Go to the latest version of this document.
search in docstrings

Search bar offers the following options:

- Term presence. The below example searches for documents that must contain “foo”, might contain “bar” and must not contain “baz”: `+foo bar -baz`
- Wildcards. The below example searches for documents with words beginning with “foo”: `foo*`
- Search in specific fields. The following search matches all objects in "twisted.mail" that matches “search”: `+qname:twisted.mail.* +search`

  Possible fields: 'name', 'qname' (fully qualified name), 'docstring', and 'kind'. Last two fields are only applicable if "search in docstrings" is enabled.

- Fuzzy matches. The following search matches all documents that have a word within 1 edit distance of “foo”: `foo~1`

Results provided by Lunr.js

# ``twisted`.`mail`.`protocols`.`SMTPFactory``

class documentation

`class SMTPFactory(smtp.SMTPFactory): (source)`

Known subclasses: `twisted.mail.protocols.ESMTPFactory`

Constructor: `SMTPFactory(service, portal)`

View In Hierarchy

An SMTP server protocol factory.

Method | `__init__` | No summary
Method | `buildProtocol` | Create an instance of an SMTP server protocol.
Instance Variable | `portal` | See `__init__`
Instance Variable | `protocol` | A callable which creates a protocol. The default value is `SMTP`.
Instance Variable | `service` | See `__init__`

Inherited from `SMTPFactory`:

Class Variable | `timeout` | Undocumented

Inherited from `Factory` (via `SMTPFactory`, `ServerFactory`):

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, service, portal=None): (source)
overrides `twisted.mail.smtp.SMTPFactory.__init__`
overridden in `twisted.mail.protocols.ESMTPFactory`

Parameters
service:`MailService` | An email service.
portal:`Portal` or `None` | A portal to use for authentication.

def buildProtocol(self, addr): (source)
from `twisted.internet.interfaces.IProtocolFactory`
overrides `twisted.mail.smtp.SMTPFactory.buildProtocol`
overridden in `twisted.mail.protocols.ESMTPFactory`

Create an instance of an SMTP server protocol.

Parameters
addr:`IAddress` provider | The address of the SMTP client.
Returns
`SMTP` | An SMTP protocol.

portal = (source)
overrides `twisted.mail.smtp.SMTPFactory.portal`

See `__init__`

protocol: no-argument callable which returns a `Protocol` subclass = (source)
overrides `twisted.internet.protocol.Factory.protocol`
overridden in `twisted.mail.protocols.ESMTPFactory`

A callable which creates a protocol. The default value is `SMTP`.

service = (source)

See `__init__`