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 InternetAddressList *recipients;
48 char *recipients_string;
50 g_mime_stream_printf (stream, "> From: %s\n", g_mime_message_get_sender (message));
51 recipients = g_mime_message_get_recipients (message, GMIME_RECIPIENT_TYPE_TO);
52 recipients_string = internet_address_list_to_string (recipients, 0);
53 if (recipients_string)
54 g_mime_stream_printf (stream, "> To: %s\n",
56 g_free (recipients_string);
57 recipients = g_mime_message_get_recipients (message, GMIME_RECIPIENT_TYPE_CC);
58 recipients_string = internet_address_list_to_string (recipients, 0);
59 if (recipients_string)
60 g_mime_stream_printf (stream, "> Cc: %s\n",
62 g_free (recipients_string);
63 g_mime_stream_printf (stream, "> Subject: %s\n", g_mime_message_get_subject (message));
64 g_mime_stream_printf (stream, "> Date: %s\n", g_mime_message_get_date_string (node, message));
65 g_mime_stream_printf (stream, ">\n");
66 } else if (GMIME_IS_PART (node->part)) {
67 GMimeContentType *content_type = g_mime_object_get_content_type (node->part);
68 GMimeContentDisposition *disposition = g_mime_object_get_content_disposition (node->part);
70 if (g_mime_content_type_is_type (content_type, "application", "pgp-encrypted") ||
71 g_mime_content_type_is_type (content_type, "application", "pgp-signature")) {
72 /* Ignore PGP/MIME cruft parts */
73 } else if (g_mime_content_type_is_type (content_type, "text", "*") &&
74 !g_mime_content_type_is_type (content_type, "text", "html")) {
75 show_text_part_content (node->part, stream, NOTMUCH_SHOW_TEXT_PART_REPLY);
76 } else if (disposition &&
77 strcasecmp (g_mime_content_disposition_get_disposition (disposition),
78 GMIME_DISPOSITION_ATTACHMENT) == 0) {
79 const char *filename = g_mime_part_get_filename (GMIME_PART (node->part));
80 g_mime_stream_printf (stream, "Attachment: %s (%s)\n", filename,
81 g_mime_content_type_to_string (content_type));
83 g_mime_stream_printf (stream, "Non-text part: %s\n",
84 g_mime_content_type_to_string (content_type));
88 for (i = 0; i < node->nchildren; i++)
89 format_part_reply (stream, mime_node_child (node, i));
93 USER_ADDRESS_IN_STRING,
94 STRING_IN_USER_ADDRESS,
95 STRING_IS_USER_ADDRESS,
98 /* Match given string against given address according to mode. */
100 match_address (const char *str, const char *address, address_match_t mode)
103 case USER_ADDRESS_IN_STRING:
104 return strcasestr (str, address) != NULL;
105 case STRING_IN_USER_ADDRESS:
106 return strcasestr (address, str) != NULL;
107 case STRING_IS_USER_ADDRESS:
108 return strcasecmp (address, str) == 0;
114 /* Match given string against user's configured "primary" and "other"
115 * addresses according to mode. */
117 address_match (const char *str, notmuch_config_t *config, address_match_t mode)
123 if (!str || *str == '\0')
126 primary = notmuch_config_get_user_primary_email (config);
127 if (match_address (str, primary, mode))
130 other = notmuch_config_get_user_other_email (config, &other_len);
131 for (i = 0; i < other_len; i++) {
132 if (match_address (str, other[i], mode))
139 /* Does the given string contain an address configured as one of the
140 * user's "primary" or "other" addresses. If so, return the matching
141 * address, NULL otherwise. */
143 user_address_in_string (const char *str, notmuch_config_t *config)
145 return address_match (str, config, USER_ADDRESS_IN_STRING);
148 /* Do any of the addresses configured as one of the user's "primary"
149 * or "other" addresses contain the given string. If so, return the
150 * matching address, NULL otherwise. */
152 string_in_user_address (const char *str, notmuch_config_t *config)
154 return address_match (str, config, STRING_IN_USER_ADDRESS);
157 /* Is the given address configured as one of the user's "primary" or
158 * "other" addresses. */
159 static notmuch_bool_t
160 address_is_users (const char *address, notmuch_config_t *config)
162 return address_match (address, config, STRING_IS_USER_ADDRESS) != NULL;
165 /* Scan addresses in 'list'.
167 * If 'message' is non-NULL, then for each address in 'list' that is
168 * not configured as one of the user's addresses in 'config', add that
169 * address to 'message' as an address of 'type'.
171 * If 'user_from' is non-NULL and *user_from is NULL, *user_from will
172 * be set to the first address encountered in 'list' that is the
175 * Return the number of addresses added to 'message'. (If 'message' is
176 * NULL, the function returns 0 by definition.)
179 scan_address_list (InternetAddressList *list,
180 notmuch_config_t *config,
181 GMimeMessage *message,
182 GMimeRecipientType type,
183 const char **user_from)
185 InternetAddress *address;
192 for (i = 0; i < internet_address_list_length (list); i++) {
193 address = internet_address_list_get_address (list, i);
194 if (INTERNET_ADDRESS_IS_GROUP (address)) {
195 InternetAddressGroup *group;
196 InternetAddressList *group_list;
198 group = INTERNET_ADDRESS_GROUP (address);
199 group_list = internet_address_group_get_members (group);
200 n += scan_address_list (group_list, config, message, type, user_from);
202 InternetAddressMailbox *mailbox;
206 mailbox = INTERNET_ADDRESS_MAILBOX (address);
208 name = internet_address_get_name (address);
209 addr = internet_address_mailbox_get_addr (mailbox);
211 if (address_is_users (addr, config)) {
212 if (user_from && *user_from == NULL)
214 } else if (message) {
215 g_mime_message_add_recipient (message, type, name, addr);
224 /* Does the address in the Reply-To header of 'message' already appear
225 * in either the 'To' or 'Cc' header of the message?
227 static notmuch_bool_t
228 reply_to_header_is_redundant (GMimeMessage *message,
229 InternetAddressList *reply_to_list)
231 const char *addr, *reply_to;
232 InternetAddress *address;
233 InternetAddressMailbox *mailbox;
234 InternetAddressList *recipients;
235 notmuch_bool_t ret = FALSE;
238 if (reply_to_list == NULL ||
239 internet_address_list_length (reply_to_list) != 1)
242 address = internet_address_list_get_address (reply_to_list, 0);
243 if (INTERNET_ADDRESS_IS_GROUP (address))
246 mailbox = INTERNET_ADDRESS_MAILBOX (address);
247 reply_to = internet_address_mailbox_get_addr (mailbox);
249 recipients = g_mime_message_get_all_recipients (message);
251 for (i = 0; i < internet_address_list_length (recipients); i++) {
252 address = internet_address_list_get_address (recipients, i);
253 if (INTERNET_ADDRESS_IS_GROUP (address))
256 mailbox = INTERNET_ADDRESS_MAILBOX (address);
257 addr = internet_address_mailbox_get_addr (mailbox);
258 if (strcmp (addr, reply_to) == 0) {
264 g_object_unref (G_OBJECT (recipients));
269 static InternetAddressList *get_sender(GMimeMessage *message)
271 InternetAddressList *reply_to_list;
273 reply_to_list = g_mime_message_get_reply_to_list (message);
275 internet_address_list_length (reply_to_list) > 0) {
277 * Some mailing lists munge the Reply-To header despite it
278 * being A Bad Thing, see
279 * http://marc.merlins.org/netrants/reply-to-harmful.html
281 * The munging is easy to detect, because it results in a
282 * redundant reply-to header, (with an address that already
283 * exists in either To or Cc). So in this case, we ignore the
284 * Reply-To field and use the From header. This ensures the
285 * original sender will get the reply even if not subscribed
286 * to the list. Note that the address in the Reply-To header
287 * will always appear in the reply if reply_all is true.
289 if (! reply_to_header_is_redundant (message, reply_to_list))
290 return reply_to_list;
292 g_object_unref (G_OBJECT (reply_to_list));
295 return internet_address_list_parse_string (
296 g_mime_message_get_sender (message));
299 static InternetAddressList *get_to(GMimeMessage *message)
301 return g_mime_message_get_recipients (message, GMIME_RECIPIENT_TYPE_TO);
304 static InternetAddressList *get_cc(GMimeMessage *message)
306 return g_mime_message_get_recipients (message, GMIME_RECIPIENT_TYPE_CC);
309 static InternetAddressList *get_bcc(GMimeMessage *message)
311 return g_mime_message_get_recipients (message, GMIME_RECIPIENT_TYPE_BCC);
314 /* Augment the recipients of 'reply' from the "Reply-to:", "From:",
315 * "To:", "Cc:", and "Bcc:" headers of 'message'.
317 * If 'reply_all' is true, use sender and all recipients, otherwise
318 * scan the headers for the first that contains something other than
319 * the user's addresses and add the recipients from this header
320 * (typically this would be reply-to-sender, but also handles reply to
321 * user's own message in a sensible way).
323 * If any of the user's addresses were found in these headers, the
324 * first of these returned, otherwise NULL is returned.
327 add_recipients_from_message (GMimeMessage *reply,
328 notmuch_config_t *config,
329 GMimeMessage *message,
330 notmuch_bool_t reply_all)
333 /* There is a memory leak here with gmime-2.6 because get_sender
334 * returns a newly allocated list, while the others return
335 * references to libgmime owned data. This leak will be fixed with
336 * the transition to gmime-3.0.
339 InternetAddressList * (*get_header)(GMimeMessage *message);
340 GMimeRecipientType recipient_type;
342 { get_sender, GMIME_RECIPIENT_TYPE_TO },
343 { get_to, GMIME_RECIPIENT_TYPE_TO },
344 { get_cc, GMIME_RECIPIENT_TYPE_CC },
345 { get_bcc, GMIME_RECIPIENT_TYPE_BCC },
347 const char *from_addr = NULL;
351 for (i = 0; i < ARRAY_SIZE (reply_to_map); i++) {
352 InternetAddressList *recipients;
354 recipients = reply_to_map[i].get_header (message);
356 n += scan_address_list (recipients, config, reply,
357 reply_to_map[i].recipient_type, &from_addr);
359 if (!reply_all && n) {
360 /* Stop adding new recipients in reply-to-sender mode if
361 * we have added some recipient(s) above.
363 * This also handles the case of user replying to his own
364 * message, where reply-to/from is not a recipient. In
365 * this case there may be more than one recipient even if
366 * not replying to all.
370 /* From address and some recipients are enough, bail out. */
380 * Look for the user's address in " for <email@add.res>" in the
383 * Return the address that was found, if any, and NULL otherwise.
386 guess_from_in_received_for (notmuch_config_t *config, const char *received)
390 ptr = strstr (received, " for ");
394 return user_address_in_string (ptr, config);
398 * Parse all the " by MTA ..." parts in received headers to guess the
399 * email address that this was originally delivered to.
401 * Extract just the MTA here by removing leading whitespace and
402 * assuming that the MTA name ends at the next whitespace. Test for
403 * *(by+4) to be non-'\0' to make sure there's something there at all
404 * - and then assume that the first whitespace delimited token that
405 * follows is the receiving system in this step of the receive chain.
407 * Return the address that was found, if any, and NULL otherwise.
410 guess_from_in_received_by (notmuch_config_t *config, const char *received)
413 const char *by = received;
414 char *domain, *tld, *mta, *ptr, *token;
416 while ((by = strstr (by, " by ")) != NULL) {
421 token = strtok(mta," \t");
427 * Now extract the last two components of the MTA host name as
431 while ((ptr = strsep (&token, ". \t")) != NULL) {
440 * Recombine domain and tld and look for it among the
441 * configured email addresses. This time we have a known
442 * domain name and nothing else - so the test is the other
443 * way around: we check if this is a substring of one of
444 * the email addresses.
448 addr = string_in_user_address (domain, config);
461 * Get the concatenated Received: headers and search from the front
462 * (last Received: header added) and try to extract from them
463 * indications to which email address this message was delivered.
465 * The Received: header is special in our get_header function and is
466 * always concatenated.
468 * Return the address that was found, if any, and NULL otherwise.
471 guess_from_in_received_headers (notmuch_config_t *config,
472 notmuch_message_t *message)
474 const char *received, *addr;
477 received = notmuch_message_get_header (message, "received");
481 sanitized = sanitize_string (NULL, received);
485 addr = guess_from_in_received_for (config, sanitized);
487 addr = guess_from_in_received_by (config, sanitized);
489 talloc_free (sanitized);
495 * Try to find user's email address in one of the extra To-like
496 * headers: Envelope-To, X-Original-To, and Delivered-To (searched in
499 * Return the address that was found, if any, and NULL otherwise.
502 get_from_in_to_headers (notmuch_config_t *config, notmuch_message_t *message)
505 const char *tohdr, *addr;
506 const char *to_headers[] = {
512 for (i = 0; i < ARRAY_SIZE (to_headers); i++) {
513 tohdr = notmuch_message_get_header (message, to_headers[i]);
515 /* Note: tohdr potentially contains a list of email addresses. */
516 addr = user_address_in_string (tohdr, config);
524 static GMimeMessage *
525 create_reply_message(void *ctx,
526 notmuch_config_t *config,
527 notmuch_message_t *message,
528 GMimeMessage *mime_message,
529 notmuch_bool_t reply_all,
530 notmuch_bool_t limited)
532 const char *subject, *from_addr = NULL;
533 const char *in_reply_to, *orig_references, *references;
536 * Use the below header order for limited headers, "pretty" order
539 GMimeMessage *reply = g_mime_message_new (limited ? 0 : 1);
541 fprintf (stderr, "Out of memory\n");
545 in_reply_to = talloc_asprintf (ctx, "<%s>",
546 notmuch_message_get_message_id (message));
548 g_mime_object_set_header (GMIME_OBJECT (reply), "In-Reply-To", in_reply_to);
550 orig_references = notmuch_message_get_header (message, "references");
551 if (orig_references && *orig_references)
552 references = talloc_asprintf (ctx, "%s %s", orig_references,
555 references = talloc_strdup (ctx, in_reply_to);
557 g_mime_object_set_header (GMIME_OBJECT (reply), "References", references);
559 from_addr = add_recipients_from_message (reply, config,
560 mime_message, reply_all);
562 /* The above is all that is needed for limited headers. */
567 * Sadly, there is no standard way to find out to which email
568 * address a mail was delivered - what is in the headers depends
569 * on the MTAs used along the way.
571 * If none of the user's email addresses are in the To: or Cc:
572 * headers, we try a number of heuristics which hopefully will
573 * answer this question.
575 * First, check for Envelope-To:, X-Original-To:, and
576 * Delivered-To: headers.
578 if (from_addr == NULL)
579 from_addr = get_from_in_to_headers (config, message);
582 * Check for a (for <email@add.res>) clause in Received: headers,
583 * and the domain part of known email addresses in the 'by' part
584 * of Received: headers
586 if (from_addr == NULL)
587 from_addr = guess_from_in_received_headers (config, message);
589 /* Default to user's primary address. */
590 if (from_addr == NULL)
591 from_addr = notmuch_config_get_user_primary_email (config);
593 from_addr = talloc_asprintf (ctx, "%s <%s>",
594 notmuch_config_get_user_name (config),
596 g_mime_object_set_header (GMIME_OBJECT (reply), "From", from_addr);
598 subject = notmuch_message_get_header (message, "subject");
600 if (strncasecmp (subject, "Re:", 3))
601 subject = talloc_asprintf (ctx, "Re: %s", subject);
602 g_mime_message_set_subject (reply, subject);
615 static int do_reply(notmuch_config_t *config,
616 notmuch_query_t *query,
617 notmuch_show_params_t *params,
619 notmuch_bool_t reply_all)
623 notmuch_messages_t *messages;
624 notmuch_message_t *message;
625 notmuch_status_t status;
626 struct sprinter *sp = NULL;
628 if (format == FORMAT_JSON || format == FORMAT_SEXP) {
631 status = notmuch_query_count_messages (query, &count);
632 if (print_status_query ("notmuch reply", query, status))
636 fprintf (stderr, "Error: search term did not match precisely one message (matched %u messages).\n", count);
640 if (format == FORMAT_JSON)
641 sp = sprinter_json_create (config, stdout);
643 sp = sprinter_sexp_create (config, stdout);
646 status = notmuch_query_search_messages (query, &messages);
647 if (print_status_query ("notmuch reply", query, status))
651 notmuch_messages_valid (messages);
652 notmuch_messages_move_to_next (messages))
654 message = notmuch_messages_get (messages);
656 if (mime_node_open (config, message, ¶ms->crypto, &node))
659 reply = create_reply_message (config, config, message,
660 GMIME_MESSAGE (node->part), reply_all,
661 format == FORMAT_HEADERS_ONLY);
665 if (format == FORMAT_JSON || format == FORMAT_SEXP) {
668 /* The headers of the reply message we've created */
669 sp->map_key (sp, "reply-headers");
670 format_headers_sprinter (sp, reply, TRUE);
672 /* Start the original */
673 sp->map_key (sp, "original");
674 format_part_sprinter (config, sp, node, TRUE, TRUE, FALSE);
679 GMimeStream *stream_stdout = stream_stdout = g_mime_stream_stdout_new ();
681 show_reply_headers (stream_stdout, reply);
682 if (format == FORMAT_DEFAULT)
683 format_part_reply (stream_stdout, node);
685 g_mime_stream_flush (stream_stdout);
686 g_object_unref(stream_stdout);
689 g_object_unref (G_OBJECT (reply));
692 notmuch_message_destroy (message);
699 notmuch_reply_command (notmuch_config_t *config, int argc, char *argv[])
701 notmuch_database_t *notmuch;
702 notmuch_query_t *query;
705 notmuch_show_params_t params = {
708 int format = FORMAT_DEFAULT;
709 int reply_all = TRUE;
711 notmuch_opt_desc_t options[] = {
712 { NOTMUCH_OPT_KEYWORD, &format, "format", 'f',
713 (notmuch_keyword_t []){ { "default", FORMAT_DEFAULT },
714 { "json", FORMAT_JSON },
715 { "sexp", FORMAT_SEXP },
716 { "headers-only", FORMAT_HEADERS_ONLY },
718 { NOTMUCH_OPT_INT, ¬much_format_version, "format-version", 0, 0 },
719 { NOTMUCH_OPT_KEYWORD, &reply_all, "reply-to", 'r',
720 (notmuch_keyword_t []){ { "all", TRUE },
723 { NOTMUCH_OPT_BOOLEAN, ¶ms.crypto.decrypt, "decrypt", 'd', 0 },
724 { NOTMUCH_OPT_INHERIT, (void *) ¬much_shared_options, NULL, 0, 0 },
728 opt_index = parse_arguments (argc, argv, options, 1);
732 notmuch_process_shared_options (argv[0]);
734 notmuch_exit_if_unsupported_format ();
736 query_string = query_string_from_args (config, argc-opt_index, argv+opt_index);
737 if (query_string == NULL) {
738 fprintf (stderr, "Out of memory\n");
742 if (*query_string == '\0') {
743 fprintf (stderr, "Error: notmuch reply requires at least one search term.\n");
747 params.crypto.gpgpath = notmuch_config_get_crypto_gpg_path (config);
749 if (notmuch_database_open (notmuch_config_get_database_path (config),
750 NOTMUCH_DATABASE_MODE_READ_ONLY, ¬much))
753 notmuch_exit_if_unmatched_db_uuid (notmuch);
755 query = notmuch_query_create (notmuch, query_string);
757 fprintf (stderr, "Out of memory\n");
761 if (do_reply (config, query, ¶ms, format, reply_all) != 0)
764 notmuch_crypto_cleanup (¶ms.crypto);
765 notmuch_query_destroy (query);
766 notmuch_database_destroy (notmuch);