<pre>
<b>notmuch</b> <b>count</b> [option ...] <<u>search-term</u>> ...
- <b>notmuch</b> <b>dump</b> [--format=(batch-tag|sup)] [--] [--output=<<u>file</u>>] [--]
+ <b>notmuch</b> <b>dump</b> [--gzip] [--format=(batch-tag|sup)] [--output=<<u>file</u>>] [--]
[<<u>search-term</u>> ...]
<b>notmuch</b> <b>reindex</b> [option ...] <<u>search-term</u>> ...
terms to match against specific portions of an email, (where <brackets>
indicate user-supplied values).
- If notmuch is built with <b>Xapian</b> <b>Field</b> <b>Processors</b> (see below) some of
- the prefixes with <regex> forms can be also used to restrict the
- results to those whose value matches a regular expression (see
+ Some of the prefixes with <regex> forms can be also used to restrict
+ the results to those whose value matches a regular expression (see
<b>regex</b>(7)) delimited with //, for example:
notmuch search 'from:"/bob@.*[.]example[.]com/"'
+ <b>body:<word-or-quoted-phrase></b>
+ Match terms in the body of messages.
+
<b>from:<name-or-address></b> <b>or</b> <b>from:/<regex>/</b>
- The <b>from:</b> prefix is used to match the name or address of the
+ The <b>from:</b> prefix is used to match the name or address of the
sender of an email message.
<b>to:<name-or-address></b>
- The <b>to:</b> prefix is used to match the names or addresses of any
+ The <b>to:</b> prefix is used to match the names or addresses of any
recipient of an email message, (whether To, Cc, or Bcc).
<b>subject:<word-or-quoted-phrase></b> <b>or</b> <b>subject:/<regex>/</b>
- Any term prefixed with <b>subject:</b> will match only text from the
- subject of an email. Searching for a phrase in the subject is
- supported by including quotation marks around the phrase, imme‐
+ Any term prefixed with <b>subject:</b> will match only text from the
+ subject of an email. Searching for a phrase in the subject is
+ supported by including quotation marks around the phrase, imme‐
diately following <b>subject:</b>.
<b>attachment:<word></b>
- The <b>attachment:</b> prefix can be used to search for specific file‐
+ The <b>attachment:</b> prefix can be used to search for specific file‐
names (or extensions) of attachments to email messages.
<b>mimetype:<word></b>
- The <b>mimetype:</b> prefix will be used to match text from the con‐
- tent-types of MIME parts within email messages (as specified by
+ The <b>mimetype:</b> prefix will be used to match text from the con‐
+ tent-types of MIME parts within email messages (as specified by
the sender).
<b>tag:<tag></b> <b>or</b> <b>tag:/<regex>/</b> <b>or</b> <b>is:<tag></b> <b>or</b> <b>is:/<regex>/</b>
- For <b>tag:</b> and <b>is:</b> valid tag values include <b>inbox</b> and <b>unread</b> by
- default for new messages added by <b>notmuch</b> <b>new</b> as well as any
+ For <b>tag:</b> and <b>is:</b> valid tag values include <b>inbox</b> and <b>unread</b> by
+ default for new messages added by <b>notmuch</b> <b>new</b> as well as any
other tag values added manually with <b>notmuch</b> <b>tag</b>.
<b>id:<message-id></b> <b>or</b> <b>mid:<message-id></b> <b>or</b> <b>mid:/<regex>/</b>
- For <b>id:</b> and <b>mid:</b>, message ID values are the literal contents of
- the Message-ID: header of email messages, but without the '<',
+ For <b>id:</b> and <b>mid:</b>, message ID values are the literal contents of
+ the Message-ID: header of email messages, but without the '<',
'>' delimiters.
<b>thread:<thread-id></b>
- The <b>thread:</b> prefix can be used with the thread ID values that
- are generated internally by notmuch (and do not appear in email
- messages). These thread ID values can be seen in the first col‐
+ The <b>thread:</b> prefix can be used with the thread ID values that
+ are generated internally by notmuch (and do not appear in email
+ messages). These thread ID values can be seen in the first col‐
umn of output from <b>notmuch</b> <b>search</b>
<b>thread:{<notmuch</b> <b>query>}</b>
- If notmuch is built with <b>Xapian</b> <b>Field</b> <b>Processors</b> (see below),
- threads may be searched for indirectly by providing an arbitrary
+ Threads may be searched for indirectly by providing an arbitrary
notmuch query in <b>{}</b>. For example, the following returns threads
containing a message from mallory and one (not necessarily the
same message) with Subject containing the word "crypto".
<b>query:<name></b>
The <b>query:</b> prefix allows queries to refer to previously saved
- queries added with <a href='../notmuch-config-1/'>notmuch-config</a>(1). Named queries are only
- available if notmuch is built with <b>Xapian</b> <b>Field</b> <b>Processors</b> (see
- below).
+ queries added with <a href='../notmuch-config-1/'>notmuch-config</a>(1).
<b>property:<key>=<value></b>
The <b>property:</b> prefix searches for messages with a particular
notmuch (and extensions) to add metadata to messages. A given
key can be present on a given message with several different
values. See <a href='../notmuch-properties-7/'>notmuch-properties</a>(7) for more details.
+
+ User defined prefixes are also supported, see <a href='../notmuch-config-1/'>notmuch-config</a>(1) for
+ details.
</pre>
<h3> Operators</h3>
<pre>
- In addition to individual terms, multiple terms can be combined with
- Boolean operators (<b>and</b>, <b>or</b>, <b>not</b>, and <b>xor</b>). Each term in the query will
- be implicitly connected by a logical AND if no explicit operator is
- provided (except that terms with a common prefix will be implicitly
- combined with OR). The shorthand '-<term>' can be used for 'not
+ In addition to individual terms, multiple terms can be combined with
+ Boolean operators (<b>and</b>, <b>or</b>, <b>not</b>, and <b>xor</b>). Each term in the query will
+ be implicitly connected by a logical AND if no explicit operator is
+ provided (except that terms with a common prefix will be implicitly
+ combined with OR). The shorthand '-<term>' can be used for 'not
<term>' but unfortunately this does not work at the start of an expres‐
- sion. Parentheses can also be used to control the combination of the
+ sion. Parentheses can also be used to control the combination of the
Boolean operators, but will have to be protected from interpretation by
the shell, (such as by putting quotation marks around any parenthesized
expression).
- In addition to the standard boolean operators, Xapian provides several
+ In addition to the standard boolean operators, Xapian provides several
operators specific to text searching.
notmuch search term1 NEAR term2
- will return results where term1 is within 10 words of term2. The
+ will return results where term1 is within 10 words of term2. The
threshold can be set like this:
notmuch search term1 NEAR/2 term2
notmuch search term1 ADJ term2
will return results where term1 is within 10 words of term2, but in the
- same order as in the query. The threshold can be set the same as with
+ same order as in the query. The threshold can be set the same as with
NEAR:
notmuch search term1 ADJ/7 term2
notmuch search details
notmuch search detail
- will all return identical results, because Xapian first "reduces" the
+ will all return identical results, because Xapian first "reduces" the
term to the common stem (here 'detail') and then performs the search.
- There are two ways to turn this off: a search for a capitalized word
- will be performed unstemmed, so that one can search for "John" and not
- get results for "Johnson"; phrase searches are also unstemmed (see
- below for details). Stemming is currently only supported for English.
+ There are two ways to turn this off: a search for a capitalized word
+ will be performed unstemmed, so that one can search for "John" and not
+ get results for "Johnson"; phrase searches are also unstemmed (see
+ below for details). Stemming is currently only supported for English.
Searches for words in other languages will be performed unstemmed.
</pre>
<h3> Wildcards</h3>
<pre>
- It is possible to use a trailing '*' as a wildcard. A search for
+ It is possible to use a trailing '*' as a wildcard. A search for
'wildc*' will match 'wildcard', 'wildcat', etc.
</pre>
<h3> Boolean and Probabilistic Prefixes</h3>
<pre>
- Xapian (and hence notmuch) prefixes are either <b>boolean</b>, supporting
- exact matches like "<u>tag:inbox</u>" or <b>probabilistic</b>, supporting a more
- flexible <b>term</b> based searching. Certain <b>special</b> prefixes are processed
- by notmuch in a way not strictly fitting either of Xapian's built in
+ Xapian (and hence notmuch) prefixes are either <b>boolean</b>, supporting
+ exact matches like "<u>tag:inbox</u>" or <b>probabilistic</b>, supporting a more
+ flexible <b>term</b> based searching. Certain <b>special</b> prefixes are processed
+ by notmuch in a way not strictly fitting either of Xapian's built in
styles. The prefixes currently supported by notmuch are as follows.
<b>Boolean</b>
<b>tag:</b>, <b>id:</b>, <b>thread:</b>, <b>folder:</b>, <b>path:</b>, <b>property:</b>
<b>Probabilistic</b>
- <b>to:</b>, <b>attachment:</b>, <b>mimetype:</b>
+ <b>body:</b>, <b>to:</b>, <b>attachment:</b>, <b>mimetype:</b>
<b>Special</b>
<b>from:</b>, <b>query:</b>, <b>subject:</b>
<h3> Terms and phrases</h3>
<pre>
- In general Xapian distinguishes between lists of terms and <b>phrases</b>.
+ In general Xapian distinguishes between lists of terms and <b>phrases</b>.
Phrases are indicated by double quotes (but beware you probably need to
- protect those from your shell) and insist that those unstemmed words
- occur in that order. One useful, but initially surprising feature is
+ protect those from your shell) and insist that those unstemmed words
+ occur in that order. One useful, but initially surprising feature is
that the following are equivalent ways to write the same phrase.
· "a list of words"
<h3> Quoting</h3>
<pre>
- Double quotes are also used by the notmuch query parser to protect
- boolean terms, regular expressions, or subqueries containing spaces or
+ Double quotes are also used by the notmuch query parser to protect
+ boolean terms, regular expressions, or subqueries containing spaces or
other special characters, e.g.
tag:"a tag"
thread:"{from:mallory and date:2009}"
- As with phrases, you need to protect the double quotes from the shell
+ As with phrases, you need to protect the double quotes from the shell
e.g.
% notmuch search 'folder:"/^.*/(Junk|Spam)$/"'
<h2>DATE AND TIME SEARCH</h2>
<pre>
- notmuch understands a variety of standard and natural ways of express‐
+ notmuch understands a variety of standard and natural ways of express‐
ing dates and times, both in absolute terms ("2012-10-24") and in rela‐
- tive terms ("yesterday"). Any number of relative terms can be combined
- ("1 hour 25 minutes") and an absolute date/time can be combined with
- relative terms to further adjust it. A non-exhaustive description of
+ tive terms ("yesterday"). Any number of relative terms can be combined
+ ("1 hour 25 minutes") and an absolute date/time can be combined with
+ relative terms to further adjust it. A non-exhaustive description of
the syntax supported for absolute and relative terms is given below.
</pre>
<pre>
date:<since>..<until>
- The above expression restricts the results to only messages from
+ The above expression restricts the results to only messages from
<since> to <until>, based on the Date: header.
- <since> and <until> can describe imprecise times, such as "yesterday".
- In this case, <since> is taken as the earliest time it could describe
+ <since> and <until> can describe imprecise times, such as "yesterday".
+ In this case, <since> is taken as the earliest time it could describe
(the beginning of yesterday) and <until> is taken as the latest time it
- could describe (the end of yesterday). Similarly, date:january..febru‐
+ could describe (the end of yesterday). Similarly, date:january..febru‐
ary matches from the beginning of January to the end of February.
- If specifying a time range using timestamps in conjunction with the
- date prefix, each timestamp must be preceded by @ (ASCII hex 40). As
- above, each timestamp is a number representing the number of seconds
+ If specifying a time range using timestamps in conjunction with the
+ date prefix, each timestamp must be preceded by @ (ASCII hex 40). As
+ above, each timestamp is a number representing the number of seconds
since 1970-01-01 00:00:00 UTC. For example:
date:@<initial-timestamp>..@<final-timestamp>
- date:<expr>..! can be used as a shorthand for date:<expr>..<expr>. The
- expansion takes place before interpretation, and thus, for example,
- date:monday..! matches from the beginning of Monday until the end of
- Monday. With <b>Xapian</b> <b>Field</b> <b>Processor</b> support (see below), non-range
- date queries such as date:yesterday will work, but otherwise will give
- unexpected results; if in doubt use date:yesterday..!
-
- Currently, we do not support spaces in range expressions. You can
+ Currently, spaces in range expressions are not supported. You can
replace the spaces with '_', or (in most cases) '-', or (in some cases)
leave the spaces out altogether. Examples in this man page use spaces
for clarity.
- Open-ended ranges are supported (since Xapian 1.2.1), i.e. it's possi‐
- ble to specify date:..<until> or date:<since>.. to not limit the start
- or end time, respectively. Pre-1.2.1 Xapian does not report an error on
- open ended ranges, but it does not work as expected either.
+ Open-ended ranges are supported. I.e. it's possible to specify
+ date:..<until> or date:<since>.. to not limit the start or end time,
+ respectively.
+</pre>
+
+<h3> Single expression</h3>
+<pre>
+ date:<expr> works as a shorthand for date:<expr>..<expr>. For example,
+ date:monday matches from the beginning of Monday until the end of Mon‐
+ day.
</pre>
<h3> Relative date and time</h3>
All refer to past, can be repeated and will be accumulated.
- Units can be abbreviated to any length, with the otherwise ambiguous
+ Units can be abbreviated to any length, with the otherwise ambiguous
single m being m for minutes and M for months.
- Number can also be written out one, two, ..., ten, dozen, hundred.
+ Number can also be written out one, two, ..., ten, dozen, hundred.
Additionally, the unit may be preceded by "last" or "this" (e.g., "last
week" or "this month").
- When combined with absolute date and time, the relative date and time
- specification will be relative from the specified absolute date and
+ When combined with absolute date and time, the relative date and time
+ specification will be relative from the specified absolute date and
time.
Examples: 5M2d, two weeks
Some time zone codes, e.g. UTC, EET.
</pre>
-<h2>XAPIAN FIELD PROCESSORS</h2>
-<pre>
- Certain optional features of the notmuch query processor rely on the
- presence of the Xapian field processor API. You can determine if your
- notmuch was built against a sufficiently recent version of Xapian by
- running
-
- % notmuch config get built_with.field_processor
-
- Currently the following features require field processor support:
-
- · non-range date queries, e.g. "date:today"
-
- · named queries e.g. "query:my_special_query"
-
- · regular expression searches, e.g. "subject:/^\[SPAM\]/"
-
- · thread subqueries, e.g. "thread:{from:bob}"
-</pre>
-
<h2>SEE ALSO</h2>
<pre>
<a href='../notmuch-1/'>notmuch</a>(1), <a href='../notmuch-config-1/'>notmuch-config</a>(1), <a href='../notmuch-count-1/'>notmuch-count</a>(1), <a href='../notmuch-dump-1/'>notmuch-dump</a>(1), <a href='../notmuch-hooks-5/'>not‐</a>
<h2>COPYRIGHT</h2>
<pre>
- 2009-2018, Carl Worth and many others
+ 2009-2020, Carl Worth and many others
</pre>
-<h2>0.27</h2>
+<h2>0.30</h2>
projects / notmuch-wiki / blobdiff