[PATCH 2/5] cli: Extend the search command for --output=addresses and similar
The new outputs allow printing senders, recipients or both of matching
messages.
This code based on a patch from Jani Nikula.
---
completion/notmuch-completion.bash | 2 +-
completion/notmuch-completion.zsh | 3 +-
doc/man1/notmuch-search.rst| 22 +++-
notmuch-search.c | 100 ++---
4 files changed, 118 insertions(+), 9 deletions(-)
diff --git a/completion/notmuch-completion.bash
b/completion/notmuch-completion.bash
index 0571dc9..c37ddf5 100644
--- a/completion/notmuch-completion.bash
+++ b/completion/notmuch-completion.bash
@@ -294,7 +294,7 @@ _notmuch_search()
return
;;
--output)
- COMPREPLY=( $( compgen -W "summary threads messages files tags" --
"${cur}" ) )
+ COMPREPLY=( $( compgen -W "summary threads messages files tags
sender recipients addresses" -- "${cur}" ) )
return
;;
--sort)
diff --git a/completion/notmuch-completion.zsh
b/completion/notmuch-completion.zsh
index 67a9aba..bff8fd5 100644
--- a/completion/notmuch-completion.zsh
+++ b/completion/notmuch-completion.zsh
@@ -52,7 +52,8 @@ _notmuch_search()
_arguments -s : \
'--max-threads=[display only the first x threads from the search
results]:number of threads to show: ' \
'--first=[omit the first x threads from the search results]:number of
threads to omit: ' \
-'--sort=[sort results]:sorting:((newest-first\:"reverse chronological
order" oldest-first\:"chronological order"))'
+'--sort=[sort results]:sorting:((newest-first\:"reverse chronological
order" oldest-first\:"chronological order"))' \
+'--output=[select what to output]:output:((summary threads messages files
tags sender recipients addresses))'
}
_notmuch()
diff --git a/doc/man1/notmuch-search.rst b/doc/man1/notmuch-search.rst
index 90160f2..6094906 100644
--- a/doc/man1/notmuch-search.rst
+++ b/doc/man1/notmuch-search.rst
@@ -35,7 +35,7 @@ Supported options for **search** include
intended for programs that invoke **notmuch(1)** internally. If
omitted, the latest supported version will be used.
-``--output=(summary|threads|messages|files|tags)``
+
``--output=(summary|threads|messages|files|tags|sender|recipients|addresses)``
**summary**
Output a summary of each thread with any message matching
@@ -78,6 +78,26 @@ Supported options for **search** include
by null characters (--format=text0), as a JSON array
(--format=json), or as an S-Expression list (--format=sexp).
+ **sender**
+Output all addresses from the *From* header that appear on
+any message matching the search terms, either one per line
+(--format=text), separated by null characters
+(--format=text0), as a JSON array (--format=json), or as
+an S-Expression list (--format=sexp).
+
+ Note: Searching for **sender** should much be faster than
+ searching for **recipients** or **addresses**, because
+ sender addresses are cached directly in the database
+ whereas other addresses need to be fetched from the
+ message file by parsing it.
+
+ **recipients**
+Like **sender** but for addresses from *To*, *Cc* and
+ *Bcc* headers.
+
+ **addresses**
+ Like **sender** and **recipients** together.
+
``--sort=``\ (**newest-first**\ \|\ **oldest-first**)
This option can be used to present results in either
chronological order (**oldest-first**) or reverse chronological
diff --git a/notmuch-search.c b/notmuch-search.c
index 5ac2a26..0614f10 100644
--- a/notmuch-search.c
+++ b/notmuch-search.c
@@ -23,11 +23,14 @@
#include "string-util.h"
typedef enum {
-OUTPUT_SUMMARY,
-OUTPUT_THREADS,
-OUTPUT_MESSAGES,
-OUTPUT_FILES,
-OUTPUT_TAGS
+OUTPUT_SUMMARY = 1 << 0,
+OUTPUT_THREADS = 1 << 1,
+OUTPUT_MESSAGES= 1 << 2,
+OUTPUT_FILES = 1 << 3,
+OUTPUT_TAGS= 1 << 4,
+OUTPUT_SENDER = 1 << 5,
+OUTPUT_RECIPIENTS = 1 << 6,
+OUTPUT_ADDRESSES = OUTPUT_SENDER | OUTPUT_RECIPIENTS,
} output_t;
typedef struct {
@@ -220,6 +223,67 @@ do_search_threads (search_options_t *o)
return 0;
}
+static void
+print_address_list (const search_options_t *o, InternetAddressList *list)
+{
+InternetAddress *address;
+int i;
+
+for (i = 0; i < internet_address_list_length (list); i++) {
+ address = internet_address_list_get_address (list, i);
+ if (INTERNET_ADDRESS_IS_GROUP (address)) {
+ InternetAddressGroup *group;
+ InternetAddressList *group_list;
+
+ group = INTERNET_ADDRESS_GROUP (address);
+ group_list = internet_address_group_get_members (group);
+ if (group_list == NULL)
+ continue;
+
+ print_address_list (o, group_list);
+ } else
[PATCH 2/5] cli: Extend the search command for --output=addresses and similar
The new outputs allow printing senders, recipients or both of matching
messages.
This code based on a patch from Jani Nikula.
---
completion/notmuch-completion.bash | 2 +-
completion/notmuch-completion.zsh | 3 +-
doc/man1/notmuch-search.rst| 22 +++-
notmuch-search.c | 100 ++---
4 files changed, 118 insertions(+), 9 deletions(-)
diff --git a/completion/notmuch-completion.bash
b/completion/notmuch-completion.bash
index 0571dc9..c37ddf5 100644
--- a/completion/notmuch-completion.bash
+++ b/completion/notmuch-completion.bash
@@ -294,7 +294,7 @@ _notmuch_search()
return
;;
--output)
- COMPREPLY=( $( compgen -W summary threads messages files tags --
${cur} ) )
+ COMPREPLY=( $( compgen -W summary threads messages files tags
sender recipients addresses -- ${cur} ) )
return
;;
--sort)
diff --git a/completion/notmuch-completion.zsh
b/completion/notmuch-completion.zsh
index 67a9aba..bff8fd5 100644
--- a/completion/notmuch-completion.zsh
+++ b/completion/notmuch-completion.zsh
@@ -52,7 +52,8 @@ _notmuch_search()
_arguments -s : \
'--max-threads=[display only the first x threads from the search
results]:number of threads to show: ' \
'--first=[omit the first x threads from the search results]:number of
threads to omit: ' \
-'--sort=[sort results]:sorting:((newest-first\:reverse chronological
order oldest-first\:chronological order))'
+'--sort=[sort results]:sorting:((newest-first\:reverse chronological
order oldest-first\:chronological order))' \
+'--output=[select what to output]:output:((summary threads messages files
tags sender recipients addresses))'
}
_notmuch()
diff --git a/doc/man1/notmuch-search.rst b/doc/man1/notmuch-search.rst
index 90160f2..6094906 100644
--- a/doc/man1/notmuch-search.rst
+++ b/doc/man1/notmuch-search.rst
@@ -35,7 +35,7 @@ Supported options for **search** include
intended for programs that invoke **notmuch(1)** internally. If
omitted, the latest supported version will be used.
-``--output=(summary|threads|messages|files|tags)``
+
``--output=(summary|threads|messages|files|tags|sender|recipients|addresses)``
**summary**
Output a summary of each thread with any message matching
@@ -78,6 +78,26 @@ Supported options for **search** include
by null characters (--format=text0), as a JSON array
(--format=json), or as an S-Expression list (--format=sexp).
+ **sender**
+Output all addresses from the *From* header that appear on
+any message matching the search terms, either one per line
+(--format=text), separated by null characters
+(--format=text0), as a JSON array (--format=json), or as
+an S-Expression list (--format=sexp).
+
+ Note: Searching for **sender** should much be faster than
+ searching for **recipients** or **addresses**, because
+ sender addresses are cached directly in the database
+ whereas other addresses need to be fetched from the
+ message file by parsing it.
+
+ **recipients**
+Like **sender** but for addresses from *To*, *Cc* and
+ *Bcc* headers.
+
+ **addresses**
+ Like **sender** and **recipients** together.
+
``--sort=``\ (**newest-first**\ \|\ **oldest-first**)
This option can be used to present results in either
chronological order (**oldest-first**) or reverse chronological
diff --git a/notmuch-search.c b/notmuch-search.c
index 5ac2a26..0614f10 100644
--- a/notmuch-search.c
+++ b/notmuch-search.c
@@ -23,11 +23,14 @@
#include string-util.h
typedef enum {
-OUTPUT_SUMMARY,
-OUTPUT_THREADS,
-OUTPUT_MESSAGES,
-OUTPUT_FILES,
-OUTPUT_TAGS
+OUTPUT_SUMMARY = 1 0,
+OUTPUT_THREADS = 1 1,
+OUTPUT_MESSAGES= 1 2,
+OUTPUT_FILES = 1 3,
+OUTPUT_TAGS= 1 4,
+OUTPUT_SENDER = 1 5,
+OUTPUT_RECIPIENTS = 1 6,
+OUTPUT_ADDRESSES = OUTPUT_SENDER | OUTPUT_RECIPIENTS,
} output_t;
typedef struct {
@@ -220,6 +223,67 @@ do_search_threads (search_options_t *o)
return 0;
}
+static void
+print_address_list (const search_options_t *o, InternetAddressList *list)
+{
+InternetAddress *address;
+int i;
+
+for (i = 0; i internet_address_list_length (list); i++) {
+ address = internet_address_list_get_address (list, i);
+ if (INTERNET_ADDRESS_IS_GROUP (address)) {
+ InternetAddressGroup *group;
+ InternetAddressList *group_list;
+
+ group = INTERNET_ADDRESS_GROUP (address);
+ group_list = internet_address_group_get_members (group);
+ if (group_list == NULL)
+ continue;
+
+ print_address_list (o, group_list);
+ } else {
+
