1 ;;; notmuch-show.el --- displaying notmuch forests.
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>
37 (require 'notmuch-lib)
38 (require 'notmuch-tag)
39 (require 'notmuch-query)
40 (require 'notmuch-wash)
41 (require 'notmuch-mua)
42 (require 'notmuch-crypto)
43 (require 'notmuch-print)
44 (require 'notmuch-draft)
46 (declare-function notmuch-call-notmuch-process "notmuch" (&rest args))
47 (declare-function notmuch-search-next-thread "notmuch" nil)
48 (declare-function notmuch-search-previous-thread "notmuch" nil)
49 (declare-function notmuch-search-show-thread "notmuch" nil)
50 (declare-function notmuch-foreach-mime-part "notmuch" (function mm-handle))
51 (declare-function notmuch-count-attachments "notmuch" (mm-handle))
52 (declare-function notmuch-save-attachments "notmuch" (mm-handle &optional queryp))
53 (declare-function notmuch-tree "notmuch-tree"
54 (&optional query query-context target buffer-name
55 open-target unthreaded))
56 (declare-function notmuch-tree-get-message-properties "notmuch-tree" nil)
57 (declare-function notmuch-unthreaded
58 (&optional query query-context target buffer-name open-target))
59 (declare-function notmuch-read-query "notmuch" (prompt))
60 (declare-function notmuch-draft-resume "notmuch-draft" (id))
62 (defcustom notmuch-message-headers '("Subject" "To" "Cc" "Date")
63 "Headers that should be shown in a message, in this order.
65 For an open message, all of these headers will be made visible
66 according to `notmuch-message-headers-visible' or can be toggled
67 with `notmuch-show-toggle-visibility-headers'. For a closed message,
68 only the first header in the list will be visible."
69 :type '(repeat string)
72 (defcustom notmuch-message-headers-visible t
73 "Should the headers be visible by default?
75 If this value is non-nil, then all of the headers defined in
76 `notmuch-message-headers' will be visible by default in the display
77 of each message. Otherwise, these headers will be hidden and
78 `notmuch-show-toggle-visibility-headers' can be used to make them
79 visible for any given message."
83 (defcustom notmuch-show-relative-dates t
84 "Display relative dates in the message summary line."
88 (defvar notmuch-show-markup-headers-hook '(notmuch-show-colour-headers)
89 "A list of functions called to decorate the headers listed in
90 `notmuch-message-headers'.")
92 (defcustom notmuch-show-hook '(notmuch-show-turn-on-visual-line-mode)
93 "Functions called after populating a `notmuch-show' buffer."
95 :options '(notmuch-show-turn-on-visual-line-mode)
97 :group 'notmuch-hooks)
99 (defcustom notmuch-show-insert-text/plain-hook
100 '(notmuch-wash-wrap-long-lines
101 notmuch-wash-tidy-citations
102 notmuch-wash-elide-blank-lines
103 notmuch-wash-excerpt-citations)
104 "Functions used to improve the display of text/plain parts."
106 :options '(notmuch-wash-convert-inline-patch-to-part
107 notmuch-wash-wrap-long-lines
108 notmuch-wash-tidy-citations
109 notmuch-wash-elide-blank-lines
110 notmuch-wash-excerpt-citations)
112 :group 'notmuch-hooks)
114 (defcustom notmuch-show-max-text-part-size 100000
115 "Maximum size of a text part to be shown by default in characters.
117 Set to 0 to show the part regardless of size."
119 :group 'notmuch-show)
121 ;; Mostly useful for debugging.
122 (defcustom notmuch-show-all-multipart/alternative-parts nil
123 "Should all parts of multipart/alternative parts be shown?"
125 :group 'notmuch-show)
127 (defcustom notmuch-show-indent-messages-width 1
128 "Width of message indentation in threads.
130 Messages are shown indented according to their depth in a thread.
131 This variable determines the width of this indentation measured
132 in number of blanks. Defaults to `1', choose `0' to disable
135 :group 'notmuch-show)
137 (defcustom notmuch-show-indent-multipart nil
138 "Should the sub-parts of a multipart/* part be indented?"
139 ;; dme: Not sure which is a good default.
141 :group 'notmuch-show)
143 (defcustom notmuch-show-part-button-default-action 'notmuch-show-save-part
144 "Default part header button action (on ENTER or mouse click)."
146 :type '(choice (const :tag "Save part"
147 notmuch-show-save-part)
148 (const :tag "View part"
149 notmuch-show-view-part)
150 (const :tag "View interactively"
151 notmuch-show-interactively-view-part)))
153 (defcustom notmuch-show-only-matching-messages nil
154 "Only matching messages are shown by default."
156 :group 'notmuch-show)
158 ;; By default, block all external images to prevent privacy leaks and
159 ;; potential attacks.
160 (defcustom notmuch-show-text/html-blocked-images "."
161 "Remote images that have URLs matching this regexp will be blocked."
162 :type '(choice (const nil) regexp)
163 :group 'notmuch-show)
165 (defvar notmuch-show-thread-id nil)
166 (make-variable-buffer-local 'notmuch-show-thread-id)
168 (defvar notmuch-show-parent-buffer nil)
169 (make-variable-buffer-local 'notmuch-show-parent-buffer)
171 (defvar notmuch-show-query-context nil)
172 (make-variable-buffer-local 'notmuch-show-query-context)
174 (defvar notmuch-show-process-crypto nil)
175 (make-variable-buffer-local 'notmuch-show-process-crypto)
177 (defvar notmuch-show-elide-non-matching-messages nil)
178 (make-variable-buffer-local 'notmuch-show-elide-non-matching-messages)
180 (defvar notmuch-show-indent-content t)
181 (make-variable-buffer-local 'notmuch-show-indent-content)
183 (defvar notmuch-show-attachment-debug nil
184 "If t log stdout and stderr from attachment handlers.
186 When set to nil (the default) stdout and stderr from attachment
187 handlers is discarded. When set to t the stdout and stderr from
188 each attachment handler is logged in buffers with names beginning
189 \" *notmuch-part*\". This option requires emacs version at least
192 (defcustom notmuch-show-stash-mlarchive-link-alist
193 '(("Gmane" . "https://mid.gmane.org/")
194 ("MARC" . "https://marc.info/?i=")
195 ("Mail Archive, The" . "https://mid.mail-archive.com/")
196 ("LKML" . "https://lkml.kernel.org/r/")
197 ;; FIXME: can these services be searched by `Message-Id' ?
198 ;; ("MarkMail" . "http://markmail.org/")
199 ;; ("Nabble" . "http://nabble.com/")
200 ;; ("opensubscriber" . "http://opensubscriber.com/")
202 "List of Mailing List Archives to use when stashing links.
204 This list is used for generating a Mailing List Archive reference
205 URI with the current message's Message-Id in
206 `notmuch-show-stash-mlarchive-link'.
208 If the cdr of the alist element is not a function, the cdr is
209 expected to contain a URI that is concatenated with the current
210 message's Message-Id to create a ML archive reference URI.
212 If the cdr is a function, the function is called with the
213 Message-Id as the argument, and the function is expected to
214 return the ML archive reference URI."
215 :type '(alist :key-type (string :tag "Name")
218 (function :tag "Function returning the URL")))
219 :group 'notmuch-show)
221 (defcustom notmuch-show-stash-mlarchive-link-default "Gmane"
222 "Default Mailing List Archive to use when stashing links.
224 This is used when `notmuch-show-stash-mlarchive-link' isn't
225 provided with an MLA argument nor `completing-read' input."
229 (list 'const :tag (car mla) :value (car mla)))
230 notmuch-show-stash-mlarchive-link-alist))
231 :group 'notmuch-show)
233 (defcustom notmuch-show-mark-read-tags '("-unread")
234 "List of tag changes to apply to a message when it is marked as read.
236 Tags starting with \"+\" (or not starting with either \"+\" or
237 \"-\") in the list will be added, and tags starting with \"-\"
238 will be removed from the message being marked as read.
240 For example, if you wanted to remove an \"unread\" tag and add a
241 \"read\" tag (which would make little sense), you would set:
242 (\"-unread\" \"+read\")"
243 :type '(repeat string)
244 :group 'notmuch-show)
246 (defcustom notmuch-show-mark-read-function #'notmuch-show-seen-current-message
247 "Function to control which messages are marked read.
249 The function should take two arguments START and END which will
250 be the start and end of the visible portion of the buffer and
251 should mark the appropriate messages read by applying
252 `notmuch-show-mark-read'. This function will be called after
253 every user interaction with notmuch."
255 :group 'notmuch-show)
257 (defcustom notmuch-show-imenu-indent nil
258 "Should Imenu display messages indented.
260 By default, Imenu (see Info node `(emacs) Imenu') in a
261 notmuch-show buffer displays all messages straight. This is
262 because the default Emacs frontend for Imenu makes it difficult
263 to select an Imenu entry with spaces in front. Other imenu
264 frontends such as counsel-imenu does not have this limitation.
265 In these cases, Imenu entries can be indented to reflect the
266 position of the message in the thread."
268 :group 'notmuch-show)
270 (defmacro with-current-notmuch-show-message (&rest body)
271 "Evaluate body with current buffer set to the text of current message."
273 (let ((id (notmuch-show-get-message-id)))
274 (let ((buf (generate-new-buffer (concat "*notmuch-msg-" id "*"))))
275 (with-current-buffer buf
276 (let ((coding-system-for-read 'no-conversion))
277 (call-process notmuch-command nil t nil "show" "--format=raw" id))
279 (kill-buffer buf)))))
281 (defun notmuch-show-turn-on-visual-line-mode ()
282 "Enable Visual Line mode."
283 (visual-line-mode t))
285 ;; DEPRECATED in Notmuch 0.16 since we now have convenient part
286 ;; commands. We'll keep the command around for a version or two in
287 ;; case people want to bind it themselves.
288 (defun notmuch-show-view-all-mime-parts ()
289 "Use external viewers to view all attachments from the current message."
291 (with-current-notmuch-show-message
292 ;; We override the mm-inline-media-tests to indicate which message
293 ;; parts are already sufficiently handled by the original
294 ;; presentation of the message in notmuch-show mode. These parts
295 ;; will be inserted directly into the temporary buffer of
296 ;; with-current-notmuch-show-message and silently discarded.
298 ;; Any MIME part not explicitly mentioned here will be handled by an
299 ;; external viewer as configured in the various mailcap files.
300 (let ((mm-inline-media-tests
301 '(("text/.*" ignore identity)
302 ("application/pgp-signature" ignore identity)
303 ("multipart/alternative" ignore identity)
304 ("multipart/mixed" ignore identity)
305 ("multipart/related" ignore identity))))
306 (mm-display-parts (mm-dissect-buffer)))))
308 (defun notmuch-show-save-attachments ()
309 "Save all attachments from the current message."
311 (with-current-notmuch-show-message
312 (let ((mm-handle (mm-dissect-buffer)))
313 (notmuch-save-attachments
314 mm-handle (> (notmuch-count-attachments mm-handle) 1))))
317 (defun notmuch-show-with-message-as-text (fn)
318 "Apply FN to a text representation of the current message.
320 FN is called with one argument, the message properties. It should
321 operation on the contents of the current buffer."
322 ;; Remake the header to ensure that all information is available.
323 (let* ((to (notmuch-show-get-to))
324 (cc (notmuch-show-get-cc))
325 (from (notmuch-show-get-from))
326 (subject (notmuch-show-get-subject))
327 (date (notmuch-show-get-date))
328 (tags (notmuch-show-get-tags))
329 (depth (notmuch-show-get-depth))
331 "Subject: " subject "\n"
333 (if (not (string= cc ""))
334 (concat "Cc: " cc "\n")
340 (mapconcat #'identity tags ", ") "\n")
342 (all (buffer-substring (notmuch-show-message-top)
343 (notmuch-show-message-bottom)))
345 (props (notmuch-show-get-message-properties))
346 (indenting notmuch-show-indent-content))
350 (indent-rigidly (point-min)
352 (- (* notmuch-show-indent-messages-width depth))))
353 ;; Remove the original header.
354 (goto-char (point-min))
355 (re-search-forward "^$" (point-max) nil)
356 (delete-region (point-min) (point))
358 (funcall fn props))))
360 (defun notmuch-show-print-message ()
361 "Print the current message."
363 (notmuch-show-with-message-as-text 'notmuch-print-message))
365 (defun notmuch-show-fontify-header ()
367 ((looking-at "[Tt]o:")
369 ((looking-at "[Bb]?[Cc][Cc]:")
371 ((looking-at "[Ss]ubject:")
372 'message-header-subject)
374 'message-header-other))))
375 (overlay-put (make-overlay (point) (re-search-forward ":"))
376 'face 'message-header-name)
377 (overlay-put (make-overlay (point) (re-search-forward ".*$"))
380 (defun notmuch-show-colour-headers ()
381 "Apply some colouring to the current headers."
382 (goto-char (point-min))
383 (while (looking-at "^[A-Za-z][-A-Za-z0-9]*:")
384 (notmuch-show-fontify-header)
387 (defun notmuch-show-spaces-n (n)
388 "Return a string comprised of `n' spaces."
391 (defun notmuch-show-update-tags (tags)
392 "Update the displayed tags of the current message."
394 (goto-char (notmuch-show-message-top))
395 (if (re-search-forward "(\\([^()]*\\))$" (line-end-position) t)
396 (let ((inhibit-read-only t))
397 (replace-match (concat "("
398 (notmuch-tag-format-tags
400 (notmuch-show-get-prop :orig-tags))
403 (defun notmuch-clean-address (address)
404 "Try to clean a single email ADDRESS for display. Return a cons
405 cell of (AUTHOR_EMAIL AUTHOR_NAME). Return (ADDRESS nil) if
408 (let (p-name p-address)
409 ;; It would be convenient to use `mail-header-parse-address',
410 ;; but that expects un-decoded mailbox parts, whereas our
411 ;; mailbox parts are already decoded (and hence may contain
412 ;; UTF-8). Given that notmuch should handle most of the awkward
413 ;; cases, some simple string deconstruction should be sufficient
416 ;; "User <user@dom.ain>" style.
417 ((string-match "\\(.*\\) <\\(.*\\)>" address)
418 (setq p-name (match-string 1 address)
419 p-address (match-string 2 address)))
421 ;; "<user@dom.ain>" style.
422 ((string-match "<\\(.*\\)>" address)
423 (setq p-address (match-string 1 address)))
426 (setq p-address address)))
428 ;; Remove elements of the mailbox part that are not relevant for
429 ;; display, even if they are required during transport:
432 (setq p-name (replace-regexp-in-string "\\\\" "" p-name))
433 ;; Outer single and double quotes, which might be nested.
434 (cl-loop with start-of-loop
435 do (setq start-of-loop p-name)
436 when (string-match "^\"\\(.*\\)\"$" p-name)
437 do (setq p-name (match-string 1 p-name))
438 when (string-match "^'\\(.*\\)'$" p-name)
439 do (setq p-name (match-string 1 p-name))
440 until (string= start-of-loop p-name)))
441 ;; If the address is 'foo@bar.com <foo@bar.com>' then show just
443 (when (string= p-name p-address)
445 (cons p-address p-name))
446 (error (cons address nil))))
448 (defun notmuch-show-clean-address (address)
449 "Try to clean a single email ADDRESS for display. Return
450 unchanged ADDRESS if parsing fails."
451 (let* ((clean-address (notmuch-clean-address address))
452 (p-address (car clean-address))
453 (p-name (cdr clean-address)))
454 ;; If no name, return just the address.
457 ;; Otherwise format the name and address together.
458 (concat p-name " <" p-address ">"))))
460 (defun notmuch-show-insert-headerline (headers date tags depth)
461 "Insert a notmuch style headerline based on HEADERS for a
462 message at DEPTH in the current thread."
463 (let ((start (point))
464 (from (notmuch-sanitize
465 (notmuch-show-clean-address (plist-get headers :From)))))
466 (when (string-match "\\cR" from)
467 ;; If the From header has a right-to-left character add
468 ;; invisible U+200E LEFT-TO-RIGHT MARK character which forces
469 ;; the header paragraph as left-to-right text.
470 (insert (propertize (string ?\x200e) 'invisible t)))
471 (insert (notmuch-show-spaces-n (* notmuch-show-indent-messages-width depth))
476 (notmuch-tag-format-tags tags tags)
478 (overlay-put (make-overlay start (point))
479 'face 'notmuch-message-summary-face)))
481 (defun notmuch-show-insert-header (header header-value)
482 "Insert a single header."
483 (insert header ": " (notmuch-sanitize header-value) "\n"))
485 (defun notmuch-show-insert-headers (headers)
486 "Insert the headers of the current message."
487 (let ((start (point)))
488 (mapc (lambda (header)
489 (let* ((header-symbol (intern (concat ":" header)))
490 (header-value (plist-get headers header-symbol)))
491 (if (and header-value
492 (not (string-equal "" header-value)))
493 (notmuch-show-insert-header header header-value))))
494 notmuch-message-headers)
497 (narrow-to-region start (point-max))
498 (run-hooks 'notmuch-show-markup-headers-hook)))))
500 (define-button-type 'notmuch-show-part-button-type
501 'action 'notmuch-show-part-button-default
504 :supertype 'notmuch-button-type)
506 (defun notmuch-show-insert-part-header (nth content-type declared-type
507 &optional name comment)
509 (base-label (concat (when name (concat name ": "))
511 (unless (string-equal declared-type content-type)
512 (concat " (as " content-type ")"))
516 (concat "[ " base-label " ]")
517 :base-label base-label
518 :type 'notmuch-show-part-button-type
519 :notmuch-part-hidden nil))
524 (defun notmuch-show-toggle-part-invisibility (&optional button)
526 (let ((button (or button (button-at (point)))))
528 (let ((overlay (button-get button 'overlay))
529 (lazy-part (button-get button :notmuch-lazy-part)))
530 ;; We have a part to toggle if there is an overlay or if there
531 ;; is a lazy part. If neither is present we cannot toggle the
532 ;; part so we just return nil.
533 (when (or overlay lazy-part)
534 (let* ((show (button-get button :notmuch-part-hidden))
535 (new-start (button-start button))
536 (button-label (button-get button :base-label))
538 (properties (text-properties-at (button-start button)))
539 (inhibit-read-only t))
540 ;; Toggle the button itself.
541 (button-put button :notmuch-part-hidden (not show))
542 (goto-char new-start)
543 (insert "[ " button-label (if show " ]" " (hidden) ]"))
544 (set-text-properties new-start (point) properties)
545 (let ((old-end (button-end button)))
546 (move-overlay button new-start (point))
547 (delete-region (point) old-end))
548 (goto-char (min old-point (1- (button-end button))))
549 ;; Return nil if there is a lazy-part, it is empty, and we are
550 ;; trying to show it. In all other cases return t.
553 (button-put button :notmuch-lazy-part nil)
554 (notmuch-show-lazy-part lazy-part button))
555 ;; else there must be an overlay.
556 (overlay-put overlay 'invisible (not show))
559 ;; Part content ID handling
561 (defvar notmuch-show--cids nil
562 "Alist from raw content ID to (MSG PART).")
563 (make-variable-buffer-local 'notmuch-show--cids)
565 (defun notmuch-show--register-cids (msg part)
566 "Register content-IDs in PART and all of PART's sub-parts."
567 (let ((content-id (plist-get part :content-id)))
569 ;; Note that content-IDs are globally unique, except when they
570 ;; aren't: RFC 2046 section 5.1.4 permits children of a
571 ;; multipart/alternative to have the same content-ID, in which
572 ;; case the MUA is supposed to pick the best one it can render.
573 ;; We simply add the content-ID to the beginning of our alist;
574 ;; so if this happens, we'll take the last (and "best")
575 ;; alternative (even if we can't render it).
576 (push (list content-id msg part) notmuch-show--cids)))
577 ;; Recurse on sub-parts
578 (let ((ctype (notmuch-split-content-type
579 (downcase (plist-get part :content-type)))))
580 (cond ((equal (car ctype) "multipart")
581 (mapc (apply-partially #'notmuch-show--register-cids msg)
582 (plist-get part :content)))
583 ((equal ctype '("message" "rfc822"))
584 (notmuch-show--register-cids
586 (car (plist-get (car (plist-get part :content)) :body)))))))
588 (defun notmuch-show--get-cid-content (cid)
589 "Return a list (CID-content content-type) or nil.
591 This will only find parts from messages that have been inserted
592 into the current buffer. CID must be a raw content ID, without
593 enclosing angle brackets, a cid: prefix, or URL encoding. This
594 will return nil if the CID is unknown or cannot be retrieved."
595 (let ((descriptor (cdr (assoc cid notmuch-show--cids))))
597 (let* ((msg (car descriptor))
598 (part (cadr descriptor))
599 ;; Request caching for this content, as some messages
600 ;; reference the same cid: part many times (hundreds!).
601 (content (notmuch-get-bodypart-binary
602 msg part notmuch-show-process-crypto 'cache))
603 (content-type (plist-get part :content-type)))
604 (list content content-type)))))
606 (defun notmuch-show-setup-w3m ()
607 "Instruct w3m how to retrieve content from a \"related\" part of a message."
609 (if (boundp 'w3m-cid-retrieve-function-alist)
610 (unless (assq 'notmuch-show-mode w3m-cid-retrieve-function-alist)
611 (push (cons 'notmuch-show-mode #'notmuch-show--cid-w3m-retrieve)
612 w3m-cid-retrieve-function-alist)))
613 (setq mm-html-inhibit-images nil))
615 (defvar w3m-current-buffer) ;; From `w3m.el'.
616 (defun notmuch-show--cid-w3m-retrieve (url &rest args)
617 ;; url includes the cid: prefix and is URL encoded (see RFC 2392).
618 (let* ((cid (url-unhex-string (substring url 4)))
620 (with-current-buffer w3m-current-buffer
621 (notmuch-show--get-cid-content cid))))
622 (when content-and-type
623 (insert (car content-and-type))
624 (cadr content-and-type))))
626 ;; MIME part renderers
628 (defun notmuch-show-multipart/*-to-list (part)
629 (mapcar (lambda (inner-part) (plist-get inner-part :content-type))
630 (plist-get part :content)))
632 (defun notmuch-show-insert-part-multipart/alternative (msg part content-type nth depth button)
633 (let ((chosen-type (car (notmuch-multipart/alternative-choose
634 msg (notmuch-show-multipart/*-to-list part))))
635 (inner-parts (plist-get part :content))
637 ;; This inserts all parts of the chosen type rather than just one,
638 ;; but it's not clear that this is the wrong thing to do - which
639 ;; should be chosen if there are more than one that match?
640 (mapc (lambda (inner-part)
641 (let* ((inner-type (plist-get inner-part :content-type))
642 (hide (not (or notmuch-show-all-multipart/alternative-parts
643 (string= chosen-type inner-type)))))
644 (notmuch-show-insert-bodypart msg inner-part depth hide)))
647 (when notmuch-show-indent-multipart
648 (indent-rigidly start (point) 1)))
651 (defun notmuch-show-insert-part-multipart/related (msg part content-type nth depth button)
652 (let ((inner-parts (plist-get part :content))
654 ;; Render the primary part. FIXME: Support RFC 2387 Start header.
655 (notmuch-show-insert-bodypart msg (car inner-parts) depth)
656 ;; Add hidden buttons for the rest
657 (mapc (lambda (inner-part)
658 (notmuch-show-insert-bodypart msg inner-part depth t))
660 (when notmuch-show-indent-multipart
661 (indent-rigidly start (point) 1)))
664 (defun notmuch-show-insert-part-multipart/signed (msg part content-type nth depth button)
666 (button-put button 'face 'notmuch-crypto-part-header))
667 ;; Insert a button detailing the signature status.
668 (notmuch-crypto-insert-sigstatus-button (car (plist-get part :sigstatus))
669 (notmuch-show-get-header :From msg))
670 (let ((inner-parts (plist-get part :content))
672 ;; Show all of the parts.
673 (mapc (lambda (inner-part)
674 (notmuch-show-insert-bodypart msg inner-part depth))
676 (when notmuch-show-indent-multipart
677 (indent-rigidly start (point) 1)))
680 (defun notmuch-show-insert-part-multipart/encrypted (msg part content-type nth depth button)
682 (button-put button 'face 'notmuch-crypto-part-header))
683 ;; Insert a button detailing the encryption status.
684 (notmuch-crypto-insert-encstatus-button (car (plist-get part :encstatus)))
685 ;; Insert a button detailing the signature status.
686 (notmuch-crypto-insert-sigstatus-button (car (plist-get part :sigstatus))
687 (notmuch-show-get-header :From msg))
688 (let ((inner-parts (plist-get part :content))
690 ;; Show all of the parts.
691 (mapc (lambda (inner-part)
692 (notmuch-show-insert-bodypart msg inner-part depth))
694 (when notmuch-show-indent-multipart
695 (indent-rigidly start (point) 1)))
698 (defun notmuch-show-insert-part-application/pgp-encrypted (msg part content-type nth depth button)
701 (defun notmuch-show-insert-part-multipart/* (msg part content-type nth depth button)
702 (let ((inner-parts (plist-get part :content))
704 ;; Show all of the parts.
705 (mapc (lambda (inner-part)
706 (notmuch-show-insert-bodypart msg inner-part depth))
708 (when notmuch-show-indent-multipart
709 (indent-rigidly start (point) 1)))
712 (defun notmuch-show-insert-part-message/rfc822 (msg part content-type nth depth button)
713 (let* ((message (car (plist-get part :content)))
714 (body (car (plist-get message :body)))
716 ;; Override `notmuch-message-headers' to force `From' to be
718 (let ((notmuch-message-headers '("From" "Subject" "To" "Cc" "Date")))
719 (notmuch-show-insert-headers (plist-get message :headers)))
720 ;; Blank line after headers to be compatible with the normal
724 (notmuch-show-insert-bodypart msg body depth)
725 (when notmuch-show-indent-multipart
726 (indent-rigidly start (point) 1)))
729 (defun notmuch-show-insert-part-text/plain (msg part content-type nth depth button)
730 ;; For backward compatibility we want to apply the text/plain hook
731 ;; to the whole of the part including the part button if there is
733 (let ((start (if button
734 (button-start button)
736 (insert (notmuch-get-bodypart-text msg part notmuch-show-process-crypto))
739 (narrow-to-region start (point-max))
740 (run-hook-with-args 'notmuch-show-insert-text/plain-hook msg depth))))
743 (defun notmuch-show-insert-part-text/calendar (msg part content-type nth depth button)
744 (insert (with-temp-buffer
745 (insert (notmuch-get-bodypart-text msg part notmuch-show-process-crypto))
746 ;; notmuch-get-bodypart-text does no newline conversion.
747 ;; Replace CRLF with LF before icalendar can use it.
748 (goto-char (point-min))
749 (while (re-search-forward "\r\n" nil t)
750 (replace-match "\n" nil nil))
751 (let ((file (make-temp-file "notmuch-ical"))
755 (unless (icalendar-import-buffer file t)
756 (error "Icalendar import error. %s"
757 "See *icalendar-errors* for more information"))
758 (set-buffer (get-file-buffer file))
759 (setq result (buffer-substring (point-min) (point-max)))
760 (set-buffer-modified-p nil)
761 (kill-buffer (current-buffer)))
766 ;; For backwards compatibility.
767 (defun notmuch-show-insert-part-text/x-vcalendar (msg part content-type nth depth button)
768 (notmuch-show-insert-part-text/calendar msg part content-type nth depth button))
770 (if (version< emacs-version "25.3")
771 ;; https://bugs.gnu.org/28350
773 ;; For newer emacs, we fall back to notmuch-show-insert-part-*/*
774 ;; (see notmuch-show-handlers-for)
775 (defun notmuch-show-insert-part-text/enriched
776 (msg part content-type nth depth button)
777 ;; By requiring enriched below, we ensure that the function
778 ;; enriched-decode-display-prop is defined before it will be
779 ;; shadowed by the letf below. Otherwise the version in
780 ;; enriched.el may be loaded a bit later and used instead (for
783 (cl-letf (((symbol-function 'enriched-decode-display-prop)
784 (lambda (start end &optional param) (list start end))))
785 (notmuch-show-insert-part-*/* msg part content-type nth depth button))))
787 (defun notmuch-show-get-mime-type-of-application/octet-stream (part)
788 ;; If we can deduce a MIME type from the filename of the attachment,
790 (if (plist-get part :filename)
791 (let ((extension (file-name-extension (plist-get part :filename)))
795 (mailcap-parse-mimetypes)
796 (setq mime-type (mailcap-extension-to-mime extension))
798 (not (string-equal mime-type "application/octet-stream")))
803 (defun notmuch-show-insert-part-text/html (msg part content-type nth depth button)
804 (if (eq mm-text-html-renderer 'shr)
805 ;; It's easier to drive shr ourselves than to work around the
806 ;; goofy things `mm-shr' does (like irreversibly taking over
807 ;; content ID handling).
808 ;; FIXME: If we block an image, offer a button to load external
810 (let ((shr-blocked-images notmuch-show-text/html-blocked-images))
811 (notmuch-show--insert-part-text/html-shr msg part))
812 ;; Otherwise, let message-mode do the heavy lifting
814 ;; w3m sets up a keymap which "leaks" outside the invisible region
815 ;; and causes strange effects in notmuch. We set
816 ;; mm-inline-text-html-with-w3m-keymap to nil to tell w3m not to
817 ;; set a keymap (so the normal notmuch-show-mode-map remains).
818 (let ((mm-inline-text-html-with-w3m-keymap nil)
819 ;; FIXME: If we block an image, offer a button to load external
821 (gnus-blocked-images notmuch-show-text/html-blocked-images))
822 (notmuch-show-insert-part-*/* msg part content-type nth depth button))))
824 ;; These functions are used by notmuch-show--insert-part-text/html-shr
825 (declare-function libxml-parse-html-region "xml.c")
826 (declare-function shr-insert-document "shr")
828 (defun notmuch-show--insert-part-text/html-shr (msg part)
829 ;; Make sure shr is loaded before we start let-binding its globals
831 (let ((dom (let ((process-crypto notmuch-show-process-crypto))
833 (insert (notmuch-get-bodypart-text msg part process-crypto))
834 (libxml-parse-html-region (point-min) (point-max)))))
835 (shr-content-function
837 ;; shr strips the "cid:" part of URL, but doesn't
838 ;; URL-decode it (see RFC 2392).
839 (let ((cid (url-unhex-string url)))
840 (car (notmuch-show--get-cid-content cid))))))
841 (shr-insert-document dom)
844 (defun notmuch-show-insert-part-*/* (msg part content-type nth depth button)
845 ;; This handler _must_ succeed - it is the handler of last resort.
846 (notmuch-mm-display-part-inline msg part content-type notmuch-show-process-crypto)
849 ;; Functions for determining how to handle MIME parts.
851 (defun notmuch-show-handlers-for (content-type)
852 "Return a list of content handlers for a part of type CONTENT-TYPE."
857 ;; Reverse order of prefrence.
858 (list (intern (concat "notmuch-show-insert-part-*/*"))
860 "notmuch-show-insert-part-"
861 (car (notmuch-split-content-type content-type))
863 (intern (concat "notmuch-show-insert-part-" content-type))))
868 (defun notmuch-show-insert-bodypart-internal (msg part content-type nth depth button)
869 ;; Run the handlers until one of them succeeds.
870 (cl-loop for handler in (notmuch-show-handlers-for content-type)
871 until (condition-case err
872 (funcall handler msg part content-type nth depth button)
873 ;; Specifying `debug' here lets the debugger run if
874 ;; `debug-on-error' is non-nil.
876 (insert "!!! Bodypart handler `" (prin1-to-string handler)
877 "' threw an error:\n"
878 "!!! " (error-message-string err) "\n")
881 (defun notmuch-show-create-part-overlays (button beg end)
882 "Add an overlay to the part between BEG and END."
883 ;; If there is no button (i.e., the part is text/plain and the first
884 ;; part) or if the part has no content then we don't make the part
886 (when (and button (/= beg end))
887 (button-put button 'overlay (make-overlay beg end))
888 ;; Return true if we created an overlay.
891 (defun notmuch-show-record-part-information (part beg end)
892 "Store PART as a text property from BEG to END."
893 ;; Record part information. Since we already inserted subparts,
894 ;; don't override existing :notmuch-part properties.
895 (notmuch-map-text-property beg end :notmuch-part
896 (lambda (v) (or v part)))
897 ;; Make :notmuch-part front sticky and rear non-sticky so it stays
898 ;; applied to the beginning of each line when we indent the
899 ;; message. Since we're operating on arbitrary renderer output,
900 ;; watch out for sticky specs of t, which means all properties are
901 ;; front-sticky/rear-nonsticky.
902 (notmuch-map-text-property beg end 'front-sticky
905 (cl-pushnew :notmuch-part v)
907 (notmuch-map-text-property beg end 'rear-nonsticky
910 (cl-pushnew :notmuch-part v)
913 (defun notmuch-show-lazy-part (part-args button)
914 ;; Insert the lazy part after the button for the part. We would just
915 ;; move to the start of the new line following the button and insert
916 ;; the part but that point might have text properties (eg colours
917 ;; from a message header etc) so instead we start from the last
918 ;; character of the button by adding a newline and finish by
919 ;; removing the extra newline from the end of the part.
921 (goto-char (button-end button))
923 (let* ((inhibit-read-only t)
924 ;; We need to use markers for the start and end of the part
925 ;; because the part insertion functions do not guarantee
926 ;; to leave point at the end of the part.
927 (part-beg (copy-marker (point) nil))
928 (part-end (copy-marker (point) t))
929 ;; We have to save the depth as we can't find the depth
931 (depth (notmuch-show-get-depth)))
933 (narrow-to-region part-beg part-end)
934 (delete-region part-beg part-end)
935 (apply #'notmuch-show-insert-bodypart-internal part-args)
936 (indent-rigidly part-beg
938 (* notmuch-show-indent-messages-width depth)))
941 (notmuch-show-record-part-information (cadr part-args)
942 (button-start button)
944 ;; Create the overlay. If the lazy-part turned out to be empty/not
945 ;; showable this returns nil.
946 (notmuch-show-create-part-overlays button part-beg part-end))))
948 (defun notmuch-show-mime-type (part)
949 "Return the correct mime-type to use for PART."
950 (let ((content-type (downcase (plist-get part :content-type))))
951 (or (and (string= content-type "application/octet-stream")
952 (notmuch-show-get-mime-type-of-application/octet-stream part))
953 (and (string= content-type "inline patch")
957 ;; The following variable can be overridden by let bindings.
958 (defvar notmuch-show-insert-header-p-function 'notmuch-show-insert-header-p
959 "Specify which function decides which part headers get inserted.
961 The function should take two parameters, PART and HIDE, and
962 should return non-NIL if a header button should be inserted for
965 (defun notmuch-show-insert-header-p (part hide)
966 ;; Show all part buttons except for the first part if it is text/plain.
967 (let ((mime-type (notmuch-show-mime-type part)))
968 (not (and (string= mime-type "text/plain")
969 (<= (plist-get part :id) 1)))))
971 (defun notmuch-show-reply-insert-header-p-never (part hide)
974 (defun notmuch-show-reply-insert-header-p-trimmed (part hide)
975 (let ((mime-type (notmuch-show-mime-type part)))
976 (and (not (notmuch-match-content-type mime-type "multipart/*"))
979 (defun notmuch-show-reply-insert-header-p-minimal (part hide)
980 (let ((mime-type (notmuch-show-mime-type part)))
981 (and (notmuch-match-content-type mime-type "text/*")
984 (defun notmuch-show-insert-bodypart (msg part depth &optional hide)
985 "Insert the body part PART at depth DEPTH in the current thread.
987 HIDE determines whether to show or hide the part and the button
988 as follows: If HIDE is nil, show the part and the button. If HIDE
989 is t, hide the part initially and show the button."
990 (let* ((content-type (downcase (plist-get part :content-type)))
991 (mime-type (notmuch-show-mime-type part))
992 (nth (plist-get part :id))
993 (long (and (notmuch-match-content-type mime-type "text/*")
994 (> notmuch-show-max-text-part-size 0)
995 (> (length (plist-get part :content))
996 notmuch-show-max-text-part-size)))
998 ;; This default header-p function omits the part button for
999 ;; the first (or only) part if this is text/plain.
1000 (button (when (funcall notmuch-show-insert-header-p-function part hide)
1001 (notmuch-show-insert-part-header nth mime-type content-type
1002 (plist-get part :filename))))
1003 ;; Hide the part initially if HIDE is t, or if it is too long
1004 ;; and we have a button to allow toggling.
1005 (show-part (not (or (equal hide t)
1006 (and long button))))
1007 (content-beg (point)))
1008 ;; Store the computed mime-type for later use (e.g. by attachment handlers).
1009 (plist-put part :computed-type mime-type)
1011 (notmuch-show-insert-bodypart-internal msg part mime-type nth depth button)
1013 (button-put button :notmuch-lazy-part
1014 (list msg part mime-type nth depth button))))
1015 ;; Some of the body part handlers leave point somewhere up in the
1016 ;; part, so we make sure that we're down at the end.
1017 (goto-char (point-max))
1018 ;; Ensure that the part ends with a carriage return.
1021 ;; We do not create the overlay for hidden (lazy) parts until
1022 ;; they are inserted.
1024 (notmuch-show-create-part-overlays button content-beg (point))
1026 (notmuch-show-toggle-part-invisibility button)))
1027 (notmuch-show-record-part-information part beg (point))))
1029 (defun notmuch-show-insert-body (msg body depth)
1030 "Insert the body BODY at depth DEPTH in the current thread."
1031 ;; Register all content IDs for this message. According to RFC
1032 ;; 2392, content IDs are *global*, but it's okay if an MUA treats
1033 ;; them as only global within a message.
1034 (notmuch-show--register-cids msg (car body))
1035 (mapc (lambda (part) (notmuch-show-insert-bodypart msg part depth)) body))
1037 (defun notmuch-show-make-symbol (type)
1038 (make-symbol (concat "notmuch-show-" type)))
1040 (defun notmuch-show-strip-re (string)
1041 (replace-regexp-in-string "^\\([Rr]e: *\\)+" "" string))
1043 (defvar notmuch-show-previous-subject "")
1044 (make-variable-buffer-local 'notmuch-show-previous-subject)
1046 (defun notmuch-show-insert-msg (msg depth)
1047 "Insert the message MSG at depth DEPTH in the current thread."
1048 (let* ((headers (plist-get msg :headers))
1049 ;; Indentation causes the buffer offset of the start/end
1050 ;; points to move, so we must use markers.
1051 message-start message-end
1052 content-start content-end
1053 headers-start headers-end
1054 (bare-subject (notmuch-show-strip-re (plist-get headers :Subject))))
1055 (setq message-start (point-marker))
1056 (notmuch-show-insert-headerline headers
1057 (or (if notmuch-show-relative-dates
1058 (plist-get msg :date_relative)
1060 (plist-get headers :Date))
1061 (plist-get msg :tags) depth)
1062 (setq content-start (point-marker))
1063 ;; Set `headers-start' to point after the 'Subject:' header to be
1064 ;; compatible with the existing implementation. This just sets it
1065 ;; to after the first header.
1066 (notmuch-show-insert-headers headers)
1068 (goto-char content-start)
1069 ;; If the subject of this message is the same as that of the
1070 ;; previous message, don't display it when this message is
1072 (when (not (string= notmuch-show-previous-subject
1075 (setq headers-start (point-marker)))
1076 (setq headers-end (point-marker))
1077 (setq notmuch-show-previous-subject bare-subject)
1078 ;; A blank line between the headers and the body.
1080 (notmuch-show-insert-body msg (plist-get msg :body)
1081 (if notmuch-show-indent-content depth 0))
1082 ;; Ensure that the body ends with a newline.
1085 (setq content-end (point-marker))
1086 ;; Indent according to the depth in the thread.
1087 (if notmuch-show-indent-content
1088 (indent-rigidly content-start
1090 (* notmuch-show-indent-messages-width depth)))
1091 (setq message-end (point-max-marker))
1092 ;; Save the extents of this message over the whole text of the
1094 (put-text-property message-start message-end
1095 :notmuch-message-extent
1096 (cons message-start message-end))
1097 ;; Create overlays used to control visibility
1098 (plist-put msg :headers-overlay (make-overlay headers-start headers-end))
1099 (plist-put msg :message-overlay (make-overlay headers-start content-end))
1100 (plist-put msg :depth depth)
1101 ;; Save the properties for this message. Currently this saves the
1102 ;; entire message (augmented it with other stuff), which seems
1103 ;; like overkill. We might save a reduced subset (for example, not
1105 (notmuch-show-set-message-properties msg)
1106 ;; Set header visibility.
1107 (notmuch-show-headers-visible msg notmuch-message-headers-visible)
1108 ;; Message visibility depends on whether it matched the search
1110 (notmuch-show-message-visible msg (and (plist-get msg :match)
1111 (not (plist-get msg :excluded))))))
1113 (defun notmuch-show-toggle-process-crypto ()
1114 "Toggle the processing of cryptographic MIME parts."
1116 (setq notmuch-show-process-crypto (not notmuch-show-process-crypto))
1117 (message (if notmuch-show-process-crypto
1118 "Processing cryptographic MIME parts."
1119 "Not processing cryptographic MIME parts."))
1120 (notmuch-show-refresh-view))
1122 (defun notmuch-show-toggle-elide-non-matching ()
1123 "Toggle the display of non-matching messages."
1125 (setq notmuch-show-elide-non-matching-messages
1126 (not notmuch-show-elide-non-matching-messages))
1127 (message (if notmuch-show-elide-non-matching-messages
1128 "Showing matching messages only."
1129 "Showing all messages."))
1130 (notmuch-show-refresh-view))
1132 (defun notmuch-show-toggle-thread-indentation ()
1133 "Toggle the indentation of threads."
1135 (setq notmuch-show-indent-content (not notmuch-show-indent-content))
1136 (message (if notmuch-show-indent-content
1137 "Content is indented."
1138 "Content is not indented."))
1139 (notmuch-show-refresh-view))
1141 (defun notmuch-show-insert-tree (tree depth)
1142 "Insert the message tree TREE at depth DEPTH in the current thread."
1143 (let ((msg (car tree))
1144 (replies (cadr tree)))
1145 ;; We test whether there is a message or just some replies.
1147 (notmuch-show-insert-msg msg depth))
1148 (notmuch-show-insert-thread replies (1+ depth))))
1150 (defun notmuch-show-insert-thread (thread depth)
1151 "Insert the thread THREAD at depth DEPTH in the current forest."
1152 (mapc (lambda (tree) (notmuch-show-insert-tree tree depth)) thread))
1154 (defun notmuch-show-insert-forest (forest)
1155 "Insert the forest of threads FOREST."
1156 (mapc (lambda (thread) (notmuch-show-insert-thread thread 0)) forest))
1158 (defvar notmuch-id-regexp
1160 ;; Match the id: prefix only if it begins a word (to disallow, for
1161 ;; example, matching cid:).
1163 ;; If the term starts with a ", then parse Xapian's quoted boolean
1164 ;; term syntax, which allows for anything as long as embedded
1165 ;; double quotes escaped by doubling them. We also disallow
1166 ;; newlines (which Xapian allows) to prevent runaway terms.
1167 "\"\\([^\"\n]\\|\"\"\\)*\""
1168 ;; Otherwise, parse Xapian's unquoted syntax, which goes up to the
1169 ;; next space or ). We disallow [.,;] as the last character
1170 ;; because these are probably part of the surrounding text, and not
1171 ;; part of the id. This doesn't match single character ids; meh.
1172 "\\|[^\"[:space:])][^[:space:])]*[^])[:space:].,:;?!]"
1174 "The regexp used to match id: links in messages.")
1176 (defvar notmuch-mid-regexp
1177 ;; goto-address-url-regexp matched cid: links, which have the same
1178 ;; grammar as the message ID part of a mid: link. Construct the
1179 ;; regexp using the same technique as goto-address-url-regexp.
1180 (concat "\\<mid:\\(" thing-at-point-url-path-regexp "\\)")
1181 "The regexp used to match mid: links in messages.
1185 (defun notmuch-show-buttonise-links (start end)
1186 "Buttonise URLs and mail addresses between START and END.
1188 This also turns id:\"<message id>\"-parts and mid: links into
1189 buttons for a corresponding notmuch search."
1190 (goto-address-fontify-region start end)
1193 (beg-line (progn (goto-char start) (line-beginning-position)))
1194 (end-line (progn (goto-char end) (line-end-position))))
1195 (goto-char beg-line)
1196 (while (re-search-forward notmuch-id-regexp end-line t)
1197 (push (list (match-beginning 0) (match-end 0)
1198 (match-string-no-properties 0)) links))
1199 (goto-char beg-line)
1200 (while (re-search-forward notmuch-mid-regexp end-line t)
1201 (let* ((mid-cid (match-string-no-properties 1))
1202 (mid (save-match-data
1203 (string-match "^[^/]*" mid-cid)
1204 (url-unhex-string (match-string 0 mid-cid)))))
1205 (push (list (match-beginning 0) (match-end 0)
1206 (notmuch-id-to-query mid)) links)))
1207 (pcase-dolist (`(,beg ,end ,link) links)
1208 ;; Remove the overlay created by goto-address-mode
1209 (remove-overlays beg end 'goto-address t)
1210 (make-text-button beg end
1211 :type 'notmuch-button-type
1212 'action `(lambda (arg)
1213 (notmuch-show ,link current-prefix-arg))
1215 'help-echo "Mouse-1, RET: search for this message"
1216 'face goto-address-mail-face)))))
1219 (defun notmuch-show (thread-id &optional elide-toggle parent-buffer query-context buffer-name)
1220 "Run \"notmuch show\" with the given thread ID and display results.
1222 ELIDE-TOGGLE, if non-nil, inverts the default elide behavior.
1224 The optional PARENT-BUFFER is the notmuch-search buffer from
1225 which this notmuch-show command was executed, (so that the
1226 next thread from that buffer can be show when done with this
1229 The optional QUERY-CONTEXT is a notmuch search term. Only
1230 messages from the thread matching this search term are shown if
1233 The optional BUFFER-NAME provides the name of the buffer in
1234 which the message thread is shown. If it is nil (which occurs
1235 when the command is called interactively) the argument to the
1238 Returns the buffer containing the messages, or NIL if no messages
1240 (interactive "sNotmuch show: \nP")
1241 (let ((buffer-name (generate-new-buffer-name
1243 (concat "*notmuch-" thread-id "*"))))
1244 ;; We override mm-inline-override-types to stop application/*
1245 ;; parts from being displayed unless the user has customized
1247 (mm-inline-override-types
1248 (if (equal mm-inline-override-types
1249 (eval (car (get 'mm-inline-override-types 'standard-value))))
1250 (cons "application/*" mm-inline-override-types)
1251 mm-inline-override-types)))
1252 (switch-to-buffer (get-buffer-create buffer-name))
1253 ;; No need to track undo information for this buffer.
1254 (setq buffer-undo-list t)
1256 ;; Set various buffer local variables to their appropriate initial
1257 ;; state. Do this after enabling `notmuch-show-mode' so that they
1258 ;; aren't wiped out.
1259 (setq notmuch-show-thread-id thread-id
1260 notmuch-show-parent-buffer parent-buffer
1261 notmuch-show-query-context (if (or (string= query-context "")
1262 (string= query-context "*"))
1264 notmuch-show-process-crypto notmuch-crypto-process-mime
1265 ;; If `elide-toggle', invert the default value.
1266 notmuch-show-elide-non-matching-messages
1268 (not notmuch-show-only-matching-messages)
1269 notmuch-show-only-matching-messages))
1270 (add-hook 'post-command-hook #'notmuch-show-command-hook nil t)
1271 (jit-lock-register #'notmuch-show-buttonise-links)
1272 (notmuch-tag-clear-cache)
1273 (let ((inhibit-read-only t))
1274 (if (notmuch-show--build-buffer)
1275 ;; Messages were inserted into the buffer.
1277 ;; No messages were inserted - presumably none matched the
1279 (kill-buffer (current-buffer))
1281 (message "No messages matched the query!")
1284 (defun notmuch-show--build-queries (thread context)
1285 "Return a list of queries to try for this search.
1287 THREAD and CONTEXT are both strings, though CONTEXT may be nil.
1288 When CONTEXT is not nil, the first query is the conjunction of it
1289 and THREAD. The next query is THREAD alone, and serves as a
1290 fallback if the prior matches no messages."
1292 (push (list thread) queries)
1293 (if context (push (list thread "and (" context ")") queries))
1296 (defun notmuch-show--build-buffer (&optional state)
1297 "Display messages matching the current buffer context.
1299 Apply the previously saved STATE if supplied, otherwise show the
1300 first relevant message.
1302 If no messages match the query return NIL."
1303 (let* ((cli-args (cons "--exclude=false"
1304 (when notmuch-show-elide-non-matching-messages
1305 (list "--entire-thread=false"))))
1306 (queries (notmuch-show--build-queries
1307 notmuch-show-thread-id notmuch-show-query-context))
1309 ;; Must be reset every time we are going to start inserting
1310 ;; messages into the buffer.
1311 (notmuch-show-previous-subject ""))
1312 ;; Use results from the first query that returns some.
1313 (while (and (not forest) queries)
1314 (setq forest (notmuch-query-get-threads
1315 (append cli-args (list "'") (car queries) (list "'"))))
1316 (setq queries (cdr queries)))
1318 (notmuch-show-insert-forest forest)
1319 ;; Store the original tags for each message so that we can
1322 (lambda () (notmuch-show-set-prop :orig-tags (notmuch-show-get-tags))))
1323 ;; Set the header line to the subject of the first message.
1324 (setq header-line-format
1325 (replace-regexp-in-string "%" "%%"
1327 (notmuch-show-strip-re
1328 (notmuch-show-get-subject)))))
1329 (run-hooks 'notmuch-show-hook)
1331 (notmuch-show-apply-state state)
1332 ;; With no state to apply, just go to the first message.
1333 (notmuch-show-goto-first-wanted-message)))
1334 ;; Report back to the caller whether any messages matched.
1337 (defun notmuch-show-capture-state ()
1338 "Capture the state of the current buffer.
1341 - the list of open messages,
1342 - the combination of current message id with/for each visible window."
1343 (let* ((win-list (get-buffer-window-list (current-buffer) nil t))
1344 (win-id-combo (mapcar (lambda (win)
1345 (with-selected-window win
1346 (list win (notmuch-show-get-message-id))))
1348 (list win-id-combo (notmuch-show-get-message-ids-for-open-messages))))
1350 (defun notmuch-show-get-query ()
1351 "Return the current query in this show buffer."
1352 (if notmuch-show-query-context
1353 (concat notmuch-show-thread-id
1355 notmuch-show-query-context
1357 notmuch-show-thread-id))
1359 (defun notmuch-show-goto-message (msg-id)
1360 "Go to message with msg-id."
1361 (goto-char (point-min))
1362 (unless (cl-loop if (string= msg-id (notmuch-show-get-message-id))
1364 until (not (notmuch-show-goto-message-next)))
1365 (goto-char (point-min))
1366 (message "Message-id not found."))
1367 (notmuch-show-message-adjust))
1369 (defun notmuch-show-apply-state (state)
1370 "Apply STATE to the current buffer.
1373 - opening the messages previously opened,
1374 - closing all other messages,
1375 - moving to the correct current message in every displayed window."
1376 (let ((win-msg-alist (car state))
1377 (open (cadr state)))
1378 ;; Open those that were open.
1379 (goto-char (point-min))
1380 (cl-loop do (notmuch-show-message-visible
1381 (notmuch-show-get-message-properties)
1382 (member (notmuch-show-get-message-id) open))
1383 until (not (notmuch-show-goto-message-next)))
1384 (dolist (win-msg-pair win-msg-alist)
1385 (with-selected-window (car win-msg-pair)
1386 ;; Go to the previously open message in this window
1387 (notmuch-show-goto-message (cadr win-msg-pair))))))
1389 (defun notmuch-show-refresh-view (&optional reset-state)
1390 "Refresh the current view.
1392 Refreshes the current view, observing changes in display
1393 preferences. If invoked with a prefix argument (or RESET-STATE is
1394 non-nil) then the state of the buffer (open/closed messages) is
1395 reset based on the original query."
1397 (let ((inhibit-read-only t)
1398 (state (unless reset-state
1399 (notmuch-show-capture-state))))
1400 ;; `erase-buffer' does not seem to remove overlays, which can lead
1401 ;; to weird effects such as remaining images, so remove them
1405 (unless (notmuch-show--build-buffer state)
1406 ;; No messages were inserted.
1407 (kill-buffer (current-buffer))
1409 (message "Refreshing the buffer resulted in no messages!"))))
1411 (defvar notmuch-show-stash-map
1412 (let ((map (make-sparse-keymap)))
1413 (define-key map "c" 'notmuch-show-stash-cc)
1414 (define-key map "d" 'notmuch-show-stash-date)
1415 (define-key map "F" 'notmuch-show-stash-filename)
1416 (define-key map "f" 'notmuch-show-stash-from)
1417 (define-key map "i" 'notmuch-show-stash-message-id)
1418 (define-key map "I" 'notmuch-show-stash-message-id-stripped)
1419 (define-key map "s" 'notmuch-show-stash-subject)
1420 (define-key map "T" 'notmuch-show-stash-tags)
1421 (define-key map "t" 'notmuch-show-stash-to)
1422 (define-key map "l" 'notmuch-show-stash-mlarchive-link)
1423 (define-key map "L" 'notmuch-show-stash-mlarchive-link-and-go)
1424 (define-key map "G" 'notmuch-show-stash-git-send-email)
1425 (define-key map "?" 'notmuch-subkeymap-help)
1427 "Submap for stash commands.")
1428 (fset 'notmuch-show-stash-map notmuch-show-stash-map)
1430 (defvar notmuch-show-part-map
1431 (let ((map (make-sparse-keymap)))
1432 (define-key map "s" 'notmuch-show-save-part)
1433 (define-key map "v" 'notmuch-show-view-part)
1434 (define-key map "o" 'notmuch-show-interactively-view-part)
1435 (define-key map "|" 'notmuch-show-pipe-part)
1436 (define-key map "m" 'notmuch-show-choose-mime-of-part)
1437 (define-key map "?" 'notmuch-subkeymap-help)
1439 "Submap for part commands.")
1440 (fset 'notmuch-show-part-map notmuch-show-part-map)
1442 (defvar notmuch-show-mode-map
1443 (let ((map (make-sparse-keymap)))
1444 (set-keymap-parent map notmuch-common-keymap)
1445 (define-key map "Z" 'notmuch-tree-from-show-current-query)
1446 (define-key map "U" 'notmuch-unthreaded-from-show-current-query)
1447 (define-key map (kbd "<C-tab>") 'widget-backward)
1448 (define-key map (kbd "M-TAB") 'notmuch-show-previous-button)
1449 (define-key map (kbd "<backtab>") 'notmuch-show-previous-button)
1450 (define-key map (kbd "TAB") 'notmuch-show-next-button)
1451 (define-key map "f" 'notmuch-show-forward-message)
1452 (define-key map "F" 'notmuch-show-forward-open-messages)
1453 (define-key map "b" 'notmuch-show-resend-message)
1454 (define-key map "l" 'notmuch-show-filter-thread)
1455 (define-key map "r" 'notmuch-show-reply-sender)
1456 (define-key map "R" 'notmuch-show-reply)
1457 (define-key map "|" 'notmuch-show-pipe-message)
1458 (define-key map "w" 'notmuch-show-save-attachments)
1459 (define-key map "V" 'notmuch-show-view-raw-message)
1460 (define-key map "e" 'notmuch-show-resume-message)
1461 (define-key map "c" 'notmuch-show-stash-map)
1462 (define-key map "h" 'notmuch-show-toggle-visibility-headers)
1463 (define-key map "k" 'notmuch-tag-jump)
1464 (define-key map "*" 'notmuch-show-tag-all)
1465 (define-key map "-" 'notmuch-show-remove-tag)
1466 (define-key map "+" 'notmuch-show-add-tag)
1467 (define-key map "X" 'notmuch-show-archive-thread-then-exit)
1468 (define-key map "x" 'notmuch-show-archive-message-then-next-or-exit)
1469 (define-key map "A" 'notmuch-show-archive-thread-then-next)
1470 (define-key map "a" 'notmuch-show-archive-message-then-next-or-next-thread)
1471 (define-key map "N" 'notmuch-show-next-message)
1472 (define-key map "P" 'notmuch-show-previous-message)
1473 (define-key map "n" 'notmuch-show-next-open-message)
1474 (define-key map "p" 'notmuch-show-previous-open-message)
1475 (define-key map (kbd "M-n") 'notmuch-show-next-thread-show)
1476 (define-key map (kbd "M-p") 'notmuch-show-previous-thread-show)
1477 (define-key map (kbd "DEL") 'notmuch-show-rewind)
1478 (define-key map " " 'notmuch-show-advance-and-archive)
1479 (define-key map (kbd "M-RET") 'notmuch-show-open-or-close-all)
1480 (define-key map (kbd "RET") 'notmuch-show-toggle-message)
1481 (define-key map "#" 'notmuch-show-print-message)
1482 (define-key map "!" 'notmuch-show-toggle-elide-non-matching)
1483 (define-key map "$" 'notmuch-show-toggle-process-crypto)
1484 (define-key map "<" 'notmuch-show-toggle-thread-indentation)
1485 (define-key map "t" 'toggle-truncate-lines)
1486 (define-key map "." 'notmuch-show-part-map)
1487 (define-key map "B" 'notmuch-show-browse-urls)
1489 "Keymap for \"notmuch show\" buffers.")
1490 (fset 'notmuch-show-mode-map notmuch-show-mode-map)
1492 (define-derived-mode notmuch-show-mode fundamental-mode "notmuch-show"
1493 "Major mode for viewing a thread with notmuch.
1495 This buffer contains the results of the \"notmuch show\" command
1496 for displaying a single thread of email from your email archives.
1498 By default, various components of email messages, (citations,
1499 signatures, already-read messages), are hidden. You can make
1500 these parts visible by clicking with the mouse button or by
1501 pressing RET after positioning the cursor on a hidden part, (for
1502 which \\[notmuch-show-next-button] and \\[notmuch-show-previous-button] are helpful).
1504 Reading the thread sequentially is well-supported by pressing
1505 \\[notmuch-show-advance-and-archive]. This will scroll the current message (if necessary), advance
1506 to the next message, or advance to the next thread (if already on
1507 the last message of a thread).
1509 Other commands are available to read or manipulate the thread
1510 more selectively, (such as '\\[notmuch-show-next-message]' and '\\[notmuch-show-previous-message]' to advance to messages
1511 without removing any tags, and '\\[notmuch-show-archive-thread]' to archive an entire thread
1512 without scrolling through with \\[notmuch-show-advance-and-archive]).
1514 You can add or remove arbitrary tags from the current message with
1515 '\\[notmuch-show-add-tag]' or '\\[notmuch-show-remove-tag]'.
1517 All currently available key bindings:
1519 \\{notmuch-show-mode-map}"
1520 (setq notmuch-buffer-refresh-function #'notmuch-show-refresh-view)
1521 (setq buffer-read-only t
1523 (setq imenu-prev-index-position-function
1524 #'notmuch-show-imenu-prev-index-position-function)
1525 (setq imenu-extract-index-name-function
1526 #'notmuch-show-imenu-extract-index-name-function))
1528 (defun notmuch-tree-from-show-current-query ()
1529 "Call notmuch tree with the current query."
1531 (notmuch-tree notmuch-show-thread-id
1532 notmuch-show-query-context
1533 (notmuch-show-get-message-id)))
1535 (defun notmuch-unthreaded-from-show-current-query ()
1536 "Call notmuch unthreaded with the current query."
1538 (notmuch-unthreaded notmuch-show-thread-id
1539 notmuch-show-query-context
1540 (notmuch-show-get-message-id)))
1542 (defun notmuch-show-move-to-message-top ()
1543 (goto-char (notmuch-show-message-top)))
1545 (defun notmuch-show-move-to-message-bottom ()
1546 (goto-char (notmuch-show-message-bottom)))
1548 (defun notmuch-show-message-adjust ()
1551 ;; Movement related functions.
1553 ;; There's some strangeness here where a text property applied to a
1554 ;; region a->b is not found when point is at b. We walk backwards
1555 ;; until finding the property.
1556 (defun notmuch-show-message-extent ()
1557 "Return a cons cell containing the start and end buffer offset
1558 of the current message."
1561 (while (not (setq r (get-text-property (point) :notmuch-message-extent)))
1565 (defun notmuch-show-message-top ()
1566 (car (notmuch-show-message-extent)))
1568 (defun notmuch-show-message-bottom ()
1569 (cdr (notmuch-show-message-extent)))
1571 (defun notmuch-show-goto-message-next ()
1572 (let ((start (point)))
1573 (notmuch-show-move-to-message-bottom)
1579 (defun notmuch-show-goto-message-previous ()
1580 (notmuch-show-move-to-message-top)
1584 (notmuch-show-move-to-message-top)
1587 (defun notmuch-show-mapc (function)
1588 "Iterate through all messages in the current thread with
1589 `notmuch-show-goto-message-next' and call FUNCTION for side
1592 (goto-char (point-min))
1593 (cl-loop do (funcall function)
1594 while (notmuch-show-goto-message-next))))
1596 ;; Functions relating to the visibility of messages and their
1599 (defun notmuch-show-message-visible (props visible-p)
1600 (overlay-put (plist-get props :message-overlay) 'invisible (not visible-p))
1601 (notmuch-show-set-prop :message-visible visible-p props))
1603 (defun notmuch-show-headers-visible (props visible-p)
1604 (overlay-put (plist-get props :headers-overlay) 'invisible (not visible-p))
1605 (notmuch-show-set-prop :headers-visible visible-p props))
1607 ;; Functions for setting and getting attributes of the current
1610 (defun notmuch-show-set-message-properties (props)
1612 (notmuch-show-move-to-message-top)
1613 (put-text-property (point) (+ (point) 1)
1614 :notmuch-message-properties props)))
1616 (defun notmuch-show-get-message-properties ()
1617 "Return the properties of the current message as a plist.
1619 Some useful entries are:
1620 :headers - Property list containing the headers :Date, :Subject, :From, etc.
1621 :body - Body of the message
1622 :tags - Tags for this message"
1624 (notmuch-show-move-to-message-top)
1625 (get-text-property (point) :notmuch-message-properties)))
1627 (defun notmuch-show-get-part-properties ()
1628 "Return the properties of the innermost part containing point.
1630 This is the part property list retrieved from the CLI. Signals
1631 an error if there is no part containing point."
1632 (or (get-text-property (point) :notmuch-part)
1633 (error "No message part here")))
1635 (defun notmuch-show-set-prop (prop val &optional props)
1636 (let ((inhibit-read-only t)
1638 (notmuch-show-get-message-properties))))
1639 (plist-put props prop val)
1640 (notmuch-show-set-message-properties props)))
1642 (defun notmuch-show-get-prop (prop &optional props)
1643 "Get property PROP from current message in show or tree mode.
1645 It gets property PROP from PROPS or, if PROPS is nil, the current
1646 message in either tree or show. This means that several utility
1647 functions in notmuch-show can be used directly by notmuch-tree as
1648 they just need the correct message properties."
1649 (let ((props (or props
1650 (cond ((eq major-mode 'notmuch-show-mode)
1651 (notmuch-show-get-message-properties))
1652 ((eq major-mode 'notmuch-tree-mode)
1653 (notmuch-tree-get-message-properties))
1655 (plist-get props prop)))
1657 (defun notmuch-show-get-message-id (&optional bare)
1658 "Return an id: query for the Message-Id of the current message.
1660 If optional argument BARE is non-nil, return
1661 the Message-Id without id: prefix and escaping."
1663 (notmuch-show-get-prop :id)
1664 (notmuch-id-to-query (notmuch-show-get-prop :id))))
1666 (defun notmuch-show-get-messages-ids ()
1667 "Return all id: queries of messages in the current thread."
1668 (let ((message-ids))
1670 (lambda () (push (notmuch-show-get-message-id) message-ids)))
1673 (defun notmuch-show-get-messages-ids-search ()
1674 "Return a search string for all message ids of messages in the
1676 (mapconcat 'identity (notmuch-show-get-messages-ids) " or "))
1678 ;; dme: Would it make sense to use a macro for many of these?
1680 ;; XXX TODO figure out what to do about multiple filenames
1681 (defun notmuch-show-get-filename ()
1682 "Return the filename of the current message."
1683 (car (notmuch-show-get-prop :filename)))
1685 (defun notmuch-show-get-header (header &optional props)
1686 "Return the named header of the current message, if any."
1687 (plist-get (notmuch-show-get-prop :headers props) header))
1689 (defun notmuch-show-get-cc ()
1690 (notmuch-show-get-header :Cc))
1692 (defun notmuch-show-get-date ()
1693 (notmuch-show-get-header :Date))
1695 (defun notmuch-show-get-timestamp ()
1696 (notmuch-show-get-prop :timestamp))
1698 (defun notmuch-show-get-from ()
1699 (notmuch-show-get-header :From))
1701 (defun notmuch-show-get-subject ()
1702 (notmuch-show-get-header :Subject))
1704 (defun notmuch-show-get-to ()
1705 (notmuch-show-get-header :To))
1707 (defun notmuch-show-get-depth ()
1708 (notmuch-show-get-prop :depth))
1710 (defun notmuch-show-set-tags (tags)
1711 "Set the tags of the current message."
1712 (notmuch-show-set-prop :tags tags)
1713 (notmuch-show-update-tags tags))
1715 (defun notmuch-show-get-tags ()
1716 "Return the tags of the current message."
1717 (notmuch-show-get-prop :tags))
1719 (defun notmuch-show-message-visible-p ()
1720 "Is the current message visible?"
1721 (notmuch-show-get-prop :message-visible))
1723 (defun notmuch-show-headers-visible-p ()
1724 "Are the headers of the current message visible?"
1725 (notmuch-show-get-prop :headers-visible))
1727 (put 'notmuch-show-mark-read 'notmuch-prefix-doc
1728 "Mark the current message as unread.")
1729 (defun notmuch-show-mark-read (&optional unread)
1730 "Mark the current message as read.
1732 Mark the current message as read by applying the tag changes in
1733 `notmuch-show-mark-read-tags' to it (remove the \"unread\" tag by
1734 default). If a prefix argument is given, the message will be
1735 marked as unread, i.e. the tag changes in
1736 `notmuch-show-mark-read-tags' will be reversed."
1738 (when notmuch-show-mark-read-tags
1739 (apply 'notmuch-show-tag-message
1740 (notmuch-tag-change-list notmuch-show-mark-read-tags unread))))
1742 (defun notmuch-show-seen-current-message (start end)
1743 "Mark the current message read if it is open.
1745 We only mark it read once: if it is changed back then that is a
1746 user decision and we should not override it."
1747 (when (and (notmuch-show-message-visible-p)
1748 (not (notmuch-show-get-prop :seen)))
1749 (notmuch-show-mark-read)
1750 (notmuch-show-set-prop :seen t)))
1752 (defvar notmuch-show--seen-has-errored nil)
1753 (make-variable-buffer-local 'notmuch-show--seen-has-errored)
1755 (defun notmuch-show-command-hook ()
1756 (when (eq major-mode 'notmuch-show-mode)
1757 ;; We need to redisplay to get window-start and window-end correct.
1761 (funcall notmuch-show-mark-read-function (window-start) (window-end))
1763 (unless notmuch-show--seen-has-errored
1764 (setq notmuch-show--seen-has-errored 't)
1765 (setq header-line-format
1766 (concat header-line-format
1768 " [some mark read tag changes may have failed]"
1769 'face font-lock-warning-face)))))))))
1771 (defun notmuch-show-filter-thread (query)
1772 "Filter or LIMIT the current thread based on a new query string.
1774 Reshows the current thread with matches defined by the new query-string."
1775 (interactive (list (notmuch-read-query "Filter thread: ")))
1776 (let ((msg-id (notmuch-show-get-message-id)))
1777 (setq notmuch-show-query-context (if (string= query "") nil query))
1778 (notmuch-show-refresh-view t)
1779 (notmuch-show-goto-message msg-id)))
1781 ;; Functions for getting attributes of several messages in the current
1784 (defun notmuch-show-get-message-ids-for-open-messages ()
1785 "Return a list of all id: queries for open messages in the current thread."
1787 (let (message-ids done)
1788 (goto-char (point-min))
1790 (if (notmuch-show-message-visible-p)
1792 (append message-ids (list (notmuch-show-get-message-id)))))
1793 (setq done (not (notmuch-show-goto-message-next))))
1796 ;; Commands typically bound to keys.
1798 (defun notmuch-show-advance ()
1799 "Advance through thread.
1801 If the current message in the thread is not yet fully visible,
1802 scroll by a near screenful to read more of the message.
1804 Otherwise, (the end of the current message is already within the
1805 current window), advance to the next open message."
1807 (let* ((end-of-this-message (notmuch-show-message-bottom))
1808 (visible-end-of-this-message (1- end-of-this-message))
1810 (while (invisible-p visible-end-of-this-message)
1811 (setq visible-end-of-this-message
1813 (1- (previous-single-char-property-change
1814 visible-end-of-this-message 'invisible)))))
1816 ;; Ideally we would test `end-of-this-message' against the result
1817 ;; of `window-end', but that doesn't account for the fact that
1818 ;; the end of the message might be hidden.
1819 ((and visible-end-of-this-message
1820 (> visible-end-of-this-message (window-end)))
1821 ;; The bottom of this message is not visible - scroll.
1823 ((not (= end-of-this-message (point-max)))
1824 ;; This is not the last message - move to the next visible one.
1825 (notmuch-show-next-open-message))
1826 ((not (= (point) (point-max)))
1827 ;; This is the last message, but the cursor is not at the end of
1828 ;; the buffer. Move it there.
1829 (goto-char (point-max)))
1831 ;; This is the last message - change the return value
1835 (defun notmuch-show-advance-and-archive ()
1836 "Advance through thread and archive.
1838 This command is intended to be one of the simplest ways to
1839 process a thread of email. It works exactly like
1840 notmuch-show-advance, in that it scrolls through messages in a
1841 show buffer, except that when it gets to the end of the buffer it
1842 archives the entire current thread, (apply changes in
1843 `notmuch-archive-tags'), kills the buffer, and displays the next
1844 thread from the search from which this thread was originally
1847 (if (notmuch-show-advance)
1848 (notmuch-show-archive-thread-then-next)))
1850 (defun notmuch-show-rewind ()
1851 "Backup through the thread (reverse scrolling compared to \
1852 \\[notmuch-show-advance-and-archive]).
1854 Specifically, if the beginning of the previous email is fewer
1855 than `window-height' lines from the current point, move to it
1856 just like `notmuch-show-previous-message'.
1858 Otherwise, just scroll down a screenful of the current message.
1860 This command does not modify any message tags, (it does not undo
1861 any effects from previous calls to
1862 `notmuch-show-advance-and-archive'."
1864 (let ((start-of-message (notmuch-show-message-top))
1865 (start-of-window (window-start)))
1867 ;; Either this message is properly aligned with the start of the
1868 ;; window or the start of this message is not visible on the
1870 ((or (= start-of-message start-of-window)
1871 (< start-of-message start-of-window))
1873 ;; If a small number of lines from the previous message are
1874 ;; visible, realign so that the top of the current message is at
1875 ;; the top of the screen.
1876 (when (<= (count-screen-lines (window-start) start-of-message)
1877 next-screen-context-lines)
1878 (goto-char (notmuch-show-message-top))
1879 (notmuch-show-message-adjust))
1880 ;; Move to the top left of the window.
1881 (goto-char (window-start)))
1883 ;; Move to the previous message.
1884 (notmuch-show-previous-message)))))
1886 (put 'notmuch-show-reply 'notmuch-prefix-doc "... and prompt for sender")
1887 (defun notmuch-show-reply (&optional prompt-for-sender)
1888 "Reply to the sender and all recipients of the current message."
1890 (notmuch-mua-new-reply (notmuch-show-get-message-id) prompt-for-sender t))
1892 (put 'notmuch-show-reply-sender 'notmuch-prefix-doc "... and prompt for sender")
1893 (defun notmuch-show-reply-sender (&optional prompt-for-sender)
1894 "Reply to the sender of the current message."
1896 (notmuch-mua-new-reply (notmuch-show-get-message-id) prompt-for-sender nil))
1898 (put 'notmuch-show-forward-message 'notmuch-prefix-doc
1899 "... and prompt for sender")
1900 (defun notmuch-show-forward-message (&optional prompt-for-sender)
1901 "Forward the current message."
1903 (notmuch-mua-new-forward-messages (list (notmuch-show-get-message-id))
1906 (put 'notmuch-show-forward-open-messages 'notmuch-prefix-doc
1907 "... and prompt for sender")
1908 (defun notmuch-show-forward-open-messages (&optional prompt-for-sender)
1909 "Forward the currently open messages."
1911 (let ((open-messages (notmuch-show-get-message-ids-for-open-messages)))
1912 (unless open-messages
1913 (error "No open messages to forward."))
1914 (notmuch-mua-new-forward-messages open-messages prompt-for-sender)))
1916 (defun notmuch-show-resend-message (addresses)
1917 "Resend the current message."
1918 (interactive (list (notmuch-address-from-minibuffer "Resend to: ")))
1919 (when (y-or-n-p (concat "Confirm resend to " addresses " "))
1920 (notmuch-show-view-raw-message)
1921 (message-resend addresses)
1922 (notmuch-bury-or-kill-this-buffer)))
1924 (defun notmuch-show-next-message (&optional pop-at-end)
1925 "Show the next message.
1927 If a prefix argument is given and this is the last message in the
1928 thread, navigate to the next thread in the parent search buffer."
1930 (if (notmuch-show-goto-message-next)
1931 (notmuch-show-message-adjust)
1933 (notmuch-show-next-thread)
1934 (goto-char (point-max)))))
1936 (defun notmuch-show-previous-message ()
1937 "Show the previous message or the start of the current message."
1939 (if (= (point) (notmuch-show-message-top))
1940 (notmuch-show-goto-message-previous)
1941 (notmuch-show-move-to-message-top))
1942 (notmuch-show-message-adjust))
1944 (defun notmuch-show-next-open-message (&optional pop-at-end)
1945 "Show the next open message.
1947 If a prefix argument is given and this is the last open message
1948 in the thread, navigate to the next thread in the parent search
1949 buffer. Return t if there was a next open message in the thread
1950 to show, nil otherwise."
1953 (while (and (setq r (notmuch-show-goto-message-next))
1954 (not (notmuch-show-message-visible-p))))
1956 (notmuch-show-message-adjust)
1958 (notmuch-show-next-thread)
1959 (goto-char (point-max))))
1962 (defun notmuch-show-next-matching-message ()
1963 "Show the next matching message."
1966 (while (and (setq r (notmuch-show-goto-message-next))
1967 (not (notmuch-show-get-prop :match))))
1969 (notmuch-show-message-adjust)
1970 (goto-char (point-max)))))
1972 (defun notmuch-show-open-if-matched ()
1973 "Open a message if it is matched (whether or not excluded)."
1974 (let ((props (notmuch-show-get-message-properties)))
1975 (notmuch-show-message-visible props (plist-get props :match))))
1977 (defun notmuch-show-goto-first-wanted-message ()
1978 "Move to the first open message and mark it read."
1979 (goto-char (point-min))
1980 (unless (notmuch-show-message-visible-p)
1981 (notmuch-show-next-open-message))
1983 ;; There are no matched non-excluded messages so open all matched
1984 ;; (necessarily excluded) messages and go to the first.
1985 (notmuch-show-mapc 'notmuch-show-open-if-matched)
1986 (force-window-update)
1987 (goto-char (point-min))
1988 (unless (notmuch-show-message-visible-p)
1989 (notmuch-show-next-open-message))))
1991 (defun notmuch-show-previous-open-message ()
1992 "Show the previous open message."
1994 (while (and (if (= (point) (notmuch-show-message-top))
1995 (notmuch-show-goto-message-previous)
1996 (notmuch-show-move-to-message-top))
1997 (not (notmuch-show-message-visible-p))))
1998 (notmuch-show-message-adjust))
2000 (defun notmuch-show-view-raw-message ()
2001 "View the original source of the current message."
2003 (let* ((id (notmuch-show-get-message-id))
2004 (buf (get-buffer-create (concat "*notmuch-raw-" id "*")))
2005 (inhibit-read-only t))
2006 (switch-to-buffer buf)
2008 (let ((coding-system-for-read 'no-conversion))
2009 (call-process notmuch-command nil t nil "show" "--format=raw" id))
2010 (goto-char (point-min))
2011 (set-buffer-modified-p nil)
2012 (setq buffer-read-only t)
2013 (view-buffer buf 'kill-buffer-if-not-modified)))
2015 (defun notmuch-show-resume-message ()
2016 "Resume EDITING the current draft message."
2018 (notmuch-draft-resume (notmuch-show-get-message-id)))
2020 (put 'notmuch-show-pipe-message 'notmuch-doc
2021 "Pipe the contents of the current message to a command.")
2022 (put 'notmuch-show-pipe-message 'notmuch-prefix-doc
2023 "Pipe the thread as an mbox to a command.")
2024 (defun notmuch-show-pipe-message (entire-thread command)
2025 "Pipe the contents of the current message (or thread) to COMMAND.
2027 COMMAND will be executed with the raw contents of the current
2028 email message as stdin. Anything printed by the command to stdout
2029 or stderr will appear in the *notmuch-pipe* buffer.
2031 If ENTIRE-THREAD is non-nil (or when invoked with a prefix
2032 argument), COMMAND will receive all open messages in the current
2033 thread (formatted as an mbox) rather than only the current
2035 (interactive (let ((query-string (if current-prefix-arg
2036 "Pipe all open messages to command: "
2037 "Pipe message to command: ")))
2038 (list current-prefix-arg (read-string query-string))))
2039 (let (shell-command)
2042 (concat notmuch-command " show --format=mbox --exclude=false "
2043 (shell-quote-argument
2044 (mapconcat 'identity
2045 (notmuch-show-get-message-ids-for-open-messages)
2049 (concat notmuch-command " show --format=raw "
2050 (shell-quote-argument (notmuch-show-get-message-id))
2052 (let ((cwd default-directory)
2053 (buf (get-buffer-create (concat "*notmuch-pipe*"))))
2054 (with-current-buffer buf
2055 (setq buffer-read-only nil)
2057 ;; Use the originating buffer's working directory instead of
2058 ;; that of the pipe buffer.
2060 (let ((exit-code (call-process-shell-command shell-command nil buf)))
2061 (goto-char (point-max))
2062 (set-buffer-modified-p nil)
2063 (setq buffer-read-only t)
2064 (unless (zerop exit-code)
2065 (switch-to-buffer-other-window buf)
2066 (message (format "Command '%s' exited abnormally with code %d"
2067 shell-command exit-code))))))))
2069 (defun notmuch-show-tag-message (&rest tag-changes)
2070 "Change tags for the current message.
2072 TAG-CHANGES is a list of tag operations for `notmuch-tag'."
2073 (let* ((current-tags (notmuch-show-get-tags))
2074 (new-tags (notmuch-update-tags current-tags tag-changes)))
2075 (unless (equal current-tags new-tags)
2076 (notmuch-tag (notmuch-show-get-message-id) tag-changes)
2077 (notmuch-show-set-tags new-tags))))
2079 (defun notmuch-show-tag (tag-changes)
2080 "Change tags for the current message.
2082 See `notmuch-tag' for information on the format of TAG-CHANGES."
2083 (interactive (list (notmuch-read-tag-changes (notmuch-show-get-tags)
2085 (notmuch-tag (notmuch-show-get-message-id) tag-changes)
2086 (let* ((current-tags (notmuch-show-get-tags))
2087 (new-tags (notmuch-update-tags current-tags tag-changes)))
2088 (unless (equal current-tags new-tags)
2089 (notmuch-show-set-tags new-tags))))
2091 (defun notmuch-show-tag-all (tag-changes)
2092 "Change tags for all messages in the current show buffer.
2094 See `notmuch-tag' for information on the format of TAG-CHANGES."
2098 (lambda () (setq tags (append (notmuch-show-get-tags) tags))))
2099 (notmuch-read-tag-changes tags "Tag thread"))))
2100 (notmuch-tag (notmuch-show-get-messages-ids-search) tag-changes)
2103 (let* ((current-tags (notmuch-show-get-tags))
2104 (new-tags (notmuch-update-tags current-tags tag-changes)))
2105 (unless (equal current-tags new-tags)
2106 (notmuch-show-set-tags new-tags))))))
2108 (defun notmuch-show-add-tag (tag-changes)
2109 "Change tags for the current message (defaulting to add).
2111 Same as `notmuch-show-tag' but sets initial input to '+'."
2113 (list (notmuch-read-tag-changes (notmuch-show-get-tags) "Tag message" "+")))
2114 (notmuch-show-tag tag-changes))
2116 (defun notmuch-show-remove-tag (tag-changes)
2117 "Change tags for the current message (defaulting to remove).
2119 Same as `notmuch-show-tag' but sets initial input to '-'."
2121 (list (notmuch-read-tag-changes (notmuch-show-get-tags) "Tag message" "-")))
2122 (notmuch-show-tag tag-changes))
2124 (defun notmuch-show-toggle-visibility-headers ()
2125 "Toggle the visibility of the current message headers."
2127 (let ((props (notmuch-show-get-message-properties)))
2128 (notmuch-show-headers-visible
2130 (not (plist-get props :headers-visible))))
2131 (force-window-update))
2133 (defun notmuch-show-toggle-message ()
2134 "Toggle the visibility of the current message."
2136 (let ((props (notmuch-show-get-message-properties)))
2137 (notmuch-show-message-visible
2139 (not (plist-get props :message-visible))))
2140 (force-window-update))
2142 (put 'notmuch-show-open-or-close-all 'notmuch-doc "Show all messages.")
2143 (put 'notmuch-show-open-or-close-all 'notmuch-prefix-doc "Hide all messages.")
2144 (defun notmuch-show-open-or-close-all ()
2145 "Set the visibility all of the messages in the current thread.
2147 By default make all of the messages visible. With a prefix
2148 argument, hide all of the messages."
2151 (goto-char (point-min))
2152 (cl-loop do (notmuch-show-message-visible
2153 (notmuch-show-get-message-properties)
2154 (not current-prefix-arg))
2155 until (not (notmuch-show-goto-message-next))))
2156 (force-window-update))
2158 (defun notmuch-show-next-button ()
2159 "Advance point to the next button in the buffer."
2163 (defun notmuch-show-previous-button ()
2164 "Move point back to the previous button in the buffer."
2166 (backward-button 1))
2168 (defun notmuch-show-next-thread (&optional show previous)
2169 "Move to the next item in the search results, if any.
2171 If SHOW is non-nil, open the next item in a show
2172 buffer. Otherwise just highlight the next item in the search
2173 buffer. If PREVIOUS is non-nil, move to the previous item in the
2174 search results instead."
2176 (let ((parent-buffer notmuch-show-parent-buffer))
2177 (notmuch-bury-or-kill-this-buffer)
2178 (when (buffer-live-p parent-buffer)
2179 (switch-to-buffer parent-buffer)
2181 (notmuch-search-previous-thread)
2182 (notmuch-search-next-thread))
2184 (notmuch-search-show-thread)))))
2186 (defun notmuch-show-next-thread-show ()
2187 "Show the next thread in the search results, if any."
2189 (notmuch-show-next-thread t))
2191 (defun notmuch-show-previous-thread-show ()
2192 "Show the previous thread in the search results, if any."
2194 (notmuch-show-next-thread t t))
2196 (put 'notmuch-show-archive-thread 'notmuch-prefix-doc
2197 "Un-archive each message in thread.")
2198 (defun notmuch-show-archive-thread (&optional unarchive)
2199 "Archive each message in thread.
2201 Archive each message currently shown by applying the tag changes
2202 in `notmuch-archive-tags' to each. If a prefix argument is given,
2203 the messages will be \"unarchived\", i.e. the tag changes in
2204 `notmuch-archive-tags' will be reversed.
2206 Note: This command is safe from any race condition of new messages
2207 being delivered to the same thread. It does not archive the
2208 entire thread, but only the messages shown in the current
2211 (when notmuch-archive-tags
2212 (notmuch-show-tag-all
2213 (notmuch-tag-change-list notmuch-archive-tags unarchive))))
2215 (defun notmuch-show-archive-thread-then-next ()
2216 "Archive all messages in the current buffer, then show next thread from search."
2218 (notmuch-show-archive-thread)
2219 (notmuch-show-next-thread t))
2221 (defun notmuch-show-archive-thread-then-exit ()
2222 "Archive all messages in the current buffer, then exit back to search results."
2224 (notmuch-show-archive-thread)
2225 (notmuch-show-next-thread))
2227 (put 'notmuch-show-archive-message 'notmuch-prefix-doc
2228 "Un-archive the current message.")
2229 (defun notmuch-show-archive-message (&optional unarchive)
2230 "Archive the current message.
2232 Archive the current message by applying the tag changes in
2233 `notmuch-archive-tags' to it. If a prefix argument is given, the
2234 message will be \"unarchived\", i.e. the tag changes in
2235 `notmuch-archive-tags' will be reversed."
2237 (when notmuch-archive-tags
2238 (apply 'notmuch-show-tag-message
2239 (notmuch-tag-change-list notmuch-archive-tags unarchive))))
2241 (defun notmuch-show-archive-message-then-next-or-exit ()
2242 "Archive current message, then show next open message in current thread.
2244 If at the last open message in the current thread, then exit back
2247 (notmuch-show-archive-message)
2248 (notmuch-show-next-open-message t))
2250 (defun notmuch-show-archive-message-then-next-or-next-thread ()
2251 "Archive current message, then show next open message in current or next thread.
2253 If at the last open message in the current thread, then show next
2254 thread from search."
2256 (notmuch-show-archive-message)
2257 (unless (notmuch-show-next-open-message)
2258 (notmuch-show-next-thread t)))
2260 (defun notmuch-show-stash-cc ()
2261 "Copy CC field of current message to kill-ring."
2263 (notmuch-common-do-stash (notmuch-show-get-cc)))
2265 (put 'notmuch-show-stash-date 'notmuch-prefix-doc
2266 "Copy timestamp of current message to kill-ring.")
2267 (defun notmuch-show-stash-date (&optional stash-timestamp)
2268 "Copy date of current message to kill-ring.
2270 If invoked with a prefix argument, copy timestamp of current
2271 message to kill-ring."
2274 (notmuch-common-do-stash (format "%d" (notmuch-show-get-timestamp)))
2275 (notmuch-common-do-stash (notmuch-show-get-date))))
2277 (defun notmuch-show-stash-filename ()
2278 "Copy filename of current message to kill-ring."
2280 (notmuch-common-do-stash (notmuch-show-get-filename)))
2282 (defun notmuch-show-stash-from ()
2283 "Copy From address of current message to kill-ring."
2285 (notmuch-common-do-stash (notmuch-show-get-from)))
2287 (put 'notmuch-show-stash-message-id 'notmuch-prefix-doc
2288 "Copy thread: query matching current thread to kill-ring.")
2289 (defun notmuch-show-stash-message-id (&optional stash-thread-id)
2290 "Copy id: query matching the current message to kill-ring.
2292 If invoked with a prefix argument (or STASH-THREAD-ID is
2293 non-nil), copy thread: query matching the current thread to
2297 (notmuch-common-do-stash notmuch-show-thread-id)
2298 (notmuch-common-do-stash (notmuch-show-get-message-id))))
2300 (defun notmuch-show-stash-message-id-stripped ()
2301 "Copy message ID of current message (sans `id:' prefix) to kill-ring."
2303 (notmuch-common-do-stash (notmuch-show-get-message-id t)))
2305 (defun notmuch-show-stash-subject ()
2306 "Copy Subject field of current message to kill-ring."
2308 (notmuch-common-do-stash (notmuch-show-get-subject)))
2310 (defun notmuch-show-stash-tags ()
2311 "Copy tags of current message to kill-ring as a comma separated list."
2313 (notmuch-common-do-stash (mapconcat 'identity (notmuch-show-get-tags) ",")))
2315 (defun notmuch-show-stash-to ()
2316 "Copy To address of current message to kill-ring."
2318 (notmuch-common-do-stash (notmuch-show-get-to)))
2320 (defun notmuch-show-stash-mlarchive-link (&optional mla)
2321 "Copy an ML Archive URI for the current message to the kill-ring.
2323 This presumes that the message is available at the selected Mailing List Archive.
2325 If optional argument MLA is non-nil, use the provided key instead of prompting
2326 the user (see `notmuch-show-stash-mlarchive-link-alist')."
2328 (let ((url (cdr (assoc
2330 (let ((completion-ignore-case t))
2332 "Mailing List Archive: "
2333 notmuch-show-stash-mlarchive-link-alist
2335 notmuch-show-stash-mlarchive-link-default)))
2336 notmuch-show-stash-mlarchive-link-alist))))
2337 (notmuch-common-do-stash
2339 (funcall url (notmuch-show-get-message-id t))
2340 (concat url (notmuch-show-get-message-id t))))))
2342 (defun notmuch-show-stash-mlarchive-link-and-go (&optional mla)
2343 "Copy an ML Archive URI for the current message to the kill-ring and visit it.
2345 This presumes that the message is available at the selected Mailing List Archive.
2347 If optional argument MLA is non-nil, use the provided key instead of prompting
2348 the user (see `notmuch-show-stash-mlarchive-link-alist')."
2350 (notmuch-show-stash-mlarchive-link mla)
2351 (browse-url (current-kill 0 t)))
2353 (defun notmuch-show-stash-git-helper (addresses prefix)
2354 "Escape, trim, quote, and add PREFIX to each address in list of ADDRESSES, and return the result as a single string."
2355 (mapconcat (lambda (x)
2357 ;; escape double-quotes
2358 (replace-regexp-in-string
2360 ;; trim leading and trailing spaces
2361 (replace-regexp-in-string
2362 "\\(^ *\\| *$\\)" ""
2366 (put 'notmuch-show-stash-git-send-email 'notmuch-prefix-doc
2367 "Copy From/To/Cc of current message to kill-ring in a form suitable for pasting to git send-email command line.")
2369 (defun notmuch-show-stash-git-send-email (&optional no-in-reply-to)
2370 "Copy From/To/Cc/Message-Id of current message to kill-ring in a form suitable for pasting to git send-email command line.
2372 If invoked with a prefix argument (or NO-IN-REPLY-TO is non-nil),
2373 omit --in-reply-to=<Message-Id>."
2375 (notmuch-common-do-stash
2376 (mapconcat 'identity
2379 (notmuch-show-stash-git-helper
2380 (message-tokenize-header (notmuch-show-get-from)) "--to=")
2381 (notmuch-show-stash-git-helper
2382 (message-tokenize-header (notmuch-show-get-to)) "--to=")
2383 (notmuch-show-stash-git-helper
2384 (message-tokenize-header (notmuch-show-get-cc)) "--cc=")
2385 (unless no-in-reply-to
2386 (notmuch-show-stash-git-helper
2387 (list (notmuch-show-get-message-id t)) "--in-reply-to="))))
2390 ;; Interactive part functions and their helpers
2392 (defun notmuch-show-generate-part-buffer (msg part)
2393 "Return a temporary buffer containing the specified part's content."
2394 (let ((buf (generate-new-buffer " *notmuch-part*"))
2395 (process-crypto notmuch-show-process-crypto))
2396 (with-current-buffer buf
2397 ;; This is always used in the content of mm handles, which
2398 ;; expect undecoded, binary part content.
2399 (insert (notmuch-get-bodypart-binary msg part process-crypto)))
2402 (defun notmuch-show-current-part-handle (&optional mime-type)
2403 "Return an mm-handle for the part containing point.
2405 This creates a temporary buffer for the part's content; the
2406 caller is responsible for killing this buffer as appropriate. If
2407 MIME-TYPE is given then set the handle's mime-type to MIME-TYPE."
2408 (let* ((msg (notmuch-show-get-message-properties))
2409 (part (notmuch-show-get-part-properties))
2410 (buf (notmuch-show-generate-part-buffer msg part))
2411 (computed-type (or mime-type (plist-get part :computed-type)))
2412 (filename (plist-get part :filename))
2413 (disposition (if filename `(attachment (filename . ,filename)))))
2414 (mm-make-handle buf (list computed-type) nil nil disposition)))
2416 (defun notmuch-show-apply-to-current-part-handle (fn &optional mime-type)
2417 "Apply FN to an mm-handle for the part containing point.
2419 This ensures that the temporary buffer created for the mm-handle
2420 is destroyed when FN returns. If MIME-TYPE is given then force
2421 part to be treated as if it had that mime-type."
2422 (let ((handle (notmuch-show-current-part-handle mime-type)))
2423 ;; emacs 24.3+ puts stdout/stderr into the calling buffer so we
2424 ;; call it from a temp-buffer, unless
2425 ;; notmuch-show-attachment-debug is non-nil in which case we put
2426 ;; it in " *notmuch-part*".
2428 (if notmuch-show-attachment-debug
2429 (with-current-buffer (generate-new-buffer " *notmuch-part*")
2430 (funcall fn handle))
2432 (funcall fn handle)))
2433 (kill-buffer (mm-handle-buffer handle)))))
2435 (defun notmuch-show-part-button-default (&optional button)
2437 (let ((button (or button (button-at (point)))))
2438 ;; Try to toggle the part, if that fails then call the default
2439 ;; action. The toggle fails if the part has no emacs renderable
2441 (unless (notmuch-show-toggle-part-invisibility button)
2442 (call-interactively notmuch-show-part-button-default-action))))
2444 (defun notmuch-show-save-part ()
2445 "Save the MIME part containing point to a file."
2447 (notmuch-show-apply-to-current-part-handle #'mm-save-part))
2449 (defun notmuch-show-view-part ()
2450 "View the MIME part containing point in an external viewer."
2452 ;; Set mm-inlined-types to nil to force an external viewer
2453 (let ((mm-inlined-types nil))
2454 (notmuch-show-apply-to-current-part-handle #'mm-display-part)))
2456 (defun notmuch-show-interactively-view-part ()
2457 "View the MIME part containing point, prompting for a viewer."
2459 (notmuch-show-apply-to-current-part-handle #'mm-interactively-view-part))
2461 (defun notmuch-show-pipe-part ()
2462 "Pipe the MIME part containing point to an external command."
2464 (notmuch-show-apply-to-current-part-handle #'mm-pipe-part))
2466 (defun notmuch-show--mm-display-part (handle)
2467 "Use mm-display-part to display HANDLE in a new buffer.
2469 If the part is displayed in an external application then close
2471 (let ((buf (get-buffer-create (generate-new-buffer-name
2472 (concat " *notmuch-internal-part*")))))
2473 (switch-to-buffer buf)
2474 (if (eq (mm-display-part handle) 'external)
2476 (goto-char (point-min))
2477 (set-buffer-modified-p nil)
2478 (view-buffer buf 'kill-buffer-if-not-modified))))
2480 (defun notmuch-show-choose-mime-of-part (mime-type)
2481 "Choose the mime type to use for displaying part."
2483 (list (completing-read "Mime type to use (default text/plain): "
2484 (mailcap-mime-types) nil nil nil nil "text/plain")))
2485 (notmuch-show-apply-to-current-part-handle #'notmuch-show--mm-display-part
2488 (defun notmuch-show-imenu-prev-index-position-function ()
2489 "Move point to previous message in notmuch-show buffer.
2490 This function is used as a value for
2491 `imenu-prev-index-position-function'."
2494 (notmuch-show-previous-message)
2497 (defun notmuch-show-imenu-extract-index-name-function ()
2498 "Return imenu name for line at point.
2499 This function is used as a value for
2500 `imenu-extract-index-name-function'. Point should be at the
2501 beginning of the line."
2502 (back-to-indentation)
2503 (buffer-substring-no-properties (if notmuch-show-imenu-indent
2504 (line-beginning-position)
2506 (line-end-position)))
2508 (defmacro notmuch-show--with-currently-shown-message (&rest body)
2509 "Evaluate BODY with display restricted to the currently shown
2513 (let ((extent (notmuch-show-message-extent)))
2514 (narrow-to-region (car extent) (cdr extent))
2517 (defun notmuch-show--gather-urls ()
2518 "Gather any URLs in the current message."
2519 (notmuch-show--with-currently-shown-message
2521 (goto-char (point-min))
2522 (while (re-search-forward goto-address-url-regexp (point-max) t)
2523 (push (match-string-no-properties 0) urls))
2526 (defun notmuch-show-browse-urls (&optional kill)
2527 "Offer to browse any URLs in the current message.
2528 With a prefix argument, copy the URL to the kill ring rather than
2531 (let ((urls (notmuch-show--gather-urls))
2532 (prompt (if kill "Copy URL to kill ring: " "Browse URL: "))
2533 (fn (if kill #'kill-new #'browse-url)))
2535 (funcall fn (completing-read prompt urls nil nil nil nil (car urls)))
2536 (message "No URLs found."))))
2538 (provide 'notmuch-show)
2540 ;;; notmuch-show.el ends here