twisted.mail.smtp.SMTPClient(basic.LineReceiver, policies.TimeoutMixin)class documentation
twisted.mail.smtpView Source (View In Hierarchy)
SMTP client for sending emails.
After the client has connected to the SMTP server, it repeatedly calls
and uses this information to send an email. It then calls
again; if it returns
the client will disconnect, otherwise it will continue as normal i.e. call
and send a new email.
|Method||sendLine||Sends a line to the other end of the connection.|
|Method||connectionMade||Called when a connection is made.|
|Method||connectionLost||We are no longer connected|
|Method||timeoutConnection||Called when the connection times out.|
|Method||lineReceived||Override this for when each line is received.|
|Method||transformChunk||Perform the necessary local to network newline conversion and escape leading periods.|
|Method||getMailFrom||Return the email address the mail is from.|
|Method||getMailTo||Return a list of emails to send to.|
|Method||getMailData||Return file-like object containing data of message to be sent.|
|Method||sendError||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||sentMail||Called when an attempt to send an email is completed.|
Inherited from LineReceiver:
|Class Variable||delimiter||The line-ending delimiter to use. By default this is
|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||clearLineBuffer||Clear buffered data.|
|Method||dataReceived||Protocol.dataReceived. Translates bytes into lines, and calls lineReceived (or rawDataReceived, depending on mode.)|
|Method||setLineMode||Sets the line-mode of this receiver.|
|Method||setRawMode||Sets the raw mode of this receiver. Further data received will be sent to rawDataReceived rather than lineReceived.|
|Method||rawDataReceived||Override this for when raw data is received.|
|Method||lineLengthExceeded||Called when the maximum line length has been reached. Override if it needs to be dealt with in some special way.|
|Method||logPrefix||Return a prefix matching the class name, to identify log messages related to this protocol instance.|
|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||resetTimeout||Reset the timeout count down.|
|Method||setTimeout||Change the timeout period|
Sends a line to the other end of the connection.
|Parameters||line||The line to send, not including the delimiter. (type: |
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.
Called when the connection times out.
Override to define behavior other than dropping the connection.
Override this for when each line is received.
|Parameters||line||The line which was received with the delimiter removed. (type: |
Perform the necessary local to network newline conversion and escape leading periods.
This method also resets the idle timeout so that as long as process is being made sending the message body, the client will not time out.
Return the email address the mail is from.
Return a list of emails to send to.
Return file-like object containing data of message to be sent.
Lines in the file should be delimited by '\n'.
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||The SMTPClientError (or child class) raised (type: |
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|
|numOK||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|