class documentation

Utility factory for sending emails easily.

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

Inherited from SMTPSenderFactory:

Method clientConnectionFailed Called when a connection has failed to connect.
Method clientConnectionLost Called when an established connection is lost.
Instance Variable file Undocumented
Instance Variable fromEmail Undocumented
Instance Variable nEmails Undocumented
Instance Variable result Undocumented
Instance Variable retries Undocumented
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 timeout Undocumented
Instance Variable toEmail Undocumented
Method _processConnectionError Undocumented
Method _removeDeferred 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 doStart Make sure startFactory is called.
Method doStop Make sure stopFactory is called.
Method logPrefix Describe this factory for log messages.
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.
Class Variable noisy Undocumented
Class Variable protocol Undocumented
Instance Variable numPorts Undocumented
def __init__(self, username, password, fromEmail, toEmail, file, deferred, retries=5, timeout=None, contextFactory=None, heloFallback=False, requireAuthentication=True, requireTransportSecurity=True, hostname=None): (source)
Parameters
usernameUndocumented
passwordUndocumented
fromEmailThe 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.
deferred:defer.DeferredA Deferred to callback or errback when sending of this message completes.
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.
contextFactoryUndocumented
heloFallbackUndocumented
requireAuthenticationUndocumented
requireTransportSecurityUndocumented
hostnameUndocumented
def buildProtocol(self, addr): (source)

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
ESMTPSenderUndocumented
currentProtocol: ESMTPSender = (source)

The current running protocol as made by buildProtocol.

password = (source)

Undocumented

username = (source)

Undocumented

_contextFactory = (source)

Undocumented

_heloFallback = (source)

Undocumented

_hostname = (source)

Undocumented

_requireAuthentication = (source)

Undocumented

_requireTransportSecurity = (source)

Undocumented