t.m.i.INamespacePresenter(Interface) : interface documentation

Part of twisted.mail.imap4 View Source View In Hierarchy

Known implementations: twisted.mail.imap4.MemoryAccount

No interface docstring
Method getPersonalNamespaces Report the available personal namespaces.
Method getSharedNamespaces Report the available shared namespaces.
Method getUserNamespaces Report the available user namespaces.
def getPersonalNamespaces(): (source)
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 "/".

ReturnsThe 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(): (source)
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.

ReturnsThe shared namespaces and their hierarchical delimiters. If no namespaces of this type exist, None should be returned. (type: iterable of two-tuples of strings)
def getUserNamespaces(): (source)
Report the available user namespaces.

These are namespaces that contain folders belonging to other users access to which this account has been granted.

ReturnsThe user namespaces and their hierarchical delimiters. If no namespaces of this type exist, None should be returned. (type: iterable of two-tuples of strings)
API Documentation for Twisted, generated by pydoctor at 2012-09-01 11:44:56.