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-lib" (&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")
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 parent-buffer))
52 (declare-function notmuch-tree-get-message-properties "notmuch-tree" nil)
53 (declare-function notmuch-unthreaded "notmuch-tree"
54 (&optional query query-context target buffer-name
56 (declare-function notmuch-read-query "notmuch" (prompt))
57 (declare-function notmuch-draft-resume "notmuch-draft" (id))
59 (defvar shr-blocked-images)
60 (defvar gnus-blocked-images)
61 (defvar shr-content-function)
62 (defvar w3m-ignored-image-url-regexp)
66 (defcustom notmuch-message-headers '("Subject" "To" "Cc" "Date")
67 "Headers that should be shown in a message, in this order.
69 For an open message, all of these headers will be made visible
70 according to `notmuch-message-headers-visible' or can be toggled
71 with `notmuch-show-toggle-visibility-headers'. For a closed message,
72 only the first header in the list will be visible."
73 :type '(repeat string)
76 (defcustom notmuch-message-headers-visible t
77 "Should the headers be visible by default?
79 If this value is non-nil, then all of the headers defined in
80 `notmuch-message-headers' will be visible by default in the display
81 of each message. Otherwise, these headers will be hidden and
82 `notmuch-show-toggle-visibility-headers' can be used to make them
83 visible for any given message."
87 (defcustom notmuch-show-relative-dates t
88 "Display relative dates in the message summary line."
92 (defvar notmuch-show-markup-headers-hook '(notmuch-show-colour-headers)
93 "A list of functions called to decorate the headers listed in
94 `notmuch-message-headers'.")
96 (defcustom notmuch-show-hook '(notmuch-show-turn-on-visual-line-mode)
97 "Functions called after populating a `notmuch-show' buffer."
99 :options '(notmuch-show-turn-on-visual-line-mode)
101 :group 'notmuch-hooks)
103 (defcustom notmuch-show-insert-text/plain-hook
104 '(notmuch-wash-wrap-long-lines
105 notmuch-wash-tidy-citations
106 notmuch-wash-elide-blank-lines
107 notmuch-wash-excerpt-citations)
108 "Functions used to improve the display of text/plain parts."
110 :options '(notmuch-wash-convert-inline-patch-to-part
111 notmuch-wash-wrap-long-lines
112 notmuch-wash-tidy-citations
113 notmuch-wash-elide-blank-lines
114 notmuch-wash-excerpt-citations)
116 :group 'notmuch-hooks)
118 (defcustom notmuch-show-max-text-part-size 100000
119 "Maximum size of a text part to be shown by default in characters.
121 Set to 0 to show the part regardless of size."
123 :group 'notmuch-show)
125 ;; Mostly useful for debugging.
126 (defcustom notmuch-show-all-multipart/alternative-parts nil
127 "Should all parts of multipart/alternative parts be shown?"
129 :group 'notmuch-show)
131 (defcustom notmuch-show-indent-messages-width 1
132 "Width of message indentation in threads.
134 Messages are shown indented according to their depth in a thread.
135 This variable determines the width of this indentation measured
136 in number of blanks. Defaults to `1', choose `0' to disable
139 :group 'notmuch-show)
141 (defcustom notmuch-show-indent-multipart nil
142 "Should the sub-parts of a multipart/* part be indented?"
143 ;; dme: Not sure which is a good default.
145 :group 'notmuch-show)
147 (defcustom notmuch-show-part-button-default-action 'notmuch-show-save-part
148 "Default part header button action (on ENTER or mouse click)."
150 :type '(choice (const :tag "Save part"
151 notmuch-show-save-part)
152 (const :tag "View part"
153 notmuch-show-view-part)
154 (const :tag "View interactively"
155 notmuch-show-interactively-view-part)))
157 (defcustom notmuch-show-only-matching-messages nil
158 "Only matching messages are shown by default."
160 :group 'notmuch-show)
162 ;; By default, block all external images to prevent privacy leaks and
163 ;; potential attacks.
164 (defcustom notmuch-show-text/html-blocked-images "."
165 "Remote images that have URLs matching this regexp will be blocked."
166 :type '(choice (const nil) regexp)
167 :group 'notmuch-show)
171 (defvar-local notmuch-show-thread-id nil)
173 (defvar-local notmuch-show-parent-buffer nil)
175 (defvar-local notmuch-show-query-context nil)
177 (defvar-local notmuch-show-process-crypto nil)
179 (defvar-local notmuch-show-elide-non-matching-messages nil)
181 (defvar-local notmuch-show-indent-content t)
183 (defvar-local notmuch-show-single-message nil)
185 (defvar notmuch-show-attachment-debug nil
186 "If t log stdout and stderr from attachment handlers.
188 When set to nil (the default) stdout and stderr from attachment
189 handlers is discarded. When set to t the stdout and stderr from
190 each attachment handler is logged in buffers with names beginning
191 \" *notmuch-part*\".")
195 (defcustom notmuch-show-stash-mlarchive-link-alist
196 '(("MARC" . "https://marc.info/?i=")
197 ("Mail Archive, The" . "https://mid.mail-archive.com/")
198 ("Lore" . "https://lore.kernel.org/r/")
199 ("Notmuch" . "https://nmbug.notmuchmail.org/nmweb/show/")
200 ;; FIXME: can these services be searched by `Message-Id' ?
201 ;; ("MarkMail" . "http://markmail.org/")
202 ;; ("Nabble" . "http://nabble.com/")
203 ;; ("opensubscriber" . "http://opensubscriber.com/")
205 "List of Mailing List Archives to use when stashing links.
207 This list is used for generating a Mailing List Archive reference
208 URI with the current message's Message-Id in
209 `notmuch-show-stash-mlarchive-link'.
211 If the cdr of the alist element is not a function, the cdr is
212 expected to contain a URI that is concatenated with the current
213 message's Message-Id to create a ML archive reference URI.
215 If the cdr is a function, the function is called with the
216 Message-Id as the argument, and the function is expected to
217 return the ML archive reference URI."
218 :type '(alist :key-type (string :tag "Name")
221 (function :tag "Function returning the URL")))
222 :group 'notmuch-show)
224 (defcustom notmuch-show-stash-mlarchive-link-default "MARC"
225 "Default Mailing List Archive to use when stashing links.
227 This is used when `notmuch-show-stash-mlarchive-link' isn't
228 provided with an MLA argument nor `completing-read' input."
232 (list 'const :tag (car mla) :value (car mla)))
233 notmuch-show-stash-mlarchive-link-alist))
234 :group 'notmuch-show)
236 (defcustom notmuch-show-mark-read-tags '("-unread")
237 "List of tag changes to apply to a message when it is marked as read.
239 Tags starting with \"+\" (or not starting with either \"+\" or
240 \"-\") in the list will be added, and tags starting with \"-\"
241 will be removed from the message being marked as read.
243 For example, if you wanted to remove an \"unread\" tag and add a
244 \"read\" tag (which would make little sense), you would set:
245 (\"-unread\" \"+read\")"
246 :type '(repeat string)
247 :group 'notmuch-show)
249 (defcustom notmuch-show-mark-read-function #'notmuch-show-seen-current-message
250 "Function to control which messages are marked read.
252 The function should take two arguments START and END which will
253 be the start and end of the visible portion of the buffer and
254 should mark the appropriate messages read by applying
255 `notmuch-show-mark-read'. This function will be called after
256 every user interaction with notmuch."
258 :group 'notmuch-show)
260 (defcustom notmuch-show-imenu-indent nil
261 "Should Imenu display messages indented.
263 By default, Imenu (see Info node `(emacs) Imenu') in a
264 notmuch-show buffer displays all messages straight. This is
265 because the default Emacs frontend for Imenu makes it difficult
266 to select an Imenu entry with spaces in front. Other imenu
267 frontends such as counsel-imenu does not have this limitation.
268 In these cases, Imenu entries can be indented to reflect the
269 position of the message in the thread."
271 :group 'notmuch-show)
275 (defmacro with-current-notmuch-show-message (&rest body)
276 "Evaluate body with current buffer set to the text of current message."
278 (let ((id (notmuch-show-get-message-id)))
279 (let ((buf (generate-new-buffer (concat "*notmuch-msg-" id "*"))))
280 (with-current-buffer buf
281 (let ((coding-system-for-read 'no-conversion))
282 (call-process notmuch-command nil t nil "show" "--format=raw" id))
284 (kill-buffer buf)))))
286 (defun notmuch-show-turn-on-visual-line-mode ()
287 "Enable Visual Line mode."
288 (visual-line-mode t))
292 ;; DEPRECATED in Notmuch 0.16 since we now have convenient part
293 ;; commands. We'll keep the command around for a version or two in
294 ;; case people want to bind it themselves.
295 (defun notmuch-show-view-all-mime-parts ()
296 "Use external viewers to view all attachments from the current message."
298 (with-current-notmuch-show-message
299 ;; We override the mm-inline-media-tests to indicate which message
300 ;; parts are already sufficiently handled by the original
301 ;; presentation of the message in notmuch-show mode. These parts
302 ;; will be inserted directly into the temporary buffer of
303 ;; with-current-notmuch-show-message and silently discarded.
305 ;; Any MIME part not explicitly mentioned here will be handled by an
306 ;; external viewer as configured in the various mailcap files.
307 (let ((mm-inline-media-tests
308 '(("text/.*" ignore identity)
309 ("application/pgp-signature" ignore identity)
310 ("multipart/alternative" ignore identity)
311 ("multipart/mixed" ignore identity)
312 ("multipart/related" ignore identity))))
313 (mm-display-parts (mm-dissect-buffer)))))
315 (defun notmuch-show-save-attachments ()
316 "Save all attachments from the current message."
318 (with-current-notmuch-show-message
319 (let ((mm-handle (mm-dissect-buffer)))
320 (notmuch-save-attachments
321 mm-handle (> (notmuch-count-attachments mm-handle) 1))))
324 (defun notmuch-show-with-message-as-text (fn)
325 "Apply FN to a text representation of the current message.
327 FN is called with one argument, the message properties. It should
328 operation on the contents of the current buffer."
329 ;; Remake the header to ensure that all information is available.
330 (let* ((to (notmuch-show-get-to))
331 (cc (notmuch-show-get-cc))
332 (from (notmuch-show-get-from))
333 (subject (notmuch-show-get-subject))
334 (date (notmuch-show-get-date))
335 (tags (notmuch-show-get-tags))
336 (depth (notmuch-show-get-depth))
338 "Subject: " subject "\n"
340 (if (not (string-empty-p cc))
341 (concat "Cc: " cc "\n")
347 (mapconcat #'identity tags ", ") "\n")
349 (all (buffer-substring (notmuch-show-message-top)
350 (notmuch-show-message-bottom)))
352 (props (notmuch-show-get-message-properties))
353 (indenting notmuch-show-indent-content))
357 (indent-rigidly (point-min)
359 (- (* notmuch-show-indent-messages-width depth))))
360 ;; Remove the original header.
361 (goto-char (point-min))
362 (re-search-forward "^$" (point-max) nil)
363 (delete-region (point-min) (point))
365 (funcall fn props))))
367 (defun notmuch-show-print-message ()
368 "Print the current message."
370 (notmuch-show-with-message-as-text 'notmuch-print-message))
374 (defun notmuch-show-fontify-header ()
376 ((looking-at "[Tt]o:")
378 ((looking-at "[Bb]?[Cc][Cc]:")
380 ((looking-at "[Ss]ubject:")
381 'message-header-subject)
383 'message-header-other))))
384 (overlay-put (make-overlay (point) (re-search-forward ":"))
385 'face 'message-header-name)
386 (overlay-put (make-overlay (point) (re-search-forward ".*$"))
389 (defun notmuch-show-colour-headers ()
390 "Apply some colouring to the current headers."
391 (goto-char (point-min))
392 (while (looking-at "^[A-Za-z][-A-Za-z0-9]*:")
393 (notmuch-show-fontify-header)
396 (defun notmuch-show-spaces-n (n)
397 "Return a string comprised of `n' spaces."
400 (defun notmuch-show-update-tags (tags)
401 "Update the displayed tags of the current message."
403 (goto-char (notmuch-show-message-top))
404 (when (re-search-forward "(\\([^()]*\\))$" (line-end-position) t)
405 (let ((inhibit-read-only t))
406 (replace-match (concat "("
407 (notmuch-tag-format-tags
409 (notmuch-show-get-prop :orig-tags))
412 (defun notmuch-clean-address (address)
413 "Try to clean a single email ADDRESS for display. Return a cons
414 cell of (AUTHOR_EMAIL AUTHOR_NAME). Return (ADDRESS nil) if
417 (let (p-name p-address)
418 ;; It would be convenient to use `mail-header-parse-address',
419 ;; but that expects un-decoded mailbox parts, whereas our
420 ;; mailbox parts are already decoded (and hence may contain
421 ;; UTF-8). Given that notmuch should handle most of the awkward
422 ;; cases, some simple string deconstruction should be sufficient
425 ;; "User <user@dom.ain>" style.
426 ((string-match "\\(.*\\) <\\(.*\\)>" address)
427 (setq p-name (match-string 1 address))
428 (setq p-address (match-string 2 address)))
430 ;; "<user@dom.ain>" style.
431 ((string-match "<\\(.*\\)>" address)
432 (setq p-address (match-string 1 address)))
435 (setq p-address address)))
437 ;; Remove elements of the mailbox part that are not relevant for
438 ;; display, even if they are required during transport:
441 (setq p-name (replace-regexp-in-string "\\\\" "" p-name))
442 ;; Outer single and double quotes, which might be nested.
443 (cl-loop with start-of-loop
444 do (setq start-of-loop p-name)
445 when (string-match "^\"\\(.*\\)\"$" p-name)
446 do (setq p-name (match-string 1 p-name))
447 when (string-match "^'\\(.*\\)'$" p-name)
448 do (setq p-name (match-string 1 p-name))
449 until (string= start-of-loop p-name)))
450 ;; If the address is 'foo@bar.com <foo@bar.com>' then show just
452 (when (string= p-name p-address)
454 (cons p-address p-name))
455 (error (cons address nil))))
457 (defun notmuch-show-clean-address (address)
458 "Try to clean a single email ADDRESS for display.
459 Return unchanged ADDRESS if parsing fails."
460 (let* ((clean-address (notmuch-clean-address address))
461 (p-address (car clean-address))
462 (p-name (cdr clean-address)))
463 ;; If no name, return just the address.
466 ;; Otherwise format the name and address together.
467 (concat p-name " <" p-address ">"))))
469 (defun notmuch-show-insert-headerline (headers date tags depth)
470 "Insert a notmuch style headerline based on HEADERS for a
471 message at DEPTH in the current thread."
472 (let ((start (point))
473 (from (notmuch-sanitize
474 (notmuch-show-clean-address (plist-get headers :From)))))
475 (when (string-match "\\cR" from)
476 ;; If the From header has a right-to-left character add
477 ;; invisible U+200E LEFT-TO-RIGHT MARK character which forces
478 ;; the header paragraph as left-to-right text.
479 (insert (propertize (string ?\x200e) 'invisible t)))
480 (insert (if notmuch-show-indent-content
481 (notmuch-show-spaces-n (* notmuch-show-indent-messages-width
488 (notmuch-tag-format-tags tags tags)
490 (overlay-put (make-overlay start (point))
491 'face 'notmuch-message-summary-face)))
493 (defun notmuch-show-insert-header (header header-value)
494 "Insert a single header."
495 (insert header ": " (notmuch-sanitize header-value) "\n"))
497 (defun notmuch-show-insert-headers (headers)
498 "Insert the headers of the current message."
499 (let ((start (point)))
500 (mapc (lambda (header)
501 (let* ((header-symbol (intern (concat ":" header)))
502 (header-value (plist-get headers header-symbol)))
503 (when (and header-value
504 (not (string-equal "" header-value)))
505 (notmuch-show-insert-header header header-value))))
506 notmuch-message-headers)
509 (narrow-to-region start (point-max))
510 (run-hooks 'notmuch-show-markup-headers-hook)))))
514 (define-button-type 'notmuch-show-part-button-type
515 'action 'notmuch-show-part-button-default
518 :supertype 'notmuch-button-type)
520 (defun notmuch-show-insert-part-header (_nth content-type declared-type
521 &optional name comment)
522 (let ((base-label (concat (and name (concat name ": "))
524 (and (not (string-equal declared-type content-type))
525 (concat " (as " content-type ")"))
527 (prog1 (insert-button
528 (concat "[ " base-label " ]")
529 :base-label base-label
530 :type 'notmuch-show-part-button-type
531 :notmuch-part-hidden nil)
534 (defun notmuch-show-toggle-part-invisibility (&optional button)
536 (let ((button (or button (button-at (point)))))
538 (let ((overlay (button-get button 'overlay))
539 (lazy-part (button-get button :notmuch-lazy-part)))
540 ;; We have a part to toggle if there is an overlay or if there
541 ;; is a lazy part. If neither is present we cannot toggle the
542 ;; part so we just return nil.
543 (when (or overlay lazy-part)
544 (let* ((show (button-get button :notmuch-part-hidden))
545 (new-start (button-start button))
546 (button-label (button-get button :base-label))
548 (properties (text-properties-at (button-start button)))
549 (inhibit-read-only t))
550 ;; Toggle the button itself.
551 (button-put button :notmuch-part-hidden (not show))
552 (goto-char new-start)
553 (insert "[ " button-label (if show " ]" " (hidden) ]"))
554 (set-text-properties new-start (point) properties)
555 (let ((old-end (button-end button)))
556 (move-overlay button new-start (point))
557 (delete-region (point) old-end))
558 (goto-char (min old-point (1- (button-end button))))
559 ;; Return nil if there is a lazy-part, it is empty, and we are
560 ;; trying to show it. In all other cases return t.
563 (button-put button :notmuch-lazy-part nil)
564 (notmuch-show-lazy-part lazy-part button))
565 ;; else there must be an overlay.
566 (overlay-put overlay 'invisible (not show))
569 ;;; Part content ID handling
571 (defvar notmuch-show--cids nil
572 "Alist from raw content ID to (MSG PART).")
573 (make-variable-buffer-local 'notmuch-show--cids)
575 (defun notmuch-show--register-cids (msg part)
576 "Register content-IDs in PART and all of PART's sub-parts."
577 (let ((content-id (plist-get part :content-id)))
579 ;; Note that content-IDs are globally unique, except when they
580 ;; aren't: RFC 2046 section 5.1.4 permits children of a
581 ;; multipart/alternative to have the same content-ID, in which
582 ;; case the MUA is supposed to pick the best one it can render.
583 ;; We simply add the content-ID to the beginning of our alist;
584 ;; so if this happens, we'll take the last (and "best")
585 ;; alternative (even if we can't render it).
586 (push (list content-id msg part) notmuch-show--cids)))
587 ;; Recurse on sub-parts
588 (when-let ((type (plist-get part :content-type)))
589 (pcase-let ((`(,type ,subtype)
590 (split-string (downcase type) "/")))
591 (cond ((equal type "multipart")
592 (mapc (apply-partially #'notmuch-show--register-cids msg)
593 (plist-get part :content)))
594 ((and (equal type "message")
595 (equal subtype "rfc822"))
596 (notmuch-show--register-cids
598 (car (plist-get (car (plist-get part :content)) :body))))))))
600 (defun notmuch-show--get-cid-content (cid)
601 "Return a list (CID-content content-type) or nil.
603 This will only find parts from messages that have been inserted
604 into the current buffer. CID must be a raw content ID, without
605 enclosing angle brackets, a cid: prefix, or URL encoding. This
606 will return nil if the CID is unknown or cannot be retrieved."
607 (when-let ((descriptor (cdr (assoc cid notmuch-show--cids))))
608 (pcase-let ((`(,msg ,part) descriptor))
609 ;; Request caching for this content, as some messages
610 ;; reference the same cid: part many times (hundreds!).
611 (list (notmuch-get-bodypart-binary
612 msg part notmuch-show-process-crypto 'cache)
613 (plist-get part :content-type)))))
615 (defun notmuch-show-setup-w3m ()
616 "Instruct w3m how to retrieve content from a \"related\" part of a message."
618 (when (and (boundp 'w3m-cid-retrieve-function-alist)
619 (not (assq 'notmuch-show-mode w3m-cid-retrieve-function-alist)))
620 (push (cons 'notmuch-show-mode #'notmuch-show--cid-w3m-retrieve)
621 w3m-cid-retrieve-function-alist))
622 (setq mm-html-inhibit-images nil))
624 (defvar w3m-current-buffer) ;; From `w3m.el'.
625 (defun notmuch-show--cid-w3m-retrieve (url &rest _args)
626 ;; url includes the cid: prefix and is URL encoded (see RFC 2392).
627 (let* ((cid (url-unhex-string (substring url 4)))
629 (with-current-buffer w3m-current-buffer
630 (notmuch-show--get-cid-content cid))))
631 (when content-and-type
632 (insert (car content-and-type))
633 (cadr content-and-type))))
635 ;; MIME part renderers
637 (defun notmuch-show-multipart/*-to-list (part)
638 (mapcar (lambda (inner-part) (plist-get inner-part :content-type))
639 (plist-get part :content)))
641 (defun notmuch-show-insert-part-multipart/alternative (msg part _content-type _nth depth _button)
642 (let ((chosen-type (car (notmuch-multipart/alternative-choose
643 msg (notmuch-show-multipart/*-to-list part))))
644 (inner-parts (plist-get part :content))
646 ;; This inserts all parts of the chosen type rather than just one,
647 ;; but it's not clear that this is the wrong thing to do - which
648 ;; should be chosen if there are more than one that match?
649 (mapc (lambda (inner-part)
650 (let* ((inner-type (plist-get inner-part :content-type))
651 (hide (not (or notmuch-show-all-multipart/alternative-parts
652 (string= chosen-type inner-type)))))
653 (notmuch-show-insert-bodypart msg inner-part depth hide)))
656 (when notmuch-show-indent-multipart
657 (indent-rigidly start (point) 1)))
660 (defun notmuch-show-insert-part-multipart/related (msg part _content-type _nth depth _button)
661 (let ((inner-parts (plist-get part :content))
663 ;; Render the primary part. FIXME: Support RFC 2387 Start header.
664 (notmuch-show-insert-bodypart msg (car inner-parts) depth)
665 ;; Add hidden buttons for the rest
666 (mapc (lambda (inner-part)
667 (notmuch-show-insert-bodypart msg inner-part depth t))
669 (when notmuch-show-indent-multipart
670 (indent-rigidly start (point) 1)))
673 (defun notmuch-show-insert-part-multipart/signed (msg part _content-type _nth depth button)
675 (button-put button 'face 'notmuch-crypto-part-header))
676 ;; Insert a button detailing the signature status.
677 (notmuch-crypto-insert-sigstatus-button (car (plist-get part :sigstatus))
678 (notmuch-show-get-header :From msg))
679 (let ((inner-parts (plist-get part :content))
681 ;; Show all of the parts.
682 (mapc (lambda (inner-part)
683 (notmuch-show-insert-bodypart msg inner-part depth))
685 (when notmuch-show-indent-multipart
686 (indent-rigidly start (point) 1)))
689 (defun notmuch-show-insert-part-multipart/encrypted (msg part _content-type _nth depth button)
691 (button-put button 'face 'notmuch-crypto-part-header))
692 ;; Insert a button detailing the encryption status.
693 (notmuch-crypto-insert-encstatus-button (car (plist-get part :encstatus)))
694 ;; Insert a button detailing the signature status.
695 (notmuch-crypto-insert-sigstatus-button (car (plist-get part :sigstatus))
696 (notmuch-show-get-header :From msg))
697 (let ((inner-parts (plist-get part :content))
699 ;; Show all of the parts.
700 (mapc (lambda (inner-part)
701 (notmuch-show-insert-bodypart msg inner-part depth))
703 (when notmuch-show-indent-multipart
704 (indent-rigidly start (point) 1)))
707 (defun notmuch-show-insert-part-application/pgp-encrypted (_msg _part _content-type _nth _depth _button)
710 (defun notmuch-show-insert-part-multipart/* (msg part _content-type _nth depth _button)
711 (let ((inner-parts (plist-get part :content))
713 ;; Show all of the parts.
714 (mapc (lambda (inner-part)
715 (notmuch-show-insert-bodypart msg inner-part depth))
717 (when notmuch-show-indent-multipart
718 (indent-rigidly start (point) 1)))
721 (defun notmuch-show-insert-part-message/rfc822 (msg part _content-type _nth depth _button)
722 (let ((message (car (plist-get part :content))))
725 (let ((body (car (plist-get message :body)))
727 ;; Override `notmuch-message-headers' to force `From' to be
729 (let ((notmuch-message-headers '("From" "Subject" "To" "Cc" "Date")))
730 (notmuch-show-insert-headers (plist-get message :headers)))
731 ;; Blank line after headers to be compatible with the normal
735 (notmuch-show-insert-bodypart msg body depth)
736 (when notmuch-show-indent-multipart
737 (indent-rigidly start (point) 1))
740 (defun notmuch-show-insert-part-text/plain (msg part _content-type _nth depth button)
741 ;; For backward compatibility we want to apply the text/plain hook
742 ;; to the whole of the part including the part button if there is
744 (let ((start (if button
745 (button-start button)
747 (insert (notmuch-get-bodypart-text msg part notmuch-show-process-crypto))
750 (narrow-to-region start (point-max))
751 (run-hook-with-args 'notmuch-show-insert-text/plain-hook msg depth))))
754 (defun notmuch-show-insert-part-text/calendar (msg part _content-type _nth _depth _button)
755 (insert (with-temp-buffer
756 (insert (notmuch-get-bodypart-text msg part notmuch-show-process-crypto))
757 ;; notmuch-get-bodypart-text does no newline conversion.
758 ;; Replace CRLF with LF before icalendar can use it.
759 (goto-char (point-min))
760 (while (re-search-forward "\r\n" nil t)
761 (replace-match "\n" nil nil))
762 (let ((file (make-temp-file "notmuch-ical"))
766 (unless (icalendar-import-buffer file t)
767 (error "Icalendar import error. %s"
768 "See *icalendar-errors* for more information"))
769 (set-buffer (get-file-buffer file))
770 (setq result (buffer-substring (point-min) (point-max)))
771 (set-buffer-modified-p nil)
772 (kill-buffer (current-buffer)))
777 ;; For backwards compatibility.
778 (defun notmuch-show-insert-part-text/x-vcalendar (msg part _content-type _nth depth _button)
779 (notmuch-show-insert-part-text/calendar msg part nil nil depth nil))
781 (when (version< emacs-version "25.3")
782 ;; https://bugs.gnu.org/28350
784 ;; For newer emacs, we fall back to notmuch-show-insert-part-*/*
785 ;; (see notmuch-show-handlers-for)
786 (defun notmuch-show-insert-part-text/enriched
787 (msg part content-type nth depth button)
788 ;; By requiring enriched below, we ensure that the function
789 ;; enriched-decode-display-prop is defined before it will be
790 ;; shadowed by the letf below. Otherwise the version in
791 ;; enriched.el may be loaded a bit later and used instead (for
794 (cl-letf (((symbol-function 'enriched-decode-display-prop)
795 (lambda (start end &optional _param) (list start end))))
796 (notmuch-show-insert-part-*/* msg part content-type nth depth button))))
798 (defun notmuch-show-get-mime-type-of-application/octet-stream (part)
799 ;; If we can deduce a MIME type from the filename of the attachment,
801 (and (plist-get part :filename)
802 (let ((extension (file-name-extension (plist-get part :filename))))
805 (mailcap-parse-mimetypes)
806 (let ((mime-type (mailcap-extension-to-mime extension)))
808 (not (string-equal mime-type "application/octet-stream"))
811 (defun notmuch-show-insert-part-text/html (msg part content-type nth depth button)
812 (if (eq mm-text-html-renderer 'shr)
813 ;; It's easier to drive shr ourselves than to work around the
814 ;; goofy things `mm-shr' does (like irreversibly taking over
815 ;; content ID handling).
816 ;; FIXME: If we block an image, offer a button to load external
818 (let ((shr-blocked-images notmuch-show-text/html-blocked-images))
819 (notmuch-show--insert-part-text/html-shr msg part))
820 ;; Otherwise, let message-mode do the heavy lifting
822 ;; w3m sets up a keymap which "leaks" outside the invisible region
823 ;; and causes strange effects in notmuch. We set
824 ;; mm-inline-text-html-with-w3m-keymap to nil to tell w3m not to
825 ;; set a keymap (so the normal notmuch-show-mode-map remains).
826 (let ((mm-inline-text-html-with-w3m-keymap nil)
827 ;; FIXME: If we block an image, offer a button to load external
829 (gnus-blocked-images notmuch-show-text/html-blocked-images)
830 (w3m-ignored-image-url-regexp notmuch-show-text/html-blocked-images))
831 (notmuch-show-insert-part-*/* msg part content-type nth depth button))))
833 ;;; Functions used by notmuch-show--insert-part-text/html-shr
835 (declare-function libxml-parse-html-region "xml.c")
836 (declare-function shr-insert-document "shr")
838 (defun notmuch-show--insert-part-text/html-shr (msg part)
839 ;; Make sure shr is loaded before we start let-binding its globals
841 (let ((dom (let ((process-crypto notmuch-show-process-crypto))
843 (insert (notmuch-get-bodypart-text msg part process-crypto))
844 (libxml-parse-html-region (point-min) (point-max)))))
845 (shr-content-function
847 ;; shr strips the "cid:" part of URL, but doesn't
848 ;; URL-decode it (see RFC 2392).
849 (let ((cid (url-unhex-string url)))
850 (car (notmuch-show--get-cid-content cid))))))
851 (shr-insert-document dom)
854 (defun notmuch-show-insert-part-*/* (msg part content-type _nth _depth _button)
855 ;; This handler _must_ succeed - it is the handler of last resort.
856 (notmuch-mm-display-part-inline msg part content-type notmuch-show-process-crypto)
859 ;;; Functions for determining how to handle MIME parts.
861 (defun notmuch-show-handlers-for (content-type)
862 "Return a list of content handlers for a part of type CONTENT-TYPE."
865 (when (functionp func)
867 ;; Reverse order of prefrence.
868 (list (intern (concat "notmuch-show-insert-part-*/*"))
869 (intern (concat "notmuch-show-insert-part-"
870 (car (split-string content-type "/"))
872 (intern (concat "notmuch-show-insert-part-" content-type))))
877 (defun notmuch-show-insert-bodypart-internal (msg part content-type nth depth button)
878 ;; Run the handlers until one of them succeeds.
879 (cl-loop for handler in (notmuch-show-handlers-for content-type)
880 until (condition-case err
881 (funcall handler msg part content-type nth depth button)
882 ;; Specifying `debug' here lets the debugger run if
883 ;; `debug-on-error' is non-nil.
885 (insert "!!! Bodypart handler `" (prin1-to-string handler)
886 "' threw an error:\n"
887 "!!! " (error-message-string err) "\n")
890 (defun notmuch-show-create-part-overlays (button beg end)
891 "Add an overlay to the part between BEG and END."
892 ;; If there is no button (i.e., the part is text/plain and the first
893 ;; part) or if the part has no content then we don't make the part
895 (when (and button (/= beg end))
896 (button-put button 'overlay (make-overlay beg end))
897 ;; Return true if we created an overlay.
900 (defun notmuch-show-record-part-information (part beg end)
901 "Store PART as a text property from BEG to END."
902 ;; Record part information. Since we already inserted subparts,
903 ;; don't override existing :notmuch-part properties.
904 (notmuch-map-text-property beg end :notmuch-part
905 (lambda (v) (or v part)))
906 ;; Make :notmuch-part front sticky and rear non-sticky so it stays
907 ;; applied to the beginning of each line when we indent the
908 ;; message. Since we're operating on arbitrary renderer output,
909 ;; watch out for sticky specs of t, which means all properties are
910 ;; front-sticky/rear-nonsticky.
911 (notmuch-map-text-property beg end 'front-sticky
914 (cl-pushnew :notmuch-part v)
916 (notmuch-map-text-property beg end 'rear-nonsticky
919 (cl-pushnew :notmuch-part v)
922 (defun notmuch-show-lazy-part (part-args button)
923 ;; Insert the lazy part after the button for the part. We would just
924 ;; move to the start of the new line following the button and insert
925 ;; the part but that point might have text properties (eg colours
926 ;; from a message header etc) so instead we start from the last
927 ;; character of the button by adding a newline and finish by
928 ;; removing the extra newline from the end of the part.
930 (goto-char (button-end button))
932 (let* ((inhibit-read-only t)
933 ;; We need to use markers for the start and end of the part
934 ;; because the part insertion functions do not guarantee
935 ;; to leave point at the end of the part.
936 (part-beg (copy-marker (point) nil))
937 (part-end (copy-marker (point) t))
938 ;; We have to save the depth as we can't find the depth
940 (depth (notmuch-show-get-depth)))
942 (narrow-to-region part-beg part-end)
943 (delete-region part-beg part-end)
944 (apply #'notmuch-show-insert-bodypart-internal part-args)
945 (indent-rigidly part-beg
947 (* notmuch-show-indent-messages-width depth)))
950 (notmuch-show-record-part-information (cadr part-args)
951 (button-start button)
953 ;; Create the overlay. If the lazy-part turned out to be empty/not
954 ;; showable this returns nil.
955 (notmuch-show-create-part-overlays button part-beg part-end))))
957 (defun notmuch-show-mime-type (part)
958 "Return the correct mime-type to use for PART."
959 (when-let ((content-type (plist-get part :content-type)))
960 (setq content-type (downcase content-type))
961 (or (and (string= content-type "application/octet-stream")
962 (notmuch-show-get-mime-type-of-application/octet-stream part))
963 (and (string= content-type "inline patch")
967 ;; The following variable can be overridden by let bindings.
968 (defvar notmuch-show-insert-header-p-function 'notmuch-show-insert-header-p
969 "Specify which function decides which part headers get inserted.
971 The function should take two parameters, PART and HIDE, and
972 should return non-NIL if a header button should be inserted for
975 (defun notmuch-show-insert-header-p (part _hide)
976 ;; Show all part buttons except for the first part if it is text/plain.
977 (let ((mime-type (notmuch-show-mime-type part)))
978 (not (and (string= mime-type "text/plain")
979 (<= (plist-get part :id) 1)))))
981 (defun notmuch-show-reply-insert-header-p-never (_part _hide)
984 (defun notmuch-show-reply-insert-header-p-trimmed (part hide)
985 (let ((mime-type (notmuch-show-mime-type part)))
986 (and (not (notmuch-match-content-type mime-type "multipart/*"))
989 (defun notmuch-show-reply-insert-header-p-minimal (part hide)
990 (let ((mime-type (notmuch-show-mime-type part)))
991 (and (notmuch-match-content-type mime-type "text/*")
994 (defun notmuch-show-insert-bodypart (msg part depth &optional hide)
995 "Insert the body part PART at depth DEPTH in the current thread.
997 HIDE determines whether to show or hide the part and the button
998 as follows: If HIDE is nil, show the part and the button. If HIDE
999 is t, hide the part initially and show the button."
1000 (let* ((content-type (plist-get part :content-type))
1001 (mime-type (notmuch-show-mime-type part))
1002 (nth (plist-get part :id))
1003 (long (and (notmuch-match-content-type mime-type "text/*")
1004 (> notmuch-show-max-text-part-size 0)
1005 (> (length (plist-get part :content))
1006 notmuch-show-max-text-part-size)))
1008 ;; This default header-p function omits the part button for
1009 ;; the first (or only) part if this is text/plain.
1010 (button (and (funcall notmuch-show-insert-header-p-function part hide)
1011 (notmuch-show-insert-part-header
1013 (and content-type (downcase content-type))
1014 (plist-get part :filename))))
1015 ;; Hide the part initially if HIDE is t, or if it is too long
1016 ;; and we have a button to allow toggling.
1017 (show-part (not (or (equal hide t)
1018 (and long button))))
1019 (content-beg (point)))
1020 ;; Store the computed mime-type for later use (e.g. by attachment handlers).
1021 (plist-put part :computed-type mime-type)
1023 (notmuch-show-insert-bodypart-internal msg part mime-type nth depth button)
1025 (button-put button :notmuch-lazy-part
1026 (list msg part mime-type nth depth button))))
1027 ;; Some of the body part handlers leave point somewhere up in the
1028 ;; part, so we make sure that we're down at the end.
1029 (goto-char (point-max))
1030 ;; Ensure that the part ends with a carriage return.
1033 ;; We do not create the overlay for hidden (lazy) parts until
1034 ;; they are inserted.
1036 (notmuch-show-create-part-overlays button content-beg (point))
1038 (notmuch-show-toggle-part-invisibility button)))
1039 (notmuch-show-record-part-information part beg (point))))
1041 (defun notmuch-show-insert-body (msg body depth)
1042 "Insert the body BODY at depth DEPTH in the current thread."
1043 ;; Register all content IDs for this message. According to RFC
1044 ;; 2392, content IDs are *global*, but it's okay if an MUA treats
1045 ;; them as only global within a message.
1046 (notmuch-show--register-cids msg (car body))
1047 (mapc (lambda (part) (notmuch-show-insert-bodypart msg part depth)) body))
1049 (defun notmuch-show-make-symbol (type)
1050 (make-symbol (concat "notmuch-show-" type)))
1052 (defun notmuch-show-strip-re (string)
1053 (replace-regexp-in-string "^\\([Rr]e: *\\)+" "" string))
1055 (defvar notmuch-show-previous-subject "")
1056 (make-variable-buffer-local 'notmuch-show-previous-subject)
1058 (defun notmuch-show-insert-msg (msg depth)
1059 "Insert the message MSG at depth DEPTH in the current thread."
1060 (let* ((headers (plist-get msg :headers))
1061 ;; Indentation causes the buffer offset of the start/end
1062 ;; points to move, so we must use markers.
1063 message-start message-end
1064 content-start content-end
1065 headers-start headers-end
1066 (bare-subject (notmuch-show-strip-re (plist-get headers :Subject))))
1067 (setq message-start (point-marker))
1068 (notmuch-show-insert-headerline headers
1069 (or (and notmuch-show-relative-dates
1070 (plist-get msg :date_relative))
1071 (plist-get headers :Date))
1072 (plist-get msg :tags) depth)
1073 (setq content-start (point-marker))
1074 ;; Set `headers-start' to point after the 'Subject:' header to be
1075 ;; compatible with the existing implementation. This just sets it
1076 ;; to after the first header.
1077 (notmuch-show-insert-headers headers)
1079 (goto-char content-start)
1080 ;; If the subject of this message is the same as that of the
1081 ;; previous message, don't display it when this message is
1083 (unless (string= notmuch-show-previous-subject bare-subject)
1085 (setq headers-start (point-marker)))
1086 (setq headers-end (point-marker))
1087 (setq notmuch-show-previous-subject bare-subject)
1088 ;; A blank line between the headers and the body.
1090 (notmuch-show-insert-body msg (plist-get msg :body)
1091 (if notmuch-show-indent-content depth 0))
1092 ;; Ensure that the body ends with a newline.
1095 (setq content-end (point-marker))
1096 ;; Indent according to the depth in the thread.
1097 (when notmuch-show-indent-content
1098 (indent-rigidly content-start
1100 (* notmuch-show-indent-messages-width depth)))
1101 (setq message-end (point-max-marker))
1102 ;; Save the extents of this message over the whole text of the
1104 (put-text-property message-start message-end
1105 :notmuch-message-extent
1106 (cons message-start message-end))
1107 ;; Create overlays used to control visibility
1108 (plist-put msg :headers-overlay (make-overlay headers-start headers-end))
1109 (plist-put msg :message-overlay (make-overlay headers-start content-end))
1110 (plist-put msg :depth depth)
1111 ;; Save the properties for this message. Currently this saves the
1112 ;; entire message (augmented it with other stuff), which seems
1113 ;; like overkill. We might save a reduced subset (for example, not
1115 (notmuch-show-set-message-properties msg)
1116 ;; Set header visibility.
1117 (notmuch-show-headers-visible msg notmuch-message-headers-visible)
1118 ;; Message visibility depends on whether it matched the search
1120 (notmuch-show-message-visible msg (and (plist-get msg :match)
1121 (not (plist-get msg :excluded))))))
1125 (defun notmuch-show-toggle-process-crypto ()
1126 "Toggle the processing of cryptographic MIME parts."
1128 (setq notmuch-show-process-crypto (not notmuch-show-process-crypto))
1129 (message (if notmuch-show-process-crypto
1130 "Processing cryptographic MIME parts."
1131 "Not processing cryptographic MIME parts."))
1132 (notmuch-show-refresh-view))
1134 (defun notmuch-show-toggle-elide-non-matching ()
1135 "Toggle the display of non-matching messages."
1137 (setq notmuch-show-elide-non-matching-messages
1138 (not notmuch-show-elide-non-matching-messages))
1139 (message (if notmuch-show-elide-non-matching-messages
1140 "Showing matching messages only."
1141 "Showing all messages."))
1142 (notmuch-show-refresh-view))
1144 (defun notmuch-show-toggle-thread-indentation ()
1145 "Toggle the indentation of threads."
1147 (setq notmuch-show-indent-content (not notmuch-show-indent-content))
1148 (message (if notmuch-show-indent-content
1149 "Content is indented."
1150 "Content is not indented."))
1151 (notmuch-show-refresh-view))
1153 ;;; Main insert functions
1155 (defun notmuch-show-insert-tree (tree depth)
1156 "Insert the message tree TREE at depth DEPTH in the current thread."
1157 (let ((msg (car tree))
1158 (replies (cadr tree)))
1159 ;; We test whether there is a message or just some replies.
1161 (notmuch-show-insert-msg msg depth))
1162 (notmuch-show-insert-thread replies (1+ depth))))
1164 (defun notmuch-show-insert-thread (thread depth)
1165 "Insert the thread THREAD at depth DEPTH in the current forest."
1166 (mapc (lambda (tree) (notmuch-show-insert-tree tree depth)) thread))
1168 (defun notmuch-show-insert-forest (forest)
1169 "Insert the forest of threads FOREST."
1170 (mapc (lambda (thread) (notmuch-show-insert-thread thread 0)) forest))
1174 (defvar notmuch-id-regexp
1176 ;; Match the id: prefix only if it begins a word (to disallow, for
1177 ;; example, matching cid:).
1179 ;; If the term starts with a ", then parse Xapian's quoted boolean
1180 ;; term syntax, which allows for anything as long as embedded
1181 ;; double quotes escaped by doubling them. We also disallow
1182 ;; newlines (which Xapian allows) to prevent runaway terms.
1183 "\"\\([^\"\n]\\|\"\"\\)*\""
1184 ;; Otherwise, parse Xapian's unquoted syntax, which goes up to the
1185 ;; next space or ). We disallow [.,;] as the last character
1186 ;; because these are probably part of the surrounding text, and not
1187 ;; part of the id. This doesn't match single character ids; meh.
1188 "\\|[^\"[:space:])][^[:space:])]*[^])[:space:].,:;?!]"
1190 "The regexp used to match id: links in messages.")
1192 (defvar notmuch-mid-regexp
1193 ;; goto-address-url-regexp matched cid: links, which have the same
1194 ;; grammar as the message ID part of a mid: link. Construct the
1195 ;; regexp using the same technique as goto-address-url-regexp.
1196 (concat "\\<mid:\\(" thing-at-point-url-path-regexp "\\)")
1197 "The regexp used to match mid: links in messages.
1201 (defun notmuch-show-buttonise-links (start end)
1202 "Buttonise URLs and mail addresses between START and END.
1204 This also turns id:\"<message id>\"-parts and mid: links into
1205 buttons for a corresponding notmuch search."
1206 (goto-address-fontify-region start end)
1209 (beg-line (progn (goto-char start) (line-beginning-position)))
1210 (end-line (progn (goto-char end) (line-end-position))))
1211 (goto-char beg-line)
1212 (while (re-search-forward notmuch-id-regexp end-line t)
1213 (push (list (match-beginning 0) (match-end 0)
1214 (match-string-no-properties 0)) links))
1215 (goto-char beg-line)
1216 (while (re-search-forward notmuch-mid-regexp end-line t)
1217 (let* ((mid-cid (match-string-no-properties 1))
1218 (mid (save-match-data
1219 (string-match "^[^/]*" mid-cid)
1220 (url-unhex-string (match-string 0 mid-cid)))))
1221 (push (list (match-beginning 0) (match-end 0)
1222 (notmuch-id-to-query mid)) links)))
1223 (pcase-dolist (`(,beg ,end ,link) links)
1224 ;; Remove the overlay created by goto-address-mode
1225 (remove-overlays beg end 'goto-address t)
1226 (make-text-button beg end
1227 :type 'notmuch-button-type
1228 'action `(lambda (arg)
1229 (notmuch-show ,link current-prefix-arg))
1231 'help-echo "Mouse-1, RET: search for this message"
1232 'face goto-address-mail-face)))))
1237 (defun notmuch-show (thread-id &optional elide-toggle parent-buffer query-context buffer-name)
1238 "Run \"notmuch show\" with the given thread ID and display results.
1240 ELIDE-TOGGLE, if non-nil, inverts the default elide behavior.
1242 The optional PARENT-BUFFER is the notmuch-search buffer from
1243 which this notmuch-show command was executed, (so that the
1244 next thread from that buffer can be show when done with this
1247 The optional QUERY-CONTEXT is a notmuch search term. Only
1248 messages from the thread matching this search term are shown if
1251 The optional BUFFER-NAME provides the name of the buffer in
1252 which the message thread is shown. If it is nil (which occurs
1253 when the command is called interactively) the argument to the
1256 Returns the buffer containing the messages, or NIL if no messages
1258 (interactive "sNotmuch show: \nP")
1259 (let ((buffer-name (generate-new-buffer-name
1261 (concat "*notmuch-" thread-id "*"))))
1262 ;; We override mm-inline-override-types to stop application/*
1263 ;; parts from being displayed unless the user has customized
1265 (mm-inline-override-types
1266 (if (equal mm-inline-override-types
1267 (eval (car (get 'mm-inline-override-types 'standard-value))))
1268 (cons "application/*" mm-inline-override-types)
1269 mm-inline-override-types)))
1270 (pop-to-buffer-same-window (get-buffer-create buffer-name))
1271 ;; No need to track undo information for this buffer.
1272 (setq buffer-undo-list t)
1274 ;; Set various buffer local variables to their appropriate initial
1275 ;; state. Do this after enabling `notmuch-show-mode' so that they
1276 ;; aren't wiped out.
1277 (setq notmuch-show-thread-id thread-id)
1278 (setq notmuch-show-parent-buffer parent-buffer)
1279 (setq notmuch-show-query-context
1280 (if (or (string= query-context "")
1281 (string= query-context "*"))
1284 (setq notmuch-show-process-crypto notmuch-crypto-process-mime)
1285 ;; If `elide-toggle', invert the default value.
1286 (setq notmuch-show-elide-non-matching-messages
1288 (not notmuch-show-only-matching-messages)
1289 notmuch-show-only-matching-messages))
1290 (add-hook 'post-command-hook #'notmuch-show-command-hook nil t)
1291 (jit-lock-register #'notmuch-show-buttonise-links)
1292 (notmuch-tag-clear-cache)
1293 (let ((inhibit-read-only t))
1294 (if (notmuch-show--build-buffer)
1295 ;; Messages were inserted into the buffer.
1297 ;; No messages were inserted - presumably none matched the
1299 (kill-buffer (current-buffer))
1301 (message "No messages matched the query!")
1304 (defun notmuch-show--build-queries (thread context)
1305 "Return a list of queries to try for this search.
1307 THREAD and CONTEXT are both strings, though CONTEXT may be nil.
1308 When CONTEXT is not nil, the first query is the conjunction of it
1309 and THREAD. The next query is THREAD alone, and serves as a
1310 fallback if the prior matches no messages."
1312 (push (list thread) queries)
1314 (push (list thread "and (" context ")") queries))
1317 (defun notmuch-show--build-buffer (&optional state)
1318 "Display messages matching the current buffer context.
1320 Apply the previously saved STATE if supplied, otherwise show the
1321 first relevant message.
1323 If no messages match the query return NIL."
1324 (let* ((cli-args (list "--exclude=false"))
1325 (cli-args (if notmuch-show-elide-non-matching-messages (cons "--entire-thread=false" cli-args) cli-args))
1326 ;; "part 0 is the whole message (headers and body)" notmuch-show(1)
1327 (cli-args (if notmuch-show-single-message (cons "--part=0" cli-args) cli-args))
1328 (queries (notmuch-show--build-queries
1329 notmuch-show-thread-id notmuch-show-query-context))
1331 ;; Must be reset every time we are going to start inserting
1332 ;; messages into the buffer.
1333 (notmuch-show-previous-subject ""))
1334 ;; Use results from the first query that returns some.
1335 (while (and (not forest) queries)
1336 (setq forest (notmuch-query-get-threads
1337 (append cli-args (list "'") (car queries) (list "'"))))
1338 (when (and forest notmuch-show-single-message)
1339 (setq forest (list (list (list forest)))))
1340 (setq queries (cdr queries)))
1342 (notmuch-show-insert-forest forest)
1343 ;; Store the original tags for each message so that we can
1346 (lambda () (notmuch-show-set-prop :orig-tags (notmuch-show-get-tags))))
1347 ;; Set the header line to the subject of the first message.
1348 (setq header-line-format
1349 (replace-regexp-in-string "%" "%%"
1351 (notmuch-show-strip-re
1352 (notmuch-show-get-subject)))))
1353 (run-hooks 'notmuch-show-hook)
1355 (notmuch-show-apply-state state)
1356 ;; With no state to apply, just go to the first message.
1357 (notmuch-show-goto-first-wanted-message)))
1358 ;; Report back to the caller whether any messages matched.
1363 (defun notmuch-show-capture-state ()
1364 "Capture the state of the current buffer.
1367 - the list of open messages,
1368 - the combination of current message id with/for each visible window."
1369 (let* ((win-list (get-buffer-window-list (current-buffer) nil t))
1370 (win-id-combo (mapcar (lambda (win)
1371 (with-selected-window win
1372 (list win (notmuch-show-get-message-id))))
1374 (list win-id-combo (notmuch-show-get-message-ids-for-open-messages))))
1376 (defun notmuch-show-get-query ()
1377 "Return the current query in this show buffer."
1378 (if notmuch-show-query-context
1379 (concat notmuch-show-thread-id
1381 notmuch-show-query-context
1383 notmuch-show-thread-id))
1385 (defun notmuch-show-goto-message (msg-id)
1386 "Go to message with msg-id."
1387 (goto-char (point-min))
1388 (unless (cl-loop if (string= msg-id (notmuch-show-get-message-id))
1390 until (not (notmuch-show-goto-message-next)))
1391 (goto-char (point-min))
1392 (message "Message-id not found."))
1393 (notmuch-show-message-adjust))
1395 (defun notmuch-show-apply-state (state)
1396 "Apply STATE to the current buffer.
1399 - opening the messages previously opened,
1400 - closing all other messages,
1401 - moving to the correct current message in every displayed window."
1402 (let ((win-msg-alist (car state))
1403 (open (cadr state)))
1404 ;; Open those that were open.
1405 (goto-char (point-min))
1406 (cl-loop do (notmuch-show-message-visible
1407 (notmuch-show-get-message-properties)
1408 (member (notmuch-show-get-message-id) open))
1409 until (not (notmuch-show-goto-message-next)))
1410 (dolist (win-msg-pair win-msg-alist)
1411 (with-selected-window (car win-msg-pair)
1412 ;; Go to the previously open message in this window
1413 (notmuch-show-goto-message (cadr win-msg-pair))))))
1415 (defun notmuch-show-refresh-view (&optional reset-state)
1416 "Refresh the current view.
1418 Refreshes the current view, observing changes in display
1419 preferences. If invoked with a prefix argument (or RESET-STATE is
1420 non-nil) then the state of the buffer (open/closed messages) is
1421 reset based on the original query."
1423 (let ((inhibit-read-only t)
1424 (state (unless reset-state
1425 (notmuch-show-capture-state))))
1426 ;; `erase-buffer' does not seem to remove overlays, which can lead
1427 ;; to weird effects such as remaining images, so remove them
1431 (unless (notmuch-show--build-buffer state)
1432 ;; No messages were inserted.
1433 (kill-buffer (current-buffer))
1435 (message "Refreshing the buffer resulted in no messages!"))))
1439 (defvar notmuch-show-stash-map
1440 (let ((map (make-sparse-keymap)))
1441 (define-key map "c" 'notmuch-show-stash-cc)
1442 (define-key map "d" 'notmuch-show-stash-date)
1443 (define-key map "F" 'notmuch-show-stash-filename)
1444 (define-key map "f" 'notmuch-show-stash-from)
1445 (define-key map "i" 'notmuch-show-stash-message-id)
1446 (define-key map "I" 'notmuch-show-stash-message-id-stripped)
1447 (define-key map "s" 'notmuch-show-stash-subject)
1448 (define-key map "T" 'notmuch-show-stash-tags)
1449 (define-key map "t" 'notmuch-show-stash-to)
1450 (define-key map "l" 'notmuch-show-stash-mlarchive-link)
1451 (define-key map "L" 'notmuch-show-stash-mlarchive-link-and-go)
1452 (define-key map "G" 'notmuch-show-stash-git-send-email)
1453 (define-key map "?" 'notmuch-subkeymap-help)
1455 "Submap for stash commands.")
1456 (fset 'notmuch-show-stash-map notmuch-show-stash-map)
1458 (defvar notmuch-show-part-map
1459 (let ((map (make-sparse-keymap)))
1460 (define-key map "s" 'notmuch-show-save-part)
1461 (define-key map "v" 'notmuch-show-view-part)
1462 (define-key map "o" 'notmuch-show-interactively-view-part)
1463 (define-key map "|" 'notmuch-show-pipe-part)
1464 (define-key map "m" 'notmuch-show-choose-mime-of-part)
1465 (define-key map "?" 'notmuch-subkeymap-help)
1467 "Submap for part commands.")
1468 (fset 'notmuch-show-part-map notmuch-show-part-map)
1470 (defvar notmuch-show-mode-map
1471 (let ((map (make-sparse-keymap)))
1472 (set-keymap-parent map notmuch-common-keymap)
1473 (define-key map "Z" 'notmuch-tree-from-show-current-query)
1474 (define-key map "U" 'notmuch-unthreaded-from-show-current-query)
1475 (define-key map (kbd "<C-tab>") 'widget-backward)
1476 (define-key map (kbd "M-TAB") 'notmuch-show-previous-button)
1477 (define-key map (kbd "<backtab>") 'notmuch-show-previous-button)
1478 (define-key map (kbd "TAB") 'notmuch-show-next-button)
1479 (define-key map "f" 'notmuch-show-forward-message)
1480 (define-key map "F" 'notmuch-show-forward-open-messages)
1481 (define-key map "b" 'notmuch-show-resend-message)
1482 (define-key map "l" 'notmuch-show-filter-thread)
1483 (define-key map "r" 'notmuch-show-reply-sender)
1484 (define-key map "R" 'notmuch-show-reply)
1485 (define-key map "|" 'notmuch-show-pipe-message)
1486 (define-key map "w" 'notmuch-show-save-attachments)
1487 (define-key map "V" 'notmuch-show-view-raw-message)
1488 (define-key map "e" 'notmuch-show-resume-message)
1489 (define-key map "c" 'notmuch-show-stash-map)
1490 (define-key map "h" 'notmuch-show-toggle-visibility-headers)
1491 (define-key map "k" 'notmuch-tag-jump)
1492 (define-key map "*" 'notmuch-show-tag-all)
1493 (define-key map "-" 'notmuch-show-remove-tag)
1494 (define-key map "+" 'notmuch-show-add-tag)
1495 (define-key map "X" 'notmuch-show-archive-thread-then-exit)
1496 (define-key map "x" 'notmuch-show-archive-message-then-next-or-exit)
1497 (define-key map "A" 'notmuch-show-archive-thread-then-next)
1498 (define-key map "a" 'notmuch-show-archive-message-then-next-or-next-thread)
1499 (define-key map "N" 'notmuch-show-next-message)
1500 (define-key map "P" 'notmuch-show-previous-message)
1501 (define-key map "n" 'notmuch-show-next-open-message)
1502 (define-key map "p" 'notmuch-show-previous-open-message)
1503 (define-key map (kbd "M-n") 'notmuch-show-next-thread-show)
1504 (define-key map (kbd "M-p") 'notmuch-show-previous-thread-show)
1505 (define-key map (kbd "DEL") 'notmuch-show-rewind)
1506 (define-key map " " 'notmuch-show-advance-and-archive)
1507 (define-key map (kbd "M-RET") 'notmuch-show-open-or-close-all)
1508 (define-key map (kbd "RET") 'notmuch-show-toggle-message)
1509 (define-key map "#" 'notmuch-show-print-message)
1510 (define-key map "!" 'notmuch-show-toggle-elide-non-matching)
1511 (define-key map "$" 'notmuch-show-toggle-process-crypto)
1512 (define-key map "<" 'notmuch-show-toggle-thread-indentation)
1513 (define-key map "t" 'toggle-truncate-lines)
1514 (define-key map "." 'notmuch-show-part-map)
1515 (define-key map "B" 'notmuch-show-browse-urls)
1517 "Keymap for \"notmuch show\" buffers.")
1521 (define-derived-mode notmuch-show-mode fundamental-mode "notmuch-show"
1522 "Major mode for viewing a thread with notmuch.
1524 This buffer contains the results of the \"notmuch show\" command
1525 for displaying a single thread of email from your email archives.
1527 By default, various components of email messages, (citations,
1528 signatures, already-read messages), are hidden. You can make
1529 these parts visible by clicking with the mouse button or by
1530 pressing RET after positioning the cursor on a hidden part, (for
1531 which \\[notmuch-show-next-button] and \\[notmuch-show-previous-button] are helpful).
1533 Reading the thread sequentially is well-supported by pressing
1534 \\[notmuch-show-advance-and-archive]. This will scroll the current message (if necessary), advance
1535 to the next message, or advance to the next thread (if already on
1536 the last message of a thread).
1538 Other commands are available to read or manipulate the thread
1539 more selectively, (such as '\\[notmuch-show-next-message]' and '\\[notmuch-show-previous-message]' to advance to messages
1540 without removing any tags, and '\\[notmuch-show-archive-thread]' to archive an entire thread
1541 without scrolling through with \\[notmuch-show-advance-and-archive]).
1543 You can add or remove arbitrary tags from the current message with
1544 '\\[notmuch-show-add-tag]' or '\\[notmuch-show-remove-tag]'.
1546 All currently available key bindings:
1548 \\{notmuch-show-mode-map}"
1549 (setq notmuch-buffer-refresh-function #'notmuch-show-refresh-view)
1550 (setq buffer-read-only t)
1551 (setq truncate-lines t)
1552 (setq imenu-prev-index-position-function
1553 #'notmuch-show-imenu-prev-index-position-function)
1554 (setq imenu-extract-index-name-function
1555 #'notmuch-show-imenu-extract-index-name-function))
1559 (defun notmuch-tree-from-show-current-query ()
1560 "Call notmuch tree with the current query."
1562 (notmuch-tree notmuch-show-thread-id
1563 notmuch-show-query-context
1564 (notmuch-show-get-message-id)))
1566 (defun notmuch-unthreaded-from-show-current-query ()
1567 "Call notmuch unthreaded with the current query."
1569 (notmuch-unthreaded notmuch-show-thread-id
1570 notmuch-show-query-context
1571 (notmuch-show-get-message-id)))
1573 ;;; Movement related functions.
1575 (defun notmuch-show-move-to-message-top ()
1576 (goto-char (notmuch-show-message-top)))
1578 (defun notmuch-show-move-to-message-bottom ()
1579 (goto-char (notmuch-show-message-bottom)))
1581 ;; There's some strangeness here where a text property applied to a
1582 ;; region a->b is not found when point is at b. We walk backwards
1583 ;; until finding the property.
1584 (defun notmuch-show-message-extent ()
1585 "Return a cons cell containing the start and end buffer offset
1586 of the current message."
1589 (while (not (setq r (get-text-property (point) :notmuch-message-extent)))
1593 (defun notmuch-show-message-top ()
1594 (car (notmuch-show-message-extent)))
1596 (defun notmuch-show-message-bottom ()
1597 (cdr (notmuch-show-message-extent)))
1599 (defun notmuch-show-goto-message-next ()
1600 (let ((start (point)))
1601 (notmuch-show-move-to-message-bottom)
1607 (defun notmuch-show-goto-message-previous ()
1608 (notmuch-show-move-to-message-top)
1612 (notmuch-show-move-to-message-top)
1615 (defun notmuch-show-mapc (function)
1616 "Iterate through all messages in the current thread with
1617 `notmuch-show-goto-message-next' and call FUNCTION for side
1620 (goto-char (point-min))
1621 (cl-loop do (funcall function)
1622 while (notmuch-show-goto-message-next))))
1624 ;;; Functions relating to the visibility of messages and their components.
1626 (defun notmuch-show-message-visible (props visible-p)
1627 (overlay-put (plist-get props :message-overlay) 'invisible (not visible-p))
1628 (notmuch-show-set-prop :message-visible visible-p props))
1630 (defun notmuch-show-headers-visible (props visible-p)
1631 (overlay-put (plist-get props :headers-overlay) 'invisible (not visible-p))
1632 (notmuch-show-set-prop :headers-visible visible-p props))
1634 ;;; Functions for setting and getting attributes of the current message.
1636 (defun notmuch-show-set-message-properties (props)
1638 (notmuch-show-move-to-message-top)
1639 (put-text-property (point) (+ (point) 1)
1640 :notmuch-message-properties props)))
1642 (defun notmuch-show-get-message-properties ()
1643 "Return the properties of the current message as a plist.
1645 Some useful entries are:
1646 :headers - Property list containing the headers :Date, :Subject, :From, etc.
1647 :body - Body of the message
1648 :tags - Tags for this message"
1650 (notmuch-show-move-to-message-top)
1651 (get-text-property (point) :notmuch-message-properties)))
1653 (defun notmuch-show-get-part-properties ()
1654 "Return the properties of the innermost part containing point.
1656 This is the part property list retrieved from the CLI. Signals
1657 an error if there is no part containing point."
1658 (or (get-text-property (point) :notmuch-part)
1659 (error "No message part here")))
1661 (defun notmuch-show-set-prop (prop val &optional props)
1662 (let ((inhibit-read-only t)
1664 (notmuch-show-get-message-properties))))
1665 (plist-put props prop val)
1666 (notmuch-show-set-message-properties props)))
1668 (defun notmuch-show-get-prop (prop &optional props)
1669 "Get property PROP from current message in show or tree mode.
1671 It gets property PROP from PROPS or, if PROPS is nil, the current
1672 message in either tree or show. This means that several utility
1673 functions in notmuch-show can be used directly by notmuch-tree as
1674 they just need the correct message properties."
1675 (plist-get (or props
1676 (cond ((eq major-mode 'notmuch-show-mode)
1677 (notmuch-show-get-message-properties))
1678 ((eq major-mode 'notmuch-tree-mode)
1679 (notmuch-tree-get-message-properties))
1683 (defun notmuch-show-get-message-id (&optional bare)
1684 "Return an id: query for the Message-Id of the current message.
1686 If optional argument BARE is non-nil, return
1687 the Message-Id without id: prefix and escaping."
1689 (notmuch-show-get-prop :id)
1690 (notmuch-id-to-query (notmuch-show-get-prop :id))))
1692 (defun notmuch-show-get-messages-ids ()
1693 "Return all id: queries of messages in the current thread."
1694 (let ((message-ids))
1696 (lambda () (push (notmuch-show-get-message-id) message-ids)))
1699 (defun notmuch-show-get-messages-ids-search ()
1700 "Return a search string for all message ids of messages in the
1702 (mapconcat 'identity (notmuch-show-get-messages-ids) " or "))
1704 ;; dme: Would it make sense to use a macro for many of these?
1706 ;; XXX TODO figure out what to do about multiple filenames
1707 (defun notmuch-show-get-filename ()
1708 "Return the filename of the current message."
1709 (car (notmuch-show-get-prop :filename)))
1711 (defun notmuch-show-get-header (header &optional props)
1712 "Return the named header of the current message, if any."
1713 (plist-get (notmuch-show-get-prop :headers props) header))
1715 (defun notmuch-show-get-cc ()
1716 (notmuch-show-get-header :Cc))
1718 (defun notmuch-show-get-date ()
1719 (notmuch-show-get-header :Date))
1721 (defun notmuch-show-get-timestamp ()
1722 (notmuch-show-get-prop :timestamp))
1724 (defun notmuch-show-get-from ()
1725 (notmuch-show-get-header :From))
1727 (defun notmuch-show-get-subject ()
1728 (notmuch-show-get-header :Subject))
1730 (defun notmuch-show-get-to ()
1731 (notmuch-show-get-header :To))
1733 (defun notmuch-show-get-depth ()
1734 (notmuch-show-get-prop :depth))
1736 (defun notmuch-show-set-tags (tags)
1737 "Set the tags of the current message."
1738 (notmuch-show-set-prop :tags tags)
1739 (notmuch-show-update-tags tags))
1741 (defun notmuch-show-get-tags ()
1742 "Return the tags of the current message."
1743 (notmuch-show-get-prop :tags))
1745 (defun notmuch-show-message-visible-p ()
1746 "Is the current message visible?"
1747 (notmuch-show-get-prop :message-visible))
1749 (defun notmuch-show-headers-visible-p ()
1750 "Are the headers of the current message visible?"
1751 (notmuch-show-get-prop :headers-visible))
1753 (put 'notmuch-show-mark-read 'notmuch-prefix-doc
1754 "Mark the current message as unread.")
1755 (defun notmuch-show-mark-read (&optional unread)
1756 "Mark the current message as read.
1758 Mark the current message as read by applying the tag changes in
1759 `notmuch-show-mark-read-tags' to it (remove the \"unread\" tag by
1760 default). If a prefix argument is given, the message will be
1761 marked as unread, i.e. the tag changes in
1762 `notmuch-show-mark-read-tags' will be reversed."
1764 (when notmuch-show-mark-read-tags
1765 (apply 'notmuch-show-tag-message
1766 (notmuch-tag-change-list notmuch-show-mark-read-tags unread))))
1768 (defun notmuch-show-seen-current-message (_start _end)
1769 "Mark the current message read if it is open.
1771 We only mark it read once: if it is changed back then that is a
1772 user decision and we should not override it."
1773 (when (and (notmuch-show-message-visible-p)
1774 (not (notmuch-show-get-prop :seen)))
1775 (notmuch-show-mark-read)
1776 (notmuch-show-set-prop :seen t)))
1778 (defvar notmuch-show--seen-has-errored nil)
1779 (make-variable-buffer-local 'notmuch-show--seen-has-errored)
1781 (defun notmuch-show-command-hook ()
1782 (when (eq major-mode 'notmuch-show-mode)
1783 ;; We need to redisplay to get window-start and window-end correct.
1787 (funcall notmuch-show-mark-read-function (window-start) (window-end))
1789 (unless notmuch-show--seen-has-errored
1790 (setq notmuch-show--seen-has-errored t)
1791 (setq header-line-format
1792 (concat header-line-format
1794 " [some mark read tag changes may have failed]"
1795 'face font-lock-warning-face)))))))))
1797 (defun notmuch-show-filter-thread (query)
1798 "Filter or LIMIT the current thread based on a new query string.
1800 Reshows the current thread with matches defined by the new query-string."
1801 (interactive (list (notmuch-read-query "Filter thread: ")))
1802 (let ((msg-id (notmuch-show-get-message-id)))
1803 (setq notmuch-show-query-context (if (string-empty-p query) nil query))
1804 (notmuch-show-refresh-view t)
1805 (notmuch-show-goto-message msg-id)))
1807 ;;; Functions for getting attributes of several messages in the current thread.
1809 (defun notmuch-show-get-message-ids-for-open-messages ()
1810 "Return a list of all id: queries for open messages in the current thread."
1812 (let (message-ids done)
1813 (goto-char (point-min))
1815 (when (notmuch-show-message-visible-p)
1817 (append message-ids (list (notmuch-show-get-message-id)))))
1818 (setq done (not (notmuch-show-goto-message-next))))
1821 ;;; Commands typically bound to keys.
1823 (defun notmuch-show-advance ()
1824 "Advance through thread.
1826 If the current message in the thread is not yet fully visible,
1827 scroll by a near screenful to read more of the message.
1829 Otherwise, (the end of the current message is already within the
1830 current window), advance to the next open message."
1832 (let* ((end-of-this-message (notmuch-show-message-bottom))
1833 (visible-end-of-this-message (1- end-of-this-message))
1835 (while (invisible-p visible-end-of-this-message)
1836 (setq visible-end-of-this-message
1838 (1- (previous-single-char-property-change
1839 visible-end-of-this-message 'invisible)))))
1841 ;; Ideally we would test `end-of-this-message' against the result
1842 ;; of `window-end', but that doesn't account for the fact that
1843 ;; the end of the message might be hidden.
1844 ((and visible-end-of-this-message
1845 (> visible-end-of-this-message (window-end)))
1846 ;; The bottom of this message is not visible - scroll.
1848 ((not (= end-of-this-message (point-max)))
1849 ;; This is not the last message - move to the next visible one.
1850 (notmuch-show-next-open-message))
1851 ((not (= (point) (point-max)))
1852 ;; This is the last message, but the cursor is not at the end of
1853 ;; the buffer. Move it there.
1854 (goto-char (point-max)))
1856 ;; This is the last message - change the return value
1860 (defun notmuch-show-advance-and-archive ()
1861 "Advance through thread and archive.
1863 This command is intended to be one of the simplest ways to
1864 process a thread of email. It works exactly like
1865 notmuch-show-advance, in that it scrolls through messages in a
1866 show buffer, except that when it gets to the end of the buffer it
1867 archives the entire current thread, (apply changes in
1868 `notmuch-archive-tags'), kills the buffer, and displays the next
1869 thread from the search from which this thread was originally
1872 (when (notmuch-show-advance)
1873 (notmuch-show-archive-thread-then-next)))
1875 (defun notmuch-show-rewind ()
1876 "Backup through the thread (reverse scrolling compared to \
1877 \\[notmuch-show-advance-and-archive]).
1879 Specifically, if the beginning of the previous email is fewer
1880 than `window-height' lines from the current point, move to it
1881 just like `notmuch-show-previous-message'.
1883 Otherwise, just scroll down a screenful of the current message.
1885 This command does not modify any message tags, (it does not undo
1886 any effects from previous calls to
1887 `notmuch-show-advance-and-archive'."
1889 (let ((start-of-message (notmuch-show-message-top))
1890 (start-of-window (window-start)))
1892 ;; Either this message is properly aligned with the start of the
1893 ;; window or the start of this message is not visible on the
1895 ((or (= start-of-message start-of-window)
1896 (< start-of-message start-of-window))
1898 ;; If a small number of lines from the previous message are
1899 ;; visible, realign so that the top of the current message is at
1900 ;; the top of the screen.
1901 (when (<= (count-screen-lines (window-start) start-of-message)
1902 next-screen-context-lines)
1903 (goto-char (notmuch-show-message-top))
1904 (notmuch-show-message-adjust))
1905 ;; Move to the top left of the window.
1906 (goto-char (window-start)))
1908 ;; Move to the previous message.
1909 (notmuch-show-previous-message)))))
1911 (put 'notmuch-show-reply 'notmuch-prefix-doc "... and prompt for sender")
1912 (defun notmuch-show-reply (&optional prompt-for-sender)
1913 "Reply to the sender and all recipients of the current message."
1915 (notmuch-mua-new-reply (notmuch-show-get-message-id) prompt-for-sender t))
1917 (put 'notmuch-show-reply-sender 'notmuch-prefix-doc "... and prompt for sender")
1918 (defun notmuch-show-reply-sender (&optional prompt-for-sender)
1919 "Reply to the sender of the current message."
1921 (notmuch-mua-new-reply (notmuch-show-get-message-id) prompt-for-sender nil))
1923 (put 'notmuch-show-forward-message 'notmuch-prefix-doc
1924 "... and prompt for sender")
1925 (defun notmuch-show-forward-message (&optional prompt-for-sender)
1926 "Forward the current message."
1928 (notmuch-mua-new-forward-messages (list (notmuch-show-get-message-id))
1931 (put 'notmuch-show-forward-open-messages 'notmuch-prefix-doc
1932 "... and prompt for sender")
1933 (defun notmuch-show-forward-open-messages (&optional prompt-for-sender)
1934 "Forward the currently open messages."
1936 (let ((open-messages (notmuch-show-get-message-ids-for-open-messages)))
1937 (unless open-messages
1938 (error "No open messages to forward."))
1939 (notmuch-mua-new-forward-messages open-messages prompt-for-sender)))
1941 (defun notmuch-show-resend-message (addresses)
1942 "Resend the current message."
1943 (interactive (list (notmuch-address-from-minibuffer "Resend to: ")))
1944 (when (y-or-n-p (concat "Confirm resend to " addresses " "))
1945 (notmuch-show-view-raw-message)
1946 (message-resend addresses)
1947 (notmuch-bury-or-kill-this-buffer)))
1949 (defun notmuch-show-message-adjust ()
1952 (defun notmuch-show-next-message (&optional pop-at-end)
1953 "Show the next message.
1955 If a prefix argument is given and this is the last message in the
1956 thread, navigate to the next thread in the parent search buffer."
1958 (if (notmuch-show-goto-message-next)
1959 (notmuch-show-message-adjust)
1961 (notmuch-show-next-thread)
1962 (goto-char (point-max)))))
1964 (defun notmuch-show-previous-message ()
1965 "Show the previous message or the start of the current message."
1967 (if (= (point) (notmuch-show-message-top))
1968 (notmuch-show-goto-message-previous)
1969 (notmuch-show-move-to-message-top))
1970 (notmuch-show-message-adjust))
1972 (defun notmuch-show-next-open-message (&optional pop-at-end)
1973 "Show the next open message.
1975 If a prefix argument is given and this is the last open message
1976 in the thread, navigate to the next thread in the parent search
1977 buffer. Return t if there was a next open message in the thread
1978 to show, nil otherwise."
1981 (while (and (setq r (notmuch-show-goto-message-next))
1982 (not (notmuch-show-message-visible-p))))
1984 (notmuch-show-message-adjust)
1986 (notmuch-show-next-thread)
1987 (goto-char (point-max))))
1990 (defun notmuch-show-next-matching-message ()
1991 "Show the next matching message."
1994 (while (and (setq r (notmuch-show-goto-message-next))
1995 (not (notmuch-show-get-prop :match))))
1997 (notmuch-show-message-adjust)
1998 (goto-char (point-max)))))
2000 (defun notmuch-show-open-if-matched ()
2001 "Open a message if it is matched (whether or not excluded)."
2002 (let ((props (notmuch-show-get-message-properties)))
2003 (notmuch-show-message-visible props (plist-get props :match))))
2005 (defun notmuch-show-goto-first-wanted-message ()
2006 "Move to the first open message and mark it read."
2007 (goto-char (point-min))
2008 (unless (notmuch-show-message-visible-p)
2009 (notmuch-show-next-open-message))
2011 ;; There are no matched non-excluded messages so open all matched
2012 ;; (necessarily excluded) messages and go to the first.
2013 (notmuch-show-mapc 'notmuch-show-open-if-matched)
2014 (force-window-update)
2015 (goto-char (point-min))
2016 (unless (notmuch-show-message-visible-p)
2017 (notmuch-show-next-open-message))))
2019 (defun notmuch-show-previous-open-message ()
2020 "Show the previous open message."
2022 (while (and (if (= (point) (notmuch-show-message-top))
2023 (notmuch-show-goto-message-previous)
2024 (notmuch-show-move-to-message-top))
2025 (not (notmuch-show-message-visible-p))))
2026 (notmuch-show-message-adjust))
2028 (defun notmuch-show-view-raw-message ()
2029 "View the original source of the current message."
2031 (let* ((id (notmuch-show-get-message-id))
2032 (buf (get-buffer-create (concat "*notmuch-raw-" id "*")))
2033 (inhibit-read-only t))
2034 (pop-to-buffer-same-window buf)
2036 (let ((coding-system-for-read 'no-conversion))
2037 (call-process notmuch-command nil t nil "show" "--format=raw" id))
2038 (goto-char (point-min))
2039 (set-buffer-modified-p nil)
2040 (setq buffer-read-only t)
2041 (view-buffer buf 'kill-buffer-if-not-modified)))
2043 (defun notmuch-show-resume-message ()
2044 "Resume EDITING the current draft message."
2046 (notmuch-draft-resume (notmuch-show-get-message-id)))
2048 (put 'notmuch-show-pipe-message 'notmuch-doc
2049 "Pipe the contents of the current message to a command.")
2050 (put 'notmuch-show-pipe-message 'notmuch-prefix-doc
2051 "Pipe the thread as an mbox to a command.")
2052 (defun notmuch-show-pipe-message (entire-thread command)
2053 "Pipe the contents of the current message (or thread) to COMMAND.
2055 COMMAND will be executed with the raw contents of the current
2056 email message as stdin. Anything printed by the command to stdout
2057 or stderr will appear in the *notmuch-pipe* buffer.
2059 If ENTIRE-THREAD is non-nil (or when invoked with a prefix
2060 argument), COMMAND will receive all open messages in the current
2061 thread (formatted as an mbox) rather than only the current
2063 (interactive (let ((query-string (if current-prefix-arg
2064 "Pipe all open messages to command: "
2065 "Pipe message to command: ")))
2066 (list current-prefix-arg (read-string query-string))))
2067 (let (shell-command)
2070 (concat notmuch-command " show --format=mbox --exclude=false "
2071 (shell-quote-argument
2072 (mapconcat 'identity
2073 (notmuch-show-get-message-ids-for-open-messages)
2077 (concat notmuch-command " show --format=raw "
2078 (shell-quote-argument (notmuch-show-get-message-id))
2080 (let ((cwd default-directory)
2081 (buf (get-buffer-create (concat "*notmuch-pipe*"))))
2082 (with-current-buffer buf
2083 (setq buffer-read-only t)
2084 (let ((inhibit-read-only t))
2086 ;; Use the originating buffer's working directory instead of
2087 ;; that of the pipe buffer.
2089 (let ((exit-code (call-process-shell-command shell-command nil buf)))
2090 (goto-char (point-max))
2091 (set-buffer-modified-p nil)
2092 (unless (zerop exit-code)
2094 (message (format "Command '%s' exited abnormally with code %d"
2095 shell-command exit-code)))))))))
2097 (defun notmuch-show-tag-message (&rest tag-changes)
2098 "Change tags for the current message.
2100 TAG-CHANGES is a list of tag operations for `notmuch-tag'."
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-tag (notmuch-show-get-message-id) tag-changes)
2105 (notmuch-show-set-tags new-tags))))
2107 (defun notmuch-show-tag (tag-changes)
2108 "Change tags for the current message.
2110 See `notmuch-tag' for information on the format of TAG-CHANGES."
2111 (interactive (list (notmuch-read-tag-changes (notmuch-show-get-tags)
2113 (notmuch-tag (notmuch-show-get-message-id) tag-changes)
2114 (let* ((current-tags (notmuch-show-get-tags))
2115 (new-tags (notmuch-update-tags current-tags tag-changes)))
2116 (unless (equal current-tags new-tags)
2117 (notmuch-show-set-tags new-tags))))
2119 (defun notmuch-show-tag-all (tag-changes)
2120 "Change tags for all messages in the current show buffer.
2122 See `notmuch-tag' for information on the format of TAG-CHANGES."
2126 (lambda () (setq tags (append (notmuch-show-get-tags) tags))))
2127 (notmuch-read-tag-changes tags "Tag thread"))))
2128 (notmuch-tag (notmuch-show-get-messages-ids-search) tag-changes)
2131 (let* ((current-tags (notmuch-show-get-tags))
2132 (new-tags (notmuch-update-tags current-tags tag-changes)))
2133 (unless (equal current-tags new-tags)
2134 (notmuch-show-set-tags new-tags))))))
2136 (defun notmuch-show-add-tag (tag-changes)
2137 "Change tags for the current message (defaulting to add).
2139 Same as `notmuch-show-tag' but sets initial input to '+'."
2141 (list (notmuch-read-tag-changes (notmuch-show-get-tags) "Tag message" "+")))
2142 (notmuch-show-tag tag-changes))
2144 (defun notmuch-show-remove-tag (tag-changes)
2145 "Change tags for the current message (defaulting to remove).
2147 Same as `notmuch-show-tag' but sets initial input to '-'."
2149 (list (notmuch-read-tag-changes (notmuch-show-get-tags) "Tag message" "-")))
2150 (notmuch-show-tag tag-changes))
2152 (defun notmuch-show-toggle-visibility-headers ()
2153 "Toggle the visibility of the current message headers."
2155 (let ((props (notmuch-show-get-message-properties)))
2156 (notmuch-show-headers-visible
2158 (not (plist-get props :headers-visible))))
2159 (force-window-update))
2161 (defun notmuch-show-toggle-message ()
2162 "Toggle the visibility of the current message."
2164 (let ((props (notmuch-show-get-message-properties)))
2165 (notmuch-show-message-visible
2167 (not (plist-get props :message-visible))))
2168 (force-window-update))
2170 (put 'notmuch-show-open-or-close-all 'notmuch-doc "Show all messages.")
2171 (put 'notmuch-show-open-or-close-all 'notmuch-prefix-doc "Hide all messages.")
2172 (defun notmuch-show-open-or-close-all ()
2173 "Set the visibility all of the messages in the current thread.
2175 By default make all of the messages visible. With a prefix
2176 argument, hide all of the messages."
2179 (goto-char (point-min))
2180 (cl-loop do (notmuch-show-message-visible
2181 (notmuch-show-get-message-properties)
2182 (not current-prefix-arg))
2183 until (not (notmuch-show-goto-message-next))))
2184 (force-window-update))
2186 (defun notmuch-show-next-button ()
2187 "Advance point to the next button in the buffer."
2191 (defun notmuch-show-previous-button ()
2192 "Move point back to the previous button in the buffer."
2194 (backward-button 1))
2196 (defun notmuch-show-next-thread (&optional show previous)
2197 "Move to the next item in the search results, if any.
2199 If SHOW is non-nil, open the next item in a show
2200 buffer. Otherwise just highlight the next item in the search
2201 buffer. If PREVIOUS is non-nil, move to the previous item in the
2202 search results instead."
2204 (let ((parent-buffer notmuch-show-parent-buffer))
2205 (notmuch-bury-or-kill-this-buffer)
2206 (when (buffer-live-p parent-buffer)
2207 (switch-to-buffer parent-buffer)
2209 (notmuch-search-previous-thread)
2210 (notmuch-search-next-thread))
2212 (notmuch-search-show-thread)))))
2214 (defun notmuch-show-next-thread-show ()
2215 "Show the next thread in the search results, if any."
2217 (notmuch-show-next-thread t))
2219 (defun notmuch-show-previous-thread-show ()
2220 "Show the previous thread in the search results, if any."
2222 (notmuch-show-next-thread t t))
2224 (put 'notmuch-show-archive-thread 'notmuch-prefix-doc
2225 "Un-archive each message in thread.")
2226 (defun notmuch-show-archive-thread (&optional unarchive)
2227 "Archive each message in thread.
2229 Archive each message currently shown by applying the tag changes
2230 in `notmuch-archive-tags' to each. If a prefix argument is given,
2231 the messages will be \"unarchived\", i.e. the tag changes in
2232 `notmuch-archive-tags' will be reversed.
2234 Note: This command is safe from any race condition of new messages
2235 being delivered to the same thread. It does not archive the
2236 entire thread, but only the messages shown in the current
2239 (when notmuch-archive-tags
2240 (notmuch-show-tag-all
2241 (notmuch-tag-change-list notmuch-archive-tags unarchive))))
2243 (defun notmuch-show-archive-thread-then-next ()
2244 "Archive all messages in the current buffer, then show next thread from search."
2246 (notmuch-show-archive-thread)
2247 (notmuch-show-next-thread t))
2249 (defun notmuch-show-archive-thread-then-exit ()
2250 "Archive all messages in the current buffer, then exit back to search results."
2252 (notmuch-show-archive-thread)
2253 (notmuch-show-next-thread))
2255 (put 'notmuch-show-archive-message 'notmuch-prefix-doc
2256 "Un-archive the current message.")
2257 (defun notmuch-show-archive-message (&optional unarchive)
2258 "Archive the current message.
2260 Archive the current message by applying the tag changes in
2261 `notmuch-archive-tags' to it. If a prefix argument is given, the
2262 message will be \"unarchived\", i.e. the tag changes in
2263 `notmuch-archive-tags' will be reversed."
2265 (when notmuch-archive-tags
2266 (apply 'notmuch-show-tag-message
2267 (notmuch-tag-change-list notmuch-archive-tags unarchive))))
2269 (defun notmuch-show-archive-message-then-next-or-exit ()
2270 "Archive current message, then show next open message in current thread.
2272 If at the last open message in the current thread, then exit back
2275 (notmuch-show-archive-message)
2276 (notmuch-show-next-open-message t))
2278 (defun notmuch-show-archive-message-then-next-or-next-thread ()
2279 "Archive current message, then show next open message in current or next thread.
2281 If at the last open message in the current thread, then show next
2282 thread from search."
2284 (notmuch-show-archive-message)
2285 (unless (notmuch-show-next-open-message)
2286 (notmuch-show-next-thread t)))
2288 (defun notmuch-show-stash-cc ()
2289 "Copy CC field of current message to kill-ring."
2291 (notmuch-common-do-stash (notmuch-show-get-cc)))
2293 (put 'notmuch-show-stash-date 'notmuch-prefix-doc
2294 "Copy timestamp of current message to kill-ring.")
2295 (defun notmuch-show-stash-date (&optional stash-timestamp)
2296 "Copy date of current message to kill-ring.
2298 If invoked with a prefix argument, copy timestamp of current
2299 message to kill-ring."
2302 (notmuch-common-do-stash (format "%d" (notmuch-show-get-timestamp)))
2303 (notmuch-common-do-stash (notmuch-show-get-date))))
2305 (defun notmuch-show-stash-filename ()
2306 "Copy filename of current message to kill-ring."
2308 (notmuch-common-do-stash (notmuch-show-get-filename)))
2310 (defun notmuch-show-stash-from ()
2311 "Copy From address of current message to kill-ring."
2313 (notmuch-common-do-stash (notmuch-show-get-from)))
2315 (put 'notmuch-show-stash-message-id 'notmuch-prefix-doc
2316 "Copy thread: query matching current thread to kill-ring.")
2317 (defun notmuch-show-stash-message-id (&optional stash-thread-id)
2318 "Copy id: query matching the current message to kill-ring.
2320 If invoked with a prefix argument (or STASH-THREAD-ID is
2321 non-nil), copy thread: query matching the current thread to
2325 (notmuch-common-do-stash notmuch-show-thread-id)
2326 (notmuch-common-do-stash (notmuch-show-get-message-id))))
2328 (defun notmuch-show-stash-message-id-stripped ()
2329 "Copy message ID of current message (sans `id:' prefix) to kill-ring."
2331 (notmuch-common-do-stash (notmuch-show-get-message-id t)))
2333 (defun notmuch-show-stash-subject ()
2334 "Copy Subject field of current message to kill-ring."
2336 (notmuch-common-do-stash (notmuch-show-get-subject)))
2338 (defun notmuch-show-stash-tags ()
2339 "Copy tags of current message to kill-ring as a comma separated list."
2341 (notmuch-common-do-stash (mapconcat 'identity (notmuch-show-get-tags) ",")))
2343 (defun notmuch-show-stash-to ()
2344 "Copy To address of current message to kill-ring."
2346 (notmuch-common-do-stash (notmuch-show-get-to)))
2348 (defun notmuch-show-stash-mlarchive-link (&optional mla)
2349 "Copy an ML Archive URI for the current message to the kill-ring.
2351 This presumes that the message is available at the selected Mailing List Archive.
2353 If optional argument MLA is non-nil, use the provided key instead of prompting
2354 the user (see `notmuch-show-stash-mlarchive-link-alist')."
2356 (let ((url (cdr (assoc
2358 (let ((completion-ignore-case t))
2360 "Mailing List Archive: "
2361 notmuch-show-stash-mlarchive-link-alist
2363 notmuch-show-stash-mlarchive-link-default)))
2364 notmuch-show-stash-mlarchive-link-alist))))
2365 (notmuch-common-do-stash
2367 (funcall url (notmuch-show-get-message-id t))
2368 (concat url (notmuch-show-get-message-id t))))))
2370 (defun notmuch-show-stash-mlarchive-link-and-go (&optional mla)
2371 "Copy an ML Archive URI for the current message to the kill-ring and visit it.
2373 This presumes that the message is available at the selected Mailing List Archive.
2375 If optional argument MLA is non-nil, use the provided key instead of prompting
2376 the user (see `notmuch-show-stash-mlarchive-link-alist')."
2378 (notmuch-show-stash-mlarchive-link mla)
2379 (browse-url (current-kill 0 t)))
2381 (defun notmuch-show-stash-git-helper (addresses prefix)
2382 "Normalize all ADDRESSES while adding PREFIX.
2383 Escape, trim, quote and add PREFIX to each address in list
2384 of ADDRESSES, and return the result as a single string."
2385 (mapconcat (lambda (x)
2387 ;; escape double-quotes
2388 (replace-regexp-in-string
2390 ;; trim leading and trailing spaces
2391 (replace-regexp-in-string
2392 "\\(^ *\\| *$\\)" ""
2396 (put 'notmuch-show-stash-git-send-email 'notmuch-prefix-doc
2397 "Copy From/To/Cc of current message to kill-ring.
2398 Use a form suitable for pasting to git send-email command line.")
2400 (defun notmuch-show-stash-git-send-email (&optional no-in-reply-to)
2401 "Copy From/To/Cc/Message-Id of current message to kill-ring.
2402 Use a form suitable for pasting to git send-email command line.
2404 If invoked with a prefix argument (or NO-IN-REPLY-TO is non-nil),
2405 omit --in-reply-to=<Message-Id>."
2407 (notmuch-common-do-stash
2408 (mapconcat 'identity
2411 (notmuch-show-stash-git-helper
2412 (message-tokenize-header (notmuch-show-get-from)) "--to=")
2413 (notmuch-show-stash-git-helper
2414 (message-tokenize-header (notmuch-show-get-to)) "--to=")
2415 (notmuch-show-stash-git-helper
2416 (message-tokenize-header (notmuch-show-get-cc)) "--cc=")
2417 (unless no-in-reply-to
2418 (notmuch-show-stash-git-helper
2419 (list (notmuch-show-get-message-id t)) "--in-reply-to="))))
2422 ;;; Interactive part functions and their helpers
2424 (defun notmuch-show-generate-part-buffer (msg part)
2425 "Return a temporary buffer containing the specified part's content."
2426 (let ((buf (generate-new-buffer " *notmuch-part*"))
2427 (process-crypto notmuch-show-process-crypto))
2428 (with-current-buffer buf
2429 ;; This is always used in the content of mm handles, which
2430 ;; expect undecoded, binary part content.
2431 (insert (notmuch-get-bodypart-binary msg part process-crypto)))
2434 (defun notmuch-show-current-part-handle (&optional mime-type)
2435 "Return an mm-handle for the part containing point.
2437 This creates a temporary buffer for the part's content; the
2438 caller is responsible for killing this buffer as appropriate. If
2439 MIME-TYPE is given then set the handle's mime-type to MIME-TYPE."
2440 (let* ((msg (notmuch-show-get-message-properties))
2441 (part (notmuch-show-get-part-properties))
2442 (buf (notmuch-show-generate-part-buffer msg part))
2443 (computed-type (or mime-type (plist-get part :computed-type)))
2444 (filename (plist-get part :filename))
2445 (disposition (and filename `(attachment (filename . ,filename)))))
2446 (mm-make-handle buf (list computed-type) nil nil disposition)))
2448 (defun notmuch-show-apply-to-current-part-handle (fn &optional mime-type)
2449 "Apply FN to an mm-handle for the part containing point.
2451 This ensures that the temporary buffer created for the mm-handle
2452 is destroyed when FN returns. If MIME-TYPE is given then force
2453 part to be treated as if it had that mime-type."
2454 (let ((handle (notmuch-show-current-part-handle mime-type)))
2455 ;; Emacs puts stdout/stderr into the calling buffer so we call
2456 ;; it from a temp-buffer, unless notmuch-show-attachment-debug
2457 ;; is non-nil, in which case we put it in " *notmuch-part*".
2459 (if notmuch-show-attachment-debug
2460 (with-current-buffer (generate-new-buffer " *notmuch-part*")
2461 (funcall fn handle))
2463 (funcall fn handle)))
2464 (kill-buffer (mm-handle-buffer handle)))))
2466 (defun notmuch-show-part-button-default (&optional button)
2468 (let ((button (or button (button-at (point)))))
2469 ;; Try to toggle the part, if that fails then call the default
2470 ;; action. The toggle fails if the part has no emacs renderable
2472 (unless (notmuch-show-toggle-part-invisibility button)
2473 (call-interactively notmuch-show-part-button-default-action))))
2475 (defun notmuch-show-save-part ()
2476 "Save the MIME part containing point to a file."
2478 (notmuch-show-apply-to-current-part-handle #'mm-save-part))
2480 (defun notmuch-show-view-part ()
2481 "View the MIME part containing point in an external viewer."
2483 ;; Set mm-inlined-types to nil to force an external viewer
2484 (let ((mm-inlined-types nil))
2485 (notmuch-show-apply-to-current-part-handle #'mm-display-part)))
2487 (defun notmuch-show-interactively-view-part ()
2488 "View the MIME part containing point, prompting for a viewer."
2490 (notmuch-show-apply-to-current-part-handle #'mm-interactively-view-part))
2492 (defun notmuch-show-pipe-part ()
2493 "Pipe the MIME part containing point to an external command."
2495 (notmuch-show-apply-to-current-part-handle #'mm-pipe-part))
2497 (defun notmuch-show--mm-display-part (handle)
2498 "Use mm-display-part to display HANDLE in a new buffer.
2500 If the part is displayed in an external application then close
2502 (let ((buf (get-buffer-create (generate-new-buffer-name
2503 (concat " *notmuch-internal-part*")))))
2504 (pop-to-buffer-same-window buf)
2505 (if (eq (mm-display-part handle) 'external)
2507 (goto-char (point-min))
2508 (set-buffer-modified-p nil)
2509 (view-buffer buf 'kill-buffer-if-not-modified))))
2511 (defun notmuch-show-choose-mime-of-part (mime-type)
2512 "Choose the mime type to use for displaying part."
2514 (list (completing-read "Mime type to use (default text/plain): "
2515 (mailcap-mime-types) nil nil nil nil "text/plain")))
2516 (notmuch-show-apply-to-current-part-handle #'notmuch-show--mm-display-part
2519 (defun notmuch-show-imenu-prev-index-position-function ()
2520 "Move point to previous message in notmuch-show buffer.
2521 This function is used as a value for
2522 `imenu-prev-index-position-function'."
2525 (notmuch-show-previous-message)
2528 (defun notmuch-show-imenu-extract-index-name-function ()
2529 "Return imenu name for line at point.
2530 This function is used as a value for
2531 `imenu-extract-index-name-function'. Point should be at the
2532 beginning of the line."
2533 (back-to-indentation)
2534 (buffer-substring-no-properties (if notmuch-show-imenu-indent
2535 (line-beginning-position)
2537 (line-end-position)))
2539 (defmacro notmuch-show--with-currently-shown-message (&rest body)
2540 "Evaluate BODY with display restricted to the currently shown
2544 (let ((extent (notmuch-show-message-extent)))
2545 (narrow-to-region (car extent) (cdr extent))
2548 (defun notmuch-show--gather-urls ()
2549 "Gather any URLs in the current message."
2550 (notmuch-show--with-currently-shown-message
2552 (goto-char (point-min))
2553 (while (re-search-forward goto-address-url-regexp (point-max) t)
2554 (push (match-string-no-properties 0) urls))
2557 (defun notmuch-show-browse-urls (&optional kill)
2558 "Offer to browse any URLs in the current message.
2559 With a prefix argument, copy the URL to the kill ring rather than
2562 (let ((urls (notmuch-show--gather-urls))
2563 (prompt (if kill "Copy URL to kill ring: " "Browse URL: "))
2564 (fn (if kill #'kill-new #'browse-url)))
2566 (funcall fn (completing-read prompt urls nil nil nil nil (car urls)))
2567 (message "No URLs found."))))
2571 (provide 'notmuch-show)
2573 ;;; notmuch-show.el ends here