twisted.mail.smtp.ESMTPSenderFactory

class documentation

class ESMTPSenderFactory(SMTPSenderFactory): (source)

View In Hierarchy

Utility factory for sending emails easily.
Method __init__
Method build​Protocol Build an ESMTPSender protocol configured with heloFallback, requireAuthentication, and requireTransportSecurity as specified in __init__.
Instance Variable current​Protocol The current running protocol as made by buildProtocol.
Instance Variable password Undocumented
Instance Variable username Undocumented
Instance Variable _context​Factory Undocumented
Instance Variable _helo​Fallback Undocumented
Instance Variable _hostname Undocumented
Instance Variable _require​Authentication Undocumented
Instance Variable _require​Transport​Security Undocumented

Inherited from SMTPSenderFactory:

Method client​Connection​Failed Called when a connection has failed to connect.
Method client​Connection​Lost Called when an established connection is lost.
Instance Variable file Undocumented
Instance Variable from​Email Undocumented
Instance Variable n​Emails Undocumented
Instance Variable result Undocumented
Instance Variable retries Undocumented
Instance Variable send​Finished 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 to​Email Undocumented
Method _process​Connection​Error Undocumented
Method _remove​Deferred Undocumented
Method _remove​Protocol Remove the protocol created in buildProtocol.

Inherited from ClientFactory (via SMTPSenderFactory):

Method started​Connecting Called when a connection has been started.

Inherited from Factory (via SMTPSenderFactory, ClientFactory):

Class Method for​Protocol Create a factory for the given protocol.
Method do​Start Make sure startFactory is called.
Method do​Stop Make sure stopFactory is called.
Method log​Prefix Describe this factory for log messages.
Method start​Factory This will be called before I begin listening on a Port or Connector.
Method stop​Factory This will be called before I stop listening on all Ports/Connectors.
Class Variable noisy Undocumented
Class Variable protocol Undocumented
Instance Variable num​Ports 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)
overrides twisted.mail.smtp.SMTPSenderFactory.__init__
Parameters
usernameUndocumented
passwordUndocumented
from​EmailThe RFC 2821 address from which to send this message.
to​EmailA 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.
context​FactoryUndocumented
helo​FallbackUndocumented
require​AuthenticationUndocumented
require​Transport​SecurityUndocumented
hostnameUndocumented
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
ESMTPSenderUndocumented
currentProtocol: ESMTPSender = (source)
overrides twisted.mail.smtp.SMTPSenderFactory.currentProtocol
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