: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: (none here yet)
+This page contains the main API overview of cnotmuch |release|. More information on specific topics can be found on the following pages: (none here yet)
Notmuch can be imported as::
.. automethod:: get_path
+ .. automethod:: get_version
+
+ .. automethod:: needs_upgrade
+
+ .. automethod:: upgrade
+
+ .. automethod:: get_directory
+
+ .. automethod:: add_message
+
+ .. automethod:: remove_message
+
.. automethod:: find_message
.. automethod:: get_all_tags
+ .. automethod:: create_query
.. attribute:: Database.MODE
.. automethod:: set_sort
+ .. automethod:: search_threads
+
.. automethod:: search_messages
+ .. automethod:: count_messages
+
:class:`Messages` -- A bunch of messages
----------------------------------------
.. automethod:: get_message_id
- .. automethod:: get_date
+ .. automethod:: get_thread_id
- .. automethod:: get_header
+ .. automethod:: get_replies
.. automethod:: get_filename
+ .. automethod:: get_flag
+
+ .. automethod:: set_flag
+
+ .. automethod:: get_date
+
+ .. automethod:: get_header
+
.. automethod:: get_tags
.. automethod:: remove_tag
.. automethod:: add_tag
+ .. automethod:: remove_all_tags
+
+ .. automethod:: freeze
+
+ .. automethod:: thaw
+
.. automethod:: format_as_text
.. automethod:: __str__
.. automethod:: __str__
+:class:`Threads` -- Threads iterator
+------------------------------------
+
+To be implemented
+
+:class:`Thread` -- A single thread
+------------------------------------
+
+To be implemented
+
+:class:`Filenames` -- An iterator over filenames
+------------------------------------------------
+
+To be implemented
+
+:class:`Directoy` -- A directory entry in the database
+------------------------------------------------------
+
+To be implemented
+
:exc:`NotmuchError` -- A Notmuch execution error
------------------------------------------------
.. autoexception:: NotmuchError
:class:`STATUS` -- Notmuch operation return status
--------------------------------------------------
.. autoclass:: STATUS
- :members:
+
+ To be documented
Indices and tables
==================