class documentation

class SMTPRelayer(RelayerMixin, smtp.SMTPClient): (source)

Known subclasses: twisted.mail.relaymanager.SMTPManagedRelayer

View In Hierarchy

A base class for SMTP relayers.
Method __init__

Inherited from RelayerMixin:

Method get​Mail​Data Undocumented
Method get​Mail​From Undocumented
Method get​Mail​To Undocumented
Method load​Messages Undocumented
Method sent​Mail Since we only use one recipient per envelope, this will be called with 0 or 1 addresses. We probably want to do something with the error message if we failed.
Instance Variable messages Undocumented
Instance Variable names Undocumented

Inherited from SMTPClient:

Method connection​Lost We are no longer connected
Method connection​Made Called when a connection is made.
Method finished​File​Transfer Undocumented
Method get​Mail​Data Return file-like object containing data of message to be sent.
Method get​Mail​From Return the email address the mail is from.
Method get​Mail​To Return a list of emails to send to.
Method line​Received Override this for when each line is received.
Method send​Error 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 send​Line Sends a line to the other end of the connection.
Method sent​Mail Called when an attempt to send an email is completed.
Method smtp​Connection​Failed Undocumented
Method smtp​State_data Undocumented
Method smtp​State_disconnect Undocumented
Method smtp​State_from Undocumented
Method smtp​State_helo Undocumented
Method smtp​State_msg​Sent Undocumented
Method smtp​State_to Undocumented
Method smtp​State_to​Or​Data Undocumented
Method smtp​Transfer​Failed Undocumented
Method timeout​Connection Called when the connection times out.
Method transform​Chunk Perform the necessary local to network newline conversion and escape leading periods.
Class Variable debug Undocumented
Class Variable timeout Undocumented
Instance Variable code Undocumented
Instance Variable identity Undocumented
Instance Variable last​Address Undocumented
Instance Variable log Undocumented
Instance Variable mail​File Undocumented
Instance Variable resp Undocumented
Instance Variable success​Addresses Undocumented
Instance Variable to​Addresses Undocumented
Instance Variable to​Addresses​Result Undocumented
Method _disconnect​From​Server Undocumented
Instance Variable _expected Undocumented
Instance Variable _failresponse Undocumented
Instance Variable _from Undocumented
Instance Variable _okresponse Undocumented

Inherited from LineReceiver (via SMTPClient):

Method clear​Line​Buffer Clear buffered data.
Method data​Received Protocol.dataReceived. Translates bytes into lines, and calls lineReceived (or rawDataReceived, depending on mode.)
Method line​Length​Exceeded Called when the maximum line length has been reached. Override if it needs to be dealt with in some special way.
Method raw​Data​Received Override this for when raw data is received.
Method set​Line​Mode Sets the line-mode of this receiver.
Method set​Raw​Mode Sets the raw mode of this receiver. Further data received will be sent to rawDataReceived rather than lineReceived.
Constant 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.
Class Variable delimiter The line-ending delimiter to use. By default this is b'\r\n'.
Instance Variable line​_mode Undocumented
Instance Variable _buffer Undocumented
Instance Variable _busy​Receiving Undocumented

Inherited from Protocol (via SMTPClient, LineReceiver):

Method log​Prefix Return a prefix matching the class name, to identify log messages related to this protocol instance.
Class Variable factory Undocumented

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

Method make​Connection Make a connection to a transport and a server.
Instance Variable connected Undocumented
Instance Variable transport Undocumented

Inherited from _PauseableMixin (via SMTPClient, LineReceiver):

Method pause​Producing Undocumented
Method resume​Producing Undocumented
Method stop​Producing Undocumented
Instance Variable paused Undocumented

Inherited from TimeoutMixin (via SMTPClient):

Method call​Later Wrapper around reactor.callLater for test purpose.
Method reset​Timeout Reset the timeout count down.
Method set​Timeout Change the timeout period
Instance Variable time​Out The number of seconds after which to timeout the connection.
Method __timed​Out Undocumented
Instance Variable __timeout​Call Undocumented
def __init__(self, messagePaths, *args, **kw): (source)
Parameters
message​Paths:list of bytesThe base filename for each message to be relayed.
*args:1-tuple of (0) bytes or 2-tuple of (0) bytes, (1) intPositional arguments for SMTPClient.__init__
**kw:dictKeyword arguments for SMTPClient.__init__