X-Git-Url: https://git.cworth.org/git?a=blobdiff_plain;f=manpages%2Fnotmuch-hooks-5.mdwn;h=6a7ae271fee902eff9158e89f0c201407a5a007e;hb=3841ab8a64c6e26f50fb90c25cf47095024e74d4;hp=d42bfcd94a77de5e494e91c54d4ae4f8b38275bf;hpb=0add150ffd941ea7ed64a9116929aaf2daa927a5;p=notmuch-wiki diff --git a/manpages/notmuch-hooks-5.mdwn b/manpages/notmuch-hooks-5.mdwn index d42bfcd..6a7ae27 100644 --- a/manpages/notmuch-hooks-5.mdwn +++ b/manpages/notmuch-hooks-5.mdwn @@ -7,44 +7,52 @@
- $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 + 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. - 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 process- - ing of the new 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. - post-new + Typically this hook is used to perform additional query-based + tagging on the imported messages. - 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. + 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 imported messages. + Typically this hook is used to perform additional query-based + tagging on the delivered messages.
- 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- + 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)@@ -55,7 +63,7 @@
- 2014, Carl Worth and many others + 2009-2022, Carl Worth and many others-