git.notmuchmail.org Git - notmuch/blob - docs/source/index.rst

   1 .. notmuch documentation master file, created by
   2    sphinx-quickstart on Tue Feb  2 10:00:47 2010.
   3
   4 .. currentmodule:: notmuch.notmuch
   5
   6 Welcome to notmuch's documentation!
   7 ===================================
   8
   9 The :mod:`notmuch` module provides an interface to the `notmuch <http://notmuchmail.org>`_ functionality. The main work horse of this module is the class :class:`Notmuch` with important other classes representing a :class:`Thread` and a single :class:`Message`.
  10
  11 .. moduleauthor:: Sebastian Spaeth <Sebastian@SSpaeth.de>
  12
  13 :License: This module is covered under the GNU GPL v2 (or later).
  14
  15 This page contains the main API overview. More information on specific topics can be found on the following pages:
  16
  17 .. toctree::
  18    :maxdepth: 1
  19
  20
  21
  22 :mod:`notmuch` -- The Notmuch interface
  23 =============================================
  24
  25 :class:`Message` -- A single email message
  26 ------------------------------------
  27
  28 .. autoclass:: Message
  29    :members:
  30
  31 :class:`Thread` -- Represents a message thread
  32 -----------------------------------------------
  33
  34 .. autoclass:: Thread
  35    :members:
  36
  37    .. note:: A Thread is what a call to notmuch.show() will return, containing a bunch of :class:`Message`\ s.
  38
  39 :class:`Notmuch` -- A notmuch call
  40 ------------------------------------
  41
  42 .. autoclass:: Notmuch
  43    :members:
  44
  45    .. data: '__notmuchcmd__'
  46
  47       This is the actual binary that will be executed in order to run a notmuch command. This is set to *notmuch* and should usually not be changed.
  48
  49 :exc:`NotmuchError` -- A Notmuch execution error
  50 ------------------------------------------------
  51 .. autoexception:: NotmuchError
  52    :members:
  53
  54    This execption inherits directly from :exc:`Exception` and is raised on errors during the notmuch execution.
  55
  56 Indices and tables
  57 ==================
  58
  59 * :ref:`genindex`
  60 * :ref:`search`
  61