264 lines
17 KiB
HTML
264 lines
17 KiB
HTML
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!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"></link>
|
|
</head>
|
|
<body bgcolor="white" text="black" link="blue" vlink="#204080"
|
|
alink="#204080">
|
|
|
|
<!-- =========== START OF NAVBAR =========== -->
|
|
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
|
|
<tr valign="center">
|
|
<th class="navbar"> <a class="navbar" href="i2p-module.html">Home</a> </th>
|
|
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
|
|
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
|
|
<th class="navbar"> <a class="navbar" 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%">
|
|
<font size="-1"><b class="breadcrumbs">
|
|
Module mimetools ::
|
|
Class Message
|
|
</b></font></br>
|
|
</td>
|
|
<td><table cellpadding="0" cellspacing="0">
|
|
<tr><td align="right"><font size="-2">[<a href="../private/mimetools.Message-class.html">show private</a> | hide private]</font></td></tr>
|
|
<tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="mimetools.Message-class.html" target="_top">no frames</a>]</font></td></tr>
|
|
</table></td>
|
|
</tr></table>
|
|
|
|
<!-- =========== START OF CLASS DESCRIPTION =========== -->
|
|
<h2 class="class">Class Message</h2>
|
|
|
|
<pre class="base-tree">
|
|
<a href="rfc822.Message-class.html"><code>Message</code></a> --+
|
|
|
|
|
<b>Message</b>
|
|
</pre><br />
|
|
|
|
<hr/>
|
|
|
|
A derived class of rfc822.Message that knows about MIME headers and
|
|
contains some hooks for decoding encoded and multipart messages.
|
|
<hr/>
|
|
|
|
|
|
<!-- =========== START OF METHOD SUMMARY =========== -->
|
|
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
|
|
<tr bgcolor="#70b0f0" class="summary">
|
|
<th colspan="2">Method Summary</th></tr>
|
|
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
|
|
<td><code><span class="summary-sig"><a href="mimetools.Message-class.html#__init__" class="summary-sig-name"><code>__init__</code></a>(<span class=summary-sig-arg>self</span>,
|
|
<span class=summary-sig-arg>fp</span>,
|
|
<span class=summary-sig-arg>seekable</span>)</span></code>
|
|
<br />
|
|
Initialize the class instance and read the headers.</td></tr>
|
|
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
|
|
<td><code><a name="getencoding"></a><span class="summary-sig"><span class="summary-sig-name">getencoding</span>(<span class=summary-sig-arg>self</span>)</span></code>
|
|
</td></tr>
|
|
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
|
|
<td><code><a name="getmaintype"></a><span class="summary-sig"><span class="summary-sig-name">getmaintype</span>(<span class=summary-sig-arg>self</span>)</span></code>
|
|
</td></tr>
|
|
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
|
|
<td><code><a name="getparam"></a><span class="summary-sig"><span class="summary-sig-name">getparam</span>(<span class=summary-sig-arg>self</span>,
|
|
<span class=summary-sig-arg>name</span>)</span></code>
|
|
</td></tr>
|
|
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
|
|
<td><code><a name="getparamnames"></a><span class="summary-sig"><span class="summary-sig-name">getparamnames</span>(<span class=summary-sig-arg>self</span>)</span></code>
|
|
</td></tr>
|
|
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
|
|
<td><code><a name="getplist"></a><span class="summary-sig"><span class="summary-sig-name">getplist</span>(<span class=summary-sig-arg>self</span>)</span></code>
|
|
</td></tr>
|
|
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
|
|
<td><code><a name="getsubtype"></a><span class="summary-sig"><span class="summary-sig-name">getsubtype</span>(<span class=summary-sig-arg>self</span>)</span></code>
|
|
</td></tr>
|
|
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
|
|
<td><code><a name="gettype"></a><span class="summary-sig"><span class="summary-sig-name">gettype</span>(<span class=summary-sig-arg>self</span>)</span></code>
|
|
</td></tr>
|
|
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
|
|
<td><code><a name="parseplist"></a><span class="summary-sig"><span class="summary-sig-name">parseplist</span>(<span class=summary-sig-arg>self</span>)</span></code>
|
|
</td></tr>
|
|
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
|
|
<td><code><a name="parsetype"></a><span class="summary-sig"><span class="summary-sig-name">parsetype</span>(<span class=summary-sig-arg>self</span>)</span></code>
|
|
</td></tr>
|
|
<tr bgcolor="#e8f0f8" class="group">
|
|
<th colspan="2"> Inherited from Message</th></tr>
|
|
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
|
|
<td><code><span class="summary-sig"><a href="rfc822.Message-class.html#__contains__" class="summary-sig-name"><code>__contains__</code></a>(<span class=summary-sig-arg>self</span>,
|
|
<span class=summary-sig-arg>name</span>)</span></code>
|
|
<br />
|
|
Determine whether a message contains the named header.</td></tr>
|
|
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
|
|
<td><code><span class="summary-sig"><a href="rfc822.Message-class.html#__delitem__" class="summary-sig-name"><code>__delitem__</code></a>(<span class=summary-sig-arg>self</span>,
|
|
<span class=summary-sig-arg>name</span>)</span></code>
|
|
<br />
|
|
Delete all occurrences of a specific header, if it is present.</td></tr>
|
|
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
|
|
<td><code><span class="summary-sig"><a href="rfc822.Message-class.html#__getitem__" class="summary-sig-name"><code>__getitem__</code></a>(<span class=summary-sig-arg>self</span>,
|
|
<span class=summary-sig-arg>name</span>)</span></code>
|
|
<br />
|
|
Get a specific header, as from a dictionary.</td></tr>
|
|
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
|
|
<td><code><span class="summary-sig"><a href="rfc822.Message-class.html#__len__" class="summary-sig-name"><code>__len__</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
|
|
<br />
|
|
Get the number of headers in a message.</td></tr>
|
|
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
|
|
<td><code><span class="summary-sig"><a href="rfc822.Message-class.html#__setitem__" class="summary-sig-name"><code>__setitem__</code></a>(<span class=summary-sig-arg>self</span>,
|
|
<span class=summary-sig-arg>name</span>,
|
|
<span class=summary-sig-arg>value</span>)</span></code>
|
|
<br />
|
|
Set the value of a header.</td></tr>
|
|
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
|
|
<td><code><span class="summary-sig"><a href="rfc822.Message-class.html#__str__" class="summary-sig-name"><code>__str__</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
|
|
</td></tr>
|
|
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
|
|
<td><code><span class="summary-sig"><a href="rfc822.Message-class.html#getheader" class="summary-sig-name"><code>get</code></a>(<span class=summary-sig-arg>self</span>,
|
|
<span class=summary-sig-arg>name</span>,
|
|
<span class=summary-sig-arg>default</span>)</span></code>
|
|
<br />
|
|
Get the header value for a name.</td></tr>
|
|
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
|
|
<td><code><span class="summary-sig"><a href="rfc822.Message-class.html#getaddr" class="summary-sig-name"><code>getaddr</code></a>(<span class=summary-sig-arg>self</span>,
|
|
<span class=summary-sig-arg>name</span>)</span></code>
|
|
<br />
|
|
Get a single address from a header, as a tuple.</td></tr>
|
|
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
|
|
<td><code><span class="summary-sig"><a href="rfc822.Message-class.html#getaddrlist" class="summary-sig-name"><code>getaddrlist</code></a>(<span class=summary-sig-arg>self</span>,
|
|
<span class=summary-sig-arg>name</span>)</span></code>
|
|
<br />
|
|
Get a list of addresses from a header.</td></tr>
|
|
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
|
|
<td><code><span class="summary-sig"><a href="rfc822.Message-class.html#getallmatchingheaders" class="summary-sig-name"><code>getallmatchingheaders</code></a>(<span class=summary-sig-arg>self</span>,
|
|
<span class=summary-sig-arg>name</span>)</span></code>
|
|
<br />
|
|
Find all header lines matching a given header name.</td></tr>
|
|
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
|
|
<td><code><span class="summary-sig"><a href="rfc822.Message-class.html#getdate" class="summary-sig-name"><code>getdate</code></a>(<span class=summary-sig-arg>self</span>,
|
|
<span class=summary-sig-arg>name</span>)</span></code>
|
|
<br />
|
|
Retrieve a date field from a header.</td></tr>
|
|
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
|
|
<td><code><span class="summary-sig"><a href="rfc822.Message-class.html#getdate_tz" class="summary-sig-name"><code>getdate_tz</code></a>(<span class=summary-sig-arg>self</span>,
|
|
<span class=summary-sig-arg>name</span>)</span></code>
|
|
<br />
|
|
Retrieve a date field from a header as a 10-tuple.</td></tr>
|
|
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
|
|
<td><code><span class="summary-sig"><a href="rfc822.Message-class.html#getfirstmatchingheader" class="summary-sig-name"><code>getfirstmatchingheader</code></a>(<span class=summary-sig-arg>self</span>,
|
|
<span class=summary-sig-arg>name</span>)</span></code>
|
|
<br />
|
|
Get the first header line matching name.</td></tr>
|
|
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
|
|
<td><code><span class="summary-sig"><a href="rfc822.Message-class.html#getheader" class="summary-sig-name"><code>getheader</code></a>(<span class=summary-sig-arg>self</span>,
|
|
<span class=summary-sig-arg>name</span>,
|
|
<span class=summary-sig-arg>default</span>)</span></code>
|
|
<br />
|
|
Get the header value for a name.</td></tr>
|
|
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
|
|
<td><code><span class="summary-sig"><a href="rfc822.Message-class.html#getheaders" class="summary-sig-name"><code>getheaders</code></a>(<span class=summary-sig-arg>self</span>,
|
|
<span class=summary-sig-arg>name</span>)</span></code>
|
|
<br />
|
|
Get all values for a header.</td></tr>
|
|
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
|
|
<td><code><span class="summary-sig"><a href="rfc822.Message-class.html#getrawheader" class="summary-sig-name"><code>getrawheader</code></a>(<span class=summary-sig-arg>self</span>,
|
|
<span class=summary-sig-arg>name</span>)</span></code>
|
|
<br />
|
|
A higher-level interface to getfirstmatchingheader().</td></tr>
|
|
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
|
|
<td><code><span class="summary-sig"><a href="rfc822.Message-class.html#has_key" class="summary-sig-name"><code>has_key</code></a>(<span class=summary-sig-arg>self</span>,
|
|
<span class=summary-sig-arg>name</span>)</span></code>
|
|
<br />
|
|
Determine whether a message contains the named header.</td></tr>
|
|
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
|
|
<td><code><span class="summary-sig"><a href="rfc822.Message-class.html#iscomment" class="summary-sig-name"><code>iscomment</code></a>(<span class=summary-sig-arg>self</span>,
|
|
<span class=summary-sig-arg>line</span>)</span></code>
|
|
<br />
|
|
Determine whether a line should be skipped entirely.</td></tr>
|
|
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
|
|
<td><code><span class="summary-sig"><a href="rfc822.Message-class.html#isheader" class="summary-sig-name"><code>isheader</code></a>(<span class=summary-sig-arg>self</span>,
|
|
<span class=summary-sig-arg>line</span>)</span></code>
|
|
<br />
|
|
Determine whether a given line is a legal header.</td></tr>
|
|
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
|
|
<td><code><span class="summary-sig"><a href="rfc822.Message-class.html#islast" class="summary-sig-name"><code>islast</code></a>(<span class=summary-sig-arg>self</span>,
|
|
<span class=summary-sig-arg>line</span>)</span></code>
|
|
<br />
|
|
Determine whether a line is a legal end of RFC 2822 headers.</td></tr>
|
|
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
|
|
<td><code><span class="summary-sig"><a href="rfc822.Message-class.html#items" class="summary-sig-name"><code>items</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
|
|
<br />
|
|
Get all of a message's headers.</td></tr>
|
|
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
|
|
<td><code><span class="summary-sig"><a href="rfc822.Message-class.html#keys" class="summary-sig-name"><code>keys</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
|
|
<br />
|
|
Get all of a message's header field names.</td></tr>
|
|
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
|
|
<td><code><span class="summary-sig"><a href="rfc822.Message-class.html#readheaders" class="summary-sig-name"><code>readheaders</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
|
|
<br />
|
|
Read header lines.</td></tr>
|
|
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
|
|
<td><code><span class="summary-sig"><a href="rfc822.Message-class.html#rewindbody" class="summary-sig-name"><code>rewindbody</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
|
|
<br />
|
|
Rewind the file to the start of the body (if seekable).</td></tr>
|
|
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
|
|
<td><code><span class="summary-sig"><a href="rfc822.Message-class.html#setdefault" class="summary-sig-name"><code>setdefault</code></a>(<span class=summary-sig-arg>self</span>,
|
|
<span class=summary-sig-arg>name</span>,
|
|
<span class=summary-sig-arg>default</span>)</span></code>
|
|
</td></tr>
|
|
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
|
|
<td><code><span class="summary-sig"><a href="rfc822.Message-class.html#values" class="summary-sig-name"><code>values</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
|
|
<br />
|
|
Get all of a message's header field values.</td></tr>
|
|
</table><br />
|
|
|
|
|
|
<!-- =========== START OF METHOD DETAILS =========== -->
|
|
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
|
|
<tr bgcolor="#70b0f0" class="details">
|
|
<th colspan="2">Method Details</th></tr>
|
|
</table>
|
|
|
|
<a name="__init__"></a>
|
|
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
|
|
<h3><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 /><i>(Constructor)</i>
|
|
</h3>
|
|
Initialize the class instance and read the headers.
|
|
<dl><dt></dt><dd>
|
|
<dl><dt><b>Overrides:</b></dt>
|
|
<dd><a href="rfc822.Message-class.html#__init__"><code>rfc822.Message.__init__</code></a> <i>(inherited documentation)</i>
|
|
</dd>
|
|
</dl>
|
|
</dd></dl>
|
|
</td></tr></table>
|
|
<br />
|
|
|
|
|
|
<!-- =========== START OF NAVBAR =========== -->
|
|
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
|
|
<tr valign="center">
|
|
<th class="navbar"> <a class="navbar" href="i2p-module.html">Home</a> </th>
|
|
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
|
|
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
|
|
<th class="navbar"> <a class="navbar" 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"><font size="-2">Generated by Epydoc 2.1 on Mon Aug 02 01:07:41 2004</font></td>
|
|
<td align="right"><a href="http://epydoc.sourceforge.net"
|
|
><font size="-2">http://epydoc.sf.net</font></a></td>
|
|
</tr>
|
|
</table>
|
|
</body>
|
|
</html>
|