interface documentation

class twisted.mail.interfaces.IAccountIMAP(Interface): (source)

Known implementations: twisted.mail.imap4.MemoryAccountWithoutNamespaces

View In Hierarchy

Interface for Account classes

Implementors of this interface should consider implementing INamespacePresenter.

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
def addMailbox(name, mbox=None): (source)

Add a new mailbox to this account

ParametersnameThe name associated with this mailbox. It may not contain multiple hierarchical parts. (type: bytes)
mboxThe mailbox to associate with this name. If None, a suitable default is created and used. (type: An object implementing IMailboxIMAP)
ReturnsA true value if the creation succeeds, or a deferred whose callback will be invoked when the creation succeeds. (type: Deferred or bool)
RaisesMailboxExceptionRaised if this mailbox cannot be added for some reason. This may also be raised asynchronously, if a Deferred is returned.
def create(pathspec): (source)

Create a new mailbox from the given hierarchical name.

ParameterspathspecThe 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)
ReturnsA true value if the creation succeeds, or a deferred whose callback will be invoked when the creation succeeds. (type: Deferred or bool)
RaisesMailboxExceptionRaised if this mailbox cannot be added. This may also be raised asynchronously, if a Deferred is returned.
def select(name, rw=True): (source)

Acquire a mailbox, given its name.

ParametersnameThe mailbox to acquire (type: bytes)
rwIf a true value, request a read-write version of this mailbox. If a false value, request a read-only version. (type: bool)
ReturnsThe 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)
def delete(name): (source)

Delete the mailbox with the specified name.

ParametersnameThe mailbox to delete. (type: bytes)
ReturnsA true value if the mailbox is successfully deleted, or a Deferred whose callback will be invoked when the deletion completes. (type: Deferred or bool)
RaisesMailboxExceptionRaised if this mailbox cannot be deleted. This may also be raised asynchronously, if a Deferred is returned.
def rename(oldname, newname): (source)

Rename a mailbox

ParametersoldnameThe current name of the mailbox to rename. (type: bytes)
newnameThe new name to associate with the mailbox. (type: bytes)
ReturnsA 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)
RaisesMailboxExceptionRaised if this mailbox cannot be renamed. This may also be raised asynchronously, if a Deferred is returned.
def isSubscribed(name): (source)

Check the subscription status of a mailbox

ParametersnameThe name of the mailbox to check (type: bytes)
ReturnsA 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)
def subscribe(name): (source)

Subscribe to a mailbox

ParametersnameThe name of the mailbox to subscribe to (type: bytes)
ReturnsA 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)
RaisesMailboxExceptionRaised if this mailbox cannot be subscribed to. This may also be raised asynchronously, if a Deferred is returned.
def unsubscribe(name): (source)

Unsubscribe from a mailbox

ParametersnameThe name of the mailbox to unsubscribe from (type: bytes)
ReturnsA 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)
RaisesMailboxExceptionRaised if this mailbox cannot be unsubscribed from. This may also be raised asynchronously, if a Deferred is returned.
def listMailboxes(ref, wildcard): (source)

List all the mailboxes that meet a certain criteria

ParametersrefThe context in which to apply the wildcard (type: bytes)
wildcardAn 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)
ReturnsA 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)
API Documentation for Twisted, generated by pydoctor 20.12.1 at 2021-02-28 19:53:36.