class documentation

Undocumented

Method addListener Undocumented
Method fetch Undocumented
Method removeListener Undocumented
Method setUp Undocumented
Method test_fetchBodyPartOfNonMultipart Single-part messages have an implicit first part which clients should be able to retrieve explicitly. Test that a client requesting part 1 of a text/plain message receives the body of the text/plain part.
Method test_fetchBodyStructure IMAP4Client.fetchBodyStructure issues a FETCH BODYSTRUCTURE command and returns a Deferred which fires with a structure giving the result of parsing the server's response. The structure is a list reflecting the parenthesized data sent by the server, as described by RFC 3501, section 7...
Method test_fetchBodyStructureMultipart IMAP4Client.fetchBodyStructure can also parse the response to a FETCH BODYSTRUCTURE command for a multipart message.
Method test_fetchInternalDateLocaleIndependent The month name in the date is locale independent.
Method test_fetchSimplifiedBodyMultipart IMAP4Client.fetchSimplifiedBody returns a dictionary mapping message sequence numbers to fetch responses for the corresponding messages. In particular, for a multipart message, the value in the dictionary maps the string ...
Method testFetchAll Undocumented
Method testFetchAllUID Undocumented
Method testFetchBody Undocumented
Method testFetchBodyParts Test the server's handling of requests for specific body sections.
Method testFetchBodyStructureUID If passed True for the uid argument, fetchBodyStructure can also issue a UID FETCH BODYSTRUCTURE command.
Method testFetchBodyUID Undocumented
Method testFetchEnvelope Undocumented
Method testFetchEnvelopeUID Undocumented
Method testFetchFast Undocumented
Method testFetchFastUID Undocumented
Method testFetchFlags Undocumented
Method testFetchFlagsUID Undocumented
Method testFetchFull Undocumented
Method testFetchFullUID Undocumented
Method testFetchHeaders Undocumented
Method testFetchHeadersUID Undocumented
Method testFetchInternalDate Undocumented
Method testFetchInternalDateUID Undocumented
Method testFetchMessage Undocumented
Method testFetchMessageUID Undocumented
Method testFetchSimplifiedBody Undocumented
Method testFetchSimplifiedBodyRFC822 Undocumented
Method testFetchSimplifiedBodyRFC822UID Undocumented
Method testFetchSimplifiedBodyText Undocumented
Method testFetchSimplifiedBodyTextUID Undocumented
Method testFetchSimplifiedBodyUID Undocumented
Method testFetchSize Undocumented
Method testFetchSizeUID Undocumented
Method testFetchUID Undocumented
Class Variable currentLocale Undocumented
Instance Variable client Undocumented
Instance Variable connected Undocumented
Instance Variable expected Undocumented
Instance Variable function Undocumented
Instance Variable messages Undocumented
Instance Variable msgObjs Undocumented
Instance Variable received_messages Undocumented
Instance Variable received_uid Undocumented
Instance Variable result Undocumented
Instance Variable server Undocumented
Method _fetchWork Undocumented

Inherited from TestCase:

Method __call__ Run the test. Should always do exactly the same thing as run().
Method __init__ Construct an asynchronous test case for methodName.
Method addCleanup Extend the base cleanup feature with support for cleanup functions which return Deferreds.
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 deferRunCleanups Run any scheduled cleanups and report errors (if any) to the result. object.
Method deferSetUp Undocumented
Method deferTearDown Undocumented
Method deferTestMethod Undocumented
Method getSuppress Undocumented
Method getTimeout Returns the timeout value set on this test. Checks on the instance first, then the class, then the module, then packages. As soon as it finds something with a timeout attribute, returns that. Returns util.DEFAULT_TIMEOUT_DURATION...
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 _cbDeferTestMethod Undocumented
Method _classCleanUp Undocumented
Method _cleanUp Undocumented
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 _ebDeferSetUp Undocumented
Method _ebDeferTearDown Undocumented
Method _ebDeferTestMethod Undocumented
Method _makeReactorMethod Create a method which wraps the reactor method name. The new method issues a deprecation warning and calls the original.
Method _run Run a single method, either a test method or fixture.
Method _runFixturesAndTest Really run setUp, the test method, and tearDown. Any of these may return defer.Deferreds. After they complete, do some reactor cleanup.
Method _undeprecateReactor Restore the deprecated reactor methods. Undoes what _deprecateReactor did.
Method _wait Take a Deferred that only ever callbacks. Block until it happens.
Instance Variable _passed Undocumented
Instance Variable _reactorMethods Undocumented
Instance Variable _timedOut Undocumented

Inherited from SynchronousTestCase (via TestCase):

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 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 flushLoggedErrors Remove stored errors received from the log.
Method flushWarnings Remove stored warnings from the list of captured warnings and return them.
Method getDeprecatedModuleAttribute Retrieve a module attribute which should have been deprecated, and assert that we saw the appropriate deprecation warning.
Method getSkip 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 getTodo 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 runTest If no methodName argument is passed to the constructor, run will treat this method as the thing with the actual test inside.
Method shortDescription Undocumented
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 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 _getSkipReason Return the reason to use for skipping a test method.
Method _getSuppress 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 _installObserver Undocumented
Method _removeObserver Undocumented
Method _runCleanups Synchronously run any cleanups which have been added.
Instance Variable _cleanups Undocumented
Instance Variable _observer Undocumented
Instance Variable _parents Undocumented
Instance Variable _testMethodName Undocumented
Instance Variable _warnings Undocumented

