:License: This module is covered under the GNU GPL v3 (or later).
-This page contains the main API overview of notmuch |release|.
+This page contains the main API overview of notmuch |release|.
Notmuch can be imported as::
:maxdepth: 1
status_and_errors
- notmuch
+ notmuch
:mod:`notmuch` -- The Notmuch interface
=================================================
Sort by email message ID.
SORT.UNSORTED
- Do not apply a special sort order (returns results in document id
- order).
+ Do not apply a special sort order (returns results in document id
+ order).
.. automethod:: set_sort
.. automethod:: count_messages
+ .. automethod:: count_threads
+
:class:`Messages` -- A bunch of messages
----------------------------------------
.. method:: __len__()
- .. warning:: :meth:`__len__` was removed in version 0.6 as it exhausted
- the iterator and broke list(Messages()). Use the
- :meth:`Query.count_messages` function or use
- `len(list(msgs))`.
+ .. warning::
+
+ :meth:`__len__` was removed in version 0.6 as it exhausted the iterator and broke
+ list(Messages()). Use the :meth:`Query.count_messages` function or use `len(list(msgs))`.
:class:`Message` -- A single message
----------------------------------------
.. attribute:: FLAG
- FLAG.MATCH
+ 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
.. automethod:: get_flag
.. automethod:: set_flag
-
+
.. automethod:: get_date
.. automethod:: get_header
.. method:: __len__
- .. warning:: :meth:`__len__` was removed in version 0.6 as it
- exhausted the iterator and broke list(Tags()). Use
- :meth:`len(list(msgs))` instead if you need to know the
- number of tags.
+ .. warning::
+
+ :meth:`__len__` was removed in version 0.6 as it exhausted the iterator and broke
+ list(Tags()). Use :meth:`len(list(msgs))` instead if you need to know the number of
+ tags.
.. automethod:: __str__