1NOTMUCH-ADDRESS(1) notmuch NOTMUCH-ADDRESS(1)
2
6 notmuch-address - output addresses from matching messages
7
9 notmuch address [option ...] <search-term> ...
10
12 Search for messages matching the given search terms, and display the
13 addresses from them. Duplicate addresses are filtered out.
14 See notmuch-search-terms for details of the supported syntax for
16 <search-terms>.
17 Supported options for address include
19 --format=(json|sexp|text|text0)
21 Presents the results in either JSON, S-Expressions, newline
22 character separated plain-text (default), or null character sep‐
23 arated plain-text (compatible with xargs(1) -0 option where
24 available).
25 --format-version=N
27 Use the specified structured output format version. This is in‐
28 tended for programs that invoke notmuch internally. If omitted,
29 the latest supported version will be used.
30 --output=(sender|recipients|count|address)
32 Controls which information appears in the output. This option
33 can be given multiple times to combine different outputs. When
34 neither --output=sender nor --output=recipients is given, --out‐
35 put=sender is implied.
36 sender Output all addresses from the From header.
38 Note: Searching for sender should be much faster than
40 searching for recipients, because sender addresses are
41 cached directly in the database whereas other addresses
42 need to be fetched from message files.
43 recipients
45 Output all addresses from the To, Cc and Bcc headers.
46 count Print the count of how many times was the address encoun‐
48 tered during search.
49 Note: With this option, addresses are printed only after
51 the whole search is finished. This may take long time.
52 address
54 Output only the email addresses instead of the full mail‐
55 boxes with names and email addresses. This option has no
56 effect on the JSON or S-Expression output formats.
57 --deduplicate=(no|mailbox|address)
59 Control the deduplication of results.
60 no Output all occurrences of addresses in the matching mes‐
62 sages. This is not applicable with --output=count.
63 mailbox
65 Deduplicate addresses based on the full, case sensitive
66 name and email address, or mailbox. This is effectively
67 the same as piping the --deduplicate=no output to sort |
68 uniq, except for the order of results. This is the de‐
69 fault.
70 address
72 Deduplicate addresses based on the case insensitive ad‐
73 dress part of the mailbox. Of all the variants (with dif‐
74 ferent name or case), print the one occurring most fre‐
75 quently among the matching messages. If --output=count is
76 specified, include all variants in the count.
77 --sort=(newest-first|oldest-first)
79 This option can be used to present results in either chronologi‐
80 cal order (oldest-first) or reverse chronological order (new‐
81 est-first).
82 By default, results will be displayed in reverse chronological
84 order, (that is, the newest results will be displayed first).
85 However, if either --output=count or --deduplicate=address is
87 specified, this option is ignored and the order of the results
88 is unspecified.
89 --exclude=(true|false)
91 A message is called "excluded" if it matches at least one tag in
92 search.exclude_tags that does not appear explicitly in the
93 search terms. This option specifies whether to omit excluded
94 messages in the search process.
95 The default value, true, prevents excluded messages from match‐
97 ing the search terms.
98 false allows excluded messages to match search terms and appear
100 in displayed results.
101
103 This command supports the following special exit status codes
104 20 The requested format version is too old.
106 21 The requested format version is too new.
108
110 notmuch, notmuch-config, notmuch-count, notmuch-dump, notmuch-hooks,
111 notmuch-insert, notmuch-new, notmuch-reply, notmuch-restore,
112 notmuch-search, notmuch-search-terms, notmuch-show, notmuch-tag
113
115 Carl Worth and many others
116
118 2009-2022, Carl Worth and many others
1190.37 Aug 22, 2022 NOTMUCH-ADDRESS(1)