git.notmuchmail.org Git - notmuch/blob - 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 - Digest::SHA <https://metacpan.org/release/Digest-SHA>
  37   (Debian package: libdigest-sha-perl)
  38 - Mail::Box <https://metacpan.org/pod/Mail::Box>
  39   (Debian package: libmail-box-perl)
  40 - Mail::Header <https://metacpan.org/pod/Mail::Header>
  41   (Debian package: libmailtools-perl)
  42 - String::ShellQuote <https://metacpan.org/pod/String::ShellQuote>
  43   (Debian package: libstring-shellquote-perl)
  44 - Term::ReadLine::Gnu <https://metacpan.org/pod/Term::ReadLine::Gnu>
  45   (Debian package: libterm-readline-gnu-perl)
  46
  47 To *build* notmuch-mutt documentation you will need:
  48
  49 - pod2man (coming with Perl) to generate the manpage
  50 - markdown to generate README.html out of this file
  51
  52
  53 License
  54 -------
  55
  56 notmuch-mutt is copyright (C) 2011-2012 Stefano Zacchiroli <zack@upsilon.cc>.
  57
  58 notmuch-mutt is released under the terms of the GNU General Public License
  59 (GPL), version 3 or above. A copy of the license is available online at
  60 <http://www.gnu.org/licenses/>.
  61