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 <http://www.gnu.org/licenses/>.
21 ;; Authors: Carl Worth <cworth@cworth.org>
22 ;; David Edmondson <dme@dme.org>
24 (eval-when-compile (require 'cl))
32 (require 'notmuch-lib)
33 (require 'notmuch-tag)
34 (require 'notmuch-query)
35 (require 'notmuch-wash)
36 (require 'notmuch-mua)
37 (require 'notmuch-crypto)
38 (require 'notmuch-print)
40 (declare-function notmuch-call-notmuch-process "notmuch" (&rest args))
41 (declare-function notmuch-search-next-thread "notmuch" nil)
42 (declare-function notmuch-search-previous-thread "notmuch" nil)
43 (declare-function notmuch-search-show-thread "notmuch" nil)
44 (declare-function notmuch-foreach-mime-part "notmuch" (function mm-handle))
45 (declare-function notmuch-count-attachments "notmuch" (mm-handle))
46 (declare-function notmuch-save-attachments "notmuch" (mm-handle &optional queryp))
47 (declare-function notmuch-tree "notmuch-tree"
48 (&optional query query-context target buffer-name open-target))
49 (declare-function notmuch-tree-get-message-properties "notmuch-tree" nil)
50 (declare-function notmuch-read-query "notmuch" (prompt))
52 (defcustom notmuch-message-headers '("Subject" "To" "Cc" "Date")
53 "Headers that should be shown in a message, in this order.
55 For an open message, all of these headers will be made visible
56 according to `notmuch-message-headers-visible' or can be toggled
57 with `notmuch-show-toggle-visibility-headers'. For a closed message,
58 only the first header in the list will be visible."
59 :type '(repeat string)
62 (defcustom notmuch-message-headers-visible t
63 "Should the headers be visible by default?
65 If this value is non-nil, then all of the headers defined in
66 `notmuch-message-headers' will be visible by default in the display
67 of each message. Otherwise, these headers will be hidden and
68 `notmuch-show-toggle-visibility-headers' can be used to make them
69 visible for any given message."
73 (defcustom notmuch-show-relative-dates t
74 "Display relative dates in the message summary line."
78 (defvar notmuch-show-markup-headers-hook '(notmuch-show-colour-headers)
79 "A list of functions called to decorate the headers listed in
80 `notmuch-message-headers'.")
82 (defcustom notmuch-show-hook '(notmuch-show-turn-on-visual-line-mode)
83 "Functions called after populating a `notmuch-show' buffer."
85 :options '(notmuch-show-turn-on-visual-line-mode)
87 :group 'notmuch-hooks)
89 (defcustom notmuch-show-insert-text/plain-hook '(notmuch-wash-wrap-long-lines
90 notmuch-wash-tidy-citations
91 notmuch-wash-elide-blank-lines
92 notmuch-wash-excerpt-citations)
93 "Functions used to improve the display of text/plain parts."
95 :options '(notmuch-wash-convert-inline-patch-to-part
96 notmuch-wash-wrap-long-lines
97 notmuch-wash-tidy-citations
98 notmuch-wash-elide-blank-lines
99 notmuch-wash-excerpt-citations)
101 :group 'notmuch-hooks)
103 (defcustom notmuch-show-max-text-part-size 100000
104 "Maximum size of a text part to be shown by default in characters.
106 Set to 0 to show the part regardless of size."
108 :group 'notmuch-show)
110 ;; Mostly useful for debugging.
111 (defcustom notmuch-show-all-multipart/alternative-parts nil
112 "Should all parts of multipart/alternative parts be shown?"
114 :group 'notmuch-show)
116 (defcustom notmuch-show-indent-messages-width 1
117 "Width of message indentation in threads.
119 Messages are shown indented according to their depth in a thread.
120 This variable determines the width of this indentation measured
121 in number of blanks. Defaults to `1', choose `0' to disable
124 :group 'notmuch-show)
126 (defcustom notmuch-show-indent-multipart nil
127 "Should the sub-parts of a multipart/* part be indented?"
128 ;; dme: Not sure which is a good default.
130 :group 'notmuch-show)
132 (defcustom notmuch-show-part-button-default-action 'notmuch-show-save-part
133 "Default part header button action (on ENTER or mouse click)."
135 :type '(choice (const :tag "Save part"
136 notmuch-show-save-part)
137 (const :tag "View part"
138 notmuch-show-view-part)
139 (const :tag "View interactively"
140 notmuch-show-interactively-view-part)))
142 (defcustom notmuch-show-only-matching-messages nil
143 "Only matching messages are shown by default."
145 :group 'notmuch-show)
147 ;; By default, block all external images to prevent privacy leaks and
148 ;; potential attacks.
149 (defcustom notmuch-show-text/html-blocked-images "."
150 "Remote images that have URLs matching this regexp will be blocked."
151 :type '(choice (const nil) regexp)
152 :group 'notmuch-show)
154 (defvar notmuch-show-thread-id nil)
155 (make-variable-buffer-local 'notmuch-show-thread-id)
157 (defvar notmuch-show-parent-buffer nil)
158 (make-variable-buffer-local 'notmuch-show-parent-buffer)
160 (defvar notmuch-show-query-context nil)
161 (make-variable-buffer-local 'notmuch-show-query-context)
163 (defvar notmuch-show-process-crypto nil)
164 (make-variable-buffer-local 'notmuch-show-process-crypto)
166 (defvar notmuch-show-elide-non-matching-messages nil)
167 (make-variable-buffer-local 'notmuch-show-elide-non-matching-messages)
169 (defvar notmuch-show-indent-content t)
170 (make-variable-buffer-local 'notmuch-show-indent-content)
172 (defvar notmuch-show-attachment-debug nil
173 "If t log stdout and stderr from attachment handlers
175 When set to nil (the default) stdout and stderr from attachment
176 handlers is discarded. When set to t the stdout and stderr from
177 each attachment handler is logged in buffers with names beginning
178 \" *notmuch-part*\". This option requires emacs version at least
181 (defcustom notmuch-show-stash-mlarchive-link-alist
182 '(("Gmane" . "http://mid.gmane.org/")
183 ("MARC" . "http://marc.info/?i=")
184 ("Mail Archive, The" . "http://mid.mail-archive.com/")
185 ("LKML" . "http://lkml.kernel.org/r/")
186 ;; FIXME: can these services be searched by `Message-Id' ?
187 ;; ("MarkMail" . "http://markmail.org/")
188 ;; ("Nabble" . "http://nabble.com/")
189 ;; ("opensubscriber" . "http://opensubscriber.com/")
191 "List of Mailing List Archives to use when stashing links.
193 This list is used for generating a Mailing List Archive reference
194 URI with the current message's Message-Id in
195 `notmuch-show-stash-mlarchive-link'.
197 If the cdr of the alist element is not a function, the cdr is
198 expected to contain a URI that is concatenated with the current
199 message's Message-Id to create a ML archive reference URI.
201 If the cdr is a function, the function is called with the
202 Message-Id as the argument, and the function is expected to
203 return the ML archive reference URI."
204 :type '(alist :key-type (string :tag "Name")
207 (function :tag "Function returning the URL")))
208 :group 'notmuch-show)
210 (defcustom notmuch-show-stash-mlarchive-link-default "Gmane"
211 "Default Mailing List Archive to use when stashing links.
213 This is used when `notmuch-show-stash-mlarchive-link' isn't
214 provided with an MLA argument nor `completing-read' input."
218 (list 'const :tag (car mla) :value (car mla)))
219 notmuch-show-stash-mlarchive-link-alist))
220 :group 'notmuch-show)
222 (defcustom notmuch-show-mark-read-tags '("-unread")
223 "List of tag changes to apply to a message when it is marked as read.
225 Tags starting with \"+\" (or not starting with either \"+\" or
226 \"-\") in the list will be added, and tags starting with \"-\"
227 will be removed from the message being marked as read.
229 For example, if you wanted to remove an \"unread\" tag and add a
230 \"read\" tag (which would make little sense), you would set:
231 (\"-unread\" \"+read\")"
232 :type '(repeat string)
233 :group 'notmuch-show)
235 (defcustom notmuch-show-mark-read-function #'notmuch-show-seen-current-message
236 "Function to control which messages are marked read.
238 The function should take two arguments START and END which will
239 be the start and end of the visible portion of the buffer and
240 should mark the appropriate messages read by applying
241 `notmuch-show-mark-read'. This function will be called after
242 every user interaction with notmuch."
244 :group 'notmuch-show)
246 (defmacro with-current-notmuch-show-message (&rest body)
247 "Evaluate body with current buffer set to the text of current message"
249 (let ((id (notmuch-show-get-message-id)))
250 (let ((buf (generate-new-buffer (concat "*notmuch-msg-" id "*"))))
251 (with-current-buffer buf
252 (let ((coding-system-for-read 'no-conversion))
253 (call-process notmuch-command nil t nil "show" "--format=raw" id))
255 (kill-buffer buf)))))
257 (defun notmuch-show-turn-on-visual-line-mode ()
258 "Enable Visual Line mode."
259 (visual-line-mode t))
261 ;; DEPRECATED in Notmuch 0.16 since we now have convenient part
262 ;; commands. We'll keep the command around for a version or two in
263 ;; case people want to bind it themselves.
264 (defun notmuch-show-view-all-mime-parts ()
265 "Use external viewers to view all attachments from the current message."
267 (with-current-notmuch-show-message
268 ;; We override the mm-inline-media-tests to indicate which message
269 ;; parts are already sufficiently handled by the original
270 ;; presentation of the message in notmuch-show mode. These parts
271 ;; will be inserted directly into the temporary buffer of
272 ;; with-current-notmuch-show-message and silently discarded.
274 ;; Any MIME part not explicitly mentioned here will be handled by an
275 ;; external viewer as configured in the various mailcap files.
276 (let ((mm-inline-media-tests '(
277 ("text/.*" ignore identity)
278 ("application/pgp-signature" ignore identity)
279 ("multipart/alternative" ignore identity)
280 ("multipart/mixed" ignore identity)
281 ("multipart/related" ignore identity)
283 (mm-display-parts (mm-dissect-buffer)))))
285 (defun notmuch-show-save-attachments ()
286 "Save all attachments from the current message."
288 (with-current-notmuch-show-message
289 (let ((mm-handle (mm-dissect-buffer)))
290 (notmuch-save-attachments
291 mm-handle (> (notmuch-count-attachments mm-handle) 1))))
294 (defun notmuch-show-with-message-as-text (fn)
295 "Apply FN to a text representation of the current message.
297 FN is called with one argument, the message properties. It should
298 operation on the contents of the current buffer."
300 ;; Remake the header to ensure that all information is available.
301 (let* ((to (notmuch-show-get-to))
302 (cc (notmuch-show-get-cc))
303 (from (notmuch-show-get-from))
304 (subject (notmuch-show-get-subject))
305 (date (notmuch-show-get-date))
306 (tags (notmuch-show-get-tags))
307 (depth (notmuch-show-get-depth))
310 "Subject: " subject "\n"
312 (if (not (string= cc ""))
313 (concat "Cc: " cc "\n")
319 (mapconcat #'identity tags ", ") "\n")
321 (all (buffer-substring (notmuch-show-message-top)
322 (notmuch-show-message-bottom)))
324 (props (notmuch-show-get-message-properties))
325 (indenting notmuch-show-indent-content))
329 (indent-rigidly (point-min) (point-max) (- depth)))
330 ;; Remove the original header.
331 (goto-char (point-min))
332 (re-search-forward "^$" (point-max) nil)
333 (delete-region (point-min) (point))
335 (funcall fn props))))
337 (defun notmuch-show-print-message ()
338 "Print the current message."
340 (notmuch-show-with-message-as-text 'notmuch-print-message))
342 (defun notmuch-show-fontify-header ()
344 ((looking-at "[Tt]o:")
346 ((looking-at "[Bb]?[Cc][Cc]:")
348 ((looking-at "[Ss]ubject:")
349 'message-header-subject)
351 'message-header-other))))
353 (overlay-put (make-overlay (point) (re-search-forward ":"))
354 'face 'message-header-name)
355 (overlay-put (make-overlay (point) (re-search-forward ".*$"))
358 (defun notmuch-show-colour-headers ()
359 "Apply some colouring to the current headers."
360 (goto-char (point-min))
361 (while (looking-at "^[A-Za-z][-A-Za-z0-9]*:")
362 (notmuch-show-fontify-header)
365 (defun notmuch-show-spaces-n (n)
366 "Return a string comprised of `n' spaces."
369 (defun notmuch-show-update-tags (tags)
370 "Update the displayed tags of the current message."
372 (goto-char (notmuch-show-message-top))
373 (if (re-search-forward "(\\([^()]*\\))$" (line-end-position) t)
374 (let ((inhibit-read-only t))
375 (replace-match (concat "("
376 (notmuch-tag-format-tags tags (notmuch-show-get-prop :orig-tags))
379 (defun notmuch-clean-address (address)
380 "Try to clean a single email ADDRESS for display. Return a cons
381 cell of (AUTHOR_EMAIL AUTHOR_NAME). Return (ADDRESS nil) if
384 (let (p-name p-address)
385 ;; It would be convenient to use `mail-header-parse-address',
386 ;; but that expects un-decoded mailbox parts, whereas our
387 ;; mailbox parts are already decoded (and hence may contain
388 ;; UTF-8). Given that notmuch should handle most of the awkward
389 ;; cases, some simple string deconstruction should be sufficient
392 ;; "User <user@dom.ain>" style.
393 ((string-match "\\(.*\\) <\\(.*\\)>" address)
394 (setq p-name (match-string 1 address)
395 p-address (match-string 2 address)))
397 ;; "<user@dom.ain>" style.
398 ((string-match "<\\(.*\\)>" address)
399 (setq p-address (match-string 1 address)))
403 (setq p-address address)))
406 ;; Remove elements of the mailbox part that are not relevant for
407 ;; display, even if they are required during transport:
410 (setq p-name (replace-regexp-in-string "\\\\" "" p-name))
412 ;; Outer single and double quotes, which might be nested.
415 do (setq start-of-loop p-name)
417 when (string-match "^\"\\(.*\\)\"$" p-name)
418 do (setq p-name (match-string 1 p-name))
420 when (string-match "^'\\(.*\\)'$" p-name)
421 do (setq p-name (match-string 1 p-name))
423 until (string= start-of-loop p-name)))
425 ;; If the address is 'foo@bar.com <foo@bar.com>' then show just
427 (when (string= p-name p-address)
430 (cons p-address p-name))
431 (error (cons address nil))))
433 (defun notmuch-show-clean-address (address)
434 "Try to clean a single email ADDRESS for display. Return
435 unchanged ADDRESS if parsing fails."
436 (let* ((clean-address (notmuch-clean-address address))
437 (p-address (car clean-address))
438 (p-name (cdr clean-address)))
439 ;; If no name, return just the address.
442 ;; Otherwise format the name and address together.
443 (concat p-name " <" p-address ">"))))
445 (defun notmuch-show-insert-headerline (headers date tags depth)
446 "Insert a notmuch style headerline based on HEADERS for a
447 message at DEPTH in the current thread."
448 (let ((start (point)))
449 (insert (notmuch-show-spaces-n (* notmuch-show-indent-messages-width depth))
451 (notmuch-show-clean-address (plist-get headers :From)))
455 (notmuch-tag-format-tags tags tags)
457 (overlay-put (make-overlay start (point)) 'face 'notmuch-message-summary-face)))
459 (defun notmuch-show-insert-header (header header-value)
460 "Insert a single header."
461 (insert header ": " (notmuch-sanitize header-value) "\n"))
463 (defun notmuch-show-insert-headers (headers)
464 "Insert the headers of the current message."
465 (let ((start (point)))
466 (mapc (lambda (header)
467 (let* ((header-symbol (intern (concat ":" header)))
468 (header-value (plist-get headers header-symbol)))
469 (if (and header-value
470 (not (string-equal "" header-value)))
471 (notmuch-show-insert-header header header-value))))
472 notmuch-message-headers)
475 (narrow-to-region start (point-max))
476 (run-hooks 'notmuch-show-markup-headers-hook)))))
478 (define-button-type 'notmuch-show-part-button-type
479 'action 'notmuch-show-part-button-default
482 :supertype 'notmuch-button-type)
484 (defun notmuch-show-insert-part-header (nth content-type declared-type &optional name comment)
486 (base-label (concat (when name (concat name ": "))
488 (unless (string-equal declared-type content-type)
489 (concat " (as " content-type ")"))
494 (concat "[ " base-label " ]")
495 :base-label base-label
496 :type 'notmuch-show-part-button-type
497 :notmuch-part-hidden nil))
502 (defun notmuch-show-toggle-part-invisibility (&optional button)
504 (let ((button (or button (button-at (point)))))
506 (let ((overlay (button-get button 'overlay))
507 (lazy-part (button-get button :notmuch-lazy-part)))
508 ;; We have a part to toggle if there is an overlay or if there is a lazy part.
509 ;; If neither is present we cannot toggle the part so we just return nil.
510 (when (or overlay lazy-part)
511 (let* ((show (button-get button :notmuch-part-hidden))
512 (new-start (button-start button))
513 (button-label (button-get button :base-label))
515 (properties (text-properties-at (button-start button)))
516 (inhibit-read-only t))
517 ;; Toggle the button itself.
518 (button-put button :notmuch-part-hidden (not show))
519 (goto-char new-start)
520 (insert "[ " button-label (if show " ]" " (hidden) ]"))
521 (set-text-properties new-start (point) properties)
522 (let ((old-end (button-end button)))
523 (move-overlay button new-start (point))
524 (delete-region (point) old-end))
525 (goto-char (min old-point (1- (button-end button))))
526 ;; Return nil if there is a lazy-part, it is empty, and we are
527 ;; trying to show it. In all other cases return t.
530 (button-put button :notmuch-lazy-part nil)
531 (notmuch-show-lazy-part lazy-part button))
532 ;; else there must be an overlay.
533 (overlay-put overlay 'invisible (not show))
536 ;; Part content ID handling
538 (defvar notmuch-show--cids nil
539 "Alist from raw content ID to (MSG PART).")
540 (make-variable-buffer-local 'notmuch-show--cids)
542 (defun notmuch-show--register-cids (msg part)
543 "Register content-IDs in PART and all of PART's sub-parts."
544 (let ((content-id (plist-get part :content-id)))
546 ;; Note that content-IDs are globally unique, except when they
547 ;; aren't: RFC 2046 section 5.1.4 permits children of a
548 ;; multipart/alternative to have the same content-ID, in which
549 ;; case the MUA is supposed to pick the best one it can render.
550 ;; We simply add the content-ID to the beginning of our alist;
551 ;; so if this happens, we'll take the last (and "best")
552 ;; alternative (even if we can't render it).
553 (push (list content-id msg part) notmuch-show--cids)))
554 ;; Recurse on sub-parts
555 (let ((ctype (notmuch-split-content-type
556 (downcase (plist-get part :content-type)))))
557 (cond ((equal (first ctype) "multipart")
558 (mapc (apply-partially #'notmuch-show--register-cids msg)
559 (plist-get part :content)))
560 ((equal ctype '("message" "rfc822"))
561 (notmuch-show--register-cids
563 (first (plist-get (first (plist-get part :content)) :body)))))))
565 (defun notmuch-show--get-cid-content (cid)
566 "Return a list (CID-content content-type) or nil.
568 This will only find parts from messages that have been inserted
569 into the current buffer. CID must be a raw content ID, without
570 enclosing angle brackets, a cid: prefix, or URL encoding. This
571 will return nil if the CID is unknown or cannot be retrieved."
572 (let ((descriptor (cdr (assoc cid notmuch-show--cids))))
574 (let* ((msg (first descriptor))
575 (part (second descriptor))
576 ;; Request caching for this content, as some messages
577 ;; reference the same cid: part many times (hundreds!).
578 (content (notmuch-get-bodypart-binary
579 msg part notmuch-show-process-crypto 'cache))
580 (content-type (plist-get part :content-type)))
581 (list content content-type)))))
583 (defun notmuch-show-setup-w3m ()
584 "Instruct w3m how to retrieve content from a \"related\" part of a message."
586 (if (boundp 'w3m-cid-retrieve-function-alist)
587 (unless (assq 'notmuch-show-mode w3m-cid-retrieve-function-alist)
588 (push (cons 'notmuch-show-mode #'notmuch-show--cid-w3m-retrieve)
589 w3m-cid-retrieve-function-alist)))
590 (setq mm-inline-text-html-with-images t))
592 (defvar w3m-current-buffer) ;; From `w3m.el'.
593 (defun notmuch-show--cid-w3m-retrieve (url &rest args)
594 ;; url includes the cid: prefix and is URL encoded (see RFC 2392).
595 (let* ((cid (url-unhex-string (substring url 4)))
597 (with-current-buffer w3m-current-buffer
598 (notmuch-show--get-cid-content cid))))
599 (when content-and-type
600 (insert (first content-and-type))
601 (second content-and-type))))
603 ;; MIME part renderers
605 (defun notmuch-show-multipart/*-to-list (part)
606 (mapcar (lambda (inner-part) (plist-get inner-part :content-type))
607 (plist-get part :content)))
609 (defun notmuch-show-insert-part-multipart/alternative (msg part content-type nth depth button)
610 (let ((chosen-type (car (notmuch-multipart/alternative-choose msg (notmuch-show-multipart/*-to-list part))))
611 (inner-parts (plist-get part :content))
613 ;; This inserts all parts of the chosen type rather than just one,
614 ;; but it's not clear that this is the wrong thing to do - which
615 ;; should be chosen if there are more than one that match?
616 (mapc (lambda (inner-part)
617 (let* ((inner-type (plist-get inner-part :content-type))
618 (hide (not (or notmuch-show-all-multipart/alternative-parts
619 (string= chosen-type inner-type)))))
620 (notmuch-show-insert-bodypart msg inner-part depth hide)))
623 (when notmuch-show-indent-multipart
624 (indent-rigidly start (point) 1)))
627 (defun notmuch-show-insert-part-multipart/related (msg part content-type nth depth button)
628 (let ((inner-parts (plist-get part :content))
631 ;; Render the primary part. FIXME: Support RFC 2387 Start header.
632 (notmuch-show-insert-bodypart msg (car inner-parts) depth)
633 ;; Add hidden buttons for the rest
634 (mapc (lambda (inner-part)
635 (notmuch-show-insert-bodypart msg inner-part depth t))
638 (when notmuch-show-indent-multipart
639 (indent-rigidly start (point) 1)))
642 (defun notmuch-show-insert-part-multipart/signed (msg part content-type nth depth button)
644 (button-put button 'face 'notmuch-crypto-part-header))
646 ;; Insert a button detailing the signature status.
647 (notmuch-crypto-insert-sigstatus-button (car (plist-get part :sigstatus))
648 (notmuch-show-get-header :From msg))
650 (let ((inner-parts (plist-get part :content))
652 ;; Show all of the parts.
653 (mapc (lambda (inner-part)
654 (notmuch-show-insert-bodypart msg inner-part depth))
657 (when notmuch-show-indent-multipart
658 (indent-rigidly start (point) 1)))
661 (defun notmuch-show-insert-part-multipart/encrypted (msg part content-type nth depth button)
663 (button-put button 'face 'notmuch-crypto-part-header))
665 ;; Insert a button detailing the encryption status.
666 (notmuch-crypto-insert-encstatus-button (car (plist-get part :encstatus)))
668 ;; Insert a button detailing the signature status.
669 (notmuch-crypto-insert-sigstatus-button (car (plist-get part :sigstatus))
670 (notmuch-show-get-header :From msg))
672 (let ((inner-parts (plist-get part :content))
674 ;; Show all of the parts.
675 (mapc (lambda (inner-part)
676 (notmuch-show-insert-bodypart msg inner-part depth))
679 (when notmuch-show-indent-multipart
680 (indent-rigidly start (point) 1)))
683 (defun notmuch-show-insert-part-multipart/* (msg part content-type nth depth button)
684 (let ((inner-parts (plist-get part :content))
686 ;; Show all of the parts.
687 (mapc (lambda (inner-part)
688 (notmuch-show-insert-bodypart msg inner-part depth))
691 (when notmuch-show-indent-multipart
692 (indent-rigidly start (point) 1)))
695 (defun notmuch-show-insert-part-message/rfc822 (msg part content-type nth depth button)
696 (let* ((message (car (plist-get part :content)))
697 (body (car (plist-get message :body)))
700 ;; Override `notmuch-message-headers' to force `From' to be
702 (let ((notmuch-message-headers '("From" "Subject" "To" "Cc" "Date")))
703 (notmuch-show-insert-headers (plist-get message :headers)))
705 ;; Blank line after headers to be compatible with the normal
710 (notmuch-show-insert-bodypart msg body depth)
712 (when notmuch-show-indent-multipart
713 (indent-rigidly start (point) 1)))
716 (defun notmuch-show-insert-part-text/plain (msg part content-type nth depth button)
717 ;; For backward compatibility we want to apply the text/plain hook
718 ;; to the whole of the part including the part button if there is
720 (let ((start (if button
721 (button-start button)
723 (insert (notmuch-get-bodypart-text msg part notmuch-show-process-crypto))
726 (narrow-to-region start (point-max))
727 (run-hook-with-args 'notmuch-show-insert-text/plain-hook msg depth))))
730 (defun notmuch-show-insert-part-text/calendar (msg part content-type nth depth button)
731 (insert (with-temp-buffer
732 (insert (notmuch-get-bodypart-text msg part notmuch-show-process-crypto))
733 ;; notmuch-get-bodypart-text does no newline conversion.
734 ;; Replace CRLF with LF before icalendar can use it.
735 (goto-char (point-min))
736 (while (re-search-forward "\r\n" nil t)
737 (replace-match "\n" nil nil))
738 (let ((file (make-temp-file "notmuch-ical"))
742 (unless (icalendar-import-buffer file t)
743 (error "Icalendar import error. See *icalendar-errors* for more information"))
744 (set-buffer (get-file-buffer file))
745 (setq result (buffer-substring (point-min) (point-max)))
746 (set-buffer-modified-p nil)
747 (kill-buffer (current-buffer)))
752 ;; For backwards compatibility.
753 (defun notmuch-show-insert-part-text/x-vcalendar (msg part content-type nth depth button)
754 (notmuch-show-insert-part-text/calendar msg part content-type nth depth button))
756 (defun notmuch-show-get-mime-type-of-application/octet-stream (part)
757 ;; If we can deduce a MIME type from the filename of the attachment,
759 (if (plist-get part :filename)
760 (let ((extension (file-name-extension (plist-get part :filename)))
764 (mailcap-parse-mimetypes)
765 (setq mime-type (mailcap-extension-to-mime extension))
767 (not (string-equal mime-type "application/octet-stream")))
772 (defun notmuch-show-insert-part-text/html (msg part content-type nth depth button)
773 (if (eq mm-text-html-renderer 'shr)
774 ;; It's easier to drive shr ourselves than to work around the
775 ;; goofy things `mm-shr' does (like irreversibly taking over
776 ;; content ID handling).
778 ;; FIXME: If we block an image, offer a button to load external
780 (let ((shr-blocked-images notmuch-show-text/html-blocked-images))
781 (notmuch-show--insert-part-text/html-shr msg part))
782 ;; Otherwise, let message-mode do the heavy lifting
784 ;; w3m sets up a keymap which "leaks" outside the invisible region
785 ;; and causes strange effects in notmuch. We set
786 ;; mm-inline-text-html-with-w3m-keymap to nil to tell w3m not to
787 ;; set a keymap (so the normal notmuch-show-mode-map remains).
788 (let ((mm-inline-text-html-with-w3m-keymap nil)
789 ;; FIXME: If we block an image, offer a button to load external
791 (gnus-blocked-images notmuch-show-text/html-blocked-images))
792 (notmuch-show-insert-part-*/* msg part content-type nth depth button))))
794 ;; These functions are used by notmuch-show--insert-part-text/html-shr
795 (declare-function libxml-parse-html-region "xml.c")
796 (declare-function shr-insert-document "shr")
798 (defun notmuch-show--insert-part-text/html-shr (msg part)
799 ;; Make sure shr is loaded before we start let-binding its globals
801 (let ((dom (let ((process-crypto notmuch-show-process-crypto))
803 (insert (notmuch-get-bodypart-text msg part process-crypto))
804 (libxml-parse-html-region (point-min) (point-max)))))
805 (shr-content-function
807 ;; shr strips the "cid:" part of URL, but doesn't
808 ;; URL-decode it (see RFC 2392).
809 (let ((cid (url-unhex-string url)))
810 (first (notmuch-show--get-cid-content cid))))))
811 (shr-insert-document dom)
814 (defun notmuch-show-insert-part-*/* (msg part content-type nth depth button)
815 ;; This handler _must_ succeed - it is the handler of last resort.
816 (notmuch-mm-display-part-inline msg part content-type notmuch-show-process-crypto)
819 ;; Functions for determining how to handle MIME parts.
821 (defun notmuch-show-handlers-for (content-type)
822 "Return a list of content handlers for a part of type CONTENT-TYPE."
827 ;; Reverse order of prefrence.
828 (list (intern (concat "notmuch-show-insert-part-*/*"))
830 "notmuch-show-insert-part-"
831 (car (notmuch-split-content-type content-type))
833 (intern (concat "notmuch-show-insert-part-" content-type))))
838 (defun notmuch-show-insert-bodypart-internal (msg part content-type nth depth button)
839 ;; Run the handlers until one of them succeeds.
840 (loop for handler in (notmuch-show-handlers-for content-type)
841 until (condition-case err
842 (funcall handler msg part content-type nth depth button)
843 ;; Specifying `debug' here lets the debugger run if
844 ;; `debug-on-error' is non-nil.
846 (insert "!!! Bodypart handler `" (prin1-to-string handler) "' threw an error:\n"
847 "!!! " (error-message-string err) "\n")
850 (defun notmuch-show-create-part-overlays (button beg end)
851 "Add an overlay to the part between BEG and END"
853 ;; If there is no button (i.e., the part is text/plain and the first
854 ;; part) or if the part has no content then we don't make the part
856 (when (and button (/= beg end))
857 (button-put button 'overlay (make-overlay beg end))
858 ;; Return true if we created an overlay.
861 (defun notmuch-show-record-part-information (part beg end)
862 "Store PART as a text property from BEG to END"
864 ;; Record part information. Since we already inserted subparts,
865 ;; don't override existing :notmuch-part properties.
866 (notmuch-map-text-property beg end :notmuch-part
867 (lambda (v) (or v part)))
868 ;; Make :notmuch-part front sticky and rear non-sticky so it stays
869 ;; applied to the beginning of each line when we indent the
870 ;; message. Since we're operating on arbitrary renderer output,
871 ;; watch out for sticky specs of t, which means all properties are
872 ;; front-sticky/rear-nonsticky.
873 (notmuch-map-text-property beg end 'front-sticky
874 (lambda (v) (if (listp v)
875 (pushnew :notmuch-part v)
877 (notmuch-map-text-property beg end 'rear-nonsticky
878 (lambda (v) (if (listp v)
879 (pushnew :notmuch-part v)
882 (defun notmuch-show-lazy-part (part-args button)
883 ;; Insert the lazy part after the button for the part. We would just
884 ;; move to the start of the new line following the button and insert
885 ;; the part but that point might have text properties (eg colours
886 ;; from a message header etc) so instead we start from the last
887 ;; character of the button by adding a newline and finish by
888 ;; removing the extra newline from the end of the part.
890 (goto-char (button-end button))
892 (let* ((inhibit-read-only t)
893 ;; We need to use markers for the start and end of the part
894 ;; because the part insertion functions do not guarantee
895 ;; to leave point at the end of the part.
896 (part-beg (copy-marker (point) nil))
897 (part-end (copy-marker (point) t))
898 ;; We have to save the depth as we can't find the depth
900 (depth (notmuch-show-get-depth)))
902 (narrow-to-region part-beg part-end)
903 (delete-region part-beg part-end)
904 (apply #'notmuch-show-insert-bodypart-internal part-args)
905 (indent-rigidly part-beg part-end depth))
908 (notmuch-show-record-part-information (second part-args)
909 (button-start button)
911 ;; Create the overlay. If the lazy-part turned out to be empty/not
912 ;; showable this returns nil.
913 (notmuch-show-create-part-overlays button part-beg part-end))))
915 (defun notmuch-show-mime-type (part)
916 "Return the correct mime-type to use for PART."
917 (let ((content-type (downcase (plist-get part :content-type))))
918 (or (and (string= content-type "application/octet-stream")
919 (notmuch-show-get-mime-type-of-application/octet-stream part))
920 (and (string= content-type "inline patch")
924 ;; The following variable can be overridden by let bindings.
925 (defvar notmuch-show-insert-header-p-function 'notmuch-show-insert-header-p
926 "Specify which function decides which part headers get inserted.
928 The function should take two parameters, PART and HIDE, and
929 should return non-NIL if a header button should be inserted for
932 (defun notmuch-show-insert-header-p (part hide)
933 ;; Show all part buttons except for the first part if it is text/plain.
934 (let ((mime-type (notmuch-show-mime-type part)))
935 (not (and (string= mime-type "text/plain")
936 (<= (plist-get part :id) 1)))))
938 (defun notmuch-show-reply-insert-header-p-never (part hide)
941 (defun notmuch-show-reply-insert-header-p-trimmed (part hide)
942 (let ((mime-type (notmuch-show-mime-type part)))
943 (and (not (notmuch-match-content-type mime-type "multipart/*"))
946 (defun notmuch-show-reply-insert-header-p-minimal (part hide)
947 (let ((mime-type (notmuch-show-mime-type part)))
948 (and (notmuch-match-content-type mime-type "text/*")
951 (defun notmuch-show-insert-bodypart (msg part depth &optional hide)
952 "Insert the body part PART at depth DEPTH in the current thread.
954 HIDE determines whether to show or hide the part and the button
955 as follows: If HIDE is nil, show the part and the button. If HIDE
956 is t, hide the part initially and show the button."
958 (let* ((content-type (downcase (plist-get part :content-type)))
959 (mime-type (notmuch-show-mime-type part))
960 (nth (plist-get part :id))
961 (long (and (notmuch-match-content-type mime-type "text/*")
962 (> notmuch-show-max-text-part-size 0)
963 (> (length (plist-get part :content)) notmuch-show-max-text-part-size)))
965 ;; This default header-p function omits the part button for
966 ;; the first (or only) part if this is text/plain.
967 (button (when (funcall notmuch-show-insert-header-p-function part hide)
968 (notmuch-show-insert-part-header nth mime-type content-type (plist-get part :filename))))
969 ;; Hide the part initially if HIDE is t, or if it is too long
970 ;; and we have a button to allow toggling.
971 (show-part (not (or (equal hide t)
973 (content-beg (point)))
975 ;; Store the computed mime-type for later use (e.g. by attachment handlers).
976 (plist-put part :computed-type mime-type)
979 (notmuch-show-insert-bodypart-internal msg part mime-type nth depth button)
981 (button-put button :notmuch-lazy-part
982 (list msg part mime-type nth depth button))))
984 ;; Some of the body part handlers leave point somewhere up in the
985 ;; part, so we make sure that we're down at the end.
986 (goto-char (point-max))
987 ;; Ensure that the part ends with a carriage return.
990 ;; We do not create the overlay for hidden (lazy) parts until
991 ;; they are inserted.
993 (notmuch-show-create-part-overlays button content-beg (point))
995 (notmuch-show-toggle-part-invisibility button)))
996 (notmuch-show-record-part-information part beg (point))))
998 (defun notmuch-show-insert-body (msg body depth)
999 "Insert the body BODY at depth DEPTH in the current thread."
1001 ;; Register all content IDs for this message. According to RFC
1002 ;; 2392, content IDs are *global*, but it's okay if an MUA treats
1003 ;; them as only global within a message.
1004 (notmuch-show--register-cids msg (first body))
1006 (mapc (lambda (part) (notmuch-show-insert-bodypart msg part depth)) body))
1008 (defun notmuch-show-make-symbol (type)
1009 (make-symbol (concat "notmuch-show-" type)))
1011 (defun notmuch-show-strip-re (string)
1012 (replace-regexp-in-string "^\\([Rr]e: *\\)+" "" string))
1014 (defvar notmuch-show-previous-subject "")
1015 (make-variable-buffer-local 'notmuch-show-previous-subject)
1017 (defun notmuch-show-insert-msg (msg depth)
1018 "Insert the message MSG at depth DEPTH in the current thread."
1019 (let* ((headers (plist-get msg :headers))
1020 ;; Indentation causes the buffer offset of the start/end
1021 ;; points to move, so we must use markers.
1022 message-start message-end
1023 content-start content-end
1024 headers-start headers-end
1025 (bare-subject (notmuch-show-strip-re (plist-get headers :Subject))))
1027 (setq message-start (point-marker))
1029 (notmuch-show-insert-headerline headers
1030 (or (if notmuch-show-relative-dates
1031 (plist-get msg :date_relative)
1033 (plist-get headers :Date))
1034 (plist-get msg :tags) depth)
1036 (setq content-start (point-marker))
1038 ;; Set `headers-start' to point after the 'Subject:' header to be
1039 ;; compatible with the existing implementation. This just sets it
1040 ;; to after the first header.
1041 (notmuch-show-insert-headers headers)
1043 (goto-char content-start)
1044 ;; If the subject of this message is the same as that of the
1045 ;; previous message, don't display it when this message is
1047 (when (not (string= notmuch-show-previous-subject
1050 (setq headers-start (point-marker)))
1051 (setq headers-end (point-marker))
1053 (setq notmuch-show-previous-subject bare-subject)
1055 ;; A blank line between the headers and the body.
1057 (notmuch-show-insert-body msg (plist-get msg :body)
1058 (if notmuch-show-indent-content depth 0))
1059 ;; Ensure that the body ends with a newline.
1062 (setq content-end (point-marker))
1064 ;; Indent according to the depth in the thread.
1065 (if notmuch-show-indent-content
1066 (indent-rigidly content-start content-end (* notmuch-show-indent-messages-width depth)))
1068 (setq message-end (point-max-marker))
1070 ;; Save the extents of this message over the whole text of the
1072 (put-text-property message-start message-end :notmuch-message-extent (cons message-start message-end))
1074 ;; Create overlays used to control visibility
1075 (plist-put msg :headers-overlay (make-overlay headers-start headers-end))
1076 (plist-put msg :message-overlay (make-overlay headers-start content-end))
1078 (plist-put msg :depth depth)
1080 ;; Save the properties for this message. Currently this saves the
1081 ;; entire message (augmented it with other stuff), which seems
1082 ;; like overkill. We might save a reduced subset (for example, not
1084 (notmuch-show-set-message-properties msg)
1086 ;; Set header visibility.
1087 (notmuch-show-headers-visible msg notmuch-message-headers-visible)
1089 ;; Message visibility depends on whether it matched the search
1091 (notmuch-show-message-visible msg (and (plist-get msg :match)
1092 (not (plist-get msg :excluded))))))
1094 (defun notmuch-show-toggle-process-crypto ()
1095 "Toggle the processing of cryptographic MIME parts."
1097 (setq notmuch-show-process-crypto (not notmuch-show-process-crypto))
1098 (message (if notmuch-show-process-crypto
1099 "Processing cryptographic MIME parts."
1100 "Not processing cryptographic MIME parts."))
1101 (notmuch-show-refresh-view))
1103 (defun notmuch-show-toggle-elide-non-matching ()
1104 "Toggle the display of non-matching messages."
1106 (setq notmuch-show-elide-non-matching-messages (not notmuch-show-elide-non-matching-messages))
1107 (message (if notmuch-show-elide-non-matching-messages
1108 "Showing matching messages only."
1109 "Showing all messages."))
1110 (notmuch-show-refresh-view))
1112 (defun notmuch-show-toggle-thread-indentation ()
1113 "Toggle the indentation of threads."
1115 (setq notmuch-show-indent-content (not notmuch-show-indent-content))
1116 (message (if notmuch-show-indent-content
1117 "Content is indented."
1118 "Content is not indented."))
1119 (notmuch-show-refresh-view))
1121 (defun notmuch-show-insert-tree (tree depth)
1122 "Insert the message tree TREE at depth DEPTH in the current thread."
1123 (let ((msg (car tree))
1124 (replies (cadr tree)))
1125 ;; We test whether there is a message or just some replies.
1127 (notmuch-show-insert-msg msg depth))
1128 (notmuch-show-insert-thread replies (1+ depth))))
1130 (defun notmuch-show-insert-thread (thread depth)
1131 "Insert the thread THREAD at depth DEPTH in the current forest."
1132 (mapc (lambda (tree) (notmuch-show-insert-tree tree depth)) thread))
1134 (defun notmuch-show-insert-forest (forest)
1135 "Insert the forest of threads FOREST."
1136 (mapc (lambda (thread) (notmuch-show-insert-thread thread 0)) forest))
1138 (defvar notmuch-id-regexp
1140 ;; Match the id: prefix only if it begins a word (to disallow, for
1141 ;; example, matching cid:).
1143 ;; If the term starts with a ", then parse Xapian's quoted boolean
1144 ;; term syntax, which allows for anything as long as embedded
1145 ;; double quotes escaped by doubling them. We also disallow
1146 ;; newlines (which Xapian allows) to prevent runaway terms.
1147 "\"\\([^\"\n]\\|\"\"\\)*\""
1148 ;; Otherwise, parse Xapian's unquoted syntax, which goes up to the
1149 ;; next space or ). We disallow [.,;] as the last character
1150 ;; because these are probably part of the surrounding text, and not
1151 ;; part of the id. This doesn't match single character ids; meh.
1152 "\\|[^\"[:space:])][^[:space:])]*[^])[:space:].,:;?!]"
1154 "The regexp used to match id: links in messages.")
1156 (defvar notmuch-mid-regexp
1157 ;; goto-address-url-regexp matched cid: links, which have the same
1158 ;; grammar as the message ID part of a mid: link. Construct the
1159 ;; regexp using the same technique as goto-address-url-regexp.
1160 (concat "\\<mid:\\(" thing-at-point-url-path-regexp "\\)")
1161 "The regexp used to match mid: links in messages.
1165 (defun notmuch-show-buttonise-links (start end)
1166 "Buttonise URLs and mail addresses between START and END.
1168 This also turns id:\"<message id>\"-parts and mid: links into
1169 buttons for a corresponding notmuch search."
1170 (goto-address-fontify-region start end)
1174 (while (re-search-forward notmuch-id-regexp end t)
1175 (push (list (match-beginning 0) (match-end 0)
1176 (match-string-no-properties 0)) links))
1178 (while (re-search-forward notmuch-mid-regexp end t)
1179 (let* ((mid-cid (match-string-no-properties 1))
1180 (mid (save-match-data
1181 (string-match "^[^/]*" mid-cid)
1182 (url-unhex-string (match-string 0 mid-cid)))))
1183 (push (list (match-beginning 0) (match-end 0)
1184 (notmuch-id-to-query mid)) links)))
1185 (dolist (link links)
1186 ;; Remove the overlay created by goto-address-mode
1187 (remove-overlays (first link) (second link) 'goto-address t)
1188 (make-text-button (first link) (second link)
1189 :type 'notmuch-button-type
1190 'action `(lambda (arg)
1191 (notmuch-show ,(third link) current-prefix-arg))
1193 'help-echo "Mouse-1, RET: search for this message"
1194 'face goto-address-mail-face)))))
1197 (defun notmuch-show (thread-id &optional elide-toggle parent-buffer query-context buffer-name)
1198 "Run \"notmuch show\" with the given thread ID and display results.
1200 ELIDE-TOGGLE, if non-nil, inverts the default elide behavior.
1202 The optional PARENT-BUFFER is the notmuch-search buffer from
1203 which this notmuch-show command was executed, (so that the
1204 next thread from that buffer can be show when done with this
1207 The optional QUERY-CONTEXT is a notmuch search term. Only
1208 messages from the thread matching this search term are shown if
1211 The optional BUFFER-NAME provides the name of the buffer in
1212 which the message thread is shown. If it is nil (which occurs
1213 when the command is called interactively) the argument to the
1216 Returns the buffer containing the messages, or NIL if no messages
1218 (interactive "sNotmuch show: \nP")
1219 (let ((buffer-name (generate-new-buffer-name
1221 (concat "*notmuch-" thread-id "*")))))
1222 (switch-to-buffer (get-buffer-create buffer-name))
1223 ;; No need to track undo information for this buffer.
1224 (setq buffer-undo-list t)
1228 ;; Set various buffer local variables to their appropriate initial
1229 ;; state. Do this after enabling `notmuch-show-mode' so that they
1230 ;; aren't wiped out.
1231 (setq notmuch-show-thread-id thread-id
1232 notmuch-show-parent-buffer parent-buffer
1233 notmuch-show-query-context query-context
1235 notmuch-show-process-crypto notmuch-crypto-process-mime
1236 ;; If `elide-toggle', invert the default value.
1237 notmuch-show-elide-non-matching-messages
1239 (not notmuch-show-only-matching-messages)
1240 notmuch-show-only-matching-messages))
1242 (add-hook 'post-command-hook #'notmuch-show-command-hook nil t)
1243 (jit-lock-register #'notmuch-show-buttonise-links)
1245 (notmuch-tag-clear-cache)
1247 (let ((inhibit-read-only t))
1248 (if (notmuch-show--build-buffer)
1249 ;; Messages were inserted into the buffer.
1252 ;; No messages were inserted - presumably none matched the
1254 (kill-buffer (current-buffer))
1256 (message "No messages matched the query!")
1259 (defun notmuch-show--build-buffer (&optional state)
1260 "Display messages matching the current buffer context.
1262 Apply the previously saved STATE if supplied, otherwise show the
1263 first relevant message.
1265 If no messages match the query return NIL."
1266 (let* ((basic-args (list notmuch-show-thread-id))
1267 (args (if notmuch-show-query-context
1268 (append (list "\'") basic-args
1269 (list "and (" notmuch-show-query-context ")\'"))
1270 (append (list "\'") basic-args (list "\'"))))
1271 (cli-args (cons "--exclude=false"
1272 (when notmuch-show-elide-non-matching-messages
1273 (list "--entire-thread=false"))))
1275 (forest (or (notmuch-query-get-threads (append cli-args args))
1276 ;; If a query context reduced the number of
1277 ;; results to zero, try again without it.
1278 (and notmuch-show-query-context
1279 (notmuch-query-get-threads (append cli-args basic-args)))))
1281 ;; Must be reset every time we are going to start inserting
1282 ;; messages into the buffer.
1283 (notmuch-show-previous-subject ""))
1286 (notmuch-show-insert-forest forest)
1288 ;; Store the original tags for each message so that we can
1291 (lambda () (notmuch-show-set-prop :orig-tags (notmuch-show-get-tags))))
1293 ;; Set the header line to the subject of the first message.
1294 (setq header-line-format
1295 (replace-regexp-in-string "%" "%%"
1297 (notmuch-show-strip-re
1298 (notmuch-show-get-subject)))))
1300 (run-hooks 'notmuch-show-hook)
1303 (notmuch-show-apply-state state)
1304 ;; With no state to apply, just go to the first message.
1305 (notmuch-show-goto-first-wanted-message)))
1307 ;; Report back to the caller whether any messages matched.
1310 (defun notmuch-show-capture-state ()
1311 "Capture the state of the current buffer.
1314 - the list of open messages,
1315 - the current message."
1316 (list (notmuch-show-get-message-id) (notmuch-show-get-message-ids-for-open-messages)))
1318 (defun notmuch-show-get-query ()
1319 "Return the current query in this show buffer"
1320 (if notmuch-show-query-context
1321 (concat notmuch-show-thread-id
1323 notmuch-show-query-context
1325 notmuch-show-thread-id))
1327 (defun notmuch-show-goto-message (msg-id)
1328 "Go to message with msg-id."
1329 (goto-char (point-min))
1330 (unless (loop if (string= msg-id (notmuch-show-get-message-id))
1332 until (not (notmuch-show-goto-message-next)))
1333 (goto-char (point-min))
1334 (message "Message-id not found."))
1335 (notmuch-show-message-adjust))
1337 (defun notmuch-show-apply-state (state)
1338 "Apply STATE to the current buffer.
1341 - opening the messages previously opened,
1342 - closing all other messages,
1343 - moving to the correct current message."
1344 (let ((current (car state))
1345 (open (cadr state)))
1347 ;; Open those that were open.
1348 (goto-char (point-min))
1349 (loop do (notmuch-show-message-visible (notmuch-show-get-message-properties)
1350 (member (notmuch-show-get-message-id) open))
1351 until (not (notmuch-show-goto-message-next)))
1353 ;; Go to the previously open message.
1354 (notmuch-show-goto-message current)))
1356 (defun notmuch-show-refresh-view (&optional reset-state)
1357 "Refresh the current view.
1359 Refreshes the current view, observing changes in display
1360 preferences. If invoked with a prefix argument (or RESET-STATE is
1361 non-nil) then the state of the buffer (open/closed messages) is
1362 reset based on the original query."
1364 (let ((inhibit-read-only t)
1365 (state (unless reset-state
1366 (notmuch-show-capture-state))))
1367 ;; `erase-buffer' does not seem to remove overlays, which can lead
1368 ;; to weird effects such as remaining images, so remove them
1373 (unless (notmuch-show--build-buffer state)
1374 ;; No messages were inserted.
1375 (kill-buffer (current-buffer))
1377 (message "Refreshing the buffer resulted in no messages!"))))
1379 (defvar notmuch-show-stash-map
1380 (let ((map (make-sparse-keymap)))
1381 (define-key map "c" 'notmuch-show-stash-cc)
1382 (define-key map "d" 'notmuch-show-stash-date)
1383 (define-key map "F" 'notmuch-show-stash-filename)
1384 (define-key map "f" 'notmuch-show-stash-from)
1385 (define-key map "i" 'notmuch-show-stash-message-id)
1386 (define-key map "I" 'notmuch-show-stash-message-id-stripped)
1387 (define-key map "s" 'notmuch-show-stash-subject)
1388 (define-key map "T" 'notmuch-show-stash-tags)
1389 (define-key map "t" 'notmuch-show-stash-to)
1390 (define-key map "l" 'notmuch-show-stash-mlarchive-link)
1391 (define-key map "L" 'notmuch-show-stash-mlarchive-link-and-go)
1392 (define-key map "G" 'notmuch-show-stash-git-send-email)
1393 (define-key map "?" 'notmuch-subkeymap-help)
1395 "Submap for stash commands")
1396 (fset 'notmuch-show-stash-map notmuch-show-stash-map)
1398 (defvar notmuch-show-part-map
1399 (let ((map (make-sparse-keymap)))
1400 (define-key map "s" 'notmuch-show-save-part)
1401 (define-key map "v" 'notmuch-show-view-part)
1402 (define-key map "o" 'notmuch-show-interactively-view-part)
1403 (define-key map "|" 'notmuch-show-pipe-part)
1404 (define-key map "?" 'notmuch-subkeymap-help)
1406 "Submap for part commands")
1407 (fset 'notmuch-show-part-map notmuch-show-part-map)
1409 (defvar notmuch-show-mode-map
1410 (let ((map (make-sparse-keymap)))
1411 (set-keymap-parent map notmuch-common-keymap)
1412 (define-key map "Z" 'notmuch-tree-from-show-current-query)
1413 (define-key map (kbd "<C-tab>") 'widget-backward)
1414 (define-key map (kbd "M-TAB") 'notmuch-show-previous-button)
1415 (define-key map (kbd "<backtab>") 'notmuch-show-previous-button)
1416 (define-key map (kbd "TAB") 'notmuch-show-next-button)
1417 (define-key map "f" 'notmuch-show-forward-message)
1418 (define-key map "F" 'notmuch-show-forward-open-messages)
1419 (define-key map "l" 'notmuch-show-filter-thread)
1420 (define-key map "r" 'notmuch-show-reply-sender)
1421 (define-key map "R" 'notmuch-show-reply)
1422 (define-key map "|" 'notmuch-show-pipe-message)
1423 (define-key map "w" 'notmuch-show-save-attachments)
1424 (define-key map "V" 'notmuch-show-view-raw-message)
1425 (define-key map "c" 'notmuch-show-stash-map)
1426 (define-key map "h" 'notmuch-show-toggle-visibility-headers)
1427 (define-key map "*" 'notmuch-show-tag-all)
1428 (define-key map "-" 'notmuch-show-remove-tag)
1429 (define-key map "+" 'notmuch-show-add-tag)
1430 (define-key map "X" 'notmuch-show-archive-thread-then-exit)
1431 (define-key map "x" 'notmuch-show-archive-message-then-next-or-exit)
1432 (define-key map "A" 'notmuch-show-archive-thread-then-next)
1433 (define-key map "a" 'notmuch-show-archive-message-then-next-or-next-thread)
1434 (define-key map "N" 'notmuch-show-next-message)
1435 (define-key map "P" 'notmuch-show-previous-message)
1436 (define-key map "n" 'notmuch-show-next-open-message)
1437 (define-key map "p" 'notmuch-show-previous-open-message)
1438 (define-key map (kbd "M-n") 'notmuch-show-next-thread-show)
1439 (define-key map (kbd "M-p") 'notmuch-show-previous-thread-show)
1440 (define-key map (kbd "DEL") 'notmuch-show-rewind)
1441 (define-key map " " 'notmuch-show-advance-and-archive)
1442 (define-key map (kbd "M-RET") 'notmuch-show-open-or-close-all)
1443 (define-key map (kbd "RET") 'notmuch-show-toggle-message)
1444 (define-key map "#" 'notmuch-show-print-message)
1445 (define-key map "!" 'notmuch-show-toggle-elide-non-matching)
1446 (define-key map "$" 'notmuch-show-toggle-process-crypto)
1447 (define-key map "<" 'notmuch-show-toggle-thread-indentation)
1448 (define-key map "t" 'toggle-truncate-lines)
1449 (define-key map "." 'notmuch-show-part-map)
1451 "Keymap for \"notmuch show\" buffers.")
1452 (fset 'notmuch-show-mode-map notmuch-show-mode-map)
1454 (defun notmuch-show-mode ()
1455 "Major mode for viewing a thread with notmuch.
1457 This buffer contains the results of the \"notmuch show\" command
1458 for displaying a single thread of email from your email archives.
1460 By default, various components of email messages, (citations,
1461 signatures, already-read messages), are hidden. You can make
1462 these parts visible by clicking with the mouse button or by
1463 pressing RET after positioning the cursor on a hidden part, (for
1464 which \\[notmuch-show-next-button] and \\[notmuch-show-previous-button] are helpful).
1466 Reading the thread sequentially is well-supported by pressing
1467 \\[notmuch-show-advance-and-archive]. This will scroll the current message (if necessary), advance
1468 to the next message, or advance to the next thread (if already on
1469 the last message of a thread).
1471 Other commands are available to read or manipulate the thread
1472 more selectively, (such as '\\[notmuch-show-next-message]' and '\\[notmuch-show-previous-message]' to advance to messages
1473 without removing any tags, and '\\[notmuch-show-archive-thread]' to archive an entire thread
1474 without scrolling through with \\[notmuch-show-advance-and-archive]).
1476 You can add or remove arbitrary tags from the current message with
1477 '\\[notmuch-show-add-tag]' or '\\[notmuch-show-remove-tag]'.
1479 All currently available key bindings:
1481 \\{notmuch-show-mode-map}"
1483 (kill-all-local-variables)
1484 (setq notmuch-buffer-refresh-function #'notmuch-show-refresh-view)
1485 (use-local-map notmuch-show-mode-map)
1486 (setq major-mode 'notmuch-show-mode
1487 mode-name "notmuch-show")
1488 (setq buffer-read-only t
1491 (defun notmuch-tree-from-show-current-query ()
1492 "Call notmuch tree with the current query"
1494 (notmuch-tree notmuch-show-thread-id
1495 notmuch-show-query-context
1496 (notmuch-show-get-message-id)))
1498 (defun notmuch-show-move-to-message-top ()
1499 (goto-char (notmuch-show-message-top)))
1501 (defun notmuch-show-move-to-message-bottom ()
1502 (goto-char (notmuch-show-message-bottom)))
1504 (defun notmuch-show-message-adjust ()
1507 ;; Movement related functions.
1509 ;; There's some strangeness here where a text property applied to a
1510 ;; region a->b is not found when point is at b. We walk backwards
1511 ;; until finding the property.
1512 (defun notmuch-show-message-extent ()
1515 (while (not (setq r (get-text-property (point) :notmuch-message-extent)))
1519 (defun notmuch-show-message-top ()
1520 (car (notmuch-show-message-extent)))
1522 (defun notmuch-show-message-bottom ()
1523 (cdr (notmuch-show-message-extent)))
1525 (defun notmuch-show-goto-message-next ()
1526 (let ((start (point)))
1527 (notmuch-show-move-to-message-bottom)
1533 (defun notmuch-show-goto-message-previous ()
1534 (notmuch-show-move-to-message-top)
1538 (notmuch-show-move-to-message-top)
1541 (defun notmuch-show-mapc (function)
1542 "Iterate through all messages in the current thread with
1543 `notmuch-show-goto-message-next' and call FUNCTION for side
1546 (goto-char (point-min))
1547 (loop do (funcall function)
1548 while (notmuch-show-goto-message-next))))
1550 ;; Functions relating to the visibility of messages and their
1553 (defun notmuch-show-message-visible (props visible-p)
1554 (overlay-put (plist-get props :message-overlay) 'invisible (not visible-p))
1555 (notmuch-show-set-prop :message-visible visible-p props))
1557 (defun notmuch-show-headers-visible (props visible-p)
1558 (overlay-put (plist-get props :headers-overlay) 'invisible (not visible-p))
1559 (notmuch-show-set-prop :headers-visible visible-p props))
1561 ;; Functions for setting and getting attributes of the current
1564 (defun notmuch-show-set-message-properties (props)
1566 (notmuch-show-move-to-message-top)
1567 (put-text-property (point) (+ (point) 1) :notmuch-message-properties props)))
1569 (defun notmuch-show-get-message-properties ()
1570 "Return the properties of the current message as a plist.
1572 Some useful entries are:
1573 :headers - Property list containing the headers :Date, :Subject, :From, etc.
1574 :body - Body of the message
1575 :tags - Tags for this message"
1577 (notmuch-show-move-to-message-top)
1578 (get-text-property (point) :notmuch-message-properties)))
1580 (defun notmuch-show-get-part-properties ()
1581 "Return the properties of the innermost part containing point.
1583 This is the part property list retrieved from the CLI. Signals
1584 an error if there is no part containing point."
1585 (or (get-text-property (point) :notmuch-part)
1586 (error "No message part here")))
1588 (defun notmuch-show-set-prop (prop val &optional props)
1589 (let ((inhibit-read-only t)
1591 (notmuch-show-get-message-properties))))
1592 (plist-put props prop val)
1593 (notmuch-show-set-message-properties props)))
1595 (defun notmuch-show-get-prop (prop &optional props)
1596 "Get property PROP from current message in show or tree mode.
1598 It gets property PROP from PROPS or, if PROPS is nil, the current
1599 message in either tree or show. This means that several utility
1600 functions in notmuch-show can be used directly by notmuch-tree as
1601 they just need the correct message properties."
1602 (let ((props (or props
1603 (cond ((eq major-mode 'notmuch-show-mode)
1604 (notmuch-show-get-message-properties))
1605 ((eq major-mode 'notmuch-tree-mode)
1606 (notmuch-tree-get-message-properties))
1608 (plist-get props prop)))
1610 (defun notmuch-show-get-message-id (&optional bare)
1611 "Return an id: query for the Message-Id of the current message.
1613 If optional argument BARE is non-nil, return
1614 the Message-Id without id: prefix and escaping."
1616 (notmuch-show-get-prop :id)
1617 (notmuch-id-to-query (notmuch-show-get-prop :id))))
1619 (defun notmuch-show-get-messages-ids ()
1620 "Return all id: queries of messages in the current thread."
1621 (let ((message-ids))
1623 (lambda () (push (notmuch-show-get-message-id) message-ids)))
1626 (defun notmuch-show-get-messages-ids-search ()
1627 "Return a search string for all message ids of messages in the
1629 (mapconcat 'identity (notmuch-show-get-messages-ids) " or "))
1631 ;; dme: Would it make sense to use a macro for many of these?
1633 (defun notmuch-show-get-filename ()
1634 "Return the filename of the current message."
1635 (notmuch-show-get-prop :filename))
1637 (defun notmuch-show-get-header (header &optional props)
1638 "Return the named header of the current message, if any."
1639 (plist-get (notmuch-show-get-prop :headers props) header))
1641 (defun notmuch-show-get-cc ()
1642 (notmuch-show-get-header :Cc))
1644 (defun notmuch-show-get-date ()
1645 (notmuch-show-get-header :Date))
1647 (defun notmuch-show-get-from ()
1648 (notmuch-show-get-header :From))
1650 (defun notmuch-show-get-subject ()
1651 (notmuch-show-get-header :Subject))
1653 (defun notmuch-show-get-to ()
1654 (notmuch-show-get-header :To))
1656 (defun notmuch-show-get-depth ()
1657 (notmuch-show-get-prop :depth))
1659 (defun notmuch-show-set-tags (tags)
1660 "Set the tags of the current message."
1661 (notmuch-show-set-prop :tags tags)
1662 (notmuch-show-update-tags tags))
1664 (defun notmuch-show-get-tags ()
1665 "Return the tags of the current message."
1666 (notmuch-show-get-prop :tags))
1668 (defun notmuch-show-message-visible-p ()
1669 "Is the current message visible?"
1670 (notmuch-show-get-prop :message-visible))
1672 (defun notmuch-show-headers-visible-p ()
1673 "Are the headers of the current message visible?"
1674 (notmuch-show-get-prop :headers-visible))
1676 (put 'notmuch-show-mark-read 'notmuch-prefix-doc
1677 "Mark the current message as unread.")
1678 (defun notmuch-show-mark-read (&optional unread)
1679 "Mark the current message as read.
1681 Mark the current message as read by applying the tag changes in
1682 `notmuch-show-mark-read-tags' to it (remove the \"unread\" tag by
1683 default). If a prefix argument is given, the message will be
1684 marked as unread, i.e. the tag changes in
1685 `notmuch-show-mark-read-tags' will be reversed."
1687 (when notmuch-show-mark-read-tags
1688 (apply 'notmuch-show-tag-message
1689 (notmuch-tag-change-list notmuch-show-mark-read-tags unread))))
1691 (defun notmuch-show-seen-current-message (start end)
1692 "Mark the current message read if it is open.
1694 We only mark it read once: if it is changed back then that is a
1695 user decision and we should not override it."
1696 (when (and (notmuch-show-message-visible-p)
1697 (not (notmuch-show-get-prop :seen)))
1698 (notmuch-show-mark-read)
1699 (notmuch-show-set-prop :seen t)))
1701 (defun notmuch-show-command-hook ()
1702 (when (eq major-mode 'notmuch-show-mode)
1703 ;; We need to redisplay to get window-start and window-end correct.
1706 (funcall notmuch-show-mark-read-function (window-start) (window-end)))))
1708 (defun notmuch-show-filter-thread (query)
1709 "Filter or LIMIT the current thread based on a new query string.
1711 Reshows the current thread with matches defined by the new query-string."
1712 (interactive (list (notmuch-read-query "Filter thread: ")))
1713 (let ((msg-id (notmuch-show-get-message-id)))
1714 (setq notmuch-show-query-context (if (string= query "") nil query))
1715 (notmuch-show-refresh-view t)
1716 (notmuch-show-goto-message msg-id)))
1718 ;; Functions for getting attributes of several messages in the current
1721 (defun notmuch-show-get-message-ids-for-open-messages ()
1722 "Return a list of all id: queries for open messages in the current thread."
1724 (let (message-ids done)
1725 (goto-char (point-min))
1727 (if (notmuch-show-message-visible-p)
1728 (setq message-ids (append message-ids (list (notmuch-show-get-message-id)))))
1729 (setq done (not (notmuch-show-goto-message-next)))
1734 ;; Commands typically bound to keys.
1736 (defun notmuch-show-advance ()
1737 "Advance through thread.
1739 If the current message in the thread is not yet fully visible,
1740 scroll by a near screenful to read more of the message.
1742 Otherwise, (the end of the current message is already within the
1743 current window), advance to the next open message."
1745 (let* ((end-of-this-message (notmuch-show-message-bottom))
1746 (visible-end-of-this-message (1- end-of-this-message))
1748 (while (invisible-p visible-end-of-this-message)
1749 (setq visible-end-of-this-message
1751 (1- (previous-single-char-property-change
1752 visible-end-of-this-message 'invisible)))))
1754 ;; Ideally we would test `end-of-this-message' against the result
1755 ;; of `window-end', but that doesn't account for the fact that
1756 ;; the end of the message might be hidden.
1757 ((and visible-end-of-this-message
1758 (> visible-end-of-this-message (window-end)))
1759 ;; The bottom of this message is not visible - scroll.
1762 ((not (= end-of-this-message (point-max)))
1763 ;; This is not the last message - move to the next visible one.
1764 (notmuch-show-next-open-message))
1766 ((not (= (point) (point-max)))
1767 ;; This is the last message, but the cursor is not at the end of
1768 ;; the buffer. Move it there.
1769 (goto-char (point-max)))
1772 ;; This is the last message - change the return value
1776 (defun notmuch-show-advance-and-archive ()
1777 "Advance through thread and archive.
1779 This command is intended to be one of the simplest ways to
1780 process a thread of email. It works exactly like
1781 notmuch-show-advance, in that it scrolls through messages in a
1782 show buffer, except that when it gets to the end of the buffer it
1783 archives the entire current thread, (apply changes in
1784 `notmuch-archive-tags'), kills the buffer, and displays the next
1785 thread from the search from which this thread was originally
1788 (if (notmuch-show-advance)
1789 (notmuch-show-archive-thread-then-next)))
1791 (defun notmuch-show-rewind ()
1792 "Backup through the thread (reverse scrolling compared to \\[notmuch-show-advance-and-archive]).
1794 Specifically, if the beginning of the previous email is fewer
1795 than `window-height' lines from the current point, move to it
1796 just like `notmuch-show-previous-message'.
1798 Otherwise, just scroll down a screenful of the current message.
1800 This command does not modify any message tags, (it does not undo
1801 any effects from previous calls to
1802 `notmuch-show-advance-and-archive'."
1804 (let ((start-of-message (notmuch-show-message-top))
1805 (start-of-window (window-start)))
1807 ;; Either this message is properly aligned with the start of the
1808 ;; window or the start of this message is not visible on the
1810 ((or (= start-of-message start-of-window)
1811 (< start-of-message start-of-window))
1813 ;; If a small number of lines from the previous message are
1814 ;; visible, realign so that the top of the current message is at
1815 ;; the top of the screen.
1816 (when (<= (count-screen-lines (window-start) start-of-message)
1817 next-screen-context-lines)
1818 (goto-char (notmuch-show-message-top))
1819 (notmuch-show-message-adjust))
1820 ;; Move to the top left of the window.
1821 (goto-char (window-start)))
1823 ;; Move to the previous message.
1824 (notmuch-show-previous-message)))))
1826 (put 'notmuch-show-reply 'notmuch-prefix-doc "... and prompt for sender")
1827 (defun notmuch-show-reply (&optional prompt-for-sender)
1828 "Reply to the sender and all recipients of the current message."
1830 (notmuch-mua-new-reply (notmuch-show-get-message-id) prompt-for-sender t))
1832 (put 'notmuch-show-reply-sender 'notmuch-prefix-doc "... and prompt for sender")
1833 (defun notmuch-show-reply-sender (&optional prompt-for-sender)
1834 "Reply to the sender of the current message."
1836 (notmuch-mua-new-reply (notmuch-show-get-message-id) prompt-for-sender nil))
1838 (put 'notmuch-show-forward-message 'notmuch-prefix-doc
1839 "... and prompt for sender")
1840 (defun notmuch-show-forward-message (&optional prompt-for-sender)
1841 "Forward the current message."
1843 (notmuch-mua-new-forward-messages (list (notmuch-show-get-message-id))
1846 (put 'notmuch-show-forward-open-messages 'notmuch-prefix-doc
1847 "... and prompt for sender")
1848 (defun notmuch-show-forward-open-messages (&optional prompt-for-sender)
1849 "Forward the currently open messages."
1851 (let ((open-messages (notmuch-show-get-message-ids-for-open-messages)))
1852 (unless open-messages
1853 (error "No open messages to forward."))
1854 (notmuch-mua-new-forward-messages open-messages prompt-for-sender)))
1856 (defun notmuch-show-next-message (&optional pop-at-end)
1857 "Show the next message.
1859 If a prefix argument is given and this is the last message in the
1860 thread, navigate to the next thread in the parent search buffer."
1862 (if (notmuch-show-goto-message-next)
1863 (notmuch-show-message-adjust)
1865 (notmuch-show-next-thread)
1866 (goto-char (point-max)))))
1868 (defun notmuch-show-previous-message ()
1869 "Show the previous message or the start of the current message."
1871 (if (= (point) (notmuch-show-message-top))
1872 (notmuch-show-goto-message-previous)
1873 (notmuch-show-move-to-message-top))
1874 (notmuch-show-message-adjust))
1876 (defun notmuch-show-next-open-message (&optional pop-at-end)
1877 "Show the next open message.
1879 If a prefix argument is given and this is the last open message
1880 in the thread, navigate to the next thread in the parent search
1881 buffer. Return t if there was a next open message in the thread
1882 to show, nil otherwise."
1885 (while (and (setq r (notmuch-show-goto-message-next))
1886 (not (notmuch-show-message-visible-p))))
1888 (notmuch-show-message-adjust)
1890 (notmuch-show-next-thread)
1891 (goto-char (point-max))))
1894 (defun notmuch-show-next-matching-message ()
1895 "Show the next matching message."
1898 (while (and (setq r (notmuch-show-goto-message-next))
1899 (not (notmuch-show-get-prop :match))))
1901 (notmuch-show-message-adjust)
1902 (goto-char (point-max)))))
1904 (defun notmuch-show-open-if-matched ()
1905 "Open a message if it is matched (whether or not excluded)."
1906 (let ((props (notmuch-show-get-message-properties)))
1907 (notmuch-show-message-visible props (plist-get props :match))))
1909 (defun notmuch-show-goto-first-wanted-message ()
1910 "Move to the first open message and mark it read"
1911 (goto-char (point-min))
1912 (unless (notmuch-show-message-visible-p)
1913 (notmuch-show-next-open-message))
1915 ;; There are no matched non-excluded messages so open all matched
1916 ;; (necessarily excluded) messages and go to the first.
1917 (notmuch-show-mapc 'notmuch-show-open-if-matched)
1918 (force-window-update)
1919 (goto-char (point-min))
1920 (unless (notmuch-show-message-visible-p)
1921 (notmuch-show-next-open-message))))
1923 (defun notmuch-show-previous-open-message ()
1924 "Show the previous open message."
1926 (while (and (if (= (point) (notmuch-show-message-top))
1927 (notmuch-show-goto-message-previous)
1928 (notmuch-show-move-to-message-top))
1929 (not (notmuch-show-message-visible-p))))
1930 (notmuch-show-message-adjust))
1932 (defun notmuch-show-view-raw-message ()
1933 "View the original source of the current message."
1935 (let* ((id (notmuch-show-get-message-id))
1936 (buf (get-buffer-create (concat "*notmuch-raw-" id "*")))
1937 (inhibit-read-only t))
1938 (switch-to-buffer buf)
1940 (let ((coding-system-for-read 'no-conversion))
1941 (call-process notmuch-command nil t nil "show" "--format=raw" id))
1942 (goto-char (point-min))
1943 (set-buffer-modified-p nil)
1944 (setq buffer-read-only t)
1945 (view-buffer buf 'kill-buffer-if-not-modified)))
1947 (put 'notmuch-show-pipe-message 'notmuch-doc
1948 "Pipe the contents of the current message to a command.")
1949 (put 'notmuch-show-pipe-message 'notmuch-prefix-doc
1950 "Pipe the thread as an mbox to a command.")
1951 (defun notmuch-show-pipe-message (entire-thread command)
1952 "Pipe the contents of the current message (or thread) to COMMAND.
1954 COMMAND will be executed with the raw contents of the current
1955 email message as stdin. Anything printed by the command to stdout
1956 or stderr will appear in the *notmuch-pipe* buffer.
1958 If ENTIRE-THREAD is non-nil (or when invoked with a prefix
1959 argument), COMMAND will receive all open messages in the current
1960 thread (formatted as an mbox) rather than only the current
1962 (interactive (let ((query-string (if current-prefix-arg
1963 "Pipe all open messages to command: "
1964 "Pipe message to command: ")))
1965 (list current-prefix-arg (read-string query-string))))
1966 (let (shell-command)
1969 (concat notmuch-command " show --format=mbox --exclude=false "
1970 (shell-quote-argument
1971 (mapconcat 'identity (notmuch-show-get-message-ids-for-open-messages) " OR "))
1974 (concat notmuch-command " show --format=raw "
1975 (shell-quote-argument (notmuch-show-get-message-id)) " | " command)))
1976 (let ((cwd default-directory)
1977 (buf (get-buffer-create (concat "*notmuch-pipe*"))))
1978 (with-current-buffer buf
1979 (setq buffer-read-only nil)
1981 ;; Use the originating buffer's working directory instead of
1982 ;; that of the pipe buffer.
1984 (let ((exit-code (call-process-shell-command shell-command nil buf)))
1985 (goto-char (point-max))
1986 (set-buffer-modified-p nil)
1987 (setq buffer-read-only t)
1988 (unless (zerop exit-code)
1989 (switch-to-buffer-other-window buf)
1990 (message (format "Command '%s' exited abnormally with code %d"
1991 shell-command exit-code))))))))
1993 (defun notmuch-show-tag-message (&rest tag-changes)
1994 "Change tags for the current message.
1996 TAG-CHANGES is a list of tag operations for `notmuch-tag'."
1997 (let* ((current-tags (notmuch-show-get-tags))
1998 (new-tags (notmuch-update-tags current-tags tag-changes)))
1999 (unless (equal current-tags new-tags)
2000 (notmuch-tag (notmuch-show-get-message-id) tag-changes)
2001 (notmuch-show-set-tags new-tags))))
2003 (defun notmuch-show-tag (tag-changes)
2004 "Change tags for the current message.
2006 See `notmuch-tag' for information on the format of TAG-CHANGES."
2007 (interactive (list (notmuch-read-tag-changes (notmuch-show-get-tags)
2009 (notmuch-tag (notmuch-show-get-message-id) tag-changes)
2010 (let* ((current-tags (notmuch-show-get-tags))
2011 (new-tags (notmuch-update-tags current-tags tag-changes)))
2012 (unless (equal current-tags new-tags)
2013 (notmuch-show-set-tags new-tags))))
2015 (defun notmuch-show-tag-all (tag-changes)
2016 "Change tags for all messages in the current show buffer.
2018 See `notmuch-tag' for information on the format of TAG-CHANGES."
2022 (lambda () (setq tags (append (notmuch-show-get-tags) tags))))
2023 (notmuch-read-tag-changes tags "Tag thread"))))
2024 (notmuch-tag (notmuch-show-get-messages-ids-search) tag-changes)
2027 (let* ((current-tags (notmuch-show-get-tags))
2028 (new-tags (notmuch-update-tags current-tags tag-changes)))
2029 (unless (equal current-tags new-tags)
2030 (notmuch-show-set-tags new-tags))))))
2032 (defun notmuch-show-add-tag (tag-changes)
2033 "Change tags for the current message (defaulting to add).
2035 Same as `notmuch-show-tag' but sets initial input to '+'."
2037 (list (notmuch-read-tag-changes (notmuch-show-get-tags) "Tag message" "+")))
2038 (notmuch-show-tag tag-changes))
2040 (defun notmuch-show-remove-tag (tag-changes)
2041 "Change tags for the current message (defaulting to remove).
2043 Same as `notmuch-show-tag' but sets initial input to '-'."
2045 (list (notmuch-read-tag-changes (notmuch-show-get-tags) "Tag message" "-")))
2046 (notmuch-show-tag tag-changes))
2048 (defun notmuch-show-toggle-visibility-headers ()
2049 "Toggle the visibility of the current message headers."
2051 (let ((props (notmuch-show-get-message-properties)))
2052 (notmuch-show-headers-visible
2054 (not (plist-get props :headers-visible))))
2055 (force-window-update))
2057 (defun notmuch-show-toggle-message ()
2058 "Toggle the visibility of the current message."
2060 (let ((props (notmuch-show-get-message-properties)))
2061 (notmuch-show-message-visible
2063 (not (plist-get props :message-visible))))
2064 (force-window-update))
2066 (put 'notmuch-show-open-or-close-all 'notmuch-doc "Show all messages.")
2067 (put 'notmuch-show-open-or-close-all 'notmuch-prefix-doc "Hide all messages.")
2068 (defun notmuch-show-open-or-close-all ()
2069 "Set the visibility all of the messages in the current thread.
2071 By default make all of the messages visible. With a prefix
2072 argument, hide all of the messages."
2075 (goto-char (point-min))
2076 (loop do (notmuch-show-message-visible (notmuch-show-get-message-properties)
2077 (not current-prefix-arg))
2078 until (not (notmuch-show-goto-message-next))))
2079 (force-window-update))
2081 (defun notmuch-show-next-button ()
2082 "Advance point to the next button in the buffer."
2086 (defun notmuch-show-previous-button ()
2087 "Move point back to the previous button in the buffer."
2089 (backward-button 1))
2091 (defun notmuch-show-next-thread (&optional show previous)
2092 "Move to the next item in the search results, if any.
2094 If SHOW is non-nil, open the next item in a show
2095 buffer. Otherwise just highlight the next item in the search
2096 buffer. If PREVIOUS is non-nil, move to the previous item in the
2097 search results instead."
2099 (let ((parent-buffer notmuch-show-parent-buffer))
2100 (notmuch-bury-or-kill-this-buffer)
2101 (when (buffer-live-p parent-buffer)
2102 (switch-to-buffer parent-buffer)
2104 (notmuch-search-previous-thread)
2105 (notmuch-search-next-thread))
2107 (notmuch-search-show-thread)))))
2109 (defun notmuch-show-next-thread-show ()
2110 "Show the next thread in the search results, if any."
2112 (notmuch-show-next-thread t))
2114 (defun notmuch-show-previous-thread-show ()
2115 "Show the previous thread in the search results, if any."
2117 (notmuch-show-next-thread t t))
2119 (put 'notmuch-show-archive-thread 'notmuch-prefix-doc
2120 "Un-archive each message in thread.")
2121 (defun notmuch-show-archive-thread (&optional unarchive)
2122 "Archive each message in thread.
2124 Archive each message currently shown by applying the tag changes
2125 in `notmuch-archive-tags' to each. If a prefix argument is given,
2126 the messages will be \"unarchived\", i.e. the tag changes in
2127 `notmuch-archive-tags' will be reversed.
2129 Note: This command is safe from any race condition of new messages
2130 being delivered to the same thread. It does not archive the
2131 entire thread, but only the messages shown in the current
2134 (when notmuch-archive-tags
2135 (notmuch-show-tag-all
2136 (notmuch-tag-change-list notmuch-archive-tags unarchive))))
2138 (defun notmuch-show-archive-thread-then-next ()
2139 "Archive all messages in the current buffer, then show next thread from search."
2141 (notmuch-show-archive-thread)
2142 (notmuch-show-next-thread t))
2144 (defun notmuch-show-archive-thread-then-exit ()
2145 "Archive all messages in the current buffer, then exit back to search results."
2147 (notmuch-show-archive-thread)
2148 (notmuch-show-next-thread))
2150 (put 'notmuch-show-archive-message 'notmuch-prefix-doc
2151 "Un-archive the current message.")
2152 (defun notmuch-show-archive-message (&optional unarchive)
2153 "Archive the current message.
2155 Archive the current message by applying the tag changes in
2156 `notmuch-archive-tags' to it. If a prefix argument is given, the
2157 message will be \"unarchived\", i.e. the tag changes in
2158 `notmuch-archive-tags' will be reversed."
2160 (when notmuch-archive-tags
2161 (apply 'notmuch-show-tag-message
2162 (notmuch-tag-change-list notmuch-archive-tags unarchive))))
2164 (defun notmuch-show-archive-message-then-next-or-exit ()
2165 "Archive the current message, then show the next open message in the current thread.
2167 If at the last open message in the current thread, then exit back
2170 (notmuch-show-archive-message)
2171 (notmuch-show-next-open-message t))
2173 (defun notmuch-show-archive-message-then-next-or-next-thread ()
2174 "Archive the current message, then show the next open message in the current thread.
2176 If at the last open message in the current thread, then show next
2177 thread from search."
2179 (notmuch-show-archive-message)
2180 (unless (notmuch-show-next-open-message)
2181 (notmuch-show-next-thread t)))
2183 (defun notmuch-show-stash-cc ()
2184 "Copy CC field of current message to kill-ring."
2186 (notmuch-common-do-stash (notmuch-show-get-cc)))
2188 (defun notmuch-show-stash-date ()
2189 "Copy date of current message to kill-ring."
2191 (notmuch-common-do-stash (notmuch-show-get-date)))
2193 (defun notmuch-show-stash-filename ()
2194 "Copy filename of current message to kill-ring."
2196 (notmuch-common-do-stash (notmuch-show-get-filename)))
2198 (defun notmuch-show-stash-from ()
2199 "Copy From address of current message to kill-ring."
2201 (notmuch-common-do-stash (notmuch-show-get-from)))
2203 (put 'notmuch-show-stash-message-id 'notmuch-prefix-doc
2204 "Copy thread: query matching current thread to kill-ring.")
2205 (defun notmuch-show-stash-message-id (&optional stash-thread-id)
2206 "Copy id: query matching the current message to kill-ring.
2208 If invoked with a prefix argument (or STASH-THREAD-ID is
2209 non-nil), copy thread: query matching the current thread to
2213 (notmuch-common-do-stash notmuch-show-thread-id)
2214 (notmuch-common-do-stash (notmuch-show-get-message-id))))
2216 (defun notmuch-show-stash-message-id-stripped ()
2217 "Copy message ID of current message (sans `id:' prefix) to kill-ring."
2219 (notmuch-common-do-stash (notmuch-show-get-message-id t)))
2221 (defun notmuch-show-stash-subject ()
2222 "Copy Subject field of current message to kill-ring."
2224 (notmuch-common-do-stash (notmuch-show-get-subject)))
2226 (defun notmuch-show-stash-tags ()
2227 "Copy tags of current message to kill-ring as a comma separated list."
2229 (notmuch-common-do-stash (mapconcat 'identity (notmuch-show-get-tags) ",")))
2231 (defun notmuch-show-stash-to ()
2232 "Copy To address of current message to kill-ring."
2234 (notmuch-common-do-stash (notmuch-show-get-to)))
2236 (defun notmuch-show-stash-mlarchive-link (&optional mla)
2237 "Copy an ML Archive URI for the current message to the kill-ring.
2239 This presumes that the message is available at the selected Mailing List Archive.
2241 If optional argument MLA is non-nil, use the provided key instead of prompting
2242 the user (see `notmuch-show-stash-mlarchive-link-alist')."
2244 (let ((url (cdr (assoc
2246 (let ((completion-ignore-case t))
2248 "Mailing List Archive: "
2249 notmuch-show-stash-mlarchive-link-alist
2251 notmuch-show-stash-mlarchive-link-default)))
2252 notmuch-show-stash-mlarchive-link-alist))))
2253 (notmuch-common-do-stash
2255 (funcall url (notmuch-show-get-message-id t))
2256 (concat url (notmuch-show-get-message-id t))))))
2258 (defun notmuch-show-stash-mlarchive-link-and-go (&optional mla)
2259 "Copy an ML Archive URI for the current message to the kill-ring and visit it.
2261 This presumes that the message is available at the selected Mailing List Archive.
2263 If optional argument MLA is non-nil, use the provided key instead of prompting
2264 the user (see `notmuch-show-stash-mlarchive-link-alist')."
2266 (notmuch-show-stash-mlarchive-link mla)
2267 (browse-url (current-kill 0 t)))
2269 (defun notmuch-show-stash-git-helper (addresses prefix)
2270 "Escape, trim, quote, and add PREFIX to each address in list of ADDRESSES, and return the result as a single string."
2271 (mapconcat (lambda (x)
2273 ;; escape double-quotes
2274 (replace-regexp-in-string
2276 ;; trim leading and trailing spaces
2277 (replace-regexp-in-string
2278 "\\(^ *\\| *$\\)" ""
2282 (put 'notmuch-show-stash-git-send-email 'notmuch-prefix-doc
2283 "Copy From/To/Cc of current message to kill-ring in a form suitable for pasting to git send-email command line.")
2285 (defun notmuch-show-stash-git-send-email (&optional no-in-reply-to)
2286 "Copy From/To/Cc/Message-Id of current message to kill-ring in a form suitable for pasting to git send-email command line.
2288 If invoked with a prefix argument (or NO-IN-REPLY-TO is non-nil),
2289 omit --in-reply-to=<Message-Id>."
2291 (notmuch-common-do-stash
2292 (mapconcat 'identity
2295 (notmuch-show-stash-git-helper
2296 (message-tokenize-header (notmuch-show-get-from)) "--to=")
2297 (notmuch-show-stash-git-helper
2298 (message-tokenize-header (notmuch-show-get-to)) "--to=")
2299 (notmuch-show-stash-git-helper
2300 (message-tokenize-header (notmuch-show-get-cc)) "--cc=")
2301 (unless no-in-reply-to
2302 (notmuch-show-stash-git-helper
2303 (list (notmuch-show-get-message-id t)) "--in-reply-to="))))
2306 ;; Interactive part functions and their helpers
2308 (defun notmuch-show-generate-part-buffer (msg part)
2309 "Return a temporary buffer containing the specified part's content."
2310 (let ((buf (generate-new-buffer " *notmuch-part*"))
2311 (process-crypto notmuch-show-process-crypto))
2312 (with-current-buffer buf
2313 ;; This is always used in the content of mm handles, which
2314 ;; expect undecoded, binary part content.
2315 (insert (notmuch-get-bodypart-binary msg part process-crypto)))
2318 (defun notmuch-show-current-part-handle ()
2319 "Return an mm-handle for the part containing point.
2321 This creates a temporary buffer for the part's content; the
2322 caller is responsible for killing this buffer as appropriate."
2323 (let* ((msg (notmuch-show-get-message-properties))
2324 (part (notmuch-show-get-part-properties))
2325 (buf (notmuch-show-generate-part-buffer msg part))
2326 (computed-type (plist-get part :computed-type))
2327 (filename (plist-get part :filename))
2328 (disposition (if filename `(attachment (filename . ,filename)))))
2329 (mm-make-handle buf (list computed-type) nil nil disposition)))
2331 (defun notmuch-show-apply-to-current-part-handle (fn)
2332 "Apply FN to an mm-handle for the part containing point.
2334 This ensures that the temporary buffer created for the mm-handle
2335 is destroyed when FN returns."
2336 (let ((handle (notmuch-show-current-part-handle)))
2337 ;; emacs 24.3+ puts stdout/stderr into the calling buffer so we
2338 ;; call it from a temp-buffer, unless
2339 ;; notmuch-show-attachment-debug is non-nil in which case we put
2340 ;; it in " *notmuch-part*".
2342 (if notmuch-show-attachment-debug
2343 (with-current-buffer (generate-new-buffer " *notmuch-part*")
2344 (funcall fn handle))
2346 (funcall fn handle)))
2347 (kill-buffer (mm-handle-buffer handle)))))
2349 (defun notmuch-show-part-button-default (&optional button)
2351 (let ((button (or button (button-at (point)))))
2352 ;; Try to toggle the part, if that fails then call the default
2353 ;; action. The toggle fails if the part has no emacs renderable
2355 (unless (notmuch-show-toggle-part-invisibility button)
2356 (call-interactively notmuch-show-part-button-default-action))))
2358 (defun notmuch-show-save-part ()
2359 "Save the MIME part containing point to a file."
2361 (notmuch-show-apply-to-current-part-handle #'mm-save-part))
2363 (defun notmuch-show-view-part ()
2364 "View the MIME part containing point in an external viewer."
2366 ;; Set mm-inlined-types to nil to force an external viewer
2367 (let ((mm-inlined-types nil))
2368 (notmuch-show-apply-to-current-part-handle #'mm-display-part)))
2370 (defun notmuch-show-interactively-view-part ()
2371 "View the MIME part containing point, prompting for a viewer."
2373 (notmuch-show-apply-to-current-part-handle #'mm-interactively-view-part))
2375 (defun notmuch-show-pipe-part ()
2376 "Pipe the MIME part containing point to an external command."
2378 (notmuch-show-apply-to-current-part-handle #'mm-pipe-part))
2381 (provide 'notmuch-show)