NAME

mutt-notmuch - notmuch (of a) helper for Mutt

SYNOPSIS

mutt-notmuch [OPTION]... search [SEARCH-TERM]...
mutt-notmuch [OPTION]... thread < MAIL

DESCRIPTION

mutt-notmuch is a frontend to the notmuch mail indexer capable of populating maildir with search results.

OPTIONS

-o DIR
--output-dir DIR: Store search results as (symlink) messages under maildir DIR. Beware: DIR will be overwritten. (Default: ~/.cache/mutt_results/)
-p
--prompt: Instead of using command line search terms, prompt the user for them (only for "search").
-h
--help: Show usage information and exit.

INTEGRATION WITH MUTT

mutt-notmuch can be used to integrate notmuch with the Mutt mail user agent (unsurprisingly, given the name). To that end, you should define the following macros in your ~/.muttrc (replacing ~/bin/mutt-notmuch for the actual location of mutt-notmuch on your system):

    macro index <F8> \
          "<enter-command>unset wait_key<enter><shell-escape>~/bin/mutt-notmuch --prompt search<enter><change-folder-readonly>~/.cache/mutt_results<enter>" \
          "search mail (using notmuch)"
    macro index <F9> \
          "<enter-command>unset wait_key<enter><pipe-message>~/bin/mutt-notmuch thread<enter><change-folder-readonly>~/.cache/mutt_results<enter><enter-command>set wait_key<enter>" \
          "search and reconstruct owning thread (using notmuch)"

The first macro (activated by <F8>) will prompt the user for notmuch search terms and then jump to a temporary maildir showing search results. The second macro (activated by <F9>) will reconstruct the thread corresponding to the current mail and show it as search results.

To keep notmuch index current you should then periodically run notmuch new. Depending on your local mail setup, you might want to do that via cron, as a hook triggered by mail retrieval, etc.

AUTHOR