twisted.mail.test.test_imap.IMAP4HelperTests

Tests for various helper utilities in the IMAP4 module.

Method	test_commandRepr	`imap4.Command`'s `repr` does not raise an exception.
Method	test_fileProducer	Undocumented
Method	test_wildcard	Undocumented
Method	test_wildcardNoDelim	Undocumented
Method	test_headerFormatter	`imap4._formatHeaders` accepts a `dict` of header name/value pairs and returns a string representing those headers in the standard multiline, `":"`-separated format.
Method	test_quotedSplitter	Undocumented
Method	test_stringCollapser	Undocumented
Method	test_parenParser	Undocumented
Method	test_fetchParserSimple	Undocumented
Method	test_fetchParserMacros	Undocumented
Method	test_fetchParserBody	Undocumented
Method	test_fetchParserQuotedHeader	Parsing a `BODY` whose `HEADER` values require quoting results in a object that perserves that quoting when serialized.
Method	test_fetchParserEmptyString	Parsing an empty string results in no data.
Method	test_fetchParserUnknownAttribute	Parsing a string with an unknown attribute raises an `Exception`.
Method	test_fetchParserIncompleteStringEndsInWhitespace	Parsing a string that prematurely ends in whitespace raises an `Exception`.
Method	test_fetchParserExpectedWhitespace	Parsing a string that contains an unexpected character rather than whitespace raises an `Exception`.
Method	test_fetchParserTextSection	A `BODY` can contain a `TEXT` section.
Method	test_fetchParserUnknownSection	Parsing a `BODY` with an unknown section raises an `Exception`.
Method	test_fetchParserMissingSectionClose	Parsing a `BODY` with an unterminated section list raises an `Exception`.
Method	test_fetchParserHeaderMissingParentheses	Parsing a `BODY` whose `HEADER.FIELDS` list does not begin with an open parenthesis (`(`) or end with a close parenthesis (`)`) raises an `Exception`.
Method	test_fetchParserDotlessPartial	Parsing a `BODY` with a range that lacks a period (`.`) raises an `Exception`.
Method	test_fetchParserUnclosedPartial	Parsing a `BODY` with a partial range that's missing its closing greater than sign (`>`) raises an `EXCEPTION`.
Method	test_files	Undocumented
Method	test_quoteAvoider	Undocumented
Method	test_literals	Undocumented
Method	test_queryBuilder	Undocumented
Method	test_queryKeywordFlagWithQuotes	When passed the `keyword` argument, `imap4.Query` returns an unquoted string.
Method	test_queryUnkeywordFlagWithQuotes	When passed the `unkeyword` argument, `imap4.Query` returns an unquoted string.
Method	test_queryWithMesssageSet	When passed a `MessageSet`, `imap4.Query` returns a query containing a quoted string representing the ID sequence.
Method	test_queryWithInteger	When passed an `int`, `imap4.Query` returns a query containing a quoted integer.
Method	test_queryOrIllegalQuery	An `imap4.Or` query with less than two arguments raises an `imap4.IllegalQueryError`.
Method	test_queryKeywordFlag	When passed the `keyword` argument, `imap4.Query` returns an `atom` that consists of one or more non-special characters.
Method	test_queryUnkeywordFlag	When passed the `unkeyword` argument, `imap4.Query` returns an `atom` that consists of one or more non-special characters.
Method	test_invalidIdListParser	Trying to parse an invalid representation of a sequence range raises an `IllegalIdentifierError`.
Method	test_invalidIdListParserNonPositive	Zeroes and negative values are not accepted in id range expressions. RFC 3501 states that sequence numbers and sequence ranges consist of non-negative numbers (RFC 3501 section 9, the seq-number grammar item).
Method	test_parseIdList	The function to parse sequence ranges yields appropriate `MessageSet` objects.
Method	test_parseTimeInvalidFormat	`imap4.parseTime` raises `ValueError` when given a a time string whose format is invalid.
Method	test_parseTimeInvalidValues	`imap4.parseTime` raises `ValueError` when given a time string composed of invalid values.
Method	test_statusRequestHelper	`imap4.statusRequestHelper` builds a `dict` mapping the requested status names to values extracted from the provided `IMailboxIMAP`'s.
Method	_keywordFilteringTest	Helper to implement tests for value filtering of KEYWORD and UNKEYWORD queries.

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.

def test_commandRepr(self):

imap4.Command's repr does not raise an exception.

def test_fileProducer(self):

Undocumented

def test_wildcard(self):

Undocumented

def test_wildcardNoDelim(self):

Undocumented

def test_headerFormatter(self):

imap4._formatHeaders accepts a dict of header name/value pairs and returns a string representing those headers in the standard multiline, ":"-separated format.

def test_quotedSplitter(self):

Undocumented

def test_stringCollapser(self):

Undocumented

def test_parenParser(self):

Undocumented

def test_fetchParserSimple(self):

Undocumented

def test_fetchParserMacros(self):

Undocumented

def test_fetchParserBody(self):

Undocumented

def test_fetchParserQuotedHeader(self):

Parsing a BODY whose HEADER values require quoting results in a object that perserves that quoting when serialized.

def test_fetchParserEmptyString(self):

Parsing an empty string results in no data.

def test_fetchParserUnknownAttribute(self):

Parsing a string with an unknown attribute raises an Exception.

def test_fetchParserIncompleteStringEndsInWhitespace(self):

Parsing a string that prematurely ends in whitespace raises an Exception.

def test_fetchParserExpectedWhitespace(self):

Parsing a string that contains an unexpected character rather than whitespace raises an Exception.

def test_fetchParserTextSection(self):

A BODY can contain a TEXT section.

def test_fetchParserUnknownSection(self):

Parsing a BODY with an unknown section raises an Exception.

def test_fetchParserMissingSectionClose(self):

Parsing a BODY with an unterminated section list raises an Exception.

def test_fetchParserHeaderMissingParentheses(self):

Parsing a BODY whose HEADER.FIELDS list does not begin with an open parenthesis (() or end with a close parenthesis ()) raises an Exception.

def test_fetchParserDotlessPartial(self):

Parsing a BODY with a range that lacks a period (.) raises an Exception.

def test_fetchParserUnclosedPartial(self):

Parsing a BODY with a partial range that's missing its closing greater than sign (>) raises an EXCEPTION.

def test_files(self):

Undocumented

def test_quoteAvoider(self):

Undocumented

def test_literals(self):

Undocumented

def test_queryBuilder(self):

Undocumented

def test_queryKeywordFlagWithQuotes(self):

When passed the keyword argument, imap4.Query returns an unquoted string.

See Also	http://tools.ietf.org/html/rfc3501#section-9
	http://tools.ietf.org/html/rfc3501#section-6.4.4

def test_queryUnkeywordFlagWithQuotes(self):

When passed the unkeyword argument, imap4.Query returns an unquoted string.

See Also	http://tools.ietf.org/html/rfc3501#section-9
	http://tools.ietf.org/html/rfc3501#section-6.4.4

def test_queryWithMesssageSet(self):

When passed a MessageSet, imap4.Query returns a query containing a quoted string representing the ID sequence.

def test_queryWithInteger(self):

When passed an int, imap4.Query returns a query containing a quoted integer.

def test_queryOrIllegalQuery(self):

An imap4.Or query with less than two arguments raises an imap4.IllegalQueryError.

def _keywordFilteringTest(self, keyword):

Helper to implement tests for value filtering of KEYWORD and UNKEYWORD queries.

Parameters keyword A native string giving the name of the imap4.Query keyword argument to test.

def test_queryKeywordFlag(self):

When passed the C{keyword} argument, L{imap4.Query} returns an
C{atom} that consists of one or more non-special characters.

List of the invalid characters:

    ( ) { % * " \ ] CTL SP

@see: U{ABNF definition of CTL and SP<https://tools.ietf.org/html/rfc2234>}
@see: U{IMAP4 grammar<http://tools.ietf.org/html/rfc3501#section-9>}
@see: U{IMAP4 SEARCH specification<http://tools.ietf.org/html/rfc3501#section-6.4.4>}

def test_queryUnkeywordFlag(self):

When passed the C{unkeyword} argument, L{imap4.Query} returns an
C{atom} that consists of one or more non-special characters.

List of the invalid characters:

    ( ) { % * " \ ] CTL SP

@see: U{ABNF definition of CTL and SP<https://tools.ietf.org/html/rfc2234>}
@see: U{IMAP4 grammar<http://tools.ietf.org/html/rfc3501#section-9>}
@see: U{IMAP4 SEARCH specification<http://tools.ietf.org/html/rfc3501#section-6.4.4>}

def test_invalidIdListParser(self):

Trying to parse an invalid representation of a sequence range raises an IllegalIdentifierError.

def test_invalidIdListParserNonPositive(self):

Zeroes and negative values are not accepted in id range expressions. RFC 3501 states that sequence numbers and sequence ranges consist of non-negative numbers (RFC 3501 section 9, the seq-number grammar item).

def test_parseIdList(self):

The function to parse sequence ranges yields appropriate MessageSet objects.

def test_parseTimeInvalidFormat(self):

imap4.parseTime raises ValueError when given a a time string whose format is invalid.

def test_parseTimeInvalidValues(self):

imap4.parseTime raises ValueError when given a time string composed of invalid values.

def test_statusRequestHelper(self):

imap4.statusRequestHelper builds a dict mapping the requested status names to values extracted from the provided IMailboxIMAP's.

API Documentation for twisted, generated by pydoctor at 2020-03-25 17:34:30.

twisted.mail.test.test_imap.IMAP4HelperTests(unittest.TestCase) class documentation

`twisted.mail.test.test_imap.IMAP4HelperTests(unittest.TestCase)` class documentation