382ac911fd188c4b52e5f33cf98950a38887954b
[notmuch] / contrib / notmuch-mutt / README
1 notmuch-mutt: Notmuch (of a) helper for Mutt
2 ============================================
3
4 notmuch-mutt provide integration among the [Mutt] [1] mail user agent and the
5 [Notmuch] [2] mail indexer.
6
7 notmuch-mutt offer two main integration features. The first one is the ability
8 of stating a **search query interactively** and then jump to a fresh Maildir
9 containing its search results only. The second one is the ability to
10 **reconstruct threads on the fly** starting from the currently highlighted
11 mail, which comes handy when a thread has been split across different maildirs,
12 archived, or the like.
13
14 notmuch-mutt enables to trigger mail searches via a Mutt macro (usually F8) and
15 reconstruct threads via another (usually F9). Check the manpage for the 2-liner
16 configuration snippet for your Mutt configuration files (~/.muttrc,
17 /etc/Muttrc, or a /etc/Muttrc.d snippet).
18
19 A [blog style introduction] [3] to notmuch-mutt is available and includes some
20 more rationale for its existence.
21
22 Arguably, some of the logics of notmuch-mutt could disappear by adding support
23 for a --output=symlinks flag to notmuch.
24
25
26 [1]: http://www.mutt.org/
27 [2]: http://notmuchmail.org/
28 [3]: http://upsilon.cc/~zack/blog/posts/2011/01/how_to_use_Notmuch_with_Mutt/
29
30
31 Requirements
32 ------------
33
34 To *run* notmuch-mutt you will need Perl with the following libraries:
35
36 - Mail::Box <http://search.cpan.org/~markov/Mail-Box/>
37   (Debian package: libmail-box-perl)
38 - Mail::Internet <http://search.cpan.org/~markov/MailTools/>
39   (Debian package: libmailtools-perl)
40 - String::ShellQuote <http://search.cpan.org/~rosch/String-ShellQuote/ShellQuote.pm>
41   (Debian package: libstring-shellquote-perl)
42 - Term::ReadLine <http://search.cpan.org/~hayashi/Term-ReadLine-Gnu/>
43   (Debian package: libterm-readline-gnu-perl)
44
45 To *build* notmuch-mutt documentation you will need:
46
47 - pod2man (coming with Perl) to generate the manpage
48 - markdown to generate README.html out of this file
49
50
51 License
52 -------
53
54 notmuch-mutt is copyright (C) 2011-2012 Stefano Zacchiroli <zack@upsilon.cc>.
55
56 notmuch-mutt is released under the terms of the GNU General Public License
57 (GPL), version 3 or above. A copy of the license is available online at
58 <http://www.gnu.org/licenses/>.
59