twisted.mail.relaymanager.SMTPManagedRelayerFactory : API documentation

class documentation

class SMTPManagedRelayerFactory(protocol.ClientFactory): (source)

A factory to create an SMTPManagedRelayer.

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

Instance Variable	`messages`	See `__init__`
Instance Variable	`manager`	See `__init__`
Instance Variable	`protocol`	A callable which returns a managed relayer for SMTP. See `SMTPManagedRelayer.__init__` for parameters to the callable.
Instance Variable	`pArgs`	Positional arguments for `SMTPClient.__init__`
Instance Variable	`pKwArgs`	Keyword arguments for `SMTPClient.__init__`
Method	`__init__`
Method	`buildProtocol`	Create an `SMTPManagedRelayer`.
Method	`clientConnectionFailed`	Notify the attempt manager that a connection could not be established.

Inherited from ClientFactory:

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

Inherited from Factory (via ClientFactory):

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.

messages = (source)

See __init__

See __init__

protocol = (source)

overrides twisted.internet.protocol.Factory.protocol

overridden in twisted.mail.relaymanager.ESMTPManagedRelayerFactory

A callable which returns a managed relayer for SMTP. See SMTPManagedRelayer.__init__ for parameters to the callable.

(type: callable which returns SMTPManagedRelayer)

Positional arguments for SMTPClient.__init__

(type: 1-tuple of (0) bytes or 2-tuple of (0) bytes, (1), int)

Keyword arguments for SMTPClient.__init__

(type: dict)

def __init__(self, messages, manager, *args, **kw): (source)

overridden in twisted.mail.relaymanager.ESMTPManagedRelayerFactory

Parameters	messages	The base filenames of messages to be relayed. (type: `list` of `bytes`)
	manager	An attempt manager. (type: `_AttemptManager`)
	args	Positional arguments for `SMTPClient.__init__` (type: 1-`tuple` of (0) `bytes` or 2-`tuple` of (0) `bytes`, (1), `int`)
	kw	Keyword arguments for `SMTPClient.__init__` (type: `dict`)

def buildProtocol(self, addr): (source)

from twisted.internet.interfaces.IProtocolFactory

overrides twisted.internet.protocol.Factory.buildProtocol

overridden in twisted.mail.relaymanager.ESMTPManagedRelayerFactory

Parameters	addr	The address of the SMTP server. (type: `IAddress` provider)
Returns	A managed relayer for SMTP. (type: `SMTPManagedRelayer`)

def clientConnectionFailed(self, connector, reason): (source)

overrides twisted.internet.protocol.ClientFactory.clientConnectionFailed

Notify the attempt manager that a connection could not be established.

Parameters	connector	A connector. (type: `IConnector` provider)
	reason	The reason the connection attempt failed. (type: `Failure`)

API Documentation for Twisted, generated by pydoctor 21.2.2 at 2021-06-04 02:13:44.