twisted.mail.relaymanager.SMTPManagedRelayer(ManagedRelayerMixin, relay.SMTPRelayer)
class documentationtwisted.mail.relaymanager
View Source
(View In Hierarchy)
An SMTP managed relayer.
This managed relayer is an SMTP client which is responsible for sending a set of messages and keeping an attempt manager informed about its progress.
Instance Variable | factory | The factory that created this relayer. This must be set by the factory. (type: SMTPManagedRelayerFactory ) |
Method | __init__ |
Inherited from ManagedRelayerMixin:
Method | sentMail | called when e-mail has been sent |
Method | connectionLost | called when connection is broken |
Inherited from RelayerMixin (via SMTPRelayer):
Method | loadMessages | Undocumented |
Method | getMailFrom | Undocumented |
Method | getMailTo | Undocumented |
Method | getMailData | Undocumented |
Method | sentMail | 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. |
Inherited from SMTPClient (via SMTPRelayer):
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 | smtpConnectionFailed | Undocumented |
Method | smtpTransferFailed | Undocumented |
Method | smtpState_helo | Undocumented |
Method | smtpState_from | Undocumented |
Method | smtpState_disconnect | Undocumented |
Method | smtpState_to | Undocumented |
Method | smtpState_toOrData | Undocumented |
Method | smtpState_data | Undocumented |
Method | smtpState_msgSent | Undocumented |
Method | transformChunk | Perform the necessary local to network newline conversion and escape leading periods. |
Method | finishedFileTransfer | Undocumented |
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. |
Method | _disconnectFromServer | Undocumented |
Inherited from LineReceiver (via SMTPRelayer, SMTPClient):
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 | 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. |
Inherited from Protocol (via SMTPRelayer, SMTPClient, LineReceiver):
Method | logPrefix | Return a prefix matching the class name, to identify log messages related to this protocol instance. |
Inherited from BaseProtocol (via SMTPRelayer, SMTPClient, LineReceiver, Protocol):
Method | makeConnection | Make a connection to a transport and a server. |
Inherited from _PauseableMixin (via SMTPRelayer, SMTPClient, LineReceiver):
Method | pauseProducing | Undocumented |
Method | resumeProducing | Undocumented |
Method | stopProducing | Undocumented |
Inherited from TimeoutMixin (via SMTPRelayer, SMTPClient):
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 |
SMTPManagedRelayerFactory
)
Parameters | messages | The base filenames of messages to be relayed. (type: list
of bytes ) |
manager | An attempt manager. (type: _AttemptManager ) | |
args | Positional arguments for SMTPClient.__init__ (type: 1-tuple
of (0) bytes
or 2-tuple
of (0) bytes ,
(1) int ) | |
kw | Keyword arguments for SMTPClient.__init__ (type: dict ) |