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`.`imap4`.`_TextMessageStructure``

class documentation

`class _TextMessageStructure(_SinglepartMessageStructure): (source)`

Constructor: `_TextMessageStructure(message, main, subtype, attrs)`

View In Hierarchy

`_TextMessageStructure` represents the message structure of a text/* message.

Method | `encode` | A body type of type TEXT contains, immediately after the basic fields, the size of the body in text lines. Note that this size is the size in its content transfer encoding and not the resulting size after any decoding.

Inherited from `_SinglepartMessageStructure`:

Method | `__init__` | No summary
Instance Variable | `attrs` | Undocumented
Instance Variable | `main` | Undocumented
Instance Variable | `subtype` | Undocumented
Method | `_basicFields` | Return a list of the basic fields for a single-part message.
Method | `_extended` | The extension data of a non-multipart body part are in the following order:
Constant | `_HEADERS` | Undocumented

Inherited from `_MessageStructure` (via `_SinglepartMessageStructure`):

Instance Variable | `message` | Undocumented
Method | `_disposition` | Parse a Content-Disposition header into a two-sequence of the disposition and a flattened list of its parameters.
Method | `_unquotedAttrs` | No summary

def encode(self, extended): (source)
overrides `twisted.mail.imap4._SinglepartMessageStructure.encode`

A body type of type TEXT contains, immediately after the basic fields, the size of the body in text lines. Note that this size is the size in its content transfer encoding and not the resulting size after any decoding.