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`.`smtp`.`User``

class documentation

`class User: (source)`

View In Hierarchy

Hold information about and SMTP message recipient, including information on where the message came from

Method | `__bytes__` | Undocumented
Method | `__getstate__` | Helper for pickle.
Method | `__init__` | Undocumented
Method | `__str__` | Undocumented
Instance Variable | `dest` | Undocumented
Instance Variable | `helo` | Undocumented
Instance Variable | `orig` | Undocumented
Instance Variable | `protocol` | Undocumented

def __bytes__(self): (source)

Undocumented

Returns
`bytes` | Undocumented

def __getstate__(self): (source)

Helper for pickle.

protocol isn't picklabe, but we want User to be, so skip it in the pickle.

def __init__(self, destination, helo, protocol, orig): (source)

Undocumented

def __str__(self): (source)

Undocumented

Returns
`str` | Undocumented

dest = (source)

Undocumented

helo = (source)

Undocumented

orig = (source)

Undocumented

protocol = (source)

Undocumented