twisted.mail.smtp.ESMTPSenderFactory(SMTPSenderFactory) class documentation

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

Utility factory for sending emails easily.

Instance Variable currentProtocol The current running protocol as made by buildProtocol.
Method __init__
Instance Variable username Undocumented
Instance Variable password Undocumented
Method buildProtocol Build an ESMTPSender protocol configured with heloFallback, requireAuthentication, and requireTransportSecurity as specified in __init__.
Instance Variable _contextFactory Undocumented
Instance Variable _heloFallback Undocumented
Instance Variable _requireAuthentication Undocumented
Instance Variable _requireTransportSecurity Undocumented

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.
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 _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 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.
currentProtocol =
The current running protocol as made by buildProtocol.
(type: ESMTPSender)
def __init__(self, username, password, fromEmail, toEmail, file, deferred, retries=5, timeout=None, contextFactory=None, heloFallback=False, requireAuthentication=True, requireTransportSecurity=True): (source)
overrides twisted.mail.smtp.SMTPSenderFactory.__init__
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.
username =
Undocumented
password =
Undocumented
_contextFactory =
Undocumented
_heloFallback =
Undocumented
_requireAuthentication =
Undocumented
_requireTransportSecurity =
Undocumented
def buildProtocol(self, addr): (source)
from twisted.internet.interfaces.IProtocolFactory
overrides twisted.mail.smtp.SMTPSenderFactory.buildProtocol

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)
API Documentation for Twisted, generated by pydoctor at 2020-03-20 23:54:06.