Inherited from _Assertions (via TestCase, SynchronousTestCase):

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 assertEqual Fail the test if first and second are not equal.
Method assertFalse Fail the test if condition evaluates to True.
Method assertIn Fail the test if containee is not found in container.
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 assertIsInstance Fail if instance is not an instance of the given class or of one of the given classes.
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 assertNoResult Assert that deferred does not have a result at this point.
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 assertNotEqual Fail the test if first == second.
Method assertNotIn Fail the test if containee is found in container.
Method assertNotIsInstance Fail if instance is an instance of the given class or of one of the given classes.
Method assertNotSubstring Fail if astring contains substring.
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 assertSubstring Fail if substring does not exist within astring.
Method assertTrue Fail the test if condition evaluates to False.
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 fail Absolutely fail the test. Do not pass go, do not collect $200.
Method failureResultOf Return the current failure result of deferred or raise self.failureException.
Method successResultOf Return the current success result of deferred or raise self.failureException.

Inherited from IMAP4HelperMixin (via TestCase, SynchronousTestCase, _Assertions):

Method assertClientFailureMessage Assert that the provided failure is an IMAP4Exception with the given message.
Method loopback Undocumented
Method tearDown Undocumented
Class Variable clientCTX Undocumented
Class Variable serverCTX Undocumented
Method _cbStopClient Undocumented
Method _ebGeneral Undocumented
def addListener(self, x): (source)

Undocumented

def fetch(self, messages, uid): (source)

Undocumented

def removeListener(self, x): (source)

Undocumented

def test_fetchBodyPartOfNonMultipart(self): (source)

Single-part messages have an implicit first part which clients should be able to retrieve explicitly. Test that a client requesting part 1 of a text/plain message receives the body of the text/plain part.

def test_fetchBodyStructure(self, uid=0): (source)

IMAP4Client.fetchBodyStructure issues a FETCH BODYSTRUCTURE command and returns a Deferred which fires with a structure giving the result of parsing the server's response. The structure is a list reflecting the parenthesized data sent by the server, as described by RFC 3501, section 7.4.2.

def test_fetchBodyStructureMultipart(self, uid=0): (source)

IMAP4Client.fetchBodyStructure can also parse the response to a FETCH BODYSTRUCTURE command for a multipart message.

@skipIf(noEsARLocale, 'The es_AR.UTF8 locale is not installed.')
def test_fetchInternalDateLocaleIndependent(self): (source)

The month name in the date is locale independent.

def test_fetchSimplifiedBodyMultipart(self): (source)

IMAP4Client.fetchSimplifiedBody returns a dictionary mapping message sequence numbers to fetch responses for the corresponding messages. In particular, for a multipart message, the value in the dictionary maps the string "BODY" to a list giving the body structure information for that message, in the form of a list of subpart body structure information followed by the subtype of the message (eg "alternative" for a multipart/alternative message). This structure is self-similar in the case where a subpart is itself multipart.

def testFetchAll(self, uid=0): (source)

Undocumented

def testFetchAllUID(self): (source)

Undocumented

def testFetchBody(self, uid=0): (source)

Undocumented

def testFetchBodyParts(self): (source)

Test the server's handling of requests for specific body sections.

def testFetchBodyStructureUID(self): (source)

If passed True for the uid argument, fetchBodyStructure can also issue a UID FETCH BODYSTRUCTURE command.

def testFetchBodyUID(self): (source)

Undocumented

def testFetchEnvelope(self, uid=0): (source)

Undocumented

def testFetchEnvelopeUID(self): (source)

Undocumented

def testFetchFast(self, uid=0): (source)

Undocumented

def testFetchFastUID(self): (source)

Undocumented

def testFetchFlags(self, uid=0): (source)

Undocumented

def testFetchFlagsUID(self): (source)

Undocumented

def testFetchFull(self, uid=0): (source)

Undocumented

def testFetchFullUID(self): (source)

Undocumented

def testFetchHeaders(self, uid=0): (source)

Undocumented

def testFetchHeadersUID(self): (source)

Undocumented

def testFetchInternalDate(self, uid=0): (source)

Undocumented

def testFetchInternalDateUID(self): (source)

Undocumented

def testFetchMessage(self, uid=0): (source)

Undocumented

def testFetchMessageUID(self): (source)

Undocumented

def testFetchSimplifiedBody(self, uid=0): (source)

Undocumented

def testFetchSimplifiedBodyRFC822(self, uid=0): (source)

Undocumented

def testFetchSimplifiedBodyRFC822UID(self): (source)

Undocumented

def testFetchSimplifiedBodyText(self, uid=0): (source)

Undocumented

def testFetchSimplifiedBodyTextUID(self): (source)

Undocumented

def testFetchSimplifiedBodyUID(self): (source)

Undocumented

def testFetchSize(self, uid=0): (source)

Undocumented

def testFetchSizeUID(self): (source)

Undocumented

def testFetchUID(self): (source)

Undocumented

currentLocale = (source)

Undocumented

Undocumented

function = (source)

Undocumented

messages: str = (source)

Undocumented

Undocumented

received_messages = (source)

Undocumented

received_uid = (source)

Undocumented

Undocumented

def _fetchWork(self, uid): (source)

Undocumented