1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
|
#!/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;
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();
}
# search($maildir, $query)
# search mails according to $query with notmuch; store results in $maildir
sub search($$) {
my ($maildir, $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/");
}
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");
} 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, @params) = @_;
if (! $interactive) {
search($results_dir, join(' ', @params));
} else {
my $query = prompt("search ('?' for man): ", join(' ', @params));
if ($query ne "") {
search($results_dir,$query);
}
}
}
sub thread_action(@) {
my ($results_dir, @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, $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 $getopt = GetOptions(
"h|help" => \$help_needed,
"o|output-dir=s" => \$results_dir,
"p|prompt" => \$interactive);
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, @params);
} elsif ($action eq "thread") {
thread_action($results_dir, @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 -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 --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 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
|
