.. OfflineImap documentation master file
.. _OfflineImap: http://offlineimap.org


Welcome to :mod:`offlineimaps`'s documentation
==============================================

`OfflineImap`_ synchronizes email between an IMAP server and a MailDir or
between two IMAP servers. It offers very powerful and flexible configuration
options, that allow things such as the filtering of folders, transposing of
names via static configuration or python scripting. It plays well with mutt and
other MailDir consuming email clients.

The documentation contains the end user documentation in a first part. It also
contains use cases and example configurations.  It is followed by the internal
:doc:`API documentation <API>` for those interested in modifying the source code
or otherwise peek into the OfflineImap internals in a second part.


If you just want to get started with minimal fuzz, have a look at our `online
quick start guide <http://offlineimap.org/#ref-quick-start>`_. Do note though,
that our configuration options are many and powerful. Perusing our precious
documentation does often pay off!

More information on specific topics can be found on the following pages:

**User documentation**
  * :doc:`Overview and features <features>`
  * :doc:`installation/uninstall <INSTALL>`

**Configuration**
  * :doc:`user manual/Configuration <MANUAL>`
  * :doc:`Folder filtering & name transformation guide <nametrans>`
  * :doc:`maxage <advanced_config>`
  * :doc:`command line options <offlineimap>`
  * :doc:`Frequently Asked Questions <FAQ>`

**Developer documentation**
  * :doc:`Contributing <CONTRIBUTING>`
  * :doc:`Advanced Git <GitAdvanced>`
  * :doc:`API documentation <API>` for internal details on the
    :mod:`offlineimap` module

.. toctree::
   :hidden:

   features
   INSTALL
   MANUAL
   nametrans
   advanced_config
   offlineimap
   FAQ

   CONTRIBUTING
   GitAdvanced
   API
   repository
   ui


.. moduleauthor:: John Goerzen, and many others. See AUTHORS and the git history for a full list.

:License: This module is covered under the GNU GPL v2 (or later).