: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::
or::
- from notmuch import Query,Database
+ from notmuch import Query, Database
+
+ db = Database('path',create=True)
+ msgs = Query(db,'from:myself').search_messages()
+
+ for msg in msgs:
+ print (msg)
More information on specific topics can be found on the following pages:
:maxdepth: 1
status_and_errors
- notmuch
+ notmuch
:mod:`notmuch` -- The Notmuch interface
=================================================
.. automodule:: notmuch
-:todo: Document nmlib,STATUS
-
-:class:`notmuch.Database` -- The underlying notmuch database
+:class:`Database` -- The underlying notmuch database
---------------------------------------------------------------------
-.. autoclass:: notmuch.Database([path=None[, create=False[, mode=MODE.READ_ONLY]]])
+.. autoclass:: Database([path=None[, create=False[, mode=MODE.READ_ONLY]]])
.. automethod:: create
.. automethod:: upgrade
+ .. automethod:: begin_atomic
+
+ .. automethod:: end_atomic
+
.. automethod:: get_directory
.. automethod:: add_message
.. automethod:: find_message
+ .. automethod:: find_message_by_filename
+
.. automethod:: get_all_tags
.. automethod:: create_query
- .. note:: :meth:`create_query` was broken in release
- 0.1 and is fixed since 0.1.1.
-
.. attribute:: Database.MODE
Defines constants that are used as the mode in which to open a database.
.. autoattribute:: db_p
-:class:`notmuch.Query` -- A search query
+
+:class:`Query` -- A search query
-------------------------------------------------
-.. autoclass:: notmuch.Query
+.. autoclass:: Query
.. automethod:: create
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__()
- .. note:: :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
.. autoclass:: Tags
:members:
- .. automethod:: __len__
+ .. 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.
.. automethod:: __str__
-:class:`notmuch.Threads` -- Threads iterator
+:class:`Threads` -- Threads iterator
-----------------------------------------------------
-.. autoclass:: notmuch.Threads
+.. autoclass:: Threads
.. automethod:: __len__
:class:`Filenames` -- An iterator over filenames
------------------------------------------------
-.. autoclass:: notmuch.database.Filenames
+.. autoclass:: Filenames
+
+ .. automethod:: Filenames.__len__
- .. automethod:: notmuch.database.Filenames.__len__
+ .. automethod:: Filenames.as_generator
-:class:`notmuch.database.Directoy` -- A directory entry in the database
+:class:`Directoy` -- A directory entry in the database
------------------------------------------------------------------------
-.. autoclass:: notmuch.database.Directory
+.. autoclass:: Directory
- .. automethod:: notmuch.database.Directory.get_child_files
+ .. automethod:: Directory.get_child_files
- .. automethod:: notmuch.database.Directory.get_child_directories
+ .. automethod:: Directory.get_child_directories
- .. automethod:: notmuch.database.Directory.get_mtime
+ .. automethod:: Directory.get_mtime
- .. automethod:: notmuch.database.Directory.set_mtime
+ .. automethod:: Directory.set_mtime
- .. autoattribute:: notmuch.database.Directory.mtime
+ .. autoattribute:: Directory.mtime
- .. autoattribute:: notmuch.database.Directory.path
+ .. autoattribute:: Directory.path
The `next page <status_and_errors.html>`_ contains information on possible Status and Error values.