class documentation

A factory to create an ESMTPManagedRelayer.

This factory creates a managed relayer which relays a set of messages over ESMTP and informs an attempt manager of its progress.

Method __init__ No summary
Method buildProtocol Create an ESMTPManagedRelayer.
Instance Variable contextFactory See __init__
Instance Variable protocol A callable which returns a managed relayer for ESMTP. See ESMTPManagedRelayer.__init__ for parameters to the callable.
Instance Variable secret See __init__

Inherited from SMTPManagedRelayerFactory:

Method clientConnectionFailed Notify the attempt manager that a connection could not be established.
Instance Variable manager See __init__
Instance Variable messages See __init__
Instance Variable pArgs Positional arguments for SMTPClient.__init__
Instance Variable pKwArgs Keyword arguments for SMTPClient.__init__

Inherited from ClientFactory (via SMTPManagedRelayerFactory):

Method clientConnectionLost Called when an established connection is lost.
Method startedConnecting Called when a connection has been started.

Inherited from Factory (via SMTPManagedRelayerFactory, 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
Instance Variable numPorts Undocumented
def __init__(self, messages, manager, secret, contextFactory, *args, **kw): (source)
Parameters
messages:list of bytesThe base filenames of messages to be relayed.
manager:_AttemptManagerAn attempt manager.
secret:bytesA string for the authentication challenge response.
contextFactory:None or ClientContextFactoryAn SSL context factory.
*args:1-tuple of (0) bytes or 2-tuple of (0) bytes, (1), intPositional arguments for SMTPClient.__init__
**kwKeyword arguments for SMTPClient.__init__
def buildProtocol(self, addr): (source)

Create an ESMTPManagedRelayer.

Parameters
addr:IAddress providerThe address of the ESMTP server.
Returns
ESMTPManagedRelayerA managed relayer for ESMTP.
contextFactory = (source)
protocol: callable which returns ESMTPManagedRelayer = (source)

A callable which returns a managed relayer for ESMTP. See ESMTPManagedRelayer.__init__ for parameters to the callable.