https://github.com/magopian/mailbot

MailBot: register callbacks to be executed on mail reception.
https://github.com/magopian/mailbot

Last synced: 3 months ago
JSON representation

MailBot: register callbacks to be executed on mail reception.

• Host: GitHub
• URL: https://github.com/magopian/mailbot
• Owner: magopian
• License: other
• Created: 2013-03-13T10:42:04.000Z (almost 12 years ago)
• Default Branch: master
• Last Pushed: 2016-07-10T18:29:34.000Z (over 8 years ago)
• Last Synced: 2024-08-18T17:15:31.394Z (4 months ago)
• Language: Python
• Size: 300 KB
• Stars: 26
• Watchers: 14
• Forks: 12
• Open Issues: 6
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG
  • License: LICENSE

Awesome Lists containing this project

README

        
#######

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

  `_

* 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 `_ 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