1 .. cnotmuch documentation master file, created by
2 sphinx-quickstart on Tue Feb 2 10:00:47 2010.
4 .. currentmodule:: cnotmuch.notmuch
6 Welcome to notmuch's documentation!
7 ===================================
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`.
12 .. moduleauthor:: Sebastian Spaeth <Sebastian@SSpaeth.de>
14 :License: This module is covered under the GNU GPL v3 (or later).
16 This page contains the main API overview. More information on specific topics can be found on the following pages: (none here yet)
18 Notmuch can be imported as:
20 from cnotmuch import notmuch
24 from cnotmuch.notmuch import Query,Database
31 :mod:`notmuch` -- The Notmuch interface
32 =============================================
34 Document from cnotmuch.globals import nmlib,STATUS,NotmuchError
36 :class:`Database` -- The underlying notmuch database
37 -----------------------------------------------------
39 .. autoclass:: Database
42 :class:`Query` -- Represents a notmuch Query
43 -----------------------------------------------
48 .. note:: A Thread is what a call to notmuch.show() will return, containing a bunch of :class:`Message`\ s.
50 :class:`Messages` -- A bunch of messages
51 ----------------------------------------
53 .. autoclass:: Messages
56 :class:`Message` -- A single message
57 ----------------------------------------
59 .. autoclass:: Message
62 :class:`Tags` -- A bunch of notmuch tags
63 ----------------------------------------
68 .. data: '__notmuchcmd__'
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.
72 :exc:`NotmuchError` -- A Notmuch execution error
73 ------------------------------------------------
74 .. autoexception:: NotmuchError
77 This execption inherits directly from :exc:`Exception` and is raised on errors during the notmuch execution.