X-Git-Url: https://git.cworth.org/git?a=blobdiff_plain;ds=sidebyside;f=manpages%2Fnotmuch-hooks-5.mdwn;h=6a7ae271fee902eff9158e89f0c201407a5a007e;hb=219490b75a85ca18d449168575a0c7538e71612e;hp=b537c0cbfc37c948ceebb563215f4784a47a847f;hpb=33b367e699bbcc8fecd001fab8033a4e91b13450;p=notmuch-wiki diff --git a/manpages/notmuch-hooks-5.mdwn b/manpages/notmuch-hooks-5.mdwn index b537c0c..6a7ae27 100644 --- a/manpages/notmuch-hooks-5.mdwn +++ b/manpages/notmuch-hooks-5.mdwn @@ -1,62 +1,69 @@
notmuch-hooks - hooks for notmuch
- $DATABASEDIR/.notmuch/hooks/* + <hook_dir>/{pre-new, post-new, post-insert}
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 + in a directory defined as described in notmuch-config(1). They must have executable permissions. --
The currently available hooks are described below. --
- 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. -+ pre-new + This hook is invoked by the notmuch-new(1) command before scanâ + ning or importing new messages into the database. If this hook + exits with a non-zero status, notmuch will abort further proâ + cessing of the notmuch-new(1) command. -
- Typically this hook is used for fetching or delivering new mail - to be imported into the database. + 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 notmuch-new(1) 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 notmuch-insert(1) 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.+
- 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. + notmuch(1), notmuch-config(1), notmuch-count(1), notmuch-dump(1), notâ + much-insert(1), notmuch-new(1), notmuch-reply(1), notmuch-restore(1), + notmuch-search(1), notmuch-search-terms(7), notmuch-show(1), notâ + much-tag(1)+
- Typically this hook is used to perform additional query-based - tagging on the imported messages. + Carl Worth and many others-
- notmuch(1), notmuch-config(1), notmuch-count(1), notmuch-dump(1), not- - much-new(1), notmuch-reply(1), notmuch-restore(1), notmuch-search(1), - notmuch-search-terms(7), notmuch-show(1), notmuch-tag(1) + 2009-2022, Carl Worth and many others-