twisted.mail.tap.Options

class documentation

class Options(usage.Options, strcred.AuthOptionMixin): (source)

An options list parser for twistd mail.

Method	`__init__`	Parse options and create a mail service.
Method	`addEndpoint`	Add an endpoint to a service.
Method	`opt_aliases`	Specify an aliases(5) file to use for the last specified domain.
Method	`opt_bounce_to_postmaster`	Send undeliverable messages to the postmaster.
Method	`opt_default`	Make the most recently specified domain the default domain.
Method	`opt_maildirdbmdomain`	Generate an SMTP/POP3 virtual domain.
Method	`opt_pop3`	Add a POP3 port listener on the specified endpoint.
Method	`opt_smtp`	Add an SMTP port listener on the specified endpoint.
Method	`opt_user`	Add a user and password to the last specified domain.
Method	`postOptions`	Check the validity of the specified set of options and configure authentication.
Instance Variable	`compData`	Metadata for the shell tab completion system.
Instance Variable	`last_domain`	The most recently specified domain.
Instance Variable	`longdesc`	A long description of the plugin for use in the usage message.
Instance Variable	`optFlags`	Information about supported flags. See `Options` for details.
Instance Variable	`optParameters`	Information about supported parameters. See `Options` for details.
Instance Variable	`service`	The email service.
Instance Variable	`synopsis`	A description of options for use in the usage message.
Method	`_getEndpoints`	Return a list of endpoints for the specified service, constructing defaults if necessary.
Instance Variable	`_protoDefaults`	A mapping of default service to port.

Inherited from Options:

Method	`__str__`	Undocumented
Method	`getSynopsis`	Returns a string containing a description of these options and how to pass them to the executed file.
Method	`getUsage`	Undocumented
Method	`opt_help`	Display this help and exit.
Method	`opt_version`	Display Twisted version and exit.
Method	`parseArgs`	I am called with any leftover arguments which were not options.
Method	`parseOptions`	The guts of the command-line parser.
Class Variable	`completionData`	Undocumented
Class Variable	`defaultSubCommand`	Undocumented
Class Variable	`parent`	Undocumented
Instance Variable	`defaults`	Undocumented
Instance Variable	`docs`	Undocumented
Instance Variable	`longOpt`	Undocumented
Instance Variable	`opts`	Undocumented
Instance Variable	`shortOpt`	Undocumented
Instance Variable	`subCommand`	Undocumented
Instance Variable	`subOptions`	Undocumented
Instance Variable	`synonyms`	Undocumented
Method	`_gather_flags`	Gather up boolean (flag) options.
Method	`_gather_handlers`	Gather up options with their own handler methods.
Method	`_gather_parameters`	Gather options which take a value.
Method	`_generic_flag`	Undocumented
Instance Variable	`_dispatch`	Undocumented

Inherited from AuthOptionMixin:

Method	`addChecker`	Supply a supplied credentials checker to the Options class.
Method	`opt_auth`	Specify an authentication method for the server.
Method	`opt_help_auth`	Show all authentication methods available.
Method	`opt_help_auth_type`	Show help for a particular authentication type.
Method	`supportsCheckerFactory`	Returns whether a checker factory will provide at least one of the credentials interfaces that we care about.
Method	`supportsInterface`	Returns whether a particular credentials interface is supported.
Class Variable	`authOutput`	A writeable object to which this options class will send all help-related output. Default: `sys.stdout`
Class Variable	`supportedInterfaces`	An iterable object that returns credential interfaces which this application is able to support.
Method	`_checkerFactoriesForOptHelpAuth`	Return a list of which authTypes will be displayed by --help-auth. This makes it a lot easier to test this module.

def __init__(self): (source)

overrides twisted.python.usage.Options.__init__

Parse options and create a mail service.

def addEndpoint(self, service, description): (source)

Add an endpoint to a service.

Parameters
service:`bytes`	A service, either `b'smtp'` or `b'pop3'`.
description:`bytes`	An endpoint description string or a TCP port number.

def opt_aliases(self, filename): (source)

Specify an aliases(5) file to use for the last specified domain.

def opt_bounce_to_postmaster(self): (source)

Send undeliverable messages to the postmaster.

def opt_default(self): (source)

Make the most recently specified domain the default domain.

def opt_maildirdbmdomain(self, domain): (source)

Generate an SMTP/POP3 virtual domain.

This option requires an argument of the form 'NAME=PATH' where NAME is the DNS domain name for which email will be accepted and where PATH is a the filesystem path to a Maildir folder. [Example: 'example.com=/tmp/example.com']

def opt_pop3(self, description): (source)

Add a POP3 port listener on the specified endpoint.

You can listen on multiple ports by specifying multiple --pop3 options.

def opt_smtp(self, description): (source)

Add an SMTP port listener on the specified endpoint.

You can listen on multiple ports by specifying multiple --smtp options.

def opt_user(self, user_pass): (source)

Add a user and password to the last specified domain.

def postOptions(self): (source)

overrides twisted.python.usage.Options.postOptions

Check the validity of the specified set of options and configure authentication.

Raises
`UsageError`	When the set of options is invalid.

compData: Completions = (source)

Metadata for the shell tab completion system.

last_domain: IDomain provider or None = (source)

The most recently specified domain.

longdesc: bytes = (source)

A long description of the plugin for use in the usage message.

optFlags: list of list of (0) bytes, (1) bytes or None, (2) bytes = (source)

Information about supported flags. See Options for details.

optParameters: list of list of (0) bytes, (1) bytes, (2) object, (3) bytes, (4) None or callable which takes bytes and returns object = (source)

Information about supported parameters. See Options for details.

service: MailService = (source)

The email service.

synopsis: bytes = (source)

A description of options for use in the usage message.

def _getEndpoints(self, reactor, service): (source)

Return a list of endpoints for the specified service, constructing defaults if necessary.

If no endpoints were configured for the service and the protocol was not explicitly disabled with a --no-* option, a default endpoint for the service is created.

Parameters
reactor:`IReactorTCP` provider	If any endpoints are created, the reactor with which they are created.
service:`bytes`	The type of service for which to retrieve endpoints, either `b'pop3'` or `b'smtp'`.
Returns
`list` of `IStreamServerEndpoint` provider	The endpoints for the specified service as configured by the command line parameters.

_protoDefaults: dict mapping bytes to int = (source)

A mapping of default service to port.