X-Git-Url: https://git.notmuchmail.org/git?a=blobdiff_plain;f=doc%2Fman5%2Fnotmuch-hooks.rst;h=de2ed0c2358809746a6fcf8e73c7569ee0f00e01;hb=bd0b5abd5d6c6fe0c1a028192680f3a505a18ef2;hp=f1c2528c5666b2dbd4e8ce1c5ae8f43b44f174de;hpb=19c09d870f18f549df3d9f5a3a30a20f7279b07a;p=notmuch diff --git a/doc/man5/notmuch-hooks.rst b/doc/man5/notmuch-hooks.rst index f1c2528c..de2ed0c2 100644 --- a/doc/man5/notmuch-hooks.rst +++ b/doc/man5/notmuch-hooks.rst @@ -5,7 +5,7 @@ notmuch-hooks SYNOPSIS ======== - $DATABASEDIR/.notmuch/hooks/* +$DATABASEDIR/.notmuch/hooks/* DESCRIPTION =========== @@ -17,39 +17,46 @@ 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 **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. + 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. +**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. + Typically this hook is used to perform additional query-based + tagging on the imported messages. - **post-insert** +**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. - 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 succesful delivery depends on the ``--keep`` option. - - Typically this hook is used to perform additional query-based - tagging on the delivered messages. + Typically this hook is used to perform additional query-based + tagging on the delivered messages. SEE ALSO ======== -**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)** +**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)**