Skip site navigation (1)Skip section navigation (2)

  
 
  

home | help
NOTMUCH-ADDRESS(1)		     notmuch		      NOTMUCH-ADDRESS(1)

NAME
     notmuch-address - output addresses from matching messages

SYNOPSIS
     notmuch address [option ...] <search-term> ...

DESCRIPTION
     Search  for  messages  matching the given search terms, and display the ad-
     dresses from them. Duplicate addresses are filtered out.

     See  notmuch-search-terms	for  details  of  the	supported   syntax   for
     <search-terms>.

     Supported options for address include

     --format=(json|sexp|text|text0)
	    Presents  the results in either JSON, S-Expressions, newline charac-
	    ter separated plain-text  (default),  or  null  character  separated
	    plain-text (compatible with xargs(1) -0 option where available).

     --format-version=N
	    Use the specified structured output format version. This is intended
	    for  programs that invoke notmuch internally. If omitted, the latest
	    supported version will be used.

     --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
	    --output=sender nor --output=recipients is given, --output=sender is
	    implied.

	    sender
		   Output all addresses from the From header.

		   Note: Searching for sender should be much faster than search-
		   ing	for  recipients, because sender addresses are cached di-
		   rectly in the database whereas other  addresses  need  to  be
		   fetched from message files.

	    recipients
		   Output all addresses from the To, Cc and Bcc headers.

	    count  Print the count of how many times was the address encountered
		   during search.

		   Note:  With this option, addresses are printed only after the
		   whole search is finished. This may take long time.

	    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.

     --deduplicate=(no|mailbox|address)
	    Control the deduplication of results.

	    no	   Output all occurrences of addresses in the matching messages.
		   This is not applicable with --output=count.

	    mailbox
		   Deduplicate	addresses based on the full, case sensitive name
		   and email address, or mailbox. This is effectively  the  same
		   as  piping the --deduplicate=no output to sort | uniq, except
		   for the order of results. This is the default.

	    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 --output=count  is  specified,  include
		   all variants in the count.

     --sort=(newest-first|oldest-first)
	    This  option  can be used to present results in either chronological
	    order (oldest-first) or reverse chronological order (newest-first).

	    By default, results will be displayed in reverse  chronological  or-
	    der, (that is, the newest results will be displayed first).

	    However, if either --output=count or --deduplicate=address is speci-
	    fied, this option is ignored and the order of the results is unspec-
	    ified.

     --exclude=(true|false)
	    A  message	is  called  "excluded" 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.

	    The default value, true, prevents excluded	messages  from	matching
	    the search terms.

	    false  allows  excluded messages to match search terms and appear in
	    displayed results.

EXIT STATUS
     This command supports the following special exit status codes

     20     The requested format version is too old.

     21     The requested format version is too new.

SEE ALSO
     notmuch,  notmuch-config,	 notmuch-count,   notmuch-dump,   notmuch-hooks,
     notmuch-insert,	  notmuch-new,	    notmuch-reply,	notmuch-restore,
     notmuch-search, notmuch-search-terms, notmuch-show, notmuch-tag

AUTHOR
     Carl Worth and many others

COPYRIGHT
     2009-2026, Carl Worth and many others

0.40				  Aug 27, 2026		      NOTMUCH-ADDRESS(1)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=notmuch-address&sektion=1&manpath=FreeBSD+Ports+15.1.quarterly>

home | help