X-Git-Url: https://git.notmuchmail.org/git?p=notmuch;a=blobdiff_plain;f=docs%2Fsource%2Findex.rst;h=6d0d5fa3f99165dbb1efb7ecc32b69215e38694d;hp=5b262bba60af1d2d9f756dcf1b9dc2f8eab4148e;hb=144953116e8e95e6cdc3b0fe69ddd16e7a3f1d01;hpb=350509028b1213402854e18b213a5a47b1dddc1c diff --git a/docs/source/index.rst b/docs/source/index.rst index 5b262bba..6d0d5fa3 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -45,6 +45,18 @@ or:: .. 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 @@ -84,8 +96,12 @@ or:: .. automethod:: set_sort + .. automethod:: search_threads + .. automethod:: search_messages + .. automethod:: count_messages + :class:`Messages` -- A bunch of messages ---------------------------------------- @@ -102,18 +118,32 @@ or:: .. 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__ @@ -128,6 +158,26 @@ or:: .. 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 @@ -138,7 +188,8 @@ or:: :class:`STATUS` -- Notmuch operation return status -------------------------------------------------- .. autoclass:: STATUS - :members: + + To be documented Indices and tables ==================