1 .. cnotmuch documentation master file, created by
2 sphinx-quickstart on Tue Feb 2 10:00:47 2010.
4 .. currentmodule:: cnotmuch
6 Welcome to :mod:`cnotmuch`'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:`notmuch.Database`, :class:`notmuch.Query` provide most of the core functionality, returning :class:`notmuch.Messages` and :class:`notmuch.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
30 :mod:`notmuch` -- The Notmuch interface
31 =============================================
33 .. automodule:: cnotmuch.notmuch
35 :todo: Document nmlib,STATUS
37 :class:`Database` -- The underlying notmuch database
38 -----------------------------------------------------
40 .. autoclass:: Database([path=None[, create=False[, mode=MODE.READ_ONLY]]])
42 .. automethod:: create
44 .. automethod:: open(path, status=MODE.READ_ONLY)
46 .. automethod:: get_path
48 .. automethod:: get_version
50 .. automethod:: needs_upgrade
52 .. automethod:: upgrade
54 .. automethod:: get_directory
56 .. automethod:: add_message
58 .. automethod:: remove_message
60 .. automethod:: find_message
62 .. automethod:: get_all_tags
65 .. attribute:: Database.MODE
67 Defines constants that are used as the mode in which to open a database.
70 Open the database in read-only mode
73 Open the database in read-write mode
75 .. autoattribute:: db_p
77 :class:`Query` -- A search query
78 -----------------------------------------------
82 .. automethod:: create
84 .. attribute:: Query.SORT
86 Defines constants that are used as the mode in which to open a database.
89 Sort by message date, oldest first.
92 Sort by message date, newest first.
95 Sort by email message ID
97 .. automethod:: set_sort
99 .. automethod:: search_messages
101 :class:`Messages` -- A bunch of messages
102 ----------------------------------------
104 .. autoclass:: Messages
106 .. automethod:: collect_tags
108 .. automethod:: __len__
110 :class:`Message` -- A single message
111 ----------------------------------------
113 .. autoclass:: Message
115 .. automethod:: get_message_id
117 .. automethod:: get_date
119 .. automethod:: get_header
121 .. automethod:: get_filename
123 .. automethod:: get_tags
125 .. automethod:: remove_tag
127 .. automethod:: add_tag
129 .. automethod:: format_as_text
131 .. automethod:: __str__
133 :class:`Tags` -- Notmuch tags
134 -----------------------------
139 .. automethod:: __len__
141 .. automethod:: __str__
143 :exc:`NotmuchError` -- A Notmuch execution error
144 ------------------------------------------------
145 .. autoexception:: NotmuchError
148 This execption inherits directly from :exc:`Exception` and is raised on errors during the notmuch execution.
150 :class:`STATUS` -- Notmuch operation return status
151 --------------------------------------------------
152 .. autoclass:: STATUS