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

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

Known implementations: twisted.mail.imap4.IMAP4Client, twisted.mail.imap4.IMAP4Server

Interface for objects interested in mailbox events
Method modeChanged Indicates that the write status of a mailbox has changed.
Method flagsChanged Indicates that the flags of one or more messages have changed.
Method newMessages Indicates that the number of messages in a mailbox has changed.
def modeChanged(writeable): (source)
Indicates that the write status of a mailbox has changed.
ParameterswriteableA true value if write is now allowed, false otherwise. (type: bool)
def flagsChanged(newFlags): (source)
Indicates that the flags of one or more messages have changed.
ParametersnewFlagsA mapping of message identifiers to tuples of flags now set on that message. (type: dict)
def newMessages(exists, recent): (source)
Indicates that the number of messages in a mailbox has changed.
ParametersexistsThe total number of messages now in this mailbox. If the total number of messages has not changed, this should be None. (type: int or None)
recentThe number of messages now flagged \Recent. If the number of recent messages has not changed, this should be None. (type: int)
API Documentation for Twisted, generated by pydoctor at 2013-04-03 11:20:05.