twisted.mail.smtp.SMTP(basic.LineOnlyReceiver, policies.TimeoutMixin) class documentation

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

Known subclasses: twisted.mail.smtp.ESMTP, twisted.mail.test.test_smtp.DummySMTP

SMTP server-side protocol.

Instance Variable host 0 The hostname of this mail server. (type: bytes)
Method __init__ Undocumented
Method host 1 Undocumented
Method host Undocumented
Method timeoutConnection Called when the connection times out.
Method greeting Undocumented
Method connectionMade Called when a connection is made.
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 lookupMethod
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:

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

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

Inherited from BaseProtocol (via LineOnlyReceiver, Protocol):

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

Inherited from TimeoutMixin:

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
host 0 =
The hostname of this mail server. (type: bytes)
def __init__(self, delivery=None, deliveryFactory=None):
overridden in twisted.mail.smtp.ESMTP
Undocumented
@property
def host 1(self):
Undocumented
@host.setter
def host(self, toSet):
Undocumented
def timeoutConnection(self):
overrides twisted.protocols.policies.TimeoutMixin.timeoutConnection

Called when the connection times out.

Override to define behavior other than dropping the connection.

def greeting(self):
overridden in twisted.mail.smtp.ESMTP
Undocumented
def connectionMade(self):
from twisted.internet.interfaces.IProtocol
overrides twisted.internet.protocol.BaseProtocol.connectionMade
overridden in twisted.mail.smtp.ESMTP

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 sendCode(self, code, message=''):

Send an SMTP code with a message.

def lineReceived(self, line):
overrides twisted.protocols.basic.LineOnlyReceiver.lineReceived

Override this for when each line is received.

ParameterslineThe line which was received with the delimiter removed. (type: bytes)
def state_COMMAND(self, line):
Undocumented
def sendSyntaxError(self):
Undocumented
def lookupMethod(self, command):
overridden in twisted.mail.smtp.ESMTP
ParameterscommandThe command to get from this class. (type: str)
ReturnsThe function which executes this command.
def lineLengthExceeded(self, line):
overrides twisted.protocols.basic.LineOnlyReceiver.lineLengthExceeded

Called when the maximum line length has been reached. Override if it needs to be dealt with in some special way.

def do_UNKNOWN(self, rest):
Undocumented
def do_HELO(self, rest):
Undocumented
def do_QUIT(self, rest):
Undocumented
def do_MAIL(self, rest):
Undocumented
def _cbFromValidate(self, fromEmail, code=250, msg='Sender address accepted'):
Undocumented
def _ebFromValidate(self, failure):
Undocumented
def do_RCPT(self, rest):
Undocumented
def _cbToValidate(self, to, user=None, code=250, msg='Recipient address accepted'):
Undocumented
def _ebToValidate(self, failure):
Undocumented
def _disconnect(self, msgs):
Undocumented
def do_DATA(self, rest):
Undocumented
def connectionLost(self, reason):
from twisted.internet.interfaces.IProtocol
overrides twisted.internet.protocol.Protocol.connectionLost

Called when the connection is shut down.

Clear any circular references here, and any external references to this Protocol. The connection has been closed.

def do_RSET(self, rest):
Undocumented
def dataLineReceived(self, line):
Undocumented
def _messageHandled(self, resultList):
Undocumented
def _cbAnonymousAuthentication(self, result):

Save the state resulting from a successful anonymous cred login.

def validateFrom(self, helo, origin):

Validate the address from which the message originates.

ParametersheloThe argument to the HELO command and the client's IP address. (type: (bytes, bytes))
originThe address the message is from (type: Address)
Returnsorigin or a Deferred whose callback will be passed origin. (type: Deferred or Address)
RaisesSMTPBadSenderRaised of messages from this address are not to be accepted.
def validateTo(self, user):

Validate the address for which the message is destined.

ParametersuserThe address to validate. (type: User)
ReturnsA Deferred which becomes, or a callable which takes no arguments and returns an object implementing IMessage. This will be called and the returned object used to deliver the message when it arrives. (type: no-argument callable)
RaisesSMTPBadRcptRaised if messages to the address are not to be accepted.
def receivedHeader(self, helo, origin, recipients):
Undocumented
API Documentation for twisted, generated by pydoctor at 2020-03-25 17:34:30.