NAME

       notmuch-hooks - hooks for notmuch

SYNOPSIS

       <hook_dir>/{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 a directory defined as described in  notmuch-config.  They  must
       have executable permissions.

       The currently available hooks are described below.

       pre-new
              This hook is invoked by the notmuch-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
              notmuch-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 notmuch-new command after any 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 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

       notmuch,  notmuch-config,  notmuch-count,  notmuch-dump,  notmuch-insert,   notmuch-new,   notmuch-reply,
       notmuch-restore, notmuch-search, notmuch-search-terms, notmuch-show, notmuch-tag

AUTHOR

       Carl Worth and many others

COPYRIGHT

       2009-2025, Carl Worth and many others

0.39                                              May 01, 2025                                  NOTMUCH-HOOKS(5)