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

   1 .. cnotmuch documentation master file, created by
   2    sphinx-quickstart on Tue Feb  2 10:00:47 2010.
   3
   4 .. currentmodule:: cnotmuch.notmuch
   5
   6 Welcome to notmuch's documentation!
   7 ===================================
   8
   9 The :mod:`cnotmuch` module provides an interface to the `notmuch <http://notmuchmail.org>`_ functionality, directly interfacing to a shared notmuch library.
  10 The classes :class:`Database`, :class:`Query` provide most of the core functionality, returning :class:`Messages` and :class:`Tags`.
  11
  12 .. moduleauthor:: Sebastian Spaeth <Sebastian@SSpaeth.de>
  13
  14 :License: This module is covered under the GNU GPL v3 (or later).
  15
  16 This page contains the main API overview. More information on specific topics can be found on the following pages: (none here yet)
  17
  18 Notmuch can be imported as:
  19
  20  from cnotmuch import notmuch
  21
  22 or:
  23
  24  from cnotmuch.notmuch import Query,Database
  25
  26 .. toctree::
  27    :maxdepth: 1
  28
  29
  30
  31 :mod:`notmuch` -- The Notmuch interface
  32 =============================================
  33
  34 Document from cnotmuch.globals import nmlib,STATUS,NotmuchError
  35
  36 :class:`Database` -- The underlying notmuch database
  37 -----------------------------------------------------
  38
  39 .. autoclass:: Database
  40    :members:
  41
  42 :class:`Query` -- Represents a notmuch Query
  43 -----------------------------------------------
  44
  45 .. autoclass:: Query
  46    :members:
  47
  48    .. note:: A Thread is what a call to notmuch.show() will return, containing a bunch of :class:`Message`\ s.
  49
  50 :class:`Messages` -- A bunch of messages
  51 ----------------------------------------
  52
  53 .. autoclass:: Messages
  54    :members:
  55
  56 :class:`Message` -- A single message
  57 ----------------------------------------
  58
  59 .. autoclass:: Message
  60    :members:
  61
  62 :class:`Tags` -- A bunch of notmuch tags
  63 ----------------------------------------
  64
  65 .. autoclass:: Tags
  66    :members:
  67
  68    .. data: '__notmuchcmd__'
  69
  70       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.
  71
  72 :exc:`NotmuchError` -- A Notmuch execution error
  73 ------------------------------------------------
  74 .. autoexception:: NotmuchError
  75    :members:
  76
  77    This execption inherits directly from :exc:`Exception` and is raised on errors during the notmuch execution.
  78
  79 Indices and tables
  80 ==================
  81
  82 * :ref:`genindex`
  83 * :ref:`search`
  84