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

class documentation

`class ESMTPSender(SenderMixin, ESMTPClient): (source)`

Constructor: `ESMTPSender(username, secret, contextFactory, *args, **kw)`

View In Hierarchy

Undocumented

Method | `__init__` | Undocumented
Instance Variable | `heloFallback` | Undocumented
Instance Variable | `requireAuthentication` | Undocumented
Instance Variable | `requireTransportSecurity` | Undocumented
Instance Variable | `username` | Undocumented
Method | `_getContextFactory` | Undocumented
Method | `_registerAuthenticators` | Undocumented
Instance Variable | `_hostname` | Undocumented

Inherited from `SenderMixin`:

Method | `getMailData` | Undocumented
Method | `getMailFrom` | Undocumented
Method | `getMailTo` | Undocumented
Method | `sendError` | Undocumented
Method | `sentMail` | Undocumented
Instance Variable | `done` | Undocumented

Inherited from `ESMTPClient` (via `SenderMixin`):

Method | `__getattr__` | Undocumented
Method | `__setattr__` | Undocumented
Method | `authenticate` | Undocumented
Method | `connectionMade` | Called when a connection has been made, and triggers sending an `EHLO` to the server.
Method | `esmtpAUTHDeclined` | Fail because the authentication was rejected.
Method | `esmtpAUTHMalformedChallenge` | Fail because the server sent a malformed authentication challenge.
Method | `esmtpAUTHRequired` | Fail because authentication is required, but the server does not support any schemes we support.
Method | `esmtpAUTHServerError` | Fail because of some other authentication error.
Method | `esmtpEHLORequired` | Fail because authentication is required, but the server does not support ESMTP, which is required for authentication.
Method | `esmtpState_challenge` | Undocumented
Method | `esmtpState_ehlo` | Send an `EHLO` to the server.
Method | `esmtpState_serverConfig` | Handle a positive response to the EHLO command by parsing the capabilities in the server's response and then taking the most appropriate next step towards entering a mail transaction.
Method | `esmtpState_starttls` | Handle a positive response to the STARTTLS command by starting a new TLS session on `self.transport`.
Method | `esmtpTLSFailed` | Fail because the TLS handshake wasn't able to be completed.
Method | `esmtpTLSRequired` | Fail because TLS is required and the server does not support it.
Method | `registerAuthenticator` | Registers an Authenticator with the ESMTPClient. The ESMTPClient will attempt to login to the SMTP Server in the order the Authenticators are registered. The most secure Authentication mechanism should be registered first.
Method | `smtpState_maybeAuthenticated` | Called to handle the next message from the server after sending a response to a SASL challenge. The server response might be another challenge or it might indicate authentication has succeeded.
Method | `tryTLS` | Take a necessary step towards being able to begin a mail transaction.
Instance Variable | `authenticators` | Undocumented
Instance Variable | `context` | The context factory to use for STARTTLS, if desired.
Instance Variable | `secret` | Undocumented
Method | `_authResponse` | Undocumented
Method | `_esmtpState_plainAuth` | Undocumented
Instance Variable | `_authinfo` | Undocumented
Instance Variable | `_expected` | Undocumented
Instance Variable | `_failresponse` | Undocumented
Instance Variable | `_okresponse` | Undocumented
Instance Variable | `_tlsMode` | Whether or not the connection is over TLS.

Inherited from `SMTPClient` (via `SenderMixin`, `ESMTPClient`):

