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

interface documentation

`class IMessageIMAPFile(Interface): (source)`

View In Hierarchy

Optional message interface for representing messages as files.

If provided by message objects, this interface will be used instead the more complex MIME-based interface.

Method | `open` | Return a file-like object opened for reading.

def open(): (source)

Return a file-like object opened for reading.

Reading from the returned file will return all the bytes of which this message consists.