t.m.r.ESMTPManagedRelayer(ManagedRelayerMixin, relay.ESMTPRelayer) : class documentation

Part of twisted.mail.relaymanager View Source View In Hierarchy

No class docstring
Method __init__

Inherited from ManagedRelayerMixin:

Method sentMail called when e-mail has been sent
Method connectionLost called when connection is broken

Inherited from RelayerMixin (via ESMTPRelayer):

Method loadMessages Undocumented
Method getMailFrom Undocumented
Method getMailTo Undocumented
Method getMailData Undocumented
Method sentMail Since we only use one recipient per envelope, this will be called with 0 or 1 addresses. We probably want to do something with the error message if we failed.

Inherited from ESMTPClient (via ESMTPRelayer):

Method __getattr__ Undocumented
Method __setattr__ Undocumented
Method esmtpEHLORequired Undocumented
Method esmtpAUTHRequired Undocumented
Method esmtpTLSRequired Undocumented
Method esmtpTLSFailed Undocumented
Method esmtpAUTHDeclined Undocumented
Method esmtpAUTHMalformedChallenge Undocumented
Method esmtpAUTHServerError Undocumented
Method registerAuthenticator No summary
Method connectionMade Called when a connection is made.
Method esmtpState_ehlo Undocumented
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 tryTLS Take a necessary step towards being able to begin a mail transaction.
Method esmtpState_starttls Handle a positive response to the STARTTLS command by starting a new TLS session on self.transport.
Method authenticate Undocumented
Method esmtpState_challenge Undocumented
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 _esmtpState_plainAuth Undocumented
Method _authResponse Undocumented

Inherited from SMTPClient (via ESMTPRelayer, ESMTPClient):

Method sendLine Sends a line to the other end of the connection.
Method connectionLost We are no longer connected
Method timeoutConnection Called when the connection times out.
Method lineReceived Override this for when each line is received.
Method smtpConnectionFailed Undocumented
Method smtpTransferFailed Undocumented
Method smtpState_helo Undocumented
Method smtpState_from Undocumented
Method smtpState_disconnect Undocumented
Method smtpState_to Undocumented
Method smtpState_toOrData Undocumented
Method smtpState_data Undocumented
Method smtpState_msgSent Undocumented
Method transformChunk Perform the necessary local to network newline conversion and escape leading periods.
Method finishedFileTransfer Undocumented
Method getMailFrom Return the email address the mail is from.
Method getMailTo Return a list of emails to send to.
Method getMailData Return file-like object containing data of message to be sent.
Method sendError If an error occurs before a mail message is sent sendError will be called. This base class method sends a QUIT if the error is non-fatal and disconnects the connection.
Method sentMail Called when an attempt to send an email is completed.
Method _disconnectFromServer Undocumented

Inherited from LineReceiver (via ESMTPRelayer, ESMTPClient, SMTPClient):

Class Variable delimiter The line-ending delimiter to use. By default this is b'\r\n'.
Class Variable 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.
Method clearLineBuffer Clear buffered data.
Method dataReceived Protocol.dataReceived. Translates bytes into lines, and calls lineReceived (or rawDataReceived, depending on mode.)
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.
Method rawDataReceived Override this for when raw data is received.
Method lineLengthExceeded Called when the maximum line length has been reached. Override if it needs to be dealt with in some special way.

Inherited from Protocol (via ESMTPRelayer, ESMTPClient, SMTPClient, LineReceiver):

Method logPrefix Return a prefix matching the class name, to identify log messages related to this protocol instance.

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

Method makeConnection Make a connection to a transport and a server.

Inherited from _PauseableMixin (via ESMTPRelayer, ESMTPClient, SMTPClient, LineReceiver):

Method pauseProducing Undocumented
Method resumeProducing Undocumented
Method stopProducing Undocumented

Inherited from TimeoutMixin (via ESMTPRelayer, ESMTPClient, SMTPClient):

Class Variable timeOut The number of seconds after which to timeout the connection.
Method callLater Wrapper around reactor.callLater for test purpose.
Method resetTimeout Reset the timeout count down.
Method setTimeout Change the timeout period
Method __timedOut Undocumented
def __init__(self, messages, manager, *args, **kw): (source)
ParametersmessagesFilenames of messages to relay

manager should support .notifySuccess, .notifyFailure and .notifyDone

(type: list of str)
API Documentation for Twisted, generated by pydoctor at 2013-11-08 22:07:30.