Edit File: rfc822.html
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <title>18.11. rfc822 — Parse RFC 2822 mail headers — Python v2.6.6 documentation</title> <link rel="stylesheet" href="../_static/default.css" type="text/css" /> <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> <script type="text/javascript"> var DOCUMENTATION_OPTIONS = { URL_ROOT: '../', VERSION: '2.6.6', COLLAPSE_MODINDEX: false, FILE_SUFFIX: '.html', HAS_SOURCE: true }; </script> <script type="text/javascript" src="../_static/jquery.js"></script> <script type="text/javascript" src="../_static/doctools.js"></script> <link rel="search" type="application/opensearchdescription+xml" title="Search within Python v2.6.6 documentation" href="../_static/opensearch.xml"/> <link rel="author" title="About these documents" href="../about.html" /> <link rel="copyright" title="Copyright" href="../copyright.html" /> <link rel="top" title="Python v2.6.6 documentation" href="../index.html" /> <link rel="up" title="18. Internet Data Handling" href="netdata.html" /> <link rel="next" title="18.12. base64 — RFC 3548: Base16, Base32, Base64 Data Encodings" href="base64.html" /> <link rel="prev" title="18.10. multifile — Support for files containing distinct parts" href="multifile.html" /> <link rel="shortcut icon" type="image/png" href="../_static/py.png" /> </head> <body> <div class="related"> <h3>Navigation</h3> <ul> <li class="right" style="margin-right: 10px"> <a href="../genindex.html" title="General Index" accesskey="I">index</a></li> <li class="right" > <a href="../modindex.html" title="Global Module Index" accesskey="M">modules</a> |</li> <li class="right" > <a href="base64.html" title="18.12. base64 — RFC 3548: Base16, Base32, Base64 Data Encodings" accesskey="N">next</a> |</li> <li class="right" > <a href="multifile.html" title="18.10. multifile — Support for files containing distinct parts" accesskey="P">previous</a> |</li> <li><img src="../_static/py.png" alt="" style="vertical-align: middle; margin-top: -1px"/></li> <li><a href="../index.html">Python v2.6.6 documentation</a> »</li> <li><a href="index.html" >The Python Standard Library</a> »</li> <li><a href="netdata.html" accesskey="U">18. Internet Data Handling</a> »</li> </ul> </div> <div class="document"> <div class="documentwrapper"> <div class="bodywrapper"> <div class="body"> <div class="section" id="module-rfc822"> <h1>18.11. <tt class="xref docutils literal"><span class="pre">rfc822</span></tt> — Parse RFC 2822 mail headers<a class="headerlink" href="#module-rfc822" title="Permalink to this headline">¶</a></h1> <p class="deprecated"> <span class="versionmodified">Deprecated since version 2.3: </span>The <a title="Package supporting the parsing, manipulating, and generating email messages, including MIME documents." class="reference external" href="email.html#module-email"><tt class="xref docutils literal"><span class="pre">email</span></tt></a> package should be used in preference to the <tt class="xref docutils literal"><span class="pre">rfc822</span></tt> module. This module is present only to maintain backward compatibility, and has been removed in 3.0.</p> <p>This module defines a class, <a title="rfc822.Message" class="reference internal" href="#rfc822.Message"><tt class="xref docutils literal"><span class="pre">Message</span></tt></a>, which represents an “email message” as defined by the Internet standard <span class="target" id="index-522"></span><a class="reference external" href="http://tools.ietf.org/html/rfc2822.html"><strong>RFC 2822</strong></a>. <a class="footnote-reference" href="#id4" id="id1">[1]</a> Such messages consist of a collection of message headers, and a message body. This module also defines a helper class <a title="rfc822.AddressList" class="reference internal" href="#rfc822.AddressList"><tt class="xref docutils literal"><span class="pre">AddressList</span></tt></a> for parsing <span class="target" id="index-523"></span><a class="reference external" href="http://tools.ietf.org/html/rfc2822.html"><strong>RFC 2822</strong></a> addresses. Please refer to the RFC for information on the specific syntax of <span class="target" id="index-524"></span><a class="reference external" href="http://tools.ietf.org/html/rfc2822.html"><strong>RFC 2822</strong></a> messages.</p> <p id="index-525">The <a title="Manipulate mailboxes in various formats" class="reference external" href="mailbox.html#module-mailbox"><tt class="xref docutils literal"><span class="pre">mailbox</span></tt></a> module provides classes to read mailboxes produced by various end-user mail programs.</p> <dl class="class"> <dt id="rfc822.Message"> <em class="property">class </em><tt class="descclassname">rfc822.</tt><tt class="descname">Message</tt><big>(</big><em>file</em><span class="optional">[</span>, <em>seekable</em><span class="optional">]</span><big>)</big><a class="headerlink" href="#rfc822.Message" title="Permalink to this definition">¶</a></dt> <dd><p>A <a title="rfc822.Message" class="reference internal" href="#rfc822.Message"><tt class="xref docutils literal"><span class="pre">Message</span></tt></a> instance is instantiated with an input object as parameter. Message relies only on the input object having a <tt class="xref docutils literal"><span class="pre">readline()</span></tt> method; in particular, ordinary file objects qualify. Instantiation reads headers from the input object up to a delimiter line (normally a blank line) and stores them in the instance. The message body, following the headers, is not consumed.</p> <p>This class can work with any input object that supports a <tt class="xref docutils literal"><span class="pre">readline()</span></tt> method. If the input object has seek and tell capability, the <a title="rfc822.Message.rewindbody" class="reference internal" href="#rfc822.Message.rewindbody"><tt class="xref docutils literal"><span class="pre">rewindbody()</span></tt></a> method will work; also, illegal lines will be pushed back onto the input stream. If the input object lacks seek but has an <tt class="xref docutils literal"><span class="pre">unread()</span></tt> method that can push back a line of input, <a title="rfc822.Message" class="reference internal" href="#rfc822.Message"><tt class="xref docutils literal"><span class="pre">Message</span></tt></a> will use that to push back illegal lines. Thus this class can be used to parse messages coming from a buffered stream.</p> <p>The optional <em>seekable</em> argument is provided as a workaround for certain stdio libraries in which <tt class="xref docutils literal"><span class="pre">tell()</span></tt> discards buffered data before discovering that the <tt class="xref docutils literal"><span class="pre">lseek()</span></tt> system call doesn’t work. For maximum portability, you should set the seekable argument to zero to prevent that initial <tt class="xref docutils literal"><span class="pre">tell()</span></tt> when passing in an unseekable object such as a file object created from a socket object.</p> <p>Input lines as read from the file may either be terminated by CR-LF or by a single linefeed; a terminating CR-LF is replaced by a single linefeed before the line is stored.</p> <p>All header matching is done independent of upper or lower case; e.g. <tt class="docutils literal"><span class="pre">m['From']</span></tt>, <tt class="docutils literal"><span class="pre">m['from']</span></tt> and <tt class="docutils literal"><span class="pre">m['FROM']</span></tt> all yield the same result.</p> </dd></dl> <dl class="class"> <dt id="rfc822.AddressList"> <em class="property">class </em><tt class="descclassname">rfc822.</tt><tt class="descname">AddressList</tt><big>(</big><em>field</em><big>)</big><a class="headerlink" href="#rfc822.AddressList" title="Permalink to this definition">¶</a></dt> <dd>You may instantiate the <a title="rfc822.AddressList" class="reference internal" href="#rfc822.AddressList"><tt class="xref docutils literal"><span class="pre">AddressList</span></tt></a> helper class using a single string parameter, a comma-separated list of <span class="target" id="index-526"></span><a class="reference external" href="http://tools.ietf.org/html/rfc2822.html"><strong>RFC 2822</strong></a> addresses to be parsed. (The parameter <tt class="xref docutils literal"><span class="pre">None</span></tt> yields an empty list.)</dd></dl> <dl class="function"> <dt id="rfc822.quote"> <tt class="descclassname">rfc822.</tt><tt class="descname">quote</tt><big>(</big><em>str</em><big>)</big><a class="headerlink" href="#rfc822.quote" title="Permalink to this definition">¶</a></dt> <dd>Return a new string with backslashes in <em>str</em> replaced by two backslashes and double quotes replaced by backslash-double quote.</dd></dl> <dl class="function"> <dt id="rfc822.unquote"> <tt class="descclassname">rfc822.</tt><tt class="descname">unquote</tt><big>(</big><em>str</em><big>)</big><a class="headerlink" href="#rfc822.unquote" title="Permalink to this definition">¶</a></dt> <dd>Return a new string which is an <em>unquoted</em> version of <em>str</em>. If <em>str</em> ends and begins with double quotes, they are stripped off. Likewise if <em>str</em> ends and begins with angle brackets, they are stripped off.</dd></dl> <dl class="function"> <dt id="rfc822.parseaddr"> <tt class="descclassname">rfc822.</tt><tt class="descname">parseaddr</tt><big>(</big><em>address</em><big>)</big><a class="headerlink" href="#rfc822.parseaddr" title="Permalink to this definition">¶</a></dt> <dd>Parse <em>address</em>, which should be the value of some address-containing field such as <em>To</em> or <em>Cc</em>, into its constituent “realname” and “email address” parts. Returns a tuple of that information, unless the parse fails, in which case a 2-tuple <tt class="docutils literal"><span class="pre">(None,</span> <span class="pre">None)</span></tt> is returned.</dd></dl> <dl class="function"> <dt id="rfc822.dump_address_pair"> <tt class="descclassname">rfc822.</tt><tt class="descname">dump_address_pair</tt><big>(</big><em>pair</em><big>)</big><a class="headerlink" href="#rfc822.dump_address_pair" title="Permalink to this definition">¶</a></dt> <dd>The inverse of <a title="rfc822.parseaddr" class="reference internal" href="#rfc822.parseaddr"><tt class="xref docutils literal"><span class="pre">parseaddr()</span></tt></a>, this takes a 2-tuple of the form <tt class="docutils literal"><span class="pre">(realname,</span> <span class="pre">email_address)</span></tt> and returns the string value suitable for a <em>To</em> or <em>Cc</em> header. If the first element of <em>pair</em> is false, then the second element is returned unmodified.</dd></dl> <dl class="function"> <dt id="rfc822.parsedate"> <tt class="descclassname">rfc822.</tt><tt class="descname">parsedate</tt><big>(</big><em>date</em><big>)</big><a class="headerlink" href="#rfc822.parsedate" title="Permalink to this definition">¶</a></dt> <dd>Attempts to parse a date according to the rules in <span class="target" id="index-527"></span><a class="reference external" href="http://tools.ietf.org/html/rfc2822.html"><strong>RFC 2822</strong></a>. however, some mailers don’t follow that format as specified, so <a title="rfc822.parsedate" class="reference internal" href="#rfc822.parsedate"><tt class="xref docutils literal"><span class="pre">parsedate()</span></tt></a> tries to guess correctly in such cases. <em>date</em> is a string containing an <span class="target" id="index-528"></span><a class="reference external" href="http://tools.ietf.org/html/rfc2822.html"><strong>RFC 2822</strong></a> date, such as <tt class="docutils literal"><span class="pre">'Mon,</span> <span class="pre">20</span> <span class="pre">Nov</span> <span class="pre">1995</span> <span class="pre">19:12:08</span> <span class="pre">-0500'</span></tt>. If it succeeds in parsing the date, <a title="rfc822.parsedate" class="reference internal" href="#rfc822.parsedate"><tt class="xref docutils literal"><span class="pre">parsedate()</span></tt></a> returns a 9-tuple that can be passed directly to <a title="time.mktime" class="reference external" href="time.html#time.mktime"><tt class="xref docutils literal"><span class="pre">time.mktime()</span></tt></a>; otherwise <tt class="xref docutils literal"><span class="pre">None</span></tt> will be returned. Note that indexes 6, 7, and 8 of the result tuple are not usable.</dd></dl> <dl class="function"> <dt id="rfc822.parsedate_tz"> <tt class="descclassname">rfc822.</tt><tt class="descname">parsedate_tz</tt><big>(</big><em>date</em><big>)</big><a class="headerlink" href="#rfc822.parsedate_tz" title="Permalink to this definition">¶</a></dt> <dd>Performs the same function as <a title="rfc822.parsedate" class="reference internal" href="#rfc822.parsedate"><tt class="xref docutils literal"><span class="pre">parsedate()</span></tt></a>, but returns either <tt class="xref docutils literal"><span class="pre">None</span></tt> or a 10-tuple; the first 9 elements make up a tuple that can be passed directly to <a title="time.mktime" class="reference external" href="time.html#time.mktime"><tt class="xref docutils literal"><span class="pre">time.mktime()</span></tt></a>, and the tenth is the offset of the date’s timezone from UTC (which is the official term for Greenwich Mean Time). (Note that the sign of the timezone offset is the opposite of the sign of the <tt class="docutils literal"><span class="pre">time.timezone</span></tt> variable for the same timezone; the latter variable follows the POSIX standard while this module follows <span class="target" id="index-529"></span><a class="reference external" href="http://tools.ietf.org/html/rfc2822.html"><strong>RFC 2822</strong></a>.) If the input string has no timezone, the last element of the tuple returned is <tt class="xref docutils literal"><span class="pre">None</span></tt>. Note that indexes 6, 7, and 8 of the result tuple are not usable.</dd></dl> <dl class="function"> <dt id="rfc822.mktime_tz"> <tt class="descclassname">rfc822.</tt><tt class="descname">mktime_tz</tt><big>(</big><em>tuple</em><big>)</big><a class="headerlink" href="#rfc822.mktime_tz" title="Permalink to this definition">¶</a></dt> <dd>Turn a 10-tuple as returned by <a title="rfc822.parsedate_tz" class="reference internal" href="#rfc822.parsedate_tz"><tt class="xref docutils literal"><span class="pre">parsedate_tz()</span></tt></a> into a UTC timestamp. If the timezone item in the tuple is <tt class="xref docutils literal"><span class="pre">None</span></tt>, assume local time. Minor deficiency: this first interprets the first 8 elements as a local time and then compensates for the timezone difference; this may yield a slight error around daylight savings time switch dates. Not enough to worry about for common use.</dd></dl> <div class="admonition-see-also admonition seealso"> <p class="first admonition-title">See also</p> <dl class="last docutils"> <dt>Module <a title="Package supporting the parsing, manipulating, and generating email messages, including MIME documents." class="reference external" href="email.html#module-email"><tt class="xref docutils literal"><span class="pre">email</span></tt></a></dt> <dd>Comprehensive email handling package; supersedes the <tt class="xref docutils literal"><span class="pre">rfc822</span></tt> module.</dd> <dt>Module <a title="Manipulate mailboxes in various formats" class="reference external" href="mailbox.html#module-mailbox"><tt class="xref docutils literal"><span class="pre">mailbox</span></tt></a></dt> <dd>Classes to read various mailbox formats produced by end-user mail programs.</dd> <dt>Module <a title="Tools for parsing MIME-style message bodies. (deprecated)" class="reference external" href="mimetools.html#module-mimetools"><tt class="xref docutils literal"><span class="pre">mimetools</span></tt></a></dt> <dd>Subclass of <a title="rfc822.Message" class="reference internal" href="#rfc822.Message"><tt class="xref docutils literal"><span class="pre">rfc822.Message</span></tt></a> that handles MIME encoded messages.</dd> </dl> </div> <div class="section" id="message-objects"> <span id="id2"></span><h2>18.11.1. Message Objects<a class="headerlink" href="#message-objects" title="Permalink to this headline">¶</a></h2> <p>A <a title="rfc822.Message" class="reference internal" href="#rfc822.Message"><tt class="xref docutils literal"><span class="pre">Message</span></tt></a> instance has the following methods:</p> <dl class="method"> <dt id="rfc822.Message.rewindbody"> <tt class="descclassname">Message.</tt><tt class="descname">rewindbody</tt><big>(</big><big>)</big><a class="headerlink" href="#rfc822.Message.rewindbody" title="Permalink to this definition">¶</a></dt> <dd>Seek to the start of the message body. This only works if the file object is seekable.</dd></dl> <dl class="method"> <dt id="rfc822.Message.isheader"> <tt class="descclassname">Message.</tt><tt class="descname">isheader</tt><big>(</big><em>line</em><big>)</big><a class="headerlink" href="#rfc822.Message.isheader" title="Permalink to this definition">¶</a></dt> <dd>Returns a line’s canonicalized fieldname (the dictionary key that will be used to index it) if the line is a legal <span class="target" id="index-530"></span><a class="reference external" href="http://tools.ietf.org/html/rfc2822.html"><strong>RFC 2822</strong></a> header; otherwise returns <tt class="xref docutils literal"><span class="pre">None</span></tt> (implying that parsing should stop here and the line be pushed back on the input stream). It is sometimes useful to override this method in a subclass.</dd></dl> <dl class="method"> <dt id="rfc822.Message.islast"> <tt class="descclassname">Message.</tt><tt class="descname">islast</tt><big>(</big><em>line</em><big>)</big><a class="headerlink" href="#rfc822.Message.islast" title="Permalink to this definition">¶</a></dt> <dd>Return true if the given line is a delimiter on which Message should stop. The delimiter line is consumed, and the file object’s read location positioned immediately after it. By default this method just checks that the line is blank, but you can override it in a subclass.</dd></dl> <dl class="method"> <dt id="rfc822.Message.iscomment"> <tt class="descclassname">Message.</tt><tt class="descname">iscomment</tt><big>(</big><em>line</em><big>)</big><a class="headerlink" href="#rfc822.Message.iscomment" title="Permalink to this definition">¶</a></dt> <dd>Return <tt class="xref docutils literal"><span class="pre">True</span></tt> if the given line should be ignored entirely, just skipped. By default this is a stub that always returns <tt class="xref docutils literal"><span class="pre">False</span></tt>, but you can override it in a subclass.</dd></dl> <dl class="method"> <dt id="rfc822.Message.getallmatchingheaders"> <tt class="descclassname">Message.</tt><tt class="descname">getallmatchingheaders</tt><big>(</big><em>name</em><big>)</big><a class="headerlink" href="#rfc822.Message.getallmatchingheaders" title="Permalink to this definition">¶</a></dt> <dd>Return a list of lines consisting of all headers matching <em>name</em>, if any. Each physical line, whether it is a continuation line or not, is a separate list item. Return the empty list if no header matches <em>name</em>.</dd></dl> <dl class="method"> <dt id="rfc822.Message.getfirstmatchingheader"> <tt class="descclassname">Message.</tt><tt class="descname">getfirstmatchingheader</tt><big>(</big><em>name</em><big>)</big><a class="headerlink" href="#rfc822.Message.getfirstmatchingheader" title="Permalink to this definition">¶</a></dt> <dd>Return a list of lines comprising the first header matching <em>name</em>, and its continuation line(s), if any. Return <tt class="xref docutils literal"><span class="pre">None</span></tt> if there is no header matching <em>name</em>.</dd></dl> <dl class="method"> <dt id="rfc822.Message.getrawheader"> <tt class="descclassname">Message.</tt><tt class="descname">getrawheader</tt><big>(</big><em>name</em><big>)</big><a class="headerlink" href="#rfc822.Message.getrawheader" title="Permalink to this definition">¶</a></dt> <dd>Return a single string consisting of the text after the colon in the first header matching <em>name</em>. This includes leading whitespace, the trailing linefeed, and internal linefeeds and whitespace if there any continuation line(s) were present. Return <tt class="xref docutils literal"><span class="pre">None</span></tt> if there is no header matching <em>name</em>.</dd></dl> <dl class="method"> <dt id="rfc822.Message.getheader"> <tt class="descclassname">Message.</tt><tt class="descname">getheader</tt><big>(</big><em>name</em><span class="optional">[</span>, <em>default</em><span class="optional">]</span><big>)</big><a class="headerlink" href="#rfc822.Message.getheader" title="Permalink to this definition">¶</a></dt> <dd>Return a single string consisting of the last header matching <em>name</em>, but strip leading and trailing whitespace. Internal whitespace is not stripped. The optional <em>default</em> argument can be used to specify a different default to be returned when there is no header matching <em>name</em>; it defaults to <tt class="xref docutils literal"><span class="pre">None</span></tt>. This is the preferred way to get parsed headers.</dd></dl> <dl class="method"> <dt id="rfc822.Message.get"> <tt class="descclassname">Message.</tt><tt class="descname">get</tt><big>(</big><em>name</em><span class="optional">[</span>, <em>default</em><span class="optional">]</span><big>)</big><a class="headerlink" href="#rfc822.Message.get" title="Permalink to this definition">¶</a></dt> <dd>An alias for <a title="rfc822.Message.getheader" class="reference internal" href="#rfc822.Message.getheader"><tt class="xref docutils literal"><span class="pre">getheader()</span></tt></a>, to make the interface more compatible with regular dictionaries.</dd></dl> <dl class="method"> <dt id="rfc822.Message.getaddr"> <tt class="descclassname">Message.</tt><tt class="descname">getaddr</tt><big>(</big><em>name</em><big>)</big><a class="headerlink" href="#rfc822.Message.getaddr" title="Permalink to this definition">¶</a></dt> <dd><p>Return a pair <tt class="docutils literal"><span class="pre">(full</span> <span class="pre">name,</span> <span class="pre">email</span> <span class="pre">address)</span></tt> parsed from the string returned by <tt class="docutils literal"><span class="pre">getheader(name)</span></tt>. If no header matching <em>name</em> exists, return <tt class="docutils literal"><span class="pre">(None,</span> <span class="pre">None)</span></tt>; otherwise both the full name and the address are (possibly empty) strings.</p> <p>Example: If <em>m</em>‘s first <em>From</em> header contains the string <tt class="docutils literal"><span class="pre">'jack@cwi.nl</span> <span class="pre">(Jack</span> <span class="pre">Jansen)'</span></tt>, then <tt class="docutils literal"><span class="pre">m.getaddr('From')</span></tt> will yield the pair <tt class="docutils literal"><span class="pre">('Jack</span> <span class="pre">Jansen',</span> <span class="pre">'jack@cwi.nl')</span></tt>. If the header contained <tt class="docutils literal"><span class="pre">'Jack</span> <span class="pre">Jansen</span> <span class="pre"><jack@cwi.nl>'</span></tt> instead, it would yield the exact same result.</p> </dd></dl> <dl class="method"> <dt id="rfc822.Message.getaddrlist"> <tt class="descclassname">Message.</tt><tt class="descname">getaddrlist</tt><big>(</big><em>name</em><big>)</big><a class="headerlink" href="#rfc822.Message.getaddrlist" title="Permalink to this definition">¶</a></dt> <dd><p>This is similar to <tt class="docutils literal"><span class="pre">getaddr(list)</span></tt>, but parses a header containing a list of email addresses (e.g. a <em>To</em> header) and returns a list of <tt class="docutils literal"><span class="pre">(full</span> <span class="pre">name,</span> <span class="pre">email</span> <span class="pre">address)</span></tt> pairs (even if there was only one address in the header). If there is no header matching <em>name</em>, return an empty list.</p> <p>If multiple headers exist that match the named header (e.g. if there are several <em>Cc</em> headers), all are parsed for addresses. Any continuation lines the named headers contain are also parsed.</p> </dd></dl> <dl class="method"> <dt id="rfc822.Message.getdate"> <tt class="descclassname">Message.</tt><tt class="descname">getdate</tt><big>(</big><em>name</em><big>)</big><a class="headerlink" href="#rfc822.Message.getdate" title="Permalink to this definition">¶</a></dt> <dd><p>Retrieve a header using <a title="rfc822.Message.getheader" class="reference internal" href="#rfc822.Message.getheader"><tt class="xref docutils literal"><span class="pre">getheader()</span></tt></a> and parse it into a 9-tuple compatible with <a title="time.mktime" class="reference external" href="time.html#time.mktime"><tt class="xref docutils literal"><span class="pre">time.mktime()</span></tt></a>; note that fields 6, 7, and 8 are not usable. If there is no header matching <em>name</em>, or it is unparsable, return <tt class="xref docutils literal"><span class="pre">None</span></tt>.</p> <p>Date parsing appears to be a black art, and not all mailers adhere to the standard. While it has been tested and found correct on a large collection of email from many sources, it is still possible that this function may occasionally yield an incorrect result.</p> </dd></dl> <dl class="method"> <dt id="rfc822.Message.getdate_tz"> <tt class="descclassname">Message.</tt><tt class="descname">getdate_tz</tt><big>(</big><em>name</em><big>)</big><a class="headerlink" href="#rfc822.Message.getdate_tz" title="Permalink to this definition">¶</a></dt> <dd>Retrieve a header using <a title="rfc822.Message.getheader" class="reference internal" href="#rfc822.Message.getheader"><tt class="xref docutils literal"><span class="pre">getheader()</span></tt></a> and parse it into a 10-tuple; the first 9 elements will make a tuple compatible with <a title="time.mktime" class="reference external" href="time.html#time.mktime"><tt class="xref docutils literal"><span class="pre">time.mktime()</span></tt></a>, and the 10th is a number giving the offset of the date’s timezone from UTC. Note that fields 6, 7, and 8 are not usable. Similarly to <a title="rfc822.Message.getdate" class="reference internal" href="#rfc822.Message.getdate"><tt class="xref docutils literal"><span class="pre">getdate()</span></tt></a>, if there is no header matching <em>name</em>, or it is unparsable, return <tt class="xref docutils literal"><span class="pre">None</span></tt>.</dd></dl> <p><a title="rfc822.Message" class="reference internal" href="#rfc822.Message"><tt class="xref docutils literal"><span class="pre">Message</span></tt></a> instances also support a limited mapping interface. In particular: <tt class="docutils literal"><span class="pre">m[name]</span></tt> is like <tt class="docutils literal"><span class="pre">m.getheader(name)</span></tt> but raises <a title="exceptions.KeyError" class="reference external" href="exceptions.html#exceptions.KeyError"><tt class="xref docutils literal"><span class="pre">KeyError</span></tt></a> if there is no matching header; and <tt class="docutils literal"><span class="pre">len(m)</span></tt>, <tt class="docutils literal"><span class="pre">m.get(name[,</span> <span class="pre">default])</span></tt>, <tt class="docutils literal"><span class="pre">name</span> <span class="pre">in</span> <span class="pre">m</span></tt>, <tt class="docutils literal"><span class="pre">m.keys()</span></tt>, <tt class="docutils literal"><span class="pre">m.values()</span></tt> <tt class="docutils literal"><span class="pre">m.items()</span></tt>, and <tt class="docutils literal"><span class="pre">m.setdefault(name[,</span> <span class="pre">default])</span></tt> act as expected, with the one difference that <tt class="xref docutils literal"><span class="pre">setdefault()</span></tt> uses an empty string as the default value. <a title="rfc822.Message" class="reference internal" href="#rfc822.Message"><tt class="xref docutils literal"><span class="pre">Message</span></tt></a> instances also support the mapping writable interface <tt class="docutils literal"><span class="pre">m[name]</span> <span class="pre">=</span> <span class="pre">value</span></tt> and <tt class="docutils literal"><span class="pre">del</span> <span class="pre">m[name]</span></tt>. <a title="rfc822.Message" class="reference internal" href="#rfc822.Message"><tt class="xref docutils literal"><span class="pre">Message</span></tt></a> objects do not support the <tt class="xref docutils literal"><span class="pre">clear()</span></tt>, <tt class="xref docutils literal"><span class="pre">copy()</span></tt>, <tt class="xref docutils literal"><span class="pre">popitem()</span></tt>, or <tt class="xref docutils literal"><span class="pre">update()</span></tt> methods of the mapping interface. (Support for <tt class="xref docutils literal"><span class="pre">get()</span></tt> and <tt class="xref docutils literal"><span class="pre">setdefault()</span></tt> was only added in Python 2.2.)</p> <p>Finally, <a title="rfc822.Message" class="reference internal" href="#rfc822.Message"><tt class="xref docutils literal"><span class="pre">Message</span></tt></a> instances have some public instance variables:</p> <dl class="attribute"> <dt id="rfc822.Message.headers"> <tt class="descclassname">Message.</tt><tt class="descname">headers</tt><a class="headerlink" href="#rfc822.Message.headers" title="Permalink to this definition">¶</a></dt> <dd>A list containing the entire set of header lines, in the order in which they were read (except that setitem calls may disturb this order). Each line contains a trailing newline. The blank line terminating the headers is not contained in the list.</dd></dl> <dl class="attribute"> <dt id="rfc822.Message.fp"> <tt class="descclassname">Message.</tt><tt class="descname">fp</tt><a class="headerlink" href="#rfc822.Message.fp" title="Permalink to this definition">¶</a></dt> <dd>The file or file-like object passed at instantiation time. This can be used to read the message content.</dd></dl> <dl class="attribute"> <dt id="rfc822.Message.unixfrom"> <tt class="descclassname">Message.</tt><tt class="descname">unixfrom</tt><a class="headerlink" href="#rfc822.Message.unixfrom" title="Permalink to this definition">¶</a></dt> <dd>The Unix <tt class="docutils literal"><span class="pre">From</span></tt> line, if the message had one, or an empty string. This is needed to regenerate the message in some contexts, such as an <tt class="docutils literal"><span class="pre">mbox</span></tt>-style mailbox file.</dd></dl> </div> <div class="section" id="addresslist-objects"> <span id="id3"></span><h2>18.11.2. AddressList Objects<a class="headerlink" href="#addresslist-objects" title="Permalink to this headline">¶</a></h2> <p>An <a title="rfc822.AddressList" class="reference internal" href="#rfc822.AddressList"><tt class="xref docutils literal"><span class="pre">AddressList</span></tt></a> instance has the following methods:</p> <dl class="method"> <dt id="rfc822.AddressList.__len__"> <tt class="descclassname">AddressList.</tt><tt class="descname">__len__</tt><big>(</big><big>)</big><a class="headerlink" href="#rfc822.AddressList.__len__" title="Permalink to this definition">¶</a></dt> <dd>Return the number of addresses in the address list.</dd></dl> <dl class="method"> <dt id="rfc822.AddressList.__str__"> <tt class="descclassname">AddressList.</tt><tt class="descname">__str__</tt><big>(</big><big>)</big><a class="headerlink" href="#rfc822.AddressList.__str__" title="Permalink to this definition">¶</a></dt> <dd>Return a canonicalized string representation of the address list. Addresses are rendered in “name” <<a class="reference external" href="mailto:host%40domain">host<span>@</span>domain</a>> form, comma-separated.</dd></dl> <dl class="method"> <dt id="rfc822.AddressList.__add__"> <tt class="descclassname">AddressList.</tt><tt class="descname">__add__</tt><big>(</big><em>alist</em><big>)</big><a class="headerlink" href="#rfc822.AddressList.__add__" title="Permalink to this definition">¶</a></dt> <dd>Return a new <a title="rfc822.AddressList" class="reference internal" href="#rfc822.AddressList"><tt class="xref docutils literal"><span class="pre">AddressList</span></tt></a> instance that contains all addresses in both <a title="rfc822.AddressList" class="reference internal" href="#rfc822.AddressList"><tt class="xref docutils literal"><span class="pre">AddressList</span></tt></a> operands, with duplicates removed (set union).</dd></dl> <dl class="method"> <dt id="rfc822.AddressList.__iadd__"> <tt class="descclassname">AddressList.</tt><tt class="descname">__iadd__</tt><big>(</big><em>alist</em><big>)</big><a class="headerlink" href="#rfc822.AddressList.__iadd__" title="Permalink to this definition">¶</a></dt> <dd>In-place version of <a title="rfc822.AddressList.__add__" class="reference internal" href="#rfc822.AddressList.__add__"><tt class="xref docutils literal"><span class="pre">__add__()</span></tt></a>; turns this <a title="rfc822.AddressList" class="reference internal" href="#rfc822.AddressList"><tt class="xref docutils literal"><span class="pre">AddressList</span></tt></a> instance into the union of itself and the right-hand instance, <em>alist</em>.</dd></dl> <dl class="method"> <dt id="rfc822.AddressList.__sub__"> <tt class="descclassname">AddressList.</tt><tt class="descname">__sub__</tt><big>(</big><em>alist</em><big>)</big><a class="headerlink" href="#rfc822.AddressList.__sub__" title="Permalink to this definition">¶</a></dt> <dd>Return a new <a title="rfc822.AddressList" class="reference internal" href="#rfc822.AddressList"><tt class="xref docutils literal"><span class="pre">AddressList</span></tt></a> instance that contains every address in the left-hand <a title="rfc822.AddressList" class="reference internal" href="#rfc822.AddressList"><tt class="xref docutils literal"><span class="pre">AddressList</span></tt></a> operand that is not present in the right-hand address operand (set difference).</dd></dl> <dl class="method"> <dt id="rfc822.AddressList.__isub__"> <tt class="descclassname">AddressList.</tt><tt class="descname">__isub__</tt><big>(</big><em>alist</em><big>)</big><a class="headerlink" href="#rfc822.AddressList.__isub__" title="Permalink to this definition">¶</a></dt> <dd>In-place version of <a title="rfc822.AddressList.__sub__" class="reference internal" href="#rfc822.AddressList.__sub__"><tt class="xref docutils literal"><span class="pre">__sub__()</span></tt></a>, removing addresses in this list which are also in <em>alist</em>.</dd></dl> <p>Finally, <a title="rfc822.AddressList" class="reference internal" href="#rfc822.AddressList"><tt class="xref docutils literal"><span class="pre">AddressList</span></tt></a> instances have one public instance variable:</p> <dl class="attribute"> <dt id="rfc822.AddressList.addresslist"> <tt class="descclassname">AddressList.</tt><tt class="descname">addresslist</tt><a class="headerlink" href="#rfc822.AddressList.addresslist" title="Permalink to this definition">¶</a></dt> <dd>A list of tuple string pairs, one per address. In each member, the first is the canonicalized name part, the second is the actual route-address (<tt class="docutils literal"><span class="pre">'@'</span></tt>-separated username-host.domain pair).</dd></dl> <p class="rubric">Footnotes</p> <table class="docutils footnote" frame="void" id="id4" rules="none"> <colgroup><col class="label" /><col /></colgroup> <tbody valign="top"> <tr><td class="label"><a class="fn-backref" href="#id1">[1]</a></td><td>This module originally conformed to <span class="target" id="index-531"></span><a class="reference external" href="http://tools.ietf.org/html/rfc822.html"><strong>RFC 822</strong></a>, hence the name. Since then, <span class="target" id="index-532"></span><a class="reference external" href="http://tools.ietf.org/html/rfc2822.html"><strong>RFC 2822</strong></a> has been released as an update to <span class="target" id="index-533"></span><a class="reference external" href="http://tools.ietf.org/html/rfc822.html"><strong>RFC 822</strong></a>. This module should be considered <span class="target" id="index-534"></span><a class="reference external" href="http://tools.ietf.org/html/rfc2822.html"><strong>RFC 2822</strong></a>-conformant, especially in cases where the syntax or semantics have changed since <span class="target" id="index-535"></span><a class="reference external" href="http://tools.ietf.org/html/rfc822.html"><strong>RFC 822</strong></a>.</td></tr> </tbody> </table> </div> </div> </div> </div> </div> <div class="sphinxsidebar"> <div class="sphinxsidebarwrapper"> <h3><a href="../contents.html">Table Of Contents</a></h3> <ul> <li><a class="reference external" href="#">18.11. <tt class="docutils literal"><span class="pre">rfc822</span></tt> — Parse RFC 2822 mail headers</a><ul> <li><a class="reference external" href="#message-objects">18.11.1. Message Objects</a></li> <li><a class="reference external" href="#addresslist-objects">18.11.2. AddressList Objects</a></li> </ul> </li> </ul> <h4>Previous topic</h4> <p class="topless"><a href="multifile.html" title="previous chapter">18.10. <tt class="docutils literal docutils literal docutils literal"><span class="pre">multifile</span></tt> — Support for files containing distinct parts</a></p> <h4>Next topic</h4> <p class="topless"><a href="base64.html" title="next chapter">18.12. <tt class="docutils literal docutils literal docutils literal"><span class="pre">base64</span></tt> — RFC 3548: Base16, Base32, Base64 Data Encodings</a></p> <h3>This Page</h3> <ul class="this-page-menu"> <li><a href="../bugs.html">Report a Bug</a></li> <li><a href="../_sources/library/rfc822.txt" rel="nofollow">Show Source</a></li> </ul> <div id="searchbox" style="display: none"> <h3>Quick search</h3> <form class="search" action="../search.html" method="get"> <input type="text" name="q" size="18" /> <input type="submit" value="Go" /> <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> <p class="searchtip" style="font-size: 90%"> Enter search terms or a module, class or function name. </p> </div> <script type="text/javascript">$('#searchbox').show(0);</script> </div> </div> <div class="clearer"></div> </div> <div class="related"> <h3>Navigation</h3> <ul> <li class="right" style="margin-right: 10px"> <a href="../genindex.html" title="General Index" >index</a></li> <li class="right" > <a href="../modindex.html" title="Global Module Index" >modules</a> |</li> <li class="right" > <a href="base64.html" title="18.12. base64 — RFC 3548: Base16, Base32, Base64 Data Encodings" >next</a> |</li> <li class="right" > <a href="multifile.html" title="18.10. multifile — Support for files containing distinct parts" >previous</a> |</li> <li><img src="../_static/py.png" alt="" style="vertical-align: middle; margin-top: -1px"/></li> <li><a href="../index.html">Python v2.6.6 documentation</a> »</li> <li><a href="index.html" >The Python Standard Library</a> »</li> <li><a href="netdata.html" >18. Internet Data Handling</a> »</li> </ul> </div> <div class="footer"> © <a href="../copyright.html">Copyright</a> 1990-2011, Python Software Foundation. <br /> The Python Software Foundation is a non-profit corporation. <a href="http://www.python.org/psf/donations/">Please donate.</a> <br /> Last updated on Jul 20, 2011. <a href="../bugs.html">Found a bug</a>? <br /> Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.6. </div> </body> </html>
Back to File Manager