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

   1 .. _notmuch-address(1):
   2
   3 ===============
   4 notmuch-address
   5 ===============
   6
   7 SYNOPSIS
   8 ========
   9
  10 **notmuch** **address** [*option* ...] <*search-term*> ...
  11
  12 DESCRIPTION
  13 ===========
  14
  15 Search for messages matching the given search terms, and display the
  16 addresses from them. Duplicate addresses are filtered out.
  17
  18 See :any:`notmuch-search-terms(7)` for details of the supported syntax for
  19 <search-terms>.
  20
  21 Supported options for **address** include
  22
  23 ``--format=``\ (**json**\ \|\ **sexp**\ \|\ **text**\ \|\ **text0**)
  24     Presents the results in either JSON, S-Expressions, newline
  25     character separated plain-text (default), or null character
  26     separated plain-text (compatible with :manpage:`xargs(1)` -0
  27     option where available).
  28
  29 ``--format-version=N``
  30     Use the specified structured output format version. This is
  31     intended for programs that invoke :any:`notmuch(1)` internally. If
  32     omitted, the latest supported version will be used.
  33
  34 ``--output=(sender|recipients|count|address)``
  35     Controls which information appears in the output. This option can
  36     be given multiple times to combine different outputs.  When
  37     neither ``--output=sender`` nor ``--output=recipients`` is
  38     given, ``--output=sender`` is implied.
  39
  40     **sender**
  41         Output all addresses from the *From* header.
  42
  43         Note: Searching for **sender** should be much faster than
  44         searching for **recipients**, because sender addresses are
  45         cached directly in the database whereas other addresses need
  46         to be fetched from message files.
  47
  48     **recipients**
  49         Output all addresses from the *To*, *Cc* and *Bcc* headers.
  50
  51     **count**
  52         Print the count of how many times was the address encountered
  53         during search.
  54
  55         Note: With this option, addresses are printed only after the
  56         whole search is finished. This may take long time.
  57
  58     **address**
  59         Output only the email addresses instead of the full mailboxes
  60         with names and email addresses. This option has no effect on
  61         the JSON or S-Expression output formats.
  62
  63 ``--deduplicate=(no|mailbox|address)``
  64     Control the deduplication of results.
  65
  66     **no**
  67         Output all occurrences of addresses in the matching
  68         messages. This is not applicable with ``--output=count``.
  69
  70     **mailbox**
  71         Deduplicate addresses based on the full, case sensitive name
  72         and email address, or mailbox. This is effectively the same as
  73         piping the ``--deduplicate=no`` output to **sort | uniq**, except
  74         for the order of results. This is the default.
  75
  76     **address**
  77         Deduplicate addresses based on the case insensitive address
  78         part of the mailbox. Of all the variants (with different name
  79         or case), print the one occurring most frequently among the
  80         matching messages. If ``--output=count`` is specified, include all
  81         variants in the count.
  82
  83 ``--sort=``\ (**newest-first**\ \|\ **oldest-first**)
  84     This option can be used to present results in either chronological
  85     order (**oldest-first**) or reverse chronological order
  86     (**newest-first**).
  87
  88     By default, results will be displayed in reverse chronological
  89     order, (that is, the newest results will be displayed first).
  90
  91     However, if either ``--output=count`` or ``--deduplicate=address`` is
  92     specified, this option is ignored and the order of the results is
  93     unspecified.
  94
  95 ``--exclude=(true|false)``
  96     A message is called "excluded" if it matches at least one tag in
  97     search.exclude\_tags that does not appear explicitly in the search
  98     terms. This option specifies whether to omit excluded messages in
  99     the search process.
 100
 101     The default value, **true**, prevents excluded messages from
 102     matching the search terms.
 103
 104     **false** allows excluded messages to match search terms and
 105     appear in displayed results.
 106
 107 EXIT STATUS
 108 ===========
 109
 110 This command supports the following special exit status codes
 111
 112 ``20``
 113     The requested format version is too old.
 114
 115 ``21``
 116     The requested format version is too new.
 117
 118 SEE ALSO
 119 ========
 120
 121 :any:`notmuch(1)`,
 122 :any:`notmuch-config(1)`,
 123 :any:`notmuch-count(1)`,
 124 :any:`notmuch-dump(1)`,
 125 :any:`notmuch-hooks(5)`,
 126 :any:`notmuch-insert(1)`,
 127 :any:`notmuch-new(1)`,
 128 :any:`notmuch-reply(1)`,
 129 :any:`notmuch-restore(1)`,
 130 :any:`notmuch-search(1)`,
 131 :any:`notmuch-search-terms(7)`,
 132 :any:`notmuch-show(1)`,
 133 :any:`notmuch-tag(1)`