-.. notmuch documentation master file, created by
+.. cnotmuch documentation master file, created by
sphinx-quickstart on Tue Feb 2 10:00:47 2010.
-.. currentmodule:: notmuch.notmuch
+.. currentmodule:: cnotmuch
-Welcome to notmuch's documentation!
-===================================
+Welcome to :mod:`cnotmuch`'s documentation
+===========================================
-The :mod:`notmuch` module provides an interface to the `notmuch <http://notmuchmail.org>`_ functionality. The main work horse of this module is the class :class:`Notmuch` with important other classes representing a :class:`Thread` and a single :class:`Message`.
+The :mod:`cnotmuch` module provides an interface to the `notmuch <http://notmuchmail.org>`_ functionality, directly interfacing to a shared notmuch library.
+The classes :class:`notmuch.Database`, :class:`notmuch.Query` provide most of the core functionality, returning :class:`notmuch.Messages` and :class:`notmuch.Tags`.
.. moduleauthor:: Sebastian Spaeth <Sebastian@SSpaeth.de>
-:License: This module is covered under the GNU GPL v2 (or later).
+:License: This module is covered under the GNU GPL v3 (or later).
-This page contains the main API overview. More information on specific topics can be found on the following pages:
+This page contains the main API overview. More information on specific topics can be found on the following pages: (none here yet)
+
+Notmuch can be imported as::
+
+ from cnotmuch import notmuch
+
+or::
+
+ from cnotmuch.notmuch import Query,Database
.. toctree::
:maxdepth: 1
-
:mod:`notmuch` -- The Notmuch interface
=============================================
-:class:`Message` -- A single email message
-------------------------------------
+.. automodule:: cnotmuch.notmuch
-.. autoclass:: Message
- :members:
+:todo: Document nmlib,STATUS
+
+:class:`Database` -- The underlying notmuch database
+-----------------------------------------------------
+
+.. autoclass:: Database([path=None[, create=False[, mode=MODE.READ_ONLY]]])
+
+ .. automethod:: create
+
+ .. automethod:: open(path, status=MODE.READ_ONLY)
+
+ .. automethod:: get_path
+
+ .. automethod:: find_message
+
+ .. automethod:: get_all_tags
-:class:`Thread` -- Represents a message thread
+
+ .. attribute:: Database.MODE
+
+ Defines constants that are used as the mode in which to open a database.
+
+ MODE.READ_ONLY
+ Open the database in read-only mode
+
+ MODE.READ_WRITE
+ Open the database in read-write mode
+
+ .. autoattribute:: db_p
+
+:class:`Query` -- Represents a notmuch Query
-----------------------------------------------
-.. autoclass:: Thread
+.. autoclass:: Query
+ :members:
+
+:class:`Messages` -- A bunch of messages
+----------------------------------------
+
+.. autoclass:: Messages
:members:
- .. note:: A Thread is what a call to notmuch.show() will return, containing a bunch of :class:`Message`\ s.
+:class:`Message` -- A single message
+----------------------------------------
-:class:`Notmuch` -- A notmuch call
-------------------------------------
+.. autoclass:: Message
+ :members:
-.. autoclass:: Notmuch
+:class:`Tags` -- A bunch of notmuch tags
+----------------------------------------
+
+.. autoclass:: Tags
:members:
.. data: '__notmuchcmd__'
This execption inherits directly from :exc:`Exception` and is raised on errors during the notmuch execution.
+:class:`STATUS` -- Notmuch operation return status
+--------------------------------------------------
+.. autoclass:: STATUS
+ :members:
+
Indices and tables
==================