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>
26 (eval-when-compile (require 'cl))
34 (require 'notmuch-lib)
35 (require 'notmuch-tag)
36 (require 'notmuch-query)
37 (require 'notmuch-wash)
38 (require 'notmuch-mua)
39 (require 'notmuch-crypto)
40 (require 'notmuch-print)
41 (require 'notmuch-draft)
43 (declare-function notmuch-call-notmuch-process "notmuch" (&rest args))
44 (declare-function notmuch-search-next-thread "notmuch" nil)
45 (declare-function notmuch-search-previous-thread "notmuch" nil)
46 (declare-function notmuch-search-show-thread "notmuch" nil)
47 (declare-function notmuch-foreach-mime-part "notmuch" (function mm-handle))
48 (declare-function notmuch-count-attachments "notmuch" (mm-handle))
49 (declare-function notmuch-save-attachments "notmuch" (mm-handle &optional queryp))
50 (declare-function notmuch-tree "notmuch-tree"
51 (&optional query query-context target buffer-name open-target))
52 (declare-function notmuch-tree-get-message-properties "notmuch-tree" nil)
53 (declare-function notmuch-read-query "notmuch" (prompt))
54 (declare-function notmuch-draft-resume "notmuch-draft" (id))
56 (defcustom notmuch-message-headers '("Subject" "To" "Cc" "Date")
57 "Headers that should be shown in a message, in this order.
59 For an open message, all of these headers will be made visible
60 according to `notmuch-message-headers-visible' or can be toggled
61 with `notmuch-show-toggle-visibility-headers'. For a closed message,
62 only the first header in the list will be visible."
63 :type '(repeat string)
66 (defcustom notmuch-message-headers-visible t
67 "Should the headers be visible by default?
69 If this value is non-nil, then all of the headers defined in
70 `notmuch-message-headers' will be visible by default in the display
71 of each message. Otherwise, these headers will be hidden and
72 `notmuch-show-toggle-visibility-headers' can be used to make them
73 visible for any given message."
77 (defcustom notmuch-show-relative-dates t
78 "Display relative dates in the message summary line."
82 (defvar notmuch-show-markup-headers-hook '(notmuch-show-colour-headers)
83 "A list of functions called to decorate the headers listed in
84 `notmuch-message-headers'.")
86 (defcustom notmuch-show-hook '(notmuch-show-turn-on-visual-line-mode)
87 "Functions called after populating a `notmuch-show' buffer."
89 :options '(notmuch-show-turn-on-visual-line-mode)
91 :group 'notmuch-hooks)
93 (defcustom notmuch-show-insert-text/plain-hook '(notmuch-wash-wrap-long-lines
94 notmuch-wash-tidy-citations
95 notmuch-wash-elide-blank-lines
96 notmuch-wash-excerpt-citations)
97 "Functions used to improve the display of text/plain parts."
99 :options '(notmuch-wash-convert-inline-patch-to-part
100 notmuch-wash-wrap-long-lines
101 notmuch-wash-tidy-citations
102 notmuch-wash-elide-blank-lines
103 notmuch-wash-excerpt-citations)
105 :group 'notmuch-hooks)
107 (defcustom notmuch-show-max-text-part-size 100000
108 "Maximum size of a text part to be shown by default in characters.
110 Set to 0 to show the part regardless of size."
112 :group 'notmuch-show)
114 ;; Mostly useful for debugging.
115 (defcustom notmuch-show-all-multipart/alternative-parts nil
116 "Should all parts of multipart/alternative parts be shown?"
118 :group 'notmuch-show)
120 (defcustom notmuch-show-indent-messages-width 1
121 "Width of message indentation in threads.
123 Messages are shown indented according to their depth in a thread.
124 This variable determines the width of this indentation measured
125 in number of blanks. Defaults to `1', choose `0' to disable
128 :group 'notmuch-show)
130 (defcustom notmuch-show-indent-multipart nil
131 "Should the sub-parts of a multipart/* part be indented?"
132 ;; dme: Not sure which is a good default.
134 :group 'notmuch-show)
136 (defcustom notmuch-show-part-button-default-action 'notmuch-show-save-part
137 "Default part header button action (on ENTER or mouse click)."
139 :type '(choice (const :tag "Save part"
140 notmuch-show-save-part)
141 (const :tag "View part"
142 notmuch-show-view-part)
143 (const :tag "View interactively"
144 notmuch-show-interactively-view-part)))
146 (defcustom notmuch-show-only-matching-messages nil
147 "Only matching messages are shown by default."
149 :group 'notmuch-show)
151 ;; By default, block all external images to prevent privacy leaks and
152 ;; potential attacks.
153 (defcustom notmuch-show-text/html-blocked-images "."
154 "Remote images that have URLs matching this regexp will be blocked."
155 :type '(choice (const nil) regexp)
156 :group 'notmuch-show)
158 (defvar notmuch-show-thread-id nil)
159 (make-variable-buffer-local 'notmuch-show-thread-id)
161 (defvar notmuch-show-parent-buffer nil)
162 (make-variable-buffer-local 'notmuch-show-parent-buffer)
164 (defvar notmuch-show-query-context nil)
165 (make-variable-buffer-local 'notmuch-show-query-context)
167 (defvar notmuch-show-process-crypto nil)
168 (make-variable-buffer-local 'notmuch-show-process-crypto)
170 (defvar notmuch-show-elide-non-matching-messages nil)
171 (make-variable-buffer-local 'notmuch-show-elide-non-matching-messages)
173 (defvar notmuch-show-indent-content t)
174 (make-variable-buffer-local 'notmuch-show-indent-content)
176 (defvar notmuch-show-attachment-debug nil
177 "If t log stdout and stderr from attachment handlers
179 When set to nil (the default) stdout and stderr from attachment
180 handlers is discarded. When set to t the stdout and stderr from
181 each attachment handler is logged in buffers with names beginning
182 \" *notmuch-part*\". This option requires emacs version at least
185 (defcustom notmuch-show-stash-mlarchive-link-alist
186 '(("Gmane" . "http://mid.gmane.org/")
187 ("MARC" . "https://marc.info/?i=")
188 ("Mail Archive, The" . "https://mid.mail-archive.com/")
189 ("LKML" . "https://lkml.kernel.org/r/")
190 ;; FIXME: can these services be searched by `Message-Id' ?
191 ;; ("MarkMail" . "http://markmail.org/")
192 ;; ("Nabble" . "http://nabble.com/")
193 ;; ("opensubscriber" . "http://opensubscriber.com/")
195 "List of Mailing List Archives to use when stashing links.
197 This list is used for generating a Mailing List Archive reference
198 URI with the current message's Message-Id in
199 `notmuch-show-stash-mlarchive-link'.
201 If the cdr of the alist element is not a function, the cdr is
202 expected to contain a URI that is concatenated with the current
203 message's Message-Id to create a ML archive reference URI.
205 If the cdr is a function, the function is called with the
206 Message-Id as the argument, and the function is expected to
207 return the ML archive reference URI."
208 :type '(alist :key-type (string :tag "Name")
211 (function :tag "Function returning the URL")))
212 :group 'notmuch-show)
214 (defcustom notmuch-show-stash-mlarchive-link-default "Gmane"
215 "Default Mailing List Archive to use when stashing links.
217 This is used when `notmuch-show-stash-mlarchive-link' isn't
218 provided with an MLA argument nor `completing-read' input."
222 (list 'const :tag (car mla) :value (car mla)))
223 notmuch-show-stash-mlarchive-link-alist))
224 :group 'notmuch-show)
226 (defcustom notmuch-show-mark-read-tags '("-unread")
227 "List of tag changes to apply to a message when it is marked as read.
229 Tags starting with \"+\" (or not starting with either \"+\" or
230 \"-\") in the list will be added, and tags starting with \"-\"
231 will be removed from the message being marked as read.
233 For example, if you wanted to remove an \"unread\" tag and add a
234 \"read\" tag (which would make little sense), you would set:
235 (\"-unread\" \"+read\")"
236 :type '(repeat string)
237 :group 'notmuch-show)
239 (defcustom notmuch-show-mark-read-function #'notmuch-show-seen-current-message
240 "Function to control which messages are marked read.
242 The function should take two arguments START and END which will
243 be the start and end of the visible portion of the buffer and
244 should mark the appropriate messages read by applying
245 `notmuch-show-mark-read'. This function will be called after
246 every user interaction with notmuch."
248 :group 'notmuch-show)
250 (defcustom notmuch-show-imenu-indent nil
251 "Should Imenu display messages indented.
253 By default, Imenu (see Info node `(emacs) Imenu') in a
254 notmuch-show buffer displays all messages straight. This is
255 because the default Emacs frontend for Imenu makes it difficult
256 to select an Imenu entry with spaces in front. Other imenu
257 frontends such as counsel-imenu does not have this limitation.
258 In these cases, Imenu entries can be indented to reflect the
259 position of the message in the thread."
261 :group 'notmuch-show)
263 (defmacro with-current-notmuch-show-message (&rest body)
264 "Evaluate body with current buffer set to the text of current message"
266 (let ((id (notmuch-show-get-message-id)))
267 (let ((buf (generate-new-buffer (concat "*notmuch-msg-" id "*"))))
268 (with-current-buffer buf
269 (let ((coding-system-for-read 'no-conversion))
270 (call-process notmuch-command nil t nil "show" "--format=raw" id))
272 (kill-buffer buf)))))
274 (defun notmuch-show-turn-on-visual-line-mode ()
275 "Enable Visual Line mode."
276 (visual-line-mode t))
278 ;; DEPRECATED in Notmuch 0.16 since we now have convenient part
279 ;; commands. We'll keep the command around for a version or two in
280 ;; case people want to bind it themselves.
281 (defun notmuch-show-view-all-mime-parts ()
282 "Use external viewers to view all attachments from the current message."
284 (with-current-notmuch-show-message
285 ;; We override the mm-inline-media-tests to indicate which message
286 ;; parts are already sufficiently handled by the original
287 ;; presentation of the message in notmuch-show mode. These parts
288 ;; will be inserted directly into the temporary buffer of
289 ;; with-current-notmuch-show-message and silently discarded.
291 ;; Any MIME part not explicitly mentioned here will be handled by an
292 ;; external viewer as configured in the various mailcap files.
293 (let ((mm-inline-media-tests '(
294 ("text/.*" ignore identity)
295 ("application/pgp-signature" ignore identity)
296 ("multipart/alternative" ignore identity)
297 ("multipart/mixed" ignore identity)
298 ("multipart/related" ignore identity)
300 (mm-display-parts (mm-dissect-buffer)))))
302 (defun notmuch-show-save-attachments ()
303 "Save all attachments from the current message."
305 (with-current-notmuch-show-message
306 (let ((mm-handle (mm-dissect-buffer)))
307 (notmuch-save-attachments
308 mm-handle (> (notmuch-count-attachments mm-handle) 1))))
311 (defun notmuch-show-with-message-as-text (fn)
312 "Apply FN to a text representation of the current message.
314 FN is called with one argument, the message properties. It should
315 operation on the contents of the current buffer."
317 ;; Remake the header to ensure that all information is available.
318 (let* ((to (notmuch-show-get-to))
319 (cc (notmuch-show-get-cc))
320 (from (notmuch-show-get-from))
321 (subject (notmuch-show-get-subject))
322 (date (notmuch-show-get-date))
323 (tags (notmuch-show-get-tags))
324 (depth (notmuch-show-get-depth))
327 "Subject: " subject "\n"
329 (if (not (string= cc ""))
330 (concat "Cc: " cc "\n")
336 (mapconcat #'identity tags ", ") "\n")
338 (all (buffer-substring (notmuch-show-message-top)
339 (notmuch-show-message-bottom)))
341 (props (notmuch-show-get-message-properties))
342 (indenting notmuch-show-indent-content))
346 (indent-rigidly (point-min) (point-max) (- (* notmuch-show-indent-messages-width depth))))
347 ;; Remove the original header.
348 (goto-char (point-min))
349 (re-search-forward "^$" (point-max) nil)
350 (delete-region (point-min) (point))
352 (funcall fn props))))
354 (defun notmuch-show-print-message ()
355 "Print the current message."
357 (notmuch-show-with-message-as-text 'notmuch-print-message))
359 (defun notmuch-show-fontify-header ()
361 ((looking-at "[Tt]o:")
363 ((looking-at "[Bb]?[Cc][Cc]:")
365 ((looking-at "[Ss]ubject:")
366 'message-header-subject)
368 'message-header-other))))
370 (overlay-put (make-overlay (point) (re-search-forward ":"))
371 'face 'message-header-name)
372 (overlay-put (make-overlay (point) (re-search-forward ".*$"))
375 (defun notmuch-show-colour-headers ()
376 "Apply some colouring to the current headers."
377 (goto-char (point-min))
378 (while (looking-at "^[A-Za-z][-A-Za-z0-9]*:")
379 (notmuch-show-fontify-header)
382 (defun notmuch-show-spaces-n (n)
383 "Return a string comprised of `n' spaces."
386 (defun notmuch-show-update-tags (tags)
387 "Update the displayed tags of the current message."
389 (goto-char (notmuch-show-message-top))
390 (if (re-search-forward "(\\([^()]*\\))$" (line-end-position) t)
391 (let ((inhibit-read-only t))
392 (replace-match (concat "("
393 (notmuch-tag-format-tags tags (notmuch-show-get-prop :orig-tags))
396 (defun notmuch-clean-address (address)
397 "Try to clean a single email ADDRESS for display. Return a cons
398 cell of (AUTHOR_EMAIL AUTHOR_NAME). Return (ADDRESS nil) if
401 (let (p-name p-address)
402 ;; It would be convenient to use `mail-header-parse-address',
403 ;; but that expects un-decoded mailbox parts, whereas our
404 ;; mailbox parts are already decoded (and hence may contain
405 ;; UTF-8). Given that notmuch should handle most of the awkward
406 ;; cases, some simple string deconstruction should be sufficient
409 ;; "User <user@dom.ain>" style.
410 ((string-match "\\(.*\\) <\\(.*\\)>" address)
411 (setq p-name (match-string 1 address)
412 p-address (match-string 2 address)))
414 ;; "<user@dom.ain>" style.
415 ((string-match "<\\(.*\\)>" address)
416 (setq p-address (match-string 1 address)))
420 (setq p-address address)))
423 ;; Remove elements of the mailbox part that are not relevant for
424 ;; display, even if they are required during transport:
427 (setq p-name (replace-regexp-in-string "\\\\" "" p-name))
429 ;; Outer single and double quotes, which might be nested.
432 do (setq start-of-loop p-name)
434 when (string-match "^\"\\(.*\\)\"$" p-name)
435 do (setq p-name (match-string 1 p-name))
437 when (string-match "^'\\(.*\\)'$" p-name)
438 do (setq p-name (match-string 1 p-name))
440 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)
447 (cons p-address p-name))
448 (error (cons address nil))))
450 (defun notmuch-show-clean-address (address)
451 "Try to clean a single email ADDRESS for display. Return
452 unchanged ADDRESS if parsing fails."
453 (let* ((clean-address (notmuch-clean-address address))
454 (p-address (car clean-address))
455 (p-name (cdr clean-address)))
456 ;; If no name, return just the address.
459 ;; Otherwise format the name and address together.
460 (concat p-name " <" p-address ">"))))
462 (defun notmuch-show-insert-headerline (headers date tags depth)
463 "Insert a notmuch style headerline based on HEADERS for a
464 message at DEPTH in the current thread."
465 (let ((start (point)))
466 (insert (notmuch-show-spaces-n (* notmuch-show-indent-messages-width depth))
468 (notmuch-show-clean-address (plist-get headers :From)))
472 (notmuch-tag-format-tags tags tags)
474 (overlay-put (make-overlay start (point)) 'face 'notmuch-message-summary-face)))
476 (defun notmuch-show-insert-header (header header-value)
477 "Insert a single header."
478 (insert header ": " (notmuch-sanitize header-value) "\n"))
480 (defun notmuch-show-insert-headers (headers)
481 "Insert the headers of the current message."
482 (let ((start (point)))
483 (mapc (lambda (header)
484 (let* ((header-symbol (intern (concat ":" header)))
485 (header-value (plist-get headers header-symbol)))
486 (if (and header-value
487 (not (string-equal "" header-value)))
488 (notmuch-show-insert-header header header-value))))
489 notmuch-message-headers)
492 (narrow-to-region start (point-max))
493 (run-hooks 'notmuch-show-markup-headers-hook)))))
495 (define-button-type 'notmuch-show-part-button-type
496 'action 'notmuch-show-part-button-default
499 :supertype 'notmuch-button-type)
501 (defun notmuch-show-insert-part-header (nth content-type declared-type &optional name comment)
503 (base-label (concat (when name (concat name ": "))
505 (unless (string-equal declared-type content-type)
506 (concat " (as " content-type ")"))
511 (concat "[ " base-label " ]")
512 :base-label base-label
513 :type 'notmuch-show-part-button-type
514 :notmuch-part-hidden nil))
519 (defun notmuch-show-toggle-part-invisibility (&optional button)
521 (let ((button (or button (button-at (point)))))
523 (let ((overlay (button-get button 'overlay))
524 (lazy-part (button-get button :notmuch-lazy-part)))
525 ;; We have a part to toggle if there is an overlay or if there is a lazy part.
526 ;; If neither is present we cannot toggle the part so we just return nil.
527 (when (or overlay lazy-part)
528 (let* ((show (button-get button :notmuch-part-hidden))
529 (new-start (button-start button))
530 (button-label (button-get button :base-label))
532 (properties (text-properties-at (button-start button)))
533 (inhibit-read-only t))
534 ;; Toggle the button itself.
535 (button-put button :notmuch-part-hidden (not show))
536 (goto-char new-start)
537 (insert "[ " button-label (if show " ]" " (hidden) ]"))
538 (set-text-properties new-start (point) properties)
539 (let ((old-end (button-end button)))
540 (move-overlay button new-start (point))
541 (delete-region (point) old-end))
542 (goto-char (min old-point (1- (button-end button))))
543 ;; Return nil if there is a lazy-part, it is empty, and we are
544 ;; trying to show it. In all other cases return t.
547 (button-put button :notmuch-lazy-part nil)
548 (notmuch-show-lazy-part lazy-part button))
549 ;; else there must be an overlay.
550 (overlay-put overlay 'invisible (not show))
553 ;; Part content ID handling
555 (defvar notmuch-show--cids nil
556 "Alist from raw content ID to (MSG PART).")
557 (make-variable-buffer-local 'notmuch-show--cids)
559 (defun notmuch-show--register-cids (msg part)
560 "Register content-IDs in PART and all of PART's sub-parts."
561 (let ((content-id (plist-get part :content-id)))
563 ;; Note that content-IDs are globally unique, except when they
564 ;; aren't: RFC 2046 section 5.1.4 permits children of a
565 ;; multipart/alternative to have the same content-ID, in which
566 ;; case the MUA is supposed to pick the best one it can render.
567 ;; We simply add the content-ID to the beginning of our alist;
568 ;; so if this happens, we'll take the last (and "best")
569 ;; alternative (even if we can't render it).
570 (push (list content-id msg part) notmuch-show--cids)))
571 ;; Recurse on sub-parts
572 (let ((ctype (notmuch-split-content-type
573 (downcase (plist-get part :content-type)))))
574 (cond ((equal (first ctype) "multipart")
575 (mapc (apply-partially #'notmuch-show--register-cids msg)
576 (plist-get part :content)))
577 ((equal ctype '("message" "rfc822"))
578 (notmuch-show--register-cids
580 (first (plist-get (first (plist-get part :content)) :body)))))))
582 (defun notmuch-show--get-cid-content (cid)
583 "Return a list (CID-content content-type) or nil.
585 This will only find parts from messages that have been inserted
586 into the current buffer. CID must be a raw content ID, without
587 enclosing angle brackets, a cid: prefix, or URL encoding. This
588 will return nil if the CID is unknown or cannot be retrieved."
589 (let ((descriptor (cdr (assoc cid notmuch-show--cids))))
591 (let* ((msg (first descriptor))
592 (part (second descriptor))
593 ;; Request caching for this content, as some messages
594 ;; reference the same cid: part many times (hundreds!).
595 (content (notmuch-get-bodypart-binary
596 msg part notmuch-show-process-crypto 'cache))
597 (content-type (plist-get part :content-type)))
598 (list content content-type)))))
600 (defun notmuch-show-setup-w3m ()
601 "Instruct w3m how to retrieve content from a \"related\" part of a message."
603 (if (boundp 'w3m-cid-retrieve-function-alist)
604 (unless (assq 'notmuch-show-mode w3m-cid-retrieve-function-alist)
605 (push (cons 'notmuch-show-mode #'notmuch-show--cid-w3m-retrieve)
606 w3m-cid-retrieve-function-alist)))
607 (setq mm-inline-text-html-with-images t))
609 (defvar w3m-current-buffer) ;; From `w3m.el'.
610 (defun notmuch-show--cid-w3m-retrieve (url &rest args)
611 ;; url includes the cid: prefix and is URL encoded (see RFC 2392).
612 (let* ((cid (url-unhex-string (substring url 4)))
614 (with-current-buffer w3m-current-buffer
615 (notmuch-show--get-cid-content cid))))
616 (when content-and-type
617 (insert (first content-and-type))
618 (second content-and-type))))
620 ;; MIME part renderers
622 (defun notmuch-show-multipart/*-to-list (part)
623 (mapcar (lambda (inner-part) (plist-get inner-part :content-type))
624 (plist-get part :content)))
626 (defun notmuch-show-insert-part-multipart/alternative (msg part content-type nth depth button)
627 (let ((chosen-type (car (notmuch-multipart/alternative-choose msg (notmuch-show-multipart/*-to-list part))))
628 (inner-parts (plist-get part :content))
630 ;; This inserts all parts of the chosen type rather than just one,
631 ;; but it's not clear that this is the wrong thing to do - which
632 ;; should be chosen if there are more than one that match?
633 (mapc (lambda (inner-part)
634 (let* ((inner-type (plist-get inner-part :content-type))
635 (hide (not (or notmuch-show-all-multipart/alternative-parts
636 (string= chosen-type inner-type)))))
637 (notmuch-show-insert-bodypart msg inner-part depth hide)))
640 (when notmuch-show-indent-multipart
641 (indent-rigidly start (point) 1)))
644 (defun notmuch-show-insert-part-multipart/related (msg part content-type nth depth button)
645 (let ((inner-parts (plist-get part :content))
648 ;; Render the primary part. FIXME: Support RFC 2387 Start header.
649 (notmuch-show-insert-bodypart msg (car inner-parts) depth)
650 ;; Add hidden buttons for the rest
651 (mapc (lambda (inner-part)
652 (notmuch-show-insert-bodypart msg inner-part depth t))
655 (when notmuch-show-indent-multipart
656 (indent-rigidly start (point) 1)))
659 (defun notmuch-show-insert-part-multipart/signed (msg part content-type nth depth button)
661 (button-put button 'face 'notmuch-crypto-part-header))
663 ;; Insert a button detailing the signature status.
664 (notmuch-crypto-insert-sigstatus-button (car (plist-get part :sigstatus))
665 (notmuch-show-get-header :From msg))
667 (let ((inner-parts (plist-get part :content))
669 ;; Show all of the parts.
670 (mapc (lambda (inner-part)
671 (notmuch-show-insert-bodypart msg inner-part depth))
674 (when notmuch-show-indent-multipart
675 (indent-rigidly start (point) 1)))
678 (defun notmuch-show-insert-part-multipart/encrypted (msg part content-type nth depth button)
680 (button-put button 'face 'notmuch-crypto-part-header))
682 ;; Insert a button detailing the encryption status.
683 (notmuch-crypto-insert-encstatus-button (car (plist-get part :encstatus)))
685 ;; Insert a button detailing the signature status.
686 (notmuch-crypto-insert-sigstatus-button (car (plist-get part :sigstatus))
687 (notmuch-show-get-header :From msg))
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))
696 (when notmuch-show-indent-multipart
697 (indent-rigidly start (point) 1)))
700 (defun notmuch-show-insert-part-application/pgp-encrypted (msg part content-type nth depth button)
703 (defun notmuch-show-insert-part-multipart/* (msg part content-type nth depth button)
704 (let ((inner-parts (plist-get part :content))
706 ;; Show all of the parts.
707 (mapc (lambda (inner-part)
708 (notmuch-show-insert-bodypart msg inner-part depth))
711 (when notmuch-show-indent-multipart
712 (indent-rigidly start (point) 1)))
715 (defun notmuch-show-insert-part-message/rfc822 (msg part content-type nth depth button)
716 (let* ((message (car (plist-get part :content)))
717 (body (car (plist-get message :body)))
720 ;; Override `notmuch-message-headers' to force `From' to be
722 (let ((notmuch-message-headers '("From" "Subject" "To" "Cc" "Date")))
723 (notmuch-show-insert-headers (plist-get message :headers)))
725 ;; Blank line after headers to be compatible with the normal
730 (notmuch-show-insert-bodypart msg body depth)
732 (when notmuch-show-indent-multipart
733 (indent-rigidly start (point) 1)))
736 (defun notmuch-show-insert-part-text/plain (msg part content-type nth depth button)
737 ;; For backward compatibility we want to apply the text/plain hook
738 ;; to the whole of the part including the part button if there is
740 (let ((start (if button
741 (button-start button)
743 (insert (notmuch-get-bodypart-text msg part notmuch-show-process-crypto))
746 (narrow-to-region start (point-max))
747 (run-hook-with-args 'notmuch-show-insert-text/plain-hook msg depth))))
750 (defun notmuch-show-insert-part-text/calendar (msg part content-type nth depth button)
751 (insert (with-temp-buffer
752 (insert (notmuch-get-bodypart-text msg part notmuch-show-process-crypto))
753 ;; notmuch-get-bodypart-text does no newline conversion.
754 ;; Replace CRLF with LF before icalendar can use it.
755 (goto-char (point-min))
756 (while (re-search-forward "\r\n" nil t)
757 (replace-match "\n" nil nil))
758 (let ((file (make-temp-file "notmuch-ical"))
762 (unless (icalendar-import-buffer file t)
763 (error "Icalendar import error. See *icalendar-errors* for more information"))
764 (set-buffer (get-file-buffer file))
765 (setq result (buffer-substring (point-min) (point-max)))
766 (set-buffer-modified-p nil)
767 (kill-buffer (current-buffer)))
772 ;; For backwards compatibility.
773 (defun notmuch-show-insert-part-text/x-vcalendar (msg part content-type nth depth button)
774 (notmuch-show-insert-part-text/calendar msg part content-type nth depth button))
776 ;; https://bugs.gnu.org/28350
777 (defun notmuch-show--enriched-decode-display-prop (start end &optional param)
780 (defun notmuch-show-insert-part-text/enriched (msg part content-type nth depth button)
781 (advice-add 'enriched-decode-display-prop :override
782 #'notmuch-show--enriched-decode-display-prop)
785 (defun notmuch-show-get-mime-type-of-application/octet-stream (part)
786 ;; If we can deduce a MIME type from the filename of the attachment,
788 (if (plist-get part :filename)
789 (let ((extension (file-name-extension (plist-get part :filename)))
793 (mailcap-parse-mimetypes)
794 (setq mime-type (mailcap-extension-to-mime extension))
796 (not (string-equal mime-type "application/octet-stream")))
801 (defun notmuch-show-insert-part-text/html (msg part content-type nth depth button)
802 (if (eq mm-text-html-renderer 'shr)
803 ;; It's easier to drive shr ourselves than to work around the
804 ;; goofy things `mm-shr' does (like irreversibly taking over
805 ;; content ID handling).
807 ;; FIXME: If we block an image, offer a button to load external
809 (let ((shr-blocked-images notmuch-show-text/html-blocked-images))
810 (notmuch-show--insert-part-text/html-shr msg part))
811 ;; Otherwise, let message-mode do the heavy lifting
813 ;; w3m sets up a keymap which "leaks" outside the invisible region
814 ;; and causes strange effects in notmuch. We set
815 ;; mm-inline-text-html-with-w3m-keymap to nil to tell w3m not to
816 ;; set a keymap (so the normal notmuch-show-mode-map remains).
817 (let ((mm-inline-text-html-with-w3m-keymap nil)
818 ;; FIXME: If we block an image, offer a button to load external
820 (gnus-blocked-images notmuch-show-text/html-blocked-images))
821 (notmuch-show-insert-part-*/* msg part content-type nth depth button))))
823 ;; These functions are used by notmuch-show--insert-part-text/html-shr
824 (declare-function libxml-parse-html-region "xml.c")
825 (declare-function shr-insert-document "shr")
827 (defun notmuch-show--insert-part-text/html-shr (msg part)
828 ;; Make sure shr is loaded before we start let-binding its globals
830 (let ((dom (let ((process-crypto notmuch-show-process-crypto))
832 (insert (notmuch-get-bodypart-text msg part process-crypto))
833 (libxml-parse-html-region (point-min) (point-max)))))
834 (shr-content-function
836 ;; shr strips the "cid:" part of URL, but doesn't
837 ;; URL-decode it (see RFC 2392).
838 (let ((cid (url-unhex-string url)))
839 (first (notmuch-show--get-cid-content cid))))))
840 (shr-insert-document dom)
843 (defun notmuch-show-insert-part-*/* (msg part content-type nth depth button)
844 ;; This handler _must_ succeed - it is the handler of last resort.
845 (notmuch-mm-display-part-inline msg part content-type notmuch-show-process-crypto)
848 ;; Functions for determining how to handle MIME parts.
850 (defun notmuch-show-handlers-for (content-type)
851 "Return a list of content handlers for a part of type CONTENT-TYPE."
856 ;; Reverse order of prefrence.
857 (list (intern (concat "notmuch-show-insert-part-*/*"))
859 "notmuch-show-insert-part-"
860 (car (notmuch-split-content-type content-type))
862 (intern (concat "notmuch-show-insert-part-" content-type))))
867 (defun notmuch-show-insert-bodypart-internal (msg part content-type nth depth button)
868 ;; Run the handlers until one of them succeeds.
869 (loop for handler in (notmuch-show-handlers-for content-type)
870 until (condition-case err
871 (funcall handler msg part content-type nth depth button)
872 ;; Specifying `debug' here lets the debugger run if
873 ;; `debug-on-error' is non-nil.
875 (insert "!!! Bodypart handler `" (prin1-to-string handler) "' threw an error:\n"
876 "!!! " (error-message-string err) "\n")
879 (defun notmuch-show-create-part-overlays (button beg end)
880 "Add an overlay to the part between BEG and END"
882 ;; If there is no button (i.e., the part is text/plain and the first
883 ;; part) or if the part has no content then we don't make the part
885 (when (and button (/= beg end))
886 (button-put button 'overlay (make-overlay beg end))
887 ;; Return true if we created an overlay.
890 (defun notmuch-show-record-part-information (part beg end)
891 "Store PART as a text property from BEG to END"
893 ;; Record part information. Since we already inserted subparts,
894 ;; don't override existing :notmuch-part properties.
895 (notmuch-map-text-property beg end :notmuch-part
896 (lambda (v) (or v part)))
897 ;; Make :notmuch-part front sticky and rear non-sticky so it stays
898 ;; applied to the beginning of each line when we indent the
899 ;; message. Since we're operating on arbitrary renderer output,
900 ;; watch out for sticky specs of t, which means all properties are
901 ;; front-sticky/rear-nonsticky.
902 (notmuch-map-text-property beg end 'front-sticky
903 (lambda (v) (if (listp v)
904 (pushnew :notmuch-part v)
906 (notmuch-map-text-property beg end 'rear-nonsticky
907 (lambda (v) (if (listp v)
908 (pushnew :notmuch-part v)
911 (defun notmuch-show-lazy-part (part-args button)
912 ;; Insert the lazy part after the button for the part. We would just
913 ;; move to the start of the new line following the button and insert
914 ;; the part but that point might have text properties (eg colours
915 ;; from a message header etc) so instead we start from the last
916 ;; character of the button by adding a newline and finish by
917 ;; removing the extra newline from the end of the part.
919 (goto-char (button-end button))
921 (let* ((inhibit-read-only t)
922 ;; We need to use markers for the start and end of the part
923 ;; because the part insertion functions do not guarantee
924 ;; to leave point at the end of the part.
925 (part-beg (copy-marker (point) nil))
926 (part-end (copy-marker (point) t))
927 ;; We have to save the depth as we can't find the depth
929 (depth (notmuch-show-get-depth)))
931 (narrow-to-region part-beg part-end)
932 (delete-region part-beg part-end)
933 (apply #'notmuch-show-insert-bodypart-internal part-args)
934 (indent-rigidly part-beg part-end (* notmuch-show-indent-messages-width depth)))
937 (notmuch-show-record-part-information (second part-args)
938 (button-start button)
940 ;; Create the overlay. If the lazy-part turned out to be empty/not
941 ;; showable this returns nil.
942 (notmuch-show-create-part-overlays button part-beg part-end))))
944 (defun notmuch-show-mime-type (part)
945 "Return the correct mime-type to use for PART."
946 (let ((content-type (downcase (plist-get part :content-type))))
947 (or (and (string= content-type "application/octet-stream")
948 (notmuch-show-get-mime-type-of-application/octet-stream part))
949 (and (string= content-type "inline patch")
953 ;; The following variable can be overridden by let bindings.
954 (defvar notmuch-show-insert-header-p-function 'notmuch-show-insert-header-p
955 "Specify which function decides which part headers get inserted.
957 The function should take two parameters, PART and HIDE, and
958 should return non-NIL if a header button should be inserted for
961 (defun notmuch-show-insert-header-p (part hide)
962 ;; Show all part buttons except for the first part if it is text/plain.
963 (let ((mime-type (notmuch-show-mime-type part)))
964 (not (and (string= mime-type "text/plain")
965 (<= (plist-get part :id) 1)))))
967 (defun notmuch-show-reply-insert-header-p-never (part hide)
970 (defun notmuch-show-reply-insert-header-p-trimmed (part hide)
971 (let ((mime-type (notmuch-show-mime-type part)))
972 (and (not (notmuch-match-content-type mime-type "multipart/*"))
975 (defun notmuch-show-reply-insert-header-p-minimal (part hide)
976 (let ((mime-type (notmuch-show-mime-type part)))
977 (and (notmuch-match-content-type mime-type "text/*")
980 (defun notmuch-show-insert-bodypart (msg part depth &optional hide)
981 "Insert the body part PART at depth DEPTH in the current thread.
983 HIDE determines whether to show or hide the part and the button
984 as follows: If HIDE is nil, show the part and the button. If HIDE
985 is t, hide the part initially and show the button."
987 (let* ((content-type (downcase (plist-get part :content-type)))
988 (mime-type (notmuch-show-mime-type part))
989 (nth (plist-get part :id))
990 (long (and (notmuch-match-content-type mime-type "text/*")
991 (> notmuch-show-max-text-part-size 0)
992 (> (length (plist-get part :content)) notmuch-show-max-text-part-size)))
994 ;; This default header-p function omits the part button for
995 ;; the first (or only) part if this is text/plain.
996 (button (when (funcall notmuch-show-insert-header-p-function part hide)
997 (notmuch-show-insert-part-header nth mime-type content-type (plist-get part :filename))))
998 ;; Hide the part initially if HIDE is t, or if it is too long
999 ;; and we have a button to allow toggling.
1000 (show-part (not (or (equal hide t)
1001 (and long button))))
1002 (content-beg (point)))
1004 ;; Store the computed mime-type for later use (e.g. by attachment handlers).
1005 (plist-put part :computed-type mime-type)
1008 (notmuch-show-insert-bodypart-internal msg part mime-type nth depth button)
1010 (button-put button :notmuch-lazy-part
1011 (list msg part mime-type nth depth button))))
1013 ;; Some of the body part handlers leave point somewhere up in the
1014 ;; part, so we make sure that we're down at the end.
1015 (goto-char (point-max))
1016 ;; Ensure that the part ends with a carriage return.
1019 ;; We do not create the overlay for hidden (lazy) parts until
1020 ;; they are inserted.
1022 (notmuch-show-create-part-overlays button content-beg (point))
1024 (notmuch-show-toggle-part-invisibility button)))
1025 (notmuch-show-record-part-information part beg (point))))
1027 (defun notmuch-show-insert-body (msg body depth)
1028 "Insert the body BODY at depth DEPTH in the current thread."
1030 ;; Register all content IDs for this message. According to RFC
1031 ;; 2392, content IDs are *global*, but it's okay if an MUA treats
1032 ;; them as only global within a message.
1033 (notmuch-show--register-cids msg (first body))
1035 (mapc (lambda (part) (notmuch-show-insert-bodypart msg part depth)) body))
1037 (defun notmuch-show-make-symbol (type)
1038 (make-symbol (concat "notmuch-show-" type)))
1040 (defun notmuch-show-strip-re (string)
1041 (replace-regexp-in-string "^\\([Rr]e: *\\)+" "" string))
1043 (defvar notmuch-show-previous-subject "")
1044 (make-variable-buffer-local 'notmuch-show-previous-subject)
1046 (defun notmuch-show-insert-msg (msg depth)
1047 "Insert the message MSG at depth DEPTH in the current thread."
1048 (let* ((headers (plist-get msg :headers))
1049 ;; Indentation causes the buffer offset of the start/end
1050 ;; points to move, so we must use markers.
1051 message-start message-end
1052 content-start content-end
1053 headers-start headers-end
1054 (bare-subject (notmuch-show-strip-re (plist-get headers :Subject))))
1056 (setq message-start (point-marker))
1058 (notmuch-show-insert-headerline headers
1059 (or (if notmuch-show-relative-dates
1060 (plist-get msg :date_relative)
1062 (plist-get headers :Date))
1063 (plist-get msg :tags) depth)
1065 (setq content-start (point-marker))
1067 ;; Set `headers-start' to point after the 'Subject:' header to be
1068 ;; compatible with the existing implementation. This just sets it
1069 ;; to after the first header.
1070 (notmuch-show-insert-headers headers)
1072 (goto-char content-start)
1073 ;; If the subject of this message is the same as that of the
1074 ;; previous message, don't display it when this message is
1076 (when (not (string= notmuch-show-previous-subject
1079 (setq headers-start (point-marker)))
1080 (setq headers-end (point-marker))
1082 (setq notmuch-show-previous-subject bare-subject)
1084 ;; A blank line between the headers and the body.
1086 (notmuch-show-insert-body msg (plist-get msg :body)
1087 (if notmuch-show-indent-content depth 0))
1088 ;; Ensure that the body ends with a newline.
1091 (setq content-end (point-marker))
1093 ;; Indent according to the depth in the thread.
1094 (if notmuch-show-indent-content
1095 (indent-rigidly content-start content-end (* notmuch-show-indent-messages-width depth)))
1097 (setq message-end (point-max-marker))
1099 ;; Save the extents of this message over the whole text of the
1101 (put-text-property message-start message-end :notmuch-message-extent (cons message-start message-end))
1103 ;; Create overlays used to control visibility
1104 (plist-put msg :headers-overlay (make-overlay headers-start headers-end))
1105 (plist-put msg :message-overlay (make-overlay headers-start content-end))
1107 (plist-put msg :depth depth)
1109 ;; Save the properties for this message. Currently this saves the
1110 ;; entire message (augmented it with other stuff), which seems
1111 ;; like overkill. We might save a reduced subset (for example, not
1113 (notmuch-show-set-message-properties msg)
1115 ;; Set header visibility.
1116 (notmuch-show-headers-visible msg notmuch-message-headers-visible)
1118 ;; Message visibility depends on whether it matched the search
1120 (notmuch-show-message-visible msg (and (plist-get msg :match)
1121 (not (plist-get msg :excluded))))))
1123 (defun notmuch-show-toggle-process-crypto ()
1124 "Toggle the processing of cryptographic MIME parts."
1126 (setq notmuch-show-process-crypto (not notmuch-show-process-crypto))
1127 (message (if notmuch-show-process-crypto
1128 "Processing cryptographic MIME parts."
1129 "Not processing cryptographic MIME parts."))
1130 (notmuch-show-refresh-view))
1132 (defun notmuch-show-toggle-elide-non-matching ()
1133 "Toggle the display of non-matching messages."
1135 (setq notmuch-show-elide-non-matching-messages (not notmuch-show-elide-non-matching-messages))
1136 (message (if notmuch-show-elide-non-matching-messages
1137 "Showing matching messages only."
1138 "Showing all messages."))
1139 (notmuch-show-refresh-view))
1141 (defun notmuch-show-toggle-thread-indentation ()
1142 "Toggle the indentation of threads."
1144 (setq notmuch-show-indent-content (not notmuch-show-indent-content))
1145 (message (if notmuch-show-indent-content
1146 "Content is indented."
1147 "Content is not indented."))
1148 (notmuch-show-refresh-view))
1150 (defun notmuch-show-insert-tree (tree depth)
1151 "Insert the message tree TREE at depth DEPTH in the current thread."
1152 (let ((msg (car tree))
1153 (replies (cadr tree)))
1154 ;; We test whether there is a message or just some replies.
1156 (notmuch-show-insert-msg msg depth))
1157 (notmuch-show-insert-thread replies (1+ depth))))
1159 (defun notmuch-show-insert-thread (thread depth)
1160 "Insert the thread THREAD at depth DEPTH in the current forest."
1161 (mapc (lambda (tree) (notmuch-show-insert-tree tree depth)) thread))
1163 (defun notmuch-show-insert-forest (forest)
1164 "Insert the forest of threads FOREST."
1165 (mapc (lambda (thread) (notmuch-show-insert-thread thread 0)) forest))
1167 (defvar notmuch-id-regexp
1169 ;; Match the id: prefix only if it begins a word (to disallow, for
1170 ;; example, matching cid:).
1172 ;; If the term starts with a ", then parse Xapian's quoted boolean
1173 ;; term syntax, which allows for anything as long as embedded
1174 ;; double quotes escaped by doubling them. We also disallow
1175 ;; newlines (which Xapian allows) to prevent runaway terms.
1176 "\"\\([^\"\n]\\|\"\"\\)*\""
1177 ;; Otherwise, parse Xapian's unquoted syntax, which goes up to the
1178 ;; next space or ). We disallow [.,;] as the last character
1179 ;; because these are probably part of the surrounding text, and not
1180 ;; part of the id. This doesn't match single character ids; meh.
1181 "\\|[^\"[:space:])][^[:space:])]*[^])[:space:].,:;?!]"
1183 "The regexp used to match id: links in messages.")
1185 (defvar notmuch-mid-regexp
1186 ;; goto-address-url-regexp matched cid: links, which have the same
1187 ;; grammar as the message ID part of a mid: link. Construct the
1188 ;; regexp using the same technique as goto-address-url-regexp.
1189 (concat "\\<mid:\\(" thing-at-point-url-path-regexp "\\)")
1190 "The regexp used to match mid: links in messages.
1194 (defun notmuch-show-buttonise-links (start end)
1195 "Buttonise URLs and mail addresses between START and END.
1197 This also turns id:\"<message id>\"-parts and mid: links into
1198 buttons for a corresponding notmuch search."
1199 (goto-address-fontify-region start end)
1202 (beg-line (progn (goto-char start) (line-beginning-position)))
1203 (end-line (progn (goto-char end) (line-end-position))))
1204 (goto-char beg-line)
1205 (while (re-search-forward notmuch-id-regexp end-line t)
1206 (push (list (match-beginning 0) (match-end 0)
1207 (match-string-no-properties 0)) links))
1208 (goto-char beg-line)
1209 (while (re-search-forward notmuch-mid-regexp end-line t)
1210 (let* ((mid-cid (match-string-no-properties 1))
1211 (mid (save-match-data
1212 (string-match "^[^/]*" mid-cid)
1213 (url-unhex-string (match-string 0 mid-cid)))))
1214 (push (list (match-beginning 0) (match-end 0)
1215 (notmuch-id-to-query mid)) links)))
1216 (dolist (link links)
1217 ;; Remove the overlay created by goto-address-mode
1218 (remove-overlays (first link) (second link) 'goto-address t)
1219 (make-text-button (first link) (second link)
1220 :type 'notmuch-button-type
1221 'action `(lambda (arg)
1222 (notmuch-show ,(third link) current-prefix-arg))
1224 'help-echo "Mouse-1, RET: search for this message"
1225 'face goto-address-mail-face)))))
1228 (defun notmuch-show (thread-id &optional elide-toggle parent-buffer query-context buffer-name)
1229 "Run \"notmuch show\" with the given thread ID and display results.
1231 ELIDE-TOGGLE, if non-nil, inverts the default elide behavior.
1233 The optional PARENT-BUFFER is the notmuch-search buffer from
1234 which this notmuch-show command was executed, (so that the
1235 next thread from that buffer can be show when done with this
1238 The optional QUERY-CONTEXT is a notmuch search term. Only
1239 messages from the thread matching this search term are shown if
1242 The optional BUFFER-NAME provides the name of the buffer in
1243 which the message thread is shown. If it is nil (which occurs
1244 when the command is called interactively) the argument to the
1247 Returns the buffer containing the messages, or NIL if no messages
1249 (interactive "sNotmuch show: \nP")
1250 (let ((buffer-name (generate-new-buffer-name
1252 (concat "*notmuch-" thread-id "*"))))
1253 ;; We override mm-inline-override-types to stop application/*
1254 ;; parts from being displayed unless the user has customized
1256 (mm-inline-override-types
1257 (if (equal mm-inline-override-types
1258 (eval (car (get 'mm-inline-override-types 'standard-value))))
1259 (cons "application/*" mm-inline-override-types)
1260 mm-inline-override-types)))
1261 (switch-to-buffer (get-buffer-create buffer-name))
1262 ;; No need to track undo information for this buffer.
1263 (setq buffer-undo-list t)
1267 ;; Set various buffer local variables to their appropriate initial
1268 ;; state. Do this after enabling `notmuch-show-mode' so that they
1269 ;; aren't wiped out.
1270 (setq notmuch-show-thread-id thread-id
1271 notmuch-show-parent-buffer parent-buffer
1272 notmuch-show-query-context (if (or (string= query-context "")
1273 (string= query-context "*"))
1276 notmuch-show-process-crypto notmuch-crypto-process-mime
1277 ;; If `elide-toggle', invert the default value.
1278 notmuch-show-elide-non-matching-messages
1280 (not notmuch-show-only-matching-messages)
1281 notmuch-show-only-matching-messages))
1283 (add-hook 'post-command-hook #'notmuch-show-command-hook nil t)
1284 (jit-lock-register #'notmuch-show-buttonise-links)
1286 (notmuch-tag-clear-cache)
1288 (let ((inhibit-read-only t))
1289 (if (notmuch-show--build-buffer)
1290 ;; Messages were inserted into the buffer.
1293 ;; No messages were inserted - presumably none matched the
1295 (kill-buffer (current-buffer))
1297 (message "No messages matched the query!")
1300 (defun notmuch-show--build-queries (thread context)
1301 "Return a list of queries to try for this search.
1303 THREAD and CONTEXT are both strings, though CONTEXT may be nil.
1304 When CONTEXT is not nil, the first query is the conjunction of it
1305 and THREAD. The next query is THREAD alone, and serves as a
1306 fallback if the prior matches no messages."
1308 (push (list thread) queries)
1309 (if context (push (list thread "and (" context ")") queries))
1312 (defun notmuch-show--build-buffer (&optional state)
1313 "Display messages matching the current buffer context.
1315 Apply the previously saved STATE if supplied, otherwise show the
1316 first relevant message.
1318 If no messages match the query return NIL."
1319 (let* ((cli-args (cons "--exclude=false"
1320 (when notmuch-show-elide-non-matching-messages
1321 (list "--entire-thread=false"))))
1322 (queries (notmuch-show--build-queries
1323 notmuch-show-thread-id notmuch-show-query-context))
1325 ;; Must be reset every time we are going to start inserting
1326 ;; messages into the buffer.
1327 (notmuch-show-previous-subject ""))
1328 ;; Use results from the first query that returns some.
1329 (while (and (not forest) queries)
1330 (setq forest (notmuch-query-get-threads
1331 (append cli-args (list "'") (car queries) (list "'"))))
1332 (setq queries (cdr queries)))
1334 (notmuch-show-insert-forest forest)
1336 ;; Store the original tags for each message so that we can
1339 (lambda () (notmuch-show-set-prop :orig-tags (notmuch-show-get-tags))))
1341 ;; Set the header line to the subject of the first message.
1342 (setq header-line-format
1343 (replace-regexp-in-string "%" "%%"
1345 (notmuch-show-strip-re
1346 (notmuch-show-get-subject)))))
1348 (run-hooks 'notmuch-show-hook)
1351 (notmuch-show-apply-state state)
1352 ;; With no state to apply, just go to the first message.
1353 (notmuch-show-goto-first-wanted-message)))
1355 ;; Report back to the caller whether any messages matched.
1358 (defun notmuch-show-capture-state ()
1359 "Capture the state of the current buffer.
1362 - the list of open messages,
1363 - the combination of current message id with/for each visible window."
1364 (let* ((win-list (get-buffer-window-list (current-buffer) nil t))
1365 (win-id-combo (mapcar (lambda (win)
1366 (with-selected-window win
1367 (list win (notmuch-show-get-message-id))))
1369 (list win-id-combo (notmuch-show-get-message-ids-for-open-messages))))
1371 (defun notmuch-show-get-query ()
1372 "Return the current query in this show buffer"
1373 (if notmuch-show-query-context
1374 (concat notmuch-show-thread-id
1376 notmuch-show-query-context
1378 notmuch-show-thread-id))
1380 (defun notmuch-show-goto-message (msg-id)
1381 "Go to message with msg-id."
1382 (goto-char (point-min))
1383 (unless (loop if (string= msg-id (notmuch-show-get-message-id))
1385 until (not (notmuch-show-goto-message-next)))
1386 (goto-char (point-min))
1387 (message "Message-id not found."))
1388 (notmuch-show-message-adjust))
1390 (defun notmuch-show-apply-state (state)
1391 "Apply STATE to the current buffer.
1394 - opening the messages previously opened,
1395 - closing all other messages,
1396 - moving to the correct current message in every displayed window."
1397 (let ((win-msg-alist (car state))
1398 (open (cadr state)))
1400 ;; Open those that were open.
1401 (goto-char (point-min))
1402 (loop do (notmuch-show-message-visible (notmuch-show-get-message-properties)
1403 (member (notmuch-show-get-message-id) open))
1404 until (not (notmuch-show-goto-message-next)))
1406 (dolist (win-msg-pair win-msg-alist)
1407 (with-selected-window (car win-msg-pair)
1408 ;; Go to the previously open message in this window
1409 (notmuch-show-goto-message (cadr win-msg-pair))))))
1411 (defun notmuch-show-refresh-view (&optional reset-state)
1412 "Refresh the current view.
1414 Refreshes the current view, observing changes in display
1415 preferences. If invoked with a prefix argument (or RESET-STATE is
1416 non-nil) then the state of the buffer (open/closed messages) is
1417 reset based on the original query."
1419 (let ((inhibit-read-only t)
1420 (state (unless reset-state
1421 (notmuch-show-capture-state))))
1422 ;; `erase-buffer' does not seem to remove overlays, which can lead
1423 ;; to weird effects such as remaining images, so remove them
1428 (unless (notmuch-show--build-buffer state)
1429 ;; No messages were inserted.
1430 (kill-buffer (current-buffer))
1432 (message "Refreshing the buffer resulted in no messages!"))))
1434 (defvar notmuch-show-stash-map
1435 (let ((map (make-sparse-keymap)))
1436 (define-key map "c" 'notmuch-show-stash-cc)
1437 (define-key map "d" 'notmuch-show-stash-date)
1438 (define-key map "F" 'notmuch-show-stash-filename)
1439 (define-key map "f" 'notmuch-show-stash-from)
1440 (define-key map "i" 'notmuch-show-stash-message-id)
1441 (define-key map "I" 'notmuch-show-stash-message-id-stripped)
1442 (define-key map "s" 'notmuch-show-stash-subject)
1443 (define-key map "T" 'notmuch-show-stash-tags)
1444 (define-key map "t" 'notmuch-show-stash-to)
1445 (define-key map "l" 'notmuch-show-stash-mlarchive-link)
1446 (define-key map "L" 'notmuch-show-stash-mlarchive-link-and-go)
1447 (define-key map "G" 'notmuch-show-stash-git-send-email)
1448 (define-key map "?" 'notmuch-subkeymap-help)
1450 "Submap for stash commands")
1451 (fset 'notmuch-show-stash-map notmuch-show-stash-map)
1453 (defvar notmuch-show-part-map
1454 (let ((map (make-sparse-keymap)))
1455 (define-key map "s" 'notmuch-show-save-part)
1456 (define-key map "v" 'notmuch-show-view-part)
1457 (define-key map "o" 'notmuch-show-interactively-view-part)
1458 (define-key map "|" 'notmuch-show-pipe-part)
1459 (define-key map "m" 'notmuch-show-choose-mime-of-part)
1460 (define-key map "?" 'notmuch-subkeymap-help)
1462 "Submap for part commands")
1463 (fset 'notmuch-show-part-map notmuch-show-part-map)
1465 (defvar notmuch-show-mode-map
1466 (let ((map (make-sparse-keymap)))
1467 (set-keymap-parent map notmuch-common-keymap)
1468 (define-key map "Z" 'notmuch-tree-from-show-current-query)
1469 (define-key map (kbd "<C-tab>") 'widget-backward)
1470 (define-key map (kbd "M-TAB") 'notmuch-show-previous-button)
1471 (define-key map (kbd "<backtab>") 'notmuch-show-previous-button)
1472 (define-key map (kbd "TAB") 'notmuch-show-next-button)
1473 (define-key map "f" 'notmuch-show-forward-message)
1474 (define-key map "F" 'notmuch-show-forward-open-messages)
1475 (define-key map "b" 'notmuch-show-resend-message)
1476 (define-key map "l" 'notmuch-show-filter-thread)
1477 (define-key map "r" 'notmuch-show-reply-sender)
1478 (define-key map "R" 'notmuch-show-reply)
1479 (define-key map "|" 'notmuch-show-pipe-message)
1480 (define-key map "w" 'notmuch-show-save-attachments)
1481 (define-key map "V" 'notmuch-show-view-raw-message)
1482 (define-key map "e" 'notmuch-show-resume-message)
1483 (define-key map "c" 'notmuch-show-stash-map)
1484 (define-key map "h" 'notmuch-show-toggle-visibility-headers)
1485 (define-key map "k" 'notmuch-tag-jump)
1486 (define-key map "*" 'notmuch-show-tag-all)
1487 (define-key map "-" 'notmuch-show-remove-tag)
1488 (define-key map "+" 'notmuch-show-add-tag)
1489 (define-key map "X" 'notmuch-show-archive-thread-then-exit)
1490 (define-key map "x" 'notmuch-show-archive-message-then-next-or-exit)
1491 (define-key map "A" 'notmuch-show-archive-thread-then-next)
1492 (define-key map "a" 'notmuch-show-archive-message-then-next-or-next-thread)
1493 (define-key map "N" 'notmuch-show-next-message)
1494 (define-key map "P" 'notmuch-show-previous-message)
1495 (define-key map "n" 'notmuch-show-next-open-message)
1496 (define-key map "p" 'notmuch-show-previous-open-message)
1497 (define-key map (kbd "M-n") 'notmuch-show-next-thread-show)
1498 (define-key map (kbd "M-p") 'notmuch-show-previous-thread-show)
1499 (define-key map (kbd "DEL") 'notmuch-show-rewind)
1500 (define-key map " " 'notmuch-show-advance-and-archive)
1501 (define-key map (kbd "M-RET") 'notmuch-show-open-or-close-all)
1502 (define-key map (kbd "RET") 'notmuch-show-toggle-message)
1503 (define-key map "#" 'notmuch-show-print-message)
1504 (define-key map "!" 'notmuch-show-toggle-elide-non-matching)
1505 (define-key map "$" 'notmuch-show-toggle-process-crypto)
1506 (define-key map "<" 'notmuch-show-toggle-thread-indentation)
1507 (define-key map "t" 'toggle-truncate-lines)
1508 (define-key map "." 'notmuch-show-part-map)
1510 "Keymap for \"notmuch show\" buffers.")
1511 (fset 'notmuch-show-mode-map notmuch-show-mode-map)
1513 (define-derived-mode notmuch-show-mode fundamental-mode "notmuch-show"
1514 "Major mode for viewing a thread with notmuch.
1516 This buffer contains the results of the \"notmuch show\" command
1517 for displaying a single thread of email from your email archives.
1519 By default, various components of email messages, (citations,
1520 signatures, already-read messages), are hidden. You can make
1521 these parts visible by clicking with the mouse button or by
1522 pressing RET after positioning the cursor on a hidden part, (for
1523 which \\[notmuch-show-next-button] and \\[notmuch-show-previous-button] are helpful).
1525 Reading the thread sequentially is well-supported by pressing
1526 \\[notmuch-show-advance-and-archive]. This will scroll the current message (if necessary), advance
1527 to the next message, or advance to the next thread (if already on
1528 the last message of a thread).
1530 Other commands are available to read or manipulate the thread
1531 more selectively, (such as '\\[notmuch-show-next-message]' and '\\[notmuch-show-previous-message]' to advance to messages
1532 without removing any tags, and '\\[notmuch-show-archive-thread]' to archive an entire thread
1533 without scrolling through with \\[notmuch-show-advance-and-archive]).
1535 You can add or remove arbitrary tags from the current message with
1536 '\\[notmuch-show-add-tag]' or '\\[notmuch-show-remove-tag]'.
1538 All currently available key bindings:
1540 \\{notmuch-show-mode-map}"
1541 (setq notmuch-buffer-refresh-function #'notmuch-show-refresh-view)
1542 (setq buffer-read-only t
1544 (setq imenu-prev-index-position-function
1545 #'notmuch-show-imenu-prev-index-position-function)
1546 (setq imenu-extract-index-name-function
1547 #'notmuch-show-imenu-extract-index-name-function))
1549 (defun notmuch-tree-from-show-current-query ()
1550 "Call notmuch tree with the current query"
1552 (notmuch-tree notmuch-show-thread-id
1553 notmuch-show-query-context
1554 (notmuch-show-get-message-id)))
1556 (defun notmuch-show-move-to-message-top ()
1557 (goto-char (notmuch-show-message-top)))
1559 (defun notmuch-show-move-to-message-bottom ()
1560 (goto-char (notmuch-show-message-bottom)))
1562 (defun notmuch-show-message-adjust ()
1565 ;; Movement related functions.
1567 ;; There's some strangeness here where a text property applied to a
1568 ;; region a->b is not found when point is at b. We walk backwards
1569 ;; until finding the property.
1570 (defun notmuch-show-message-extent ()
1573 (while (not (setq r (get-text-property (point) :notmuch-message-extent)))
1577 (defun notmuch-show-message-top ()
1578 (car (notmuch-show-message-extent)))
1580 (defun notmuch-show-message-bottom ()
1581 (cdr (notmuch-show-message-extent)))
1583 (defun notmuch-show-goto-message-next ()
1584 (let ((start (point)))
1585 (notmuch-show-move-to-message-bottom)
1591 (defun notmuch-show-goto-message-previous ()
1592 (notmuch-show-move-to-message-top)
1596 (notmuch-show-move-to-message-top)
1599 (defun notmuch-show-mapc (function)
1600 "Iterate through all messages in the current thread with
1601 `notmuch-show-goto-message-next' and call FUNCTION for side
1604 (goto-char (point-min))
1605 (loop do (funcall function)
1606 while (notmuch-show-goto-message-next))))
1608 ;; Functions relating to the visibility of messages and their
1611 (defun notmuch-show-message-visible (props visible-p)
1612 (overlay-put (plist-get props :message-overlay) 'invisible (not visible-p))
1613 (notmuch-show-set-prop :message-visible visible-p props))
1615 (defun notmuch-show-headers-visible (props visible-p)
1616 (overlay-put (plist-get props :headers-overlay) 'invisible (not visible-p))
1617 (notmuch-show-set-prop :headers-visible visible-p props))
1619 ;; Functions for setting and getting attributes of the current
1622 (defun notmuch-show-set-message-properties (props)
1624 (notmuch-show-move-to-message-top)
1625 (put-text-property (point) (+ (point) 1) :notmuch-message-properties props)))
1627 (defun notmuch-show-get-message-properties ()
1628 "Return the properties of the current message as a plist.
1630 Some useful entries are:
1631 :headers - Property list containing the headers :Date, :Subject, :From, etc.
1632 :body - Body of the message
1633 :tags - Tags for this message"
1635 (notmuch-show-move-to-message-top)
1636 (get-text-property (point) :notmuch-message-properties)))
1638 (defun notmuch-show-get-part-properties ()
1639 "Return the properties of the innermost part containing point.
1641 This is the part property list retrieved from the CLI. Signals
1642 an error if there is no part containing point."
1643 (or (get-text-property (point) :notmuch-part)
1644 (error "No message part here")))
1646 (defun notmuch-show-set-prop (prop val &optional props)
1647 (let ((inhibit-read-only t)
1649 (notmuch-show-get-message-properties))))
1650 (plist-put props prop val)
1651 (notmuch-show-set-message-properties props)))
1653 (defun notmuch-show-get-prop (prop &optional props)
1654 "Get property PROP from current message in show or tree mode.
1656 It gets property PROP from PROPS or, if PROPS is nil, the current
1657 message in either tree or show. This means that several utility
1658 functions in notmuch-show can be used directly by notmuch-tree as
1659 they just need the correct message properties."
1660 (let ((props (or props
1661 (cond ((eq major-mode 'notmuch-show-mode)
1662 (notmuch-show-get-message-properties))
1663 ((eq major-mode 'notmuch-tree-mode)
1664 (notmuch-tree-get-message-properties))
1666 (plist-get props prop)))
1668 (defun notmuch-show-get-message-id (&optional bare)
1669 "Return an id: query for the Message-Id of the current message.
1671 If optional argument BARE is non-nil, return
1672 the Message-Id without id: prefix and escaping."
1674 (notmuch-show-get-prop :id)
1675 (notmuch-id-to-query (notmuch-show-get-prop :id))))
1677 (defun notmuch-show-get-messages-ids ()
1678 "Return all id: queries of messages in the current thread."
1679 (let ((message-ids))
1681 (lambda () (push (notmuch-show-get-message-id) message-ids)))
1684 (defun notmuch-show-get-messages-ids-search ()
1685 "Return a search string for all message ids of messages in the
1687 (mapconcat 'identity (notmuch-show-get-messages-ids) " or "))
1689 ;; dme: Would it make sense to use a macro for many of these?
1691 ;; XXX TODO figure out what to do about multiple filenames
1692 (defun notmuch-show-get-filename ()
1693 "Return the filename of the current message."
1694 (car (notmuch-show-get-prop :filename)))
1696 (defun notmuch-show-get-header (header &optional props)
1697 "Return the named header of the current message, if any."
1698 (plist-get (notmuch-show-get-prop :headers props) header))
1700 (defun notmuch-show-get-cc ()
1701 (notmuch-show-get-header :Cc))
1703 (defun notmuch-show-get-date ()
1704 (notmuch-show-get-header :Date))
1706 (defun notmuch-show-get-timestamp ()
1707 (notmuch-show-get-prop :timestamp))
1709 (defun notmuch-show-get-from ()
1710 (notmuch-show-get-header :From))
1712 (defun notmuch-show-get-subject ()
1713 (notmuch-show-get-header :Subject))
1715 (defun notmuch-show-get-to ()
1716 (notmuch-show-get-header :To))
1718 (defun notmuch-show-get-depth ()
1719 (notmuch-show-get-prop :depth))
1721 (defun notmuch-show-set-tags (tags)
1722 "Set the tags of the current message."
1723 (notmuch-show-set-prop :tags tags)
1724 (notmuch-show-update-tags tags))
1726 (defun notmuch-show-get-tags ()
1727 "Return the tags of the current message."
1728 (notmuch-show-get-prop :tags))
1730 (defun notmuch-show-message-visible-p ()
1731 "Is the current message visible?"
1732 (notmuch-show-get-prop :message-visible))
1734 (defun notmuch-show-headers-visible-p ()
1735 "Are the headers of the current message visible?"
1736 (notmuch-show-get-prop :headers-visible))
1738 (put 'notmuch-show-mark-read 'notmuch-prefix-doc
1739 "Mark the current message as unread.")
1740 (defun notmuch-show-mark-read (&optional unread)
1741 "Mark the current message as read.
1743 Mark the current message as read by applying the tag changes in
1744 `notmuch-show-mark-read-tags' to it (remove the \"unread\" tag by
1745 default). If a prefix argument is given, the message will be
1746 marked as unread, i.e. the tag changes in
1747 `notmuch-show-mark-read-tags' will be reversed."
1749 (when notmuch-show-mark-read-tags
1750 (apply 'notmuch-show-tag-message
1751 (notmuch-tag-change-list notmuch-show-mark-read-tags unread))))
1753 (defun notmuch-show-seen-current-message (start end)
1754 "Mark the current message read if it is open.
1756 We only mark it read once: if it is changed back then that is a
1757 user decision and we should not override it."
1758 (when (and (notmuch-show-message-visible-p)
1759 (not (notmuch-show-get-prop :seen)))
1760 (notmuch-show-mark-read)
1761 (notmuch-show-set-prop :seen t)))
1763 (defvar notmuch-show--seen-has-errored nil)
1764 (make-variable-buffer-local 'notmuch-show--seen-has-errored)
1766 (defun notmuch-show-command-hook ()
1767 (when (eq major-mode 'notmuch-show-mode)
1768 ;; We need to redisplay to get window-start and window-end correct.
1772 (funcall notmuch-show-mark-read-function (window-start) (window-end))
1774 (unless notmuch-show--seen-has-errored
1775 (setq notmuch-show--seen-has-errored 't)
1776 (setq header-line-format
1777 (concat header-line-format
1778 (propertize " [some mark read tag changes may have failed]"
1779 'face font-lock-warning-face)))))))))
1781 (defun notmuch-show-filter-thread (query)
1782 "Filter or LIMIT the current thread based on a new query string.
1784 Reshows the current thread with matches defined by the new query-string."
1785 (interactive (list (notmuch-read-query "Filter thread: ")))
1786 (let ((msg-id (notmuch-show-get-message-id)))
1787 (setq notmuch-show-query-context (if (string= query "") nil query))
1788 (notmuch-show-refresh-view t)
1789 (notmuch-show-goto-message msg-id)))
1791 ;; Functions for getting attributes of several messages in the current
1794 (defun notmuch-show-get-message-ids-for-open-messages ()
1795 "Return a list of all id: queries for open messages in the current thread."
1797 (let (message-ids done)
1798 (goto-char (point-min))
1800 (if (notmuch-show-message-visible-p)
1801 (setq message-ids (append message-ids (list (notmuch-show-get-message-id)))))
1802 (setq done (not (notmuch-show-goto-message-next)))
1807 ;; Commands typically bound to keys.
1809 (defun notmuch-show-advance ()
1810 "Advance through thread.
1812 If the current message in the thread is not yet fully visible,
1813 scroll by a near screenful to read more of the message.
1815 Otherwise, (the end of the current message is already within the
1816 current window), advance to the next open message."
1818 (let* ((end-of-this-message (notmuch-show-message-bottom))
1819 (visible-end-of-this-message (1- end-of-this-message))
1821 (while (invisible-p visible-end-of-this-message)
1822 (setq visible-end-of-this-message
1824 (1- (previous-single-char-property-change
1825 visible-end-of-this-message 'invisible)))))
1827 ;; Ideally we would test `end-of-this-message' against the result
1828 ;; of `window-end', but that doesn't account for the fact that
1829 ;; the end of the message might be hidden.
1830 ((and visible-end-of-this-message
1831 (> visible-end-of-this-message (window-end)))
1832 ;; The bottom of this message is not visible - scroll.
1835 ((not (= end-of-this-message (point-max)))
1836 ;; This is not the last message - move to the next visible one.
1837 (notmuch-show-next-open-message))
1839 ((not (= (point) (point-max)))
1840 ;; This is the last message, but the cursor is not at the end of
1841 ;; the buffer. Move it there.
1842 (goto-char (point-max)))
1845 ;; This is the last message - change the return value
1849 (defun notmuch-show-advance-and-archive ()
1850 "Advance through thread and archive.
1852 This command is intended to be one of the simplest ways to
1853 process a thread of email. It works exactly like
1854 notmuch-show-advance, in that it scrolls through messages in a
1855 show buffer, except that when it gets to the end of the buffer it
1856 archives the entire current thread, (apply changes in
1857 `notmuch-archive-tags'), kills the buffer, and displays the next
1858 thread from the search from which this thread was originally
1861 (if (notmuch-show-advance)
1862 (notmuch-show-archive-thread-then-next)))
1864 (defun notmuch-show-rewind ()
1865 "Backup through the thread (reverse scrolling compared to \\[notmuch-show-advance-and-archive]).
1867 Specifically, if the beginning of the previous email is fewer
1868 than `window-height' lines from the current point, move to it
1869 just like `notmuch-show-previous-message'.
1871 Otherwise, just scroll down a screenful of the current message.
1873 This command does not modify any message tags, (it does not undo
1874 any effects from previous calls to
1875 `notmuch-show-advance-and-archive'."
1877 (let ((start-of-message (notmuch-show-message-top))
1878 (start-of-window (window-start)))
1880 ;; Either this message is properly aligned with the start of the
1881 ;; window or the start of this message is not visible on the
1883 ((or (= start-of-message start-of-window)
1884 (< start-of-message start-of-window))
1886 ;; If a small number of lines from the previous message are
1887 ;; visible, realign so that the top of the current message is at
1888 ;; the top of the screen.
1889 (when (<= (count-screen-lines (window-start) start-of-message)
1890 next-screen-context-lines)
1891 (goto-char (notmuch-show-message-top))
1892 (notmuch-show-message-adjust))
1893 ;; Move to the top left of the window.
1894 (goto-char (window-start)))
1896 ;; Move to the previous message.
1897 (notmuch-show-previous-message)))))
1899 (put 'notmuch-show-reply 'notmuch-prefix-doc "... and prompt for sender")
1900 (defun notmuch-show-reply (&optional prompt-for-sender)
1901 "Reply to the sender and all recipients of the current message."
1903 (notmuch-mua-new-reply (notmuch-show-get-message-id) prompt-for-sender t))
1905 (put 'notmuch-show-reply-sender 'notmuch-prefix-doc "... and prompt for sender")
1906 (defun notmuch-show-reply-sender (&optional prompt-for-sender)
1907 "Reply to the sender of the current message."
1909 (notmuch-mua-new-reply (notmuch-show-get-message-id) prompt-for-sender nil))
1911 (put 'notmuch-show-forward-message 'notmuch-prefix-doc
1912 "... and prompt for sender")
1913 (defun notmuch-show-forward-message (&optional prompt-for-sender)
1914 "Forward the current message."
1916 (notmuch-mua-new-forward-messages (list (notmuch-show-get-message-id))
1919 (put 'notmuch-show-forward-open-messages 'notmuch-prefix-doc
1920 "... and prompt for sender")
1921 (defun notmuch-show-forward-open-messages (&optional prompt-for-sender)
1922 "Forward the currently open messages."
1924 (let ((open-messages (notmuch-show-get-message-ids-for-open-messages)))
1925 (unless open-messages
1926 (error "No open messages to forward."))
1927 (notmuch-mua-new-forward-messages open-messages prompt-for-sender)))
1929 (defun notmuch-show-resend-message (addresses)
1930 "Resend the current message."
1931 (interactive (list (notmuch-address-from-minibuffer "Resend to: ")))
1932 (when (y-or-n-p (concat "Confirm resend to " addresses " "))
1933 (notmuch-show-view-raw-message)
1934 (message-resend addresses)
1935 (notmuch-bury-or-kill-this-buffer)))
1937 (defun notmuch-show-next-message (&optional pop-at-end)
1938 "Show the next message.
1940 If a prefix argument is given and this is the last message in the
1941 thread, navigate to the next thread in the parent search buffer."
1943 (if (notmuch-show-goto-message-next)
1944 (notmuch-show-message-adjust)
1946 (notmuch-show-next-thread)
1947 (goto-char (point-max)))))
1949 (defun notmuch-show-previous-message ()
1950 "Show the previous message or the start of the current message."
1952 (if (= (point) (notmuch-show-message-top))
1953 (notmuch-show-goto-message-previous)
1954 (notmuch-show-move-to-message-top))
1955 (notmuch-show-message-adjust))
1957 (defun notmuch-show-next-open-message (&optional pop-at-end)
1958 "Show the next open message.
1960 If a prefix argument is given and this is the last open message
1961 in the thread, navigate to the next thread in the parent search
1962 buffer. Return t if there was a next open message in the thread
1963 to show, nil otherwise."
1966 (while (and (setq r (notmuch-show-goto-message-next))
1967 (not (notmuch-show-message-visible-p))))
1969 (notmuch-show-message-adjust)
1971 (notmuch-show-next-thread)
1972 (goto-char (point-max))))
1975 (defun notmuch-show-next-matching-message ()
1976 "Show the next matching message."
1979 (while (and (setq r (notmuch-show-goto-message-next))
1980 (not (notmuch-show-get-prop :match))))
1982 (notmuch-show-message-adjust)
1983 (goto-char (point-max)))))
1985 (defun notmuch-show-open-if-matched ()
1986 "Open a message if it is matched (whether or not excluded)."
1987 (let ((props (notmuch-show-get-message-properties)))
1988 (notmuch-show-message-visible props (plist-get props :match))))
1990 (defun notmuch-show-goto-first-wanted-message ()
1991 "Move to the first open message and mark it read"
1992 (goto-char (point-min))
1993 (unless (notmuch-show-message-visible-p)
1994 (notmuch-show-next-open-message))
1996 ;; There are no matched non-excluded messages so open all matched
1997 ;; (necessarily excluded) messages and go to the first.
1998 (notmuch-show-mapc 'notmuch-show-open-if-matched)
1999 (force-window-update)
2000 (goto-char (point-min))
2001 (unless (notmuch-show-message-visible-p)
2002 (notmuch-show-next-open-message))))
2004 (defun notmuch-show-previous-open-message ()
2005 "Show the previous open message."
2007 (while (and (if (= (point) (notmuch-show-message-top))
2008 (notmuch-show-goto-message-previous)
2009 (notmuch-show-move-to-message-top))
2010 (not (notmuch-show-message-visible-p))))
2011 (notmuch-show-message-adjust))
2013 (defun notmuch-show-view-raw-message ()
2014 "View the original source of the current message."
2016 (let* ((id (notmuch-show-get-message-id))
2017 (buf (get-buffer-create (concat "*notmuch-raw-" id "*")))
2018 (inhibit-read-only t))
2019 (switch-to-buffer buf)
2021 (let ((coding-system-for-read 'no-conversion))
2022 (call-process notmuch-command nil t nil "show" "--format=raw" id))
2023 (goto-char (point-min))
2024 (set-buffer-modified-p nil)
2025 (setq buffer-read-only t)
2026 (view-buffer buf 'kill-buffer-if-not-modified)))
2028 (defun notmuch-show-resume-message ()
2029 "Resume EDITING the current draft message."
2031 (notmuch-draft-resume (notmuch-show-get-message-id)))
2033 (put 'notmuch-show-pipe-message 'notmuch-doc
2034 "Pipe the contents of the current message to a command.")
2035 (put 'notmuch-show-pipe-message 'notmuch-prefix-doc
2036 "Pipe the thread as an mbox to a command.")
2037 (defun notmuch-show-pipe-message (entire-thread command)
2038 "Pipe the contents of the current message (or thread) to COMMAND.
2040 COMMAND will be executed with the raw contents of the current
2041 email message as stdin. Anything printed by the command to stdout
2042 or stderr will appear in the *notmuch-pipe* buffer.
2044 If ENTIRE-THREAD is non-nil (or when invoked with a prefix
2045 argument), COMMAND will receive all open messages in the current
2046 thread (formatted as an mbox) rather than only the current
2048 (interactive (let ((query-string (if current-prefix-arg
2049 "Pipe all open messages to command: "
2050 "Pipe message to command: ")))
2051 (list current-prefix-arg (read-string query-string))))
2052 (let (shell-command)
2055 (concat notmuch-command " show --format=mbox --exclude=false "
2056 (shell-quote-argument
2057 (mapconcat 'identity (notmuch-show-get-message-ids-for-open-messages) " OR "))
2060 (concat notmuch-command " show --format=raw "
2061 (shell-quote-argument (notmuch-show-get-message-id)) " | " command)))
2062 (let ((cwd default-directory)
2063 (buf (get-buffer-create (concat "*notmuch-pipe*"))))
2064 (with-current-buffer buf
2065 (setq buffer-read-only nil)
2067 ;; Use the originating buffer's working directory instead of
2068 ;; that of the pipe buffer.
2070 (let ((exit-code (call-process-shell-command shell-command nil buf)))
2071 (goto-char (point-max))
2072 (set-buffer-modified-p nil)
2073 (setq buffer-read-only t)
2074 (unless (zerop exit-code)
2075 (switch-to-buffer-other-window buf)
2076 (message (format "Command '%s' exited abnormally with code %d"
2077 shell-command exit-code))))))))
2079 (defun notmuch-show-tag-message (&rest tag-changes)
2080 "Change tags for the current message.
2082 TAG-CHANGES is a list of tag operations for `notmuch-tag'."
2083 (let* ((current-tags (notmuch-show-get-tags))
2084 (new-tags (notmuch-update-tags current-tags tag-changes)))
2085 (unless (equal current-tags new-tags)
2086 (notmuch-tag (notmuch-show-get-message-id) tag-changes)
2087 (notmuch-show-set-tags new-tags))))
2089 (defun notmuch-show-tag (tag-changes)
2090 "Change tags for the current message.
2092 See `notmuch-tag' for information on the format of TAG-CHANGES."
2093 (interactive (list (notmuch-read-tag-changes (notmuch-show-get-tags)
2095 (notmuch-tag (notmuch-show-get-message-id) tag-changes)
2096 (let* ((current-tags (notmuch-show-get-tags))
2097 (new-tags (notmuch-update-tags current-tags tag-changes)))
2098 (unless (equal current-tags new-tags)
2099 (notmuch-show-set-tags new-tags))))
2101 (defun notmuch-show-tag-all (tag-changes)
2102 "Change tags for all messages in the current show buffer.
2104 See `notmuch-tag' for information on the format of TAG-CHANGES."
2108 (lambda () (setq tags (append (notmuch-show-get-tags) tags))))
2109 (notmuch-read-tag-changes tags "Tag thread"))))
2110 (notmuch-tag (notmuch-show-get-messages-ids-search) tag-changes)
2113 (let* ((current-tags (notmuch-show-get-tags))
2114 (new-tags (notmuch-update-tags current-tags tag-changes)))
2115 (unless (equal current-tags new-tags)
2116 (notmuch-show-set-tags new-tags))))))
2118 (defun notmuch-show-add-tag (tag-changes)
2119 "Change tags for the current message (defaulting to add).
2121 Same as `notmuch-show-tag' but sets initial input to '+'."
2123 (list (notmuch-read-tag-changes (notmuch-show-get-tags) "Tag message" "+")))
2124 (notmuch-show-tag tag-changes))
2126 (defun notmuch-show-remove-tag (tag-changes)
2127 "Change tags for the current message (defaulting to remove).
2129 Same as `notmuch-show-tag' but sets initial input to '-'."
2131 (list (notmuch-read-tag-changes (notmuch-show-get-tags) "Tag message" "-")))
2132 (notmuch-show-tag tag-changes))
2134 (defun notmuch-show-toggle-visibility-headers ()
2135 "Toggle the visibility of the current message headers."
2137 (let ((props (notmuch-show-get-message-properties)))
2138 (notmuch-show-headers-visible
2140 (not (plist-get props :headers-visible))))
2141 (force-window-update))
2143 (defun notmuch-show-toggle-message ()
2144 "Toggle the visibility of the current message."
2146 (let ((props (notmuch-show-get-message-properties)))
2147 (notmuch-show-message-visible
2149 (not (plist-get props :message-visible))))
2150 (force-window-update))
2152 (put 'notmuch-show-open-or-close-all 'notmuch-doc "Show all messages.")
2153 (put 'notmuch-show-open-or-close-all 'notmuch-prefix-doc "Hide all messages.")
2154 (defun notmuch-show-open-or-close-all ()
2155 "Set the visibility all of the messages in the current thread.
2157 By default make all of the messages visible. With a prefix
2158 argument, hide all of the messages."
2161 (goto-char (point-min))
2162 (loop do (notmuch-show-message-visible (notmuch-show-get-message-properties)
2163 (not current-prefix-arg))
2164 until (not (notmuch-show-goto-message-next))))
2165 (force-window-update))
2167 (defun notmuch-show-next-button ()
2168 "Advance point to the next button in the buffer."
2172 (defun notmuch-show-previous-button ()
2173 "Move point back to the previous button in the buffer."
2175 (backward-button 1))
2177 (defun notmuch-show-next-thread (&optional show previous)
2178 "Move to the next item in the search results, if any.
2180 If SHOW is non-nil, open the next item in a show
2181 buffer. Otherwise just highlight the next item in the search
2182 buffer. If PREVIOUS is non-nil, move to the previous item in the
2183 search results instead."
2185 (let ((parent-buffer notmuch-show-parent-buffer))
2186 (notmuch-bury-or-kill-this-buffer)
2187 (when (buffer-live-p parent-buffer)
2188 (switch-to-buffer parent-buffer)
2190 (notmuch-search-previous-thread)
2191 (notmuch-search-next-thread))
2193 (notmuch-search-show-thread)))))
2195 (defun notmuch-show-next-thread-show ()
2196 "Show the next thread in the search results, if any."
2198 (notmuch-show-next-thread t))
2200 (defun notmuch-show-previous-thread-show ()
2201 "Show the previous thread in the search results, if any."
2203 (notmuch-show-next-thread t t))
2205 (put 'notmuch-show-archive-thread 'notmuch-prefix-doc
2206 "Un-archive each message in thread.")
2207 (defun notmuch-show-archive-thread (&optional unarchive)
2208 "Archive each message in thread.
2210 Archive each message currently shown by applying the tag changes
2211 in `notmuch-archive-tags' to each. If a prefix argument is given,
2212 the messages will be \"unarchived\", i.e. the tag changes in
2213 `notmuch-archive-tags' will be reversed.
2215 Note: This command is safe from any race condition of new messages
2216 being delivered to the same thread. It does not archive the
2217 entire thread, but only the messages shown in the current
2220 (when notmuch-archive-tags
2221 (notmuch-show-tag-all
2222 (notmuch-tag-change-list notmuch-archive-tags unarchive))))
2224 (defun notmuch-show-archive-thread-then-next ()
2225 "Archive all messages in the current buffer, then show next thread from search."
2227 (notmuch-show-archive-thread)
2228 (notmuch-show-next-thread t))
2230 (defun notmuch-show-archive-thread-then-exit ()
2231 "Archive all messages in the current buffer, then exit back to search results."
2233 (notmuch-show-archive-thread)
2234 (notmuch-show-next-thread))
2236 (put 'notmuch-show-archive-message 'notmuch-prefix-doc
2237 "Un-archive the current message.")
2238 (defun notmuch-show-archive-message (&optional unarchive)
2239 "Archive the current message.
2241 Archive the current message by applying the tag changes in
2242 `notmuch-archive-tags' to it. If a prefix argument is given, the
2243 message will be \"unarchived\", i.e. the tag changes in
2244 `notmuch-archive-tags' will be reversed."
2246 (when notmuch-archive-tags
2247 (apply 'notmuch-show-tag-message
2248 (notmuch-tag-change-list notmuch-archive-tags unarchive))))
2250 (defun notmuch-show-archive-message-then-next-or-exit ()
2251 "Archive the current message, then show the next open message in the current thread.
2253 If at the last open message in the current thread, then exit back
2256 (notmuch-show-archive-message)
2257 (notmuch-show-next-open-message t))
2259 (defun notmuch-show-archive-message-then-next-or-next-thread ()
2260 "Archive the current message, then show the next open message in the current thread.
2262 If at the last open message in the current thread, then show next
2263 thread from search."
2265 (notmuch-show-archive-message)
2266 (unless (notmuch-show-next-open-message)
2267 (notmuch-show-next-thread t)))
2269 (defun notmuch-show-stash-cc ()
2270 "Copy CC field of current message to kill-ring."
2272 (notmuch-common-do-stash (notmuch-show-get-cc)))
2274 (put 'notmuch-show-stash-date 'notmuch-prefix-doc
2275 "Copy timestamp of current message to kill-ring.")
2276 (defun notmuch-show-stash-date (&optional stash-timestamp)
2277 "Copy date of current message to kill-ring.
2279 If invoked with a prefix argument, copy timestamp of current
2280 message to kill-ring."
2283 (notmuch-common-do-stash (format "%d" (notmuch-show-get-timestamp)))
2284 (notmuch-common-do-stash (notmuch-show-get-date))))
2286 (defun notmuch-show-stash-filename ()
2287 "Copy filename of current message to kill-ring."
2289 (notmuch-common-do-stash (notmuch-show-get-filename)))
2291 (defun notmuch-show-stash-from ()
2292 "Copy From address of current message to kill-ring."
2294 (notmuch-common-do-stash (notmuch-show-get-from)))
2296 (put 'notmuch-show-stash-message-id 'notmuch-prefix-doc
2297 "Copy thread: query matching current thread to kill-ring.")
2298 (defun notmuch-show-stash-message-id (&optional stash-thread-id)
2299 "Copy id: query matching the current message to kill-ring.
2301 If invoked with a prefix argument (or STASH-THREAD-ID is
2302 non-nil), copy thread: query matching the current thread to
2306 (notmuch-common-do-stash notmuch-show-thread-id)
2307 (notmuch-common-do-stash (notmuch-show-get-message-id))))
2309 (defun notmuch-show-stash-message-id-stripped ()
2310 "Copy message ID of current message (sans `id:' prefix) to kill-ring."
2312 (notmuch-common-do-stash (notmuch-show-get-message-id t)))
2314 (defun notmuch-show-stash-subject ()
2315 "Copy Subject field of current message to kill-ring."
2317 (notmuch-common-do-stash (notmuch-show-get-subject)))
2319 (defun notmuch-show-stash-tags ()
2320 "Copy tags of current message to kill-ring as a comma separated list."
2322 (notmuch-common-do-stash (mapconcat 'identity (notmuch-show-get-tags) ",")))
2324 (defun notmuch-show-stash-to ()
2325 "Copy To address of current message to kill-ring."
2327 (notmuch-common-do-stash (notmuch-show-get-to)))
2329 (defun notmuch-show-stash-mlarchive-link (&optional mla)
2330 "Copy an ML Archive URI for the current message to the kill-ring.
2332 This presumes that the message is available at the selected Mailing List Archive.
2334 If optional argument MLA is non-nil, use the provided key instead of prompting
2335 the user (see `notmuch-show-stash-mlarchive-link-alist')."
2337 (let ((url (cdr (assoc
2339 (let ((completion-ignore-case t))
2341 "Mailing List Archive: "
2342 notmuch-show-stash-mlarchive-link-alist
2344 notmuch-show-stash-mlarchive-link-default)))
2345 notmuch-show-stash-mlarchive-link-alist))))
2346 (notmuch-common-do-stash
2348 (funcall url (notmuch-show-get-message-id t))
2349 (concat url (notmuch-show-get-message-id t))))))
2351 (defun notmuch-show-stash-mlarchive-link-and-go (&optional mla)
2352 "Copy an ML Archive URI for the current message to the kill-ring and visit it.
2354 This presumes that the message is available at the selected Mailing List Archive.
2356 If optional argument MLA is non-nil, use the provided key instead of prompting
2357 the user (see `notmuch-show-stash-mlarchive-link-alist')."
2359 (notmuch-show-stash-mlarchive-link mla)
2360 (browse-url (current-kill 0 t)))
2362 (defun notmuch-show-stash-git-helper (addresses prefix)
2363 "Escape, trim, quote, and add PREFIX to each address in list of ADDRESSES, and return the result as a single string."
2364 (mapconcat (lambda (x)
2366 ;; escape double-quotes
2367 (replace-regexp-in-string
2369 ;; trim leading and trailing spaces
2370 (replace-regexp-in-string
2371 "\\(^ *\\| *$\\)" ""
2375 (put 'notmuch-show-stash-git-send-email 'notmuch-prefix-doc
2376 "Copy From/To/Cc of current message to kill-ring in a form suitable for pasting to git send-email command line.")
2378 (defun notmuch-show-stash-git-send-email (&optional no-in-reply-to)
2379 "Copy From/To/Cc/Message-Id of current message to kill-ring in a form suitable for pasting to git send-email command line.
2381 If invoked with a prefix argument (or NO-IN-REPLY-TO is non-nil),
2382 omit --in-reply-to=<Message-Id>."
2384 (notmuch-common-do-stash
2385 (mapconcat 'identity
2388 (notmuch-show-stash-git-helper
2389 (message-tokenize-header (notmuch-show-get-from)) "--to=")
2390 (notmuch-show-stash-git-helper
2391 (message-tokenize-header (notmuch-show-get-to)) "--to=")
2392 (notmuch-show-stash-git-helper
2393 (message-tokenize-header (notmuch-show-get-cc)) "--cc=")
2394 (unless no-in-reply-to
2395 (notmuch-show-stash-git-helper
2396 (list (notmuch-show-get-message-id t)) "--in-reply-to="))))
2399 ;; Interactive part functions and their helpers
2401 (defun notmuch-show-generate-part-buffer (msg part)
2402 "Return a temporary buffer containing the specified part's content."
2403 (let ((buf (generate-new-buffer " *notmuch-part*"))
2404 (process-crypto notmuch-show-process-crypto))
2405 (with-current-buffer buf
2406 ;; This is always used in the content of mm handles, which
2407 ;; expect undecoded, binary part content.
2408 (insert (notmuch-get-bodypart-binary msg part process-crypto)))
2411 (defun notmuch-show-current-part-handle (&optional mime-type)
2412 "Return an mm-handle for the part containing point.
2414 This creates a temporary buffer for the part's content; the
2415 caller is responsible for killing this buffer as appropriate. If
2416 MIME-TYPE is given then set the handle's mime-type to MIME-TYPE."
2417 (let* ((msg (notmuch-show-get-message-properties))
2418 (part (notmuch-show-get-part-properties))
2419 (buf (notmuch-show-generate-part-buffer msg part))
2420 (computed-type (or mime-type (plist-get part :computed-type)))
2421 (filename (plist-get part :filename))
2422 (disposition (if filename `(attachment (filename . ,filename)))))
2423 (mm-make-handle buf (list computed-type) nil nil disposition)))
2425 (defun notmuch-show-apply-to-current-part-handle (fn &optional mime-type)
2426 "Apply FN to an mm-handle for the part containing point.
2428 This ensures that the temporary buffer created for the mm-handle
2429 is destroyed when FN returns. If MIME-TYPE is given then force
2430 part to be treated as if it had that mime-type."
2431 (let ((handle (notmuch-show-current-part-handle mime-type)))
2432 ;; emacs 24.3+ puts stdout/stderr into the calling buffer so we
2433 ;; call it from a temp-buffer, unless
2434 ;; notmuch-show-attachment-debug is non-nil in which case we put
2435 ;; it in " *notmuch-part*".
2437 (if notmuch-show-attachment-debug
2438 (with-current-buffer (generate-new-buffer " *notmuch-part*")
2439 (funcall fn handle))
2441 (funcall fn handle)))
2442 (kill-buffer (mm-handle-buffer handle)))))
2444 (defun notmuch-show-part-button-default (&optional button)
2446 (let ((button (or button (button-at (point)))))
2447 ;; Try to toggle the part, if that fails then call the default
2448 ;; action. The toggle fails if the part has no emacs renderable
2450 (unless (notmuch-show-toggle-part-invisibility button)
2451 (call-interactively notmuch-show-part-button-default-action))))
2453 (defun notmuch-show-save-part ()
2454 "Save the MIME part containing point to a file."
2456 (notmuch-show-apply-to-current-part-handle #'mm-save-part))
2458 (defun notmuch-show-view-part ()
2459 "View the MIME part containing point in an external viewer."
2461 ;; Set mm-inlined-types to nil to force an external viewer
2462 (let ((mm-inlined-types nil))
2463 (notmuch-show-apply-to-current-part-handle #'mm-display-part)))
2465 (defun notmuch-show-interactively-view-part ()
2466 "View the MIME part containing point, prompting for a viewer."
2468 (notmuch-show-apply-to-current-part-handle #'mm-interactively-view-part))
2470 (defun notmuch-show-pipe-part ()
2471 "Pipe the MIME part containing point to an external command."
2473 (notmuch-show-apply-to-current-part-handle #'mm-pipe-part))
2476 (defun notmuch-show--mm-display-part (handle)
2477 "Use mm-display-part to display HANDLE in a new buffer.
2479 If the part is displayed in an external application then close
2481 (let ((buf (get-buffer-create (generate-new-buffer-name
2482 (concat " *notmuch-internal-part*")))))
2483 (switch-to-buffer buf)
2484 (if (eq (mm-display-part handle) 'external)
2486 (goto-char (point-min))
2487 (set-buffer-modified-p nil)
2488 (view-buffer buf 'kill-buffer-if-not-modified))))
2490 (defun notmuch-show-choose-mime-of-part (mime-type)
2491 "Choose the mime type to use for displaying part"
2493 (list (completing-read "Mime type to use (default text/plain): "
2494 (mailcap-mime-types) nil nil nil nil "text/plain")))
2495 (notmuch-show-apply-to-current-part-handle #'notmuch-show--mm-display-part mime-type))
2497 (defun notmuch-show-imenu-prev-index-position-function ()
2498 "Move point to previous message in notmuch-show buffer.
2499 This function is used as a value for
2500 `imenu-prev-index-position-function'."
2503 (notmuch-show-previous-message)
2506 (defun notmuch-show-imenu-extract-index-name-function ()
2507 "Return imenu name for line at point.
2508 This function is used as a value for
2509 `imenu-extract-index-name-function'. Point should be at the
2510 beginning of the line."
2511 (back-to-indentation)
2512 (buffer-substring-no-properties (if notmuch-show-imenu-indent
2513 (line-beginning-position)
2515 (line-end-position)))
2517 (provide 'notmuch-show)
2519 ;;; notmuch-show.el ends here