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:
.. toctree::
:maxdepth: 1
+ status_and_errors
notmuch
:mod:`notmuch` -- The Notmuch interface
.. automodule:: notmuch
-:todo: Document nmlib,STATUS
-
:class:`notmuch.Database` -- The underlying notmuch database
---------------------------------------------------------------------
.. 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
-------------------------------------------------
Sort by message date, newest first.
SORT.MESSAGE_ID
- Sort by email message ID
+ Sort by email message ID.
+
+ SORT.UNSORTED
+ 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
----------------------------------------
.. automethod:: collect_tags
- .. automethod:: __len__
+ .. 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))`.
:class:`Message` -- A single message
----------------------------------------
.. automethod:: get_filename
+ .. automethod:: get_filenames
+
.. attribute:: FLAG
FLAG.MATCH
query. This allows us to distinguish matches from the rest
of the messages in that thread.
- .. automethod:: get_flag
+ .. automethod:: get_flag
.. automethod:: set_flag
.. automethod:: get_tags
+ .. automethod:: maildir_flags_to_tags
+
+ .. automethod:: tags_to_maildir_flags
+
.. automethod:: remove_tag
.. automethod:: add_tag
.. automethod:: thaw
- .. automethod:: format_as_text
+ .. automethod:: format_message_as_json
+
+ .. automethod:: format_message_as_text
.. automethod:: __str__
.. 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__
.. autoattribute:: notmuch.database.Directory.path
-:exc:`NotmuchError` -- A Notmuch execution error
-------------------------------------------------
-.. autoexception:: NotmuchError
- :members:
-
- This execption inherits directly from :exc:`Exception` and is raised on errors during the notmuch execution.
-
-:class:`STATUS` -- Notmuch operation return status
---------------------------------------------------
-
-.. data:: STATUS
-
- STATUS is a class, whose attributes provide constants that serve as return indicators for notmuch functions. Currently the following ones are defined. For possible return values and specific meaning for each method, see the method description.
-
- * SUCCESS
- * OUT_OF_MEMORY
- * READ_ONLY_DATABASE
- * XAPIAN_EXCEPTION
- * FILE_ERROR
- * FILE_NOT_EMAIL
- * DUPLICATE_MESSAGE_ID
- * NULL_POINTER
- * TAG_TOO_LONG
- * UNBALANCED_FREEZE_THAW
- * NOT_INITIALIZED
+The `next page <status_and_errors.html>`_ contains information on possible Status and Error values.
Indices and tables
==================