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
36 :class:`Database` -- The underlying notmuch database
37 -----------------------------------------------------
39 .. autoclass:: Database([path=None[, create=False[, mode=MODE.READ_ONLY]]])
41 .. automethod:: create
43 .. automethod:: open(path, status=MODE.READ_ONLY)
45 .. automethod:: get_path
47 .. automethod:: find_message
49 .. automethod:: get_all_tags
52 .. attribute:: Database.MODE
54 Defines constants that are used as the mode in which to open a database.
57 Open the database in read-only mode
60 Open the database in read-write mode
62 .. autoattribute:: db_p
64 :class:`Query` -- Represents a notmuch Query
65 -----------------------------------------------
70 :class:`Messages` -- A bunch of messages
71 ----------------------------------------
73 .. autoclass:: Messages
76 :class:`Message` -- A single message
77 ----------------------------------------
79 .. autoclass:: Message
82 :class:`Tags` -- A bunch of notmuch tags
83 ----------------------------------------
88 .. data: '__notmuchcmd__'
90 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 :exc:`NotmuchError` -- A Notmuch execution error
93 ------------------------------------------------
94 .. autoexception:: NotmuchError
97 This execption inherits directly from :exc:`Exception` and is raised on errors during the notmuch execution.
99 :class:`STATUS` -- Notmuch operation return status
100 --------------------------------------------------
101 .. autoclass:: STATUS