debian/notmuch
1
0
Fork 0
mirror of https://git.notmuchmail.org/git/notmuch synced 2024-11-22 19:08:09 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions
notmuch/doc/man5/notmuch-hooks.rst

63 lines
1.8 KiB
ReStructuredText
Raw Normal View History

doc: convert sphinx based docs This is the output from sphinx-quickstart, massaged a bit, along with our existing man pages converted to rst. A skeleton notmuch-emacs manual is also included. It is not suitable for end user use yet.
2014-01-28 17:12:37 +01:00
=============
notmuch-hooks
=============
SYNOPSIS
========
doc: whitespace cleanup Changed one tab in doc/man1/notmuch-show.rst to 8 spaces. Removed one leading tab in doc/man5/notmuch-hooks.rst to make the SYNOPSIS style consistent with other pages.
2014-11-06 18:46:59 +01:00
$DATABASEDIR/.notmuch/hooks/*
doc: convert sphinx based docs This is the output from sphinx-quickstart, massaged a bit, along with our existing man pages converted to rst. A skeleton notmuch-emacs manual is also included. It is not suitable for end user use yet.
2014-01-28 17:12:37 +01:00
DESCRIPTION
===========
Hooks are scripts (or arbitrary executables or symlinks to such) that
notmuch invokes before and after certain actions. These scripts reside
in the .notmuch/hooks directory within the database directory and must
have executable permissions.
The currently available hooks are described below.
doc: unify definition list usage across man pages Make all parameter descriptions etc. use reStructuredText definition lists with uniform style and indentation. Remove redundant indentation from around the lists. Remove blank lines between term lines and definition blocks. Use four spaces for indentation. This is almost completely whitespace and paragraph reflow changes.
2017-12-30 18:16:11 +01:00
**pre-new**
This hook is invoked by the **new** command before scanning or
importing new messages into the database. If this hook exits with
a non-zero status, notmuch will abort further processing of the
**new** command.
Typically this hook is used for fetching or delivering new mail to
be imported into the database.
**post-new**
This hook is invoked by the **new** command after new messages
have been imported into the database and initial tags have been
applied. The hook will not be run if there have been any errors
during the scan or import.
Typically this hook is used to perform additional query-based
tagging on the imported messages.
**post-insert**
This hook is invoked by the **insert** command after the message
has been delivered, added to the database, and initial tags have
been applied. The hook will not be run if there have been any
errors during the message delivery; what is regarded as successful
delivery depends on the ``--keep`` option.
Typically this hook is used to perform additional query-based
tagging on the delivered messages.
cli/insert: add post-insert hook The post-new hook might no longer be needed or run very often if notmuch insert is being used. Therefore a post-insert hook is needed (arguably pre-insert not so much, so don't add one). Also add the --no-hooks option to skip hooks.
2014-09-28 16:40:59 +02:00
doc: convert sphinx based docs This is the output from sphinx-quickstart, massaged a bit, along with our existing man pages converted to rst. A skeleton notmuch-emacs manual is also included. It is not suitable for end user use yet.
2014-01-28 17:12:37 +01:00
SEE ALSO
========
doc: make SEE ALSO references one-per-line This will make future diffs cleaner, make it easier to keep them alphabetical, and make it easier to scan and search the documentation sources.
2017-10-17 18:57:21 +02:00
**notmuch(1)**,
**notmuch-config(1)**,
**notmuch-count(1)**,
**notmuch-dump(1)**,
**notmuch-insert(1)**,
**notmuch-new(1)**,
**notmuch-reply(1)**,
**notmuch-restore(1)**,
**notmuch-search(1)**,
**notmuch-search-terms(7)**,
**notmuch-show(1)**,
**notmuch-tag(1)**
Reference in a new issue Copy permalink