twisted.mail.protocols.VirtualPOP3.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.mail.protocols.VirtualPOP3</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.mail.html">Package mail</a> ::
<a href="twisted.mail.protocols.html">Module protocols</a> ::
Class VirtualPOP3
</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.mail.protocols.VirtualPOP3.html" target="_top">no frames</a>]</font></td></tr>
</table></td>
</tr></table>
<!-- =========== START OF CLASS DESCRIPTION =========== -->
<h2 class="class">Class VirtualPOP3</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.LineOnlyReceiver.html"><code>LineOnlyReceiver</code></a> --+
|
<a href="twisted.protocols.policies.TimeoutMixin.html"><code>TimeoutMixin</code></a> --+
|
<a href="twisted.protocols.pop3.POP3.html"><code>POP3</code></a> --+
|
<b>VirtualPOP3</b>
</pre><br />
<hr/>
Virtual hosting POP3.
<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"> <code>Deferred</code>
</font></td>
<td><code><span class="summary-sig"><a href="twisted.mail.protocols.VirtualPOP3.html#authenticateUserAPOP" class="summary-sig-name"><code>authenticateUserAPOP</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>user</span>,
<span class=summary-sig-arg>digest</span>)</span></code>
<br />
Perform authentication of an APOP login.</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.mail.protocols.VirtualPOP3.html#authenticateUserPASS" class="summary-sig-name"><code>authenticateUserPASS</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>user</span>,
<span class=summary-sig-arg>password</span>)</span></code>
<br />
Perform authentication of a username/password login.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="lookupDomain"></a><span class="summary-sig"><span class="summary-sig-name">lookupDomain</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>user</span>)</span></code>
</td></tr>
<tr bgcolor="#e8f0f8" class="group">
<th colspan="2"> Inherited from POP3</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.protocols.pop3.POP3.html#_cbMailbox" class="summary-sig-name"><code>_cbMailbox</code></a>(<span class=summary-sig-arg>self</span>,
(<span class=summary-sig-arg>interface</span>,
<span class=summary-sig-arg>avatar</span>,
<span class=summary-sig-arg>logout</span>),
<span class=summary-sig-arg>user</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.pop3.POP3.html#_ebMailbox" class="summary-sig-name"><code>_ebMailbox</code></a>(<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><span class="summary-sig"><a href="twisted.protocols.pop3.POP3.html#_ebUnexpected" class="summary-sig-name"><code>_ebUnexpected</code></a>(<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><span class="summary-sig"><a href="twisted.protocols.pop3.POP3.html#_unblock" class="summary-sig-name"><code>_unblock</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>_</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.pop3.POP3.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>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.protocols.pop3.POP3.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.protocols.pop3.POP3.html#do_APOP" class="summary-sig-name"><code>do_APOP</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>user</span>,
<span class=summary-sig-arg>digest</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.pop3.POP3.html#do_AUTH" class="summary-sig-name"><code>do_AUTH</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>args</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.pop3.POP3.html#do_CAPA" class="summary-sig-name"><code>do_CAPA</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.protocols.pop3.POP3.html#do_DELE" class="summary-sig-name"><code>do_DELE</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>i</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.pop3.POP3.html#do_LAST" class="summary-sig-name"><code>do_LAST</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Respond with the highest message access thus far</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.protocols.pop3.POP3.html#do_LIST" class="summary-sig-name"><code>do_LIST</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>i</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.pop3.POP3.html#do_NOOP" class="summary-sig-name"><code>do_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.pop3.POP3.html#do_PASS" class="summary-sig-name"><code>do_PASS</code></a>(<span class=summary-sig-arg>self</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><span class="summary-sig"><a href="twisted.protocols.pop3.POP3.html#do_QUIT" class="summary-sig-name"><code>do_QUIT</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.protocols.pop3.POP3.html#do_RETR" class="summary-sig-name"><code>do_RETR</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>i</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.pop3.POP3.html#do_RPOP" class="summary-sig-name"><code>do_RPOP</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>user</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.pop3.POP3.html#do_RSET" class="summary-sig-name"><code>do_RSET</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Unset all deleted message flags</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.protocols.pop3.POP3.html#do_STAT" class="summary-sig-name"><code>do_STAT</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.protocols.pop3.POP3.html#do_TOP" class="summary-sig-name"><code>do_TOP</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>i</span>,
<span class=summary-sig-arg>size</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.pop3.POP3.html#do_UIDL" class="summary-sig-name"><code>do_UIDL</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>i</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.pop3.POP3.html#do_USER" class="summary-sig-name"><code>do_USER</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>user</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.pop3.POP3.html#failResponse" class="summary-sig-name"><code>failResponse</code></a>(<span class=summary-sig-arg>self</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><span class="summary-sig"><a href="twisted.protocols.pop3.POP3.html#finishedFileTransfer" class="summary-sig-name"><code>finishedFileTransfer</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>lastsent</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.pop3.POP3.html#generateMagic" class="summary-sig-name"><code>generateMagic</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.protocols.pop3.POP3.html#getMessageFile" class="summary-sig-name"><code>getMessageFile</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>i</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.pop3.POP3.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"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.protocols.pop3.POP3.html#listCapabilities" class="summary-sig-name"><code>listCapabilities</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.protocols.pop3.POP3.html#processCommand" class="summary-sig-name"><code>processCommand</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>command</span>,
<span class="summary-sig-vararg">*args</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.pop3.POP3.html#state_AUTH" class="summary-sig-name"><code>state_AUTH</code></a>(<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><span class="summary-sig"><a href="twisted.protocols.pop3.POP3.html#state_COMMAND" class="summary-sig-name"><code>state_COMMAND</code></a>(<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><span class="summary-sig"><a href="twisted.protocols.pop3.POP3.html#successResponse" class="summary-sig-name"><code>successResponse</code></a>(<span class=summary-sig-arg>self</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><span class="summary-sig"><a href="twisted.protocols.pop3.POP3.html#transformChunk" class="summary-sig-name"><code>transformChunk</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>chunk</span>)</span></code>
</td></tr>
<tr bgcolor="#e8f0f8" class="group">
<th colspan="2"> Inherited from LineOnlyReceiver</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.LineOnlyReceiver.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.LineOnlyReceiver.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.LineOnlyReceiver.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 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 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#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>
<tr bgcolor="#e8f0f8" class="group">
<th colspan="2"> Inherited from TimeoutMixin</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.policies.TimeoutMixin.html#resetTimeout" class="summary-sig-name"><code>resetTimeout</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Reset the timeout count down</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.policies.TimeoutMixin.html#setTimeout" class="summary-sig-name"><code>setTimeout</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>period</span>)</span></code>
<br />
Change the timeout period</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.policies.TimeoutMixin.html#timeoutConnection" class="summary-sig-name"><code>timeoutConnection</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Called when the connection times out.</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>str</code></font></td>
<td><b><a href="twisted.mail.protocols.VirtualPOP3.html#domainSpecifier"><code>domainSpecifier</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>NoneType</code></font></td>
<td><b><a href="twisted.mail.protocols.VirtualPOP3.html#service"><code>service</code></a></b> = <span title="None">None </span></td></tr>
<tr bgcolor="#e8f0f8" class="group">
<th colspan="2"> Inherited from POP3</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>tuple</code></font></td>
<td><b><a href="twisted.protocols.pop3.POP3.html#__implements__"><code>__implements__</code></a></b> = <span title="(<class twisted.internet.interfaces.IProducer at 0x827b064>,)"><code>(<class twisted.internet.interfaces.IPr<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.pop3.POP3.html#_onLogout"><code>_onLogout</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.pop3.POP3.html#_userIs"><code>_userIs</code></a></b> = <span title="None">None </span></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>list</code></font></td>
<td><b><a href="twisted.protocols.pop3.POP3.html#AUTH_CMDS"><code>AUTH_CMDS</code></a></b> = <span title="['CAPA', 'USER', 'PASS', 'APOP', 'AUTH', 'RPOP', 'QUIT']"><code>['CAPA', 'USER', 'PASS', 'APOP', 'AUTH', 'RP<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.pop3.POP3.html#blocked"><code>blocked</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.pop3.POP3.html#factory"><code>factory</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.pop3.POP3.html#highest"><code>highest</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.protocols.pop3.POP3.html#magic"><code>magic</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.pop3.POP3.html#mbox"><code>mbox</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.pop3.POP3.html#portal"><code>portal</code></a></b> = <span title="None">None </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.pop3.POP3.html#state"><code>state</code></a></b> = <span title="'COMMAND'"><code><span class="variable-quote">'</span>COMMAND<span class="variable-quote">'</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.pop3.POP3.html#timeOut"><code>timeOut</code></a></b>: The number of seconds after which to timeout the connection.</td></tr>
<tr bgcolor="#e8f0f8" class="group">
<th colspan="2"> Inherited from LineOnlyReceiver</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.LineOnlyReceiver.html#_buffer"><code>_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.LineOnlyReceiver.html#delimiter"><code>delimiter</code></a></b> = <span title="'\r\n'"><code><span class="variable-quote">'</span>\r\n<span class="variable-quote">'</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.basic.LineOnlyReceiver.html#MAX_LENGTH"><code>MAX_LENGTH</code></a></b> = <span title="16384">16384 </span></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>
<tr bgcolor="#e8f0f8" class="group">
<th colspan="2"> Inherited from TimeoutMixin</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>NoneType</code></font></td>
<td><b><a href="twisted.protocols.policies.TimeoutMixin.html#__lastReceived"><code>_TimeoutMixin__lastReceived</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.policies.TimeoutMixin.html#__timeoutCall"><code>_TimeoutMixin__timeoutCall</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="authenticateUserAPOP"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">authenticateUserAPOP</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>user</span>,
<span class=sig-arg>digest</span>)</span>
</h3>
Perform authentication of an APOP login.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>user</b></code> -
The name of the user attempting to log in.
<br /><i>
(type=<code>str</code>)</i>
<dd><code><b>digest</b></code> -
The response string with which the user replied.
<br /><i>
(type=<code>str</code>)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
A deferred whose callback is invoked if the login is
successful, and whose errback will be invoked otherwise. The
callback will be passed a 3-tuple consisting of IMailbox, an
object implementing IMailbox, and a zero-argument callable to be
invoked when this session is terminated.
<br /><i>
(type=<code>Deferred</code>)</i>
</dd>
</dl>
<dl><dt><b>Overrides:</b></dt>
<dd><a href="twisted.protocols.pop3.POP3.html#authenticateUserAPOP"><code>twisted.protocols.pop3.POP3.authenticateUserAPOP</code></a> <i>(inherited documentation)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="authenticateUserPASS"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">authenticateUserPASS</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>user</span>,
<span class=sig-arg>password</span>)</span>
</h3>
Perform authentication of a username/password login.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>user</b></code> -
The name of the user attempting to log in.
<br /><i>
(type=<code>str</code>)</i>
<dd><code><b>password</b></code> -
The password to attempt to authenticate with.
<br /><i>
(type=<code>str</code>)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
A deferred whose callback is invoked if the login is
successful, and whose errback will be invoked otherwise. The
callback will be passed a 3-tuple consisting of IMailbox, an
object implementing IMailbox, and a zero-argument callable to be
invoked when this session is terminated.
<br /><i>
(type=<code>Deferred</code>)</i>
</dd>
</dl>
<dl><dt><b>Overrides:</b></dt>
<dd><a href="twisted.protocols.pop3.POP3.html#authenticateUserPASS"><code>twisted.protocols.pop3.POP3.authenticateUserPASS</code></a> <i>(inherited documentation)</i>
</dd>
</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="domainSpecifier"></a>
<h3>domainSpecifier</h3>
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>str</code>
</dd>
<span title="'@'"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
<span class="variable-quote">'</span>@<span class="variable-quote">'</span> </pre>
</td></tr></table></dd>
</span> </dl>
</dd>
</dl></td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="service"></a>
<h3>service</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:54 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>