twisted.protocols.imap4.IMAP4Client.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.IMAP4Client</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 IMAP4Client
</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.IMAP4Client.html" target="_top">no frames</a>]</font></td></tr>
</table></td>
</tr></table>
<!-- =========== START OF CLASS DESCRIPTION =========== -->
<h2 class="class">Class IMAP4Client</h2>
<pre class="base-tree">
<a href="twisted.internet.protocol.BaseProtocol.html"><code>BaseProtocol</code></a> --+
|
<a href="twisted.internet.protocol.Protocol.html"><code>Protocol</code></a> --+
|
<a href="twisted.protocols.basic.LineReceiver.html"><code>LineReceiver</code></a> --+
|
<b>IMAP4Client</b>
</pre><br />
<hr/>
IMAP4 client protocol implementation
<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><a name="__init__"></a><span class="summary-sig"><span class="summary-sig-name">__init__</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>contextFactory</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="__cbAuthenticate"></a><span class="summary-sig"><span class="summary-sig-name">__cbAuthenticate</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>caps</span>,
<span class=summary-sig-arg>secret</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="__cbAuthTLS"></a><span class="summary-sig"><span class="summary-sig-name">__cbAuthTLS</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>caps</span>,
<span class=summary-sig-arg>secret</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="__cbCapabilities"></a><span class="summary-sig"><span class="summary-sig-name">__cbCapabilities</span>(<span class=summary-sig-arg>self</span>,
(<span class=summary-sig-arg>lines</span>,
<span class=summary-sig-arg>tagline</span>))</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="__cbContinueAppend"></a><span class="summary-sig"><span class="summary-sig-name">__cbContinueAppend</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>lines</span>,
<span class=summary-sig-arg>message</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="__cbContinueAuth"></a><span class="summary-sig"><span class="summary-sig-name">__cbContinueAuth</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>rest</span>,
<span class=summary-sig-arg>scheme</span>,
<span class=summary-sig-arg>secret</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="__cbExpunge"></a><span class="summary-sig"><span class="summary-sig-name">__cbExpunge</span>(<span class=summary-sig-arg>self</span>,
(<span class=summary-sig-arg>lines</span>,
<span class=summary-sig-arg>last</span>))</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="__cbFetch"></a><span class="summary-sig"><span class="summary-sig-name">__cbFetch</span>(<span class=summary-sig-arg>self</span>,
(<span class=summary-sig-arg>lines</span>,
<span class=summary-sig-arg>last</span>))</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="__cbFetchSpecific"></a><span class="summary-sig"><span class="summary-sig-name">__cbFetchSpecific</span>(<span class=summary-sig-arg>self</span>,
(<span class=summary-sig-arg>lines</span>,
<span class=summary-sig-arg>last</span>))</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="__cbFinishAppend"></a><span class="summary-sig"><span class="summary-sig-name">__cbFinishAppend</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>foo</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="__cbList"></a><span class="summary-sig"><span class="summary-sig-name">__cbList</span>(<span class=summary-sig-arg>self</span>,
(<span class=summary-sig-arg>lines</span>,
<span class=summary-sig-arg>last</span>),
<span class=summary-sig-arg>command</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="__cbLoginCaps"></a><span class="summary-sig"><span class="summary-sig-name">__cbLoginCaps</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>capabilities</span>,
<span class=summary-sig-arg>username</span>,
<span class=summary-sig-arg>password</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="__cbLoginTLS"></a><span class="summary-sig"><span class="summary-sig-name">__cbLoginTLS</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>result</span>,
<span class=summary-sig-arg>username</span>,
<span class=summary-sig-arg>password</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="__cbLogout"></a><span class="summary-sig"><span class="summary-sig-name">__cbLogout</span>(<span class=summary-sig-arg>self</span>,
(<span class=summary-sig-arg>lines</span>,
<span class=summary-sig-arg>tagline</span>))</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="__cbNamespace"></a><span class="summary-sig"><span class="summary-sig-name">__cbNamespace</span>(<span class=summary-sig-arg>self</span>,
(<span class=summary-sig-arg>lines</span>,
<span class=summary-sig-arg>last</span>))</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="__cbNoop"></a><span class="summary-sig"><span class="summary-sig-name">__cbNoop</span>(<span class=summary-sig-arg>self</span>,
(<span class=summary-sig-arg>lines</span>,
<span class=summary-sig-arg>tagline</span>))</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="__cbSearch"></a><span class="summary-sig"><span class="summary-sig-name">__cbSearch</span>(<span class=summary-sig-arg>self</span>,
(<span class=summary-sig-arg>lines</span>,
<span class=summary-sig-arg>end</span>))</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="__cbSelect"></a><span class="summary-sig"><span class="summary-sig-name">__cbSelect</span>(<span class=summary-sig-arg>self</span>,
(<span class=summary-sig-arg>lines</span>,
<span class=summary-sig-arg>tagline</span>),
<span class=summary-sig-arg>rw</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="__cbStatus"></a><span class="summary-sig"><span class="summary-sig-name">__cbStatus</span>(<span class=summary-sig-arg>self</span>,
(<span class=summary-sig-arg>lines</span>,
<span class=summary-sig-arg>last</span>))</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="__ebLoginCaps"></a><span class="summary-sig"><span class="summary-sig-name">__ebLoginCaps</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>failure</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="__ebLoginTLS"></a><span class="summary-sig"><span class="summary-sig-name">__ebLoginTLS</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>failure</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="_defaultHandler"></a><span class="summary-sig"><span class="summary-sig-name">_defaultHandler</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>tag</span>,
<span class=summary-sig-arg>rest</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="_extraInfo"></a><span class="summary-sig"><span class="summary-sig-name">_extraInfo</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>lines</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="_fetch"></a><span class="summary-sig"><span class="summary-sig-name">_fetch</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>messages</span>,
<span class=summary-sig-arg>useUID</span>,
<span class="summary-sig-kwarg">**terms</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="_flushQueue"></a><span class="summary-sig"><span class="summary-sig-name">_flushQueue</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="_getContextFactory"></a><span class="summary-sig"><span class="summary-sig-name">_getContextFactory</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="_regularDispatch"></a><span class="summary-sig"><span class="summary-sig-name">_regularDispatch</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>line</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="_setupForLiteral"></a><span class="summary-sig"><span class="summary-sig-name">_setupForLiteral</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>rest</span>,
<span class=summary-sig-arg>octets</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="_startedTLS"></a><span class="summary-sig"><span class="summary-sig-name">_startedTLS</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>result</span>,
<span class=summary-sig-arg>context</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="_store"></a><span class="summary-sig"><span class="summary-sig-name">_store</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>messages</span>,
<span class=summary-sig-arg>cmd</span>,
<span class=summary-sig-arg>flags</span>,
<span class=summary-sig-arg>uid</span>)</span></code>
</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.IMAP4Client.html#addFlags" class="summary-sig-name"><code>addFlags</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>silent</span>,
<span class=summary-sig-arg>uid</span>)</span></code>
<br />
Add to the set flags for one or more messages.</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.IMAP4Client.html#append" class="summary-sig-name"><code>append</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>mailbox</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 the currently selected mailbox</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.IMAP4Client.html#authenticate" class="summary-sig-name"><code>authenticate</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>secret</span>)</span></code>
<br />
Attempt to enter the authenticated state with the server</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.IMAP4Client.html#check" class="summary-sig-name"><code>check</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Tell the server to perform a checkpoint</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.IMAP4Client.html#close" class="summary-sig-name"><code>close</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Return the connection to the Authenticated state.</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.IMAP4Client.html#copy" class="summary-sig-name"><code>copy</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>messages</span>,
<span class=summary-sig-arg>mailbox</span>,
<span class=summary-sig-arg>uid</span>)</span></code>
<br />
Copy the specified messages to the specified mailbox.</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.IMAP4Client.html#create" class="summary-sig-name"><code>create</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>name</span>)</span></code>
<br />
Create a new mailbox on the server</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.IMAP4Client.html#delete" class="summary-sig-name"><code>delete</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>name</span>)</span></code>
<br />
Delete a mailbox</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="dispatchCommand"></a><span class="summary-sig"><span class="summary-sig-name">dispatchCommand</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>tag</span>,
<span class=summary-sig-arg>rest</span>)</span></code>
</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.IMAP4Client.html#examine" class="summary-sig-name"><code>examine</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>mailbox</span>)</span></code>
<br />
Select a mailbox in read-only mode</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.IMAP4Client.html#expunge" class="summary-sig-name"><code>expunge</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Return the connection to the Authenticate state.</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.IMAP4Client.html#fetchAll" class="summary-sig-name"><code>fetchAll</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 several different fields of one or more messages</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.IMAP4Client.html#fetchBody" class="summary-sig-name"><code>fetchBody</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 body text of one or more messages</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.IMAP4Client.html#fetchBodyStructure" class="summary-sig-name"><code>fetchBodyStructure</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 the structure of the body of one or more messages</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.IMAP4Client.html#fetchEnvelope" class="summary-sig-name"><code>fetchEnvelope</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 the envelope data for one or more messages</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.IMAP4Client.html#fetchFast" class="summary-sig-name"><code>fetchFast</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 several different fields of one or more messages</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.IMAP4Client.html#fetchFlags" class="summary-sig-name"><code>fetchFlags</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 the flags for one or more messages</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.IMAP4Client.html#fetchFull" class="summary-sig-name"><code>fetchFull</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 several different fields of one or more messages</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.IMAP4Client.html#fetchHeaders" class="summary-sig-name"><code>fetchHeaders</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 headers of one or more messages</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.IMAP4Client.html#fetchInternalDate" class="summary-sig-name"><code>fetchInternalDate</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 the internal date associated with one or more messages</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.IMAP4Client.html#fetchMessage" class="summary-sig-name"><code>fetchMessage</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 entire messages</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.IMAP4Client.html#fetchSimplifiedBody" class="summary-sig-name"><code>fetchSimplifiedBody</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 the simplified body structure of one or more messages</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.IMAP4Client.html#fetchSize" class="summary-sig-name"><code>fetchSize</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 the size, in octets, of one or more messages</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.IMAP4Client.html#fetchSpecific" class="summary-sig-name"><code>fetchSpecific</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>messages</span>,
<span class=summary-sig-arg>uid</span>,
<span class=summary-sig-arg>headerType</span>,
<span class=summary-sig-arg>headerNumber</span>,
<span class=summary-sig-arg>headerArgs</span>,
<span class=summary-sig-arg>peek</span>,
<span class=summary-sig-arg>offset</span>,
<span class=summary-sig-arg>length</span>)</span></code>
<br />
Retrieve a specific section of one or more messages</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.IMAP4Client.html#fetchUID" class="summary-sig-name"><code>fetchUID</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 the unique identifier for 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.imap4.IMAP4Client.html#flagsChanged" class="summary-sig-name"><code>flagsChanged</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>newFlags</span>)</span></code>
<br />
Override me</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.IMAP4Client.html#getCapabilities" class="summary-sig-name"><code>getCapabilities</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>useCache</span>)</span></code>
<br />
Request the capabilities available on this server.</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.IMAP4Client.html#lineReceived" class="summary-sig-name"><code>lineReceived</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>line</span>)</span></code>
<br />
Override this for when each line is received.</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.IMAP4Client.html#list" class="summary-sig-name"><code>list</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>reference</span>,
<span class=summary-sig-arg>wildcard</span>)</span></code>
<br />
List a subset of the available mailboxes</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.IMAP4Client.html#login" class="summary-sig-name"><code>login</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>username</span>,
<span class=summary-sig-arg>password</span>)</span></code>
<br />
Authenticate with the server using a username and password</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.IMAP4Client.html#logout" class="summary-sig-name"><code>logout</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Inform the server that we are done with the connection.</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.IMAP4Client.html#lsub" class="summary-sig-name"><code>lsub</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>reference</span>,
<span class=summary-sig-arg>wildcard</span>)</span></code>
<br />
List a subset of the subscribed available mailboxes</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="makeTag"></a><span class="summary-sig"><span class="summary-sig-name">makeTag</span>(<span class=summary-sig-arg>self</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> Any object which implements <code>write(string)</code> and
<code>seek(int, int)</code>
</font></td>
<td><code><span class="summary-sig"><a href="twisted.protocols.imap4.IMAP4Client.html#messageFile" class="summary-sig-name"><code>messageFile</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>octets</span>)</span></code>
<br />
Create a file to which an incoming message may be written.</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.IMAP4Client.html#modeChanged" class="summary-sig-name"><code>modeChanged</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>writeable</span>)</span></code>
<br />
Override me</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.IMAP4Client.html#namespace" class="summary-sig-name"><code>namespace</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Retrieve information about the namespaces available to this account
This command is allowed in the Authenticated and Selected states.</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.IMAP4Client.html#newMessages" class="summary-sig-name"><code>newMessages</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>exists</span>,
<span class=summary-sig-arg>recent</span>)</span></code>
<br />
Override me</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.IMAP4Client.html#noop" class="summary-sig-name"><code>noop</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Perform no operation.</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.IMAP4Client.html#rawDataReceived" class="summary-sig-name"><code>rawDataReceived</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>data</span>)</span></code>
<br />
Override this for when raw data is received.</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.IMAP4Client.html#registerAuthenticator" class="summary-sig-name"><code>registerAuthenticator</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>auth</span>)</span></code>
<br />
Register a new form of authentication</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.IMAP4Client.html#removeFlags" class="summary-sig-name"><code>removeFlags</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>silent</span>,
<span class=summary-sig-arg>uid</span>)</span></code>
<br />
Remove from the set flags for one or more messages.</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.IMAP4Client.html#rename" class="summary-sig-name"><code>rename</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>oldname</span>,
<span class=summary-sig-arg>newname</span>)</span></code>
<br />
Rename a mailbox</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="response_AUTH"></a><span class="summary-sig"><span class="summary-sig-name">response_AUTH</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>tag</span>,
<span class=summary-sig-arg>rest</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="response_UNAUTH"></a><span class="summary-sig"><span class="summary-sig-name">response_UNAUTH</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>tag</span>,
<span class=summary-sig-arg>rest</span>)</span></code>
</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.IMAP4Client.html#search" class="summary-sig-name"><code>search</code></a>(<span class=summary-sig-arg>self</span>,
<span class="summary-sig-vararg">*queries</span>,
<span class="summary-sig-kwarg">**kwarg</span>)</span></code>
<br />
Search messages in the currently selected mailbox</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.IMAP4Client.html#select" class="summary-sig-name"><code>select</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>mailbox</span>)</span></code>
<br />
Select a mailbox</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="sendCommand"></a><span class="summary-sig"><span class="summary-sig-name">sendCommand</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>cmd</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="twisted.protocols.imap4.IMAP4Client.html#serverGreeting" class="summary-sig-name"><code>serverGreeting</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>caps</span>)</span></code>
<br />
Called when the server has sent us a greeting.</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.IMAP4Client.html#setFlags" class="summary-sig-name"><code>setFlags</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>silent</span>,
<span class=summary-sig-arg>uid</span>)</span></code>
<br />
Set the flags for one or more messages.</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.IMAP4Client.html#status" class="summary-sig-name"><code>status</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>mailbox</span>,
<span class="summary-sig-vararg">*names</span>)</span></code>
<br />
Retrieve the status of the given mailbox</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.IMAP4Client.html#subscribe" class="summary-sig-name"><code>subscribe</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>name</span>)</span></code>
<br />
Add a mailbox to the subscription list</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.IMAP4Client.html#unsubscribe" class="summary-sig-name"><code>unsubscribe</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>name</span>)</span></code>
<br />
Remove a mailbox from the subscription list</td></tr>
<tr bgcolor="#e8f0f8" class="group">
<th colspan="2"> Inherited from LineReceiver</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.basic.LineReceiver.html#clearLineBuffer" class="summary-sig-name"><code>clearLineBuffer</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Clear buffered data.</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.basic.LineReceiver.html#dataReceived" class="summary-sig-name"><code>dataReceived</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>data</span>)</span></code>
<br />
Protocol.dataReceived.</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.basic.LineReceiver.html#lineLengthExceeded" class="summary-sig-name"><code>lineLengthExceeded</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>line</span>)</span></code>
<br />
Called when the maximum line length has been reached.</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.basic.LineReceiver.html#sendLine" class="summary-sig-name"><code>sendLine</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>line</span>)</span></code>
<br />
Sends a line to the other end of the connection.</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.basic.LineReceiver.html#setLineMode" class="summary-sig-name"><code>setLineMode</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>extra</span>)</span></code>
<br />
Sets the line-mode of this receiver.</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.basic.LineReceiver.html#setRawMode" class="summary-sig-name"><code>setRawMode</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Sets the raw mode of this receiver.</td></tr>
<tr bgcolor="#e8f0f8" class="group">
<th colspan="2"> Inherited from Protocol</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.internet.protocol.Protocol.html#connectionFailed" class="summary-sig-name"><code>connectionFailed</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
(Deprecated)</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.internet.protocol.Protocol.html#connectionLost" class="summary-sig-name"><code>connectionLost</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>reason</span>)</span></code>
<br />
Called when the connection is shut down.</td></tr>
<tr bgcolor="#e8f0f8" class="group">
<th colspan="2"> Inherited from BaseProtocol</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.internet.protocol.BaseProtocol.html#connectionMade" class="summary-sig-name"><code>connectionMade</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Called when a connection is made.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.internet.protocol.BaseProtocol.html#makeConnection" class="summary-sig-name"><code>makeConnection</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>transport</span>)</span></code>
<br />
Make a connection to a transport and a server.</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>NoneType</code></font></td>
<td><b><a href="twisted.protocols.imap4.IMAP4Client.html#state"><code>state</code></a></b>: A string representing the state the connection is currently in.</td></tr>
</table><br />
<!-- =========== START OF CLASS VARIABLE SUMMARY =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Class Variable Summary</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>tuple</code></font></td>
<td><b><a href="twisted.protocols.imap4.IMAP4Client.html#__implements__"><code>__implements__</code></a></b> = <span title="(<class twisted.protocols.imap4.IMailboxListener at 0x8871e0c>,)"><code>(<class twisted.protocols.imap4.IMailbo<span class="variable-ellipsis">...</span></code>
</span></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>NoneType</code></font></td>
<td><b><a href="twisted.protocols.imap4.IMAP4Client.html#_capCache"><code>_capCache</code></a></b> = <span title="None">None </span></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td>
<td><b><a href="twisted.protocols.imap4.IMAP4Client.html#_memoryFileLimit"><code>_memoryFileLimit</code></a></b> = <span title="10485760">10485760 </span></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>NoneType</code></font></td>
<td><b><a href="twisted.protocols.imap4.IMAP4Client.html#authenticators"><code>authenticators</code></a></b> = <span title="None">None </span></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>NoneType</code></font></td>
<td><b><a href="twisted.protocols.imap4.IMAP4Client.html#context"><code>context</code></a></b> = <span title="None">None </span></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>NoneType</code></font></td>
<td><b><a href="twisted.protocols.imap4.IMAP4Client.html#queued"><code>queued</code></a></b> = <span title="None">None </span></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td>
<td><b><a href="twisted.protocols.imap4.IMAP4Client.html#startedTLS"><code>startedTLS</code></a></b> = <span title="0">0 </span></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>tuple</code></font></td>
<td><b><a href="twisted.protocols.imap4.IMAP4Client.html#STATUS_CODES"><code>STATUS_CODES</code></a></b> = <span title="('OK', 'NO', 'BAD', 'PREAUTH', 'BYE')"><code>('OK', 'NO', 'BAD', 'PREAUTH', 'BYE') </code>
</span></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>dict</code></font></td>
<td><b><a href="twisted.protocols.imap4.IMAP4Client.html#STATUS_TRANSFORMATIONS"><code>STATUS_TRANSFORMATIONS</code></a></b> = <span title="{'MESSAGES': <type 'int'>, 'UNSEEN': <type 'int'>, 'RECENT': <type 'int'>}"><code>{'MESSAGES': <type 'int'>, 'UNS<span class="variable-ellipsis">...</span></code>
</span></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td>
<td><b><a href="twisted.protocols.imap4.IMAP4Client.html#tagID"><code>tagID</code></a></b> = <span title="1">1 </span></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>NoneType</code></font></td>
<td><b><a href="twisted.protocols.imap4.IMAP4Client.html#tags"><code>tags</code></a></b> = <span title="None">None </span></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>NoneType</code></font></td>
<td><b><a href="twisted.protocols.imap4.IMAP4Client.html#waiting"><code>waiting</code></a></b> = <span title="None">None </span></td></tr>
<tr bgcolor="#e8f0f8" class="group">
<th colspan="2"> Inherited from LineReceiver</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>str</code></font></td>
<td><b><a href="twisted.protocols.basic.LineReceiver.html#__buffer"><code>_LineReceiver__buffer</code></a></b> = <span title="''"><code><span class="variable-quote">'</span><span class="variable-quote">'</span> </code>
</span></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>str</code></font></td>
<td><b><a href="twisted.protocols.basic.LineReceiver.html#delimiter"><code>delimiter</code></a></b>: The line-ending delimiter to use.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td>
<td><b><a href="twisted.protocols.basic.LineReceiver.html#line_mode"><code>line_mode</code></a></b> = <span title="1">1 </span></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td>
<td><b><a href="twisted.protocols.basic.LineReceiver.html#MAX_LENGTH"><code>MAX_LENGTH</code></a></b>: The maximum length of a line to allow (If a sent line is longer than
this, the connection is dropped).</td></tr>
<tr bgcolor="#e8f0f8" class="group">
<th colspan="2"> Inherited from BaseProtocol</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td>
<td><b><a href="twisted.internet.protocol.BaseProtocol.html#connected"><code>connected</code></a></b> = <span title="0">0 </span></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>NoneType</code></font></td>
<td><b><a href="twisted.internet.protocol.BaseProtocol.html#transport"><code>transport</code></a></b> = <span title="None">None </span></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="addFlags"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">addFlags</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>messages</span>,
<span class=sig-arg>flags</span>,
<span class=sig-arg>silent</span>=<span class=sig-default>1</span>,
<span class=sig-arg>uid</span>=<span class=sig-default>0</span>)</span>
</h3>
<p>Add to the set flags for one or more messages.</p>
This command is allowed in the Selected state.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>messages</b></code> -
A message sequence set
<br /><i>
(type=<code>MessageSet</code> or <code>str</code>)</i>
<dd><code><b>flags</b></code> -
The flags to set
<br /><i>
(type=Any iterable of <code>str</code>)</i>
<dd><code><b>silent</b></code> -
If true, cause the server to supress its verbose response.
<br /><i>
(type=<code>bool</code>)</i>
<dd><code><b>uid</b></code> -
Indicates whether the message sequence set is of message
numbers or of unique message IDs.
<br /><i>
(type=<code>bool</code>)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
A deferred whose callback is invoked with a list of the the
server's responses (<code>[]</code> if <code>silent</code> is
true) or whose errback is invoked if there is an error.
<br /><i>
(type=<code>Deferred</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="append"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">append</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>mailbox</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>
<p>Add the given message to the currently selected mailbox</p>
This command is allowed in the Authenticated and Selected
states.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>mailbox</b></code> -
The mailbox to which to add this message.
<br /><i>
(type=<code>str</code>)</i>
<dd><code><b>message</b></code> -
The message to add, in RFC822 format.
<br /><i>
(type=Any file-like object)</i>
<dd><code><b>flags</b></code> -
The flags to associated with this message.
<br /><i>
(type=Any iterable of <code>str</code>)</i>
<dd><code><b>date</b></code> -
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 when this command
succeeds or whose errback is invoked if it fails.
<br /><i>
(type=<code>Deferred</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="authenticate"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">authenticate</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>secret</span>)</span>
</h3>
<p>Attempt to enter the authenticated state with the server</p>
This command is allowed in the Non-Authenticated state.
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
A deferred whose callback is invoked if the authentication
succeeds and whose errback will be invoked otherwise.
<br /><i>
(type=<code>Deferred</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="check"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">check</span>(<span class=sig-arg>self</span>)</span>
</h3>
<p>Tell the server to perform a checkpoint</p>
This command is allowed in the Selected state.
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
A deferred whose callback is invoked when this command
succeeds or whose errback is invoked if it fails.
<br /><i>
(type=<code>Deferred</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="close"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">close</span>(<span class=sig-arg>self</span>)</span>
</h3>
<p>Return the connection to the Authenticated state.</p>
<p>This command is allowed in the Selected state.</p>
Issuing this command will also remove all messages flagged \Deleted
from the selected mailbox if it is opened in read-write mode, otherwise
it indicates success by no messages are removed.
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
A deferred whose callback is invoked when the command
completes successfully or whose errback is invoked if it
fails.
<br /><i>
(type=<code>Deferred</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="copy"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">copy</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>messages</span>,
<span class=sig-arg>mailbox</span>,
<span class=sig-arg>uid</span>)</span>
</h3>
<p>Copy the specified messages to the specified mailbox.</p>
This command is allowed in the Selected state.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>messages</b></code> -
A message sequence set
<br /><i>
(type=<code>str</code>)</i>
<dd><code><b>mailbox</b></code> -
The mailbox to which to copy the messages
<br /><i>
(type=<code>str</code>)</i>
<dd><code><b>uid</b></code> -
If true, the <code>messages</code> refers to message UIDs,
rather than message sequence numbers.
<br /><i>
(type=<code>bool</code>)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
A deferred whose callback is invoked with a true value when
the copy is successful, or whose errback is invoked if there is
an error.
<br /><i>
(type=<code>Deferred</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="create"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">create</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>name</span>)</span>
</h3>
<p>Create a new mailbox on the server</p>
This command is allowed in the Authenticated and Selected
states.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>name</b></code> -
The name of the mailbox to create.
<br /><i>
(type=<code>str</code>)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
A deferred whose callback is invoked if the mailbox creation
is successful and whose errback is invoked otherwise.
<br /><i>
(type=<code>Deferred</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="delete"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">delete</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>name</span>)</span>
</h3>
<p>Delete a mailbox</p>
This command is allowed in the Authenticated and Selected
states.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>name</b></code> -
The name of the mailbox to delete.
<br /><i>
(type=<code>str</code>)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
A deferred whose calblack is invoked if the mailbox is deleted
successfully and whose errback is invoked otherwise.
<br /><i>
(type=<code>Deferred</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="examine"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">examine</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>mailbox</span>)</span>
</h3>
<p>Select a mailbox in read-only mode</p>
This command is allowed in the Authenticated and Selected
states.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>mailbox</b></code> -
The name of the mailbox to examine
<br /><i>
(type=<code>str</code>)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
A deferred whose callback is invoked with mailbox information
if the examine is successful and whose errback is invoked
otherwise. Mailbox information consists of a dictionary with the
following keys and values:
<pre class="literalblock">
'FLAGS': A list of strings containing the flags settable on
messages in this mailbox.
'EXISTS': An integer indicating the number of messages in this
mailbox.
'RECENT': An integer indicating the number of "recent"
messages in this mailbox.
'UNSEEN': An integer indicating the number of messages not
flagged \Seen in this mailbox.
'PERMANENTFLAGS': A list of strings containing the flags that
can be permanently set on messages in this mailbox.
'UIDVALIDITY': An integer uniquely identifying this mailbox.
</pre>
<br /><i>
(type=<code>Deferred</code>)</i>
</dd>
</dl>
</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>
<p>Return the connection to the Authenticate state.</p>
<p>This command is allowed in the Selected state.</p>
Issuing this command will perform the same actions as issuing the
close command, but will also generate an 'expunge' response for every
message deleted.
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
A deferred whose callback is invoked with a list of the
'expunge' responses when this command is successful or whose
errback is invoked otherwise.
<br /><i>
(type=<code>Deferred</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="fetchAll"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">fetchAll</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>messages</span>,
<span class=sig-arg>uid</span>=<span class=sig-default>0</span>)</span>
</h3>
<p>Retrieve several different fields of one or more messages</p>
This command is allowed in the Selected state. This is equivalent to
issuing all of the <code>fetchFlags</code>,
<code>fetchInternalDate</code>, <code>fetchSize</code>, and
<code>fetchEnvelope</code> functions.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>messages</b></code> -
A message sequence set
<br /><i>
(type=<code>MessageSet</code> or <code>str</code>)</i>
<dd><code><b>uid</b></code> -
Indicates whether the message sequence set is of message
numbers or of unique message IDs.
<br /><i>
(type=<code>bool</code>)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
A deferred whose callback is invoked with a dict mapping
message numbers to dict of the retrieved data values, or whose
errback is invoked if there is an error. They dictionary keys are
"flags", "date", "size", and
"envelope".
<br /><i>
(type=<code>Deferred</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="fetchBody"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">fetchBody</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>messages</span>,
<span class=sig-arg>uid</span>=<span class=sig-default>0</span>)</span>
</h3>
<p>Retrieve body text of one or more messages</p>
This command is allowed in the Selected state.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>messages</b></code> -
A message sequence set
<br /><i>
(type=<code>MessageSet</code> or <code>str</code>)</i>
<dd><code><b>uid</b></code> -
Indicates whether the message sequence set is of message
numbers or of unique message IDs.
<br /><i>
(type=<code>bool</code>)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
A deferred whose callback is invoked with a dict mapping
message numbers to file-like objects containing body text, or
whose errback is invoked if there is an error.
<br /><i>
(type=<code>Deferred</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="fetchBodyStructure"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">fetchBodyStructure</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>messages</span>,
<span class=sig-arg>uid</span>=<span class=sig-default>0</span>)</span>
</h3>
<p>Retrieve the structure of the body of one or more messages</p>
This command is allowed in the Selected state.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>messages</b></code> -
The messages for which to retrieve body structure data.
<br /><i>
(type=<code>MessageSet</code> or <code>str</code>)</i>
<dd><code><b>uid</b></code> -
Indicates whether the message sequence set is of message
numbers or of unique message IDs.
<br /><i>
(type=<code>bool</code>)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
A deferred whose callback is invoked with a dict mapping
message numbers to body structure data, or whose errback is
invoked if there is an error. Body structure data describes the
MIME-IMB format of a message and consists of a sequence of mime
type, mime subtype, parameters, content id, description,
encoding, and size. The fields following the size field are
variable: if the mime type/subtype is message/rfc822, the
contained message's envelope information, body structure data,
and number of lines of text; if the mime type is text, the number
of lines of text. Extension fields may also be included; if
present, they are: the MD5 hash of the body, body disposition,
body language.
<br /><i>
(type=<code>Deferred</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="fetchEnvelope"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">fetchEnvelope</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>messages</span>,
<span class=sig-arg>uid</span>=<span class=sig-default>0</span>)</span>
</h3>
<p>Retrieve the envelope data for one or more messages</p>
This command is allowed in the Selected state.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>messages</b></code> -
The messages for which to retrieve envelope data.
<br /><i>
(type=<code>MessageSet</code> or <code>str</code>)</i>
<dd><code><b>uid</b></code> -
Indicates whether the message sequence set is of message
numbers or of unique message IDs.
<br /><i>
(type=<code>bool</code>)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
A deferred whose callback is invoked with a dict mapping
message numbers to envelope data, or whose errback is invoked if
there is an error. Envelope data consists of a sequence of the
date, subject, from, sender, reply-to, to, cc, bcc, in-reply-to,
and message-id header fields. The date, subject, in-reply-to, and
message-id fields are strings, while the from, sender, reply-to,
to, cc, and bcc fields contain address data. Address data
consists of a sequence of name, source route, mailbox name, and
hostname. Fields which are not present for a particular address
may be <code>None</code>.
<br /><i>
(type=<code>Deferred</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="fetchFast"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">fetchFast</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>messages</span>,
<span class=sig-arg>uid</span>=<span class=sig-default>0</span>)</span>
</h3>
<p>Retrieve several different fields of one or more messages</p>
This command is allowed in the Selected state. This is equivalent to
issuing all of the <code>fetchFlags</code>,
<code>fetchInternalDate</code>, and <code>fetchSize</code>
functions.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>messages</b></code> -
A message sequence set
<br /><i>
(type=<code>MessageSet</code> or <code>str</code>)</i>
<dd><code><b>uid</b></code> -
Indicates whether the message sequence set is of message
numbers or of unique message IDs.
<br /><i>
(type=<code>bool</code>)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
A deferred whose callback is invoked with a dict mapping
message numbers to dict of the retrieved data values, or whose
errback is invoked if there is an error. They dictionary keys are
"flags", "date", and "size".
<br /><i>
(type=<code>Deferred</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="fetchFlags"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">fetchFlags</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>messages</span>,
<span class=sig-arg>uid</span>=<span class=sig-default>0</span>)</span>
</h3>
<p>Retrieve the flags for one or more messages</p>
This command is allowed in the Selected state.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>messages</b></code> -
The messages for which to retrieve flags.
<br /><i>
(type=<code>MessageSet</code> or <code>str</code>)</i>
<dd><code><b>uid</b></code> -
Indicates whether the message sequence set is of message
numbers or of unique message IDs.
<br /><i>
(type=<code>bool</code>)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
A deferred whose callback is invoked with a dict mapping
message numbers to lists of flags, or whose errback is invoked if
there is an error.
<br /><i>
(type=<code>Deferred</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="fetchFull"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">fetchFull</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>messages</span>,
<span class=sig-arg>uid</span>=<span class=sig-default>0</span>)</span>
</h3>
<p>Retrieve several different fields of one or more messages</p>
This command is allowed in the Selected state. This is equivalent to
issuing all of the <code>fetchFlags</code>,
<code>fetchInternalDate</code>, <code>fetchSize</code>,
<code>fetchEnvelope</code>, and <code>fetchSimplifiedBody</code>
functions.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>messages</b></code> -
A message sequence set
<br /><i>
(type=<code>MessageSet</code> or <code>str</code>)</i>
<dd><code><b>uid</b></code> -
Indicates whether the message sequence set is of message
numbers or of unique message IDs.
<br /><i>
(type=<code>bool</code>)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
A deferred whose callback is invoked with a dict mapping
message numbers to dict of the retrieved data values, or whose
errback is invoked if there is an error. They dictionary keys are
"flags", "date", "size",
"envelope", and "body".
<br /><i>
(type=<code>Deferred</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="fetchHeaders"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">fetchHeaders</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>messages</span>,
<span class=sig-arg>uid</span>=<span class=sig-default>0</span>)</span>
</h3>
<p>Retrieve headers of one or more messages</p>
This command is allowed in the Selected state.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>messages</b></code> -
A message sequence set
<br /><i>
(type=<code>MessageSet</code> or <code>str</code>)</i>
<dd><code><b>uid</b></code> -
Indicates whether the message sequence set is of message
numbers or of unique message IDs.
<br /><i>
(type=<code>bool</code>)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
A deferred whose callback is invoked with a dict mapping
message numbers to dicts of message headers, or whose errback is
invoked if there is an error.
<br /><i>
(type=<code>Deferred</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="fetchInternalDate"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">fetchInternalDate</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>messages</span>,
<span class=sig-arg>uid</span>=<span class=sig-default>0</span>)</span>
</h3>
<p>Retrieve the internal date associated with one or more messages</p>
This command is allowed in the Selected state.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>messages</b></code> -
The messages for which to retrieve the internal date.
<br /><i>
(type=<code>MessageSet</code> or <code>str</code>)</i>
<dd><code><b>uid</b></code> -
Indicates whether the message sequence set is of message
numbers or of unique message IDs.
<br /><i>
(type=<code>bool</code>)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
A deferred whose callback is invoked with a dict mapping
message numbers to date strings, or whose errback is invoked if
there is an error. Date strings take the format of
"day-month-year time timezone".
<br /><i>
(type=<code>Deferred</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="fetchMessage"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">fetchMessage</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>messages</span>,
<span class=sig-arg>uid</span>=<span class=sig-default>0</span>)</span>
</h3>
<p>Retrieve one or more entire messages</p>
This command is allowed in the Selected state.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>messages</b></code> -
A message sequence set
<br /><i>
(type=<code>MessageSet</code> or <code>str</code>)</i>
<dd><code><b>uid</b></code> -
Indicates whether the message sequence set is of message
numbers or of unique message IDs.
<br /><i>
(type=<code>bool</code>)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
A deferred whose callback is invoked with a dict mapping
message objects (as returned by self.messageFile(), file objects
by default), or whose errback is invoked if there is an
error.
<br /><i>
(type=<code>Deferred</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="fetchSimplifiedBody"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">fetchSimplifiedBody</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>messages</span>,
<span class=sig-arg>uid</span>=<span class=sig-default>0</span>)</span>
</h3>
<p>Retrieve the simplified body structure of one or more messages</p>
This command is allowed in the Selected state.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>messages</b></code> -
A message sequence set
<br /><i>
(type=<code>MessageSet</code> or <code>str</code>)</i>
<dd><code><b>uid</b></code> -
Indicates whether the message sequence set is of message
numbers or of unique message IDs.
<br /><i>
(type=<code>bool</code>)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
A deferred whose callback is invoked with a dict mapping
message numbers to body data, or whose errback is invoked if
there is an error. The simplified body structure is the same as
the body structure, except that extension fields will never be
present.
<br /><i>
(type=<code>Deferred</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="fetchSize"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">fetchSize</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>messages</span>,
<span class=sig-arg>uid</span>=<span class=sig-default>0</span>)</span>
</h3>
<p>Retrieve the size, in octets, of one or more messages</p>
This command is allowed in the Selected state.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>messages</b></code> -
A message sequence set
<br /><i>
(type=<code>MessageSet</code> or <code>str</code>)</i>
<dd><code><b>uid</b></code> -
Indicates whether the message sequence set is of message
numbers or of unique message IDs.
<br /><i>
(type=<code>bool</code>)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
A deferred whose callback is invoked with a dict mapping
message numbers to sizes, or whose errback is invoked if there is
an error.
<br /><i>
(type=<code>Deferred</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="fetchSpecific"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">fetchSpecific</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>messages</span>,
<span class=sig-arg>uid</span>=<span class=sig-default>0</span>,
<span class=sig-arg>headerType</span>=<span class=sig-default>None</span>,
<span class=sig-arg>headerNumber</span>=<span class=sig-default>None</span>,
<span class=sig-arg>headerArgs</span>=<span class=sig-default>None</span>,
<span class=sig-arg>peek</span>=<span class=sig-default>None</span>,
<span class=sig-arg>offset</span>=<span class=sig-default>None</span>,
<span class=sig-arg>length</span>=<span class=sig-default>None</span>)</span>
</h3>
Retrieve a specific section of one or more messages
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>messages</b></code> -
A message sequence set
<br /><i>
(type=<code>MessageSet</code> or <code>str</code>)</i>
<dd><code><b>uid</b></code> -
Indicates whether the message sequence set is of message
numbers or of unique message IDs.
<br /><i>
(type=<code>bool</code>)</i>
<dd><code><b>headerType</b></code> -
If specified, must be one of HEADER, HEADER.FIELDS,
HEADER.FIELDS.NOT, MIME, or TEXT, and will determine which part
of the message is retrieved. For HEADER.FIELDS and
HEADER.FIELDS.NOT, <code>headerArgs</code> must be a sequence of
header names. For MIME, <code>headerNumber</code> must be
specified.
<br /><i>
(type=<code>str</code>)</i>
<dd><code><b>headerNumber</b></code> -
The nested rfc822 index specifying the entity to retrieve. For
example, <code>1</code> retrieves the first entity of the
message, and <code>(2, 1, 3</code>) retrieves the 3rd entity
inside the first entity inside the second entity of the
message.
<br /><i>
(type=<code>int</code> or <code>int</code> sequence)</i>
<dd><code><b>headerArgs</b></code> -
If <code>headerType</code> is HEADER.FIELDS, these are the
headers to retrieve. If it is HEADER.FIELDS.NOT, these are the
headers to exclude from retrieval.
<br /><i>
(type=A sequence of <code>str</code>)</i>
<dd><code><b>peek</b></code> -
If true, cause the server to not set the \Seen flag on this
message as a result of this command.
<br /><i>
(type=<code>bool</code>)</i>
<dd><code><b>offset</b></code> -
The number of octets at the beginning of the result to
skip.
<br /><i>
(type=<code>int</code>)</i>
<dd><code><b>length</b></code> -
The number of octets to retrieve.
<br /><i>
(type=<code>int</code>)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
A deferred whose callback is invoked with a mapping of message
numbers to retrieved data, or whose errback is invoked if there
is an error.
<br /><i>
(type=<code>Deferred</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="fetchUID"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">fetchUID</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>messages</span>,
<span class=sig-arg>uid</span>=<span class=sig-default>0</span>)</span>
</h3>
<p>Retrieve the unique identifier for one or more messages</p>
This command is allowed in the Selected state.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>messages</b></code> -
A message sequence set
<br /><i>
(type=<code>MessageSet</code> or <code>str</code>)</i>
<dd><code><b>uid</b></code> -
Indicates whether the message sequence set is of message
numbers or of unique message IDs.
<br /><i>
(type=<code>bool</code>)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
A deferred whose callback is invoked with a dict mapping
message sequence numbers to unique message identifiers, or whose
errback is invoked if there is an error.
<br /><i>
(type=<code>Deferred</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="flagsChanged"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">flagsChanged</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>newFlags</span>)</span>
</h3>
Override me
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="getCapabilities"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">getCapabilities</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>useCache</span>=<span class=sig-default>1</span>)</span>
</h3>
<p>Request the capabilities available on this server.</p>
This command is allowed in any state of connection.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>useCache</b></code> -
Specify whether to use the capability-cache or to re-retrieve
the capabilities from the server. Server capabilities should
never change, so for normal use, this flag should never be
false.
<br /><i>
(type=<code>bool</code>)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
A deferred whose callback will be invoked with a dictionary
mapping capability types to lists of supported mechanisms, or to
None if a support list is not applicable.
<br /><i>
(type=<code>Deferred</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="lineReceived"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">lineReceived</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>line</span>)</span>
</h3>
Override this for when each line is received.
<dl><dt></dt><dd>
<dl><dt><b>Overrides:</b></dt>
<dd><a href="twisted.protocols.basic.LineReceiver.html#lineReceived"><code>twisted.protocols.basic.LineReceiver.lineReceived</code></a> <i>(inherited documentation)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="list"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">list</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>reference</span>,
<span class=sig-arg>wildcard</span>)</span>
</h3>
<p>List a subset of the available mailboxes</p>
This command is allowed in the Authenticated and Selected
states.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>reference</b></code> -
The context in which to interpret <code>wildcard</code>
<br /><i>
(type=<code>str</code>)</i>
<dd><code><b>wildcard</b></code> -
The pattern of mailbox names to match, optionally including
either or both of the '*' and '%' wildcards. '*' will match zero
or more characters and cross hierarchical boundaries. '%' will
also match zero or more characters, but is limited to a single
hierarchical level.
<br /><i>
(type=<code>str</code>)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
A deferred whose callback is invoked with a list of
<code>tuple</code>s, the first element of which is a
<code>tuple</code> of mailbox flags, the second element of which
is the hierarchy delimiter for this mailbox, and the third of
which is the mailbox name; if the command is unsuccessful, the
deferred's errback is invoked instead.
<br /><i>
(type=<code>Deferred</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="login"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">login</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>username</span>,
<span class=sig-arg>password</span>)</span>
</h3>
<p>Authenticate with the server using a username and password</p>
This command is allowed in the Non-Authenticated state. If the
server supports the STARTTLS capability and our transport supports TLS,
TLS is negotiated before the login command is issued.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>username</b></code> -
The username to log in with
<br /><i>
(type=<code>str</code>)</i>
<dd><code><b>password</b></code> -
The password to log in with
<br /><i>
(type=<code>str</code>)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
A deferred whose callback is invoked if login is successful
and whose errback is invoked otherwise.
<br /><i>
(type=<code>Deferred</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="logout"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">logout</span>(<span class=sig-arg>self</span>)</span>
</h3>
<p>Inform the server that we are done with the connection.</p>
This command is allowed in any state of connection.
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
A deferred whose callback will be invoked with None when the
proper server acknowledgement has been received.
<br /><i>
(type=<code>Deferred</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="lsub"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">lsub</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>reference</span>,
<span class=sig-arg>wildcard</span>)</span>
</h3>
<p>List a subset of the subscribed available mailboxes</p>
<p>This command is allowed in the Authenticated and Selected
states.</p>
The parameters and returned object are the same as for the
<code>list</code> method, with one slight difference: Only mailboxes
which have been subscribed can be included in the resulting list.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="messageFile"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">messageFile</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>octets</span>)</span>
</h3>
Create a file to which an incoming message may be written.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>octets</b></code> -
The number of octets which will be written to the file
<br /><i>
(type=<code>int</code>)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
A file-like object
<br /><i>
(type=Any object which implements <code>write(string)</code> and
<code>seek(int, int)</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="modeChanged"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">modeChanged</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>writeable</span>)</span>
</h3>
Override me
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="namespace"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">namespace</span>(<span class=sig-arg>self</span>)</span>
</h3>
<pre class="literalblock">
Retrieve information about the namespaces available to this account
This command is allowed in the Authenticated and Selected states.
@rtype: C{Deferred}
@return: A deferred whose callback is invoked with namespace
information. An example of this information is:
[[['', '/']], [], []]
which indicates a single personal namespace called '' with '/'
as its hierarchical delimiter, and no shared or user namespaces.
</pre>
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="newMessages"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">newMessages</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>exists</span>,
<span class=sig-arg>recent</span>)</span>
</h3>
Override me
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="noop"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">noop</span>(<span class=sig-arg>self</span>)</span>
</h3>
<p>Perform no operation.</p>
This command is allowed in any state of connection.
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
A deferred whose callback will be invoked with a list of
untagged status updates the server responds with.
<br /><i>
(type=<code>Deferred</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="rawDataReceived"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">rawDataReceived</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>data</span>)</span>
</h3>
Override this for when raw data is received.
<dl><dt></dt><dd>
<dl><dt><b>Overrides:</b></dt>
<dd><a href="twisted.protocols.basic.LineReceiver.html#rawDataReceived"><code>twisted.protocols.basic.LineReceiver.rawDataReceived</code></a> <i>(inherited documentation)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="registerAuthenticator"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">registerAuthenticator</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>auth</span>)</span>
</h3>
<p>Register a new form of authentication</p>
When invoking the authenticate() method of IMAP4Client, the first
matching authentication scheme found will be used. The ordering is that
in which the server lists support authentication schemes.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>auth</b></code> -
The object to use to perform the client side of this
authentication scheme.
<br /><i>
(type=Implementor of <code>IClientAuthentication</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="removeFlags"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">removeFlags</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>messages</span>,
<span class=sig-arg>flags</span>,
<span class=sig-arg>silent</span>=<span class=sig-default>1</span>,
<span class=sig-arg>uid</span>=<span class=sig-default>0</span>)</span>
</h3>
<p>Remove from the set flags for one or more messages.</p>
This command is allowed in the Selected state.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>messages</b></code> -
A message sequence set
<br /><i>
(type=<code>MessageSet</code> or <code>str</code>)</i>
<dd><code><b>flags</b></code> -
The flags to set
<br /><i>
(type=Any iterable of <code>str</code>)</i>
<dd><code><b>silent</b></code> -
If true, cause the server to supress its verbose response.
<br /><i>
(type=<code>bool</code>)</i>
<dd><code><b>uid</b></code> -
Indicates whether the message sequence set is of message
numbers or of unique message IDs.
<br /><i>
(type=<code>bool</code>)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
A deferred whose callback is invoked with a list of the the
server's responses (<code>[]</code> if <code>silent</code> is
true) or whose errback is invoked if there is an error.
<br /><i>
(type=<code>Deferred</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="rename"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">rename</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>oldname</span>,
<span class=sig-arg>newname</span>)</span>
</h3>
<p>Rename a mailbox</p>
This command is allowed in the Authenticated and Selected
states.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>oldname</b></code> -
The current name of the mailbox to rename.
<br /><i>
(type=<code>str</code>)</i>
<dd><code><b>newname</b></code> -
The new name to give the mailbox.
<br /><i>
(type=<code>str</code>)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
A deferred whose callback is invoked if the rename is
successful and whose errback is invoked otherwise.
<br /><i>
(type=<code>Deferred</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="search"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">search</span>(<span class=sig-arg>self</span>,
<span class="sig-vararg">*queries</span>,
<span class="sig-kwarg">**kwarg</span>)</span>
</h3>
<p>Search messages in the currently selected mailbox</p>
<p>This command is allowed in the Selected state.</p>
<p>Any non-zero number of queries are accepted by this method, as
returned by the <code>Query</code>, <code>Or</code>, and
<code>Not</code> functions.</p>
One keyword argument is accepted: if uid is passed in with a
non-zero value, the server is asked to return message UIDs instead of
message sequence numbers.
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
A deferred whose callback will be invoked with a list of all
the message sequence numbers return by the search, or whose
errback will be invoked if there is an error.
<br /><i>
(type=<code>Deferred</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="select"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">select</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>mailbox</span>)</span>
</h3>
<p>Select a mailbox</p>
This command is allowed in the Authenticated and Selected
states.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>mailbox</b></code> -
The name of the mailbox to select
<br /><i>
(type=<code>str</code>)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
A deferred whose callback is invoked with mailbox information
if the select is successful and whose errback is invoked
otherwise. Mailbox information consists of a dictionary with the
following keys and values:
<pre class="literalblock">
FLAGS: A list of strings containing the flags settable on
messages in this mailbox.
EXISTS: An integer indicating the number of messages in this
mailbox.
RECENT: An integer indicating the number of "recent"
messages in this mailbox.
UNSEEN: An integer indicating the number of messages not
flagged \Seen in this mailbox.
PERMANENTFLAGS: A list of strings containing the flags that
can be permanently set on messages in this mailbox.
UIDVALIDITY: An integer uniquely identifying this mailbox.
</pre>
<br /><i>
(type=<code>Deferred</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="serverGreeting"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">serverGreeting</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>caps</span>)</span>
</h3>
Called when the server has sent us a greeting.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>caps</b></code> -
Capabilities the server advertised in its greeting.
<br /><i>
(type=<code>dict</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="setFlags"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">setFlags</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>messages</span>,
<span class=sig-arg>flags</span>,
<span class=sig-arg>silent</span>=<span class=sig-default>1</span>,
<span class=sig-arg>uid</span>=<span class=sig-default>0</span>)</span>
</h3>
<p>Set the flags for one or more messages.</p>
This command is allowed in the Selected state.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>messages</b></code> -
A message sequence set
<br /><i>
(type=<code>MessageSet</code> or <code>str</code>)</i>
<dd><code><b>flags</b></code> -
The flags to set
<br /><i>
(type=Any iterable of <code>str</code>)</i>
<dd><code><b>silent</b></code> -
If true, cause the server to supress its verbose response.
<br /><i>
(type=<code>bool</code>)</i>
<dd><code><b>uid</b></code> -
Indicates whether the message sequence set is of message
numbers or of unique message IDs.
<br /><i>
(type=<code>bool</code>)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
A deferred whose callback is invoked with a list of the the
server's responses (<code>[]</code> if <code>silent</code> is
true) or whose errback is invoked if there is an error.
<br /><i>
(type=<code>Deferred</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="status"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">status</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>mailbox</span>,
<span class="sig-vararg">*names</span>)</span>
</h3>
<p>Retrieve the status of the given mailbox</p>
This command is allowed in the Authenticated and Selected
states.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>mailbox</b></code> -
The name of the mailbox to query
<br /><i>
(type=<code>str</code>)</i>
<dd><code><b>names</b></code> -
The status names to query. These may be any number of:
MESSAGES, RECENT, UIDNEXT, UIDVALIDITY, and UNSEEN.
<br /><i>
(type=<code>str</code>)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
A deferred whose callback is invoked with the status
information if the command is successful and whose errback is
invoked otherwise.
<br /><i>
(type=<code>Deferred</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="subscribe"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">subscribe</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>name</span>)</span>
</h3>
<p>Add a mailbox to the subscription list</p>
This command is allowed in the Authenticated and Selected
states.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>name</b></code> -
The mailbox to mark as 'active' or 'subscribed'
<br /><i>
(type=<code>str</code>)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
A deferred whose callback is invoked if the subscription is
successful and whose errback is invoked otherwise.
<br /><i>
(type=<code>Deferred</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="unsubscribe"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">unsubscribe</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>name</span>)</span>
</h3>
<p>Remove a mailbox from the subscription list</p>
This command is allowed in the Authenticated and Selected
states.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>name</b></code> -
The mailbox to unsubscribe
<br /><i>
(type=<code>str</code>)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
A deferred whose callback is invoked if the unsubscription is
successful and whose errback is invoked otherwise.
<br /><i>
(type=<code>Deferred</code>)</i>
</dd>
</dl>
</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="state"></a>
<h3>state</h3>
A string representing the state the connection is currently in.
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>NoneType</code>
</dd>
<span title="None"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
None </pre>
</td></tr></table></dd>
</span> </dl>
</dd>
</dl></td></tr></table>
<br />
<!-- =========== START OF CLASS VARIABLE DETAILS =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
<th colspan="2">Class Variable Details</th></tr>
</table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="__implements__"></a>
<h3>__implements__</h3>
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>tuple</code>
</dd>
<span title="(<class twisted.protocols.imap4.IMailboxListener at 0x8871e0c>,)"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
(<class twisted.protocols.imap4.IMailboxListener at 0x8871e0c>,) </pre>
</td></tr></table></dd>
</span> </dl>
</dd>
</dl></td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="_capCache"></a>
<h3>_capCache</h3>
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>NoneType</code>
</dd>
<span title="None"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
None </pre>
</td></tr></table></dd>
</span> </dl>
</dd>
</dl></td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="_memoryFileLimit"></a>
<h3>_memoryFileLimit</h3>
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>int</code>
</dd>
<span title="10485760"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
10485760 </pre>
</td></tr></table></dd>
</span> </dl>
</dd>
</dl></td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="authenticators"></a>
<h3>authenticators</h3>
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>NoneType</code>
</dd>
<span title="None"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
None </pre>
</td></tr></table></dd>
</span> </dl>
</dd>
</dl></td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="context"></a>
<h3>context</h3>
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>NoneType</code>
</dd>
<span title="None"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
None </pre>
</td></tr></table></dd>
</span> </dl>
</dd>
</dl></td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="queued"></a>
<h3>queued</h3>
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>NoneType</code>
</dd>
<span title="None"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
None </pre>
</td></tr></table></dd>
</span> </dl>
</dd>
</dl></td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="startedTLS"></a>
<h3>startedTLS</h3>
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>int</code>
</dd>
<span title="0"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
0 </pre>
</td></tr></table></dd>
</span> </dl>
</dd>
</dl></td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="STATUS_CODES"></a>
<h3>STATUS_CODES</h3>
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>tuple</code>
</dd>
<span title="('OK', 'NO', 'BAD', 'PREAUTH', 'BYE')"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
('OK', 'NO', 'BAD', 'PREAUTH', 'BYE') </pre>
</td></tr></table></dd>
</span> </dl>
</dd>
</dl></td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="STATUS_TRANSFORMATIONS"></a>
<h3>STATUS_TRANSFORMATIONS</h3>
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>dict</code>
</dd>
<span title="{'MESSAGES': <type 'int'>, 'UNSEEN': <type 'int'>, 'RECENT': <type 'int'>}"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
{'MESSAGES': <type 'int'>, 'UNSEEN': <type 'int'>, 'RECENT': <type 'in<span class="variable-linewrap">\</span>
t'>} </pre>
</td></tr></table></dd>
</span> </dl>
</dd>
</dl></td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="tagID"></a>
<h3>tagID</h3>
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>int</code>
</dd>
<span title="1"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
1 </pre>
</td></tr></table></dd>
</span> </dl>
</dd>
</dl></td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="tags"></a>
<h3>tags</h3>
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>NoneType</code>
</dd>
<span title="None"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
None </pre>
</td></tr></table></dd>
</span> </dl>
</dd>
</dl></td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="waiting"></a>
<h3>waiting</h3>
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>NoneType</code>
</dd>
<span title="None"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
None </pre>
</td></tr></table></dd>
</span> </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:20 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>