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`.`ICloseableMailboxIMAP``

interface documentation

`class ICloseableMailboxIMAP(Interface): (source)`

View In Hierarchy

A supplementary interface for mailboxes which require cleanup on close.

Implementing this interface is optional. If it is implemented, the protocol code will call the close method defined whenever a mailbox is closed.

Method | `close` | Close this mailbox.

def close(): (source)

Close this mailbox.

Returns
A `Deferred` which fires when this mailbox has been closed, or None if the mailbox can be closed immediately.