| <?xml version="1.0" encoding="ascii"?> |
| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" |
| "DTD/xhtml1-transitional.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
| <head> |
| <title>mimetools.Message</title> |
| <link rel="stylesheet" href="epydoc.css" type="text/css" /> |
| <script type="text/javascript" src="epydoc.js"></script> |
| </head> |
| |
| <body bgcolor="white" text="black" link="blue" vlink="#204080" |
| alink="#204080"> |
| <!-- ==================== NAVIGATION BAR ==================== --> |
| <table class="navbar" border="0" width="100%" cellpadding="0" |
| bgcolor="#a0c0ff" cellspacing="0"> |
| <tr valign="middle"> |
| |
| <!-- Tree link --> |
| <th> <a |
| href="module-tree.html">Trees</a> </th> |
| |
| <!-- Index link --> |
| <th> <a |
| href="identifier-index.html">Indices</a> </th> |
| |
| <!-- Help link --> |
| <th> <a |
| href="help.html">Help</a> </th> |
| |
| <th class="navbar" width="100%"></th> |
| </tr> |
| </table> |
| <table width="100%" cellpadding="0" cellspacing="0"> |
| <tr valign="top"> |
| <td width="100%"> |
| <span class="breadcrumbs"> |
| mimetools :: |
| Message :: |
| Class Message |
| </span> |
| </td> |
| <td> |
| <table cellpadding="0" cellspacing="0"> |
| <!-- hide/show private --> |
| <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink" |
| onclick="toggle_private();">hide private</a>]</span></td></tr> |
| <tr><td align="right"><span class="options" |
| >[<a href="frames.html" target="_top">frames</a |
| >] | <a href="mimetools.Message-class.html" |
| target="_top">no frames</a>]</span></td></tr> |
| </table> |
| </td> |
| </tr> |
| </table> |
| <!-- ==================== CLASS DESCRIPTION ==================== --> |
| <h1 class="epydoc">Class Message</h1><p class="nomargin-top"></p> |
| <center> |
| <center> <map id="uml_class_diagram_for_mimetool" name="uml_class_diagram_for_mimetool"> |
| <area shape="rect" href="mimetools.Message-class.html#__init__" title="Initialize the class instance and read the headers." alt="" coords="33,372,207,391"/> |
| <area shape="rect" href="mimetools.Message-class.html#getencoding" title="mimetools.Message.getencoding" alt="" coords="33,391,207,409"/> |
| <area shape="rect" href="mimetools.Message-class.html#getmaintype" title="mimetools.Message.getmaintype" alt="" coords="33,409,207,428"/> |
| <area shape="rect" href="mimetools.Message-class.html#getparam" title="mimetools.Message.getparam" alt="" coords="33,428,207,447"/> |
| <area shape="rect" href="mimetools.Message-class.html#getparamnames" title="mimetools.Message.getparamnames" alt="" coords="33,447,207,465"/> |
| <area shape="rect" href="mimetools.Message-class.html#getplist" title="mimetools.Message.getplist" alt="" coords="33,465,207,484"/> |
| <area shape="rect" href="mimetools.Message-class.html#getsubtype" title="mimetools.Message.getsubtype" alt="" coords="33,484,207,503"/> |
| <area shape="rect" href="mimetools.Message-class.html#gettype" title="mimetools.Message.gettype" alt="" coords="33,503,207,521"/> |
| <area shape="rect" href="mimetools.Message-class.html#parseplist" title="mimetools.Message.parseplist" alt="" coords="33,521,207,540"/> |
| <area shape="rect" href="mimetools.Message-class.html#parsetype" title="mimetools.Message.parsetype" alt="" coords="33,540,207,559"/> |
| <area shape="rect" href="mimetools.Message-class.html" title="A derived class of rfc822.Message that knows about MIME headers and contains some hooks for decoding encoded and multipart messages." alt="" coords="32,347,208,560"/> |
| <area shape="rect" href="javascript:void(0);" title="Determine whether a message contains the named header." alt="" coords="17,36,223,55"/> |
| <area shape="rect" href="javascript:void(0);" title="Delete all occurrences of a specific header, if it is present." alt="" coords="17,55,223,73"/> |
| <area shape="rect" href="javascript:void(0);" title="Get a specific header, as from a dictionary." alt="" coords="17,73,223,92"/> |
| <area shape="rect" href="javascript:void(0);" title="rfc822.Message.__iter__" alt="" coords="17,92,223,111"/> |
| <area shape="rect" href="javascript:void(0);" title="Get the number of headers in a message." alt="" coords="17,111,223,129"/> |
| <area shape="rect" href="javascript:void(0);" title="Set the value of a header." alt="" coords="17,129,223,148"/> |
| <area shape="rect" href="javascript:void(0);" title="rfc822.Message.__str__" alt="" coords="17,148,223,167"/> |
| <area shape="rect" href="javascript:void(0);" title="Get the header value for a name." alt="" coords="17,167,223,185"/> |
| <area shape="rect" href="javascript:void(0);" title="Get a single address from a header, as a tuple." alt="" coords="17,185,223,204"/> |
| <area shape="rect" href="javascript:void(0);" title="Get a list of addresses from a header." alt="" coords="17,204,223,223"/> |
| <area shape="rect" href="javascript:void(0);" title="Find all header lines matching a given header name." alt="" coords="17,223,223,241"/> |
| <area shape="rect" href="javascript:void(0);" title="Retrieve a date field from a header." alt="" coords="17,241,223,260"/> |
| <area shape="rect" href="javascript:void(0);" title="Retrieve a date field from a header as a 10-tuple." alt="" coords="17,260,223,279"/> |
| <area shape="rect" href="javascript:void(0);" title="Get all of a message's header field values." alt="" coords="17,297,223,316"/> |
| <area shape="rect" href="javascript:void(0);" title="Represents a single RFC 2822-compliant message." alt="" coords="16,11,224,317"/> |
| </map> |
| <img src="uml_class_diagram_for_mimetool.gif" alt='' usemap="#uml_class_diagram_for_mimetool" ismap="ismap" class="graph-without-title" /> |
| </center> |
| </center> |
| <hr /> |
| <pre class="literalblock"> |
| A derived class of rfc822.Message that knows about MIME headers and |
| contains some hooks for decoding encoded and multipart messages. |
| |
| </pre> |
| |
| <!-- ==================== INSTANCE METHODS ==================== --> |
| <a name="section-InstanceMethods"></a> |
| <table class="summary" border="1" cellpadding="3" |
| cellspacing="0" width="100%" bgcolor="white"> |
| <tr bgcolor="#70b0f0" class="table-header"> |
| <td colspan="2" class="table-header"> |
| <table border="0" cellpadding="0" cellspacing="0" width="100%"> |
| <tr valign="top"> |
| <td align="left"><span class="table-header">Instance Methods</span></td> |
| <td align="right" valign="top" |
| ><span class="options">[<a href="#section-InstanceMethods" |
| class="privatelink" onclick="toggle_private();" |
| >hide private</a>]</span></td> |
| </tr> |
| </table> |
| </td> |
| </tr> |
| <tr> |
| <td width="15%" align="right" valign="top" class="summary"> |
| <span class="summary-type"> </span> |
| </td><td class="summary"> |
| <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| <tr> |
| <td><span class="summary-sig"><a href="mimetools.Message-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>, |
| <span class="summary-sig-arg">fp</span>, |
| <span class="summary-sig-arg">seekable</span>=<span class="summary-sig-default">1</span>)</span><br /> |
| Initialize the class instance and read the headers.</td> |
| <td align="right" valign="top"> |
| |
| |
| </td> |
| </tr> |
| </table> |
| |
| </td> |
| </tr> |
| <tr> |
| <td width="15%" align="right" valign="top" class="summary"> |
| <span class="summary-type"> </span> |
| </td><td class="summary"> |
| <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| <tr> |
| <td><span class="summary-sig"><a name="getencoding"></a><span class="summary-sig-name">getencoding</span>(<span class="summary-sig-arg">self</span>)</span></td> |
| <td align="right" valign="top"> |
| |
| |
| </td> |
| </tr> |
| </table> |
| |
| </td> |
| </tr> |
| <tr> |
| <td width="15%" align="right" valign="top" class="summary"> |
| <span class="summary-type"> </span> |
| </td><td class="summary"> |
| <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| <tr> |
| <td><span class="summary-sig"><a name="getmaintype"></a><span class="summary-sig-name">getmaintype</span>(<span class="summary-sig-arg">self</span>)</span></td> |
| <td align="right" valign="top"> |
| |
| |
| </td> |
| </tr> |
| </table> |
| |
| </td> |
| </tr> |
| <tr> |
| <td width="15%" align="right" valign="top" class="summary"> |
| <span class="summary-type"> </span> |
| </td><td class="summary"> |
| <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| <tr> |
| <td><span class="summary-sig"><a name="getparam"></a><span class="summary-sig-name">getparam</span>(<span class="summary-sig-arg">self</span>, |
| <span class="summary-sig-arg">name</span>)</span></td> |
| <td align="right" valign="top"> |
| |
| |
| </td> |
| </tr> |
| </table> |
| |
| </td> |
| </tr> |
| <tr> |
| <td width="15%" align="right" valign="top" class="summary"> |
| <span class="summary-type"> </span> |
| </td><td class="summary"> |
| <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| <tr> |
| <td><span class="summary-sig"><a name="getparamnames"></a><span class="summary-sig-name">getparamnames</span>(<span class="summary-sig-arg">self</span>)</span></td> |
| <td align="right" valign="top"> |
| |
| |
| </td> |
| </tr> |
| </table> |
| |
| </td> |
| </tr> |
| <tr> |
| <td width="15%" align="right" valign="top" class="summary"> |
| <span class="summary-type"> </span> |
| </td><td class="summary"> |
| <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| <tr> |
| <td><span class="summary-sig"><a name="getplist"></a><span class="summary-sig-name">getplist</span>(<span class="summary-sig-arg">self</span>)</span></td> |
| <td align="right" valign="top"> |
| |
| |
| </td> |
| </tr> |
| </table> |
| |
| </td> |
| </tr> |
| <tr> |
| <td width="15%" align="right" valign="top" class="summary"> |
| <span class="summary-type"> </span> |
| </td><td class="summary"> |
| <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| <tr> |
| <td><span class="summary-sig"><a name="getsubtype"></a><span class="summary-sig-name">getsubtype</span>(<span class="summary-sig-arg">self</span>)</span></td> |
| <td align="right" valign="top"> |
| |
| |
| </td> |
| </tr> |
| </table> |
| |
| </td> |
| </tr> |
| <tr> |
| <td width="15%" align="right" valign="top" class="summary"> |
| <span class="summary-type"> </span> |
| </td><td class="summary"> |
| <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| <tr> |
| <td><span class="summary-sig"><a name="gettype"></a><span class="summary-sig-name">gettype</span>(<span class="summary-sig-arg">self</span>)</span></td> |
| <td align="right" valign="top"> |
| |
| |
| </td> |
| </tr> |
| </table> |
| |
| </td> |
| </tr> |
| <tr> |
| <td width="15%" align="right" valign="top" class="summary"> |
| <span class="summary-type"> </span> |
| </td><td class="summary"> |
| <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| <tr> |
| <td><span class="summary-sig"><a name="parseplist"></a><span class="summary-sig-name">parseplist</span>(<span class="summary-sig-arg">self</span>)</span></td> |
| <td align="right" valign="top"> |
| |
| |
| </td> |
| </tr> |
| </table> |
| |
| </td> |
| </tr> |
| <tr> |
| <td width="15%" align="right" valign="top" class="summary"> |
| <span class="summary-type"> </span> |
| </td><td class="summary"> |
| <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| <tr> |
| <td><span class="summary-sig"><a name="parsetype"></a><span class="summary-sig-name">parsetype</span>(<span class="summary-sig-arg">self</span>)</span></td> |
| <td align="right" valign="top"> |
| |
| |
| </td> |
| </tr> |
| </table> |
| |
| </td> |
| </tr> |
| <tr> |
| <td colspan="2" class="summary"> |
| <p class="indent-wrapped-lines"><b>Inherited from <code>rfc822.Message</code></b>: |
| <code>__contains__</code>, |
| <code>__delitem__</code>, |
| <code>__getitem__</code>, |
| <code>__iter__</code>, |
| <code>__len__</code>, |
| <code>__setitem__</code>, |
| <code>__str__</code>, |
| <code>get</code>, |
| <code>getaddr</code>, |
| <code>getaddrlist</code>, |
| <code>getallmatchingheaders</code>, |
| <code>getdate</code>, |
| <code>getdate_tz</code>, |
| <code>getfirstmatchingheader</code>, |
| <code>getheader</code>, |
| <code>getheaders</code>, |
| <code>getrawheader</code>, |
| <code>has_key</code>, |
| <code>iscomment</code>, |
| <code>isheader</code>, |
| <code>islast</code>, |
| <code>items</code>, |
| <code>keys</code>, |
| <code>readheaders</code>, |
| <code>rewindbody</code>, |
| <code>setdefault</code>, |
| <code>values</code> |
| </p> |
| </td> |
| </tr> |
| </table> |
| <!-- ==================== METHOD DETAILS ==================== --> |
| <a name="section-MethodDetails"></a> |
| <table class="details" border="1" cellpadding="3" |
| cellspacing="0" width="100%" bgcolor="white"> |
| <tr bgcolor="#70b0f0" class="table-header"> |
| <td colspan="2" class="table-header"> |
| <table border="0" cellpadding="0" cellspacing="0" width="100%"> |
| <tr valign="top"> |
| <td align="left"><span class="table-header">Method Details</span></td> |
| <td align="right" valign="top" |
| ><span class="options">[<a href="#section-MethodDetails" |
| class="privatelink" onclick="toggle_private();" |
| >hide private</a>]</span></td> |
| </tr> |
| </table> |
| </td> |
| </tr> |
| </table> |
| <a name="__init__"></a> |
| <div> |
| <table class="details" border="1" cellpadding="3" |
| cellspacing="0" width="100%" bgcolor="white"> |
| <tr><td> |
| <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
| <tr valign="top"><td> |
| <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>, |
| <span class="sig-arg">fp</span>, |
| <span class="sig-arg">seekable</span>=<span class="sig-default">1</span>)</span> |
| <br /><em class="fname">(Constructor)</em> |
| </h3> |
| </td><td align="right" valign="top" |
| > |
| </td> |
| </tr></table> |
| |
| <pre class="literalblock"> |
| Initialize the class instance and read the headers. |
| |
| </pre> |
| <dl class="fields"> |
| <dt>Overrides: |
| rfc822.Message.__init__ |
| <dd><em class="note">(inherited documentation)</em></dd> |
| </dt> |
| </dl> |
| </td></tr></table> |
| </div> |
| <br /> |
| <!-- ==================== NAVIGATION BAR ==================== --> |
| <table class="navbar" border="0" width="100%" cellpadding="0" |
| bgcolor="#a0c0ff" cellspacing="0"> |
| <tr valign="middle"> |
| |
| <!-- Tree link --> |
| <th> <a |
| href="module-tree.html">Trees</a> </th> |
| |
| <!-- Index link --> |
| <th> <a |
| href="identifier-index.html">Indices</a> </th> |
| |
| <!-- Help link --> |
| <th> <a |
| href="help.html">Help</a> </th> |
| |
| <th class="navbar" width="100%"></th> |
| </tr> |
| </table> |
| <table border="0" cellpadding="0" cellspacing="0" width="100%%"> |
| <tr> |
| <td align="left" class="footer"> |
| Generated by Epydoc 3.0.1 on Thu Jun 14 08:01:56 2012 |
| </td> |
| <td align="right" class="footer"> |
| <a target="mainFrame" href="http://epydoc.sourceforge.net" |
| >http://epydoc.sourceforge.net</a> |
| </td> |
| </tr> |
| </table> |
| |
| <script type="text/javascript"> |
| <!-- |
| // Private objects are initially displayed (because if |
| // javascript is turned off then we want them to be |
| // visible); but by default, we want to hide them. So hide |
| // them unless we have a cookie that says to show them. |
| checkCookie(); |
| // --> |
| </script> |
| </body> |
| </html> |