class documentation
class IMAP4ClientExamineTests(SelectionTestsMixin, SynchronousTestCase): (source)
Tests for the IMAP4Client.examine
method.
An example of usage of the EXAMINE command from RFC 3501, section 6.3.2:
S: * 17 EXISTS S: * 2 RECENT S: * OK [UNSEEN 8] Message 8 is first unseen S: * OK [UIDVALIDITY 3857529045] UIDs valid S: * OK [UIDNEXT 4392] Predicted next UID S: * FLAGS (\Answered \Flagged \Deleted \Seen \Draft) S: * OK [PERMANENTFLAGS ()] No permanent flags permitted S: A932 OK [READ-ONLY] EXAMINE completed
Class Variable | command |
Undocumented |
Class Variable | method |
Undocumented |
Inherited from SelectionTestsMixin
:
Method | test_bare |
If the server response to a SELECT or EXAMINE command includes an OK with no response code text, parsing does not fail. |
Method | test |
If the server response to a SELECT or EXAMINE command includes an EXISTS response, the Deferred return by IMAP4Client.select or IMAP4Client.examine fires with a dict including the value associated with the ... |
Method | test |
If the server response to a SELECT or EXAMINE command includes an FLAGS response, the Deferred returned by IMAP4Client.select or IMAP4Client.examine fires with a dict including the value associated with the ... |
Method | test_non |
If the server returns a non-integer EXISTS value in its response to a SELECT or EXAMINE command, the Deferred returned by IMAP4Client.select or IMAP4Client.examine fails with IllegalServerResponse . |
Method | test_non |
If the server returns a non-integer RECENT value in its response to a SELECT or EXAMINE command, the Deferred returned by IMAP4Client.select or IMAP4Client.examine fails with IllegalServerResponse . |
Method | test_non |
If the server returns a non-integer UIDNEXT value in its response to a SELECT or EXAMINE command, the Deferred returned by IMAP4Client.select or IMAP4Client.examine fails with IllegalServerResponse . |
Method | test_non |
If the server returns a non-integer UIDVALIDITY value in its response to a SELECT or EXAMINE command, the Deferred returned by IMAP4Client.select or IMAP4Client.examine fails with IllegalServerResponse ... |
Method | test_non |
If the server returns a non-integer UNSEEN value in its response to a SELECT or EXAMINE command, the Deferred returned by IMAP4Client.select or IMAP4Client.examine fails with IllegalServerResponse . |
Method | test |
If the server response to a SELECT or EXAMINE command includes an FLAGS response, the Deferred returned by IMAP4Client.select or IMAP4Client.examine fires with a dict including the value associated with the ... |
Method | test |
If the server response to a SELECT or EXAMINE command includes an RECENT response, the Deferred return by IMAP4Client.select or IMAP4Client.examine fires with a dict including the value associated with the ... |
Method | test |
If the server response to a SELECT or EXAMINE command includes an UIDNEXT response, the Deferred returned by IMAP4Client.select or IMAP4Client.examine fires with a dict including the value associated with the ... |
Method | test |
If the server response to a SELECT or EXAMINE command includes an UIDVALIDITY response, the Deferred returned by IMAP4Client.select or IMAP4Client.examine fires with a dict including the value associated with the ... |
Method | test_unrecognized |
If the server response to a SELECT or EXAMINE command includes an OK with unrecognized response code text, parsing does not fail. |
Method | test |
If the server response to a SELECT or EXAMINE command includes an UNSEEN response, the Deferred returned by IMAP4Client.select or IMAP4Client.examine fires with a dict including the value associated with the ... |
Method | _examine |
Issue either an EXAMINE or SELECT command (depending on self.method), assert that the correct bytes are written to the transport, and return the Deferred returned by whichever method was called. |
Method | _response |
Deliver the given (unterminated) response lines to self.client and then deliver a tagged SELECT or EXAMINE completion line to finish the SELECT or EXAMINE response. |
Inherited from PreauthIMAP4ClientMixin
(via SelectionTestsMixin
):
Method | set |
Create an IMAP4Client connected to a fake transport and in the authenticated state. |
Instance Variable | client |
An IMAP4Client which is connected to transport. |
Instance Variable | transport |
A StringTransport to which client is connected. |
Inherited from SynchronousTestCase
(via SelectionTestsMixin
, PreauthIMAP4ClientMixin
):
Method | __eq__ |
Override the comparison defined by the base TestCase which considers instances of the same class with the same _testMethodName to be equal. Since trial puts TestCase instances into a set, that definition of comparison makes it impossible to run the same test method twice... |
Method | __hash__ |
Undocumented |
Method | __init__ |
Undocumented |
Method | add |
Add the given function to a list of functions to be called after the test has run, but before tearDown. |
Method | call |
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 | flush |
Remove stored errors received from the log. |
Method | flush |
Remove stored warnings from the list of captured warnings and return them. |
Method | get |
Retrieve a module attribute which should have been deprecated, and assert that we saw the appropriate deprecation warning. |
Method | get |
Return the skip reason set on this test, if any is set. Checks on the instance first, then the class, then the module, then packages. As soon as it finds something with a skip attribute, returns that in a tuple (... |
Method | get |
Return a Todo object if the test is marked todo. Checks on the instance first, then the class, then the module, then packages. As soon as it finds something with a todo attribute, returns that. Returns ... |
Method | mktemp |
Create a new path name which can be used for a new file or directory. |
Method | patch |
Monkey patch an object for the duration of the test. |
Method | run |
Run the test case, storing the results in result. |
Method | run |
If no methodName argument is passed to the constructor, run will treat this method as the thing with the actual test inside. |
Method | short |
Undocumented |
Instance Variable | failure |
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 | 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 . |
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. |
Method | _get |
Return the reason to use for skipping a test method. |
Method | _get |
Returns any warning suppressions set for this test. Checks on the instance first, then the class, then the module, then packages. As soon as it finds something with a suppress attribute, returns that. ... |
Method | _install |
Undocumented |
Method | _remove |
Undocumented |
Method | _run |
Run a single method, either a test method or fixture. |
Method | _run |
Synchronously run any cleanups which have been added. |
Method | _run |
Run setUp, a test method, test cleanups, and tearDown. |
Instance Variable | _cleanups |
Undocumented |
Instance Variable | _observer |
Undocumented |
Instance Variable | _parents |
Undocumented |
Instance Variable | _passed |
Undocumented |
Instance Variable | _test |
Undocumented |
Instance Variable | _warnings |
Undocumented |
Inherited from _Assertions
(via SelectionTestsMixin
, PreauthIMAP4ClientMixin
, SynchronousTestCase
):
Method | assert |
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 | assert |
Fail if first - second > tolerance |
Method | assert |
Fail the test if first and second are not equal. |
Method | assert |
Fail the test if condition evaluates to True. |
Method | assert |
Fail the test if containee is not found in container. |
Method | assert |
Fail the test if first is not second. This is an obect-identity-equality test, not an object equality (i.e. __eq__) test. |
Method | assert |
Fail if instance is not an instance of the given class or of one of the given classes. |
Method | assert |
Fail the test if first is second. This is an obect-identity-equality test, not an object equality (i.e. __eq__) test. |
Method | assert |
Assert that deferred does not have a result at this point. |
Method | assert |
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 | assert |
Fail the test if first == second. |
Method | assert |
Fail the test if containee is found in container. |
Method | assert |
Fail if instance is an instance of the given class or of one of the given classes. |
Method | assert |
Fail if astring contains substring. |
Method | assert |
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 | assert |
Fail if substring does not exist within astring. |
Method | assert |
Fail the test if condition evaluates to False. |
Method | assert |
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 | fail |
Absolutely fail the test. Do not pass go, do not collect $200. |
Method | failure |
Return the current failure result of deferred or raise self.failureException. |
Method | success |
Return the current success result of deferred or raise self.failureException. |