X-Git-Url: https://git.notmuchmail.org/git?p=notmuch;a=blobdiff_plain;f=bindings%2Fpython%2Fdocs%2Fsource%2Findex.rst;h=e9f39eb03428269bf037b1255095dc885d29d162;hp=c90492c8b674ce99a7683c42c8d1fc4f66881548;hb=0817f0e168c8212200fc6624aeaac77318a9bc35;hpb=8cbb5114a20c1217f23977fd5edca99a0b7a2955 diff --git a/bindings/python/docs/source/index.rst b/bindings/python/docs/source/index.rst index c90492c8..e9f39eb0 100644 --- a/bindings/python/docs/source/index.rst +++ b/bindings/python/docs/source/index.rst @@ -28,6 +28,7 @@ More information on specific topics can be found on the following pages: .. toctree:: :maxdepth: 1 + status_and_errors notmuch :mod:`notmuch` -- The Notmuch interface @@ -99,7 +100,11 @@ More information on specific topics can be found on the following pages: 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 @@ -123,7 +128,12 @@ More information on specific topics can be found on the following pages: .. automethod:: collect_tags - .. automethod:: __len__ + .. 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))`. :class:`Message` -- A single message ---------------------------------------- @@ -138,6 +148,8 @@ More information on specific topics can be found on the following pages: .. automethod:: get_filename + .. automethod:: get_filenames + .. attribute:: FLAG FLAG.MATCH @@ -146,7 +158,7 @@ More information on specific topics can be found on the following pages: 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 @@ -156,6 +168,10 @@ More information on specific topics can be found on the following pages: .. automethod:: get_tags + .. automethod:: maildir_flags_to_tags + + .. automethod:: tags_to_maildir_flags + .. automethod:: remove_tag .. automethod:: add_tag @@ -166,7 +182,9 @@ More information on specific topics can be found on the following pages: .. automethod:: thaw - .. automethod:: format_as_text + .. automethod:: format_message_as_json + + .. automethod:: format_message_as_text .. automethod:: __str__ @@ -241,32 +259,8 @@ More information on specific topics can be found on the following pages: .. 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 `_ contains information on possible Status and Error values. Indices and tables ==================