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

   1 ===============
   2 notmuch-address
   3 ===============
   4
   5 SYNOPSIS
   6 ========
   7
   8 **notmuch** **address** [*option* ...] <*search-term*> ...
   9
  10 DESCRIPTION
  11 ===========
  12
  13 Search for messages matching the given search terms, and display the
  14 addresses from them.
  15
  16 See **notmuch-search-terms(7)** for details of the supported syntax for
  17 <search-terms>.
  18
  19 Supported options for **address** include
  20
  21     ``--format=``\ (**json**\ \|\ **sexp**\ \|\ **text**\ \|\ **text0**)
  22         Presents the results in either JSON, S-Expressions, newline
  23         character separated plain-text (default), or null character
  24         separated plain-text (compatible with **xargs(1)** -0 option
  25         where available).
  26
  27     ``--format-version=N``
  28         Use the specified structured output format version. This is
  29         intended for programs that invoke **notmuch(1)** internally. If
  30         omitted, the latest supported version will be used.
  31
  32     ``--output=(sender|recipients)``
  33
  34         Controls which information appears in the output. This option
  35         can be given multiple times to combine different outputs.
  36         Omitting this option is equivalent to
  37         --output=sender --output=recipients.
  38
  39         **sender**
  40             Output all addresses from the *From* header.
  41
  42             Note: Searching for **sender** should be much faster than
  43             searching for **recipients**, because sender addresses are
  44             cached directly in the database whereas other addresses
  45             need to be fetched from message files.
  46
  47         **recipients**
  48             Output all addresses from the *To*, *Cc* and *Bcc*
  49             headers.
  50
  51     ``--sort=``\ (**newest-first**\ \|\ **oldest-first**)
  52         This option can be used to present results in either
  53         chronological order (**oldest-first**) or reverse chronological
  54         order (**newest-first**).
  55
  56         By default, results will be displayed in reverse chronological
  57         order, (that is, the newest results will be displayed first).
  58
  59     ``--exclude=(true|false)``
  60         A message is called "excluded" if it matches at least one tag in
  61         search.tag\_exclude that does not appear explicitly in the
  62         search terms. This option specifies whether to omit excluded
  63         messages in the search process.
  64
  65         The default value, **true**, prevents excluded messages from
  66         matching the search terms.
  67
  68         **false** allows excluded messages to match search terms and
  69         appear in displayed results.
  70
  71 EXIT STATUS
  72 ===========
  73
  74 This command supports the following special exit status codes
  75
  76 ``20``
  77     The requested format version is too old.
  78
  79 ``21``
  80     The requested format version is too new.
  81
  82 SEE ALSO
  83 ========
  84
  85 **notmuch(1)**, **notmuch-config(1)**, **notmuch-count(1)**,
  86 **notmuch-dump(1)**, **notmuch-hooks(5)**, **notmuch-insert(1)**,
  87 **notmuch-new(1)**, **notmuch-reply(1)**, **notmuch-restore(1)**,
  88 **notmuch-search-terms(7)**, **notmuch-show(1)**, **notmuch-tag(1)**,
  89 ***notmuch-search(1)**