HTTPS SSH

Introduction

IMAPClient aims to be a easy-to-use, Pythonic and complete IMAP client library with no dependencies outside the Python standard library.

Features: - Arguments and return values are natural Python types. - IMAP server responses are fully parsed and readily usable. - IMAP unique message IDs (UIDs) are handled transparently. There is

no need to call different methods to use UIDs.
  • Escaping for internationalised mailbox names is transparently handled. Unicode mailbox names may be passed as input wherever a folder name is accepted.
  • Time zones are transparently handled including when the server and client are in different zones.
  • Convenience methods are provided for commonly used functionality.
  • Exceptions are raised when errors occur.

Why IMAPClient?

You may ask: "why create another IMAP client library for Python? Doesn't the Python standard library already have imaplib?".

The problem with imaplib is that it's very low-level. It expects string values where lists or tuples would be more appropriate and returns server responses almost unparsed. As IMAP server responses can be quite complex this means everyone using imaplib ends up writing their own flimsy parsing routines which break easily.

Also, imaplib doesn't make good use of exceptions. This means you need to check the return value of each call to imaplib to see if what you just did was successful.

IMAPClient actually uses imaplib internally. This may change at some point in the future.

Current Status

IMAPClient is currently under development but it is unlikely that the existing API will change in backwards-incompatible ways. Changes planned for the near future will only add extra functionality to the API.

You should feel confident using IMAPClient for production purposes. Any problems found will be fixed quickly once reported.

The project's home page is a Trac instance at:

http://imapclient.freshfoo.com/

Details about upcoming versions and planned features/fixes can be found there.

Using IMAPClient

IMAPClient is listed on the PyPI (Python Package Index). To install via PyPI use the pip or easy_install tools:

pip install imapclient

easy_install IMAPClient

To install from the source distribution:

python setup.py install

The project is packaged using Distribute (mostly compatible with setuptools) and all the usual setup.py installation options are available. See http://packages.python.org/distribute/ for more info.

Documentation

HTML documentation can be found at doc/html in the source distribution. The documentation is also available online at:

http://imapclient.readthedocs.org/

The Sphinx source is at doc/src. If Sphinx is installed, the documentation can be rebuilt using:

python setup.py build_sphinx

See imapclient/examples/example.py for a sample of how to use IMAPClient. If the IMAPClient was installed from PyPI the examples subdirectory can be found under the imapclient package installation directory.

Mailing List

The IMAPClient mailing list can be used to ask IMAPClient related questions and report bugs.

interact.py

This script connects an IMAPClient instance using the command line args given and starts an interactive session. This is useful for exploring the IMAPClient API and testing things out, avoiding the steps required to set up an IMAPClient instance.

The IPython shell is used if it is installed. Otherwise the code.interact() function from the standard library is used.

The interact functionality can also be accessed like this:

python -m imapclient.interact ...

This works when IMAPClient has been installed from PyPI.

livetest.py

This script runs a series of functional tests which exercise IMAPClient against a live IMAP account. It is useful for ensuring compatibility with a given IMAP server implementation. livetest.py must be used with an account with write access.

WARNING: As of version 0.9, livetest limits it's activity to a folder it creates and subfolders of that folder. It should be safe to use with any IMAP account. That said, some of the operations used by livetest are destructive and could cause unintended loss of non-test data. Please don't run the live test against a truly important IMAP account.

Run livetest.py with the --help option to see usage.

Please send the output of livetest.py to the mailing list if it fails to run successfully against a particular IMAP server. Reports of successful runs are also welcome. Please include the type and version of the IMAP server, if known.

The livetest functionality can also be accessed like this:

python -m imapclient.livetest ...

Unit Tests

There are comprehensive unit tests for the server response parser and a number of other parts of the code. These tests use the unittest2 package which is also included as the standard unittest package in Python 2.7 and 3.2.

Where unittest2 is included in the standard library (eg. Python 2.7 and 3.2) you can run all unit tests like this (starting from the root directory of the IMAPClient source):

python -m unittest discover

Alternatively, if unittest2 is installed separately use the unit2 script (for Unix-like systems) or the unit2.py script:

unit2 discover unit2.py discover