twisted.mail.test.test_mailmail.OptionsTests(TestCase)
class documentationtwisted.mail.test.test_mailmail
(View In Hierarchy)
Tests for parseOptions
which parses command line arguments and reads message text from stdin to
produce an Options
instance which can be used to send a message.
Method | setUp | Override some things in mailmail, so that we capture
stdout , and do not call reactor.stop . |
Method | test_unspecifiedRecipients | If no recipients are given in the argument list and there is no
recipient header in the message text, parseOptions
raises SystemExit
with a string describing the problem. |
Method | test_listQueueInformation | The -bp option for listing queue information is unsupported and
if it is passed to parseOptions ,
SystemExit
is raised. |
Method | test_stdioTransport | The -bs option for using stdin and stdout as the SMTP transport
is unsupported and if it is passed to parseOptions ,
SystemExit
is raised. |
Method | test_ignoreFullStop | The -i and -oi options for ignoring
"." by itself on a line are unsupported and if
either is passed to parseOptions ,
SystemExit
is raised. |
Method | test_copyAliasedSender | The -om option for copying the sender if they appear in an alias
expansion is unsupported and if it is passed to parseOptions ,
SystemExit
is raised. |
Method | test_version | The --version option displays the version and raises SystemExit
with None
as the exit code. |
Method | test_backgroundDelivery | The -odb flag specifies background delivery. |
Method | test_foregroundDelivery | The -odf flags specifies foreground delivery. |
Method | test_recipientsFromHeaders | The -t flags specifies that recipients should be obtained from headers. |
Method | test_setFrom | When a message has no From: header, a From: value can be specified with the -F flag. |
Method | test_overrideFromFlagByFromHeader | The -F flag specifies the From: value. However, -F flag is overriden by the value of From: in the e-mail header. |
Method | test_runErrorsToStderr | Call mailmail.run ,
and specify -oep to print errors to stderr. The sender, to, and
printErrors options should be set and there should be no failure. |
Method | test_readInvalidConfig | Error messages for illegal UID value, illegal GID value, and illegal identity entry will be sent to stderr. |
Method | getConfigFromFile | Read a mailmail configuration file. |
Method | test_loadConfig | twisted.mail.scripts.mailmail.loadConfig
parses the config file for mailmail. |
Method | test_senderror | twisted.mail.scripts.mailmail.senderror
sends mail back to the sender if an error occurs while sending mail to the
recipient. |
Inherited from TestCase:
Instance Variable | timeout | A real number of seconds. If set, the test will raise an error if it takes
longer than timeout seconds. If not set,
util.DEFAULT_TIMEOUT_DURATION is used. |
Method | __init__ | Construct an asynchronous test case for methodName . |
Method | assertFailure | Fail if deferred does not errback with one of
expectedFailures . Returns the original Deferred with callbacks
added. You will need to return this Deferred from your test case. |
Method | __call__ | Run the test. Should always do exactly the same thing as run(). |
Method | deferSetUp | Undocumented |
Method | deferTestMethod | Undocumented |
Method | deferTearDown | Undocumented |
Method | deferRunCleanups | Run any scheduled cleanups and report errors (if any to the result object. |
Method | addCleanup | Extend the base cleanup feature with support for cleanup functions which return Deferreds. |
Method | getSuppress | Undocumented |
Method | getTimeout | No summary |
Method | _run | Run a single method, either a test method or fixture. |
Method | _ebDeferSetUp | Undocumented |
Method | _cbDeferTestMethod | Undocumented |
Method | _ebDeferTestMethod | Undocumented |
Method | _ebDeferTearDown | Undocumented |
Method | _cbDeferRunCleanups | Undocumented |
Method | _cleanUp | Undocumented |
Method | _classCleanUp | Undocumented |
Method | _makeReactorMethod | Create a method which wraps the reactor method name . The
new method issues a deprecation warning and calls the original. |
Method | _deprecateReactor | Deprecate iterate , crash and stop
on reactor . That is, each method is wrapped in a function that
issues a deprecation warning, then calls the original. |
Method | _undeprecateReactor | Restore the deprecated reactor methods. Undoes what _deprecateReactor
did. |
Method | _runCleanups | Run the cleanups added with addCleanup
in order. |
Method | _runFixturesAndTest | Really run setUp , the test method, and
tearDown . Any of these may return defer.Deferred s.
After they complete, do some reactor cleanup. |
Method | _wait | Take a Deferred that only ever callbacks. Block until it happens. |
Inherited from SynchronousTestCase (via TestCase):
Instance Variable | failureException | An exception class, defaulting to FailTest . If the test method
raises this exception, it will be reported as a failure, rather than an
exception. All of the assertion methods raise this if the assertion fails. |
Instance Variable | skip | None
or a string explaining why this test is to be skipped. If defined, the test
will not be run. Instead, it will be reported to the result object as
'skipped' (if the TestResult supports skipping). |
Instance Variable | todo | None ,
a string or a tuple of (errors, reason) where
errors is either an exception class or an iterable of
exception classes, and reason is a string. See Todo or makeTodo for
more information. |
Instance Variable | suppress | None
or a list of tuples of (args, kwargs) to be passed to
warnings.filterwarnings . Use these to suppress warnings raised
in a test. Useful for testing deprecated code. See also util.suppress . |
Method | __eq__ | No summary |
Method | __ne__ | Undocumented |
Method | __hash__ | Undocumented |
Method | shortDescription | Undocumented |
Method | getSkip | No summary |
Method | getTodo | No summary |
Method | runTest | If no methodName argument is passed to the constructor, run
will treat this method as the thing with the actual test inside. |
Method | run | Run the test case, storing the results in result . |
Method | patch | Monkey patch an object for the duration of the test. |
Method | flushLoggedErrors | Remove stored errors received from the log. |
Method | flushWarnings | Remove stored warnings from the list of captured warnings and return them. |
Method | callDeprecated | Call a function that should have been deprecated at a specific version and in favor of a specific alternative, and assert that it was thusly deprecated. |
Method | mktemp | Create a new path name which can be used for a new file or directory. |
Method | _getSuppress | No summary |
Method | _getSkipReason | Return the reason to use for skipping a test method. |
Method | _installObserver | Undocumented |
Method | _removeObserver | Undocumented |
Inherited from _Assertions (via TestCase, SynchronousTestCase):
Method | fail | Absolutely fail the test. Do not pass go, do not collect $200. |
Method | assertFalse | Fail the test if condition evaluates to True. |
Method | assertTrue | Fail the test if condition evaluates to False. |
Method | assertRaises | Fail the test unless calling the function f with the given
args and kwargs raises exception .
The failure will report the traceback and call stack of the unexpected
exception. |
Method | assertEqual | Fail the test if first and second are not
equal. |
Method | assertIs | Fail the test if first is not second . This is
an obect-identity-equality test, not an object equality (i.e.
__eq__ ) test. |
Method | assertIsNot | Fail the test if first is second . This is an
obect-identity-equality test, not an object equality (i.e.
__eq__ ) test. |
Method | assertNotEqual | Fail the test if first == second . |
Method | assertIn | Fail the test if containee is not found in
container . |
Method | assertNotIn | Fail the test if containee is found in
container . |
Method | assertNotAlmostEqual | Fail if the two objects are equal as determined by their difference rounded to the given number of decimal places (default 7) and comparing to zero. |
Method | assertAlmostEqual | Fail if the two objects are unequal as determined by their difference rounded to the given number of decimal places (default 7) and comparing to zero. |
Method | assertApproximates | Fail if first - second >
tolerance |
Method | assertSubstring | Fail if substring does not exist within
astring . |
Method | assertNotSubstring | Fail if astring contains substring . |
Method | assertWarns | Fail if the given function doesn't generate the specified warning when called. It calls the function, checks the warning, and forwards the result of the function if everything is fine. |
Method | assertIsInstance | Fail if instance is not an instance of the given class or
of one of the given classes. |
Method | assertNotIsInstance | Fail if instance is an instance of the given class or of
one of the given classes. |
Method | successResultOf | Return the current success result of deferred or raise
self.failureException . |
Method | failureResultOf | Return the current failure result of deferred or raise
self.failureException . |
Method | assertNoResult | Assert that deferred does not have a result at this
point. |
Method | assertRegex | Fail the test if a regexp search of text
fails. |
Override some things in mailmail, so that we capture
stdout
, and do not call reactor.stop
.
If no recipients are given in the argument list and there is no
recipient header in the message text, parseOptions
raises SystemExit
with a string describing the problem.
The -bp option for listing queue information is unsupported and
if it is passed to parseOptions
,
SystemExit
is raised.
The -bs option for using stdin and stdout as the SMTP transport
is unsupported and if it is passed to parseOptions
,
SystemExit
is raised.
The -i and -oi options for ignoring
"."
by itself on a line are unsupported and if
either is passed to parseOptions
,
SystemExit
is raised.
The -om option for copying the sender if they appear in an alias
expansion is unsupported and if it is passed to parseOptions
,
SystemExit
is raised.
The --version option displays the version and raises SystemExit
with None
as the exit code.
The -t flags specifies that recipients should be obtained from headers.
When a message has no From: header, a From: value can be specified with the -F flag.
The -F flag specifies the From: value. However, -F flag is overriden by the value of From: in the e-mail header.
Call mailmail.run
,
and specify -oep to print errors to stderr. The sender, to, and
printErrors options should be set and there should be no failure.
Error messages for illegal UID value, illegal GID value, and illegal identity entry will be sent to stderr.
Read a mailmail configuration file.
The mailmail script checks the twisted.mail.scripts.mailmail.GLOBAL_CFG variable and then the twisted.mail.scripts.mailmail.LOCAL_CFG variable for the path to its config file.
Parameters | config | path to config file (type: str ) |
Returns | A parsed config. (type: twisted.mail.scripts.mailmail.Configuration ) |
twisted.mail.scripts.mailmail.loadConfig
parses the config file for mailmail.
twisted.mail.scripts.mailmail.senderror
sends mail back to the sender if an error occurs while sending mail to the
recipient.