From: Jani Nikula <jani@nikula.org>
To: notmuch@notmuchmail.org
Subject: [PATCH v2 3/6] cli: add support for replying just to the sender in
	"notmuch reply"
Date: Sun,  8 Jan 2012 23:48:32 +0200
Message-Id:
 <6e37e058190d7c06519de3e67569fbee0be45461.1326058946.git.jani@nikula.org>
In-Reply-To: <cover.1326058946.git.jani@nikula.org>
References: <cover.1326058946.git.jani@nikula.org>
In-Reply-To: <cover.1326058946.git.jani@nikula.org>
References: <cover.1325794371.git.jani@nikula.org>
	<cover.1326058946.git.jani@nikula.org>
Precedence: list

Add new option --reply-to=(all|sender) to "notmuch reply" to select whether
to reply to all (sender and all recipients), or just sender. Reply to all
remains the default.

Credits to Mark Walters <markwalters1009@gmail.com> for his similar earlier
work where I picked up the basic idea of handling reply-to-sender in
add_recipients_from_message(). All bugs are mine, though.

Signed-off-by: Jani Nikula <jani@nikula.org>

---

Settled on --reply-to=(all|sender) per Carl's earlier suggestion
(id:87pqn5cg4g.fsf@yoom.home.cworth.org) and David's approval on IRC.
---
 man/man1/notmuch-reply.1 |   28 +++++++++++++---
 notmuch-reply.c          |   78 ++++++++++++++++++++++++++++++++++++----------
 2 files changed, 84 insertions(+), 22 deletions(-)

diff --git a/man/man1/notmuch-reply.1 b/man/man1/notmuch-reply.1
index 099d808..21afa35 100644
--- a/man/man1/notmuch-reply.1
+++ b/man/man1/notmuch-reply.1
@@ -14,11 +14,13 @@ Constructs a reply template for a set of messages.
 To make replying to email easier,
 .B notmuch reply
 takes an existing set of messages and constructs a suitable mail
-template. The Reply-to header (if any, otherwise From:) is used for
-the To: address. Vales from the To: and Cc: headers are copied, but
-not including any of the current user's email addresses (as configured
-in primary_mail or other_email in the .notmuch\-config file) in the
-recipient list
+template. The Reply-to: header (if any, otherwise From:) is used for
+the To: address. Unless
+.BR \-\-reply-to=sender
+is specified, values from the To: and Cc: headers are copied, but not
+including any of the current user's email addresses (as configured in
+primary_mail or other_email in the .notmuch\-config file) in the
+recipient list.
 
 It also builds a suitable new subject, including Re: at the front (if
 not already present), and adding the message IDs of the messages being
@@ -45,6 +47,22 @@ Includes subject and quoted message body.
 Only produces In\-Reply\-To, References, To, Cc, and Bcc headers.
 .RE
 .RE
