d6f9411dabbf162bf34df9a7ecb8eec233d82bd6
[notmuch] / 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
5
6 Welcome to :mod:`cnotmuch`'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:`notmuch.Database`, :class:`notmuch.Query` provide most of the core functionality, returning :class:`notmuch.Messages` and :class:`notmuch.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 :mod:`notmuch` -- The Notmuch interface
31 =============================================
32
33 .. automodule:: cnotmuch.notmuch
34
35 :todo: Document nmlib,STATUS
36
37 :class:`Database` -- The underlying notmuch database
38 -----------------------------------------------------
39
40 .. autoclass:: Database([path=None[, create=False[, mode=MODE.READ_ONLY]]])
41
42    .. automethod:: create
43
44    .. automethod:: open(path, status=MODE.READ_ONLY)
45
46    .. automethod:: get_path
47
48    .. automethod:: find_message
49
50    .. automethod:: get_all_tags
51
52
53    .. attribute:: Database.MODE
54
55      Defines constants that are used as the mode in which to open a database.
56
57      MODE.READ_ONLY
58        Open the database in read-only mode
59
60      MODE.READ_WRITE
61        Open the database in read-write mode
62
63    .. autoattribute:: db_p
64
65 :class:`Query` -- Represents a notmuch Query
66 -----------------------------------------------
67
68 .. autoclass:: Query
69    :members:
70
71 :class:`Messages` -- A bunch of messages
72 ----------------------------------------
73
74 .. autoclass:: Messages
75    :members:
76
77 :class:`Message` -- A single message
78 ----------------------------------------
79
80 .. autoclass:: Message
81    :members:
82
83 :class:`Tags` -- A bunch of notmuch tags
84 ----------------------------------------
85
86 .. autoclass:: Tags
87    :members:
88
89    .. data: '__notmuchcmd__'
90
91       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.
92
93 :exc:`NotmuchError` -- A Notmuch execution error
94 ------------------------------------------------
95 .. autoexception:: NotmuchError
96    :members:
97
98    This execption inherits directly from :exc:`Exception` and is raised on errors during the notmuch execution.
99
100 :class:`STATUS` -- Notmuch operation return status
101 --------------------------------------------------
102 .. autoclass:: STATUS
103    :members:
104
105 Indices and tables
106 ==================
107
108 * :ref:`genindex`
109 * :ref:`search`
110