NOTMUCH-HOOKS(5)

📦
version 0.40 · 13 versions
, in fedora 44, nixos 26.05, ubuntu resolute

✨ NAME ✨

notmuch-hooks — it's giving... hooks for notmuch, bestie 💅

🎀 SYNOPSIS 🎀

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

💖 DESCRIPTION 💖

okay so hooks are scripts (or arbitrary executables, or symlinks to such — yes, symlinks count, she's flexible) that notmuch invokes before and after certain actions. these little icons live in a directory defined as described in notmuch-config 🦋, and they must have executable permissions — if they're not executable, they're literally just sitting there, main character with no lines 😭.

The currently available hooks are described below. slay.

🌸 pre-new 🌸

This hook is invoked by the notmuch-new command before scanning or importing new messages into the database. And listen — if this hook exits with a non-zero status, notmuch will abort further processing of the notmuch-new command. like, full stop, no cap. 🛑

Typically this hook is used for fetching or delivering new mail to be imported into the database. it's the little mail-delivery bestie who shows up before the party starts 🫶

🦋 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 — no errors allowed, periodt. 💀

Typically this hook is used to perform additional query-based tagging on the imported messages. lowkey the glow-up phase ✨

👑 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; and heads up bestie, what is regarded as successful delivery depends on the --keep option 👀 — so don't come for her, read the option first.

Typically this hook is used to perform additional query-based tagging on the delivered messages. it's giving finishing-touches energy 💅

🌈 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

go read them all, iykyk 💜

⭐ AUTHOR ⭐

Carl Worth and many others

2009-2026, Carl Worth and many others

and that's the vibe check, bestie — go forth and hook responsibly 🧚

sending you off with version 0.40, dated Jan 31, 2026 — mwah 💖

📦 where this page comes from