.\" Man page generated from reStructuredText.
.
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "NOTMUCH-ADDRESS" "1" "Oct 03, 2024" "0.38.3" "notmuch"
.SH NAME
notmuch-address \- output addresses from matching messages
.SH SYNOPSIS
.sp
\fBnotmuch\fP \fBaddress\fP [\fIoption\fP ...] <\fIsearch\-term\fP> ...
.SH DESCRIPTION
.sp
Search for messages matching the given search terms, and display the
addresses from them. Duplicate addresses are filtered out.
.sp
See \fI\%notmuch\-search\-terms\fP for details of the supported syntax for
<search\-terms>.
.sp
Supported options for \fBaddress\fP include
.INDENT 0.0
.TP
.B \-\-format=(json|sexp|text|text0)
Presents the results in either JSON, S\-Expressions, newline
character separated plain\-text (default), or null character
separated plain\-text (compatible with \fB\X'tty: link https://manpages.debian.org/xargs.1.html'\fI\%xargs(1)\fP\X'tty: link'\fP \-0
option where available).
.UNINDENT
.INDENT 0.0
.TP
.B \-\-format\-version=N
Use the specified structured output format version. This is
intended for programs that invoke \fI\%notmuch\fP internally. If
omitted, the latest supported version will be used.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-output=(sender|recipients|count|address)
Controls which information appears in the output. This option can
be given multiple times to combine different outputs.  When
neither \fB\-\-output=sender\fP nor \fB\-\-output=recipients\fP is
given, \fB\-\-output=sender\fP is implied.
.INDENT 7.0
.TP
.B sender
Output all addresses from the \fIFrom\fP header.
.sp
Note: Searching for \fBsender\fP should be much faster than
searching for \fBrecipients\fP, because sender addresses are
cached directly in the database whereas other addresses need
to be fetched from message files.
.TP
.B recipients
Output all addresses from the \fITo\fP, \fICc\fP and \fIBcc\fP headers.
.TP
.B count
Print the count of how many times was the address encountered
during search.
.sp
Note: With this option, addresses are printed only after the
whole search is finished. This may take long time.
.TP
.B address
Output only the email addresses instead of the full mailboxes
with names and email addresses. This option has no effect on
the JSON or S\-Expression output formats.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B \-\-deduplicate=(no|mailbox|address)
Control the deduplication of results.
.INDENT 7.0
.TP
.B no
Output all occurrences of addresses in the matching
messages. This is not applicable with \fB\-\-output=count\fP\&.
.TP
.B mailbox
Deduplicate addresses based on the full, case sensitive name
and email address, or mailbox. This is effectively the same as
piping the \fB\-\-deduplicate=no\fP output to \fBsort | uniq\fP, except
for the order of results. This is the default.
.TP
.B address
Deduplicate addresses based on the case insensitive address
part of the mailbox. Of all the variants (with different name
or case), print the one occurring most frequently among the
matching messages. If \fB\-\-output=count\fP is specified, include all
variants in the count.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B \-\-sort=(newest\-first|oldest\-first)
This option can be used to present results in either chronological
order (\fBoldest\-first\fP) or reverse chronological order
(\fBnewest\-first\fP).
.sp
By default, results will be displayed in reverse chronological
order, (that is, the newest results will be displayed first).
.sp
However, if either \fB\-\-output=count\fP or \fB\-\-deduplicate=address\fP is
specified, this option is ignored and the order of the results is
unspecified.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-exclude=(true|false)
A message is called \(dqexcluded\(dq if it matches at least one tag in
search.exclude_tags that does not appear explicitly in the search
terms. This option specifies whether to omit excluded messages in
the search process.
.sp
The default value, \fBtrue\fP, prevents excluded messages from
matching the search terms.
.sp
\fBfalse\fP allows excluded messages to match search terms and
appear in displayed results.
.UNINDENT
.SH EXIT STATUS
.sp
This command supports the following special exit status codes
.INDENT 0.0
.TP
.B \fB20\fP
The requested format version is too old.
.TP
.B \fB21\fP
The requested format version is too new.
.UNINDENT
.SH SEE ALSO
.sp
\fI\%notmuch\fP,
\fI\%notmuch\-config\fP,
\fI\%notmuch\-count\fP,
\fI\%notmuch\-dump\fP,
\fI\%notmuch\-hooks\fP,
\fI\%notmuch\-insert\fP,
\fI\%notmuch\-new\fP,
\fI\%notmuch\-reply\fP,
\fI\%notmuch\-restore\fP,
\fI\%notmuch\-search\fP,
\fI\%notmuch\-search\-terms\fP,
\fI\%notmuch\-show\fP,
\fI\%notmuch\-tag\fP
.SH AUTHOR
Carl Worth and many others
.SH COPYRIGHT
2009-2024, Carl Worth and many others
.\" Generated by docutils manpage writer.
.