8 **notmuch** **count** [option ...] <*search-term*> ...
10 **notmuch** **dump** [--gzip] [--format=(batch-tag|sup)] [--output=<*file*>] [--] [<*search-term*> ...]
12 **notmuch** **reindex** [option ...] <*search-term*> ...
14 **notmuch** **search** [option ...] <*search-term*> ...
16 **notmuch** **show** [option ...] <*search-term*> ...
18 **notmuch** **tag** +<*tag*> ... -<*tag*> [--] <*search-term*> ...
23 Several notmuch commands accept a common syntax for search terms.
25 The search terms can consist of free-form text (and quoted phrases)
26 which will match all messages that contain all of the given
27 terms/phrases in the body, the subject, or any of the sender or
30 As a special case, a search string consisting of exactly a single
31 asterisk ("\*") will match all messages.
36 In addition to free text, the following prefixes can be used to force
37 terms to match against specific portions of an email, (where <brackets>
38 indicate user-supplied values).
40 If notmuch is built with **Xapian Field Processors** (see below) some
41 of the prefixes with <regex> forms can be also used to restrict the
42 results to those whose value matches a regular expression (see
43 **regex(7)**) delimited with //, for example::
45 notmuch search 'from:"/bob@.*[.]example[.]com/"'
47 body:<word-or-quoted-phrase>
48 Match terms in the body of messages.
50 from:<name-or-address> or from:/<regex>/
51 The **from:** prefix is used to match the name or address of
52 the sender of an email message.
55 The **to:** prefix is used to match the names or addresses of any
56 recipient of an email message, (whether To, Cc, or Bcc).
58 subject:<word-or-quoted-phrase> or subject:/<regex>/
59 Any term prefixed with **subject:** will match only text from the
60 subject of an email. Searching for a phrase in the subject is
61 supported by including quotation marks around the phrase,
62 immediately following **subject:**.
65 The **attachment:** prefix can be used to search for specific
66 filenames (or extensions) of attachments to email messages.
69 The **mimetype:** prefix will be used to match text from the
70 content-types of MIME parts within email messages (as specified by
73 tag:<tag> or tag:/<regex>/ or is:<tag> or is:/<regex>/
74 For **tag:** and **is:** valid tag values include **inbox** and
75 **unread** by default for new messages added by **notmuch new** as
76 well as any other tag values added manually with **notmuch tag**.
78 id:<message-id> or mid:<message-id> or mid:/<regex>/
79 For **id:** and **mid:**, message ID values are the literal
80 contents of the Message-ID: header of email messages, but without
81 the '<', '>' delimiters.
84 The **thread:** prefix can be used with the thread ID values that
85 are generated internally by notmuch (and do not appear in email
86 messages). These thread ID values can be seen in the first column
87 of output from **notmuch search**
89 thread:{<notmuch query>}
90 If notmuch is built with **Xapian Field Processors** (see below),
91 threads may be searched for indirectly by providing an arbitrary
92 notmuch query in **{}**. For example, the following returns
93 threads containing a message from mallory and one (not necessarily
94 the same message) with Subject containing the word "crypto".
98 % notmuch search 'thread:"{from:mallory}" and thread:"{subject:crypto}"'
100 The performance of such queries can vary wildly. To understand
101 this, the user should think of the query **thread:{<something>}**
102 as expanding to all of the thread IDs which match **<something>**;
103 notmuch then performs a second search using the expanded query.
105 path:<directory-path> or path:<directory-path>/** or path:/<regex>/
106 The **path:** prefix searches for email messages that are in
107 particular directories within the mail store. The directory must
108 be specified relative to the top-level maildir (and without the
109 leading slash). By default, **path:** matches messages in the
110 specified directory only. The "/\*\*" suffix can be used to match
111 messages in the specified directory and all its subdirectories
112 recursively. **path:""** matches messages in the root of the mail
113 store and, likewise, **path:\*\*** matches all messages.
115 **path:** will find a message if *any* copy of that message is in
116 the specific directory.
118 folder:<maildir-folder> or folder:/<regex>/
119 The **folder:** prefix searches for email messages by maildir or
120 MH folder. For MH-style folders, this is equivalent to
121 **path:**. For maildir, this includes messages in the "new" and
122 "cur" subdirectories. The exact syntax for maildir folders depends
123 on your mail configuration. For maildir++, **folder:""** matches
124 the inbox folder (which is the root in maildir++), other folder
125 names always start with ".", and nested folders are separated by
126 "."s, such as **folder:.classes.topology**. For "file system"
127 maildir, the inbox is typically **folder:INBOX** and nested
128 folders are separated by slashes, such as
129 **folder:classes/topology**.
131 **folder:** will find a message if *any* copy of that message is
132 in the specific folder.
134 date:<since>..<until> or date:<date>
135 The **date:** prefix can be used to restrict the results to only
136 messages within a particular time range (based on the Date:
139 See **DATE AND TIME SEARCH** below for details on the range
140 expression, and supported syntax for <since> and <until> date and
143 The time range can also be specified using timestamps without
144 including the date prefix using a syntax of:
146 <initial-timestamp>..<final-timestamp>
148 Each timestamp is a number representing the number of seconds
149 since 1970-01-01 00:00:00 UTC. Specifying a time range this way
150 is considered legacy and predates the date prefix.
152 lastmod:<initial-revision>..<final-revision>
153 The **lastmod:** prefix can be used to restrict the result by the
154 database revision number of when messages were last modified (tags
155 were added/removed or filenames changed). This is usually used in
156 conjunction with the ``--uuid`` argument to **notmuch search** to
157 find messages that have changed since an earlier query.
160 The **query:** prefix allows queries to refer to previously saved
161 queries added with **notmuch-config(1)**. Named queries are only
162 available if notmuch is built with **Xapian Field Processors**
165 property:<key>=<value>
166 The **property:** prefix searches for messages with a particular
167 <key>=<value> property pair. Properties are used internally by
168 notmuch (and extensions) to add metadata to messages. A given key
169 can be present on a given message with several different values.
170 See **notmuch-properties(7)** for more details.
172 User defined prefixes are also supported, see **notmuch-config(1)** for
178 In addition to individual terms, multiple terms can be combined with
179 Boolean operators (**and**, **or**, **not**, and **xor**). Each term
180 in the query will be implicitly connected by a logical AND if no
181 explicit operator is provided (except that terms with a common prefix
182 will be implicitly combined with OR). The shorthand '-<term>' can be
183 used for 'not <term>' but unfortunately this does not work at the
184 start of an expression. Parentheses can also be used to control the
185 combination of the Boolean operators, but will have to be protected
186 from interpretation by the shell, (such as by putting quotation marks
187 around any parenthesized expression).
189 In addition to the standard boolean operators, Xapian provides several
190 operators specific to text searching.
194 notmuch search term1 NEAR term2
196 will return results where term1 is within 10 words of term2. The
197 threshold can be set like this:
201 notmuch search term1 NEAR/2 term2
207 notmuch search term1 ADJ term2
209 will return results where term1 is within 10 words of term2, but in the
210 same order as in the query. The threshold can be set the same as with
215 notmuch search term1 ADJ/7 term2
221 **Stemming** in notmuch means that these searches
225 notmuch search detailed
226 notmuch search details
227 notmuch search detail
229 will all return identical results, because Xapian first "reduces" the
230 term to the common stem (here 'detail') and then performs the search.
232 There are two ways to turn this off: a search for a capitalized word
233 will be performed unstemmed, so that one can search for "John" and not
234 get results for "Johnson"; phrase searches are also unstemmed (see
235 below for details). Stemming is currently only supported for
236 English. Searches for words in other languages will be performed unstemmed.
241 It is possible to use a trailing '\*' as a wildcard. A search for
242 'wildc\*' will match 'wildcard', 'wildcat', etc.
245 Boolean and Probabilistic Prefixes
246 ----------------------------------
248 Xapian (and hence notmuch) prefixes are either **boolean**, supporting
249 exact matches like "tag:inbox" or **probabilistic**, supporting a more
250 flexible **term** based searching. Certain **special** prefixes are
251 processed by notmuch in a way not strictly fitting either of Xapian's
252 built in styles. The prefixes currently supported by notmuch are as
256 **tag:**, **id:**, **thread:**, **folder:**, **path:**, **property:**
258 **body:**, **to:**, **attachment:**, **mimetype:**
260 **from:**, **query:**, **subject:**
265 In general Xapian distinguishes between lists of terms and
266 **phrases**. Phrases are indicated by double quotes (but beware you
267 probably need to protect those from your shell) and insist that those
268 unstemmed words occur in that order. One useful, but initially
269 surprising feature is that the following are equivalent ways to write
277 Both parenthesised lists of terms and quoted phrases are ok with
278 probabilistic prefixes such as **to:**, **from:**, and **subject:**. In particular
288 subject:pizza and subject:free
290 Both of these will match a subject "Free Delicious Pizza" while
301 Double quotes are also used by the notmuch query parser to protect
302 boolean terms, regular expressions, or subqueries containing spaces or
303 other special characters, e.g.
311 folder:"/^.*/(Junk|Spam)$/"
315 thread:"{from:mallory and date:2009}"
317 As with phrases, you need to protect the double quotes from the shell
322 % notmuch search 'folder:"/^.*/(Junk|Spam)$/"'
323 % notmuch search 'thread:"{from:mallory and date:2009}" and thread:{to:mallory}'
328 notmuch understands a variety of standard and natural ways of expressing
329 dates and times, both in absolute terms ("2012-10-24") and in relative
330 terms ("yesterday"). Any number of relative terms can be combined ("1
331 hour 25 minutes") and an absolute date/time can be combined with
332 relative terms to further adjust it. A non-exhaustive description of the
333 syntax supported for absolute and relative terms is given below.
338 date:<since>..<until>
340 The above expression restricts the results to only messages from <since>
341 to <until>, based on the Date: header.
343 <since> and <until> can describe imprecise times, such as "yesterday".
344 In this case, <since> is taken as the earliest time it could describe
345 (the beginning of yesterday) and <until> is taken as the latest time it
346 could describe (the end of yesterday). Similarly, date:january..february
347 matches from the beginning of January to the end of February.
349 If specifying a time range using timestamps in conjunction with the
350 date prefix, each timestamp must be preceded by @ (ASCII hex 40). As
351 above, each timestamp is a number representing the number of seconds
352 since 1970-01-01 00:00:00 UTC. For example:
354 date:@<initial-timestamp>..@<final-timestamp>
356 date:<expr>..! can be used as a shorthand for date:<expr>..<expr>. The
357 expansion takes place before interpretation, and thus, for example,
358 date:monday..! matches from the beginning of Monday until the end of
360 With **Xapian Field Processor** support (see below), non-range
361 date queries such as date:yesterday will work, but otherwise
362 will give unexpected results; if in doubt use date:yesterday..!
364 Currently, we do not support spaces in range expressions. You can
365 replace the spaces with '\_', or (in most cases) '-', or (in some cases)
366 leave the spaces out altogether. Examples in this man page use spaces
369 Open-ended ranges are supported (since Xapian 1.2.1), i.e. it's possible
370 to specify date:..<until> or date:<since>.. to not limit the start or
371 end time, respectively. Pre-1.2.1 Xapian does not report an error on
372 open ended ranges, but it does not work as expected either.
374 Relative date and time
375 ----------------------
378 (years\|months\|weeks\|days\|hours\|hrs\|minutes\|mins\|seconds\|secs)
381 All refer to past, can be repeated and will be accumulated.
383 Units can be abbreviated to any length, with the otherwise ambiguous
384 single m being m for minutes and M for months.
386 Number can also be written out one, two, ..., ten, dozen, hundred.
387 Additionally, the unit may be preceded by "last" or "this" (e.g., "last
388 week" or "this month").
390 When combined with absolute date and time, the relative date and time
391 specification will be relative from the specified absolute date and
394 Examples: 5M2d, two weeks
396 Supported absolute time formats
397 -------------------------------
399 - H[H]:MM[:SS] [(am\|a.m.\|pm\|p.m.)]
401 - H[H] (am\|a.m.\|pm\|p.m.)
411 - Examples: 17:05, 5pm
413 Supported absolute date formats
414 -------------------------------
428 - D[D][(st\|nd\|rd\|th)] Mon[thname] [YYYY]
430 - Mon[thname] D[D][(st\|nd\|rd\|th)] [YYYY]
434 Month names can be abbreviated at three or more characters.
436 Weekday names can be abbreviated at three or more characters.
438 Examples: 2012-07-31, 31-07-2012, 7/31/2012, August 3
447 Some time zone codes, e.g. UTC, EET.
449 XAPIAN FIELD PROCESSORS
450 =======================
452 Certain optional features of the notmuch query processor rely on the
453 presence of the Xapian field processor API. You can determine if your
454 notmuch was built against a sufficiently recent version of Xapian by running
458 % notmuch config get built_with.field_processor
460 Currently the following features require field processor support:
462 - non-range date queries, e.g. "date:today"
463 - named queries e.g. "query:my_special_query"
464 - regular expression searches, e.g. "subject:/^\\[SPAM\\]/"
465 - thread subqueries, e.g. "thread:{from:bob}"
471 **notmuch-config(1)**,
472 **notmuch-count(1)**,
474 **notmuch-hooks(5)**,
475 **notmuch-insert(1)**,
477 **notmuch-reindex(1)**,
478 **notmuch-properties(1)**,
479 ***notmuch-reply(1)**,
480 **notmuch-restore(1)**,
481 **notmuch-search(1)**,
482 ***notmuch-show(1)**,