twisted.mail.maildir.MaildirMailbox.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.maildir.MaildirMailbox</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.maildir.html">Module maildir</a> ::
Class MaildirMailbox
</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.maildir.MaildirMailbox.html" target="_top">no frames</a>]</font></td></tr>
</table></td>
</tr></table>
<!-- =========== START OF CLASS DESCRIPTION =========== -->
<h2 class="class">Class MaildirMailbox</h2>
<pre class="base-tree">
<a href="twisted.protocols.pop3.Mailbox.html"><code>Mailbox</code></a> --+
|
<b>MaildirMailbox</b>
</pre><br />
<hr/>
Implement the POP3 mailbox semantics for a Maildir mailbox
<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.mail.maildir.MaildirMailbox.html#__init__" class="summary-sig-name"><code>__init__</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>path</span>)</span></code>
<br />
Initialize with name of the Maildir mailbox</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.mail.maildir.MaildirMailbox.html#deleteMessage" class="summary-sig-name"><code>deleteMessage</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>i</span>)</span></code>
<br />
Delete a message</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.mail.maildir.MaildirMailbox.html#getMessage" class="summary-sig-name"><code>getMessage</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>i</span>)</span></code>
<br />
Return an open file-pointer to a message</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.mail.maildir.MaildirMailbox.html#getUidl" class="summary-sig-name"><code>getUidl</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>i</span>)</span></code>
<br />
Return a unique identifier for a message</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.mail.maildir.MaildirMailbox.html#listMessages" class="summary-sig-name"><code>listMessages</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>i</span>)</span></code>
<br />
Return a list of lengths of all files in new/ and cur/</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.mail.maildir.MaildirMailbox.html#undeleteMessages" class="summary-sig-name"><code>undeleteMessages</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Undelete any deleted messages it is possible to undelete</td></tr>
<tr bgcolor="#e8f0f8" class="group">
<th colspan="2"> Inherited from Mailbox</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.Mailbox.html#sync" class="summary-sig-name"><code>sync</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
</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 bgcolor="#e8f0f8" class="group">
<th colspan="2"> Inherited from Mailbox</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.Mailbox.html#__implements__"><code>__implements__</code></a></b> = <span title="(<class twisted.protocols.pop3.IMailbox at 0x86e222c>,)"><code>(<class twisted.protocols.pop3.IMailbox<span class="variable-ellipsis">...</span></code>
</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="__init__"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">__init__</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>path</span>)</span>
<br /><i>(Constructor)</i>
</h3>
Initialize with name of the Maildir mailbox
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="deleteMessage"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">deleteMessage</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>i</span>)</span>
</h3>
<p>Delete a message</p>
This only moves a message to the .Trash/ subfolder, so it can be
undeleted by an administrator.
<dl><dt></dt><dd>
<dl><dt><b>Overrides:</b></dt>
<dd><a href="twisted.protocols.pop3.Mailbox.html#deleteMessage"><code>twisted.protocols.pop3.Mailbox.deleteMessage</code></a></dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="getMessage"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">getMessage</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>i</span>)</span>
</h3>
Return an open file-pointer to a message
<dl><dt></dt><dd>
<dl><dt><b>Overrides:</b></dt>
<dd><a href="twisted.protocols.pop3.Mailbox.html#getMessage"><code>twisted.protocols.pop3.Mailbox.getMessage</code></a></dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="getUidl"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">getUidl</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>i</span>)</span>
</h3>
<p>Return a unique identifier for a message</p>
This is done using the basename of the filename. It is globally
unique because this is how Maildirs are designed.
<dl><dt></dt><dd>
<dl><dt><b>Overrides:</b></dt>
<dd><a href="twisted.protocols.pop3.Mailbox.html#getUidl"><code>twisted.protocols.pop3.Mailbox.getUidl</code></a></dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="listMessages"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">listMessages</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>i</span>=<span class=sig-default>None</span>)</span>
</h3>
Return a list of lengths of all files in new/ and cur/
<dl><dt></dt><dd>
<dl><dt><b>Overrides:</b></dt>
<dd><a href="twisted.protocols.pop3.Mailbox.html#listMessages"><code>twisted.protocols.pop3.Mailbox.listMessages</code></a></dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="undeleteMessages"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">undeleteMessages</span>(<span class=sig-arg>self</span>)</span>
</h3>
<p>Undelete any deleted messages it is possible to undelete</p>
This moves any messages from .Trash/ subfolder back to their
original position, and empties out the deleted dictionary.
<dl><dt></dt><dd>
<dl><dt><b>Overrides:</b></dt>
<dd><a href="twisted.protocols.pop3.Mailbox.html#undeleteMessages"><code>twisted.protocols.pop3.Mailbox.undeleteMessages</code></a></dd>
</dl>
</dd></dl>
</td></tr></table>
<br />
<!-- =========== START OF NAVBAR =========== -->
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
<tr valign="center">
<th class="navbar"> <a class="navbar" href="twisted.html">Home</a> </th>
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center">
<p class="nomargin">
<a class="navbar" target="_top" href="http://twistedmatrix.com/">Twisted 1.3.0rc1</a>
</p></th></tr></table>
</th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td align="left"><font size="-2">Generated by Epydoc 2.0 on Sat May 15 20:07:56 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>