imapami: your best IMAP friend
======================================================

Imapami is a tool that connects to an IMAP server and process the mails.
It can usually replace the filters of your mail client or webmail, and
provide more advanced features.

For instance, it can:

- move or copy mails into a directory, depending on its header or
  content
- pipe mails to a local program
- archive old mails into a directory
- flag or modify messages

Run imapami
-----------

Run ``imapami --help`` for a list of command line options.

Some configuration samples can be found in the ``config-samples``
directory.  Run ``imapami --config-help`` for a documentation about the
configuration files.

Pros
----

- Imapami has a powerful configuration file in YAML:

  - easily understandable.
  - you can edit it without using your mouse :)
  - rules can be generated by an external tool.

- It is easily extendable in python to add specific checks or actions:

  - imapami can be used as a lib.

- It runs outside of your mail client:

  - your mail filters do not depend on your mail client or on your
    webmail provider anymore.

Cons
----

- compared to procmail which can be run each time a mail is received,
  imapami needs to be launched periodically, for instance in a crontab.