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 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 Undocumented
Method tryTLS Undocumented
Method esmtpState_starttls Undocumented
Method authenticate Undocumented
Method esmtpState_challenge Undocumented
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. Override to define behavior other than dropping the connection.
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 Undocumented
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):

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 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):

Method callLater Undocumented
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)
def esmtpEHLORequired(self, code=-1, resp=None): (source)
def esmtpAUTHRequired(self, code=-1, resp=None): (source)
def esmtpTLSRequired(self, code=-1, resp=None): (source)
def esmtpTLSFailed(self, code=-1, resp=None): (source)
def esmtpAUTHDeclined(self, code=-1, resp=None): (source)
def esmtpAUTHMalformedChallenge(self, code=-1, resp=None): (source)
def esmtpAUTHServerError(self, code=-1, resp=None): (source)
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)

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)
def esmtpState_serverConfig(self, code, resp): (source)
def tryTLS(self, code, resp, items): (source)
def esmtpState_starttls(self, code, resp): (source)
def authenticate(self, code, resp, items): (source)
def _esmtpState_plainAuth(self, code, resp): (source)
def esmtpState_challenge(self, code, resp): (source)
def _authResponse(self, auth, challenge): (source)
API Documentation for Twisted, generated by pydoctor at 2011-10-27 16:02:37.