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`.`protocols`.`ESMTPFactory``

class documentation

`class ESMTPFactory(SMTPFactory): (source)`

Constructor: `ESMTPFactory(*args)`

View In Hierarchy

An ESMTP server protocol factory.

Method | `__init__` | No summary
Method | `buildProtocol` | Create an instance of an ESMTP server protocol.
Instance Variable | `challengers` | A mapping of acceptable authorization mechanism to callable which creates credentials to use for authentication.
Instance Variable | `context` | A factory to generate contexts to be used in negotiating encrypted communication.
Instance Variable | `protocol` | A callable which creates a protocol. The default value is `ESMTP`.

Inherited from `SMTPFactory`:

Instance Variable | `portal` | See `__init__`
Instance Variable | `service` | See `__init__`

Inherited from `SMTPFactory` (via `SMTPFactory`):

Class Variable | `timeout` | Undocumented

Inherited from `Factory` (via `SMTPFactory`, `SMTPFactory`, `ServerFactory`):

Class Method | `forProtocol` | Create a factory for the given protocol.
Method | `doStart` | Make sure startFactory is called.
Method | `doStop` | Make sure stopFactory is called.
Method | `logPrefix` | Describe this factory for log messages.
Method | `startFactory` | This will be called before I begin listening on a Port or Connector.
Method | `stopFactory` | This will be called before I stop listening on all Ports/Connectors.
Class Variable | `noisy` | Undocumented
Instance Variable | `numPorts` | Undocumented

def __init__(self, *args): (source)
overrides `twisted.mail.protocols.SMTPFactory.__init__`

Parameters
*args | Arguments for `SMTPFactory.__init__`
See Also
`SMTPFactory.__init__`

def buildProtocol(self, addr): (source)
from `twisted.internet.interfaces.IProtocolFactory`
overrides `twisted.mail.protocols.SMTPFactory.buildProtocol`

Create an instance of an ESMTP server protocol.

Parameters
addr:`IAddress` provider | The address of the ESMTP client.
Returns
`ESMTP` | An ESMTP protocol.

challengers: `dict` mapping `bytes` to no-argument callable which returns `ICredentials` subclass provider. = (source)

A mapping of acceptable authorization mechanism to callable which creates credentials to use for authentication.

context: `IOpenSSLContextFactory` or `None` = (source)

A factory to generate contexts to be used in negotiating encrypted communication.

protocol: no-argument callable which returns a `Protocol` subclass = (source)
overrides `twisted.mail.protocols.SMTPFactory.protocol`

A callable which creates a protocol. The default value is `ESMTP`.