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 (let ((inhibit-read-only t)
456 (start (notmuch-show-message-top))
457 (depth (notmuch-show-get-prop :depth))
458 (orig-tags (notmuch-show-get-prop :orig-tags))
459 (props (notmuch-show-get-message-properties))
460 (extent (notmuch-show-message-extent)))
462 (notmuch-show-insert-headerline props depth tags orig-tags)
463 (put-text-property start (1+ start)
464 :notmuch-message-properties props)
465 (put-text-property (car extent) (cdr extent) :notmuch-message-extent extent)
466 ;; delete original headerline, but do not save to kill ring
467 (delete-region (point) (1+ (line-end-position))))))
469 (defun notmuch-clean-address (address)
470 "Try to clean a single email ADDRESS for display. Return a cons
471 cell of (AUTHOR_EMAIL AUTHOR_NAME). Return (ADDRESS nil) if
474 (let (p-name p-address)
475 ;; It would be convenient to use `mail-header-parse-address',
476 ;; but that expects un-decoded mailbox parts, whereas our
477 ;; mailbox parts are already decoded (and hence may contain
478 ;; UTF-8). Given that notmuch should handle most of the awkward
479 ;; cases, some simple string deconstruction should be sufficient
482 ;; "User <user@dom.ain>" style.
483 ((string-match "\\(.*\\) <\\(.*\\)>" address)
484 (setq p-name (match-string 1 address))
485 (setq p-address (match-string 2 address)))
487 ;; "<user@dom.ain>" style.
488 ((string-match "<\\(.*\\)>" address)
489 (setq p-address (match-string 1 address)))
492 (setq p-address address)))
494 ;; Remove elements of the mailbox part that are not relevant for
495 ;; display, even if they are required during transport:
498 (setq p-name (replace-regexp-in-string "\\\\" "" p-name))
499 ;; Outer single and double quotes, which might be nested.
500 (cl-loop with start-of-loop
501 do (setq start-of-loop p-name)
502 when (string-match "^\"\\(.*\\)\"$" p-name)
503 do (setq p-name (match-string 1 p-name))
504 when (string-match "^'\\(.*\\)'$" p-name)
505 do (setq p-name (match-string 1 p-name))
506 until (string= start-of-loop p-name)))
507 ;; If the address is 'foo@bar.com <foo@bar.com>' then show just
509 (when (string= p-name p-address)
511 (cons p-address p-name))
512 (error (cons address nil))))
514 (defun notmuch-show-clean-address (address)
515 "Try to clean a single email ADDRESS for display.
516 Return unchanged ADDRESS if parsing fails."
517 (let* ((clean-address (notmuch-clean-address address))
518 (p-address (car clean-address))
519 (p-name (cdr clean-address)))
520 ;; If no name, return just the address.
523 ;; Otherwise format the name and address together.
524 (concat p-name " <" p-address ">"))))
526 (defun notmuch-show--mark-height (tree)
527 "Calculate and cache height (distance from deepest descendent)"
528 (let* ((msg (car tree))
529 (children (cadr tree))
530 (cached-height (plist-get msg :height)))
533 (if (null children) 0
534 (1+ (apply #'max (mapcar #'notmuch-show--mark-height children))))))
535 (plist-put msg :height height)
538 (defun notmuch-show-insert-headerline (msg-plist depth tags &optional orig-tags)
539 "Insert a notmuch style headerline based on HEADERS for a
540 message at DEPTH in the current thread."
541 (let* ((start (point))
542 (headers (plist-get msg-plist :headers))
543 (duplicate (or (plist-get msg-plist :duplicate) 0))
544 (file-count (length (plist-get msg-plist :filename)))
545 (date (or (and notmuch-show-relative-dates
546 (plist-get msg-plist :date_relative))
547 (plist-get headers :Date)))
548 (from (notmuch-sanitize
549 (notmuch-show-clean-address (plist-get headers :From)))))
550 (when (string-match "\\cR" from)
551 ;; If the From header has a right-to-left character add
552 ;; invisible U+200E LEFT-TO-RIGHT MARK character which forces
553 ;; the header paragraph as left-to-right text.
554 (insert (propertize (string ?\x200e) 'invisible t)))
555 (insert (if notmuch-show-indent-content
556 (notmuch-show-spaces-n (* notmuch-show-indent-messages-width
563 (notmuch-tag-format-tags tags (or orig-tags tags))
567 (let ((txt (format "%d/%d\n" duplicate file-count)))
569 (notmuch-show-spaces-n (max 0 (- (window-width) (+ (current-column) (length txt)))))
572 (overlay-put (make-overlay start (point))
573 'face 'notmuch-message-summary-face)))
575 (defun notmuch-show-insert-header (header header-value)
576 "Insert a single header."
577 (insert header ": " (notmuch-sanitize header-value) "\n"))
579 (defun notmuch-show-insert-headers (headers)
580 "Insert the headers of the current message."
581 (let ((start (point)))
582 (mapc (lambda (header)
583 (let* ((header-symbol (intern (concat ":" header)))
584 (header-value (plist-get headers header-symbol)))
585 (when (and header-value
586 (not (string-equal "" header-value)))
587 (notmuch-show-insert-header header header-value))))
588 notmuch-message-headers)
591 (narrow-to-region start (point-max))
592 (run-hooks 'notmuch-show-markup-headers-hook)))))
596 (define-button-type 'notmuch-show-part-button-type
597 'action 'notmuch-show-part-button-default
600 :supertype 'notmuch-button-type)
602 (defun notmuch-show-insert-part-header (_nth content-type declared-type
603 &optional name comment)
604 (let ((base-label (concat (and name (concat name ": "))
606 (and (not (string-equal declared-type content-type))
607 (concat " (as " content-type ")"))
609 (prog1 (insert-button
610 (concat "[ " base-label " ]")
611 :base-label base-label
612 :type 'notmuch-show-part-button-type
613 :notmuch-part-hidden nil)
616 (defun notmuch-show-toggle-part-invisibility (&optional button)
618 (let ((button (or button (button-at (point)))))
620 (let ((overlay (button-get button 'overlay))
621 (lazy-part (button-get button :notmuch-lazy-part)))
622 ;; We have a part to toggle if there is an overlay or if there
623 ;; is a lazy part. If neither is present we cannot toggle the
624 ;; part so we just return nil.
625 (when (or overlay lazy-part)
626 (let* ((show (button-get button :notmuch-part-hidden))
627 (new-start (button-start button))
628 (button-label (button-get button :base-label))
630 (properties (text-properties-at (button-start button)))
631 (inhibit-read-only t))
632 ;; Toggle the button itself.
633 (button-put button :notmuch-part-hidden (not show))
634 (goto-char new-start)
635 (insert "[ " button-label (if show " ]" " (hidden) ]"))
636 (set-text-properties new-start (point) properties)
637 (let ((old-end (button-end button)))
638 (move-overlay button new-start (point))
639 (delete-region (point) old-end))
640 (goto-char (min old-point (1- (button-end button))))
641 ;; Return nil if there is a lazy-part, it is empty, and we are
642 ;; trying to show it. In all other cases return t.
645 (button-put button :notmuch-lazy-part nil)
646 (notmuch-show-lazy-part lazy-part button))
647 ;; else there must be an overlay.
648 (overlay-put overlay 'invisible (not show))
651 ;;; Part content ID handling
653 (defvar notmuch-show--cids nil
654 "Alist from raw content ID to (MSG PART).")
655 (make-variable-buffer-local 'notmuch-show--cids)
657 (defun notmuch-show--register-cids (msg part)
658 "Register content-IDs in PART and all of PART's sub-parts."
659 (let ((content-id (plist-get part :content-id)))
661 ;; Note that content-IDs are globally unique, except when they
662 ;; aren't: RFC 2046 section 5.1.4 permits children of a
663 ;; multipart/alternative to have the same content-ID, in which
664 ;; case the MUA is supposed to pick the best one it can render.
665 ;; We simply add the content-ID to the beginning of our alist;
666 ;; so if this happens, we'll take the last (and "best")
667 ;; alternative (even if we can't render it).
668 (push (list content-id msg part) notmuch-show--cids)))
669 ;; Recurse on sub-parts
670 (when-let ((type (plist-get part :content-type)))
671 (pcase-let ((`(,type ,subtype)
672 (split-string (downcase type) "/")))
673 (cond ((equal type "multipart")
674 (mapc (apply-partially #'notmuch-show--register-cids msg)
675 (plist-get part :content)))
676 ((and (equal type "message")
677 (equal subtype "rfc822"))
678 (notmuch-show--register-cids
680 (car (plist-get (car (plist-get part :content)) :body))))))))
682 (defun notmuch-show--get-cid-content (cid)
683 "Return a list (CID-content content-type) or nil.
685 This will only find parts from messages that have been inserted
686 into the current buffer. CID must be a raw content ID, without
687 enclosing angle brackets, a cid: prefix, or URL encoding. This
688 will return nil if the CID is unknown or cannot be retrieved."
689 (when-let ((descriptor (cdr (assoc cid notmuch-show--cids))))
690 (pcase-let ((`(,msg ,part) descriptor))
691 ;; Request caching for this content, as some messages
692 ;; reference the same cid: part many times (hundreds!).
693 (list (notmuch-get-bodypart-binary
694 msg part notmuch-show-process-crypto 'cache)
695 (plist-get part :content-type)))))
697 (defun notmuch-show-setup-w3m ()
698 "Instruct w3m how to retrieve content from a \"related\" part of a message."
700 (when (and (boundp 'w3m-cid-retrieve-function-alist)
701 (not (assq 'notmuch-show-mode w3m-cid-retrieve-function-alist)))
702 (push (cons 'notmuch-show-mode #'notmuch-show--cid-w3m-retrieve)
703 w3m-cid-retrieve-function-alist))
704 (setq mm-html-inhibit-images nil))
706 (defvar w3m-current-buffer) ;; From `w3m.el'.
707 (defun notmuch-show--cid-w3m-retrieve (url &rest _args)
708 ;; url includes the cid: prefix and is URL encoded (see RFC 2392).
709 (let* ((cid (url-unhex-string (substring url 4)))
711 (with-current-buffer w3m-current-buffer
712 (notmuch-show--get-cid-content cid))))
713 (when content-and-type
714 (insert (car content-and-type))
715 (cadr content-and-type))))
717 ;; MIME part renderers
719 (defun notmuch-show-multipart/*-to-list (part)
720 (mapcar (lambda (inner-part) (plist-get inner-part :content-type))
721 (plist-get part :content)))
723 (defun notmuch-show-insert-part-multipart/alternative (msg part _content-type _nth depth _button)
724 (let ((chosen-type (car (notmuch-multipart/alternative-choose
725 msg (notmuch-show-multipart/*-to-list part))))
726 (inner-parts (plist-get part :content))
728 ;; This inserts all parts of the chosen type rather than just one,
729 ;; but it's not clear that this is the wrong thing to do - which
730 ;; should be chosen if there are more than one that match?
731 (mapc (lambda (inner-part)
732 (let* ((inner-type (plist-get inner-part :content-type))
733 (hide (not (or notmuch-show-all-multipart/alternative-parts
734 (string= chosen-type inner-type)))))
735 (notmuch-show-insert-bodypart msg inner-part depth hide)))
738 (when notmuch-show-indent-multipart
739 (indent-rigidly start (point) 1)))
742 (defun notmuch-show-insert-part-multipart/related (msg part _content-type _nth depth _button)
743 (let ((inner-parts (plist-get part :content))
745 ;; Render the primary part. FIXME: Support RFC 2387 Start header.
746 (notmuch-show-insert-bodypart msg (car inner-parts) depth)
747 ;; Add hidden buttons for the rest
748 (mapc (lambda (inner-part)
749 (notmuch-show-insert-bodypart msg inner-part depth t))
751 (when notmuch-show-indent-multipart
752 (indent-rigidly start (point) 1)))
755 (defun notmuch-show-insert-part-multipart/signed (msg part _content-type _nth depth button)
757 (button-put button 'face 'notmuch-crypto-part-header))
758 ;; Insert a button detailing the signature status.
759 (notmuch-crypto-insert-sigstatus-button (car (plist-get part :sigstatus))
760 (notmuch-show-get-header :From msg))
761 (let ((inner-parts (plist-get part :content))
763 ;; Show all of the parts.
764 (mapc (lambda (inner-part)
765 (notmuch-show-insert-bodypart msg inner-part depth))
767 (when notmuch-show-indent-multipart
768 (indent-rigidly start (point) 1)))
771 (defun notmuch-show-insert-part-multipart/encrypted (msg part _content-type _nth depth button)
773 (button-put button 'face 'notmuch-crypto-part-header))
774 ;; Insert a button detailing the encryption status.
775 (notmuch-crypto-insert-encstatus-button (car (plist-get part :encstatus)))
776 ;; Insert a button detailing the signature status.
777 (notmuch-crypto-insert-sigstatus-button (car (plist-get part :sigstatus))
778 (notmuch-show-get-header :From msg))
779 (let ((inner-parts (plist-get part :content))
781 ;; Show all of the parts.
782 (mapc (lambda (inner-part)
783 (notmuch-show-insert-bodypart msg inner-part depth))
785 (when notmuch-show-indent-multipart
786 (indent-rigidly start (point) 1)))
789 (defun notmuch-show-insert-part-application/pgp-encrypted (_msg _part _content-type _nth _depth _button)
792 (defun notmuch-show-insert-part-multipart/* (msg part _content-type _nth depth _button)
793 (let ((inner-parts (plist-get part :content))
795 ;; Show all of the parts.
796 (mapc (lambda (inner-part)
797 (notmuch-show-insert-bodypart msg inner-part depth))
799 (when notmuch-show-indent-multipart
800 (indent-rigidly start (point) 1)))
803 (defun notmuch-show-insert-part-message/rfc822 (msg part _content-type _nth depth _button)
804 (let ((message (car (plist-get part :content))))
807 (let ((body (car (plist-get message :body)))
809 ;; Override `notmuch-message-headers' to force `From' to be
811 (let ((notmuch-message-headers '("From" "Subject" "To" "Cc" "Date")))
812 (notmuch-show-insert-headers (plist-get message :headers)))
813 ;; Blank line after headers to be compatible with the normal
817 (notmuch-show-insert-bodypart msg body depth)
818 (when notmuch-show-indent-multipart
819 (indent-rigidly start (point) 1))
822 (defun notmuch-show-insert-part-text/plain (msg part _content-type _nth depth button)
823 ;; For backward compatibility we want to apply the text/plain hook
824 ;; to the whole of the part including the part button if there is
826 (let ((start (if button
827 (button-start button)
829 (insert (notmuch-get-bodypart-text msg part notmuch-show-process-crypto))
832 (narrow-to-region start (point-max))
833 (run-hook-with-args 'notmuch-show-insert-text/plain-hook msg depth))))
836 (defun notmuch-show-insert-part-text/calendar (msg part _content-type _nth _depth _button)
837 (insert (with-temp-buffer
838 (insert (notmuch-get-bodypart-text msg part notmuch-show-process-crypto))
839 ;; notmuch-get-bodypart-text does no newline conversion.
840 ;; Replace CRLF with LF before icalendar can use it.
841 (goto-char (point-min))
842 (while (re-search-forward "\r\n" nil t)
843 (replace-match "\n" nil nil))
844 (let ((file (make-temp-file "notmuch-ical"))
848 (unless (icalendar-import-buffer file t)
849 (error "Icalendar import error. %s"
850 "See *icalendar-errors* for more information"))
851 (set-buffer (get-file-buffer file))
852 (setq result (buffer-substring (point-min) (point-max)))
853 (set-buffer-modified-p nil)
854 (kill-buffer (current-buffer)))
859 ;; For backwards compatibility.
860 (defun notmuch-show-insert-part-text/x-vcalendar (msg part _content-type _nth depth _button)
861 (notmuch-show-insert-part-text/calendar msg part nil nil depth nil))
863 (when (version< emacs-version "25.3")
864 ;; https://bugs.gnu.org/28350
866 ;; For newer emacs, we fall back to notmuch-show-insert-part-*/*
867 ;; (see notmuch-show-handlers-for)
868 (defun notmuch-show-insert-part-text/enriched
869 (msg part content-type nth depth button)
870 ;; By requiring enriched below, we ensure that the function
871 ;; enriched-decode-display-prop is defined before it will be
872 ;; shadowed by the letf below. Otherwise the version in
873 ;; enriched.el may be loaded a bit later and used instead (for
876 (cl-letf (((symbol-function 'enriched-decode-display-prop)
877 (lambda (start end &optional _param) (list start end))))
878 (notmuch-show-insert-part-*/* msg part content-type nth depth button))))
880 (defun notmuch-show-get-mime-type-of-application/octet-stream (part)
881 ;; If we can deduce a MIME type from the filename of the attachment,
883 (and (plist-get part :filename)
884 (let ((extension (file-name-extension (plist-get part :filename))))
887 (mailcap-parse-mimetypes)
888 (let ((mime-type (mailcap-extension-to-mime extension)))
890 (not (string-equal mime-type "application/octet-stream"))
893 (defun notmuch-show-insert-part-text/html (msg part content-type nth depth button)
894 (if (eq mm-text-html-renderer 'shr)
895 ;; It's easier to drive shr ourselves than to work around the
896 ;; goofy things `mm-shr' does (like irreversibly taking over
897 ;; content ID handling).
898 ;; FIXME: If we block an image, offer a button to load external
900 (let ((shr-blocked-images notmuch-show-text/html-blocked-images))
901 (notmuch-show--insert-part-text/html-shr msg part))
902 ;; Otherwise, let message-mode do the heavy lifting
904 ;; w3m sets up a keymap which "leaks" outside the invisible region
905 ;; and causes strange effects in notmuch. We set
906 ;; mm-inline-text-html-with-w3m-keymap to nil to tell w3m not to
907 ;; set a keymap (so the normal notmuch-show-mode-map remains).
908 (let ((mm-inline-text-html-with-w3m-keymap nil)
909 ;; FIXME: If we block an image, offer a button to load external
911 (gnus-blocked-images notmuch-show-text/html-blocked-images)
912 (w3m-ignored-image-url-regexp notmuch-show-text/html-blocked-images))
913 (notmuch-show-insert-part-*/* msg part content-type nth depth button))))
915 ;;; Functions used by notmuch-show--insert-part-text/html-shr
917 (declare-function libxml-parse-html-region "xml.c")
918 (declare-function shr-insert-document "shr")
920 (defun notmuch-show--insert-part-text/html-shr (msg part)
921 ;; Make sure shr is loaded before we start let-binding its globals
923 (let ((dom (let ((process-crypto notmuch-show-process-crypto))
925 (insert (notmuch-get-bodypart-text msg part process-crypto))
926 (libxml-parse-html-region (point-min) (point-max)))))
927 (shr-content-function
929 ;; shr strips the "cid:" part of URL, but doesn't
930 ;; URL-decode it (see RFC 2392).
931 (let ((cid (url-unhex-string url)))
932 (car (notmuch-show--get-cid-content cid))))))
933 (shr-insert-document dom)
936 (defun notmuch-show-insert-part-*/* (msg part content-type _nth _depth _button)
937 ;; This handler _must_ succeed - it is the handler of last resort.
938 (notmuch-mm-display-part-inline msg part content-type notmuch-show-process-crypto)
941 ;;; Functions for determining how to handle MIME parts.
943 (defun notmuch-show-handlers-for (content-type)
944 "Return a list of content handlers for a part of type CONTENT-TYPE."
947 (when (functionp func)
949 ;; Reverse order of prefrence.
950 (list (intern (concat "notmuch-show-insert-part-*/*"))
951 (intern (concat "notmuch-show-insert-part-"
952 (car (split-string content-type "/"))
954 (intern (concat "notmuch-show-insert-part-" content-type))))
959 (defun notmuch-show-insert-bodypart-internal (msg part content-type nth depth button)
960 ;; Run the handlers until one of them succeeds.
961 (cl-loop for handler in (notmuch-show-handlers-for content-type)
962 until (condition-case err
963 (funcall handler msg part content-type nth depth button)
964 ;; Specifying `debug' here lets the debugger run if
965 ;; `debug-on-error' is non-nil.
967 (insert "!!! Bodypart handler `" (prin1-to-string handler)
968 "' threw an error:\n"
969 "!!! " (error-message-string err) "\n")
972 (defun notmuch-show-create-part-overlays (button beg end)
973 "Add an overlay to the part between BEG and END."
974 ;; If there is no button (i.e., the part is text/plain and the first
975 ;; part) or if the part has no content then we don't make the part
977 (when (and button (/= beg end))
978 (button-put button 'overlay (make-overlay beg end))
979 ;; Return true if we created an overlay.
982 (defun notmuch-show-record-part-information (part beg end)
983 "Store PART as a text property from BEG to END."
984 ;; Record part information. Since we already inserted subparts,
985 ;; don't override existing :notmuch-part properties.
986 (notmuch-map-text-property beg end :notmuch-part
987 (lambda (v) (or v part)))
988 ;; Make :notmuch-part front sticky and rear non-sticky so it stays
989 ;; applied to the beginning of each line when we indent the
990 ;; message. Since we're operating on arbitrary renderer output,
991 ;; watch out for sticky specs of t, which means all properties are
992 ;; front-sticky/rear-nonsticky.
993 (notmuch-map-text-property beg end 'front-sticky
996 (cl-pushnew :notmuch-part v)
998 (notmuch-map-text-property beg end 'rear-nonsticky
1001 (cl-pushnew :notmuch-part v)
1004 (defun notmuch-show-lazy-part (part-args button)
1005 ;; Insert the lazy part after the button for the part. We would just
1006 ;; move to the start of the new line following the button and insert
1007 ;; the part but that point might have text properties (eg colours
1008 ;; from a message header etc) so instead we start from the last
1009 ;; character of the button by adding a newline and finish by
1010 ;; removing the extra newline from the end of the part.
1012 (goto-char (button-end button))
1014 (let* ((inhibit-read-only t)
1015 ;; We need to use markers for the start and end of the part
1016 ;; because the part insertion functions do not guarantee
1017 ;; to leave point at the end of the part.
1018 (part-beg (copy-marker (point) nil))
1019 (part-end (copy-marker (point) t))
1020 ;; We have to save the depth as we can't find the depth
1022 (depth (notmuch-show-get-depth)))
1024 (narrow-to-region part-beg part-end)
1025 (delete-region part-beg part-end)
1026 (apply #'notmuch-show-insert-bodypart-internal part-args)
1027 (indent-rigidly part-beg
1029 (* notmuch-show-indent-messages-width depth)))
1030 (goto-char part-end)
1032 (notmuch-show-record-part-information (cadr part-args)
1033 (button-start button)
1035 ;; Create the overlay. If the lazy-part turned out to be empty/not
1036 ;; showable this returns nil.
1037 (notmuch-show-create-part-overlays button part-beg part-end))))
1039 (defun notmuch-show-mime-type (part)
1040 "Return the correct mime-type to use for PART."
1041 (when-let ((content-type (plist-get part :content-type)))
1042 (setq content-type (downcase content-type))
1043 (or (and (string= content-type "application/octet-stream")
1044 (notmuch-show-get-mime-type-of-application/octet-stream part))
1045 (and (string= content-type "inline patch")
1049 ;; The following variable can be overridden by let bindings.
1050 (defvar notmuch-show-insert-header-p-function 'notmuch-show-insert-header-p
1051 "Specify which function decides which part headers get inserted.
1053 The function should take two parameters, PART and HIDE, and
1054 should return non-NIL if a header button should be inserted for
1057 (defun notmuch-show-insert-header-p (part _hide)
1058 ;; Show all part buttons except for the first part if it is text/plain.
1059 (let ((mime-type (notmuch-show-mime-type part)))
1060 (not (and (string= mime-type "text/plain")
1061 (<= (plist-get part :id) 1)))))
1063 (defun notmuch-show-reply-insert-header-p-never (_part _hide)
1066 (defun notmuch-show-reply-insert-header-p-trimmed (part hide)
1067 (let ((mime-type (notmuch-show-mime-type part)))
1068 (and (not (notmuch-match-content-type mime-type "multipart/*"))
1071 (defun notmuch-show-reply-insert-header-p-minimal (part hide)
1072 (let ((mime-type (notmuch-show-mime-type part)))
1073 (and (notmuch-match-content-type mime-type "text/*")
1076 (defun notmuch-show-insert-bodypart (msg part depth &optional hide)
1077 "Insert the body part PART at depth DEPTH in the current thread.
1079 HIDE determines whether to show or hide the part and the button
1080 as follows: If HIDE is nil, show the part and the button. If HIDE
1081 is t, hide the part initially and show the button."
1082 (let* ((content-type (plist-get part :content-type))
1083 (mime-type (notmuch-show-mime-type part))
1084 (nth (plist-get part :id))
1085 (height (plist-get msg :height))
1086 (long (and (notmuch-match-content-type mime-type "text/*")
1087 (> notmuch-show-max-text-part-size 0)
1088 (> (length (plist-get part :content))
1089 notmuch-show-max-text-part-size)))
1090 (deep (and notmuch-show-depth-limit
1091 (> depth notmuch-show-depth-limit)))
1092 (high (and notmuch-show-height-limit
1093 (> height notmuch-show-height-limit)))
1095 ;; This default header-p function omits the part button for
1096 ;; the first (or only) part if this is text/plain.
1097 (button (and (or deep long high
1098 (funcall notmuch-show-insert-header-p-function part hide))
1099 (notmuch-show-insert-part-header
1101 (and content-type (downcase content-type))
1102 (plist-get part :filename))))
1103 ;; Hide the part initially if HIDE is t, or if it is too long/deep
1104 ;; and we have a button to allow toggling.
1105 (show-part (not (or (equal hide t)
1108 (and long button))))
1109 (content-beg (point)))
1110 ;; Store the computed mime-type for later use (e.g. by attachment handlers).
1111 (plist-put part :computed-type mime-type)
1113 (notmuch-show-insert-bodypart-internal msg part mime-type nth depth button)
1115 (button-put button :notmuch-lazy-part
1116 (list msg part mime-type nth depth button))))
1117 ;; Some of the body part handlers leave point somewhere up in the
1118 ;; part, so we make sure that we're down at the end.
1119 (goto-char (point-max))
1120 ;; Ensure that the part ends with a carriage return.
1123 ;; We do not create the overlay for hidden (lazy) parts until
1124 ;; they are inserted.
1126 (notmuch-show-create-part-overlays button content-beg (point))
1128 (notmuch-show-toggle-part-invisibility button)))
1129 (notmuch-show-record-part-information part beg (point))))
1131 (defun notmuch-show-insert-body (msg body depth)
1132 "Insert the body BODY at depth DEPTH in the current thread."
1133 ;; Register all content IDs for this message. According to RFC
1134 ;; 2392, content IDs are *global*, but it's okay if an MUA treats
1135 ;; them as only global within a message.
1136 (notmuch-show--register-cids msg (car body))
1137 (mapc (lambda (part) (notmuch-show-insert-bodypart msg part depth)) body))
1139 (defun notmuch-show-make-symbol (type)
1140 (make-symbol (concat "notmuch-show-" type)))
1142 (defun notmuch-show-strip-re (string)
1143 (replace-regexp-in-string "^\\([Rr]e: *\\)+" "" string))
1145 (defvar notmuch-show-previous-subject "")
1146 (make-variable-buffer-local 'notmuch-show-previous-subject)
1148 (defun notmuch-show-choose-duplicate (duplicate)
1149 "Display message file with index DUPLICATE in place of the current one.
1151 Message file indices are based on the order the files are
1152 discovered by `notmuch new' (and hence are somewhat arbitrary),
1153 and correspond to those passed to the \"\\-\\-duplicate\" arguments
1156 When called interactively, the function will prompt for the index
1157 of the file to display. An error will be signaled if the index
1159 (interactive "Nduplicate: ")
1160 (let ((count (length (notmuch-show-get-prop :filename))))
1161 (when (or (> duplicate count)
1163 (error "Duplicate %d out of range [1,%d]" duplicate count)))
1164 (notmuch-show-move-to-message-top)
1166 (let* ((extent (notmuch-show-message-extent))
1167 (id (notmuch-show-get-message-id))
1168 (depth (notmuch-show-get-depth))
1169 (inhibit-read-only t)
1170 (new-msg (notmuch--run-show (list id) duplicate)))
1171 ;; clean up existing overlays to avoid extending them.
1172 (dolist (o (overlays-in (car extent) (cdr extent)))
1174 ;; pretend insertion is happening at end of buffer
1175 (narrow-to-region (point-min) (car extent))
1176 ;; Insert first, then delete, to avoid marker for start of next
1177 ;; message being in same place as the start of this one.
1178 (notmuch-show-insert-msg new-msg depth)
1180 (delete-region (point) (cdr extent)))))
1182 (defun notmuch-show-insert-msg (msg depth)
1183 "Insert the message MSG at depth DEPTH in the current thread."
1184 (let* ((headers (plist-get msg :headers))
1185 ;; Indentation causes the buffer offset of the start/end
1186 ;; points to move, so we must use markers.
1187 message-start message-end
1188 content-start content-end
1189 headers-start headers-end
1190 (bare-subject (notmuch-show-strip-re (plist-get headers :Subject))))
1191 (setq message-start (point-marker))
1192 (notmuch-show-insert-headerline msg depth (plist-get msg :tags))
1193 (setq content-start (point-marker))
1194 ;; Set `headers-start' to point after the 'Subject:' header to be
1195 ;; compatible with the existing implementation. This just sets it
1196 ;; to after the first header.
1197 (notmuch-show-insert-headers headers)
1199 (goto-char content-start)
1200 ;; If the subject of this message is the same as that of the
1201 ;; previous message, don't display it when this message is
1203 (unless (string= notmuch-show-previous-subject bare-subject)
1205 (setq headers-start (point-marker)))
1206 (setq headers-end (point-marker))
1207 (setq notmuch-show-previous-subject bare-subject)
1208 ;; A blank line between the headers and the body.
1210 (notmuch-show-insert-body msg (plist-get msg :body)
1211 (if notmuch-show-indent-content depth 0))
1212 ;; Ensure that the body ends with a newline.
1215 (setq content-end (point-marker))
1216 ;; Indent according to the depth in the thread.
1217 (when notmuch-show-indent-content
1218 (indent-rigidly content-start
1220 (* notmuch-show-indent-messages-width depth)))
1221 (setq message-end (point-max-marker))
1222 ;; Save the extents of this message over the whole text of the
1224 (put-text-property message-start message-end
1225 :notmuch-message-extent
1226 (cons message-start message-end))
1227 ;; Create overlays used to control visibility
1228 (plist-put msg :headers-overlay (make-overlay headers-start headers-end))
1229 (plist-put msg :message-overlay (make-overlay headers-start content-end))
1230 (plist-put msg :depth depth)
1231 ;; Save the properties for this message. Currently this saves the
1232 ;; entire message (augmented it with other stuff), which seems
1233 ;; like overkill. We might save a reduced subset (for example, not
1235 (notmuch-show-set-message-properties msg)
1236 ;; Set header visibility.
1237 (notmuch-show-headers-visible msg notmuch-message-headers-visible)
1238 ;; Message visibility depends on whether it matched the search
1240 (notmuch-show-message-visible msg (and (plist-get msg :match)
1241 (not (plist-get msg :excluded))))))
1245 (defun notmuch-show-toggle-process-crypto ()
1246 "Toggle the processing of cryptographic MIME parts."
1248 (setq notmuch-show-process-crypto (not notmuch-show-process-crypto))
1249 (message (if notmuch-show-process-crypto
1250 "Processing cryptographic MIME parts."
1251 "Not processing cryptographic MIME parts."))
1252 (notmuch-show-refresh-view))
1254 (defun notmuch-show-toggle-elide-non-matching ()
1255 "Toggle the display of non-matching messages."
1257 (setq notmuch-show-elide-non-matching-messages
1258 (not notmuch-show-elide-non-matching-messages))
1259 (message (if notmuch-show-elide-non-matching-messages
1260 "Showing matching messages only."
1261 "Showing all messages."))
1262 (notmuch-show-refresh-view))
1264 (defun notmuch-show-toggle-thread-indentation ()
1265 "Toggle the indentation of threads."
1267 (setq notmuch-show-indent-content (not notmuch-show-indent-content))
1268 (message (if notmuch-show-indent-content
1269 "Content is indented."
1270 "Content is not indented."))
1271 (notmuch-show-refresh-view))
1273 ;;; Main insert functions
1275 (defun notmuch-show-insert-tree (tree depth)
1276 "Insert the message tree TREE at depth DEPTH in the current thread."
1277 (let ((msg (car tree))
1278 (replies (cadr tree)))
1279 ;; We test whether there is a message or just some replies.
1281 (notmuch-show--mark-height tree)
1282 (notmuch-show-insert-msg msg depth))
1283 (notmuch-show-insert-thread replies (1+ depth))))
1285 (defun notmuch-show-insert-thread (thread depth)
1286 "Insert the thread THREAD at depth DEPTH in the current forest."
1287 (mapc (lambda (tree) (notmuch-show-insert-tree tree depth)) thread))
1289 (defun notmuch-show-insert-forest (forest)
1290 "Insert the forest of threads FOREST."
1291 (mapc (lambda (thread) (notmuch-show-insert-thread thread 0)) forest))
1295 (defvar notmuch-id-regexp
1297 ;; Match the id: prefix only if it begins a word (to disallow, for
1298 ;; example, matching cid:).
1300 ;; If the term starts with a ", then parse Xapian's quoted boolean
1301 ;; term syntax, which allows for anything as long as embedded
1302 ;; double quotes escaped by doubling them. We also disallow
1303 ;; newlines (which Xapian allows) to prevent runaway terms.
1304 "\"\\([^\"\n]\\|\"\"\\)*\""
1305 ;; Otherwise, parse Xapian's unquoted syntax, which goes up to the
1306 ;; next space or ). We disallow [.,;] as the last character
1307 ;; because these are probably part of the surrounding text, and not
1308 ;; part of the id. This doesn't match single character ids; meh.
1309 "\\|[^\"[:space:])][^[:space:])]*[^])[:space:].,:;?!]"
1311 "The regexp used to match id: links in messages.")
1313 (defvar notmuch-mid-regexp
1314 ;; goto-address-url-regexp matched cid: links, which have the same
1315 ;; grammar as the message ID part of a mid: link. Construct the
1316 ;; regexp using the same technique as goto-address-url-regexp.
1317 (concat "\\<mid:\\(" thing-at-point-url-path-regexp "\\)")
1318 "The regexp used to match mid: links in messages.
1322 (defun notmuch-show-buttonise-links (start end)
1323 "Buttonise URLs and mail addresses between START and END.
1325 This also turns id:\"<message id>\"-parts and mid: links into
1326 buttons for a corresponding notmuch search."
1327 (goto-address-fontify-region start end)
1330 (beg-line (progn (goto-char start) (line-beginning-position)))
1331 (end-line (progn (goto-char end) (line-end-position))))
1332 (goto-char beg-line)
1333 (while (re-search-forward notmuch-id-regexp end-line t)
1334 (push (list (match-beginning 0) (match-end 0)
1335 (match-string-no-properties 0)) links))
1336 (goto-char beg-line)
1337 (while (re-search-forward notmuch-mid-regexp end-line t)
1338 (let* ((mid-cid (match-string-no-properties 1))
1339 (mid (save-match-data
1340 (string-match "^[^/]*" mid-cid)
1341 (url-unhex-string (match-string 0 mid-cid)))))
1342 (push (list (match-beginning 0) (match-end 0)
1343 (notmuch-id-to-query mid)) links)))
1344 (pcase-dolist (`(,beg ,end ,link) links)
1345 ;; Remove the overlay created by goto-address-mode
1346 (remove-overlays beg end 'goto-address t)
1347 (make-text-button beg end
1348 :type 'notmuch-button-type
1349 'action `(lambda (arg)
1350 (notmuch-show ,link current-prefix-arg))
1352 'help-echo "Mouse-1, RET: search for this message"
1353 'face goto-address-mail-face)))))
1358 (defun notmuch-show (thread-id &optional elide-toggle parent-buffer query-context buffer-name)
1359 "Run \"notmuch show\" with the given thread ID and display results.
1361 ELIDE-TOGGLE, if non-nil, inverts the default elide behavior.
1363 The optional PARENT-BUFFER is the notmuch-search buffer from
1364 which this notmuch-show command was executed, (so that the
1365 next thread from that buffer can be show when done with this
1368 The optional QUERY-CONTEXT is a notmuch search term. Only
1369 messages from the thread matching this search term are shown if
1372 The optional BUFFER-NAME provides the name of the buffer in
1373 which the message thread is shown. If it is nil (which occurs
1374 when the command is called interactively) the argument to the
1377 Returns the buffer containing the messages, or NIL if no messages
1379 (interactive "sNotmuch show: \nP")
1380 (let ((buffer-name (generate-new-buffer-name
1382 (concat "*notmuch-" thread-id "*"))))
1383 (mm-inline-override-types (notmuch--inline-override-types)))
1385 (pop-to-buffer-same-window (get-buffer-create buffer-name))
1386 ;; No need to track undo information for this buffer.
1387 (setq buffer-undo-list t)
1389 ;; Set various buffer local variables to their appropriate initial
1390 ;; state. Do this after enabling `notmuch-show-mode' so that they
1391 ;; aren't wiped out.
1392 (setq notmuch-show-thread-id thread-id)
1393 (setq notmuch-show-parent-buffer parent-buffer)
1394 (setq notmuch-show-query-context
1395 (if (or (string= query-context "")
1396 (string= query-context "*"))
1399 (setq notmuch-show-process-crypto notmuch-crypto-process-mime)
1400 ;; If `elide-toggle', invert the default value.
1401 (setq notmuch-show-elide-non-matching-messages
1403 (not notmuch-show-only-matching-messages)
1404 notmuch-show-only-matching-messages))
1405 (add-hook 'post-command-hook #'notmuch-show-command-hook nil t)
1406 (jit-lock-register #'notmuch-show-buttonise-links)
1407 (notmuch-tag-clear-cache)
1408 (let ((inhibit-read-only t))
1409 (if (notmuch-show--build-buffer)
1410 ;; Messages were inserted into the buffer.
1412 ;; No messages were inserted - presumably none matched the
1414 (kill-buffer (current-buffer))
1416 (message "No messages matched the query!")
1419 (defun notmuch-show--build-queries (thread context)
1420 "Return a list of queries to try for this search.
1422 THREAD and CONTEXT are both strings, though CONTEXT may be nil.
1423 When CONTEXT is not nil, the first query is the conjunction of it
1424 and THREAD. The next query is THREAD alone, and serves as a
1425 fallback if the prior matches no messages."
1427 (push (list thread) queries)
1429 (push (list thread "and (" context ")") queries))
1432 (defun notmuch-show--header-line-format ()
1433 "Compute the header line format of a notmuch-show buffer."
1434 (when notmuch-show-header-line
1435 (let* ((s (notmuch-sanitize
1436 (notmuch-show-strip-re (notmuch-show-get-subject))))
1437 (subject (replace-regexp-in-string "%" "%%" s)))
1438 (cond ((stringp notmuch-show-header-line)
1439 (format-spec notmuch-show-header-line `((?s . ,subject))))
1440 ((functionp notmuch-show-header-line)
1441 (funcall notmuch-show-header-line subject))
1442 (notmuch-show-header-line subject)))))
1444 (defun notmuch-show--build-buffer (&optional state)
1445 "Display messages matching the current buffer context.
1447 Apply the previously saved STATE if supplied, otherwise show the
1448 first relevant message.
1450 If no messages match the query return NIL."
1451 (let* ((cli-args (list "--exclude=false"))
1452 (cli-args (if notmuch-show-elide-non-matching-messages (cons "--entire-thread=false" cli-args) cli-args))
1453 ;; "part 0 is the whole message (headers and body)" notmuch-show(1)
1454 (cli-args (if notmuch-show-single-message (cons "--part=0" cli-args) cli-args))
1455 (queries (notmuch-show--build-queries
1456 notmuch-show-thread-id notmuch-show-query-context))
1458 ;; Must be reset every time we are going to start inserting
1459 ;; messages into the buffer.
1460 (notmuch-show-previous-subject ""))
1461 ;; Use results from the first query that returns some.
1462 (while (and (not forest) queries)
1463 (setq forest (notmuch--run-show
1464 (append cli-args (list "'") (car queries) (list "'"))))
1465 (when (and forest notmuch-show-single-message)
1466 (setq forest (list (list (list forest)))))
1467 (setq queries (cdr queries)))
1469 (notmuch-show-insert-forest forest)
1470 ;; Store the original tags for each message so that we can
1473 (lambda () (notmuch-show-set-prop :orig-tags (notmuch-show-get-tags))))
1474 (setq header-line-format (notmuch-show--header-line-format))
1475 (run-hooks 'notmuch-show-hook)
1477 (notmuch-show-apply-state state)
1478 ;; With no state to apply, just go to the first message.
1479 (notmuch-show-goto-first-wanted-message)))
1480 ;; Report back to the caller whether any messages matched.
1485 (defun notmuch-show-capture-state ()
1486 "Capture the state of the current buffer.
1489 - the list of open messages,
1490 - the combination of current message id with/for each visible window."
1491 (let* ((win-list (get-buffer-window-list (current-buffer) nil t))
1492 (win-id-combo (mapcar (lambda (win)
1493 (with-selected-window win
1494 (list win (notmuch-show-get-message-id))))
1496 (list win-id-combo (notmuch-show-get-message-ids-for-open-messages))))
1498 (defun notmuch-show-get-query ()
1499 "Return the current query in this show buffer."
1500 (if notmuch-show-query-context
1501 (concat notmuch-show-thread-id
1503 notmuch-show-query-context
1505 notmuch-show-thread-id))
1507 (defun notmuch-show-goto-message (msg-id)
1508 "Go to message with msg-id."
1509 (goto-char (point-min))
1510 (unless (cl-loop if (string= msg-id (notmuch-show-get-message-id))
1512 until (not (notmuch-show-goto-message-next)))
1513 (goto-char (point-min))
1514 (message "Message-id not found."))
1515 (notmuch-show-message-adjust))
1517 (defun notmuch-show-apply-state (state)
1518 "Apply STATE to the current buffer.
1521 - opening the messages previously opened,
1522 - closing all other messages,
1523 - moving to the correct current message in every displayed window."
1524 (let ((win-msg-alist (car state))
1525 (open (cadr state)))
1526 ;; Open those that were open.
1527 (goto-char (point-min))
1528 (cl-loop do (notmuch-show-message-visible
1529 (notmuch-show-get-message-properties)
1530 (member (notmuch-show-get-message-id) open))
1531 until (not (notmuch-show-goto-message-next)))
1532 (dolist (win-msg-pair win-msg-alist)
1533 (with-selected-window (car win-msg-pair)
1534 ;; Go to the previously open message in this window
1535 (notmuch-show-goto-message (cadr win-msg-pair))))))
1537 (defun notmuch-show-refresh-view (&optional reset-state)
1538 "Refresh the current view.
1540 Refreshes the current view, observing changes in display
1541 preferences. If invoked with a prefix argument (or RESET-STATE is
1542 non-nil) then the state of the buffer (open/closed messages) is
1543 reset based on the original query."
1545 (let ((inhibit-read-only t)
1546 (mm-inline-override-types (notmuch--inline-override-types))
1547 (state (unless reset-state
1548 (notmuch-show-capture-state))))
1549 ;; `erase-buffer' does not seem to remove overlays, which can lead
1550 ;; to weird effects such as remaining images, so remove them
1554 (unless (notmuch-show--build-buffer state)
1555 ;; No messages were inserted.
1556 (kill-buffer (current-buffer))
1558 (message "Refreshing the buffer resulted in no messages!"))))
1562 (defvar notmuch-show-stash-map
1563 (let ((map (make-sparse-keymap)))
1564 (define-key map "c" 'notmuch-show-stash-cc)
1565 (define-key map "d" 'notmuch-show-stash-date)
1566 (define-key map "F" 'notmuch-show-stash-filename)
1567 (define-key map "f" 'notmuch-show-stash-from)
1568 (define-key map "i" 'notmuch-show-stash-message-id)
1569 (define-key map "I" 'notmuch-show-stash-message-id-stripped)
1570 (define-key map "s" 'notmuch-show-stash-subject)
1571 (define-key map "T" 'notmuch-show-stash-tags)
1572 (define-key map "t" 'notmuch-show-stash-to)
1573 (define-key map "l" 'notmuch-show-stash-mlarchive-link)
1574 (define-key map "L" 'notmuch-show-stash-mlarchive-link-and-go)
1575 (define-key map "G" 'notmuch-show-stash-git-send-email)
1576 (define-key map "?" 'notmuch-subkeymap-help)
1578 "Submap for stash commands.")
1579 (fset 'notmuch-show-stash-map notmuch-show-stash-map)
1581 (defvar notmuch-show-part-map
1582 (let ((map (make-sparse-keymap)))
1583 (define-key map "s" 'notmuch-show-save-part)
1584 (define-key map "v" 'notmuch-show-view-part)
1585 (define-key map "o" 'notmuch-show-interactively-view-part)
1586 (define-key map "|" 'notmuch-show-pipe-part)
1587 (define-key map "m" 'notmuch-show-choose-mime-of-part)
1588 (define-key map "?" 'notmuch-subkeymap-help)
1590 "Submap for part commands.")
1591 (fset 'notmuch-show-part-map notmuch-show-part-map)
1593 (defvar notmuch-show-mode-map
1594 (let ((map (make-sparse-keymap)))
1595 (set-keymap-parent map notmuch-common-keymap)
1596 (define-key map "Z" 'notmuch-tree-from-show-current-query)
1597 (define-key map "U" 'notmuch-unthreaded-from-show-current-query)
1598 (define-key map (kbd "<C-tab>") 'widget-backward)
1599 (define-key map (kbd "M-TAB") 'notmuch-show-previous-button)
1600 (define-key map (kbd "<backtab>") 'notmuch-show-previous-button)
1601 (define-key map (kbd "TAB") 'notmuch-show-next-button)
1602 (define-key map "f" 'notmuch-show-forward-message)
1603 (define-key map "F" 'notmuch-show-forward-open-messages)
1604 (define-key map "b" 'notmuch-show-resend-message)
1605 (define-key map "l" 'notmuch-show-filter-thread)
1606 (define-key map "r" 'notmuch-show-reply-sender)
1607 (define-key map "R" 'notmuch-show-reply)
1608 (define-key map "|" 'notmuch-show-pipe-message)
1609 (define-key map "w" 'notmuch-show-save-attachments)
1610 (define-key map "V" 'notmuch-show-view-raw-message)
1611 (define-key map "e" 'notmuch-show-resume-message)
1612 (define-key map "c" 'notmuch-show-stash-map)
1613 (define-key map "h" 'notmuch-show-toggle-visibility-headers)
1614 (define-key map "k" 'notmuch-tag-jump)
1615 (define-key map "*" 'notmuch-show-tag-all)
1616 (define-key map "-" 'notmuch-show-remove-tag)
1617 (define-key map "+" 'notmuch-show-add-tag)
1618 (define-key map "X" 'notmuch-show-archive-thread-then-exit)
1619 (define-key map "x" 'notmuch-show-archive-message-then-next-or-exit)
1620 (define-key map "A" 'notmuch-show-archive-thread-then-next)
1621 (define-key map "a" 'notmuch-show-archive-message-then-next-or-next-thread)
1622 (define-key map "N" 'notmuch-show-next-message)
1623 (define-key map "P" 'notmuch-show-previous-message)
1624 (define-key map "n" 'notmuch-show-next-open-message)
1625 (define-key map "p" 'notmuch-show-previous-open-message)
1626 (define-key map (kbd "M-n") 'notmuch-show-next-thread-show)
1627 (define-key map (kbd "M-p") 'notmuch-show-previous-thread-show)
1628 (define-key map (kbd "DEL") 'notmuch-show-rewind)
1629 (define-key map " " 'notmuch-show-advance-and-archive)
1630 (define-key map (kbd "M-RET") 'notmuch-show-open-or-close-all)
1631 (define-key map (kbd "RET") 'notmuch-show-toggle-message)
1632 (define-key map "#" 'notmuch-show-print-message)
1633 (define-key map "!" 'notmuch-show-toggle-elide-non-matching)
1634 (define-key map "$" 'notmuch-show-toggle-process-crypto)
1635 (define-key map "%" 'notmuch-show-choose-duplicate)
1636 (define-key map "<" 'notmuch-show-toggle-thread-indentation)
1637 (define-key map "t" 'toggle-truncate-lines)
1638 (define-key map "." 'notmuch-show-part-map)
1639 (define-key map "B" 'notmuch-show-browse-urls)
1641 "Keymap for \"notmuch show\" buffers.")
1645 (define-derived-mode notmuch-show-mode fundamental-mode "notmuch-show"
1646 "Major mode for viewing a thread with notmuch.
1648 This buffer contains the results of the \"notmuch show\" command
1649 for displaying a single thread of email from your email archives.
1651 By default, various components of email messages, (citations,
1652 signatures, already-read messages), are hidden. You can make
1653 these parts visible by clicking with the mouse button or by
1654 pressing RET after positioning the cursor on a hidden part, (for
1655 which \\[notmuch-show-next-button] and \\[notmuch-show-previous-button] are helpful).
1657 Reading the thread sequentially is well-supported by pressing
1658 \\[notmuch-show-advance-and-archive]. This will scroll the current message (if necessary), advance
1659 to the next message, or advance to the next thread (if already on
1660 the last message of a thread).
1662 Other commands are available to read or manipulate the thread
1663 more selectively, (such as '\\[notmuch-show-next-message]' and '\\[notmuch-show-previous-message]' to advance to messages
1664 without removing any tags, and '\\[notmuch-show-archive-thread]' to archive an entire thread
1665 without scrolling through with \\[notmuch-show-advance-and-archive]).
1667 You can add or remove arbitrary tags from the current message with
1668 '\\[notmuch-show-add-tag]' or '\\[notmuch-show-remove-tag]'.
1670 All currently available key bindings:
1672 \\{notmuch-show-mode-map}"
1673 (setq notmuch-buffer-refresh-function #'notmuch-show-refresh-view)
1674 (setq buffer-read-only t)
1675 (setq truncate-lines t)
1676 (setq imenu-prev-index-position-function
1677 #'notmuch-show-imenu-prev-index-position-function)
1678 (setq imenu-extract-index-name-function
1679 #'notmuch-show-imenu-extract-index-name-function))
1683 (defun notmuch-tree-from-show-current-query ()
1684 "Call notmuch tree with the current query."
1686 (notmuch-tree notmuch-show-thread-id
1687 notmuch-show-query-context
1688 (notmuch-show-get-message-id)))
1690 (defun notmuch-unthreaded-from-show-current-query ()
1691 "Call notmuch unthreaded with the current query."
1693 (notmuch-unthreaded notmuch-show-thread-id
1694 notmuch-show-query-context
1695 (notmuch-show-get-message-id)))
1697 ;;; Movement related functions.
1699 (defun notmuch-show-move-to-message-top ()
1700 (goto-char (notmuch-show-message-top)))
1702 (defun notmuch-show-move-to-message-bottom ()
1703 (goto-char (notmuch-show-message-bottom)))
1705 ;; There's some strangeness here where a text property applied to a
1706 ;; region a->b is not found when point is at b. We walk backwards
1707 ;; until finding the property.
1708 (defun notmuch-show-message-extent ()
1709 "Return a cons cell containing the start and end buffer offset
1710 of the current message."
1713 (while (not (setq r (get-text-property (point) :notmuch-message-extent)))
1717 (defun notmuch-show-message-top ()
1718 (car (notmuch-show-message-extent)))
1720 (defun notmuch-show-message-bottom ()
1721 (cdr (notmuch-show-message-extent)))
1723 (defun notmuch-show-goto-message-next ()
1724 (let ((start (point)))
1725 (notmuch-show-move-to-message-bottom)
1731 (defun notmuch-show-goto-message-previous ()
1732 (notmuch-show-move-to-message-top)
1736 (notmuch-show-move-to-message-top)
1739 (defun notmuch-show-mapc (function)
1740 "Iterate through all messages in the current thread with
1741 `notmuch-show-goto-message-next' and call FUNCTION for side
1744 (goto-char (point-min))
1745 (cl-loop do (funcall function)
1746 while (notmuch-show-goto-message-next))))
1748 ;;; Functions relating to the visibility of messages and their components.
1750 (defun notmuch-show-message-visible (props visible-p)
1751 (overlay-put (plist-get props :message-overlay) 'invisible (not visible-p))
1752 (notmuch-show-set-prop :message-visible visible-p props))
1754 (defun notmuch-show-headers-visible (props visible-p)
1755 (overlay-put (plist-get props :headers-overlay) 'invisible (not visible-p))
1756 (notmuch-show-set-prop :headers-visible visible-p props))
1758 ;;; Functions for setting and getting attributes of the current message.
1760 (defun notmuch-show-set-message-properties (props)
1762 (notmuch-show-move-to-message-top)
1763 (put-text-property (point) (+ (point) 1)
1764 :notmuch-message-properties props)))
1766 (defun notmuch-show-get-message-properties ()
1767 "Return the properties of the current message as a plist.
1769 Some useful entries are:
1770 :headers - Property list containing the headers :Date, :Subject, :From, etc.
1771 :body - Body of the message
1772 :tags - Tags for this message"
1774 (notmuch-show-move-to-message-top)
1775 (get-text-property (point) :notmuch-message-properties)))
1777 (defun notmuch-show-get-part-properties ()
1778 "Return the properties of the innermost part containing point.
1780 This is the part property list retrieved from the CLI. Signals
1781 an error if there is no part containing point."
1782 (or (get-text-property (point) :notmuch-part)
1783 (error "No message part here")))
1785 (defun notmuch-show-set-prop (prop val &optional props)
1786 (let ((inhibit-read-only t)
1788 (notmuch-show-get-message-properties))))
1789 (plist-put props prop val)
1790 (notmuch-show-set-message-properties props)))
1792 (defun notmuch-show-get-prop (prop &optional props)
1793 "Get property PROP from current message in show or tree mode.
1795 It gets property PROP from PROPS or, if PROPS is nil, the current
1796 message in either tree or show. This means that several utility
1797 functions in notmuch-show can be used directly by notmuch-tree as
1798 they just need the correct message properties."
1799 (plist-get (or props
1800 (cond ((eq major-mode 'notmuch-show-mode)
1801 (notmuch-show-get-message-properties))
1802 ((eq major-mode 'notmuch-tree-mode)
1803 (notmuch-tree-get-message-properties))
1807 (defun notmuch-show-get-message-id (&optional bare)
1808 "Return an id: query for the Message-Id of the current message.
1810 If optional argument BARE is non-nil, return
1811 the Message-Id without id: prefix and escaping."
1813 (notmuch-show-get-prop :id)
1814 (notmuch-id-to-query (notmuch-show-get-prop :id))))
1816 (defun notmuch-show-get-messages-ids ()
1817 "Return all id: queries of messages in the current thread."
1818 (let ((message-ids))
1820 (lambda () (push (notmuch-show-get-message-id) message-ids)))
1823 (defun notmuch-show-get-messages-ids-search ()
1824 "Return a search string for all message ids of messages in the
1826 (mapconcat 'identity (notmuch-show-get-messages-ids) " or "))
1828 ;; dme: Would it make sense to use a macro for many of these?
1830 (defun notmuch-show-get-filename ()
1831 "Return the filename of the current message."
1832 (let ((duplicate (notmuch-show-get-duplicate)))
1833 (nth (1- duplicate) (notmuch-show-get-prop :filename))))
1835 (defun notmuch-show-get-header (header &optional props)
1836 "Return the named header of the current message, if any."
1837 (plist-get (notmuch-show-get-prop :headers props) header))
1839 (defun notmuch-show-get-cc ()
1840 (notmuch-show-get-header :Cc))
1842 (defun notmuch-show-get-date ()
1843 (notmuch-show-get-header :Date))
1845 (defun notmuch-show-get-duplicate ()
1846 ;; if no duplicate property exists, assume first file
1847 (or (notmuch-show-get-prop :duplicate) 1))
1849 (defun notmuch-show-get-timestamp ()
1850 (notmuch-show-get-prop :timestamp))
1852 (defun notmuch-show-get-from ()
1853 (notmuch-show-get-header :From))
1855 (defun notmuch-show-get-subject ()
1856 (notmuch-show-get-header :Subject))
1858 (defun notmuch-show-get-to ()
1859 (notmuch-show-get-header :To))
1861 (defun notmuch-show-get-depth ()
1862 (notmuch-show-get-prop :depth))
1864 (defun notmuch-show-set-tags (tags)
1865 "Set the tags of the current message."
1866 (notmuch-show-set-prop :tags tags)
1867 (notmuch-show-update-tags tags))
1869 (defun notmuch-show-get-tags ()
1870 "Return the tags of the current message."
1871 (notmuch-show-get-prop :tags))
1873 (defun notmuch-show-message-visible-p ()
1874 "Is the current message visible?"
1875 (notmuch-show-get-prop :message-visible))
1877 (defun notmuch-show-headers-visible-p ()
1878 "Are the headers of the current message visible?"
1879 (notmuch-show-get-prop :headers-visible))
1881 (put 'notmuch-show-mark-read 'notmuch-prefix-doc
1882 "Mark the current message as unread.")
1883 (defun notmuch-show-mark-read (&optional unread)
1884 "Mark the current message as read.
1886 Mark the current message as read by applying the tag changes in
1887 `notmuch-show-mark-read-tags' to it (remove the \"unread\" tag by
1888 default). If a prefix argument is given, the message will be
1889 marked as unread, i.e. the tag changes in
1890 `notmuch-show-mark-read-tags' will be reversed."
1892 (when notmuch-show-mark-read-tags
1893 (apply 'notmuch-show-tag-message
1894 (notmuch-tag-change-list notmuch-show-mark-read-tags unread))))
1896 (defun notmuch-show-seen-current-message (_start _end)
1897 "Mark the current message read if it is open.
1899 We only mark it read once: if it is changed back then that is a
1900 user decision and we should not override it."
1901 (when (and (notmuch-show-message-visible-p)
1902 (not (notmuch-show-get-prop :seen)))
1903 (notmuch-show-mark-read)
1904 (notmuch-show-set-prop :seen t)))
1906 (defvar notmuch-show--seen-has-errored nil)
1907 (make-variable-buffer-local 'notmuch-show--seen-has-errored)
1909 (defun notmuch-show-command-hook ()
1910 (when (eq major-mode 'notmuch-show-mode)
1911 ;; We need to redisplay to get window-start and window-end correct.
1915 (funcall notmuch-show-mark-read-function (window-start) (window-end))
1917 (unless notmuch-show--seen-has-errored
1918 (setq notmuch-show--seen-has-errored t)
1919 (setq header-line-format
1920 (concat header-line-format
1922 " [some mark read tag changes may have failed]"
1923 'face font-lock-warning-face)))))))))
1925 (defun notmuch-show-filter-thread (query)
1926 "Filter or LIMIT the current thread based on a new query string.
1928 Reshows the current thread with matches defined by the new query-string."
1929 (interactive (list (notmuch-read-query "Filter thread: ")))
1930 (let ((msg-id (notmuch-show-get-message-id)))
1931 (setq notmuch-show-query-context (if (string-empty-p query) nil query))
1932 (notmuch-show-refresh-view t)
1933 (notmuch-show-goto-message msg-id)))
1935 ;;; Functions for getting attributes of several messages in the current thread.
1937 (defun notmuch-show-get-message-ids-for-open-messages ()
1938 "Return a list of all id: queries for open messages in the current thread."
1940 (let (message-ids done)
1941 (goto-char (point-min))
1943 (when (notmuch-show-message-visible-p)
1945 (append message-ids (list (notmuch-show-get-message-id)))))
1946 (setq done (not (notmuch-show-goto-message-next))))
1949 ;;; Commands typically bound to keys.
1951 (defun notmuch-show-advance ()
1952 "Advance through thread.
1954 If the current message in the thread is not yet fully visible,
1955 scroll by a near screenful to read more of the message.
1957 Otherwise, (the end of the current message is already within the
1958 current window), advance to the next open message."
1960 (let* ((end-of-this-message (notmuch-show-message-bottom))
1961 (visible-end-of-this-message (1- end-of-this-message))
1963 (while (invisible-p visible-end-of-this-message)
1964 (setq visible-end-of-this-message
1966 (1- (previous-single-char-property-change
1967 visible-end-of-this-message 'invisible)))))
1969 ;; Ideally we would test `end-of-this-message' against the result
1970 ;; of `window-end', but that doesn't account for the fact that
1971 ;; the end of the message might be hidden.
1972 ((and visible-end-of-this-message
1973 (> visible-end-of-this-message (window-end)))
1974 ;; The bottom of this message is not visible - scroll.
1976 ((not (= end-of-this-message (point-max)))
1977 ;; This is not the last message - move to the next visible one.
1978 (notmuch-show-next-open-message))
1979 ((not (= (point) (point-max)))
1980 ;; This is the last message, but the cursor is not at the end of
1981 ;; the buffer. Move it there.
1982 (goto-char (point-max)))
1984 ;; This is the last message - change the return value
1988 (defun notmuch-show-advance-and-archive ()
1989 "Advance through thread and archive.
1991 This command is intended to be one of the simplest ways to
1992 process a thread of email. It works exactly like
1993 notmuch-show-advance, in that it scrolls through messages in a
1994 show buffer, except that when it gets to the end of the buffer it
1995 archives the entire current thread, (apply changes in
1996 `notmuch-archive-tags'), kills the buffer, and displays the next
1997 thread from the search from which this thread was originally
2000 (when (notmuch-show-advance)
2001 (notmuch-show-archive-thread-then-next)))
2003 (defun notmuch-show-rewind ()
2004 "Backup through the thread (reverse scrolling compared to \
2005 \\[notmuch-show-advance-and-archive]).
2007 Specifically, if the beginning of the previous email is fewer
2008 than `window-height' lines from the current point, move to it
2009 just like `notmuch-show-previous-message'.
2011 Otherwise, just scroll down a screenful of the current message.
2013 This command does not modify any message tags, (it does not undo
2014 any effects from previous calls to
2015 `notmuch-show-advance-and-archive'."
2017 (let ((start-of-message (notmuch-show-message-top))
2018 (start-of-window (window-start)))
2020 ;; Either this message is properly aligned with the start of the
2021 ;; window or the start of this message is not visible on the
2023 ((or (= start-of-message start-of-window)
2024 (< start-of-message start-of-window))
2026 ;; If a small number of lines from the previous message are
2027 ;; visible, realign so that the top of the current message is at
2028 ;; the top of the screen.
2029 (when (<= (count-screen-lines (window-start) start-of-message)
2030 next-screen-context-lines)
2031 (goto-char (notmuch-show-message-top))
2032 (notmuch-show-message-adjust))
2033 ;; Move to the top left of the window.
2034 (goto-char (window-start)))
2036 ;; Move to the previous message.
2037 (notmuch-show-previous-message)))))
2039 (put 'notmuch-show-reply 'notmuch-prefix-doc "... and prompt for sender")
2040 (defun notmuch-show-reply (&optional prompt-for-sender)
2041 "Reply to the sender and all recipients of the current message."
2043 (notmuch-mua-new-reply (notmuch-show-get-message-id) prompt-for-sender t
2044 (notmuch-show-get-prop :duplicate)))
2046 (put 'notmuch-show-reply-sender 'notmuch-prefix-doc "... and prompt for sender")
2047 (defun notmuch-show-reply-sender (&optional prompt-for-sender)
2048 "Reply to the sender of the current message."
2050 (notmuch-mua-new-reply (notmuch-show-get-message-id) prompt-for-sender nil
2051 (notmuch-show-get-prop :duplicate)))
2053 (put 'notmuch-show-forward-message 'notmuch-prefix-doc
2054 "... and prompt for sender")
2055 (defun notmuch-show-forward-message (&optional prompt-for-sender)
2056 "Forward the current message."
2058 (notmuch-mua-new-forward-messages (list (notmuch-show-get-message-id))
2061 (put 'notmuch-show-forward-open-messages 'notmuch-prefix-doc
2062 "... and prompt for sender")
2063 (defun notmuch-show-forward-open-messages (&optional prompt-for-sender)
2064 "Forward the currently open messages."
2066 (let ((open-messages (notmuch-show-get-message-ids-for-open-messages)))
2067 (unless open-messages
2068 (error "No open messages to forward."))
2069 (notmuch-mua-new-forward-messages open-messages prompt-for-sender)))
2071 (defun notmuch-show-resend-message (addresses)
2072 "Resend the current message."
2073 (interactive (list (notmuch-address-from-minibuffer "Resend to: ")))
2074 (when (y-or-n-p (concat "Confirm resend to " addresses " "))
2075 (notmuch-show-view-raw-message)
2076 (message-resend addresses)
2077 (notmuch-bury-or-kill-this-buffer)))
2079 (defun notmuch-show-message-adjust ()
2082 (defun notmuch-show-next-message (&optional pop-at-end)
2083 "Show the next message.
2085 If a prefix argument is given and this is the last message in the
2086 thread, navigate to the next thread in the parent search buffer."
2088 (if (notmuch-show-goto-message-next)
2089 (notmuch-show-message-adjust)
2091 (notmuch-show-next-thread)
2092 (goto-char (point-max)))))
2094 (defun notmuch-show-previous-message ()
2095 "Show the previous message or the start of the current message."
2097 (if (= (point) (notmuch-show-message-top))
2098 (notmuch-show-goto-message-previous)
2099 (notmuch-show-move-to-message-top))
2100 (notmuch-show-message-adjust))
2102 (defun notmuch-show-next-open-message (&optional pop-at-end)
2103 "Show the next open message.
2105 If a prefix argument is given and this is the last open message
2106 in the thread, navigate to the next thread in the parent search
2107 buffer. Return t if there was a next open message in the thread
2108 to show, nil otherwise."
2111 (while (and (setq r (notmuch-show-goto-message-next))
2112 (not (notmuch-show-message-visible-p))))
2114 (notmuch-show-message-adjust)
2116 (notmuch-show-next-thread)
2117 (goto-char (point-max))))
2120 (defun notmuch-show-next-matching-message ()
2121 "Show the next matching message."
2124 (while (and (setq r (notmuch-show-goto-message-next))
2125 (not (notmuch-show-get-prop :match))))
2127 (notmuch-show-message-adjust)
2128 (goto-char (point-max)))))
2130 (defun notmuch-show-open-if-matched ()
2131 "Open a message if it is matched (whether or not excluded)."
2132 (let ((props (notmuch-show-get-message-properties)))
2133 (notmuch-show-message-visible props (plist-get props :match))))
2135 (defun notmuch-show-goto-first-wanted-message ()
2136 "Move to the first open message and mark it read."
2137 (goto-char (point-min))
2138 (unless (notmuch-show-message-visible-p)
2139 (notmuch-show-next-open-message))
2141 ;; There are no matched non-excluded messages so open all matched
2142 ;; (necessarily excluded) messages and go to the first.
2143 (notmuch-show-mapc 'notmuch-show-open-if-matched)
2144 (force-window-update)
2145 (goto-char (point-min))
2146 (unless (notmuch-show-message-visible-p)
2147 (notmuch-show-next-open-message))))
2149 (defun notmuch-show-previous-open-message ()
2150 "Show the previous open message."
2152 (while (and (if (= (point) (notmuch-show-message-top))
2153 (notmuch-show-goto-message-previous)
2154 (notmuch-show-move-to-message-top))
2155 (not (notmuch-show-message-visible-p))))
2156 (notmuch-show-message-adjust))
2158 (defun notmuch-show-view-raw-message ()
2159 "View the original source of the current message."
2161 (let* ((id (notmuch-show-get-message-id))
2162 (duplicate (notmuch-show-get-duplicate))
2163 (args (if (> duplicate 1)
2164 (list (format "--duplicate=%d" duplicate) id)
2166 (buf (get-buffer-create (format "*notmuch-raw-%s-%d*" id duplicate)))
2167 (inhibit-read-only t))
2168 (pop-to-buffer-same-window buf)
2170 (let ((coding-system-for-read 'no-conversion))
2171 (apply #'notmuch--call-process notmuch-command nil t nil "show" "--format=raw" args))
2172 (goto-char (point-min))
2173 (set-buffer-modified-p nil)
2174 (setq buffer-read-only t)
2175 (view-buffer buf 'kill-buffer-if-not-modified)))
2177 (defun notmuch-show-resume-message ()
2178 "Resume EDITING the current draft message."
2180 (notmuch-draft-resume (notmuch-show-get-message-id)))
2182 (put 'notmuch-show-pipe-message 'notmuch-doc
2183 "Pipe the contents of the current message to a command.")
2184 (put 'notmuch-show-pipe-message 'notmuch-prefix-doc
2185 "Pipe the thread as an mbox to a command.")
2186 (defun notmuch-show-pipe-message (entire-thread command)
2187 "Pipe the contents of the current message (or thread) to COMMAND.
2189 COMMAND will be executed with the raw contents of the current
2190 email message as stdin. Anything printed by the command to stdout
2191 or stderr will appear in the *notmuch-pipe* buffer.
2193 If ENTIRE-THREAD is non-nil (or when invoked with a prefix
2194 argument), COMMAND will receive all open messages in the current
2195 thread (formatted as an mbox) rather than only the current
2197 (interactive (let ((query-string (if current-prefix-arg
2198 "Pipe all open messages to command: "
2199 "Pipe message to command: ")))
2200 (list current-prefix-arg (read-shell-command query-string))))
2201 (let (shell-command)
2204 (concat notmuch-command " show --format=mbox --exclude=false "
2205 (shell-quote-argument
2206 (mapconcat 'identity
2207 (notmuch-show-get-message-ids-for-open-messages)
2211 (concat notmuch-command " show --format=raw "
2212 (shell-quote-argument (notmuch-show-get-message-id))
2214 (let ((cwd default-directory)
2215 (buf (get-buffer-create (concat "*notmuch-pipe*"))))
2216 (with-current-buffer buf
2217 (setq buffer-read-only t)
2218 (let ((inhibit-read-only t))
2220 ;; Use the originating buffer's working directory instead of
2221 ;; that of the pipe buffer.
2223 (let ((exit-code (call-process-shell-command shell-command nil buf)))
2224 (goto-char (point-max))
2225 (set-buffer-modified-p nil)
2226 (unless (zerop exit-code)
2228 (message (format "Command '%s' exited abnormally with code %d"
2229 shell-command exit-code)))))))))
2231 (defun notmuch-show-tag-message (&rest tag-changes)
2232 "Change tags for the current message.
2234 TAG-CHANGES is a list of tag operations for `notmuch-tag'."
2235 (let* ((current-tags (notmuch-show-get-tags))
2236 (new-tags (notmuch-update-tags current-tags tag-changes)))
2237 (unless (equal current-tags new-tags)
2238 (notmuch-tag (notmuch-show-get-message-id) tag-changes)
2239 (notmuch-show-set-tags new-tags))))
2241 (defun notmuch-show-tag (tag-changes)
2242 "Change tags for the current message.
2244 See `notmuch-tag' for information on the format of TAG-CHANGES."
2245 (interactive (list (notmuch-read-tag-changes (notmuch-show-get-tags)
2247 (notmuch-tag (notmuch-show-get-message-id) tag-changes)
2248 (let* ((current-tags (notmuch-show-get-tags))
2249 (new-tags (notmuch-update-tags current-tags tag-changes)))
2250 (unless (equal current-tags new-tags)
2251 (notmuch-show-set-tags new-tags))))
2253 (defun notmuch-show-tag-all (tag-changes)
2254 "Change tags for all messages in the current show buffer.
2256 See `notmuch-tag' for information on the format of TAG-CHANGES."
2260 (lambda () (setq tags (append (notmuch-show-get-tags) tags))))
2261 (notmuch-read-tag-changes tags "Tag thread"))))
2262 (notmuch-tag (notmuch-show-get-messages-ids-search) tag-changes)
2265 (let* ((current-tags (notmuch-show-get-tags))
2266 (new-tags (notmuch-update-tags current-tags tag-changes)))
2267 (unless (equal current-tags new-tags)
2268 (notmuch-show-set-tags new-tags))))))
2270 (defun notmuch-show-add-tag (tag-changes)
2271 "Change tags for the current message (defaulting to add).
2273 Same as `notmuch-show-tag' but sets initial input to '+'."
2275 (list (notmuch-read-tag-changes (notmuch-show-get-tags) "Tag message" "+")))
2276 (notmuch-show-tag tag-changes))
2278 (defun notmuch-show-remove-tag (tag-changes)
2279 "Change tags for the current message (defaulting to remove).
2281 Same as `notmuch-show-tag' but sets initial input to '-'."
2283 (list (notmuch-read-tag-changes (notmuch-show-get-tags) "Tag message" "-")))
2284 (notmuch-show-tag tag-changes))
2286 (defun notmuch-show-toggle-visibility-headers ()
2287 "Toggle the visibility of the current message headers."
2289 (let ((props (notmuch-show-get-message-properties)))
2290 (notmuch-show-headers-visible
2292 (not (plist-get props :headers-visible))))
2293 (force-window-update))
2295 (defun notmuch-show-toggle-message ()
2296 "Toggle the visibility of the current message."
2298 (let ((props (notmuch-show-get-message-properties)))
2299 (notmuch-show-message-visible
2301 (not (plist-get props :message-visible))))
2302 (force-window-update))
2304 (put 'notmuch-show-open-or-close-all 'notmuch-doc "Show all messages.")
2305 (put 'notmuch-show-open-or-close-all 'notmuch-prefix-doc "Hide all messages.")
2306 (defun notmuch-show-open-or-close-all ()
2307 "Set the visibility all of the messages in the current thread.
2309 By default make all of the messages visible. With a prefix
2310 argument, hide all of the messages."
2313 (goto-char (point-min))
2314 (cl-loop do (notmuch-show-message-visible
2315 (notmuch-show-get-message-properties)
2316 (not current-prefix-arg))
2317 until (not (notmuch-show-goto-message-next))))
2318 (force-window-update))
2320 (defun notmuch-show-next-button ()
2321 "Advance point to the next button in the buffer."
2325 (defun notmuch-show-previous-button ()
2326 "Move point back to the previous button in the buffer."
2328 (backward-button 1))
2330 (defun notmuch-show-next-thread (&optional show previous)
2331 "Move to the next item in the search results, if any.
2333 If SHOW is non-nil, open the next item in a show
2334 buffer. Otherwise just highlight the next item in the search
2335 buffer. If PREVIOUS is non-nil, move to the previous item in the
2336 search results instead.
2338 Return non-nil on success."
2340 (let ((parent-buffer notmuch-show-parent-buffer))
2341 (notmuch-bury-or-kill-this-buffer)
2342 (when (buffer-live-p parent-buffer)
2343 (switch-to-buffer parent-buffer)
2345 (notmuch-search-previous-thread)
2346 (notmuch-search-next-thread))
2348 (notmuch-search-show-thread)))))
2350 (defun notmuch-show-next-thread-show ()
2351 "Show the next thread in the search results, if any."
2353 (notmuch-show-next-thread t))
2355 (defun notmuch-show-previous-thread-show ()
2356 "Show the previous thread in the search results, if any."
2358 (notmuch-show-next-thread t t))
2360 (put 'notmuch-show-archive-thread 'notmuch-prefix-doc
2361 "Un-archive each message in thread.")
2362 (defun notmuch-show-archive-thread (&optional unarchive)
2363 "Archive each message in thread.
2365 Archive each message currently shown by applying the tag changes
2366 in `notmuch-archive-tags' to each. If a prefix argument is given,
2367 the messages will be \"unarchived\", i.e. the tag changes in
2368 `notmuch-archive-tags' will be reversed.
2370 Note: This command is safe from any race condition of new messages
2371 being delivered to the same thread. It does not archive the
2372 entire thread, but only the messages shown in the current
2375 (when notmuch-archive-tags
2376 (notmuch-show-tag-all
2377 (notmuch-tag-change-list notmuch-archive-tags unarchive))))
2379 (defun notmuch-show-archive-thread-then-next ()
2380 "Archive all messages in the current buffer, then show next thread from search."
2382 (notmuch-show-archive-thread)
2383 (notmuch-show-next-thread t))
2385 (defun notmuch-show-archive-thread-then-exit ()
2386 "Archive all messages in the current buffer, then exit back to search results."
2388 (notmuch-show-archive-thread)
2389 (notmuch-show-next-thread))
2391 (put 'notmuch-show-archive-message 'notmuch-prefix-doc
2392 "Un-archive the current message.")
2393 (defun notmuch-show-archive-message (&optional unarchive)
2394 "Archive the current message.
2396 Archive the current message by applying the tag changes in
2397 `notmuch-archive-tags' to it. If a prefix argument is given, the
2398 message will be \"unarchived\", i.e. the tag changes in
2399 `notmuch-archive-tags' will be reversed."
2401 (when notmuch-archive-tags
2402 (apply 'notmuch-show-tag-message
2403 (notmuch-tag-change-list notmuch-archive-tags unarchive))))
2405 (defun notmuch-show-archive-message-then-next-or-exit ()
2406 "Archive current message, then show next open message in current thread.
2408 If at the last open message in the current thread, then exit back
2411 (notmuch-show-archive-message)
2412 (notmuch-show-next-open-message t))
2414 (defun notmuch-show-archive-message-then-next-or-next-thread ()
2415 "Archive current message, then show next open message in current or next thread.
2417 If at the last open message in the current thread, then show next
2418 thread from search."
2420 (notmuch-show-archive-message)
2421 (unless (notmuch-show-next-open-message)
2422 (notmuch-show-next-thread t)))
2424 (defun notmuch-show-stash-cc ()
2425 "Copy CC field of current message to kill-ring."
2427 (notmuch-common-do-stash (notmuch-show-get-cc)))
2429 (put 'notmuch-show-stash-date 'notmuch-prefix-doc
2430 "Copy timestamp of current message to kill-ring.")
2431 (defun notmuch-show-stash-date (&optional stash-timestamp)
2432 "Copy date of current message to kill-ring.
2434 If invoked with a prefix argument, copy timestamp of current
2435 message to kill-ring."
2438 (notmuch-common-do-stash (format "%d" (notmuch-show-get-timestamp)))
2439 (notmuch-common-do-stash (notmuch-show-get-date))))
2441 (defun notmuch-show-stash-filename ()
2442 "Copy filename of current message to kill-ring."
2444 (notmuch-common-do-stash (notmuch-show-get-filename)))
2446 (defun notmuch-show-stash-from ()
2447 "Copy From address of current message to kill-ring."
2449 (notmuch-common-do-stash (notmuch-show-get-from)))
2451 (put 'notmuch-show-stash-message-id 'notmuch-prefix-doc
2452 "Copy thread: query matching current thread to kill-ring.")
2453 (defun notmuch-show-stash-message-id (&optional stash-thread-id)
2454 "Copy id: query matching the current message to kill-ring.
2456 If invoked with a prefix argument (or STASH-THREAD-ID is
2457 non-nil), copy thread: query matching the current thread to
2461 (notmuch-common-do-stash notmuch-show-thread-id)
2462 (notmuch-common-do-stash (notmuch-show-get-message-id))))
2464 (defun notmuch-show-stash-message-id-stripped ()
2465 "Copy message ID of current message (sans `id:' prefix) to kill-ring."
2467 (notmuch-common-do-stash (notmuch-show-get-message-id t)))
2469 (defun notmuch-show-stash-subject ()
2470 "Copy Subject field of current message to kill-ring."
2472 (notmuch-common-do-stash (notmuch-show-get-subject)))
2474 (defun notmuch-show-stash-tags ()
2475 "Copy tags of current message to kill-ring as a comma separated list."
2477 (notmuch-common-do-stash (mapconcat 'identity (notmuch-show-get-tags) ",")))
2479 (defun notmuch-show-stash-to ()
2480 "Copy To address of current message to kill-ring."
2482 (notmuch-common-do-stash (notmuch-show-get-to)))
2484 (defun notmuch-show-stash-mlarchive-link (&optional mla)
2485 "Copy an ML Archive URI for the current message to the kill-ring.
2487 This presumes that the message is available at the selected Mailing List Archive.
2489 If optional argument MLA is non-nil, use the provided key instead of prompting
2490 the user (see `notmuch-show-stash-mlarchive-link-alist')."
2492 (let ((url (cdr (assoc
2494 (let ((completion-ignore-case t))
2496 "Mailing List Archive: "
2497 notmuch-show-stash-mlarchive-link-alist
2499 notmuch-show-stash-mlarchive-link-default)))
2500 notmuch-show-stash-mlarchive-link-alist))))
2501 (notmuch-common-do-stash
2503 (funcall url (notmuch-show-get-message-id t))
2504 (concat url (notmuch-show-get-message-id t))))))
2506 (defun notmuch-show-stash-mlarchive-link-and-go (&optional mla)
2507 "Copy an ML Archive URI for the current message to the kill-ring and visit it.
2509 This presumes that the message is available at the selected Mailing List Archive.
2511 If optional argument MLA is non-nil, use the provided key instead of prompting
2512 the user (see `notmuch-show-stash-mlarchive-link-alist')."
2514 (notmuch-show-stash-mlarchive-link mla)
2515 (browse-url (current-kill 0 t)))
2517 (defun notmuch-show-stash-git-helper (addresses prefix)
2518 "Normalize all ADDRESSES while adding PREFIX.
2519 Escape, trim, quote and add PREFIX to each address in list
2520 of ADDRESSES, and return the result as a single string."
2521 (mapconcat (lambda (x)
2523 ;; escape double-quotes
2524 (replace-regexp-in-string
2526 ;; trim leading and trailing spaces
2527 (replace-regexp-in-string
2528 "\\(^ *\\| *$\\)" ""
2532 (put 'notmuch-show-stash-git-send-email 'notmuch-prefix-doc
2533 "Copy From/To/Cc of current message to kill-ring.
2534 Use a form suitable for pasting to git send-email command line.")
2536 (defun notmuch-show-stash-git-send-email (&optional no-in-reply-to)
2537 "Copy From/To/Cc/Message-Id of current message to kill-ring.
2538 Use a form suitable for pasting to git send-email command line.
2540 If invoked with a prefix argument (or NO-IN-REPLY-TO is non-nil),
2541 omit --in-reply-to=<Message-Id>."
2543 (notmuch-common-do-stash
2544 (mapconcat 'identity
2547 (notmuch-show-stash-git-helper
2548 (message-tokenize-header (notmuch-show-get-from)) "--to=")
2549 (notmuch-show-stash-git-helper
2550 (message-tokenize-header (notmuch-show-get-to)) "--to=")
2551 (notmuch-show-stash-git-helper
2552 (message-tokenize-header (notmuch-show-get-cc)) "--cc=")
2553 (unless no-in-reply-to
2554 (notmuch-show-stash-git-helper
2555 (list (notmuch-show-get-message-id t)) "--in-reply-to="))))
2558 ;;; Interactive part functions and their helpers
2560 (defun notmuch-show-generate-part-buffer (msg part)
2561 "Return a temporary buffer containing the specified part's content."
2562 (let ((buf (generate-new-buffer " *notmuch-part*"))
2563 (process-crypto notmuch-show-process-crypto))
2564 (with-current-buffer buf
2565 ;; This is always used in the content of mm handles, which
2566 ;; expect undecoded, binary part content.
2567 (insert (notmuch-get-bodypart-binary msg part process-crypto)))
2570 (defun notmuch-show-current-part-handle (&optional mime-type)
2571 "Return an mm-handle for the part containing point.
2573 This creates a temporary buffer for the part's content; the
2574 caller is responsible for killing this buffer as appropriate. If
2575 MIME-TYPE is given then set the handle's mime-type to MIME-TYPE."
2576 (let* ((msg (notmuch-show-get-message-properties))
2577 (part (notmuch-show-get-part-properties))
2578 (buf (notmuch-show-generate-part-buffer msg part))
2579 (computed-type (or mime-type (plist-get part :computed-type)))
2580 (filename (plist-get part :filename))
2581 (disposition (and filename `(attachment (filename . ,filename)))))
2582 (mm-make-handle buf (list computed-type) nil nil disposition)))
2584 (defun notmuch-show-apply-to-current-part-handle (fn &optional mime-type)
2585 "Apply FN to an mm-handle for the part containing point.
2587 This ensures that the temporary buffer created for the mm-handle
2588 is destroyed when FN returns. If MIME-TYPE is given then force
2589 part to be treated as if it had that mime-type."
2590 (let ((handle (notmuch-show-current-part-handle mime-type)))
2591 ;; Emacs puts stdout/stderr into the calling buffer so we call
2592 ;; it from a temp-buffer, unless notmuch-show-attachment-debug
2593 ;; is non-nil, in which case we put it in " *notmuch-part*".
2595 (if notmuch-show-attachment-debug
2596 (with-current-buffer (generate-new-buffer " *notmuch-part*")
2597 (funcall fn handle))
2599 (funcall fn handle)))
2600 (kill-buffer (mm-handle-buffer handle)))))
2602 (defun notmuch-show-part-button-default (&optional button)
2604 (let ((button (or button (button-at (point)))))
2605 ;; Try to toggle the part, if that fails then call the default
2606 ;; action. The toggle fails if the part has no emacs renderable
2608 (unless (notmuch-show-toggle-part-invisibility button)
2609 (call-interactively notmuch-show-part-button-default-action))))
2611 (defun notmuch-show-save-part ()
2612 "Save the MIME part containing point to a file."
2614 (notmuch-show-apply-to-current-part-handle #'mm-save-part))
2616 (defun notmuch-show-view-part ()
2617 "View the MIME part containing point in an external viewer."
2619 ;; Set mm-inlined-types to nil to force an external viewer
2620 (let ((mm-inlined-types nil))
2621 (notmuch-show-apply-to-current-part-handle #'mm-display-part)))
2623 (defun notmuch-show-interactively-view-part ()
2624 "View the MIME part containing point, prompting for a viewer."
2626 (notmuch-show-apply-to-current-part-handle #'mm-interactively-view-part))
2628 (defun notmuch-show-pipe-part ()
2629 "Pipe the MIME part containing point to an external command."
2631 (notmuch-show-apply-to-current-part-handle #'mm-pipe-part))
2633 (defun notmuch-show--mm-display-part (handle)
2634 "Use mm-display-part to display HANDLE in a new buffer.
2636 If the part is displayed in an external application then close
2638 (let ((buf (get-buffer-create (generate-new-buffer-name
2639 (concat " *notmuch-internal-part*")))))
2640 (pop-to-buffer-same-window buf)
2641 (if (eq (mm-display-part handle) 'external)
2643 (goto-char (point-min))
2644 (set-buffer-modified-p nil)
2645 (view-buffer buf 'kill-buffer-if-not-modified))))
2647 (defun notmuch-show-choose-mime-of-part (mime-type)
2648 "Choose the mime type to use for displaying part."
2650 (list (completing-read "Mime type to use (default text/plain): "
2651 (mailcap-mime-types) nil nil nil nil "text/plain")))
2652 (notmuch-show-apply-to-current-part-handle #'notmuch-show--mm-display-part
2655 (defun notmuch-show-imenu-prev-index-position-function ()
2656 "Move point to previous message in notmuch-show buffer.
2657 This function is used as a value for
2658 `imenu-prev-index-position-function'."
2661 (notmuch-show-previous-message)
2664 (defun notmuch-show-imenu-extract-index-name-function ()
2665 "Return imenu name for line at point.
2666 This function is used as a value for
2667 `imenu-extract-index-name-function'. Point should be at the
2668 beginning of the line."
2669 (back-to-indentation)
2670 (buffer-substring-no-properties (if notmuch-show-imenu-indent
2671 (line-beginning-position)
2673 (line-end-position)))
2675 (defmacro notmuch-show--with-currently-shown-message (&rest body)
2676 "Evaluate BODY with display restricted to the currently shown
2680 (let ((extent (notmuch-show-message-extent)))
2681 (narrow-to-region (car extent) (cdr extent))
2684 (defun notmuch-show--gather-urls ()
2685 "Gather any URLs in the current message."
2686 (notmuch-show--with-currently-shown-message
2688 (goto-char (point-min))
2689 (while (re-search-forward goto-address-url-regexp (point-max) t)
2690 (push (match-string-no-properties 0) urls))
2693 (defun notmuch-show-browse-urls (&optional kill)
2694 "Offer to browse any URLs in the current message.
2695 With a prefix argument, copy the URL to the kill ring rather than
2698 (let ((urls (notmuch-show--gather-urls))
2699 (prompt (if kill "Copy URL to kill ring: " "Browse URL: "))
2700 (fn (if kill #'kill-new #'browse-url)))
2702 (funcall fn (completing-read prompt urls nil nil nil nil (car urls)))
2703 (message "No URLs found."))))
2707 (provide 'notmuch-show)
2709 ;;; notmuch-show.el ends here