1 ;;; notmuch-show.el --- displaying notmuch forests -*- lexical-binding: t -*-
3 ;; Copyright © Carl Worth
4 ;; Copyright © David Edmondson
6 ;; This file is part of Notmuch.
8 ;; Notmuch is free software: you can redistribute it and/or modify it
9 ;; under the terms of the GNU General Public License as published by
10 ;; the Free Software Foundation, either version 3 of the License, or
11 ;; (at your option) any later version.
13 ;; Notmuch is distributed in the hope that it will be useful, but
14 ;; WITHOUT ANY WARRANTY; without even the implied warranty of
15 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 ;; General Public License for more details.
18 ;; You should have received a copy of the GNU General Public License
19 ;; along with Notmuch. If not, see <https://www.gnu.org/licenses/>.
21 ;; Authors: Carl Worth <cworth@cworth.org>
22 ;; David Edmondson <dme@dme.org>
33 (require 'notmuch-lib)
34 (require 'notmuch-tag)
35 (require 'notmuch-query)
36 (require 'notmuch-wash)
37 (require 'notmuch-mua)
38 (require 'notmuch-crypto)
39 (require 'notmuch-print)
40 (require 'notmuch-draft)
42 (declare-function notmuch-call-notmuch-process "notmuch" (&rest args))
43 (declare-function notmuch-search-next-thread "notmuch" nil)
44 (declare-function notmuch-search-previous-thread "notmuch" nil)
45 (declare-function notmuch-search-show-thread "notmuch" nil)
46 (declare-function notmuch-foreach-mime-part "notmuch" (function mm-handle))
47 (declare-function notmuch-count-attachments "notmuch" (mm-handle))
48 (declare-function notmuch-save-attachments "notmuch" (mm-handle &optional queryp))
49 (declare-function notmuch-tree "notmuch-tree"
50 (&optional query query-context target buffer-name
51 open-target unthreaded))
52 (declare-function notmuch-tree-get-message-properties "notmuch-tree" nil)
53 (declare-function notmuch-unthreaded
54 (&optional query query-context target buffer-name open-target))
55 (declare-function notmuch-read-query "notmuch" (prompt))
56 (declare-function notmuch-draft-resume "notmuch-draft" (id))
58 (defvar shr-blocked-images)
59 (defvar gnus-blocked-images)
60 (defvar shr-content-function)
64 (defcustom notmuch-message-headers '("Subject" "To" "Cc" "Date")
65 "Headers that should be shown in a message, in this order.
67 For an open message, all of these headers will be made visible
68 according to `notmuch-message-headers-visible' or can be toggled
69 with `notmuch-show-toggle-visibility-headers'. For a closed message,
70 only the first header in the list will be visible."
71 :type '(repeat string)
74 (defcustom notmuch-message-headers-visible t
75 "Should the headers be visible by default?
77 If this value is non-nil, then all of the headers defined in
78 `notmuch-message-headers' will be visible by default in the display
79 of each message. Otherwise, these headers will be hidden and
80 `notmuch-show-toggle-visibility-headers' can be used to make them
81 visible for any given message."
85 (defcustom notmuch-show-relative-dates t
86 "Display relative dates in the message summary line."
90 (defvar notmuch-show-markup-headers-hook '(notmuch-show-colour-headers)
91 "A list of functions called to decorate the headers listed in
92 `notmuch-message-headers'.")
94 (defcustom notmuch-show-hook '(notmuch-show-turn-on-visual-line-mode)
95 "Functions called after populating a `notmuch-show' buffer."
97 :options '(notmuch-show-turn-on-visual-line-mode)
99 :group 'notmuch-hooks)
101 (defcustom notmuch-show-insert-text/plain-hook
102 '(notmuch-wash-wrap-long-lines
103 notmuch-wash-tidy-citations
104 notmuch-wash-elide-blank-lines
105 notmuch-wash-excerpt-citations)
106 "Functions used to improve the display of text/plain parts."
108 :options '(notmuch-wash-convert-inline-patch-to-part
109 notmuch-wash-wrap-long-lines
110 notmuch-wash-tidy-citations
111 notmuch-wash-elide-blank-lines
112 notmuch-wash-excerpt-citations)
114 :group 'notmuch-hooks)
116 (defcustom notmuch-show-max-text-part-size 100000
117 "Maximum size of a text part to be shown by default in characters.
119 Set to 0 to show the part regardless of size."
121 :group 'notmuch-show)
123 ;; Mostly useful for debugging.
124 (defcustom notmuch-show-all-multipart/alternative-parts nil
125 "Should all parts of multipart/alternative parts be shown?"
127 :group 'notmuch-show)
129 (defcustom notmuch-show-indent-messages-width 1
130 "Width of message indentation in threads.
132 Messages are shown indented according to their depth in a thread.
133 This variable determines the width of this indentation measured
134 in number of blanks. Defaults to `1', choose `0' to disable
137 :group 'notmuch-show)
139 (defcustom notmuch-show-indent-multipart nil
140 "Should the sub-parts of a multipart/* part be indented?"
141 ;; dme: Not sure which is a good default.
143 :group 'notmuch-show)
145 (defcustom notmuch-show-part-button-default-action 'notmuch-show-save-part
146 "Default part header button action (on ENTER or mouse click)."
148 :type '(choice (const :tag "Save part"
149 notmuch-show-save-part)
150 (const :tag "View part"
151 notmuch-show-view-part)
152 (const :tag "View interactively"
153 notmuch-show-interactively-view-part)))
155 (defcustom notmuch-show-only-matching-messages nil
156 "Only matching messages are shown by default."
158 :group 'notmuch-show)
160 ;; By default, block all external images to prevent privacy leaks and
161 ;; potential attacks.
162 (defcustom notmuch-show-text/html-blocked-images "."
163 "Remote images that have URLs matching this regexp will be blocked."
164 :type '(choice (const nil) regexp)
165 :group 'notmuch-show)
169 (defvar-local notmuch-show-thread-id nil)
171 (defvar-local notmuch-show-parent-buffer nil)
173 (defvar-local notmuch-show-query-context nil)
175 (defvar-local notmuch-show-process-crypto nil)
177 (defvar-local notmuch-show-elide-non-matching-messages nil)
179 (defvar-local notmuch-show-indent-content t)
181 (defvar notmuch-show-attachment-debug nil
182 "If t log stdout and stderr from attachment handlers.
184 When set to nil (the default) stdout and stderr from attachment
185 handlers is discarded. When set to t the stdout and stderr from
186 each attachment handler is logged in buffers with names beginning
187 \" *notmuch-part*\".")
191 (defcustom notmuch-show-stash-mlarchive-link-alist
192 '(("Gmane" . "https://mid.gmane.org/")
193 ("MARC" . "https://marc.info/?i=")
194 ("Mail Archive, The" . "https://mid.mail-archive.com/")
195 ("LKML" . "https://lkml.kernel.org/r/")
196 ;; FIXME: can these services be searched by `Message-Id' ?
197 ;; ("MarkMail" . "http://markmail.org/")
198 ;; ("Nabble" . "http://nabble.com/")
199 ;; ("opensubscriber" . "http://opensubscriber.com/")
201 "List of Mailing List Archives to use when stashing links.
203 This list is used for generating a Mailing List Archive reference
204 URI with the current message's Message-Id in
205 `notmuch-show-stash-mlarchive-link'.
207 If the cdr of the alist element is not a function, the cdr is
208 expected to contain a URI that is concatenated with the current
209 message's Message-Id to create a ML archive reference URI.
211 If the cdr is a function, the function is called with the
212 Message-Id as the argument, and the function is expected to
213 return the ML archive reference URI."
214 :type '(alist :key-type (string :tag "Name")
217 (function :tag "Function returning the URL")))
218 :group 'notmuch-show)
220 (defcustom notmuch-show-stash-mlarchive-link-default "Gmane"
221 "Default Mailing List Archive to use when stashing links.
223 This is used when `notmuch-show-stash-mlarchive-link' isn't
224 provided with an MLA argument nor `completing-read' input."
228 (list 'const :tag (car mla) :value (car mla)))
229 notmuch-show-stash-mlarchive-link-alist))
230 :group 'notmuch-show)
232 (defcustom notmuch-show-mark-read-tags '("-unread")
233 "List of tag changes to apply to a message when it is marked as read.
235 Tags starting with \"+\" (or not starting with either \"+\" or
236 \"-\") in the list will be added, and tags starting with \"-\"
237 will be removed from the message being marked as read.
239 For example, if you wanted to remove an \"unread\" tag and add a
240 \"read\" tag (which would make little sense), you would set:
241 (\"-unread\" \"+read\")"
242 :type '(repeat string)
243 :group 'notmuch-show)
245 (defcustom notmuch-show-mark-read-function #'notmuch-show-seen-current-message
246 "Function to control which messages are marked read.
248 The function should take two arguments START and END which will
249 be the start and end of the visible portion of the buffer and
250 should mark the appropriate messages read by applying
251 `notmuch-show-mark-read'. This function will be called after
252 every user interaction with notmuch."
254 :group 'notmuch-show)
256 (defcustom notmuch-show-imenu-indent nil
257 "Should Imenu display messages indented.
259 By default, Imenu (see Info node `(emacs) Imenu') in a
260 notmuch-show buffer displays all messages straight. This is
261 because the default Emacs frontend for Imenu makes it difficult
262 to select an Imenu entry with spaces in front. Other imenu
263 frontends such as counsel-imenu does not have this limitation.
264 In these cases, Imenu entries can be indented to reflect the
265 position of the message in the thread."
267 :group 'notmuch-show)
271 (defmacro with-current-notmuch-show-message (&rest body)
272 "Evaluate body with current buffer set to the text of current message."
274 (let ((id (notmuch-show-get-message-id)))
275 (let ((buf (generate-new-buffer (concat "*notmuch-msg-" id "*"))))
276 (with-current-buffer buf
277 (let ((coding-system-for-read 'no-conversion))
278 (call-process notmuch-command nil t nil "show" "--format=raw" id))
280 (kill-buffer buf)))))
282 (defun notmuch-show-turn-on-visual-line-mode ()
283 "Enable Visual Line mode."
284 (visual-line-mode t))
288 ;; DEPRECATED in Notmuch 0.16 since we now have convenient part
289 ;; commands. We'll keep the command around for a version or two in
290 ;; case people want to bind it themselves.
291 (defun notmuch-show-view-all-mime-parts ()
292 "Use external viewers to view all attachments from the current message."
294 (with-current-notmuch-show-message
295 ;; We override the mm-inline-media-tests to indicate which message
296 ;; parts are already sufficiently handled by the original
297 ;; presentation of the message in notmuch-show mode. These parts
298 ;; will be inserted directly into the temporary buffer of
299 ;; with-current-notmuch-show-message and silently discarded.
301 ;; Any MIME part not explicitly mentioned here will be handled by an
302 ;; external viewer as configured in the various mailcap files.
303 (let ((mm-inline-media-tests
304 '(("text/.*" ignore identity)
305 ("application/pgp-signature" ignore identity)
306 ("multipart/alternative" ignore identity)
307 ("multipart/mixed" ignore identity)
308 ("multipart/related" ignore identity))))
309 (mm-display-parts (mm-dissect-buffer)))))
311 (defun notmuch-show-save-attachments ()
312 "Save all attachments from the current message."
314 (with-current-notmuch-show-message
315 (let ((mm-handle (mm-dissect-buffer)))
316 (notmuch-save-attachments
317 mm-handle (> (notmuch-count-attachments mm-handle) 1))))
320 (defun notmuch-show-with-message-as-text (fn)
321 "Apply FN to a text representation of the current message.
323 FN is called with one argument, the message properties. It should
324 operation on the contents of the current buffer."
325 ;; Remake the header to ensure that all information is available.
326 (let* ((to (notmuch-show-get-to))
327 (cc (notmuch-show-get-cc))
328 (from (notmuch-show-get-from))
329 (subject (notmuch-show-get-subject))
330 (date (notmuch-show-get-date))
331 (tags (notmuch-show-get-tags))
332 (depth (notmuch-show-get-depth))
334 "Subject: " subject "\n"
336 (if (not (string-empty-p cc))
337 (concat "Cc: " cc "\n")
343 (mapconcat #'identity tags ", ") "\n")
345 (all (buffer-substring (notmuch-show-message-top)
346 (notmuch-show-message-bottom)))
348 (props (notmuch-show-get-message-properties))
349 (indenting notmuch-show-indent-content))
353 (indent-rigidly (point-min)
355 (- (* notmuch-show-indent-messages-width depth))))
356 ;; Remove the original header.
357 (goto-char (point-min))
358 (re-search-forward "^$" (point-max) nil)
359 (delete-region (point-min) (point))
361 (funcall fn props))))
363 (defun notmuch-show-print-message ()
364 "Print the current message."
366 (notmuch-show-with-message-as-text 'notmuch-print-message))
370 (defun notmuch-show-fontify-header ()
372 ((looking-at "[Tt]o:")
374 ((looking-at "[Bb]?[Cc][Cc]:")
376 ((looking-at "[Ss]ubject:")
377 'message-header-subject)
379 'message-header-other))))
380 (overlay-put (make-overlay (point) (re-search-forward ":"))
381 'face 'message-header-name)
382 (overlay-put (make-overlay (point) (re-search-forward ".*$"))
385 (defun notmuch-show-colour-headers ()
386 "Apply some colouring to the current headers."
387 (goto-char (point-min))
388 (while (looking-at "^[A-Za-z][-A-Za-z0-9]*:")
389 (notmuch-show-fontify-header)
392 (defun notmuch-show-spaces-n (n)
393 "Return a string comprised of `n' spaces."
396 (defun notmuch-show-update-tags (tags)
397 "Update the displayed tags of the current message."
399 (goto-char (notmuch-show-message-top))
400 (when (re-search-forward "(\\([^()]*\\))$" (line-end-position) t)
401 (let ((inhibit-read-only t))
402 (replace-match (concat "("
403 (notmuch-tag-format-tags
405 (notmuch-show-get-prop :orig-tags))
408 (defun notmuch-clean-address (address)
409 "Try to clean a single email ADDRESS for display. Return a cons
410 cell of (AUTHOR_EMAIL AUTHOR_NAME). Return (ADDRESS nil) if
413 (let (p-name p-address)
414 ;; It would be convenient to use `mail-header-parse-address',
415 ;; but that expects un-decoded mailbox parts, whereas our
416 ;; mailbox parts are already decoded (and hence may contain
417 ;; UTF-8). Given that notmuch should handle most of the awkward
418 ;; cases, some simple string deconstruction should be sufficient
421 ;; "User <user@dom.ain>" style.
422 ((string-match "\\(.*\\) <\\(.*\\)>" address)
423 (setq p-name (match-string 1 address))
424 (setq p-address (match-string 2 address)))
426 ;; "<user@dom.ain>" style.
427 ((string-match "<\\(.*\\)>" address)
428 (setq p-address (match-string 1 address)))
431 (setq p-address address)))
433 ;; Remove elements of the mailbox part that are not relevant for
434 ;; display, even if they are required during transport:
437 (setq p-name (replace-regexp-in-string "\\\\" "" p-name))
438 ;; Outer single and double quotes, which might be nested.
439 (cl-loop with start-of-loop
440 do (setq start-of-loop p-name)
441 when (string-match "^\"\\(.*\\)\"$" p-name)
442 do (setq p-name (match-string 1 p-name))
443 when (string-match "^'\\(.*\\)'$" p-name)
444 do (setq p-name (match-string 1 p-name))
445 until (string= start-of-loop p-name)))
446 ;; If the address is 'foo@bar.com <foo@bar.com>' then show just
448 (when (string= p-name p-address)
450 (cons p-address p-name))
451 (error (cons address nil))))
453 (defun notmuch-show-clean-address (address)
454 "Try to clean a single email ADDRESS for display.
455 Return unchanged ADDRESS if parsing fails."
456 (let* ((clean-address (notmuch-clean-address address))
457 (p-address (car clean-address))
458 (p-name (cdr clean-address)))
459 ;; If no name, return just the address.
462 ;; Otherwise format the name and address together.
463 (concat p-name " <" p-address ">"))))
465 (defun notmuch-show-insert-headerline (headers date tags depth)
466 "Insert a notmuch style headerline based on HEADERS for a
467 message at DEPTH in the current thread."
468 (let ((start (point))
469 (from (notmuch-sanitize
470 (notmuch-show-clean-address (plist-get headers :From)))))
471 (when (string-match "\\cR" from)
472 ;; If the From header has a right-to-left character add
473 ;; invisible U+200E LEFT-TO-RIGHT MARK character which forces
474 ;; the header paragraph as left-to-right text.
475 (insert (propertize (string ?\x200e) 'invisible t)))
476 (insert (if notmuch-show-indent-content
477 (notmuch-show-spaces-n (* notmuch-show-indent-messages-width
484 (notmuch-tag-format-tags tags tags)
486 (overlay-put (make-overlay start (point))
487 'face 'notmuch-message-summary-face)))
489 (defun notmuch-show-insert-header (header header-value)
490 "Insert a single header."
491 (insert header ": " (notmuch-sanitize header-value) "\n"))
493 (defun notmuch-show-insert-headers (headers)
494 "Insert the headers of the current message."
495 (let ((start (point)))
496 (mapc (lambda (header)
497 (let* ((header-symbol (intern (concat ":" header)))
498 (header-value (plist-get headers header-symbol)))
499 (when (and header-value
500 (not (string-equal "" header-value)))
501 (notmuch-show-insert-header header header-value))))
502 notmuch-message-headers)
505 (narrow-to-region start (point-max))
506 (run-hooks 'notmuch-show-markup-headers-hook)))))
510 (define-button-type 'notmuch-show-part-button-type
511 'action 'notmuch-show-part-button-default
514 :supertype 'notmuch-button-type)
516 (defun notmuch-show-insert-part-header (_nth content-type declared-type
517 &optional name comment)
518 (let ((base-label (concat (and name (concat name ": "))
520 (and (not (string-equal declared-type content-type))
521 (concat " (as " content-type ")"))
523 (prog1 (insert-button
524 (concat "[ " base-label " ]")
525 :base-label base-label
526 :type 'notmuch-show-part-button-type
527 :notmuch-part-hidden nil)
530 (defun notmuch-show-toggle-part-invisibility (&optional button)
532 (let ((button (or button (button-at (point)))))
534 (let ((overlay (button-get button 'overlay))
535 (lazy-part (button-get button :notmuch-lazy-part)))
536 ;; We have a part to toggle if there is an overlay or if there
537 ;; is a lazy part. If neither is present we cannot toggle the
538 ;; part so we just return nil.
539 (when (or overlay lazy-part)
540 (let* ((show (button-get button :notmuch-part-hidden))
541 (new-start (button-start button))
542 (button-label (button-get button :base-label))
544 (properties (text-properties-at (button-start button)))
545 (inhibit-read-only t))
546 ;; Toggle the button itself.
547 (button-put button :notmuch-part-hidden (not show))
548 (goto-char new-start)
549 (insert "[ " button-label (if show " ]" " (hidden) ]"))
550 (set-text-properties new-start (point) properties)
551 (let ((old-end (button-end button)))
552 (move-overlay button new-start (point))
553 (delete-region (point) old-end))
554 (goto-char (min old-point (1- (button-end button))))
555 ;; Return nil if there is a lazy-part, it is empty, and we are
556 ;; trying to show it. In all other cases return t.
559 (button-put button :notmuch-lazy-part nil)
560 (notmuch-show-lazy-part lazy-part button))
561 ;; else there must be an overlay.
562 (overlay-put overlay 'invisible (not show))
565 ;;; Part content ID handling
567 (defvar notmuch-show--cids nil
568 "Alist from raw content ID to (MSG PART).")
569 (make-variable-buffer-local 'notmuch-show--cids)
571 (defun notmuch-show--register-cids (msg part)
572 "Register content-IDs in PART and all of PART's sub-parts."
573 (let ((content-id (plist-get part :content-id)))
575 ;; Note that content-IDs are globally unique, except when they
576 ;; aren't: RFC 2046 section 5.1.4 permits children of a
577 ;; multipart/alternative to have the same content-ID, in which
578 ;; case the MUA is supposed to pick the best one it can render.
579 ;; We simply add the content-ID to the beginning of our alist;
580 ;; so if this happens, we'll take the last (and "best")
581 ;; alternative (even if we can't render it).
582 (push (list content-id msg part) notmuch-show--cids)))
583 ;; Recurse on sub-parts
584 (pcase-let ((`(,type ,subtype)
585 (split-string (downcase (plist-get part :content-type)) "/")))
586 (cond ((equal type "multipart")
587 (mapc (apply-partially #'notmuch-show--register-cids msg)
588 (plist-get part :content)))
589 ((and (equal type "message")
590 (equal subtype "rfc822"))
591 (notmuch-show--register-cids
593 (car (plist-get (car (plist-get part :content)) :body)))))))
595 (defun notmuch-show--get-cid-content (cid)
596 "Return a list (CID-content content-type) or nil.
598 This will only find parts from messages that have been inserted
599 into the current buffer. CID must be a raw content ID, without
600 enclosing angle brackets, a cid: prefix, or URL encoding. This
601 will return nil if the CID is unknown or cannot be retrieved."
602 (when-let ((descriptor (cdr (assoc cid notmuch-show--cids))))
603 (pcase-let ((`(,msg ,part) descriptor))
604 ;; Request caching for this content, as some messages
605 ;; reference the same cid: part many times (hundreds!).
606 (list (notmuch-get-bodypart-binary
607 msg part notmuch-show-process-crypto 'cache)
608 (plist-get part :content-type)))))
610 (defun notmuch-show-setup-w3m ()
611 "Instruct w3m how to retrieve content from a \"related\" part of a message."
613 (when (and (boundp 'w3m-cid-retrieve-function-alist)
614 (not (assq 'notmuch-show-mode w3m-cid-retrieve-function-alist)))
615 (push (cons 'notmuch-show-mode #'notmuch-show--cid-w3m-retrieve)
616 w3m-cid-retrieve-function-alist))
617 (setq mm-html-inhibit-images nil))
619 (defvar w3m-current-buffer) ;; From `w3m.el'.
620 (defun notmuch-show--cid-w3m-retrieve (url &rest _args)
621 ;; url includes the cid: prefix and is URL encoded (see RFC 2392).
622 (let* ((cid (url-unhex-string (substring url 4)))
624 (with-current-buffer w3m-current-buffer
625 (notmuch-show--get-cid-content cid))))
626 (when content-and-type
627 (insert (car content-and-type))
628 (cadr content-and-type))))
630 ;; MIME part renderers
632 (defun notmuch-show-multipart/*-to-list (part)
633 (mapcar (lambda (inner-part) (plist-get inner-part :content-type))
634 (plist-get part :content)))
636 (defun notmuch-show-insert-part-multipart/alternative (msg part _content-type _nth depth _button)
637 (let ((chosen-type (car (notmuch-multipart/alternative-choose
638 msg (notmuch-show-multipart/*-to-list part))))
639 (inner-parts (plist-get part :content))
641 ;; This inserts all parts of the chosen type rather than just one,
642 ;; but it's not clear that this is the wrong thing to do - which
643 ;; should be chosen if there are more than one that match?
644 (mapc (lambda (inner-part)
645 (let* ((inner-type (plist-get inner-part :content-type))
646 (hide (not (or notmuch-show-all-multipart/alternative-parts
647 (string= chosen-type inner-type)))))
648 (notmuch-show-insert-bodypart msg inner-part depth hide)))
651 (when notmuch-show-indent-multipart
652 (indent-rigidly start (point) 1)))
655 (defun notmuch-show-insert-part-multipart/related (msg part _content-type _nth depth _button)
656 (let ((inner-parts (plist-get part :content))
658 ;; Render the primary part. FIXME: Support RFC 2387 Start header.
659 (notmuch-show-insert-bodypart msg (car inner-parts) depth)
660 ;; Add hidden buttons for the rest
661 (mapc (lambda (inner-part)
662 (notmuch-show-insert-bodypart msg inner-part depth t))
664 (when notmuch-show-indent-multipart
665 (indent-rigidly start (point) 1)))
668 (defun notmuch-show-insert-part-multipart/signed (msg part _content-type _nth depth button)
670 (button-put button 'face 'notmuch-crypto-part-header))
671 ;; Insert a button detailing the signature status.
672 (notmuch-crypto-insert-sigstatus-button (car (plist-get part :sigstatus))
673 (notmuch-show-get-header :From msg))
674 (let ((inner-parts (plist-get part :content))
676 ;; Show all of the parts.
677 (mapc (lambda (inner-part)
678 (notmuch-show-insert-bodypart msg inner-part depth))
680 (when notmuch-show-indent-multipart
681 (indent-rigidly start (point) 1)))
684 (defun notmuch-show-insert-part-multipart/encrypted (msg part _content-type _nth depth button)
686 (button-put button 'face 'notmuch-crypto-part-header))
687 ;; Insert a button detailing the encryption status.
688 (notmuch-crypto-insert-encstatus-button (car (plist-get part :encstatus)))
689 ;; Insert a button detailing the signature status.
690 (notmuch-crypto-insert-sigstatus-button (car (plist-get part :sigstatus))
691 (notmuch-show-get-header :From msg))
692 (let ((inner-parts (plist-get part :content))
694 ;; Show all of the parts.
695 (mapc (lambda (inner-part)
696 (notmuch-show-insert-bodypart msg inner-part depth))
698 (when notmuch-show-indent-multipart
699 (indent-rigidly start (point) 1)))
702 (defun notmuch-show-insert-part-application/pgp-encrypted (_msg _part _content-type _nth _depth _button)
705 (defun notmuch-show-insert-part-multipart/* (msg part _content-type _nth depth _button)
706 (let ((inner-parts (plist-get part :content))
708 ;; Show all of the parts.
709 (mapc (lambda (inner-part)
710 (notmuch-show-insert-bodypart msg inner-part depth))
712 (when notmuch-show-indent-multipart
713 (indent-rigidly start (point) 1)))
716 (defun notmuch-show-insert-part-message/rfc822 (msg part _content-type _nth depth _button)
717 (let* ((message (car (plist-get part :content)))
718 (body (car (plist-get message :body)))
720 ;; Override `notmuch-message-headers' to force `From' to be
722 (let ((notmuch-message-headers '("From" "Subject" "To" "Cc" "Date")))
723 (notmuch-show-insert-headers (plist-get message :headers)))
724 ;; Blank line after headers to be compatible with the normal
728 (notmuch-show-insert-bodypart msg body depth)
729 (when notmuch-show-indent-multipart
730 (indent-rigidly start (point) 1)))
733 (defun notmuch-show-insert-part-text/plain (msg part _content-type _nth depth button)
734 ;; For backward compatibility we want to apply the text/plain hook
735 ;; to the whole of the part including the part button if there is
737 (let ((start (if button
738 (button-start button)
740 (insert (notmuch-get-bodypart-text msg part notmuch-show-process-crypto))
743 (narrow-to-region start (point-max))
744 (run-hook-with-args 'notmuch-show-insert-text/plain-hook msg depth))))
747 (defun notmuch-show-insert-part-text/calendar (msg part _content-type _nth _depth _button)
748 (insert (with-temp-buffer
749 (insert (notmuch-get-bodypart-text msg part notmuch-show-process-crypto))
750 ;; notmuch-get-bodypart-text does no newline conversion.
751 ;; Replace CRLF with LF before icalendar can use it.
752 (goto-char (point-min))
753 (while (re-search-forward "\r\n" nil t)
754 (replace-match "\n" nil nil))
755 (let ((file (make-temp-file "notmuch-ical"))
759 (unless (icalendar-import-buffer file t)
760 (error "Icalendar import error. %s"
761 "See *icalendar-errors* for more information"))
762 (set-buffer (get-file-buffer file))
763 (setq result (buffer-substring (point-min) (point-max)))
764 (set-buffer-modified-p nil)
765 (kill-buffer (current-buffer)))
770 ;; For backwards compatibility.
771 (defun notmuch-show-insert-part-text/x-vcalendar (msg part _content-type _nth depth _button)
772 (notmuch-show-insert-part-text/calendar msg part nil nil depth nil))
774 (when (version< emacs-version "25.3")
775 ;; https://bugs.gnu.org/28350
777 ;; For newer emacs, we fall back to notmuch-show-insert-part-*/*
778 ;; (see notmuch-show-handlers-for)
779 (defun notmuch-show-insert-part-text/enriched
780 (msg part content-type nth depth button)
781 ;; By requiring enriched below, we ensure that the function
782 ;; enriched-decode-display-prop is defined before it will be
783 ;; shadowed by the letf below. Otherwise the version in
784 ;; enriched.el may be loaded a bit later and used instead (for
787 (cl-letf (((symbol-function 'enriched-decode-display-prop)
788 (lambda (start end &optional _param) (list start end))))
789 (notmuch-show-insert-part-*/* msg part content-type nth depth button))))
791 (defun notmuch-show-get-mime-type-of-application/octet-stream (part)
792 ;; If we can deduce a MIME type from the filename of the attachment,
794 (and (plist-get part :filename)
795 (let ((extension (file-name-extension (plist-get part :filename))))
798 (mailcap-parse-mimetypes)
799 (let ((mime-type (mailcap-extension-to-mime extension)))
801 (not (string-equal mime-type "application/octet-stream"))
804 (defun notmuch-show-insert-part-text/html (msg part content-type nth depth button)
805 (if (eq mm-text-html-renderer 'shr)
806 ;; It's easier to drive shr ourselves than to work around the
807 ;; goofy things `mm-shr' does (like irreversibly taking over
808 ;; content ID handling).
809 ;; FIXME: If we block an image, offer a button to load external
811 (let ((shr-blocked-images notmuch-show-text/html-blocked-images))
812 (notmuch-show--insert-part-text/html-shr msg part))
813 ;; Otherwise, let message-mode do the heavy lifting
815 ;; w3m sets up a keymap which "leaks" outside the invisible region
816 ;; and causes strange effects in notmuch. We set
817 ;; mm-inline-text-html-with-w3m-keymap to nil to tell w3m not to
818 ;; set a keymap (so the normal notmuch-show-mode-map remains).
819 (let ((mm-inline-text-html-with-w3m-keymap nil)
820 ;; FIXME: If we block an image, offer a button to load external
822 (gnus-blocked-images notmuch-show-text/html-blocked-images))
823 (notmuch-show-insert-part-*/* msg part content-type nth depth button))))
825 ;;; Functions used by notmuch-show--insert-part-text/html-shr
827 (declare-function libxml-parse-html-region "xml.c")
828 (declare-function shr-insert-document "shr")
830 (defun notmuch-show--insert-part-text/html-shr (msg part)
831 ;; Make sure shr is loaded before we start let-binding its globals
833 (let ((dom (let ((process-crypto notmuch-show-process-crypto))
835 (insert (notmuch-get-bodypart-text msg part process-crypto))
836 (libxml-parse-html-region (point-min) (point-max)))))
837 (shr-content-function
839 ;; shr strips the "cid:" part of URL, but doesn't
840 ;; URL-decode it (see RFC 2392).
841 (let ((cid (url-unhex-string url)))
842 (car (notmuch-show--get-cid-content cid))))))
843 (shr-insert-document dom)
846 (defun notmuch-show-insert-part-*/* (msg part content-type _nth _depth _button)
847 ;; This handler _must_ succeed - it is the handler of last resort.
848 (notmuch-mm-display-part-inline msg part content-type notmuch-show-process-crypto)
851 ;;; Functions for determining how to handle MIME parts.
853 (defun notmuch-show-handlers-for (content-type)
854 "Return a list of content handlers for a part of type CONTENT-TYPE."
857 (when (functionp func)
859 ;; Reverse order of prefrence.
860 (list (intern (concat "notmuch-show-insert-part-*/*"))
861 (intern (concat "notmuch-show-insert-part-"
862 (car (split-string content-type "/"))
864 (intern (concat "notmuch-show-insert-part-" content-type))))
869 (defun notmuch-show-insert-bodypart-internal (msg part content-type nth depth button)
870 ;; Run the handlers until one of them succeeds.
871 (cl-loop for handler in (notmuch-show-handlers-for content-type)
872 until (condition-case err
873 (funcall handler msg part content-type nth depth button)
874 ;; Specifying `debug' here lets the debugger run if
875 ;; `debug-on-error' is non-nil.
877 (insert "!!! Bodypart handler `" (prin1-to-string handler)
878 "' threw an error:\n"
879 "!!! " (error-message-string err) "\n")
882 (defun notmuch-show-create-part-overlays (button beg end)
883 "Add an overlay to the part between BEG and END."
884 ;; If there is no button (i.e., the part is text/plain and the first
885 ;; part) or if the part has no content then we don't make the part
887 (when (and button (/= beg end))
888 (button-put button 'overlay (make-overlay beg end))
889 ;; Return true if we created an overlay.
892 (defun notmuch-show-record-part-information (part beg end)
893 "Store PART as a text property from BEG to END."
894 ;; Record part information. Since we already inserted subparts,
895 ;; don't override existing :notmuch-part properties.
896 (notmuch-map-text-property beg end :notmuch-part
897 (lambda (v) (or v part)))
898 ;; Make :notmuch-part front sticky and rear non-sticky so it stays
899 ;; applied to the beginning of each line when we indent the
900 ;; message. Since we're operating on arbitrary renderer output,
901 ;; watch out for sticky specs of t, which means all properties are
902 ;; front-sticky/rear-nonsticky.
903 (notmuch-map-text-property beg end 'front-sticky
906 (cl-pushnew :notmuch-part v)
908 (notmuch-map-text-property beg end 'rear-nonsticky
911 (cl-pushnew :notmuch-part v)
914 (defun notmuch-show-lazy-part (part-args button)
915 ;; Insert the lazy part after the button for the part. We would just
916 ;; move to the start of the new line following the button and insert
917 ;; the part but that point might have text properties (eg colours
918 ;; from a message header etc) so instead we start from the last
919 ;; character of the button by adding a newline and finish by
920 ;; removing the extra newline from the end of the part.
922 (goto-char (button-end button))
924 (let* ((inhibit-read-only t)
925 ;; We need to use markers for the start and end of the part
926 ;; because the part insertion functions do not guarantee
927 ;; to leave point at the end of the part.
928 (part-beg (copy-marker (point) nil))
929 (part-end (copy-marker (point) t))
930 ;; We have to save the depth as we can't find the depth
932 (depth (notmuch-show-get-depth)))
934 (narrow-to-region part-beg part-end)
935 (delete-region part-beg part-end)
936 (apply #'notmuch-show-insert-bodypart-internal part-args)
937 (indent-rigidly part-beg
939 (* notmuch-show-indent-messages-width depth)))
942 (notmuch-show-record-part-information (cadr part-args)
943 (button-start button)
945 ;; Create the overlay. If the lazy-part turned out to be empty/not
946 ;; showable this returns nil.
947 (notmuch-show-create-part-overlays button part-beg part-end))))
949 (defun notmuch-show-mime-type (part)
950 "Return the correct mime-type to use for PART."
951 (let ((content-type (downcase (plist-get part :content-type))))
952 (or (and (string= content-type "application/octet-stream")
953 (notmuch-show-get-mime-type-of-application/octet-stream part))
954 (and (string= content-type "inline patch")
958 ;; The following variable can be overridden by let bindings.
959 (defvar notmuch-show-insert-header-p-function 'notmuch-show-insert-header-p
960 "Specify which function decides which part headers get inserted.
962 The function should take two parameters, PART and HIDE, and
963 should return non-NIL if a header button should be inserted for
966 (defun notmuch-show-insert-header-p (part _hide)
967 ;; Show all part buttons except for the first part if it is text/plain.
968 (let ((mime-type (notmuch-show-mime-type part)))
969 (not (and (string= mime-type "text/plain")
970 (<= (plist-get part :id) 1)))))
972 (defun notmuch-show-reply-insert-header-p-never (_part _hide)
975 (defun notmuch-show-reply-insert-header-p-trimmed (part hide)
976 (let ((mime-type (notmuch-show-mime-type part)))
977 (and (not (notmuch-match-content-type mime-type "multipart/*"))
980 (defun notmuch-show-reply-insert-header-p-minimal (part hide)
981 (let ((mime-type (notmuch-show-mime-type part)))
982 (and (notmuch-match-content-type mime-type "text/*")
985 (defun notmuch-show-insert-bodypart (msg part depth &optional hide)
986 "Insert the body part PART at depth DEPTH in the current thread.
988 HIDE determines whether to show or hide the part and the button
989 as follows: If HIDE is nil, show the part and the button. If HIDE
990 is t, hide the part initially and show the button."
991 (let* ((content-type (downcase (plist-get part :content-type)))
992 (mime-type (notmuch-show-mime-type part))
993 (nth (plist-get part :id))
994 (long (and (notmuch-match-content-type mime-type "text/*")
995 (> notmuch-show-max-text-part-size 0)
996 (> (length (plist-get part :content))
997 notmuch-show-max-text-part-size)))
999 ;; This default header-p function omits the part button for
1000 ;; the first (or only) part if this is text/plain.
1001 (button (and (funcall notmuch-show-insert-header-p-function part hide)
1002 (notmuch-show-insert-part-header
1003 nth mime-type content-type
1004 (plist-get part :filename))))
1005 ;; Hide the part initially if HIDE is t, or if it is too long
1006 ;; and we have a button to allow toggling.
1007 (show-part (not (or (equal hide t)
1008 (and long button))))
1009 (content-beg (point)))
1010 ;; Store the computed mime-type for later use (e.g. by attachment handlers).
1011 (plist-put part :computed-type mime-type)
1013 (notmuch-show-insert-bodypart-internal msg part mime-type nth depth button)
1015 (button-put button :notmuch-lazy-part
1016 (list msg part mime-type nth depth button))))
1017 ;; Some of the body part handlers leave point somewhere up in the
1018 ;; part, so we make sure that we're down at the end.
1019 (goto-char (point-max))
1020 ;; Ensure that the part ends with a carriage return.
1023 ;; We do not create the overlay for hidden (lazy) parts until
1024 ;; they are inserted.
1026 (notmuch-show-create-part-overlays button content-beg (point))
1028 (notmuch-show-toggle-part-invisibility button)))
1029 (notmuch-show-record-part-information part beg (point))))
1031 (defun notmuch-show-insert-body (msg body depth)
1032 "Insert the body BODY at depth DEPTH in the current thread."
1033 ;; Register all content IDs for this message. According to RFC
1034 ;; 2392, content IDs are *global*, but it's okay if an MUA treats
1035 ;; them as only global within a message.
1036 (notmuch-show--register-cids msg (car body))
1037 (mapc (lambda (part) (notmuch-show-insert-bodypart msg part depth)) body))
1039 (defun notmuch-show-make-symbol (type)
1040 (make-symbol (concat "notmuch-show-" type)))
1042 (defun notmuch-show-strip-re (string)
1043 (replace-regexp-in-string "^\\([Rr]e: *\\)+" "" string))
1045 (defvar notmuch-show-previous-subject "")
1046 (make-variable-buffer-local 'notmuch-show-previous-subject)
1048 (defun notmuch-show-insert-msg (msg depth)
1049 "Insert the message MSG at depth DEPTH in the current thread."
1050 (let* ((headers (plist-get msg :headers))
1051 ;; Indentation causes the buffer offset of the start/end
1052 ;; points to move, so we must use markers.
1053 message-start message-end
1054 content-start content-end
1055 headers-start headers-end
1056 (bare-subject (notmuch-show-strip-re (plist-get headers :Subject))))
1057 (setq message-start (point-marker))
1058 (notmuch-show-insert-headerline headers
1059 (or (and notmuch-show-relative-dates
1060 (plist-get msg :date_relative))
1061 (plist-get headers :Date))
1062 (plist-get msg :tags) depth)
1063 (setq content-start (point-marker))
1064 ;; Set `headers-start' to point after the 'Subject:' header to be
1065 ;; compatible with the existing implementation. This just sets it
1066 ;; to after the first header.
1067 (notmuch-show-insert-headers headers)
1069 (goto-char content-start)
1070 ;; If the subject of this message is the same as that of the
1071 ;; previous message, don't display it when this message is
1073 (unless (string= notmuch-show-previous-subject bare-subject)
1075 (setq headers-start (point-marker)))
1076 (setq headers-end (point-marker))
1077 (setq notmuch-show-previous-subject bare-subject)
1078 ;; A blank line between the headers and the body.
1080 (notmuch-show-insert-body msg (plist-get msg :body)
1081 (if notmuch-show-indent-content depth 0))
1082 ;; Ensure that the body ends with a newline.
1085 (setq content-end (point-marker))
1086 ;; Indent according to the depth in the thread.
1087 (when notmuch-show-indent-content
1088 (indent-rigidly content-start
1090 (* notmuch-show-indent-messages-width depth)))
1091 (setq message-end (point-max-marker))
1092 ;; Save the extents of this message over the whole text of the
1094 (put-text-property message-start message-end
1095 :notmuch-message-extent
1096 (cons message-start message-end))
1097 ;; Create overlays used to control visibility
1098 (plist-put msg :headers-overlay (make-overlay headers-start headers-end))
1099 (plist-put msg :message-overlay (make-overlay headers-start content-end))
1100 (plist-put msg :depth depth)
1101 ;; Save the properties for this message. Currently this saves the
1102 ;; entire message (augmented it with other stuff), which seems
1103 ;; like overkill. We might save a reduced subset (for example, not
1105 (notmuch-show-set-message-properties msg)
1106 ;; Set header visibility.
1107 (notmuch-show-headers-visible msg notmuch-message-headers-visible)
1108 ;; Message visibility depends on whether it matched the search
1110 (notmuch-show-message-visible msg (and (plist-get msg :match)
1111 (not (plist-get msg :excluded))))))
1115 (defun notmuch-show-toggle-process-crypto ()
1116 "Toggle the processing of cryptographic MIME parts."
1118 (setq notmuch-show-process-crypto (not notmuch-show-process-crypto))
1119 (message (if notmuch-show-process-crypto
1120 "Processing cryptographic MIME parts."
1121 "Not processing cryptographic MIME parts."))
1122 (notmuch-show-refresh-view))
1124 (defun notmuch-show-toggle-elide-non-matching ()
1125 "Toggle the display of non-matching messages."
1127 (setq notmuch-show-elide-non-matching-messages
1128 (not notmuch-show-elide-non-matching-messages))
1129 (message (if notmuch-show-elide-non-matching-messages
1130 "Showing matching messages only."
1131 "Showing all messages."))
1132 (notmuch-show-refresh-view))
1134 (defun notmuch-show-toggle-thread-indentation ()
1135 "Toggle the indentation of threads."
1137 (setq notmuch-show-indent-content (not notmuch-show-indent-content))
1138 (message (if notmuch-show-indent-content
1139 "Content is indented."
1140 "Content is not indented."))
1141 (notmuch-show-refresh-view))
1143 ;;; Main insert functions
1145 (defun notmuch-show-insert-tree (tree depth)
1146 "Insert the message tree TREE at depth DEPTH in the current thread."
1147 (let ((msg (car tree))
1148 (replies (cadr tree)))
1149 ;; We test whether there is a message or just some replies.
1151 (notmuch-show-insert-msg msg depth))
1152 (notmuch-show-insert-thread replies (1+ depth))))
1154 (defun notmuch-show-insert-thread (thread depth)
1155 "Insert the thread THREAD at depth DEPTH in the current forest."
1156 (mapc (lambda (tree) (notmuch-show-insert-tree tree depth)) thread))
1158 (defun notmuch-show-insert-forest (forest)
1159 "Insert the forest of threads FOREST."
1160 (mapc (lambda (thread) (notmuch-show-insert-thread thread 0)) forest))
1164 (defvar notmuch-id-regexp
1166 ;; Match the id: prefix only if it begins a word (to disallow, for
1167 ;; example, matching cid:).
1169 ;; If the term starts with a ", then parse Xapian's quoted boolean
1170 ;; term syntax, which allows for anything as long as embedded
1171 ;; double quotes escaped by doubling them. We also disallow
1172 ;; newlines (which Xapian allows) to prevent runaway terms.
1173 "\"\\([^\"\n]\\|\"\"\\)*\""
1174 ;; Otherwise, parse Xapian's unquoted syntax, which goes up to the
1175 ;; next space or ). We disallow [.,;] as the last character
1176 ;; because these are probably part of the surrounding text, and not
1177 ;; part of the id. This doesn't match single character ids; meh.
1178 "\\|[^\"[:space:])][^[:space:])]*[^])[:space:].,:;?!]"
1180 "The regexp used to match id: links in messages.")
1182 (defvar notmuch-mid-regexp
1183 ;; goto-address-url-regexp matched cid: links, which have the same
1184 ;; grammar as the message ID part of a mid: link. Construct the
1185 ;; regexp using the same technique as goto-address-url-regexp.
1186 (concat "\\<mid:\\(" thing-at-point-url-path-regexp "\\)")
1187 "The regexp used to match mid: links in messages.
1191 (defun notmuch-show-buttonise-links (start end)
1192 "Buttonise URLs and mail addresses between START and END.
1194 This also turns id:\"<message id>\"-parts and mid: links into
1195 buttons for a corresponding notmuch search."
1196 (goto-address-fontify-region start end)
1199 (beg-line (progn (goto-char start) (line-beginning-position)))
1200 (end-line (progn (goto-char end) (line-end-position))))
1201 (goto-char beg-line)
1202 (while (re-search-forward notmuch-id-regexp end-line t)
1203 (push (list (match-beginning 0) (match-end 0)
1204 (match-string-no-properties 0)) links))
1205 (goto-char beg-line)
1206 (while (re-search-forward notmuch-mid-regexp end-line t)
1207 (let* ((mid-cid (match-string-no-properties 1))
1208 (mid (save-match-data
1209 (string-match "^[^/]*" mid-cid)
1210 (url-unhex-string (match-string 0 mid-cid)))))
1211 (push (list (match-beginning 0) (match-end 0)
1212 (notmuch-id-to-query mid)) links)))
1213 (pcase-dolist (`(,beg ,end ,link) links)
1214 ;; Remove the overlay created by goto-address-mode
1215 (remove-overlays beg end 'goto-address t)
1216 (make-text-button beg end
1217 :type 'notmuch-button-type
1218 'action `(lambda (arg)
1219 (notmuch-show ,link current-prefix-arg))
1221 'help-echo "Mouse-1, RET: search for this message"
1222 'face goto-address-mail-face)))))
1227 (defun notmuch-show (thread-id &optional elide-toggle parent-buffer query-context buffer-name)
1228 "Run \"notmuch show\" with the given thread ID and display results.
1230 ELIDE-TOGGLE, if non-nil, inverts the default elide behavior.
1232 The optional PARENT-BUFFER is the notmuch-search buffer from
1233 which this notmuch-show command was executed, (so that the
1234 next thread from that buffer can be show when done with this
1237 The optional QUERY-CONTEXT is a notmuch search term. Only
1238 messages from the thread matching this search term are shown if
1241 The optional BUFFER-NAME provides the name of the buffer in
1242 which the message thread is shown. If it is nil (which occurs
1243 when the command is called interactively) the argument to the
1246 Returns the buffer containing the messages, or NIL if no messages
1248 (interactive "sNotmuch show: \nP")
1249 (let ((buffer-name (generate-new-buffer-name
1251 (concat "*notmuch-" thread-id "*"))))
1252 ;; We override mm-inline-override-types to stop application/*
1253 ;; parts from being displayed unless the user has customized
1255 (mm-inline-override-types
1256 (if (equal mm-inline-override-types
1257 (eval (car (get 'mm-inline-override-types 'standard-value))))
1258 (cons "application/*" mm-inline-override-types)
1259 mm-inline-override-types)))
1260 (pop-to-buffer-same-window (get-buffer-create buffer-name))
1261 ;; No need to track undo information for this buffer.
1262 (setq buffer-undo-list t)
1264 ;; Set various buffer local variables to their appropriate initial
1265 ;; state. Do this after enabling `notmuch-show-mode' so that they
1266 ;; aren't wiped out.
1267 (setq notmuch-show-thread-id thread-id)
1268 (setq notmuch-show-parent-buffer parent-buffer)
1269 (setq notmuch-show-query-context
1270 (if (or (string= query-context "")
1271 (string= query-context "*"))
1274 (setq notmuch-show-process-crypto notmuch-crypto-process-mime)
1275 ;; If `elide-toggle', invert the default value.
1276 (setq notmuch-show-elide-non-matching-messages
1278 (not notmuch-show-only-matching-messages)
1279 notmuch-show-only-matching-messages))
1280 (add-hook 'post-command-hook #'notmuch-show-command-hook nil t)
1281 (jit-lock-register #'notmuch-show-buttonise-links)
1282 (notmuch-tag-clear-cache)
1283 (let ((inhibit-read-only t))
1284 (if (notmuch-show--build-buffer)
1285 ;; Messages were inserted into the buffer.
1287 ;; No messages were inserted - presumably none matched the
1289 (kill-buffer (current-buffer))
1291 (message "No messages matched the query!")
1294 (defun notmuch-show--build-queries (thread context)
1295 "Return a list of queries to try for this search.
1297 THREAD and CONTEXT are both strings, though CONTEXT may be nil.
1298 When CONTEXT is not nil, the first query is the conjunction of it
1299 and THREAD. The next query is THREAD alone, and serves as a
1300 fallback if the prior matches no messages."
1302 (push (list thread) queries)
1304 (push (list thread "and (" context ")") queries))
1307 (defun notmuch-show--build-buffer (&optional state)
1308 "Display messages matching the current buffer context.
1310 Apply the previously saved STATE if supplied, otherwise show the
1311 first relevant message.
1313 If no messages match the query return NIL."
1314 (let* ((cli-args (cons "--exclude=false"
1315 (and notmuch-show-elide-non-matching-messages
1316 (list "--entire-thread=false"))))
1317 (queries (notmuch-show--build-queries
1318 notmuch-show-thread-id notmuch-show-query-context))
1320 ;; Must be reset every time we are going to start inserting
1321 ;; messages into the buffer.
1322 (notmuch-show-previous-subject ""))
1323 ;; Use results from the first query that returns some.
1324 (while (and (not forest) queries)
1325 (setq forest (notmuch-query-get-threads
1326 (append cli-args (list "'") (car queries) (list "'"))))
1327 (setq queries (cdr queries)))
1329 (notmuch-show-insert-forest forest)
1330 ;; Store the original tags for each message so that we can
1333 (lambda () (notmuch-show-set-prop :orig-tags (notmuch-show-get-tags))))
1334 ;; Set the header line to the subject of the first message.
1335 (setq header-line-format
1336 (replace-regexp-in-string "%" "%%"
1338 (notmuch-show-strip-re
1339 (notmuch-show-get-subject)))))
1340 (run-hooks 'notmuch-show-hook)
1342 (notmuch-show-apply-state state)
1343 ;; With no state to apply, just go to the first message.
1344 (notmuch-show-goto-first-wanted-message)))
1345 ;; Report back to the caller whether any messages matched.
1350 (defun notmuch-show-capture-state ()
1351 "Capture the state of the current buffer.
1354 - the list of open messages,
1355 - the combination of current message id with/for each visible window."
1356 (let* ((win-list (get-buffer-window-list (current-buffer) nil t))
1357 (win-id-combo (mapcar (lambda (win)
1358 (with-selected-window win
1359 (list win (notmuch-show-get-message-id))))
1361 (list win-id-combo (notmuch-show-get-message-ids-for-open-messages))))
1363 (defun notmuch-show-get-query ()
1364 "Return the current query in this show buffer."
1365 (if notmuch-show-query-context
1366 (concat notmuch-show-thread-id
1368 notmuch-show-query-context
1370 notmuch-show-thread-id))
1372 (defun notmuch-show-goto-message (msg-id)
1373 "Go to message with msg-id."
1374 (goto-char (point-min))
1375 (unless (cl-loop if (string= msg-id (notmuch-show-get-message-id))
1377 until (not (notmuch-show-goto-message-next)))
1378 (goto-char (point-min))
1379 (message "Message-id not found."))
1380 (notmuch-show-message-adjust))
1382 (defun notmuch-show-apply-state (state)
1383 "Apply STATE to the current buffer.
1386 - opening the messages previously opened,
1387 - closing all other messages,
1388 - moving to the correct current message in every displayed window."
1389 (let ((win-msg-alist (car state))
1390 (open (cadr state)))
1391 ;; Open those that were open.
1392 (goto-char (point-min))
1393 (cl-loop do (notmuch-show-message-visible
1394 (notmuch-show-get-message-properties)
1395 (member (notmuch-show-get-message-id) open))
1396 until (not (notmuch-show-goto-message-next)))
1397 (dolist (win-msg-pair win-msg-alist)
1398 (with-selected-window (car win-msg-pair)
1399 ;; Go to the previously open message in this window
1400 (notmuch-show-goto-message (cadr win-msg-pair))))))
1402 (defun notmuch-show-refresh-view (&optional reset-state)
1403 "Refresh the current view.
1405 Refreshes the current view, observing changes in display
1406 preferences. If invoked with a prefix argument (or RESET-STATE is
1407 non-nil) then the state of the buffer (open/closed messages) is
1408 reset based on the original query."
1410 (let ((inhibit-read-only t)
1411 (state (unless reset-state
1412 (notmuch-show-capture-state))))
1413 ;; `erase-buffer' does not seem to remove overlays, which can lead
1414 ;; to weird effects such as remaining images, so remove them
1418 (unless (notmuch-show--build-buffer state)
1419 ;; No messages were inserted.
1420 (kill-buffer (current-buffer))
1422 (message "Refreshing the buffer resulted in no messages!"))))
1426 (defvar notmuch-show-stash-map
1427 (let ((map (make-sparse-keymap)))
1428 (define-key map "c" 'notmuch-show-stash-cc)
1429 (define-key map "d" 'notmuch-show-stash-date)
1430 (define-key map "F" 'notmuch-show-stash-filename)
1431 (define-key map "f" 'notmuch-show-stash-from)
1432 (define-key map "i" 'notmuch-show-stash-message-id)
1433 (define-key map "I" 'notmuch-show-stash-message-id-stripped)
1434 (define-key map "s" 'notmuch-show-stash-subject)
1435 (define-key map "T" 'notmuch-show-stash-tags)
1436 (define-key map "t" 'notmuch-show-stash-to)
1437 (define-key map "l" 'notmuch-show-stash-mlarchive-link)
1438 (define-key map "L" 'notmuch-show-stash-mlarchive-link-and-go)
1439 (define-key map "G" 'notmuch-show-stash-git-send-email)
1440 (define-key map "?" 'notmuch-subkeymap-help)
1442 "Submap for stash commands.")
1443 (fset 'notmuch-show-stash-map notmuch-show-stash-map)
1445 (defvar notmuch-show-part-map
1446 (let ((map (make-sparse-keymap)))
1447 (define-key map "s" 'notmuch-show-save-part)
1448 (define-key map "v" 'notmuch-show-view-part)
1449 (define-key map "o" 'notmuch-show-interactively-view-part)
1450 (define-key map "|" 'notmuch-show-pipe-part)
1451 (define-key map "m" 'notmuch-show-choose-mime-of-part)
1452 (define-key map "?" 'notmuch-subkeymap-help)
1454 "Submap for part commands.")
1455 (fset 'notmuch-show-part-map notmuch-show-part-map)
1457 (defvar notmuch-show-mode-map
1458 (let ((map (make-sparse-keymap)))
1459 (set-keymap-parent map notmuch-common-keymap)
1460 (define-key map "Z" 'notmuch-tree-from-show-current-query)
1461 (define-key map "U" 'notmuch-unthreaded-from-show-current-query)
1462 (define-key map (kbd "<C-tab>") 'widget-backward)
1463 (define-key map (kbd "M-TAB") 'notmuch-show-previous-button)
1464 (define-key map (kbd "<backtab>") 'notmuch-show-previous-button)
1465 (define-key map (kbd "TAB") 'notmuch-show-next-button)
1466 (define-key map "f" 'notmuch-show-forward-message)
1467 (define-key map "F" 'notmuch-show-forward-open-messages)
1468 (define-key map "b" 'notmuch-show-resend-message)
1469 (define-key map "l" 'notmuch-show-filter-thread)
1470 (define-key map "r" 'notmuch-show-reply-sender)
1471 (define-key map "R" 'notmuch-show-reply)
1472 (define-key map "|" 'notmuch-show-pipe-message)
1473 (define-key map "w" 'notmuch-show-save-attachments)
1474 (define-key map "V" 'notmuch-show-view-raw-message)
1475 (define-key map "e" 'notmuch-show-resume-message)
1476 (define-key map "c" 'notmuch-show-stash-map)
1477 (define-key map "h" 'notmuch-show-toggle-visibility-headers)
1478 (define-key map "k" 'notmuch-tag-jump)
1479 (define-key map "*" 'notmuch-show-tag-all)
1480 (define-key map "-" 'notmuch-show-remove-tag)
1481 (define-key map "+" 'notmuch-show-add-tag)
1482 (define-key map "X" 'notmuch-show-archive-thread-then-exit)
1483 (define-key map "x" 'notmuch-show-archive-message-then-next-or-exit)
1484 (define-key map "A" 'notmuch-show-archive-thread-then-next)
1485 (define-key map "a" 'notmuch-show-archive-message-then-next-or-next-thread)
1486 (define-key map "N" 'notmuch-show-next-message)
1487 (define-key map "P" 'notmuch-show-previous-message)
1488 (define-key map "n" 'notmuch-show-next-open-message)
1489 (define-key map "p" 'notmuch-show-previous-open-message)
1490 (define-key map (kbd "M-n") 'notmuch-show-next-thread-show)
1491 (define-key map (kbd "M-p") 'notmuch-show-previous-thread-show)
1492 (define-key map (kbd "DEL") 'notmuch-show-rewind)
1493 (define-key map " " 'notmuch-show-advance-and-archive)
1494 (define-key map (kbd "M-RET") 'notmuch-show-open-or-close-all)
1495 (define-key map (kbd "RET") 'notmuch-show-toggle-message)
1496 (define-key map "#" 'notmuch-show-print-message)
1497 (define-key map "!" 'notmuch-show-toggle-elide-non-matching)
1498 (define-key map "$" 'notmuch-show-toggle-process-crypto)
1499 (define-key map "<" 'notmuch-show-toggle-thread-indentation)
1500 (define-key map "t" 'toggle-truncate-lines)
1501 (define-key map "." 'notmuch-show-part-map)
1502 (define-key map "B" 'notmuch-show-browse-urls)
1504 "Keymap for \"notmuch show\" buffers.")
1508 (define-derived-mode notmuch-show-mode fundamental-mode "notmuch-show"
1509 "Major mode for viewing a thread with notmuch.
1511 This buffer contains the results of the \"notmuch show\" command
1512 for displaying a single thread of email from your email archives.
1514 By default, various components of email messages, (citations,
1515 signatures, already-read messages), are hidden. You can make
1516 these parts visible by clicking with the mouse button or by
1517 pressing RET after positioning the cursor on a hidden part, (for
1518 which \\[notmuch-show-next-button] and \\[notmuch-show-previous-button] are helpful).
1520 Reading the thread sequentially is well-supported by pressing
1521 \\[notmuch-show-advance-and-archive]. This will scroll the current message (if necessary), advance
1522 to the next message, or advance to the next thread (if already on
1523 the last message of a thread).
1525 Other commands are available to read or manipulate the thread
1526 more selectively, (such as '\\[notmuch-show-next-message]' and '\\[notmuch-show-previous-message]' to advance to messages
1527 without removing any tags, and '\\[notmuch-show-archive-thread]' to archive an entire thread
1528 without scrolling through with \\[notmuch-show-advance-and-archive]).
1530 You can add or remove arbitrary tags from the current message with
1531 '\\[notmuch-show-add-tag]' or '\\[notmuch-show-remove-tag]'.
1533 All currently available key bindings:
1535 \\{notmuch-show-mode-map}"
1536 (setq notmuch-buffer-refresh-function #'notmuch-show-refresh-view)
1537 (setq buffer-read-only t)
1538 (setq truncate-lines t)
1539 (setq imenu-prev-index-position-function
1540 #'notmuch-show-imenu-prev-index-position-function)
1541 (setq imenu-extract-index-name-function
1542 #'notmuch-show-imenu-extract-index-name-function))
1546 (defun notmuch-tree-from-show-current-query ()
1547 "Call notmuch tree with the current query."
1549 (notmuch-tree notmuch-show-thread-id
1550 notmuch-show-query-context
1551 (notmuch-show-get-message-id)))
1553 (defun notmuch-unthreaded-from-show-current-query ()
1554 "Call notmuch unthreaded with the current query."
1556 (notmuch-unthreaded notmuch-show-thread-id
1557 notmuch-show-query-context
1558 (notmuch-show-get-message-id)))
1560 ;;; Movement related functions.
1562 (defun notmuch-show-move-to-message-top ()
1563 (goto-char (notmuch-show-message-top)))
1565 (defun notmuch-show-move-to-message-bottom ()
1566 (goto-char (notmuch-show-message-bottom)))
1568 ;; There's some strangeness here where a text property applied to a
1569 ;; region a->b is not found when point is at b. We walk backwards
1570 ;; until finding the property.
1571 (defun notmuch-show-message-extent ()
1572 "Return a cons cell containing the start and end buffer offset
1573 of the current message."
1576 (while (not (setq r (get-text-property (point) :notmuch-message-extent)))
1580 (defun notmuch-show-message-top ()
1581 (car (notmuch-show-message-extent)))
1583 (defun notmuch-show-message-bottom ()
1584 (cdr (notmuch-show-message-extent)))
1586 (defun notmuch-show-goto-message-next ()
1587 (let ((start (point)))
1588 (notmuch-show-move-to-message-bottom)
1594 (defun notmuch-show-goto-message-previous ()
1595 (notmuch-show-move-to-message-top)
1599 (notmuch-show-move-to-message-top)
1602 (defun notmuch-show-mapc (function)
1603 "Iterate through all messages in the current thread with
1604 `notmuch-show-goto-message-next' and call FUNCTION for side
1607 (goto-char (point-min))
1608 (cl-loop do (funcall function)
1609 while (notmuch-show-goto-message-next))))
1611 ;;; Functions relating to the visibility of messages and their components.
1613 (defun notmuch-show-message-visible (props visible-p)
1614 (overlay-put (plist-get props :message-overlay) 'invisible (not visible-p))
1615 (notmuch-show-set-prop :message-visible visible-p props))
1617 (defun notmuch-show-headers-visible (props visible-p)
1618 (overlay-put (plist-get props :headers-overlay) 'invisible (not visible-p))
1619 (notmuch-show-set-prop :headers-visible visible-p props))
1621 ;;; Functions for setting and getting attributes of the current message.
1623 (defun notmuch-show-set-message-properties (props)
1625 (notmuch-show-move-to-message-top)
1626 (put-text-property (point) (+ (point) 1)
1627 :notmuch-message-properties props)))
1629 (defun notmuch-show-get-message-properties ()
1630 "Return the properties of the current message as a plist.
1632 Some useful entries are:
1633 :headers - Property list containing the headers :Date, :Subject, :From, etc.
1634 :body - Body of the message
1635 :tags - Tags for this message"
1637 (notmuch-show-move-to-message-top)
1638 (get-text-property (point) :notmuch-message-properties)))
1640 (defun notmuch-show-get-part-properties ()
1641 "Return the properties of the innermost part containing point.
1643 This is the part property list retrieved from the CLI. Signals
1644 an error if there is no part containing point."
1645 (or (get-text-property (point) :notmuch-part)
1646 (error "No message part here")))
1648 (defun notmuch-show-set-prop (prop val &optional props)
1649 (let ((inhibit-read-only t)
1651 (notmuch-show-get-message-properties))))
1652 (plist-put props prop val)
1653 (notmuch-show-set-message-properties props)))
1655 (defun notmuch-show-get-prop (prop &optional props)
1656 "Get property PROP from current message in show or tree mode.
1658 It gets property PROP from PROPS or, if PROPS is nil, the current
1659 message in either tree or show. This means that several utility
1660 functions in notmuch-show can be used directly by notmuch-tree as
1661 they just need the correct message properties."
1662 (plist-get (or props
1663 (cond ((eq major-mode 'notmuch-show-mode)
1664 (notmuch-show-get-message-properties))
1665 ((eq major-mode 'notmuch-tree-mode)
1666 (notmuch-tree-get-message-properties))
1670 (defun notmuch-show-get-message-id (&optional bare)
1671 "Return an id: query for the Message-Id of the current message.
1673 If optional argument BARE is non-nil, return
1674 the Message-Id without id: prefix and escaping."
1676 (notmuch-show-get-prop :id)
1677 (notmuch-id-to-query (notmuch-show-get-prop :id))))
1679 (defun notmuch-show-get-messages-ids ()
1680 "Return all id: queries of messages in the current thread."
1681 (let ((message-ids))
1683 (lambda () (push (notmuch-show-get-message-id) message-ids)))
1686 (defun notmuch-show-get-messages-ids-search ()
1687 "Return a search string for all message ids of messages in the
1689 (mapconcat 'identity (notmuch-show-get-messages-ids) " or "))
1691 ;; dme: Would it make sense to use a macro for many of these?
1693 ;; XXX TODO figure out what to do about multiple filenames
1694 (defun notmuch-show-get-filename ()
1695 "Return the filename of the current message."
1696 (car (notmuch-show-get-prop :filename)))
1698 (defun notmuch-show-get-header (header &optional props)
1699 "Return the named header of the current message, if any."
1700 (plist-get (notmuch-show-get-prop :headers props) header))
1702 (defun notmuch-show-get-cc ()
1703 (notmuch-show-get-header :Cc))
1705 (defun notmuch-show-get-date ()
1706 (notmuch-show-get-header :Date))
1708 (defun notmuch-show-get-timestamp ()
1709 (notmuch-show-get-prop :timestamp))
1711 (defun notmuch-show-get-from ()
1712 (notmuch-show-get-header :From))
1714 (defun notmuch-show-get-subject ()
1715 (notmuch-show-get-header :Subject))
1717 (defun notmuch-show-get-to ()
1718 (notmuch-show-get-header :To))
1720 (defun notmuch-show-get-depth ()
1721 (notmuch-show-get-prop :depth))
1723 (defun notmuch-show-set-tags (tags)
1724 "Set the tags of the current message."
1725 (notmuch-show-set-prop :tags tags)
1726 (notmuch-show-update-tags tags))
1728 (defun notmuch-show-get-tags ()
1729 "Return the tags of the current message."
1730 (notmuch-show-get-prop :tags))
1732 (defun notmuch-show-message-visible-p ()
1733 "Is the current message visible?"
1734 (notmuch-show-get-prop :message-visible))
1736 (defun notmuch-show-headers-visible-p ()
1737 "Are the headers of the current message visible?"
1738 (notmuch-show-get-prop :headers-visible))
1740 (put 'notmuch-show-mark-read 'notmuch-prefix-doc
1741 "Mark the current message as unread.")
1742 (defun notmuch-show-mark-read (&optional unread)
1743 "Mark the current message as read.
1745 Mark the current message as read by applying the tag changes in
1746 `notmuch-show-mark-read-tags' to it (remove the \"unread\" tag by
1747 default). If a prefix argument is given, the message will be
1748 marked as unread, i.e. the tag changes in
1749 `notmuch-show-mark-read-tags' will be reversed."
1751 (when notmuch-show-mark-read-tags
1752 (apply 'notmuch-show-tag-message
1753 (notmuch-tag-change-list notmuch-show-mark-read-tags unread))))
1755 (defun notmuch-show-seen-current-message (_start _end)
1756 "Mark the current message read if it is open.
1758 We only mark it read once: if it is changed back then that is a
1759 user decision and we should not override it."
1760 (when (and (notmuch-show-message-visible-p)
1761 (not (notmuch-show-get-prop :seen)))
1762 (notmuch-show-mark-read)
1763 (notmuch-show-set-prop :seen t)))
1765 (defvar notmuch-show--seen-has-errored nil)
1766 (make-variable-buffer-local 'notmuch-show--seen-has-errored)
1768 (defun notmuch-show-command-hook ()
1769 (when (eq major-mode 'notmuch-show-mode)
1770 ;; We need to redisplay to get window-start and window-end correct.
1774 (funcall notmuch-show-mark-read-function (window-start) (window-end))
1776 (unless notmuch-show--seen-has-errored
1777 (setq notmuch-show--seen-has-errored t)
1778 (setq header-line-format
1779 (concat header-line-format
1781 " [some mark read tag changes may have failed]"
1782 'face font-lock-warning-face)))))))))
1784 (defun notmuch-show-filter-thread (query)
1785 "Filter or LIMIT the current thread based on a new query string.
1787 Reshows the current thread with matches defined by the new query-string."
1788 (interactive (list (notmuch-read-query "Filter thread: ")))
1789 (let ((msg-id (notmuch-show-get-message-id)))
1790 (setq notmuch-show-query-context (if (string-empty-p query) nil query))
1791 (notmuch-show-refresh-view t)
1792 (notmuch-show-goto-message msg-id)))
1794 ;;; Functions for getting attributes of several messages in the current thread.
1796 (defun notmuch-show-get-message-ids-for-open-messages ()
1797 "Return a list of all id: queries for open messages in the current thread."
1799 (let (message-ids done)
1800 (goto-char (point-min))
1802 (when (notmuch-show-message-visible-p)
1804 (append message-ids (list (notmuch-show-get-message-id)))))
1805 (setq done (not (notmuch-show-goto-message-next))))
1808 ;;; Commands typically bound to keys.
1810 (defun notmuch-show-advance ()
1811 "Advance through thread.
1813 If the current message in the thread is not yet fully visible,
1814 scroll by a near screenful to read more of the message.
1816 Otherwise, (the end of the current message is already within the
1817 current window), advance to the next open message."
1819 (let* ((end-of-this-message (notmuch-show-message-bottom))
1820 (visible-end-of-this-message (1- end-of-this-message))
1822 (while (invisible-p visible-end-of-this-message)
1823 (setq visible-end-of-this-message
1825 (1- (previous-single-char-property-change
1826 visible-end-of-this-message 'invisible)))))
1828 ;; Ideally we would test `end-of-this-message' against the result
1829 ;; of `window-end', but that doesn't account for the fact that
1830 ;; the end of the message might be hidden.
1831 ((and visible-end-of-this-message
1832 (> visible-end-of-this-message (window-end)))
1833 ;; The bottom of this message is not visible - scroll.
1835 ((not (= end-of-this-message (point-max)))
1836 ;; This is not the last message - move to the next visible one.
1837 (notmuch-show-next-open-message))
1838 ((not (= (point) (point-max)))
1839 ;; This is the last message, but the cursor is not at the end of
1840 ;; the buffer. Move it there.
1841 (goto-char (point-max)))
1843 ;; This is the last message - change the return value
1847 (defun notmuch-show-advance-and-archive ()
1848 "Advance through thread and archive.
1850 This command is intended to be one of the simplest ways to
1851 process a thread of email. It works exactly like
1852 notmuch-show-advance, in that it scrolls through messages in a
1853 show buffer, except that when it gets to the end of the buffer it
1854 archives the entire current thread, (apply changes in
1855 `notmuch-archive-tags'), kills the buffer, and displays the next
1856 thread from the search from which this thread was originally
1859 (when (notmuch-show-advance)
1860 (notmuch-show-archive-thread-then-next)))
1862 (defun notmuch-show-rewind ()
1863 "Backup through the thread (reverse scrolling compared to \
1864 \\[notmuch-show-advance-and-archive]).
1866 Specifically, if the beginning of the previous email is fewer
1867 than `window-height' lines from the current point, move to it
1868 just like `notmuch-show-previous-message'.
1870 Otherwise, just scroll down a screenful of the current message.
1872 This command does not modify any message tags, (it does not undo
1873 any effects from previous calls to
1874 `notmuch-show-advance-and-archive'."
1876 (let ((start-of-message (notmuch-show-message-top))
1877 (start-of-window (window-start)))
1879 ;; Either this message is properly aligned with the start of the
1880 ;; window or the start of this message is not visible on the
1882 ((or (= start-of-message start-of-window)
1883 (< start-of-message start-of-window))
1885 ;; If a small number of lines from the previous message are
1886 ;; visible, realign so that the top of the current message is at
1887 ;; the top of the screen.
1888 (when (<= (count-screen-lines (window-start) start-of-message)
1889 next-screen-context-lines)
1890 (goto-char (notmuch-show-message-top))
1891 (notmuch-show-message-adjust))
1892 ;; Move to the top left of the window.
1893 (goto-char (window-start)))
1895 ;; Move to the previous message.
1896 (notmuch-show-previous-message)))))
1898 (put 'notmuch-show-reply 'notmuch-prefix-doc "... and prompt for sender")
1899 (defun notmuch-show-reply (&optional prompt-for-sender)
1900 "Reply to the sender and all recipients of the current message."
1902 (notmuch-mua-new-reply (notmuch-show-get-message-id) prompt-for-sender t))
1904 (put 'notmuch-show-reply-sender 'notmuch-prefix-doc "... and prompt for sender")
1905 (defun notmuch-show-reply-sender (&optional prompt-for-sender)
1906 "Reply to the sender of the current message."
1908 (notmuch-mua-new-reply (notmuch-show-get-message-id) prompt-for-sender nil))
1910 (put 'notmuch-show-forward-message 'notmuch-prefix-doc
1911 "... and prompt for sender")
1912 (defun notmuch-show-forward-message (&optional prompt-for-sender)
1913 "Forward the current message."
1915 (notmuch-mua-new-forward-messages (list (notmuch-show-get-message-id))
1918 (put 'notmuch-show-forward-open-messages 'notmuch-prefix-doc
1919 "... and prompt for sender")
1920 (defun notmuch-show-forward-open-messages (&optional prompt-for-sender)
1921 "Forward the currently open messages."
1923 (let ((open-messages (notmuch-show-get-message-ids-for-open-messages)))
1924 (unless open-messages
1925 (error "No open messages to forward."))
1926 (notmuch-mua-new-forward-messages open-messages prompt-for-sender)))
1928 (defun notmuch-show-resend-message (addresses)
1929 "Resend the current message."
1930 (interactive (list (notmuch-address-from-minibuffer "Resend to: ")))
1931 (when (y-or-n-p (concat "Confirm resend to " addresses " "))
1932 (notmuch-show-view-raw-message)
1933 (message-resend addresses)
1934 (notmuch-bury-or-kill-this-buffer)))
1936 (defun notmuch-show-message-adjust ()
1939 (defun notmuch-show-next-message (&optional pop-at-end)
1940 "Show the next message.
1942 If a prefix argument is given and this is the last message in the
1943 thread, navigate to the next thread in the parent search buffer."
1945 (if (notmuch-show-goto-message-next)
1946 (notmuch-show-message-adjust)
1948 (notmuch-show-next-thread)
1949 (goto-char (point-max)))))
1951 (defun notmuch-show-previous-message ()
1952 "Show the previous message or the start of the current message."
1954 (if (= (point) (notmuch-show-message-top))
1955 (notmuch-show-goto-message-previous)
1956 (notmuch-show-move-to-message-top))
1957 (notmuch-show-message-adjust))
1959 (defun notmuch-show-next-open-message (&optional pop-at-end)
1960 "Show the next open message.
1962 If a prefix argument is given and this is the last open message
1963 in the thread, navigate to the next thread in the parent search
1964 buffer. Return t if there was a next open message in the thread
1965 to show, nil otherwise."
1968 (while (and (setq r (notmuch-show-goto-message-next))
1969 (not (notmuch-show-message-visible-p))))
1971 (notmuch-show-message-adjust)
1973 (notmuch-show-next-thread)
1974 (goto-char (point-max))))
1977 (defun notmuch-show-next-matching-message ()
1978 "Show the next matching message."
1981 (while (and (setq r (notmuch-show-goto-message-next))
1982 (not (notmuch-show-get-prop :match))))
1984 (notmuch-show-message-adjust)
1985 (goto-char (point-max)))))
1987 (defun notmuch-show-open-if-matched ()
1988 "Open a message if it is matched (whether or not excluded)."
1989 (let ((props (notmuch-show-get-message-properties)))
1990 (notmuch-show-message-visible props (plist-get props :match))))
1992 (defun notmuch-show-goto-first-wanted-message ()
1993 "Move to the first open message and mark it read."
1994 (goto-char (point-min))
1995 (unless (notmuch-show-message-visible-p)
1996 (notmuch-show-next-open-message))
1998 ;; There are no matched non-excluded messages so open all matched
1999 ;; (necessarily excluded) messages and go to the first.
2000 (notmuch-show-mapc 'notmuch-show-open-if-matched)
2001 (force-window-update)
2002 (goto-char (point-min))
2003 (unless (notmuch-show-message-visible-p)
2004 (notmuch-show-next-open-message))))
2006 (defun notmuch-show-previous-open-message ()
2007 "Show the previous open message."
2009 (while (and (if (= (point) (notmuch-show-message-top))
2010 (notmuch-show-goto-message-previous)
2011 (notmuch-show-move-to-message-top))
2012 (not (notmuch-show-message-visible-p))))
2013 (notmuch-show-message-adjust))
2015 (defun notmuch-show-view-raw-message ()
2016 "View the original source of the current message."
2018 (let* ((id (notmuch-show-get-message-id))
2019 (buf (get-buffer-create (concat "*notmuch-raw-" id "*")))
2020 (inhibit-read-only t))
2021 (pop-to-buffer-same-window buf)
2023 (let ((coding-system-for-read 'no-conversion))
2024 (call-process notmuch-command nil t nil "show" "--format=raw" id))
2025 (goto-char (point-min))
2026 (set-buffer-modified-p nil)
2027 (setq buffer-read-only t)
2028 (view-buffer buf 'kill-buffer-if-not-modified)))
2030 (defun notmuch-show-resume-message ()
2031 "Resume EDITING the current draft message."
2033 (notmuch-draft-resume (notmuch-show-get-message-id)))
2035 (put 'notmuch-show-pipe-message 'notmuch-doc
2036 "Pipe the contents of the current message to a command.")
2037 (put 'notmuch-show-pipe-message 'notmuch-prefix-doc
2038 "Pipe the thread as an mbox to a command.")
2039 (defun notmuch-show-pipe-message (entire-thread command)
2040 "Pipe the contents of the current message (or thread) to COMMAND.
2042 COMMAND will be executed with the raw contents of the current
2043 email message as stdin. Anything printed by the command to stdout
2044 or stderr will appear in the *notmuch-pipe* buffer.
2046 If ENTIRE-THREAD is non-nil (or when invoked with a prefix
2047 argument), COMMAND will receive all open messages in the current
2048 thread (formatted as an mbox) rather than only the current
2050 (interactive (let ((query-string (if current-prefix-arg
2051 "Pipe all open messages to command: "
2052 "Pipe message to command: ")))
2053 (list current-prefix-arg (read-string query-string))))
2054 (let (shell-command)
2057 (concat notmuch-command " show --format=mbox --exclude=false "
2058 (shell-quote-argument
2059 (mapconcat 'identity
2060 (notmuch-show-get-message-ids-for-open-messages)
2064 (concat notmuch-command " show --format=raw "
2065 (shell-quote-argument (notmuch-show-get-message-id))
2067 (let ((cwd default-directory)
2068 (buf (get-buffer-create (concat "*notmuch-pipe*"))))
2069 (with-current-buffer buf
2070 (setq buffer-read-only nil)
2072 ;; Use the originating buffer's working directory instead of
2073 ;; that of the pipe buffer.
2075 (let ((exit-code (call-process-shell-command shell-command nil buf)))
2076 (goto-char (point-max))
2077 (set-buffer-modified-p nil)
2078 (setq buffer-read-only t)
2079 (unless (zerop exit-code)
2081 (message (format "Command '%s' exited abnormally with code %d"
2082 shell-command exit-code))))))))
2084 (defun notmuch-show-tag-message (&rest tag-changes)
2085 "Change tags for the current message.
2087 TAG-CHANGES is a list of tag operations for `notmuch-tag'."
2088 (let* ((current-tags (notmuch-show-get-tags))
2089 (new-tags (notmuch-update-tags current-tags tag-changes)))
2090 (unless (equal current-tags new-tags)
2091 (notmuch-tag (notmuch-show-get-message-id) tag-changes)
2092 (notmuch-show-set-tags new-tags))))
2094 (defun notmuch-show-tag (tag-changes)
2095 "Change tags for the current message.
2097 See `notmuch-tag' for information on the format of TAG-CHANGES."
2098 (interactive (list (notmuch-read-tag-changes (notmuch-show-get-tags)
2100 (notmuch-tag (notmuch-show-get-message-id) tag-changes)
2101 (let* ((current-tags (notmuch-show-get-tags))
2102 (new-tags (notmuch-update-tags current-tags tag-changes)))
2103 (unless (equal current-tags new-tags)
2104 (notmuch-show-set-tags new-tags))))
2106 (defun notmuch-show-tag-all (tag-changes)
2107 "Change tags for all messages in the current show buffer.
2109 See `notmuch-tag' for information on the format of TAG-CHANGES."
2113 (lambda () (setq tags (append (notmuch-show-get-tags) tags))))
2114 (notmuch-read-tag-changes tags "Tag thread"))))
2115 (notmuch-tag (notmuch-show-get-messages-ids-search) tag-changes)
2118 (let* ((current-tags (notmuch-show-get-tags))
2119 (new-tags (notmuch-update-tags current-tags tag-changes)))
2120 (unless (equal current-tags new-tags)
2121 (notmuch-show-set-tags new-tags))))))
2123 (defun notmuch-show-add-tag (tag-changes)
2124 "Change tags for the current message (defaulting to add).
2126 Same as `notmuch-show-tag' but sets initial input to '+'."
2128 (list (notmuch-read-tag-changes (notmuch-show-get-tags) "Tag message" "+")))
2129 (notmuch-show-tag tag-changes))
2131 (defun notmuch-show-remove-tag (tag-changes)
2132 "Change tags for the current message (defaulting to remove).
2134 Same as `notmuch-show-tag' but sets initial input to '-'."
2136 (list (notmuch-read-tag-changes (notmuch-show-get-tags) "Tag message" "-")))
2137 (notmuch-show-tag tag-changes))
2139 (defun notmuch-show-toggle-visibility-headers ()
2140 "Toggle the visibility of the current message headers."
2142 (let ((props (notmuch-show-get-message-properties)))
2143 (notmuch-show-headers-visible
2145 (not (plist-get props :headers-visible))))
2146 (force-window-update))
2148 (defun notmuch-show-toggle-message ()
2149 "Toggle the visibility of the current message."
2151 (let ((props (notmuch-show-get-message-properties)))
2152 (notmuch-show-message-visible
2154 (not (plist-get props :message-visible))))
2155 (force-window-update))
2157 (put 'notmuch-show-open-or-close-all 'notmuch-doc "Show all messages.")
2158 (put 'notmuch-show-open-or-close-all 'notmuch-prefix-doc "Hide all messages.")
2159 (defun notmuch-show-open-or-close-all ()
2160 "Set the visibility all of the messages in the current thread.
2162 By default make all of the messages visible. With a prefix
2163 argument, hide all of the messages."
2166 (goto-char (point-min))
2167 (cl-loop do (notmuch-show-message-visible
2168 (notmuch-show-get-message-properties)
2169 (not current-prefix-arg))
2170 until (not (notmuch-show-goto-message-next))))
2171 (force-window-update))
2173 (defun notmuch-show-next-button ()
2174 "Advance point to the next button in the buffer."
2178 (defun notmuch-show-previous-button ()
2179 "Move point back to the previous button in the buffer."
2181 (backward-button 1))
2183 (defun notmuch-show-next-thread (&optional show previous)
2184 "Move to the next item in the search results, if any.
2186 If SHOW is non-nil, open the next item in a show
2187 buffer. Otherwise just highlight the next item in the search
2188 buffer. If PREVIOUS is non-nil, move to the previous item in the
2189 search results instead."
2191 (let ((parent-buffer notmuch-show-parent-buffer))
2192 (notmuch-bury-or-kill-this-buffer)
2193 (when (buffer-live-p parent-buffer)
2194 (switch-to-buffer parent-buffer)
2196 (notmuch-search-previous-thread)
2197 (notmuch-search-next-thread))
2199 (notmuch-search-show-thread)))))
2201 (defun notmuch-show-next-thread-show ()
2202 "Show the next thread in the search results, if any."
2204 (notmuch-show-next-thread t))
2206 (defun notmuch-show-previous-thread-show ()
2207 "Show the previous thread in the search results, if any."
2209 (notmuch-show-next-thread t t))
2211 (put 'notmuch-show-archive-thread 'notmuch-prefix-doc
2212 "Un-archive each message in thread.")
2213 (defun notmuch-show-archive-thread (&optional unarchive)
2214 "Archive each message in thread.
2216 Archive each message currently shown by applying the tag changes
2217 in `notmuch-archive-tags' to each. If a prefix argument is given,
2218 the messages will be \"unarchived\", i.e. the tag changes in
2219 `notmuch-archive-tags' will be reversed.
2221 Note: This command is safe from any race condition of new messages
2222 being delivered to the same thread. It does not archive the
2223 entire thread, but only the messages shown in the current
2226 (when notmuch-archive-tags
2227 (notmuch-show-tag-all
2228 (notmuch-tag-change-list notmuch-archive-tags unarchive))))
2230 (defun notmuch-show-archive-thread-then-next ()
2231 "Archive all messages in the current buffer, then show next thread from search."
2233 (notmuch-show-archive-thread)
2234 (notmuch-show-next-thread t))
2236 (defun notmuch-show-archive-thread-then-exit ()
2237 "Archive all messages in the current buffer, then exit back to search results."
2239 (notmuch-show-archive-thread)
2240 (notmuch-show-next-thread))
2242 (put 'notmuch-show-archive-message 'notmuch-prefix-doc
2243 "Un-archive the current message.")
2244 (defun notmuch-show-archive-message (&optional unarchive)
2245 "Archive the current message.
2247 Archive the current message by applying the tag changes in
2248 `notmuch-archive-tags' to it. If a prefix argument is given, the
2249 message will be \"unarchived\", i.e. the tag changes in
2250 `notmuch-archive-tags' will be reversed."
2252 (when notmuch-archive-tags
2253 (apply 'notmuch-show-tag-message
2254 (notmuch-tag-change-list notmuch-archive-tags unarchive))))
2256 (defun notmuch-show-archive-message-then-next-or-exit ()
2257 "Archive current message, then show next open message in current thread.
2259 If at the last open message in the current thread, then exit back
2262 (notmuch-show-archive-message)
2263 (notmuch-show-next-open-message t))
2265 (defun notmuch-show-archive-message-then-next-or-next-thread ()
2266 "Archive current message, then show next open message in current or next thread.
2268 If at the last open message in the current thread, then show next
2269 thread from search."
2271 (notmuch-show-archive-message)
2272 (unless (notmuch-show-next-open-message)
2273 (notmuch-show-next-thread t)))
2275 (defun notmuch-show-stash-cc ()
2276 "Copy CC field of current message to kill-ring."
2278 (notmuch-common-do-stash (notmuch-show-get-cc)))
2280 (put 'notmuch-show-stash-date 'notmuch-prefix-doc
2281 "Copy timestamp of current message to kill-ring.")
2282 (defun notmuch-show-stash-date (&optional stash-timestamp)
2283 "Copy date of current message to kill-ring.
2285 If invoked with a prefix argument, copy timestamp of current
2286 message to kill-ring."
2289 (notmuch-common-do-stash (format "%d" (notmuch-show-get-timestamp)))
2290 (notmuch-common-do-stash (notmuch-show-get-date))))
2292 (defun notmuch-show-stash-filename ()
2293 "Copy filename of current message to kill-ring."
2295 (notmuch-common-do-stash (notmuch-show-get-filename)))
2297 (defun notmuch-show-stash-from ()
2298 "Copy From address of current message to kill-ring."
2300 (notmuch-common-do-stash (notmuch-show-get-from)))
2302 (put 'notmuch-show-stash-message-id 'notmuch-prefix-doc
2303 "Copy thread: query matching current thread to kill-ring.")
2304 (defun notmuch-show-stash-message-id (&optional stash-thread-id)
2305 "Copy id: query matching the current message to kill-ring.
2307 If invoked with a prefix argument (or STASH-THREAD-ID is
2308 non-nil), copy thread: query matching the current thread to
2312 (notmuch-common-do-stash notmuch-show-thread-id)
2313 (notmuch-common-do-stash (notmuch-show-get-message-id))))
2315 (defun notmuch-show-stash-message-id-stripped ()
2316 "Copy message ID of current message (sans `id:' prefix) to kill-ring."
2318 (notmuch-common-do-stash (notmuch-show-get-message-id t)))
2320 (defun notmuch-show-stash-subject ()
2321 "Copy Subject field of current message to kill-ring."
2323 (notmuch-common-do-stash (notmuch-show-get-subject)))
2325 (defun notmuch-show-stash-tags ()
2326 "Copy tags of current message to kill-ring as a comma separated list."
2328 (notmuch-common-do-stash (mapconcat 'identity (notmuch-show-get-tags) ",")))
2330 (defun notmuch-show-stash-to ()
2331 "Copy To address of current message to kill-ring."
2333 (notmuch-common-do-stash (notmuch-show-get-to)))
2335 (defun notmuch-show-stash-mlarchive-link (&optional mla)
2336 "Copy an ML Archive URI for the current message to the kill-ring.
2338 This presumes that the message is available at the selected Mailing List Archive.
2340 If optional argument MLA is non-nil, use the provided key instead of prompting
2341 the user (see `notmuch-show-stash-mlarchive-link-alist')."
2343 (let ((url (cdr (assoc
2345 (let ((completion-ignore-case t))
2347 "Mailing List Archive: "
2348 notmuch-show-stash-mlarchive-link-alist
2350 notmuch-show-stash-mlarchive-link-default)))
2351 notmuch-show-stash-mlarchive-link-alist))))
2352 (notmuch-common-do-stash
2354 (funcall url (notmuch-show-get-message-id t))
2355 (concat url (notmuch-show-get-message-id t))))))
2357 (defun notmuch-show-stash-mlarchive-link-and-go (&optional mla)
2358 "Copy an ML Archive URI for the current message to the kill-ring and visit it.
2360 This presumes that the message is available at the selected Mailing List Archive.
2362 If optional argument MLA is non-nil, use the provided key instead of prompting
2363 the user (see `notmuch-show-stash-mlarchive-link-alist')."
2365 (notmuch-show-stash-mlarchive-link mla)
2366 (browse-url (current-kill 0 t)))
2368 (defun notmuch-show-stash-git-helper (addresses prefix)
2369 "Normalize all ADDRESSES while adding PREFIX.
2370 Escape, trim, quote and add PREFIX to each address in list
2371 of ADDRESSES, and return the result as a single string."
2372 (mapconcat (lambda (x)
2374 ;; escape double-quotes
2375 (replace-regexp-in-string
2377 ;; trim leading and trailing spaces
2378 (replace-regexp-in-string
2379 "\\(^ *\\| *$\\)" ""
2383 (put 'notmuch-show-stash-git-send-email 'notmuch-prefix-doc
2384 "Copy From/To/Cc of current message to kill-ring.
2385 Use a form suitable for pasting to git send-email command line.")
2387 (defun notmuch-show-stash-git-send-email (&optional no-in-reply-to)
2388 "Copy From/To/Cc/Message-Id of current message to kill-ring.
2389 Use a form suitable for pasting to git send-email command line.
2391 If invoked with a prefix argument (or NO-IN-REPLY-TO is non-nil),
2392 omit --in-reply-to=<Message-Id>."
2394 (notmuch-common-do-stash
2395 (mapconcat 'identity
2398 (notmuch-show-stash-git-helper
2399 (message-tokenize-header (notmuch-show-get-from)) "--to=")
2400 (notmuch-show-stash-git-helper
2401 (message-tokenize-header (notmuch-show-get-to)) "--to=")
2402 (notmuch-show-stash-git-helper
2403 (message-tokenize-header (notmuch-show-get-cc)) "--cc=")
2404 (unless no-in-reply-to
2405 (notmuch-show-stash-git-helper
2406 (list (notmuch-show-get-message-id t)) "--in-reply-to="))))
2409 ;;; Interactive part functions and their helpers
2411 (defun notmuch-show-generate-part-buffer (msg part)
2412 "Return a temporary buffer containing the specified part's content."
2413 (let ((buf (generate-new-buffer " *notmuch-part*"))
2414 (process-crypto notmuch-show-process-crypto))
2415 (with-current-buffer buf
2416 ;; This is always used in the content of mm handles, which
2417 ;; expect undecoded, binary part content.
2418 (insert (notmuch-get-bodypart-binary msg part process-crypto)))
2421 (defun notmuch-show-current-part-handle (&optional mime-type)
2422 "Return an mm-handle for the part containing point.
2424 This creates a temporary buffer for the part's content; the
2425 caller is responsible for killing this buffer as appropriate. If
2426 MIME-TYPE is given then set the handle's mime-type to MIME-TYPE."
2427 (let* ((msg (notmuch-show-get-message-properties))
2428 (part (notmuch-show-get-part-properties))
2429 (buf (notmuch-show-generate-part-buffer msg part))
2430 (computed-type (or mime-type (plist-get part :computed-type)))
2431 (filename (plist-get part :filename))
2432 (disposition (and filename `(attachment (filename . ,filename)))))
2433 (mm-make-handle buf (list computed-type) nil nil disposition)))
2435 (defun notmuch-show-apply-to-current-part-handle (fn &optional mime-type)
2436 "Apply FN to an mm-handle for the part containing point.
2438 This ensures that the temporary buffer created for the mm-handle
2439 is destroyed when FN returns. If MIME-TYPE is given then force
2440 part to be treated as if it had that mime-type."
2441 (let ((handle (notmuch-show-current-part-handle mime-type)))
2442 ;; Emacs puts stdout/stderr into the calling buffer so we call
2443 ;; it from a temp-buffer, unless notmuch-show-attachment-debug
2444 ;; is non-nil, in which case we put it in " *notmuch-part*".
2446 (if notmuch-show-attachment-debug
2447 (with-current-buffer (generate-new-buffer " *notmuch-part*")
2448 (funcall fn handle))
2450 (funcall fn handle)))
2451 (kill-buffer (mm-handle-buffer handle)))))
2453 (defun notmuch-show-part-button-default (&optional button)
2455 (let ((button (or button (button-at (point)))))
2456 ;; Try to toggle the part, if that fails then call the default
2457 ;; action. The toggle fails if the part has no emacs renderable
2459 (unless (notmuch-show-toggle-part-invisibility button)
2460 (call-interactively notmuch-show-part-button-default-action))))
2462 (defun notmuch-show-save-part ()
2463 "Save the MIME part containing point to a file."
2465 (notmuch-show-apply-to-current-part-handle #'mm-save-part))
2467 (defun notmuch-show-view-part ()
2468 "View the MIME part containing point in an external viewer."
2470 ;; Set mm-inlined-types to nil to force an external viewer
2471 (let ((mm-inlined-types nil))
2472 (notmuch-show-apply-to-current-part-handle #'mm-display-part)))
2474 (defun notmuch-show-interactively-view-part ()
2475 "View the MIME part containing point, prompting for a viewer."
2477 (notmuch-show-apply-to-current-part-handle #'mm-interactively-view-part))
2479 (defun notmuch-show-pipe-part ()
2480 "Pipe the MIME part containing point to an external command."
2482 (notmuch-show-apply-to-current-part-handle #'mm-pipe-part))
2484 (defun notmuch-show--mm-display-part (handle)
2485 "Use mm-display-part to display HANDLE in a new buffer.
2487 If the part is displayed in an external application then close
2489 (let ((buf (get-buffer-create (generate-new-buffer-name
2490 (concat " *notmuch-internal-part*")))))
2491 (pop-to-buffer-same-window buf)
2492 (if (eq (mm-display-part handle) 'external)
2494 (goto-char (point-min))
2495 (set-buffer-modified-p nil)
2496 (view-buffer buf 'kill-buffer-if-not-modified))))
2498 (defun notmuch-show-choose-mime-of-part (mime-type)
2499 "Choose the mime type to use for displaying part."
2501 (list (completing-read "Mime type to use (default text/plain): "
2502 (mailcap-mime-types) nil nil nil nil "text/plain")))
2503 (notmuch-show-apply-to-current-part-handle #'notmuch-show--mm-display-part
2506 (defun notmuch-show-imenu-prev-index-position-function ()
2507 "Move point to previous message in notmuch-show buffer.
2508 This function is used as a value for
2509 `imenu-prev-index-position-function'."
2512 (notmuch-show-previous-message)
2515 (defun notmuch-show-imenu-extract-index-name-function ()
2516 "Return imenu name for line at point.
2517 This function is used as a value for
2518 `imenu-extract-index-name-function'. Point should be at the
2519 beginning of the line."
2520 (back-to-indentation)
2521 (buffer-substring-no-properties (if notmuch-show-imenu-indent
2522 (line-beginning-position)
2524 (line-end-position)))
2526 (defmacro notmuch-show--with-currently-shown-message (&rest body)
2527 "Evaluate BODY with display restricted to the currently shown
2531 (let ((extent (notmuch-show-message-extent)))
2532 (narrow-to-region (car extent) (cdr extent))
2535 (defun notmuch-show--gather-urls ()
2536 "Gather any URLs in the current message."
2537 (notmuch-show--with-currently-shown-message
2539 (goto-char (point-min))
2540 (while (re-search-forward goto-address-url-regexp (point-max) t)
2541 (push (match-string-no-properties 0) urls))
2544 (defun notmuch-show-browse-urls (&optional kill)
2545 "Offer to browse any URLs in the current message.
2546 With a prefix argument, copy the URL to the kill ring rather than
2549 (let ((urls (notmuch-show--gather-urls))
2550 (prompt (if kill "Copy URL to kill ring: " "Browse URL: "))
2551 (fn (if kill #'kill-new #'browse-url)))
2553 (funcall fn (completing-read prompt urls nil nil nil nil (car urls)))
2554 (message "No URLs found."))))
2558 (provide 'notmuch-show)
2560 ;;; notmuch-show.el ends here