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 (GMimeStream *stream, GMimeMessage *message)
30 /* Output RFC 2822 formatted (and RFC 2047 encoded) headers. */
31 if (g_mime_object_write_to_stream (GMIME_OBJECT(message), stream) < 0) {
32 INTERNAL_ERROR("failed to write headers to stdout\n");
37 format_part_reply (GMimeStream *stream, mime_node_t *node)
41 if (node->envelope_file) {
42 g_mime_stream_printf (stream, "On %s, %s wrote:\n",
43 notmuch_message_get_header (node->envelope_file, "date"),
44 notmuch_message_get_header (node->envelope_file, "from"));
45 } else if (GMIME_IS_MESSAGE (node->part)) {
46 GMimeMessage *message = GMIME_MESSAGE (node->part);
47 char *recipients_string;
49 g_mime_stream_printf (stream, "> From: %s\n", g_mime_message_get_from_string (message));
50 recipients_string = g_mime_message_get_address_string (message, GMIME_ADDRESS_TYPE_TO);
51 if (recipients_string)
52 g_mime_stream_printf (stream, "> To: %s\n",
54 g_free (recipients_string);
55 recipients_string = g_mime_message_get_address_string (message, GMIME_ADDRESS_TYPE_CC);
56 if (recipients_string)
57 g_mime_stream_printf (stream, "> Cc: %s\n",
59 g_free (recipients_string);
60 g_mime_stream_printf (stream, "> Subject: %s\n", g_mime_message_get_subject (message));
61 g_mime_stream_printf (stream, "> Date: %s\n", g_mime_message_get_date_string (node, message));
62 g_mime_stream_printf (stream, ">\n");
63 } else if (GMIME_IS_PART (node->part)) {
64 GMimeContentType *content_type = g_mime_object_get_content_type (node->part);
65 GMimeContentDisposition *disposition = g_mime_object_get_content_disposition (node->part);
67 if (g_mime_content_type_is_type (content_type, "application", "pgp-encrypted") ||
68 g_mime_content_type_is_type (content_type, "application", "pgp-signature")) {
69 /* Ignore PGP/MIME cruft parts */
70 } else if (g_mime_content_type_is_type (content_type, "text", "*") &&
71 !g_mime_content_type_is_type (content_type, "text", "html")) {
72 show_text_part_content (node->part, stream, NOTMUCH_SHOW_TEXT_PART_REPLY);
73 } else if (disposition &&
74 strcasecmp (g_mime_content_disposition_get_disposition (disposition),
75 GMIME_DISPOSITION_ATTACHMENT) == 0) {
76 const char *filename = g_mime_part_get_filename (GMIME_PART (node->part));
77 g_mime_stream_printf (stream, "Attachment: %s (%s)\n", filename,
78 g_mime_content_type_to_string (content_type));
80 g_mime_stream_printf (stream, "Non-text part: %s\n",
81 g_mime_content_type_to_string (content_type));
85 for (i = 0; i < node->nchildren; i++)
86 format_part_reply (stream, mime_node_child (node, i));
90 USER_ADDRESS_IN_STRING,
91 STRING_IN_USER_ADDRESS,
92 STRING_IS_USER_ADDRESS,
95 /* Match given string against given address according to mode. */
97 match_address (const char *str, const char *address, address_match_t mode)
100 case USER_ADDRESS_IN_STRING:
101 return strcasestr (str, address) != NULL;
102 case STRING_IN_USER_ADDRESS:
103 return strcasestr (address, str) != NULL;
104 case STRING_IS_USER_ADDRESS:
105 return strcasecmp (address, str) == 0;
111 /* Match given string against user's configured "primary" and "other"
112 * addresses according to mode. */
114 address_match (const char *str, notmuch_config_t *config, address_match_t mode)
120 if (!str || *str == '\0')
123 primary = notmuch_config_get_user_primary_email (config);
124 if (match_address (str, primary, mode))
127 other = notmuch_config_get_user_other_email (config, &other_len);
128 for (i = 0; i < other_len; i++) {
129 if (match_address (str, other[i], mode))
136 /* Does the given string contain an address configured as one of the
137 * user's "primary" or "other" addresses. If so, return the matching
138 * address, NULL otherwise. */
140 user_address_in_string (const char *str, notmuch_config_t *config)
142 return address_match (str, config, USER_ADDRESS_IN_STRING);
145 /* Do any of the addresses configured as one of the user's "primary"
146 * or "other" addresses contain the given string. If so, return the
147 * matching address, NULL otherwise. */
149 string_in_user_address (const char *str, notmuch_config_t *config)
151 return address_match (str, config, STRING_IN_USER_ADDRESS);
154 /* Is the given address configured as one of the user's "primary" or
155 * "other" addresses. */
157 address_is_users (const char *address, notmuch_config_t *config)
159 return address_match (address, config, STRING_IS_USER_ADDRESS) != NULL;
162 /* Scan addresses in 'list'.
164 * If 'message' is non-NULL, then for each address in 'list' that is
165 * not configured as one of the user's addresses in 'config', add that
166 * address to 'message' as an address of 'type'.
168 * If 'user_from' is non-NULL and *user_from is NULL, *user_from will
169 * be set to the first address encountered in 'list' that is the
172 * Return the number of addresses added to 'message'. (If 'message' is
173 * NULL, the function returns 0 by definition.)
176 scan_address_list (InternetAddressList *list,
177 notmuch_config_t *config,
178 GMimeMessage *message,
179 GMimeRecipientType type,
180 const char **user_from)
182 InternetAddress *address;
189 for (i = 0; i < internet_address_list_length (list); i++) {
190 address = internet_address_list_get_address (list, i);
191 if (INTERNET_ADDRESS_IS_GROUP (address)) {
192 InternetAddressGroup *group;
193 InternetAddressList *group_list;
195 group = INTERNET_ADDRESS_GROUP (address);
196 group_list = internet_address_group_get_members (group);
197 n += scan_address_list (group_list, config, message, type, user_from);
199 InternetAddressMailbox *mailbox;
203 mailbox = INTERNET_ADDRESS_MAILBOX (address);
205 name = internet_address_get_name (address);
206 addr = internet_address_mailbox_get_addr (mailbox);
208 if (address_is_users (addr, config)) {
209 if (user_from && *user_from == NULL)
211 } else if (message) {
212 g_mime_message_add_recipient (message, type, name, addr);
221 /* Does the address in the Reply-To header of 'message' already appear
222 * in either the 'To' or 'Cc' header of the message?
225 reply_to_header_is_redundant (GMimeMessage *message,
226 InternetAddressList *reply_to_list)
228 const char *addr, *reply_to;
229 InternetAddress *address;
230 InternetAddressMailbox *mailbox;
231 InternetAddressList *recipients;
235 if (reply_to_list == NULL ||
236 internet_address_list_length (reply_to_list) != 1)
239 address = internet_address_list_get_address (reply_to_list, 0);
240 if (INTERNET_ADDRESS_IS_GROUP (address))
243 mailbox = INTERNET_ADDRESS_MAILBOX (address);
244 reply_to = internet_address_mailbox_get_addr (mailbox);
246 recipients = g_mime_message_get_all_recipients (message);
248 for (i = 0; i < internet_address_list_length (recipients); i++) {
249 address = internet_address_list_get_address (recipients, i);
250 if (INTERNET_ADDRESS_IS_GROUP (address))
253 mailbox = INTERNET_ADDRESS_MAILBOX (address);
254 addr = internet_address_mailbox_get_addr (mailbox);
255 if (strcmp (addr, reply_to) == 0) {
261 g_object_unref (G_OBJECT (recipients));
266 static InternetAddressList *get_sender(GMimeMessage *message)
268 InternetAddressList *reply_to_list;
270 reply_to_list = g_mime_message_get_reply_to_list (message);
272 internet_address_list_length (reply_to_list) > 0) {
274 * Some mailing lists munge the Reply-To header despite it
275 * being A Bad Thing, see
276 * http://marc.merlins.org/netrants/reply-to-harmful.html
278 * The munging is easy to detect, because it results in a
279 * redundant reply-to header, (with an address that already
280 * exists in either To or Cc). So in this case, we ignore the
281 * Reply-To field and use the From header. This ensures the
282 * original sender will get the reply even if not subscribed
283 * to the list. Note that the address in the Reply-To header
284 * will always appear in the reply if reply_all is true.
286 if (! reply_to_header_is_redundant (message, reply_to_list))
287 return reply_to_list;
289 g_mime_2_6_unref (G_OBJECT (reply_to_list));
292 return g_mime_message_get_from (message);
295 static InternetAddressList *get_to(GMimeMessage *message)
297 return g_mime_message_get_addresses (message, GMIME_ADDRESS_TYPE_TO);
300 static InternetAddressList *get_cc(GMimeMessage *message)
302 return g_mime_message_get_addresses (message, GMIME_ADDRESS_TYPE_CC);
305 static InternetAddressList *get_bcc(GMimeMessage *message)
307 return g_mime_message_get_addresses (message, GMIME_ADDRESS_TYPE_BCC);
310 /* Augment the recipients of 'reply' from the "Reply-to:", "From:",
311 * "To:", "Cc:", and "Bcc:" headers of 'message'.
313 * If 'reply_all' is true, use sender and all recipients, otherwise
314 * scan the headers for the first that contains something other than
315 * the user's addresses and add the recipients from this header
316 * (typically this would be reply-to-sender, but also handles reply to
317 * user's own message in a sensible way).
319 * If any of the user's addresses were found in these headers, the
320 * first of these returned, otherwise NULL is returned.
323 add_recipients_from_message (GMimeMessage *reply,
324 notmuch_config_t *config,
325 GMimeMessage *message,
329 /* There is a memory leak here with gmime-2.6 because get_sender
330 * returns a newly allocated list, while the others return
331 * references to libgmime owned data. This leak will be fixed with
332 * the transition to gmime-3.0.
335 InternetAddressList * (*get_header)(GMimeMessage *message);
336 GMimeRecipientType recipient_type;
338 { get_sender, GMIME_ADDRESS_TYPE_TO },
339 { get_to, GMIME_ADDRESS_TYPE_TO },
340 { get_cc, GMIME_ADDRESS_TYPE_CC },
341 { get_bcc, GMIME_ADDRESS_TYPE_BCC },
343 const char *from_addr = NULL;
347 for (i = 0; i < ARRAY_SIZE (reply_to_map); i++) {
348 InternetAddressList *recipients;
350 recipients = reply_to_map[i].get_header (message);
352 n += scan_address_list (recipients, config, reply,
353 reply_to_map[i].recipient_type, &from_addr);
355 if (!reply_all && n) {
356 /* Stop adding new recipients in reply-to-sender mode if
357 * we have added some recipient(s) above.
359 * This also handles the case of user replying to his own
360 * message, where reply-to/from is not a recipient. In
361 * this case there may be more than one recipient even if
362 * not replying to all.
366 /* From address and some recipients are enough, bail out. */
372 /* If no recipients were added but we found one of the user's
373 * addresses to use as a from address then the message is from the
374 * user to the user - add the discovered from address to the list
375 * of recipients so that the reply goes back to the user.
377 if (n == 0 && from_addr)
378 g_mime_message_add_recipient (reply, GMIME_ADDRESS_TYPE_TO, NULL, from_addr);
384 * Look for the user's address in " for <email@add.res>" in the
387 * Return the address that was found, if any, and NULL otherwise.
390 guess_from_in_received_for (notmuch_config_t *config, const char *received)
394 ptr = strstr (received, " for ");
398 return user_address_in_string (ptr, config);
402 * Parse all the " by MTA ..." parts in received headers to guess the
403 * email address that this was originally delivered to.
405 * Extract just the MTA here by removing leading whitespace and
406 * assuming that the MTA name ends at the next whitespace. Test for
407 * *(by+4) to be non-'\0' to make sure there's something there at all
408 * - and then assume that the first whitespace delimited token that
409 * follows is the receiving system in this step of the receive chain.
411 * Return the address that was found, if any, and NULL otherwise.
414 guess_from_in_received_by (notmuch_config_t *config, const char *received)
417 const char *by = received;
418 char *domain, *tld, *mta, *ptr, *token;
420 while ((by = strstr (by, " by ")) != NULL) {
425 token = strtok(mta," \t");
431 * Now extract the last two components of the MTA host name as
435 while ((ptr = strsep (&token, ". \t")) != NULL) {
444 * Recombine domain and tld and look for it among the
445 * configured email addresses. This time we have a known
446 * domain name and nothing else - so the test is the other
447 * way around: we check if this is a substring of one of
448 * the email addresses.
452 addr = string_in_user_address (domain, config);
465 * Get the concatenated Received: headers and search from the front
466 * (last Received: header added) and try to extract from them
467 * indications to which email address this message was delivered.
469 * The Received: header is special in our get_header function and is
470 * always concatenated.
472 * Return the address that was found, if any, and NULL otherwise.
475 guess_from_in_received_headers (notmuch_config_t *config,
476 notmuch_message_t *message)
478 const char *received, *addr;
481 received = notmuch_message_get_header (message, "received");
485 sanitized = sanitize_string (NULL, received);
489 addr = guess_from_in_received_for (config, sanitized);
491 addr = guess_from_in_received_by (config, sanitized);
493 talloc_free (sanitized);
499 * Try to find user's email address in one of the extra To-like
500 * headers: Envelope-To, X-Original-To, and Delivered-To (searched in
503 * Return the address that was found, if any, and NULL otherwise.
506 get_from_in_to_headers (notmuch_config_t *config, notmuch_message_t *message)
509 const char *tohdr, *addr;
510 const char *to_headers[] = {
516 for (i = 0; i < ARRAY_SIZE (to_headers); i++) {
517 tohdr = notmuch_message_get_header (message, to_headers[i]);
519 /* Note: tohdr potentially contains a list of email addresses. */
520 addr = user_address_in_string (tohdr, config);
528 static GMimeMessage *
529 create_reply_message(void *ctx,
530 notmuch_config_t *config,
531 notmuch_message_t *message,
532 GMimeMessage *mime_message,
536 const char *subject, *from_addr = NULL;
537 const char *in_reply_to, *orig_references, *references;
540 * Use the below header order for limited headers, "pretty" order
543 GMimeMessage *reply = g_mime_message_new (limited ? 0 : 1);
545 fprintf (stderr, "Out of memory\n");
549 in_reply_to = talloc_asprintf (ctx, "<%s>",
550 notmuch_message_get_message_id (message));
552 g_mime_object_set_header (GMIME_OBJECT (reply), "In-Reply-To", in_reply_to);
554 orig_references = notmuch_message_get_header (message, "references");
555 if (orig_references && *orig_references)
556 references = talloc_asprintf (ctx, "%s %s", orig_references,
559 references = talloc_strdup (ctx, in_reply_to);
561 g_mime_object_set_header (GMIME_OBJECT (reply), "References", references);
563 from_addr = add_recipients_from_message (reply, config,
564 mime_message, reply_all);
566 /* The above is all that is needed for limited headers. */
571 * Sadly, there is no standard way to find out to which email
572 * address a mail was delivered - what is in the headers depends
573 * on the MTAs used along the way.
575 * If none of the user's email addresses are in the To: or Cc:
576 * headers, we try a number of heuristics which hopefully will
577 * answer this question.
579 * First, check for Envelope-To:, X-Original-To:, and
580 * Delivered-To: headers.
582 if (from_addr == NULL)
583 from_addr = get_from_in_to_headers (config, message);
586 * Check for a (for <email@add.res>) clause in Received: headers,
587 * and the domain part of known email addresses in the 'by' part
588 * of Received: headers
590 if (from_addr == NULL)
591 from_addr = guess_from_in_received_headers (config, message);
593 /* Default to user's primary address. */
594 if (from_addr == NULL)
595 from_addr = notmuch_config_get_user_primary_email (config);
597 from_addr = talloc_asprintf (ctx, "%s <%s>",
598 notmuch_config_get_user_name (config),
600 g_mime_object_set_header (GMIME_OBJECT (reply), "From", from_addr);
602 subject = notmuch_message_get_header (message, "subject");
604 if (strncasecmp (subject, "Re:", 3))
605 subject = talloc_asprintf (ctx, "Re: %s", subject);
606 g_mime_message_set_subject (reply, subject);
619 static int do_reply(notmuch_config_t *config,
620 notmuch_query_t *query,
621 notmuch_show_params_t *params,
627 notmuch_messages_t *messages;
628 notmuch_message_t *message;
629 notmuch_status_t status;
630 struct sprinter *sp = NULL;
632 if (format == FORMAT_JSON || format == FORMAT_SEXP) {
635 status = notmuch_query_count_messages (query, &count);
636 if (print_status_query ("notmuch reply", query, status))
640 fprintf (stderr, "Error: search term did not match precisely one message (matched %u messages).\n", count);
644 if (format == FORMAT_JSON)
645 sp = sprinter_json_create (config, stdout);
647 sp = sprinter_sexp_create (config, stdout);
650 status = notmuch_query_search_messages (query, &messages);
651 if (print_status_query ("notmuch reply", query, status))
655 notmuch_messages_valid (messages);
656 notmuch_messages_move_to_next (messages))
658 message = notmuch_messages_get (messages);
660 if (mime_node_open (config, message, ¶ms->crypto, &node))
663 reply = create_reply_message (config, config, message,
664 GMIME_MESSAGE (node->part), reply_all,
665 format == FORMAT_HEADERS_ONLY);
669 if (format == FORMAT_JSON || format == FORMAT_SEXP) {
672 /* The headers of the reply message we've created */
673 sp->map_key (sp, "reply-headers");
674 format_headers_sprinter (sp, reply, true);
676 /* Start the original */
677 sp->map_key (sp, "original");
678 format_part_sprinter (config, sp, node, true, false);
683 GMimeStream *stream_stdout = stream_stdout = g_mime_stream_stdout_new ();
685 show_reply_headers (stream_stdout, reply);
686 if (format == FORMAT_DEFAULT)
687 format_part_reply (stream_stdout, node);
689 g_mime_stream_flush (stream_stdout);
690 g_object_unref(stream_stdout);
693 g_object_unref (G_OBJECT (reply));
696 notmuch_message_destroy (message);
703 notmuch_reply_command (notmuch_config_t *config, int argc, char *argv[])
705 notmuch_database_t *notmuch;
706 notmuch_query_t *query;
709 notmuch_show_params_t params = {
711 .crypto = { .decrypt = NOTMUCH_DECRYPT_AUTO },
713 int format = FORMAT_DEFAULT;
714 int reply_all = true;
716 notmuch_opt_desc_t options[] = {
717 { .opt_keyword = &format, .name = "format", .keywords =
718 (notmuch_keyword_t []){ { "default", FORMAT_DEFAULT },
719 { "json", FORMAT_JSON },
720 { "sexp", FORMAT_SEXP },
721 { "headers-only", FORMAT_HEADERS_ONLY },
723 { .opt_int = ¬much_format_version, .name = "format-version" },
724 { .opt_keyword = &reply_all, .name = "reply-to", .keywords =
725 (notmuch_keyword_t []){ { "all", true },
728 { .opt_keyword = (int*)(¶ms.crypto.decrypt), .name = "decrypt",
729 .keyword_no_arg_value = "true", .keywords =
730 (notmuch_keyword_t []){ { "false", NOTMUCH_DECRYPT_FALSE },
731 { "auto", NOTMUCH_DECRYPT_AUTO },
732 { "true", NOTMUCH_DECRYPT_NOSTASH },
734 { .opt_inherit = notmuch_shared_options },
738 opt_index = parse_arguments (argc, argv, options, 1);
742 notmuch_process_shared_options (argv[0]);
744 notmuch_exit_if_unsupported_format ();
746 query_string = query_string_from_args (config, argc-opt_index, argv+opt_index);
747 if (query_string == NULL) {
748 fprintf (stderr, "Out of memory\n");
752 if (*query_string == '\0') {
753 fprintf (stderr, "Error: notmuch reply requires at least one search term.\n");
757 #if (GMIME_MAJOR_VERSION < 3)
758 params.crypto.gpgpath = notmuch_config_get_crypto_gpg_path (config);
761 if (notmuch_database_open (notmuch_config_get_database_path (config),
762 NOTMUCH_DATABASE_MODE_READ_ONLY, ¬much))
765 notmuch_exit_if_unmatched_db_uuid (notmuch);
767 query = notmuch_query_create (notmuch, query_string);
769 fprintf (stderr, "Out of memory\n");
773 if (do_reply (config, query, ¶ms, format, reply_all) != 0)
776 _notmuch_crypto_cleanup (¶ms.crypto);
777 notmuch_query_destroy (query);
778 notmuch_database_destroy (notmuch);