Metadata-Version: 2.0
Name: mailbot
Version: 0.3
Summary: MailBot: execute callback on mail reception
Home-page: https://github.com/magopian/mailbot
Author: Mathieu Agopian
Author-email: mathieu.agopian@gmail.com
License: BSD Licence
Keywords: m,a,i,l, ,c,a,l,l,b,a,c,k
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Requires-Dist: imapclient

#######
MailBot
#######

.. image:: https://secure.travis-ci.org/magopian/mailbot.png?branch=master
   :alt: Build Status
   :target: https://travis-ci.org/magopian/mailbot

MailBot: register callbacks to be executed on mail reception.

* Authors: Mathieu Agopian and `contributors
  <https://github.com/magopian/mailbot/contributors>`_
* Licence: BSD
* Compatibility: Python 2.7 and Python 3.3
* Project URL: https://github.com/magopian/mailbot
* Documentation: http://mailbot.rtfd.org/


Hacking
=======

Setup your environment:

::

    git clone https://github.com/magopian/mailbot.git
    cd mailbot

Hack and run the tests using `Tox <https://pypi.python.org/pypi/tox>`_ to test
on all the supported python versions:

::

    make test

There's also a live test suite, that you may run using the following command:

::

    make livetest

Please note that to run live tests, you need to create a
``livetest_settings.py`` file with the following content:

::

    # mandatory
    HOST = 'your host here'
    USERNAME = 'your username here'
    PASSWORD = 'your password here'

    # optional
    # check http://imapclient.readthedocs.org/en/latest/#imapclient.IMAPClient)
    PORT = 143  # port number, usually 143 or 993 if ssl is enabled
    USE_UID = True
    SSL = False
    STREAM = False

For convenience, you can copy the provided sample, and modify it:

::

    $ cp livetest_settings.py.sample livetest_settings.py


Changelog
=========

0.3 (2013-03-28)
----------------

  - compatible python 3.3


0.2 (2013-03-28)
----------------

  - automatically decode headers, allowing for unicode subjects, senders,
    recipients, CCs and body
  - new timeout parameter: mails in the processing state for longer than this
    timeout will be reprocessed
  - use SEEN and FLAGGED to manage mail states (not processed, processing,
    processed)
  - captures from the rules' regexps available in Callback.matches (previously,
    this was storing MatchObjects)


0.1 (2013-03-20)
----------------

  - first version


