aioimaplib: A Python repository from aliceh75

About

This library is inspired by imaplib and imaplib2 from Piers Lauder, Nicolas Sebrecht, Sebastian Spaeth. Some utilities functions are taken from imaplib/imaplib2 thanks to them.

The aim is to port the imaplib with asyncio, to benefit from the sleep or treat model.

It runs with python 3.4 and 3.5.

Example

import asyncio
from aioimaplib import aioimaplib


@asyncio.coroutine
def check_mailbox(host, user, password):
    imap_client = aioimaplib.IMAP4_SSL(host=host)
    yield from imap_client.wait_hello_from_server()

    yield from imap_client.login(user, password)

    res, data = yield from imap_client.select()
    print('there is %s messages INBOX' % data[0])

    yield from imap_client.logout()


if __name__ == '__main__':
    loop = asyncio.get_event_loop()
    loop.run_until_complete(check_mailbox('my.imap.server', 'user', 'pass'))

Beware that the IMAP4.close() function is an IMAP function that is closing the selected mailbox, thus passing from SELECTED state to AUTH state. It does not close the TCP connection. The way to close TCP connection properly is to logout.

IDLE command

The RFC2177 is implemented, to be able to wait for new mail messages without using CPU. The responses are pushed in an async queue, and it is possible to read them in real time. To leave the IDLE mode, it is necessary to send a "DONE" command to the server.

@asyncio.coroutine
def wait_for_new_message(host, user, password):
    imap_client = aioimaplib.IMAP4_SSL(host=host)
    yield from imap_client.wait_hello_from_server()

    yield from imap_client.login(user, password)
    yield from imap_client.select()

    idle = yield from imap_client.idle_start(timeout=10)
    while imap_client.has_pending_idle():
        msg = yield from imap_client.wait_server_push()
        print(msg)
        if msg == STOP_WAIT_SERVER_PUSH:
            imap_client.idle_done()
            yield from asyncio.wait_for(idle, 1)

    yield from imap_client.logout()

if __name__ == '__main__':
        loop = asyncio.get_event_loop()
        loop.run_until_complete(wait_for_new_message('my.imap.server', 'user', 'pass'))

Or in a more event based style (the IDLE command is closed at each message from server):

@asyncio.coroutine
def idle_loop(host, user, password):
   imap_client = aioimaplib.IMAP4_SSL(host=host, timeout=30)
   yield from imap_client.wait_hello_from_server()

   yield from imap_client.login(user, password)
   yield from imap_client.select()

   while True:
      print((yield from imap_client.uid('fetch', '1:*', 'FLAGS')))

      idle = yield from imap_client.idle_start(timeout=60)
      print((yield from imap_client.wait_server_push()))

      imap_client.idle_done()
      yield from asyncio.wait_for(idle, 30)

Threading

The IMAP4ClientProtocol class is not thread safe, it uses asyncio.Event and asyncio.Condition that are not thread safe, and state change for pending commands is not locked.

It is possible to use threads but each IMAP4ClientProtocol instance should run in the same thread :

Each color rectangle is an IMAP4ClientProtocol instance piece of code executed by the thread asyncio loop until it reaches a yield, waiting on I/O.

For example, it is possible to launch 4 mono-threaded mail-fetcher processes on a 4 cores server with supervisor, and use a distribution function like len(email) % (process_num) or whatever to share equally a mail account list between the 4 processes.

IMAP command concurrency

IMAP protocol allows to run some commands in parallel. Four rules are implemented to ensure responses consistency:

if a sync command is running, the following requests (sync or async) must wait
if an async command is running, same async commands (or with the same untagged response type) must wait
async commands can be executed in parallel
sync command must wait pending async commands to finish

Logging

As said in the logging howto the logger is defined with

logger = logging.getLogger(__name__)

Where name is 'aioimaplib.aioimaplib'. You can set the logger parameters, either by python API

aioimaplib_logger = logging.getLogger('aioimaplib.aioimaplib')
sh = logging.StreamHandler()
sh.setLevel(logging.DEBUG)
sh.setFormatter(logging.Formatter("%(asctime)s %(levelname)s [%(module)s:%(lineno)d] %(message)s"))
aioimaplib_logger.addHandler(sh)

Or loading config file (for example with logging.config.dictConfig(yaml.load(file))) with this piece of yaml file:

loggers:
...
  aioimaplib.aioimaplib:
    level: DEBUG
    handlers: [syslog]
    propagate: no
...

Tested with

dovecot 2.2.13 on debian Jessie
gmail with imap and SSL
outlook with SSL
yahoo with SSL
free.fr with SSL
orange.fr with SSL
mailden.net with SSL

Develop

Developers are welcome ! If you want to improve it, fix bugs, test it with other IMAP servers, give feedback, thank you for it.

To develop, just run:

virtualenv --python=python3.4 venv
source venv/bin/activate
python setup.py develop
pip install -r dev-requirements.txt
nosetests

To add an imaplib or imaplib2 command you can :

add the function to the testing imapserver with a new imaplib or imaplib2 server test, i.e. test_imapserver_imaplib.py or test_imapserver_imaplib2.py respectively;
then add the function to the aioimaplib doing almost the same test than above but the async way in test_aioimaplib.py.

Not unit tested

PREAUTH
SSL

TODO

23/25 IMAP4rev1 commands are implemented from the main rfc3501. 'STARTTLS' and 'AUTHENTICATE' are still missing.
'COMPRESS' from rfc4978
'SETACL' 'DELETEACL' 'GETACL' 'MYRIGHTS' 'LISTRIGHTS' from ACL rfc4314
'GETQUOTA': 'GETQUOTAROOT': 'SETQUOTA' from quota rfc2087
'SORT' and 'THREAD' from the rfc5256
'ID' from the rfc2971
'NAMESPACE' from rfc2342
'CATENATE' from rfc4469
tests with other servers

If it goes wrong

Sometimes you break things and you don't understand what's going on (I always do). For this library I have two related tools:

ngrep on the imap test port : sudo ngrep -d lo port 12345
activate debug logs changing INFO to DEBUG at the top of the mock server and the aioimaplib

aliceh75/aioimaplib