<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/phrases in the body, the subject, or any of the sender or recipi‐
ent headers.
- As a special case, a search string consisting of exactly a single
- asterisk ("*") will match all messages.
+ As a special case, a search string consisting of exactly a single as‐
+ terisk ("*") will match all messages.
</pre>
<h3> Search prefixes</h3>
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/'
+ 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
- other tag values added manually with <b>notmuch</b> <b>tag</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 <a href='../notmuch-new-1/'>notmuch-new</a>(1) as well as any
+ other tag values added manually with <a href='../notmuch-tag-1/'>notmuch-tag</a>(1).
<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‐
- umn of output from <b>notmuch</b> <b>search</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‐
+ umn of output from <a href='../notmuch-search-1/'>notmuch-search</a>(1)
+
+ <b>thread:{<notmuch</b> <b>query>}</b>
+ 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".
+
+ % notmuch search 'thread:"{from:mallory}" and thread:"{subject:crypto}"'
+
+ The performance of such queries can vary wildly. To understand
+ this, the user should think of the query <b>thread:{<something>}</b> as
+ expanding to all of the thread IDs which match <b><something></b>; not‐
+ much then performs a second search using the expanded query.
<b>path:<directory-path></b> <b>or</b> <b>path:<directory-path>/**</b> <b>or</b> <b>path:/<regex>/</b>
The <b>path:</b> prefix searches for email messages that are in partic‐
- ular directories within the mail store. The directory must be
- specified relative to the top-level maildir (and without the
+ ular directories within the mail store. The directory must be
+ specified relative to the top-level maildir (and without the
leading slash). By default, <b>path:</b> matches messages in the speci‐
- fied directory only. The "/**" suffix can be used to match mes‐
- sages in the specified directory and all its subdirectories
- recursively. <b>path:""</b> matches messages in the root of the mail
+ fied directory only. The "/**" suffix can be used to match mes‐
+ sages in the specified directory and all its subdirectories re‐
+ cursively. <b>path:""</b> matches messages in the root of the mail
store and, likewise, <b>path:**</b> matches all messages.
- <b>path:</b> will find a message if <u>any</u> copy of that message is in the
+ <b>path:</b> will find a message if <u>any</u> copy of that message is in the
specific directory.
<b>folder:<maildir-folder></b> <b>or</b> <b>folder:/<regex>/</b>
- The <b>folder:</b> prefix searches for email messages by maildir or MH
- folder. For MH-style folders, this is equivalent to <b>path:</b>. For
+ The <b>folder:</b> prefix searches for email messages by maildir or MH
+ folder. For MH-style folders, this is equivalent to <b>path:</b>. For
maildir, this includes messages in the "new" and "cur" subdirec‐
- tories. The exact syntax for maildir folders depends on your
- mail configuration. For maildir++, <b>folder:""</b> matches the inbox
- folder (which is the root in maildir++), other folder names
- always start with ".", and nested folders are separated by "."s,
+ tories. The exact syntax for maildir folders depends on your
+ mail configuration. For maildir++, <b>folder:""</b> matches the inbox
+ folder (which is the root in maildir++), other folder names al‐
+ ways start with ".", and nested folders are separated by "."s,
such as <b>folder:.classes.topology</b>. For "file system" maildir, the
inbox is typically <b>folder:INBOX</b> and nested folders are separated
by slashes, such as <b>folder:classes/topology</b>.
- <b>folder:</b> will find a message if <u>any</u> copy of that message is in
+ <b>folder:</b> will find a message if <u>any</u> copy of that message is in
the specific folder.
<b>date:<since>..<until></b> <b>or</b> <b>date:<date></b>
- The <b>date:</b> prefix can be used to restrict the results to only
- messages within a particular time range (based on the Date:
+ The <b>date:</b> prefix can be used to restrict the results to only
+ messages within a particular time range (based on the Date:
header).
- See <b>DATE</b> <b>AND</b> <b>TIME</b> <b>SEARCH</b> below for details on the range expres‐
+ See <b>DATE</b> <b>AND</b> <b>TIME</b> <b>SEARCH</b> below for details on the range expres‐
sion, and supported syntax for <since> and <until> date and time
expressions.
- The time range can also be specified using timestamps with a
- syntax of:
+ The time range can also be specified using timestamps without
+ including the date prefix using a syntax of:
<initial-timestamp>..<final-timestamp>
- Each timestamp is a number representing the number of seconds
- since 1970-01-01 00:00:00 UTC.
+ Each timestamp is a number representing the number of seconds
+ since 1970-01-01 00:00:00 UTC. Specifying a time range this way
+ is considered legacy and predates the date prefix.
<b>lastmod:<initial-revision>..<final-revision></b>
The <b>lastmod:</b> prefix can be used to restrict the result by the
database revision number of when messages were last modified
(tags were added/removed or filenames changed). This is usually
- used in conjunction with the <b>--uuid</b> argument to <b>notmuch</b> <b>search</b>
- to find messages that have changed since an earlier query.
+ used in conjunction with the <b>--uuid</b> argument to <a href='../notmuch-search-1/'>not‐</a>
+ <a href='../notmuch-search-1/'>much-search</a>(1) to find messages that have changed since an ear‐
+ lier query.
<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).
+ The <b>query:</b> prefix allows queries to refer to previously saved
+ 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
- <key>=<value> property pair. Properties are used internally by
- notmuch (and extensions) to add metadata to messages. A given
- key can be present on a given message with several different
+ The <b>property:</b> prefix searches for messages with a particular
+ <key>=<value> property pair. Properties are used internally by
+ 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 de‐
+ tails.
</pre>
<h3> Operators</h3>
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.
+ get results for "Johnson"; phrase searches are also unstemmed (see be‐
+ low for details). Stemming is currently only supported for English.
Searches for words in other languages will be performed unstemmed.
</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 ex‐
+ act matches like "<u>tag:inbox</u>" or <b>probabilistic</b>, supporting a more flexi‐
+ ble <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>
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"
+ • "a list of words"
- · a-list-of-words
+ • a-list-of-words
- · a/list/of/words
+ • a/list/of/words
- · a.list.of.words
+ • a.list.of.words
Both parenthesised lists of terms and quoted phrases are ok with proba‐
bilistic prefixes such as <b>to:</b>, <b>from:</b>, and <b>subject:</b>. In particular
will not.
</pre>
+<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
+ other special characters, e.g.
+
+ tag:"a tag"
+
+ folder:"/^.*/(Junk|Spam)$/"
+
+ thread:"{from:mallory and date:2009}"
+
+ As with phrases, you need to protect the double quotes from the shell
+ e.g.
+
+ % notmuch search 'folder:"/^.*/(Junk|Spam)$/"'
+ % notmuch search 'thread:"{from:mallory and date:2009}" and thread:{to:mallory}'
+</pre>
+
<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.
- 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..!
+ 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>
- Currently, we do not support spaces in range expressions. 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
+ Currently, spaces in range expressions are not supported. You can re‐
+ place 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>
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.
- Additionally, the unit may be preceded by "last" or "this" (e.g., "last
+ Number can also be written out one, two, ..., ten, dozen, hundred. Ad‐
+ ditionally, 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
<h3> Supported absolute time formats</h3>
<pre>
- · H[H]:MM[:SS] [(am|a.m.|pm|p.m.)]
+ • H[H]:MM[:SS] [(am|a.m.|pm|p.m.)]
- · H[H] (am|a.m.|pm|p.m.)
+ • H[H] (am|a.m.|pm|p.m.)
- · HHMMSS
+ • HHMMSS
- · now
+ • now
- · noon
+ • noon
- · midnight
+ • midnight
- · Examples: 17:05, 5pm
+ • Examples: 17:05, 5pm
</pre>
<h3> Supported absolute date formats</h3>
<pre>
- · YYYY-MM[-DD]
+ • YYYY-MM[-DD]
- · DD-MM[-[YY]YY]
+ • DD-MM[-[YY]YY]
- · MM-YYYY
+ • MM-YYYY
- · M[M]/D[D][/[YY]YY]
+ • M[M]/D[D][/[YY]YY]
- · M[M]/YYYY
+ • M[M]/YYYY
- · D[D].M[M][.[YY]YY]
+ • D[D].M[M][.[YY]YY]
- · D[D][(st|nd|rd|th)] Mon[thname] [YYYY]
+ • D[D][(st|nd|rd|th)] Mon[thname] [YYYY]
- · Mon[thname] D[D][(st|nd|rd|th)] [YYYY]
+ • Mon[thname] D[D][(st|nd|rd|th)] [YYYY]
- · Wee[kday]
+ • Wee[kday]
Month names can be abbreviated at three or more characters.
<h3> Time zones</h3>
<pre>
- · (+|-)HH:MM
+ • (+|-)HH:MM
- · (+|-)HH[MM]
+ • (+|-)HH[MM]
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\]/"
-</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>
- <a href='../notmuch-hooks-5/'>much-hooks</a>(5), <a href='../notmuch-insert-1/'>notmuch-insert</a>(1), <a href='../notmuch-new-1/'>notmuch-new</a>(1), <a href='../notmuch-reindex-1/'>notmuch-reindex</a>(1),
- <
b>notmuch-properties</b>(1), <b>*notmuch-reply</b>(1), <a href='../notmuch-restore-1/'>notmuch-restore</a>(1), <a href='../notmuch-search-1/'>not‐</a>
- <a href='../notmuch-search-1/'>much-search</a>(1), <
b>*notmuch-show</b>(1), <a href='../notmuch-tag-1/'>notmuch-tag</a>(1)
+ <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>
+ <a href='../notmuch-hooks-5/'>much-hooks</a>(5), <a href='../notmuch-insert-1/'>notmuch-insert</a>(1), <a href='../notmuch-new-1/'>notmuch-new</a>(1), <a href='../notmuch-properties-7/'>notmuch-proper‐</a>
+ <
a href='../notmuch-properties-7/'>ties</a>(7), <a href='../notmuch-reindex-1/'>notmuch-reindex</a>(1), <a href='../notmuch-reply-1/'>notmuch-reply</a>(1), <a href='../notmuch-restore-1/'>notmuch-restore</a>(1), <a href='../notmuch-search-1/'>not‐</a>
+ <a href='../notmuch-search-1/'>much-search</a>(1), <
a href='../notmuch-show-1/'>notmuch-show</a>(1), <a href='../notmuch-tag-1/'>notmuch-tag</a>(1)
</pre>
<h2>AUTHOR</h2>
<h2>COPYRIGHT</h2>
<pre>
- 2009-2018, Carl Worth and many others
+ 2009-2021, Carl Worth and many others
</pre>
-<h2>0.26</h2>
+<h2>0.33</h2>
projects / notmuch-wiki / blobdiff