twisted.mail.test.test_imap.SimpleMailbox

class documentation

class SimpleMailbox: (source)

Known subclasses: twisted.mail.test.test_imap.SlowMailbox

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

View In Hierarchy

Undocumented

Method	`__init__`	Undocumented
Method	`addMessage`	Add the given message to this mailbox.
Method	`close`	Close this mailbox.
Method	`destroy`	Called before this mailbox is deleted, permanently.
Method	`expunge`	Remove all messages flagged \Deleted.
Method	`fetch`	Retrieve one or more messages.
Method	`getFlags`	Return the flags defined in this mailbox
Method	`getHierarchicalDelimiter`	Get the character which delimits namespaces for in this mailbox.
Method	`getMessageCount`	Return the number of messages in this mailbox.
Method	`getRecentCount`	Return the number of messages with the 'Recent' flag.
Method	`getUID`	Return the UID of a message in the mailbox
Method	`getUIDNext`	Return the likely UID for the next message added to this mailbox.
Method	`getUIDValidity`	Return the unique validity identifier for this mailbox.
Method	`getUnseenCount`	Return the number of messages with the 'Unseen' flag.
Method	`isWriteable`	Get the read/write status of the mailbox.
Method	`requestStatus`	Return status information about this mailbox.
Method	`store`	Set the flags of one or more messages.
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	`closed`	Undocumented
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 the given message to this mailbox.

Parameters
message:A file-like object	The RFC822 formatted message
flags:Any iterable of `bytes`	The flags to associate with this message
date:`bytes`	If specified, the date to associate with this message.
Returns
`Deferred`	A deferred whose callback is invoked with the message id if the message is added successfully and whose errback is invoked otherwise.
Raises
`ReadOnlyMailbox`	Raised if this Mailbox is not open for read-write.

def close(self): (source) ¶

from twisted.mail.interfaces.ICloseableMailboxIMAP

Close this mailbox.

Returns
A `Deferred` which fires when this mailbox has been closed, or None if the mailbox can be closed immediately.

def destroy(self): (source) ¶

from twisted.mail.interfaces.IMailboxIMAP

Called before this mailbox is deleted, permanently.

If necessary, all resources held by this mailbox should be cleaned up here. This function _must_ set the \Noselect flag on this mailbox.

def expunge(self): (source) ¶

from twisted.mail.interfaces.IMailboxIMAP

Remove all messages flagged \Deleted.

Returns
`list` or `Deferred`	The list of message sequence numbers which were deleted, or a `Deferred` whose callback will be invoked with such a list.
Raises
`ReadOnlyMailbox`	Raised if this Mailbox is not open for read-write.

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

from twisted.mail.interfaces.IMailboxIMAP

overridden in twisted.mail.test.test_imap.SlowMailbox

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

Return the flags defined in this mailbox

Flags with the \ prefix are reserved for use as system flags.

Returns
`list` of `str`	A list of the flags that can be set on messages in this mailbox.

def getHierarchicalDelimiter(self): (source) ¶

from twisted.mail.interfaces.IMailboxIMAPInfo

Get the character which delimits namespaces for in this mailbox.

Returns
`bytes`	Undocumented

def getMessageCount(self): (source) ¶

from twisted.mail.interfaces.IMailboxIMAP

Return the number of messages in this mailbox.

Returns
`int`	Undocumented

def getRecentCount(self): (source) ¶

from twisted.mail.interfaces.IMailboxIMAP

Return the number of messages with the 'Recent' flag.

Returns
`int`	Undocumented

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

Return the likely UID for the next message added to this mailbox.

Returns
`int`	Undocumented

def getUIDValidity(self): (source) ¶

from twisted.mail.interfaces.IMailboxIMAP

Return the unique validity identifier for this mailbox.

Returns
`int`	Undocumented

def getUnseenCount(self): (source) ¶

from twisted.mail.interfaces.IMailboxIMAP

Return the number of messages with the 'Unseen' flag.

Returns
`int`	Undocumented

def isWriteable(self): (source) ¶

from twisted.mail.interfaces.IMailboxIMAP

Get the read/write status of the mailbox.

Returns
`int`	A true value if write permission is allowed, a false value otherwise.

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

from twisted.mail.interfaces.IMailboxIMAP

Return status information about this mailbox.

Mailboxes which do not intend to do any special processing to generate the return value, statusRequestHelper can be used to build the dictionary by calling the other interface methods which return the data for each name.

Parameters
names:Any iterable	The status names to return information regarding. The possible values for each name are: MESSAGES, RECENT, UIDNEXT, UIDVALIDITY, UNSEEN.
Returns
`dict` or `Deferred`	A dictionary containing status information about the requested names is returned. If the process of looking this information up would be costly, a deferred whose callback will eventually be passed this dictionary is returned instead.

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.