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`.`relaymanager`.`ESMTPManagedRelayerFactory``

class documentation

`class ESMTPManagedRelayerFactory(SMTPManagedRelayerFactory): (source)`

Constructor: `ESMTPManagedRelayerFactory(messages, manager, secret, contextFactory, ...)`

View In Hierarchy

A factory to create an `ESMTPManagedRelayer`.

This factory creates a managed relayer which relays a set of messages over ESMTP and informs an attempt manager of its progress.

Method | `__init__` | No summary
Method | `buildProtocol` | Create an `ESMTPManagedRelayer`.
Instance Variable | `contextFactory` | See `__init__`
Instance Variable | `protocol` | A callable which returns a managed relayer for ESMTP. See `ESMTPManagedRelayer.__init__` for parameters to the callable.
Instance Variable | `secret` | See `__init__`

Inherited from `SMTPManagedRelayerFactory`:

Method | `clientConnectionFailed` | Notify the attempt manager that a connection could not be established.
Instance Variable | `manager` | See `__init__`
Instance Variable | `messages` | See `__init__`
Instance Variable | `pArgs` | Positional arguments for `SMTPClient.__init__`
Instance Variable | `pKwArgs` | Keyword arguments for `SMTPClient.__init__`

Inherited from `ClientFactory` (via `SMTPManagedRelayerFactory`):

Method | `clientConnectionLost` | Called when an established connection is lost.
Method | `startedConnecting` | Called when a connection has been started.

Inherited from `Factory` (via `SMTPManagedRelayerFactory`, `ClientFactory`):

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, messages, manager, secret, contextFactory, *args, **kw): (source)
overrides `twisted.mail.relaymanager.SMTPManagedRelayerFactory.__init__`

Parameters
messages:`list` of `bytes` | The base filenames of messages to be relayed.
manager:`_AttemptManager` | An attempt manager.
secret:`bytes` | A string for the authentication challenge response.
contextFactory:`None` or `ClientContextFactory` | An SSL context factory.
*args:1-`tuple` of (0) `bytes` or 2-`tuple` of (0) `bytes`, (1), `int` | Positional arguments for `SMTPClient.__init__`
**kw | Keyword arguments for `SMTPClient.__init__`

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

Create an `ESMTPManagedRelayer`.

Parameters
addr:`IAddress` provider | The address of the ESMTP server.
Returns
`ESMTPManagedRelayer` | A managed relayer for ESMTP.

contextFactory = (source)

See `__init__`

protocol: callable which returns `ESMTPManagedRelayer` = (source)
overrides `twisted.mail.relaymanager.SMTPManagedRelayerFactory.protocol`

A callable which returns a managed relayer for ESMTP. See `ESMTPManagedRelayer.__init__` for parameters to the callable.

secret = (source)

See `__init__`