The manual pages are licensed under
[the GNU General Public License](https://www.gnu.org/licenses/gpl.txt),
either version 3.0 or at your option any later version.
+
+<h2>0.23</h2>
+
it does not provide the most convenient interface for that functional‐
ity. More sophisticated interfaces are expected to be built on top of
either the command-line interface, or more likely, on top of the not‐
- much library interface. See <u>https://notmuchmail.org</u> for more about
+ much library interface. See <u>https://notmuchmail.org</u> for more about
alternate interfaces to notmuch. The emacs-based interface to notmuch
(available under <b>emacs/</b> in the Notmuch source distribution) is probably
the most widely used at this time.
Print the installed version of notmuch, and exit.
<b>--config=FILE</b>
- Specify the configuration file to use. This overrides any
+ Specify the configuration file to use. This overrides any
configuration file specified by ${NOTMUCH_CONFIG}.
<b>--uuid=HEX</b>
<h3> SETUP</h3>
<pre>
- The <b>notmuch</b> <b>setup</b> command is used to configure Notmuch for first use,
+ The <b>notmuch</b> <b>setup</b> command is used to configure Notmuch for first use,
(or to reconfigure it later).
- The setup command will prompt for your full name, your primary email
- address, any alternate email addresses you use, and the directory con‐
+ The setup command will prompt for your full name, your primary email
+ address, any alternate email addresses you use, and the directory con‐
taining your email archives. Your answers will be written to a configu‐
- ration file in ${NOTMUCH_CONFIG} (if set) or ${HOME}/.notmuch-config .
+ ration file in ${NOTMUCH_CONFIG} (if set) or ${HOME}/.notmuch-config .
This configuration file will be created with descriptive comments, mak‐
- ing it easy to edit by hand later to change the configuration. Or you
+ ing it easy to edit by hand later to change the configuration. Or you
can run <b>notmuch</b> <b>setup</b> again to change the configuration.
- The mail directory you specify can contain any number of sub-directo‐
+ The mail directory you specify can contain any number of sub-directo‐
ries and should primarily contain only files with individual email mes‐
- sages (eg. maildir or mh archives are perfect). If there are other,
- non-email files (such as indexes maintained by other email programs)
+ sages (eg. maildir or mh archives are perfect). If there are other,
+ non-email files (such as indexes maintained by other email programs)
then notmuch will do its best to detect those and ignore them.
- Mail storage that uses mbox format, (where one mbox file contains many
- messages), will not work with notmuch. If that's how your mail is cur‐
+ Mail storage that uses mbox format, (where one mbox file contains many
+ messages), will not work with notmuch. If that's how your mail is cur‐
rently stored, it is recommended you first convert it to maildir format
with a utility such as mb2md before running <b>notmuch</b> <b>setup</b> <b>.</b>
- Invoking <b>notmuch</b> with no command argument will run <b>setup</b> if the setup
+ Invoking <b>notmuch</b> with no command argument will run <b>setup</b> if the setup
command has not previously been completed.
</pre>
<h3> OTHER COMMANDS</h3>
<pre>
- Several of the notmuch commands accept search terms with a common syn‐
+ Several of the notmuch commands accept search terms with a common syn‐
tax. See <b>notmuch-search-terms</b>(7) for more details on the supported syn‐
tax.
- The <b>search</b>, <b>show</b>, <b>address</b> and <b>count</b> commands are used to query the
+ The <b>search</b>, <b>show</b>, <b>address</b> and <b>count</b> commands are used to query the
email database.
- The <b>reply</b> command is useful for preparing a template for an email
+ The <b>reply</b> command is useful for preparing a template for an email
reply.
The <b>tag</b> command is the only command available for manipulating database
contents.
- The <b>dump</b> and <b>restore</b> commands can be used to create a textual dump of
+ The <b>dump</b> and <b>restore</b> commands can be used to create a textual dump of
email tags for backup purposes, and to restore from that dump.
- The <b>config</b> command can be used to get or set settings in the notmuch
+ The <b>config</b> command can be used to get or set settings in the notmuch
configuration file.
</pre>
of notmuch.
<b>NOTMUCH</b>_<b>CONFIG</b>
- Specifies the location of the notmuch configuration file. Not‐
- much will use ${HOME}/.notmuch-config if this variable is not
+ Specifies the location of the notmuch configuration file. Not‐
+ much will use ${HOME}/.notmuch-config if this variable is not
set.
<b>NOTMUCH</b>_<b>TALLOC</b>_<b>REPORT</b>
- Location to write a talloc memory usage report. See <b>tal-</b>
+ Location to write a talloc memory usage report. See <b>tal-</b>
<b>loc</b>_<b>enable</b>_<b>leak</b>_<b>report</b>_<b>full</b> in <b>talloc</b>(3) for more information.
<b>NOTMUCH</b>_<b>DEBUG</b>_<b>QUERY</b>
- If set to a non-empty value, the notmuch library will print (to
+ If set to a non-empty value, the notmuch library will print (to
stderr) Xapian queries it constructs.
</pre>
<h2>SEE ALSO</h2>
<pre>
- <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/'>notmuch-hooks</a>(5),
- <a href='../notmuch-insert-1/'>notmuch-insert</a>(1), <a href='../notmuch-new-1/'>notmuch-new</a>(1), <a href='../notmuch-reply-1/'>notmuch-reply</a>(1), <a href='../notmuch-restore-1/'>not‐</a>
- <a href='../notmuch-restore-1/'>much-restore</a>(1), <a href='../notmuch-search-1/'>notmuch-search</a>(1), <a href='../notmuch-search-terms-7/'>notmuch-search-terms</a>(7), <a href='../notmuch-show-1/'>not‐</a>
- <a href='../notmuch-show-1/'>much-show</a>(1), <a href='../notmuch-tag-1/'>notmuch-tag</a>(1), <a href='../notmuch-address-1/'>notmuch-address</a>(1)
+ <a href='../notmuch-address-1/'>notmuch-address</a>(1), <a href='../notmuch-compact-1/'>notmuch-compact</a>(1), <a href='../notmuch-config-1/'>notmuch-config</a>(1), <a href='../notmuch-count-1/'>not‐</a>
+ <a href='../notmuch-count-1/'>much-count</a>(1), <a href='../notmuch-dump-1/'>notmuch-dump</a>(1), <a href='../notmuch-hooks-5/'>notmuch-hooks</a>(5), <a href='../notmuch-insert-1/'>notmuch-insert</a>(1),
+ <a href='../notmuch-new-1/'>notmuch-new</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-search-terms-7/'>notmuch-search-terms</a>(7), <a href='../notmuch-show-1/'>notmuch-show</a>(1), <a href='../notmuch-tag-1/'>not‐</a>
+ <a href='../notmuch-tag-1/'>much-tag</a>(1)
The notmuch website: <b>https://notmuchmail.org</b>
</pre>
2009-2016, Carl Worth and many others
</pre>
-<h2>0.22.1</h2>
+<h2>0.23</h2>
is specified, include all variants in the count.
<b>--sort=(newest-first|oldest-first)</b>
- This option can be used to present results in either chrono‐
- logical order (<b>oldest-first</b>) or reverse chronological order
+ This option can be used to present results in either chrono‐
+ logical order (<b>oldest-first</b>) or reverse chronological order
(<b>newest-first</b>).
- By default, results will be displayed in reverse chronologi‐
- cal order, (that is, the newest results will be displayed
+ By default, results will be displayed in reverse chronologi‐
+ cal order, (that is, the newest results will be displayed
first).
However, if either --output=count or --deduplicate=address is
<b>--exclude=(true|false)</b>
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
+ 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, <b>true</b>, prevents excluded messages from
+ The default value, <b>true</b>, prevents excluded messages from
matching the search terms.
- <b>false</b> allows excluded messages to match search terms and
+ <b>false</b> allows excluded messages to match search terms and
appear in displayed results.
</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-reply-1/'>notmuch-reply</a>(1),
- <a href='../notmuch-restore-1/'>notmuch-restore</a>(1),
<a href='../notmuch-search-terms-7/'>notmuch-search-terms</a>(7), <a href='../notmuch-show-1/'>notmuch-show</a>(1), <a href='../notmuch-tag-1/'>not‐</a>
+ <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-reply-1/'>notmuch-reply</a>(1),
+ <a href='../notmuch-restore-1/'>notmuch-restore</a>(1),
<a href='../notmuch-search-terms-7/'>notmuch-search-terms</a>(7), <a href='../notmuch-show-1/'>notmuch-show</a>(1), <a href='../notmuch-tag-1/'>not‐</a>
<a href='../notmuch-tag-1/'>much-tag</a>(1), <a href='../notmuch-search-1/'>notmuch-search</a>(1)
</pre>
2009-2016, Carl Worth and many others
</pre>
-<h2>0.22.1</h2>
+<h2>0.23</h2>
2009-2016, Carl Worth and many others
</pre>
-<h2>0.22.1</h2>
+<h2>0.23</h2>
of notmuch.
<b>NOTMUCH</b>_<b>CONFIG</b>
- Specifies the location of the notmuch configuration file. Not‐
- much will use ${HOME}/.notmuch-config if this variable is not
+ Specifies the location of the notmuch configuration file. Not‐
+ much will use ${HOME}/.notmuch-config if this variable is not
set.
</pre>
<h2>SEE ALSO</h2>
<pre>
- <a href='../notmuch-1/'>notmuch</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/'>notmuch-hooks</a>(5), <a href='../notmuch-insert-1/'>not‐</a>
- <a href='../notmuch-insert-1/'>much-insert</a>(1),
<a href='../notmuch-new-1/'>notmuch-new</a>(1), <a href='../notmuch-reply-1/'>notmuch-reply</a>(1), <a href='../notmuch-restore-1/'>notmuch-restore</a>(1),
+ <a href='../notmuch-1/'>notmuch</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/'>notmuch-hooks</a>(5), <a href='../notmuch-insert-1/'>not‐</a>
+ <a href='../notmuch-insert-1/'>much-insert</a>(1),
<a href='../notmuch-new-1/'>notmuch-new</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/'>notmuch-search</a>(1), <a href='../notmuch-search-terms-7/'>notmuch-search-terms</a>(7), <a href='../notmuch-show-1/'>notmuch-show</a>(1), <a href='../notmuch-tag-1/'>not‐</a>
<a href='../notmuch-tag-1/'>much-tag</a>(1)
</pre>
2009-2016, Carl Worth and many others
</pre>
-<h2>0.22.1</h2>
+<h2>0.23</h2>
2009-2016, Carl Worth and many others
</pre>
-<h2>0.22.1</h2>
+<h2>0.23</h2>
characters. Note also that tags with spaces will not be
correctly restored with this format.
- <b>--include=(config|tags)</b>
+ <b>--include=(config|properties|tags)</b>
Control what kind of metadata is included in the output.
<b>config</b>
Output configuration data stored in the database. Each line
- starts with "#@ ", followed by a space seperated key-value
+ starts with "#@ ", followed by a space separated key-value
pair. Both key and value are hex encoded if needed.
+ <b>properties</b>
+ Output per-message (key,value) metadata. Each line starts
+ with "#= ", followed by a message id, and a space separated
+ list of key=value pairs. pair. Ids, keys and values are hex
+ encoded if needed.
+
<b>tags</b>
- Output per-message metadata, namely tags. See <u>format</u> above
- for description of the output.
+ Output per-message boolean metadata, namely tags. See <u>format</u>
+ above for description of the output.
- The default is to include both tags and configuration informa‐
- tion. As of version 2 of the dump format, there is a header line
- of the following form
+ The default is to include all available types of data. The
+ option can be specified multiple times to select some subset. As
+ of version 2 of the dump format, there is a header line of the
+ following form
#notmuch-dump <<u>format</u>>:<<u>version</u>> <<u>included</u>>
<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-hooks-5/'>notmuch-hooks</a>(5), <a href='../notmuch-insert-1/'>not‐</a>
- <a href='../notmuch-insert-1/'>much-insert</a>(1),
<a href='../notmuch-new-1/'>notmuch-new</a>(1), <a href='../notmuch-reply-1/'>notmuch-reply</a>(1), <a href='../notmuch-restore-1/'>notmuch-restore</a>(1),
+ <a href='../notmuch-insert-1/'>much-insert</a>(1),
<a href='../notmuch-new-1/'>notmuch-new</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/'>notmuch-search</a>(1), <a href='../notmuch-search-terms-7/'>notmuch-search-terms</a>(7), <a href='../notmuch-show-1/'>notmuch-show</a>(1), <a href='../notmuch-tag-1/'>not‐</a>
<a href='../notmuch-tag-1/'>much-tag</a>(1)
</pre>
2009-2016, Carl Worth and many others
</pre>
-<h2>0.22.1</h2>
+<h2>0.23</h2>
This hook is invoked by the <b>insert</b> command after the message has
been delivered, added to the database, and initial tags have
been applied. The hook will not be run if there have been any
- errors during the message delivery; what is regarded as succes‐
+ errors during the message delivery; what is regarded as success‐
ful delivery depends on the <b>--keep</b> option.
Typically this hook is used to perform additional query-based
2009-2016, Carl Worth and many others
</pre>
-<h2>0.22.1</h2>
+<h2>0.23</h2>
<b>--keep</b> Keep the message file if indexing fails, and keep the message
indexed if applying tags or maildir flag synchronization
fails. Ignore these errors and return exit status 0 to indi‐
- cate succesful mail delivery.
+ cate successful mail delivery.
<b>--no-hooks</b>
Prevent hooks from being run.
<h2>EXIT STATUS</h2>
<pre>
- This command returns exit status 0 on succesful mail delivery, non-zero
- otherwise. The default is to indicate failed mail delivery on any
- errors, including message file delivery to the filesystem, message
+ This command returns exit status 0 on successful mail delivery,
+ non-zero otherwise. The default is to indicate failed mail delivery on
+ any errors, including message file delivery to the filesystem, message
indexing to Notmuch database, changing tags, and synchronizing tags to
maildir flags. The <b>--keep</b> option may be used to settle for successful
message file delivery.
2009-2016, Carl Worth and many others
</pre>
-<h2>0.22.1</h2>
+<h2>0.23</h2>
2009-2016, Carl Worth and many others
</pre>
-<h2>0.22.1</h2>
+<h2>0.23</h2>
of the current user's email addresses (as configured in primary_mail or
other_email in the .notmuch-config file) in the recipient list.
- It also builds a suitable new subject, including Re: at the front (if
- not already present), and adding the message IDs of the messages being
- replied to to the References list and setting the In-Reply-To: field
+ It also builds a suitable new subject, including Re: at the front (if
+ not already present), and adding the message IDs of the messages being
+ replied to to the References list and setting the In-Reply-To: field
correctly.
- Finally, the original contents of the emails are quoted by prefixing
+ Finally, the original contents of the emails are quoted by prefixing
each line with '> ' and included in the body.
The resulting message template is output to stdout.
<b>--format=</b>(<b>default</b>|<b>json</b>|<b>sexp</b>|<b>headers-only</b>)
<b>default</b>
- Includes subject and quoted message body as an RFC 2822
+ Includes subject and quoted message body as an RFC 2822
message.
- <b>json</b> Produces JSON output containing headers for a reply mes‐
- sage and the contents of the original message. This out‐
- put can be used by a client to create a reply message
+ <b>json</b> Produces JSON output containing headers for a reply mes‐
+ sage and the contents of the original message. This out‐
+ put can be used by a client to create a reply message
intelligently.
- <b>sexp</b> Produces S-Expression output containing headers for a
- reply message and the contents of the original message.
- This output can be used by a client to create a reply
+ <b>sexp</b> Produces S-Expression output containing headers for a
+ reply message and the contents of the original message.
+ This output can be used by a client to create a reply
message intelligently.
<b>headers-only</b>
- Only produces In-Reply-To, References, To, Cc, and Bcc
+ Only produces In-Reply-To, References, To, Cc, and Bcc
headers.
<b>--format-version=N</b>
- Use the specified structured output format version. This is
- intended for programs that invoke <a href='../notmuch-1/'>notmuch</a>(1) internally. If
+ Use the specified structured output format version. This is
+ intended for programs that invoke <a href='../notmuch-1/'>notmuch</a>(1) internally. If
omitted, the latest supported version will be used.
<b>--reply-to=</b>(<b>all</b>|<b>sender</b>)
<b>all</b> <b>(default)</b>
Replies to all addresses.
- <b>sender</b> Replies only to the sender. If replying to user's own
- message (Reply-to: or From: header is one of the user's
+ <b>sender</b> Replies only to the sender. If replying to user's own
+ message (Reply-to: or From: header is one of the user's
configured email addresses), try To:, Cc:, and Bcc: head‐
- ers in this order, and copy values from the first that
+ ers in this order, and copy values from the first that
contains something other than only the user's addresses.
<b>--decrypt</b>
- Decrypt any MIME encrypted parts found in the selected con‐
+ Decrypt any MIME encrypted parts found in the selected con‐
tent (ie. "multipart/encrypted" parts). Status of the decryp‐
- tion will be reported (currently only supported with --for‐
- mat=json and --format=sexp) and on successful decryption the
- multipart/encrypted part will be replaced by the decrypted
+ tion will be reported (currently only supported with --for‐
+ mat=json and --format=sexp) and on successful decryption the
+ multipart/encrypted part will be replaced by the decrypted
content.
- Decryption expects a functioning <b>gpg-agent</b>(1) to provide any
+ Decryption expects a functioning <b>gpg-agent</b>(1) to provide any
needed credentials. Without one, the decryption will fail.
- See <a href='../notmuch-search-terms-7/'>notmuch-search-terms</a>(7) for details of the supported syntax for
+ See <a href='../notmuch-search-terms-7/'>notmuch-search-terms</a>(7) for details of the supported syntax for
<search-terms>.
- Note: It is most common to use <b>notmuch</b> <b>reply</b> with a search string
- matching a single message, (such as id:<message-id>), but it can be
+ Note: It is most common to use <b>notmuch</b> <b>reply</b> with a search string
+ matching a single message, (such as id:<message-id>), but it can be
useful to reply to several messages at once. For example, when a series
- of patches are sent in a single thread, replying to the entire thread
- allows for the reply to comment on issues found in multiple patches.
- The default format supports replying to multiple messages at once, but
+ of patches are sent in a single thread, replying to the entire thread
+ allows for the reply to comment on issues found in multiple patches.
+ The default format supports replying to multiple messages at once, but
the JSON and S-Expression formats do not.
</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-restore-1/'>notmuch-restore</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-restore-1/'>notmuch-restore</a>(1),
<a href='../notmuch-search-1/'>notmuch-search</a>(1), <a href='../notmuch-search-terms-7/'>notmuch-search-terms</a>(7), <a href='../notmuch-show-1/'>notmuch-show</a>(1), <a href='../notmuch-tag-1/'>not‐</a>
<a href='../notmuch-tag-1/'>much-tag</a>(1)
</pre>
2009-2016, Carl Worth and many others
</pre>
-<h2>0.22.1</h2>
+<h2>0.23</h2>
batch-tag format contains no parentheses, should be
accurate.
- <b>--include=(config|tags)</b>
+ <b>--include=(config|properties|tags)</b>
Control what kind of metadata is restored.
<b>config</b>
Restore configuration data to the database. Each configu‐
- ration line starts with "#@ ", followed by a space seper‐
- ated key-value pair. Both key and value are hex encoded
+ ration line starts with "#@ ", followed by a space sepa‐
+ rated key-value pair. Both key and value are hex encoded
if needed.
+ <b>properties</b>
+ Output per-message (key,value) metadata. Each line
+ starts with "#= ", followed by a message id, and a space
+ separated list of key=value pairs. pair. Ids, keys and
+ values are hex encoded if needed.
+
<b>tags</b>
- Output per-message metadata, namely tags. See <u>format</u>
+ Output per-message metadata, namely tags. See <u>format</u>
above for more details.
- The default is to restore both tags and configuration informa‐
- tion
+ The default is to restore all available types of data. The
+ option can be specified multiple times to select some subset.
<b>--input=<filename></b>
Read input from given file instead of stdin.
2009-2016, Carl Worth and many others
</pre>
-<h2>0.22.1</h2>
+<h2>0.23</h2>
2009-2016, Carl Worth and many others
</pre>
-<h2>0.22.1</h2>
+<h2>0.23</h2>
· query:<name>
+ · property:<key>=<value>
+
The <b>from:</b> prefix is used to match the name or address of the sender of
an email message.
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 not‐
much is built with <b>Xapian</b> <b>Field</b> <b>Processors</b> (see below).
+
+ 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.
</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
+ 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. The prefixes currently supported by not‐
much are as follows.
<b>Boolean</b>
- <b>tag:</b>, <b>id:</b>, <b>thread:</b>, <b>folder:</b>, <b>path:</b>
+ <b>tag:</b>, <b>id:</b>, <b>thread:</b>, <b>folder:</b>, <b>path:</b>, <b>property:</b>
<b>Probabilistic</b>
<b>from:</b>, <b>to:</b>, <b>subject:</b>, <b>attachment:</b>, <b>mimetype:</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 equivalant ways to write the same phrase.
· "a list of words"
<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
+ 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, 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
for clarity.
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
<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
+ 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
2009-2016, Carl Worth and many others
</pre>
-<h2>0.22.1</h2>
+<h2>0.23</h2>
2009-2016, Carl Worth and many others
</pre>
-<h2>0.22.1</h2>
+<h2>0.23</h2>
2009-2016, Carl Worth and many others
</pre>
-<h2>0.22.1</h2>
+<h2>0.23</h2>
projects / notmuch-wiki / commitdiff