twisted.mail.test.test_imap.UncloseableMailbox

class documentation

class UncloseableMailbox: (source)

Implements interfaces: twisted.mail.interfaces.IMailboxIMAP, twisted.mail.interfaces.IMailboxIMAPInfo

A mailbox that cannot be closed.

Method	`__init__`	Undocumented
Method	`addMessage`	Add a message to the mailbox.
Method	`destroy`	Destroy this mailbox.
Method	`expunge`	Delete messages marked for deletion.
Method	`fetch`	Retrieve one or more messages.
Method	`getFlags`	The flags
Method	`getHierarchicalDelimiter`	Return the hierarchical delimiter.
Method	`getMessageCount`	The number of messages.
Method	`getRecentCount`	The recent messages.
Method	`getUID`	Return the UID of a message in the mailbox
Method	`getUIDNext`	The next UID.
Method	`getUIDValidity`	The UID validity value.
Method	`getUnseenCount`	The recent messages.
Method	`isWriteable`	The recent messages.
Method	`requestStatus`	Return the mailbox's status.
Method	`store`	Set the flags of one or more messages.
Class Variable	`closed`	Undocumented
Class Variable	`flags`	Undocumented
Class Variable	`messages`	Undocumented
Class Variable	`mUID`	Undocumented
Class Variable	`rw`	Undocumented
Instance Variable	`addListener`	Add a mailbox change listener
Instance Variable	`listeners`	Undocumented
Instance Variable	`removeListener`	Remove a mailbox change listener

def __init__(self): (source) ¶

Undocumented

def addMessage(self, message, flags, date=None): (source) ¶

from twisted.mail.interfaces.IMailboxIMAP

Add a message to the mailbox.

Parameters
message	The message body.
flags	The message flags.
date	The message date.
Returns
A `Deferred` that fires when the message has been added.

def destroy(self): (source) ¶

from twisted.mail.interfaces.IMailboxIMAP

Destroy this mailbox.

def expunge(self): (source) ¶

from twisted.mail.interfaces.IMailboxIMAP

Delete messages marked for deletion.

Returns
A `list` of deleted message IDs.

def fetch(self, messages, uid): (source) ¶

from twisted.mail.interfaces.IMailboxIMAP

Retrieve one or more messages.

Parameters
messages:`MessageSet`	The identifiers of messages to retrieve information about
uid:`bool`	If true, the IDs specified in the query are UIDs; otherwise they are message sequence IDs.
Returns
Any iterable of two-tuples of message sequence numbers and implementors of `IMessageIMAP`.	Undocumented

def getFlags(self): (source) ¶

from twisted.mail.interfaces.IMailboxIMAPInfo

The flags

Returns
A sequence of flags.

def getHierarchicalDelimiter(self): (source) ¶

from twisted.mail.interfaces.IMailboxIMAPInfo

Return the hierarchical delimiter.

Returns
The delimiter.

def getMessageCount(self): (source) ¶

from twisted.mail.interfaces.IMailboxIMAP

The number of messages.

Returns
The number.

def getRecentCount(self): (source) ¶

from twisted.mail.interfaces.IMailboxIMAP

The recent messages.

Returns
The number.

def getUID(self, message): (source) ¶

from twisted.mail.interfaces.IMailboxIMAP

Return the UID of a message in the mailbox

Parameters
message:`int`	The message sequence number
Returns
`int`	The UID of the message.

def getUIDNext(self): (source) ¶

from twisted.mail.interfaces.IMailboxIMAP

The next UID.

Returns
The UID.

def getUIDValidity(self): (source) ¶

from twisted.mail.interfaces.IMailboxIMAP

The UID validity value.

Returns
The value.

def getUnseenCount(self): (source) ¶

from twisted.mail.interfaces.IMailboxIMAP

The recent messages.

Returns
The number.

def isWriteable(self): (source) ¶

from twisted.mail.interfaces.IMailboxIMAP

The recent messages.

Returns
Whether or not the mailbox is writable.

def requestStatus(self, names): (source) ¶

from twisted.mail.interfaces.IMailboxIMAP

Return the mailbox's status.

Parameters
names	The status items to include.
Returns
A `dict` of status data.

def store(self, messages, flags, mode, uid): (source) ¶

from twisted.mail.interfaces.IMailboxIMAP

Set the flags of one or more messages.

Parameters
messages:A MessageSet object with the list of messages requested	The identifiers of the messages to set the flags of.
flags:sequence of `str`	The flags to set, unset, or add.
mode:-1, 0, or 1	If mode is -1, these flags should be removed from the specified messages. If mode is 1, these flags should be added to the specified messages. If mode is 0, all existing flags should be cleared and these flags should be added.
uid:`bool`	If true, the IDs specified in the query are UIDs; otherwise they are message sequence IDs.
Returns
`dict` or `Deferred`	A `dict` mapping message sequence numbers to sequences of `str` representing the flags set on the message after this operation has been performed, or a `Deferred` whose callback will be invoked with such a `dict`.
Raises
`ReadOnlyMailbox`	Raised if this mailbox is not open for read-write.