mirror of
https://git.notmuchmail.org/git/notmuch
synced 2024-11-26 20:57:58 +01:00
2dd0cf8f5b
Rather than hardcoding the version in various places, we export it from the module itself. Also improve the README somewhat.
200 lines
4.3 KiB
ReStructuredText
200 lines
4.3 KiB
ReStructuredText
.. cnotmuch documentation master file, created by
|
|
sphinx-quickstart on Tue Feb 2 10:00:47 2010.
|
|
|
|
.. currentmodule:: cnotmuch
|
|
|
|
Welcome to :mod:`cnotmuch`'s documentation
|
|
===========================================
|
|
|
|
The :mod:`cnotmuch` module provides an interface to the `notmuch <http://notmuchmail.org>`_ functionality, directly interfacing to a shared notmuch library.
|
|
The classes :class:`notmuch.Database`, :class:`notmuch.Query` provide most of the core functionality, returning :class:`notmuch.Messages` and :class:`notmuch.Tags`.
|
|
|
|
.. moduleauthor:: Sebastian Spaeth <Sebastian@SSpaeth.de>
|
|
|
|
:License: This module is covered under the GNU GPL v3 (or later).
|
|
|
|
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::
|
|
|
|
from cnotmuch import notmuch
|
|
|
|
or::
|
|
|
|
from cnotmuch.notmuch import Query,Database
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
|
|
:mod:`notmuch` -- The Notmuch interface
|
|
=============================================
|
|
|
|
.. automodule:: cnotmuch.notmuch
|
|
|
|
:todo: Document nmlib,STATUS
|
|
|
|
:class:`Database` -- The underlying notmuch database
|
|
-----------------------------------------------------
|
|
|
|
.. autoclass:: Database([path=None[, create=False[, mode=MODE.READ_ONLY]]])
|
|
|
|
.. automethod:: create
|
|
|
|
.. automethod:: open(path, status=MODE.READ_ONLY)
|
|
|
|
.. 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
|
|
|
|
Defines constants that are used as the mode in which to open a database.
|
|
|
|
MODE.READ_ONLY
|
|
Open the database in read-only mode
|
|
|
|
MODE.READ_WRITE
|
|
Open the database in read-write mode
|
|
|
|
.. autoattribute:: db_p
|
|
|
|
:class:`Query` -- A search query
|
|
-----------------------------------------------
|
|
|
|
.. autoclass:: Query
|
|
|
|
.. automethod:: create
|
|
|
|
.. attribute:: Query.SORT
|
|
|
|
Defines constants that are used as the mode in which to open a database.
|
|
|
|
SORT.OLDEST_FIRST
|
|
Sort by message date, oldest first.
|
|
|
|
SORT.NEWEST_FIRST
|
|
Sort by message date, newest first.
|
|
|
|
SORT.MESSAGE_ID
|
|
Sort by email message ID
|
|
|
|
.. automethod:: set_sort
|
|
|
|
.. automethod:: search_threads
|
|
|
|
.. automethod:: search_messages
|
|
|
|
.. automethod:: count_messages
|
|
|
|
:class:`Messages` -- A bunch of messages
|
|
----------------------------------------
|
|
|
|
.. autoclass:: Messages
|
|
|
|
.. automethod:: collect_tags
|
|
|
|
.. automethod:: __len__
|
|
|
|
:class:`Message` -- A single message
|
|
----------------------------------------
|
|
|
|
.. autoclass:: Message
|
|
|
|
.. automethod:: get_message_id
|
|
|
|
.. automethod:: get_thread_id
|
|
|
|
.. 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__
|
|
|
|
:class:`Tags` -- Notmuch tags
|
|
-----------------------------
|
|
|
|
.. autoclass:: Tags
|
|
:members:
|
|
|
|
.. automethod:: __len__
|
|
|
|
.. 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
|
|
:members:
|
|
|
|
This execption inherits directly from :exc:`Exception` and is raised on errors during the notmuch execution.
|
|
|
|
:class:`STATUS` -- Notmuch operation return status
|
|
--------------------------------------------------
|
|
.. autoclass:: STATUS
|
|
|
|
To be documented
|
|
|
|
Indices and tables
|
|
==================
|
|
|
|
* :ref:`genindex`
|
|
* :ref:`search`
|
|
|