twisted.mail.test.test_imap.IMAP4ClientFetchTests

class documentation

class IMAP4ClientFetchTests(PreauthIMAP4ClientMixin, SynchronousTestCase): (source)

View In Hierarchy

Tests for the IMAP4Client.fetch method.

See RFC 3501, section 6.4.5.

Method assertFetchSpecificFieldsWithEmptyList Assert that the provided BODY section, when invoked with no arguments, produces an empty list, and that it returns a Deferred which fires with a dict mapping message sequence numbers to lists of corresponding message data given by the server's response.
Method test_fetchBody IMAP4Client.fetchBody sends the FETCH BODY command and returns a Deferred which fires with a dict mapping message sequence numbers to dicts mapping 'RFC822.TEXT' to that message's body as given in the server's response.
Method test_fetchSpecific IMAP4Client.fetchSpecific sends the BODY[] command if no parameters beyond the message set to retrieve are given. It returns a Deferred which fires with a dict mapping message sequence numbers to list...
Method test_fetchSpecificHeader IMAP4Client.fetchSpecific, when passed 'HEADER' for headerType, sends the BODY[HEADER] command. It returns a Deferred which fires with a dict mapping message sequence numbers to lists of corresponding message data given by the server's response.
Method test_fetchSpecificHeaderFieldsNotWithoutHeaders IMAP4Client.fetchSpecific, when passed 'HEADER.FIELDS.NOT' for headerType but no headerArgs, sends the BODY[HEADER.FIELDS.NOT] command with no arguments. It returns a Deferred which fires with a dict mapping message sequence numbers to ...
Method test_fetchSpecificHeaderFieldsWithoutHeaders IMAP4Client.fetchSpecific, when passed 'HEADER.FIELDS' for headerType but no headerArgs, sends the BODY[HEADER.FIELDS] command with no arguments. It returns a Deferred which fires with a dict mapping message sequence numbers to ...
Method test_fetchSpecificHTML If the body of a message begins with < and ends with > (as, for example, HTML bodies typically will), this is still interpreted as the body by IMAP4Client.fetchSpecific (and particularly, not as a length indicator for a response to a request for a partial body).
Method test_fetchSpecificMIME IMAP4Client.fetchSpecific, when passed 'MIME' for headerType, sends the BODY[MIME] command. It returns a Deferred which fires with a dict mapping message sequence numbers to lists of corresponding message data given by the server's response.
Method test_fetchSpecificNumbered IMAP4Client.fetchSpecific, when passed a sequence for headerNumber, sends the BODY[N.M] command. It returns a Deferred which fires with a dict mapping message sequence numbers to lists of corresponding message data given by the server's response.
Method test_fetchSpecificNumberedText If passed a value for the headerNumber parameter and 'TEXT' for the headerType parameter, IMAP4Client.fetchSpecific sends a BODY[number.TEXT] request and returns a Deferred which fires with a dict mapping message sequence numbers to ...
Method test_fetchSpecificPartial IMAP4Client.fetchSpecific, when passed offset and length, sends a partial content request (like BODY[TEXT]<offset.length>). It returns a Deferred which fires with a dict mapping message sequence numbers to ...
Method test_fetchSpecificPeek IMAP4Client.fetchSpecific issues a BODY.PEEK[] command if passed True for the peek parameter.
Method test_fetchSpecificText IMAP4Client.fetchSpecific, when passed 'TEXT' for headerType, sends the BODY[TEXT] command. It returns a Deferred which fires with a dict mapping message sequence numbers to lists of corresponding message data given by the server's response.
Method test_fetchUID IMAP4Client.fetchUID sends the FETCH UID command and returns a Deferred which fires with a dict mapping message sequence numbers to dicts mapping 'UID' to that message's UID in the server's response.
Method test_fetchUIDNonIntegerFound If the server responds with a non-integer where a message sequence number is expected, the Deferred returned by IMAP4Client.fetchUID fails with IllegalServerResponse.
Method test_incompleteFetchSpecificPartialResponse If the server responds to a BODY[TEXT] request with a FETCH line which is truncated after the BODY[TEXT]<offset> tokens, the Deferred returned by IMAP4Client.fetchUID fails with IllegalServerResponse.
Method test_incompleteFetchSpecificTextResponse If the server responds to a BODY[TEXT] request with a FETCH line which is truncated after the BODY[TEXT] tokens, the Deferred returned by IMAP4Client.fetchUID fails with IllegalServerResponse.
Method test_incompleteFetchUIDResponse If the server responds with an incomplete FETCH response line, the Deferred returned by IMAP4Client.fetchUID fails with IllegalServerResponse.

Inherited from PreauthIMAP4ClientMixin:

Method setUp 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 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 addCleanup Add the given function to a list of functions to be called after the test has run, but before tearDown.
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 _run Run a single method, either a test method or fixture.
Method _runCleanups Synchronously run any cleanups which have been added.
Method _runFixturesAndTest 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 _testMethodName Undocumented
Instance Variable _warnings Undocumented

