t.m.t.Options(usage.Options, strcred.AuthOptionMixin) : class documentation

Part of twisted.mail.tap View Source View In Hierarchy

No class docstring

Method	__init__	Undocumented
Method	addEndpoint	Given a 'service' (pop3 or smtp), add an endpoint.
Method	opt_pop3	No summary
Method	opt_smtp	No summary
Method	opt_passwordfile	Specify a file containing username:password login info for authenticated ESMTP connections. (DEPRECATED; see --help-auth instead)
Method	opt_default	Make the most recently specified domain the default domain.
Method	opt_maildirdbmdomain	generate an SMTP/POP3 virtual domain which saves to "path"
Method	opt_user	add a user/password to the last specified domains
Method	opt_bounce_to_postmaster	undelivered mails are sent to the postmaster
Method	opt_aliases	Specify an aliases(5) file to use for this domain
Method	postOptions	I am called after the options are parsed.
Method	_getEndpoints	Return a list of endpoints for the specified service, constructing defaults if necessary.

Inherited from Options:

Method	__hash__	Define a custom hash function so that Options instances can be used as dictionary keys. This is an internal feature used to implement the parser. Do not rely on it in application code.
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.

def __init__(self): (source)

overrides twisted.python.usage.Options.__init__

Undocumented

def addEndpoint(self, service, description, certificate=None): (source)

Given a 'service' (pop3 or smtp), add an endpoint.

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. For backwards compatibility, a bare TCP port number can be specified, but this is deprecated. [SSL Example: ssl:8995:privateKey=mycert.pem] [default: tcp:8110]

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 For backwards compatibility, a bare TCP port number can be specified, but this is deprecated. [SSL Example: ssl:8465:privateKey=mycert.pem] [default: tcp:8025]

def opt_passwordfile(self, filename): (source)

Specify a file containing username:password login info for authenticated ESMTP connections. (DEPRECATED; see --help-auth instead)

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 which saves to "path"

def opt_user(self, user_pass): (source)

add a user/password to the last specified domains

def opt_bounce_to_postmaster(self): (source)

undelivered mails are sent to the postmaster

def opt_aliases(self, filename): (source)

Specify an aliases(5) file to use for this domain

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

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

Parameters	reactor	If any endpoints are created, this is the reactor with which they are created.
	service	A key into self indicating the type of service to retrieve endpoints for. This is either `"pop3"` or `"smtp"`.
Returns	A `list` of `IServerStreamEndpoint` providers corresponding to the command line parameters that were specified for `service`. If none were and the protocol was not explicitly disabled with a --no-* option, a default endpoint for the service is created using `self._protoDefaults`.

def postOptions(self): (source)

overrides twisted.python.usage.Options.postOptions

I am called after the options are parsed.

Override this method in your subclass to do something after the options have been parsed and assigned, like validate that all options are sane.

API Documentation for Twisted, generated by pydoctor at 2012-06-04 17:20:01.