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