Inherited from _Assertions (via PreauthIMAP4ClientMixin, 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.
def assertFetchSpecificFieldsWithEmptyList(self, section): (source)

Assert that the provided BODY section, when invoked with no arguments, produces an empty list, and that it returns a Deferred which fires with a dict mapping message sequence numbers to lists of corresponding message data given by the server's response.

Parameters
section:strThe BODY section to test: either 'HEADER.FIELDS' or 'HEADER.FIELDS.NOT'
def test_fetchBody(self): (source)

IMAP4Client.fetchBody sends the FETCH BODY command and returns a Deferred which fires with a dict mapping message sequence numbers to dicts mapping 'RFC822.TEXT' to that message's body as given in the server's response.

def test_fetchSpecific(self): (source)

IMAP4Client.fetchSpecific sends the BODY[] command if no parameters beyond the message set to retrieve are given. It returns a Deferred which fires with a dict mapping message sequence numbers to lists of corresponding message data given by the server's response.

def test_fetchSpecificHeader(self): (source)

IMAP4Client.fetchSpecific, when passed 'HEADER' for headerType, sends the BODY[HEADER] command. It returns a Deferred which fires with a dict mapping message sequence numbers to lists of corresponding message data given by the server's response.

def test_fetchSpecificHeaderFieldsNotWithoutHeaders(self): (source)

IMAP4Client.fetchSpecific, when passed 'HEADER.FIELDS.NOT' for headerType but no headerArgs, sends the BODY[HEADER.FIELDS.NOT] command with no arguments. It returns a Deferred which fires with a dict mapping message sequence numbers to lists of corresponding message data given by the server's response.

def test_fetchSpecificHeaderFieldsWithoutHeaders(self): (source)

IMAP4Client.fetchSpecific, when passed 'HEADER.FIELDS' for headerType but no headerArgs, sends the BODY[HEADER.FIELDS] command with no arguments. It returns a Deferred which fires with a dict mapping message sequence numbers to lists of corresponding message data given by the server's response.

def test_fetchSpecificHTML(self): (source)

If the body of a message begins with < and ends with > (as, for example, HTML bodies typically will), this is still interpreted as the body by IMAP4Client.fetchSpecific (and particularly, not as a length indicator for a response to a request for a partial body).

def test_fetchSpecificMIME(self): (source)

IMAP4Client.fetchSpecific, when passed 'MIME' for headerType, sends the BODY[MIME] command. It returns a Deferred which fires with a dict mapping message sequence numbers to lists of corresponding message data given by the server's response.

def test_fetchSpecificNumbered(self): (source)

IMAP4Client.fetchSpecific, when passed a sequence for headerNumber, sends the BODY[N.M] command. It returns a Deferred which fires with a dict mapping message sequence numbers to lists of corresponding message data given by the server's response.

def test_fetchSpecificNumberedText(self): (source)

If passed a value for the headerNumber parameter and 'TEXT' for the headerType parameter, IMAP4Client.fetchSpecific sends a BODY[number.TEXT] request and returns a Deferred which fires with a dict mapping message sequence numbers to lists of message data given by the server's response.

def test_fetchSpecificPartial(self): (source)

IMAP4Client.fetchSpecific, when passed offset and length, sends a partial content request (like BODY[TEXT]<offset.length>). It returns a Deferred which fires with a dict mapping message sequence numbers to lists of corresponding message data given by the server's response.

def test_fetchSpecificPeek(self): (source)

IMAP4Client.fetchSpecific issues a BODY.PEEK[] command if passed True for the peek parameter.

def test_fetchSpecificText(self): (source)

IMAP4Client.fetchSpecific, when passed 'TEXT' for headerType, sends the BODY[TEXT] command. It returns a Deferred which fires with a dict mapping message sequence numbers to lists of corresponding message data given by the server's response.

def test_fetchUID(self): (source)

IMAP4Client.fetchUID sends the FETCH UID command and returns a Deferred which fires with a dict mapping message sequence numbers to dicts mapping 'UID' to that message's UID in the server's response.

def test_fetchUIDNonIntegerFound(self): (source)

If the server responds with a non-integer where a message sequence number is expected, the Deferred returned by IMAP4Client.fetchUID fails with IllegalServerResponse.

def test_incompleteFetchSpecificPartialResponse(self): (source)

If the server responds to a BODY[TEXT] request with a FETCH line which is truncated after the BODY[TEXT]<offset> tokens, the Deferred returned by IMAP4Client.fetchUID fails with IllegalServerResponse.

def test_incompleteFetchSpecificTextResponse(self): (source)

If the server responds to a BODY[TEXT] request with a FETCH line which is truncated after the BODY[TEXT] tokens, the Deferred returned by IMAP4Client.fetchUID fails with IllegalServerResponse.

def test_incompleteFetchUIDResponse(self): (source)

If the server responds with an incomplete FETCH response line, the Deferred returned by IMAP4Client.fetchUID fails with IllegalServerResponse.