1 /* notmuch - Not much of an email program, (just index and search)
3 * Copyright © 2009 Carl Worth
4 * Copyright © 2009 Keith Packard
6 * This program is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program. If not, see https://www.gnu.org/licenses/ .
19 * Authors: Carl Worth <cworth@cworth.org>
20 * Keith Packard <keithp@keithp.com>
23 #include "notmuch-client.h"
24 #include "string-util.h"
28 show_reply_headers (GMimeMessage *message)
30 GMimeStream *stream_stdout = NULL;
32 stream_stdout = g_mime_stream_file_new (stdout);
34 g_mime_stream_file_set_owner (GMIME_STREAM_FILE (stream_stdout), FALSE);
35 /* Output RFC 2822 formatted (and RFC 2047 encoded) headers. */
36 g_mime_object_write_to_stream (GMIME_OBJECT(message), stream_stdout);
37 g_object_unref(stream_stdout);
42 format_part_reply (mime_node_t *node)
46 if (node->envelope_file) {
47 printf ("On %s, %s wrote:\n",
48 notmuch_message_get_header (node->envelope_file, "date"),
49 notmuch_message_get_header (node->envelope_file, "from"));
50 } else if (GMIME_IS_MESSAGE (node->part)) {
51 GMimeMessage *message = GMIME_MESSAGE (node->part);
52 InternetAddressList *recipients;
53 const char *recipients_string;
55 printf ("> From: %s\n", g_mime_message_get_sender (message));
56 recipients = g_mime_message_get_recipients (message, GMIME_RECIPIENT_TYPE_TO);
57 recipients_string = internet_address_list_to_string (recipients, 0);
58 if (recipients_string)
61 recipients = g_mime_message_get_recipients (message, GMIME_RECIPIENT_TYPE_CC);
62 recipients_string = internet_address_list_to_string (recipients, 0);
63 if (recipients_string)
66 printf ("> Subject: %s\n", g_mime_message_get_subject (message));
67 printf ("> Date: %s\n", g_mime_message_get_date_as_string (message));
69 } else if (GMIME_IS_PART (node->part)) {
70 GMimeContentType *content_type = g_mime_object_get_content_type (node->part);
71 GMimeContentDisposition *disposition = g_mime_object_get_content_disposition (node->part);
73 if (g_mime_content_type_is_type (content_type, "application", "pgp-encrypted") ||
74 g_mime_content_type_is_type (content_type, "application", "pgp-signature")) {
75 /* Ignore PGP/MIME cruft parts */
76 } else if (g_mime_content_type_is_type (content_type, "text", "*") &&
77 !g_mime_content_type_is_type (content_type, "text", "html")) {
78 GMimeStream *stream_stdout = g_mime_stream_file_new (stdout);
79 g_mime_stream_file_set_owner (GMIME_STREAM_FILE (stream_stdout), FALSE);
80 show_text_part_content (node->part, stream_stdout, NOTMUCH_SHOW_TEXT_PART_REPLY);
81 g_object_unref(stream_stdout);
82 } else if (disposition &&
83 strcasecmp (g_mime_content_disposition_get_disposition (disposition),
84 GMIME_DISPOSITION_ATTACHMENT) == 0) {
85 const char *filename = g_mime_part_get_filename (GMIME_PART (node->part));
86 printf ("Attachment: %s (%s)\n", filename,
87 g_mime_content_type_to_string (content_type));
89 printf ("Non-text part: %s\n",
90 g_mime_content_type_to_string (content_type));
94 for (i = 0; i < node->nchildren; i++)
95 format_part_reply (mime_node_child (node, i));
99 USER_ADDRESS_IN_STRING,
100 STRING_IN_USER_ADDRESS,
101 STRING_IS_USER_ADDRESS,
104 /* Match given string against given address according to mode. */
105 static notmuch_bool_t
106 match_address (const char *str, const char *address, address_match_t mode)
109 case USER_ADDRESS_IN_STRING:
110 return strcasestr (str, address) != NULL;
111 case STRING_IN_USER_ADDRESS:
112 return strcasestr (address, str) != NULL;
113 case STRING_IS_USER_ADDRESS:
114 return strcasecmp (address, str) == 0;
120 /* Match given string against user's configured "primary" and "other"
121 * addresses according to mode. */
123 address_match (const char *str, notmuch_config_t *config, address_match_t mode)
129 if (!str || *str == '\0')
132 primary = notmuch_config_get_user_primary_email (config);
133 if (match_address (str, primary, mode))
136 other = notmuch_config_get_user_other_email (config, &other_len);
137 for (i = 0; i < other_len; i++) {
138 if (match_address (str, other[i], mode))
145 /* Does the given string contain an address configured as one of the
146 * user's "primary" or "other" addresses. If so, return the matching
147 * address, NULL otherwise. */
149 user_address_in_string (const char *str, notmuch_config_t *config)
151 return address_match (str, config, USER_ADDRESS_IN_STRING);
154 /* Do any of the addresses configured as one of the user's "primary"
155 * or "other" addresses contain the given string. If so, return the
156 * matching address, NULL otherwise. */
158 string_in_user_address (const char *str, notmuch_config_t *config)
160 return address_match (str, config, STRING_IN_USER_ADDRESS);
163 /* Is the given address configured as one of the user's "primary" or
164 * "other" addresses. */
165 static notmuch_bool_t
166 address_is_users (const char *address, notmuch_config_t *config)
168 return address_match (address, config, STRING_IS_USER_ADDRESS) != NULL;
171 /* Scan addresses in 'list'.
173 * If 'message' is non-NULL, then for each address in 'list' that is
174 * not configured as one of the user's addresses in 'config', add that
175 * address to 'message' as an address of 'type'.
177 * If 'user_from' is non-NULL and *user_from is NULL, *user_from will
178 * be set to the first address encountered in 'list' that is the
181 * Return the number of addresses added to 'message'. (If 'message' is
182 * NULL, the function returns 0 by definition.)
185 scan_address_list (InternetAddressList *list,
186 notmuch_config_t *config,
187 GMimeMessage *message,
188 GMimeRecipientType type,
189 const char **user_from)
191 InternetAddress *address;
195 for (i = 0; i < internet_address_list_length (list); i++) {
196 address = internet_address_list_get_address (list, i);
197 if (INTERNET_ADDRESS_IS_GROUP (address)) {
198 InternetAddressGroup *group;
199 InternetAddressList *group_list;
201 group = INTERNET_ADDRESS_GROUP (address);
202 group_list = internet_address_group_get_members (group);
203 if (group_list == NULL)
206 n += scan_address_list (group_list, config, message, type, user_from);
208 InternetAddressMailbox *mailbox;
212 mailbox = INTERNET_ADDRESS_MAILBOX (address);
214 name = internet_address_get_name (address);
215 addr = internet_address_mailbox_get_addr (mailbox);
217 if (address_is_users (addr, config)) {
218 if (user_from && *user_from == NULL)
220 } else if (message) {
221 g_mime_message_add_recipient (message, type, name, addr);
230 /* Scan addresses in 'recipients'.
232 * See the documentation of scan_address_list() above. This function
233 * does exactly the same, but converts 'recipients' to an
234 * InternetAddressList first.
237 scan_address_string (const char *recipients,
238 notmuch_config_t *config,
239 GMimeMessage *message,
240 GMimeRecipientType type,
241 const char **user_from)
243 InternetAddressList *list;
245 if (recipients == NULL)
248 list = internet_address_list_parse_string (recipients);
252 return scan_address_list (list, config, message, type, user_from);
255 /* Does the address in the Reply-To header of 'message' already appear
256 * in either the 'To' or 'Cc' header of the message?
259 reply_to_header_is_redundant (notmuch_message_t *message)
261 const char *reply_to, *to, *cc, *addr;
262 InternetAddressList *list;
263 InternetAddress *address;
264 InternetAddressMailbox *mailbox;
266 reply_to = notmuch_message_get_header (message, "reply-to");
267 if (reply_to == NULL || *reply_to == '\0')
270 list = internet_address_list_parse_string (reply_to);
272 if (internet_address_list_length (list) != 1)
275 address = internet_address_list_get_address (list, 0);
276 if (INTERNET_ADDRESS_IS_GROUP (address))
279 mailbox = INTERNET_ADDRESS_MAILBOX (address);
280 addr = internet_address_mailbox_get_addr (mailbox);
282 to = notmuch_message_get_header (message, "to");
283 cc = notmuch_message_get_header (message, "cc");
285 if ((to && strstr (to, addr) != 0) ||
286 (cc && strstr (cc, addr) != 0))
294 /* Augment the recipients of 'reply' from the "Reply-to:", "From:",
295 * "To:", "Cc:", and "Bcc:" headers of 'message'.
297 * If 'reply_all' is true, use sender and all recipients, otherwise
298 * scan the headers for the first that contains something other than
299 * the user's addresses and add the recipients from this header
300 * (typically this would be reply-to-sender, but also handles reply to
301 * user's own message in a sensible way).
303 * If any of the user's addresses were found in these headers, the
304 * first of these returned, otherwise NULL is returned.
307 add_recipients_from_message (GMimeMessage *reply,
308 notmuch_config_t *config,
309 notmuch_message_t *message,
310 notmuch_bool_t reply_all)
314 const char *fallback;
315 GMimeRecipientType recipient_type;
317 { "reply-to", "from", GMIME_RECIPIENT_TYPE_TO },
318 { "to", NULL, GMIME_RECIPIENT_TYPE_TO },
319 { "cc", NULL, GMIME_RECIPIENT_TYPE_CC },
320 { "bcc", NULL, GMIME_RECIPIENT_TYPE_BCC }
322 const char *from_addr = NULL;
326 /* Some mailing lists munge the Reply-To header despite it being A Bad
327 * Thing, see http://marc.merlins.org/netrants/reply-to-harmful.html
329 * The munging is easy to detect, because it results in a
330 * redundant reply-to header, (with an address that already exists
331 * in either To or Cc). So in this case, we ignore the Reply-To
332 * field and use the From header. This ensures the original sender
333 * will get the reply even if not subscribed to the list. Note
334 * that the address in the Reply-To header will always appear in
335 * the reply if reply_all is true.
337 if (reply_to_header_is_redundant (message)) {
338 reply_to_map[0].header = "from";
339 reply_to_map[0].fallback = NULL;
342 for (i = 0; i < ARRAY_SIZE (reply_to_map); i++) {
343 const char *recipients;
345 recipients = notmuch_message_get_header (message,
346 reply_to_map[i].header);
347 if ((recipients == NULL || recipients[0] == '\0') && reply_to_map[i].fallback)
348 recipients = notmuch_message_get_header (message,
349 reply_to_map[i].fallback);
351 n += scan_address_string (recipients, config, reply,
352 reply_to_map[i].recipient_type, &from_addr);
354 if (!reply_all && n) {
355 /* Stop adding new recipients in reply-to-sender mode if
356 * we have added some recipient(s) above.
358 * This also handles the case of user replying to his own
359 * message, where reply-to/from is not a recipient. In
360 * this case there may be more than one recipient even if
361 * not replying to all.
365 /* From address and some recipients are enough, bail out. */
375 * Look for the user's address in " for <email@add.res>" in the
378 * Return the address that was found, if any, and NULL otherwise.
381 guess_from_in_received_for (notmuch_config_t *config, const char *received)
385 ptr = strstr (received, " for ");
389 return user_address_in_string (ptr, config);
393 * Parse all the " by MTA ..." parts in received headers to guess the
394 * email address that this was originally delivered to.
396 * Extract just the MTA here by removing leading whitespace and
397 * assuming that the MTA name ends at the next whitespace. Test for
398 * *(by+4) to be non-'\0' to make sure there's something there at all
399 * - and then assume that the first whitespace delimited token that
400 * follows is the receiving system in this step of the receive chain.
402 * Return the address that was found, if any, and NULL otherwise.
405 guess_from_in_received_by (notmuch_config_t *config, const char *received)
408 const char *by = received;
409 char *domain, *tld, *mta, *ptr, *token;
411 while ((by = strstr (by, " by ")) != NULL) {
416 token = strtok(mta," \t");
422 * Now extract the last two components of the MTA host name as
426 while ((ptr = strsep (&token, ". \t")) != NULL) {
435 * Recombine domain and tld and look for it among the
436 * configured email addresses. This time we have a known
437 * domain name and nothing else - so the test is the other
438 * way around: we check if this is a substring of one of
439 * the email addresses.
443 addr = string_in_user_address (domain, config);
456 * Get the concatenated Received: headers and search from the front
457 * (last Received: header added) and try to extract from them
458 * indications to which email address this message was delivered.
460 * The Received: header is special in our get_header function and is
461 * always concatenated.
463 * Return the address that was found, if any, and NULL otherwise.
466 guess_from_in_received_headers (notmuch_config_t *config,
467 notmuch_message_t *message)
469 const char *received, *addr;
472 received = notmuch_message_get_header (message, "received");
476 sanitized = sanitize_string (NULL, received);
480 addr = guess_from_in_received_for (config, sanitized);
482 addr = guess_from_in_received_by (config, sanitized);
484 talloc_free (sanitized);
490 * Try to find user's email address in one of the extra To-like
491 * headers: Envelope-To, X-Original-To, and Delivered-To (searched in
494 * Return the address that was found, if any, and NULL otherwise.
497 get_from_in_to_headers (notmuch_config_t *config, notmuch_message_t *message)
500 const char *tohdr, *addr;
501 const char *to_headers[] = {
507 for (i = 0; i < ARRAY_SIZE (to_headers); i++) {
508 tohdr = notmuch_message_get_header (message, to_headers[i]);
510 /* Note: tohdr potentially contains a list of email addresses. */
511 addr = user_address_in_string (tohdr, config);
519 static GMimeMessage *
520 create_reply_message(void *ctx,
521 notmuch_config_t *config,
522 notmuch_message_t *message,
523 notmuch_bool_t reply_all)
525 const char *subject, *from_addr = NULL;
526 const char *in_reply_to, *orig_references, *references;
528 /* The 1 means we want headers in a "pretty" order. */
529 GMimeMessage *reply = g_mime_message_new (1);
531 fprintf (stderr, "Out of memory\n");
535 in_reply_to = talloc_asprintf (ctx, "<%s>",
536 notmuch_message_get_message_id (message));
538 g_mime_object_set_header (GMIME_OBJECT (reply), "In-Reply-To", in_reply_to);
540 orig_references = notmuch_message_get_header (message, "references");
541 if (!orig_references)
542 /* Treat errors like missing References headers. */
543 orig_references = "";
544 references = talloc_asprintf (ctx, "%s%s%s",
545 *orig_references ? orig_references : "",
546 *orig_references ? " " : "",
548 g_mime_object_set_header (GMIME_OBJECT (reply), "References", references);
550 from_addr = add_recipients_from_message (reply, config,
554 * Sadly, there is no standard way to find out to which email
555 * address a mail was delivered - what is in the headers depends
556 * on the MTAs used along the way.
558 * If none of the user's email addresses are in the To: or Cc:
559 * headers, we try a number of heuristics which hopefully will
560 * answer this question.
562 * First, check for Envelope-To:, X-Original-To:, and
563 * Delivered-To: headers.
565 if (from_addr == NULL)
566 from_addr = get_from_in_to_headers (config, message);
569 * Check for a (for <email@add.res>) clause in Received: headers,
570 * and the domain part of known email addresses in the 'by' part
571 * of Received: headers
573 if (from_addr == NULL)
574 from_addr = guess_from_in_received_headers (config, message);
576 /* Default to user's primary address. */
577 if (from_addr == NULL)
578 from_addr = notmuch_config_get_user_primary_email (config);
580 from_addr = talloc_asprintf (ctx, "%s <%s>",
581 notmuch_config_get_user_name (config),
583 g_mime_object_set_header (GMIME_OBJECT (reply), "From", from_addr);
585 subject = notmuch_message_get_header (message, "subject");
587 if (strncasecmp (subject, "Re:", 3))
588 subject = talloc_asprintf (ctx, "Re: %s", subject);
589 g_mime_message_set_subject (reply, subject);
596 notmuch_reply_format_default(void *ctx,
597 notmuch_config_t *config,
598 notmuch_message_t *message,
599 notmuch_show_params_t *params,
600 notmuch_bool_t reply_all,
601 unused (sprinter_t *sp))
606 if (mime_node_open (ctx, message, ¶ms->crypto, &node))
609 reply = create_reply_message (ctx, config, message, reply_all);
613 show_reply_headers (reply);
614 format_part_reply (node);
616 g_object_unref (G_OBJECT (reply));
623 notmuch_reply_format_sprinter(void *ctx,
624 notmuch_config_t *config,
625 notmuch_message_t *message,
626 notmuch_show_params_t *params,
627 notmuch_bool_t reply_all,
633 if (mime_node_open (ctx, message, ¶ms->crypto, &node))
636 reply = create_reply_message (ctx, config, message, reply_all);
642 /* The headers of the reply message we've created */
643 sp->map_key (sp, "reply-headers");
644 format_headers_sprinter (sp, reply, TRUE);
646 /* Start the original */
647 sp->map_key (sp, "original");
648 format_part_sprinter (ctx, sp, node, TRUE, TRUE, FALSE);
653 g_object_unref (G_OBJECT (reply));
659 /* This format is currently tuned for a git send-email --notmuch hook */
661 notmuch_reply_format_headers_only(void *ctx,
662 notmuch_config_t *config,
663 notmuch_message_t *message,
664 unused (notmuch_show_params_t *params),
665 notmuch_bool_t reply_all,
666 unused (sprinter_t *sp))
669 const char *in_reply_to, *orig_references, *references;
671 /* The 0 means we do not want headers in a "pretty" order. */
672 reply = g_mime_message_new (0);
674 fprintf (stderr, "Out of memory\n");
678 in_reply_to = talloc_asprintf (ctx, "<%s>",
679 notmuch_message_get_message_id (message));
681 g_mime_object_set_header (GMIME_OBJECT (reply), "In-Reply-To", in_reply_to);
683 orig_references = notmuch_message_get_header (message, "references");
686 * We print In-Reply-To followed by References because git
687 * format-patch treats them specially. Git does not interpret the
688 * other headers specially.
690 references = talloc_asprintf (ctx, "%s%s%s",
691 orig_references ? orig_references : "",
692 orig_references ? " " : "",
694 g_mime_object_set_header (GMIME_OBJECT (reply), "References", references);
696 (void)add_recipients_from_message (reply, config, message, reply_all);
698 show_reply_headers (reply);
700 g_object_unref (G_OBJECT (reply));
712 static int do_reply(notmuch_config_t *config,
713 notmuch_query_t *query,
714 notmuch_show_params_t *params,
716 notmuch_bool_t reply_all)
718 notmuch_messages_t *messages;
719 notmuch_message_t *message;
720 notmuch_status_t status;
721 struct sprinter *sp = NULL;
723 int (*reply_format_func) (void *ctx,
724 notmuch_config_t *config,
725 notmuch_message_t *message,
726 notmuch_show_params_t *params,
727 notmuch_bool_t reply_all,
728 struct sprinter *sp);
730 if (format == FORMAT_JSON || format == FORMAT_SEXP) {
733 status = notmuch_query_count_messages_st (query, &count);
734 if (print_status_query ("notmuch reply", query, status))
738 fprintf (stderr, "Error: search term did not match precisely one message (matched %d messages).\n", count);
743 if (format == FORMAT_HEADERS_ONLY) {
744 reply_format_func = notmuch_reply_format_headers_only;
745 } else if (format == FORMAT_JSON) {
746 reply_format_func = notmuch_reply_format_sprinter;
747 sp = sprinter_json_create (config, stdout);
748 } else if (format == FORMAT_SEXP) {
749 reply_format_func = notmuch_reply_format_sprinter;
750 sp = sprinter_sexp_create (config, stdout);
752 reply_format_func = notmuch_reply_format_default;
755 status = notmuch_query_search_messages_st (query, &messages);
756 if (print_status_query ("notmuch reply", query, status))
760 notmuch_messages_valid (messages);
761 notmuch_messages_move_to_next (messages))
763 message = notmuch_messages_get (messages);
765 ret = reply_format_func(config, config, message, params, reply_all, sp);
767 notmuch_message_destroy (message);
777 notmuch_reply_command (notmuch_config_t *config, int argc, char *argv[])
779 notmuch_database_t *notmuch;
780 notmuch_query_t *query;
783 notmuch_show_params_t params = {
791 int format = FORMAT_DEFAULT;
792 int reply_all = TRUE;
794 notmuch_opt_desc_t options[] = {
795 { NOTMUCH_OPT_KEYWORD, &format, "format", 'f',
796 (notmuch_keyword_t []){ { "default", FORMAT_DEFAULT },
797 { "json", FORMAT_JSON },
798 { "sexp", FORMAT_SEXP },
799 { "headers-only", FORMAT_HEADERS_ONLY },
801 { NOTMUCH_OPT_INT, ¬much_format_version, "format-version", 0, 0 },
802 { NOTMUCH_OPT_KEYWORD, &reply_all, "reply-to", 'r',
803 (notmuch_keyword_t []){ { "all", TRUE },
806 { NOTMUCH_OPT_BOOLEAN, ¶ms.crypto.decrypt, "decrypt", 'd', 0 },
807 { NOTMUCH_OPT_INHERIT, (void *) ¬much_shared_options, NULL, 0, 0 },
811 opt_index = parse_arguments (argc, argv, options, 1);
815 notmuch_process_shared_options (argv[0]);
817 notmuch_exit_if_unsupported_format ();
819 query_string = query_string_from_args (config, argc-opt_index, argv+opt_index);
820 if (query_string == NULL) {
821 fprintf (stderr, "Out of memory\n");
825 if (*query_string == '\0') {
826 fprintf (stderr, "Error: notmuch reply requires at least one search term.\n");
830 params.crypto.gpgpath = notmuch_config_get_crypto_gpg_path (config);
832 if (notmuch_database_open (notmuch_config_get_database_path (config),
833 NOTMUCH_DATABASE_MODE_READ_ONLY, ¬much))
836 notmuch_exit_if_unmatched_db_uuid (notmuch);
838 query = notmuch_query_create (notmuch, query_string);
840 fprintf (stderr, "Out of memory\n");
844 if (do_reply (config, query, ¶ms, format, reply_all) != 0)
847 notmuch_crypto_cleanup (¶ms.crypto);
848 notmuch_query_destroy (query);
849 notmuch_database_destroy (notmuch);