twisted.mail.test.test_pop3.SyncDeferredMailbox

class documentation

class SyncDeferredMailbox(DummyMailbox): (source)

View In Hierarchy

Mailbox which has a listMessages implementation which returns a Deferred which has already fired.

Method listMessages Synchronously list messages.

Inherited from DummyMailbox:

Method __init__ Undocumented
Method deleteMessage Wipe the message at the given index.
Method getMessage Get the message content.
Method getUidl Construct a UID which is simply the string representation of the given index.
Instance Variable exceptionType The type of exception to raise when an out-of-bounds index is addressed.
Instance Variable messages A sequence of bytes defining the messages in this mailbox.

Inherited from Mailbox (via DummyMailbox):

Method sync Discard the contents of any message marked for deletion.
Method undeleteMessages Undelete all messages marked for deletion.
def listMessages(self, n=None): (source)
from twisted.mail.interfaces.IMailboxPOP3
overrides twisted.mail.test.test_pop3.DummyMailbox.listMessages

Synchronously list messages.

Parameters
n:int or NoneThe 0-based index of the message.
Returns
A Deferred which already has a message list result.