===========================================
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`.
+The classes :class:`notmuch.Database`, :class:`notmuch.Query` provide most of the core functionality, returning :class:`notmuch.Threads`, :class:`notmuch.Messages` and :class:`notmuch.Tags`.
.. moduleauthor:: Sebastian Spaeth <Sebastian@SSpaeth.de>
.. automethod:: count_messages
+.. #############################################
+.. currentmodule:: cnotmuch.message
+
:class:`Messages` -- A bunch of messages
----------------------------------------
.. automethod:: get_filename
- .. automethod:: get_flag
+ .. attribute:: FLAG
+
+ FLAG.MATCH
+ This flag is automatically set by a
+ Query.search_threads on those messages that match the
+ query. This allows us to distinguish matches from the rest
+ of the messages in that thread.
+
+ .. automethod:: get_flag
.. automethod:: set_flag
.. automethod:: __str__
+.. #############################################
+.. currentmodule:: cnotmuch.tag
+
:class:`Tags` -- Notmuch tags
-----------------------------
.. automethod:: __str__
-.. -----------------------------------------------------------------
+.. #############################################
.. currentmodule:: cnotmuch.thread
:class:`Threads` -- Threads iterator
.. automethod:: __str__
+.. #############################################
+.. currentmodule:: cnotmuch.notmuch
+
:class:`Filenames` -- An iterator over filenames
------------------------------------------------