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

module documentation
(source)

Infrastructure for relaying mail through a smart host.

Traditional peer-to-peer email has been increasingly replaced by smart host configurations. Instead of sending mail directly to the recipient, a sender sends mail to a smart host. The smart host finds the mail exchange server for the recipient and sends on the message.

Class | `ESMTPManagedRelayer` | An ESMTP managed relayer.
Class | `ESMTPManagedRelayerFactory` | A factory to create an `ESMTPManagedRelayer`.
Class | `ManagedRelayerMixin` | SMTP Relayer which notifies a manager
Class | `MXCalculator` | A utility for looking up mail exchange hosts and tracking whether they are working or not.
Class | `Queue` | A queue for messages to be relayed.
Class | `SmartHostESMTPRelayingManager` | A smart host which uses ESMTP managed relayers to send messages from the relay queue.
Class | `SmartHostSMTPRelayingManager` | A smart host which uses SMTP managed relayers to send messages from the relay queue.
Class | `SMTPManagedRelayer` | An SMTP managed relayer.
Class | `SMTPManagedRelayerFactory` | A factory to create an `SMTPManagedRelayer`.
Exception | `CanonicalNameChainTooLong` | An error indicating that when trying to look up a mail exchange host, too many canonical name records which point to other canonical name records were encountered and resolution was abandoned.
Exception | `CanonicalNameLoop` | An error indicating that when trying to look up a mail exchange host, a set of canonical name records was found which form a cycle and resolution was abandoned.
Function | `RelayStateHelper` | Set up a periodic call to prompt a relaying manager to check state.
Class | `_AttemptManager` | A manager for an attempt to relay a set of messages to a mail exchange server.
Function | `_checkState` | Prompt a relaying manager to check state.

def RelayStateHelper(manager, delay): (source)

Set up a periodic call to prompt a relaying manager to check state.

Parameters
manager:`SmartHostSMTPRelayingManager` | A relaying manager.
delay:`float` | The number of seconds between calls.
Returns
`TimerService` | A service which periodically reminds a relaying manager to check state.

def _checkState(manager): (source)

Prompt a relaying manager to check state.

Parameters
manager:`SmartHostSMTPRelayingManager` | A relaying manager.