twisted.mail.interfaces.IMailboxIMAPInfo(Interface) interface documentation

Part of twisted.mail.interfaces (View In Hierarchy)

Known subclasses: twisted.mail.interfaces.IMailboxIMAP

Known implementations: twisted.mail.test.test_imap.SimpleMailbox, twisted.mail.test.test_imap.UncloseableMailbox

Interface specifying only the methods required for listMailboxes.

Implementations can return objects implementing only these methods for return to listMailboxes if it can allow them to operate more efficiently.

Method getFlags Return the flags defined in this mailbox
Method getHierarchicalDelimiter Get the character which delimits namespaces for in this mailbox.
def getFlags():

Return the flags defined in this mailbox

Flags with the \ prefix are reserved for use as system flags.

ReturnsA list of the flags that can be set on messages in this mailbox. (type: list of str)
def getHierarchicalDelimiter():

Get the character which delimits namespaces for in this mailbox.

Returns (type: bytes)
API Documentation for twisted, generated by pydoctor at 2020-03-25 17:34:30.