]> git.cworth.org Git - notmuch-wiki/blob - notmuch-mutt.mdwn
add notmuch-mutt.mdwn
[notmuch-wiki] / notmuch-mutt.mdwn
1 [[!img notmuch-logo.png alt="Notmuch logo" class="left"]]
2 # Using Notmuch with Mutt
3
4 Notmuch is a great mail indexing tool that can also be used *in conjunction*
5 with existing Mail User Agents (MUA) instead of replacing them. The advantage of
6 such mixed solutions is that users can benefit from notmuch features (such as
7 full-text search and thread reconstruction) without *having to* change MUA.
8
9 A popular geek MUA is [the Mutt e-mail client](http://www.mutt.org); integrating
10 notmuch with Mutt is not seamless, but fairly straightforward. There are two
11 principal possibilities, each with its own ups and downs:
12
13 * Using
14   [notmuch-mutt](http://git.notmuchmail.org/git/notmuch/tree/HEAD:/contrib/notmuch-mutt),
15   which will create a "virtual" maildir folder with search results whenever a
16   search is made. The upside is that you can search all your folders
17   simultanously; the downside is that your modifications in the results listing
18   do not carry over, also having to switch folders comes with some more
19   annoyances.
20
21   A
22   [how to use Notmuch with Mutt](http://upsilon.cc/~zack/blog/posts/2011/01/how_to_use_Notmuch_with_Mutt/)
23   has been written by Stefano Zacchiroli.
24
25   <small>(Note by the howto author: I've linked the howto from this wiki rather
26   than splicing it in, in order to avoid duplication of information. If you
27   think it would be better to have it here, feel free to copy the text
28   here. The howto is
29   [available](http://git.upsilon.cc/cgi-bin/gitweb.cgi?p=zack-homepage.git;a=history;f=blog/posts/2011/01/how_to_use_Notmuch_with_Mutt.mdwn)
30   in markdown syntax from the Git repository of my homepage.)</small>
31
32 * Using a simple macro that will emulate the "limit" mutt functionality
33   using notmuch.
34
35   See the [alternative notmuch integration](http://log.or.cz/?p=228)
36   blog post for instructions and details,
37   or simply put these two macros to your muttrc:
38
39         # 'L' performs a notmuch query, showing only the results
40         macro index L "<enter-command>unset wait_key<enter><shell-escape>read -p 'notmuch query: ' x; echo \$x >~/.cache/mutt_terms<enter><limit>~i \"\`notmuch search --output=messages \$(cat ~/.cache/mutt_terms) | head -n 600 | perl -le '@a=<>;chomp@a;s/\^id:// for@a;$,=\"|\";print@a'\`\"<enter>" "show only messages matching a notmuch pattern"
41         # 'a' shows all messages again (supersedes default <alias> binding)
42         macro index a "<limit>all\n" "show all messages (undo limit)"
43
44   The upside (if you are used to working in the context of a single folder) is
45   that this really does use the limit functionality of mutt and you are still in
46   your original folder.  The downside is that this approach has scaling problems
47   and works well only for reasonably specific queries.
48