twisted.protocols.imap4.IMessagePart.html [plain text]
<?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>twisted.protocols.imap4.IMessagePart</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="twisted.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" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center">
<p class="nomargin">
<a class="navbar" target="_top" href="http://twistedmatrix.com/">Twisted 1.3.0rc1</a>
</p></th></tr></table>
</th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<font size="-1"><b class="breadcrumbs">
<a href="twisted.html">Package twisted</a> ::
<a href="twisted.protocols.html">Package protocols</a> ::
<a href="twisted.protocols.imap4.html">Module imap4</a> ::
Class IMessagePart
</b></font></br>
</td>
<td><table cellpadding="0" cellspacing="0">
<tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="twisted.protocols.imap4.IMessagePart.html" target="_top">no frames</a>]</font></td></tr>
</table></td>
</tr></table>
<!-- =========== START OF CLASS DESCRIPTION =========== -->
<h2 class="class">Class IMessagePart</h2>
<pre class="base-tree">
<a href="twisted.python.components.Interface.html"><code>Interface</code></a> --+
|
<b>IMessagePart</b>
</pre><br />
<dl><dt><b>Known Subclasses:</b></dt>
<dd>
<a href="twisted.protocols.imap4.IMessage.html"><code>IMessage</code></a></dd></dl>
<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="twisted.protocols.imap4.IMessagePart.html#getBodyFile" class="summary-sig-name"><code>getBodyFile</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Retrieve a file object containing only the body of this message.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> <code>dict</code>
</font></td>
<td><code><span class="summary-sig"><a href="twisted.protocols.imap4.IMessagePart.html#getHeaders" class="summary-sig-name"><code>getHeaders</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>negate</span>,
<span class="summary-sig-vararg">*names</span>)</span></code>
<br />
Retrieve a group of message headers.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> <code>int</code>
</font></td>
<td><code><span class="summary-sig"><a href="twisted.protocols.imap4.IMessagePart.html#getSize" class="summary-sig-name"><code>getSize</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Retrieve the total size, in octets, of this message.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> Any object implementing <code>IMessagePart</code>.
</font></td>
<td><code><span class="summary-sig"><a href="twisted.protocols.imap4.IMessagePart.html#getSubPart" class="summary-sig-name"><code>getSubPart</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>part</span>)</span></code>
<br />
Retrieve a MIME sub-message</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> <code>bool</code>
</font></td>
<td><code><span class="summary-sig"><a href="twisted.protocols.imap4.IMessagePart.html#isMultipart" class="summary-sig-name"><code>isMultipart</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Indicate whether this message has subparts.</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="getBodyFile"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">getBodyFile</span>(<span class=sig-arg>self</span>)</span>
</h3>
Retrieve a file object containing only the body of this message.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="getHeaders"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">getHeaders</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>negate</span>,
<span class="sig-vararg">*names</span>)</span>
</h3>
Retrieve a group of message headers.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>negate</b></code> -
If True, indicates that the headers listed in
<code>names</code> should be omitted from the return value,
rather than included.
<br /><i>
(type=<code>bool</code>)</i>
<dd><code><b>names</b></code> -
The names of the headers to retrieve or omit.
<br /><i>
(type=<code>tuple</code> of <code>str</code>)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
A mapping of header field names to header field values
<br /><i>
(type=<code>dict</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="getSize"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">getSize</span>(<span class=sig-arg>self</span>)</span>
</h3>
Retrieve the total size, in octets, of this message.
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
<code>int</code>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="getSubPart"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">getSubPart</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>part</span>)</span>
</h3>
Retrieve a MIME sub-message
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>part</b></code> -
<p>The number of the part to retrieve, indexed from 0.</p>
@raise <code>IndexError</code>: Raised if the specified
part does not exist. @raise <code>TypeError</code>: Raised if
this message is not multipart.
<br /><i>
(type=<code>int</code>)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
The specified sub-part.
<br /><i>
(type=Any object implementing <code>IMessagePart</code>.)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="isMultipart"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">isMultipart</span>(<span class=sig-arg>self</span>)</span>
</h3>
Indicate whether this message has subparts.
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
<code>bool</code>
</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="twisted.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" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center">
<p class="nomargin">
<a class="navbar" target="_top" href="http://twistedmatrix.com/">Twisted 1.3.0rc1</a>
</p></th></tr></table>
</th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td align="left"><font size="-2">Generated by Epydoc 2.0 on Sat May 15 20:08:39 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>