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 http://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 strcmp (disposition->disposition, GMIME_DISPOSITION_ATTACHMENT) == 0) {
84 const char *filename = g_mime_part_get_filename (GMIME_PART (node->part));
85 printf ("Attachment: %s (%s)\n", filename,
86 g_mime_content_type_to_string (content_type));
88 printf ("Non-text part: %s\n",
89 g_mime_content_type_to_string (content_type));
93 for (i = 0; i < node->nchildren; i++)
94 format_part_reply (mime_node_child (node, i));
98 USER_ADDRESS_IN_STRING,
99 STRING_IN_USER_ADDRESS,
100 STRING_IS_USER_ADDRESS,
103 /* Match given string against given address according to mode. */
104 static notmuch_bool_t
105 match_address (const char *str, const char *address, address_match_t mode)
108 case USER_ADDRESS_IN_STRING:
109 return strcasestr (str, address) != NULL;
110 case STRING_IN_USER_ADDRESS:
111 return strcasestr (address, str) != NULL;
112 case STRING_IS_USER_ADDRESS:
113 return strcasecmp (address, str) == 0;
119 /* Match given string against user's configured "primary" and "other"
120 * addresses according to mode. */
122 address_match (const char *str, notmuch_config_t *config, address_match_t mode)
128 if (!str || *str == '\0')
131 primary = notmuch_config_get_user_primary_email (config);
132 if (match_address (str, primary, mode))
135 other = notmuch_config_get_user_other_email (config, &other_len);
136 for (i = 0; i < other_len; i++) {
137 if (match_address (str, other[i], mode))
144 /* Does the given string contain an address configured as one of the
145 * user's "primary" or "other" addresses. If so, return the matching
146 * address, NULL otherwise. */
148 user_address_in_string (const char *str, notmuch_config_t *config)
150 return address_match (str, config, USER_ADDRESS_IN_STRING);
153 /* Do any of the addresses configured as one of the user's "primary"
154 * or "other" addresses contain the given string. If so, return the
155 * matching address, NULL otherwise. */
157 string_in_user_address (const char *str, notmuch_config_t *config)
159 return address_match (str, config, STRING_IN_USER_ADDRESS);
162 /* Is the given address configured as one of the user's "primary" or
163 * "other" addresses. */
164 static notmuch_bool_t
165 address_is_users (const char *address, notmuch_config_t *config)
167 return address_match (address, config, STRING_IS_USER_ADDRESS) != NULL;
170 /* Scan addresses in 'list'.
172 * If 'message' is non-NULL, then for each address in 'list' that is
173 * not configured as one of the user's addresses in 'config', add that
174 * address to 'message' as an address of 'type'.
176 * If 'user_from' is non-NULL and *user_from is NULL, *user_from will
177 * be set to the first address encountered in 'list' that is the
180 * Return the number of addresses added to 'message'. (If 'message' is
181 * NULL, the function returns 0 by definition.)
184 scan_address_list (InternetAddressList *list,
185 notmuch_config_t *config,
186 GMimeMessage *message,
187 GMimeRecipientType type,
188 const char **user_from)
190 InternetAddress *address;
194 for (i = 0; i < internet_address_list_length (list); i++) {
195 address = internet_address_list_get_address (list, i);
196 if (INTERNET_ADDRESS_IS_GROUP (address)) {
197 InternetAddressGroup *group;
198 InternetAddressList *group_list;
200 group = INTERNET_ADDRESS_GROUP (address);
201 group_list = internet_address_group_get_members (group);
202 if (group_list == NULL)
205 n += scan_address_list (group_list, config, message, type, user_from);
207 InternetAddressMailbox *mailbox;
211 mailbox = INTERNET_ADDRESS_MAILBOX (address);
213 name = internet_address_get_name (address);
214 addr = internet_address_mailbox_get_addr (mailbox);
216 if (address_is_users (addr, config)) {
217 if (user_from && *user_from == NULL)
219 } else if (message) {
220 g_mime_message_add_recipient (message, type, name, addr);
229 /* Scan addresses in 'recipients'.
231 * See the documentation of scan_address_list() above. This function
232 * does exactly the same, but converts 'recipients' to an
233 * InternetAddressList first.
236 scan_address_string (const char *recipients,
237 notmuch_config_t *config,
238 GMimeMessage *message,
239 GMimeRecipientType type,
240 const char **user_from)
242 InternetAddressList *list;
244 if (recipients == NULL)
247 list = internet_address_list_parse_string (recipients);
251 return scan_address_list (list, config, message, type, user_from);
254 /* Does the address in the Reply-To header of 'message' already appear
255 * in either the 'To' or 'Cc' header of the message?
258 reply_to_header_is_redundant (notmuch_message_t *message)
260 const char *reply_to, *to, *cc, *addr;
261 InternetAddressList *list;
262 InternetAddress *address;
263 InternetAddressMailbox *mailbox;
265 reply_to = notmuch_message_get_header (message, "reply-to");
266 if (reply_to == NULL || *reply_to == '\0')
269 list = internet_address_list_parse_string (reply_to);
271 if (internet_address_list_length (list) != 1)
274 address = internet_address_list_get_address (list, 0);
275 if (INTERNET_ADDRESS_IS_GROUP (address))
278 mailbox = INTERNET_ADDRESS_MAILBOX (address);
279 addr = internet_address_mailbox_get_addr (mailbox);
281 to = notmuch_message_get_header (message, "to");
282 cc = notmuch_message_get_header (message, "cc");
284 if ((to && strstr (to, addr) != 0) ||
285 (cc && strstr (cc, addr) != 0))
293 /* Augment the recipients of 'reply' from the "Reply-to:", "From:",
294 * "To:", "Cc:", and "Bcc:" headers of 'message'.
296 * If 'reply_all' is true, use sender and all recipients, otherwise
297 * scan the headers for the first that contains something other than
298 * the user's addresses and add the recipients from this header
299 * (typically this would be reply-to-sender, but also handles reply to
300 * user's own message in a sensible way).
302 * If any of the user's addresses were found in these headers, the
303 * first of these returned, otherwise NULL is returned.
306 add_recipients_from_message (GMimeMessage *reply,
307 notmuch_config_t *config,
308 notmuch_message_t *message,
309 notmuch_bool_t reply_all)
313 const char *fallback;
314 GMimeRecipientType recipient_type;
316 { "reply-to", "from", GMIME_RECIPIENT_TYPE_TO },
317 { "to", NULL, GMIME_RECIPIENT_TYPE_TO },
318 { "cc", NULL, GMIME_RECIPIENT_TYPE_CC },
319 { "bcc", NULL, GMIME_RECIPIENT_TYPE_BCC }
321 const char *from_addr = NULL;
325 /* Some mailing lists munge the Reply-To header despite it being A Bad
326 * Thing, see http://www.unicom.com/pw/reply-to-harmful.html
328 * The munging is easy to detect, because it results in a
329 * redundant reply-to header, (with an address that already exists
330 * in either To or Cc). So in this case, we ignore the Reply-To
331 * field and use the From header. This ensures the original sender
332 * will get the reply even if not subscribed to the list. Note
333 * that the address in the Reply-To header will always appear in
336 if (reply_to_header_is_redundant (message)) {
337 reply_to_map[0].header = "from";
338 reply_to_map[0].fallback = NULL;
341 for (i = 0; i < ARRAY_SIZE (reply_to_map); i++) {
342 const char *recipients;
344 recipients = notmuch_message_get_header (message,
345 reply_to_map[i].header);
346 if ((recipients == NULL || recipients[0] == '\0') && reply_to_map[i].fallback)
347 recipients = notmuch_message_get_header (message,
348 reply_to_map[i].fallback);
350 n += scan_address_string (recipients, config, reply,
351 reply_to_map[i].recipient_type, &from_addr);
353 if (!reply_all && n) {
354 /* Stop adding new recipients in reply-to-sender mode if
355 * we have added some recipient(s) above.
357 * This also handles the case of user replying to his own
358 * message, where reply-to/from is not a recipient. In
359 * this case there may be more than one recipient even if
360 * not replying to all.
364 /* From address and some recipients are enough, bail out. */
374 * Look for the user's address in " for <email@add.res>" in the
377 * Return the address that was found, if any, and NULL otherwise.
380 guess_from_in_received_for (notmuch_config_t *config, const char *received)
384 ptr = strstr (received, " for ");
388 return user_address_in_string (ptr, config);
392 * Parse all the " by MTA ..." parts in received headers to guess the
393 * email address that this was originally delivered to.
395 * Extract just the MTA here by removing leading whitespace and
396 * assuming that the MTA name ends at the next whitespace. Test for
397 * *(by+4) to be non-'\0' to make sure there's something there at all
398 * - and then assume that the first whitespace delimited token that
399 * follows is the receiving system in this step of the receive chain.
401 * Return the address that was found, if any, and NULL otherwise.
404 guess_from_in_received_by (notmuch_config_t *config, const char *received)
407 const char *by = received;
408 char *domain, *tld, *mta, *ptr, *token;
410 while ((by = strstr (by, " by ")) != NULL) {
415 token = strtok(mta," \t");
421 * Now extract the last two components of the MTA host name as
425 while ((ptr = strsep (&token, ". \t")) != NULL) {
434 * Recombine domain and tld and look for it among the
435 * configured email addresses. This time we have a known
436 * domain name and nothing else - so the test is the other
437 * way around: we check if this is a substring of one of
438 * the email addresses.
442 addr = string_in_user_address (domain, config);
455 * Get the concatenated Received: headers and search from the front
456 * (last Received: header added) and try to extract from them
457 * indications to which email address this message was delivered.
459 * The Received: header is special in our get_header function and is
460 * always concatenated.
462 * Return the address that was found, if any, and NULL otherwise.
465 guess_from_in_received_headers (notmuch_config_t *config,
466 notmuch_message_t *message)
468 const char *received, *addr;
471 received = notmuch_message_get_header (message, "received");
475 sanitized = sanitize_string (NULL, received);
479 addr = guess_from_in_received_for (config, sanitized);
481 addr = guess_from_in_received_by (config, sanitized);
483 talloc_free (sanitized);
489 * Try to find user's email address in one of the extra To-like
490 * headers: Envelope-To, X-Original-To, and Delivered-To (searched in
493 * Return the address that was found, if any, and NULL otherwise.
496 get_from_in_to_headers (notmuch_config_t *config, notmuch_message_t *message)
499 const char *tohdr, *addr;
500 const char *to_headers[] = {
506 for (i = 0; i < ARRAY_SIZE (to_headers); i++) {
507 tohdr = notmuch_message_get_header (message, to_headers[i]);
509 /* Note: tohdr potentially contains a list of email addresses. */
510 addr = user_address_in_string (tohdr, config);
518 static GMimeMessage *
519 create_reply_message(void *ctx,
520 notmuch_config_t *config,
521 notmuch_message_t *message,
522 notmuch_bool_t reply_all)
524 const char *subject, *from_addr = NULL;
525 const char *in_reply_to, *orig_references, *references;
527 /* The 1 means we want headers in a "pretty" order. */
528 GMimeMessage *reply = g_mime_message_new (1);
530 fprintf (stderr, "Out of memory\n");
534 subject = notmuch_message_get_header (message, "subject");
536 if (strncasecmp (subject, "Re:", 3))
537 subject = talloc_asprintf (ctx, "Re: %s", subject);
538 g_mime_message_set_subject (reply, subject);
541 from_addr = add_recipients_from_message (reply, config,
545 * Sadly, there is no standard way to find out to which email
546 * address a mail was delivered - what is in the headers depends
547 * on the MTAs used along the way.
549 * If none of the user's email addresses are in the To: or Cc:
550 * headers, we try a number of heuristics which hopefully will
551 * answer this question.
553 * First, check for Envelope-To:, X-Original-To:, and
554 * Delivered-To: headers.
556 if (from_addr == NULL)
557 from_addr = get_from_in_to_headers (config, message);
560 * Check for a (for <email@add.res>) clause in Received: headers,
561 * and the domain part of known email addresses in the 'by' part
562 * of Received: headers
564 if (from_addr == NULL)
565 from_addr = guess_from_in_received_headers (config, message);
567 /* Default to user's primary address. */
568 if (from_addr == NULL)
569 from_addr = notmuch_config_get_user_primary_email (config);
571 from_addr = talloc_asprintf (ctx, "%s <%s>",
572 notmuch_config_get_user_name (config),
574 g_mime_object_set_header (GMIME_OBJECT (reply),
577 in_reply_to = talloc_asprintf (ctx, "<%s>",
578 notmuch_message_get_message_id (message));
580 g_mime_object_set_header (GMIME_OBJECT (reply),
581 "In-Reply-To", in_reply_to);
583 orig_references = notmuch_message_get_header (message, "references");
584 if (!orig_references)
585 /* Treat errors like missing References headers. */
586 orig_references = "";
587 references = talloc_asprintf (ctx, "%s%s%s",
588 *orig_references ? orig_references : "",
589 *orig_references ? " " : "",
591 g_mime_object_set_header (GMIME_OBJECT (reply),
592 "References", references);
598 notmuch_reply_format_default(void *ctx,
599 notmuch_config_t *config,
600 notmuch_query_t *query,
601 notmuch_show_params_t *params,
602 notmuch_bool_t reply_all,
603 unused (sprinter_t *sp))
606 notmuch_messages_t *messages;
607 notmuch_message_t *message;
610 for (messages = notmuch_query_search_messages (query);
611 notmuch_messages_valid (messages);
612 notmuch_messages_move_to_next (messages))
614 message = notmuch_messages_get (messages);
616 reply = create_reply_message (ctx, config, message, reply_all);
618 /* If reply creation failed, we're out of memory, so don't
619 * bother trying any more messages.
622 notmuch_message_destroy (message);
626 show_reply_headers (reply);
628 g_object_unref (G_OBJECT (reply));
631 if (mime_node_open (ctx, message, &(params->crypto), &root) == NOTMUCH_STATUS_SUCCESS) {
632 format_part_reply (root);
636 notmuch_message_destroy (message);
642 notmuch_reply_format_sprinter(void *ctx,
643 notmuch_config_t *config,
644 notmuch_query_t *query,
645 notmuch_show_params_t *params,
646 notmuch_bool_t reply_all,
650 notmuch_messages_t *messages;
651 notmuch_message_t *message;
654 if (notmuch_query_count_messages (query) != 1) {
655 fprintf (stderr, "Error: search term did not match precisely one message.\n");
659 messages = notmuch_query_search_messages (query);
660 message = notmuch_messages_get (messages);
661 if (mime_node_open (ctx, message, &(params->crypto), &node) != NOTMUCH_STATUS_SUCCESS)
664 reply = create_reply_message (ctx, config, message, reply_all);
670 /* The headers of the reply message we've created */
671 sp->map_key (sp, "reply-headers");
672 format_headers_sprinter (sp, reply, TRUE);
673 g_object_unref (G_OBJECT (reply));
676 /* Start the original */
677 sp->map_key (sp, "original");
678 format_part_sprinter (ctx, sp, node, TRUE, TRUE, FALSE);
682 notmuch_message_destroy (message);
687 /* This format is currently tuned for a git send-email --notmuch hook */
689 notmuch_reply_format_headers_only(void *ctx,
690 notmuch_config_t *config,
691 notmuch_query_t *query,
692 unused (notmuch_show_params_t *params),
693 notmuch_bool_t reply_all,
694 unused (sprinter_t *sp))
697 notmuch_messages_t *messages;
698 notmuch_message_t *message;
699 const char *in_reply_to, *orig_references, *references;
702 for (messages = notmuch_query_search_messages (query);
703 notmuch_messages_valid (messages);
704 notmuch_messages_move_to_next (messages))
706 message = notmuch_messages_get (messages);
708 /* The 0 means we do not want headers in a "pretty" order. */
709 reply = g_mime_message_new (0);
711 fprintf (stderr, "Out of memory\n");
715 in_reply_to = talloc_asprintf (ctx, "<%s>",
716 notmuch_message_get_message_id (message));
718 g_mime_object_set_header (GMIME_OBJECT (reply),
719 "In-Reply-To", in_reply_to);
722 orig_references = notmuch_message_get_header (message, "references");
724 /* We print In-Reply-To followed by References because git format-patch treats them
725 * specially. Git does not interpret the other headers specially
727 references = talloc_asprintf (ctx, "%s%s%s",
728 orig_references ? orig_references : "",
729 orig_references ? " " : "",
731 g_mime_object_set_header (GMIME_OBJECT (reply),
732 "References", references);
734 (void)add_recipients_from_message (reply, config, message, reply_all);
736 reply_headers = g_mime_object_to_string (GMIME_OBJECT (reply));
737 printf ("%s", reply_headers);
738 free (reply_headers);
740 g_object_unref (G_OBJECT (reply));
743 notmuch_message_destroy (message);
756 notmuch_reply_command (notmuch_config_t *config, int argc, char *argv[])
758 notmuch_database_t *notmuch;
759 notmuch_query_t *query;
762 int (*reply_format_func) (void *ctx,
763 notmuch_config_t *config,
764 notmuch_query_t *query,
765 notmuch_show_params_t *params,
766 notmuch_bool_t reply_all,
767 struct sprinter *sp);
768 notmuch_show_params_t params = {
775 int format = FORMAT_DEFAULT;
776 int reply_all = TRUE;
777 struct sprinter *sp = NULL;
779 notmuch_opt_desc_t options[] = {
780 { NOTMUCH_OPT_KEYWORD, &format, "format", 'f',
781 (notmuch_keyword_t []){ { "default", FORMAT_DEFAULT },
782 { "json", FORMAT_JSON },
783 { "sexp", FORMAT_SEXP },
784 { "headers-only", FORMAT_HEADERS_ONLY },
786 { NOTMUCH_OPT_INT, ¬much_format_version, "format-version", 0, 0 },
787 { NOTMUCH_OPT_KEYWORD, &reply_all, "reply-to", 'r',
788 (notmuch_keyword_t []){ { "all", TRUE },
791 { NOTMUCH_OPT_BOOLEAN, ¶ms.crypto.decrypt, "decrypt", 'd', 0 },
795 opt_index = parse_arguments (argc, argv, options, 1);
799 if (format == FORMAT_HEADERS_ONLY) {
800 reply_format_func = notmuch_reply_format_headers_only;
801 } else if (format == FORMAT_JSON) {
802 reply_format_func = notmuch_reply_format_sprinter;
803 sp = sprinter_json_create (config, stdout);
804 } else if (format == FORMAT_SEXP) {
805 reply_format_func = notmuch_reply_format_sprinter;
806 sp = sprinter_sexp_create (config, stdout);
808 reply_format_func = notmuch_reply_format_default;
811 notmuch_exit_if_unsupported_format ();
813 query_string = query_string_from_args (config, argc-opt_index, argv+opt_index);
814 if (query_string == NULL) {
815 fprintf (stderr, "Out of memory\n");
819 if (*query_string == '\0') {
820 fprintf (stderr, "Error: notmuch reply requires at least one search term.\n");
824 if (notmuch_database_open (notmuch_config_get_database_path (config),
825 NOTMUCH_DATABASE_MODE_READ_ONLY, ¬much))
828 query = notmuch_query_create (notmuch, query_string);
830 fprintf (stderr, "Out of memory\n");
834 if (reply_format_func (config, config, query, ¶ms, reply_all, sp) != 0)
837 notmuch_crypto_cleanup (¶ms.crypto);
838 notmuch_query_destroy (query);
839 notmuch_database_destroy (notmuch);