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-query)
34 (require 'notmuch-wash)
35 (require 'notmuch-mua)
36 (require 'notmuch-crypto)
38 (declare-function notmuch-call-notmuch-process "notmuch" (&rest args))
39 (declare-function notmuch-fontify-headers "notmuch" nil)
40 (declare-function notmuch-select-tag-with-completion "notmuch" (prompt &rest search-terms))
41 (declare-function notmuch-search-show-thread "notmuch" nil)
43 (defcustom notmuch-message-headers '("Subject" "To" "Cc" "Date")
44 "Headers that should be shown in a message, in this order.
46 For an open message, all of these headers will be made visible
47 according to `notmuch-message-headers-visible' or can be toggled
48 with `notmuch-show-toggle-headers'. For a closed message, only
49 the first header in the list will be visible."
51 :type '(repeat string))
53 (defcustom notmuch-message-headers-visible t
54 "Should the headers be visible by default?
56 If this value is non-nil, then all of the headers defined in
57 `notmuch-message-headers' will be visible by default in the display
58 of each message. Otherwise, these headers will be hidden and
59 `notmuch-show-toggle-headers' can be used to make the visible for
64 (defcustom notmuch-show-relative-dates t
65 "Display relative dates in the message summary line."
69 (defvar notmuch-show-markup-headers-hook '(notmuch-show-colour-headers)
70 "A list of functions called to decorate the headers listed in
71 `notmuch-message-headers'.")
73 (defcustom notmuch-show-hook nil
74 "Functions called after populating a `notmuch-show' buffer."
78 (defcustom notmuch-show-insert-text/plain-hook '(notmuch-wash-wrap-long-lines
79 notmuch-wash-tidy-citations
80 notmuch-wash-elide-blank-lines
81 notmuch-wash-excerpt-citations)
82 "Functions used to improve the display of text/plain parts."
85 :options '(notmuch-wash-convert-inline-patch-to-part
86 notmuch-wash-wrap-long-lines
87 notmuch-wash-tidy-citations
88 notmuch-wash-elide-blank-lines
89 notmuch-wash-excerpt-citations))
91 ;; Mostly useful for debugging.
92 (defcustom notmuch-show-all-multipart/alternative-parts t
93 "Should all parts of multipart/alternative parts be shown?"
97 (defcustom notmuch-show-indent-messages-width 1
98 "Width of message indentation in threads.
100 Messages are shown indented according to their depth in a thread.
101 This variable determines the width of this indentation measured
102 in number of blanks. Defaults to `1', choose `0' to disable
107 (defcustom notmuch-show-indent-multipart nil
108 "Should the sub-parts of a multipart/* part be indented?"
109 ;; dme: Not sure which is a good default.
113 (defmacro with-current-notmuch-show-message (&rest body)
114 "Evaluate body with current buffer set to the text of current message"
116 (let ((id (notmuch-show-get-message-id)))
117 (let ((buf (generate-new-buffer (concat "*notmuch-msg-" id "*"))))
118 (with-current-buffer buf
119 (call-process notmuch-command nil t nil "show" "--format=raw" id)
121 (kill-buffer buf)))))
123 (defun notmuch-show-view-all-mime-parts ()
124 "Use external viewers to view all attachments from the current message."
126 (with-current-notmuch-show-message
127 ; We override the mm-inline-media-tests to indicate which message
128 ; parts are already sufficiently handled by the original
129 ; presentation of the message in notmuch-show mode. These parts
130 ; will be inserted directly into the temporary buffer of
131 ; with-current-notmuch-show-message and silently discarded.
133 ; Any MIME part not explicitly mentioned here will be handled by an
134 ; external viewer as configured in the various mailcap files.
135 (let ((mm-inline-media-tests '(
136 ("text/.*" ignore identity)
137 ("application/pgp-signature" ignore identity)
138 ("multipart/alternative" ignore identity)
139 ("multipart/mixed" ignore identity)
140 ("multipart/related" ignore identity)
142 (mm-display-parts (mm-dissect-buffer)))))
144 (defun notmuch-foreach-mime-part (function mm-handle)
145 (cond ((stringp (car mm-handle))
146 (dolist (part (cdr mm-handle))
147 (notmuch-foreach-mime-part function part)))
148 ((bufferp (car mm-handle))
149 (funcall function mm-handle))
150 (t (dolist (part mm-handle)
151 (notmuch-foreach-mime-part function part)))))
153 (defun notmuch-count-attachments (mm-handle)
155 (notmuch-foreach-mime-part
157 (let ((disposition (mm-handle-disposition p)))
158 (and (listp disposition)
159 (or (equal (car disposition) "attachment")
160 (and (equal (car disposition) "inline")
161 (assq 'filename disposition)))
166 (defun notmuch-save-attachments (mm-handle &optional queryp)
167 (notmuch-foreach-mime-part
169 (let ((disposition (mm-handle-disposition p)))
170 (and (listp disposition)
171 (or (equal (car disposition) "attachment")
172 (and (equal (car disposition) "inline")
173 (assq 'filename disposition)))
176 (concat "Save '" (cdr (assq 'filename disposition)) "' ")))
180 (defun notmuch-show-save-attachments ()
181 "Save all attachments from the current message."
183 (with-current-notmuch-show-message
184 (let ((mm-handle (mm-dissect-buffer)))
185 (notmuch-save-attachments
186 mm-handle (> (notmuch-count-attachments mm-handle) 1))))
189 (defun notmuch-show-fontify-header ()
191 ((looking-at "[Tt]o:")
193 ((looking-at "[Bb]?[Cc][Cc]:")
195 ((looking-at "[Ss]ubject:")
196 'message-header-subject)
197 ((looking-at "[Ff]rom:")
198 'message-header-from)
200 'message-header-other))))
202 (overlay-put (make-overlay (point) (re-search-forward ":"))
203 'face 'message-header-name)
204 (overlay-put (make-overlay (point) (re-search-forward ".*$"))
207 (defun notmuch-show-colour-headers ()
208 "Apply some colouring to the current headers."
209 (goto-char (point-min))
210 (while (looking-at "^[A-Za-z][-A-Za-z0-9]*:")
211 (notmuch-show-fontify-header)
214 (defun notmuch-show-spaces-n (n)
215 "Return a string comprised of `n' spaces."
218 (defun notmuch-show-update-tags (tags)
219 "Update the displayed tags of the current message."
221 (goto-char (notmuch-show-message-top))
222 (if (re-search-forward "(\\([^()]*\\))$" (line-end-position) t)
223 (let ((inhibit-read-only t))
224 (replace-match (concat "("
225 (propertize (mapconcat 'identity tags " ")
226 'face 'notmuch-tag-face)
229 (defun notmuch-show-clean-address (address)
230 "Try to clean a single email ADDRESS for display. Return
231 unchanged ADDRESS if parsing fails."
233 (let* ((parsed (mail-header-parse-address address))
234 (address (car parsed))
236 ;; Remove double quotes. They might be required during transport,
237 ;; but we don't need to see them.
239 (setq name (replace-regexp-in-string "\"" "" name)))
240 ;; If the address is 'foo@bar.com <foo@bar.com>' then show just
242 (when (string= name address)
247 (concat name " <" address ">")))
250 (defun notmuch-show-insert-headerline (headers date tags depth)
251 "Insert a notmuch style headerline based on HEADERS for a
252 message at DEPTH in the current thread."
253 (let ((start (point)))
254 (insert (notmuch-show-spaces-n (* notmuch-show-indent-messages-width depth))
255 (notmuch-show-clean-address (plist-get headers :From))
259 (propertize (mapconcat 'identity tags " ")
260 'face 'notmuch-tag-face)
262 (overlay-put (make-overlay start (point)) 'face 'notmuch-message-summary-face)))
264 (defun notmuch-show-insert-header (header header-value)
265 "Insert a single header."
266 (insert header ": " header-value "\n"))
268 (defun notmuch-show-insert-headers (headers)
269 "Insert the headers of the current message."
270 (let ((start (point)))
271 (mapc (lambda (header)
272 (let* ((header-symbol (intern (concat ":" header)))
273 (header-value (plist-get headers header-symbol)))
274 (if (and header-value
275 (not (string-equal "" header-value)))
276 (notmuch-show-insert-header header header-value))))
277 notmuch-message-headers)
280 (narrow-to-region start (point-max))
281 (run-hooks 'notmuch-show-markup-headers-hook)))))
283 (define-button-type 'notmuch-show-part-button-type
284 'action 'notmuch-show-part-button-action
288 (defun notmuch-show-insert-part-header (nth content-type declared-type &optional name comment)
293 (if name (concat name ": ") "")
295 (if (not (string-equal declared-type content-type))
296 (concat " (as " content-type ")")
300 :type 'notmuch-show-part-button-type
302 :notmuch-filename name))
307 ;; Functions handling particular MIME parts.
309 (defun notmuch-show-save-part (message-id nth &optional filename)
310 (let ((process-crypto notmuch-show-process-crypto))
312 (setq notmuch-show-process-crypto process-crypto)
313 ;; Always acquires the part via `notmuch part', even if it is
314 ;; available in the JSON output.
315 (insert (notmuch-show-get-bodypart-internal message-id nth))
316 (let ((file (read-file-name
317 "Filename to save as: "
318 (or mailcap-download-directory "~/")
321 ;; Don't re-compress .gz & al. Arguably we should make
322 ;; `file-name-handler-alist' nil, but that would chop
323 ;; ange-ftp, which is reasonable to use here.
324 (mm-write-region (point-min) (point-max) file nil nil nil 'no-conversion t)))))
326 (defun notmuch-show-mm-display-part-inline (msg part nth content-type)
327 "Use the mm-decode/mm-view functions to display a part in the
328 current buffer, if possible."
329 (let ((display-buffer (current-buffer)))
331 (let* ((charset (plist-get part :content-charset))
332 (handle (mm-make-handle (current-buffer) `(,content-type (charset . ,charset)))))
333 (if (and (mm-inlinable-p handle)
334 (mm-inlined-p handle))
335 (let ((content (notmuch-show-get-bodypart-content msg part nth)))
337 (set-buffer display-buffer)
338 (mm-display-part handle)
342 (defvar notmuch-show-multipart/alternative-discouraged
346 ;; multipart/related usually contain a text/html part and some associated graphics.
350 (defun notmuch-show-multipart/*-to-list (part)
351 (mapcar (lambda (inner-part) (plist-get inner-part :content-type))
352 (plist-get part :content)))
354 (defun notmuch-show-multipart/alternative-choose (types)
355 ;; Based on `mm-preferred-alternative-precedence'.
357 (dolist (pref (reverse notmuch-show-multipart/alternative-discouraged))
358 (dolist (elem (copy-sequence seq))
359 (when (string-match pref elem)
360 (setq seq (nconc (delete elem seq) (list elem))))))
363 (defun notmuch-show-insert-part-multipart/alternative (msg part content-type nth depth declared-type)
364 (notmuch-show-insert-part-header nth declared-type content-type nil)
365 (let ((chosen-type (car (notmuch-show-multipart/alternative-choose (notmuch-show-multipart/*-to-list part))))
366 (inner-parts (plist-get part :content))
368 ;; This inserts all parts of the chosen type rather than just one,
369 ;; but it's not clear that this is the wrong thing to do - which
370 ;; should be chosen if there are more than one that match?
371 (mapc (lambda (inner-part)
372 (let ((inner-type (plist-get inner-part :content-type)))
373 (if (or notmuch-show-all-multipart/alternative-parts
374 (string= chosen-type inner-type))
375 (notmuch-show-insert-bodypart msg inner-part depth)
376 (notmuch-show-insert-part-header (plist-get inner-part :id) inner-type inner-type nil " (not shown)"))))
379 (when notmuch-show-indent-multipart
380 (indent-rigidly start (point) 1)))
383 (defun notmuch-show-setup-w3m ()
384 "Instruct w3m how to retrieve content from a \"related\" part of a message."
386 (if (boundp 'w3m-cid-retrieve-function-alist)
387 (unless (assq 'notmuch-show-mode w3m-cid-retrieve-function-alist)
388 (push (cons 'notmuch-show-mode 'notmuch-show-w3m-cid-retrieve)
389 w3m-cid-retrieve-function-alist)))
390 (setq mm-inline-text-html-with-images t))
392 (defvar w3m-current-buffer) ;; From `w3m.el'.
393 (defvar notmuch-show-w3m-cid-store nil)
394 (make-variable-buffer-local 'notmuch-show-w3m-cid-store)
396 (defun notmuch-show-w3m-cid-store-internal (content-id
401 (push (list content-id
406 notmuch-show-w3m-cid-store))
408 (defun notmuch-show-w3m-cid-store (msg part)
409 (let ((content-id (plist-get part :content-id)))
411 (notmuch-show-w3m-cid-store-internal (concat "cid:" content-id)
414 (plist-get part :content-type)
417 (defun notmuch-show-w3m-cid-retrieve (url &rest args)
418 (let ((matching-part (with-current-buffer w3m-current-buffer
419 (assoc url notmuch-show-w3m-cid-store))))
421 (let ((message-id (nth 1 matching-part))
422 (part-number (nth 2 matching-part))
423 (content-type (nth 3 matching-part))
424 (content (nth 4 matching-part)))
425 ;; If we don't already have the content, get it and cache
426 ;; it, as some messages reference the same cid: part many
427 ;; times (hundreds!), which results in many calls to
430 (setq content (notmuch-show-get-bodypart-internal (concat "id:" message-id)
432 (with-current-buffer w3m-current-buffer
433 (notmuch-show-w3m-cid-store-internal url
442 (defun notmuch-show-insert-part-multipart/related (msg part content-type nth depth declared-type)
443 (notmuch-show-insert-part-header nth declared-type content-type nil)
444 (let ((inner-parts (plist-get part :content))
447 ;; We assume that the first part is text/html and the remainder
448 ;; things that it references.
450 ;; Stash the non-primary parts.
452 (notmuch-show-w3m-cid-store msg part))
455 ;; Render the primary part.
456 (notmuch-show-insert-bodypart msg (car inner-parts) depth)
458 (when notmuch-show-indent-multipart
459 (indent-rigidly start (point) 1)))
462 (defun notmuch-show-insert-part-multipart/signed (msg part content-type nth depth declared-type)
463 (let ((button (notmuch-show-insert-part-header nth declared-type content-type nil)))
464 (button-put button 'face 'notmuch-crypto-part-header)
465 ;; add signature status button if sigstatus provided
466 (if (plist-member part :sigstatus)
467 (let* ((from (notmuch-show-get-header :From msg))
468 (sigstatus (car (plist-get part :sigstatus))))
469 (notmuch-crypto-insert-sigstatus-button sigstatus from))
470 ;; if we're not adding sigstatus, tell the user how they can get it
471 (button-put button 'help-echo "Set notmuch-crypto-process-mime to process cryptographic mime parts.")))
473 (let ((inner-parts (plist-get part :content))
475 ;; Show all of the parts.
476 (mapc (lambda (inner-part)
477 (notmuch-show-insert-bodypart msg inner-part depth))
480 (when notmuch-show-indent-multipart
481 (indent-rigidly start (point) 1)))
484 (defun notmuch-show-insert-part-multipart/encrypted (msg part content-type nth depth declared-type)
485 (let ((button (notmuch-show-insert-part-header nth declared-type content-type nil)))
486 (button-put button 'face 'notmuch-crypto-part-header)
487 ;; add encryption status button if encstatus specified
488 (if (plist-member part :encstatus)
489 (let ((encstatus (car (plist-get part :encstatus))))
490 (notmuch-crypto-insert-encstatus-button encstatus)
491 ;; add signature status button if sigstatus specified
492 (if (plist-member part :sigstatus)
493 (let* ((from (notmuch-show-get-header :From msg))
494 (sigstatus (car (plist-get part :sigstatus))))
495 (notmuch-crypto-insert-sigstatus-button sigstatus from))))
496 ;; if we're not adding encstatus, tell the user how they can get it
497 (button-put button 'help-echo "Set notmuch-crypto-process-mime to process cryptographic mime parts.")))
499 (let ((inner-parts (plist-get part :content))
501 ;; Show all of the parts.
502 (mapc (lambda (inner-part)
503 (notmuch-show-insert-bodypart msg inner-part depth))
506 (when notmuch-show-indent-multipart
507 (indent-rigidly start (point) 1)))
510 (defun notmuch-show-insert-part-multipart/* (msg part content-type nth depth declared-type)
511 (notmuch-show-insert-part-header nth declared-type content-type nil)
512 (let ((inner-parts (plist-get part :content))
514 ;; Show all of the parts.
515 (mapc (lambda (inner-part)
516 (notmuch-show-insert-bodypart msg inner-part depth))
519 (when notmuch-show-indent-multipart
520 (indent-rigidly start (point) 1)))
523 (defun notmuch-show-insert-part-message/rfc822 (msg part content-type nth depth declared-type)
524 (notmuch-show-insert-part-header nth declared-type content-type nil)
525 (let* ((message (car (plist-get part :content)))
526 (body (car (plist-get message :body)))
529 ;; Override `notmuch-message-headers' to force `From' to be
531 (let ((notmuch-message-headers '("From" "Subject" "To" "Cc" "Date")))
532 (notmuch-show-insert-headers (plist-get message :headers)))
534 ;; Blank line after headers to be compatible with the normal
539 (notmuch-show-insert-bodypart msg body depth)
541 (when notmuch-show-indent-multipart
542 (indent-rigidly start (point) 1)))
545 (defun notmuch-show-insert-part-text/plain (msg part content-type nth depth declared-type)
546 (let ((start (point)))
547 ;; If this text/plain part is not the first part in the message,
548 ;; insert a header to make this clear.
550 (notmuch-show-insert-part-header nth declared-type content-type (plist-get part :filename)))
551 (insert (notmuch-show-get-bodypart-content msg part nth))
554 (narrow-to-region start (point-max))
555 (run-hook-with-args 'notmuch-show-insert-text/plain-hook msg depth))))
558 (defun notmuch-show-insert-part-text/x-vcalendar (msg part content-type nth depth declared-type)
559 (notmuch-show-insert-part-header nth declared-type content-type (plist-get part :filename))
560 (insert (with-temp-buffer
561 (insert (notmuch-show-get-bodypart-content msg part nth))
562 (goto-char (point-min))
563 (let ((file (make-temp-file "notmuch-ical"))
565 (icalendar--convert-ical-to-diary
566 (icalendar--read-element nil nil)
568 (set-buffer (get-file-buffer file))
569 (setq result (buffer-substring (point-min) (point-max)))
570 (set-buffer-modified-p nil)
571 (kill-buffer (current-buffer))
576 (defun notmuch-show-insert-part-application/octet-stream (msg part content-type nth depth declared-type)
577 ;; If we can deduce a MIME type from the filename of the attachment,
578 ;; do so and pass it on to the handler for that type.
579 (if (plist-get part :filename)
580 (let ((extension (file-name-extension (plist-get part :filename)))
584 (mailcap-parse-mimetypes)
585 (setq mime-type (mailcap-extension-to-mime extension))
587 (not (string-equal mime-type "application/octet-stream")))
588 (notmuch-show-insert-bodypart-internal msg part mime-type nth depth content-type)
592 ;; Handler for wash generated inline patch fake parts.
593 (defun notmuch-show-insert-part-inline-patch-fake-part (msg part content-type nth depth declared-type)
594 (notmuch-show-insert-part-*/* msg part "text/x-diff" nth depth "inline patch"))
596 (defun notmuch-show-insert-part-*/* (msg part content-type nth depth declared-type)
597 ;; This handler _must_ succeed - it is the handler of last resort.
598 (notmuch-show-insert-part-header nth content-type declared-type (plist-get part :filename))
599 (notmuch-show-mm-display-part-inline msg part nth content-type)
602 ;; Functions for determining how to handle MIME parts.
604 (defun notmuch-show-split-content-type (content-type)
605 (split-string content-type "/"))
607 (defun notmuch-show-handlers-for (content-type)
608 "Return a list of content handlers for a part of type CONTENT-TYPE."
613 ;; Reverse order of prefrence.
614 (list (intern (concat "notmuch-show-insert-part-*/*"))
616 "notmuch-show-insert-part-"
617 (car (notmuch-show-split-content-type content-type))
619 (intern (concat "notmuch-show-insert-part-" content-type))))
622 ;; Helper for parts which are generally not included in the default
624 ;; Uses the buffer-local variable notmuch-show-process-crypto to
625 ;; determine if parts should be decrypted first.
626 (defun notmuch-show-get-bodypart-internal (message-id part-number)
627 (let ((args '("show" "--format=raw"))
628 (part-arg (format "--part=%s" part-number)))
629 (setq args (append args (list part-arg)))
630 (if notmuch-show-process-crypto
631 (setq args (append args '("--decrypt"))))
632 (setq args (append args (list message-id)))
634 (let ((coding-system-for-read 'no-conversion))
636 (apply 'call-process (append (list notmuch-command nil (list t nil) nil) args))
639 (defun notmuch-show-get-bodypart-content (msg part nth)
640 (or (plist-get part :content)
641 (notmuch-show-get-bodypart-internal (concat "id:" (plist-get msg :id)) nth)))
645 (defun notmuch-show-insert-bodypart-internal (msg part content-type nth depth declared-type)
646 (let ((handlers (notmuch-show-handlers-for content-type)))
647 ;; Run the content handlers until one of them returns a non-nil
650 (not (funcall (car handlers) msg part content-type nth depth declared-type)))
651 (setq handlers (cdr handlers))))
654 (defun notmuch-show-insert-bodypart (msg part depth)
655 "Insert the body part PART at depth DEPTH in the current thread."
656 (let ((content-type (downcase (plist-get part :content-type)))
657 (nth (plist-get part :id)))
658 (notmuch-show-insert-bodypart-internal msg part content-type nth depth content-type))
659 ;; Some of the body part handlers leave point somewhere up in the
660 ;; part, so we make sure that we're down at the end.
661 (goto-char (point-max))
662 ;; Ensure that the part ends with a carriage return.
666 (defun notmuch-show-insert-body (msg body depth)
667 "Insert the body BODY at depth DEPTH in the current thread."
668 (mapc (lambda (part) (notmuch-show-insert-bodypart msg part depth)) body))
670 (defun notmuch-show-make-symbol (type)
671 (make-symbol (concat "notmuch-show-" type)))
673 (defun notmuch-show-strip-re (string)
674 (replace-regexp-in-string "\\([Rr]e: *\\)+" "" string))
676 (defvar notmuch-show-previous-subject "")
677 (make-variable-buffer-local 'notmuch-show-previous-subject)
679 (defun notmuch-show-insert-msg (msg depth)
680 "Insert the message MSG at depth DEPTH in the current thread."
681 (let* ((headers (plist-get msg :headers))
682 ;; Indentation causes the buffer offset of the start/end
683 ;; points to move, so we must use markers.
684 message-start message-end
685 content-start content-end
686 headers-start headers-end
688 (headers-invis-spec (notmuch-show-make-symbol "header"))
689 (message-invis-spec (notmuch-show-make-symbol "message"))
690 (bare-subject (notmuch-show-strip-re (plist-get headers :Subject))))
692 ;; Set `buffer-invisibility-spec' to `nil' (a list), otherwise
693 ;; removing items from `buffer-invisibility-spec' (which is what
694 ;; `notmuch-show-headers-visible' and
695 ;; `notmuch-show-message-visible' do) is a no-op and has no
696 ;; effect. This caused threads with only matching messages to have
697 ;; those messages hidden initially because
698 ;; `buffer-invisibility-spec' stayed `t'.
700 ;; This needs to be set here (rather than just above the call to
701 ;; `notmuch-show-headers-visible') because some of the part
702 ;; rendering or body washing functions
703 ;; (e.g. `notmuch-wash-text/plain-citations') manipulate
704 ;; `buffer-invisibility-spec').
705 (when (eq buffer-invisibility-spec t)
706 (setq buffer-invisibility-spec nil))
708 (setq message-start (point-marker))
710 (notmuch-show-insert-headerline headers
711 (or (if notmuch-show-relative-dates
712 (plist-get msg :date_relative)
714 (plist-get headers :Date))
715 (plist-get msg :tags) depth)
717 (setq content-start (point-marker))
719 (plist-put msg :headers-invis-spec headers-invis-spec)
720 (plist-put msg :message-invis-spec message-invis-spec)
722 ;; Set `headers-start' to point after the 'Subject:' header to be
723 ;; compatible with the existing implementation. This just sets it
724 ;; to after the first header.
725 (notmuch-show-insert-headers headers)
726 ;; Headers should include a blank line (backwards compatibility).
729 (goto-char content-start)
730 ;; If the subject of this message is the same as that of the
731 ;; previous message, don't display it when this message is
733 (when (not (string= notmuch-show-previous-subject
736 (setq headers-start (point-marker)))
737 (setq headers-end (point-marker))
739 (setq notmuch-show-previous-subject bare-subject)
741 (setq body-start (point-marker))
742 (notmuch-show-insert-body msg (plist-get msg :body) depth)
743 ;; Ensure that the body ends with a newline.
746 (setq body-end (point-marker))
747 (setq content-end (point-marker))
749 ;; Indent according to the depth in the thread.
750 (indent-rigidly content-start content-end (* notmuch-show-indent-messages-width depth))
752 (setq message-end (point-max-marker))
754 ;; Save the extents of this message over the whole text of the
756 (put-text-property message-start message-end :notmuch-message-extent (cons message-start message-end))
758 (let ((headers-overlay (make-overlay headers-start headers-end))
759 (invis-specs (list headers-invis-spec message-invis-spec)))
760 (overlay-put headers-overlay 'invisible invis-specs)
761 (overlay-put headers-overlay 'priority 10))
762 (overlay-put (make-overlay body-start body-end) 'invisible message-invis-spec)
764 ;; Save the properties for this message. Currently this saves the
765 ;; entire message (augmented it with other stuff), which seems
766 ;; like overkill. We might save a reduced subset (for example, not
768 (notmuch-show-set-message-properties msg)
770 ;; Set header visibility.
771 (notmuch-show-headers-visible msg notmuch-message-headers-visible)
773 ;; Message visibility depends on whether it matched the search
775 (notmuch-show-message-visible msg (plist-get msg :match))))
777 (defun notmuch-show-insert-tree (tree depth)
778 "Insert the message tree TREE at depth DEPTH in the current thread."
779 (let ((msg (car tree))
780 (replies (cadr tree)))
781 (notmuch-show-insert-msg msg depth)
782 (notmuch-show-insert-thread replies (1+ depth))))
784 (defun notmuch-show-insert-thread (thread depth)
785 "Insert the thread THREAD at depth DEPTH in the current forest."
786 (mapc (lambda (tree) (notmuch-show-insert-tree tree depth)) thread))
788 (defun notmuch-show-insert-forest (forest)
789 "Insert the forest of threads FOREST."
790 (mapc (lambda (thread) (notmuch-show-insert-thread thread 0)) forest))
792 (defvar notmuch-show-thread-id nil)
793 (make-variable-buffer-local 'notmuch-show-thread-id)
794 (defvar notmuch-show-parent-buffer nil)
795 (make-variable-buffer-local 'notmuch-show-parent-buffer)
796 (defvar notmuch-show-query-context nil)
797 (make-variable-buffer-local 'notmuch-show-query-context)
798 (defvar notmuch-show-buffer-name nil)
799 (make-variable-buffer-local 'notmuch-show-buffer-name)
801 (defun notmuch-show-buttonise-links (start end)
802 "Buttonise URLs and mail addresses between START and END.
804 This also turns id:\"<message id>\"-parts into buttons for
805 a corresponding notmuch search."
806 (goto-address-fontify-region start end)
809 (while (re-search-forward "id:\\(\"?\\)[^[:space:]\"]+\\1" end t)
810 ;; remove the overlay created by goto-address-mode
811 (remove-overlays (match-beginning 0) (match-end 0) 'goto-address t)
812 (make-text-button (match-beginning 0) (match-end 0)
813 'action `(lambda (arg)
814 (notmuch-show ,(match-string-no-properties 0)))
816 'help-echo "Mouse-1, RET: search for this message"
817 'face goto-address-mail-face))))
820 (defun notmuch-show (thread-id &optional parent-buffer query-context buffer-name crypto-switch)
821 "Run \"notmuch show\" with the given thread ID and display results.
823 The optional PARENT-BUFFER is the notmuch-search buffer from
824 which this notmuch-show command was executed, (so that the
825 next thread from that buffer can be show when done with this
828 The optional QUERY-CONTEXT is a notmuch search term. Only
829 messages from the thread matching this search term are shown if
832 The optional BUFFER-NAME provides the name of the buffer in
833 which the message thread is shown. If it is nil (which occurs
834 when the command is called interactively) the argument to the
837 The optional CRYPTO-SWITCH toggles the value of the
838 notmuch-crypto-process-mime customization variable for this show
840 (interactive "sNotmuch show: ")
841 (let* ((process-crypto (if crypto-switch
842 (not notmuch-crypto-process-mime)
843 notmuch-crypto-process-mime)))
844 (notmuch-show-worker thread-id parent-buffer query-context buffer-name process-crypto)))
846 (defun notmuch-show-worker (thread-id parent-buffer query-context buffer-name process-crypto)
847 (let* ((buffer-name (generate-new-buffer-name
849 (concat "*notmuch-" thread-id "*"))))
850 (buffer (get-buffer-create buffer-name))
851 (inhibit-read-only t))
852 (switch-to-buffer buffer)
854 ;; Don't track undo information for this buffer
855 (set 'buffer-undo-list t)
857 (setq notmuch-show-thread-id thread-id)
858 (setq notmuch-show-parent-buffer parent-buffer)
859 (setq notmuch-show-query-context query-context)
860 (setq notmuch-show-buffer-name buffer-name)
861 (setq notmuch-show-process-crypto process-crypto)
864 (goto-char (point-min))
866 (let* ((basic-args (list thread-id))
867 (args (if query-context
868 (append (list "\'") basic-args (list "and (" query-context ")\'"))
869 (append (list "\'") basic-args (list "\'")))))
870 (notmuch-show-insert-forest (notmuch-query-get-threads args))
871 ;; If the query context reduced the results to nothing, run
873 (when (and (eq (buffer-size) 0)
875 (notmuch-show-insert-forest
876 (notmuch-query-get-threads basic-args))))
878 (jit-lock-register #'notmuch-show-buttonise-links)
880 ;; Act on visual lines rather than logical lines.
883 (run-hooks 'notmuch-show-hook))
885 ;; Move straight to the first open message
886 (if (not (notmuch-show-message-visible-p))
887 (notmuch-show-next-open-message))
889 ;; Set the header line to the subject of the first open message.
890 (setq header-line-format (notmuch-show-strip-re (notmuch-show-get-subject)))
892 (notmuch-show-mark-read)))
894 (defun notmuch-show-refresh-view (&optional crypto-switch)
895 "Refresh the current view (with crypto switch if prefix given).
897 Kills the current buffer and reruns notmuch show with the same
898 thread id. If a prefix is given, crypto processing is toggled."
900 (let ((thread-id notmuch-show-thread-id)
901 (parent-buffer notmuch-show-parent-buffer)
902 (query-context notmuch-show-query-context)
903 (buffer-name notmuch-show-buffer-name)
904 (process-crypto (if crypto-switch
905 (not notmuch-show-process-crypto)
906 notmuch-show-process-crypto)))
907 (notmuch-kill-this-buffer)
908 (notmuch-show-worker thread-id parent-buffer query-context buffer-name process-crypto)))
910 (defvar notmuch-show-stash-map
911 (let ((map (make-sparse-keymap)))
912 (define-key map "c" 'notmuch-show-stash-cc)
913 (define-key map "d" 'notmuch-show-stash-date)
914 (define-key map "F" 'notmuch-show-stash-filename)
915 (define-key map "f" 'notmuch-show-stash-from)
916 (define-key map "i" 'notmuch-show-stash-message-id)
917 (define-key map "I" 'notmuch-show-stash-message-id-stripped)
918 (define-key map "s" 'notmuch-show-stash-subject)
919 (define-key map "T" 'notmuch-show-stash-tags)
920 (define-key map "t" 'notmuch-show-stash-to)
922 "Submap for stash commands")
923 (fset 'notmuch-show-stash-map notmuch-show-stash-map)
925 (defvar notmuch-show-mode-map
926 (let ((map (make-sparse-keymap)))
927 (define-key map "?" 'notmuch-help)
928 (define-key map "q" 'notmuch-kill-this-buffer)
929 (define-key map (kbd "<C-tab>") 'widget-backward)
930 (define-key map (kbd "M-TAB") 'notmuch-show-previous-button)
931 (define-key map (kbd "<backtab>") 'notmuch-show-previous-button)
932 (define-key map (kbd "TAB") 'notmuch-show-next-button)
933 (define-key map "s" 'notmuch-search)
934 (define-key map "m" 'notmuch-mua-new-mail)
935 (define-key map "f" 'notmuch-show-forward-message)
936 (define-key map "r" 'notmuch-show-reply-sender)
937 (define-key map "R" 'notmuch-show-reply)
938 (define-key map "|" 'notmuch-show-pipe-message)
939 (define-key map "w" 'notmuch-show-save-attachments)
940 (define-key map "V" 'notmuch-show-view-raw-message)
941 (define-key map "v" 'notmuch-show-view-all-mime-parts)
942 (define-key map "c" 'notmuch-show-stash-map)
943 (define-key map "=" 'notmuch-show-refresh-view)
944 (define-key map "h" 'notmuch-show-toggle-headers)
945 (define-key map "-" 'notmuch-show-remove-tag)
946 (define-key map "+" 'notmuch-show-add-tag)
947 (define-key map "x" 'notmuch-show-archive-thread-then-exit)
948 (define-key map "a" 'notmuch-show-archive-thread)
949 (define-key map "N" 'notmuch-show-next-message)
950 (define-key map "P" 'notmuch-show-previous-message)
951 (define-key map "n" 'notmuch-show-next-open-message)
952 (define-key map "p" 'notmuch-show-previous-open-message)
953 (define-key map (kbd "DEL") 'notmuch-show-rewind)
954 (define-key map " " 'notmuch-show-advance-and-archive)
955 (define-key map (kbd "M-RET") 'notmuch-show-open-or-close-all)
956 (define-key map (kbd "RET") 'notmuch-show-toggle-message)
958 "Keymap for \"notmuch show\" buffers.")
959 (fset 'notmuch-show-mode-map notmuch-show-mode-map)
961 (defun notmuch-show-mode ()
962 "Major mode for viewing a thread with notmuch.
964 This buffer contains the results of the \"notmuch show\" command
965 for displaying a single thread of email from your email archives.
967 By default, various components of email messages, (citations,
968 signatures, already-read messages), are hidden. You can make
969 these parts visible by clicking with the mouse button or by
970 pressing RET after positioning the cursor on a hidden part, (for
971 which \\[notmuch-show-next-button] and \\[notmuch-show-previous-button] are helpful).
973 Reading the thread sequentially is well-supported by pressing
974 \\[notmuch-show-advance-and-archive]. This will scroll the current message (if necessary), advance
975 to the next message, or advance to the next thread (if already on
976 the last message of a thread).
978 Other commands are available to read or manipulate the thread
979 more selectively, (such as '\\[notmuch-show-next-message]' and '\\[notmuch-show-previous-message]' to advance to messages
980 without removing any tags, and '\\[notmuch-show-archive-thread]' to archive an entire thread
981 without scrolling through with \\[notmuch-show-advance-and-archive]).
983 You can add or remove arbitrary tags from the current message with
984 '\\[notmuch-show-add-tag]' or '\\[notmuch-show-remove-tag]'.
986 All currently available key bindings:
988 \\{notmuch-show-mode-map}"
990 (kill-all-local-variables)
991 (use-local-map notmuch-show-mode-map)
992 (setq major-mode 'notmuch-show-mode
993 mode-name "notmuch-show")
994 (setq buffer-read-only t))
996 (defun notmuch-show-move-to-message-top ()
997 (goto-char (notmuch-show-message-top)))
999 (defun notmuch-show-move-to-message-bottom ()
1000 (goto-char (notmuch-show-message-bottom)))
1002 (defun notmuch-show-message-adjust ()
1005 ;; Movement related functions.
1007 ;; There's some strangeness here where a text property applied to a
1008 ;; region a->b is not found when point is at b. We walk backwards
1009 ;; until finding the property.
1010 (defun notmuch-show-message-extent ()
1013 (while (not (setq r (get-text-property (point) :notmuch-message-extent)))
1017 (defun notmuch-show-message-top ()
1018 (car (notmuch-show-message-extent)))
1020 (defun notmuch-show-message-bottom ()
1021 (cdr (notmuch-show-message-extent)))
1023 (defun notmuch-show-goto-message-next ()
1024 (let ((start (point)))
1025 (notmuch-show-move-to-message-bottom)
1031 (defun notmuch-show-goto-message-previous ()
1032 (notmuch-show-move-to-message-top)
1036 (notmuch-show-move-to-message-top)
1039 ;; Functions relating to the visibility of messages and their
1042 (defun notmuch-show-element-visible (props visible-p spec-property)
1043 (let ((spec (plist-get props spec-property)))
1045 (remove-from-invisibility-spec spec)
1046 (add-to-invisibility-spec spec))))
1048 (defun notmuch-show-message-visible (props visible-p)
1049 (notmuch-show-element-visible props visible-p :message-invis-spec)
1050 (notmuch-show-set-prop :message-visible visible-p props))
1052 (defun notmuch-show-headers-visible (props visible-p)
1053 (notmuch-show-element-visible props visible-p :headers-invis-spec)
1054 (notmuch-show-set-prop :headers-visible visible-p props))
1056 ;; Functions for setting and getting attributes of the current
1059 (defun notmuch-show-set-message-properties (props)
1061 (notmuch-show-move-to-message-top)
1062 (put-text-property (point) (+ (point) 1) :notmuch-message-properties props)))
1064 (defun notmuch-show-get-message-properties ()
1065 "Return the properties of the current message as a plist.
1067 Some useful entries are:
1068 :headers - Property list containing the headers :Date, :Subject, :From, etc.
1069 :body - Body of the message
1070 :tags - Tags for this message"
1072 (notmuch-show-move-to-message-top)
1073 (get-text-property (point) :notmuch-message-properties)))
1075 (defun notmuch-show-set-prop (prop val &optional props)
1076 (let ((inhibit-read-only t)
1078 (notmuch-show-get-message-properties))))
1079 (plist-put props prop val)
1080 (notmuch-show-set-message-properties props)))
1082 (defun notmuch-show-get-prop (prop &optional props)
1083 (let ((props (or props
1084 (notmuch-show-get-message-properties))))
1085 (plist-get props prop)))
1087 (defun notmuch-show-get-message-id ()
1088 "Return the message id of the current message."
1089 (concat "id:\"" (notmuch-show-get-prop :id) "\""))
1091 ;; dme: Would it make sense to use a macro for many of these?
1093 (defun notmuch-show-get-filename ()
1094 "Return the filename of the current message."
1095 (notmuch-show-get-prop :filename))
1097 (defun notmuch-show-get-header (header &optional props)
1098 "Return the named header of the current message, if any."
1099 (plist-get (notmuch-show-get-prop :headers props) header))
1101 (defun notmuch-show-get-cc ()
1102 (notmuch-show-get-header :Cc))
1104 (defun notmuch-show-get-date ()
1105 (notmuch-show-get-header :Date))
1107 (defun notmuch-show-get-from ()
1108 (notmuch-show-get-header :From))
1110 (defun notmuch-show-get-subject ()
1111 (notmuch-show-get-header :Subject))
1113 (defun notmuch-show-get-to ()
1114 (notmuch-show-get-header :To))
1116 (defun notmuch-show-set-tags (tags)
1117 "Set the tags of the current message."
1118 (notmuch-show-set-prop :tags tags)
1119 (notmuch-show-update-tags tags))
1121 (defun notmuch-show-get-tags ()
1122 "Return the tags of the current message."
1123 (notmuch-show-get-prop :tags))
1125 (defun notmuch-show-message-visible-p ()
1126 "Is the current message visible?"
1127 (notmuch-show-get-prop :message-visible))
1129 (defun notmuch-show-headers-visible-p ()
1130 "Are the headers of the current message visible?"
1131 (notmuch-show-get-prop :headers-visible))
1133 (defun notmuch-show-mark-read ()
1134 "Mark the current message as read."
1135 (notmuch-show-remove-tag "unread"))
1137 ;; Functions for getting attributes of several messages in the current
1140 (defun notmuch-show-get-message-ids-for-open-messages ()
1141 "Return a list of all message IDs for open messages in the current thread."
1143 (let (message-ids done)
1144 (goto-char (point-min))
1146 (if (notmuch-show-message-visible-p)
1147 (setq message-ids (append message-ids (list (notmuch-show-get-message-id)))))
1148 (setq done (not (notmuch-show-goto-message-next)))
1153 ;; Commands typically bound to keys.
1155 (defun notmuch-show-advance ()
1156 "Advance through thread.
1158 If the current message in the thread is not yet fully visible,
1159 scroll by a near screenful to read more of the message.
1161 Otherwise, (the end of the current message is already within the
1162 current window), advance to the next open message."
1164 (let* ((end-of-this-message (notmuch-show-message-bottom))
1165 (visible-end-of-this-message (1- end-of-this-message))
1167 (while (invisible-p visible-end-of-this-message)
1168 (setq visible-end-of-this-message
1170 (1- (previous-single-char-property-change
1171 visible-end-of-this-message 'invisible)))))
1173 ;; Ideally we would test `end-of-this-message' against the result
1174 ;; of `window-end', but that doesn't account for the fact that
1175 ;; the end of the message might be hidden.
1176 ((and visible-end-of-this-message
1177 (> visible-end-of-this-message (window-end)))
1178 ;; The bottom of this message is not visible - scroll.
1181 ((not (= end-of-this-message (point-max)))
1182 ;; This is not the last message - move to the next visible one.
1183 (notmuch-show-next-open-message))
1186 ;; This is the last message - change the return value
1190 (defun notmuch-show-advance-and-archive ()
1191 "Advance through thread and archive.
1193 This command is intended to be one of the simplest ways to
1194 process a thread of email. It works exactly like
1195 notmuch-show-advance, in that it scrolls through messages in a
1196 show buffer, except that when it gets to the end of the buffer it
1197 archives the entire current thread, (remove the \"inbox\" tag
1198 from each message), kills the buffer, and displays the next
1199 thread from the search from which this thread was originally
1202 (if (notmuch-show-advance)
1203 (notmuch-show-archive-thread)))
1205 (defun notmuch-show-rewind ()
1206 "Backup through the thread, (reverse scrolling compared to \\[notmuch-show-advance-and-archive]).
1208 Specifically, if the beginning of the previous email is fewer
1209 than `window-height' lines from the current point, move to it
1210 just like `notmuch-show-previous-message'.
1212 Otherwise, just scroll down a screenful of the current message.
1214 This command does not modify any message tags, (it does not undo
1215 any effects from previous calls to
1216 `notmuch-show-advance-and-archive'."
1218 (let ((start-of-message (notmuch-show-message-top))
1219 (start-of-window (window-start)))
1221 ;; Either this message is properly aligned with the start of the
1222 ;; window or the start of this message is not visible on the
1224 ((or (= start-of-message start-of-window)
1225 (< start-of-message start-of-window))
1227 ;; If a small number of lines from the previous message are
1228 ;; visible, realign so that the top of the current message is at
1229 ;; the top of the screen.
1230 (if (<= (count-screen-lines (window-start) start-of-message)
1231 next-screen-context-lines)
1233 (goto-char (notmuch-show-message-top))
1234 (notmuch-show-message-adjust)))
1235 ;; Move to the top left of the window.
1236 (goto-char (window-start)))
1238 ;; Move to the previous message.
1239 (notmuch-show-previous-message)))))
1241 (defun notmuch-show-reply (&optional prompt-for-sender)
1242 "Reply to the sender and all recipients of the current message."
1244 (notmuch-mua-new-reply (notmuch-show-get-message-id) prompt-for-sender t))
1246 (defun notmuch-show-reply-sender (&optional prompt-for-sender)
1247 "Reply to the sender of the current message."
1249 (notmuch-mua-new-reply (notmuch-show-get-message-id) prompt-for-sender nil))
1251 (defun notmuch-show-forward-message (&optional prompt-for-sender)
1252 "Forward the current message."
1254 (with-current-notmuch-show-message
1255 (notmuch-mua-new-forward-message prompt-for-sender)))
1257 (defun notmuch-show-next-message ()
1258 "Show the next message."
1260 (if (notmuch-show-goto-message-next)
1262 (notmuch-show-mark-read)
1263 (notmuch-show-message-adjust))
1264 (goto-char (point-max))))
1266 (defun notmuch-show-previous-message ()
1267 "Show the previous message."
1269 (notmuch-show-goto-message-previous)
1270 (notmuch-show-mark-read)
1271 (notmuch-show-message-adjust))
1273 (defun notmuch-show-next-open-message ()
1274 "Show the next message."
1277 (while (and (setq r (notmuch-show-goto-message-next))
1278 (not (notmuch-show-message-visible-p))))
1281 (notmuch-show-mark-read)
1282 (notmuch-show-message-adjust))
1283 (goto-char (point-max)))))
1285 (defun notmuch-show-previous-open-message ()
1286 "Show the previous message."
1288 (while (and (notmuch-show-goto-message-previous)
1289 (not (notmuch-show-message-visible-p))))
1290 (notmuch-show-mark-read)
1291 (notmuch-show-message-adjust))
1293 (defun notmuch-show-view-raw-message ()
1294 "View the file holding the current message."
1296 (let* ((id (notmuch-show-get-message-id))
1297 (buf (get-buffer-create (concat "*notmuch-raw-" id "*"))))
1298 (call-process notmuch-command nil buf nil "show" "--format=raw" id)
1299 (switch-to-buffer buf)
1300 (goto-char (point-min))
1301 (set-buffer-modified-p nil)
1302 (view-buffer buf 'kill-buffer-if-not-modified)))
1304 (defun notmuch-show-pipe-message (entire-thread command)
1305 "Pipe the contents of the current message (or thread) to the given command.
1307 The given command will be executed with the raw contents of the
1308 current email message as stdin. Anything printed by the command
1309 to stdout or stderr will appear in the *notmuch-pipe* buffer.
1311 When invoked with a prefix argument, the command will receive all
1312 open messages in the current thread (formatted as an mbox) rather
1313 than only the current message."
1314 (interactive "P\nsPipe message to command: ")
1315 (let (shell-command)
1318 (concat notmuch-command " show --format=mbox "
1319 (shell-quote-argument
1320 (mapconcat 'identity (notmuch-show-get-message-ids-for-open-messages) " OR "))
1323 (concat notmuch-command " show --format=raw "
1324 (shell-quote-argument (notmuch-show-get-message-id)) " | " command)))
1325 (let ((buf (get-buffer-create (concat "*notmuch-pipe*"))))
1326 (with-current-buffer buf
1327 (setq buffer-read-only nil)
1329 (let ((exit-code (call-process-shell-command shell-command nil buf)))
1330 (goto-char (point-max))
1331 (set-buffer-modified-p nil)
1332 (setq buffer-read-only t)
1333 (unless (zerop exit-code)
1334 (switch-to-buffer-other-window buf)
1335 (message (format "Command '%s' exited abnormally with code %d"
1336 shell-command exit-code))))))))
1338 (defun notmuch-show-add-tags-worker (current-tags add-tags)
1339 "Add to `current-tags' with any tags from `add-tags' not
1340 currently present and return the result."
1341 (let ((result-tags (copy-sequence current-tags)))
1342 (mapc (lambda (add-tag)
1343 (unless (member add-tag current-tags)
1344 (setq result-tags (push add-tag result-tags))))
1346 (sort result-tags 'string<)))
1348 (defun notmuch-show-del-tags-worker (current-tags del-tags)
1349 "Remove any tags in `del-tags' from `current-tags' and return
1351 (let ((result-tags (copy-sequence current-tags)))
1352 (mapc (lambda (del-tag)
1353 (setq result-tags (delete del-tag result-tags)))
1357 (defun notmuch-show-add-tag (&rest toadd)
1358 "Add a tag to the current message."
1360 (list (notmuch-select-tag-with-completion "Tag to add: ")))
1362 (let* ((current-tags (notmuch-show-get-tags))
1363 (new-tags (notmuch-show-add-tags-worker current-tags toadd)))
1365 (unless (equal current-tags new-tags)
1366 (apply 'notmuch-tag (notmuch-show-get-message-id)
1367 (mapcar (lambda (s) (concat "+" s)) toadd))
1368 (notmuch-show-set-tags new-tags))))
1370 (defun notmuch-show-remove-tag (&rest toremove)
1371 "Remove a tag from the current message."
1373 (list (notmuch-select-tag-with-completion
1374 "Tag to remove: " (notmuch-show-get-message-id))))
1376 (let* ((current-tags (notmuch-show-get-tags))
1377 (new-tags (notmuch-show-del-tags-worker current-tags toremove)))
1379 (unless (equal current-tags new-tags)
1380 (apply 'notmuch-tag (notmuch-show-get-message-id)
1381 (mapcar (lambda (s) (concat "-" s)) toremove))
1382 (notmuch-show-set-tags new-tags))))
1384 (defun notmuch-show-toggle-headers ()
1385 "Toggle the visibility of the current message headers."
1387 (let ((props (notmuch-show-get-message-properties)))
1388 (notmuch-show-headers-visible
1390 (not (plist-get props :headers-visible))))
1391 (force-window-update))
1393 (defun notmuch-show-toggle-message ()
1394 "Toggle the visibility of the current message."
1396 (let ((props (notmuch-show-get-message-properties)))
1397 (notmuch-show-message-visible
1399 (not (plist-get props :message-visible))))
1400 (force-window-update))
1402 (defun notmuch-show-open-or-close-all ()
1403 "Set the visibility all of the messages in the current thread.
1404 By default make all of the messages visible. With a prefix
1405 argument, hide all of the messages."
1408 (goto-char (point-min))
1409 (loop do (notmuch-show-message-visible (notmuch-show-get-message-properties)
1410 (not current-prefix-arg))
1411 until (not (notmuch-show-goto-message-next))))
1412 (force-window-update))
1414 (defun notmuch-show-next-button ()
1415 "Advance point to the next button in the buffer."
1419 (defun notmuch-show-previous-button ()
1420 "Move point back to the previous button in the buffer."
1422 (backward-button 1))
1424 (defun notmuch-show-archive-thread-internal (show-next)
1425 ;; Remove the tag from the current set of messages.
1426 (goto-char (point-min))
1427 (loop do (notmuch-show-remove-tag "inbox")
1428 until (not (notmuch-show-goto-message-next)))
1429 ;; Move to the next item in the search results, if any.
1430 (let ((parent-buffer notmuch-show-parent-buffer))
1431 (notmuch-kill-this-buffer)
1434 (switch-to-buffer parent-buffer)
1437 (notmuch-search-show-thread))))))
1439 (defun notmuch-show-archive-thread ()
1440 "Archive each message in thread, then show next thread from search.
1442 Archive each message currently shown by removing the \"inbox\"
1443 tag from each. Then kill this buffer and show the next thread
1444 from the search from which this thread was originally shown.
1446 Note: This command is safe from any race condition of new messages
1447 being delivered to the same thread. It does not archive the
1448 entire thread, but only the messages shown in the current
1451 (notmuch-show-archive-thread-internal t))
1453 (defun notmuch-show-archive-thread-then-exit ()
1454 "Archive each message in thread, then exit back to search results."
1456 (notmuch-show-archive-thread-internal nil))
1458 (defun notmuch-show-stash-cc ()
1459 "Copy CC field of current message to kill-ring."
1461 (notmuch-common-do-stash (notmuch-show-get-cc)))
1463 (defun notmuch-show-stash-date ()
1464 "Copy date of current message to kill-ring."
1466 (notmuch-common-do-stash (notmuch-show-get-date)))
1468 (defun notmuch-show-stash-filename ()
1469 "Copy filename of current message to kill-ring."
1471 (notmuch-common-do-stash (notmuch-show-get-filename)))
1473 (defun notmuch-show-stash-from ()
1474 "Copy From address of current message to kill-ring."
1476 (notmuch-common-do-stash (notmuch-show-get-from)))
1478 (defun notmuch-show-stash-message-id ()
1479 "Copy message ID of current message to kill-ring."
1481 (notmuch-common-do-stash (notmuch-show-get-message-id)))
1483 (defun notmuch-show-stash-message-id-stripped ()
1484 "Copy message ID of current message (sans `id:' prefix) to kill-ring."
1486 (notmuch-common-do-stash (substring (notmuch-show-get-message-id) 4 -1)))
1488 (defun notmuch-show-stash-subject ()
1489 "Copy Subject field of current message to kill-ring."
1491 (notmuch-common-do-stash (notmuch-show-get-subject)))
1493 (defun notmuch-show-stash-tags ()
1494 "Copy tags of current message to kill-ring as a comma separated list."
1496 (notmuch-common-do-stash (mapconcat 'identity (notmuch-show-get-tags) ",")))
1498 (defun notmuch-show-stash-to ()
1499 "Copy To address of current message to kill-ring."
1501 (notmuch-common-do-stash (notmuch-show-get-to)))
1503 ;; Commands typically bound to buttons.
1505 (defun notmuch-show-part-button-action (button)
1506 (let ((nth (button-get button :notmuch-part)))
1508 (notmuch-show-save-part (notmuch-show-get-message-id) nth
1509 (button-get button :notmuch-filename))
1510 (message "Not a valid part (is it a fake part?)."))))
1514 (provide 'notmuch-show)