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

class documentation

`class MessageProducer: (source)`

Constructor: `MessageProducer(msg, buffer, scheduler)`

View In Hierarchy

Undocumented

Method | `__init__` | Produce this message.
Method | `beginProducing` | Undocumented
Constant | `CHUNK_SIZE` | Undocumented
Instance Variable | `buffer` | Undocumented
Instance Variable | `consumer` | Undocumented
Instance Variable | `msg` | Undocumented
Instance Variable | `scheduler` | Undocumented
Instance Variable | `write` | Undocumented
Method | `_produce` | Undocumented
Class Variable | `_uuid4` | Undocumented

def __init__(self, msg, buffer=None, scheduler=None): (source)

Produce this message.

Parameters
msg:`IMessage` | The message I am to produce.
buffer:file-like | A buffer to hold the message in. If None, I will use a `tempfile.TemporaryFile`.
scheduler | Undocumented

def beginProducing(self, consumer): (source)

Undocumented

CHUNK_SIZE = (source)

Undocumented

Value

    2**(2**(2**2))

buffer = (source)

Undocumented

consumer = (source)

Undocumented

msg = (source)

Undocumented

scheduler = (source)

Undocumented

write = (source)

Undocumented

def _produce(self): (source)

Undocumented

_uuid4 = (source)

Undocumented