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

.. currentmodule:: notmuch

The :mod:`notmuch` module provides an interface to the `notmuch
<https://notmuchmail.org>`_ functionality, directly interfacing to a
shared notmuch library.  Within :mod:`notmuch`, the classes
:class:`Database`, :class:`Query` provide most of the core
functionality, returning :class:`Threads`, :class:`Messages` and
:class:`Tags`.

.. moduleauthor:: Sebastian Spaeth <Sebastian@SSpaeth.de>

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

.. toctree::
   :maxdepth: 1

   quickstart
   notes
   status_and_errors
   database
   query
   messages
   message
   tags
   threads
   thread
   filesystem

Indices and tables
==================

* :ref:`genindex`
* :ref:`search`
