aboutsummaryrefslogtreecommitdiff
path: root/contrib
diff options
context:
space:
mode:
Diffstat (limited to 'contrib')
-rwxr-xr-xcontrib/nmbug/nmbug (renamed from contrib/nmbug)37
-rwxr-xr-xcontrib/nmbug/nmbug-status149
-rw-r--r--contrib/nmbug/status-config.json65
-rw-r--r--contrib/notmuch-deliver/src/main.c12
-rw-r--r--contrib/notmuch-mutt/.gitignore2
-rw-r--r--contrib/notmuch-mutt/Makefile12
-rw-r--r--contrib/notmuch-mutt/README59
-rwxr-xr-xcontrib/notmuch-mutt/notmuch-mutt297
-rw-r--r--contrib/notmuch-mutt/notmuch-mutt.rc9
9 files changed, 635 insertions, 7 deletions
diff --git a/contrib/nmbug b/contrib/nmbug/nmbug
index bb0739f..f003ef9 100755
--- a/contrib/nmbug
+++ b/contrib/nmbug/nmbug
@@ -60,6 +60,9 @@ sub git_pipe {
sub git {
my $fh = git_pipe (@_);
my $str = join ('', <$fh>);
+ unless (close $fh) {
+ die "'git @_' exited with nonzero value\n";
+ }
chomp($str);
return $str;
}
@@ -84,7 +87,7 @@ sub spawn {
foreach my $line (@{$ioref}) {
print $fh $line, "\n";
}
- exit 0;
+ exit ! close $fh;
} else {
if ($dir ne '|-') {
open STDIN, '<', '/dev/null' or die "reopening stdin: $!"
@@ -106,6 +109,9 @@ sub get_tags {
chomp ();
push @tags, $_ if (m/^$prefix/);
}
+ unless (close $fh) {
+ die "'notmuch search --output=tags *' exited with nonzero value\n";
+ }
return @tags;
}
@@ -173,6 +179,10 @@ sub update_index {
foreach my $pair (@{$status->{added}}) {
index_tags_for_msg ($git, $pair->{id}, 'A', $pair->{tag});
}
+ unless (close $git) {
+ die "'git update-index --index-info' exited with nonzero value\n";
+ }
+
}
@@ -211,8 +221,12 @@ sub index_tags {
my @tags = grep { s/^$TAGPREFIX//; } split (' ', $rest);
index_tags_for_msg ($git,$id, 'A', @tags);
}
-
- close $git;
+ unless (close $git) {
+ die "'git update-index --index-info' exited with nonzero value\n";
+ }
+ unless (close $fh) {
+ die "'notmuch dump -- $query' exited with nonzero value\n";
+ }
return $index;
}
@@ -395,6 +409,9 @@ sub compute_status {
} else {
push @deleted, $pair;
}
+ unless (close $fh) {
+ die "'notmuch search --output=files id:$id' exited with nonzero value\n";
+ }
}
@@ -414,7 +431,12 @@ sub diff_index {
qw/diff-index --cached/,
"--diff-filter=$filter", qw/--name-only HEAD/ );
- return unpack_diff_lines ($fh);
+ my @lines = unpack_diff_lines ($fh);
+ unless (close $fh) {
+ die "'git diff-index --cached --diff-filter=$filter --name-only HEAD' ",
+ "exited with nonzero value\n";
+ }
+ return @lines;
}
@@ -426,7 +448,12 @@ sub diff_refs {
my $fh= git_pipe ( 'diff', "--diff-filter=$filter", '--name-only',
$ref1, $ref2);
- return unpack_diff_lines ($fh);
+ my @lines = unpack_diff_lines ($fh);
+ unless (close $fh) {
+ die "'git diff --diff-filter=$filter --name-only $ref1 $ref2' ",
+ "exited with nonzero value\n";
+ }
+ return @lines;
}
diff --git a/contrib/nmbug/nmbug-status b/contrib/nmbug/nmbug-status
new file mode 100755
index 0000000..f37ee84
--- /dev/null
+++ b/contrib/nmbug/nmbug-status
@@ -0,0 +1,149 @@
+#!/usr/bin/python
+#
+# Copyright (c) 2011-2012 David Bremner <david@tethera.net>
+# License: Same as notmuch
+# dependencies
+# - python 2.6 for json
+# - argparse; either python 2.7, or install separately
+
+import datetime
+import notmuch
+import rfc822
+import urllib
+import json
+import argparse
+import os
+import subprocess
+
+# parse command line arguments
+
+parser = argparse.ArgumentParser()
+parser.add_argument('--text', help='output plain text format',
+ action='store_true')
+
+parser.add_argument('--config', help='load config from given file')
+
+
+args = parser.parse_args()
+
+# read config from json file
+
+if args.config != None:
+ fp = open(args.config)
+else:
+ nmbhome = os.getenv('NMBGIT', os.path.expanduser('~/.nmbug'))
+
+ # read only the first line from the pipe
+ sha1 = subprocess.Popen(['git', '--git-dir', nmbhome,
+ 'show-ref', '-s', 'config'],
+ stdout=subprocess.PIPE).stdout.readline()
+
+ sha1 = sha1.rstrip()
+
+ fp = subprocess.Popen(['git', '--git-dir', nmbhome,
+ 'cat-file', 'blob', sha1+':status-config.json'],
+ stdout=subprocess.PIPE).stdout
+
+config = json.load(fp)
+
+if args.text:
+ output_format = 'text'
+else:
+ output_format = 'html'
+
+headers = ['date', 'from', 'subject']
+last = {}
+
+def clear_last():
+ for header in headers:
+ last[header] = ''
+
+def print_view(title, query, comment):
+
+ query_string = ' and '.join(query)
+ q_new = notmuch.Query(db, query_string)
+ q_new.set_sort(notmuch.Query.SORT.OLDEST_FIRST)
+
+ last['thread_id'] = ''
+
+ if output_format == 'html':
+ print '<h3>%s</h3>' % title
+ print comment
+ print 'The view is generated from the following query:'
+ print '<blockquote>'
+ print query_string
+ print '</blockquote>'
+ print '<table>\n'
+
+ for m in q_new.search_messages():
+
+ out = {}
+
+ thread_id = m.get_thread_id()
+ if thread_id != last['thread_id']:
+ clear_last()
+
+ for header in headers:
+ val = m.get_header(header)
+
+ if header == 'date':
+ val = str.join(' ', val.split(None)[1:4])
+ val = str(datetime.datetime.strptime(val, '%d %b %Y').date())
+ elif header == 'from':
+ val = rfc822.parseaddr(val)[0]
+
+ if last[header] == val:
+ out[header] = ''
+ else:
+ out[header] = val.encode('utf-8')
+ last[header] = val
+
+ mid = m.get_message_id()
+ out['id'] = 'id:"%s"' % mid
+
+ if output_format == 'html':
+ # XXX using <br /> is a hack, but ... // 20111216 too
+ if thread_id != last['thread_id']:
+ br = '<br />'
+ else:
+ br = ''
+
+ out['subject'] = '<a href="http://mid.gmane.org/%s">%s</a>' \
+ % (urllib.quote(mid), out['subject'])
+
+ print ' <tr><td>%s %s' % (br, out['date'])
+ print '</td><td>%s %s' % (br, out['id'])
+ print '</td></tr>'
+ print ' <tr><td>%s' % out['from']
+ print '</td><td>%s' % out['subject']
+ print '</td></tr>\n'
+ else:
+ print '%(date)-10.10s %(from)-20.20s %(subject)-40.40s\n%(id)72s\n' % out
+
+ last['thread_id'] = thread_id
+
+ if output_format == 'html':
+ print '</table>'
+
+# main program
+
+db = notmuch.Database(mode=notmuch.Database.MODE.READ_WRITE)
+
+if output_format == 'html':
+ print '''<?xml version="1.0" encoding="utf-8" ?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<title>Notmuch Patches</title>
+</head>
+<body>'''
+ print '<h2>Notmuch Patches</h2>'
+ print 'Generated: %s<br />' % datetime.datetime.utcnow().date()
+ print 'For more infomation see <a href="http://notmuchmail.org/nmbug">nmbug</a>'
+
+for view in config['views']:
+ print_view(**view)
+
+if output_format == 'html':
+ print '</body>\n</html>'
diff --git a/contrib/nmbug/status-config.json b/contrib/nmbug/status-config.json
new file mode 100644
index 0000000..6b4934f
--- /dev/null
+++ b/contrib/nmbug/status-config.json
@@ -0,0 +1,65 @@
+{
+ "views": [
+ {
+ "comment": "Unresolved bugs (or just need tag updating).",
+ "query": [
+ "tag:notmuch::bug",
+ "not tag:notmuch::fixed",
+ "not tag:notmuch::wontfix"
+ ],
+ "title": "Bugs"
+ },
+ {
+ "comment": "These patches are under consideration for pushing.",
+ "query": [
+ "tag:notmuch::patch and not tag:notmuch::pushed",
+ "not tag:notmuch::obsolete and not tag:notmuch::wip",
+ "not tag:notmuch::stale and not tag:notmuch::contrib",
+ "not tag:notmuch::moreinfo",
+ "not tag:notmuch::python",
+ "not tag:notmuch::vim",
+ "not tag:notmuch::wontfix",
+ "not tag:notmuch::needs-review"
+ ],
+ "title": "Maybe Ready (Core and Emacs)"
+ },
+ {
+ "comment": "These python related patches might be ready to push, or they might just need updated tags.",
+ "query": [
+ "tag:notmuch::patch and not tag:notmuch::pushed",
+ "not tag:notmuch::obsolete and not tag:notmuch::wip",
+ "not tag:notmuch::stale and not tag:notmuch::contrib",
+ "not tag:notmuch::moreinfo",
+ "not tag:notmuch::wontfix",
+ " tag:notmuch::python",
+ "not tag:notmuch::needs-review"
+ ],
+ "title": "Maybe Ready (Python)"
+ },
+ {
+ "comment": "These vim related patches might be ready to push, or they might just need updated tags.",
+ "query": [
+ "tag:notmuch::patch and not tag:notmuch::pushed",
+ "not tag:notmuch::obsolete and not tag:notmuch::wip",
+ "not tag:notmuch::stale and not tag:notmuch::contrib",
+ "not tag:notmuch::moreinfo",
+ "not tag:notmuch::wontfix",
+ "tag:notmuch::vim",
+ "not tag:notmuch::needs-review"
+ ],
+ "title": "Maybe Ready (vim)"
+ },
+ {
+ "comment": "These patches are under review, or waiting for feedback.",
+ "query": [
+ "tag:notmuch::patch",
+ "not tag:notmuch::pushed",
+ "not tag:notmuch::obsolete",
+ "not tag:notmuch::stale",
+ "not tag:notmuch::wontfix",
+ "(tag:notmuch::moreinfo or tag:notmuch::needs-review)"
+ ],
+ "title": "Review"
+ }
+ ]
+}
diff --git a/contrib/notmuch-deliver/src/main.c b/contrib/notmuch-deliver/src/main.c
index 6f32f73..032b9d6 100644
--- a/contrib/notmuch-deliver/src/main.c
+++ b/contrib/notmuch-deliver/src/main.c
@@ -359,6 +359,7 @@ main(int argc, char **argv)
GOptionContext *ctx;
GError *error = NULL;
notmuch_database_t *db;
+ notmuch_status_t status;
ctx = g_option_context_new("[FOLDER]");
g_option_context_add_main_entries(ctx, options, PACKAGE);
@@ -429,7 +430,14 @@ main(int argc, char **argv)
maildir = g_strdup(db_path);
g_debug("Opening notmuch database `%s'", db_path);
- db = notmuch_database_open(db_path, NOTMUCH_DATABASE_MODE_READ_WRITE);
+ status = notmuch_database_open(db_path, NOTMUCH_DATABASE_MODE_READ_WRITE,
+ &db);
+ if (status) {
+ g_critical("Failed to open database `%s': %s",
+ db_path, notmuch_status_to_string(status));
+ g_free(maildir);
+ return EX_SOFTWARE;
+ }
g_free(db_path);
if (db == NULL)
return EX_SOFTWARE;
@@ -455,7 +463,7 @@ main(int argc, char **argv)
g_strfreev(opt_rtags);
g_free(mail);
- notmuch_database_close(db);
+ notmuch_database_destroy(db);
return 0;
}
diff --git a/contrib/notmuch-mutt/.gitignore b/contrib/notmuch-mutt/.gitignore
new file mode 100644
index 0000000..682a577
--- /dev/null
+++ b/contrib/notmuch-mutt/.gitignore
@@ -0,0 +1,2 @@
+notmuch-mutt.1
+README.html
diff --git a/contrib/notmuch-mutt/Makefile b/contrib/notmuch-mutt/Makefile
new file mode 100644
index 0000000..87f9031
--- /dev/null
+++ b/contrib/notmuch-mutt/Makefile
@@ -0,0 +1,12 @@
+NAME = notmuch-mutt
+
+all: $(NAME) $(NAME).1
+
+$(NAME).1: $(NAME)
+ pod2man $< > $@
+
+README.html: README
+ markdown $< > $@
+
+clean:
+ rm -f notmuch-mutt.1 README.html
diff --git a/contrib/notmuch-mutt/README b/contrib/notmuch-mutt/README
new file mode 100644
index 0000000..382ac91
--- /dev/null
+++ b/contrib/notmuch-mutt/README
@@ -0,0 +1,59 @@
+notmuch-mutt: Notmuch (of a) helper for Mutt
+============================================
+
+notmuch-mutt provide integration among the [Mutt] [1] mail user agent and the
+[Notmuch] [2] mail indexer.
+
+notmuch-mutt offer two main integration features. The first one is the ability
+of stating a **search query interactively** and then jump to a fresh Maildir
+containing its search results only. The second one is the ability to
+**reconstruct threads on the fly** starting from the currently highlighted
+mail, which comes handy when a thread has been split across different maildirs,
+archived, or the like.
+
+notmuch-mutt enables to trigger mail searches via a Mutt macro (usually F8) and
+reconstruct threads via another (usually F9). Check the manpage for the 2-liner
+configuration snippet for your Mutt configuration files (~/.muttrc,
+/etc/Muttrc, or a /etc/Muttrc.d snippet).
+
+A [blog style introduction] [3] to notmuch-mutt is available and includes some
+more rationale for its existence.
+
+Arguably, some of the logics of notmuch-mutt could disappear by adding support
+for a --output=symlinks flag to notmuch.
+
+
+[1]: http://www.mutt.org/
+[2]: http://notmuchmail.org/
+[3]: http://upsilon.cc/~zack/blog/posts/2011/01/how_to_use_Notmuch_with_Mutt/
+
+
+Requirements
+------------
+
+To *run* notmuch-mutt you will need Perl with the following libraries:
+
+- Mail::Box <http://search.cpan.org/~markov/Mail-Box/>
+ (Debian package: libmail-box-perl)
+- Mail::Internet <http://search.cpan.org/~markov/MailTools/>
+ (Debian package: libmailtools-perl)
+- String::ShellQuote <http://search.cpan.org/~rosch/String-ShellQuote/ShellQuote.pm>
+ (Debian package: libstring-shellquote-perl)
+- Term::ReadLine <http://search.cpan.org/~hayashi/Term-ReadLine-Gnu/>
+ (Debian package: libterm-readline-gnu-perl)
+
+To *build* notmuch-mutt documentation you will need:
+
+- pod2man (coming with Perl) to generate the manpage
+- markdown to generate README.html out of this file
+
+
+License
+-------
+
+notmuch-mutt is copyright (C) 2011-2012 Stefano Zacchiroli <zack@upsilon.cc>.
+
+notmuch-mutt is released under the terms of the GNU General Public License
+(GPL), version 3 or above. A copy of the license is available online at
+<http://www.gnu.org/licenses/>.
+
diff --git a/contrib/notmuch-mutt/notmuch-mutt b/contrib/notmuch-mutt/notmuch-mutt
new file mode 100755
index 0000000..d14709d
--- /dev/null
+++ b/contrib/notmuch-mutt/notmuch-mutt
@@ -0,0 +1,297 @@
+#!/usr/bin/perl -w
+#
+# notmuch-mutt - notmuch (of a) helper for Mutt
+#
+# Copyright: © 2011-2012 Stefano Zacchiroli <zack@upsilon.cc>
+# License: GNU General Public License (GPL), version 3 or above
+#
+# See the bottom of this file for more documentation.
+# A manpage can be obtained by running "pod2man notmuch-mutt > notmuch-mutt.1"
+
+use strict;
+use warnings;
+
+use File::Path;
+use Getopt::Long qw(:config no_getopt_compat);
+use Mail::Internet;
+use Mail::Box::Maildir;
+use Pod::Usage;
+use String::ShellQuote;
+use Term::ReadLine;
+use Digest::SHA;
+use File::Which;
+
+
+my $xdg_cache_dir = "$ENV{HOME}/.cache";
+$xdg_cache_dir = $ENV{XDG_CACHE_HOME} if $ENV{XDG_CACHE_HOME};
+my $cache_dir = "$xdg_cache_dir/notmuch/mutt";
+
+
+# create an empty maildir (if missing) or empty an existing maildir"
+sub empty_maildir($) {
+ my ($maildir) = (@_);
+ rmtree($maildir) if (-d $maildir);
+ my $folder = new Mail::Box::Maildir(folder => $maildir,
+ create => 1);
+ $folder->close();
+}
+
+# Match files by size and SHA-256; then delete duplicates
+sub builtin_remove_dups($) {
+ my ($maildir) = @_;
+ my (%size_to_files, %sha_to_files);
+
+ # Group files by matching sizes
+ foreach my $file (glob("$maildir/cur/*")) {
+ my $size = -s $file;
+ push(@{$size_to_files{$size}}, $file) if $size;
+ }
+
+ foreach my $same_size_files (values %size_to_files) {
+ # Don't run sha unless there is another file of the same size
+ next if scalar(@$same_size_files) < 2;
+ %sha_to_files = ();
+
+ # Group files with matching sizes by SHA-256
+ foreach my $file (@$same_size_files) {
+ open(my $fh, '<', $file) or next;
+ binmode($fh);
+ my $sha256hash = Digest::SHA->new(256)->addfile($fh)->hexdigest;
+ close($fh);
+
+ push(@{$sha_to_files{$sha256hash}}, $file);
+ }
+
+ # Remove duplicates
+ foreach my $same_sha_files (values %sha_to_files) {
+ next if scalar(@$same_sha_files) < 2;
+ unlink(@{$same_sha_files}[1..$#$same_sha_files]);
+ }
+ }
+}
+
+# Use either fdupes or the built-in scanner to detect and remove duplicate
+# search results in the maildir
+sub remove_duplicates($) {
+ my ($maildir) = @_;
+
+ my $fdupes = which("fdupes");
+ if ($fdupes) {
+ system("$fdupes --hardlinks --symlinks --delete --noprompt"
+ . " --quiet $maildir/cur/ > /dev/null");
+ } else {
+ builtin_remove_dups($maildir);
+ }
+}
+
+# search($maildir, $remove_dups, $query)
+# search mails according to $query with notmuch; store results in $maildir
+sub search($$$) {
+ my ($maildir, $remove_dups, $query) = @_;
+ $query = shell_quote($query);
+
+ empty_maildir($maildir);
+ system("notmuch search --output=files $query"
+ . " | sed -e 's: :\\\\ :g'"
+ . " | xargs --no-run-if-empty ln -s -t $maildir/cur/");
+ remove_duplicates($maildir) if ($remove_dups);
+}
+
+sub prompt($$) {
+ my ($text, $default) = @_;
+ my $query = "";
+ my $term = Term::ReadLine->new( "notmuch-mutt" );
+ my $histfile = "$cache_dir/history";
+
+ $term->ornaments( 0 );
+ $term->unbind_key( ord( "\t" ) );
+ $term->MinLine( 3 );
+ $histfile = $ENV{MUTT_NOTMUCH_HISTFILE} if $ENV{MUTT_NOTMUCH_HISTFILE};
+ $term->ReadHistory($histfile) if (-r $histfile);
+ while (1) {
+ chomp($query = $term->readline($text, $default));
+ if ($query eq "?") {
+ system("man", "notmuch-search-terms");
+ } else {
+ $term->WriteHistory($histfile);
+ return $query;
+ }
+ }
+}
+
+sub get_message_id() {
+ my $mail = Mail::Internet->new(\*STDIN);
+ $mail->head->get("message-id") =~ /^<(.*)>$/; # get message-id
+ return $1;
+}
+
+sub search_action($$$@) {
+ my ($interactive, $results_dir, $remove_dups, @params) = @_;
+
+ if (! $interactive) {
+ search($results_dir, $remove_dups, join(' ', @params));
+ } else {
+ my $query = prompt("search ('?' for man): ", join(' ', @params));
+ if ($query ne "") {
+ search($results_dir, $remove_dups, $query);
+ }
+ }
+}
+
+sub thread_action($$@) {
+ my ($results_dir, $remove_dups, @params) = @_;
+
+ my $mid = get_message_id();
+ my $search_cmd = 'notmuch search --output=threads ' . shell_quote("id:$mid");
+ my $tid = `$search_cmd`; # get thread id
+ chomp($tid);
+
+ search($results_dir, $remove_dups, $tid);
+}
+
+sub tag_action(@) {
+ my $mid = get_message_id();
+
+ system("notmuch tag "
+ . shell_quote(join(' ', @_))
+ . " id:$mid");
+}
+
+sub die_usage() {
+ my %podflags = ( "verbose" => 1,
+ "exitval" => 2 );
+ pod2usage(%podflags);
+}
+
+sub main() {
+ mkpath($cache_dir) unless (-d $cache_dir);
+
+ my $results_dir = "$cache_dir/results";
+ my $interactive = 0;
+ my $help_needed = 0;
+ my $remove_dups = 0;
+
+ my $getopt = GetOptions(
+ "h|help" => \$help_needed,
+ "o|output-dir=s" => \$results_dir,
+ "p|prompt" => \$interactive,
+ "r|remove-dups" => \$remove_dups);
+ if (! $getopt || $#ARGV < 0) { die_usage() };
+ my ($action, @params) = ($ARGV[0], @ARGV[1..$#ARGV]);
+
+ foreach my $param (@params) {
+ $param =~ s/folder:=/folder:/g;
+ }
+
+ if ($help_needed) {
+ die_usage();
+ } elsif ($action eq "search" && $#ARGV == 0 && ! $interactive) {
+ print STDERR "Error: no search term provided\n\n";
+ die_usage();
+ } elsif ($action eq "search") {
+ search_action($interactive, $results_dir, $remove_dups, @params);
+ } elsif ($action eq "thread") {
+ thread_action($results_dir, $remove_dups, @params);
+ } elsif ($action eq "tag") {
+ tag_action(@params);
+ } else {
+ die_usage();
+ }
+}
+
+main();
+
+__END__
+
+=head1 NAME
+
+notmuch-mutt - notmuch (of a) helper for Mutt
+
+=head1 SYNOPSIS
+
+=over
+
+=item B<notmuch-mutt> [I<OPTION>]... search [I<SEARCH-TERM>]...
+
+=item B<notmuch-mutt> [I<OPTION>]... thread < I<MAIL>
+
+=item B<notmuch-mutt> [I<OPTION>]... tag [I<TAGS>]... < I<MAIL>
+
+=back
+
+=head1 DESCRIPTION
+
+notmuch-mutt is a frontend to the notmuch mail indexer capable of populating
+a maildir with search results.
+
+=head1 OPTIONS
+
+=over 4
+
+=item -o DIR
+
+=item --output-dir DIR
+
+Store search results as (symlink) messages under maildir DIR. Beware: DIR will
+be overwritten. (Default: F<~/.cache/notmuch/mutt/results/>)
+
+=item -p
+
+=item --prompt
+
+Instead of using command line search terms, prompt the user for them (only for
+"search").
+
+=item -r
+
+=item --remove-dups
+
+Remove duplicates from search results.
+
+=item -h
+
+=item --help
+
+Show usage information and exit.
+
+=back
+
+=head1 INTEGRATION WITH MUTT
+
+notmuch-mutt can be used to integrate notmuch with the Mutt mail user agent
+(unsurprisingly, given the name). To that end, you should define macros like
+the following in your Mutt configuration (usually one of: F<~/.muttrc>,
+F</etc/Muttrc>, or a configuration snippet under F</etc/Muttrc.d/>):
+
+ macro index <F8> \
+ "<enter-command>unset wait_key<enter><shell-escape>notmuch-mutt -r --prompt search<enter><change-folder-readonly>~/.cache/notmuch/mutt/results<enter>" \
+ "notmuch: search mail"
+ macro index <F9> \
+ "<enter-command>unset wait_key<enter><pipe-message>notmuch-mutt -r thread<enter><change-folder-readonly>~/.cache/notmuch/mutt/results<enter><enter-command>set wait_key<enter>" \
+ "notmuch: reconstruct thread"
+ macro index <F6> \
+ "<enter-command>unset wait_key<enter><pipe-message>notmuch-mutt tag -- -inbox<enter>" \
+ "notmuch: remove message from inbox"
+
+The first macro (activated by <F8>) prompts the user for notmuch search terms
+and then jump to a temporary maildir showing search results. The second macro
+(activated by <F9>) reconstructs the thread corresponding to the current mail
+and show it as search results. The third macro (activated by <F6>) removes the
+tag C<inbox> from the current message; by changing C<-inbox> this macro may be
+customised to add or remove tags appropriate to the users notmuch work-flow.
+
+To keep notmuch index current you should then periodically run C<notmuch
+new>. Depending on your local mail setup, you might want to do that via cron,
+as a hook triggered by mail retrieval, etc.
+
+=head1 SEE ALSO
+
+mutt(1), notmuch(1)
+
+=head1 AUTHOR
+
+Copyright: (C) 2011-2012 Stefano Zacchiroli <zack@upsilon.cc>
+
+License: GNU General Public License (GPL), version 3 or higher
+
+=cut
diff --git a/contrib/notmuch-mutt/notmuch-mutt.rc b/contrib/notmuch-mutt/notmuch-mutt.rc
new file mode 100644
index 0000000..ddc4b48
--- /dev/null
+++ b/contrib/notmuch-mutt/notmuch-mutt.rc
@@ -0,0 +1,9 @@
+macro index <F8> \
+ "<enter-command>unset wait_key<enter><shell-escape>notmuch-mutt -r --prompt search<enter><change-folder-readonly>`echo ${XDG_CACHE_HOME:-$HOME/.cache}/notmuch/mutt/results`<enter>" \
+ "notmuch: search mail"
+macro index <F9> \
+ "<enter-command>unset wait_key<enter><pipe-message>notmuch-mutt -r thread<enter><change-folder-readonly>`echo ${XDG_CACHE_HOME:-$HOME/.cache}/notmuch/mutt/results`<enter><enter-command>set wait_key<enter>" \
+ "notmuch: reconstruct thread"
+macro index <F6> \
+ "<enter-command>unset wait_key<enter><pipe-message>notmuch-mutt tag -- -inbox<enter>" \
+ "notmuch: remove message from inbox"