t.m.s.ESMTPClient(SMTPClient) : class documentation

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

Known subclasses: twisted.mail.relay.ESMTPRelayer, twisted.mail.smtp.ESMTPSender

No class docstring
Method __init__ Undocumented
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:

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 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 SMTPClient, LineReceiver):

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

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

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

Inherited from _PauseableMixin (via SMTPClient, LineReceiver):

Method pauseProducing Undocumented
Method resumeProducing Undocumented
Method stopProducing Undocumented

Inherited from TimeoutMixin (via 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, secret, *args, contextFactory=None, **kw): (source)
overrides twisted.mail.smtp.SMTPClient.__init__
overridden in twisted.mail.relay.ESMTPRelayer, twisted.mail.smtp.ESMTPSender
Undocumented
def __getattr__(self, name): (source)
Undocumented
def __setattr__(self, name, value): (source)
Undocumented
def esmtpEHLORequired(self, code=-1, resp=None): (source)
Undocumented
def esmtpAUTHRequired(self, code=-1, resp=None): (source)
Undocumented
def esmtpTLSRequired(self, code=-1, resp=None): (source)
Undocumented
def esmtpTLSFailed(self, code=-1, resp=None): (source)
Undocumented
def esmtpAUTHDeclined(self, code=-1, resp=None): (source)
Undocumented
def esmtpAUTHMalformedChallenge(self, code=-1, resp=None): (source)
Undocumented
def esmtpAUTHServerError(self, code=-1, resp=None): (source)
Undocumented
def registerAuthenticator(self, auth): (source)
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.
ParametersauthThe Authentication mechanism to register (type: class implementing IClientAuthentication)
def connectionMade(self): (source)
overrides twisted.mail.smtp.SMTPClient.connectionMade
Called when a connection is made.

This may be considered the initializer of the protocol, because it is called when the connection is completed. For clients, this is called once the connection to the server has been established; for servers, this is called after an accept() call stops blocking and a socket has been received. If you need to send any greeting or initial message, do it here.

def esmtpState_ehlo(self, code, resp): (source)
Undocumented
def esmtpState_serverConfig(self, code, resp): (source)
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.
def tryTLS(self, code, resp, items): (source)
Take a necessary step towards being able to begin a mail transaction.

The step may be to ask the server to being a TLS session. If TLS is already in use or not necessary and not available then the step may be to authenticate with the server. If TLS is necessary and not available, fail the mail transmission attempt.

This is an internal helper method.

ParameterscodeThe server status code from the most recently received server message. (type: int)
respThe server status response from the most recently received server message. (type: bytes)
itemsA mapping of ESMTP extensions offered by the server. Keys are extension identifiers and values are the associated values. (type: dict mapping bytes to bytes)
ReturnsNone
def esmtpState_starttls(self, code, resp): (source)
Handle a positive response to the STARTTLS command by starting a new TLS session on self.transport.

Upon success, re-handshake with the server to discover what capabilities it has when TLS is in use.

def authenticate(self, code, resp, items): (source)
Undocumented
def _esmtpState_plainAuth(self, code, resp): (source)
Undocumented
def esmtpState_challenge(self, code, resp): (source)
Undocumented
def _authResponse(self, auth, challenge): (source)
Undocumented
def smtpState_maybeAuthenticated(self, code, resp): (source)
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.
API Documentation for Twisted, generated by pydoctor at 2014-05-12 18:27:00.