X-Git-Url: https://git.notmuchmail.org/git?p=notmuch;a=blobdiff_plain;f=doc%2Fman5%2Fnotmuch-hooks.rst;h=c509afb39bb5944c72763769bb582ca89c183c9e;hp=f07e4dabf21ab5dc608eb989d3e4c94218391fbe;hb=4c79a2dabe38ac72eb9eb21620f2ffca5f1885c6;hpb=6499fce3911df2646db67c0f1ff65672324904f0 diff --git a/doc/man5/notmuch-hooks.rst b/doc/man5/notmuch-hooks.rst index f07e4dab..c509afb3 100644 --- a/doc/man5/notmuch-hooks.rst +++ b/doc/man5/notmuch-hooks.rst @@ -5,46 +5,45 @@ notmuch-hooks SYNOPSIS ======== -$DATABASEDIR/.notmuch/hooks/* +/{pre-new, post-new, post-insert} 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. +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. - - 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. +**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. SEE ALSO ========