t.m.m.MaildirMailbox(pop3.Mailbox) : class documentation

Implement the POP3 mailbox semantics for a Maildir mailbox

Method	__init__	Initialize with name of the Maildir mailbox
Method	listMessages	Return a list of lengths of all files in new/ and cur/
Method	getMessage	Return an open file-pointer to a message
Method	getUidl	Return a unique identifier for a message
Method	deleteMessage	Delete a message
Method	undeleteMessages	Undelete any deleted messages it is possible to undelete
Method	appendMessage	Appends a message into the mailbox.

Inherited from Mailbox:

Method

Perform checkpointing.

def __init__(self, path): (source)

Initialize with name of the Maildir mailbox

def listMessages(self, i=None): (source)

Return a list of lengths of all files in new/ and cur/

def getMessage(self, i): (source)

Return an open file-pointer to a message

def getUidl(self, i): (source)

Return a unique identifier for a message

This is done using the basename of the filename. It is globally unique because this is how Maildirs are designed.

def deleteMessage(self, i): (source)

Delete a message

This only moves a message to the .Trash/ subfolder, so it can be undeleted by an administrator.

def undeleteMessages(self): (source)

Undelete any deleted messages it is possible to undelete

This moves any messages from .Trash/ subfolder back to their original position, and empties out the deleted dictionary.

def appendMessage(self, txt): (source)

Appends a message into the mailbox.

Parameters	txt	A `str` or file-like object giving the message to append.
Returns	A `Deferred` which fires when the message has been appended to the mailbox.

API Documentation for Twisted, generated by pydoctor at 2012-06-04 17:20:01.