class twisted.mail.smtp.SMTPSenderFactory(protocol.ClientFactory): (source)
Known subclasses: twisted.mail.smtp.ESMTPSenderFactory
Utility factory for sending emails easily.
| Instance Variable | currentProtocol | The current running protocol returned by buildProtocol. |
| 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. |
| Method | __init__ | |
| Instance Variable | fromEmail | Undocumented |
| Instance Variable | nEmails | Undocumented |
| Instance Variable | toEmail | Undocumented |
| Instance Variable | file | Undocumented |
| Instance Variable | result | Undocumented |
| Instance Variable | retries | Undocumented |
| Instance Variable | timeout | Undocumented |
| Method | clientConnectionFailed | Called when a connection has failed to connect. |
| Method | clientConnectionLost | Called when an established connection is lost. |
| Method | buildProtocol | Create an instance of a subclass of Protocol. |
| Method | _removeDeferred | Undocumented |
| Method | _processConnectionError | Undocumented |
| Method | _removeProtocol | Remove the protocol created in buildProtocol. |
Inherited from ClientFactory:
| Method | startedConnecting | Called when a connection has been started. |
Inherited from Factory (via ClientFactory):
| Class Variable | protocol | Undocumented |
| Instance Variable | numPorts | Undocumented |
| Class Variable | noisy | Undocumented |
| 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. |
buildProtocol.SMTPSender)
bool)
| 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. |
Called when a connection has failed to connect.
It may be useful to call connector.connect() - this will reconnect.
| Parameters | connector | Undocumented |
| err | Undocumented | |
| reason | Undocumented (type: twisted.python.failure.Failure) |
Called when an established connection is lost.
It may be useful to call connector.connect() - this will reconnect.
| Parameters | connector | Undocumented |
| err | Undocumented | |
| reason | Undocumented (type: twisted.python.failure.Failure) |
Create an instance of a subclass of Protocol.
The returned instance will handle input on an incoming server connection, and an attribute "factory" pointing to the creating factory.
Alternatively, None may be returned to immediately close the new connection.
Override this method to alter how Protocol instances get created.
| Parameters | addr | an object implementing twisted.internet.interfaces.IAddress |
Remove the protocol created in buildProtocol.
| Parameters | result | The result/error passed to the callback/errback of defer.Deferred. |
| Returns | The result untouched. | |