Introduction

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

  • 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.

IMAPClient is currently at version 0.6 (new BSD License)

Installation

To install from PyPI using  EasyInstall: 

easy_install IMAPClient            # install
easy_install --upgrade IMAPClient  # upgrade

 pip can also be used to install or upgrade from PyPI: 

pip install IMAPClient             # install
pip install --upgrade IMAPClient   # upgrade

Alternatively download one of the source archives below and follow the directions in README.

Bugs and Feature Requests

Please report any bugs or feature requests using this Trac instance. You'll need to create an account first using the Register link at the top right of this page. Once you've registered an account and logged in you can use the New Ticket button to submit a report.

Alternatively you can send an email to menno _AT_ freshfoo _DOT_ com.

Developers

Who's Using IMAPClient?

IMAPClient is being used as part of the Mozilla Labs  Raindrop project.

(Let me know if you'd like your project to be included here)

This Wiki

For a complete list of local wiki pages, see TitleIndex.