Method | `connectionLost` | We are no longer connected
Method | `finishedFileTransfer` | Undocumented
Method | `lineReceived` | Override this for when each line is received.
Method | `sendLine` | Sends a line to the other end of the connection.
Method | `smtpConnectionFailed` | Undocumented
Method | `smtpState_data` | Undocumented
Method | `smtpState_disconnect` | Undocumented
Method | `smtpState_from` | Undocumented
Method | `smtpState_helo` | Undocumented
Method | `smtpState_msgSent` | Undocumented
Method | `smtpState_to` | Undocumented
Method | `smtpState_toOrData` | Undocumented
Method | `smtpTransferFailed` | Undocumented
Method | `timeoutConnection` | Called when the connection times out.
Method | `transformChunk` | Perform the necessary local to network newline conversion and escape leading periods.
Class Variable | `debug` | Undocumented
Class Variable | `timeout` | Undocumented
Instance Variable | `code` | Undocumented
Instance Variable | `identity` | Undocumented
Instance Variable | `lastAddress` | Undocumented
Instance Variable | `log` | Undocumented
Instance Variable | `mailFile` | Undocumented
Instance Variable | `resp` | Undocumented
Instance Variable | `successAddresses` | Undocumented
Instance Variable | `toAddresses` | Undocumented
Instance Variable | `toAddressesResult` | Undocumented
Method | `_disconnectFromServer` | Undocumented
Instance Variable | `_from` | Undocumented

Inherited from `LineReceiver` (via `SenderMixin`, `ESMTPClient`, `SMTPClient`):

Method | `clearLineBuffer` | Clear buffered data.
Method | `dataReceived` | Protocol.dataReceived. Translates bytes into lines, and calls lineReceived (or rawDataReceived, depending on mode.)
Method | `lineLengthExceeded` | Called when the maximum line length has been reached. Override if it needs to be dealt with in some special way.
Method | `rawDataReceived` | Override this for when raw data is received.
Method | `setLineMode` | Sets the line-mode of this receiver.
Method | `setRawMode` | Sets the raw mode of this receiver. Further data received will be sent to rawDataReceived rather than lineReceived.
Constant | `MAX_LENGTH` | The maximum length of a line to allow (If a sent line is longer than this, the connection is dropped). Default is 16384.
Class Variable | `delimiter` | The line-ending delimiter to use. By default this is `b'\r\n'`.
Instance Variable | `line_mode` | Undocumented
Instance Variable | `_buffer` | Undocumented
Instance Variable | `_busyReceiving` | Undocumented

Inherited from `Protocol` (via `SenderMixin`, `ESMTPClient`, `SMTPClient`, `LineReceiver`):

Method | `logPrefix` | Return a prefix matching the class name, to identify log messages related to this protocol instance.
Class Variable | `factory` | Undocumented

Inherited from `BaseProtocol` (via `SenderMixin`, `ESMTPClient`, `SMTPClient`, `LineReceiver`, `Protocol`):

Method | `makeConnection` | Make a connection to a transport and a server.
Instance Variable | `connected` | Undocumented
Instance Variable | `transport` | Undocumented

Inherited from `_PauseableMixin` (via `SenderMixin`, `ESMTPClient`, `SMTPClient`, `LineReceiver`, `Protocol`, `BaseProtocol`):

Method | `pauseProducing` | Undocumented
Method | `resumeProducing` | Undocumented
Method | `stopProducing` | Undocumented
Instance Variable | `paused` | Undocumented

Inherited from `TimeoutMixin` (via `SenderMixin`, `ESMTPClient`, `SMTPClient`, `LineReceiver`, `Protocol`, `BaseProtocol`, `_PauseableMixin`):

Method | `callLater` | Wrapper around `reactor.callLater` for test purpose.
Method | `resetTimeout` | Reset the timeout count down.
Method | `setTimeout` | Change the timeout period
Instance Variable | `timeOut` | The number of seconds after which to timeout the connection.
Method | `__timedOut` | Undocumented
Instance Variable | `__timeoutCall` | Undocumented

def __init__(self, username, secret, contextFactory=None, *args, **kw): (source)
overrides `twisted.mail.smtp.ESMTPClient.__init__`

Undocumented

heloFallback: `int` = (source)
overrides `twisted.mail.smtp.ESMTPClient.heloFallback`

Undocumented

requireAuthentication: `bool` = (source)
overrides `twisted.mail.smtp.ESMTPClient.requireAuthentication`

Undocumented

requireTransportSecurity: `bool` = (source)
overrides `twisted.mail.smtp.ESMTPClient.requireTransportSecurity`

Undocumented

username = (source)

Undocumented

def _getContextFactory(self): (source)

Undocumented

def _registerAuthenticators(self): (source)

Undocumented

_hostname = (source)

Undocumented