git.notmuchmail.org Git - notmuch/blob - doc/man7/notmuch-search-terms.rst

   1 ====================
   2 notmuch-search-terms
   3 ====================
   4
   5 SYNOPSIS
   6 ========
   7
   8 **notmuch** **count** [option ...] <*search-term*> ...
   9
  10 **notmuch** **dump** [--format=(batch-tag|sup)] [--] [--output=<*file*>] [--] [<*search-term*> ...]
  11
  12 **notmuch** **search** [option ...] <*search-term*> ...
  13
  14 **notmuch** **show** [option ...] <*search-term*> ...
  15
  16 **notmuch** **tag** +<*tag*> ... -<*tag*> [--] <*search-term*> ...
  17
  18 DESCRIPTION
  19 ===========
  20
  21 Several notmuch commands accept a common syntax for search terms.
  22
  23 The search terms can consist of free-form text (and quoted phrases)
  24 which will match all messages that contain all of the given
  25 terms/phrases in the body, the subject, or any of the sender or
  26 recipient headers.
  27
  28 As a special case, a search string consisting of exactly a single
  29 asterisk ("\*") will match all messages.
  30
  31 In addition to free text, the following prefixes can be used to force
  32 terms to match against specific portions of an email, (where <brackets>
  33 indicate user-supplied values):
  34
  35 -  from:<name-or-address>
  36
  37 -  to:<name-or-address>
  38
  39 -  subject:<word-or-quoted-phrase>
  40
  41 -  attachment:<word>
  42
  43 -  mimetype:<word>
  44
  45 -  tag:<tag> (or is:<tag>)
  46
  47 -  id:<message-id>
  48
  49 -  thread:<thread-id>
  50
  51 -  folder:<maildir-folder>
  52
  53 -  path:<directory-path> or path:<directory-path>/**
  54
  55 -  date:<since>..<until>
  56
  57 The **from:** prefix is used to match the name or address of the sender
  58 of an email message.
  59
  60 The **to:** prefix is used to match the names or addresses of any
  61 recipient of an email message, (whether To, Cc, or Bcc).
  62
  63 Any term prefixed with **subject:** will match only text from the
  64 subject of an email. Searching for a phrase in the subject is supported
  65 by including quotation marks around the phrase, immediately following
  66 **subject:**.
  67
  68 The **attachment:** prefix can be used to search for specific filenames
  69 (or extensions) of attachments to email messages.
  70
  71 The **mimetype:** prefix will be used to match text from the
  72 content-types of MIME parts within email messages (as specified by the
  73 sender).
  74
  75 For **tag:** and **is:** valid tag values include **inbox** and
  76 **unread** by default for new messages added by **notmuch new** as well
  77 as any other tag values added manually with **notmuch tag**.
  78
  79 For **id:**, message ID values are the literal contents of the
  80 Message-ID: header of email messages, but without the '<', '>'
  81 delimiters.
  82
  83 The **thread:** prefix can be used with the thread ID values that are
  84 generated internally by notmuch (and do not appear in email messages).
  85 These thread ID values can be seen in the first column of output from
  86 **notmuch search**
  87
  88 The **path:** prefix searches for email messages that are in
  89 particular directories within the mail store. The directory must be
  90 specified relative to the top-level maildir (and without the leading
  91 slash). By default, **path:** matches messages in the specified
  92 directory only. The "/\*\*" suffix can be used to match messages in
  93 the specified directory and all its subdirectories recursively.
  94 **path:""** matches messages in the root of the mail store and,
  95 likewise, **path:\*\*** matches all messages.
  96
  97 The **folder:** prefix searches for email messages by maildir or MH
  98 folder. For MH-style folders, this is equivalent to **path:**. For
  99 maildir, this includes messages in the "new" and "cur"
 100 subdirectories. The exact syntax for maildir folders depends on your
 101 mail configuration. For maildir++, **folder:""** matches the inbox
 102 folder (which is the root in maildir++), other folder names always
 103 start with ".", and nested folders are separated by "."s, such as
 104 **folder:.classes.topology**. For "file system" maildir, the inbox is
 105 typically **folder:INBOX** and nested folders are separated by
 106 slashes, such as **folder:classes/topology**.
 107
 108 Both **path:** and **folder:** will find a message if *any* copy of
 109 that message is in the specific directory/folder.
 110
 111 The **date:** prefix can be used to restrict the results to only
 112 messages within a particular time range (based on the Date: header) with
 113 a range syntax of:
 114
 115 date:<since>..<until>
 116
 117 See **DATE AND TIME SEARCH** below for details on the range expression,
 118 and supported syntax for <since> and <until> date and time expressions.
 119
 120 The time range can also be specified using timestamps with a syntax of:
 121
 122 <initial-timestamp>..<final-timestamp>
 123
 124 Each timestamp is a number representing the number of seconds since
 125 1970-01-01 00:00:00 UTC.
 126
 127 In addition to individual terms, multiple terms can be combined with
 128 Boolean operators ( **and**, **or**, **not** , etc.). Each term in the
 129 query will be implicitly connected by a logical AND if no explicit
 130 operator is provided, (except that terms with a common prefix will be
 131 implicitly combined with OR until we get Xapian defect #402 fixed).
 132
 133 Parentheses can also be used to control the combination of the Boolean
 134 operators, but will have to be protected from interpretation by the
 135 shell, (such as by putting quotation marks around any parenthesized
 136 expression).
 137
 138 Boolean and Probabilistic Prefixes
 139 ----------------------------------
 140
 141 Xapian (and hence notmuch) prefixes are either **boolean**, supporting
 142 exact matches like "tag:inbox"  or **probabilistic**, supporting a most flexible **term** based searching. The prefixes currently supported by notmuch are as follows.
 143
 144 +------------------+-----------------------+
 145 |Boolean           |Probabilistic          |
 146 +------------------+-----------------------+
 147 | **tag:** **id:** | **from:** **to:**     |
 148 |**thread:**       |**subject:**           |
 149 |**folder:**       |**attachment**         |
 150 |**path:**         |                       |
 151 |                  |                       |
 152 +------------------+-----------------------+
 153
 154 Terms and phrases
 155 -----------------
 156
 157 In general Xapian distinguishes between lists of terms and
 158 **phrases**. Phrases are indicated by double quotes (but beware you
 159 probably need to protect those from your shell) and insist that those
 160 unstemmed words occur in that order. One useful, but initially
 161 surprising feature is that the following are equivalant ways to write
 162 the same phrase.
 163
 164 - "a list of words"
 165 - a-list-of-words
 166 - a/list/of/words
 167 - a.list.of.words
 168
 169 Both parenthesised lists of terms and quoted phrases are ok with
 170 probabilisitic prefixes such as **to:**, **from:**, and **subject:**. In particular
 171
 172 ::
 173
 174    subject:(pizza free)
 175
 176 is equivalent to
 177
 178 ::
 179
 180    subject:pizza and subject:free
 181
 182 Both of these will match a subject "Free Delicious Pizza" while
 183
 184 ::
 185
 186    subject:"pizza free"
 187
 188 will not.
 189
 190 DATE AND TIME SEARCH
 191 ====================
 192
 193 notmuch understands a variety of standard and natural ways of expressing
 194 dates and times, both in absolute terms ("2012-10-24") and in relative
 195 terms ("yesterday"). Any number of relative terms can be combined ("1
 196 hour 25 minutes") and an absolute date/time can be combined with
 197 relative terms to further adjust it. A non-exhaustive description of the
 198 syntax supported for absolute and relative terms is given below.
 199
 200 The range expression
 201 --------------------
 202
 203 date:<since>..<until>
 204
 205 The above expression restricts the results to only messages from <since>
 206 to <until>, based on the Date: header.
 207
 208 <since> and <until> can describe imprecise times, such as "yesterday".
 209 In this case, <since> is taken as the earliest time it could describe
 210 (the beginning of yesterday) and <until> is taken as the latest time it
 211 could describe (the end of yesterday). Similarly, date:january..february
 212 matches from the beginning of January to the end of February.
 213
 214 Currently, we do not support spaces in range expressions. You can
 215 replace the spaces with '\_', or (in most cases) '-', or (in some cases)
 216 leave the spaces out altogether. Examples in this man page use spaces
 217 for clarity.
 218
 219 Open-ended ranges are supported (since Xapian 1.2.1), i.e. it's possible
 220 to specify date:..<until> or date:<since>.. to not limit the start or
 221 end time, respectively. Pre-1.2.1 Xapian does not report an error on
 222 open ended ranges, but it does not work as expected either.
 223
 224 Entering date:expr without ".." (for example date:yesterday) won't work,
 225 as it's not interpreted as a range expression at all. You can achieve
 226 the expected result by duplicating the expr both sides of ".." (for
 227 example date:yesterday..yesterday).
 228
 229 Relative date and time
 230 ----------------------
 231
 232 [N\|number]
 233 (years\|months\|weeks\|days\|hours\|hrs\|minutes\|mins\|seconds\|secs)
 234 [...]
 235
 236 All refer to past, can be repeated and will be accumulated.
 237
 238 Units can be abbreviated to any length, with the otherwise ambiguous
 239 single m being m for minutes and M for months.
 240
 241 Number can also be written out one, two, ..., ten, dozen, hundred.
 242 Additionally, the unit may be preceded by "last" or "this" (e.g., "last
 243 week" or "this month").
 244
 245 When combined with absolute date and time, the relative date and time
 246 specification will be relative from the specified absolute date and
 247 time.
 248
 249 Examples: 5M2d, two weeks
 250
 251 Supported absolute time formats
 252 -------------------------------
 253
 254 -  H[H]:MM[:SS] [(am\|a.m.\|pm\|p.m.)]
 255
 256 -  H[H] (am\|a.m.\|pm\|p.m.)
 257
 258 -  HHMMSS
 259
 260 -  now
 261
 262 -  noon
 263
 264 -  midnight
 265
 266 -  Examples: 17:05, 5pm
 267
 268 Supported absolute date formats
 269 -------------------------------
 270
 271 -  YYYY-MM[-DD]
 272
 273 -  DD-MM[-[YY]YY]
 274
 275 -  MM-YYYY
 276
 277 -  M[M]/D[D][/[YY]YY]
 278
 279 -  M[M]/YYYY
 280
 281 -  D[D].M[M][.[YY]YY]
 282
 283 -  D[D][(st\|nd\|rd\|th)] Mon[thname] [YYYY]
 284
 285 -  Mon[thname] D[D][(st\|nd\|rd\|th)] [YYYY]
 286
 287 -  Wee[kday]
 288
 289 Month names can be abbreviated at three or more characters.
 290
 291 Weekday names can be abbreviated at three or more characters.
 292
 293 Examples: 2012-07-31, 31-07-2012, 7/31/2012, August 3
 294
 295 Time zones
 296 ----------
 297
 298 -  (+\|-)HH:MM
 299
 300 -  (+\|-)HH[MM]
 301
 302 Some time zone codes, e.g. UTC, EET.
 303
 304 SEE ALSO
 305 ========
 306
 307 **notmuch(1)**, **notmuch-config(1)**, **notmuch-count(1)**,
 308 **notmuch-dump(1)**, **notmuch-hooks(5)**, **notmuch-insert(1)**,
 309 **notmuch-new(1)**, **notmuch-reply(1)**, **notmuch-restore(1)**,
 310 **notmuch-search(1)**, **notmuch-show(1)**, **notmuch-tag(1)**