sam-t2/devtools/amd64/html/python/lib/module-email.Parser.html

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<link rel="STYLESHEET" href="lib.css" type='text/css' />
<link rel="SHORTCUT ICON" href="../icons/pyfav.png" type="image/png" />
<link rel='start' href='../index.html' title='Python Documentation Index' />
<link rel="first" href="lib.html" title='Python Library Reference' />
<link rel='contents' href='contents.html' title="Contents" />
<link rel='index' href='genindex.html' title='Index' />
<link rel='last' href='about.html' title='About this document...' />
<link rel='help' href='about.html' title='About this document...' />
<link rel="next" href="module-email.Generator.html" />
<link rel="prev" href="module-email.Message.html" />
<link rel="parent" href="module-email.html" />
<link rel="next" href="node583.html" />
<meta name='aesop' content='information' />
<title>12.2.2 Parsing email messages</title>
</head>
<body>
<DIV CLASS="navigation">
<div id='top-navigation-panel' xml:id='top-navigation-panel'>
<table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<td class='online-navigation'><a rel="prev" title="12.2.1.1 Deprecated methods"
  href="node581.html"><img src='../icons/previous.png'
  border='0' height='32'  alt='Previous Page' width='32' /></A></td>
<td class='online-navigation'><a rel="parent" title="12.2 email  "
  href="module-email.html"><img src='../icons/up.png'
  border='0' height='32'  alt='Up One Level' width='32' /></A></td>
<td class='online-navigation'><a rel="next" title="12.2.2.1 FeedParser API"
  href="node583.html"><img src='../icons/next.png'
  border='0' height='32'  alt='Next Page' width='32' /></A></td>
<td align="center" width="100%">Python Library Reference</td>
<td class='online-navigation'><a rel="contents" title="Table of Contents"
  href="contents.html"><img src='../icons/contents.png'
  border='0' height='32'  alt='Contents' width='32' /></A></td>
<td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png'
  border='0' height='32'  alt='Module Index' width='32' /></a></td>
<td class='online-navigation'><a rel="index" title="Index"
  href="genindex.html"><img src='../icons/index.png'
  border='0' height='32'  alt='Index' width='32' /></A></td>
</tr></table>
<div class='online-navigation'>
<b class="navlabel">Previous:</b>
<a class="sectref" rel="prev" href="node581.html">12.2.1.1 Deprecated methods</A>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="module-email.html">12.2 email  </A>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="node583.html">12.2.2.1 FeedParser API</A>
</div>
<hr /></div>
</DIV>
<!--End of Navigation Panel-->

<H2><A NAME="SECTION0014220000000000000000">
12.2.2 Parsing email messages</A>
</H2>
<A NAME="module-email.Parser"></A>

<P>
Message object structures can be created in one of two ways: they can be
created from whole cloth by instantiating <tt class="class">Message</tt> objects and
stringing them together via <tt class="method">attach()</tt> and
<tt class="method">set_payload()</tt> calls, or they can be created by parsing a flat text
representation of the email message.

<P>
The <tt class="module">email</tt> package provides a standard parser that understands
most email document structures, including MIME documents.  You can
pass the parser a string or a file object, and the parser will return
to you the root <tt class="class">Message</tt> instance of the object structure.  For
simple, non-MIME messages the payload of this root object will likely
be a string containing the text of the message.  For MIME
messages, the root object will return <code>True</code> from its
<tt class="method">is_multipart()</tt> method, and the subparts can be accessed via
the <tt class="method">get_payload()</tt> and <tt class="method">walk()</tt> methods.

<P>
There are actually two parser interfaces available for use, the classic
<tt class="class">Parser</tt> API and the incremental <tt class="class">FeedParser</tt> API.  The classic
<tt class="class">Parser</tt> API is fine if you have the entire text of the message in
memory as a string, or if the entire message lives in a file on the file
system.  <tt class="class">FeedParser</tt> is more appropriate for when you're reading the
message from a stream which might block waiting for more input (e.g. reading
an email message from a socket).  The <tt class="class">FeedParser</tt> can consume and parse
the message incrementally, and only returns the root object when you close the
parser<A NAME="tex2html101"
  HREF="#foot56991"><SUP>12.1</SUP></A>.

<P>
Note that the parser can be extended in limited ways, and of course
you can implement your own parser completely from scratch.  There is
no magical connection between the <tt class="module">email</tt> package's bundled
parser and the <tt class="class">Message</tt> class, so your custom parser can create
message object trees any way it finds necessary.

<P>
<BR><HR><H4>Footnotes</H4>
<DL>
<DT><A NAME="foot56991">...
parser</A><A
 href="module-email.Parser.html#tex2html101"><SUP>12.1</SUP></A></DT>
<DD>As of email package version 3.0, introduced in
Python 2.4, the classic <tt class="class">Parser</tt> was re-implemented in terms of the
<tt class="class">FeedParser</tt>, so the semantics and results are identical between the two
parsers.

</DD>
</DL>
<p><br /></p><hr class='online-navigation' />
<div class='online-navigation'>
<!--Table of Child-Links-->
<A NAME="CHILD_LINKS"><STRONG>Subsections</STRONG></a>

<UL CLASS="ChildLinks">
<LI><A href="node583.html">12.2.2.1 FeedParser API</a>
<LI><A href="node584.html">12.2.2.2 Parser class API</a>
<LI><A href="node585.html">12.2.2.3 Additional notes</a>
</ul>
<!--End of Table of Child-Links-->
</div>

<DIV CLASS="navigation">
<div class='online-navigation'>
<p></p><hr />
<table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<td class='online-navigation'><a rel="prev" title="12.2.1.1 Deprecated methods"
  href="node581.html"><img src='../icons/previous.png'
  border='0' height='32'  alt='Previous Page' width='32' /></A></td>
<td class='online-navigation'><a rel="parent" title="12.2 email  "
  href="module-email.html"><img src='../icons/up.png'
  border='0' height='32'  alt='Up One Level' width='32' /></A></td>
<td class='online-navigation'><a rel="next" title="12.2.2.1 FeedParser API"
  href="node583.html"><img src='../icons/next.png'
  border='0' height='32'  alt='Next Page' width='32' /></A></td>
<td align="center" width="100%">Python Library Reference</td>
<td class='online-navigation'><a rel="contents" title="Table of Contents"
  href="contents.html"><img src='../icons/contents.png'
  border='0' height='32'  alt='Contents' width='32' /></A></td>
<td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png'
  border='0' height='32'  alt='Module Index' width='32' /></a></td>
<td class='online-navigation'><a rel="index" title="Index"
  href="genindex.html"><img src='../icons/index.png'
  border='0' height='32'  alt='Index' width='32' /></A></td>
</tr></table>
<div class='online-navigation'>
<b class="navlabel">Previous:</b>
<a class="sectref" rel="prev" href="node581.html">12.2.1.1 Deprecated methods</A>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="module-email.html">12.2 email  </A>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="node583.html">12.2.2.1 FeedParser API</A>
</div>
</div>
<hr />
<span class="release-info">Release 2.4.2, documentation updated on 28 September 2005.</span>
</DIV>
<!--End of Navigation Panel-->
<ADDRESS>
See <i><a href="about.html">About this document...</a></i> for information on suggesting changes.
</ADDRESS>
</BODY>
</HTML>