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

   1 ==============
   2 notmuch-search
   3 ==============
   4
   5 SYNOPSIS
   6 ========
   7
   8 **notmuch** **search** [*option* ...] <*search-term*> ...
   9
  10 DESCRIPTION
  11 ===========
  12
  13 Search for messages matching the given search terms, and display as
  14 results the threads containing the matched messages.
  15
  16 The output consists of one line per thread, giving a thread ID, the date
  17 of the newest (or oldest, depending on the sort option) matched message
  18 in the thread, the number of matched messages and total messages in the
  19 thread, the names of all participants in the thread, and the subject of
  20 the newest (or oldest) message.
  21
  22 See **notmuch-search-terms(7)** for details of the supported syntax for
  23 <search-terms>.
  24
  25 Supported options for **search** include
  26
  27     ``--format=``\ (**json**\ \|\ **sexp**\ \|\ **text**\ \|\ **text0**)
  28         Presents the results in either JSON, S-Expressions, newline
  29         character separated plain-text (default), or null character
  30         separated plain-text (compatible with **xargs(1)** -0 option
  31         where available).
  32
  33     ``--format-version=N``
  34         Use the specified structured output format version. This is
  35         intended for programs that invoke **notmuch(1)** internally. If
  36         omitted, the latest supported version will be used.
  37
  38     ``--output=(summary|threads|messages|files|tags|sender|recipients)``
  39
  40         **summary**
  41             Output a summary of each thread with any message matching
  42             the search terms. The summary includes the thread ID, date,
  43             the number of messages in the thread (both the number
  44             matched and the total number), the authors of the thread and
  45             the subject.
  46
  47         **threads**
  48             Output the thread IDs of all threads with any message
  49             matching the search terms, either one per line
  50             (--format=text), separated by null characters
  51             (--format=text0), as a JSON array (--format=json), or an
  52             S-Expression list (--format=sexp).
  53
  54         **messages**
  55             Output the message IDs of all messages matching the search
  56             terms, either one per line (--format=text), separated by
  57             null characters (--format=text0), as a JSON array
  58             (--format=json), or as an S-Expression list (--format=sexp).
  59
  60         **files**
  61             Output the filenames of all messages matching the search
  62             terms, either one per line (--format=text), separated by
  63             null characters (--format=text0), as a JSON array
  64             (--format=json), or as an S-Expression list (--format=sexp).
  65
  66             Note that each message may have multiple filenames
  67             associated with it. All of them are included in the output
  68             (unless limited with the --duplicate=N option). This may
  69             be particularly confusing for **folder:** or **path:**
  70             searches in a specified directory, as the messages may
  71             have duplicates in other directories that are included in
  72             the output, although these files alone would not match the
  73             search.
  74
  75         **tags**
  76             Output all tags that appear on any message matching the
  77             search terms, either one per line (--format=text), separated
  78             by null characters (--format=text0), as a JSON array
  79             (--format=json), or as an S-Expression list (--format=sexp).
  80
  81         **sender**
  82             Output all addresses from the *From* header that appear on
  83             any message matching the search terms, either one per line
  84             (--format=text), separated by null characters
  85             (--format=text0), as a JSON array (--format=json), or as
  86             an S-Expression list (--format=sexp).
  87
  88             Note: Searching for **sender** should be much faster than
  89             searching for **recipients**, because sender addresses are
  90             cached directly in the database whereas other addresses
  91             need to be fetched from message files.
  92
  93         **recipients**
  94             Like **sender** but for addresses from *To*, *Cc* and
  95             *Bcc* headers.
  96
  97         This option can be given multiple times to combine different
  98         outputs. Currently, this is only supported for **sender** and
  99         **recipients** outputs.
 100
 101     ``--sort=``\ (**newest-first**\ \|\ **oldest-first**)
 102         This option can be used to present results in either
 103         chronological order (**oldest-first**) or reverse chronological
 104         order (**newest-first**).
 105
 106         Note: The thread order will be distinct between these two
 107         options (beyond being simply reversed). When sorting by
 108         **oldest-first** the threads will be sorted by the oldest
 109         message in each thread, but when sorting by **newest-first** the
 110         threads will be sorted by the newest message in each thread.
 111
 112         By default, results will be displayed in reverse chronological
 113         order, (that is, the newest results will be displayed first).
 114
 115     ``--offset=[-]N``
 116         Skip displaying the first N results. With the leading '-', start
 117         at the Nth result from the end.
 118
 119     ``--limit=N``
 120         Limit the number of displayed results to N.
 121
 122     ``--exclude=(true|false|all|flag)``
 123         A message is called "excluded" if it matches at least one tag in
 124         search.tag\_exclude that does not appear explicitly in the
 125         search terms. This option specifies whether to omit excluded
 126         messages in the search process.
 127
 128         The default value, **true**, prevents excluded messages from
 129         matching the search terms.
 130
 131         **all** additionally prevents excluded messages from appearing
 132         in displayed results, in effect behaving as though the excluded
 133         messages do not exist.
 134
 135         **false** allows excluded messages to match search terms and
 136         appear in displayed results. Excluded messages are still marked
 137         in the relevant outputs.
 138
 139         **flag** only has an effect when ``--output=summary``. The
 140         output is almost identical to **false**, but the "match count"
 141         is the number of matching non-excluded messages in the thread,
 142         rather than the number of matching messages.
 143
 144     ``--duplicate=N``
 145         For ``--output=files``, output the Nth filename associated
 146         with each message matching the query (N is 1-based). If N is
 147         greater than the number of files associated with the message,
 148         don't print anything.
 149
 150         For ``--output=messages``, only output message IDs of messages
 151         matching the search terms that have at least N filenames
 152         associated with them.
 153
 154         Note that this option is orthogonal with the **folder:** search
 155         prefix. The prefix matches messages based on filenames. This
 156         option filters filenames of the matching messages.
 157
 158 EXIT STATUS
 159 ===========
 160
 161 This command supports the following special exit status codes
 162
 163 ``20``
 164     The requested format version is too old.
 165
 166 ``21``
 167     The requested format version is too new.
 168
 169 SEE ALSO
 170 ========
 171
 172 **notmuch(1)**, **notmuch-config(1)**, **notmuch-count(1)**,
 173 **notmuch-dump(1)**, **notmuch-hooks(5)**, **notmuch-insert(1)**,
 174 **notmuch-new(1)**, **notmuch-reply(1)**, **notmuch-restore(1)**,
 175 **notmuch-search-terms(7)**, **notmuch-show(1)**, **notmuch-tag(1)**