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
| | ==============
notmuch-search
==============
SYNOPSIS
========
**notmuch** **search** [*option* ...] <*search-term*> ...
DESCRIPTION
===========
Search for messages matching the given search terms, and display as
results the threads containing the matched messages.
The output consists of one line per thread, giving a thread ID, the date
of the newest (or oldest, depending on the sort option) matched message
in the thread, the number of matched messages and total messages in the
thread, the names of all participants in the thread, and the subject of
the newest (or oldest) message.
See **notmuch-search-terms(7)** for details of the supported syntax for
<search-terms>.
Supported options for **search** include
``--format=``\ (**json**\ \|\ **sexp**\ \|\ **text**\ \|\ **text0**)
Presents the results in either JSON, S-Expressions, newline
character separated plain-text (default), or null character
separated plain-text (compatible with **xargs(1)** -0 option
where available).
``--format-version=N``
Use the specified structured output format version. This is
intended for programs that invoke **notmuch(1)** internally. If
omitted, the latest supported version will be used.
``--output=(summary|threads|messages|files|tags|sender|recipients)``
**summary**
Output a summary of each thread with any message matching
the search terms. The summary includes the thread ID, date,
the number of messages in the thread (both the number
matched and the total number), the authors of the thread and
the subject.
**threads**
Output the thread IDs of all threads with any message
matching the search terms, either one per line
(--format=text), separated by null characters
(--format=text0), as a JSON array (--format=json), or an
S-Expression list (--format=sexp).
**messages**
Output the message IDs of all messages matching the search
terms, either one per line (--format=text), separated by
null characters (--format=text0), as a JSON array
(--format=json), or as an S-Expression list (--format=sexp).
**files**
Output the filenames of all messages matching the search
terms, either one per line (--format=text), separated by
null characters (--format=text0), as a JSON array
(--format=json), or as an S-Expression list (--format=sexp).
Note that each message may have multiple filenames
associated with it. All of them are included in the output
(unless limited with the --duplicate=N option). This may
be particularly confusing for **folder:** or **path:**
searches in a specified directory, as the messages may
have duplicates in other directories that are included in
the output, although these files alone would not match the
search.
**tags**
Output all tags that appear on any message matching the
search terms, either one per line (--format=text), separated
by null characters (--format=text0), as a JSON array
(--format=json), or as an S-Expression list (--format=sexp).
**sender**
Output all addresses from the *From* header that appear on
any message matching the search terms, either one per line
(--format=text), separated by null characters
(--format=text0), as a JSON array (--format=json), or as
an S-Expression list (--format=sexp).
Duplicate addresses are filtered out. Filtering can be
configured with the --filter-by option.
Note: Searching for **sender** should be much faster than
searching for **recipients**, because sender addresses are
cached directly in the database whereas other addresses
need to be fetched from message files.
**recipients**
Like **sender** but for addresses from *To*, *Cc* and
*Bcc* headers.
**count**
Can be used in combination with **sender** or
**recipients** to print the count of how many times was
the address encountered during search.
This option can be given multiple times to combine different
outputs. Currently, this is only supported for **sender**,
**recipients** and **count** outputs.
``--sort=``\ (**newest-first**\ \|\ **oldest-first**)
This option can be used to present results in either
chronological order (**oldest-first**) or reverse chronological
order (**newest-first**).
Note: The thread order will be distinct between these two
options (beyond being simply reversed). When sorting by
**oldest-first** the threads will be sorted by the oldest
message in each thread, but when sorting by **newest-first** the
threads will be sorted by the newest message in each thread.
By default, results will be displayed in reverse chronological
order, (that is, the newest results will be displayed first).
``--offset=[-]N``
Skip displaying the first N results. With the leading '-', start
at the Nth result from the end.
``--limit=N``
Limit the number of displayed results to N.
``--exclude=(true|false|all|flag)``
A message is called "excluded" if it matches at least one tag in
search.tag\_exclude that does not appear explicitly in the
search terms. This option specifies whether to omit excluded
messages in the search process.
The default value, **true**, prevents excluded messages from
matching the search terms.
**all** additionally prevents excluded messages from appearing
in displayed results, in effect behaving as though the excluded
messages do not exist.
**false** allows excluded messages to match search terms and
appear in displayed results. Excluded messages are still marked
in the relevant outputs.
**flag** only has an effect when ``--output=summary``. The
output is almost identical to **false**, but the "match count"
is the number of matching non-excluded messages in the thread,
rather than the number of matching messages.
``--duplicate=N``
Effective with ``--output=files``, output the Nth filename
associated with each message matching the query (N is 1-based).
If N is greater than the number of files associated with the
message, don't print anything.
Note that this option is orthogonal with the **folder:** search
prefix. The prefix matches messages based on filenames. This
option filters filenames of the matching messages.
``--filter-by=``\ (**nameaddr**\ \|\ **name** \|\ **addr**\ \|\ **addrfold**\ \|\ **nameaddrfold**\)
Can be used with ``--output=sender`` or
``--output=recipients`` to filter out duplicate addresses. The
filtering algorithm receives a sequence of email addresses and
outputs the same sequence without the addresses that are
considered a duplicate of a previously output address. What is
considered a duplicate depends on how the two addresses are
compared and this can be controlled with the follwing flags:
**nameaddr** means that both name and address parts are
compared in case-sensitive manner. Therefore, all same looking
addresses strings are considered duplicate. This is the
default.
**name** means that only the name part is compared (in
case-sensitive manner). For example, the addresses "John Doe
<me@example.com>" and "John Doe <john@doe.name>" will be
considered duplicate.
**addr** means that only the address part is compared (in
case-sensitive manner). For example, the addresses "John Doe
<john@example.com>" and "Dr. John Doe <john@example.com>" will
be considered duplicate.
**addrfold** is like **addr**, but comparison is done in
canse-insensitive manner. For example, the addresses "John Doe
<john@example.com>" and "Dr. John Doe <JOHN@EXAMPLE.COM>" will
be considered duplicate.
**nameaddrfold** is like **nameaddr**, but address comparison
is done in canse-insensitive manner. For example, the
addresses "John Doe <john@example.com>" and "John Doe
<JOHN@EXAMPLE.COM>" will be considered duplicate.
EXIT STATUS
===========
This command supports the following special exit status codes
``20``
The requested format version is too old.
``21``
The requested format version is too new.
SEE ALSO
========
**notmuch(1)**, **notmuch-config(1)**, **notmuch-count(1)**,
**notmuch-dump(1)**, **notmuch-hooks(5)**, **notmuch-insert(1)**,
**notmuch-new(1)**, **notmuch-reply(1)**, **notmuch-restore(1)**,
**notmuch-search-terms(7)**, **notmuch-show(1)**, **notmuch-tag(1)**
|