Go to the latest version of this document.
search in docstrings

Search bar offers the following options:

- Term presence. The below example searches for documents that must contain “foo”, might contain “bar” and must not contain “baz”: `+foo bar -baz`
- Wildcards. The below example searches for documents with words beginning with “foo”: `foo*`
- Search in specific fields. The following search matches all objects in "twisted.mail" that matches “search”: `+qname:twisted.mail.* +search`

  Possible fields: 'name', 'qname' (fully qualified name), 'docstring', and 'kind'. Last two fields are only applicable if "search in docstrings" is enabled.

- Fuzzy matches. The following search matches all documents that have a word within 1 edit distance of “foo”: `foo~1`

Results provided by Lunr.js

# ``twisted`.`mail`.`interfaces`.`IMailboxIMAPListener``

interface documentation

`class IMailboxIMAPListener(Interface): (source)`

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

View In Hierarchy

Interface for objects interested in mailbox events

Method | `flagsChanged` | Indicates that the flags of one or more messages have changed.
Method | `modeChanged` | Indicates that the write status of a mailbox has changed.
Method | `newMessages` | Indicates that the number of messages in a mailbox has changed.

def flagsChanged(newFlags): (source)

Indicates that the flags of one or more messages have changed.

Parameters
newFlags:`dict` | A mapping of message identifiers to tuples of flags now set on that message.

def modeChanged(writeable): (source)

Indicates that the write status of a mailbox has changed.

Parameters
writeable:`bool` | A true value if write is now allowed, false otherwise.

def newMessages(exists, recent): (source)

Indicates that the number of messages in a mailbox has changed.

Parameters
exists:`int` or `None` | The total number of messages now in this mailbox. If the total number of messages has not changed, this should be `None`.
recent:`int` | The number of messages now flagged `\Recent`. If the number of recent messages has not changed, this should be `None`.