Notmuch logo

Notmuch -- The mail indexer

Why Notmuch?

Because dealing with your mail can be so much better.

If you've been looking for a fast, global-search and tag-based email reader to use within your text editor or in a terminal, then Notmuch may be exactly what you've been looking for.

If you're a developer of an existing email program and would love a good library interface for fast, global search with support for arbitrary tags, then Notmuch also may be exactly what you've been looking for.

News

The latest news from notmuch

Documentation

To get started with notmuch, just run "notmuch" at the command line. The configuration wizard will walk you through initial setup, including specifying the location of your mail store and how to start the initial indexing. After that, come back and checkout our docs:

Apart from the wiki, help is available via email and on IRC (see below). Join the mailing list. Read the archives. Ask questions.

Email clients and front ends

Notmuch ships with a powerful set of command-line tools, an email client for Emacs, another client for vim, and a Mutt integration script.

There are also many other email clients and frontends based on Notmuch. And a few tips about integrating it with Mutt and Vim.

Screenshots

Obtaining Notmuch

Notmuch source releases are available as source tar balls.

Notmuch is packaged for at least the following distributions:

Notmuch can be installed on Mac OS X using MacPorts.

Development and Contributing

All of the code for Notmuch is available as free software released under the GNU GPL version 3. The latest versions can be checked out via git with this command:

    git clone git://notmuchmail.org/git/notmuch

You can browse the Notmuch code history online. And finally, you can subscribe to the notmuch-commits list to watch every commit made to notmuch and the notmuchmail.org web site.

We have a buildbot (here's its configuration).

Contributions, such as patches, to Notmuch are most welcome. Please refer to the guide to contributing.

Bug and patch tracking

The tagging and filtering features of notmuch make it quite suitable for use as a bug- and patch-tracker. We are currently experimenting with using it for this purpose for notmuch development, using a utility called nmbug. The status of bugs and current patches can also be followed online.

Bug reports should be sent to the Notmuch mailing list notmuch@notmuchmail.org.

Contact: Email & IRC

Comments? Please feel free to email the notmuch mailing list: notmuch@notmuchmail.org (subscription is not required, but you can also subscribe to the notmuch mailing list). You can also browse the online list archives, read them as a web forum (nabble), or download an mbox file of the entire mailing-list.

The mb2md utility can be used to convert the archives to maildir format which is convenient for reading the archives within notmuch itself.

If you prefer real-time chat, there is often someone on the #notmuch@irc.freenode.net IRC channel.

Feature ideas

If you have a feature idea/request, please send it to the mailing list. You don't have to be subscribed to send, although there might be a delay for non-subscribers.

Website

This wiki is maintained using ikiwiki. Here are instructions on how to edit the wiki.