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-wash)
36 (require 'notmuch-mua)
37 (require 'notmuch-crypto)
38 (require 'notmuch-print)
39 (require 'notmuch-draft)
41 (declare-function notmuch-call-notmuch-process "notmuch-lib" (&rest args))
42 (declare-function notmuch-search-next-thread "notmuch" nil)
43 (declare-function notmuch-search-previous-thread "notmuch" nil)
44 (declare-function notmuch-search-show-thread "notmuch")
45 (declare-function notmuch-foreach-mime-part "notmuch" (function mm-handle))
46 (declare-function notmuch-count-attachments "notmuch" (mm-handle))
47 (declare-function notmuch-save-attachments "notmuch" (mm-handle &optional queryp))
48 (declare-function notmuch-tree "notmuch-tree"
49 (&optional query query-context target buffer-name
50 open-target unthreaded parent-buffer))
51 (declare-function notmuch-tree-get-message-properties "notmuch-tree" nil)
52 (declare-function notmuch-unthreaded "notmuch-tree"
53 (&optional query query-context target buffer-name
55 (declare-function notmuch-read-query "notmuch" (prompt))
56 (declare-function notmuch-draft-resume "notmuch-draft" (id))
58 (defvar shr-blocked-images)
59 (defvar gnus-blocked-images)
60 (defvar shr-content-function)
61 (defvar w3m-ignored-image-url-regexp)
65 (defcustom notmuch-message-headers '("Subject" "To" "Cc" "Date")
66 "Headers that should be shown in a message, in this order.
68 For an open message, all of these headers will be made visible
69 according to `notmuch-message-headers-visible' or can be toggled
70 with `notmuch-show-toggle-visibility-headers'. For a closed message,
71 only the first header in the list will be visible."
72 :type '(repeat string)
75 (defcustom notmuch-message-headers-visible t
76 "Should the headers be visible by default?
78 If this value is non-nil, then all of the headers defined in
79 `notmuch-message-headers' will be visible by default in the display
80 of each message. Otherwise, these headers will be hidden and
81 `notmuch-show-toggle-visibility-headers' can be used to make them
82 visible for any given message."
86 (defcustom notmuch-show-header-line t
87 "Show a header line in notmuch show buffers.
89 If t (the default), the header line will contain the current
92 If a string, this value is interpreted as a format string to be
93 passed to `format-spec` with `%s` as the substitution variable
94 for the message's subject. E.g., to display the subject trimmed
95 to a maximum of 80 columns, you could use \"%>-80s\" as format.
97 If you assign to this variable a function, it will be called with
98 the subject as argument, and the return value will be used as the
99 header line format. Since the function is called with the
100 message buffer as the current buffer, it is also possible to
101 access any other properties of the message, using for instance
102 notmuch-show functions such as
103 `notmuch-show-get-message-properties'.
105 Finally, if this variable is set to nil, no header is
107 :type '(choice (const :tag "No header" ni)
108 (const :tag "Subject" t)
109 (string :tag "Format")
110 (function :tag "Function"))
111 :group 'notmuch-show)
113 (defcustom notmuch-show-depth-limit nil
114 "Depth beyond which message bodies are displayed lazily.
116 If bound to an integer, any message with tree depth greater than
117 this will have its body display lazily, initially
118 inserting only a button.
120 If this variable is set to nil (the default) no such lazy
122 :type '(choice (const :tag "No limit" nil)
123 (number :tag "Limit" 10))
124 :group 'notmuch-show)
126 (defcustom notmuch-show-height-limit nil
127 "Height (from leaves) beyond which message bodies are displayed lazily.
129 If bound to an integer, any message with height in the message
130 tree greater than this will have its body displayed lazily,
131 initially only a button.
133 If this variable is set to nil (the default) no such lazy
135 :type '(choice (const :tag "No limit" nil)
136 (number :tag "Limit" 10))
137 :group 'notmuch-show)
139 (defcustom notmuch-show-relative-dates t
140 "Display relative dates in the message summary line."
142 :group 'notmuch-show)
144 (defvar notmuch-show-markup-headers-hook '(notmuch-show-colour-headers)
145 "A list of functions called to decorate the headers listed in
146 `notmuch-message-headers'.")
148 (defcustom notmuch-show-hook '(notmuch-show-turn-on-visual-line-mode)
149 "Functions called after populating a `notmuch-show' buffer."
151 :options '(notmuch-show-turn-on-visual-line-mode)
153 :group 'notmuch-hooks)
155 (defcustom notmuch-show-insert-text/plain-hook
156 '(notmuch-wash-wrap-long-lines
157 notmuch-wash-tidy-citations
158 notmuch-wash-elide-blank-lines
159 notmuch-wash-excerpt-citations)
160 "Functions used to improve the display of text/plain parts."
162 :options '(notmuch-wash-convert-inline-patch-to-part
163 notmuch-wash-wrap-long-lines
164 notmuch-wash-tidy-citations
165 notmuch-wash-elide-blank-lines
166 notmuch-wash-excerpt-citations)
168 :group 'notmuch-hooks)
170 (defcustom notmuch-show-max-text-part-size 100000
171 "Maximum size of a text part to be shown by default in characters.
173 Set to 0 to show the part regardless of size."
175 :group 'notmuch-show)
177 ;; Mostly useful for debugging.
178 (defcustom notmuch-show-all-multipart/alternative-parts nil
179 "Should all parts of multipart/alternative parts be shown?"
181 :group 'notmuch-show)
183 (defcustom notmuch-show-indent-messages-width 1
184 "Width of message indentation in threads.
186 Messages are shown indented according to their depth in a thread.
187 This variable determines the width of this indentation measured
188 in number of blanks. Defaults to `1', choose `0' to disable
191 :group 'notmuch-show)
193 (defcustom notmuch-show-indent-multipart nil
194 "Should the sub-parts of a multipart/* part be indented?"
195 ;; dme: Not sure which is a good default.
197 :group 'notmuch-show)
199 (defcustom notmuch-show-part-button-default-action 'notmuch-show-save-part
200 "Default part header button action (on ENTER or mouse click)."
202 :type '(choice (const :tag "Save part"
203 notmuch-show-save-part)
204 (const :tag "View part"
205 notmuch-show-view-part)
206 (const :tag "View interactively"
207 notmuch-show-interactively-view-part)))
209 (defcustom notmuch-show-only-matching-messages nil
210 "Only matching messages are shown by default."
212 :group 'notmuch-show)
214 ;; By default, block all external images to prevent privacy leaks and
215 ;; potential attacks.
216 (defcustom notmuch-show-text/html-blocked-images "."
217 "Remote images that have URLs matching this regexp will be blocked."
218 :type '(choice (const nil) regexp)
219 :group 'notmuch-show)
223 (defvar-local notmuch-show-thread-id nil)
225 (defvar-local notmuch-show-parent-buffer nil)
227 (defvar-local notmuch-show-query-context nil)
229 (defvar-local notmuch-show-process-crypto nil)
231 (defvar-local notmuch-show-elide-non-matching-messages nil)
233 (defvar-local notmuch-show-indent-content t)
235 (defvar-local notmuch-show-single-message nil)
237 (defvar notmuch-show-attachment-debug nil
238 "If t log stdout and stderr from attachment handlers.
240 When set to nil (the default) stdout and stderr from attachment
241 handlers is discarded. When set to t the stdout and stderr from
242 each attachment handler is logged in buffers with names beginning
243 \" *notmuch-part*\".")
247 (defcustom notmuch-show-stash-mlarchive-link-alist
248 '(("MARC" . "https://marc.info/?i=")
249 ("Mail Archive, The" . "https://mid.mail-archive.com/")
250 ("Lore" . "https://lore.kernel.org/r/")
251 ("Notmuch" . "https://nmbug.notmuchmail.org/nmweb/show/")
252 ;; FIXME: can these services be searched by `Message-Id' ?
253 ;; ("MarkMail" . "http://markmail.org/")
254 ;; ("Nabble" . "http://nabble.com/")
255 ;; ("opensubscriber" . "http://opensubscriber.com/")
257 "List of Mailing List Archives to use when stashing links.
259 This list is used for generating a Mailing List Archive reference
260 URI with the current message's Message-Id in
261 `notmuch-show-stash-mlarchive-link'.
263 If the cdr of the alist element is not a function, the cdr is
264 expected to contain a URI that is concatenated with the current
265 message's Message-Id to create a ML archive reference URI.
267 If the cdr is a function, the function is called with the
268 Message-Id as the argument, and the function is expected to
269 return the ML archive reference URI."
270 :type '(alist :key-type (string :tag "Name")
273 (function :tag "Function returning the URL")))
274 :group 'notmuch-show)
276 (defcustom notmuch-show-stash-mlarchive-link-default "MARC"
277 "Default Mailing List Archive to use when stashing links.
279 This is used when `notmuch-show-stash-mlarchive-link' isn't
280 provided with an MLA argument nor `completing-read' input."
284 (list 'const :tag (car mla) :value (car mla)))
285 notmuch-show-stash-mlarchive-link-alist))
286 :group 'notmuch-show)
288 (defcustom notmuch-show-mark-read-tags '("-unread")
289 "List of tag changes to apply to a message when it is marked as read.
291 Tags starting with \"+\" (or not starting with either \"+\" or
292 \"-\") in the list will be added, and tags starting with \"-\"
293 will be removed from the message being marked as read.
295 For example, if you wanted to remove an \"unread\" tag and add a
296 \"read\" tag (which would make little sense), you would set:
297 (\"-unread\" \"+read\")"
298 :type '(repeat string)
299 :group 'notmuch-show)
301 (defcustom notmuch-show-mark-read-function #'notmuch-show-seen-current-message
302 "Function to control which messages are marked read.
304 The function should take two arguments START and END which will
305 be the start and end of the visible portion of the buffer and
306 should mark the appropriate messages read by applying
307 `notmuch-show-mark-read'. This function will be called after
308 every user interaction with notmuch."
310 :group 'notmuch-show)
312 (defcustom notmuch-show-imenu-indent nil
313 "Should Imenu display messages indented.
315 By default, Imenu (see Info node `(emacs) Imenu') in a
316 notmuch-show buffer displays all messages straight. This is
317 because the default Emacs frontend for Imenu makes it difficult
318 to select an Imenu entry with spaces in front. Other imenu
319 frontends such as counsel-imenu does not have this limitation.
320 In these cases, Imenu entries can be indented to reflect the
321 position of the message in the thread."
323 :group 'notmuch-show)
327 (defmacro with-current-notmuch-show-message (&rest body)
328 "Evaluate body with current buffer set to the text of current message."
330 (let ((id (notmuch-show-get-message-id)))
331 (let ((buf (generate-new-buffer (concat "*notmuch-msg-" id "*"))))
332 (with-current-buffer buf
333 (let ((coding-system-for-read 'no-conversion))
334 (notmuch--call-process notmuch-command nil t nil "show" "--format=raw" id))
336 (kill-buffer buf)))))
338 (defun notmuch-show-turn-on-visual-line-mode ()
339 "Enable Visual Line mode."
340 (visual-line-mode t))
344 ;; DEPRECATED in Notmuch 0.16 since we now have convenient part
345 ;; commands. We'll keep the command around for a version or two in
346 ;; case people want to bind it themselves.
347 (defun notmuch-show-view-all-mime-parts ()
348 "Use external viewers to view all attachments from the current message."
350 (with-current-notmuch-show-message
351 ;; We override the mm-inline-media-tests to indicate which message
352 ;; parts are already sufficiently handled by the original
353 ;; presentation of the message in notmuch-show mode. These parts
354 ;; will be inserted directly into the temporary buffer of
355 ;; with-current-notmuch-show-message and silently discarded.
357 ;; Any MIME part not explicitly mentioned here will be handled by an
358 ;; external viewer as configured in the various mailcap files.
359 (let ((mm-inline-media-tests
360 '(("text/.*" ignore identity)
361 ("application/pgp-signature" ignore identity)
362 ("multipart/alternative" ignore identity)
363 ("multipart/mixed" ignore identity)
364 ("multipart/related" ignore identity))))
365 (mm-display-parts (mm-dissect-buffer)))))
367 (defun notmuch-show-save-attachments ()
368 "Save all attachments from the current message."
370 (with-current-notmuch-show-message
371 (let ((mm-handle (mm-dissect-buffer)))
372 (notmuch-save-attachments
373 mm-handle (> (notmuch-count-attachments mm-handle) 1))))
376 (defun notmuch-show-with-message-as-text (fn)
377 "Apply FN to a text representation of the current message.
379 FN is called with one argument, the message properties. It should
380 operation on the contents of the current buffer."
381 ;; Remake the header to ensure that all information is available.
382 (let* ((to (notmuch-show-get-to))
383 (cc (notmuch-show-get-cc))
384 (from (notmuch-show-get-from))
385 (subject (notmuch-show-get-subject))
386 (date (notmuch-show-get-date))
387 (tags (notmuch-show-get-tags))
388 (depth (notmuch-show-get-depth))
390 "Subject: " subject "\n"
392 (if (not (string-empty-p cc))
393 (concat "Cc: " cc "\n")
399 (mapconcat #'identity tags ", ") "\n")
401 (all (buffer-substring (notmuch-show-message-top)
402 (notmuch-show-message-bottom)))
404 (props (notmuch-show-get-message-properties))
405 (indenting notmuch-show-indent-content))
409 (indent-rigidly (point-min)
411 (- (* notmuch-show-indent-messages-width depth))))
412 ;; Remove the original header.
413 (goto-char (point-min))
414 (re-search-forward "^$" (point-max) nil)
415 (delete-region (point-min) (point))
417 (funcall fn props))))
419 (defun notmuch-show-print-message ()
420 "Print the current message."
422 (notmuch-show-with-message-as-text 'notmuch-print-message))
426 (defun notmuch-show-fontify-header ()
428 ((looking-at "[Tt]o:")
430 ((looking-at "[Bb]?[Cc][Cc]:")
432 ((looking-at "[Ss]ubject:")
433 'message-header-subject)
435 'message-header-other))))
436 (overlay-put (make-overlay (point) (re-search-forward ":"))
437 'face 'message-header-name)
438 (overlay-put (make-overlay (point) (re-search-forward ".*$"))
441 (defun notmuch-show-colour-headers ()
442 "Apply some colouring to the current headers."
443 (goto-char (point-min))
444 (while (looking-at "^[A-Za-z][-A-Za-z0-9]*:")
445 (notmuch-show-fontify-header)
448 (defun notmuch-show-spaces-n (n)
449 "Return a string comprised of `n' spaces."
452 (defun notmuch-show-update-tags (tags)
453 "Update the displayed tags of the current message."
455 (goto-char (notmuch-show-message-top))
456 (when (re-search-forward "(\\([^()]*\\))$" (line-end-position) t)
457 (let ((inhibit-read-only t))
458 (replace-match (concat "("
459 (notmuch-tag-format-tags
461 (notmuch-show-get-prop :orig-tags))
464 (defun notmuch-clean-address (address)
465 "Try to clean a single email ADDRESS for display. Return a cons
466 cell of (AUTHOR_EMAIL AUTHOR_NAME). Return (ADDRESS nil) if
469 (let (p-name p-address)
470 ;; It would be convenient to use `mail-header-parse-address',
471 ;; but that expects un-decoded mailbox parts, whereas our
472 ;; mailbox parts are already decoded (and hence may contain
473 ;; UTF-8). Given that notmuch should handle most of the awkward
474 ;; cases, some simple string deconstruction should be sufficient
477 ;; "User <user@dom.ain>" style.
478 ((string-match "\\(.*\\) <\\(.*\\)>" address)
479 (setq p-name (match-string 1 address))
480 (setq p-address (match-string 2 address)))
482 ;; "<user@dom.ain>" style.
483 ((string-match "<\\(.*\\)>" address)
484 (setq p-address (match-string 1 address)))
487 (setq p-address address)))
489 ;; Remove elements of the mailbox part that are not relevant for
490 ;; display, even if they are required during transport:
493 (setq p-name (replace-regexp-in-string "\\\\" "" p-name))
494 ;; Outer single and double quotes, which might be nested.
495 (cl-loop with start-of-loop
496 do (setq start-of-loop p-name)
497 when (string-match "^\"\\(.*\\)\"$" p-name)
498 do (setq p-name (match-string 1 p-name))
499 when (string-match "^'\\(.*\\)'$" p-name)
500 do (setq p-name (match-string 1 p-name))
501 until (string= start-of-loop p-name)))
502 ;; If the address is 'foo@bar.com <foo@bar.com>' then show just
504 (when (string= p-name p-address)
506 (cons p-address p-name))
507 (error (cons address nil))))
509 (defun notmuch-show-clean-address (address)
510 "Try to clean a single email ADDRESS for display.
511 Return unchanged ADDRESS if parsing fails."
512 (let* ((clean-address (notmuch-clean-address address))
513 (p-address (car clean-address))
514 (p-name (cdr clean-address)))
515 ;; If no name, return just the address.
518 ;; Otherwise format the name and address together.
519 (concat p-name " <" p-address ">"))))
521 (defun notmuch-show--mark-height (tree)
522 "Calculate and cache height (distance from deepest descendent)"
523 (let* ((msg (car tree))
524 (children (cadr tree))
525 (cached-height (plist-get msg :height)))
528 (if (null children) 0
529 (1+ (apply #'max (mapcar #'notmuch-show--mark-height children))))))
530 (plist-put msg :height height)
533 (defun notmuch-show-insert-headerline (headers date tags depth duplicate file-count)
534 "Insert a notmuch style headerline based on HEADERS for a
535 message at DEPTH in the current thread."
536 (let ((start (point))
537 (from (notmuch-sanitize
538 (notmuch-show-clean-address (plist-get headers :From)))))
539 (when (string-match "\\cR" from)
540 ;; If the From header has a right-to-left character add
541 ;; invisible U+200E LEFT-TO-RIGHT MARK character which forces
542 ;; the header paragraph as left-to-right text.
543 (insert (propertize (string ?\x200e) 'invisible t)))
544 (insert (if notmuch-show-indent-content
545 (notmuch-show-spaces-n (* notmuch-show-indent-messages-width
552 (notmuch-tag-format-tags tags tags)
556 (let ((txt (format "%d/%d\n" duplicate file-count)))
558 (notmuch-show-spaces-n (max 0 (- (window-width) (+ (current-column) (length txt)))))
561 (overlay-put (make-overlay start (point))
562 'face 'notmuch-message-summary-face)))
564 (defun notmuch-show-insert-header (header header-value)
565 "Insert a single header."
566 (insert header ": " (notmuch-sanitize header-value) "\n"))
568 (defun notmuch-show-insert-headers (headers)
569 "Insert the headers of the current message."
570 (let ((start (point)))
571 (mapc (lambda (header)
572 (let* ((header-symbol (intern (concat ":" header)))
573 (header-value (plist-get headers header-symbol)))
574 (when (and header-value
575 (not (string-equal "" header-value)))
576 (notmuch-show-insert-header header header-value))))
577 notmuch-message-headers)
580 (narrow-to-region start (point-max))
581 (run-hooks 'notmuch-show-markup-headers-hook)))))
585 (define-button-type 'notmuch-show-part-button-type
586 'action 'notmuch-show-part-button-default
589 :supertype 'notmuch-button-type)
591 (defun notmuch-show-insert-part-header (_nth content-type declared-type
592 &optional name comment)
593 (let ((base-label (concat (and name (concat name ": "))
595 (and (not (string-equal declared-type content-type))
596 (concat " (as " content-type ")"))
598 (prog1 (insert-button
599 (concat "[ " base-label " ]")
600 :base-label base-label
601 :type 'notmuch-show-part-button-type
602 :notmuch-part-hidden nil)
605 (defun notmuch-show-toggle-part-invisibility (&optional button)
607 (let ((button (or button (button-at (point)))))
609 (let ((overlay (button-get button 'overlay))
610 (lazy-part (button-get button :notmuch-lazy-part)))
611 ;; We have a part to toggle if there is an overlay or if there
612 ;; is a lazy part. If neither is present we cannot toggle the
613 ;; part so we just return nil.
614 (when (or overlay lazy-part)
615 (let* ((show (button-get button :notmuch-part-hidden))
616 (new-start (button-start button))
617 (button-label (button-get button :base-label))
619 (properties (text-properties-at (button-start button)))
620 (inhibit-read-only t))
621 ;; Toggle the button itself.
622 (button-put button :notmuch-part-hidden (not show))
623 (goto-char new-start)
624 (insert "[ " button-label (if show " ]" " (hidden) ]"))
625 (set-text-properties new-start (point) properties)
626 (let ((old-end (button-end button)))
627 (move-overlay button new-start (point))
628 (delete-region (point) old-end))
629 (goto-char (min old-point (1- (button-end button))))
630 ;; Return nil if there is a lazy-part, it is empty, and we are
631 ;; trying to show it. In all other cases return t.
634 (button-put button :notmuch-lazy-part nil)
635 (notmuch-show-lazy-part lazy-part button))
636 ;; else there must be an overlay.
637 (overlay-put overlay 'invisible (not show))
640 ;;; Part content ID handling
642 (defvar notmuch-show--cids nil
643 "Alist from raw content ID to (MSG PART).")
644 (make-variable-buffer-local 'notmuch-show--cids)
646 (defun notmuch-show--register-cids (msg part)
647 "Register content-IDs in PART and all of PART's sub-parts."
648 (let ((content-id (plist-get part :content-id)))
650 ;; Note that content-IDs are globally unique, except when they
651 ;; aren't: RFC 2046 section 5.1.4 permits children of a
652 ;; multipart/alternative to have the same content-ID, in which
653 ;; case the MUA is supposed to pick the best one it can render.
654 ;; We simply add the content-ID to the beginning of our alist;
655 ;; so if this happens, we'll take the last (and "best")
656 ;; alternative (even if we can't render it).
657 (push (list content-id msg part) notmuch-show--cids)))
658 ;; Recurse on sub-parts
659 (when-let ((type (plist-get part :content-type)))
660 (pcase-let ((`(,type ,subtype)
661 (split-string (downcase type) "/")))
662 (cond ((equal type "multipart")
663 (mapc (apply-partially #'notmuch-show--register-cids msg)
664 (plist-get part :content)))
665 ((and (equal type "message")
666 (equal subtype "rfc822"))
667 (notmuch-show--register-cids
669 (car (plist-get (car (plist-get part :content)) :body))))))))
671 (defun notmuch-show--get-cid-content (cid)
672 "Return a list (CID-content content-type) or nil.
674 This will only find parts from messages that have been inserted
675 into the current buffer. CID must be a raw content ID, without
676 enclosing angle brackets, a cid: prefix, or URL encoding. This
677 will return nil if the CID is unknown or cannot be retrieved."
678 (when-let ((descriptor (cdr (assoc cid notmuch-show--cids))))
679 (pcase-let ((`(,msg ,part) descriptor))
680 ;; Request caching for this content, as some messages
681 ;; reference the same cid: part many times (hundreds!).
682 (list (notmuch-get-bodypart-binary
683 msg part notmuch-show-process-crypto 'cache)
684 (plist-get part :content-type)))))
686 (defun notmuch-show-setup-w3m ()
687 "Instruct w3m how to retrieve content from a \"related\" part of a message."
689 (when (and (boundp 'w3m-cid-retrieve-function-alist)
690 (not (assq 'notmuch-show-mode w3m-cid-retrieve-function-alist)))
691 (push (cons 'notmuch-show-mode #'notmuch-show--cid-w3m-retrieve)
692 w3m-cid-retrieve-function-alist))
693 (setq mm-html-inhibit-images nil))
695 (defvar w3m-current-buffer) ;; From `w3m.el'.
696 (defun notmuch-show--cid-w3m-retrieve (url &rest _args)
697 ;; url includes the cid: prefix and is URL encoded (see RFC 2392).
698 (let* ((cid (url-unhex-string (substring url 4)))
700 (with-current-buffer w3m-current-buffer
701 (notmuch-show--get-cid-content cid))))
702 (when content-and-type
703 (insert (car content-and-type))
704 (cadr content-and-type))))
706 ;; MIME part renderers
708 (defun notmuch-show-multipart/*-to-list (part)
709 (mapcar (lambda (inner-part) (plist-get inner-part :content-type))
710 (plist-get part :content)))
712 (defun notmuch-show-insert-part-multipart/alternative (msg part _content-type _nth depth _button)
713 (let ((chosen-type (car (notmuch-multipart/alternative-choose
714 msg (notmuch-show-multipart/*-to-list part))))
715 (inner-parts (plist-get part :content))
717 ;; This inserts all parts of the chosen type rather than just one,
718 ;; but it's not clear that this is the wrong thing to do - which
719 ;; should be chosen if there are more than one that match?
720 (mapc (lambda (inner-part)
721 (let* ((inner-type (plist-get inner-part :content-type))
722 (hide (not (or notmuch-show-all-multipart/alternative-parts
723 (string= chosen-type inner-type)))))
724 (notmuch-show-insert-bodypart msg inner-part depth hide)))
727 (when notmuch-show-indent-multipart
728 (indent-rigidly start (point) 1)))
731 (defun notmuch-show-insert-part-multipart/related (msg part _content-type _nth depth _button)
732 (let ((inner-parts (plist-get part :content))
734 ;; Render the primary part. FIXME: Support RFC 2387 Start header.
735 (notmuch-show-insert-bodypart msg (car inner-parts) depth)
736 ;; Add hidden buttons for the rest
737 (mapc (lambda (inner-part)
738 (notmuch-show-insert-bodypart msg inner-part depth t))
740 (when notmuch-show-indent-multipart
741 (indent-rigidly start (point) 1)))
744 (defun notmuch-show-insert-part-multipart/signed (msg part _content-type _nth depth button)
746 (button-put button 'face 'notmuch-crypto-part-header))
747 ;; Insert a button detailing the signature status.
748 (notmuch-crypto-insert-sigstatus-button (car (plist-get part :sigstatus))
749 (notmuch-show-get-header :From msg))
750 (let ((inner-parts (plist-get part :content))
752 ;; Show all of the parts.
753 (mapc (lambda (inner-part)
754 (notmuch-show-insert-bodypart msg inner-part depth))
756 (when notmuch-show-indent-multipart
757 (indent-rigidly start (point) 1)))
760 (defun notmuch-show-insert-part-multipart/encrypted (msg part _content-type _nth depth button)
762 (button-put button 'face 'notmuch-crypto-part-header))
763 ;; Insert a button detailing the encryption status.
764 (notmuch-crypto-insert-encstatus-button (car (plist-get part :encstatus)))
765 ;; Insert a button detailing the signature status.
766 (notmuch-crypto-insert-sigstatus-button (car (plist-get part :sigstatus))
767 (notmuch-show-get-header :From msg))
768 (let ((inner-parts (plist-get part :content))
770 ;; Show all of the parts.
771 (mapc (lambda (inner-part)
772 (notmuch-show-insert-bodypart msg inner-part depth))
774 (when notmuch-show-indent-multipart
775 (indent-rigidly start (point) 1)))
778 (defun notmuch-show-insert-part-application/pgp-encrypted (_msg _part _content-type _nth _depth _button)
781 (defun notmuch-show-insert-part-multipart/* (msg part _content-type _nth depth _button)
782 (let ((inner-parts (plist-get part :content))
784 ;; Show all of the parts.
785 (mapc (lambda (inner-part)
786 (notmuch-show-insert-bodypart msg inner-part depth))
788 (when notmuch-show-indent-multipart
789 (indent-rigidly start (point) 1)))
792 (defun notmuch-show-insert-part-message/rfc822 (msg part _content-type _nth depth _button)
793 (let ((message (car (plist-get part :content))))
796 (let ((body (car (plist-get message :body)))
798 ;; Override `notmuch-message-headers' to force `From' to be
800 (let ((notmuch-message-headers '("From" "Subject" "To" "Cc" "Date")))
801 (notmuch-show-insert-headers (plist-get message :headers)))
802 ;; Blank line after headers to be compatible with the normal
806 (notmuch-show-insert-bodypart msg body depth)
807 (when notmuch-show-indent-multipart
808 (indent-rigidly start (point) 1))
811 (defun notmuch-show-insert-part-text/plain (msg part _content-type _nth depth button)
812 ;; For backward compatibility we want to apply the text/plain hook
813 ;; to the whole of the part including the part button if there is
815 (let ((start (if button
816 (button-start button)
818 (insert (notmuch-get-bodypart-text msg part notmuch-show-process-crypto))
821 (narrow-to-region start (point-max))
822 (run-hook-with-args 'notmuch-show-insert-text/plain-hook msg depth))))
825 (defun notmuch-show-insert-part-text/calendar (msg part _content-type _nth _depth _button)
826 (insert (with-temp-buffer
827 (insert (notmuch-get-bodypart-text msg part notmuch-show-process-crypto))
828 ;; notmuch-get-bodypart-text does no newline conversion.
829 ;; Replace CRLF with LF before icalendar can use it.
830 (goto-char (point-min))
831 (while (re-search-forward "\r\n" nil t)
832 (replace-match "\n" nil nil))
833 (let ((file (make-temp-file "notmuch-ical"))
837 (unless (icalendar-import-buffer file t)
838 (error "Icalendar import error. %s"
839 "See *icalendar-errors* for more information"))
840 (set-buffer (get-file-buffer file))
841 (setq result (buffer-substring (point-min) (point-max)))
842 (set-buffer-modified-p nil)
843 (kill-buffer (current-buffer)))
848 ;; For backwards compatibility.
849 (defun notmuch-show-insert-part-text/x-vcalendar (msg part _content-type _nth depth _button)
850 (notmuch-show-insert-part-text/calendar msg part nil nil depth nil))
852 (when (version< emacs-version "25.3")
853 ;; https://bugs.gnu.org/28350
855 ;; For newer emacs, we fall back to notmuch-show-insert-part-*/*
856 ;; (see notmuch-show-handlers-for)
857 (defun notmuch-show-insert-part-text/enriched
858 (msg part content-type nth depth button)
859 ;; By requiring enriched below, we ensure that the function
860 ;; enriched-decode-display-prop is defined before it will be
861 ;; shadowed by the letf below. Otherwise the version in
862 ;; enriched.el may be loaded a bit later and used instead (for
865 (cl-letf (((symbol-function 'enriched-decode-display-prop)
866 (lambda (start end &optional _param) (list start end))))
867 (notmuch-show-insert-part-*/* msg part content-type nth depth button))))
869 (defun notmuch-show-get-mime-type-of-application/octet-stream (part)
870 ;; If we can deduce a MIME type from the filename of the attachment,
872 (and (plist-get part :filename)
873 (let ((extension (file-name-extension (plist-get part :filename))))
876 (mailcap-parse-mimetypes)
877 (let ((mime-type (mailcap-extension-to-mime extension)))
879 (not (string-equal mime-type "application/octet-stream"))
882 (defun notmuch-show-insert-part-text/html (msg part content-type nth depth button)
883 (if (eq mm-text-html-renderer 'shr)
884 ;; It's easier to drive shr ourselves than to work around the
885 ;; goofy things `mm-shr' does (like irreversibly taking over
886 ;; content ID handling).
887 ;; FIXME: If we block an image, offer a button to load external
889 (let ((shr-blocked-images notmuch-show-text/html-blocked-images))
890 (notmuch-show--insert-part-text/html-shr msg part))
891 ;; Otherwise, let message-mode do the heavy lifting
893 ;; w3m sets up a keymap which "leaks" outside the invisible region
894 ;; and causes strange effects in notmuch. We set
895 ;; mm-inline-text-html-with-w3m-keymap to nil to tell w3m not to
896 ;; set a keymap (so the normal notmuch-show-mode-map remains).
897 (let ((mm-inline-text-html-with-w3m-keymap nil)
898 ;; FIXME: If we block an image, offer a button to load external
900 (gnus-blocked-images notmuch-show-text/html-blocked-images)
901 (w3m-ignored-image-url-regexp notmuch-show-text/html-blocked-images))
902 (notmuch-show-insert-part-*/* msg part content-type nth depth button))))
904 ;;; Functions used by notmuch-show--insert-part-text/html-shr
906 (declare-function libxml-parse-html-region "xml.c")
907 (declare-function shr-insert-document "shr")
909 (defun notmuch-show--insert-part-text/html-shr (msg part)
910 ;; Make sure shr is loaded before we start let-binding its globals
912 (let ((dom (let ((process-crypto notmuch-show-process-crypto))
914 (insert (notmuch-get-bodypart-text msg part process-crypto))
915 (libxml-parse-html-region (point-min) (point-max)))))
916 (shr-content-function
918 ;; shr strips the "cid:" part of URL, but doesn't
919 ;; URL-decode it (see RFC 2392).
920 (let ((cid (url-unhex-string url)))
921 (car (notmuch-show--get-cid-content cid))))))
922 (shr-insert-document dom)
925 (defun notmuch-show-insert-part-*/* (msg part content-type _nth _depth _button)
926 ;; This handler _must_ succeed - it is the handler of last resort.
927 (notmuch-mm-display-part-inline msg part content-type notmuch-show-process-crypto)
930 ;;; Functions for determining how to handle MIME parts.
932 (defun notmuch-show-handlers-for (content-type)
933 "Return a list of content handlers for a part of type CONTENT-TYPE."
936 (when (functionp func)
938 ;; Reverse order of prefrence.
939 (list (intern (concat "notmuch-show-insert-part-*/*"))
940 (intern (concat "notmuch-show-insert-part-"
941 (car (split-string content-type "/"))
943 (intern (concat "notmuch-show-insert-part-" content-type))))
948 (defun notmuch-show-insert-bodypart-internal (msg part content-type nth depth button)
949 ;; Run the handlers until one of them succeeds.
950 (cl-loop for handler in (notmuch-show-handlers-for content-type)
951 until (condition-case err
952 (funcall handler msg part content-type nth depth button)
953 ;; Specifying `debug' here lets the debugger run if
954 ;; `debug-on-error' is non-nil.
956 (insert "!!! Bodypart handler `" (prin1-to-string handler)
957 "' threw an error:\n"
958 "!!! " (error-message-string err) "\n")
961 (defun notmuch-show-create-part-overlays (button beg end)
962 "Add an overlay to the part between BEG and END."
963 ;; If there is no button (i.e., the part is text/plain and the first
964 ;; part) or if the part has no content then we don't make the part
966 (when (and button (/= beg end))
967 (button-put button 'overlay (make-overlay beg end))
968 ;; Return true if we created an overlay.
971 (defun notmuch-show-record-part-information (part beg end)
972 "Store PART as a text property from BEG to END."
973 ;; Record part information. Since we already inserted subparts,
974 ;; don't override existing :notmuch-part properties.
975 (notmuch-map-text-property beg end :notmuch-part
976 (lambda (v) (or v part)))
977 ;; Make :notmuch-part front sticky and rear non-sticky so it stays
978 ;; applied to the beginning of each line when we indent the
979 ;; message. Since we're operating on arbitrary renderer output,
980 ;; watch out for sticky specs of t, which means all properties are
981 ;; front-sticky/rear-nonsticky.
982 (notmuch-map-text-property beg end 'front-sticky
985 (cl-pushnew :notmuch-part v)
987 (notmuch-map-text-property beg end 'rear-nonsticky
990 (cl-pushnew :notmuch-part v)
993 (defun notmuch-show-lazy-part (part-args button)
994 ;; Insert the lazy part after the button for the part. We would just
995 ;; move to the start of the new line following the button and insert
996 ;; the part but that point might have text properties (eg colours
997 ;; from a message header etc) so instead we start from the last
998 ;; character of the button by adding a newline and finish by
999 ;; removing the extra newline from the end of the part.
1001 (goto-char (button-end button))
1003 (let* ((inhibit-read-only t)
1004 ;; We need to use markers for the start and end of the part
1005 ;; because the part insertion functions do not guarantee
1006 ;; to leave point at the end of the part.
1007 (part-beg (copy-marker (point) nil))
1008 (part-end (copy-marker (point) t))
1009 ;; We have to save the depth as we can't find the depth
1011 (depth (notmuch-show-get-depth)))
1013 (narrow-to-region part-beg part-end)
1014 (delete-region part-beg part-end)
1015 (apply #'notmuch-show-insert-bodypart-internal part-args)
1016 (indent-rigidly part-beg
1018 (* notmuch-show-indent-messages-width depth)))
1019 (goto-char part-end)
1021 (notmuch-show-record-part-information (cadr part-args)
1022 (button-start button)
1024 ;; Create the overlay. If the lazy-part turned out to be empty/not
1025 ;; showable this returns nil.
1026 (notmuch-show-create-part-overlays button part-beg part-end))))
1028 (defun notmuch-show-mime-type (part)
1029 "Return the correct mime-type to use for PART."
1030 (when-let ((content-type (plist-get part :content-type)))
1031 (setq content-type (downcase content-type))
1032 (or (and (string= content-type "application/octet-stream")
1033 (notmuch-show-get-mime-type-of-application/octet-stream part))
1034 (and (string= content-type "inline patch")
1038 ;; The following variable can be overridden by let bindings.
1039 (defvar notmuch-show-insert-header-p-function 'notmuch-show-insert-header-p
1040 "Specify which function decides which part headers get inserted.
1042 The function should take two parameters, PART and HIDE, and
1043 should return non-NIL if a header button should be inserted for
1046 (defun notmuch-show-insert-header-p (part _hide)
1047 ;; Show all part buttons except for the first part if it is text/plain.
1048 (let ((mime-type (notmuch-show-mime-type part)))
1049 (not (and (string= mime-type "text/plain")
1050 (<= (plist-get part :id) 1)))))
1052 (defun notmuch-show-reply-insert-header-p-never (_part _hide)
1055 (defun notmuch-show-reply-insert-header-p-trimmed (part hide)
1056 (let ((mime-type (notmuch-show-mime-type part)))
1057 (and (not (notmuch-match-content-type mime-type "multipart/*"))
1060 (defun notmuch-show-reply-insert-header-p-minimal (part hide)
1061 (let ((mime-type (notmuch-show-mime-type part)))
1062 (and (notmuch-match-content-type mime-type "text/*")
1065 (defun notmuch-show-insert-bodypart (msg part depth &optional hide)
1066 "Insert the body part PART at depth DEPTH in the current thread.
1068 HIDE determines whether to show or hide the part and the button
1069 as follows: If HIDE is nil, show the part and the button. If HIDE
1070 is t, hide the part initially and show the button."
1071 (let* ((content-type (plist-get part :content-type))
1072 (mime-type (notmuch-show-mime-type part))
1073 (nth (plist-get part :id))
1074 (height (plist-get msg :height))
1075 (long (and (notmuch-match-content-type mime-type "text/*")
1076 (> notmuch-show-max-text-part-size 0)
1077 (> (length (plist-get part :content))
1078 notmuch-show-max-text-part-size)))
1079 (deep (and notmuch-show-depth-limit
1080 (> depth notmuch-show-depth-limit)))
1081 (high (and notmuch-show-height-limit
1082 (> height notmuch-show-height-limit)))
1084 ;; This default header-p function omits the part button for
1085 ;; the first (or only) part if this is text/plain.
1086 (button (and (or deep long high
1087 (funcall notmuch-show-insert-header-p-function part hide))
1088 (notmuch-show-insert-part-header
1090 (and content-type (downcase content-type))
1091 (plist-get part :filename))))
1092 ;; Hide the part initially if HIDE is t, or if it is too long/deep
1093 ;; and we have a button to allow toggling.
1094 (show-part (not (or (equal hide t)
1097 (and long button))))
1098 (content-beg (point)))
1099 ;; Store the computed mime-type for later use (e.g. by attachment handlers).
1100 (plist-put part :computed-type mime-type)
1102 (notmuch-show-insert-bodypart-internal msg part mime-type nth depth button)
1104 (button-put button :notmuch-lazy-part
1105 (list msg part mime-type nth depth button))))
1106 ;; Some of the body part handlers leave point somewhere up in the
1107 ;; part, so we make sure that we're down at the end.
1108 (goto-char (point-max))
1109 ;; Ensure that the part ends with a carriage return.
1112 ;; We do not create the overlay for hidden (lazy) parts until
1113 ;; they are inserted.
1115 (notmuch-show-create-part-overlays button content-beg (point))
1117 (notmuch-show-toggle-part-invisibility button)))
1118 (notmuch-show-record-part-information part beg (point))))
1120 (defun notmuch-show-insert-body (msg body depth)
1121 "Insert the body BODY at depth DEPTH in the current thread."
1122 ;; Register all content IDs for this message. According to RFC
1123 ;; 2392, content IDs are *global*, but it's okay if an MUA treats
1124 ;; them as only global within a message.
1125 (notmuch-show--register-cids msg (car body))
1126 (mapc (lambda (part) (notmuch-show-insert-bodypart msg part depth)) body))
1128 (defun notmuch-show-make-symbol (type)
1129 (make-symbol (concat "notmuch-show-" type)))
1131 (defun notmuch-show-strip-re (string)
1132 (replace-regexp-in-string "^\\([Rr]e: *\\)+" "" string))
1134 (defvar notmuch-show-previous-subject "")
1135 (make-variable-buffer-local 'notmuch-show-previous-subject)
1137 (defun notmuch-show-choose-duplicate (duplicate)
1138 "Display message file with index DUPLICATE in place of the current one.
1140 Message file indices are based on the order the files are
1141 discovered by `notmuch new' (and hence are somewhat arbitrary),
1142 and correspond to those passed to the \"\\-\\-duplicate\" arguments
1145 When called interactively, the function will prompt for the index
1146 of the file to display. An error will be signaled if the index
1148 (interactive "Nduplicate: ")
1149 (let ((count (length (notmuch-show-get-prop :filename))))
1150 (when (or (> duplicate count)
1152 (error "Duplicate %d out of range [1,%d]" duplicate count)))
1153 (notmuch-show-move-to-message-top)
1155 (let* ((extent (notmuch-show-message-extent))
1156 (id (notmuch-show-get-message-id))
1157 (depth (notmuch-show-get-depth))
1158 (inhibit-read-only t)
1159 (new-msg (notmuch--run-show (list id) duplicate)))
1160 ;; clean up existing overlays to avoid extending them.
1161 (dolist (o (overlays-in (car extent) (cdr extent)))
1163 ;; pretend insertion is happening at end of buffer
1164 (narrow-to-region (point-min) (car extent))
1165 ;; Insert first, then delete, to avoid marker for start of next
1166 ;; message being in same place as the start of this one.
1167 (notmuch-show-insert-msg new-msg depth)
1169 (delete-region (point) (cdr extent)))))
1171 (defun notmuch-show-insert-msg (msg depth)
1172 "Insert the message MSG at depth DEPTH in the current thread."
1173 (let* ((headers (plist-get msg :headers))
1174 (duplicate (or (plist-get msg :duplicate) 0))
1175 (files (length (plist-get msg :filename)))
1176 ;; Indentation causes the buffer offset of the start/end
1177 ;; points to move, so we must use markers.
1178 message-start message-end
1179 content-start content-end
1180 headers-start headers-end
1181 (bare-subject (notmuch-show-strip-re (plist-get headers :Subject))))
1182 (setq message-start (point-marker))
1183 (notmuch-show-insert-headerline headers
1184 (or (and notmuch-show-relative-dates
1185 (plist-get msg :date_relative))
1186 (plist-get headers :Date))
1187 (plist-get msg :tags) depth duplicate files)
1188 (setq content-start (point-marker))
1189 ;; Set `headers-start' to point after the 'Subject:' header to be
1190 ;; compatible with the existing implementation. This just sets it
1191 ;; to after the first header.
1192 (notmuch-show-insert-headers headers)
1194 (goto-char content-start)
1195 ;; If the subject of this message is the same as that of the
1196 ;; previous message, don't display it when this message is
1198 (unless (string= notmuch-show-previous-subject bare-subject)
1200 (setq headers-start (point-marker)))
1201 (setq headers-end (point-marker))
1202 (setq notmuch-show-previous-subject bare-subject)
1203 ;; A blank line between the headers and the body.
1205 (notmuch-show-insert-body msg (plist-get msg :body)
1206 (if notmuch-show-indent-content depth 0))
1207 ;; Ensure that the body ends with a newline.
1210 (setq content-end (point-marker))
1211 ;; Indent according to the depth in the thread.
1212 (when notmuch-show-indent-content
1213 (indent-rigidly content-start
1215 (* notmuch-show-indent-messages-width depth)))
1216 (setq message-end (point-max-marker))
1217 ;; Save the extents of this message over the whole text of the
1219 (put-text-property message-start message-end
1220 :notmuch-message-extent
1221 (cons message-start message-end))
1222 ;; Create overlays used to control visibility
1223 (plist-put msg :headers-overlay (make-overlay headers-start headers-end))
1224 (plist-put msg :message-overlay (make-overlay headers-start content-end))
1225 (plist-put msg :depth depth)
1226 ;; Save the properties for this message. Currently this saves the
1227 ;; entire message (augmented it with other stuff), which seems
1228 ;; like overkill. We might save a reduced subset (for example, not
1230 (notmuch-show-set-message-properties msg)
1231 ;; Set header visibility.
1232 (notmuch-show-headers-visible msg notmuch-message-headers-visible)
1233 ;; Message visibility depends on whether it matched the search
1235 (notmuch-show-message-visible msg (and (plist-get msg :match)
1236 (not (plist-get msg :excluded))))))
1240 (defun notmuch-show-toggle-process-crypto ()
1241 "Toggle the processing of cryptographic MIME parts."
1243 (setq notmuch-show-process-crypto (not notmuch-show-process-crypto))
1244 (message (if notmuch-show-process-crypto
1245 "Processing cryptographic MIME parts."
1246 "Not processing cryptographic MIME parts."))
1247 (notmuch-show-refresh-view))
1249 (defun notmuch-show-toggle-elide-non-matching ()
1250 "Toggle the display of non-matching messages."
1252 (setq notmuch-show-elide-non-matching-messages
1253 (not notmuch-show-elide-non-matching-messages))
1254 (message (if notmuch-show-elide-non-matching-messages
1255 "Showing matching messages only."
1256 "Showing all messages."))
1257 (notmuch-show-refresh-view))
1259 (defun notmuch-show-toggle-thread-indentation ()
1260 "Toggle the indentation of threads."
1262 (setq notmuch-show-indent-content (not notmuch-show-indent-content))
1263 (message (if notmuch-show-indent-content
1264 "Content is indented."
1265 "Content is not indented."))
1266 (notmuch-show-refresh-view))
1268 ;;; Main insert functions
1270 (defun notmuch-show-insert-tree (tree depth)
1271 "Insert the message tree TREE at depth DEPTH in the current thread."
1272 (let ((msg (car tree))
1273 (replies (cadr tree)))
1274 ;; We test whether there is a message or just some replies.
1276 (notmuch-show--mark-height tree)
1277 (notmuch-show-insert-msg msg depth))
1278 (notmuch-show-insert-thread replies (1+ depth))))
1280 (defun notmuch-show-insert-thread (thread depth)
1281 "Insert the thread THREAD at depth DEPTH in the current forest."
1282 (mapc (lambda (tree) (notmuch-show-insert-tree tree depth)) thread))
1284 (defun notmuch-show-insert-forest (forest)
1285 "Insert the forest of threads FOREST."
1286 (mapc (lambda (thread) (notmuch-show-insert-thread thread 0)) forest))
1290 (defvar notmuch-id-regexp
1292 ;; Match the id: prefix only if it begins a word (to disallow, for
1293 ;; example, matching cid:).
1295 ;; If the term starts with a ", then parse Xapian's quoted boolean
1296 ;; term syntax, which allows for anything as long as embedded
1297 ;; double quotes escaped by doubling them. We also disallow
1298 ;; newlines (which Xapian allows) to prevent runaway terms.
1299 "\"\\([^\"\n]\\|\"\"\\)*\""
1300 ;; Otherwise, parse Xapian's unquoted syntax, which goes up to the
1301 ;; next space or ). We disallow [.,;] as the last character
1302 ;; because these are probably part of the surrounding text, and not
1303 ;; part of the id. This doesn't match single character ids; meh.
1304 "\\|[^\"[:space:])][^[:space:])]*[^])[:space:].,:;?!]"
1306 "The regexp used to match id: links in messages.")
1308 (defvar notmuch-mid-regexp
1309 ;; goto-address-url-regexp matched cid: links, which have the same
1310 ;; grammar as the message ID part of a mid: link. Construct the
1311 ;; regexp using the same technique as goto-address-url-regexp.
1312 (concat "\\<mid:\\(" thing-at-point-url-path-regexp "\\)")
1313 "The regexp used to match mid: links in messages.
1317 (defun notmuch-show-buttonise-links (start end)
1318 "Buttonise URLs and mail addresses between START and END.
1320 This also turns id:\"<message id>\"-parts and mid: links into
1321 buttons for a corresponding notmuch search."
1322 (goto-address-fontify-region start end)
1325 (beg-line (progn (goto-char start) (line-beginning-position)))
1326 (end-line (progn (goto-char end) (line-end-position))))
1327 (goto-char beg-line)
1328 (while (re-search-forward notmuch-id-regexp end-line t)
1329 (push (list (match-beginning 0) (match-end 0)
1330 (match-string-no-properties 0)) links))
1331 (goto-char beg-line)
1332 (while (re-search-forward notmuch-mid-regexp end-line t)
1333 (let* ((mid-cid (match-string-no-properties 1))
1334 (mid (save-match-data
1335 (string-match "^[^/]*" mid-cid)
1336 (url-unhex-string (match-string 0 mid-cid)))))
1337 (push (list (match-beginning 0) (match-end 0)
1338 (notmuch-id-to-query mid)) links)))
1339 (pcase-dolist (`(,beg ,end ,link) links)
1340 ;; Remove the overlay created by goto-address-mode
1341 (remove-overlays beg end 'goto-address t)
1342 (make-text-button beg end
1343 :type 'notmuch-button-type
1344 'action `(lambda (arg)
1345 (notmuch-show ,link current-prefix-arg))
1347 'help-echo "Mouse-1, RET: search for this message"
1348 'face goto-address-mail-face)))))
1353 (defun notmuch-show (thread-id &optional elide-toggle parent-buffer query-context buffer-name)
1354 "Run \"notmuch show\" with the given thread ID and display results.
1356 ELIDE-TOGGLE, if non-nil, inverts the default elide behavior.
1358 The optional PARENT-BUFFER is the notmuch-search buffer from
1359 which this notmuch-show command was executed, (so that the
1360 next thread from that buffer can be show when done with this
1363 The optional QUERY-CONTEXT is a notmuch search term. Only
1364 messages from the thread matching this search term are shown if
1367 The optional BUFFER-NAME provides the name of the buffer in
1368 which the message thread is shown. If it is nil (which occurs
1369 when the command is called interactively) the argument to the
1372 Returns the buffer containing the messages, or NIL if no messages
1374 (interactive "sNotmuch show: \nP")
1375 (let ((buffer-name (generate-new-buffer-name
1377 (concat "*notmuch-" thread-id "*"))))
1378 (mm-inline-override-types (notmuch--inline-override-types)))
1380 (pop-to-buffer-same-window (get-buffer-create buffer-name))
1381 ;; No need to track undo information for this buffer.
1382 (setq buffer-undo-list t)
1384 ;; Set various buffer local variables to their appropriate initial
1385 ;; state. Do this after enabling `notmuch-show-mode' so that they
1386 ;; aren't wiped out.
1387 (setq notmuch-show-thread-id thread-id)
1388 (setq notmuch-show-parent-buffer parent-buffer)
1389 (setq notmuch-show-query-context
1390 (if (or (string= query-context "")
1391 (string= query-context "*"))
1394 (setq notmuch-show-process-crypto notmuch-crypto-process-mime)
1395 ;; If `elide-toggle', invert the default value.
1396 (setq notmuch-show-elide-non-matching-messages
1398 (not notmuch-show-only-matching-messages)
1399 notmuch-show-only-matching-messages))
1400 (add-hook 'post-command-hook #'notmuch-show-command-hook nil t)
1401 (jit-lock-register #'notmuch-show-buttonise-links)
1402 (notmuch-tag-clear-cache)
1403 (let ((inhibit-read-only t))
1404 (if (notmuch-show--build-buffer)
1405 ;; Messages were inserted into the buffer.
1407 ;; No messages were inserted - presumably none matched the
1409 (kill-buffer (current-buffer))
1411 (message "No messages matched the query!")
1414 (defun notmuch-show--build-queries (thread context)
1415 "Return a list of queries to try for this search.
1417 THREAD and CONTEXT are both strings, though CONTEXT may be nil.
1418 When CONTEXT is not nil, the first query is the conjunction of it
1419 and THREAD. The next query is THREAD alone, and serves as a
1420 fallback if the prior matches no messages."
1422 (push (list thread) queries)
1424 (push (list thread "and (" context ")") queries))
1427 (defun notmuch-show--header-line-format ()
1428 "Compute the header line format of a notmuch-show buffer."
1429 (when notmuch-show-header-line
1430 (let* ((s (notmuch-sanitize
1431 (notmuch-show-strip-re (notmuch-show-get-subject))))
1432 (subject (replace-regexp-in-string "%" "%%" s)))
1433 (cond ((stringp notmuch-show-header-line)
1434 (format-spec notmuch-show-header-line `((?s . ,subject))))
1435 ((functionp notmuch-show-header-line)
1436 (funcall notmuch-show-header-line subject))
1437 (notmuch-show-header-line subject)))))
1439 (defun notmuch-show--build-buffer (&optional state)
1440 "Display messages matching the current buffer context.
1442 Apply the previously saved STATE if supplied, otherwise show the
1443 first relevant message.
1445 If no messages match the query return NIL."
1446 (let* ((cli-args (list "--exclude=false"))
1447 (cli-args (if notmuch-show-elide-non-matching-messages (cons "--entire-thread=false" cli-args) cli-args))
1448 ;; "part 0 is the whole message (headers and body)" notmuch-show(1)
1449 (cli-args (if notmuch-show-single-message (cons "--part=0" cli-args) cli-args))
1450 (queries (notmuch-show--build-queries
1451 notmuch-show-thread-id notmuch-show-query-context))
1453 ;; Must be reset every time we are going to start inserting
1454 ;; messages into the buffer.
1455 (notmuch-show-previous-subject ""))
1456 ;; Use results from the first query that returns some.
1457 (while (and (not forest) queries)
1458 (setq forest (notmuch--run-show
1459 (append cli-args (list "'") (car queries) (list "'"))))
1460 (when (and forest notmuch-show-single-message)
1461 (setq forest (list (list (list forest)))))
1462 (setq queries (cdr queries)))
1464 (notmuch-show-insert-forest forest)
1465 ;; Store the original tags for each message so that we can
1468 (lambda () (notmuch-show-set-prop :orig-tags (notmuch-show-get-tags))))
1469 (setq header-line-format (notmuch-show--header-line-format))
1470 (run-hooks 'notmuch-show-hook)
1472 (notmuch-show-apply-state state)
1473 ;; With no state to apply, just go to the first message.
1474 (notmuch-show-goto-first-wanted-message)))
1475 ;; Report back to the caller whether any messages matched.
1480 (defun notmuch-show-capture-state ()
1481 "Capture the state of the current buffer.
1484 - the list of open messages,
1485 - the combination of current message id with/for each visible window."
1486 (let* ((win-list (get-buffer-window-list (current-buffer) nil t))
1487 (win-id-combo (mapcar (lambda (win)
1488 (with-selected-window win
1489 (list win (notmuch-show-get-message-id))))
1491 (list win-id-combo (notmuch-show-get-message-ids-for-open-messages))))
1493 (defun notmuch-show-get-query ()
1494 "Return the current query in this show buffer."
1495 (if notmuch-show-query-context
1496 (concat notmuch-show-thread-id
1498 notmuch-show-query-context
1500 notmuch-show-thread-id))
1502 (defun notmuch-show-goto-message (msg-id)
1503 "Go to message with msg-id."
1504 (goto-char (point-min))
1505 (unless (cl-loop if (string= msg-id (notmuch-show-get-message-id))
1507 until (not (notmuch-show-goto-message-next)))
1508 (goto-char (point-min))
1509 (message "Message-id not found."))
1510 (notmuch-show-message-adjust))
1512 (defun notmuch-show-apply-state (state)
1513 "Apply STATE to the current buffer.
1516 - opening the messages previously opened,
1517 - closing all other messages,
1518 - moving to the correct current message in every displayed window."
1519 (let ((win-msg-alist (car state))
1520 (open (cadr state)))
1521 ;; Open those that were open.
1522 (goto-char (point-min))
1523 (cl-loop do (notmuch-show-message-visible
1524 (notmuch-show-get-message-properties)
1525 (member (notmuch-show-get-message-id) open))
1526 until (not (notmuch-show-goto-message-next)))
1527 (dolist (win-msg-pair win-msg-alist)
1528 (with-selected-window (car win-msg-pair)
1529 ;; Go to the previously open message in this window
1530 (notmuch-show-goto-message (cadr win-msg-pair))))))
1532 (defun notmuch-show-refresh-view (&optional reset-state)
1533 "Refresh the current view.
1535 Refreshes the current view, observing changes in display
1536 preferences. If invoked with a prefix argument (or RESET-STATE is
1537 non-nil) then the state of the buffer (open/closed messages) is
1538 reset based on the original query."
1540 (let ((inhibit-read-only t)
1541 (mm-inline-override-types (notmuch--inline-override-types))
1542 (state (unless reset-state
1543 (notmuch-show-capture-state))))
1544 ;; `erase-buffer' does not seem to remove overlays, which can lead
1545 ;; to weird effects such as remaining images, so remove them
1549 (unless (notmuch-show--build-buffer state)
1550 ;; No messages were inserted.
1551 (kill-buffer (current-buffer))
1553 (message "Refreshing the buffer resulted in no messages!"))))
1557 (defvar notmuch-show-stash-map
1558 (let ((map (make-sparse-keymap)))
1559 (define-key map "c" 'notmuch-show-stash-cc)
1560 (define-key map "d" 'notmuch-show-stash-date)
1561 (define-key map "F" 'notmuch-show-stash-filename)
1562 (define-key map "f" 'notmuch-show-stash-from)
1563 (define-key map "i" 'notmuch-show-stash-message-id)
1564 (define-key map "I" 'notmuch-show-stash-message-id-stripped)
1565 (define-key map "s" 'notmuch-show-stash-subject)
1566 (define-key map "T" 'notmuch-show-stash-tags)
1567 (define-key map "t" 'notmuch-show-stash-to)
1568 (define-key map "l" 'notmuch-show-stash-mlarchive-link)
1569 (define-key map "L" 'notmuch-show-stash-mlarchive-link-and-go)
1570 (define-key map "G" 'notmuch-show-stash-git-send-email)
1571 (define-key map "?" 'notmuch-subkeymap-help)
1573 "Submap for stash commands.")
1574 (fset 'notmuch-show-stash-map notmuch-show-stash-map)
1576 (defvar notmuch-show-part-map
1577 (let ((map (make-sparse-keymap)))
1578 (define-key map "s" 'notmuch-show-save-part)
1579 (define-key map "v" 'notmuch-show-view-part)
1580 (define-key map "o" 'notmuch-show-interactively-view-part)
1581 (define-key map "|" 'notmuch-show-pipe-part)
1582 (define-key map "m" 'notmuch-show-choose-mime-of-part)
1583 (define-key map "?" 'notmuch-subkeymap-help)
1585 "Submap for part commands.")
1586 (fset 'notmuch-show-part-map notmuch-show-part-map)
1588 (defvar notmuch-show-mode-map
1589 (let ((map (make-sparse-keymap)))
1590 (set-keymap-parent map notmuch-common-keymap)
1591 (define-key map "Z" 'notmuch-tree-from-show-current-query)
1592 (define-key map "U" 'notmuch-unthreaded-from-show-current-query)
1593 (define-key map (kbd "<C-tab>") 'widget-backward)
1594 (define-key map (kbd "M-TAB") 'notmuch-show-previous-button)
1595 (define-key map (kbd "<backtab>") 'notmuch-show-previous-button)
1596 (define-key map (kbd "TAB") 'notmuch-show-next-button)
1597 (define-key map "f" 'notmuch-show-forward-message)
1598 (define-key map "F" 'notmuch-show-forward-open-messages)
1599 (define-key map "b" 'notmuch-show-resend-message)
1600 (define-key map "l" 'notmuch-show-filter-thread)
1601 (define-key map "r" 'notmuch-show-reply-sender)
1602 (define-key map "R" 'notmuch-show-reply)
1603 (define-key map "|" 'notmuch-show-pipe-message)
1604 (define-key map "w" 'notmuch-show-save-attachments)
1605 (define-key map "V" 'notmuch-show-view-raw-message)
1606 (define-key map "e" 'notmuch-show-resume-message)
1607 (define-key map "c" 'notmuch-show-stash-map)
1608 (define-key map "h" 'notmuch-show-toggle-visibility-headers)
1609 (define-key map "k" 'notmuch-tag-jump)
1610 (define-key map "*" 'notmuch-show-tag-all)
1611 (define-key map "-" 'notmuch-show-remove-tag)
1612 (define-key map "+" 'notmuch-show-add-tag)
1613 (define-key map "X" 'notmuch-show-archive-thread-then-exit)
1614 (define-key map "x" 'notmuch-show-archive-message-then-next-or-exit)
1615 (define-key map "A" 'notmuch-show-archive-thread-then-next)
1616 (define-key map "a" 'notmuch-show-archive-message-then-next-or-next-thread)
1617 (define-key map "N" 'notmuch-show-next-message)
1618 (define-key map "P" 'notmuch-show-previous-message)
1619 (define-key map "n" 'notmuch-show-next-open-message)
1620 (define-key map "p" 'notmuch-show-previous-open-message)
1621 (define-key map (kbd "M-n") 'notmuch-show-next-thread-show)
1622 (define-key map (kbd "M-p") 'notmuch-show-previous-thread-show)
1623 (define-key map (kbd "DEL") 'notmuch-show-rewind)
1624 (define-key map " " 'notmuch-show-advance-and-archive)
1625 (define-key map (kbd "M-RET") 'notmuch-show-open-or-close-all)
1626 (define-key map (kbd "RET") 'notmuch-show-toggle-message)
1627 (define-key map "#" 'notmuch-show-print-message)
1628 (define-key map "!" 'notmuch-show-toggle-elide-non-matching)
1629 (define-key map "$" 'notmuch-show-toggle-process-crypto)
1630 (define-key map "%" 'notmuch-show-choose-duplicate)
1631 (define-key map "<" 'notmuch-show-toggle-thread-indentation)
1632 (define-key map "t" 'toggle-truncate-lines)
1633 (define-key map "." 'notmuch-show-part-map)
1634 (define-key map "B" 'notmuch-show-browse-urls)
1636 "Keymap for \"notmuch show\" buffers.")
1640 (define-derived-mode notmuch-show-mode fundamental-mode "notmuch-show"
1641 "Major mode for viewing a thread with notmuch.
1643 This buffer contains the results of the \"notmuch show\" command
1644 for displaying a single thread of email from your email archives.
1646 By default, various components of email messages, (citations,
1647 signatures, already-read messages), are hidden. You can make
1648 these parts visible by clicking with the mouse button or by
1649 pressing RET after positioning the cursor on a hidden part, (for
1650 which \\[notmuch-show-next-button] and \\[notmuch-show-previous-button] are helpful).
1652 Reading the thread sequentially is well-supported by pressing
1653 \\[notmuch-show-advance-and-archive]. This will scroll the current message (if necessary), advance
1654 to the next message, or advance to the next thread (if already on
1655 the last message of a thread).
1657 Other commands are available to read or manipulate the thread
1658 more selectively, (such as '\\[notmuch-show-next-message]' and '\\[notmuch-show-previous-message]' to advance to messages
1659 without removing any tags, and '\\[notmuch-show-archive-thread]' to archive an entire thread
1660 without scrolling through with \\[notmuch-show-advance-and-archive]).
1662 You can add or remove arbitrary tags from the current message with
1663 '\\[notmuch-show-add-tag]' or '\\[notmuch-show-remove-tag]'.
1665 All currently available key bindings:
1667 \\{notmuch-show-mode-map}"
1668 (setq notmuch-buffer-refresh-function #'notmuch-show-refresh-view)
1669 (setq buffer-read-only t)
1670 (setq truncate-lines t)
1671 (setq imenu-prev-index-position-function
1672 #'notmuch-show-imenu-prev-index-position-function)
1673 (setq imenu-extract-index-name-function
1674 #'notmuch-show-imenu-extract-index-name-function))
1678 (defun notmuch-tree-from-show-current-query ()
1679 "Call notmuch tree with the current query."
1681 (notmuch-tree notmuch-show-thread-id
1682 notmuch-show-query-context
1683 (notmuch-show-get-message-id)))
1685 (defun notmuch-unthreaded-from-show-current-query ()
1686 "Call notmuch unthreaded with the current query."
1688 (notmuch-unthreaded notmuch-show-thread-id
1689 notmuch-show-query-context
1690 (notmuch-show-get-message-id)))
1692 ;;; Movement related functions.
1694 (defun notmuch-show-move-to-message-top ()
1695 (goto-char (notmuch-show-message-top)))
1697 (defun notmuch-show-move-to-message-bottom ()
1698 (goto-char (notmuch-show-message-bottom)))
1700 ;; There's some strangeness here where a text property applied to a
1701 ;; region a->b is not found when point is at b. We walk backwards
1702 ;; until finding the property.
1703 (defun notmuch-show-message-extent ()
1704 "Return a cons cell containing the start and end buffer offset
1705 of the current message."
1708 (while (not (setq r (get-text-property (point) :notmuch-message-extent)))
1712 (defun notmuch-show-message-top ()
1713 (car (notmuch-show-message-extent)))
1715 (defun notmuch-show-message-bottom ()
1716 (cdr (notmuch-show-message-extent)))
1718 (defun notmuch-show-goto-message-next ()
1719 (let ((start (point)))
1720 (notmuch-show-move-to-message-bottom)
1726 (defun notmuch-show-goto-message-previous ()
1727 (notmuch-show-move-to-message-top)
1731 (notmuch-show-move-to-message-top)
1734 (defun notmuch-show-mapc (function)
1735 "Iterate through all messages in the current thread with
1736 `notmuch-show-goto-message-next' and call FUNCTION for side
1739 (goto-char (point-min))
1740 (cl-loop do (funcall function)
1741 while (notmuch-show-goto-message-next))))
1743 ;;; Functions relating to the visibility of messages and their components.
1745 (defun notmuch-show-message-visible (props visible-p)
1746 (overlay-put (plist-get props :message-overlay) 'invisible (not visible-p))
1747 (notmuch-show-set-prop :message-visible visible-p props))
1749 (defun notmuch-show-headers-visible (props visible-p)
1750 (overlay-put (plist-get props :headers-overlay) 'invisible (not visible-p))
1751 (notmuch-show-set-prop :headers-visible visible-p props))
1753 ;;; Functions for setting and getting attributes of the current message.
1755 (defun notmuch-show-set-message-properties (props)
1757 (notmuch-show-move-to-message-top)
1758 (put-text-property (point) (+ (point) 1)
1759 :notmuch-message-properties props)))
1761 (defun notmuch-show-get-message-properties ()
1762 "Return the properties of the current message as a plist.
1764 Some useful entries are:
1765 :headers - Property list containing the headers :Date, :Subject, :From, etc.
1766 :body - Body of the message
1767 :tags - Tags for this message"
1769 (notmuch-show-move-to-message-top)
1770 (get-text-property (point) :notmuch-message-properties)))
1772 (defun notmuch-show-get-part-properties ()
1773 "Return the properties of the innermost part containing point.
1775 This is the part property list retrieved from the CLI. Signals
1776 an error if there is no part containing point."
1777 (or (get-text-property (point) :notmuch-part)
1778 (error "No message part here")))
1780 (defun notmuch-show-set-prop (prop val &optional props)
1781 (let ((inhibit-read-only t)
1783 (notmuch-show-get-message-properties))))
1784 (plist-put props prop val)
1785 (notmuch-show-set-message-properties props)))
1787 (defun notmuch-show-get-prop (prop &optional props)
1788 "Get property PROP from current message in show or tree mode.
1790 It gets property PROP from PROPS or, if PROPS is nil, the current
1791 message in either tree or show. This means that several utility
1792 functions in notmuch-show can be used directly by notmuch-tree as
1793 they just need the correct message properties."
1794 (plist-get (or props
1795 (cond ((eq major-mode 'notmuch-show-mode)
1796 (notmuch-show-get-message-properties))
1797 ((eq major-mode 'notmuch-tree-mode)
1798 (notmuch-tree-get-message-properties))
1802 (defun notmuch-show-get-message-id (&optional bare)
1803 "Return an id: query for the Message-Id of the current message.
1805 If optional argument BARE is non-nil, return
1806 the Message-Id without id: prefix and escaping."
1808 (notmuch-show-get-prop :id)
1809 (notmuch-id-to-query (notmuch-show-get-prop :id))))
1811 (defun notmuch-show-get-messages-ids ()
1812 "Return all id: queries of messages in the current thread."
1813 (let ((message-ids))
1815 (lambda () (push (notmuch-show-get-message-id) message-ids)))
1818 (defun notmuch-show-get-messages-ids-search ()
1819 "Return a search string for all message ids of messages in the
1821 (mapconcat 'identity (notmuch-show-get-messages-ids) " or "))
1823 ;; dme: Would it make sense to use a macro for many of these?
1825 (defun notmuch-show-get-filename ()
1826 "Return the filename of the current message."
1827 (let ((duplicate (notmuch-show-get-duplicate)))
1828 (nth (1- duplicate) (notmuch-show-get-prop :filename))))
1830 (defun notmuch-show-get-header (header &optional props)
1831 "Return the named header of the current message, if any."
1832 (plist-get (notmuch-show-get-prop :headers props) header))
1834 (defun notmuch-show-get-cc ()
1835 (notmuch-show-get-header :Cc))
1837 (defun notmuch-show-get-date ()
1838 (notmuch-show-get-header :Date))
1840 (defun notmuch-show-get-duplicate ()
1841 ;; if no duplicate property exists, assume first file
1842 (or (notmuch-show-get-prop :duplicate) 1))
1844 (defun notmuch-show-get-timestamp ()
1845 (notmuch-show-get-prop :timestamp))
1847 (defun notmuch-show-get-from ()
1848 (notmuch-show-get-header :From))
1850 (defun notmuch-show-get-subject ()
1851 (notmuch-show-get-header :Subject))
1853 (defun notmuch-show-get-to ()
1854 (notmuch-show-get-header :To))
1856 (defun notmuch-show-get-depth ()
1857 (notmuch-show-get-prop :depth))
1859 (defun notmuch-show-set-tags (tags)
1860 "Set the tags of the current message."
1861 (notmuch-show-set-prop :tags tags)
1862 (notmuch-show-update-tags tags))
1864 (defun notmuch-show-get-tags ()
1865 "Return the tags of the current message."
1866 (notmuch-show-get-prop :tags))
1868 (defun notmuch-show-message-visible-p ()
1869 "Is the current message visible?"
1870 (notmuch-show-get-prop :message-visible))
1872 (defun notmuch-show-headers-visible-p ()
1873 "Are the headers of the current message visible?"
1874 (notmuch-show-get-prop :headers-visible))
1876 (put 'notmuch-show-mark-read 'notmuch-prefix-doc
1877 "Mark the current message as unread.")
1878 (defun notmuch-show-mark-read (&optional unread)
1879 "Mark the current message as read.
1881 Mark the current message as read by applying the tag changes in
1882 `notmuch-show-mark-read-tags' to it (remove the \"unread\" tag by
1883 default). If a prefix argument is given, the message will be
1884 marked as unread, i.e. the tag changes in
1885 `notmuch-show-mark-read-tags' will be reversed."
1887 (when notmuch-show-mark-read-tags
1888 (apply 'notmuch-show-tag-message
1889 (notmuch-tag-change-list notmuch-show-mark-read-tags unread))))
1891 (defun notmuch-show-seen-current-message (_start _end)
1892 "Mark the current message read if it is open.
1894 We only mark it read once: if it is changed back then that is a
1895 user decision and we should not override it."
1896 (when (and (notmuch-show-message-visible-p)
1897 (not (notmuch-show-get-prop :seen)))
1898 (notmuch-show-mark-read)
1899 (notmuch-show-set-prop :seen t)))
1901 (defvar notmuch-show--seen-has-errored nil)
1902 (make-variable-buffer-local 'notmuch-show--seen-has-errored)
1904 (defun notmuch-show-command-hook ()
1905 (when (eq major-mode 'notmuch-show-mode)
1906 ;; We need to redisplay to get window-start and window-end correct.
1910 (funcall notmuch-show-mark-read-function (window-start) (window-end))
1912 (unless notmuch-show--seen-has-errored
1913 (setq notmuch-show--seen-has-errored t)
1914 (setq header-line-format
1915 (concat header-line-format
1917 " [some mark read tag changes may have failed]"
1918 'face font-lock-warning-face)))))))))
1920 (defun notmuch-show-filter-thread (query)
1921 "Filter or LIMIT the current thread based on a new query string.
1923 Reshows the current thread with matches defined by the new query-string."
1924 (interactive (list (notmuch-read-query "Filter thread: ")))
1925 (let ((msg-id (notmuch-show-get-message-id)))
1926 (setq notmuch-show-query-context (if (string-empty-p query) nil query))
1927 (notmuch-show-refresh-view t)
1928 (notmuch-show-goto-message msg-id)))
1930 ;;; Functions for getting attributes of several messages in the current thread.
1932 (defun notmuch-show-get-message-ids-for-open-messages ()
1933 "Return a list of all id: queries for open messages in the current thread."
1935 (let (message-ids done)
1936 (goto-char (point-min))
1938 (when (notmuch-show-message-visible-p)
1940 (append message-ids (list (notmuch-show-get-message-id)))))
1941 (setq done (not (notmuch-show-goto-message-next))))
1944 ;;; Commands typically bound to keys.
1946 (defun notmuch-show-advance ()
1947 "Advance through thread.
1949 If the current message in the thread is not yet fully visible,
1950 scroll by a near screenful to read more of the message.
1952 Otherwise, (the end of the current message is already within the
1953 current window), advance to the next open message."
1955 (let* ((end-of-this-message (notmuch-show-message-bottom))
1956 (visible-end-of-this-message (1- end-of-this-message))
1958 (while (invisible-p visible-end-of-this-message)
1959 (setq visible-end-of-this-message
1961 (1- (previous-single-char-property-change
1962 visible-end-of-this-message 'invisible)))))
1964 ;; Ideally we would test `end-of-this-message' against the result
1965 ;; of `window-end', but that doesn't account for the fact that
1966 ;; the end of the message might be hidden.
1967 ((and visible-end-of-this-message
1968 (> visible-end-of-this-message (window-end)))
1969 ;; The bottom of this message is not visible - scroll.
1971 ((not (= end-of-this-message (point-max)))
1972 ;; This is not the last message - move to the next visible one.
1973 (notmuch-show-next-open-message))
1974 ((not (= (point) (point-max)))
1975 ;; This is the last message, but the cursor is not at the end of
1976 ;; the buffer. Move it there.
1977 (goto-char (point-max)))
1979 ;; This is the last message - change the return value
1983 (defun notmuch-show-advance-and-archive ()
1984 "Advance through thread and archive.
1986 This command is intended to be one of the simplest ways to
1987 process a thread of email. It works exactly like
1988 notmuch-show-advance, in that it scrolls through messages in a
1989 show buffer, except that when it gets to the end of the buffer it
1990 archives the entire current thread, (apply changes in
1991 `notmuch-archive-tags'), kills the buffer, and displays the next
1992 thread from the search from which this thread was originally
1995 (when (notmuch-show-advance)
1996 (notmuch-show-archive-thread-then-next)))
1998 (defun notmuch-show-rewind ()
1999 "Backup through the thread (reverse scrolling compared to \
2000 \\[notmuch-show-advance-and-archive]).
2002 Specifically, if the beginning of the previous email is fewer
2003 than `window-height' lines from the current point, move to it
2004 just like `notmuch-show-previous-message'.
2006 Otherwise, just scroll down a screenful of the current message.
2008 This command does not modify any message tags, (it does not undo
2009 any effects from previous calls to
2010 `notmuch-show-advance-and-archive'."
2012 (let ((start-of-message (notmuch-show-message-top))
2013 (start-of-window (window-start)))
2015 ;; Either this message is properly aligned with the start of the
2016 ;; window or the start of this message is not visible on the
2018 ((or (= start-of-message start-of-window)
2019 (< start-of-message start-of-window))
2021 ;; If a small number of lines from the previous message are
2022 ;; visible, realign so that the top of the current message is at
2023 ;; the top of the screen.
2024 (when (<= (count-screen-lines (window-start) start-of-message)
2025 next-screen-context-lines)
2026 (goto-char (notmuch-show-message-top))
2027 (notmuch-show-message-adjust))
2028 ;; Move to the top left of the window.
2029 (goto-char (window-start)))
2031 ;; Move to the previous message.
2032 (notmuch-show-previous-message)))))
2034 (put 'notmuch-show-reply 'notmuch-prefix-doc "... and prompt for sender")
2035 (defun notmuch-show-reply (&optional prompt-for-sender)
2036 "Reply to the sender and all recipients of the current message."
2038 (notmuch-mua-new-reply (notmuch-show-get-message-id) prompt-for-sender t
2039 (notmuch-show-get-prop :duplicate)))
2041 (put 'notmuch-show-reply-sender 'notmuch-prefix-doc "... and prompt for sender")
2042 (defun notmuch-show-reply-sender (&optional prompt-for-sender)
2043 "Reply to the sender of the current message."
2045 (notmuch-mua-new-reply (notmuch-show-get-message-id) prompt-for-sender nil
2046 (notmuch-show-get-prop :duplicate)))
2048 (put 'notmuch-show-forward-message 'notmuch-prefix-doc
2049 "... and prompt for sender")
2050 (defun notmuch-show-forward-message (&optional prompt-for-sender)
2051 "Forward the current message."
2053 (notmuch-mua-new-forward-messages (list (notmuch-show-get-message-id))
2056 (put 'notmuch-show-forward-open-messages 'notmuch-prefix-doc
2057 "... and prompt for sender")
2058 (defun notmuch-show-forward-open-messages (&optional prompt-for-sender)
2059 "Forward the currently open messages."
2061 (let ((open-messages (notmuch-show-get-message-ids-for-open-messages)))
2062 (unless open-messages
2063 (error "No open messages to forward."))
2064 (notmuch-mua-new-forward-messages open-messages prompt-for-sender)))
2066 (defun notmuch-show-resend-message (addresses)
2067 "Resend the current message."
2068 (interactive (list (notmuch-address-from-minibuffer "Resend to: ")))
2069 (when (y-or-n-p (concat "Confirm resend to " addresses " "))
2070 (notmuch-show-view-raw-message)
2071 (message-resend addresses)
2072 (notmuch-bury-or-kill-this-buffer)))
2074 (defun notmuch-show-message-adjust ()
2077 (defun notmuch-show-next-message (&optional pop-at-end)
2078 "Show the next message.
2080 If a prefix argument is given and this is the last message in the
2081 thread, navigate to the next thread in the parent search buffer."
2083 (if (notmuch-show-goto-message-next)
2084 (notmuch-show-message-adjust)
2086 (notmuch-show-next-thread)
2087 (goto-char (point-max)))))
2089 (defun notmuch-show-previous-message ()
2090 "Show the previous message or the start of the current message."
2092 (if (= (point) (notmuch-show-message-top))
2093 (notmuch-show-goto-message-previous)
2094 (notmuch-show-move-to-message-top))
2095 (notmuch-show-message-adjust))
2097 (defun notmuch-show-next-open-message (&optional pop-at-end)
2098 "Show the next open message.
2100 If a prefix argument is given and this is the last open message
2101 in the thread, navigate to the next thread in the parent search
2102 buffer. Return t if there was a next open message in the thread
2103 to show, nil otherwise."
2106 (while (and (setq r (notmuch-show-goto-message-next))
2107 (not (notmuch-show-message-visible-p))))
2109 (notmuch-show-message-adjust)
2111 (notmuch-show-next-thread)
2112 (goto-char (point-max))))
2115 (defun notmuch-show-next-matching-message ()
2116 "Show the next matching message."
2119 (while (and (setq r (notmuch-show-goto-message-next))
2120 (not (notmuch-show-get-prop :match))))
2122 (notmuch-show-message-adjust)
2123 (goto-char (point-max)))))
2125 (defun notmuch-show-open-if-matched ()
2126 "Open a message if it is matched (whether or not excluded)."
2127 (let ((props (notmuch-show-get-message-properties)))
2128 (notmuch-show-message-visible props (plist-get props :match))))
2130 (defun notmuch-show-goto-first-wanted-message ()
2131 "Move to the first open message and mark it read."
2132 (goto-char (point-min))
2133 (unless (notmuch-show-message-visible-p)
2134 (notmuch-show-next-open-message))
2136 ;; There are no matched non-excluded messages so open all matched
2137 ;; (necessarily excluded) messages and go to the first.
2138 (notmuch-show-mapc 'notmuch-show-open-if-matched)
2139 (force-window-update)
2140 (goto-char (point-min))
2141 (unless (notmuch-show-message-visible-p)
2142 (notmuch-show-next-open-message))))
2144 (defun notmuch-show-previous-open-message ()
2145 "Show the previous open message."
2147 (while (and (if (= (point) (notmuch-show-message-top))
2148 (notmuch-show-goto-message-previous)
2149 (notmuch-show-move-to-message-top))
2150 (not (notmuch-show-message-visible-p))))
2151 (notmuch-show-message-adjust))
2153 (defun notmuch-show-view-raw-message ()
2154 "View the original source of the current message."
2156 (let* ((id (notmuch-show-get-message-id))
2157 (duplicate (notmuch-show-get-duplicate))
2158 (args (if (> duplicate 1)
2159 (list (format "--duplicate=%d" duplicate) id)
2161 (buf (get-buffer-create (format "*notmuch-raw-%s-%d*" id duplicate)))
2162 (inhibit-read-only t))
2163 (pop-to-buffer-same-window buf)
2165 (let ((coding-system-for-read 'no-conversion))
2166 (apply #'notmuch--call-process notmuch-command nil t nil "show" "--format=raw" args))
2167 (goto-char (point-min))
2168 (set-buffer-modified-p nil)
2169 (setq buffer-read-only t)
2170 (view-buffer buf 'kill-buffer-if-not-modified)))
2172 (defun notmuch-show-resume-message ()
2173 "Resume EDITING the current draft message."
2175 (notmuch-draft-resume (notmuch-show-get-message-id)))
2177 (put 'notmuch-show-pipe-message 'notmuch-doc
2178 "Pipe the contents of the current message to a command.")
2179 (put 'notmuch-show-pipe-message 'notmuch-prefix-doc
2180 "Pipe the thread as an mbox to a command.")
2181 (defun notmuch-show-pipe-message (entire-thread command)
2182 "Pipe the contents of the current message (or thread) to COMMAND.
2184 COMMAND will be executed with the raw contents of the current
2185 email message as stdin. Anything printed by the command to stdout
2186 or stderr will appear in the *notmuch-pipe* buffer.
2188 If ENTIRE-THREAD is non-nil (or when invoked with a prefix
2189 argument), COMMAND will receive all open messages in the current
2190 thread (formatted as an mbox) rather than only the current
2192 (interactive (let ((query-string (if current-prefix-arg
2193 "Pipe all open messages to command: "
2194 "Pipe message to command: ")))
2195 (list current-prefix-arg (read-shell-command query-string))))
2196 (let (shell-command)
2199 (concat notmuch-command " show --format=mbox --exclude=false "
2200 (shell-quote-argument
2201 (mapconcat 'identity
2202 (notmuch-show-get-message-ids-for-open-messages)
2206 (concat notmuch-command " show --format=raw "
2207 (shell-quote-argument (notmuch-show-get-message-id))
2209 (let ((cwd default-directory)
2210 (buf (get-buffer-create (concat "*notmuch-pipe*"))))
2211 (with-current-buffer buf
2212 (setq buffer-read-only t)
2213 (let ((inhibit-read-only t))
2215 ;; Use the originating buffer's working directory instead of
2216 ;; that of the pipe buffer.
2218 (let ((exit-code (call-process-shell-command shell-command nil buf)))
2219 (goto-char (point-max))
2220 (set-buffer-modified-p nil)
2221 (unless (zerop exit-code)
2223 (message (format "Command '%s' exited abnormally with code %d"
2224 shell-command exit-code)))))))))
2226 (defun notmuch-show-tag-message (&rest tag-changes)
2227 "Change tags for the current message.
2229 TAG-CHANGES is a list of tag operations for `notmuch-tag'."
2230 (let* ((current-tags (notmuch-show-get-tags))
2231 (new-tags (notmuch-update-tags current-tags tag-changes)))
2232 (unless (equal current-tags new-tags)
2233 (notmuch-tag (notmuch-show-get-message-id) tag-changes)
2234 (notmuch-show-set-tags new-tags))))
2236 (defun notmuch-show-tag (tag-changes)
2237 "Change tags for the current message.
2239 See `notmuch-tag' for information on the format of TAG-CHANGES."
2240 (interactive (list (notmuch-read-tag-changes (notmuch-show-get-tags)
2242 (notmuch-tag (notmuch-show-get-message-id) tag-changes)
2243 (let* ((current-tags (notmuch-show-get-tags))
2244 (new-tags (notmuch-update-tags current-tags tag-changes)))
2245 (unless (equal current-tags new-tags)
2246 (notmuch-show-set-tags new-tags))))
2248 (defun notmuch-show-tag-all (tag-changes)
2249 "Change tags for all messages in the current show buffer.
2251 See `notmuch-tag' for information on the format of TAG-CHANGES."
2255 (lambda () (setq tags (append (notmuch-show-get-tags) tags))))
2256 (notmuch-read-tag-changes tags "Tag thread"))))
2257 (notmuch-tag (notmuch-show-get-messages-ids-search) tag-changes)
2260 (let* ((current-tags (notmuch-show-get-tags))
2261 (new-tags (notmuch-update-tags current-tags tag-changes)))
2262 (unless (equal current-tags new-tags)
2263 (notmuch-show-set-tags new-tags))))))
2265 (defun notmuch-show-add-tag (tag-changes)
2266 "Change tags for the current message (defaulting to add).
2268 Same as `notmuch-show-tag' but sets initial input to '+'."
2270 (list (notmuch-read-tag-changes (notmuch-show-get-tags) "Tag message" "+")))
2271 (notmuch-show-tag tag-changes))
2273 (defun notmuch-show-remove-tag (tag-changes)
2274 "Change tags for the current message (defaulting to remove).
2276 Same as `notmuch-show-tag' but sets initial input to '-'."
2278 (list (notmuch-read-tag-changes (notmuch-show-get-tags) "Tag message" "-")))
2279 (notmuch-show-tag tag-changes))
2281 (defun notmuch-show-toggle-visibility-headers ()
2282 "Toggle the visibility of the current message headers."
2284 (let ((props (notmuch-show-get-message-properties)))
2285 (notmuch-show-headers-visible
2287 (not (plist-get props :headers-visible))))
2288 (force-window-update))
2290 (defun notmuch-show-toggle-message ()
2291 "Toggle the visibility of the current message."
2293 (let ((props (notmuch-show-get-message-properties)))
2294 (notmuch-show-message-visible
2296 (not (plist-get props :message-visible))))
2297 (force-window-update))
2299 (put 'notmuch-show-open-or-close-all 'notmuch-doc "Show all messages.")
2300 (put 'notmuch-show-open-or-close-all 'notmuch-prefix-doc "Hide all messages.")
2301 (defun notmuch-show-open-or-close-all ()
2302 "Set the visibility all of the messages in the current thread.
2304 By default make all of the messages visible. With a prefix
2305 argument, hide all of the messages."
2308 (goto-char (point-min))
2309 (cl-loop do (notmuch-show-message-visible
2310 (notmuch-show-get-message-properties)
2311 (not current-prefix-arg))
2312 until (not (notmuch-show-goto-message-next))))
2313 (force-window-update))
2315 (defun notmuch-show-next-button ()
2316 "Advance point to the next button in the buffer."
2320 (defun notmuch-show-previous-button ()
2321 "Move point back to the previous button in the buffer."
2323 (backward-button 1))
2325 (defun notmuch-show-next-thread (&optional show previous)
2326 "Move to the next item in the search results, if any.
2328 If SHOW is non-nil, open the next item in a show
2329 buffer. Otherwise just highlight the next item in the search
2330 buffer. If PREVIOUS is non-nil, move to the previous item in the
2331 search results instead.
2333 Return non-nil on success."
2335 (let ((parent-buffer notmuch-show-parent-buffer))
2336 (notmuch-bury-or-kill-this-buffer)
2337 (when (buffer-live-p parent-buffer)
2338 (switch-to-buffer parent-buffer)
2340 (notmuch-search-previous-thread)
2341 (notmuch-search-next-thread))
2343 (notmuch-search-show-thread)))))
2345 (defun notmuch-show-next-thread-show ()
2346 "Show the next thread in the search results, if any."
2348 (notmuch-show-next-thread t))
2350 (defun notmuch-show-previous-thread-show ()
2351 "Show the previous thread in the search results, if any."
2353 (notmuch-show-next-thread t t))
2355 (put 'notmuch-show-archive-thread 'notmuch-prefix-doc
2356 "Un-archive each message in thread.")
2357 (defun notmuch-show-archive-thread (&optional unarchive)
2358 "Archive each message in thread.
2360 Archive each message currently shown by applying the tag changes
2361 in `notmuch-archive-tags' to each. If a prefix argument is given,
2362 the messages will be \"unarchived\", i.e. the tag changes in
2363 `notmuch-archive-tags' will be reversed.
2365 Note: This command is safe from any race condition of new messages
2366 being delivered to the same thread. It does not archive the
2367 entire thread, but only the messages shown in the current
2370 (when notmuch-archive-tags
2371 (notmuch-show-tag-all
2372 (notmuch-tag-change-list notmuch-archive-tags unarchive))))
2374 (defun notmuch-show-archive-thread-then-next ()
2375 "Archive all messages in the current buffer, then show next thread from search."
2377 (notmuch-show-archive-thread)
2378 (notmuch-show-next-thread t))
2380 (defun notmuch-show-archive-thread-then-exit ()
2381 "Archive all messages in the current buffer, then exit back to search results."
2383 (notmuch-show-archive-thread)
2384 (notmuch-show-next-thread))
2386 (put 'notmuch-show-archive-message 'notmuch-prefix-doc
2387 "Un-archive the current message.")
2388 (defun notmuch-show-archive-message (&optional unarchive)
2389 "Archive the current message.
2391 Archive the current message by applying the tag changes in
2392 `notmuch-archive-tags' to it. If a prefix argument is given, the
2393 message will be \"unarchived\", i.e. the tag changes in
2394 `notmuch-archive-tags' will be reversed."
2396 (when notmuch-archive-tags
2397 (apply 'notmuch-show-tag-message
2398 (notmuch-tag-change-list notmuch-archive-tags unarchive))))
2400 (defun notmuch-show-archive-message-then-next-or-exit ()
2401 "Archive current message, then show next open message in current thread.
2403 If at the last open message in the current thread, then exit back
2406 (notmuch-show-archive-message)
2407 (notmuch-show-next-open-message t))
2409 (defun notmuch-show-archive-message-then-next-or-next-thread ()
2410 "Archive current message, then show next open message in current or next thread.
2412 If at the last open message in the current thread, then show next
2413 thread from search."
2415 (notmuch-show-archive-message)
2416 (unless (notmuch-show-next-open-message)
2417 (notmuch-show-next-thread t)))
2419 (defun notmuch-show-stash-cc ()
2420 "Copy CC field of current message to kill-ring."
2422 (notmuch-common-do-stash (notmuch-show-get-cc)))
2424 (put 'notmuch-show-stash-date 'notmuch-prefix-doc
2425 "Copy timestamp of current message to kill-ring.")
2426 (defun notmuch-show-stash-date (&optional stash-timestamp)
2427 "Copy date of current message to kill-ring.
2429 If invoked with a prefix argument, copy timestamp of current
2430 message to kill-ring."
2433 (notmuch-common-do-stash (format "%d" (notmuch-show-get-timestamp)))
2434 (notmuch-common-do-stash (notmuch-show-get-date))))
2436 (defun notmuch-show-stash-filename ()
2437 "Copy filename of current message to kill-ring."
2439 (notmuch-common-do-stash (notmuch-show-get-filename)))
2441 (defun notmuch-show-stash-from ()
2442 "Copy From address of current message to kill-ring."
2444 (notmuch-common-do-stash (notmuch-show-get-from)))
2446 (put 'notmuch-show-stash-message-id 'notmuch-prefix-doc
2447 "Copy thread: query matching current thread to kill-ring.")
2448 (defun notmuch-show-stash-message-id (&optional stash-thread-id)
2449 "Copy id: query matching the current message to kill-ring.
2451 If invoked with a prefix argument (or STASH-THREAD-ID is
2452 non-nil), copy thread: query matching the current thread to
2456 (notmuch-common-do-stash notmuch-show-thread-id)
2457 (notmuch-common-do-stash (notmuch-show-get-message-id))))
2459 (defun notmuch-show-stash-message-id-stripped ()
2460 "Copy message ID of current message (sans `id:' prefix) to kill-ring."
2462 (notmuch-common-do-stash (notmuch-show-get-message-id t)))
2464 (defun notmuch-show-stash-subject ()
2465 "Copy Subject field of current message to kill-ring."
2467 (notmuch-common-do-stash (notmuch-show-get-subject)))
2469 (defun notmuch-show-stash-tags ()
2470 "Copy tags of current message to kill-ring as a comma separated list."
2472 (notmuch-common-do-stash (mapconcat 'identity (notmuch-show-get-tags) ",")))
2474 (defun notmuch-show-stash-to ()
2475 "Copy To address of current message to kill-ring."
2477 (notmuch-common-do-stash (notmuch-show-get-to)))
2479 (defun notmuch-show-stash-mlarchive-link (&optional mla)
2480 "Copy an ML Archive URI for the current message to the kill-ring.
2482 This presumes that the message is available at the selected Mailing List Archive.
2484 If optional argument MLA is non-nil, use the provided key instead of prompting
2485 the user (see `notmuch-show-stash-mlarchive-link-alist')."
2487 (let ((url (cdr (assoc
2489 (let ((completion-ignore-case t))
2491 "Mailing List Archive: "
2492 notmuch-show-stash-mlarchive-link-alist
2494 notmuch-show-stash-mlarchive-link-default)))
2495 notmuch-show-stash-mlarchive-link-alist))))
2496 (notmuch-common-do-stash
2498 (funcall url (notmuch-show-get-message-id t))
2499 (concat url (notmuch-show-get-message-id t))))))
2501 (defun notmuch-show-stash-mlarchive-link-and-go (&optional mla)
2502 "Copy an ML Archive URI for the current message to the kill-ring and visit it.
2504 This presumes that the message is available at the selected Mailing List Archive.
2506 If optional argument MLA is non-nil, use the provided key instead of prompting
2507 the user (see `notmuch-show-stash-mlarchive-link-alist')."
2509 (notmuch-show-stash-mlarchive-link mla)
2510 (browse-url (current-kill 0 t)))
2512 (defun notmuch-show-stash-git-helper (addresses prefix)
2513 "Normalize all ADDRESSES while adding PREFIX.
2514 Escape, trim, quote and add PREFIX to each address in list
2515 of ADDRESSES, and return the result as a single string."
2516 (mapconcat (lambda (x)
2518 ;; escape double-quotes
2519 (replace-regexp-in-string
2521 ;; trim leading and trailing spaces
2522 (replace-regexp-in-string
2523 "\\(^ *\\| *$\\)" ""
2527 (put 'notmuch-show-stash-git-send-email 'notmuch-prefix-doc
2528 "Copy From/To/Cc of current message to kill-ring.
2529 Use a form suitable for pasting to git send-email command line.")
2531 (defun notmuch-show-stash-git-send-email (&optional no-in-reply-to)
2532 "Copy From/To/Cc/Message-Id of current message to kill-ring.
2533 Use a form suitable for pasting to git send-email command line.
2535 If invoked with a prefix argument (or NO-IN-REPLY-TO is non-nil),
2536 omit --in-reply-to=<Message-Id>."
2538 (notmuch-common-do-stash
2539 (mapconcat 'identity
2542 (notmuch-show-stash-git-helper
2543 (message-tokenize-header (notmuch-show-get-from)) "--to=")
2544 (notmuch-show-stash-git-helper
2545 (message-tokenize-header (notmuch-show-get-to)) "--to=")
2546 (notmuch-show-stash-git-helper
2547 (message-tokenize-header (notmuch-show-get-cc)) "--cc=")
2548 (unless no-in-reply-to
2549 (notmuch-show-stash-git-helper
2550 (list (notmuch-show-get-message-id t)) "--in-reply-to="))))
2553 ;;; Interactive part functions and their helpers
2555 (defun notmuch-show-generate-part-buffer (msg part)
2556 "Return a temporary buffer containing the specified part's content."
2557 (let ((buf (generate-new-buffer " *notmuch-part*"))
2558 (process-crypto notmuch-show-process-crypto))
2559 (with-current-buffer buf
2560 ;; This is always used in the content of mm handles, which
2561 ;; expect undecoded, binary part content.
2562 (insert (notmuch-get-bodypart-binary msg part process-crypto)))
2565 (defun notmuch-show-current-part-handle (&optional mime-type)
2566 "Return an mm-handle for the part containing point.
2568 This creates a temporary buffer for the part's content; the
2569 caller is responsible for killing this buffer as appropriate. If
2570 MIME-TYPE is given then set the handle's mime-type to MIME-TYPE."
2571 (let* ((msg (notmuch-show-get-message-properties))
2572 (part (notmuch-show-get-part-properties))
2573 (buf (notmuch-show-generate-part-buffer msg part))
2574 (computed-type (or mime-type (plist-get part :computed-type)))
2575 (filename (plist-get part :filename))
2576 (disposition (and filename `(attachment (filename . ,filename)))))
2577 (mm-make-handle buf (list computed-type) nil nil disposition)))
2579 (defun notmuch-show-apply-to-current-part-handle (fn &optional mime-type)
2580 "Apply FN to an mm-handle for the part containing point.
2582 This ensures that the temporary buffer created for the mm-handle
2583 is destroyed when FN returns. If MIME-TYPE is given then force
2584 part to be treated as if it had that mime-type."
2585 (let ((handle (notmuch-show-current-part-handle mime-type)))
2586 ;; Emacs puts stdout/stderr into the calling buffer so we call
2587 ;; it from a temp-buffer, unless notmuch-show-attachment-debug
2588 ;; is non-nil, in which case we put it in " *notmuch-part*".
2590 (if notmuch-show-attachment-debug
2591 (with-current-buffer (generate-new-buffer " *notmuch-part*")
2592 (funcall fn handle))
2594 (funcall fn handle)))
2595 (kill-buffer (mm-handle-buffer handle)))))
2597 (defun notmuch-show-part-button-default (&optional button)
2599 (let ((button (or button (button-at (point)))))
2600 ;; Try to toggle the part, if that fails then call the default
2601 ;; action. The toggle fails if the part has no emacs renderable
2603 (unless (notmuch-show-toggle-part-invisibility button)
2604 (call-interactively notmuch-show-part-button-default-action))))
2606 (defun notmuch-show-save-part ()
2607 "Save the MIME part containing point to a file."
2609 (notmuch-show-apply-to-current-part-handle #'mm-save-part))
2611 (defun notmuch-show-view-part ()
2612 "View the MIME part containing point in an external viewer."
2614 ;; Set mm-inlined-types to nil to force an external viewer
2615 (let ((mm-inlined-types nil))
2616 (notmuch-show-apply-to-current-part-handle #'mm-display-part)))
2618 (defun notmuch-show-interactively-view-part ()
2619 "View the MIME part containing point, prompting for a viewer."
2621 (notmuch-show-apply-to-current-part-handle #'mm-interactively-view-part))
2623 (defun notmuch-show-pipe-part ()
2624 "Pipe the MIME part containing point to an external command."
2626 (notmuch-show-apply-to-current-part-handle #'mm-pipe-part))
2628 (defun notmuch-show--mm-display-part (handle)
2629 "Use mm-display-part to display HANDLE in a new buffer.
2631 If the part is displayed in an external application then close
2633 (let ((buf (get-buffer-create (generate-new-buffer-name
2634 (concat " *notmuch-internal-part*")))))
2635 (pop-to-buffer-same-window buf)
2636 (if (eq (mm-display-part handle) 'external)
2638 (goto-char (point-min))
2639 (set-buffer-modified-p nil)
2640 (view-buffer buf 'kill-buffer-if-not-modified))))
2642 (defun notmuch-show-choose-mime-of-part (mime-type)
2643 "Choose the mime type to use for displaying part."
2645 (list (completing-read "Mime type to use (default text/plain): "
2646 (mailcap-mime-types) nil nil nil nil "text/plain")))
2647 (notmuch-show-apply-to-current-part-handle #'notmuch-show--mm-display-part
2650 (defun notmuch-show-imenu-prev-index-position-function ()
2651 "Move point to previous message in notmuch-show buffer.
2652 This function is used as a value for
2653 `imenu-prev-index-position-function'."
2656 (notmuch-show-previous-message)
2659 (defun notmuch-show-imenu-extract-index-name-function ()
2660 "Return imenu name for line at point.
2661 This function is used as a value for
2662 `imenu-extract-index-name-function'. Point should be at the
2663 beginning of the line."
2664 (back-to-indentation)
2665 (buffer-substring-no-properties (if notmuch-show-imenu-indent
2666 (line-beginning-position)
2668 (line-end-position)))
2670 (defmacro notmuch-show--with-currently-shown-message (&rest body)
2671 "Evaluate BODY with display restricted to the currently shown
2675 (let ((extent (notmuch-show-message-extent)))
2676 (narrow-to-region (car extent) (cdr extent))
2679 (defun notmuch-show--gather-urls ()
2680 "Gather any URLs in the current message."
2681 (notmuch-show--with-currently-shown-message
2683 (goto-char (point-min))
2684 (while (re-search-forward goto-address-url-regexp (point-max) t)
2685 (push (match-string-no-properties 0) urls))
2688 (defun notmuch-show-browse-urls (&optional kill)
2689 "Offer to browse any URLs in the current message.
2690 With a prefix argument, copy the URL to the kill ring rather than
2693 (let ((urls (notmuch-show--gather-urls))
2694 (prompt (if kill "Copy URL to kill ring: " "Browse URL: "))
2695 (fn (if kill #'kill-new #'browse-url)))
2697 (funcall fn (completing-read prompt urls nil nil nil nil (car urls)))
2698 (message "No URLs found."))))
2702 (provide 'notmuch-show)
2704 ;;; notmuch-show.el ends here