twisted.mail.smtp.SMTPSenderFactory(protocol.ClientFactory) class documentation

Part of twisted.mail.smtp View Source (View In Hierarchy)

Known subclasses: twisted.mail.smtp.ESMTPSenderFactory

Utility factory for sending emails easily.

Instance Variable currentProtocol The current running protocol returned by buildProtocol. (type: SMTPSender)
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 __init__
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 Factory (via 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.

Inherited from Factory (via 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.
currentProtocol =
The current running protocol returned by buildProtocol. (type: SMTPSender)
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)
def __init__(self, fromEmail, toEmail, file, deferred, retries=5, timeout=None): (source)
overridden in twisted.mail.smtp.ESMTPSenderFactory
ParametersfromEmailThe RFC 2821 address from which to send this message.
toEmailA sequence of RFC 2821 addresses to which to send this message.
fileA file-like object containing the message to send.
deferredA Deferred to callback or errback when sending of this message completes. (type: defer.Deferred)
retriesThe number of times to retry delivery of this message.
timeoutPeriod, in seconds, for which to wait for server responses, or None to wait forever.
def _removeDeferred(self, result): (source)
Undocumented
def clientConnectionFailed(self, connector, err): (source)
overrides twisted.internet.protocol.ClientFactory.clientConnectionFailed

Called when a connection has failed to connect.

It may be useful to call connector.connect() - this will reconnect.

def clientConnectionLost(self, connector, err): (source)
overrides twisted.internet.protocol.ClientFactory.clientConnectionLost

Called when an established connection is lost.

It may be useful to call connector.connect() - this will reconnect.

def _processConnectionError(self, connector, err): (source)
Undocumented
def buildProtocol(self, addr): (source)
from twisted.internet.interfaces.IProtocolFactory
overrides twisted.internet.protocol.Factory.buildProtocol
overridden in twisted.mail.smtp.ESMTPSenderFactory

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.

Parametersaddran object implementing twisted.internet.interfaces.IAddress
def _removeProtocol(self, result): (source)

Remove the protocol created in buildProtocol.

ParametersresultThe result/error passed to the callback/errback of defer.Deferred.
ReturnsThe result untouched.
API Documentation for Twisted, generated by pydoctor at 2016-04-11 10:39:53.