Difference between revisions of "Notmuch"

From ArchWiki
Jump to: navigation, search
m (alot: fix aur/wiki links)
m (mutt-kz)
 
(15 intermediate revisions by 8 users not shown)
Line 1: Line 1:
[[Category:Email Client]]
+
[[Category:Email clients]]
{{Article summary start}}
+
[[ja:Notmuch]]
{{Article summary text|This article explains how to install and configure notmuch.}}
+
{{Related articles start}}
{{Article summary heading|Related}}
+
{{Related|mutt}}
{{Article summary wiki|mutt}}
+
{{Related articles end}}
{{Article summary end}}
+
  
[http://notmuchmail.org/ Notmuch] is a mail indexer. Essentially, is a very thin front end on top of [[xapian]].
+
[http://notmuchmail.org/ Notmuch] is a mail indexer. Essentially, is a very thin front end on top of ''xapian''.
 
Much like [[Sup]], it focuses on one thing: indexing your email messages. Notmuch can be used as an email reader, or simply as an indexer and search tool for other MUAs, like [[mutt]].
 
Much like [[Sup]], it focuses on one thing: indexing your email messages. Notmuch can be used as an email reader, or simply as an indexer and search tool for other MUAs, like [[mutt]].
  
Line 13: Line 12:
 
Notmuch can be terminated during the indexing process, on the next run it will continue where it left off.
 
Notmuch can be terminated during the indexing process, on the next run it will continue where it left off.
 
Also like sup-mail, it does not provide a way to permanently delete unwanted email messages.
 
Also like sup-mail, it does not provide a way to permanently delete unwanted email messages.
It doesn't fetch or send mails, nor does it store your email addresses, you'll need to use programs like [[offlineimap]], [[msmtp]] and [[abook]] for those tasks.
+
It doesn't fetch or send mails, nor does it store your email addresses, you'll need to use programs like [[OfflineIMAP]], [[msmtp]] and ''abook'' for those tasks.
  
Notmuch is available in the [[Official Repositories]]: {{Pkg|notmuch}} or {{AUR|notmuch-git}} from the [[AUR]]
+
Notmuch is available in the [[official repositories]]: {{Pkg|notmuch}} or {{AUR|notmuch-git}}{{Broken package link|{{aur-mirror|notmuch-git}}}} from the [[AUR]]
  
 
It provides [[python]], [[vim]], and [[emacs]] bindings.
 
It provides [[python]], [[vim]], and [[emacs]] bindings.
Line 38: Line 37:
  
 
===alot===
 
===alot===
alot is a standalone CLI interface for notmuch, written in python. It is available from [[AUR]] as {{AUR|alot}} or {{AUR|alot-git}}.
+
alot is a standalone CLI interface for notmuch, written in python. It is available from [[AUR]] as {{AUR|alot}} or {{AUR|alot-git}}{{Broken package link|{{aur-mirror|alot-git}}}}.
  
Alot uses [https://en.wikipedia.org/wiki/Mailcap mailcap] for handling different kinds of files. This currently includes html mails, which means that you need to configure a {{Ic|~/.mailcap}} file in order to view html mails. As minimum, put this line into your {{Ic|~/.mailcap}}:
+
Alot uses [[wikipedia:Mailcap|mailcap]] for handling different kinds of files. This currently includes html mails, which means that you need to configure a {{Ic|~/.mailcap}} file in order to view html mails. As minimum, put this line into your {{Ic|~/.mailcap}}:
  
   text/html; w3m -dump %s; nametemplate=%s.html; copiousoutput
+
   text/html; w3m -dump -o -document_charset=%{charset} %s; nametemplate=%s.html; copiousoutput
 +
 
 +
This uses {{Pkg|w3m}}, some other text based clients such as {{Pkg|links}} or {{Pkg|lynx}} can be used instead, although their arguments might differ.
  
 
More file handlers can be configured of course.
 
More file handlers can be configured of course.
  
 
===bower===
 
===bower===
bower[https://github.com/wangp/bower] is another CLI interface, this one is written in Mercury[http://www.mercury.csse.unimelb.edu.au/].
+
[https://github.com/wangp/bower bower] is another CLI interface, this one is written in [https://mercurylang.org/ Mercury].
 +
 
 +
===mutt-kz===
 +
[http://kzak.redcrew.org/doku.php?id=mutt:start mutt-kz] - A fork of mutt with integrated notmuch. It has a virtual folder support and talks directly to libnotmuch, avoiding hacks with symbolic links. It is available from [[AUR]] as {{AUR|mutt-kz}} or {{AUR|mutt-kz-git}}.
  
 
===ner===
 
===ner===
ner - notmuch email reader [http://the-ner.org/] is yet another CLI interface, apparently written in C++.
+
[http://the-ner.org/ ner] - notmuch email reader - is yet another CLI interface, apparently written in C++.
  
{{AUR|ner-git}} is avaiable from the [[AUR]].
+
{{AUR|ner-git}}{{Broken package link|{{aur-mirror|ner-git}}}} is available from the [[AUR]].
  
 
==Integrating with mutt==
 
==Integrating with mutt==

Latest revision as of 08:13, 11 March 2016

Related articles

Notmuch is a mail indexer. Essentially, is a very thin front end on top of xapian. Much like Sup, it focuses on one thing: indexing your email messages. Notmuch can be used as an email reader, or simply as an indexer and search tool for other MUAs, like mutt.

Overview

Notmuch is written in C and an order of magnitude faster than sup-mail. Notmuch can be terminated during the indexing process, on the next run it will continue where it left off. Also like sup-mail, it does not provide a way to permanently delete unwanted email messages. It doesn't fetch or send mails, nor does it store your email addresses, you'll need to use programs like OfflineIMAP, msmtp and abook for those tasks.

Notmuch is available in the official repositories: notmuch or notmuch-gitAUR[broken link: archived in aur-mirror] from the AUR

It provides python, vim, and emacs bindings.

First time Usage

After installation, you enter an interactive setup by running:

 notmuch setup

The program prompts you for the location of your maildir and your primary and secondary email addresses. You can also edit the config file directly which is created by default at $HOME/.notmuch-config.

Subsequent re-indexing of the mail directories is done with:

 notmuch new

Frontends

There are a range of ways to use notmuch, including cli, or with one of the Unix $EDITORS:

Emacs

The default frontend for notmuch is Emacs. It is developed by the same people that develop notmuch.

Vim

There's a vim interface available and included in notmuch. To start it, type:

vim -c NotMuch

alot

alot is a standalone CLI interface for notmuch, written in python. It is available from AUR as alotAUR or alot-gitAUR[broken link: archived in aur-mirror].

Alot uses mailcap for handling different kinds of files. This currently includes html mails, which means that you need to configure a ~/.mailcap file in order to view html mails. As minimum, put this line into your ~/.mailcap:

 text/html; w3m -dump -o -document_charset=%{charset} %s; nametemplate=%s.html; copiousoutput

This uses w3m, some other text based clients such as links or lynx can be used instead, although their arguments might differ.

More file handlers can be configured of course.

bower

bower is another CLI interface, this one is written in Mercury.

mutt-kz

mutt-kz - A fork of mutt with integrated notmuch. It has a virtual folder support and talks directly to libnotmuch, avoiding hacks with symbolic links. It is available from AUR as mutt-kzAUR or mutt-kz-gitAUR.

ner

ner - notmuch email reader - is yet another CLI interface, apparently written in C++.

ner-gitAUR[broken link: archived in aur-mirror] is available from the AUR.

Integrating with mutt

If you use mutt as your MUA, then notmuch is an excellent complementary tool to index and search your mail. The notmuch-mutt package provides a script to integrate notmuch with mutt.

Refer to the notmuch-mutt man page for configuration information. This blogpost steps through how to setup notmuch with mutt, but the information is a little outdated.