X-Git-Url: https://git.cworth.org/git?a=blobdiff_plain;f=manpages%2Fnotmuch-search-terms-7.mdwn;h=e46c6b5e9d024f942e882bb74d8b954da719a911;hb=edc130b91717dd825c911fdc18f4051dcd2c8896;hp=ccc203fabb444d2ddaf1cdb54faa31f4c95ca58d;hpb=39aab76514c6f6f2b6769b9fd45fd9570664fa49;p=notmuch-wiki diff --git a/manpages/notmuch-search-terms-7.mdwn b/manpages/notmuch-search-terms-7.mdwn index ccc203f..e46c6b5 100644 --- a/manpages/notmuch-search-terms-7.mdwn +++ b/manpages/notmuch-search-terms-7.mdwn @@ -9,9 +9,11 @@
notmuch count [option ...] <search-term> ... - notmuch dump [--format=(batch-tag|sup)] [--] [--output=<file>] [--] + notmuch dump [--gzip] [--format=(batch-tag|sup)] [--output=<file>] [--] [<search-term> ...] + notmuch reindex [option ...] <search-term> ... + notmuch search [option ...] <search-term> ... notmuch show [option ...] <search-term> ... @@ -30,112 +32,145 @@ As a special case, a search string consisting of exactly a single asterisk ("*") will match all messages. ++
In addition to free text, the following prefixes can be used to force terms to match against specific portions of an email, (where <brackets> - indicate user-supplied values): - - · from:<name-or-address> - - · to:<name-or-address> - - · subject:<word-or-quoted-phrase> - - · attachment:<word> - - · mimetype:<word> - - · tag:<tag> (or is:<tag>) - - · id:<message-id> - - · thread:<thread-id> - - · folder:<maildir-folder> - - · path:<directory-path> or path:<directory-path>/** - - · date:<since>..<until> - - · lastmod:<initial-revision>..<final-revision> - - · query:<name> - - The from: prefix is used to match the name or address of the sender of - an email message. - - The to: prefix is used to match the names or addresses of any recipient - of an email message, (whether To, Cc, or Bcc). - - Any term prefixed with subject: 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, immediately following sub- - ject:. - - The attachment: prefix can be used to search for specific filenames (or - extensions) of attachments to email messages. - - The mimetype: prefix will be used to match text from the content-types - of MIME parts within email messages (as specified by the sender). - - For tag: and is: valid tag values include inbox and unread by default - for new messages added by notmuch new as well as any other tag values - added manually with notmuch tag. - - For id:, message ID values are the literal contents of the Message-ID: - header of email messages, but without the '<', '>' delimiters. - - The thread: prefix can be used with the thread ID values that are genâ - erated internally by notmuch (and do not appear in email messages). - These thread ID values can be seen in the first column of output from - notmuch search - - The path: prefix searches for email messages that are in particular - directories within the mail store. The directory must be specified relâ - ative to the top-level maildir (and without the leading slash). By - default, path: matches messages in the specified directory only. The - "/**" suffix can be used to match messages in the specified directory - and all its subdirectories recursively. path:"" matches messages in - the root of the mail store and, likewise, path:** matches all messages. - - The folder: prefix searches for email messages by maildir or MH folder. - For MH-style folders, this is equivalent to path:. For maildir, this - includes messages in the "new" and "cur" subdirectories. The exact synâ - tax for maildir folders depends on your mail configuration. For - maildir++, folder:"" matches the inbox folder (which is the root in - maildir++), other folder names always start with ".", and nested foldâ - ers are separated by "."s, such as folder:.classes.topology. For "file - system" maildir, the inbox is typically folder:INBOX and nested folders - are separated by slashes, such as folder:classes/topology. - - Both path: and folder: will find a message if any copy of that message - is in the specific directory/folder. - - The date: prefix can be used to restrict the results to only messages - within a particular time range (based on the Date: header) with a range - syntax of: - - date:<since>..<until> - - See DATE AND TIME SEARCH below for details on the range expression, and - supported syntax for <since> and <until> date and time expressions. - - The time range can also be specified using timestamps with 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. - - The lastmod: 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 conjuncâ - tion with the --uuid argument to notmuch search to find messages that - have changed since an earlier query. - - The query: prefix allows queries to refer to previously saved queries - added with notmuch-config(1). Named queries are only available if notâ - much is built with Xapian Field Processors (see below). + indicate user-supplied values). + + If notmuch is built with Xapian Field Processors (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 + regex(7)) delimited with //, for example: + + notmuch search 'from:"/bob@.*[.]example[.]com/"' + + body:<word-or-quoted-phrase> + Match terms in the body of messages. + + from:<name-or-address> or from:/<regex>/ + The from: prefix is used to match the name or address of the + sender of an email message. + + to:<name-or-address> + The to: prefix is used to match the names or addresses of any + recipient of an email message, (whether To, Cc, or Bcc). + + subject:<word-or-quoted-phrase> or subject:/<regex>/ + Any term prefixed with subject: 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 subject:. + + attachment:<word> + The attachment: prefix can be used to search for specific fileâ + names (or extensions) of attachments to email messages. + + mimetype:<word> + The mimetype: prefix will be used to match text from the conâ + tent-types of MIME parts within email messages (as specified by + the sender). + + tag:<tag> or tag:/<regex>/ or is:<tag> or is:/<regex>/ + For tag: and is: valid tag values include inbox and unread by + default for new messages added by notmuch new as well as any + other tag values added manually with notmuch tag. + + id:<message-id> or mid:<message-id> or mid:/<regex>/ + For id: and mid:, message ID values are the literal contents of + the Message-ID: header of email messages, but without the '<', + '>' delimiters. + + thread:<thread-id> + The thread: 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 notmuch search + + thread:{<notmuch query>} + If notmuch is built with Xapian Field Processors (see below), + threads may be searched for indirectly by providing an arbitrary + notmuch query in {}. 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 thread:{<something>} as + expanding to all of the thread IDs which match <something>; notâ + much then performs a second search using the expanded query. + + path:<directory-path> or path:<directory-path>/** or path:/<regex>/ + The path: 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 + leading slash). By default, path: 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. path:"" matches messages in the root of the mail + store and, likewise, path:** matches all messages. + + path: will find a message if any copy of that message is in the + specific directory. + + folder:<maildir-folder> or folder:/<regex>/ + The folder: prefix searches for email messages by maildir or MH + folder. For MH-style folders, this is equivalent to path:. 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++, folder:"" matches the inbox + folder (which is the root in maildir++), other folder names + always start with ".", and nested folders are separated by "."s, + such as folder:.classes.topology. For "file system" maildir, the + inbox is typically folder:INBOX and nested folders are separated + by slashes, such as folder:classes/topology. + + folder: will find a message if any copy of that message is in + the specific folder. + + date:<since>..<until> or date:<date> + The date: prefix can be used to restrict the results to only + messages within a particular time range (based on the Date: + header). + + See DATE AND TIME SEARCH 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 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. Specifying a time range this way + is considered legacy and predates the date prefix. + + lastmod:<initial-revision>..<final-revision> + The lastmod: 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 --uuid argument to notmuch search + to find messages that have changed since an earlier query. + + query:<name> + The query: prefix allows queries to refer to previously saved + queries added with notmuch-config(1). Named queries are only + available if notmuch is built with Xapian Field Processors (see + below). + + property:<key>=<value> + The property: 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 notmuch-properties(7) for more details. + + User defined prefixes are also supported, see notmuch-config(1) for + details.
Xapian (and hence notmuch) prefixes are either boolean, supporting exact matches like "tag:inbox" or probabilistic, supporting a more - flexible term based searching. The prefixes currently supported by notâ - much are as follows. + flexible term based searching. Certain special 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. Boolean - tag:, id:, thread:, folder:, path: + tag:, id:, thread:, folder:, path:, property: Probabilistic - from:, to:, subject:, attachment:, mimetype: + body:, to:, attachment:, mimetype: + + Special + from:, query:, subject:
- In general Xapian distinguishes between lists of terms and phrases. + In general Xapian distinguishes between lists of terms and phrases. 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 - that the following are equivalant ways to write the same phrase. + 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" @@ -227,7 +266,7 @@ · a.list.of.words Both parenthesised lists of terms and quoted phrases are ok with probaâ - bilisitic prefixes such as to:, from:, and subject:. In particular + bilistic prefixes such as to:, from:, and subject:. In particular subject:(pizza free) @@ -242,6 +281,25 @@ will not.+
+ 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}' ++
notmuch understands a variety of standard and natural ways of expressâ @@ -265,14 +323,20 @@ 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 Xapian Field Processor support (see below), non-range - date queries such as date:yesterday will work, but otherwise will give + 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 Xapian Field Processor 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. @@ -290,15 +354,15 @@ 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 @@ -359,9 +423,9 @@XAPIAN FIELD PROCESSORS
- 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 @@ -371,13 +435,18 @@ · 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}"SEE ALSO
notmuch(1), notmuch-config(1), notmuch-count(1), notmuch-dump(1), notâ - much-hooks(5), notmuch-insert(1), notmuch-new(1), notmuch-reply(1), - notmuch-restore(1), notmuch-search(1), notmuch-show(1), notmuch-tag(1) + much-hooks(5), notmuch-insert(1), notmuch-new(1), notmuch-reindex(1), + notmuch-properties(1), *notmuch-reply(1), notmuch-restore(1), notâ + much-search(1), *notmuch-show(1), notmuch-tag(1)AUTHOR
@@ -387,7 +456,7 @@COPYRIGHT
- 2009-2016, Carl Worth and many others + 2009-2019, Carl Worth and many others-0.22
+0.29