1. Manuals
  2. Tumbleweed
  3. notmuch
  4. notmuch-hooks(5)

Scroll to navigation

NOTMUCH-HOOKS(5) notmuch NOTMUCH-HOOKS(5)

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 <#notmuch-config-1>. They must have executable permissions.

The currently available hooks are described below.

This hook is invoked by the notmuch-new <#notmuch-new-1> 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 <#notmuch-new-1> command.

Typically this hook is used for fetching or delivering new mail to be imported into the database.

This hook is invoked by the notmuch-new <#notmuch-new-1> 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.

This hook is invoked by the notmuch-insert <#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.


SEE ALSO

notmuch <#notmuch-1>, notmuch-config <#notmuch-config-1>, notmuch-count <#notmuch-count-1>, notmuch-dump <#notmuch-dump-1>, notmuch-insert <#notmuch-insert-1>, notmuch-new <#notmuch-new-1>, notmuch-reply <#notmuch-reply-1>, notmuch-restore <#notmuch-restore-1>, notmuch-search <#notmuch-search-1>, notmuch-search-terms <#notmuch-search-terms-7>, notmuch-show <#notmuch-show-1>, notmuch-tag <#notmuch-tag-1>

Author

Carl Worth and many others

Copyright

2009-2024, Carl Worth and many others

October 23, 2025 0.38.3