t.m.t.Options(usage.Options) : class documentation

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

No class docstring
Method __init__ Undocumented
Method opt_passwordfile Specify a file containing username:password login info for authenticated ESMTP connections.
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.

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 Undocumented
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.
def __init__(self): (source)
Undocumented
def opt_passwordfile(self, filename): (source)
Specify a file containing username:password login info for authenticated ESMTP connections.
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 postOptions(self): (source)

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 2011-10-27 15:57:47.