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)
42 (declare-function notmuch-call-notmuch-process "notmuch" (&rest args))
43 (declare-function notmuch-search-next-thread "notmuch" nil)
44 (declare-function notmuch-search-previous-thread "notmuch" nil)
45 (declare-function notmuch-search-show-thread "notmuch" nil)
46 (declare-function notmuch-foreach-mime-part "notmuch" (function mm-handle))
47 (declare-function notmuch-count-attachments "notmuch" (mm-handle))
48 (declare-function notmuch-save-attachments "notmuch" (mm-handle &optional queryp))
49 (declare-function notmuch-tree "notmuch-tree"
50 (&optional query query-context target buffer-name open-target))
51 (declare-function notmuch-tree-get-message-properties "notmuch-tree" nil)
52 (declare-function notmuch-read-query "notmuch" (prompt))
54 (defcustom notmuch-message-headers '("Subject" "To" "Cc" "Date")
55 "Headers that should be shown in a message, in this order.
57 For an open message, all of these headers will be made visible
58 according to `notmuch-message-headers-visible' or can be toggled
59 with `notmuch-show-toggle-visibility-headers'. For a closed message,
60 only the first header in the list will be visible."
61 :type '(repeat string)
64 (defcustom notmuch-message-headers-visible t
65 "Should the headers be visible by default?
67 If this value is non-nil, then all of the headers defined in
68 `notmuch-message-headers' will be visible by default in the display
69 of each message. Otherwise, these headers will be hidden and
70 `notmuch-show-toggle-visibility-headers' can be used to make them
71 visible for any given message."
75 (defcustom notmuch-show-relative-dates t
76 "Display relative dates in the message summary line."
80 (defvar notmuch-show-markup-headers-hook '(notmuch-show-colour-headers)
81 "A list of functions called to decorate the headers listed in
82 `notmuch-message-headers'.")
84 (defcustom notmuch-show-hook '(notmuch-show-turn-on-visual-line-mode)
85 "Functions called after populating a `notmuch-show' buffer."
87 :options '(notmuch-show-turn-on-visual-line-mode)
89 :group 'notmuch-hooks)
91 (defcustom notmuch-show-insert-text/plain-hook '(notmuch-wash-wrap-long-lines
92 notmuch-wash-tidy-citations
93 notmuch-wash-elide-blank-lines
94 notmuch-wash-excerpt-citations)
95 "Functions used to improve the display of text/plain parts."
97 :options '(notmuch-wash-convert-inline-patch-to-part
98 notmuch-wash-wrap-long-lines
99 notmuch-wash-tidy-citations
100 notmuch-wash-elide-blank-lines
101 notmuch-wash-excerpt-citations)
103 :group 'notmuch-hooks)
105 (defcustom notmuch-show-max-text-part-size 100000
106 "Maximum size of a text part to be shown by default in characters.
108 Set to 0 to show the part regardless of size."
110 :group 'notmuch-show)
112 ;; Mostly useful for debugging.
113 (defcustom notmuch-show-all-multipart/alternative-parts nil
114 "Should all parts of multipart/alternative parts be shown?"
116 :group 'notmuch-show)
118 (defcustom notmuch-show-indent-messages-width 1
119 "Width of message indentation in threads.
121 Messages are shown indented according to their depth in a thread.
122 This variable determines the width of this indentation measured
123 in number of blanks. Defaults to `1', choose `0' to disable
126 :group 'notmuch-show)
128 (defcustom notmuch-show-indent-multipart nil
129 "Should the sub-parts of a multipart/* part be indented?"
130 ;; dme: Not sure which is a good default.
132 :group 'notmuch-show)
134 (defcustom notmuch-show-part-button-default-action 'notmuch-show-save-part
135 "Default part header button action (on ENTER or mouse click)."
137 :type '(choice (const :tag "Save part"
138 notmuch-show-save-part)
139 (const :tag "View part"
140 notmuch-show-view-part)
141 (const :tag "View interactively"
142 notmuch-show-interactively-view-part)))
144 (defcustom notmuch-show-only-matching-messages nil
145 "Only matching messages are shown by default."
147 :group 'notmuch-show)
149 ;; By default, block all external images to prevent privacy leaks and
150 ;; potential attacks.
151 (defcustom notmuch-show-text/html-blocked-images "."
152 "Remote images that have URLs matching this regexp will be blocked."
153 :type '(choice (const nil) regexp)
154 :group 'notmuch-show)
156 (defvar notmuch-show-thread-id nil)
157 (make-variable-buffer-local 'notmuch-show-thread-id)
159 (defvar notmuch-show-parent-buffer nil)
160 (make-variable-buffer-local 'notmuch-show-parent-buffer)
162 (defvar notmuch-show-query-context nil)
163 (make-variable-buffer-local 'notmuch-show-query-context)
165 (defvar notmuch-show-process-crypto nil)
166 (make-variable-buffer-local 'notmuch-show-process-crypto)
168 (defvar notmuch-show-elide-non-matching-messages nil)
169 (make-variable-buffer-local 'notmuch-show-elide-non-matching-messages)
171 (defvar notmuch-show-indent-content t)
172 (make-variable-buffer-local 'notmuch-show-indent-content)
174 (defvar notmuch-show-attachment-debug nil
175 "If t log stdout and stderr from attachment handlers
177 When set to nil (the default) stdout and stderr from attachment
178 handlers is discarded. When set to t the stdout and stderr from
179 each attachment handler is logged in buffers with names beginning
180 \" *notmuch-part*\". This option requires emacs version at least
183 (defcustom notmuch-show-stash-mlarchive-link-alist
184 '(("Gmane" . "http://mid.gmane.org/")
185 ("MARC" . "https://marc.info/?i=")
186 ("Mail Archive, The" . "https://mid.mail-archive.com/")
187 ("LKML" . "https://lkml.kernel.org/r/")
188 ;; FIXME: can these services be searched by `Message-Id' ?
189 ;; ("MarkMail" . "http://markmail.org/")
190 ;; ("Nabble" . "http://nabble.com/")
191 ;; ("opensubscriber" . "http://opensubscriber.com/")
193 "List of Mailing List Archives to use when stashing links.
195 This list is used for generating a Mailing List Archive reference
196 URI with the current message's Message-Id in
197 `notmuch-show-stash-mlarchive-link'.
199 If the cdr of the alist element is not a function, the cdr is
200 expected to contain a URI that is concatenated with the current
201 message's Message-Id to create a ML archive reference URI.
203 If the cdr is a function, the function is called with the
204 Message-Id as the argument, and the function is expected to
205 return the ML archive reference URI."
206 :type '(alist :key-type (string :tag "Name")
209 (function :tag "Function returning the URL")))
210 :group 'notmuch-show)
212 (defcustom notmuch-show-stash-mlarchive-link-default "Gmane"
213 "Default Mailing List Archive to use when stashing links.
215 This is used when `notmuch-show-stash-mlarchive-link' isn't
216 provided with an MLA argument nor `completing-read' input."
220 (list 'const :tag (car mla) :value (car mla)))
221 notmuch-show-stash-mlarchive-link-alist))
222 :group 'notmuch-show)
224 (defcustom notmuch-show-mark-read-tags '("-unread")
225 "List of tag changes to apply to a message when it is marked as read.
227 Tags starting with \"+\" (or not starting with either \"+\" or
228 \"-\") in the list will be added, and tags starting with \"-\"
229 will be removed from the message being marked as read.
231 For example, if you wanted to remove an \"unread\" tag and add a
232 \"read\" tag (which would make little sense), you would set:
233 (\"-unread\" \"+read\")"
234 :type '(repeat string)
235 :group 'notmuch-show)
237 (defcustom notmuch-show-mark-read-function #'notmuch-show-seen-current-message
238 "Function to control which messages are marked read.
240 The function should take two arguments START and END which will
241 be the start and end of the visible portion of the buffer and
242 should mark the appropriate messages read by applying
243 `notmuch-show-mark-read'. This function will be called after
244 every user interaction with notmuch."
246 :group 'notmuch-show)
248 (defmacro with-current-notmuch-show-message (&rest body)
249 "Evaluate body with current buffer set to the text of current message"
251 (let ((id (notmuch-show-get-message-id)))
252 (let ((buf (generate-new-buffer (concat "*notmuch-msg-" id "*"))))
253 (with-current-buffer buf
254 (let ((coding-system-for-read 'no-conversion))
255 (call-process notmuch-command nil t nil "show" "--format=raw" id))
257 (kill-buffer buf)))))
259 (defun notmuch-show-turn-on-visual-line-mode ()
260 "Enable Visual Line mode."
261 (visual-line-mode t))
263 ;; DEPRECATED in Notmuch 0.16 since we now have convenient part
264 ;; commands. We'll keep the command around for a version or two in
265 ;; case people want to bind it themselves.
266 (defun notmuch-show-view-all-mime-parts ()
267 "Use external viewers to view all attachments from the current message."
269 (with-current-notmuch-show-message
270 ;; We override the mm-inline-media-tests to indicate which message
271 ;; parts are already sufficiently handled by the original
272 ;; presentation of the message in notmuch-show mode. These parts
273 ;; will be inserted directly into the temporary buffer of
274 ;; with-current-notmuch-show-message and silently discarded.
276 ;; Any MIME part not explicitly mentioned here will be handled by an
277 ;; external viewer as configured in the various mailcap files.
278 (let ((mm-inline-media-tests '(
279 ("text/.*" ignore identity)
280 ("application/pgp-signature" ignore identity)
281 ("multipart/alternative" ignore identity)
282 ("multipart/mixed" ignore identity)
283 ("multipart/related" ignore identity)
285 (mm-display-parts (mm-dissect-buffer)))))
287 (defun notmuch-show-save-attachments ()
288 "Save all attachments from the current message."
290 (with-current-notmuch-show-message
291 (let ((mm-handle (mm-dissect-buffer)))
292 (notmuch-save-attachments
293 mm-handle (> (notmuch-count-attachments mm-handle) 1))))
296 (defun notmuch-show-with-message-as-text (fn)
297 "Apply FN to a text representation of the current message.
299 FN is called with one argument, the message properties. It should
300 operation on the contents of the current buffer."
302 ;; Remake the header to ensure that all information is available.
303 (let* ((to (notmuch-show-get-to))
304 (cc (notmuch-show-get-cc))
305 (from (notmuch-show-get-from))
306 (subject (notmuch-show-get-subject))
307 (date (notmuch-show-get-date))
308 (tags (notmuch-show-get-tags))
309 (depth (notmuch-show-get-depth))
312 "Subject: " subject "\n"
314 (if (not (string= cc ""))
315 (concat "Cc: " cc "\n")
321 (mapconcat #'identity tags ", ") "\n")
323 (all (buffer-substring (notmuch-show-message-top)
324 (notmuch-show-message-bottom)))
326 (props (notmuch-show-get-message-properties))
327 (indenting notmuch-show-indent-content))
331 (indent-rigidly (point-min) (point-max) (- depth)))
332 ;; Remove the original header.
333 (goto-char (point-min))
334 (re-search-forward "^$" (point-max) nil)
335 (delete-region (point-min) (point))
337 (funcall fn props))))
339 (defun notmuch-show-print-message ()
340 "Print the current message."
342 (notmuch-show-with-message-as-text 'notmuch-print-message))
344 (defun notmuch-show-fontify-header ()
346 ((looking-at "[Tt]o:")
348 ((looking-at "[Bb]?[Cc][Cc]:")
350 ((looking-at "[Ss]ubject:")
351 'message-header-subject)
353 'message-header-other))))
355 (overlay-put (make-overlay (point) (re-search-forward ":"))
356 'face 'message-header-name)
357 (overlay-put (make-overlay (point) (re-search-forward ".*$"))
360 (defun notmuch-show-colour-headers ()
361 "Apply some colouring to the current headers."
362 (goto-char (point-min))
363 (while (looking-at "^[A-Za-z][-A-Za-z0-9]*:")
364 (notmuch-show-fontify-header)
367 (defun notmuch-show-spaces-n (n)
368 "Return a string comprised of `n' spaces."
371 (defun notmuch-show-update-tags (tags)
372 "Update the displayed tags of the current message."
374 (goto-char (notmuch-show-message-top))
375 (if (re-search-forward "(\\([^()]*\\))$" (line-end-position) t)
376 (let ((inhibit-read-only t))
377 (replace-match (concat "("
378 (notmuch-tag-format-tags tags (notmuch-show-get-prop :orig-tags))
381 (defun notmuch-clean-address (address)
382 "Try to clean a single email ADDRESS for display. Return a cons
383 cell of (AUTHOR_EMAIL AUTHOR_NAME). Return (ADDRESS nil) if
386 (let (p-name p-address)
387 ;; It would be convenient to use `mail-header-parse-address',
388 ;; but that expects un-decoded mailbox parts, whereas our
389 ;; mailbox parts are already decoded (and hence may contain
390 ;; UTF-8). Given that notmuch should handle most of the awkward
391 ;; cases, some simple string deconstruction should be sufficient
394 ;; "User <user@dom.ain>" style.
395 ((string-match "\\(.*\\) <\\(.*\\)>" address)
396 (setq p-name (match-string 1 address)
397 p-address (match-string 2 address)))
399 ;; "<user@dom.ain>" style.
400 ((string-match "<\\(.*\\)>" address)
401 (setq p-address (match-string 1 address)))
405 (setq p-address address)))
408 ;; Remove elements of the mailbox part that are not relevant for
409 ;; display, even if they are required during transport:
412 (setq p-name (replace-regexp-in-string "\\\\" "" p-name))
414 ;; Outer single and double quotes, which might be nested.
417 do (setq start-of-loop p-name)
419 when (string-match "^\"\\(.*\\)\"$" p-name)
420 do (setq p-name (match-string 1 p-name))
422 when (string-match "^'\\(.*\\)'$" p-name)
423 do (setq p-name (match-string 1 p-name))
425 until (string= start-of-loop p-name)))
427 ;; If the address is 'foo@bar.com <foo@bar.com>' then show just
429 (when (string= p-name p-address)
432 (cons p-address p-name))
433 (error (cons address nil))))
435 (defun notmuch-show-clean-address (address)
436 "Try to clean a single email ADDRESS for display. Return
437 unchanged ADDRESS if parsing fails."
438 (let* ((clean-address (notmuch-clean-address address))
439 (p-address (car clean-address))
440 (p-name (cdr clean-address)))
441 ;; If no name, return just the address.
444 ;; Otherwise format the name and address together.
445 (concat p-name " <" p-address ">"))))
447 (defun notmuch-show-insert-headerline (headers date tags depth)
448 "Insert a notmuch style headerline based on HEADERS for a
449 message at DEPTH in the current thread."
450 (let ((start (point)))
451 (insert (notmuch-show-spaces-n (* notmuch-show-indent-messages-width depth))
453 (notmuch-show-clean-address (plist-get headers :From)))
457 (notmuch-tag-format-tags tags tags)
459 (overlay-put (make-overlay start (point)) 'face 'notmuch-message-summary-face)))
461 (defun notmuch-show-insert-header (header header-value)
462 "Insert a single header."
463 (insert header ": " (notmuch-sanitize header-value) "\n"))
465 (defun notmuch-show-insert-headers (headers)
466 "Insert the headers of the current message."
467 (let ((start (point)))
468 (mapc (lambda (header)
469 (let* ((header-symbol (intern (concat ":" header)))
470 (header-value (plist-get headers header-symbol)))
471 (if (and header-value
472 (not (string-equal "" header-value)))
473 (notmuch-show-insert-header header header-value))))
474 notmuch-message-headers)
477 (narrow-to-region start (point-max))
478 (run-hooks 'notmuch-show-markup-headers-hook)))))
480 (define-button-type 'notmuch-show-part-button-type
481 'action 'notmuch-show-part-button-default
484 :supertype 'notmuch-button-type)
486 (defun notmuch-show-insert-part-header (nth content-type declared-type &optional name comment)
488 (base-label (concat (when name (concat name ": "))
490 (unless (string-equal declared-type content-type)
491 (concat " (as " content-type ")"))
496 (concat "[ " base-label " ]")
497 :base-label base-label
498 :type 'notmuch-show-part-button-type
499 :notmuch-part-hidden nil))
504 (defun notmuch-show-toggle-part-invisibility (&optional button)
506 (let ((button (or button (button-at (point)))))
508 (let ((overlay (button-get button 'overlay))
509 (lazy-part (button-get button :notmuch-lazy-part)))
510 ;; We have a part to toggle if there is an overlay or if there is a lazy part.
511 ;; If neither is present we cannot toggle the part so we just return nil.
512 (when (or overlay lazy-part)
513 (let* ((show (button-get button :notmuch-part-hidden))
514 (new-start (button-start button))
515 (button-label (button-get button :base-label))
517 (properties (text-properties-at (button-start button)))
518 (inhibit-read-only t))
519 ;; Toggle the button itself.
520 (button-put button :notmuch-part-hidden (not show))
521 (goto-char new-start)
522 (insert "[ " button-label (if show " ]" " (hidden) ]"))
523 (set-text-properties new-start (point) properties)
524 (let ((old-end (button-end button)))
525 (move-overlay button new-start (point))
526 (delete-region (point) old-end))
527 (goto-char (min old-point (1- (button-end button))))
528 ;; Return nil if there is a lazy-part, it is empty, and we are
529 ;; trying to show it. In all other cases return t.
532 (button-put button :notmuch-lazy-part nil)
533 (notmuch-show-lazy-part lazy-part button))
534 ;; else there must be an overlay.
535 (overlay-put overlay 'invisible (not show))
538 ;; Part content ID handling
540 (defvar notmuch-show--cids nil
541 "Alist from raw content ID to (MSG PART).")
542 (make-variable-buffer-local 'notmuch-show--cids)
544 (defun notmuch-show--register-cids (msg part)
545 "Register content-IDs in PART and all of PART's sub-parts."
546 (let ((content-id (plist-get part :content-id)))
548 ;; Note that content-IDs are globally unique, except when they
549 ;; aren't: RFC 2046 section 5.1.4 permits children of a
550 ;; multipart/alternative to have the same content-ID, in which
551 ;; case the MUA is supposed to pick the best one it can render.
552 ;; We simply add the content-ID to the beginning of our alist;
553 ;; so if this happens, we'll take the last (and "best")
554 ;; alternative (even if we can't render it).
555 (push (list content-id msg part) notmuch-show--cids)))
556 ;; Recurse on sub-parts
557 (let ((ctype (notmuch-split-content-type
558 (downcase (plist-get part :content-type)))))
559 (cond ((equal (first ctype) "multipart")
560 (mapc (apply-partially #'notmuch-show--register-cids msg)
561 (plist-get part :content)))
562 ((equal ctype '("message" "rfc822"))
563 (notmuch-show--register-cids
565 (first (plist-get (first (plist-get part :content)) :body)))))))
567 (defun notmuch-show--get-cid-content (cid)
568 "Return a list (CID-content content-type) or nil.
570 This will only find parts from messages that have been inserted
571 into the current buffer. CID must be a raw content ID, without
572 enclosing angle brackets, a cid: prefix, or URL encoding. This
573 will return nil if the CID is unknown or cannot be retrieved."
574 (let ((descriptor (cdr (assoc cid notmuch-show--cids))))
576 (let* ((msg (first descriptor))
577 (part (second descriptor))
578 ;; Request caching for this content, as some messages
579 ;; reference the same cid: part many times (hundreds!).
580 (content (notmuch-get-bodypart-binary
581 msg part notmuch-show-process-crypto 'cache))
582 (content-type (plist-get part :content-type)))
583 (list content content-type)))))
585 (defun notmuch-show-setup-w3m ()
586 "Instruct w3m how to retrieve content from a \"related\" part of a message."
588 (if (boundp 'w3m-cid-retrieve-function-alist)
589 (unless (assq 'notmuch-show-mode w3m-cid-retrieve-function-alist)
590 (push (cons 'notmuch-show-mode #'notmuch-show--cid-w3m-retrieve)
591 w3m-cid-retrieve-function-alist)))
592 (setq mm-inline-text-html-with-images t))
594 (defvar w3m-current-buffer) ;; From `w3m.el'.
595 (defun notmuch-show--cid-w3m-retrieve (url &rest args)
596 ;; url includes the cid: prefix and is URL encoded (see RFC 2392).
597 (let* ((cid (url-unhex-string (substring url 4)))
599 (with-current-buffer w3m-current-buffer
600 (notmuch-show--get-cid-content cid))))
601 (when content-and-type
602 (insert (first content-and-type))
603 (second content-and-type))))
605 ;; MIME part renderers
607 (defun notmuch-show-multipart/*-to-list (part)
608 (mapcar (lambda (inner-part) (plist-get inner-part :content-type))
609 (plist-get part :content)))
611 (defun notmuch-show-insert-part-multipart/alternative (msg part content-type nth depth button)
612 (let ((chosen-type (car (notmuch-multipart/alternative-choose msg (notmuch-show-multipart/*-to-list part))))
613 (inner-parts (plist-get part :content))
615 ;; This inserts all parts of the chosen type rather than just one,
616 ;; but it's not clear that this is the wrong thing to do - which
617 ;; should be chosen if there are more than one that match?
618 (mapc (lambda (inner-part)
619 (let* ((inner-type (plist-get inner-part :content-type))
620 (hide (not (or notmuch-show-all-multipart/alternative-parts
621 (string= chosen-type inner-type)))))
622 (notmuch-show-insert-bodypart msg inner-part depth hide)))
625 (when notmuch-show-indent-multipart
626 (indent-rigidly start (point) 1)))
629 (defun notmuch-show-insert-part-multipart/related (msg part content-type nth depth button)
630 (let ((inner-parts (plist-get part :content))
633 ;; Render the primary part. FIXME: Support RFC 2387 Start header.
634 (notmuch-show-insert-bodypart msg (car inner-parts) depth)
635 ;; Add hidden buttons for the rest
636 (mapc (lambda (inner-part)
637 (notmuch-show-insert-bodypart msg inner-part depth t))
640 (when notmuch-show-indent-multipart
641 (indent-rigidly start (point) 1)))
644 (defun notmuch-show-insert-part-multipart/signed (msg part content-type nth depth button)
646 (button-put button 'face 'notmuch-crypto-part-header))
648 ;; Insert a button detailing the signature status.
649 (notmuch-crypto-insert-sigstatus-button (car (plist-get part :sigstatus))
650 (notmuch-show-get-header :From msg))
652 (let ((inner-parts (plist-get part :content))
654 ;; Show all of the parts.
655 (mapc (lambda (inner-part)
656 (notmuch-show-insert-bodypart msg inner-part depth))
659 (when notmuch-show-indent-multipart
660 (indent-rigidly start (point) 1)))
663 (defun notmuch-show-insert-part-multipart/encrypted (msg part content-type nth depth button)
665 (button-put button 'face 'notmuch-crypto-part-header))
667 ;; Insert a button detailing the encryption status.
668 (notmuch-crypto-insert-encstatus-button (car (plist-get part :encstatus)))
670 ;; Insert a button detailing the signature status.
671 (notmuch-crypto-insert-sigstatus-button (car (plist-get part :sigstatus))
672 (notmuch-show-get-header :From msg))
674 (let ((inner-parts (plist-get part :content))
676 ;; Show all of the parts.
677 (mapc (lambda (inner-part)
678 (notmuch-show-insert-bodypart msg inner-part depth))
681 (when notmuch-show-indent-multipart
682 (indent-rigidly start (point) 1)))
685 (defun notmuch-show-insert-part-application/pgp-encrypted (msg part content-type nth depth button)
688 (defun notmuch-show-insert-part-multipart/* (msg part content-type nth depth button)
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-message/rfc822 (msg part content-type nth depth button)
701 (let* ((message (car (plist-get part :content)))
702 (body (car (plist-get message :body)))
705 ;; Override `notmuch-message-headers' to force `From' to be
707 (let ((notmuch-message-headers '("From" "Subject" "To" "Cc" "Date")))
708 (notmuch-show-insert-headers (plist-get message :headers)))
710 ;; Blank line after headers to be compatible with the normal
715 (notmuch-show-insert-bodypart msg body depth)
717 (when notmuch-show-indent-multipart
718 (indent-rigidly start (point) 1)))
721 (defun notmuch-show-insert-part-text/plain (msg part content-type nth depth button)
722 ;; For backward compatibility we want to apply the text/plain hook
723 ;; to the whole of the part including the part button if there is
725 (let ((start (if button
726 (button-start button)
728 (insert (notmuch-get-bodypart-text msg part notmuch-show-process-crypto))
731 (narrow-to-region start (point-max))
732 (run-hook-with-args 'notmuch-show-insert-text/plain-hook msg depth))))
735 (defun notmuch-show-insert-part-text/calendar (msg part content-type nth depth button)
736 (insert (with-temp-buffer
737 (insert (notmuch-get-bodypart-text msg part notmuch-show-process-crypto))
738 ;; notmuch-get-bodypart-text does no newline conversion.
739 ;; Replace CRLF with LF before icalendar can use it.
740 (goto-char (point-min))
741 (while (re-search-forward "\r\n" nil t)
742 (replace-match "\n" nil nil))
743 (let ((file (make-temp-file "notmuch-ical"))
747 (unless (icalendar-import-buffer file t)
748 (error "Icalendar import error. See *icalendar-errors* for more information"))
749 (set-buffer (get-file-buffer file))
750 (setq result (buffer-substring (point-min) (point-max)))
751 (set-buffer-modified-p nil)
752 (kill-buffer (current-buffer)))
757 ;; For backwards compatibility.
758 (defun notmuch-show-insert-part-text/x-vcalendar (msg part content-type nth depth button)
759 (notmuch-show-insert-part-text/calendar msg part content-type nth depth button))
761 (defun notmuch-show-get-mime-type-of-application/octet-stream (part)
762 ;; If we can deduce a MIME type from the filename of the attachment,
764 (if (plist-get part :filename)
765 (let ((extension (file-name-extension (plist-get part :filename)))
769 (mailcap-parse-mimetypes)
770 (setq mime-type (mailcap-extension-to-mime extension))
772 (not (string-equal mime-type "application/octet-stream")))
777 (defun notmuch-show-insert-part-text/html (msg part content-type nth depth button)
778 (if (eq mm-text-html-renderer 'shr)
779 ;; It's easier to drive shr ourselves than to work around the
780 ;; goofy things `mm-shr' does (like irreversibly taking over
781 ;; content ID handling).
783 ;; FIXME: If we block an image, offer a button to load external
785 (let ((shr-blocked-images notmuch-show-text/html-blocked-images))
786 (notmuch-show--insert-part-text/html-shr msg part))
787 ;; Otherwise, let message-mode do the heavy lifting
789 ;; w3m sets up a keymap which "leaks" outside the invisible region
790 ;; and causes strange effects in notmuch. We set
791 ;; mm-inline-text-html-with-w3m-keymap to nil to tell w3m not to
792 ;; set a keymap (so the normal notmuch-show-mode-map remains).
793 (let ((mm-inline-text-html-with-w3m-keymap nil)
794 ;; FIXME: If we block an image, offer a button to load external
796 (gnus-blocked-images notmuch-show-text/html-blocked-images))
797 (notmuch-show-insert-part-*/* msg part content-type nth depth button))))
799 ;; These functions are used by notmuch-show--insert-part-text/html-shr
800 (declare-function libxml-parse-html-region "xml.c")
801 (declare-function shr-insert-document "shr")
803 (defun notmuch-show--insert-part-text/html-shr (msg part)
804 ;; Make sure shr is loaded before we start let-binding its globals
806 (let ((dom (let ((process-crypto notmuch-show-process-crypto))
808 (insert (notmuch-get-bodypart-text msg part process-crypto))
809 (libxml-parse-html-region (point-min) (point-max)))))
810 (shr-content-function
812 ;; shr strips the "cid:" part of URL, but doesn't
813 ;; URL-decode it (see RFC 2392).
814 (let ((cid (url-unhex-string url)))
815 (first (notmuch-show--get-cid-content cid))))))
816 (shr-insert-document dom)
819 (defun notmuch-show-insert-part-*/* (msg part content-type nth depth button)
820 ;; This handler _must_ succeed - it is the handler of last resort.
821 (notmuch-mm-display-part-inline msg part content-type notmuch-show-process-crypto)
824 ;; Functions for determining how to handle MIME parts.
826 (defun notmuch-show-handlers-for (content-type)
827 "Return a list of content handlers for a part of type CONTENT-TYPE."
832 ;; Reverse order of prefrence.
833 (list (intern (concat "notmuch-show-insert-part-*/*"))
835 "notmuch-show-insert-part-"
836 (car (notmuch-split-content-type content-type))
838 (intern (concat "notmuch-show-insert-part-" content-type))))
843 (defun notmuch-show-insert-bodypart-internal (msg part content-type nth depth button)
844 ;; Run the handlers until one of them succeeds.
845 (loop for handler in (notmuch-show-handlers-for content-type)
846 until (condition-case err
847 (funcall handler msg part content-type nth depth button)
848 ;; Specifying `debug' here lets the debugger run if
849 ;; `debug-on-error' is non-nil.
851 (insert "!!! Bodypart handler `" (prin1-to-string handler) "' threw an error:\n"
852 "!!! " (error-message-string err) "\n")
855 (defun notmuch-show-create-part-overlays (button beg end)
856 "Add an overlay to the part between BEG and END"
858 ;; If there is no button (i.e., the part is text/plain and the first
859 ;; part) or if the part has no content then we don't make the part
861 (when (and button (/= beg end))
862 (button-put button 'overlay (make-overlay beg end))
863 ;; Return true if we created an overlay.
866 (defun notmuch-show-record-part-information (part beg end)
867 "Store PART as a text property from BEG to END"
869 ;; Record part information. Since we already inserted subparts,
870 ;; don't override existing :notmuch-part properties.
871 (notmuch-map-text-property beg end :notmuch-part
872 (lambda (v) (or v part)))
873 ;; Make :notmuch-part front sticky and rear non-sticky so it stays
874 ;; applied to the beginning of each line when we indent the
875 ;; message. Since we're operating on arbitrary renderer output,
876 ;; watch out for sticky specs of t, which means all properties are
877 ;; front-sticky/rear-nonsticky.
878 (notmuch-map-text-property beg end 'front-sticky
879 (lambda (v) (if (listp v)
880 (pushnew :notmuch-part v)
882 (notmuch-map-text-property beg end 'rear-nonsticky
883 (lambda (v) (if (listp v)
884 (pushnew :notmuch-part v)
887 (defun notmuch-show-lazy-part (part-args button)
888 ;; Insert the lazy part after the button for the part. We would just
889 ;; move to the start of the new line following the button and insert
890 ;; the part but that point might have text properties (eg colours
891 ;; from a message header etc) so instead we start from the last
892 ;; character of the button by adding a newline and finish by
893 ;; removing the extra newline from the end of the part.
895 (goto-char (button-end button))
897 (let* ((inhibit-read-only t)
898 ;; We need to use markers for the start and end of the part
899 ;; because the part insertion functions do not guarantee
900 ;; to leave point at the end of the part.
901 (part-beg (copy-marker (point) nil))
902 (part-end (copy-marker (point) t))
903 ;; We have to save the depth as we can't find the depth
905 (depth (notmuch-show-get-depth)))
907 (narrow-to-region part-beg part-end)
908 (delete-region part-beg part-end)
909 (apply #'notmuch-show-insert-bodypart-internal part-args)
910 (indent-rigidly part-beg part-end depth))
913 (notmuch-show-record-part-information (second part-args)
914 (button-start button)
916 ;; Create the overlay. If the lazy-part turned out to be empty/not
917 ;; showable this returns nil.
918 (notmuch-show-create-part-overlays button part-beg part-end))))
920 (defun notmuch-show-mime-type (part)
921 "Return the correct mime-type to use for PART."
922 (let ((content-type (downcase (plist-get part :content-type))))
923 (or (and (string= content-type "application/octet-stream")
924 (notmuch-show-get-mime-type-of-application/octet-stream part))
925 (and (string= content-type "inline patch")
929 ;; The following variable can be overridden by let bindings.
930 (defvar notmuch-show-insert-header-p-function 'notmuch-show-insert-header-p
931 "Specify which function decides which part headers get inserted.
933 The function should take two parameters, PART and HIDE, and
934 should return non-NIL if a header button should be inserted for
937 (defun notmuch-show-insert-header-p (part hide)
938 ;; Show all part buttons except for the first part if it is text/plain.
939 (let ((mime-type (notmuch-show-mime-type part)))
940 (not (and (string= mime-type "text/plain")
941 (<= (plist-get part :id) 1)))))
943 (defun notmuch-show-reply-insert-header-p-never (part hide)
946 (defun notmuch-show-reply-insert-header-p-trimmed (part hide)
947 (let ((mime-type (notmuch-show-mime-type part)))
948 (and (not (notmuch-match-content-type mime-type "multipart/*"))
951 (defun notmuch-show-reply-insert-header-p-minimal (part hide)
952 (let ((mime-type (notmuch-show-mime-type part)))
953 (and (notmuch-match-content-type mime-type "text/*")
956 (defun notmuch-show-insert-bodypart (msg part depth &optional hide)
957 "Insert the body part PART at depth DEPTH in the current thread.
959 HIDE determines whether to show or hide the part and the button
960 as follows: If HIDE is nil, show the part and the button. If HIDE
961 is t, hide the part initially and show the button."
963 (let* ((content-type (downcase (plist-get part :content-type)))
964 (mime-type (notmuch-show-mime-type part))
965 (nth (plist-get part :id))
966 (long (and (notmuch-match-content-type mime-type "text/*")
967 (> notmuch-show-max-text-part-size 0)
968 (> (length (plist-get part :content)) notmuch-show-max-text-part-size)))
970 ;; This default header-p function omits the part button for
971 ;; the first (or only) part if this is text/plain.
972 (button (when (funcall notmuch-show-insert-header-p-function part hide)
973 (notmuch-show-insert-part-header nth mime-type content-type (plist-get part :filename))))
974 ;; Hide the part initially if HIDE is t, or if it is too long
975 ;; and we have a button to allow toggling.
976 (show-part (not (or (equal hide t)
978 (content-beg (point)))
980 ;; Store the computed mime-type for later use (e.g. by attachment handlers).
981 (plist-put part :computed-type mime-type)
984 (notmuch-show-insert-bodypart-internal msg part mime-type nth depth button)
986 (button-put button :notmuch-lazy-part
987 (list msg part mime-type nth depth button))))
989 ;; Some of the body part handlers leave point somewhere up in the
990 ;; part, so we make sure that we're down at the end.
991 (goto-char (point-max))
992 ;; Ensure that the part ends with a carriage return.
995 ;; We do not create the overlay for hidden (lazy) parts until
996 ;; they are inserted.
998 (notmuch-show-create-part-overlays button content-beg (point))
1000 (notmuch-show-toggle-part-invisibility button)))
1001 (notmuch-show-record-part-information part beg (point))))
1003 (defun notmuch-show-insert-body (msg body depth)
1004 "Insert the body BODY at depth DEPTH in the current thread."
1006 ;; Register all content IDs for this message. According to RFC
1007 ;; 2392, content IDs are *global*, but it's okay if an MUA treats
1008 ;; them as only global within a message.
1009 (notmuch-show--register-cids msg (first body))
1011 (mapc (lambda (part) (notmuch-show-insert-bodypart msg part depth)) body))
1013 (defun notmuch-show-make-symbol (type)
1014 (make-symbol (concat "notmuch-show-" type)))
1016 (defun notmuch-show-strip-re (string)
1017 (replace-regexp-in-string "^\\([Rr]e: *\\)+" "" string))
1019 (defvar notmuch-show-previous-subject "")
1020 (make-variable-buffer-local 'notmuch-show-previous-subject)
1022 (defun notmuch-show-insert-msg (msg depth)
1023 "Insert the message MSG at depth DEPTH in the current thread."
1024 (let* ((headers (plist-get msg :headers))
1025 ;; Indentation causes the buffer offset of the start/end
1026 ;; points to move, so we must use markers.
1027 message-start message-end
1028 content-start content-end
1029 headers-start headers-end
1030 (bare-subject (notmuch-show-strip-re (plist-get headers :Subject))))
1032 (setq message-start (point-marker))
1034 (notmuch-show-insert-headerline headers
1035 (or (if notmuch-show-relative-dates
1036 (plist-get msg :date_relative)
1038 (plist-get headers :Date))
1039 (plist-get msg :tags) depth)
1041 (setq content-start (point-marker))
1043 ;; Set `headers-start' to point after the 'Subject:' header to be
1044 ;; compatible with the existing implementation. This just sets it
1045 ;; to after the first header.
1046 (notmuch-show-insert-headers headers)
1048 (goto-char content-start)
1049 ;; If the subject of this message is the same as that of the
1050 ;; previous message, don't display it when this message is
1052 (when (not (string= notmuch-show-previous-subject
1055 (setq headers-start (point-marker)))
1056 (setq headers-end (point-marker))
1058 (setq notmuch-show-previous-subject bare-subject)
1060 ;; A blank line between the headers and the body.
1062 (notmuch-show-insert-body msg (plist-get msg :body)
1063 (if notmuch-show-indent-content depth 0))
1064 ;; Ensure that the body ends with a newline.
1067 (setq content-end (point-marker))
1069 ;; Indent according to the depth in the thread.
1070 (if notmuch-show-indent-content
1071 (indent-rigidly content-start content-end (* notmuch-show-indent-messages-width depth)))
1073 (setq message-end (point-max-marker))
1075 ;; Save the extents of this message over the whole text of the
1077 (put-text-property message-start message-end :notmuch-message-extent (cons message-start message-end))
1079 ;; Create overlays used to control visibility
1080 (plist-put msg :headers-overlay (make-overlay headers-start headers-end))
1081 (plist-put msg :message-overlay (make-overlay headers-start content-end))
1083 (plist-put msg :depth depth)
1085 ;; Save the properties for this message. Currently this saves the
1086 ;; entire message (augmented it with other stuff), which seems
1087 ;; like overkill. We might save a reduced subset (for example, not
1089 (notmuch-show-set-message-properties msg)
1091 ;; Set header visibility.
1092 (notmuch-show-headers-visible msg notmuch-message-headers-visible)
1094 ;; Message visibility depends on whether it matched the search
1096 (notmuch-show-message-visible msg (and (plist-get msg :match)
1097 (not (plist-get msg :excluded))))))
1099 (defun notmuch-show-toggle-process-crypto ()
1100 "Toggle the processing of cryptographic MIME parts."
1102 (setq notmuch-show-process-crypto (not notmuch-show-process-crypto))
1103 (message (if notmuch-show-process-crypto
1104 "Processing cryptographic MIME parts."
1105 "Not processing cryptographic MIME parts."))
1106 (notmuch-show-refresh-view))
1108 (defun notmuch-show-toggle-elide-non-matching ()
1109 "Toggle the display of non-matching messages."
1111 (setq notmuch-show-elide-non-matching-messages (not notmuch-show-elide-non-matching-messages))
1112 (message (if notmuch-show-elide-non-matching-messages
1113 "Showing matching messages only."
1114 "Showing all messages."))
1115 (notmuch-show-refresh-view))
1117 (defun notmuch-show-toggle-thread-indentation ()
1118 "Toggle the indentation of threads."
1120 (setq notmuch-show-indent-content (not notmuch-show-indent-content))
1121 (message (if notmuch-show-indent-content
1122 "Content is indented."
1123 "Content is not indented."))
1124 (notmuch-show-refresh-view))
1126 (defun notmuch-show-insert-tree (tree depth)
1127 "Insert the message tree TREE at depth DEPTH in the current thread."
1128 (let ((msg (car tree))
1129 (replies (cadr tree)))
1130 ;; We test whether there is a message or just some replies.
1132 (notmuch-show-insert-msg msg depth))
1133 (notmuch-show-insert-thread replies (1+ depth))))
1135 (defun notmuch-show-insert-thread (thread depth)
1136 "Insert the thread THREAD at depth DEPTH in the current forest."
1137 (mapc (lambda (tree) (notmuch-show-insert-tree tree depth)) thread))
1139 (defun notmuch-show-insert-forest (forest)
1140 "Insert the forest of threads FOREST."
1141 (mapc (lambda (thread) (notmuch-show-insert-thread thread 0)) forest))
1143 (defvar notmuch-id-regexp
1145 ;; Match the id: prefix only if it begins a word (to disallow, for
1146 ;; example, matching cid:).
1148 ;; If the term starts with a ", then parse Xapian's quoted boolean
1149 ;; term syntax, which allows for anything as long as embedded
1150 ;; double quotes escaped by doubling them. We also disallow
1151 ;; newlines (which Xapian allows) to prevent runaway terms.
1152 "\"\\([^\"\n]\\|\"\"\\)*\""
1153 ;; Otherwise, parse Xapian's unquoted syntax, which goes up to the
1154 ;; next space or ). We disallow [.,;] as the last character
1155 ;; because these are probably part of the surrounding text, and not
1156 ;; part of the id. This doesn't match single character ids; meh.
1157 "\\|[^\"[:space:])][^[:space:])]*[^])[:space:].,:;?!]"
1159 "The regexp used to match id: links in messages.")
1161 (defvar notmuch-mid-regexp
1162 ;; goto-address-url-regexp matched cid: links, which have the same
1163 ;; grammar as the message ID part of a mid: link. Construct the
1164 ;; regexp using the same technique as goto-address-url-regexp.
1165 (concat "\\<mid:\\(" thing-at-point-url-path-regexp "\\)")
1166 "The regexp used to match mid: links in messages.
1170 (defun notmuch-show-buttonise-links (start end)
1171 "Buttonise URLs and mail addresses between START and END.
1173 This also turns id:\"<message id>\"-parts and mid: links into
1174 buttons for a corresponding notmuch search."
1175 (goto-address-fontify-region start end)
1179 (while (re-search-forward notmuch-id-regexp end t)
1180 (push (list (match-beginning 0) (match-end 0)
1181 (match-string-no-properties 0)) links))
1183 (while (re-search-forward notmuch-mid-regexp end t)
1184 (let* ((mid-cid (match-string-no-properties 1))
1185 (mid (save-match-data
1186 (string-match "^[^/]*" mid-cid)
1187 (url-unhex-string (match-string 0 mid-cid)))))
1188 (push (list (match-beginning 0) (match-end 0)
1189 (notmuch-id-to-query mid)) links)))
1190 (dolist (link links)
1191 ;; Remove the overlay created by goto-address-mode
1192 (remove-overlays (first link) (second link) 'goto-address t)
1193 (make-text-button (first link) (second link)
1194 :type 'notmuch-button-type
1195 'action `(lambda (arg)
1196 (notmuch-show ,(third link) current-prefix-arg))
1198 'help-echo "Mouse-1, RET: search for this message"
1199 'face goto-address-mail-face)))))
1202 (defun notmuch-show (thread-id &optional elide-toggle parent-buffer query-context buffer-name)
1203 "Run \"notmuch show\" with the given thread ID and display results.
1205 ELIDE-TOGGLE, if non-nil, inverts the default elide behavior.
1207 The optional PARENT-BUFFER is the notmuch-search buffer from
1208 which this notmuch-show command was executed, (so that the
1209 next thread from that buffer can be show when done with this
1212 The optional QUERY-CONTEXT is a notmuch search term. Only
1213 messages from the thread matching this search term are shown if
1216 The optional BUFFER-NAME provides the name of the buffer in
1217 which the message thread is shown. If it is nil (which occurs
1218 when the command is called interactively) the argument to the
1221 Returns the buffer containing the messages, or NIL if no messages
1223 (interactive "sNotmuch show: \nP")
1224 (let ((buffer-name (generate-new-buffer-name
1226 (concat "*notmuch-" thread-id "*")))))
1227 (switch-to-buffer (get-buffer-create buffer-name))
1228 ;; No need to track undo information for this buffer.
1229 (setq buffer-undo-list t)
1233 ;; Set various buffer local variables to their appropriate initial
1234 ;; state. Do this after enabling `notmuch-show-mode' so that they
1235 ;; aren't wiped out.
1236 (setq notmuch-show-thread-id thread-id
1237 notmuch-show-parent-buffer parent-buffer
1238 notmuch-show-query-context query-context
1240 notmuch-show-process-crypto notmuch-crypto-process-mime
1241 ;; If `elide-toggle', invert the default value.
1242 notmuch-show-elide-non-matching-messages
1244 (not notmuch-show-only-matching-messages)
1245 notmuch-show-only-matching-messages))
1247 (add-hook 'post-command-hook #'notmuch-show-command-hook nil t)
1248 (jit-lock-register #'notmuch-show-buttonise-links)
1250 (notmuch-tag-clear-cache)
1252 (let ((inhibit-read-only t))
1253 (if (notmuch-show--build-buffer)
1254 ;; Messages were inserted into the buffer.
1257 ;; No messages were inserted - presumably none matched the
1259 (kill-buffer (current-buffer))
1261 (message "No messages matched the query!")
1264 (defun notmuch-show--build-buffer (&optional state)
1265 "Display messages matching the current buffer context.
1267 Apply the previously saved STATE if supplied, otherwise show the
1268 first relevant message.
1270 If no messages match the query return NIL."
1271 (let* ((basic-args (list notmuch-show-thread-id))
1272 (args (if notmuch-show-query-context
1273 (append (list "\'") basic-args
1274 (list "and (" notmuch-show-query-context ")\'"))
1275 (append (list "\'") basic-args (list "\'"))))
1276 (cli-args (cons "--exclude=false"
1277 (when notmuch-show-elide-non-matching-messages
1278 (list "--entire-thread=false"))))
1280 (forest (or (notmuch-query-get-threads (append cli-args args))
1281 ;; If a query context reduced the number of
1282 ;; results to zero, try again without it.
1283 (and notmuch-show-query-context
1284 (notmuch-query-get-threads (append cli-args basic-args)))))
1286 ;; Must be reset every time we are going to start inserting
1287 ;; messages into the buffer.
1288 (notmuch-show-previous-subject ""))
1291 (notmuch-show-insert-forest forest)
1293 ;; Store the original tags for each message so that we can
1296 (lambda () (notmuch-show-set-prop :orig-tags (notmuch-show-get-tags))))
1298 ;; Set the header line to the subject of the first message.
1299 (setq header-line-format
1300 (replace-regexp-in-string "%" "%%"
1302 (notmuch-show-strip-re
1303 (notmuch-show-get-subject)))))
1305 (run-hooks 'notmuch-show-hook)
1308 (notmuch-show-apply-state state)
1309 ;; With no state to apply, just go to the first message.
1310 (notmuch-show-goto-first-wanted-message)))
1312 ;; Report back to the caller whether any messages matched.
1315 (defun notmuch-show-capture-state ()
1316 "Capture the state of the current buffer.
1319 - the list of open messages,
1320 - the current message."
1321 (list (notmuch-show-get-message-id) (notmuch-show-get-message-ids-for-open-messages)))
1323 (defun notmuch-show-get-query ()
1324 "Return the current query in this show buffer"
1325 (if notmuch-show-query-context
1326 (concat notmuch-show-thread-id
1328 notmuch-show-query-context
1330 notmuch-show-thread-id))
1332 (defun notmuch-show-goto-message (msg-id)
1333 "Go to message with msg-id."
1334 (goto-char (point-min))
1335 (unless (loop if (string= msg-id (notmuch-show-get-message-id))
1337 until (not (notmuch-show-goto-message-next)))
1338 (goto-char (point-min))
1339 (message "Message-id not found."))
1340 (notmuch-show-message-adjust))
1342 (defun notmuch-show-apply-state (state)
1343 "Apply STATE to the current buffer.
1346 - opening the messages previously opened,
1347 - closing all other messages,
1348 - moving to the correct current message."
1349 (let ((current (car state))
1350 (open (cadr state)))
1352 ;; Open those that were open.
1353 (goto-char (point-min))
1354 (loop do (notmuch-show-message-visible (notmuch-show-get-message-properties)
1355 (member (notmuch-show-get-message-id) open))
1356 until (not (notmuch-show-goto-message-next)))
1358 ;; Go to the previously open message.
1359 (notmuch-show-goto-message current)))
1361 (defun notmuch-show-refresh-view (&optional reset-state)
1362 "Refresh the current view.
1364 Refreshes the current view, observing changes in display
1365 preferences. If invoked with a prefix argument (or RESET-STATE is
1366 non-nil) then the state of the buffer (open/closed messages) is
1367 reset based on the original query."
1369 (let ((inhibit-read-only t)
1370 (state (unless reset-state
1371 (notmuch-show-capture-state))))
1372 ;; `erase-buffer' does not seem to remove overlays, which can lead
1373 ;; to weird effects such as remaining images, so remove them
1378 (unless (notmuch-show--build-buffer state)
1379 ;; No messages were inserted.
1380 (kill-buffer (current-buffer))
1382 (message "Refreshing the buffer resulted in no messages!"))))
1384 (defvar notmuch-show-stash-map
1385 (let ((map (make-sparse-keymap)))
1386 (define-key map "c" 'notmuch-show-stash-cc)
1387 (define-key map "d" 'notmuch-show-stash-date)
1388 (define-key map "F" 'notmuch-show-stash-filename)
1389 (define-key map "f" 'notmuch-show-stash-from)
1390 (define-key map "i" 'notmuch-show-stash-message-id)
1391 (define-key map "I" 'notmuch-show-stash-message-id-stripped)
1392 (define-key map "s" 'notmuch-show-stash-subject)
1393 (define-key map "T" 'notmuch-show-stash-tags)
1394 (define-key map "t" 'notmuch-show-stash-to)
1395 (define-key map "l" 'notmuch-show-stash-mlarchive-link)
1396 (define-key map "L" 'notmuch-show-stash-mlarchive-link-and-go)
1397 (define-key map "G" 'notmuch-show-stash-git-send-email)
1398 (define-key map "?" 'notmuch-subkeymap-help)
1400 "Submap for stash commands")
1401 (fset 'notmuch-show-stash-map notmuch-show-stash-map)
1403 (defvar notmuch-show-part-map
1404 (let ((map (make-sparse-keymap)))
1405 (define-key map "s" 'notmuch-show-save-part)
1406 (define-key map "v" 'notmuch-show-view-part)
1407 (define-key map "o" 'notmuch-show-interactively-view-part)
1408 (define-key map "|" 'notmuch-show-pipe-part)
1409 (define-key map "m" 'notmuch-show-choose-mime-of-part)
1410 (define-key map "?" 'notmuch-subkeymap-help)
1412 "Submap for part commands")
1413 (fset 'notmuch-show-part-map notmuch-show-part-map)
1415 (defvar notmuch-show-mode-map
1416 (let ((map (make-sparse-keymap)))
1417 (set-keymap-parent map notmuch-common-keymap)
1418 (define-key map "Z" 'notmuch-tree-from-show-current-query)
1419 (define-key map (kbd "<C-tab>") 'widget-backward)
1420 (define-key map (kbd "M-TAB") 'notmuch-show-previous-button)
1421 (define-key map (kbd "<backtab>") 'notmuch-show-previous-button)
1422 (define-key map (kbd "TAB") 'notmuch-show-next-button)
1423 (define-key map "f" 'notmuch-show-forward-message)
1424 (define-key map "F" 'notmuch-show-forward-open-messages)
1425 (define-key map "b" 'notmuch-show-resend-message)
1426 (define-key map "l" 'notmuch-show-filter-thread)
1427 (define-key map "r" 'notmuch-show-reply-sender)
1428 (define-key map "R" 'notmuch-show-reply)
1429 (define-key map "|" 'notmuch-show-pipe-message)
1430 (define-key map "w" 'notmuch-show-save-attachments)
1431 (define-key map "V" 'notmuch-show-view-raw-message)
1432 (define-key map "c" 'notmuch-show-stash-map)
1433 (define-key map "h" 'notmuch-show-toggle-visibility-headers)
1434 (define-key map "*" 'notmuch-show-tag-all)
1435 (define-key map "-" 'notmuch-show-remove-tag)
1436 (define-key map "+" 'notmuch-show-add-tag)
1437 (define-key map "X" 'notmuch-show-archive-thread-then-exit)
1438 (define-key map "x" 'notmuch-show-archive-message-then-next-or-exit)
1439 (define-key map "A" 'notmuch-show-archive-thread-then-next)
1440 (define-key map "a" 'notmuch-show-archive-message-then-next-or-next-thread)
1441 (define-key map "N" 'notmuch-show-next-message)
1442 (define-key map "P" 'notmuch-show-previous-message)
1443 (define-key map "n" 'notmuch-show-next-open-message)
1444 (define-key map "p" 'notmuch-show-previous-open-message)
1445 (define-key map (kbd "M-n") 'notmuch-show-next-thread-show)
1446 (define-key map (kbd "M-p") 'notmuch-show-previous-thread-show)
1447 (define-key map (kbd "DEL") 'notmuch-show-rewind)
1448 (define-key map " " 'notmuch-show-advance-and-archive)
1449 (define-key map (kbd "M-RET") 'notmuch-show-open-or-close-all)
1450 (define-key map (kbd "RET") 'notmuch-show-toggle-message)
1451 (define-key map "#" 'notmuch-show-print-message)
1452 (define-key map "!" 'notmuch-show-toggle-elide-non-matching)
1453 (define-key map "$" 'notmuch-show-toggle-process-crypto)
1454 (define-key map "<" 'notmuch-show-toggle-thread-indentation)
1455 (define-key map "t" 'toggle-truncate-lines)
1456 (define-key map "." 'notmuch-show-part-map)
1458 "Keymap for \"notmuch show\" buffers.")
1459 (fset 'notmuch-show-mode-map notmuch-show-mode-map)
1461 (define-derived-mode notmuch-show-mode fundamental-mode "notmuch-show"
1462 "Major mode for viewing a thread with notmuch.
1464 This buffer contains the results of the \"notmuch show\" command
1465 for displaying a single thread of email from your email archives.
1467 By default, various components of email messages, (citations,
1468 signatures, already-read messages), are hidden. You can make
1469 these parts visible by clicking with the mouse button or by
1470 pressing RET after positioning the cursor on a hidden part, (for
1471 which \\[notmuch-show-next-button] and \\[notmuch-show-previous-button] are helpful).
1473 Reading the thread sequentially is well-supported by pressing
1474 \\[notmuch-show-advance-and-archive]. This will scroll the current message (if necessary), advance
1475 to the next message, or advance to the next thread (if already on
1476 the last message of a thread).
1478 Other commands are available to read or manipulate the thread
1479 more selectively, (such as '\\[notmuch-show-next-message]' and '\\[notmuch-show-previous-message]' to advance to messages
1480 without removing any tags, and '\\[notmuch-show-archive-thread]' to archive an entire thread
1481 without scrolling through with \\[notmuch-show-advance-and-archive]).
1483 You can add or remove arbitrary tags from the current message with
1484 '\\[notmuch-show-add-tag]' or '\\[notmuch-show-remove-tag]'.
1486 All currently available key bindings:
1488 \\{notmuch-show-mode-map}"
1489 (setq notmuch-buffer-refresh-function #'notmuch-show-refresh-view)
1490 (setq buffer-read-only t
1493 (defun notmuch-tree-from-show-current-query ()
1494 "Call notmuch tree with the current query"
1496 (notmuch-tree notmuch-show-thread-id
1497 notmuch-show-query-context
1498 (notmuch-show-get-message-id)))
1500 (defun notmuch-show-move-to-message-top ()
1501 (goto-char (notmuch-show-message-top)))
1503 (defun notmuch-show-move-to-message-bottom ()
1504 (goto-char (notmuch-show-message-bottom)))
1506 (defun notmuch-show-message-adjust ()
1509 ;; Movement related functions.
1511 ;; There's some strangeness here where a text property applied to a
1512 ;; region a->b is not found when point is at b. We walk backwards
1513 ;; until finding the property.
1514 (defun notmuch-show-message-extent ()
1517 (while (not (setq r (get-text-property (point) :notmuch-message-extent)))
1521 (defun notmuch-show-message-top ()
1522 (car (notmuch-show-message-extent)))
1524 (defun notmuch-show-message-bottom ()
1525 (cdr (notmuch-show-message-extent)))
1527 (defun notmuch-show-goto-message-next ()
1528 (let ((start (point)))
1529 (notmuch-show-move-to-message-bottom)
1535 (defun notmuch-show-goto-message-previous ()
1536 (notmuch-show-move-to-message-top)
1540 (notmuch-show-move-to-message-top)
1543 (defun notmuch-show-mapc (function)
1544 "Iterate through all messages in the current thread with
1545 `notmuch-show-goto-message-next' and call FUNCTION for side
1548 (goto-char (point-min))
1549 (loop do (funcall function)
1550 while (notmuch-show-goto-message-next))))
1552 ;; Functions relating to the visibility of messages and their
1555 (defun notmuch-show-message-visible (props visible-p)
1556 (overlay-put (plist-get props :message-overlay) 'invisible (not visible-p))
1557 (notmuch-show-set-prop :message-visible visible-p props))
1559 (defun notmuch-show-headers-visible (props visible-p)
1560 (overlay-put (plist-get props :headers-overlay) 'invisible (not visible-p))
1561 (notmuch-show-set-prop :headers-visible visible-p props))
1563 ;; Functions for setting and getting attributes of the current
1566 (defun notmuch-show-set-message-properties (props)
1568 (notmuch-show-move-to-message-top)
1569 (put-text-property (point) (+ (point) 1) :notmuch-message-properties props)))
1571 (defun notmuch-show-get-message-properties ()
1572 "Return the properties of the current message as a plist.
1574 Some useful entries are:
1575 :headers - Property list containing the headers :Date, :Subject, :From, etc.
1576 :body - Body of the message
1577 :tags - Tags for this message"
1579 (notmuch-show-move-to-message-top)
1580 (get-text-property (point) :notmuch-message-properties)))
1582 (defun notmuch-show-get-part-properties ()
1583 "Return the properties of the innermost part containing point.
1585 This is the part property list retrieved from the CLI. Signals
1586 an error if there is no part containing point."
1587 (or (get-text-property (point) :notmuch-part)
1588 (error "No message part here")))
1590 (defun notmuch-show-set-prop (prop val &optional props)
1591 (let ((inhibit-read-only t)
1593 (notmuch-show-get-message-properties))))
1594 (plist-put props prop val)
1595 (notmuch-show-set-message-properties props)))
1597 (defun notmuch-show-get-prop (prop &optional props)
1598 "Get property PROP from current message in show or tree mode.
1600 It gets property PROP from PROPS or, if PROPS is nil, the current
1601 message in either tree or show. This means that several utility
1602 functions in notmuch-show can be used directly by notmuch-tree as
1603 they just need the correct message properties."
1604 (let ((props (or props
1605 (cond ((eq major-mode 'notmuch-show-mode)
1606 (notmuch-show-get-message-properties))
1607 ((eq major-mode 'notmuch-tree-mode)
1608 (notmuch-tree-get-message-properties))
1610 (plist-get props prop)))
1612 (defun notmuch-show-get-message-id (&optional bare)
1613 "Return an id: query for the Message-Id of the current message.
1615 If optional argument BARE is non-nil, return
1616 the Message-Id without id: prefix and escaping."
1618 (notmuch-show-get-prop :id)
1619 (notmuch-id-to-query (notmuch-show-get-prop :id))))
1621 (defun notmuch-show-get-messages-ids ()
1622 "Return all id: queries of messages in the current thread."
1623 (let ((message-ids))
1625 (lambda () (push (notmuch-show-get-message-id) message-ids)))
1628 (defun notmuch-show-get-messages-ids-search ()
1629 "Return a search string for all message ids of messages in the
1631 (mapconcat 'identity (notmuch-show-get-messages-ids) " or "))
1633 ;; dme: Would it make sense to use a macro for many of these?
1635 (defun notmuch-show-get-filename ()
1636 "Return the filename of the current message."
1637 (notmuch-show-get-prop :filename))
1639 (defun notmuch-show-get-header (header &optional props)
1640 "Return the named header of the current message, if any."
1641 (plist-get (notmuch-show-get-prop :headers props) header))
1643 (defun notmuch-show-get-cc ()
1644 (notmuch-show-get-header :Cc))
1646 (defun notmuch-show-get-date ()
1647 (notmuch-show-get-header :Date))
1649 (defun notmuch-show-get-from ()
1650 (notmuch-show-get-header :From))
1652 (defun notmuch-show-get-subject ()
1653 (notmuch-show-get-header :Subject))
1655 (defun notmuch-show-get-to ()
1656 (notmuch-show-get-header :To))
1658 (defun notmuch-show-get-depth ()
1659 (notmuch-show-get-prop :depth))
1661 (defun notmuch-show-set-tags (tags)
1662 "Set the tags of the current message."
1663 (notmuch-show-set-prop :tags tags)
1664 (notmuch-show-update-tags tags))
1666 (defun notmuch-show-get-tags ()
1667 "Return the tags of the current message."
1668 (notmuch-show-get-prop :tags))
1670 (defun notmuch-show-message-visible-p ()
1671 "Is the current message visible?"
1672 (notmuch-show-get-prop :message-visible))
1674 (defun notmuch-show-headers-visible-p ()
1675 "Are the headers of the current message visible?"
1676 (notmuch-show-get-prop :headers-visible))
1678 (put 'notmuch-show-mark-read 'notmuch-prefix-doc
1679 "Mark the current message as unread.")
1680 (defun notmuch-show-mark-read (&optional unread)
1681 "Mark the current message as read.
1683 Mark the current message as read by applying the tag changes in
1684 `notmuch-show-mark-read-tags' to it (remove the \"unread\" tag by
1685 default). If a prefix argument is given, the message will be
1686 marked as unread, i.e. the tag changes in
1687 `notmuch-show-mark-read-tags' will be reversed."
1689 (when notmuch-show-mark-read-tags
1690 (apply 'notmuch-show-tag-message
1691 (notmuch-tag-change-list notmuch-show-mark-read-tags unread))))
1693 (defun notmuch-show-seen-current-message (start end)
1694 "Mark the current message read if it is open.
1696 We only mark it read once: if it is changed back then that is a
1697 user decision and we should not override it."
1698 (when (and (notmuch-show-message-visible-p)
1699 (not (notmuch-show-get-prop :seen)))
1700 (notmuch-show-mark-read)
1701 (notmuch-show-set-prop :seen t)))
1703 (defvar notmuch-show--seen-has-errored nil)
1704 (make-variable-buffer-local 'notmuch-show--seen-has-errored)
1706 (defun notmuch-show-command-hook ()
1707 (when (eq major-mode 'notmuch-show-mode)
1708 ;; We need to redisplay to get window-start and window-end correct.
1712 (funcall notmuch-show-mark-read-function (window-start) (window-end))
1714 (unless notmuch-show--seen-has-errored
1715 (setq notmuch-show--seen-has-errored 't)
1716 (setq header-line-format
1717 (concat header-line-format
1718 (propertize " [some mark read tag changes may have failed]"
1719 'face font-lock-warning-face)))))))))
1721 (defun notmuch-show-filter-thread (query)
1722 "Filter or LIMIT the current thread based on a new query string.
1724 Reshows the current thread with matches defined by the new query-string."
1725 (interactive (list (notmuch-read-query "Filter thread: ")))
1726 (let ((msg-id (notmuch-show-get-message-id)))
1727 (setq notmuch-show-query-context (if (string= query "") nil query))
1728 (notmuch-show-refresh-view t)
1729 (notmuch-show-goto-message msg-id)))
1731 ;; Functions for getting attributes of several messages in the current
1734 (defun notmuch-show-get-message-ids-for-open-messages ()
1735 "Return a list of all id: queries for open messages in the current thread."
1737 (let (message-ids done)
1738 (goto-char (point-min))
1740 (if (notmuch-show-message-visible-p)
1741 (setq message-ids (append message-ids (list (notmuch-show-get-message-id)))))
1742 (setq done (not (notmuch-show-goto-message-next)))
1747 ;; Commands typically bound to keys.
1749 (defun notmuch-show-advance ()
1750 "Advance through thread.
1752 If the current message in the thread is not yet fully visible,
1753 scroll by a near screenful to read more of the message.
1755 Otherwise, (the end of the current message is already within the
1756 current window), advance to the next open message."
1758 (let* ((end-of-this-message (notmuch-show-message-bottom))
1759 (visible-end-of-this-message (1- end-of-this-message))
1761 (while (invisible-p visible-end-of-this-message)
1762 (setq visible-end-of-this-message
1764 (1- (previous-single-char-property-change
1765 visible-end-of-this-message 'invisible)))))
1767 ;; Ideally we would test `end-of-this-message' against the result
1768 ;; of `window-end', but that doesn't account for the fact that
1769 ;; the end of the message might be hidden.
1770 ((and visible-end-of-this-message
1771 (> visible-end-of-this-message (window-end)))
1772 ;; The bottom of this message is not visible - scroll.
1775 ((not (= end-of-this-message (point-max)))
1776 ;; This is not the last message - move to the next visible one.
1777 (notmuch-show-next-open-message))
1779 ((not (= (point) (point-max)))
1780 ;; This is the last message, but the cursor is not at the end of
1781 ;; the buffer. Move it there.
1782 (goto-char (point-max)))
1785 ;; This is the last message - change the return value
1789 (defun notmuch-show-advance-and-archive ()
1790 "Advance through thread and archive.
1792 This command is intended to be one of the simplest ways to
1793 process a thread of email. It works exactly like
1794 notmuch-show-advance, in that it scrolls through messages in a
1795 show buffer, except that when it gets to the end of the buffer it
1796 archives the entire current thread, (apply changes in
1797 `notmuch-archive-tags'), kills the buffer, and displays the next
1798 thread from the search from which this thread was originally
1801 (if (notmuch-show-advance)
1802 (notmuch-show-archive-thread-then-next)))
1804 (defun notmuch-show-rewind ()
1805 "Backup through the thread (reverse scrolling compared to \\[notmuch-show-advance-and-archive]).
1807 Specifically, if the beginning of the previous email is fewer
1808 than `window-height' lines from the current point, move to it
1809 just like `notmuch-show-previous-message'.
1811 Otherwise, just scroll down a screenful of the current message.
1813 This command does not modify any message tags, (it does not undo
1814 any effects from previous calls to
1815 `notmuch-show-advance-and-archive'."
1817 (let ((start-of-message (notmuch-show-message-top))
1818 (start-of-window (window-start)))
1820 ;; Either this message is properly aligned with the start of the
1821 ;; window or the start of this message is not visible on the
1823 ((or (= start-of-message start-of-window)
1824 (< start-of-message start-of-window))
1826 ;; If a small number of lines from the previous message are
1827 ;; visible, realign so that the top of the current message is at
1828 ;; the top of the screen.
1829 (when (<= (count-screen-lines (window-start) start-of-message)
1830 next-screen-context-lines)
1831 (goto-char (notmuch-show-message-top))
1832 (notmuch-show-message-adjust))
1833 ;; Move to the top left of the window.
1834 (goto-char (window-start)))
1836 ;; Move to the previous message.
1837 (notmuch-show-previous-message)))))
1839 (put 'notmuch-show-reply 'notmuch-prefix-doc "... and prompt for sender")
1840 (defun notmuch-show-reply (&optional prompt-for-sender)
1841 "Reply to the sender and all recipients of the current message."
1843 (notmuch-mua-new-reply (notmuch-show-get-message-id) prompt-for-sender t))
1845 (put 'notmuch-show-reply-sender 'notmuch-prefix-doc "... and prompt for sender")
1846 (defun notmuch-show-reply-sender (&optional prompt-for-sender)
1847 "Reply to the sender of the current message."
1849 (notmuch-mua-new-reply (notmuch-show-get-message-id) prompt-for-sender nil))
1851 (put 'notmuch-show-forward-message 'notmuch-prefix-doc
1852 "... and prompt for sender")
1853 (defun notmuch-show-forward-message (&optional prompt-for-sender)
1854 "Forward the current message."
1856 (notmuch-mua-new-forward-messages (list (notmuch-show-get-message-id))
1859 (put 'notmuch-show-forward-open-messages 'notmuch-prefix-doc
1860 "... and prompt for sender")
1861 (defun notmuch-show-forward-open-messages (&optional prompt-for-sender)
1862 "Forward the currently open messages."
1864 (let ((open-messages (notmuch-show-get-message-ids-for-open-messages)))
1865 (unless open-messages
1866 (error "No open messages to forward."))
1867 (notmuch-mua-new-forward-messages open-messages prompt-for-sender)))
1869 (defun notmuch-show-resend-message (addresses)
1870 "Resend the current message."
1871 (interactive (list (notmuch-address-from-minibuffer "Resend to: ")))
1872 (when (y-or-n-p (concat "Confirm resend to " addresses " "))
1873 (notmuch-show-view-raw-message)
1874 (message-resend addresses)
1875 (notmuch-bury-or-kill-this-buffer)))
1877 (defun notmuch-show-next-message (&optional pop-at-end)
1878 "Show the next message.
1880 If a prefix argument is given and this is the last message in the
1881 thread, navigate to the next thread in the parent search buffer."
1883 (if (notmuch-show-goto-message-next)
1884 (notmuch-show-message-adjust)
1886 (notmuch-show-next-thread)
1887 (goto-char (point-max)))))
1889 (defun notmuch-show-previous-message ()
1890 "Show the previous message or the start of the current message."
1892 (if (= (point) (notmuch-show-message-top))
1893 (notmuch-show-goto-message-previous)
1894 (notmuch-show-move-to-message-top))
1895 (notmuch-show-message-adjust))
1897 (defun notmuch-show-next-open-message (&optional pop-at-end)
1898 "Show the next open message.
1900 If a prefix argument is given and this is the last open message
1901 in the thread, navigate to the next thread in the parent search
1902 buffer. Return t if there was a next open message in the thread
1903 to show, nil otherwise."
1906 (while (and (setq r (notmuch-show-goto-message-next))
1907 (not (notmuch-show-message-visible-p))))
1909 (notmuch-show-message-adjust)
1911 (notmuch-show-next-thread)
1912 (goto-char (point-max))))
1915 (defun notmuch-show-next-matching-message ()
1916 "Show the next matching message."
1919 (while (and (setq r (notmuch-show-goto-message-next))
1920 (not (notmuch-show-get-prop :match))))
1922 (notmuch-show-message-adjust)
1923 (goto-char (point-max)))))
1925 (defun notmuch-show-open-if-matched ()
1926 "Open a message if it is matched (whether or not excluded)."
1927 (let ((props (notmuch-show-get-message-properties)))
1928 (notmuch-show-message-visible props (plist-get props :match))))
1930 (defun notmuch-show-goto-first-wanted-message ()
1931 "Move to the first open message and mark it read"
1932 (goto-char (point-min))
1933 (unless (notmuch-show-message-visible-p)
1934 (notmuch-show-next-open-message))
1936 ;; There are no matched non-excluded messages so open all matched
1937 ;; (necessarily excluded) messages and go to the first.
1938 (notmuch-show-mapc 'notmuch-show-open-if-matched)
1939 (force-window-update)
1940 (goto-char (point-min))
1941 (unless (notmuch-show-message-visible-p)
1942 (notmuch-show-next-open-message))))
1944 (defun notmuch-show-previous-open-message ()
1945 "Show the previous open message."
1947 (while (and (if (= (point) (notmuch-show-message-top))
1948 (notmuch-show-goto-message-previous)
1949 (notmuch-show-move-to-message-top))
1950 (not (notmuch-show-message-visible-p))))
1951 (notmuch-show-message-adjust))
1953 (defun notmuch-show-view-raw-message ()
1954 "View the original source of the current message."
1956 (let* ((id (notmuch-show-get-message-id))
1957 (buf (get-buffer-create (concat "*notmuch-raw-" id "*")))
1958 (inhibit-read-only t))
1959 (switch-to-buffer buf)
1961 (let ((coding-system-for-read 'no-conversion))
1962 (call-process notmuch-command nil t nil "show" "--format=raw" id))
1963 (goto-char (point-min))
1964 (set-buffer-modified-p nil)
1965 (setq buffer-read-only t)
1966 (view-buffer buf 'kill-buffer-if-not-modified)))
1968 (put 'notmuch-show-pipe-message 'notmuch-doc
1969 "Pipe the contents of the current message to a command.")
1970 (put 'notmuch-show-pipe-message 'notmuch-prefix-doc
1971 "Pipe the thread as an mbox to a command.")
1972 (defun notmuch-show-pipe-message (entire-thread command)
1973 "Pipe the contents of the current message (or thread) to COMMAND.
1975 COMMAND will be executed with the raw contents of the current
1976 email message as stdin. Anything printed by the command to stdout
1977 or stderr will appear in the *notmuch-pipe* buffer.
1979 If ENTIRE-THREAD is non-nil (or when invoked with a prefix
1980 argument), COMMAND will receive all open messages in the current
1981 thread (formatted as an mbox) rather than only the current
1983 (interactive (let ((query-string (if current-prefix-arg
1984 "Pipe all open messages to command: "
1985 "Pipe message to command: ")))
1986 (list current-prefix-arg (read-string query-string))))
1987 (let (shell-command)
1990 (concat notmuch-command " show --format=mbox --exclude=false "
1991 (shell-quote-argument
1992 (mapconcat 'identity (notmuch-show-get-message-ids-for-open-messages) " OR "))
1995 (concat notmuch-command " show --format=raw "
1996 (shell-quote-argument (notmuch-show-get-message-id)) " | " command)))
1997 (let ((cwd default-directory)
1998 (buf (get-buffer-create (concat "*notmuch-pipe*"))))
1999 (with-current-buffer buf
2000 (setq buffer-read-only nil)
2002 ;; Use the originating buffer's working directory instead of
2003 ;; that of the pipe buffer.
2005 (let ((exit-code (call-process-shell-command shell-command nil buf)))
2006 (goto-char (point-max))
2007 (set-buffer-modified-p nil)
2008 (setq buffer-read-only t)
2009 (unless (zerop exit-code)
2010 (switch-to-buffer-other-window buf)
2011 (message (format "Command '%s' exited abnormally with code %d"
2012 shell-command exit-code))))))))
2014 (defun notmuch-show-tag-message (&rest tag-changes)
2015 "Change tags for the current message.
2017 TAG-CHANGES is a list of tag operations for `notmuch-tag'."
2018 (let* ((current-tags (notmuch-show-get-tags))
2019 (new-tags (notmuch-update-tags current-tags tag-changes)))
2020 (unless (equal current-tags new-tags)
2021 (notmuch-tag (notmuch-show-get-message-id) tag-changes)
2022 (notmuch-show-set-tags new-tags))))
2024 (defun notmuch-show-tag (tag-changes)
2025 "Change tags for the current message.
2027 See `notmuch-tag' for information on the format of TAG-CHANGES."
2028 (interactive (list (notmuch-read-tag-changes (notmuch-show-get-tags)
2030 (notmuch-tag (notmuch-show-get-message-id) tag-changes)
2031 (let* ((current-tags (notmuch-show-get-tags))
2032 (new-tags (notmuch-update-tags current-tags tag-changes)))
2033 (unless (equal current-tags new-tags)
2034 (notmuch-show-set-tags new-tags))))
2036 (defun notmuch-show-tag-all (tag-changes)
2037 "Change tags for all messages in the current show buffer.
2039 See `notmuch-tag' for information on the format of TAG-CHANGES."
2043 (lambda () (setq tags (append (notmuch-show-get-tags) tags))))
2044 (notmuch-read-tag-changes tags "Tag thread"))))
2045 (notmuch-tag (notmuch-show-get-messages-ids-search) tag-changes)
2048 (let* ((current-tags (notmuch-show-get-tags))
2049 (new-tags (notmuch-update-tags current-tags tag-changes)))
2050 (unless (equal current-tags new-tags)
2051 (notmuch-show-set-tags new-tags))))))
2053 (defun notmuch-show-add-tag (tag-changes)
2054 "Change tags for the current message (defaulting to add).
2056 Same as `notmuch-show-tag' but sets initial input to '+'."
2058 (list (notmuch-read-tag-changes (notmuch-show-get-tags) "Tag message" "+")))
2059 (notmuch-show-tag tag-changes))
2061 (defun notmuch-show-remove-tag (tag-changes)
2062 "Change tags for the current message (defaulting to remove).
2064 Same as `notmuch-show-tag' but sets initial input to '-'."
2066 (list (notmuch-read-tag-changes (notmuch-show-get-tags) "Tag message" "-")))
2067 (notmuch-show-tag tag-changes))
2069 (defun notmuch-show-toggle-visibility-headers ()
2070 "Toggle the visibility of the current message headers."
2072 (let ((props (notmuch-show-get-message-properties)))
2073 (notmuch-show-headers-visible
2075 (not (plist-get props :headers-visible))))
2076 (force-window-update))
2078 (defun notmuch-show-toggle-message ()
2079 "Toggle the visibility of the current message."
2081 (let ((props (notmuch-show-get-message-properties)))
2082 (notmuch-show-message-visible
2084 (not (plist-get props :message-visible))))
2085 (force-window-update))
2087 (put 'notmuch-show-open-or-close-all 'notmuch-doc "Show all messages.")
2088 (put 'notmuch-show-open-or-close-all 'notmuch-prefix-doc "Hide all messages.")
2089 (defun notmuch-show-open-or-close-all ()
2090 "Set the visibility all of the messages in the current thread.
2092 By default make all of the messages visible. With a prefix
2093 argument, hide all of the messages."
2096 (goto-char (point-min))
2097 (loop do (notmuch-show-message-visible (notmuch-show-get-message-properties)
2098 (not current-prefix-arg))
2099 until (not (notmuch-show-goto-message-next))))
2100 (force-window-update))
2102 (defun notmuch-show-next-button ()
2103 "Advance point to the next button in the buffer."
2107 (defun notmuch-show-previous-button ()
2108 "Move point back to the previous button in the buffer."
2110 (backward-button 1))
2112 (defun notmuch-show-next-thread (&optional show previous)
2113 "Move to the next item in the search results, if any.
2115 If SHOW is non-nil, open the next item in a show
2116 buffer. Otherwise just highlight the next item in the search
2117 buffer. If PREVIOUS is non-nil, move to the previous item in the
2118 search results instead."
2120 (let ((parent-buffer notmuch-show-parent-buffer))
2121 (notmuch-bury-or-kill-this-buffer)
2122 (when (buffer-live-p parent-buffer)
2123 (switch-to-buffer parent-buffer)
2125 (notmuch-search-previous-thread)
2126 (notmuch-search-next-thread))
2128 (notmuch-search-show-thread)))))
2130 (defun notmuch-show-next-thread-show ()
2131 "Show the next thread in the search results, if any."
2133 (notmuch-show-next-thread t))
2135 (defun notmuch-show-previous-thread-show ()
2136 "Show the previous thread in the search results, if any."
2138 (notmuch-show-next-thread t t))
2140 (put 'notmuch-show-archive-thread 'notmuch-prefix-doc
2141 "Un-archive each message in thread.")
2142 (defun notmuch-show-archive-thread (&optional unarchive)
2143 "Archive each message in thread.
2145 Archive each message currently shown by applying the tag changes
2146 in `notmuch-archive-tags' to each. If a prefix argument is given,
2147 the messages will be \"unarchived\", i.e. the tag changes in
2148 `notmuch-archive-tags' will be reversed.
2150 Note: This command is safe from any race condition of new messages
2151 being delivered to the same thread. It does not archive the
2152 entire thread, but only the messages shown in the current
2155 (when notmuch-archive-tags
2156 (notmuch-show-tag-all
2157 (notmuch-tag-change-list notmuch-archive-tags unarchive))))
2159 (defun notmuch-show-archive-thread-then-next ()
2160 "Archive all messages in the current buffer, then show next thread from search."
2162 (notmuch-show-archive-thread)
2163 (notmuch-show-next-thread t))
2165 (defun notmuch-show-archive-thread-then-exit ()
2166 "Archive all messages in the current buffer, then exit back to search results."
2168 (notmuch-show-archive-thread)
2169 (notmuch-show-next-thread))
2171 (put 'notmuch-show-archive-message 'notmuch-prefix-doc
2172 "Un-archive the current message.")
2173 (defun notmuch-show-archive-message (&optional unarchive)
2174 "Archive the current message.
2176 Archive the current message by applying the tag changes in
2177 `notmuch-archive-tags' to it. If a prefix argument is given, the
2178 message will be \"unarchived\", i.e. the tag changes in
2179 `notmuch-archive-tags' will be reversed."
2181 (when notmuch-archive-tags
2182 (apply 'notmuch-show-tag-message
2183 (notmuch-tag-change-list notmuch-archive-tags unarchive))))
2185 (defun notmuch-show-archive-message-then-next-or-exit ()
2186 "Archive the current message, then show the next open message in the current thread.
2188 If at the last open message in the current thread, then exit back
2191 (notmuch-show-archive-message)
2192 (notmuch-show-next-open-message t))
2194 (defun notmuch-show-archive-message-then-next-or-next-thread ()
2195 "Archive the current message, then show the next open message in the current thread.
2197 If at the last open message in the current thread, then show next
2198 thread from search."
2200 (notmuch-show-archive-message)
2201 (unless (notmuch-show-next-open-message)
2202 (notmuch-show-next-thread t)))
2204 (defun notmuch-show-stash-cc ()
2205 "Copy CC field of current message to kill-ring."
2207 (notmuch-common-do-stash (notmuch-show-get-cc)))
2209 (defun notmuch-show-stash-date ()
2210 "Copy date of current message to kill-ring."
2212 (notmuch-common-do-stash (notmuch-show-get-date)))
2214 (defun notmuch-show-stash-filename ()
2215 "Copy filename of current message to kill-ring."
2217 (notmuch-common-do-stash (notmuch-show-get-filename)))
2219 (defun notmuch-show-stash-from ()
2220 "Copy From address of current message to kill-ring."
2222 (notmuch-common-do-stash (notmuch-show-get-from)))
2224 (put 'notmuch-show-stash-message-id 'notmuch-prefix-doc
2225 "Copy thread: query matching current thread to kill-ring.")
2226 (defun notmuch-show-stash-message-id (&optional stash-thread-id)
2227 "Copy id: query matching the current message to kill-ring.
2229 If invoked with a prefix argument (or STASH-THREAD-ID is
2230 non-nil), copy thread: query matching the current thread to
2234 (notmuch-common-do-stash notmuch-show-thread-id)
2235 (notmuch-common-do-stash (notmuch-show-get-message-id))))
2237 (defun notmuch-show-stash-message-id-stripped ()
2238 "Copy message ID of current message (sans `id:' prefix) to kill-ring."
2240 (notmuch-common-do-stash (notmuch-show-get-message-id t)))
2242 (defun notmuch-show-stash-subject ()
2243 "Copy Subject field of current message to kill-ring."
2245 (notmuch-common-do-stash (notmuch-show-get-subject)))
2247 (defun notmuch-show-stash-tags ()
2248 "Copy tags of current message to kill-ring as a comma separated list."
2250 (notmuch-common-do-stash (mapconcat 'identity (notmuch-show-get-tags) ",")))
2252 (defun notmuch-show-stash-to ()
2253 "Copy To address of current message to kill-ring."
2255 (notmuch-common-do-stash (notmuch-show-get-to)))
2257 (defun notmuch-show-stash-mlarchive-link (&optional mla)
2258 "Copy an ML Archive URI for the current message to the kill-ring.
2260 This presumes that the message is available at the selected Mailing List Archive.
2262 If optional argument MLA is non-nil, use the provided key instead of prompting
2263 the user (see `notmuch-show-stash-mlarchive-link-alist')."
2265 (let ((url (cdr (assoc
2267 (let ((completion-ignore-case t))
2269 "Mailing List Archive: "
2270 notmuch-show-stash-mlarchive-link-alist
2272 notmuch-show-stash-mlarchive-link-default)))
2273 notmuch-show-stash-mlarchive-link-alist))))
2274 (notmuch-common-do-stash
2276 (funcall url (notmuch-show-get-message-id t))
2277 (concat url (notmuch-show-get-message-id t))))))
2279 (defun notmuch-show-stash-mlarchive-link-and-go (&optional mla)
2280 "Copy an ML Archive URI for the current message to the kill-ring and visit it.
2282 This presumes that the message is available at the selected Mailing List Archive.
2284 If optional argument MLA is non-nil, use the provided key instead of prompting
2285 the user (see `notmuch-show-stash-mlarchive-link-alist')."
2287 (notmuch-show-stash-mlarchive-link mla)
2288 (browse-url (current-kill 0 t)))
2290 (defun notmuch-show-stash-git-helper (addresses prefix)
2291 "Escape, trim, quote, and add PREFIX to each address in list of ADDRESSES, and return the result as a single string."
2292 (mapconcat (lambda (x)
2294 ;; escape double-quotes
2295 (replace-regexp-in-string
2297 ;; trim leading and trailing spaces
2298 (replace-regexp-in-string
2299 "\\(^ *\\| *$\\)" ""
2303 (put 'notmuch-show-stash-git-send-email 'notmuch-prefix-doc
2304 "Copy From/To/Cc of current message to kill-ring in a form suitable for pasting to git send-email command line.")
2306 (defun notmuch-show-stash-git-send-email (&optional no-in-reply-to)
2307 "Copy From/To/Cc/Message-Id of current message to kill-ring in a form suitable for pasting to git send-email command line.
2309 If invoked with a prefix argument (or NO-IN-REPLY-TO is non-nil),
2310 omit --in-reply-to=<Message-Id>."
2312 (notmuch-common-do-stash
2313 (mapconcat 'identity
2316 (notmuch-show-stash-git-helper
2317 (message-tokenize-header (notmuch-show-get-from)) "--to=")
2318 (notmuch-show-stash-git-helper
2319 (message-tokenize-header (notmuch-show-get-to)) "--to=")
2320 (notmuch-show-stash-git-helper
2321 (message-tokenize-header (notmuch-show-get-cc)) "--cc=")
2322 (unless no-in-reply-to
2323 (notmuch-show-stash-git-helper
2324 (list (notmuch-show-get-message-id t)) "--in-reply-to="))))
2327 ;; Interactive part functions and their helpers
2329 (defun notmuch-show-generate-part-buffer (msg part)
2330 "Return a temporary buffer containing the specified part's content."
2331 (let ((buf (generate-new-buffer " *notmuch-part*"))
2332 (process-crypto notmuch-show-process-crypto))
2333 (with-current-buffer buf
2334 ;; This is always used in the content of mm handles, which
2335 ;; expect undecoded, binary part content.
2336 (insert (notmuch-get-bodypart-binary msg part process-crypto)))
2339 (defun notmuch-show-current-part-handle (&optional mime-type)
2340 "Return an mm-handle for the part containing point.
2342 This creates a temporary buffer for the part's content; the
2343 caller is responsible for killing this buffer as appropriate. If
2344 MIME-TYPE is given then set the handle's mime-type to MIME-TYPE."
2345 (let* ((msg (notmuch-show-get-message-properties))
2346 (part (notmuch-show-get-part-properties))
2347 (buf (notmuch-show-generate-part-buffer msg part))
2348 (computed-type (or mime-type (plist-get part :computed-type)))
2349 (filename (plist-get part :filename))
2350 (disposition (if filename `(attachment (filename . ,filename)))))
2351 (mm-make-handle buf (list computed-type) nil nil disposition)))
2353 (defun notmuch-show-apply-to-current-part-handle (fn &optional mime-type)
2354 "Apply FN to an mm-handle for the part containing point.
2356 This ensures that the temporary buffer created for the mm-handle
2357 is destroyed when FN returns. If MIME-TYPE is given then force
2358 part to be treated as if it had that mime-type."
2359 (let ((handle (notmuch-show-current-part-handle mime-type)))
2360 ;; emacs 24.3+ puts stdout/stderr into the calling buffer so we
2361 ;; call it from a temp-buffer, unless
2362 ;; notmuch-show-attachment-debug is non-nil in which case we put
2363 ;; it in " *notmuch-part*".
2365 (if notmuch-show-attachment-debug
2366 (with-current-buffer (generate-new-buffer " *notmuch-part*")
2367 (funcall fn handle))
2369 (funcall fn handle)))
2370 (kill-buffer (mm-handle-buffer handle)))))
2372 (defun notmuch-show-part-button-default (&optional button)
2374 (let ((button (or button (button-at (point)))))
2375 ;; Try to toggle the part, if that fails then call the default
2376 ;; action. The toggle fails if the part has no emacs renderable
2378 (unless (notmuch-show-toggle-part-invisibility button)
2379 (call-interactively notmuch-show-part-button-default-action))))
2381 (defun notmuch-show-save-part ()
2382 "Save the MIME part containing point to a file."
2384 (notmuch-show-apply-to-current-part-handle #'mm-save-part))
2386 (defun notmuch-show-view-part ()
2387 "View the MIME part containing point in an external viewer."
2389 ;; Set mm-inlined-types to nil to force an external viewer
2390 (let ((mm-inlined-types nil))
2391 (notmuch-show-apply-to-current-part-handle #'mm-display-part)))
2393 (defun notmuch-show-interactively-view-part ()
2394 "View the MIME part containing point, prompting for a viewer."
2396 (notmuch-show-apply-to-current-part-handle #'mm-interactively-view-part))
2398 (defun notmuch-show-pipe-part ()
2399 "Pipe the MIME part containing point to an external command."
2401 (notmuch-show-apply-to-current-part-handle #'mm-pipe-part))
2404 (defun notmuch-show--mm-display-part (handle)
2405 "Use mm-display-part to display HANDLE in a new buffer.
2407 If the part is displayed in an external application then close
2409 (let ((buf (get-buffer-create (generate-new-buffer-name
2410 (concat " *notmuch-internal-part*")))))
2411 (switch-to-buffer buf)
2412 (if (eq (mm-display-part handle) 'external)
2414 (goto-char (point-min))
2415 (set-buffer-modified-p nil)
2416 (view-buffer buf 'kill-buffer-if-not-modified))))
2418 (defun notmuch-show-choose-mime-of-part (mime-type)
2419 "Choose the mime type to use for displaying part"
2421 (list (completing-read "Mime type to use (default text/plain): "
2422 (mailcap-mime-types) nil nil nil nil "text/plain")))
2423 (notmuch-show-apply-to-current-part-handle #'notmuch-show--mm-display-part mime-type))
2425 (provide 'notmuch-show)
2427 ;;; notmuch-show.el ends here