twisted.protocols.pop3.IServerFactory.html [plain text]
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>twisted.protocols.pop3.IServerFactory</title>
<link rel="stylesheet" href="epydoc.css" type="text/css"></link>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- =========== START OF NAVBAR =========== -->
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
<tr valign="center">
<th class="navbar"> <a class="navbar" href="twisted.html">Home</a> </th>
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center">
<p class="nomargin">
<a class="navbar" target="_top" href="http://twistedmatrix.com/">Twisted 1.3.0rc1</a>
</p></th></tr></table>
</th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<font size="-1"><b class="breadcrumbs">
<a href="twisted.html">Package twisted</a> ::
<a href="twisted.protocols.html">Package protocols</a> ::
<a href="twisted.protocols.pop3.html">Module pop3</a> ::
Class IServerFactory
</b></font></br>
</td>
<td><table cellpadding="0" cellspacing="0">
<tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="twisted.protocols.pop3.IServerFactory.html" target="_top">no frames</a>]</font></td></tr>
</table></td>
</tr></table>
<!-- =========== START OF CLASS DESCRIPTION =========== -->
<h2 class="class">Class IServerFactory</h2>
<pre class="base-tree">
<a href="twisted.python.components.Interface.html"><code>Interface</code></a> --+
|
<b>IServerFactory</b>
</pre><br />
<hr/>
<p>Interface for querying additional parameters of this POP3 server.</p>
Any cap_* method may raise NotImplementedError if the particular
capability is not supported. If cap_EXPIRE() does not raise
NotImplementedError, perUserExpiration() must be implemented, otherwise
they are optional. If cap_LOGIN_DELAY() is implemented,
perUserLoginDelay() must be implemented, otherwise they are optional.
<hr/>
<!-- =========== START OF METHOD SUMMARY =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Method Summary</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.protocols.pop3.IServerFactory.html#cap_EXPIRE" class="summary-sig-name"><code>cap_EXPIRE</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Return the minimum number of days messages are retained.</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.IServerFactory.html#cap_IMPLEMENTATION" class="summary-sig-name"><code>cap_IMPLEMENTATION</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Return a string describing this POP3 server implementation.</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.IServerFactory.html#cap_LOGIN_DELAY" class="summary-sig-name"><code>cap_LOGIN_DELAY</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Return the minimum number of seconds between client logins.</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.IServerFactory.html#perUserExpiration" class="summary-sig-name"><code>perUserExpiration</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Indicate whether message expiration is per-user.</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.IServerFactory.html#perUserLoginDelay" class="summary-sig-name"><code>perUserLoginDelay</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Indicate whether the login delay period is per-user.</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"> </font></td>
<td><b><a href="twisted.protocols.pop3.IServerFactory.html#challengers"><code>challengers</code></a></b>: A dictionary mapping challenger names to classes implementing
<code>IUsernameHashedPassword</code>.</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="cap_EXPIRE"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">cap_EXPIRE</span>(<span class=sig-arg>self</span>)</span>
</h3>
Return the minimum number of days messages are retained.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="cap_IMPLEMENTATION"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">cap_IMPLEMENTATION</span>(<span class=sig-arg>self</span>)</span>
</h3>
Return a string describing this POP3 server implementation.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="cap_LOGIN_DELAY"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">cap_LOGIN_DELAY</span>(<span class=sig-arg>self</span>)</span>
</h3>
Return the minimum number of seconds between client logins.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="perUserExpiration"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">perUserExpiration</span>(<span class=sig-arg>self</span>)</span>
</h3>
Indicate whether message expiration is per-user.
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
True if it is, false otherwise.
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="perUserLoginDelay"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">perUserLoginDelay</span>(<span class=sig-arg>self</span>)</span>
</h3>
Indicate whether the login delay period is per-user.
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
True if it is, false otherwise.
</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="challengers"></a>
<h3>challengers</h3>
A dictionary mapping challenger names to classes implementing
<code>IUsernameHashedPassword</code>.
</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:07:43 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>