twisted.protocols.imap4.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.imap4.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.imap4.html">Module imap4</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.imap4.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> --+
|
<a href="twisted.protocols.imap4.IMailboxInfo.html"><code>IMailboxInfo</code></a> --+
|
<b>IMailbox</b>
</pre><br />
<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.IMailbox.html#addListener" class="summary-sig-name"><code>addListener</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>listener</span>)</span></code>
<br />
Add a mailbox change listener</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> <code>Deferred</code>
</font></td>
<td><code><span class="summary-sig"><a href="twisted.protocols.imap4.IMailbox.html#addMessage" class="summary-sig-name"><code>addMessage</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>message</span>,
<span class=summary-sig-arg>flags</span>,
<span class=summary-sig-arg>date</span>)</span></code>
<br />
Add the given message to this mailbox.</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.imap4.IMailbox.html#destroy" class="summary-sig-name"><code>destroy</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Called before this mailbox is deleted, permanently.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> <code>list</code> or <code>Deferred</code>
</font></td>
<td><code><span class="summary-sig"><a href="twisted.protocols.imap4.IMailbox.html#expunge" class="summary-sig-name"><code>expunge</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Remove all messages flagged \Deleted.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> Any iterable of two-tuples of message sequence numbers and
implementors of <code>IMessage</code>.
</font></td>
<td><code><span class="summary-sig"><a href="twisted.protocols.imap4.IMailbox.html#fetch" class="summary-sig-name"><code>fetch</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>messages</span>,
<span class=summary-sig-arg>uid</span>)</span></code>
<br />
Retrieve one or more messages.</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.IMailbox.html#getMessageCount" class="summary-sig-name"><code>getMessageCount</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Return the number of messages in this mailbox.</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.IMailbox.html#getRecentCount" class="summary-sig-name"><code>getRecentCount</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Return the number of messages with the 'Recent' flag.</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.IMailbox.html#getUID" class="summary-sig-name"><code>getUID</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>message</span>)</span></code>
<br />
Return the UID of a message in the mailbox</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.IMailbox.html#getUIDNext" class="summary-sig-name"><code>getUIDNext</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Return the likely UID for the next message added to this mailbox.</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.IMailbox.html#getUIDValidity" class="summary-sig-name"><code>getUIDValidity</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Return the unique validity identifier for this mailbox.</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.IMailbox.html#getUnseenCount" class="summary-sig-name"><code>getUnseenCount</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Return the number of messages with the 'Unseen' flag.</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.IMailbox.html#isWriteable" class="summary-sig-name"><code>isWriteable</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Get the read/write status of the mailbox.</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.imap4.IMailbox.html#removeListener" class="summary-sig-name"><code>removeListener</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>listener</span>)</span></code>
<br />
Remove a mailbox change listener</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> <code>dict</code> or <code>Deferred</code>
</font></td>
<td><code><span class="summary-sig"><a href="twisted.protocols.imap4.IMailbox.html#requestStatus" class="summary-sig-name"><code>requestStatus</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>names</span>)</span></code>
<br />
Return status information about this mailbox.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> <code>dict</code> or <code>Deferred</code>
</font></td>
<td><code><span class="summary-sig"><a href="twisted.protocols.imap4.IMailbox.html#store" class="summary-sig-name"><code>store</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>messages</span>,
<span class=summary-sig-arg>flags</span>,
<span class=summary-sig-arg>mode</span>,
<span class=summary-sig-arg>uid</span>)</span></code>
<br />
Set the flags of one or more messages.</td></tr>
<tr bgcolor="#e8f0f8" class="group">
<th colspan="2"> Inherited from IMailboxInfo</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> <code>list</code> of <code>str</code>
</font></td>
<td><code><span class="summary-sig"><a href="twisted.protocols.imap4.IMailboxInfo.html#getFlags" class="summary-sig-name"><code>getFlags</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Return the flags defined in this mailbox</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.imap4.IMailboxInfo.html#getHierarchicalDelimiter" class="summary-sig-name"><code>getHierarchicalDelimiter</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Get the character which delimits namespaces for in this mailbox.</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="addListener"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">addListener</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>listener</span>)</span>
</h3>
Add a mailbox change listener
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>listener</b></code> -
An object to add to the set of those which will be notified
when the contents of this mailbox change.
<br /><i>
(type=Any object which implements
<code>IMailboxListener</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="addMessage"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">addMessage</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>message</span>,
<span class=sig-arg>flags</span>=<span class=sig-default>()</span>,
<span class=sig-arg>date</span>=<span class=sig-default>None</span>)</span>
</h3>
Add the given message to this mailbox.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>message</b></code> -
The RFC822 formatted message
<br /><i>
(type=A file-like object)</i>
<dd><code><b>flags</b></code> -
The flags to associate with this message
<br /><i>
(type=Any iterable of <code>str</code>)</i>
<dd><code><b>date</b></code> -
If specified, the date to associate with this message.
<br /><i>
(type=<code>str</code>)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
A deferred whose callback is invoked with the message id if
the message is added successfully and whose errback is invoked
otherwise.
<br /><i>
(type=<code>Deferred</code>)</i>
</dd>
</dl>
<dl><dt><b>Raises:</b></dt>
<dd><code><b>ReadOnlyMailbox</b></code> -
Raised if this Mailbox is not open for read-write.
</dl>
</dd></dl>
</td></tr></table>
<a name="destroy"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">destroy</span>(<span class=sig-arg>self</span>)</span>
</h3>
<p>Called before this mailbox is deleted, permanently.</p>
If necessary, all resources held by this mailbox should be cleaned
up here. This function _must_ set the \Noselect flag on this
mailbox.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="expunge"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">expunge</span>(<span class=sig-arg>self</span>)</span>
</h3>
Remove all messages flagged \Deleted.
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
The list of message sequence numbers which were deleted, or a
<code>Deferred</code> whose callback will be invoked with such a
list.
<br /><i>
(type=<code>list</code> or <code>Deferred</code>)</i>
</dd>
</dl>
<dl><dt><b>Raises:</b></dt>
<dd><code><b>ReadOnlyMailbox</b></code> -
Raised if this Mailbox is not open for read-write.
</dl>
</dd></dl>
</td></tr></table>
<a name="fetch"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">fetch</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>messages</span>,
<span class=sig-arg>uid</span>)</span>
</h3>
Retrieve one or more messages.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>messages</b></code> -
The identifiers of messages to retrieve information about
<br /><i>
(type=<code>MessageSet</code>)</i>
<dd><code><b>uid</b></code> -
If true, the IDs specified in the query are UIDs; otherwise
they are message sequence IDs.
<br /><i>
(type=<code>bool</code>)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
Any iterable of two-tuples of message sequence numbers and
implementors of <code>IMessage</code>.
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="getMessageCount"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">getMessageCount</span>(<span class=sig-arg>self</span>)</span>
</h3>
Return the number of messages in this mailbox.
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
<code>int</code>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="getRecentCount"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">getRecentCount</span>(<span class=sig-arg>self</span>)</span>
</h3>
Return the number of messages with the 'Recent' flag.
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
<code>int</code>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="getUID"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">getUID</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>message</span>)</span>
</h3>
Return the UID of a message in the mailbox
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>message</b></code> -
The message sequence number
<br /><i>
(type=<code>int</code>)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
The UID of the message.
<br /><i>
(type=<code>int</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="getUIDNext"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">getUIDNext</span>(<span class=sig-arg>self</span>)</span>
</h3>
Return the likely UID for the next message added to this
mailbox.
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
<code>int</code>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="getUIDValidity"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">getUIDValidity</span>(<span class=sig-arg>self</span>)</span>
</h3>
Return the unique validity identifier for this mailbox.
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
<code>int</code>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="getUnseenCount"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">getUnseenCount</span>(<span class=sig-arg>self</span>)</span>
</h3>
Return the number of messages with the 'Unseen' flag.
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
<code>int</code>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="isWriteable"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">isWriteable</span>(<span class=sig-arg>self</span>)</span>
</h3>
Get the read/write status of the mailbox.
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
A true value if write permission is allowed, a false value
otherwise.
<br /><i>
(type=<code>int</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="removeListener"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">removeListener</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>listener</span>)</span>
</h3>
Remove a mailbox change listener
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>listener</b></code> -
The object to remove from the set of listeners.
<br /><i>
(type=Any object previously added to and not removed from this
mailbox as a listener.)</i>
</dd>
</dl>
<dl><dt><b>Raises:</b></dt>
<dd><code><b>ValueError</b></code> -
Raised when the given object is not a listener for this
mailbox.
</dl>
</dd></dl>
</td></tr></table>
<a name="requestStatus"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">requestStatus</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>names</span>)</span>
</h3>
<p>Return status information about this mailbox.</p>
Mailboxes which do not intend to do any special processing to
generate the return value, <code>statusRequestHelper</code> can be used
to build the dictionary by calling the other interface methods which
return the data for each name.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>names</b></code> -
The status names to return information regarding. The possible
values for each name are: MESSAGES, RECENT, UIDNEXT, UIDVALIDITY,
UNSEEN.
<br /><i>
(type=Any iterable)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
A dictionary containing status information about the requested
names is returned. If the process of looking this information up
would be costly, a deferred whose callback will eventually be
passed this dictionary is returned instead.
<br /><i>
(type=<code>dict</code> or <code>Deferred</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="store"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">store</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>messages</span>,
<span class=sig-arg>flags</span>,
<span class=sig-arg>mode</span>,
<span class=sig-arg>uid</span>)</span>
</h3>
Set the flags of one or more messages.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>messages</b></code> -
The identifiers of the messages to set the flags of.
<br /><i>
(type=A MessageSet object with the list of messages
requested)</i>
<dd><code><b>flags</b></code> -
The flags to set, unset, or add.
<br /><i>
(type=sequence of <code>str</code>)</i>
<dd><code><b>mode</b></code> -
If mode is -1, these flags should be removed from the
specified messages. If mode is 1, these flags should be added to
the specified messages. If mode is 0, all existing flags should
be cleared and these flags should be added.
<br /><i>
(type=-1, 0, or 1)</i>
<dd><code><b>uid</b></code> -
If true, the IDs specified in the query are UIDs; otherwise
they are message sequence IDs.
<br /><i>
(type=<code>bool</code>)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
A <code>dict</code> mapping message sequence numbers to
sequences of <code>str</code> representing the flags set on the
message after this operation has been performed, or a
<code>Deferred</code> whose callback will be invoked with such a
<code>dict</code>.
<br /><i>
(type=<code>dict</code> or <code>Deferred</code>)</i>
</dd>
</dl>
<dl><dt><b>Raises:</b></dt>
<dd><code><b>ReadOnlyMailbox</b></code> -
Raised if this mailbox is not open for read-write.
</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:47 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>