+.RS
+.TP 4
+.BR \-\-reply\-to= ( all | sender )
+.RS
+.TP 4
+.BR all " (default)"
+Replies to all addresses.
+.TP 4
+.BR sender
+Replies only to the sender. If Reply-to: header (if any, otherwise
+From:) is any of the current user's configured email addresses
+(replying to user's own message), try To:, Cc:, and Bcc: headers in
+this order, and use the addresses in the first that contains something
+other than only the user's addresses for the To: address.
+.RE
+.RE
 
 See \fBnotmuch-search-terms\fR(7)
 for details of the supported syntax for <search-terms>.
diff --git a/notmuch-reply.c b/notmuch-reply.c
index 000f6da..71946b3 100644
--- a/notmuch-reply.c
+++ b/notmuch-reply.c
@@ -170,7 +170,7 @@ address_is_users (const char *address, notmuch_config_t *config)
 
 /* For each address in 'list' that is not configured as one of the
  * user's addresses in 'config', add that address to 'message' as an
- * address of 'type'.
+ * address of 'type', if 'add' is true.
  *
  * The first address encountered that *is* the user's address will be
  * returned, (otherwise NULL is returned).
@@ -179,7 +179,8 @@ static const char *
 add_recipients_for_address_list (GMimeMessage *message,
 				 notmuch_config_t *config,
 				 GMimeRecipientType type,
-				 InternetAddressList *list)
+				 InternetAddressList *list,
+				 notmuch_bool_t add)
 {
     InternetAddress *address;
     int i;
@@ -197,7 +198,7 @@ add_recipients_for_address_list (GMimeMessage *message,
 		continue;
 
 	    add_recipients_for_address_list (message, config,
-					     type, group_list);
+					     type, group_list, add);
 	} else {
 	    InternetAddressMailbox *mailbox;
 	    const char *name;
@@ -211,7 +212,7 @@ add_recipients_for_address_list (GMimeMessage *message,
 	    if (address_is_users (addr, config)) {
 		if (ret == NULL)
 		    ret = addr;
-	    } else {
+	    } else if (add) {
 		g_mime_message_add_recipient (message, type, name, addr);
 	    }
 	}
@@ -222,7 +223,7 @@ add_recipients_for_address_list (GMimeMessage *message,
 
 /* For each address in 'recipients' that is not configured as one of
  * the user's addresses in 'config', add that address to 'message' as
- * an address of 'type'.
+ * an address of 'type', if 'add' is true.
  *
  * The first address encountered that *is* the user's address will be
  * returned, (otherwise NULL is returned).
@@ -231,7 +232,8 @@ static const char *
 add_recipients_for_string (GMimeMessage *message,
 			   notmuch_config_t *config,
 			   GMimeRecipientType type,
-			   const char *recipients)
+			   const char *recipients,
+			   notmuch_bool_t add)
 {
     InternetAddressList *list;
 
@@ -242,7 +244,7 @@ add_recipients_for_string (GMimeMessage *message,
     if (list == NULL)
 	return NULL;
 
-    return add_recipients_for_address_list (message, config, type, list);
+    return add_recipients_for_address_list (message, config, type, list, add);
 }
 
 /* Does the address in the Reply-To header of 'message' already appear
@@ -286,13 +288,19 @@ reply_to_header_is_redundant (notmuch_message_t *message)
 
 /* Augments the recipients of reply from the headers of message.
  *
+ * If 'reply_all' is true, use sender and all recipients, otherwise use the
+ * first header that contains something other than the user's addresses
+ * (typically this would be reply-to-sender, but also handles reply to user's
+ * own message in a sensible way).
+ *
  * If any of the user's addresses were found in these headers, the first
  * of these returned, otherwise NULL is returned.
  */
 static const char *
 add_recipients_from_message (GMimeMessage *reply,
 			     notmuch_config_t *config,
-			     notmuch_message_t *message)
+			     notmuch_message_t *message,
+			     notmuch_bool_t reply_all)
 {
     struct {
 	const char *header;
@@ -305,6 +313,7 @@ add_recipients_from_message (GMimeMessage *reply,
 	{ "bcc",        NULL, GMIME_RECIPIENT_TYPE_BCC }
     };
     const char *from_addr = NULL;
+    notmuch_bool_t add_recipients = TRUE;
     unsigned int i;
 
     /* Some mailing lists munge the Reply-To header despite it being A Bad
@@ -325,6 +334,7 @@ add_recipients_from_message (GMimeMessage *reply,
 
     for (i = 0; i < ARRAY_SIZE (reply_to_map); i++) {
 	const char *addr, *recipients;
+	GMimeRecipientType recipient_type;
 
 	recipients = notmuch_message_get_header (message,
 						 reply_to_map[i].header);
@@ -332,11 +342,37 @@ add_recipients_from_message (GMimeMessage *reply,
 	    recipients = notmuch_message_get_header (message,
 						     reply_to_map[i].fallback);
 
-	addr = add_recipients_for_string (reply, config,
-					  reply_to_map[i].recipient_type,
-					  recipients);
+	/* Force recipient type in reply-to-sender mode just in case replying to
+	 * user's own message finds recipients in Cc/Bcc fields only.
+	 */
+	if (reply_all)
+	    recipient_type = reply_to_map[i].recipient_type;
+	else
+	    recipient_type = GMIME_RECIPIENT_TYPE_TO;
+
+	addr = add_recipients_for_string (reply, config, recipient_type,
+					  recipients, add_recipients);
+
 	if (from_addr == NULL)
 	    from_addr = addr;
+
+	if (!reply_all) {
+	    /* Stop adding new recipients in reply-to-sender mode if we have
+	     * added some recipient(s) above.
+	     *
+	     * This also handles the case of user replying to his own message,
+	     * where reply-to/from is not a recipient. In this case there may be
+	     * more than one recipient even if not replying to all.
+	     */
+	    InternetAddressList *list;
+	    list = g_mime_message_get_recipients (reply, recipient_type);
+	    if (list && internet_address_list_length (list))
+		add_recipients = FALSE;
+
+	    /* Check if we've got a from address and all recipients we need. */
+	    if (!add_recipients && from_addr)
+		break;
+	}
     }
 
     return from_addr;
@@ -480,7 +516,8 @@ static int
 notmuch_reply_format_default(void *ctx,
 			     notmuch_config_t *config,
 			     notmuch_query_t *query,
-			     notmuch_show_params_t *params)
+			     notmuch_show_params_t *params,
+			     notmuch_bool_t reply_all)
 {
     GMimeMessage *reply;
     notmuch_messages_t *messages;
@@ -509,7 +546,8 @@ notmuch_reply_format_default(void *ctx,
 	    g_mime_message_set_subject (reply, subject);
 	}
 
-	from_addr = add_recipients_from_message (reply, config, message);
+	from_addr = add_recipients_from_message (reply, config, message,
+						 reply_all);
 
 	if (from_addr == NULL)
 	    from_addr = guess_from_received_header (config, message);
@@ -558,7 +596,8 @@ static int
 notmuch_reply_format_headers_only(void *ctx,
 				  notmuch_config_t *config,
 				  notmuch_query_t *query,
-				  unused (notmuch_show_params_t *params))
+				  unused (notmuch_show_params_t *params),
+				  notmuch_bool_t reply_all)
 {
     GMimeMessage *reply;
     notmuch_messages_t *messages;
@@ -598,7 +637,7 @@ notmuch_reply_format_headers_only(void *ctx,
 	g_mime_object_set_header (GMIME_OBJECT (reply),
 				  "References", references);
 
-	(void)add_recipients_from_message (reply, config, message);
+	(void)add_recipients_from_message (reply, config, message, reply_all);
 
 	reply_headers = g_mime_object_to_string (GMIME_OBJECT (reply));
 	printf ("%s", reply_headers);
@@ -625,9 +664,10 @@ notmuch_reply_command (void *ctx, int argc, char *argv[])
     notmuch_query_t *query;
     char *query_string;
     int opt_index, ret = 0;
-    int (*reply_format_func)(void *ctx, notmuch_config_t *config, notmuch_query_t *query, notmuch_show_params_t *params);
+    int (*reply_format_func)(void *ctx, notmuch_config_t *config, notmuch_query_t *query, notmuch_show_params_t *params, notmuch_bool_t reply_all);
     notmuch_show_params_t params = { .part = -1 };
     int format = FORMAT_DEFAULT;
+    int reply_all = TRUE;
     notmuch_bool_t decrypt = FALSE;
 
     notmuch_opt_desc_t options[] = {
@@ -635,6 +675,10 @@ notmuch_reply_command (void *ctx, int argc, char *argv[])
 	  (notmuch_keyword_t []){ { "default", FORMAT_DEFAULT },
 				  { "headers-only", FORMAT_HEADERS_ONLY },
 				  { 0, 0 } } },
+	{ NOTMUCH_OPT_KEYWORD, &reply_all, "reply-to", 'r',
+	  (notmuch_keyword_t []){ { "all", TRUE },
+				  { "sender", FALSE },
+				  { 0, 0 } } },
 	{ NOTMUCH_OPT_BOOLEAN, &decrypt, "decrypt", 'd', 0 },
 	{ 0, 0, 0, 0, 0 }
     };
@@ -688,7 +732,7 @@ notmuch_reply_command (void *ctx, int argc, char *argv[])
 	return 1;
     }
 
-    if (reply_format_func (ctx, config, query, &params) != 0)
+    if (reply_format_func (ctx, config, query, &params, reply_all) != 0)
 	return 1;
 
     notmuch_query_destroy (query);
-- 
1.7.5.4