diff options
Diffstat (limited to 'docs/dev/source/database.rst')
| -rw-r--r-- | docs/dev/source/database.rst | 55 |
1 files changed, 55 insertions, 0 deletions
diff --git a/docs/dev/source/database.rst b/docs/dev/source/database.rst new file mode 100644 index 00000000..00334a4b --- /dev/null +++ b/docs/dev/source/database.rst @@ -0,0 +1,55 @@ +Email Database +============== + +.. module:: alot.db + +The python bindings to libnotmuch define :class:`notmuch.Thread` and +:class:`notmuch.Message`, which unfortunately are very fragile. +Alot defines the wrapper classes :class:`Thread` and :class:`~alot.message.Message` that +use an :class:`DBManager` instance to transparently provide persistent objects. + +:class:`~alot.message.Message` moreover contains convenience methods +to extract information about the message like reformated header values, a summary, +decoded and interpreted body text and a list of :class:`Attachments <alot.message.Attachment>`. + +The central :class:`~alot.ui.UI` instance carries around a :class:`DBManager` object that +is used for any lookups or modifications of the email base. :class:`DBManager` can +directly look up :class:`Thread` and :class:`~alot.message.Message` objects and is able to +postpone/cache/retry writing operations in case the Xapian index is locked by another +process. + + +Database Manager +----------------- +.. autoclass:: DBManager + :members: + + +Exceptions +---------- +.. autoclass:: DatabaseError + :members: +.. autoclass:: DatabaseROError + :members: +.. autoclass:: DatabaseLockedError + :members: + +Wrapper +------- +.. autoclass:: Thread + :members: + +.. module:: alot.message + +.. autoclass:: Message + :members: + + +Other Structures +--------------------------- + +.. autoclass:: Attachment + :members: + +.. autoclass:: Envelope + :members: |