twisted.mail.maildir.StringListMailbox : API documentation

The indices of messages which have been marked for deletion.

(type: set of int)

def __init__(self, msgs): (source)

Parameters msgs The contents of each message in the mailbox. (type: list of bytes)

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

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 in each message 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)

Return an in-memory file-like object with the contents of a message.

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

def getUidl(self, i): (source)

Get a unique identifier for a message.

Parameters	i	The 0-based index of a message. (type: `int`)
Returns	A hash of the contents of the message at the given index. (type: `bytes`)
Raises	IndexError	When the index does not correspond to a message in the mailbox.

def deleteMessage(self, i): (source)

Mark a message for deletion.

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

def undeleteMessages(self): (source)

Undelete any messages which have been marked for deletion.

def sync(self): (source)

Discard the contents of any messages marked for deletion.

Instance Variable	msgs	See `__init__`.
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	Return an in-memory 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 any messages which have been marked for deletion.
Method	sync	Discard the contents of any messages marked for deletion.
Instance Variable	_delete	The indices of messages which have been marked for deletion.