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

class documentation

`class _MultipartMessageStructure(_MessageStructure): (source)`

Constructor: `_MultipartMessageStructure(message, subtype, attrs)`

View In Hierarchy

`_MultipartMessageStructure` represents the message structure of a multipart/* message.

Method | `__init__` | No summary
Method | `encode` | Encode each sub-message and added the additional multipart fields.
Instance Variable | `subtype` | Undocumented
Method | `_extended` | The extension data of a multipart body part are in the following order:
Method | `_getParts` | Return an iterator over all of the sub-messages of this message.

Inherited from `_MessageStructure`:

Instance Variable | `attrs` | Undocumented
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 __init__(self, message, subtype, attrs): (source)
overrides `twisted.mail.imap4._MessageStructure.__init__`

Parameters
message | An `IMessagePart` provider which this structure object reports on.
subtype | A `str` giving the MIME subtype of the message (for example, `"plain"`).
attrs | A `dict` giving the parameters of the Content-Type header of the message.

def encode(self, extended): (source)

Encode each sub-message and added the additional multipart fields.

subtype = (source)

Undocumented

def _extended(self): (source)

The extension data of a multipart body part are in the following order:

1. body parameter parenthesized list A parenthesized list of attribute/value pairs [e.g., ("foo" "bar" "baz" "rag") where "bar" is the value of "foo", and "rag" is the value of "baz"] as defined in [MIME-IMB].
2. body disposition A parenthesized list, consisting of a disposition type string, followed by a parenthesized list of disposition attribute/value pairs as defined in [DISPOSITION].
3. body language A string or parenthesized list giving the body language value as defined in [LANGUAGE-TAGS].
4. body location A string list giving the body content URI as defined in [LOCATION].

def _getParts(self): (source)

Return an iterator over all of the sub-messages of this message.