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)
307 (mm-display-parts (mm-dissect-buffer)))))
309 (defun notmuch-show-save-attachments ()
310 "Save all attachments from the current message."
312 (with-current-notmuch-show-message
313 (let ((mm-handle (mm-dissect-buffer)))
314 (notmuch-save-attachments
315 mm-handle (> (notmuch-count-attachments mm-handle) 1))))
318 (defun notmuch-show-with-message-as-text (fn)
319 "Apply FN to a text representation of the current message.
321 FN is called with one argument, the message properties. It should
322 operation on the contents of the current buffer."
323 ;; Remake the header to ensure that all information is available.
324 (let* ((to (notmuch-show-get-to))
325 (cc (notmuch-show-get-cc))
326 (from (notmuch-show-get-from))
327 (subject (notmuch-show-get-subject))
328 (date (notmuch-show-get-date))
329 (tags (notmuch-show-get-tags))
330 (depth (notmuch-show-get-depth))
332 "Subject: " subject "\n"
334 (if (not (string= cc ""))
335 (concat "Cc: " cc "\n")
341 (mapconcat #'identity tags ", ") "\n")
343 (all (buffer-substring (notmuch-show-message-top)
344 (notmuch-show-message-bottom)))
346 (props (notmuch-show-get-message-properties))
347 (indenting notmuch-show-indent-content))
351 (indent-rigidly (point-min)
353 (- (* notmuch-show-indent-messages-width depth))))
354 ;; Remove the original header.
355 (goto-char (point-min))
356 (re-search-forward "^$" (point-max) nil)
357 (delete-region (point-min) (point))
359 (funcall fn props))))
361 (defun notmuch-show-print-message ()
362 "Print the current message."
364 (notmuch-show-with-message-as-text 'notmuch-print-message))
366 (defun notmuch-show-fontify-header ()
368 ((looking-at "[Tt]o:")
370 ((looking-at "[Bb]?[Cc][Cc]:")
372 ((looking-at "[Ss]ubject:")
373 'message-header-subject)
375 'message-header-other))))
376 (overlay-put (make-overlay (point) (re-search-forward ":"))
377 'face 'message-header-name)
378 (overlay-put (make-overlay (point) (re-search-forward ".*$"))
381 (defun notmuch-show-colour-headers ()
382 "Apply some colouring to the current headers."
383 (goto-char (point-min))
384 (while (looking-at "^[A-Za-z][-A-Za-z0-9]*:")
385 (notmuch-show-fontify-header)
388 (defun notmuch-show-spaces-n (n)
389 "Return a string comprised of `n' spaces."
392 (defun notmuch-show-update-tags (tags)
393 "Update the displayed tags of the current message."
395 (goto-char (notmuch-show-message-top))
396 (if (re-search-forward "(\\([^()]*\\))$" (line-end-position) t)
397 (let ((inhibit-read-only t))
398 (replace-match (concat "("
399 (notmuch-tag-format-tags
401 (notmuch-show-get-prop :orig-tags))
404 (defun notmuch-clean-address (address)
405 "Try to clean a single email ADDRESS for display. Return a cons
406 cell of (AUTHOR_EMAIL AUTHOR_NAME). Return (ADDRESS nil) if
409 (let (p-name p-address)
410 ;; It would be convenient to use `mail-header-parse-address',
411 ;; but that expects un-decoded mailbox parts, whereas our
412 ;; mailbox parts are already decoded (and hence may contain
413 ;; UTF-8). Given that notmuch should handle most of the awkward
414 ;; cases, some simple string deconstruction should be sufficient
417 ;; "User <user@dom.ain>" style.
418 ((string-match "\\(.*\\) <\\(.*\\)>" address)
419 (setq p-name (match-string 1 address)
420 p-address (match-string 2 address)))
422 ;; "<user@dom.ain>" style.
423 ((string-match "<\\(.*\\)>" address)
424 (setq p-address (match-string 1 address)))
427 (setq p-address address)))
429 ;; Remove elements of the mailbox part that are not relevant for
430 ;; display, even if they are required during transport:
433 (setq p-name (replace-regexp-in-string "\\\\" "" p-name))
434 ;; Outer single and double quotes, which might be nested.
435 (cl-loop with start-of-loop
436 do (setq start-of-loop p-name)
437 when (string-match "^\"\\(.*\\)\"$" p-name)
438 do (setq p-name (match-string 1 p-name))
439 when (string-match "^'\\(.*\\)'$" p-name)
440 do (setq p-name (match-string 1 p-name))
441 until (string= start-of-loop p-name)))
442 ;; If the address is 'foo@bar.com <foo@bar.com>' then show just
444 (when (string= p-name p-address)
446 (cons p-address p-name))
447 (error (cons address nil))))
449 (defun notmuch-show-clean-address (address)
450 "Try to clean a single email ADDRESS for display. Return
451 unchanged ADDRESS if parsing fails."
452 (let* ((clean-address (notmuch-clean-address address))
453 (p-address (car clean-address))
454 (p-name (cdr clean-address)))
455 ;; If no name, return just the address.
458 ;; Otherwise format the name and address together.
459 (concat p-name " <" p-address ">"))))
461 (defun notmuch-show-insert-headerline (headers date tags depth)
462 "Insert a notmuch style headerline based on HEADERS for a
463 message at DEPTH in the current thread."
464 (let ((start (point))
465 (from (notmuch-sanitize
466 (notmuch-show-clean-address (plist-get headers :From)))))
467 (when (string-match "\\cR" from)
468 ;; If the From header has a right-to-left character add
469 ;; invisible U+200E LEFT-TO-RIGHT MARK character which forces
470 ;; the header paragraph as left-to-right text.
471 (insert (propertize (string ?\x200e) 'invisible t)))
472 (insert (notmuch-show-spaces-n (* notmuch-show-indent-messages-width depth))
477 (notmuch-tag-format-tags tags tags)
479 (overlay-put (make-overlay start (point))
480 'face 'notmuch-message-summary-face)))
482 (defun notmuch-show-insert-header (header header-value)
483 "Insert a single header."
484 (insert header ": " (notmuch-sanitize header-value) "\n"))
486 (defun notmuch-show-insert-headers (headers)
487 "Insert the headers of the current message."
488 (let ((start (point)))
489 (mapc (lambda (header)
490 (let* ((header-symbol (intern (concat ":" header)))
491 (header-value (plist-get headers header-symbol)))
492 (if (and header-value
493 (not (string-equal "" header-value)))
494 (notmuch-show-insert-header header header-value))))
495 notmuch-message-headers)
498 (narrow-to-region start (point-max))
499 (run-hooks 'notmuch-show-markup-headers-hook)))))
501 (define-button-type 'notmuch-show-part-button-type
502 'action 'notmuch-show-part-button-default
505 :supertype 'notmuch-button-type)
507 (defun notmuch-show-insert-part-header (nth content-type declared-type
508 &optional name comment)
510 (base-label (concat (when name (concat name ": "))
512 (unless (string-equal declared-type content-type)
513 (concat " (as " content-type ")"))
517 (concat "[ " base-label " ]")
518 :base-label base-label
519 :type 'notmuch-show-part-button-type
520 :notmuch-part-hidden nil))
525 (defun notmuch-show-toggle-part-invisibility (&optional button)
527 (let ((button (or button (button-at (point)))))
529 (let ((overlay (button-get button 'overlay))
530 (lazy-part (button-get button :notmuch-lazy-part)))
531 ;; We have a part to toggle if there is an overlay or if there
532 ;; is a lazy part. If neither is present we cannot toggle the
533 ;; part so we just return nil.
534 (when (or overlay lazy-part)
535 (let* ((show (button-get button :notmuch-part-hidden))
536 (new-start (button-start button))
537 (button-label (button-get button :base-label))
539 (properties (text-properties-at (button-start button)))
540 (inhibit-read-only t))
541 ;; Toggle the button itself.
542 (button-put button :notmuch-part-hidden (not show))
543 (goto-char new-start)
544 (insert "[ " button-label (if show " ]" " (hidden) ]"))
545 (set-text-properties new-start (point) properties)
546 (let ((old-end (button-end button)))
547 (move-overlay button new-start (point))
548 (delete-region (point) old-end))
549 (goto-char (min old-point (1- (button-end button))))
550 ;; Return nil if there is a lazy-part, it is empty, and we are
551 ;; trying to show it. In all other cases return t.
554 (button-put button :notmuch-lazy-part nil)
555 (notmuch-show-lazy-part lazy-part button))
556 ;; else there must be an overlay.
557 (overlay-put overlay 'invisible (not show))
560 ;; Part content ID handling
562 (defvar notmuch-show--cids nil
563 "Alist from raw content ID to (MSG PART).")
564 (make-variable-buffer-local 'notmuch-show--cids)
566 (defun notmuch-show--register-cids (msg part)
567 "Register content-IDs in PART and all of PART's sub-parts."
568 (let ((content-id (plist-get part :content-id)))
570 ;; Note that content-IDs are globally unique, except when they
571 ;; aren't: RFC 2046 section 5.1.4 permits children of a
572 ;; multipart/alternative to have the same content-ID, in which
573 ;; case the MUA is supposed to pick the best one it can render.
574 ;; We simply add the content-ID to the beginning of our alist;
575 ;; so if this happens, we'll take the last (and "best")
576 ;; alternative (even if we can't render it).
577 (push (list content-id msg part) notmuch-show--cids)))
578 ;; Recurse on sub-parts
579 (let ((ctype (notmuch-split-content-type
580 (downcase (plist-get part :content-type)))))
581 (cond ((equal (car ctype) "multipart")
582 (mapc (apply-partially #'notmuch-show--register-cids msg)
583 (plist-get part :content)))
584 ((equal ctype '("message" "rfc822"))
585 (notmuch-show--register-cids
587 (car (plist-get (car (plist-get part :content)) :body)))))))
589 (defun notmuch-show--get-cid-content (cid)
590 "Return a list (CID-content content-type) or nil.
592 This will only find parts from messages that have been inserted
593 into the current buffer. CID must be a raw content ID, without
594 enclosing angle brackets, a cid: prefix, or URL encoding. This
595 will return nil if the CID is unknown or cannot be retrieved."
596 (let ((descriptor (cdr (assoc cid notmuch-show--cids))))
598 (let* ((msg (car descriptor))
599 (part (cadr descriptor))
600 ;; Request caching for this content, as some messages
601 ;; reference the same cid: part many times (hundreds!).
602 (content (notmuch-get-bodypart-binary
603 msg part notmuch-show-process-crypto 'cache))
604 (content-type (plist-get part :content-type)))
605 (list content content-type)))))
607 (defun notmuch-show-setup-w3m ()
608 "Instruct w3m how to retrieve content from a \"related\" part of a message."
610 (if (boundp 'w3m-cid-retrieve-function-alist)
611 (unless (assq 'notmuch-show-mode w3m-cid-retrieve-function-alist)
612 (push (cons 'notmuch-show-mode #'notmuch-show--cid-w3m-retrieve)
613 w3m-cid-retrieve-function-alist)))
614 (setq mm-html-inhibit-images nil))
616 (defvar w3m-current-buffer) ;; From `w3m.el'.
617 (defun notmuch-show--cid-w3m-retrieve (url &rest args)
618 ;; url includes the cid: prefix and is URL encoded (see RFC 2392).
619 (let* ((cid (url-unhex-string (substring url 4)))
621 (with-current-buffer w3m-current-buffer
622 (notmuch-show--get-cid-content cid))))
623 (when content-and-type
624 (insert (car content-and-type))
625 (cadr content-and-type))))
627 ;; MIME part renderers
629 (defun notmuch-show-multipart/*-to-list (part)
630 (mapcar (lambda (inner-part) (plist-get inner-part :content-type))
631 (plist-get part :content)))
633 (defun notmuch-show-insert-part-multipart/alternative (msg part content-type nth depth button)
634 (let ((chosen-type (car (notmuch-multipart/alternative-choose
635 msg (notmuch-show-multipart/*-to-list part))))
636 (inner-parts (plist-get part :content))
638 ;; This inserts all parts of the chosen type rather than just one,
639 ;; but it's not clear that this is the wrong thing to do - which
640 ;; should be chosen if there are more than one that match?
641 (mapc (lambda (inner-part)
642 (let* ((inner-type (plist-get inner-part :content-type))
643 (hide (not (or notmuch-show-all-multipart/alternative-parts
644 (string= chosen-type inner-type)))))
645 (notmuch-show-insert-bodypart msg inner-part depth hide)))
648 (when notmuch-show-indent-multipart
649 (indent-rigidly start (point) 1)))
652 (defun notmuch-show-insert-part-multipart/related (msg part content-type nth depth button)
653 (let ((inner-parts (plist-get part :content))
655 ;; Render the primary part. FIXME: Support RFC 2387 Start header.
656 (notmuch-show-insert-bodypart msg (car inner-parts) depth)
657 ;; Add hidden buttons for the rest
658 (mapc (lambda (inner-part)
659 (notmuch-show-insert-bodypart msg inner-part depth t))
661 (when notmuch-show-indent-multipart
662 (indent-rigidly start (point) 1)))
665 (defun notmuch-show-insert-part-multipart/signed (msg part content-type nth depth button)
667 (button-put button 'face 'notmuch-crypto-part-header))
668 ;; Insert a button detailing the signature status.
669 (notmuch-crypto-insert-sigstatus-button (car (plist-get part :sigstatus))
670 (notmuch-show-get-header :From msg))
671 (let ((inner-parts (plist-get part :content))
673 ;; Show all of the parts.
674 (mapc (lambda (inner-part)
675 (notmuch-show-insert-bodypart msg inner-part depth))
677 (when notmuch-show-indent-multipart
678 (indent-rigidly start (point) 1)))
681 (defun notmuch-show-insert-part-multipart/encrypted (msg part content-type nth depth button)
683 (button-put button 'face 'notmuch-crypto-part-header))
684 ;; Insert a button detailing the encryption status.
685 (notmuch-crypto-insert-encstatus-button (car (plist-get part :encstatus)))
686 ;; Insert a button detailing the signature status.
687 (notmuch-crypto-insert-sigstatus-button (car (plist-get part :sigstatus))
688 (notmuch-show-get-header :From msg))
689 (let ((inner-parts (plist-get part :content))
691 ;; Show all of the parts.
692 (mapc (lambda (inner-part)
693 (notmuch-show-insert-bodypart msg inner-part depth))
695 (when notmuch-show-indent-multipart
696 (indent-rigidly start (point) 1)))
699 (defun notmuch-show-insert-part-application/pgp-encrypted (msg part content-type nth depth button)
702 (defun notmuch-show-insert-part-multipart/* (msg part content-type nth depth button)
703 (let ((inner-parts (plist-get part :content))
705 ;; Show all of the parts.
706 (mapc (lambda (inner-part)
707 (notmuch-show-insert-bodypart msg inner-part depth))
709 (when notmuch-show-indent-multipart
710 (indent-rigidly start (point) 1)))
713 (defun notmuch-show-insert-part-message/rfc822 (msg part content-type nth depth button)
714 (let* ((message (car (plist-get part :content)))
715 (body (car (plist-get message :body)))
717 ;; Override `notmuch-message-headers' to force `From' to be
719 (let ((notmuch-message-headers '("From" "Subject" "To" "Cc" "Date")))
720 (notmuch-show-insert-headers (plist-get message :headers)))
721 ;; Blank line after headers to be compatible with the normal
725 (notmuch-show-insert-bodypart msg body depth)
726 (when notmuch-show-indent-multipart
727 (indent-rigidly start (point) 1)))
730 (defun notmuch-show-insert-part-text/plain (msg part content-type nth depth button)
731 ;; For backward compatibility we want to apply the text/plain hook
732 ;; to the whole of the part including the part button if there is
734 (let ((start (if button
735 (button-start button)
737 (insert (notmuch-get-bodypart-text msg part notmuch-show-process-crypto))
740 (narrow-to-region start (point-max))
741 (run-hook-with-args 'notmuch-show-insert-text/plain-hook msg depth))))
744 (defun notmuch-show-insert-part-text/calendar (msg part content-type nth depth button)
745 (insert (with-temp-buffer
746 (insert (notmuch-get-bodypart-text msg part notmuch-show-process-crypto))
747 ;; notmuch-get-bodypart-text does no newline conversion.
748 ;; Replace CRLF with LF before icalendar can use it.
749 (goto-char (point-min))
750 (while (re-search-forward "\r\n" nil t)
751 (replace-match "\n" nil nil))
752 (let ((file (make-temp-file "notmuch-ical"))
756 (unless (icalendar-import-buffer file t)
757 (error "Icalendar import error. %s"
758 "See *icalendar-errors* for more information"))
759 (set-buffer (get-file-buffer file))
760 (setq result (buffer-substring (point-min) (point-max)))
761 (set-buffer-modified-p nil)
762 (kill-buffer (current-buffer)))
767 ;; For backwards compatibility.
768 (defun notmuch-show-insert-part-text/x-vcalendar (msg part content-type nth depth button)
769 (notmuch-show-insert-part-text/calendar msg part content-type nth depth button))
771 (if (version< emacs-version "25.3")
772 ;; https://bugs.gnu.org/28350
774 ;; For newer emacs, we fall back to notmuch-show-insert-part-*/*
775 ;; (see notmuch-show-handlers-for)
776 (defun notmuch-show-insert-part-text/enriched
777 (msg part content-type nth depth button)
778 ;; By requiring enriched below, we ensure that the function
779 ;; enriched-decode-display-prop is defined before it will be
780 ;; shadowed by the letf below. Otherwise the version in
781 ;; enriched.el may be loaded a bit later and used instead (for
784 (cl-letf (((symbol-function 'enriched-decode-display-prop)
785 (lambda (start end &optional param) (list start end))))
786 (notmuch-show-insert-part-*/* msg part content-type nth depth button))))
788 (defun notmuch-show-get-mime-type-of-application/octet-stream (part)
789 ;; If we can deduce a MIME type from the filename of the attachment,
791 (if (plist-get part :filename)
792 (let ((extension (file-name-extension (plist-get part :filename)))
796 (mailcap-parse-mimetypes)
797 (setq mime-type (mailcap-extension-to-mime extension))
799 (not (string-equal mime-type "application/octet-stream")))
804 (defun notmuch-show-insert-part-text/html (msg part content-type nth depth button)
805 (if (eq mm-text-html-renderer 'shr)
806 ;; It's easier to drive shr ourselves than to work around the
807 ;; goofy things `mm-shr' does (like irreversibly taking over
808 ;; content ID handling).
809 ;; FIXME: If we block an image, offer a button to load external
811 (let ((shr-blocked-images notmuch-show-text/html-blocked-images))
812 (notmuch-show--insert-part-text/html-shr msg part))
813 ;; Otherwise, let message-mode do the heavy lifting
815 ;; w3m sets up a keymap which "leaks" outside the invisible region
816 ;; and causes strange effects in notmuch. We set
817 ;; mm-inline-text-html-with-w3m-keymap to nil to tell w3m not to
818 ;; set a keymap (so the normal notmuch-show-mode-map remains).
819 (let ((mm-inline-text-html-with-w3m-keymap nil)
820 ;; FIXME: If we block an image, offer a button to load external
822 (gnus-blocked-images notmuch-show-text/html-blocked-images))
823 (notmuch-show-insert-part-*/* msg part content-type nth depth button))))
825 ;; These functions are used by notmuch-show--insert-part-text/html-shr
826 (declare-function libxml-parse-html-region "xml.c")
827 (declare-function shr-insert-document "shr")
829 (defun notmuch-show--insert-part-text/html-shr (msg part)
830 ;; Make sure shr is loaded before we start let-binding its globals
832 (let ((dom (let ((process-crypto notmuch-show-process-crypto))
834 (insert (notmuch-get-bodypart-text msg part process-crypto))
835 (libxml-parse-html-region (point-min) (point-max)))))
836 (shr-content-function
838 ;; shr strips the "cid:" part of URL, but doesn't
839 ;; URL-decode it (see RFC 2392).
840 (let ((cid (url-unhex-string url)))
841 (car (notmuch-show--get-cid-content cid))))))
842 (shr-insert-document dom)
845 (defun notmuch-show-insert-part-*/* (msg part content-type nth depth button)
846 ;; This handler _must_ succeed - it is the handler of last resort.
847 (notmuch-mm-display-part-inline msg part content-type notmuch-show-process-crypto)
850 ;; Functions for determining how to handle MIME parts.
852 (defun notmuch-show-handlers-for (content-type)
853 "Return a list of content handlers for a part of type CONTENT-TYPE."
858 ;; Reverse order of prefrence.
859 (list (intern (concat "notmuch-show-insert-part-*/*"))
861 "notmuch-show-insert-part-"
862 (car (notmuch-split-content-type content-type))
864 (intern (concat "notmuch-show-insert-part-" content-type))))
869 (defun notmuch-show-insert-bodypart-internal (msg part content-type nth depth button)
870 ;; Run the handlers until one of them succeeds.
871 (cl-loop for handler in (notmuch-show-handlers-for content-type)
872 until (condition-case err
873 (funcall handler msg part content-type nth depth button)
874 ;; Specifying `debug' here lets the debugger run if
875 ;; `debug-on-error' is non-nil.
877 (insert "!!! Bodypart handler `" (prin1-to-string handler)
878 "' threw an error:\n"
879 "!!! " (error-message-string err) "\n")
882 (defun notmuch-show-create-part-overlays (button beg end)
883 "Add an overlay to the part between BEG and END."
884 ;; If there is no button (i.e., the part is text/plain and the first
885 ;; part) or if the part has no content then we don't make the part
887 (when (and button (/= beg end))
888 (button-put button 'overlay (make-overlay beg end))
889 ;; Return true if we created an overlay.
892 (defun notmuch-show-record-part-information (part beg end)
893 "Store PART as a text property from BEG to END."
894 ;; Record part information. Since we already inserted subparts,
895 ;; don't override existing :notmuch-part properties.
896 (notmuch-map-text-property beg end :notmuch-part
897 (lambda (v) (or v part)))
898 ;; Make :notmuch-part front sticky and rear non-sticky so it stays
899 ;; applied to the beginning of each line when we indent the
900 ;; message. Since we're operating on arbitrary renderer output,
901 ;; watch out for sticky specs of t, which means all properties are
902 ;; front-sticky/rear-nonsticky.
903 (notmuch-map-text-property beg end 'front-sticky
906 (cl-pushnew :notmuch-part v)
908 (notmuch-map-text-property beg end 'rear-nonsticky
911 (cl-pushnew :notmuch-part v)
914 (defun notmuch-show-lazy-part (part-args button)
915 ;; Insert the lazy part after the button for the part. We would just
916 ;; move to the start of the new line following the button and insert
917 ;; the part but that point might have text properties (eg colours
918 ;; from a message header etc) so instead we start from the last
919 ;; character of the button by adding a newline and finish by
920 ;; removing the extra newline from the end of the part.
922 (goto-char (button-end button))
924 (let* ((inhibit-read-only t)
925 ;; We need to use markers for the start and end of the part
926 ;; because the part insertion functions do not guarantee
927 ;; to leave point at the end of the part.
928 (part-beg (copy-marker (point) nil))
929 (part-end (copy-marker (point) t))
930 ;; We have to save the depth as we can't find the depth
932 (depth (notmuch-show-get-depth)))
934 (narrow-to-region part-beg part-end)
935 (delete-region part-beg part-end)
936 (apply #'notmuch-show-insert-bodypart-internal part-args)
937 (indent-rigidly part-beg
939 (* notmuch-show-indent-messages-width depth)))
942 (notmuch-show-record-part-information (cadr part-args)
943 (button-start button)
945 ;; Create the overlay. If the lazy-part turned out to be empty/not
946 ;; showable this returns nil.
947 (notmuch-show-create-part-overlays button part-beg part-end))))
949 (defun notmuch-show-mime-type (part)
950 "Return the correct mime-type to use for PART."
951 (let ((content-type (downcase (plist-get part :content-type))))
952 (or (and (string= content-type "application/octet-stream")
953 (notmuch-show-get-mime-type-of-application/octet-stream part))
954 (and (string= content-type "inline patch")
958 ;; The following variable can be overridden by let bindings.
959 (defvar notmuch-show-insert-header-p-function 'notmuch-show-insert-header-p
960 "Specify which function decides which part headers get inserted.
962 The function should take two parameters, PART and HIDE, and
963 should return non-NIL if a header button should be inserted for
966 (defun notmuch-show-insert-header-p (part hide)
967 ;; Show all part buttons except for the first part if it is text/plain.
968 (let ((mime-type (notmuch-show-mime-type part)))
969 (not (and (string= mime-type "text/plain")
970 (<= (plist-get part :id) 1)))))
972 (defun notmuch-show-reply-insert-header-p-never (part hide)
975 (defun notmuch-show-reply-insert-header-p-trimmed (part hide)
976 (let ((mime-type (notmuch-show-mime-type part)))
977 (and (not (notmuch-match-content-type mime-type "multipart/*"))
980 (defun notmuch-show-reply-insert-header-p-minimal (part hide)
981 (let ((mime-type (notmuch-show-mime-type part)))
982 (and (notmuch-match-content-type mime-type "text/*")
985 (defun notmuch-show-insert-bodypart (msg part depth &optional hide)
986 "Insert the body part PART at depth DEPTH in the current thread.
988 HIDE determines whether to show or hide the part and the button
989 as follows: If HIDE is nil, show the part and the button. If HIDE
990 is t, hide the part initially and show the button."
991 (let* ((content-type (downcase (plist-get part :content-type)))
992 (mime-type (notmuch-show-mime-type part))
993 (nth (plist-get part :id))
994 (long (and (notmuch-match-content-type mime-type "text/*")
995 (> notmuch-show-max-text-part-size 0)
996 (> (length (plist-get part :content))
997 notmuch-show-max-text-part-size)))
999 ;; This default header-p function omits the part button for
1000 ;; the first (or only) part if this is text/plain.
1001 (button (when (funcall notmuch-show-insert-header-p-function part hide)
1002 (notmuch-show-insert-part-header nth mime-type content-type
1003 (plist-get part :filename))))
1004 ;; Hide the part initially if HIDE is t, or if it is too long
1005 ;; and we have a button to allow toggling.
1006 (show-part (not (or (equal hide t)
1007 (and long button))))
1008 (content-beg (point)))
1009 ;; Store the computed mime-type for later use (e.g. by attachment handlers).
1010 (plist-put part :computed-type mime-type)
1012 (notmuch-show-insert-bodypart-internal msg part mime-type nth depth button)
1014 (button-put button :notmuch-lazy-part
1015 (list msg part mime-type nth depth button))))
1016 ;; Some of the body part handlers leave point somewhere up in the
1017 ;; part, so we make sure that we're down at the end.
1018 (goto-char (point-max))
1019 ;; Ensure that the part ends with a carriage return.
1022 ;; We do not create the overlay for hidden (lazy) parts until
1023 ;; they are inserted.
1025 (notmuch-show-create-part-overlays button content-beg (point))
1027 (notmuch-show-toggle-part-invisibility button)))
1028 (notmuch-show-record-part-information part beg (point))))
1030 (defun notmuch-show-insert-body (msg body depth)
1031 "Insert the body BODY at depth DEPTH in the current thread."
1032 ;; Register all content IDs for this message. According to RFC
1033 ;; 2392, content IDs are *global*, but it's okay if an MUA treats
1034 ;; them as only global within a message.
1035 (notmuch-show--register-cids msg (car body))
1036 (mapc (lambda (part) (notmuch-show-insert-bodypart msg part depth)) body))
1038 (defun notmuch-show-make-symbol (type)
1039 (make-symbol (concat "notmuch-show-" type)))
1041 (defun notmuch-show-strip-re (string)
1042 (replace-regexp-in-string "^\\([Rr]e: *\\)+" "" string))
1044 (defvar notmuch-show-previous-subject "")
1045 (make-variable-buffer-local 'notmuch-show-previous-subject)
1047 (defun notmuch-show-insert-msg (msg depth)
1048 "Insert the message MSG at depth DEPTH in the current thread."
1049 (let* ((headers (plist-get msg :headers))
1050 ;; Indentation causes the buffer offset of the start/end
1051 ;; points to move, so we must use markers.
1052 message-start message-end
1053 content-start content-end
1054 headers-start headers-end
1055 (bare-subject (notmuch-show-strip-re (plist-get headers :Subject))))
1056 (setq message-start (point-marker))
1057 (notmuch-show-insert-headerline headers
1058 (or (if notmuch-show-relative-dates
1059 (plist-get msg :date_relative)
1061 (plist-get headers :Date))
1062 (plist-get msg :tags) depth)
1063 (setq content-start (point-marker))
1064 ;; Set `headers-start' to point after the 'Subject:' header to be
1065 ;; compatible with the existing implementation. This just sets it
1066 ;; to after the first header.
1067 (notmuch-show-insert-headers headers)
1069 (goto-char content-start)
1070 ;; If the subject of this message is the same as that of the
1071 ;; previous message, don't display it when this message is
1073 (when (not (string= notmuch-show-previous-subject
1076 (setq headers-start (point-marker)))
1077 (setq headers-end (point-marker))
1078 (setq notmuch-show-previous-subject bare-subject)
1079 ;; A blank line between the headers and the body.
1081 (notmuch-show-insert-body msg (plist-get msg :body)
1082 (if notmuch-show-indent-content depth 0))
1083 ;; Ensure that the body ends with a newline.
1086 (setq content-end (point-marker))
1087 ;; Indent according to the depth in the thread.
1088 (if notmuch-show-indent-content
1089 (indent-rigidly content-start
1091 (* notmuch-show-indent-messages-width depth)))
1092 (setq message-end (point-max-marker))
1093 ;; Save the extents of this message over the whole text of the
1095 (put-text-property message-start message-end
1096 :notmuch-message-extent
1097 (cons message-start message-end))
1098 ;; Create overlays used to control visibility
1099 (plist-put msg :headers-overlay (make-overlay headers-start headers-end))
1100 (plist-put msg :message-overlay (make-overlay headers-start content-end))
1101 (plist-put msg :depth depth)
1102 ;; Save the properties for this message. Currently this saves the
1103 ;; entire message (augmented it with other stuff), which seems
1104 ;; like overkill. We might save a reduced subset (for example, not
1106 (notmuch-show-set-message-properties msg)
1107 ;; Set header visibility.
1108 (notmuch-show-headers-visible msg notmuch-message-headers-visible)
1109 ;; Message visibility depends on whether it matched the search
1111 (notmuch-show-message-visible msg (and (plist-get msg :match)
1112 (not (plist-get msg :excluded))))))
1114 (defun notmuch-show-toggle-process-crypto ()
1115 "Toggle the processing of cryptographic MIME parts."
1117 (setq notmuch-show-process-crypto (not notmuch-show-process-crypto))
1118 (message (if notmuch-show-process-crypto
1119 "Processing cryptographic MIME parts."
1120 "Not processing cryptographic MIME parts."))
1121 (notmuch-show-refresh-view))
1123 (defun notmuch-show-toggle-elide-non-matching ()
1124 "Toggle the display of non-matching messages."
1126 (setq notmuch-show-elide-non-matching-messages
1127 (not notmuch-show-elide-non-matching-messages))
1128 (message (if notmuch-show-elide-non-matching-messages
1129 "Showing matching messages only."
1130 "Showing all messages."))
1131 (notmuch-show-refresh-view))
1133 (defun notmuch-show-toggle-thread-indentation ()
1134 "Toggle the indentation of threads."
1136 (setq notmuch-show-indent-content (not notmuch-show-indent-content))
1137 (message (if notmuch-show-indent-content
1138 "Content is indented."
1139 "Content is not indented."))
1140 (notmuch-show-refresh-view))
1142 (defun notmuch-show-insert-tree (tree depth)
1143 "Insert the message tree TREE at depth DEPTH in the current thread."
1144 (let ((msg (car tree))
1145 (replies (cadr tree)))
1146 ;; We test whether there is a message or just some replies.
1148 (notmuch-show-insert-msg msg depth))
1149 (notmuch-show-insert-thread replies (1+ depth))))
1151 (defun notmuch-show-insert-thread (thread depth)
1152 "Insert the thread THREAD at depth DEPTH in the current forest."
1153 (mapc (lambda (tree) (notmuch-show-insert-tree tree depth)) thread))
1155 (defun notmuch-show-insert-forest (forest)
1156 "Insert the forest of threads FOREST."
1157 (mapc (lambda (thread) (notmuch-show-insert-thread thread 0)) forest))
1159 (defvar notmuch-id-regexp
1161 ;; Match the id: prefix only if it begins a word (to disallow, for
1162 ;; example, matching cid:).
1164 ;; If the term starts with a ", then parse Xapian's quoted boolean
1165 ;; term syntax, which allows for anything as long as embedded
1166 ;; double quotes escaped by doubling them. We also disallow
1167 ;; newlines (which Xapian allows) to prevent runaway terms.
1168 "\"\\([^\"\n]\\|\"\"\\)*\""
1169 ;; Otherwise, parse Xapian's unquoted syntax, which goes up to the
1170 ;; next space or ). We disallow [.,;] as the last character
1171 ;; because these are probably part of the surrounding text, and not
1172 ;; part of the id. This doesn't match single character ids; meh.
1173 "\\|[^\"[:space:])][^[:space:])]*[^])[:space:].,:;?!]"
1175 "The regexp used to match id: links in messages.")
1177 (defvar notmuch-mid-regexp
1178 ;; goto-address-url-regexp matched cid: links, which have the same
1179 ;; grammar as the message ID part of a mid: link. Construct the
1180 ;; regexp using the same technique as goto-address-url-regexp.
1181 (concat "\\<mid:\\(" thing-at-point-url-path-regexp "\\)")
1182 "The regexp used to match mid: links in messages.
1186 (defun notmuch-show-buttonise-links (start end)
1187 "Buttonise URLs and mail addresses between START and END.
1189 This also turns id:\"<message id>\"-parts and mid: links into
1190 buttons for a corresponding notmuch search."
1191 (goto-address-fontify-region start end)
1194 (beg-line (progn (goto-char start) (line-beginning-position)))
1195 (end-line (progn (goto-char end) (line-end-position))))
1196 (goto-char beg-line)
1197 (while (re-search-forward notmuch-id-regexp end-line t)
1198 (push (list (match-beginning 0) (match-end 0)
1199 (match-string-no-properties 0)) links))
1200 (goto-char beg-line)
1201 (while (re-search-forward notmuch-mid-regexp end-line t)
1202 (let* ((mid-cid (match-string-no-properties 1))
1203 (mid (save-match-data
1204 (string-match "^[^/]*" mid-cid)
1205 (url-unhex-string (match-string 0 mid-cid)))))
1206 (push (list (match-beginning 0) (match-end 0)
1207 (notmuch-id-to-query mid)) links)))
1208 (pcase-dolist (`(,beg ,end ,link) links)
1209 ;; Remove the overlay created by goto-address-mode
1210 (remove-overlays beg end 'goto-address t)
1211 (make-text-button beg end
1212 :type 'notmuch-button-type
1213 'action `(lambda (arg)
1214 (notmuch-show ,link current-prefix-arg))
1216 'help-echo "Mouse-1, RET: search for this message"
1217 'face goto-address-mail-face)))))
1220 (defun notmuch-show (thread-id &optional elide-toggle parent-buffer query-context buffer-name)
1221 "Run \"notmuch show\" with the given thread ID and display results.
1223 ELIDE-TOGGLE, if non-nil, inverts the default elide behavior.
1225 The optional PARENT-BUFFER is the notmuch-search buffer from
1226 which this notmuch-show command was executed, (so that the
1227 next thread from that buffer can be show when done with this
1230 The optional QUERY-CONTEXT is a notmuch search term. Only
1231 messages from the thread matching this search term are shown if
1234 The optional BUFFER-NAME provides the name of the buffer in
1235 which the message thread is shown. If it is nil (which occurs
1236 when the command is called interactively) the argument to the
1239 Returns the buffer containing the messages, or NIL if no messages
1241 (interactive "sNotmuch show: \nP")
1242 (let ((buffer-name (generate-new-buffer-name
1244 (concat "*notmuch-" thread-id "*"))))
1245 ;; We override mm-inline-override-types to stop application/*
1246 ;; parts from being displayed unless the user has customized
1248 (mm-inline-override-types
1249 (if (equal mm-inline-override-types
1250 (eval (car (get 'mm-inline-override-types 'standard-value))))
1251 (cons "application/*" mm-inline-override-types)
1252 mm-inline-override-types)))
1253 (switch-to-buffer (get-buffer-create buffer-name))
1254 ;; No need to track undo information for this buffer.
1255 (setq buffer-undo-list t)
1257 ;; Set various buffer local variables to their appropriate initial
1258 ;; state. Do this after enabling `notmuch-show-mode' so that they
1259 ;; aren't wiped out.
1260 (setq notmuch-show-thread-id thread-id
1261 notmuch-show-parent-buffer parent-buffer
1262 notmuch-show-query-context (if (or (string= query-context "")
1263 (string= query-context "*"))
1265 notmuch-show-process-crypto notmuch-crypto-process-mime
1266 ;; If `elide-toggle', invert the default value.
1267 notmuch-show-elide-non-matching-messages
1269 (not notmuch-show-only-matching-messages)
1270 notmuch-show-only-matching-messages))
1271 (add-hook 'post-command-hook #'notmuch-show-command-hook nil t)
1272 (jit-lock-register #'notmuch-show-buttonise-links)
1273 (notmuch-tag-clear-cache)
1274 (let ((inhibit-read-only t))
1275 (if (notmuch-show--build-buffer)
1276 ;; Messages were inserted into the buffer.
1278 ;; No messages were inserted - presumably none matched the
1280 (kill-buffer (current-buffer))
1282 (message "No messages matched the query!")
1285 (defun notmuch-show--build-queries (thread context)
1286 "Return a list of queries to try for this search.
1288 THREAD and CONTEXT are both strings, though CONTEXT may be nil.
1289 When CONTEXT is not nil, the first query is the conjunction of it
1290 and THREAD. The next query is THREAD alone, and serves as a
1291 fallback if the prior matches no messages."
1293 (push (list thread) queries)
1294 (if context (push (list thread "and (" context ")") queries))
1297 (defun notmuch-show--build-buffer (&optional state)
1298 "Display messages matching the current buffer context.
1300 Apply the previously saved STATE if supplied, otherwise show the
1301 first relevant message.
1303 If no messages match the query return NIL."
1304 (let* ((cli-args (cons "--exclude=false"
1305 (when notmuch-show-elide-non-matching-messages
1306 (list "--entire-thread=false"))))
1307 (queries (notmuch-show--build-queries
1308 notmuch-show-thread-id notmuch-show-query-context))
1310 ;; Must be reset every time we are going to start inserting
1311 ;; messages into the buffer.
1312 (notmuch-show-previous-subject ""))
1313 ;; Use results from the first query that returns some.
1314 (while (and (not forest) queries)
1315 (setq forest (notmuch-query-get-threads
1316 (append cli-args (list "'") (car queries) (list "'"))))
1317 (setq queries (cdr queries)))
1319 (notmuch-show-insert-forest forest)
1320 ;; Store the original tags for each message so that we can
1323 (lambda () (notmuch-show-set-prop :orig-tags (notmuch-show-get-tags))))
1324 ;; Set the header line to the subject of the first message.
1325 (setq header-line-format
1326 (replace-regexp-in-string "%" "%%"
1328 (notmuch-show-strip-re
1329 (notmuch-show-get-subject)))))
1330 (run-hooks 'notmuch-show-hook)
1332 (notmuch-show-apply-state state)
1333 ;; With no state to apply, just go to the first message.
1334 (notmuch-show-goto-first-wanted-message)))
1335 ;; Report back to the caller whether any messages matched.
1338 (defun notmuch-show-capture-state ()
1339 "Capture the state of the current buffer.
1342 - the list of open messages,
1343 - the combination of current message id with/for each visible window."
1344 (let* ((win-list (get-buffer-window-list (current-buffer) nil t))
1345 (win-id-combo (mapcar (lambda (win)
1346 (with-selected-window win
1347 (list win (notmuch-show-get-message-id))))
1349 (list win-id-combo (notmuch-show-get-message-ids-for-open-messages))))
1351 (defun notmuch-show-get-query ()
1352 "Return the current query in this show buffer."
1353 (if notmuch-show-query-context
1354 (concat notmuch-show-thread-id
1356 notmuch-show-query-context
1358 notmuch-show-thread-id))
1360 (defun notmuch-show-goto-message (msg-id)
1361 "Go to message with msg-id."
1362 (goto-char (point-min))
1363 (unless (cl-loop if (string= msg-id (notmuch-show-get-message-id))
1365 until (not (notmuch-show-goto-message-next)))
1366 (goto-char (point-min))
1367 (message "Message-id not found."))
1368 (notmuch-show-message-adjust))
1370 (defun notmuch-show-apply-state (state)
1371 "Apply STATE to the current buffer.
1374 - opening the messages previously opened,
1375 - closing all other messages,
1376 - moving to the correct current message in every displayed window."
1377 (let ((win-msg-alist (car state))
1378 (open (cadr state)))
1379 ;; Open those that were open.
1380 (goto-char (point-min))
1381 (cl-loop do (notmuch-show-message-visible
1382 (notmuch-show-get-message-properties)
1383 (member (notmuch-show-get-message-id) open))
1384 until (not (notmuch-show-goto-message-next)))
1385 (dolist (win-msg-pair win-msg-alist)
1386 (with-selected-window (car win-msg-pair)
1387 ;; Go to the previously open message in this window
1388 (notmuch-show-goto-message (cadr win-msg-pair))))))
1390 (defun notmuch-show-refresh-view (&optional reset-state)
1391 "Refresh the current view.
1393 Refreshes the current view, observing changes in display
1394 preferences. If invoked with a prefix argument (or RESET-STATE is
1395 non-nil) then the state of the buffer (open/closed messages) is
1396 reset based on the original query."
1398 (let ((inhibit-read-only t)
1399 (state (unless reset-state
1400 (notmuch-show-capture-state))))
1401 ;; `erase-buffer' does not seem to remove overlays, which can lead
1402 ;; to weird effects such as remaining images, so remove them
1406 (unless (notmuch-show--build-buffer state)
1407 ;; No messages were inserted.
1408 (kill-buffer (current-buffer))
1410 (message "Refreshing the buffer resulted in no messages!"))))
1412 (defvar notmuch-show-stash-map
1413 (let ((map (make-sparse-keymap)))
1414 (define-key map "c" 'notmuch-show-stash-cc)
1415 (define-key map "d" 'notmuch-show-stash-date)
1416 (define-key map "F" 'notmuch-show-stash-filename)
1417 (define-key map "f" 'notmuch-show-stash-from)
1418 (define-key map "i" 'notmuch-show-stash-message-id)
1419 (define-key map "I" 'notmuch-show-stash-message-id-stripped)
1420 (define-key map "s" 'notmuch-show-stash-subject)
1421 (define-key map "T" 'notmuch-show-stash-tags)
1422 (define-key map "t" 'notmuch-show-stash-to)
1423 (define-key map "l" 'notmuch-show-stash-mlarchive-link)
1424 (define-key map "L" 'notmuch-show-stash-mlarchive-link-and-go)
1425 (define-key map "G" 'notmuch-show-stash-git-send-email)
1426 (define-key map "?" 'notmuch-subkeymap-help)
1428 "Submap for stash commands.")
1429 (fset 'notmuch-show-stash-map notmuch-show-stash-map)
1431 (defvar notmuch-show-part-map
1432 (let ((map (make-sparse-keymap)))
1433 (define-key map "s" 'notmuch-show-save-part)
1434 (define-key map "v" 'notmuch-show-view-part)
1435 (define-key map "o" 'notmuch-show-interactively-view-part)
1436 (define-key map "|" 'notmuch-show-pipe-part)
1437 (define-key map "m" 'notmuch-show-choose-mime-of-part)
1438 (define-key map "?" 'notmuch-subkeymap-help)
1440 "Submap for part commands.")
1441 (fset 'notmuch-show-part-map notmuch-show-part-map)
1443 (defvar notmuch-show-mode-map
1444 (let ((map (make-sparse-keymap)))
1445 (set-keymap-parent map notmuch-common-keymap)
1446 (define-key map "Z" 'notmuch-tree-from-show-current-query)
1447 (define-key map "U" 'notmuch-unthreaded-from-show-current-query)
1448 (define-key map (kbd "<C-tab>") 'widget-backward)
1449 (define-key map (kbd "M-TAB") 'notmuch-show-previous-button)
1450 (define-key map (kbd "<backtab>") 'notmuch-show-previous-button)
1451 (define-key map (kbd "TAB") 'notmuch-show-next-button)
1452 (define-key map "f" 'notmuch-show-forward-message)
1453 (define-key map "F" 'notmuch-show-forward-open-messages)
1454 (define-key map "b" 'notmuch-show-resend-message)
1455 (define-key map "l" 'notmuch-show-filter-thread)
1456 (define-key map "r" 'notmuch-show-reply-sender)
1457 (define-key map "R" 'notmuch-show-reply)
1458 (define-key map "|" 'notmuch-show-pipe-message)
1459 (define-key map "w" 'notmuch-show-save-attachments)
1460 (define-key map "V" 'notmuch-show-view-raw-message)
1461 (define-key map "e" 'notmuch-show-resume-message)
1462 (define-key map "c" 'notmuch-show-stash-map)
1463 (define-key map "h" 'notmuch-show-toggle-visibility-headers)
1464 (define-key map "k" 'notmuch-tag-jump)
1465 (define-key map "*" 'notmuch-show-tag-all)
1466 (define-key map "-" 'notmuch-show-remove-tag)
1467 (define-key map "+" 'notmuch-show-add-tag)
1468 (define-key map "X" 'notmuch-show-archive-thread-then-exit)
1469 (define-key map "x" 'notmuch-show-archive-message-then-next-or-exit)
1470 (define-key map "A" 'notmuch-show-archive-thread-then-next)
1471 (define-key map "a" 'notmuch-show-archive-message-then-next-or-next-thread)
1472 (define-key map "N" 'notmuch-show-next-message)
1473 (define-key map "P" 'notmuch-show-previous-message)
1474 (define-key map "n" 'notmuch-show-next-open-message)
1475 (define-key map "p" 'notmuch-show-previous-open-message)
1476 (define-key map (kbd "M-n") 'notmuch-show-next-thread-show)
1477 (define-key map (kbd "M-p") 'notmuch-show-previous-thread-show)
1478 (define-key map (kbd "DEL") 'notmuch-show-rewind)
1479 (define-key map " " 'notmuch-show-advance-and-archive)
1480 (define-key map (kbd "M-RET") 'notmuch-show-open-or-close-all)
1481 (define-key map (kbd "RET") 'notmuch-show-toggle-message)
1482 (define-key map "#" 'notmuch-show-print-message)
1483 (define-key map "!" 'notmuch-show-toggle-elide-non-matching)
1484 (define-key map "$" 'notmuch-show-toggle-process-crypto)
1485 (define-key map "<" 'notmuch-show-toggle-thread-indentation)
1486 (define-key map "t" 'toggle-truncate-lines)
1487 (define-key map "." 'notmuch-show-part-map)
1488 (define-key map "B" 'notmuch-show-browse-urls)
1490 "Keymap for \"notmuch show\" buffers.")
1491 (fset 'notmuch-show-mode-map notmuch-show-mode-map)
1493 (define-derived-mode notmuch-show-mode fundamental-mode "notmuch-show"
1494 "Major mode for viewing a thread with notmuch.
1496 This buffer contains the results of the \"notmuch show\" command
1497 for displaying a single thread of email from your email archives.
1499 By default, various components of email messages, (citations,
1500 signatures, already-read messages), are hidden. You can make
1501 these parts visible by clicking with the mouse button or by
1502 pressing RET after positioning the cursor on a hidden part, (for
1503 which \\[notmuch-show-next-button] and \\[notmuch-show-previous-button] are helpful).
1505 Reading the thread sequentially is well-supported by pressing
1506 \\[notmuch-show-advance-and-archive]. This will scroll the current message (if necessary), advance
1507 to the next message, or advance to the next thread (if already on
1508 the last message of a thread).
1510 Other commands are available to read or manipulate the thread
1511 more selectively, (such as '\\[notmuch-show-next-message]' and '\\[notmuch-show-previous-message]' to advance to messages
1512 without removing any tags, and '\\[notmuch-show-archive-thread]' to archive an entire thread
1513 without scrolling through with \\[notmuch-show-advance-and-archive]).
1515 You can add or remove arbitrary tags from the current message with
1516 '\\[notmuch-show-add-tag]' or '\\[notmuch-show-remove-tag]'.
1518 All currently available key bindings:
1520 \\{notmuch-show-mode-map}"
1521 (setq notmuch-buffer-refresh-function #'notmuch-show-refresh-view)
1522 (setq buffer-read-only t
1524 (setq imenu-prev-index-position-function
1525 #'notmuch-show-imenu-prev-index-position-function)
1526 (setq imenu-extract-index-name-function
1527 #'notmuch-show-imenu-extract-index-name-function))
1529 (defun notmuch-tree-from-show-current-query ()
1530 "Call notmuch tree with the current query."
1532 (notmuch-tree notmuch-show-thread-id
1533 notmuch-show-query-context
1534 (notmuch-show-get-message-id)))
1536 (defun notmuch-unthreaded-from-show-current-query ()
1537 "Call notmuch unthreaded with the current query."
1539 (notmuch-unthreaded notmuch-show-thread-id
1540 notmuch-show-query-context
1541 (notmuch-show-get-message-id)))
1543 (defun notmuch-show-move-to-message-top ()
1544 (goto-char (notmuch-show-message-top)))
1546 (defun notmuch-show-move-to-message-bottom ()
1547 (goto-char (notmuch-show-message-bottom)))
1549 (defun notmuch-show-message-adjust ()
1552 ;; Movement related functions.
1554 ;; There's some strangeness here where a text property applied to a
1555 ;; region a->b is not found when point is at b. We walk backwards
1556 ;; until finding the property.
1557 (defun notmuch-show-message-extent ()
1558 "Return a cons cell containing the start and end buffer offset
1559 of the current message."
1562 (while (not (setq r (get-text-property (point) :notmuch-message-extent)))
1566 (defun notmuch-show-message-top ()
1567 (car (notmuch-show-message-extent)))
1569 (defun notmuch-show-message-bottom ()
1570 (cdr (notmuch-show-message-extent)))
1572 (defun notmuch-show-goto-message-next ()
1573 (let ((start (point)))
1574 (notmuch-show-move-to-message-bottom)
1580 (defun notmuch-show-goto-message-previous ()
1581 (notmuch-show-move-to-message-top)
1585 (notmuch-show-move-to-message-top)
1588 (defun notmuch-show-mapc (function)
1589 "Iterate through all messages in the current thread with
1590 `notmuch-show-goto-message-next' and call FUNCTION for side
1593 (goto-char (point-min))
1594 (cl-loop do (funcall function)
1595 while (notmuch-show-goto-message-next))))
1597 ;; Functions relating to the visibility of messages and their
1600 (defun notmuch-show-message-visible (props visible-p)
1601 (overlay-put (plist-get props :message-overlay) 'invisible (not visible-p))
1602 (notmuch-show-set-prop :message-visible visible-p props))
1604 (defun notmuch-show-headers-visible (props visible-p)
1605 (overlay-put (plist-get props :headers-overlay) 'invisible (not visible-p))
1606 (notmuch-show-set-prop :headers-visible visible-p props))
1608 ;; Functions for setting and getting attributes of the current
1611 (defun notmuch-show-set-message-properties (props)
1613 (notmuch-show-move-to-message-top)
1614 (put-text-property (point) (+ (point) 1)
1615 :notmuch-message-properties props)))
1617 (defun notmuch-show-get-message-properties ()
1618 "Return the properties of the current message as a plist.
1620 Some useful entries are:
1621 :headers - Property list containing the headers :Date, :Subject, :From, etc.
1622 :body - Body of the message
1623 :tags - Tags for this message"
1625 (notmuch-show-move-to-message-top)
1626 (get-text-property (point) :notmuch-message-properties)))
1628 (defun notmuch-show-get-part-properties ()
1629 "Return the properties of the innermost part containing point.
1631 This is the part property list retrieved from the CLI. Signals
1632 an error if there is no part containing point."
1633 (or (get-text-property (point) :notmuch-part)
1634 (error "No message part here")))
1636 (defun notmuch-show-set-prop (prop val &optional props)
1637 (let ((inhibit-read-only t)
1639 (notmuch-show-get-message-properties))))
1640 (plist-put props prop val)
1641 (notmuch-show-set-message-properties props)))
1643 (defun notmuch-show-get-prop (prop &optional props)
1644 "Get property PROP from current message in show or tree mode.
1646 It gets property PROP from PROPS or, if PROPS is nil, the current
1647 message in either tree or show. This means that several utility
1648 functions in notmuch-show can be used directly by notmuch-tree as
1649 they just need the correct message properties."
1650 (let ((props (or props
1651 (cond ((eq major-mode 'notmuch-show-mode)
1652 (notmuch-show-get-message-properties))
1653 ((eq major-mode 'notmuch-tree-mode)
1654 (notmuch-tree-get-message-properties))
1656 (plist-get props prop)))
1658 (defun notmuch-show-get-message-id (&optional bare)
1659 "Return an id: query for the Message-Id of the current message.
1661 If optional argument BARE is non-nil, return
1662 the Message-Id without id: prefix and escaping."
1664 (notmuch-show-get-prop :id)
1665 (notmuch-id-to-query (notmuch-show-get-prop :id))))
1667 (defun notmuch-show-get-messages-ids ()
1668 "Return all id: queries of messages in the current thread."
1669 (let ((message-ids))
1671 (lambda () (push (notmuch-show-get-message-id) message-ids)))
1674 (defun notmuch-show-get-messages-ids-search ()
1675 "Return a search string for all message ids of messages in the
1677 (mapconcat 'identity (notmuch-show-get-messages-ids) " or "))
1679 ;; dme: Would it make sense to use a macro for many of these?
1681 ;; XXX TODO figure out what to do about multiple filenames
1682 (defun notmuch-show-get-filename ()
1683 "Return the filename of the current message."
1684 (car (notmuch-show-get-prop :filename)))
1686 (defun notmuch-show-get-header (header &optional props)
1687 "Return the named header of the current message, if any."
1688 (plist-get (notmuch-show-get-prop :headers props) header))
1690 (defun notmuch-show-get-cc ()
1691 (notmuch-show-get-header :Cc))
1693 (defun notmuch-show-get-date ()
1694 (notmuch-show-get-header :Date))
1696 (defun notmuch-show-get-timestamp ()
1697 (notmuch-show-get-prop :timestamp))
1699 (defun notmuch-show-get-from ()
1700 (notmuch-show-get-header :From))
1702 (defun notmuch-show-get-subject ()
1703 (notmuch-show-get-header :Subject))
1705 (defun notmuch-show-get-to ()
1706 (notmuch-show-get-header :To))
1708 (defun notmuch-show-get-depth ()
1709 (notmuch-show-get-prop :depth))
1711 (defun notmuch-show-set-tags (tags)
1712 "Set the tags of the current message."
1713 (notmuch-show-set-prop :tags tags)
1714 (notmuch-show-update-tags tags))
1716 (defun notmuch-show-get-tags ()
1717 "Return the tags of the current message."
1718 (notmuch-show-get-prop :tags))
1720 (defun notmuch-show-message-visible-p ()
1721 "Is the current message visible?"
1722 (notmuch-show-get-prop :message-visible))
1724 (defun notmuch-show-headers-visible-p ()
1725 "Are the headers of the current message visible?"
1726 (notmuch-show-get-prop :headers-visible))
1728 (put 'notmuch-show-mark-read 'notmuch-prefix-doc
1729 "Mark the current message as unread.")
1730 (defun notmuch-show-mark-read (&optional unread)
1731 "Mark the current message as read.
1733 Mark the current message as read by applying the tag changes in
1734 `notmuch-show-mark-read-tags' to it (remove the \"unread\" tag by
1735 default). If a prefix argument is given, the message will be
1736 marked as unread, i.e. the tag changes in
1737 `notmuch-show-mark-read-tags' will be reversed."
1739 (when notmuch-show-mark-read-tags
1740 (apply 'notmuch-show-tag-message
1741 (notmuch-tag-change-list notmuch-show-mark-read-tags unread))))
1743 (defun notmuch-show-seen-current-message (start end)
1744 "Mark the current message read if it is open.
1746 We only mark it read once: if it is changed back then that is a
1747 user decision and we should not override it."
1748 (when (and (notmuch-show-message-visible-p)
1749 (not (notmuch-show-get-prop :seen)))
1750 (notmuch-show-mark-read)
1751 (notmuch-show-set-prop :seen t)))
1753 (defvar notmuch-show--seen-has-errored nil)
1754 (make-variable-buffer-local 'notmuch-show--seen-has-errored)
1756 (defun notmuch-show-command-hook ()
1757 (when (eq major-mode 'notmuch-show-mode)
1758 ;; We need to redisplay to get window-start and window-end correct.
1762 (funcall notmuch-show-mark-read-function (window-start) (window-end))
1764 (unless notmuch-show--seen-has-errored
1765 (setq notmuch-show--seen-has-errored 't)
1766 (setq header-line-format
1767 (concat header-line-format
1769 " [some mark read tag changes may have failed]"
1770 'face font-lock-warning-face)))))))))
1772 (defun notmuch-show-filter-thread (query)
1773 "Filter or LIMIT the current thread based on a new query string.
1775 Reshows the current thread with matches defined by the new query-string."
1776 (interactive (list (notmuch-read-query "Filter thread: ")))
1777 (let ((msg-id (notmuch-show-get-message-id)))
1778 (setq notmuch-show-query-context (if (string= query "") nil query))
1779 (notmuch-show-refresh-view t)
1780 (notmuch-show-goto-message msg-id)))
1782 ;; Functions for getting attributes of several messages in the current
1785 (defun notmuch-show-get-message-ids-for-open-messages ()
1786 "Return a list of all id: queries for open messages in the current thread."
1788 (let (message-ids done)
1789 (goto-char (point-min))
1791 (if (notmuch-show-message-visible-p)
1793 (append message-ids (list (notmuch-show-get-message-id)))))
1794 (setq done (not (notmuch-show-goto-message-next)))
1799 ;; Commands typically bound to keys.
1801 (defun notmuch-show-advance ()
1802 "Advance through thread.
1804 If the current message in the thread is not yet fully visible,
1805 scroll by a near screenful to read more of the message.
1807 Otherwise, (the end of the current message is already within the
1808 current window), advance to the next open message."
1810 (let* ((end-of-this-message (notmuch-show-message-bottom))
1811 (visible-end-of-this-message (1- end-of-this-message))
1813 (while (invisible-p visible-end-of-this-message)
1814 (setq visible-end-of-this-message
1816 (1- (previous-single-char-property-change
1817 visible-end-of-this-message 'invisible)))))
1819 ;; Ideally we would test `end-of-this-message' against the result
1820 ;; of `window-end', but that doesn't account for the fact that
1821 ;; the end of the message might be hidden.
1822 ((and visible-end-of-this-message
1823 (> visible-end-of-this-message (window-end)))
1824 ;; The bottom of this message is not visible - scroll.
1826 ((not (= end-of-this-message (point-max)))
1827 ;; This is not the last message - move to the next visible one.
1828 (notmuch-show-next-open-message))
1829 ((not (= (point) (point-max)))
1830 ;; This is the last message, but the cursor is not at the end of
1831 ;; the buffer. Move it there.
1832 (goto-char (point-max)))
1834 ;; This is the last message - change the return value
1838 (defun notmuch-show-advance-and-archive ()
1839 "Advance through thread and archive.
1841 This command is intended to be one of the simplest ways to
1842 process a thread of email. It works exactly like
1843 notmuch-show-advance, in that it scrolls through messages in a
1844 show buffer, except that when it gets to the end of the buffer it
1845 archives the entire current thread, (apply changes in
1846 `notmuch-archive-tags'), kills the buffer, and displays the next
1847 thread from the search from which this thread was originally
1850 (if (notmuch-show-advance)
1851 (notmuch-show-archive-thread-then-next)))
1853 (defun notmuch-show-rewind ()
1854 "Backup through the thread (reverse scrolling compared to \
1855 \\[notmuch-show-advance-and-archive]).
1857 Specifically, if the beginning of the previous email is fewer
1858 than `window-height' lines from the current point, move to it
1859 just like `notmuch-show-previous-message'.
1861 Otherwise, just scroll down a screenful of the current message.
1863 This command does not modify any message tags, (it does not undo
1864 any effects from previous calls to
1865 `notmuch-show-advance-and-archive'."
1867 (let ((start-of-message (notmuch-show-message-top))
1868 (start-of-window (window-start)))
1870 ;; Either this message is properly aligned with the start of the
1871 ;; window or the start of this message is not visible on the
1873 ((or (= start-of-message start-of-window)
1874 (< start-of-message start-of-window))
1876 ;; If a small number of lines from the previous message are
1877 ;; visible, realign so that the top of the current message is at
1878 ;; the top of the screen.
1879 (when (<= (count-screen-lines (window-start) start-of-message)
1880 next-screen-context-lines)
1881 (goto-char (notmuch-show-message-top))
1882 (notmuch-show-message-adjust))
1883 ;; Move to the top left of the window.
1884 (goto-char (window-start)))
1886 ;; Move to the previous message.
1887 (notmuch-show-previous-message)))))
1889 (put 'notmuch-show-reply 'notmuch-prefix-doc "... and prompt for sender")
1890 (defun notmuch-show-reply (&optional prompt-for-sender)
1891 "Reply to the sender and all recipients of the current message."
1893 (notmuch-mua-new-reply (notmuch-show-get-message-id) prompt-for-sender t))
1895 (put 'notmuch-show-reply-sender 'notmuch-prefix-doc "... and prompt for sender")
1896 (defun notmuch-show-reply-sender (&optional prompt-for-sender)
1897 "Reply to the sender of the current message."
1899 (notmuch-mua-new-reply (notmuch-show-get-message-id) prompt-for-sender nil))
1901 (put 'notmuch-show-forward-message 'notmuch-prefix-doc
1902 "... and prompt for sender")
1903 (defun notmuch-show-forward-message (&optional prompt-for-sender)
1904 "Forward the current message."
1906 (notmuch-mua-new-forward-messages (list (notmuch-show-get-message-id))
1909 (put 'notmuch-show-forward-open-messages 'notmuch-prefix-doc
1910 "... and prompt for sender")
1911 (defun notmuch-show-forward-open-messages (&optional prompt-for-sender)
1912 "Forward the currently open messages."
1914 (let ((open-messages (notmuch-show-get-message-ids-for-open-messages)))
1915 (unless open-messages
1916 (error "No open messages to forward."))
1917 (notmuch-mua-new-forward-messages open-messages prompt-for-sender)))
1919 (defun notmuch-show-resend-message (addresses)
1920 "Resend the current message."
1921 (interactive (list (notmuch-address-from-minibuffer "Resend to: ")))
1922 (when (y-or-n-p (concat "Confirm resend to " addresses " "))
1923 (notmuch-show-view-raw-message)
1924 (message-resend addresses)
1925 (notmuch-bury-or-kill-this-buffer)))
1927 (defun notmuch-show-next-message (&optional pop-at-end)
1928 "Show the next message.
1930 If a prefix argument is given and this is the last message in the
1931 thread, navigate to the next thread in the parent search buffer."
1933 (if (notmuch-show-goto-message-next)
1934 (notmuch-show-message-adjust)
1936 (notmuch-show-next-thread)
1937 (goto-char (point-max)))))
1939 (defun notmuch-show-previous-message ()
1940 "Show the previous message or the start of the current message."
1942 (if (= (point) (notmuch-show-message-top))
1943 (notmuch-show-goto-message-previous)
1944 (notmuch-show-move-to-message-top))
1945 (notmuch-show-message-adjust))
1947 (defun notmuch-show-next-open-message (&optional pop-at-end)
1948 "Show the next open message.
1950 If a prefix argument is given and this is the last open message
1951 in the thread, navigate to the next thread in the parent search
1952 buffer. Return t if there was a next open message in the thread
1953 to show, nil otherwise."
1956 (while (and (setq r (notmuch-show-goto-message-next))
1957 (not (notmuch-show-message-visible-p))))
1959 (notmuch-show-message-adjust)
1961 (notmuch-show-next-thread)
1962 (goto-char (point-max))))
1965 (defun notmuch-show-next-matching-message ()
1966 "Show the next matching message."
1969 (while (and (setq r (notmuch-show-goto-message-next))
1970 (not (notmuch-show-get-prop :match))))
1972 (notmuch-show-message-adjust)
1973 (goto-char (point-max)))))
1975 (defun notmuch-show-open-if-matched ()
1976 "Open a message if it is matched (whether or not excluded)."
1977 (let ((props (notmuch-show-get-message-properties)))
1978 (notmuch-show-message-visible props (plist-get props :match))))
1980 (defun notmuch-show-goto-first-wanted-message ()
1981 "Move to the first open message and mark it read."
1982 (goto-char (point-min))
1983 (unless (notmuch-show-message-visible-p)
1984 (notmuch-show-next-open-message))
1986 ;; There are no matched non-excluded messages so open all matched
1987 ;; (necessarily excluded) messages and go to the first.
1988 (notmuch-show-mapc 'notmuch-show-open-if-matched)
1989 (force-window-update)
1990 (goto-char (point-min))
1991 (unless (notmuch-show-message-visible-p)
1992 (notmuch-show-next-open-message))))
1994 (defun notmuch-show-previous-open-message ()
1995 "Show the previous open message."
1997 (while (and (if (= (point) (notmuch-show-message-top))
1998 (notmuch-show-goto-message-previous)
1999 (notmuch-show-move-to-message-top))
2000 (not (notmuch-show-message-visible-p))))
2001 (notmuch-show-message-adjust))
2003 (defun notmuch-show-view-raw-message ()
2004 "View the original source of the current message."
2006 (let* ((id (notmuch-show-get-message-id))
2007 (buf (get-buffer-create (concat "*notmuch-raw-" id "*")))
2008 (inhibit-read-only t))
2009 (switch-to-buffer buf)
2011 (let ((coding-system-for-read 'no-conversion))
2012 (call-process notmuch-command nil t nil "show" "--format=raw" id))
2013 (goto-char (point-min))
2014 (set-buffer-modified-p nil)
2015 (setq buffer-read-only t)
2016 (view-buffer buf 'kill-buffer-if-not-modified)))
2018 (defun notmuch-show-resume-message ()
2019 "Resume EDITING the current draft message."
2021 (notmuch-draft-resume (notmuch-show-get-message-id)))
2023 (put 'notmuch-show-pipe-message 'notmuch-doc
2024 "Pipe the contents of the current message to a command.")
2025 (put 'notmuch-show-pipe-message 'notmuch-prefix-doc
2026 "Pipe the thread as an mbox to a command.")
2027 (defun notmuch-show-pipe-message (entire-thread command)
2028 "Pipe the contents of the current message (or thread) to COMMAND.
2030 COMMAND will be executed with the raw contents of the current
2031 email message as stdin. Anything printed by the command to stdout
2032 or stderr will appear in the *notmuch-pipe* buffer.
2034 If ENTIRE-THREAD is non-nil (or when invoked with a prefix
2035 argument), COMMAND will receive all open messages in the current
2036 thread (formatted as an mbox) rather than only the current
2038 (interactive (let ((query-string (if current-prefix-arg
2039 "Pipe all open messages to command: "
2040 "Pipe message to command: ")))
2041 (list current-prefix-arg (read-string query-string))))
2042 (let (shell-command)
2045 (concat notmuch-command " show --format=mbox --exclude=false "
2046 (shell-quote-argument
2047 (mapconcat 'identity
2048 (notmuch-show-get-message-ids-for-open-messages)
2052 (concat notmuch-command " show --format=raw "
2053 (shell-quote-argument (notmuch-show-get-message-id))
2055 (let ((cwd default-directory)
2056 (buf (get-buffer-create (concat "*notmuch-pipe*"))))
2057 (with-current-buffer buf
2058 (setq buffer-read-only nil)
2060 ;; Use the originating buffer's working directory instead of
2061 ;; that of the pipe buffer.
2063 (let ((exit-code (call-process-shell-command shell-command nil buf)))
2064 (goto-char (point-max))
2065 (set-buffer-modified-p nil)
2066 (setq buffer-read-only t)
2067 (unless (zerop exit-code)
2068 (switch-to-buffer-other-window buf)
2069 (message (format "Command '%s' exited abnormally with code %d"
2070 shell-command exit-code))))))))
2072 (defun notmuch-show-tag-message (&rest tag-changes)
2073 "Change tags for the current message.
2075 TAG-CHANGES is a list of tag operations for `notmuch-tag'."
2076 (let* ((current-tags (notmuch-show-get-tags))
2077 (new-tags (notmuch-update-tags current-tags tag-changes)))
2078 (unless (equal current-tags new-tags)
2079 (notmuch-tag (notmuch-show-get-message-id) tag-changes)
2080 (notmuch-show-set-tags new-tags))))
2082 (defun notmuch-show-tag (tag-changes)
2083 "Change tags for the current message.
2085 See `notmuch-tag' for information on the format of TAG-CHANGES."
2086 (interactive (list (notmuch-read-tag-changes (notmuch-show-get-tags)
2088 (notmuch-tag (notmuch-show-get-message-id) tag-changes)
2089 (let* ((current-tags (notmuch-show-get-tags))
2090 (new-tags (notmuch-update-tags current-tags tag-changes)))
2091 (unless (equal current-tags new-tags)
2092 (notmuch-show-set-tags new-tags))))
2094 (defun notmuch-show-tag-all (tag-changes)
2095 "Change tags for all messages in the current show buffer.
2097 See `notmuch-tag' for information on the format of TAG-CHANGES."
2101 (lambda () (setq tags (append (notmuch-show-get-tags) tags))))
2102 (notmuch-read-tag-changes tags "Tag thread"))))
2103 (notmuch-tag (notmuch-show-get-messages-ids-search) tag-changes)
2106 (let* ((current-tags (notmuch-show-get-tags))
2107 (new-tags (notmuch-update-tags current-tags tag-changes)))
2108 (unless (equal current-tags new-tags)
2109 (notmuch-show-set-tags new-tags))))))
2111 (defun notmuch-show-add-tag (tag-changes)
2112 "Change tags for the current message (defaulting to add).
2114 Same as `notmuch-show-tag' but sets initial input to '+'."
2116 (list (notmuch-read-tag-changes (notmuch-show-get-tags) "Tag message" "+")))
2117 (notmuch-show-tag tag-changes))
2119 (defun notmuch-show-remove-tag (tag-changes)
2120 "Change tags for the current message (defaulting to remove).
2122 Same as `notmuch-show-tag' but sets initial input to '-'."
2124 (list (notmuch-read-tag-changes (notmuch-show-get-tags) "Tag message" "-")))
2125 (notmuch-show-tag tag-changes))
2127 (defun notmuch-show-toggle-visibility-headers ()
2128 "Toggle the visibility of the current message headers."
2130 (let ((props (notmuch-show-get-message-properties)))
2131 (notmuch-show-headers-visible
2133 (not (plist-get props :headers-visible))))
2134 (force-window-update))
2136 (defun notmuch-show-toggle-message ()
2137 "Toggle the visibility of the current message."
2139 (let ((props (notmuch-show-get-message-properties)))
2140 (notmuch-show-message-visible
2142 (not (plist-get props :message-visible))))
2143 (force-window-update))
2145 (put 'notmuch-show-open-or-close-all 'notmuch-doc "Show all messages.")
2146 (put 'notmuch-show-open-or-close-all 'notmuch-prefix-doc "Hide all messages.")
2147 (defun notmuch-show-open-or-close-all ()
2148 "Set the visibility all of the messages in the current thread.
2150 By default make all of the messages visible. With a prefix
2151 argument, hide all of the messages."
2154 (goto-char (point-min))
2155 (cl-loop do (notmuch-show-message-visible
2156 (notmuch-show-get-message-properties)
2157 (not current-prefix-arg))
2158 until (not (notmuch-show-goto-message-next))))
2159 (force-window-update))
2161 (defun notmuch-show-next-button ()
2162 "Advance point to the next button in the buffer."
2166 (defun notmuch-show-previous-button ()
2167 "Move point back to the previous button in the buffer."
2169 (backward-button 1))
2171 (defun notmuch-show-next-thread (&optional show previous)
2172 "Move to the next item in the search results, if any.
2174 If SHOW is non-nil, open the next item in a show
2175 buffer. Otherwise just highlight the next item in the search
2176 buffer. If PREVIOUS is non-nil, move to the previous item in the
2177 search results instead."
2179 (let ((parent-buffer notmuch-show-parent-buffer))
2180 (notmuch-bury-or-kill-this-buffer)
2181 (when (buffer-live-p parent-buffer)
2182 (switch-to-buffer parent-buffer)
2184 (notmuch-search-previous-thread)
2185 (notmuch-search-next-thread))
2187 (notmuch-search-show-thread)))))
2189 (defun notmuch-show-next-thread-show ()
2190 "Show the next thread in the search results, if any."
2192 (notmuch-show-next-thread t))
2194 (defun notmuch-show-previous-thread-show ()
2195 "Show the previous thread in the search results, if any."
2197 (notmuch-show-next-thread t t))
2199 (put 'notmuch-show-archive-thread 'notmuch-prefix-doc
2200 "Un-archive each message in thread.")
2201 (defun notmuch-show-archive-thread (&optional unarchive)
2202 "Archive each message in thread.
2204 Archive each message currently shown by applying the tag changes
2205 in `notmuch-archive-tags' to each. If a prefix argument is given,
2206 the messages will be \"unarchived\", i.e. the tag changes in
2207 `notmuch-archive-tags' will be reversed.
2209 Note: This command is safe from any race condition of new messages
2210 being delivered to the same thread. It does not archive the
2211 entire thread, but only the messages shown in the current
2214 (when notmuch-archive-tags
2215 (notmuch-show-tag-all
2216 (notmuch-tag-change-list notmuch-archive-tags unarchive))))
2218 (defun notmuch-show-archive-thread-then-next ()
2219 "Archive all messages in the current buffer, then show next thread from search."
2221 (notmuch-show-archive-thread)
2222 (notmuch-show-next-thread t))
2224 (defun notmuch-show-archive-thread-then-exit ()
2225 "Archive all messages in the current buffer, then exit back to search results."
2227 (notmuch-show-archive-thread)
2228 (notmuch-show-next-thread))
2230 (put 'notmuch-show-archive-message 'notmuch-prefix-doc
2231 "Un-archive the current message.")
2232 (defun notmuch-show-archive-message (&optional unarchive)
2233 "Archive the current message.
2235 Archive the current message by applying the tag changes in
2236 `notmuch-archive-tags' to it. If a prefix argument is given, the
2237 message will be \"unarchived\", i.e. the tag changes in
2238 `notmuch-archive-tags' will be reversed."
2240 (when notmuch-archive-tags
2241 (apply 'notmuch-show-tag-message
2242 (notmuch-tag-change-list notmuch-archive-tags unarchive))))
2244 (defun notmuch-show-archive-message-then-next-or-exit ()
2245 "Archive current message, then show next open message in current thread.
2247 If at the last open message in the current thread, then exit back
2250 (notmuch-show-archive-message)
2251 (notmuch-show-next-open-message t))
2253 (defun notmuch-show-archive-message-then-next-or-next-thread ()
2254 "Archive current message, then show next open message in current or next thread.
2256 If at the last open message in the current thread, then show next
2257 thread from search."
2259 (notmuch-show-archive-message)
2260 (unless (notmuch-show-next-open-message)
2261 (notmuch-show-next-thread t)))
2263 (defun notmuch-show-stash-cc ()
2264 "Copy CC field of current message to kill-ring."
2266 (notmuch-common-do-stash (notmuch-show-get-cc)))
2268 (put 'notmuch-show-stash-date 'notmuch-prefix-doc
2269 "Copy timestamp of current message to kill-ring.")
2270 (defun notmuch-show-stash-date (&optional stash-timestamp)
2271 "Copy date of current message to kill-ring.
2273 If invoked with a prefix argument, copy timestamp of current
2274 message to kill-ring."
2277 (notmuch-common-do-stash (format "%d" (notmuch-show-get-timestamp)))
2278 (notmuch-common-do-stash (notmuch-show-get-date))))
2280 (defun notmuch-show-stash-filename ()
2281 "Copy filename of current message to kill-ring."
2283 (notmuch-common-do-stash (notmuch-show-get-filename)))
2285 (defun notmuch-show-stash-from ()
2286 "Copy From address of current message to kill-ring."
2288 (notmuch-common-do-stash (notmuch-show-get-from)))
2290 (put 'notmuch-show-stash-message-id 'notmuch-prefix-doc
2291 "Copy thread: query matching current thread to kill-ring.")
2292 (defun notmuch-show-stash-message-id (&optional stash-thread-id)
2293 "Copy id: query matching the current message to kill-ring.
2295 If invoked with a prefix argument (or STASH-THREAD-ID is
2296 non-nil), copy thread: query matching the current thread to
2300 (notmuch-common-do-stash notmuch-show-thread-id)
2301 (notmuch-common-do-stash (notmuch-show-get-message-id))))
2303 (defun notmuch-show-stash-message-id-stripped ()
2304 "Copy message ID of current message (sans `id:' prefix) to kill-ring."
2306 (notmuch-common-do-stash (notmuch-show-get-message-id t)))
2308 (defun notmuch-show-stash-subject ()
2309 "Copy Subject field of current message to kill-ring."
2311 (notmuch-common-do-stash (notmuch-show-get-subject)))
2313 (defun notmuch-show-stash-tags ()
2314 "Copy tags of current message to kill-ring as a comma separated list."
2316 (notmuch-common-do-stash (mapconcat 'identity (notmuch-show-get-tags) ",")))
2318 (defun notmuch-show-stash-to ()
2319 "Copy To address of current message to kill-ring."
2321 (notmuch-common-do-stash (notmuch-show-get-to)))
2323 (defun notmuch-show-stash-mlarchive-link (&optional mla)
2324 "Copy an ML Archive URI for the current message to the kill-ring.
2326 This presumes that the message is available at the selected Mailing List Archive.
2328 If optional argument MLA is non-nil, use the provided key instead of prompting
2329 the user (see `notmuch-show-stash-mlarchive-link-alist')."
2331 (let ((url (cdr (assoc
2333 (let ((completion-ignore-case t))
2335 "Mailing List Archive: "
2336 notmuch-show-stash-mlarchive-link-alist
2338 notmuch-show-stash-mlarchive-link-default)))
2339 notmuch-show-stash-mlarchive-link-alist))))
2340 (notmuch-common-do-stash
2342 (funcall url (notmuch-show-get-message-id t))
2343 (concat url (notmuch-show-get-message-id t))))))
2345 (defun notmuch-show-stash-mlarchive-link-and-go (&optional mla)
2346 "Copy an ML Archive URI for the current message to the kill-ring and visit it.
2348 This presumes that the message is available at the selected Mailing List Archive.
2350 If optional argument MLA is non-nil, use the provided key instead of prompting
2351 the user (see `notmuch-show-stash-mlarchive-link-alist')."
2353 (notmuch-show-stash-mlarchive-link mla)
2354 (browse-url (current-kill 0 t)))
2356 (defun notmuch-show-stash-git-helper (addresses prefix)
2357 "Escape, trim, quote, and add PREFIX to each address in list of ADDRESSES, and return the result as a single string."
2358 (mapconcat (lambda (x)
2360 ;; escape double-quotes
2361 (replace-regexp-in-string
2363 ;; trim leading and trailing spaces
2364 (replace-regexp-in-string
2365 "\\(^ *\\| *$\\)" ""
2369 (put 'notmuch-show-stash-git-send-email 'notmuch-prefix-doc
2370 "Copy From/To/Cc of current message to kill-ring in a form suitable for pasting to git send-email command line.")
2372 (defun notmuch-show-stash-git-send-email (&optional no-in-reply-to)
2373 "Copy From/To/Cc/Message-Id of current message to kill-ring in a form suitable for pasting to git send-email command line.
2375 If invoked with a prefix argument (or NO-IN-REPLY-TO is non-nil),
2376 omit --in-reply-to=<Message-Id>."
2378 (notmuch-common-do-stash
2379 (mapconcat 'identity
2382 (notmuch-show-stash-git-helper
2383 (message-tokenize-header (notmuch-show-get-from)) "--to=")
2384 (notmuch-show-stash-git-helper
2385 (message-tokenize-header (notmuch-show-get-to)) "--to=")
2386 (notmuch-show-stash-git-helper
2387 (message-tokenize-header (notmuch-show-get-cc)) "--cc=")
2388 (unless no-in-reply-to
2389 (notmuch-show-stash-git-helper
2390 (list (notmuch-show-get-message-id t)) "--in-reply-to="))))
2393 ;; Interactive part functions and their helpers
2395 (defun notmuch-show-generate-part-buffer (msg part)
2396 "Return a temporary buffer containing the specified part's content."
2397 (let ((buf (generate-new-buffer " *notmuch-part*"))
2398 (process-crypto notmuch-show-process-crypto))
2399 (with-current-buffer buf
2400 ;; This is always used in the content of mm handles, which
2401 ;; expect undecoded, binary part content.
2402 (insert (notmuch-get-bodypart-binary msg part process-crypto)))
2405 (defun notmuch-show-current-part-handle (&optional mime-type)
2406 "Return an mm-handle for the part containing point.
2408 This creates a temporary buffer for the part's content; the
2409 caller is responsible for killing this buffer as appropriate. If
2410 MIME-TYPE is given then set the handle's mime-type to MIME-TYPE."
2411 (let* ((msg (notmuch-show-get-message-properties))
2412 (part (notmuch-show-get-part-properties))
2413 (buf (notmuch-show-generate-part-buffer msg part))
2414 (computed-type (or mime-type (plist-get part :computed-type)))
2415 (filename (plist-get part :filename))
2416 (disposition (if filename `(attachment (filename . ,filename)))))
2417 (mm-make-handle buf (list computed-type) nil nil disposition)))
2419 (defun notmuch-show-apply-to-current-part-handle (fn &optional mime-type)
2420 "Apply FN to an mm-handle for the part containing point.
2422 This ensures that the temporary buffer created for the mm-handle
2423 is destroyed when FN returns. If MIME-TYPE is given then force
2424 part to be treated as if it had that mime-type."
2425 (let ((handle (notmuch-show-current-part-handle mime-type)))
2426 ;; emacs 24.3+ puts stdout/stderr into the calling buffer so we
2427 ;; call it from a temp-buffer, unless
2428 ;; notmuch-show-attachment-debug is non-nil in which case we put
2429 ;; it in " *notmuch-part*".
2431 (if notmuch-show-attachment-debug
2432 (with-current-buffer (generate-new-buffer " *notmuch-part*")
2433 (funcall fn handle))
2435 (funcall fn handle)))
2436 (kill-buffer (mm-handle-buffer handle)))))
2438 (defun notmuch-show-part-button-default (&optional button)
2440 (let ((button (or button (button-at (point)))))
2441 ;; Try to toggle the part, if that fails then call the default
2442 ;; action. The toggle fails if the part has no emacs renderable
2444 (unless (notmuch-show-toggle-part-invisibility button)
2445 (call-interactively notmuch-show-part-button-default-action))))
2447 (defun notmuch-show-save-part ()
2448 "Save the MIME part containing point to a file."
2450 (notmuch-show-apply-to-current-part-handle #'mm-save-part))
2452 (defun notmuch-show-view-part ()
2453 "View the MIME part containing point in an external viewer."
2455 ;; Set mm-inlined-types to nil to force an external viewer
2456 (let ((mm-inlined-types nil))
2457 (notmuch-show-apply-to-current-part-handle #'mm-display-part)))
2459 (defun notmuch-show-interactively-view-part ()
2460 "View the MIME part containing point, prompting for a viewer."
2462 (notmuch-show-apply-to-current-part-handle #'mm-interactively-view-part))
2464 (defun notmuch-show-pipe-part ()
2465 "Pipe the MIME part containing point to an external command."
2467 (notmuch-show-apply-to-current-part-handle #'mm-pipe-part))
2469 (defun notmuch-show--mm-display-part (handle)
2470 "Use mm-display-part to display HANDLE in a new buffer.
2472 If the part is displayed in an external application then close
2474 (let ((buf (get-buffer-create (generate-new-buffer-name
2475 (concat " *notmuch-internal-part*")))))
2476 (switch-to-buffer buf)
2477 (if (eq (mm-display-part handle) 'external)
2479 (goto-char (point-min))
2480 (set-buffer-modified-p nil)
2481 (view-buffer buf 'kill-buffer-if-not-modified))))
2483 (defun notmuch-show-choose-mime-of-part (mime-type)
2484 "Choose the mime type to use for displaying part."
2486 (list (completing-read "Mime type to use (default text/plain): "
2487 (mailcap-mime-types) nil nil nil nil "text/plain")))
2488 (notmuch-show-apply-to-current-part-handle #'notmuch-show--mm-display-part
2491 (defun notmuch-show-imenu-prev-index-position-function ()
2492 "Move point to previous message in notmuch-show buffer.
2493 This function is used as a value for
2494 `imenu-prev-index-position-function'."
2497 (notmuch-show-previous-message)
2500 (defun notmuch-show-imenu-extract-index-name-function ()
2501 "Return imenu name for line at point.
2502 This function is used as a value for
2503 `imenu-extract-index-name-function'. Point should be at the
2504 beginning of the line."
2505 (back-to-indentation)
2506 (buffer-substring-no-properties (if notmuch-show-imenu-indent
2507 (line-beginning-position)
2509 (line-end-position)))
2511 (defmacro notmuch-show--with-currently-shown-message (&rest body)
2512 "Evaluate BODY with display restricted to the currently shown
2516 (let ((extent (notmuch-show-message-extent)))
2517 (narrow-to-region (car extent) (cdr extent))
2520 (defun notmuch-show--gather-urls ()
2521 "Gather any URLs in the current message."
2522 (notmuch-show--with-currently-shown-message
2524 (goto-char (point-min))
2525 (while (re-search-forward goto-address-url-regexp (point-max) t)
2526 (push (match-string-no-properties 0) urls))
2529 (defun notmuch-show-browse-urls (&optional kill)
2530 "Offer to browse any URLs in the current message.
2531 With a prefix argument, copy the URL to the kill ring rather than
2534 (let ((urls (notmuch-show--gather-urls))
2535 (prompt (if kill "Copy URL to kill ring: " "Browse URL: "))
2536 (fn (if kill #'kill-new #'browse-url)))
2538 (funcall fn (completing-read prompt urls nil nil nil nil (car urls)))
2539 (message "No URLs found."))))
2541 (provide 'notmuch-show)
2543 ;;; notmuch-show.el ends here