twisted.mail.smtp.ESMTPSenderFactory(SMTPSenderFactory)
class documentationtwisted.mail.smtp
View Source
(View In Hierarchy)
Utility factory for sending emails easily.
Instance Variable | currentProtocol | The current running protocol as made by buildProtocol . (type: ESMTPSender ) |
Method | __init__ | |
Method | buildProtocol | Build an ESMTPSender
protocol configured with heloFallback ,
requireAuthentication , and
requireTransportSecurity as specified in __init__ . |
Inherited from SMTPSenderFactory:
Instance Variable | sendFinished | When the value is set to True, it means the message has been sent or there
has been an unrecoverable error or the sending has been cancelled. The
default value is False. (type: bool ) |
Method | clientConnectionFailed | Called when a connection has failed to connect. |
Method | clientConnectionLost | Called when an established connection is lost. |
Method | _removeDeferred | Undocumented |
Method | _processConnectionError | Undocumented |
Method | _removeProtocol | Remove the protocol created in buildProtocol . |
Inherited from ClientFactory (via SMTPSenderFactory):
Method | startedConnecting | Called when a connection has been started. |
Inherited from Factory (via SMTPSenderFactory, ClientFactory):
Class Method | forProtocol | Create a factory for the given protocol. |
Method | logPrefix | Describe this factory for log messages. |
Method | doStart | Make sure startFactory is called. |
Method | doStop | Make sure stopFactory is called. |
Method | startFactory | This will be called before I begin listening on a Port or Connector. |
Method | stopFactory | This will be called before I stop listening on all Ports/Connectors. |
Parameters | fromEmail | The RFC 2821 address from which to send this message. |
toEmail | A sequence of RFC 2821 addresses to which to send this message. | |
file | A file-like object containing the message to send. | |
deferred | A Deferred to callback or errback when sending of this message completes. (type: defer.Deferred ) | |
retries | The number of times to retry delivery of this message. | |
timeout | Period, in seconds, for which to wait for server responses, or None to wait forever. |
Build an ESMTPSender
protocol configured with heloFallback
,
requireAuthentication
, and
requireTransportSecurity
as specified in __init__
.
This sets currentProtocol
on the factory, as well as returning it.
Returns | (type: ESMTPSender ) |