.. -*- coding: utf-8 -*-

.. _OfflineIMAP: https://github.com/nicolas33/offlineimap

.. contents::
.. sectnum::

===================
HACKING OFFLINEIMAP
===================

Welcome to the `OfflineIMAP`_ project. You'll find here all the information you
need to start hacking OfflineIMAP. Be aware there are a lot of very usefull tips
in the mailing list.  You may want to subscribe if you didn't, yet. This is
where you'll get help.

===
API
===

API is documented in the dev-doc-src directory using the sphinx tools (also used
for python itself). This is a WIP. Contributions in this area would be very
appreciated.