twisted.mail.imap4.MemoryAccountWithoutNamespaces(object)
class documentationtwisted.mail.imap4
View Source
(View In Hierarchy)
Known subclasses: twisted.mail.imap4.MemoryAccount
Implements interfaces: twisted.mail.interfaces.IAccountIMAP
Method | __init__ | Undocumented |
Method | allocateID | Undocumented |
Method | addMailbox | Add a new mailbox to this account |
Method | create | Create a new mailbox from the given hierarchical name. |
Method | select | Acquire a mailbox, given its name. |
Method | delete | Delete the mailbox with the specified name. |
Method | rename | Rename a mailbox |
Method | isSubscribed | Check the subscription status of a mailbox |
Method | subscribe | Subscribe to a mailbox |
Method | unsubscribe | Unsubscribe from a mailbox |
Method | listMailboxes | List all the mailboxes that meet a certain criteria |
Method | _emptyMailbox | Undocumented |
Method | _inferiorNames | Undocumented |
Add a new mailbox to this account
Parameters | name | The name associated with this mailbox. It may not contain multiple
hierarchical parts. (type: bytes ) |
mbox | The mailbox to associate with this name. If None ,
a suitable default is created and used. (type: An object implementing IMailboxIMAP ) | |
Returns | A true value if the creation succeeds, or a deferred whose callback will be
invoked when the creation succeeds. (type: Deferred or
bool ) | |
Raises | MailboxException | Raised if this mailbox cannot be added for some reason. This may also be
raised asynchronously, if a Deferred is
returned. |
Create a new mailbox from the given hierarchical name.
Parameters | pathspec | The full hierarchical name of a new mailbox to create. If any of the
inferior hierarchical names to this one do not exist, they are created as
well. (type: bytes ) |
Returns | A true value if the creation succeeds, or a deferred whose callback will be
invoked when the creation succeeds. (type: Deferred or
bool ) | |
Raises | MailboxException | Raised if this mailbox cannot be added. This may also be raised
asynchronously, if a Deferred is
returned. |
Acquire a mailbox, given its name.
Parameters | name | The mailbox to acquire (type: bytes ) |
rw | If a true value, request a read-write version of this mailbox. If a false
value, request a read-only version. (type: bool ) | |
Returns | The mailbox object, or a Deferred whose
callback will be invoked with the mailbox object. None may be returned if
the specified mailbox may not be selected for any reason. (type: Any object implementing IMailboxIMAP or Deferred ) |
Delete the mailbox with the specified name.
Parameters | name | The mailbox to delete. (type: bytes ) |
Returns | A true value if the mailbox is successfully deleted, or a Deferred whose
callback will be invoked when the deletion completes. (type: Deferred or
bool ) | |
Raises | MailboxException | Raised if this mailbox cannot be deleted. This may also be raised
asynchronously, if a Deferred is
returned. |
Rename a mailbox
Parameters | oldname | The current name of the mailbox to rename. (type: bytes ) |
newname | The new name to associate with the mailbox. (type: bytes ) | |
Returns | A true value if the mailbox is successfully renamed, or a Deferred whose
callback will be invoked when the rename operation is completed. (type: Deferred or
bool ) | |
Raises | MailboxException | Raised if this mailbox cannot be renamed. This may also be raised
asynchronously, if a Deferred is
returned. |
Check the subscription status of a mailbox
Parameters | name | The name of the mailbox to check (type: bytes ) |
Returns | A true value if the given mailbox is currently subscribed to, a false value
otherwise. A Deferred may
also be returned whose callback will be invoked with one of these values. (type: Deferred or
bool ) |
Subscribe to a mailbox
Parameters | name | The name of the mailbox to subscribe to (type: bytes ) |
Returns | A true value if the mailbox is subscribed to successfully, or a Deferred
whose callback will be invoked with this value when the subscription is
successful. (type: Deferred or
bool ) | |
Raises | MailboxException | Raised if this mailbox cannot be subscribed to. This may also be raised
asynchronously, if a Deferred is
returned. |
Unsubscribe from a mailbox
Parameters | name | The name of the mailbox to unsubscribe from (type: bytes ) |
Returns | A true value if the mailbox is unsubscribed from successfully, or a
Deferred whose callback will be invoked with this value when the
unsubscription is successful. (type: Deferred or
bool ) | |
Raises | MailboxException | Raised if this mailbox cannot be unsubscribed from. This may also be raised
asynchronously, if a Deferred is
returned. |
List all the mailboxes that meet a certain criteria
Parameters | ref | The context in which to apply the wildcard (type: bytes ) |
wildcard | An expression against which to match mailbox names. '*' matches any number
of characters in a mailbox name, and '%' matches similarly, but will not
match across hierarchical boundaries. (type: bytes ) | |
Returns | A list of (mailboxName, mailboxObject) which meet the given
criteria. mailboxObject should implement either
IMailboxIMAPInfo or IMailboxIMAP . A Deferred may
also be returned. (type: list
of tuple ) |