class SMTPClient(basic.LineReceiver, policies.TimeoutMixin): (source)
Known subclasses: twisted.mail.relay.SMTPRelayer
, twisted.mail.smtp.ESMTPClient
, twisted.mail.smtp.SMTPSender
Constructor: SMTPClient(identity, logsize)
SMTP client for sending emails.
After the client has connected to the SMTP server, it repeatedly calls SMTPClient.getMailFrom
, SMTPClient.getMailTo
and SMTPClient.getMailData
and uses this information to send an email. It then calls SMTPClient.getMailFrom
again; if it returns None
, the client will disconnect, otherwise it will continue as normal i.e. call SMTPClient.getMailTo
and SMTPClient.getMailData
and send a new email.
Method | __init__ |
Undocumented |
Method | connection |
We are no longer connected |
Method | connection |
Called when a connection is made. |
Method | finished |
Undocumented |
Method | get |
Return file-like object containing data of message to be sent. |
Method | get |
Return the email address the mail is from. |
Method | get |
Return a list of emails to send to. |
Method | line |
Override this for when each line is received. |
Method | send |
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 |
Sends a line to the other end of the connection. |
Method | sent |
Called when an attempt to send an email is completed. |
Method | smtp |
Undocumented |
Method | smtp |
Undocumented |
Method | smtp |
Undocumented |
Method | smtp |
Undocumented |
Method | smtp |
Undocumented |
Method | smtp |
Undocumented |
Method | smtp |
Undocumented |
Method | smtp |
Undocumented |
Method | smtp |
Undocumented |
Method | timeout |
Called when the connection times out. |
Method | transform |
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 |
Undocumented |
Instance Variable | log |
Undocumented |
Instance Variable | mail |
Undocumented |
Instance Variable | resp |
Undocumented |
Instance Variable | success |
Undocumented |
Instance Variable | to |
Undocumented |
Instance Variable | to |
Undocumented |
Method | _disconnect |
Undocumented |
Instance Variable | _expected |
Undocumented |
Instance Variable | _failresponse |
Undocumented |
Instance Variable | _from |
Undocumented |
Instance Variable | _okresponse |
Undocumented |
Inherited from LineReceiver
:
Method | clear |
Clear buffered data. |
Method | data |
Protocol.dataReceived. Translates bytes into lines, and calls lineReceived (or rawDataReceived, depending on mode.) |
Method | line |
Called when the maximum line length has been reached. Override if it needs to be dealt with in some special way. |
Method | raw |
Override this for when raw data is received. |
Method | set |
Sets the line-mode of this receiver. |
Method | set |
Sets the raw mode of this receiver. Further data received will be sent to rawDataReceived rather than lineReceived. |
Constant | MAX |
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 |
Undocumented |
Instance Variable | _buffer |
Undocumented |
Instance Variable | _busy |
Undocumented |
Inherited from Protocol
(via LineReceiver
):
Method | log |
Return a prefix matching the class name, to identify log messages related to this protocol instance. |
Class Variable | factory |
Undocumented |
Inherited from BaseProtocol
(via LineReceiver
, Protocol
):
Method | make |
Make a connection to a transport and a server. |
Instance Variable | connected |
Undocumented |
Instance Variable | transport |
Undocumented |
Inherited from _PauseableMixin
(via LineReceiver
, Protocol
, BaseProtocol
):
Method | pause |
Undocumented |
Method | resume |
Undocumented |
Method | stop |
Undocumented |
Instance Variable | paused |
Undocumented |
Inherited from TimeoutMixin
(via LineReceiver
, Protocol
, BaseProtocol
, _PauseableMixin
):
Method | call |
Wrapper around reactor.callLater for test purpose. |
Method | reset |
Reset the timeout count down. |
Method | set |
Change the timeout period |
Instance Variable | time |
The number of seconds after which to timeout the connection. |
Method | __timed |
Undocumented |
Instance Variable | __timeout |
Undocumented |
twisted.mail.smtp.ESMTPClient
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.
Return file-like object containing data of message to be sent.
Lines in the file should be delimited by '\n'.
Override this for when each line is received.
Parameters | |
line:bytes | The line which was received with the delimiter removed. |
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.
Parameters | |
exc:SMTPClientError | The SMTPClientError (or child class) raised |
Sends a line to the other end of the connection.
Parameters | |
line:bytes | The line to send, not including the delimiter. |
Called when an attempt to send an email is completed.
If some addresses were accepted, code and resp are the response to the DATA command. If no addresses were accepted, code is -1 and resp is an informative message.
Parameters | |
code | the code returned by the SMTP Server |
resp | The string response returned from the SMTP Server |
num | the number of addresses accepted by the remote host. |
addresses | is a list of tuples (address, code, resp) listing the response to each RCPT command. |
log | is the SMTP session log |
Called when the connection times out.
Override to define behavior other than dropping the connection.