doc/html/api/mimetools.Message-class.html

   1 <?xml version="1.0" encoding="ascii"?>
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
   3           "DTD/xhtml1-transitional.dtd">
   4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
   5 <head>
   6   <title>mimetools.Message</title>
   7   <link rel="stylesheet" href="epydoc.css" type="text/css" />
   8   <script type="text/javascript" src="epydoc.js"></script>
   9 </head>
  10
  11 <body bgcolor="white" text="black" link="blue" vlink="#204080"
  12       alink="#204080">
  13 <!-- ==================== NAVIGATION BAR ==================== -->
  14 <table class="navbar" border="0" width="100%" cellpadding="0"
  15        bgcolor="#a0c0ff" cellspacing="0">
  16   <tr valign="middle">
  17   <!-- Home link -->
  18       <th>&nbsp;&nbsp;&nbsp;<a
  19         href="lxml-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
  20
  21   <!-- Tree link -->
  22       <th>&nbsp;&nbsp;&nbsp;<a
  23         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
  24
  25   <!-- Index link -->
  26       <th>&nbsp;&nbsp;&nbsp;<a
  27         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
  28
  29   <!-- Help link -->
  30       <th>&nbsp;&nbsp;&nbsp;<a
  31         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
  32
  33   <!-- Project homepage -->
  34       <th class="navbar" align="right" width="100%">
  35         <table border="0" cellpadding="0" cellspacing="0">
  36           <tr><th class="navbar" align="center"
  37             ><a class="navbar" target="_top" href="/">lxml API</a></th>
  38           </tr></table></th>
  39   </tr>
  40 </table>
  41 <table width="100%" cellpadding="0" cellspacing="0">
  42   <tr valign="top">
  43     <td width="100%">
  44       <span class="breadcrumbs">
  45         mimetools ::
  46         Message ::
  47         Class&nbsp;Message
  48       </span>
  49     </td>
  50     <td>
  51       <table cellpadding="0" cellspacing="0">
  52         <!-- hide/show private -->
  53         <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
  54     onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
  55         <tr><td align="right"><span class="options"
  56             >[<a href="frames.html" target="_top">frames</a
  57             >]&nbsp;|&nbsp;<a href="mimetools.Message-class.html"
  58             target="_top">no&nbsp;frames</a>]</span></td></tr>
  59       </table>
  60     </td>
  61   </tr>
  62 </table>
  63 <!-- ==================== CLASS DESCRIPTION ==================== -->
  64 <h1 class="epydoc">Class Message</h1><p class="nomargin-top"></p>
  65 <pre class="base-tree">
  66 rfc822.Message --+
  67                  |
  68                 <strong class="uidshort">Message</strong>
  69 </pre>
  70
  71 <hr />
  72 A derived class of rfc822.Message that knows about MIME headers and
  73 contains some hooks for decoding encoded and multipart messages.
  74
  75 <!-- ==================== INSTANCE METHODS ==================== -->
  76 <a name="section-InstanceMethods"></a>
  77 <table class="summary" border="1" cellpadding="3"
  78        cellspacing="0" width="100%" bgcolor="white">
  79 <tr bgcolor="#70b0f0" class="table-header">
  80   <td colspan="2" class="table-header">
  81     <table border="0" cellpadding="0" cellspacing="0" width="100%">
  82       <tr valign="top">
  83         <td align="left"><span class="table-header">Instance Methods</span></td>
  84         <td align="right" valign="top"
  85          ><span class="options">[<a href="#section-InstanceMethods"
  86          class="privatelink" onclick="toggle_private();"
  87          >hide private</a>]</span></td>
  88       </tr>
  89     </table>
  90   </td>
  91 </tr>
  92 <tr>
  93     <td width="15%" align="right" valign="top" class="summary">
  94       <span class="summary-type">&nbsp;</span>
  95     </td><td class="summary">
  96       <table width="100%" cellpadding="0" cellspacing="0" border="0">
  97         <tr>
  98           <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>,
  99         <span class="summary-sig-arg">fp</span>,
 100         <span class="summary-sig-arg">seekable</span>=<span class="summary-sig-default">1</span>)</span><br />
 101       Initialize the class instance and read the headers.</td>
 102           <td align="right" valign="top">
 103
 104
 105           </td>
 106         </tr>
 107       </table>
 108
 109     </td>
 110   </tr>
 111 <tr>
 112     <td width="15%" align="right" valign="top" class="summary">
 113       <span class="summary-type">&nbsp;</span>
 114     </td><td class="summary">
 115       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 116         <tr>
 117           <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>
 118           <td align="right" valign="top">
 119
 120
 121           </td>
 122         </tr>
 123       </table>
 124
 125     </td>
 126   </tr>
 127 <tr>
 128     <td width="15%" align="right" valign="top" class="summary">
 129       <span class="summary-type">&nbsp;</span>
 130     </td><td class="summary">
 131       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 132         <tr>
 133           <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>
 134           <td align="right" valign="top">
 135
 136
 137           </td>
 138         </tr>
 139       </table>
 140
 141     </td>
 142   </tr>
 143 <tr>
 144     <td width="15%" align="right" valign="top" class="summary">
 145       <span class="summary-type">&nbsp;</span>
 146     </td><td class="summary">
 147       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 148         <tr>
 149           <td><span class="summary-sig"><a name="getparam"></a><span class="summary-sig-name">getparam</span>(<span class="summary-sig-arg">self</span>,
 150         <span class="summary-sig-arg">name</span>)</span></td>
 151           <td align="right" valign="top">
 152
 153
 154           </td>
 155         </tr>
 156       </table>
 157
 158     </td>
 159   </tr>
 160 <tr>
 161     <td width="15%" align="right" valign="top" class="summary">
 162       <span class="summary-type">&nbsp;</span>
 163     </td><td class="summary">
 164       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 165         <tr>
 166           <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>
 167           <td align="right" valign="top">
 168
 169
 170           </td>
 171         </tr>
 172       </table>
 173
 174     </td>
 175   </tr>
 176 <tr>
 177     <td width="15%" align="right" valign="top" class="summary">
 178       <span class="summary-type">&nbsp;</span>
 179     </td><td class="summary">
 180       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 181         <tr>
 182           <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>
 183           <td align="right" valign="top">
 184
 185
 186           </td>
 187         </tr>
 188       </table>
 189
 190     </td>
 191   </tr>
 192 <tr>
 193     <td width="15%" align="right" valign="top" class="summary">
 194       <span class="summary-type">&nbsp;</span>
 195     </td><td class="summary">
 196       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 197         <tr>
 198           <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>
 199           <td align="right" valign="top">
 200
 201
 202           </td>
 203         </tr>
 204       </table>
 205
 206     </td>
 207   </tr>
 208 <tr>
 209     <td width="15%" align="right" valign="top" class="summary">
 210       <span class="summary-type">&nbsp;</span>
 211     </td><td class="summary">
 212       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 213         <tr>
 214           <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>
 215           <td align="right" valign="top">
 216
 217
 218           </td>
 219         </tr>
 220       </table>
 221
 222     </td>
 223   </tr>
 224 <tr>
 225     <td width="15%" align="right" valign="top" class="summary">
 226       <span class="summary-type">&nbsp;</span>
 227     </td><td class="summary">
 228       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 229         <tr>
 230           <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>
 231           <td align="right" valign="top">
 232
 233
 234           </td>
 235         </tr>
 236       </table>
 237
 238     </td>
 239   </tr>
 240 <tr>
 241     <td width="15%" align="right" valign="top" class="summary">
 242       <span class="summary-type">&nbsp;</span>
 243     </td><td class="summary">
 244       <table width="100%" cellpadding="0" cellspacing="0" border="0">
 245         <tr>
 246           <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>
 247           <td align="right" valign="top">
 248
 249
 250           </td>
 251         </tr>
 252       </table>
 253
 254     </td>
 255   </tr>
 256   <tr>
 257     <td colspan="2" class="summary">
 258     <p class="indent-wrapped-lines"><b>Inherited from <code>rfc822.Message</code></b>:
 259       <code>__contains__</code>,
 260       <code>__delitem__</code>,
 261       <code>__getitem__</code>,
 262       <code>__iter__</code>,
 263       <code>__len__</code>,
 264       <code>__setitem__</code>,
 265       <code>__str__</code>,
 266       <code>get</code>,
 267       <code>getaddr</code>,
 268       <code>getaddrlist</code>,
 269       <code>getallmatchingheaders</code>,
 270       <code>getdate</code>,
 271       <code>getdate_tz</code>,
 272       <code>getfirstmatchingheader</code>,
 273       <code>getheader</code>,
 274       <code>getheaders</code>,
 275       <code>getrawheader</code>,
 276       <code>has_key</code>,
 277       <code>iscomment</code>,
 278       <code>isheader</code>,
 279       <code>islast</code>,
 280       <code>items</code>,
 281       <code>keys</code>,
 282       <code>readheaders</code>,
 283       <code>rewindbody</code>,
 284       <code>setdefault</code>,
 285       <code>values</code>
 286       </p>
 287     </td>
 288   </tr>
 289 </table>
 290 <!-- ==================== METHOD DETAILS ==================== -->
 291 <a name="section-MethodDetails"></a>
 292 <table class="details" border="1" cellpadding="3"
 293        cellspacing="0" width="100%" bgcolor="white">
 294 <tr bgcolor="#70b0f0" class="table-header">
 295   <td colspan="2" class="table-header">
 296     <table border="0" cellpadding="0" cellspacing="0" width="100%">
 297       <tr valign="top">
 298         <td align="left"><span class="table-header">Method Details</span></td>
 299         <td align="right" valign="top"
 300          ><span class="options">[<a href="#section-MethodDetails"
 301          class="privatelink" onclick="toggle_private();"
 302          >hide private</a>]</span></td>
 303       </tr>
 304     </table>
 305   </td>
 306 </tr>
 307 </table>
 308 <a name="__init__"></a>
 309 <div>
 310 <table class="details" border="1" cellpadding="3"
 311        cellspacing="0" width="100%" bgcolor="white">
 312 <tr><td>
 313   <table width="100%" cellpadding="0" cellspacing="0" border="0">
 314   <tr valign="top"><td>
 315   <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
 316         <span class="sig-arg">fp</span>,
 317         <span class="sig-arg">seekable</span>=<span class="sig-default">1</span>)</span>
 318     <br /><em class="fname">(Constructor)</em>
 319   </h3>
 320   </td><td align="right" valign="top"
 321     >&nbsp;
 322     </td>
 323   </tr></table>
 324
 325   Initialize the class instance and read the headers.
 326   <dl class="fields">
 327     <dt>Overrides:
 328         rfc822.Message.__init__
 329         <dd><em class="note">(inherited documentation)</em></dd>
 330     </dt>
 331   </dl>
 332 </td></tr></table>
 333 </div>
 334 <br />
 335 <!-- ==================== NAVIGATION BAR ==================== -->
 336 <table class="navbar" border="0" width="100%" cellpadding="0"
 337        bgcolor="#a0c0ff" cellspacing="0">
 338   <tr valign="middle">
 339   <!-- Home link -->
 340       <th>&nbsp;&nbsp;&nbsp;<a
 341         href="lxml-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
 342
 343   <!-- Tree link -->
 344       <th>&nbsp;&nbsp;&nbsp;<a
 345         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 346
 347   <!-- Index link -->
 348       <th>&nbsp;&nbsp;&nbsp;<a
 349         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
 350
 351   <!-- Help link -->
 352       <th>&nbsp;&nbsp;&nbsp;<a
 353         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 354
 355   <!-- Project homepage -->
 356       <th class="navbar" align="right" width="100%">
 357         <table border="0" cellpadding="0" cellspacing="0">
 358           <tr><th class="navbar" align="center"
 359             ><a class="navbar" target="_top" href="/">lxml API</a></th>
 360           </tr></table></th>
 361   </tr>
 362 </table>
 363 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
 364   <tr>
 365     <td align="left" class="footer">
 366     Generated by Epydoc 3.0.1
 367     on Thu Jul  9 18:29:53 2020
 368     </td>
 369     <td align="right" class="footer">
 370       <a target="mainFrame" href="http://epydoc.sourceforge.net"
 371         >http://epydoc.sourceforge.net</a>
 372     </td>
 373   </tr>
 374 </table>
 375
 376 <script type="text/javascript">
 377   <!--
 378   // Private objects are initially displayed (because if
 379   // javascript is turned off then we want them to be
 380   // visible); but by default, we want to hide them.  So hide
 381   // them unless we have a cookie that says to show them.
 382   checkCookie();
 383   // -->
 384 </script>
 385 </body>
 386 </html>