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

module documentation
(source)

Maildir-style mailbox support.

Class | `AbstractMaildirDomain` | An abstract maildir-backed domain.
Class | `DirdbmDatabase` | A credentials checker which authenticates users out of a `DirDBM` database.
Class | `MaildirDirdbmDomain` | A maildir-backed domain where membership is checked with a `DirDBM` database.
Class | `MaildirMailbox` | A maildir-backed mailbox.
Class | `MaildirMessage` | A message receiver which adds a header and delivers a message to a file whose name includes the size of the message.
Class | `StringListMailbox` | An in-memory mailbox.
Function | `initializeMaildir` | Create a maildir user directory if it doesn't already exist.
Constant | `INTERNAL_ERROR` | Undocumented
Class | `_MaildirMailboxAppendMessageTask` | A task which adds a message to a maildir mailbox.
Class | `_MaildirNameGenerator` | A utility class to generate a unique maildir name.
Variable | `_generateMaildirName` | Undocumented

def initializeMaildir(dir): (source)

Create a maildir user directory if it doesn't already exist.

Parameters
dir:`bytes` | The path name for a user directory.

INTERNAL_ERROR: `str` = (source)

Undocumented

Value

    '''From: Twisted.mail Internals
    Subject: An Error Occurred

      An internal server error has occurred.  Please contact the
      server administrator.
    '''

_generateMaildirName = (source)

Undocumented