git.cworth.org Git - notmuch-wiki/blob - manpages/notmuch-address-1.mdwn

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