twisted.mail.tap.Options(usage.Options, strcred.AuthOptionMixin)
class documentationtwisted.mail.tap
View Source
(View In Hierarchy)
An options list parser for twistd mail.
Instance Variable | synopsis | A description of options for use in the usage message. (type: bytes ) |
Instance Variable | optParameters | 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 ) |
Instance Variable | optFlags | Information about supported flags. See Options for
details. (type: list
of list
of (0) bytes ,
(1) bytes
or None ,
(2) bytes ) |
Instance Variable | compData | Metadata for the shell tab completion system. (type: Completions ) |
Instance Variable | longdesc | A long description of the plugin for use in the usage message. (type: bytes ) |
Instance Variable | service | The email service. (type: MailService ) |
Instance Variable | last_domain | The most recently specified domain. (type: IDomain
provider or None ) |
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. (type: dict
mapping bytes
to int ) |
Method | _getEndpoints | Return a list of endpoints for the specified service, constructing defaults if necessary. |
Inherited from Options:
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. |
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 |
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. |
Parse options and create a mail service.
Add a POP3 port listener on the specified endpoint.
You can listen on multiple ports by specifying multiple --pop3 options.
Add an SMTP port listener on the specified endpoint.
You can listen on multiple ports by specifying multiple --smtp options.
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']
Specify an aliases(5) file to use for the last specified domain.
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) |
Check the validity of the specified set of options and configure authentication.
Raises | UsageError | When the set of options is invalid. |