twisted.mail.test.test_imap.IMAP4ServerTests(IMAP4HelperMixin, unittest.TestCase) class documentation

Part of twisted.mail.test.test_imap (View In Hierarchy)
No class docstring
Method testCapability Undocumented
Method testCapabilityWithAuth Undocumented
Method testLogout Undocumented
Method testNoop Undocumented
Method testLogin Undocumented
Method testFailedLogin Undocumented
Method test_loginWithoutPortal Attempting to log into a server that has no Portal results in a failed login.
Method test_nonIAccountAvatar No summary
Method test_loginException Any exception raised by IMAP4Server.authenticateLogin that is not UnauthorizedLogin is logged results in a BAD response.
Method testLoginRequiringQuoting Undocumented
Method testNamespace Undocumented
Method test_mailboxWithoutNamespace A mailbox that does not provide INamespacePresenter returns empty lists for its personal, shared, and user namespaces.
Method testSelect Undocumented
Method test_selectWithoutMailbox A client that selects a mailbox that does not exist receives a NO response.
Method test_examine No summary
Method testCreate Undocumented
Method testDelete Undocumented
Method testDeleteWithInferiorHierarchicalNames Attempting to delete a mailbox with hierarchically inferior names fails with an informative error.
Method testIllegalInboxDelete Undocumented
Method testNonExistentDelete Undocumented
Method testIllegalDelete Undocumented
Method testRename Undocumented
Method testIllegalInboxRename Undocumented
Method testHierarchicalRename Undocumented
Method testSubscribe Undocumented
Method testUnsubscribe Undocumented
Method assertListDelimiterAndMailboxAreStrings Assert a LIST response's delimiter and mailbox are native strings.
Method testList Undocumented
Method testLSub Undocumented
Method testStatus Undocumented
Method testFailedStatus Undocumented
Method testFullAppend Undocumented
Method testPartialAppend Undocumented
Method test_check Trigger the imap.IMAP4Server._cbSelectWork callback by selecting an mbox.
Method test_checkFail Trigger the imap.IMAP4Server._ebSelectWork errback by failing when we select an mbox.
Method testClose Undocumented
Method testExpunge Undocumented
Method _cbTestLogin Undocumented
Method _cbTestFailedLogin Undocumented
Method _cbTestLoginRequiringQuoting Undocumented
Method _cbTestSelect Undocumented
Method _cbTestExamine Undocumented
Method _cbTestCreate Undocumented
Method _cbTestHierarchicalRename Undocumented
Method _listSetup Undocumented
Method _cbTestFailedStatus Undocumented
Method _cbTestFullAppend Undocumented
Method _cbTestPartialAppend Undocumented
Method _testCheck Undocumented
Method _cbTestClose Undocumented
Method _cbTestExpunge Undocumented

Inherited from IMAP4HelperMixin:

Method setUp Undocumented
Method tearDown Undocumented
Method loopback Undocumented
Method assertClientFailureMessage Assert that the provided failure is an IMAP4Exception with the given message.
Method _cbStopClient Undocumented
Method _ebGeneral Undocumented

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.Deferreds. 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 testCapability(self):
Undocumented
def testCapabilityWithAuth(self):
Undocumented
def testLogout(self):
Undocumented
def testNoop(self):
Undocumented
def testLogin(self):
Undocumented
def _cbTestLogin(self, ignored):
Undocumented
def testFailedLogin(self):
Undocumented
def _cbTestFailedLogin(self, ignored):
Undocumented
def test_loginWithoutPortal(self):

Attempting to log into a server that has no Portal results in a failed login.

def test_nonIAccountAvatar(self):

The server responds with a BAD response when its portal attempts to log a user in with checker that claims to support IAccount but returns an an avatar interface that is not IAccount.

def test_loginException(self):

Any exception raised by IMAP4Server.authenticateLogin that is not UnauthorizedLogin is logged results in a BAD response.

def testLoginRequiringQuoting(self):
Undocumented
def _cbTestLoginRequiringQuoting(self, ignored):
Undocumented
def testNamespace(self):
Undocumented
def test_mailboxWithoutNamespace(self):

A mailbox that does not provide INamespacePresenter returns empty lists for its personal, shared, and user namespaces.

def testSelect(self):
Undocumented
def test_selectWithoutMailbox(self):

A client that selects a mailbox that does not exist receives a NO response.

def _cbTestSelect(self, ignored):
Undocumented
def test_examine(self):

IMAP4Client.examine issues an EXAMINE command to the server and returns a Deferred which fires with a dict with as many of the following keys as the server includes in its response: 'FLAGS', 'EXISTS', 'RECENT', 'UNSEEN', 'READ-WRITE', 'READ-ONLY', 'UIDVALIDITY', and 'PERMANENTFLAGS'.

Unfortunately the server doesn't generate all of these so it's hard to test the client's handling of them here. See IMAP4ClientExamineTests below.

See RFC 3501, section 6.3.2, for details.

def _cbTestExamine(self, ignored):
Undocumented
def testCreate(self):
Undocumented
def _cbTestCreate(self, ignored, succeed, fail):
Undocumented
def testDelete(self):
Undocumented
def testDeleteWithInferiorHierarchicalNames(self):

Attempting to delete a mailbox with hierarchically inferior names fails with an informative error.

ReturnsA Deferred with assertions.
See Alsohttps://tools.ietf.org/html/rfc3501#section-6.3.4
def testIllegalInboxDelete(self):
Undocumented
def testNonExistentDelete(self):
Undocumented
def testIllegalDelete(self):
Undocumented
def testRename(self):
Undocumented
def testIllegalInboxRename(self):
Undocumented
def testHierarchicalRename(self):
Undocumented
def _cbTestHierarchicalRename(self, ignored):
Undocumented
def testSubscribe(self):
Undocumented
def testUnsubscribe(self):
Undocumented
def _listSetup(self, f):
Undocumented
def assertListDelimiterAndMailboxAreStrings(self, results):

Assert a LIST response's delimiter and mailbox are native strings.

ParametersresultsA list of tuples as returned by IMAP4Client.list or IMAP4Client.lsub.
def testList(self):
Undocumented
def testLSub(self):
Undocumented
def testStatus(self):
Undocumented
def testFailedStatus(self):
Undocumented
def _cbTestFailedStatus(self, ignored):
Undocumented
def testFullAppend(self):
Undocumented
def _cbTestFullAppend(self, ignored, infile):
Undocumented
def testPartialAppend(self):
Undocumented
def _cbTestPartialAppend(self, ignored, infile):
Undocumented
def _testCheck(self):
Undocumented
def test_check(self):

Trigger the imap.IMAP4Server._cbSelectWork callback by selecting an mbox.

def test_checkFail(self):

Trigger the imap.IMAP4Server._ebSelectWork errback by failing when we select an mbox.

def testClose(self):
Undocumented
def _cbTestClose(self, ignored, m):
Undocumented
def testExpunge(self):
Undocumented
def _cbTestExpunge(self, ignored, m):
Undocumented
API Documentation for twisted, generated by pydoctor at 2020-03-25 17:34:30.