doc update

This commit is contained in:
Mathieu Agopian
2013-03-20 09:40:46 +01:00
parent 208288e8e8
commit abd169c95f

View File

@@ -56,9 +56,17 @@ You also need to provide the username and password. Here's an simple example:
from mailbot import MailBot
from mycallbacks import MyCallback
mailbot = MailBot('imap.myserver.com', 'username', 'password')
# register your callback
mailbot.register(MyCallback)
# check the unprocessed messages and trigger the callback
mailbot.process_messages()
Once that's done, you may register the callbacks and rules that will be tested
on each mail received when calling ``mailbot.process_messages``.
@@ -221,10 +229,3 @@ All the rules are respected, and the callback will be triggered
The last bullet point also means that if register a callback with no rules at
all, it'll be triggered on each and every email, making it a "catchall
callback".
Contents
--------
.. toctree::
:maxdepth: 2