twisted.mail.tap.Options : API documentation

class documentation

class twisted.mail.tap.Options(usage.Options, strcred.AuthOptionMixin): (source)

An options list parser for twistd mail.

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

Inherited from Options:

Instance Variable	subCommand	Undocumented
Class Variable	defaultSubCommand	Undocumented
Class Variable	parent	Undocumented
Class Variable	completionData	Undocumented
Instance Variable	opts	Undocumented
Instance Variable	defaults	Undocumented
Instance Variable	longOpt	Undocumented
Instance Variable	shortOpt	Undocumented
Instance Variable	docs	Undocumented
Instance Variable	synonyms	Undocumented
Method	opt_help	Display this help and exit.
Method	opt_version	Display Twisted version and exit.
Method	parseOptions	The guts of the command-line parser.
Instance Variable	subOptions	Undocumented
Method	parseArgs	I am called with any leftover arguments which were not 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
Instance Variable	_dispatch	Undocumented
Method	_generic_flag	Undocumented
Method	_gather_flags	Gather up boolean (flag) options.
Method	_gather_parameters	Gather options which take a value.
Method	_gather_handlers	Gather up options with their own handler methods.

Inherited from AuthOptionMixin:

Class Variable	supportedInterfaces	An iterable object that returns credential interfaces which this application is able to support.
Class Variable	authOutput	A writeable object to which this options class will send all help-related output. Default: `sys.stdout`
Method	supportsInterface	Returns whether a particular credentials interface is supported.
Method	supportsCheckerFactory	Returns whether a checker factory will provide at least one of the credentials interfaces that we care about.
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	_checkerFactoriesForOptHelpAuth	Return a list of which authTypes will be displayed by --help-auth. This makes it a lot easier to test this module.

synopsis = (source)

A description of options for use in the usage message.

(type: bytes)

optParameters = (source)

Information about supported parameters. See Options for details.

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

optFlags = (source)

Information about supported flags. See Options for details.

(type: list of list of (0) bytes, (1) bytes or None, (2) bytes)

_protoDefaults = (source)

A mapping of default service to port.

(type: dict mapping bytes to int)

compData = (source)

Metadata for the shell tab completion system.

(type: Completions)

longdesc = (source)

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

(type: bytes)

service = (source)

The email service.

(type: MailService)

last_domain = (source)

The most recently specified domain.

(type: IDomain provider or None)

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	A service, either `b'smtp'` or `b'pop3'`. (type: `bytes`)
	description	An endpoint description string or a TCP port number. (type: `bytes`)

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_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_user(self, user_pass): (source)

Add a user and password to the last specified domain.

def opt_bounce_to_postmaster(self): (source)

Send undeliverable messages to the postmaster.

def opt_aliases(self, filename): (source)

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

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	If any endpoints are created, the reactor with which they are created. (type: `IReactorTCP` provider)
	service	The type of service for which to retrieve endpoints, either `b'pop3'` or `b'smtp'`. (type: `bytes`)
Returns	The endpoints for the specified service as configured by the command line parameters. (type: `list` of `IStreamServerEndpoint` provider)

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.

API Documentation for Twisted, generated by pydoctor 20.12.1 at 2021-02-28 19:53:36.