git.notmuchmail.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=(json|sexp|text|text0)</b>
  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  <b>xargs</b>(1)  -0 option
  27                  where 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)</b>
  35               Controls which information appears in the  output.  This  option
  36               can  be given multiple times to combine different outputs.  When
  37               neither --output=sender nor --output=recipients is given, --out‐
  38               put=sender 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>--deduplicate=(no|mailbox|address)</b>
  57               Control the deduplication of results.
  58
  59               <b>no</b>     Output all occurences of addresses in the  matching  mes‐
  60                      sages. This is not applicable with --output=count.
  61
  62               <b>mailbox</b>
  63                      Deduplicate  addresses  based on the full, case sensitive
  64                      name and email address, or mailbox. This  is  effectively
  65                      the  same as piping the --deduplicate=no output to <b>sort</b> <b>|</b>
  66                      <b>uniq</b>, except for  the  order  of  results.  This  is  the
  67                      default.
  68
  69               <b>address</b>
  70                      Deduplicate  addresses  based  on  the  case  insensitive
  71                      address part of the mailbox. Of all  the  variants  (with
  72                      different  name  or  case),  print the one occurring most
  73                      frequently among the matching messages. If --output=count
  74                      is specified, include all variants in the count.
  75
  76           <b>--sort=(newest-first|oldest-first)</b>
  77                  This  option can be used to present results in either chrono‐
  78                  logical order (<b>oldest-first</b>) or reverse  chronological  order
  79                  (<b>newest-first</b>).
  80
  81                  By  default, results will be displayed in reverse chronologi‐
  82                  cal order, (that is, the newest  results  will  be  displayed
  83                  first).
  84
  85                  However, if either --output=count or --deduplicate=address is
  86                  specified, this option  is  ignored  and  the  order  of  the
  87                  results is unspecified.
  88
  89           <b>--exclude=(true|false)</b>
  90                  A message is called &quot;excluded&quot; if it matches at least one tag
  91                  in search.tag_exclude that does not appear explicitly in  the
  92                  search  terms. This option specifies whether to omit excluded
  93                  messages in the search process.
  94
  95                  The default value,  <b>true</b>,  prevents  excluded  messages  from
  96                  matching the search terms.
  97
  98                  <b>false</b>  allows  excluded  messages  to  match search terms and
  99                  appear in displayed results.
 100 </pre>
 101
 102 <h2>EXIT STATUS</h2>
 103 <pre>
 104        This command supports the following special exit status codes
 105
 106        <b>20</b>     The requested format version is too old.
 107
 108        <b>21</b>     The requested format version is too new.
 109 </pre>
 110
 111 <h2>SEE ALSO</h2>
 112 <pre>
 113        <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>
 114        <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),
 115        <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>
 116        <a href='../notmuch-tag-1/'>much-tag</a>(1), <a href='../notmuch-search-1/'>notmuch-search</a>(1)
 117 </pre>
 118
 119 <h2>AUTHOR</h2>
 120 <pre>
 121        Carl Worth and many others
 122 </pre>
 123
 124 <h2>COPYRIGHT</h2>
 125 <pre>
 126        2009-2016, Carl Worth and many others
 127 </pre>
 128
 129 <h2>0.23.4</h2>