imapfw is a simple and powerfull framework to work with mails.

Also, it comes as a replacement to the OfflineIMAP syncer. Read the blog to get last news about imapfw.

• for branch "master"
• for branch "next"

As a framework, imapfw allows you to take control on what gets done.

It comes with pre-configured actions requiring to write few to no Python code at all. For more control, a dedicated API allows to redefine the key parts of the frame in one file (called the rascal). Also, more experienced users might rather directly import one or more modules and use them to write a full software (using the framework as a "master-library"): imapfw is written with separation of concerns in mind.

The choice of the level of control is left to the user.

The framework is intended to provide everything is needed. If any key library is missing, it's welcome to make requests.

imapfw provides nice embedded pre-configured actions. It can be used like any other software sharing the same goals of an action.

Mainly relying on UIDs greatly helps to be fast.

Also, imapfw is designed to be fully concurrent. It even let the choice of the concurrency backend (multiprocessing or threading, for now). To take real advantage of this, implemetation is made asynchronous almost everywhere.

Providing good documentation is a concern.

Testing the framework is done with both static and dynamic testing. Each is used where it's the most relevant:

• low-level code and modules have unit tests;
• features like actions have black box tests.

Continous intergration is done with Travis CI.

The project is developed with a proven release cycle and release candidates.

In order to offer the best, imapfw relies on the last Python 3 technologies. It uses the most usefull of what Python 3 provides.

The user discussions, development, announcements and all the exciting stuff take place on the OfflineIMAP's mailing list and github.

While not mandatory to send emails, you can subscribe here.

Bugs, issues and contributions can be requested to both the mailing list or the official Github project.

• Python v3.3
• typing (Python < 3.5)

imapfw is WORK IN PROGRESS. Running imapfw should not hurt but all the features are not yet implemented. This is still early stage of development.

Last WIP is in the next branch. Also, you might like to check the TODO list online.

Please, support the efforts! Staring the project at github is a good start. Reviews, feedbacks and pull requests are welcome, too. ,-)

Side note: I'm convinced that sooner is better when it's about reviews and feedbacks. Once features you need will be implemented, it might be harder to get things improved and take a longer time.