1NOTMUCH-MUTT(1)       User Contributed Perl Documentation      NOTMUCH-MUTT(1)
2
3
4

NAME

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

SYNOPSIS

9       notmuch-mutt [OPTION]... search [SEARCH-TERM]...
10       notmuch-mutt [OPTION]... thread < MAIL
11       notmuch-mutt [OPTION]... tag [TAGS]... < MAIL
12

DESCRIPTION

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

OPTIONS

18       -o DIR
19       --output-dir DIR
20           Store search results as (symlink) messages under maildir DIR.
21           Beware: DIR will be overwritten. (Default:
22           ~/.cache/notmuch/mutt/results/)
23
24       -p
25       --prompt
26           Instead of using command line search terms, prompt the user for
27           them (only for "search").
28
29       -r
30       --remove-dups
31           Remove emails with duplicate message-ids from search results.
32           (Passes --duplicate=1 to notmuch search command.)  Note this can
33           hide search results if an email accidentally or maliciously uses
34           the same message-id as a different email.
35
36       -h
37       --help
38           Show usage information and exit.
39

INTEGRATION WITH MUTT

41       notmuch-mutt can be used to integrate notmuch with the Mutt mail user
42       agent (unsurprisingly, given the name). To that end, you should define
43       macros like the following in your Mutt configuration (usually one of:
44       ~/.muttrc, /etc/Muttrc, or a configuration snippet under
45       /etc/Muttrc.d/):
46
47           macro index <F8> \
48           "<enter-command>set my_old_pipe_decode=\$pipe_decode my_old_wait_key=\$wait_key nopipe_decode nowait_key<enter>\
49           <shell-escape>notmuch-mutt -r --prompt search<enter>\
50           <change-folder-readonly>`echo ${XDG_CACHE_HOME:-$HOME/.cache}/notmuch/mutt/results`<enter>\
51           <enter-command>set pipe_decode=\$my_old_pipe_decode wait_key=\$my_old_wait_key<enter>" \
52                 "notmuch: search mail"
53
54           macro index <F9> \
55           "<enter-command>set my_old_pipe_decode=\$pipe_decode my_old_wait_key=\$wait_key nopipe_decode nowait_key<enter>\
56           <pipe-message>notmuch-mutt -r thread<enter>\
57           <change-folder-readonly>`echo ${XDG_CACHE_HOME:-$HOME/.cache}/notmuch/mutt/results`<enter>\
58           <enter-command>set pipe_decode=\$my_old_pipe_decode wait_key=\$my_old_wait_key<enter>" \
59                 "notmuch: reconstruct thread"
60
61           macro index <F6> \
62           "<enter-command>set my_old_pipe_decode=\$pipe_decode my_old_wait_key=\$wait_key nopipe_decode nowait_key<enter>\
63           <pipe-message>notmuch-mutt tag -- -inbox<enter>\
64           <enter-command>set pipe_decode=\$my_old_pipe_decode wait_key=\$my_old_wait_key<enter>" \
65                 "notmuch: remove message from inbox"
66
67       The first macro (activated by <F8>) prompts the user for notmuch search
68       terms and then jump to a temporary maildir showing search results. The
69       second macro (activated by <F9>) reconstructs the thread corresponding
70       to the current mail and show it as search results. The third macro
71       (activated by <F6>) removes the tag "inbox" from the current message;
72       by changing "-inbox" this macro may be customised to add or remove tags
73       appropriate to the users notmuch work-flow.
74
75       To keep notmuch index current you should then periodically run "notmuch
76       new". Depending on your local mail setup, you might want to do that via
77       cron, as a hook triggered by mail retrieval, etc.
78

SEE ALSO

80       mutt(1), notmuch(1)
81

AUTHOR

83       Copyright: (C) 2011-2012 Stefano Zacchiroli <zack@upsilon.cc>
84
85       License: GNU General Public License (GPL), version 3 or higher
86
87
88
89perl v5.34.1                      2022-06-25                   NOTMUCH-MUTT(1)
Impressum