twisted.mail.smtp.ESMTP(SMTP) class documentation

Part of twisted.mail.smtp (View In Hierarchy)

Known subclasses: twisted.mail.test.test_smtp.DummyESMTP

No class docstring
Method __init__ Undocumented
Method connectionMade Called when a connection is made.
Method greeting Undocumented
Method extensions SMTP service extensions
Method lookupMethod
Method listExtensions Undocumented
Method do_EHLO Undocumented
Method ext_STARTTLS Undocumented
Method ext_AUTH Undocumented
Method state_AUTH Handle one step of challenge/response authentication.
Method _cbAuthenticated Save the state resulting from a successful cred login and mark this connection as authenticated.
Method _ebAuthenticated Handle cred login errors by translating them to the SMTP authenticate failed. Translate all other errors into a generic SMTP error code and log the failure for inspection. Stop all errors from propagating.

Inherited from SMTP:

Instance Variable host 0 The hostname of this mail server. (type: bytes)
Method host 1 Undocumented
Method host Undocumented
Method timeoutConnection Called when the connection times out.
Method sendCode Send an SMTP code with a message.
Method lineReceived Override this for when each line is received.
Method state_COMMAND Undocumented
Method sendSyntaxError Undocumented
Method lineLengthExceeded Called when the maximum line length has been reached. Override if it needs to be dealt with in some special way.
Method do_UNKNOWN Undocumented
Method do_HELO Undocumented
Method do_QUIT Undocumented
Method do_MAIL Undocumented
Method do_RCPT Undocumented
Method do_DATA Undocumented
Method connectionLost Called when the connection is shut down.
Method do_RSET Undocumented
Method dataLineReceived Undocumented
Method validateFrom Validate the address from which the message originates.
Method validateTo Validate the address for which the message is destined.
Method receivedHeader Undocumented
Method _cbFromValidate Undocumented
Method _ebFromValidate Undocumented
Method _cbToValidate Undocumented
Method _ebToValidate Undocumented
Method _disconnect Undocumented
Method _messageHandled Undocumented
Method _cbAnonymousAuthentication Save the state resulting from a successful anonymous cred login.

Inherited from LineOnlyReceiver (via SMTP):

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 dataReceived Translates bytes into lines, and calls lineReceived.
Method sendLine Sends a line to the other end of the connection.

Inherited from Protocol (via SMTP, LineOnlyReceiver):

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

Inherited from BaseProtocol (via SMTP, LineOnlyReceiver, Protocol):

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

Inherited from TimeoutMixin (via SMTP):

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, chal=None, contextFactory=None):
overrides twisted.mail.smtp.SMTP.__init__
Undocumented
def connectionMade(self):
from twisted.internet.interfaces.IProtocol
overrides twisted.mail.smtp.SMTP.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 greeting(self):
overrides twisted.mail.smtp.SMTP.greeting
Undocumented
def extensions(self):

SMTP service extensions

Returnsthe SMTP service extensions that are supported. (type: dict with bytes keys and a value of either None or a list of bytes.)
def lookupMethod(self, command):
overrides twisted.mail.smtp.SMTP.lookupMethod
ParameterscommandThe command to get from this class. (type: str)
ReturnsThe function which executes this command.
def listExtensions(self):
Undocumented
def do_EHLO(self, rest):
Undocumented
def ext_STARTTLS(self, rest):
Undocumented
def ext_AUTH(self, rest):
Undocumented
def _cbAuthenticated(self, loginInfo):

Save the state resulting from a successful cred login and mark this connection as authenticated.

def _ebAuthenticated(self, reason):

Handle cred login errors by translating them to the SMTP authenticate failed. Translate all other errors into a generic SMTP error code and log the failure for inspection. Stop all errors from propagating.

ParametersreasonReason for failure.
def state_AUTH(self, response):

Handle one step of challenge/response authentication.

ParametersresponseThe text of a response. If None, this function has been called as a result of an AUTH command with no initial response. A response of '*' aborts authentication, as per RFC 2554.
API Documentation for twisted, generated by pydoctor at 2020-03-25 17:34:30.