twisted.mail.imap4.MemoryAccount : API documentation

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	getPersonalNamespaces	Report the available personal namespaces.
Method	getSharedNamespaces	Report the available shared namespaces.
Method	getOtherNamespaces	Undocumented
Method	_emptyMailbox	Undocumented
Method	_inferiorNames	Undocumented

def __init__(self, name): (source)

Undocumented

def allocateID(self): (source)

Undocumented

def addMailbox(self, name, mbox=None): (source)

from twisted.mail.imap4.IAccount

Add a new mailbox to this account

Parameters	name	The name associated with this mailbox. It may not contain multiple hierarchical parts. (type: `str`)
	mbox	The mailbox to associate with this name. If `None`, a suitable default is created and used. (type: An object implementing `IMailbox`)
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.

def create(self, pathspec): (source)

from twisted.mail.imap4.IAccount

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: `str`)
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.

def _emptyMailbox(self, name, id): (source)

Undocumented

def select(self, name, readwrite=1): (source)

from twisted.mail.imap4.IAccount

Acquire a mailbox, given its name.

Parameters	name	The mailbox to acquire (type: `str`)
	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 `IMailbox` or `Deferred`)

def delete(self, name): (source)

from twisted.mail.imap4.IAccount

Delete the mailbox with the specified name.

Parameters	name	The mailbox to delete. (type: `str`)
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.

def rename(self, oldname, newname): (source)

from twisted.mail.imap4.IAccount

Rename a mailbox

Parameters	oldname	The current name of the mailbox to rename. (type: `str`)
	newname	The new name to associate with the mailbox. (type: `str`)
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.

def _inferiorNames(self, name): (source)

Undocumented

def isSubscribed(self, name): (source)

from twisted.mail.imap4.IAccount

Check the subscription status of a mailbox

Parameters	name	The name of the mailbox to check (type: `str`)
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`)

def subscribe(self, name): (source)

from twisted.mail.imap4.IAccount

Subscribe to a mailbox

Parameters	name	The name of the mailbox to subscribe to (type: `str`)
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.

def unsubscribe(self, name): (source)

from twisted.mail.imap4.IAccount

Unsubscribe from a mailbox

Parameters	name	The name of the mailbox to unsubscribe from (type: `str`)
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.

def listMailboxes(self, ref, wildcard): (source)

from twisted.mail.imap4.IAccount

List all the mailboxes that meet a certain criteria

Parameters	ref	The context in which to apply the wildcard (type: `str`)
	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: `str`)
Returns	A list of `(mailboxName, mailboxObject)` which meet the given criteria. `mailboxObject` should implement either `IMailboxInfo` or `IMailbox`. A Deferred may also be returned. (type: `list` of `tuple`)

def getPersonalNamespaces(self): (source)

from twisted.mail.imap4.INamespacePresenter

Report the available personal namespaces.

Typically there should be only one personal namespace. A common name for it is "", and its hierarchical delimiter is usually "/".

Returns The personal namespaces and their hierarchical delimiters. If no namespaces of this type exist, None should be returned. (type: iterable of two-tuples of strings)

def getSharedNamespaces(self): (source)

from twisted.mail.imap4.INamespacePresenter

Report the available shared namespaces.

Shared namespaces do not belong to any individual user but are usually to one or more of them. Examples of shared namespaces might be "#news" for a usenet gateway.

Returns The shared namespaces and their hierarchical delimiters. If no namespaces of this type exist, None should be returned. (type: iterable of two-tuples of strings)

t.m.i.MemoryAccount(object) : class documentation