twisted.protocols.pop3.IMailbox.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.pop3.IMailbox</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.pop3.html">Module pop3</a> ::
Class IMailbox
</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.pop3.IMailbox.html" target="_top">no frames</a>]</font></td></tr>
</table></td>
</tr></table>
<!-- =========== START OF CLASS DESCRIPTION =========== -->
<h2 class="class">Class IMailbox</h2>
<pre class="base-tree">
<a href="twisted.python.components.Interface.html"><code>Interface</code></a> --+
|
<b>IMailbox</b>
</pre><br />
<hr/>
<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.pop3.IMailbox.html#deleteMessage" class="summary-sig-name"><code>deleteMessage</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>index</span>)</span></code>
<br />
Delete a particular message.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> A file-like object
</font></td>
<td><code><span class="summary-sig"><a href="twisted.protocols.pop3.IMailbox.html#getMessage" class="summary-sig-name"><code>getMessage</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>index</span>)</span></code>
<br />
Retrieve a file-like object for a particular message.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> <code>str</code>
</font></td>
<td><code><span class="summary-sig"><a href="twisted.protocols.pop3.IMailbox.html#getUidl" class="summary-sig-name"><code>getUidl</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>index</span>)</span></code>
<br />
Get a unique identifier for a particular message.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> <code>int</code> or any iterable of <code>int</code>
</font></td>
<td><code><span class="summary-sig"><a href="twisted.protocols.pop3.IMailbox.html#listMessages" class="summary-sig-name"><code>listMessages</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>index</span>)</span></code>
<br />
Retrieve the size of one or more messages.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.protocols.pop3.IMailbox.html#sync" class="summary-sig-name"><code>sync</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Perform checkpointing.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.protocols.pop3.IMailbox.html#undeleteMessages" class="summary-sig-name"><code>undeleteMessages</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Undelete any messages possible.</td></tr>
</table><br />
<!-- =========== START OF INSTANCE VARIABLE SUMMARY =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Instance Variable Summary</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td>
<td><b><a href="twisted.protocols.pop3.IMailbox.html#loginDelay"><code>loginDelay</code></a></b>: The number of seconds between allowed logins for the user associated
with this mailbox.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td>
<td><b><a href="twisted.protocols.pop3.IMailbox.html#messageExpiration"><code>messageExpiration</code></a></b>: The number of days messages in this mailbox will remain on the server
before being deleted.</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="deleteMessage"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">deleteMessage</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>index</span>)</span>
</h3>
<p>Delete a particular message.</p>
This must not change the number of messages in this mailbox. Further
requests for the size of deleted messages should return 0. Further
requests for the message itself may raise an exception.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>index</b></code> -
The number of the message to delete.
<br /><i>
(type=<code>int</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="getMessage"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">getMessage</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>index</span>)</span>
</h3>
Retrieve a file-like object for a particular message.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>index</b></code> -
The number of the message to retrieve
<br /><i>
(type=<code>int</code>)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
A file-like object
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="getUidl"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">getUidl</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>index</span>)</span>
</h3>
Get a unique identifier for a particular message.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>index</b></code> -
The number of the message for which to retrieve a UIDL
<br /><i>
(type=<code>int</code>)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
A string of printable characters uniquely identifying for all
time the specified message.
<br /><i>
(type=<code>str</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="listMessages"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">listMessages</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>index</span>=<span class=sig-default>None</span>)</span>
</h3>
Retrieve the size of one or more messages.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>index</b></code> -
The number of the message for which to retrieve the size
(starting at 0), or None to retrieve the size of all
messages.
<br /><i>
(type=<code>int</code> or <code>None</code>)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
The number of octets in the specified message, or an iterable
of integers representing the number of octets in all the
messages.
<br /><i>
(type=<code>int</code> or any iterable of <code>int</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="sync"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">sync</span>(<span class=sig-arg>self</span>)</span>
</h3>
<p>Perform checkpointing.</p>
This method will be called to indicate the mailbox should attempt to
clean up any remaining deleted messages.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="undeleteMessages"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">undeleteMessages</span>(<span class=sig-arg>self</span>)</span>
</h3>
<p>Undelete any messages possible.</p>
If a message can be deleted it, it should return it its original
position in the message sequence and retain the same UIDL.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<br />
<!-- =========== START OF INSTANCE VARIABLE DETAILS =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
<th colspan="2">Instance Variable Details</th></tr>
</table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="loginDelay"></a>
<h3>loginDelay</h3>
The number of seconds between allowed logins for the user associated
with this mailbox. None
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>int</code>
</dd>
</dl>
</dd>
</dl></td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="messageExpiration"></a>
<h3>messageExpiration</h3>
The number of days messages in this mailbox will remain on the server
before being deleted.
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>int</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:21 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>