aboutsummaryrefslogtreecommitdiffhomepage
path: root/bindings/python/docs/source/status_and_errors.rst
blob: 1d74ba17dde8cf4035afd57bd13e8f1b2b796d9d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
.. currentmodule:: notmuch

Status and Errors
=================

Some methods return a status, indicating if an operation was successful and what the error was. Most of these status codes are expressed as a specific value, the :class:`notmuch.STATUS`.

:class:`STATUS` -- Notmuch operation return value
--------------------------------------------------

.. autoclass:: notmuch.STATUS
   :inherited-members:

.. automethod:: notmuch.STATUS.status2str

:exc:`NotmuchError` -- A Notmuch execution error
------------------------------------------------
Whenever an error occurs, we throw a special Exception:

.. autoexception:: NotmuchError
   :members:

   This execption inherits directly from :exc:`Exception` and is raised on errors during the notmuch execution.