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

     notmuch 0.39, Apr 17, 2025

     Carl Worth and many others

     Copyright © 2009-2025, Carl Worth and many others

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


   Generated by Sphinx 8.2.3.


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

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

     notmuch 0.39, Apr 17, 2025

     Carl Worth and many others

     Copyright © 2009-2025, 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: Top371
Ref: man5/notmuch-hooks doc620
Ref: 0620
Node: SYNOPSIS672
Ref: man5/notmuch-hooks notmuch-hooks759
Ref: 1759
Ref: man5/notmuch-hooks notmuch-hooks-5759
Ref: 2759
Ref: man5/notmuch-hooks synopsis759
Ref: 3759
Node: DESCRIPTION827
Ref: man5/notmuch-hooks description919
Ref: 4919
Node: SEE ALSO2462
Ref: man5/notmuch-hooks see-also2537
Ref: 52537

End Tag Table


Local Variables:
coding: utf-8
End:
