twisted.mail.maildir.MaildirMailbox : API documentation

See __init__.

Information about the messages in the mailbox. For undeleted messages, the file containing the message and the full path name of the file are stored. Deleted messages are indicated by 0.

(type: list of int or 2-tuple of (0) file-like object, (1) bytes)

deleted = (source)

Undocumented

(type: A mapping of the information about a file before it was deleted to the full path name of the deleted file in the .Trash/ subfolder.)

def __init__(self, path): (source)

Parameters path The directory name for a maildir mailbox. (type: bytes)

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

from twisted.mail.interfaces.IMailboxPOP3

overrides twisted.mail.pop3.Mailbox.listMessages

Retrieve the size of a message, or, if none is specified, the size of each message in the mailbox.

Parameters	i	The 0-based index of a message. (type: `int` or `None`)
Returns	The number of octets in the specified message, or, if an index is not specified, a list of the number of octets for all messages in the mailbox. Any value which corresponds to a deleted message is set to 0. (type: `int` or `list` of `int`)
Raises	IndexError	When the index does not correspond to a message in the mailbox.

def getMessage(self, i): (source)

from twisted.mail.interfaces.IMailboxPOP3

overrides twisted.mail.pop3.Mailbox.getMessage

Retrieve a file-like object with the contents of a message.

Parameters	i	The 0-based index of a message. (type: `int`)
Returns	A file containing the message. (type: file-like object)
Raises	IndexError	When the index does not correspond to a message in the mailbox.

def getUidl(self, i): (source)

from twisted.mail.interfaces.IMailboxPOP3

overrides twisted.mail.pop3.Mailbox.getUidl

Get a unique identifier for a message.

Parameters	i	The 0-based index of a message. (type: `int`)
Returns	A string of printable characters uniquely identifying the message for all time. (type: `bytes`)
Raises	IndexError	When the index does not correspond to a message in the mailbox.

def deleteMessage(self, i): (source)

from twisted.mail.interfaces.IMailboxPOP3

overrides twisted.mail.pop3.Mailbox.deleteMessage

Mark a message for deletion.

Move the message to the .Trash/ subfolder so it can be undeleted by an administrator.

Parameters	i	The 0-based index of a message. (type: `int`)
Raises	IndexError	When the index does not correspond to a message in the mailbox.

def undeleteMessages(self): (source)

from twisted.mail.interfaces.IMailboxPOP3

overrides twisted.mail.pop3.Mailbox.undeleteMessages

Undelete all messages marked for deletion.

Move each message marked for deletion from the .Trash/ subfolder back to its original position.

def appendMessage(self, txt): (source)

Add a message to the mailbox.

Parameters	txt	A message to add. (type: `bytes` or file-like object)
Returns	A deferred which fires when the message has been added to the mailbox. (type: `Deferred`)

Instance Variable	path	See `__init__`.
Instance Variable	list	Information about the messages in the mailbox. For undeleted messages, the file containing the message and the full path name of the file are stored. Deleted messages are indicated by 0.
Instance Variable	deleted	Undocumented
Method	__init__
Method	listMessages	Retrieve the size of a message, or, if none is specified, the size of each message in the mailbox.
Method	getMessage	Retrieve a file-like object with the contents of a message.
Method	getUidl	Get a unique identifier for a message.
Method	deleteMessage	Mark a message for deletion.
Method	undeleteMessages	Undelete all messages marked for deletion.
Method	appendMessage	Add a message to the mailbox.