This is notmuch-hooks.info, produced by makeinfo version 4.8 from
notmuch-hooks.texi.

Generated by Sphinx 9.1.0.
INFO-DIR-SECTION Miscellaneous
START-INFO-DIR-ENTRY
* notmuch-hooks: (notmuch-hooks.info). hooks for notmuch
END-INFO-DIR-ENTRY

     notmuch 0.40, Apr 10, 2026

     Carl Worth and many others

     Copyright (C) 2009-2026, Carl Worth and many others


File: notmuch-hooks.info,  Node: Top,  Next: SYNOPSIS,  Up: (dir)

notmuch-hooks documentation
***************************

     notmuch 0.40, Apr 10, 2026

     Carl Worth and many others

     Copyright (C) 2009-2026, Carl Worth and many others

* Menu:

* SYNOPSIS::
* DESCRIPTION::
* SEE ALSO::


File: notmuch-hooks.info,  Node: SYNOPSIS,  Next: DESCRIPTION,  Prev: Top,  Up: Top

1 SYNOPSIS
**********

<hook_dir>/{pre-new, post-new, post-insert}


File: notmuch-hooks.info,  Node: DESCRIPTION,  Next: SEE ALSO,  Prev: SYNOPSIS,  Up: Top

2 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(1)'. They must
have executable permissions.

The currently available hooks are described below.

pre-new
     This hook is invoked by the `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(1)' 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(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.

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 delivered messages.


File: notmuch-hooks.info,  Node: SEE ALSO,  Prev: DESCRIPTION,  Up: Top

3 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)'



Tag Table:
Node: Top367
Ref: man5/notmuch-hooks doc617
Ref: 0617
Node: SYNOPSIS669
Ref: man5/notmuch-hooks notmuch-hooks756
Ref: 1756
Ref: man5/notmuch-hooks notmuch-hooks-5756
Ref: 2756
Ref: man5/notmuch-hooks synopsis756
Ref: 3756
Node: DESCRIPTION824
Ref: man5/notmuch-hooks description916
Ref: 4916
Node: SEE ALSO2427
Ref: man5/notmuch-hooks see-also2502
Ref: 52502

End Tag Table
