README

   1 imapami: your best IMAP friend
   2 ======================================================
   3
   4 Imapami is a tool that connects to an IMAP server and process the mails.
   5 It can usually replace the filters of your mail client or webmail, and
   6 provide more advanced features.
   7
   8 For instance, it can:
   9
  10 - move or copy mails into a directory, depending on its header or
  11   content
  12 - pipe mails to a local program
  13 - archive old mails into a directory
  14 - flag or modify messages
  15
  16 Run imapami
  17 -----------
  18
  19 Run ``imapami --help`` for a list of command line options.
  20
  21 Some configuration samples can be found in the ``config-samples``
  22 directory.  Run ``imapami --config-help`` for a documentation about the
  23 configuration files.
  24
  25 Pros
  26 ----
  27
  28 - Imapami has a powerful configuration file in YAML:
  29
  30   - easily understandable.
  31   - you can edit it without using your mouse :)
  32   - rules can be generated by an external tool.
  33
  34 - It is easily extendable in python to add specific checks or actions:
  35
  36   - imapami can be used as a lib.
  37
  38 - It runs outside of your mail client:
  39
  40   - your mail filters do not depend on your mail client or on your
  41     webmail provider anymore.
  42
  43 Cons
  44 ----
  45
  46 - compared to procmail which can be run each time a mail is received,
  47   imapami needs to be launched periodically, for instance in a crontab.