twisted.mail.smtp.ESMTP : API documentation

class documentation

class twisted.mail.smtp.ESMTP(SMTP): (source)

Undocumented

Instance Variable	ctx	Undocumented
Instance Variable	canStartTLS	Undocumented
Instance Variable	startedTLS	Undocumented
Instance Variable	authenticated	Undocumented
Method	__init__	Undocumented
Instance Variable	challengers	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
Instance Variable	mode	Undocumented
Instance Variable	challenger	Undocumented
Instance Variable	challenge	Undocumented
Method	state_AUTH	Handle one step of challenge/response authentication.
Instance Variable	_helo	Undocumented
Instance Variable	_from	Undocumented
Instance Variable	_to	Undocumented
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:

Property	host	Undocumented
Class Variable	timeout	Undocumented
Class Variable	portal	Undocumented
Class Variable	noisy	Undocumented
Instance Variable	deliveryFactory	Undocumented
Instance Variable	delivery	Undocumented
Method	host.setter	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
Class Variable	qstring	Undocumented
Class Variable	mail_re	Undocumented
Class Variable	rcpt_re	Undocumented
Method	do_MAIL	Undocumented
Method	do_RCPT	Undocumented
Method	do_DATA	Undocumented
Instance Variable	datafailed	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
Instance Variable	_onLogout	Undocumented
Instance Variable	_host	Undocumented
Method	_cbFromValidate	Undocumented
Method	_ebFromValidate	Undocumented
Method	_cbToValidate	Undocumented
Method	_ebToValidate	Undocumented
Method	_disconnect	Undocumented
Instance Variable	__messages	Undocumented
Instance Variable	__inheader	Undocumented
Instance Variable	__inbody	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.
Instance Variable	_buffer	Undocumented

Inherited from Protocol (via SMTP, LineOnlyReceiver):

Class Variable	factory	Undocumented
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):

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

Inherited from TimeoutMixin (via SMTP):

Instance 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
Instance Variable	__timeoutCall	Undocumented
Method	__timedOut	Undocumented

ctx = (source)

Undocumented

canStartTLS = (source)

Undocumented

startedTLS = (source)

Undocumented

(type: bool)

authenticated = (source)

Undocumented

(type: bool)

def __init__(self, chal=None, contextFactory=None): (source)

overrides twisted.mail.smtp.SMTP.__init__

Undocumented

challengers = (source)

Undocumented

def connectionMade(self): (source)

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

overrides twisted.mail.smtp.SMTP.greeting

Undocumented

def extensions(self): (source)

SMTP service extensions

Returns the 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): (source)

overrides twisted.mail.smtp.SMTP.lookupMethod

Parameters	command	The command to get from this class. (type: `str`)
Returns	The function which executes this command.

def listExtensions(self): (source)

Undocumented

def do_EHLO(self, rest): (source)

Undocumented

_helo = (source)

overrides twisted.mail.smtp.SMTP._helo

Undocumented

_from = (source)

overrides twisted.mail.smtp.SMTP._from

Undocumented

_to = (source)

overrides twisted.mail.smtp.SMTP._to

Undocumented

(type: list)

def ext_STARTTLS(self, rest): (source)

Undocumented

def ext_AUTH(self, rest): (source)

Undocumented

mode = (source)

overrides twisted.mail.smtp.SMTP.mode

Undocumented

challenger = (source)

overrides twisted.mail.smtp.SMTP.challenger

Undocumented

def _cbAuthenticated(self, loginInfo): (source)

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

def _ebAuthenticated(self, reason): (source)

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.

Parameters reason Reason for failure.

challenge = (source)

Undocumented

def state_AUTH(self, response): (source)

Handle one step of challenge/response authentication.

Parameters response The 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 20.12.1 at 2021-02-28 19:53:36.