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)
156 (put 'notmuch-show-thread-id 'permanent-local t)
158 (defvar notmuch-show-parent-buffer nil)
159 (make-variable-buffer-local 'notmuch-show-parent-buffer)
160 (put 'notmuch-show-parent-buffer 'permanent-local t)
162 (defvar notmuch-show-query-context nil)
163 (make-variable-buffer-local 'notmuch-show-query-context)
164 (put 'notmuch-show-query-context 'permanent-local t)
166 (defvar notmuch-show-process-crypto nil)
167 (make-variable-buffer-local 'notmuch-show-process-crypto)
168 (put 'notmuch-show-process-crypto 'permanent-local t)
170 (defvar notmuch-show-elide-non-matching-messages nil)
171 (make-variable-buffer-local 'notmuch-show-elide-non-matching-messages)
172 (put 'notmuch-show-elide-non-matching-messages 'permanent-local t)
174 (defvar notmuch-show-indent-content t)
175 (make-variable-buffer-local 'notmuch-show-indent-content)
176 (put 'notmuch-show-indent-content 'permanent-local t)
178 (defvar notmuch-show-attachment-debug nil
179 "If t log stdout and stderr from attachment handlers
181 When set to nil (the default) stdout and stderr from attachment
182 handlers is discarded. When set to t the stdout and stderr from
183 each attachment handler is logged in buffers with names beginning
184 \" *notmuch-part*\". This option requires emacs version at least
187 (defcustom notmuch-show-stash-mlarchive-link-alist
188 '(("Gmane" . "http://mid.gmane.org/")
189 ("MARC" . "http://marc.info/?i=")
190 ("Mail Archive, The" . "http://mid.mail-archive.com/")
191 ("LKML" . "http://lkml.kernel.org/r/")
192 ;; FIXME: can these services be searched by `Message-Id' ?
193 ;; ("MarkMail" . "http://markmail.org/")
194 ;; ("Nabble" . "http://nabble.com/")
195 ;; ("opensubscriber" . "http://opensubscriber.com/")
197 "List of Mailing List Archives to use when stashing links.
199 This list is used for generating a Mailing List Archive reference
200 URI with the current message's Message-Id in
201 `notmuch-show-stash-mlarchive-link'.
203 If the cdr of the alist element is not a function, the cdr is
204 expected to contain a URI that is concatenated with the current
205 message's Message-Id to create a ML archive reference URI.
207 If the cdr is a function, the function is called with the
208 Message-Id as the argument, and the function is expected to
209 return the ML archive reference URI."
210 :type '(alist :key-type (string :tag "Name")
213 (function :tag "Function returning the URL")))
214 :group 'notmuch-show)
216 (defcustom notmuch-show-stash-mlarchive-link-default "Gmane"
217 "Default Mailing List Archive to use when stashing links.
219 This is used when `notmuch-show-stash-mlarchive-link' isn't
220 provided with an MLA argument nor `completing-read' input."
224 (list 'const :tag (car mla) :value (car mla)))
225 notmuch-show-stash-mlarchive-link-alist))
226 :group 'notmuch-show)
228 (defcustom notmuch-show-mark-read-tags '("-unread")
229 "List of tag changes to apply to a message when it is marked as read.
231 Tags starting with \"+\" (or not starting with either \"+\" or
232 \"-\") in the list will be added, and tags starting with \"-\"
233 will be removed from the message being marked as read.
235 For example, if you wanted to remove an \"unread\" tag and add a
236 \"read\" tag (which would make little sense), you would set:
237 (\"-unread\" \"+read\")"
238 :type '(repeat string)
239 :group 'notmuch-show)
241 (defcustom notmuch-show-mark-read-function #'notmuch-show-seen-current-message
242 "Function to control which messages are marked read.
244 The function should take two arguments START and END which will
245 be the start and end of the visible portion of the buffer and
246 should mark the appropriate messages read by applying
247 `notmuch-show-mark-read'. This function will be called after
248 every user interaction with notmuch."
250 :group 'notmuch-show)
252 (defmacro with-current-notmuch-show-message (&rest body)
253 "Evaluate body with current buffer set to the text of current message"
255 (let ((id (notmuch-show-get-message-id)))
256 (let ((buf (generate-new-buffer (concat "*notmuch-msg-" id "*"))))
257 (with-current-buffer buf
258 (let ((coding-system-for-read 'no-conversion))
259 (call-process notmuch-command nil t nil "show" "--format=raw" id))
261 (kill-buffer buf)))))
263 (defun notmuch-show-turn-on-visual-line-mode ()
264 "Enable Visual Line mode."
265 (visual-line-mode t))
267 ;; DEPRECATED in Notmuch 0.16 since we now have convenient part
268 ;; commands. We'll keep the command around for a version or two in
269 ;; case people want to bind it themselves.
270 (defun notmuch-show-view-all-mime-parts ()
271 "Use external viewers to view all attachments from the current message."
273 (with-current-notmuch-show-message
274 ;; We override the mm-inline-media-tests to indicate which message
275 ;; parts are already sufficiently handled by the original
276 ;; presentation of the message in notmuch-show mode. These parts
277 ;; will be inserted directly into the temporary buffer of
278 ;; with-current-notmuch-show-message and silently discarded.
280 ;; Any MIME part not explicitly mentioned here will be handled by an
281 ;; external viewer as configured in the various mailcap files.
282 (let ((mm-inline-media-tests '(
283 ("text/.*" ignore identity)
284 ("application/pgp-signature" ignore identity)
285 ("multipart/alternative" ignore identity)
286 ("multipart/mixed" ignore identity)
287 ("multipart/related" ignore identity)
289 (mm-display-parts (mm-dissect-buffer)))))
291 (defun notmuch-show-save-attachments ()
292 "Save all attachments from the current message."
294 (with-current-notmuch-show-message
295 (let ((mm-handle (mm-dissect-buffer)))
296 (notmuch-save-attachments
297 mm-handle (> (notmuch-count-attachments mm-handle) 1))))
300 (defun notmuch-show-with-message-as-text (fn)
301 "Apply FN to a text representation of the current message.
303 FN is called with one argument, the message properties. It should
304 operation on the contents of the current buffer."
306 ;; Remake the header to ensure that all information is available.
307 (let* ((to (notmuch-show-get-to))
308 (cc (notmuch-show-get-cc))
309 (from (notmuch-show-get-from))
310 (subject (notmuch-show-get-subject))
311 (date (notmuch-show-get-date))
312 (tags (notmuch-show-get-tags))
313 (depth (notmuch-show-get-depth))
316 "Subject: " subject "\n"
318 (if (not (string= cc ""))
319 (concat "Cc: " cc "\n")
325 (mapconcat #'identity tags ", ") "\n")
327 (all (buffer-substring (notmuch-show-message-top)
328 (notmuch-show-message-bottom)))
330 (props (notmuch-show-get-message-properties))
331 (indenting notmuch-show-indent-content))
335 (indent-rigidly (point-min) (point-max) (- depth)))
336 ;; Remove the original header.
337 (goto-char (point-min))
338 (re-search-forward "^$" (point-max) nil)
339 (delete-region (point-min) (point))
341 (funcall fn props))))
343 (defun notmuch-show-print-message ()
344 "Print the current message."
346 (notmuch-show-with-message-as-text 'notmuch-print-message))
348 (defun notmuch-show-fontify-header ()
350 ((looking-at "[Tt]o:")
352 ((looking-at "[Bb]?[Cc][Cc]:")
354 ((looking-at "[Ss]ubject:")
355 'message-header-subject)
356 ((looking-at "[Ff]rom:")
357 'message-header-from)
359 'message-header-other))))
361 (overlay-put (make-overlay (point) (re-search-forward ":"))
362 'face 'message-header-name)
363 (overlay-put (make-overlay (point) (re-search-forward ".*$"))
366 (defun notmuch-show-colour-headers ()
367 "Apply some colouring to the current headers."
368 (goto-char (point-min))
369 (while (looking-at "^[A-Za-z][-A-Za-z0-9]*:")
370 (notmuch-show-fontify-header)
373 (defun notmuch-show-spaces-n (n)
374 "Return a string comprised of `n' spaces."
377 (defun notmuch-show-update-tags (tags)
378 "Update the displayed tags of the current message."
380 (goto-char (notmuch-show-message-top))
381 (if (re-search-forward "(\\([^()]*\\))$" (line-end-position) t)
382 (let ((inhibit-read-only t))
383 (replace-match (concat "("
384 (notmuch-tag-format-tags tags (notmuch-show-get-prop :orig-tags))
387 (defun notmuch-clean-address (address)
388 "Try to clean a single email ADDRESS for display. Return a cons
389 cell of (AUTHOR_EMAIL AUTHOR_NAME). Return (ADDRESS nil) if
392 (let (p-name p-address)
393 ;; It would be convenient to use `mail-header-parse-address',
394 ;; but that expects un-decoded mailbox parts, whereas our
395 ;; mailbox parts are already decoded (and hence may contain
396 ;; UTF-8). Given that notmuch should handle most of the awkward
397 ;; cases, some simple string deconstruction should be sufficient
400 ;; "User <user@dom.ain>" style.
401 ((string-match "\\(.*\\) <\\(.*\\)>" address)
402 (setq p-name (match-string 1 address)
403 p-address (match-string 2 address)))
405 ;; "<user@dom.ain>" style.
406 ((string-match "<\\(.*\\)>" address)
407 (setq p-address (match-string 1 address)))
411 (setq p-address address)))
414 ;; Remove elements of the mailbox part that are not relevant for
415 ;; display, even if they are required during transport:
418 (setq p-name (replace-regexp-in-string "\\\\" "" p-name))
420 ;; Outer single and double quotes, which might be nested.
423 do (setq start-of-loop p-name)
425 when (string-match "^\"\\(.*\\)\"$" p-name)
426 do (setq p-name (match-string 1 p-name))
428 when (string-match "^'\\(.*\\)'$" p-name)
429 do (setq p-name (match-string 1 p-name))
431 until (string= start-of-loop p-name)))
433 ;; If the address is 'foo@bar.com <foo@bar.com>' then show just
435 (when (string= p-name p-address)
438 (cons p-address p-name))
439 (error (cons address nil))))
441 (defun notmuch-show-clean-address (address)
442 "Try to clean a single email ADDRESS for display. Return
443 unchanged ADDRESS if parsing fails."
444 (let* ((clean-address (notmuch-clean-address address))
445 (p-address (car clean-address))
446 (p-name (cdr clean-address)))
447 ;; If no name, return just the address.
450 ;; Otherwise format the name and address together.
451 (concat p-name " <" p-address ">"))))
453 (defun notmuch-show-insert-headerline (headers date tags depth)
454 "Insert a notmuch style headerline based on HEADERS for a
455 message at DEPTH in the current thread."
456 (let ((start (point)))
457 (insert (notmuch-show-spaces-n (* notmuch-show-indent-messages-width depth))
459 (notmuch-show-clean-address (plist-get headers :From)))
463 (notmuch-tag-format-tags tags tags)
465 (overlay-put (make-overlay start (point)) 'face 'notmuch-message-summary-face)))
467 (defun notmuch-show-insert-header (header header-value)
468 "Insert a single header."
469 (insert header ": " (notmuch-sanitize header-value) "\n"))
471 (defun notmuch-show-insert-headers (headers)
472 "Insert the headers of the current message."
473 (let ((start (point)))
474 (mapc (lambda (header)
475 (let* ((header-symbol (intern (concat ":" header)))
476 (header-value (plist-get headers header-symbol)))
477 (if (and header-value
478 (not (string-equal "" header-value)))
479 (notmuch-show-insert-header header header-value))))
480 notmuch-message-headers)
483 (narrow-to-region start (point-max))
484 (run-hooks 'notmuch-show-markup-headers-hook)))))
486 (define-button-type 'notmuch-show-part-button-type
487 'action 'notmuch-show-part-button-default
490 :supertype 'notmuch-button-type)
492 (defun notmuch-show-insert-part-header (nth content-type declared-type &optional name comment)
494 (base-label (concat (when name (concat name ": "))
496 (unless (string-equal declared-type content-type)
497 (concat " (as " content-type ")"))
502 (concat "[ " base-label " ]")
503 :base-label base-label
504 :type 'notmuch-show-part-button-type
505 :notmuch-part-hidden nil))
510 (defun notmuch-show-toggle-part-invisibility (&optional button)
512 (let* ((button (or button (button-at (point))))
513 (overlay (button-get button 'overlay))
514 (lazy-part (button-get button :notmuch-lazy-part)))
515 ;; We have a part to toggle if there is an overlay or if there is a lazy part.
516 ;; If neither is present we cannot toggle the part so we just return nil.
517 (when (or overlay lazy-part)
518 (let* ((show (button-get button :notmuch-part-hidden))
519 (new-start (button-start button))
520 (button-label (button-get button :base-label))
522 (properties (text-properties-at (button-start button)))
523 (inhibit-read-only t))
524 ;; Toggle the button itself.
525 (button-put button :notmuch-part-hidden (not show))
526 (goto-char new-start)
527 (insert "[ " button-label (if show " ]" " (hidden) ]"))
528 (set-text-properties new-start (point) properties)
529 (let ((old-end (button-end button)))
530 (move-overlay button new-start (point))
531 (delete-region (point) old-end))
532 (goto-char (min old-point (1- (button-end button))))
533 ;; Return nil if there is a lazy-part, it is empty, and we are
534 ;; trying to show it. In all other cases return t.
537 (button-put button :notmuch-lazy-part nil)
538 (notmuch-show-lazy-part lazy-part button))
539 ;; else there must be an overlay.
540 (overlay-put overlay 'invisible (not show))
543 ;; Part content ID handling
545 (defvar notmuch-show--cids nil
546 "Alist from raw content ID to (MSG PART).")
547 (make-variable-buffer-local 'notmuch-show--cids)
549 (defun notmuch-show--register-cids (msg part)
550 "Register content-IDs in PART and all of PART's sub-parts."
551 (let ((content-id (plist-get part :content-id)))
553 ;; Note that content-IDs are globally unique, except when they
554 ;; aren't: RFC 2046 section 5.1.4 permits children of a
555 ;; multipart/alternative to have the same content-ID, in which
556 ;; case the MUA is supposed to pick the best one it can render.
557 ;; We simply add the content-ID to the beginning of our alist;
558 ;; so if this happens, we'll take the last (and "best")
559 ;; alternative (even if we can't render it).
560 (push (list content-id msg part) notmuch-show--cids)))
561 ;; Recurse on sub-parts
562 (let ((ctype (notmuch-split-content-type
563 (downcase (plist-get part :content-type)))))
564 (cond ((equal (first ctype) "multipart")
565 (mapc (apply-partially #'notmuch-show--register-cids msg)
566 (plist-get part :content)))
567 ((equal ctype '("message" "rfc822"))
568 (notmuch-show--register-cids
570 (first (plist-get (first (plist-get part :content)) :body)))))))
572 (defun notmuch-show--get-cid-content (cid)
573 "Return a list (CID-content content-type) or nil.
575 This will only find parts from messages that have been inserted
576 into the current buffer. CID must be a raw content ID, without
577 enclosing angle brackets, a cid: prefix, or URL encoding. This
578 will return nil if the CID is unknown or cannot be retrieved."
579 (let ((descriptor (cdr (assoc cid notmuch-show--cids))))
581 (let* ((msg (first descriptor))
582 (part (second descriptor))
583 ;; Request caching for this content, as some messages
584 ;; reference the same cid: part many times (hundreds!).
585 (content (notmuch-get-bodypart-binary
586 msg part notmuch-show-process-crypto 'cache))
587 (content-type (plist-get part :content-type)))
588 (list content content-type)))))
590 (defun notmuch-show-setup-w3m ()
591 "Instruct w3m how to retrieve content from a \"related\" part of a message."
593 (if (boundp 'w3m-cid-retrieve-function-alist)
594 (unless (assq 'notmuch-show-mode w3m-cid-retrieve-function-alist)
595 (push (cons 'notmuch-show-mode #'notmuch-show--cid-w3m-retrieve)
596 w3m-cid-retrieve-function-alist)))
597 (setq mm-inline-text-html-with-images t))
599 (defvar w3m-current-buffer) ;; From `w3m.el'.
600 (defun notmuch-show--cid-w3m-retrieve (url &rest args)
601 ;; url includes the cid: prefix and is URL encoded (see RFC 2392).
602 (let* ((cid (url-unhex-string (substring url 4)))
604 (with-current-buffer w3m-current-buffer
605 (notmuch-show--get-cid-content cid))))
606 (when content-and-type
607 (insert (first content-and-type))
608 (second content-and-type))))
610 ;; MIME part renderers
612 (defun notmuch-show-multipart/*-to-list (part)
613 (mapcar (lambda (inner-part) (plist-get inner-part :content-type))
614 (plist-get part :content)))
616 (defun notmuch-show-insert-part-multipart/alternative (msg part content-type nth depth button)
617 (let ((chosen-type (car (notmuch-multipart/alternative-choose (notmuch-show-multipart/*-to-list part))))
618 (inner-parts (plist-get part :content))
620 ;; This inserts all parts of the chosen type rather than just one,
621 ;; but it's not clear that this is the wrong thing to do - which
622 ;; should be chosen if there are more than one that match?
623 (mapc (lambda (inner-part)
624 (let* ((inner-type (plist-get inner-part :content-type))
625 (hide (not (or notmuch-show-all-multipart/alternative-parts
626 (string= chosen-type inner-type)))))
627 (notmuch-show-insert-bodypart msg inner-part depth hide)))
630 (when notmuch-show-indent-multipart
631 (indent-rigidly start (point) 1)))
634 (defun notmuch-show-insert-part-multipart/related (msg part content-type nth depth button)
635 (let ((inner-parts (plist-get part :content))
638 ;; Render the primary part. FIXME: Support RFC 2387 Start header.
639 (notmuch-show-insert-bodypart msg (car inner-parts) depth)
640 ;; Add hidden buttons for the rest
641 (mapc (lambda (inner-part)
642 (notmuch-show-insert-bodypart msg inner-part depth t))
645 (when notmuch-show-indent-multipart
646 (indent-rigidly start (point) 1)))
649 (defun notmuch-show-insert-part-multipart/signed (msg part content-type nth depth button)
650 (button-put button 'face 'notmuch-crypto-part-header)
651 ;; add signature status button if sigstatus provided
652 (if (plist-member part :sigstatus)
653 (let* ((from (notmuch-show-get-header :From msg))
654 (sigstatus (car (plist-get part :sigstatus))))
655 (notmuch-crypto-insert-sigstatus-button sigstatus from))
656 ;; if we're not adding sigstatus, tell the user how they can get it
657 (button-put button 'help-echo "Set notmuch-crypto-process-mime to process cryptographic MIME parts."))
659 (let ((inner-parts (plist-get part :content))
661 ;; Show all of the parts.
662 (mapc (lambda (inner-part)
663 (notmuch-show-insert-bodypart msg inner-part depth))
666 (when notmuch-show-indent-multipart
667 (indent-rigidly start (point) 1)))
670 (defun notmuch-show-insert-part-multipart/encrypted (msg part content-type nth depth button)
671 (button-put button 'face 'notmuch-crypto-part-header)
672 ;; add encryption status button if encstatus specified
673 (if (plist-member part :encstatus)
674 (let ((encstatus (car (plist-get part :encstatus))))
675 (notmuch-crypto-insert-encstatus-button encstatus)
676 ;; add signature status button if sigstatus specified
677 (if (plist-member part :sigstatus)
678 (let* ((from (notmuch-show-get-header :From msg))
679 (sigstatus (car (plist-get part :sigstatus))))
680 (notmuch-crypto-insert-sigstatus-button sigstatus from))))
681 ;; if we're not adding encstatus, tell the user how they can get it
682 (button-put button 'help-echo "Set notmuch-crypto-process-mime to process cryptographic MIME parts."))
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-multipart/* (msg part content-type nth depth button)
696 (let ((inner-parts (plist-get part :content))
698 ;; Show all of the parts.
699 (mapc (lambda (inner-part)
700 (notmuch-show-insert-bodypart msg inner-part depth))
703 (when notmuch-show-indent-multipart
704 (indent-rigidly start (point) 1)))
707 (defun notmuch-show-insert-part-message/rfc822 (msg part content-type nth depth button)
708 (let* ((message (car (plist-get part :content)))
709 (body (car (plist-get message :body)))
712 ;; Override `notmuch-message-headers' to force `From' to be
714 (let ((notmuch-message-headers '("From" "Subject" "To" "Cc" "Date")))
715 (notmuch-show-insert-headers (plist-get message :headers)))
717 ;; Blank line after headers to be compatible with the normal
722 (notmuch-show-insert-bodypart msg body depth)
724 (when notmuch-show-indent-multipart
725 (indent-rigidly start (point) 1)))
728 (defun notmuch-show-insert-part-text/plain (msg part content-type nth depth button)
729 ;; For backward compatibility we want to apply the text/plain hook
730 ;; to the whole of the part including the part button if there is
732 (let ((start (if button
733 (button-start button)
735 (insert (notmuch-get-bodypart-text msg part notmuch-show-process-crypto))
738 (narrow-to-region start (point-max))
739 (run-hook-with-args 'notmuch-show-insert-text/plain-hook msg depth))))
742 (defun notmuch-show-insert-part-text/calendar (msg part content-type nth depth button)
743 (insert (with-temp-buffer
744 (insert (notmuch-get-bodypart-text msg part notmuch-show-process-crypto))
745 ;; notmuch-get-bodypart-text does no newline conversion.
746 ;; Replace CRLF with LF before icalendar can use it.
747 (goto-char (point-min))
748 (while (re-search-forward "\r\n" nil t)
749 (replace-match "\n" nil nil))
750 (let ((file (make-temp-file "notmuch-ical"))
754 (unless (icalendar-import-buffer file t)
755 (error "Icalendar import error. See *icalendar-errors* for more information"))
756 (set-buffer (get-file-buffer file))
757 (setq result (buffer-substring (point-min) (point-max)))
758 (set-buffer-modified-p nil)
759 (kill-buffer (current-buffer)))
764 ;; For backwards compatibility.
765 (defun notmuch-show-insert-part-text/x-vcalendar (msg part content-type nth depth button)
766 (notmuch-show-insert-part-text/calendar msg part content-type nth depth button))
768 (defun notmuch-show-get-mime-type-of-application/octet-stream (part)
769 ;; If we can deduce a MIME type from the filename of the attachment,
771 (if (plist-get part :filename)
772 (let ((extension (file-name-extension (plist-get part :filename)))
776 (mailcap-parse-mimetypes)
777 (setq mime-type (mailcap-extension-to-mime extension))
779 (not (string-equal mime-type "application/octet-stream")))
784 (defun notmuch-show-insert-part-text/html (msg part content-type nth depth button)
785 (if (eq mm-text-html-renderer 'shr)
786 ;; It's easier to drive shr ourselves than to work around the
787 ;; goofy things `mm-shr' does (like irreversibly taking over
788 ;; content ID handling).
790 ;; FIXME: If we block an image, offer a button to load external
792 (let ((shr-blocked-images notmuch-show-text/html-blocked-images))
793 (notmuch-show--insert-part-text/html-shr msg part))
794 ;; Otherwise, let message-mode do the heavy lifting
796 ;; w3m sets up a keymap which "leaks" outside the invisible region
797 ;; and causes strange effects in notmuch. We set
798 ;; mm-inline-text-html-with-w3m-keymap to nil to tell w3m not to
799 ;; set a keymap (so the normal notmuch-show-mode-map remains).
800 (let ((mm-inline-text-html-with-w3m-keymap nil)
801 ;; FIXME: If we block an image, offer a button to load external
803 (gnus-blocked-images notmuch-show-text/html-blocked-images))
804 (notmuch-show-insert-part-*/* msg part content-type nth depth button))))
806 ;; These functions are used by notmuch-show--insert-part-text/html-shr
807 (declare-function libxml-parse-html-region "xml.c")
808 (declare-function shr-insert-document "shr")
810 (defun notmuch-show--insert-part-text/html-shr (msg part)
811 ;; Make sure shr is loaded before we start let-binding its globals
813 (let ((dom (let ((process-crypto notmuch-show-process-crypto))
815 (insert (notmuch-get-bodypart-text msg part process-crypto))
816 (libxml-parse-html-region (point-min) (point-max)))))
817 (shr-content-function
819 ;; shr strips the "cid:" part of URL, but doesn't
820 ;; URL-decode it (see RFC 2392).
821 (let ((cid (url-unhex-string url)))
822 (first (notmuch-show--get-cid-content cid))))))
823 (shr-insert-document dom)
826 (defun notmuch-show-insert-part-*/* (msg part content-type nth depth button)
827 ;; This handler _must_ succeed - it is the handler of last resort.
828 (notmuch-mm-display-part-inline msg part content-type notmuch-show-process-crypto)
831 ;; Functions for determining how to handle MIME parts.
833 (defun notmuch-show-handlers-for (content-type)
834 "Return a list of content handlers for a part of type CONTENT-TYPE."
839 ;; Reverse order of prefrence.
840 (list (intern (concat "notmuch-show-insert-part-*/*"))
842 "notmuch-show-insert-part-"
843 (car (notmuch-split-content-type content-type))
845 (intern (concat "notmuch-show-insert-part-" content-type))))
850 (defun notmuch-show-insert-bodypart-internal (msg part content-type nth depth button)
851 (let ((handlers (notmuch-show-handlers-for content-type)))
852 ;; Run the content handlers until one of them returns a non-nil
855 (not (condition-case err
856 (funcall (car handlers) msg part content-type nth depth button)
857 ;; Specifying `debug' here lets the debugger
858 ;; run if `debug-on-error' is non-nil.
861 (insert "!!! Bodypart insert error: ")
862 (insert (error-message-string err))
863 (insert " !!!\n") nil)))))
864 (setq handlers (cdr handlers))))
867 (defun notmuch-show-create-part-overlays (button beg end)
868 "Add an overlay to the part between BEG and END"
870 ;; If there is no button (i.e., the part is text/plain and the first
871 ;; part) or if the part has no content then we don't make the part
873 (when (and button (/= beg end))
874 (button-put button 'overlay (make-overlay beg end))
875 ;; Return true if we created an overlay.
878 (defun notmuch-show-record-part-information (part beg end)
879 "Store PART as a text property from BEG to END"
881 ;; Record part information. Since we already inserted subparts,
882 ;; don't override existing :notmuch-part properties.
883 (notmuch-map-text-property beg end :notmuch-part
884 (lambda (v) (or v part)))
885 ;; Make :notmuch-part front sticky and rear non-sticky so it stays
886 ;; applied to the beginning of each line when we indent the
887 ;; message. Since we're operating on arbitrary renderer output,
888 ;; watch out for sticky specs of t, which means all properties are
889 ;; front-sticky/rear-nonsticky.
890 (notmuch-map-text-property beg end 'front-sticky
891 (lambda (v) (if (listp v)
892 (pushnew :notmuch-part v)
894 (notmuch-map-text-property beg end 'rear-nonsticky
895 (lambda (v) (if (listp v)
896 (pushnew :notmuch-part v)
899 (defun notmuch-show-lazy-part (part-args button)
900 ;; Insert the lazy part after the button for the part. We would just
901 ;; move to the start of the new line following the button and insert
902 ;; the part but that point might have text properties (eg colours
903 ;; from a message header etc) so instead we start from the last
904 ;; character of the button by adding a newline and finish by
905 ;; removing the extra newline from the end of the part.
907 (goto-char (button-end button))
909 (let* ((inhibit-read-only t)
910 ;; We need to use markers for the start and end of the part
911 ;; because the part insertion functions do not guarantee
912 ;; to leave point at the end of the part.
913 (part-beg (copy-marker (point) nil))
914 (part-end (copy-marker (point) t))
915 ;; We have to save the depth as we can't find the depth
917 (depth (notmuch-show-get-depth)))
919 (narrow-to-region part-beg part-end)
920 (delete-region part-beg part-end)
921 (apply #'notmuch-show-insert-bodypart-internal part-args)
922 (indent-rigidly part-beg part-end depth))
925 (notmuch-show-record-part-information (second part-args)
926 (button-start button)
928 ;; Create the overlay. If the lazy-part turned out to be empty/not
929 ;; showable this returns nil.
930 (notmuch-show-create-part-overlays button part-beg part-end))))
932 (defun notmuch-show-insert-bodypart (msg part depth &optional hide)
933 "Insert the body part PART at depth DEPTH in the current thread.
935 HIDE determines whether to show or hide the part and the button
936 as follows: If HIDE is nil, show the part and the button. If HIDE
937 is t, hide the part initially and show the button. If HIDE is
938 'no-buttons, show the part but do not add any buttons (this is
939 useful for quoting in replies)."
941 (let* ((content-type (downcase (plist-get part :content-type)))
942 (mime-type (or (and (string= content-type "application/octet-stream")
943 (notmuch-show-get-mime-type-of-application/octet-stream part))
944 (and (string= content-type "inline patch")
947 (nth (plist-get part :id))
948 (long (and (notmuch-match-content-type mime-type "text/*")
949 (> notmuch-show-max-text-part-size 0)
950 (> (length (plist-get part :content)) notmuch-show-max-text-part-size)))
952 ;; We omit the part button for the first (or only) part if
953 ;; this is text/plain, or HIDE is 'no-buttons.
954 (button (unless (or (equal hide 'no-buttons)
955 (and (string= mime-type "text/plain") (<= nth 1)))
956 (notmuch-show-insert-part-header nth mime-type content-type (plist-get part :filename))))
957 ;; Hide the part initially if HIDE is t, or if it is too long
958 ;; and we have a button to allow toggling (thus reply which
959 ;; uses 'no-buttons automatically includes long parts)
960 (show-part (not (or (equal hide t)
962 (content-beg (point)))
964 ;; Store the computed mime-type for later use (e.g. by attachment handlers).
965 (plist-put part :computed-type mime-type)
968 (notmuch-show-insert-bodypart-internal msg part mime-type nth depth button)
969 (button-put button :notmuch-lazy-part
970 (list msg part mime-type nth depth button)))
972 ;; Some of the body part handlers leave point somewhere up in the
973 ;; part, so we make sure that we're down at the end.
974 (goto-char (point-max))
975 ;; Ensure that the part ends with a carriage return.
978 ;; We do not create the overlay for hidden (lazy) parts until
979 ;; they are inserted.
981 (notmuch-show-create-part-overlays button content-beg (point))
983 (notmuch-show-toggle-part-invisibility button)))
984 (notmuch-show-record-part-information part beg (point))))
986 (defun notmuch-show-insert-body (msg body depth)
987 "Insert the body BODY at depth DEPTH in the current thread."
989 ;; Register all content IDs for this message. According to RFC
990 ;; 2392, content IDs are *global*, but it's okay if an MUA treats
991 ;; them as only global within a message.
992 (notmuch-show--register-cids msg (first body))
994 (mapc (lambda (part) (notmuch-show-insert-bodypart msg part depth)) body))
996 (defun notmuch-show-make-symbol (type)
997 (make-symbol (concat "notmuch-show-" type)))
999 (defun notmuch-show-strip-re (string)
1000 (replace-regexp-in-string "^\\([Rr]e: *\\)+" "" string))
1002 (defvar notmuch-show-previous-subject "")
1003 (make-variable-buffer-local 'notmuch-show-previous-subject)
1005 (defun notmuch-show-insert-msg (msg depth)
1006 "Insert the message MSG at depth DEPTH in the current thread."
1007 (let* ((headers (plist-get msg :headers))
1008 ;; Indentation causes the buffer offset of the start/end
1009 ;; points to move, so we must use markers.
1010 message-start message-end
1011 content-start content-end
1012 headers-start headers-end
1013 (bare-subject (notmuch-show-strip-re (plist-get headers :Subject))))
1015 (setq message-start (point-marker))
1017 (notmuch-show-insert-headerline headers
1018 (or (if notmuch-show-relative-dates
1019 (plist-get msg :date_relative)
1021 (plist-get headers :Date))
1022 (plist-get msg :tags) depth)
1024 (setq content-start (point-marker))
1026 ;; Set `headers-start' to point after the 'Subject:' header to be
1027 ;; compatible with the existing implementation. This just sets it
1028 ;; to after the first header.
1029 (notmuch-show-insert-headers headers)
1031 (goto-char content-start)
1032 ;; If the subject of this message is the same as that of the
1033 ;; previous message, don't display it when this message is
1035 (when (not (string= notmuch-show-previous-subject
1038 (setq headers-start (point-marker)))
1039 (setq headers-end (point-marker))
1041 (setq notmuch-show-previous-subject bare-subject)
1043 ;; A blank line between the headers and the body.
1045 (notmuch-show-insert-body msg (plist-get msg :body)
1046 (if notmuch-show-indent-content depth 0))
1047 ;; Ensure that the body ends with a newline.
1050 (setq content-end (point-marker))
1052 ;; Indent according to the depth in the thread.
1053 (if notmuch-show-indent-content
1054 (indent-rigidly content-start content-end (* notmuch-show-indent-messages-width depth)))
1056 (setq message-end (point-max-marker))
1058 ;; Save the extents of this message over the whole text of the
1060 (put-text-property message-start message-end :notmuch-message-extent (cons message-start message-end))
1062 ;; Create overlays used to control visibility
1063 (plist-put msg :headers-overlay (make-overlay headers-start headers-end))
1064 (plist-put msg :message-overlay (make-overlay headers-start content-end))
1066 (plist-put msg :depth depth)
1068 ;; Save the properties for this message. Currently this saves the
1069 ;; entire message (augmented it with other stuff), which seems
1070 ;; like overkill. We might save a reduced subset (for example, not
1072 (notmuch-show-set-message-properties msg)
1074 ;; Set header visibility.
1075 (notmuch-show-headers-visible msg notmuch-message-headers-visible)
1077 ;; Message visibility depends on whether it matched the search
1079 (notmuch-show-message-visible msg (and (plist-get msg :match)
1080 (not (plist-get msg :excluded))))))
1082 (defun notmuch-show-toggle-process-crypto ()
1083 "Toggle the processing of cryptographic MIME parts."
1085 (setq notmuch-show-process-crypto (not notmuch-show-process-crypto))
1086 (message (if notmuch-show-process-crypto
1087 "Processing cryptographic MIME parts."
1088 "Not processing cryptographic MIME parts."))
1089 (notmuch-show-refresh-view))
1091 (defun notmuch-show-toggle-elide-non-matching ()
1092 "Toggle the display of non-matching messages."
1094 (setq notmuch-show-elide-non-matching-messages (not notmuch-show-elide-non-matching-messages))
1095 (message (if notmuch-show-elide-non-matching-messages
1096 "Showing matching messages only."
1097 "Showing all messages."))
1098 (notmuch-show-refresh-view))
1100 (defun notmuch-show-toggle-thread-indentation ()
1101 "Toggle the indentation of threads."
1103 (setq notmuch-show-indent-content (not notmuch-show-indent-content))
1104 (message (if notmuch-show-indent-content
1105 "Content is indented."
1106 "Content is not indented."))
1107 (notmuch-show-refresh-view))
1109 (defun notmuch-show-insert-tree (tree depth)
1110 "Insert the message tree TREE at depth DEPTH in the current thread."
1111 (let ((msg (car tree))
1112 (replies (cadr tree)))
1113 ;; We test whether there is a message or just some replies.
1115 (notmuch-show-insert-msg msg depth))
1116 (notmuch-show-insert-thread replies (1+ depth))))
1118 (defun notmuch-show-insert-thread (thread depth)
1119 "Insert the thread THREAD at depth DEPTH in the current forest."
1120 (mapc (lambda (tree) (notmuch-show-insert-tree tree depth)) thread))
1122 (defun notmuch-show-insert-forest (forest)
1123 "Insert the forest of threads FOREST."
1124 (mapc (lambda (thread) (notmuch-show-insert-thread thread 0)) forest))
1126 (defvar notmuch-id-regexp
1128 ;; Match the id: prefix only if it begins a word (to disallow, for
1129 ;; example, matching cid:).
1131 ;; If the term starts with a ", then parse Xapian's quoted boolean
1132 ;; term syntax, which allows for anything as long as embedded
1133 ;; double quotes escaped by doubling them. We also disallow
1134 ;; newlines (which Xapian allows) to prevent runaway terms.
1135 "\"\\([^\"\n]\\|\"\"\\)*\""
1136 ;; Otherwise, parse Xapian's unquoted syntax, which goes up to the
1137 ;; next space or ). We disallow [.,;] as the last character
1138 ;; because these are probably part of the surrounding text, and not
1139 ;; part of the id. This doesn't match single character ids; meh.
1140 "\\|[^\"[:space:])][^[:space:])]*[^])[:space:].,:;?!]"
1142 "The regexp used to match id: links in messages.")
1144 (defvar notmuch-mid-regexp
1145 ;; goto-address-url-regexp matched cid: links, which have the same
1146 ;; grammar as the message ID part of a mid: link. Construct the
1147 ;; regexp using the same technique as goto-address-url-regexp.
1148 (concat "\\<mid:\\(" thing-at-point-url-path-regexp "\\)")
1149 "The regexp used to match mid: links in messages.
1153 (defun notmuch-show-buttonise-links (start end)
1154 "Buttonise URLs and mail addresses between START and END.
1156 This also turns id:\"<message id>\"-parts and mid: links into
1157 buttons for a corresponding notmuch search."
1158 (goto-address-fontify-region start end)
1162 (while (re-search-forward notmuch-id-regexp end t)
1163 (push (list (match-beginning 0) (match-end 0)
1164 (match-string-no-properties 0)) links))
1166 (while (re-search-forward notmuch-mid-regexp end t)
1167 (let* ((mid-cid (match-string-no-properties 1))
1168 (mid (save-match-data
1169 (string-match "^[^/]*" mid-cid)
1170 (url-unhex-string (match-string 0 mid-cid)))))
1171 (push (list (match-beginning 0) (match-end 0)
1172 (notmuch-id-to-query mid)) links)))
1173 (dolist (link links)
1174 ;; Remove the overlay created by goto-address-mode
1175 (remove-overlays (first link) (second link) 'goto-address t)
1176 (make-text-button (first link) (second link)
1177 :type 'notmuch-button-type
1178 'action `(lambda (arg)
1179 (notmuch-show ,(third link) current-prefix-arg))
1181 'help-echo "Mouse-1, RET: search for this message"
1182 'face goto-address-mail-face)))))
1185 (defun notmuch-show (thread-id &optional elide-toggle parent-buffer query-context buffer-name)
1186 "Run \"notmuch show\" with the given thread ID and display results.
1188 ELIDE-TOGGLE, if non-nil, inverts the default elide behavior.
1190 The optional PARENT-BUFFER is the notmuch-search buffer from
1191 which this notmuch-show command was executed, (so that the
1192 next thread from that buffer can be show when done with this
1195 The optional QUERY-CONTEXT is a notmuch search term. Only
1196 messages from the thread matching this search term are shown if
1199 The optional BUFFER-NAME provides the name of the buffer in
1200 which the message thread is shown. If it is nil (which occurs
1201 when the command is called interactively) the argument to the
1203 (interactive "sNotmuch show: \nP")
1204 (let ((buffer-name (generate-new-buffer-name
1206 (concat "*notmuch-" thread-id "*")))))
1207 (switch-to-buffer (get-buffer-create buffer-name))
1208 ;; Set the default value for `notmuch-show-process-crypto' in this
1210 (setq notmuch-show-process-crypto notmuch-crypto-process-mime)
1211 ;; Set the default value for
1212 ;; `notmuch-show-elide-non-matching-messages' in this buffer. If
1213 ;; elide-toggle is set, invert the default.
1214 (setq notmuch-show-elide-non-matching-messages notmuch-show-only-matching-messages)
1216 (setq notmuch-show-elide-non-matching-messages (not notmuch-show-elide-non-matching-messages)))
1218 (setq notmuch-show-thread-id thread-id
1219 notmuch-show-parent-buffer parent-buffer
1220 notmuch-show-query-context query-context)
1221 (notmuch-show-build-buffer)
1222 (notmuch-show-goto-first-wanted-message)
1225 (defun notmuch-show-build-buffer ()
1226 (let ((inhibit-read-only t))
1229 (add-hook 'post-command-hook #'notmuch-show-command-hook nil t)
1231 ;; Don't track undo information for this buffer
1232 (set 'buffer-undo-list t)
1234 (notmuch-tag-clear-cache)
1236 (goto-char (point-min))
1238 (let* ((basic-args (list notmuch-show-thread-id))
1239 (args (if notmuch-show-query-context
1240 (append (list "\'") basic-args
1241 (list "and (" notmuch-show-query-context ")\'"))
1242 (append (list "\'") basic-args (list "\'"))))
1243 (cli-args (cons "--exclude=false"
1244 (when notmuch-show-elide-non-matching-messages
1245 (list "--entire-thread=false")))))
1247 (notmuch-show-insert-forest (notmuch-query-get-threads (append cli-args args)))
1248 ;; If the query context reduced the results to nothing, run
1250 (when (and (eq (buffer-size) 0)
1251 notmuch-show-query-context)
1252 (notmuch-show-insert-forest
1253 (notmuch-query-get-threads (append cli-args basic-args)))))
1255 (jit-lock-register #'notmuch-show-buttonise-links)
1257 (notmuch-show-mapc (lambda () (notmuch-show-set-prop :orig-tags (notmuch-show-get-tags))))
1259 ;; Set the header line to the subject of the first message.
1260 (setq header-line-format
1261 (replace-regexp-in-string "%" "%%"
1263 (notmuch-show-strip-re
1264 (notmuch-show-get-subject)))))
1266 (run-hooks 'notmuch-show-hook))))
1268 (defun notmuch-show-capture-state ()
1269 "Capture the state of the current buffer.
1272 - the list of open messages,
1273 - the current message."
1274 (list (notmuch-show-get-message-id) (notmuch-show-get-message-ids-for-open-messages)))
1276 (defun notmuch-show-get-query ()
1277 "Return the current query in this show buffer"
1278 (if notmuch-show-query-context
1279 (concat notmuch-show-thread-id
1281 notmuch-show-query-context
1283 notmuch-show-thread-id))
1285 (defun notmuch-show-goto-message (msg-id)
1286 "Go to message with msg-id."
1287 (goto-char (point-min))
1288 (unless (loop if (string= msg-id (notmuch-show-get-message-id))
1290 until (not (notmuch-show-goto-message-next)))
1291 (goto-char (point-min))
1292 (message "Message-id not found."))
1293 (notmuch-show-message-adjust))
1295 (defun notmuch-show-apply-state (state)
1296 "Apply STATE to the current buffer.
1299 - opening the messages previously opened,
1300 - closing all other messages,
1301 - moving to the correct current message."
1302 (let ((current (car state))
1303 (open (cadr state)))
1305 ;; Open those that were open.
1306 (goto-char (point-min))
1307 (loop do (notmuch-show-message-visible (notmuch-show-get-message-properties)
1308 (member (notmuch-show-get-message-id) open))
1309 until (not (notmuch-show-goto-message-next)))
1311 ;; Go to the previously open message.
1312 (notmuch-show-goto-message current)))
1314 (defun notmuch-show-refresh-view (&optional reset-state)
1315 "Refresh the current view.
1317 Refreshes the current view, observing changes in display
1318 preferences. If invoked with a prefix argument (or RESET-STATE is
1319 non-nil) then the state of the buffer (open/closed messages) is
1320 reset based on the original query."
1322 (let ((inhibit-read-only t)
1323 (state (unless reset-state
1324 (notmuch-show-capture-state))))
1325 ;; erase-buffer does not seem to remove overlays, which can lead
1326 ;; to weird effects such as remaining images, so remove them
1330 (notmuch-show-build-buffer)
1332 (notmuch-show-apply-state state)
1333 ;; We're resetting state, so navigate to the first open message
1334 ;; and mark it read, just like opening a new show buffer.
1335 (notmuch-show-goto-first-wanted-message))))
1337 (defvar notmuch-show-stash-map
1338 (let ((map (make-sparse-keymap)))
1339 (define-key map "c" 'notmuch-show-stash-cc)
1340 (define-key map "d" 'notmuch-show-stash-date)
1341 (define-key map "F" 'notmuch-show-stash-filename)
1342 (define-key map "f" 'notmuch-show-stash-from)
1343 (define-key map "i" 'notmuch-show-stash-message-id)
1344 (define-key map "I" 'notmuch-show-stash-message-id-stripped)
1345 (define-key map "s" 'notmuch-show-stash-subject)
1346 (define-key map "T" 'notmuch-show-stash-tags)
1347 (define-key map "t" 'notmuch-show-stash-to)
1348 (define-key map "l" 'notmuch-show-stash-mlarchive-link)
1349 (define-key map "L" 'notmuch-show-stash-mlarchive-link-and-go)
1350 (define-key map "G" 'notmuch-show-stash-git-send-email)
1351 (define-key map "?" 'notmuch-subkeymap-help)
1353 "Submap for stash commands")
1354 (fset 'notmuch-show-stash-map notmuch-show-stash-map)
1356 (defvar notmuch-show-part-map
1357 (let ((map (make-sparse-keymap)))
1358 (define-key map "s" 'notmuch-show-save-part)
1359 (define-key map "v" 'notmuch-show-view-part)
1360 (define-key map "o" 'notmuch-show-interactively-view-part)
1361 (define-key map "|" 'notmuch-show-pipe-part)
1362 (define-key map "?" 'notmuch-subkeymap-help)
1364 "Submap for part commands")
1365 (fset 'notmuch-show-part-map notmuch-show-part-map)
1367 (defvar notmuch-show-mode-map
1368 (let ((map (make-sparse-keymap)))
1369 (set-keymap-parent map notmuch-common-keymap)
1370 (define-key map "Z" 'notmuch-tree-from-show-current-query)
1371 (define-key map (kbd "<C-tab>") 'widget-backward)
1372 (define-key map (kbd "M-TAB") 'notmuch-show-previous-button)
1373 (define-key map (kbd "<backtab>") 'notmuch-show-previous-button)
1374 (define-key map (kbd "TAB") 'notmuch-show-next-button)
1375 (define-key map "f" 'notmuch-show-forward-message)
1376 (define-key map "l" 'notmuch-show-filter-thread)
1377 (define-key map "r" 'notmuch-show-reply-sender)
1378 (define-key map "R" 'notmuch-show-reply)
1379 (define-key map "|" 'notmuch-show-pipe-message)
1380 (define-key map "w" 'notmuch-show-save-attachments)
1381 (define-key map "V" 'notmuch-show-view-raw-message)
1382 (define-key map "c" 'notmuch-show-stash-map)
1383 (define-key map "h" 'notmuch-show-toggle-visibility-headers)
1384 (define-key map "*" 'notmuch-show-tag-all)
1385 (define-key map "-" 'notmuch-show-remove-tag)
1386 (define-key map "+" 'notmuch-show-add-tag)
1387 (define-key map "X" 'notmuch-show-archive-thread-then-exit)
1388 (define-key map "x" 'notmuch-show-archive-message-then-next-or-exit)
1389 (define-key map "A" 'notmuch-show-archive-thread-then-next)
1390 (define-key map "a" 'notmuch-show-archive-message-then-next-or-next-thread)
1391 (define-key map "N" 'notmuch-show-next-message)
1392 (define-key map "P" 'notmuch-show-previous-message)
1393 (define-key map "n" 'notmuch-show-next-open-message)
1394 (define-key map "p" 'notmuch-show-previous-open-message)
1395 (define-key map (kbd "M-n") 'notmuch-show-next-thread-show)
1396 (define-key map (kbd "M-p") 'notmuch-show-previous-thread-show)
1397 (define-key map (kbd "DEL") 'notmuch-show-rewind)
1398 (define-key map " " 'notmuch-show-advance-and-archive)
1399 (define-key map (kbd "M-RET") 'notmuch-show-open-or-close-all)
1400 (define-key map (kbd "RET") 'notmuch-show-toggle-message)
1401 (define-key map "#" 'notmuch-show-print-message)
1402 (define-key map "!" 'notmuch-show-toggle-elide-non-matching)
1403 (define-key map "$" 'notmuch-show-toggle-process-crypto)
1404 (define-key map "<" 'notmuch-show-toggle-thread-indentation)
1405 (define-key map "t" 'toggle-truncate-lines)
1406 (define-key map "." 'notmuch-show-part-map)
1408 "Keymap for \"notmuch show\" buffers.")
1409 (fset 'notmuch-show-mode-map notmuch-show-mode-map)
1411 (defun notmuch-show-mode ()
1412 "Major mode for viewing a thread with notmuch.
1414 This buffer contains the results of the \"notmuch show\" command
1415 for displaying a single thread of email from your email archives.
1417 By default, various components of email messages, (citations,
1418 signatures, already-read messages), are hidden. You can make
1419 these parts visible by clicking with the mouse button or by
1420 pressing RET after positioning the cursor on a hidden part, (for
1421 which \\[notmuch-show-next-button] and \\[notmuch-show-previous-button] are helpful).
1423 Reading the thread sequentially is well-supported by pressing
1424 \\[notmuch-show-advance-and-archive]. This will scroll the current message (if necessary), advance
1425 to the next message, or advance to the next thread (if already on
1426 the last message of a thread).
1428 Other commands are available to read or manipulate the thread
1429 more selectively, (such as '\\[notmuch-show-next-message]' and '\\[notmuch-show-previous-message]' to advance to messages
1430 without removing any tags, and '\\[notmuch-show-archive-thread]' to archive an entire thread
1431 without scrolling through with \\[notmuch-show-advance-and-archive]).
1433 You can add or remove arbitrary tags from the current message with
1434 '\\[notmuch-show-add-tag]' or '\\[notmuch-show-remove-tag]'.
1436 All currently available key bindings:
1438 \\{notmuch-show-mode-map}"
1440 (kill-all-local-variables)
1441 (setq notmuch-buffer-refresh-function #'notmuch-show-refresh-view)
1442 (use-local-map notmuch-show-mode-map)
1443 (setq major-mode 'notmuch-show-mode
1444 mode-name "notmuch-show")
1445 (setq buffer-read-only t
1448 (defun notmuch-tree-from-show-current-query ()
1449 "Call notmuch tree with the current query"
1451 (notmuch-tree notmuch-show-thread-id
1452 notmuch-show-query-context
1453 (notmuch-show-get-message-id)))
1455 (defun notmuch-show-move-to-message-top ()
1456 (goto-char (notmuch-show-message-top)))
1458 (defun notmuch-show-move-to-message-bottom ()
1459 (goto-char (notmuch-show-message-bottom)))
1461 (defun notmuch-show-message-adjust ()
1464 ;; Movement related functions.
1466 ;; There's some strangeness here where a text property applied to a
1467 ;; region a->b is not found when point is at b. We walk backwards
1468 ;; until finding the property.
1469 (defun notmuch-show-message-extent ()
1472 (while (not (setq r (get-text-property (point) :notmuch-message-extent)))
1476 (defun notmuch-show-message-top ()
1477 (car (notmuch-show-message-extent)))
1479 (defun notmuch-show-message-bottom ()
1480 (cdr (notmuch-show-message-extent)))
1482 (defun notmuch-show-goto-message-next ()
1483 (let ((start (point)))
1484 (notmuch-show-move-to-message-bottom)
1490 (defun notmuch-show-goto-message-previous ()
1491 (notmuch-show-move-to-message-top)
1495 (notmuch-show-move-to-message-top)
1498 (defun notmuch-show-mapc (function)
1499 "Iterate through all messages in the current thread with
1500 `notmuch-show-goto-message-next' and call FUNCTION for side
1503 (goto-char (point-min))
1504 (loop do (funcall function)
1505 while (notmuch-show-goto-message-next))))
1507 ;; Functions relating to the visibility of messages and their
1510 (defun notmuch-show-message-visible (props visible-p)
1511 (overlay-put (plist-get props :message-overlay) 'invisible (not visible-p))
1512 (notmuch-show-set-prop :message-visible visible-p props))
1514 (defun notmuch-show-headers-visible (props visible-p)
1515 (overlay-put (plist-get props :headers-overlay) 'invisible (not visible-p))
1516 (notmuch-show-set-prop :headers-visible visible-p props))
1518 ;; Functions for setting and getting attributes of the current
1521 (defun notmuch-show-set-message-properties (props)
1523 (notmuch-show-move-to-message-top)
1524 (put-text-property (point) (+ (point) 1) :notmuch-message-properties props)))
1526 (defun notmuch-show-get-message-properties ()
1527 "Return the properties of the current message as a plist.
1529 Some useful entries are:
1530 :headers - Property list containing the headers :Date, :Subject, :From, etc.
1531 :body - Body of the message
1532 :tags - Tags for this message"
1534 (notmuch-show-move-to-message-top)
1535 (get-text-property (point) :notmuch-message-properties)))
1537 (defun notmuch-show-get-part-properties ()
1538 "Return the properties of the innermost part containing point.
1540 This is the part property list retrieved from the CLI. Signals
1541 an error if there is no part containing point."
1542 (or (get-text-property (point) :notmuch-part)
1543 (error "No message part here")))
1545 (defun notmuch-show-set-prop (prop val &optional props)
1546 (let ((inhibit-read-only t)
1548 (notmuch-show-get-message-properties))))
1549 (plist-put props prop val)
1550 (notmuch-show-set-message-properties props)))
1552 (defun notmuch-show-get-prop (prop &optional props)
1553 "Get property PROP from current message in show or tree mode.
1555 It gets property PROP from PROPS or, if PROPS is nil, the current
1556 message in either tree or show. This means that several utility
1557 functions in notmuch-show can be used directly by notmuch-tree as
1558 they just need the correct message properties."
1559 (let ((props (or props
1560 (cond ((eq major-mode 'notmuch-show-mode)
1561 (notmuch-show-get-message-properties))
1562 ((eq major-mode 'notmuch-tree-mode)
1563 (notmuch-tree-get-message-properties))
1565 (plist-get props prop)))
1567 (defun notmuch-show-get-message-id (&optional bare)
1568 "Return an id: query for the Message-Id of the current message.
1570 If optional argument BARE is non-nil, return
1571 the Message-Id without id: prefix and escaping."
1573 (notmuch-show-get-prop :id)
1574 (notmuch-id-to-query (notmuch-show-get-prop :id))))
1576 (defun notmuch-show-get-messages-ids ()
1577 "Return all id: queries of messages in the current thread."
1578 (let ((message-ids))
1580 (lambda () (push (notmuch-show-get-message-id) message-ids)))
1583 (defun notmuch-show-get-messages-ids-search ()
1584 "Return a search string for all message ids of messages in the
1586 (mapconcat 'identity (notmuch-show-get-messages-ids) " or "))
1588 ;; dme: Would it make sense to use a macro for many of these?
1590 (defun notmuch-show-get-filename ()
1591 "Return the filename of the current message."
1592 (notmuch-show-get-prop :filename))
1594 (defun notmuch-show-get-header (header &optional props)
1595 "Return the named header of the current message, if any."
1596 (plist-get (notmuch-show-get-prop :headers props) header))
1598 (defun notmuch-show-get-cc ()
1599 (notmuch-show-get-header :Cc))
1601 (defun notmuch-show-get-date ()
1602 (notmuch-show-get-header :Date))
1604 (defun notmuch-show-get-from ()
1605 (notmuch-show-get-header :From))
1607 (defun notmuch-show-get-subject ()
1608 (notmuch-show-get-header :Subject))
1610 (defun notmuch-show-get-to ()
1611 (notmuch-show-get-header :To))
1613 (defun notmuch-show-get-depth ()
1614 (notmuch-show-get-prop :depth))
1616 (defun notmuch-show-set-tags (tags)
1617 "Set the tags of the current message."
1618 (notmuch-show-set-prop :tags tags)
1619 (notmuch-show-update-tags tags))
1621 (defun notmuch-show-get-tags ()
1622 "Return the tags of the current message."
1623 (notmuch-show-get-prop :tags))
1625 (defun notmuch-show-message-visible-p ()
1626 "Is the current message visible?"
1627 (notmuch-show-get-prop :message-visible))
1629 (defun notmuch-show-headers-visible-p ()
1630 "Are the headers of the current message visible?"
1631 (notmuch-show-get-prop :headers-visible))
1633 (put 'notmuch-show-mark-read 'notmuch-prefix-doc
1634 "Mark the current message as unread.")
1635 (defun notmuch-show-mark-read (&optional unread)
1636 "Mark the current message as read.
1638 Mark the current message as read by applying the tag changes in
1639 `notmuch-show-mark-read-tags' to it (remove the \"unread\" tag by
1640 default). If a prefix argument is given, the message will be
1641 marked as unread, i.e. the tag changes in
1642 `notmuch-show-mark-read-tags' will be reversed."
1644 (when notmuch-show-mark-read-tags
1645 (apply 'notmuch-show-tag-message
1646 (notmuch-tag-change-list notmuch-show-mark-read-tags unread))))
1648 (defun notmuch-show-seen-current-message (start end)
1649 "Mark the current message read if it is open.
1651 We only mark it read once: if it is changed back then that is a
1652 user decision and we should not override it."
1653 (when (and (notmuch-show-message-visible-p)
1654 (not (notmuch-show-get-prop :seen)))
1655 (notmuch-show-mark-read)
1656 (notmuch-show-set-prop :seen t)))
1658 (defun notmuch-show-command-hook ()
1659 (when (eq major-mode 'notmuch-show-mode)
1660 ;; We need to redisplay to get window-start and window-end correct.
1663 (funcall notmuch-show-mark-read-function (window-start) (window-end)))))
1665 (defun notmuch-show-filter-thread (query)
1666 "Filter or LIMIT the current thread based on a new query string.
1668 Reshows the current thread with matches defined by the new query-string."
1669 (interactive (list (notmuch-read-query "Filter thread: ")))
1670 (let ((msg-id (notmuch-show-get-message-id)))
1671 (setq notmuch-show-query-context (if (string= query "") nil query))
1672 (notmuch-show-refresh-view t)
1673 (notmuch-show-goto-message msg-id)))
1675 ;; Functions for getting attributes of several messages in the current
1678 (defun notmuch-show-get-message-ids-for-open-messages ()
1679 "Return a list of all id: queries for open messages in the current thread."
1681 (let (message-ids done)
1682 (goto-char (point-min))
1684 (if (notmuch-show-message-visible-p)
1685 (setq message-ids (append message-ids (list (notmuch-show-get-message-id)))))
1686 (setq done (not (notmuch-show-goto-message-next)))
1691 ;; Commands typically bound to keys.
1693 (defun notmuch-show-advance ()
1694 "Advance through thread.
1696 If the current message in the thread is not yet fully visible,
1697 scroll by a near screenful to read more of the message.
1699 Otherwise, (the end of the current message is already within the
1700 current window), advance to the next open message."
1702 (let* ((end-of-this-message (notmuch-show-message-bottom))
1703 (visible-end-of-this-message (1- end-of-this-message))
1705 (while (invisible-p visible-end-of-this-message)
1706 (setq visible-end-of-this-message
1708 (1- (previous-single-char-property-change
1709 visible-end-of-this-message 'invisible)))))
1711 ;; Ideally we would test `end-of-this-message' against the result
1712 ;; of `window-end', but that doesn't account for the fact that
1713 ;; the end of the message might be hidden.
1714 ((and visible-end-of-this-message
1715 (> visible-end-of-this-message (window-end)))
1716 ;; The bottom of this message is not visible - scroll.
1719 ((not (= end-of-this-message (point-max)))
1720 ;; This is not the last message - move to the next visible one.
1721 (notmuch-show-next-open-message))
1723 ((not (= (point) (point-max)))
1724 ;; This is the last message, but the cursor is not at the end of
1725 ;; the buffer. Move it there.
1726 (goto-char (point-max)))
1729 ;; This is the last message - change the return value
1733 (defun notmuch-show-advance-and-archive ()
1734 "Advance through thread and archive.
1736 This command is intended to be one of the simplest ways to
1737 process a thread of email. It works exactly like
1738 notmuch-show-advance, in that it scrolls through messages in a
1739 show buffer, except that when it gets to the end of the buffer it
1740 archives the entire current thread, (apply changes in
1741 `notmuch-archive-tags'), kills the buffer, and displays the next
1742 thread from the search from which this thread was originally
1745 (if (notmuch-show-advance)
1746 (notmuch-show-archive-thread-then-next)))
1748 (defun notmuch-show-rewind ()
1749 "Backup through the thread (reverse scrolling compared to \\[notmuch-show-advance-and-archive]).
1751 Specifically, if the beginning of the previous email is fewer
1752 than `window-height' lines from the current point, move to it
1753 just like `notmuch-show-previous-message'.
1755 Otherwise, just scroll down a screenful of the current message.
1757 This command does not modify any message tags, (it does not undo
1758 any effects from previous calls to
1759 `notmuch-show-advance-and-archive'."
1761 (let ((start-of-message (notmuch-show-message-top))
1762 (start-of-window (window-start)))
1764 ;; Either this message is properly aligned with the start of the
1765 ;; window or the start of this message is not visible on the
1767 ((or (= start-of-message start-of-window)
1768 (< start-of-message start-of-window))
1770 ;; If a small number of lines from the previous message are
1771 ;; visible, realign so that the top of the current message is at
1772 ;; the top of the screen.
1773 (when (<= (count-screen-lines (window-start) start-of-message)
1774 next-screen-context-lines)
1775 (goto-char (notmuch-show-message-top))
1776 (notmuch-show-message-adjust))
1777 ;; Move to the top left of the window.
1778 (goto-char (window-start)))
1780 ;; Move to the previous message.
1781 (notmuch-show-previous-message)))))
1783 (put 'notmuch-show-reply 'notmuch-prefix-doc "... and prompt for sender")
1784 (defun notmuch-show-reply (&optional prompt-for-sender)
1785 "Reply to the sender and all recipients of the current message."
1787 (notmuch-mua-new-reply (notmuch-show-get-message-id) prompt-for-sender t))
1789 (put 'notmuch-show-reply-sender 'notmuch-prefix-doc "... and prompt for sender")
1790 (defun notmuch-show-reply-sender (&optional prompt-for-sender)
1791 "Reply to the sender of the current message."
1793 (notmuch-mua-new-reply (notmuch-show-get-message-id) prompt-for-sender nil))
1795 (put 'notmuch-show-forward-message 'notmuch-prefix-doc
1796 "... and prompt for sender")
1797 (defun notmuch-show-forward-message (&optional prompt-for-sender)
1798 "Forward the current message."
1800 (with-current-notmuch-show-message
1801 (notmuch-mua-new-forward-message prompt-for-sender)))
1803 (defun notmuch-show-next-message (&optional pop-at-end)
1804 "Show the next message.
1806 If a prefix argument is given and this is the last message in the
1807 thread, navigate to the next thread in the parent search buffer."
1809 (if (notmuch-show-goto-message-next)
1810 (notmuch-show-message-adjust)
1812 (notmuch-show-next-thread)
1813 (goto-char (point-max)))))
1815 (defun notmuch-show-previous-message ()
1816 "Show the previous message or the start of the current message."
1818 (if (= (point) (notmuch-show-message-top))
1819 (notmuch-show-goto-message-previous)
1820 (notmuch-show-move-to-message-top))
1821 (notmuch-show-message-adjust))
1823 (defun notmuch-show-next-open-message (&optional pop-at-end)
1824 "Show the next open message.
1826 If a prefix argument is given and this is the last open message
1827 in the thread, navigate to the next thread in the parent search
1828 buffer. Return t if there was a next open message in the thread
1829 to show, nil otherwise."
1832 (while (and (setq r (notmuch-show-goto-message-next))
1833 (not (notmuch-show-message-visible-p))))
1835 (notmuch-show-message-adjust)
1837 (notmuch-show-next-thread)
1838 (goto-char (point-max))))
1841 (defun notmuch-show-next-matching-message ()
1842 "Show the next matching message."
1845 (while (and (setq r (notmuch-show-goto-message-next))
1846 (not (notmuch-show-get-prop :match))))
1848 (notmuch-show-message-adjust)
1849 (goto-char (point-max)))))
1851 (defun notmuch-show-open-if-matched ()
1852 "Open a message if it is matched (whether or not excluded)."
1853 (let ((props (notmuch-show-get-message-properties)))
1854 (notmuch-show-message-visible props (plist-get props :match))))
1856 (defun notmuch-show-goto-first-wanted-message ()
1857 "Move to the first open message and mark it read"
1858 (goto-char (point-min))
1859 (unless (notmuch-show-message-visible-p)
1860 (notmuch-show-next-open-message))
1862 ;; There are no matched non-excluded messages so open all matched
1863 ;; (necessarily excluded) messages and go to the first.
1864 (notmuch-show-mapc 'notmuch-show-open-if-matched)
1865 (force-window-update)
1866 (goto-char (point-min))
1867 (unless (notmuch-show-message-visible-p)
1868 (notmuch-show-next-open-message))))
1870 (defun notmuch-show-previous-open-message ()
1871 "Show the previous open message."
1873 (while (and (if (= (point) (notmuch-show-message-top))
1874 (notmuch-show-goto-message-previous)
1875 (notmuch-show-move-to-message-top))
1876 (not (notmuch-show-message-visible-p))))
1877 (notmuch-show-message-adjust))
1879 (defun notmuch-show-view-raw-message ()
1880 "View the original source of the current message."
1882 (let* ((id (notmuch-show-get-message-id))
1883 (buf (get-buffer-create (concat "*notmuch-raw-" id "*"))))
1884 (let ((coding-system-for-read 'no-conversion))
1885 (call-process notmuch-command nil buf nil "show" "--format=raw" id))
1886 (switch-to-buffer buf)
1887 (goto-char (point-min))
1888 (set-buffer-modified-p nil)
1889 (view-buffer buf 'kill-buffer-if-not-modified)))
1891 (put 'notmuch-show-pipe-message 'notmuch-doc
1892 "Pipe the contents of the current message to a command.")
1893 (put 'notmuch-show-pipe-message 'notmuch-prefix-doc
1894 "Pipe the thread as an mbox to a command.")
1895 (defun notmuch-show-pipe-message (entire-thread command)
1896 "Pipe the contents of the current message (or thread) to COMMAND.
1898 COMMAND will be executed with the raw contents of the current
1899 email message as stdin. Anything printed by the command to stdout
1900 or stderr will appear in the *notmuch-pipe* buffer.
1902 If ENTIRE-THREAD is non-nil (or when invoked with a prefix
1903 argument), COMMAND will receive all open messages in the current
1904 thread (formatted as an mbox) rather than only the current
1906 (interactive (let ((query-string (if current-prefix-arg
1907 "Pipe all open messages to command: "
1908 "Pipe message to command: ")))
1909 (list current-prefix-arg (read-string query-string))))
1910 (let (shell-command)
1913 (concat notmuch-command " show --format=mbox --exclude=false "
1914 (shell-quote-argument
1915 (mapconcat 'identity (notmuch-show-get-message-ids-for-open-messages) " OR "))
1918 (concat notmuch-command " show --format=raw "
1919 (shell-quote-argument (notmuch-show-get-message-id)) " | " command)))
1920 (let ((cwd default-directory)
1921 (buf (get-buffer-create (concat "*notmuch-pipe*"))))
1922 (with-current-buffer buf
1923 (setq buffer-read-only nil)
1925 ;; Use the originating buffer's working directory instead of
1926 ;; that of the pipe buffer.
1928 (let ((exit-code (call-process-shell-command shell-command nil buf)))
1929 (goto-char (point-max))
1930 (set-buffer-modified-p nil)
1931 (setq buffer-read-only t)
1932 (unless (zerop exit-code)
1933 (switch-to-buffer-other-window buf)
1934 (message (format "Command '%s' exited abnormally with code %d"
1935 shell-command exit-code))))))))
1937 (defun notmuch-show-tag-message (&rest tag-changes)
1938 "Change tags for the current message.
1940 TAG-CHANGES is a list of tag operations for `notmuch-tag'."
1941 (let* ((current-tags (notmuch-show-get-tags))
1942 (new-tags (notmuch-update-tags current-tags tag-changes)))
1943 (unless (equal current-tags new-tags)
1944 (notmuch-tag (notmuch-show-get-message-id) tag-changes)
1945 (notmuch-show-set-tags new-tags))))
1947 (defun notmuch-show-tag (tag-changes)
1948 "Change tags for the current message.
1950 See `notmuch-tag' for information on the format of TAG-CHANGES."
1951 (interactive (list (notmuch-read-tag-changes (notmuch-show-get-tags)
1953 (notmuch-tag (notmuch-show-get-message-id) tag-changes)
1954 (let* ((current-tags (notmuch-show-get-tags))
1955 (new-tags (notmuch-update-tags current-tags tag-changes)))
1956 (unless (equal current-tags new-tags)
1957 (notmuch-show-set-tags new-tags))))
1959 (defun notmuch-show-tag-all (tag-changes)
1960 "Change tags for all messages in the current show buffer.
1962 See `notmuch-tag' for information on the format of TAG-CHANGES."
1966 (lambda () (setq tags (append (notmuch-show-get-tags) tags))))
1967 (notmuch-read-tag-changes tags "Tag thread"))))
1968 (notmuch-tag (notmuch-show-get-messages-ids-search) tag-changes)
1971 (let* ((current-tags (notmuch-show-get-tags))
1972 (new-tags (notmuch-update-tags current-tags tag-changes)))
1973 (unless (equal current-tags new-tags)
1974 (notmuch-show-set-tags new-tags))))))
1976 (defun notmuch-show-add-tag (tag-changes)
1977 "Change tags for the current message (defaulting to add).
1979 Same as `notmuch-show-tag' but sets initial input to '+'."
1981 (list (notmuch-read-tag-changes (notmuch-show-get-tags) "Tag message" "+")))
1982 (notmuch-show-tag tag-changes))
1984 (defun notmuch-show-remove-tag (tag-changes)
1985 "Change tags for the current message (defaulting to remove).
1987 Same as `notmuch-show-tag' but sets initial input to '-'."
1989 (list (notmuch-read-tag-changes (notmuch-show-get-tags) "Tag message" "-")))
1990 (notmuch-show-tag tag-changes))
1992 (defun notmuch-show-toggle-visibility-headers ()
1993 "Toggle the visibility of the current message headers."
1995 (let ((props (notmuch-show-get-message-properties)))
1996 (notmuch-show-headers-visible
1998 (not (plist-get props :headers-visible))))
1999 (force-window-update))
2001 (defun notmuch-show-toggle-message ()
2002 "Toggle the visibility of the current message."
2004 (let ((props (notmuch-show-get-message-properties)))
2005 (notmuch-show-message-visible
2007 (not (plist-get props :message-visible))))
2008 (force-window-update))
2010 (put 'notmuch-show-open-or-close-all 'notmuch-doc "Show all messages.")
2011 (put 'notmuch-show-open-or-close-all 'notmuch-prefix-doc "Hide all messages.")
2012 (defun notmuch-show-open-or-close-all ()
2013 "Set the visibility all of the messages in the current thread.
2015 By default make all of the messages visible. With a prefix
2016 argument, hide all of the messages."
2019 (goto-char (point-min))
2020 (loop do (notmuch-show-message-visible (notmuch-show-get-message-properties)
2021 (not current-prefix-arg))
2022 until (not (notmuch-show-goto-message-next))))
2023 (force-window-update))
2025 (defun notmuch-show-next-button ()
2026 "Advance point to the next button in the buffer."
2030 (defun notmuch-show-previous-button ()
2031 "Move point back to the previous button in the buffer."
2033 (backward-button 1))
2035 (defun notmuch-show-next-thread (&optional show previous)
2036 "Move to the next item in the search results, if any.
2038 If SHOW is non-nil, open the next item in a show
2039 buffer. Otherwise just highlight the next item in the search
2040 buffer. If PREVIOUS is non-nil, move to the previous item in the
2041 search results instead."
2043 (let ((parent-buffer notmuch-show-parent-buffer))
2044 (notmuch-bury-or-kill-this-buffer)
2045 (when (buffer-live-p parent-buffer)
2046 (switch-to-buffer parent-buffer)
2048 (notmuch-search-previous-thread)
2049 (notmuch-search-next-thread))
2051 (notmuch-search-show-thread)))))
2053 (defun notmuch-show-next-thread-show ()
2054 "Show the next thread in the search results, if any."
2056 (notmuch-show-next-thread t))
2058 (defun notmuch-show-previous-thread-show ()
2059 "Show the previous thread in the search results, if any."
2061 (notmuch-show-next-thread t t))
2063 (put 'notmuch-show-archive-thread 'notmuch-prefix-doc
2064 "Un-archive each message in thread.")
2065 (defun notmuch-show-archive-thread (&optional unarchive)
2066 "Archive each message in thread.
2068 Archive each message currently shown by applying the tag changes
2069 in `notmuch-archive-tags' to each. If a prefix argument is given,
2070 the messages will be \"unarchived\", i.e. the tag changes in
2071 `notmuch-archive-tags' will be reversed.
2073 Note: This command is safe from any race condition of new messages
2074 being delivered to the same thread. It does not archive the
2075 entire thread, but only the messages shown in the current
2078 (when notmuch-archive-tags
2079 (notmuch-show-tag-all
2080 (notmuch-tag-change-list notmuch-archive-tags unarchive))))
2082 (defun notmuch-show-archive-thread-then-next ()
2083 "Archive all messages in the current buffer, then show next thread from search."
2085 (notmuch-show-archive-thread)
2086 (notmuch-show-next-thread t))
2088 (defun notmuch-show-archive-thread-then-exit ()
2089 "Archive all messages in the current buffer, then exit back to search results."
2091 (notmuch-show-archive-thread)
2092 (notmuch-show-next-thread))
2094 (put 'notmuch-show-archive-message 'notmuch-prefix-doc
2095 "Un-archive the current message.")
2096 (defun notmuch-show-archive-message (&optional unarchive)
2097 "Archive the current message.
2099 Archive the current message by applying the tag changes in
2100 `notmuch-archive-tags' to it. If a prefix argument is given, the
2101 message will be \"unarchived\", i.e. the tag changes in
2102 `notmuch-archive-tags' will be reversed."
2104 (when notmuch-archive-tags
2105 (apply 'notmuch-show-tag-message
2106 (notmuch-tag-change-list notmuch-archive-tags unarchive))))
2108 (defun notmuch-show-archive-message-then-next-or-exit ()
2109 "Archive the current message, then show the next open message in the current thread.
2111 If at the last open message in the current thread, then exit back
2114 (notmuch-show-archive-message)
2115 (notmuch-show-next-open-message t))
2117 (defun notmuch-show-archive-message-then-next-or-next-thread ()
2118 "Archive the current message, then show the next open message in the current thread.
2120 If at the last open message in the current thread, then show next
2121 thread from search."
2123 (notmuch-show-archive-message)
2124 (unless (notmuch-show-next-open-message)
2125 (notmuch-show-next-thread t)))
2127 (defun notmuch-show-stash-cc ()
2128 "Copy CC field of current message to kill-ring."
2130 (notmuch-common-do-stash (notmuch-show-get-cc)))
2132 (defun notmuch-show-stash-date ()
2133 "Copy date of current message to kill-ring."
2135 (notmuch-common-do-stash (notmuch-show-get-date)))
2137 (defun notmuch-show-stash-filename ()
2138 "Copy filename of current message to kill-ring."
2140 (notmuch-common-do-stash (notmuch-show-get-filename)))
2142 (defun notmuch-show-stash-from ()
2143 "Copy From address of current message to kill-ring."
2145 (notmuch-common-do-stash (notmuch-show-get-from)))
2147 (put 'notmuch-show-stash-message-id 'notmuch-prefix-doc
2148 "Copy thread: query matching current thread to kill-ring.")
2149 (defun notmuch-show-stash-message-id (&optional stash-thread-id)
2150 "Copy id: query matching the current message to kill-ring.
2152 If invoked with a prefix argument (or STASH-THREAD-ID is
2153 non-nil), copy thread: query matching the current thread to
2157 (notmuch-common-do-stash notmuch-show-thread-id)
2158 (notmuch-common-do-stash (notmuch-show-get-message-id))))
2160 (defun notmuch-show-stash-message-id-stripped ()
2161 "Copy message ID of current message (sans `id:' prefix) to kill-ring."
2163 (notmuch-common-do-stash (notmuch-show-get-message-id t)))
2165 (defun notmuch-show-stash-subject ()
2166 "Copy Subject field of current message to kill-ring."
2168 (notmuch-common-do-stash (notmuch-show-get-subject)))
2170 (defun notmuch-show-stash-tags ()
2171 "Copy tags of current message to kill-ring as a comma separated list."
2173 (notmuch-common-do-stash (mapconcat 'identity (notmuch-show-get-tags) ",")))
2175 (defun notmuch-show-stash-to ()
2176 "Copy To address of current message to kill-ring."
2178 (notmuch-common-do-stash (notmuch-show-get-to)))
2180 (defun notmuch-show-stash-mlarchive-link (&optional mla)
2181 "Copy an ML Archive URI for the current message to the kill-ring.
2183 This presumes that the message is available at the selected Mailing List Archive.
2185 If optional argument MLA is non-nil, use the provided key instead of prompting
2186 the user (see `notmuch-show-stash-mlarchive-link-alist')."
2188 (let ((url (cdr (assoc
2190 (let ((completion-ignore-case t))
2192 "Mailing List Archive: "
2193 notmuch-show-stash-mlarchive-link-alist
2195 notmuch-show-stash-mlarchive-link-default)))
2196 notmuch-show-stash-mlarchive-link-alist))))
2197 (notmuch-common-do-stash
2199 (funcall url (notmuch-show-get-message-id t))
2200 (concat url (notmuch-show-get-message-id t))))))
2202 (defun notmuch-show-stash-mlarchive-link-and-go (&optional mla)
2203 "Copy an ML Archive URI for the current message to the kill-ring and visit it.
2205 This presumes that the message is available at the selected Mailing List Archive.
2207 If optional argument MLA is non-nil, use the provided key instead of prompting
2208 the user (see `notmuch-show-stash-mlarchive-link-alist')."
2210 (notmuch-show-stash-mlarchive-link mla)
2211 (browse-url (current-kill 0 t)))
2213 (defun notmuch-show-stash-git-helper (addresses prefix)
2214 "Escape, trim, quote, and add PREFIX to each address in list of ADDRESSES, and return the result as a single string."
2215 (mapconcat (lambda (x)
2217 ;; escape double-quotes
2218 (replace-regexp-in-string
2220 ;; trim leading and trailing spaces
2221 (replace-regexp-in-string
2222 "\\(^ *\\| *$\\)" ""
2226 (put 'notmuch-show-stash-git-send-email 'notmuch-prefix-doc
2227 "Copy From/To/Cc of current message to kill-ring in a form suitable for pasting to git send-email command line.")
2229 (defun notmuch-show-stash-git-send-email (&optional no-in-reply-to)
2230 "Copy From/To/Cc/Message-Id of current message to kill-ring in a form suitable for pasting to git send-email command line.
2232 If invoked with a prefix argument (or NO-IN-REPLY-TO is non-nil),
2233 omit --in-reply-to=<Message-Id>."
2235 (notmuch-common-do-stash
2236 (mapconcat 'identity
2239 (notmuch-show-stash-git-helper
2240 (message-tokenize-header (notmuch-show-get-from)) "--to=")
2241 (notmuch-show-stash-git-helper
2242 (message-tokenize-header (notmuch-show-get-to)) "--to=")
2243 (notmuch-show-stash-git-helper
2244 (message-tokenize-header (notmuch-show-get-cc)) "--cc=")
2245 (unless no-in-reply-to
2246 (notmuch-show-stash-git-helper
2247 (list (notmuch-show-get-message-id t)) "--in-reply-to="))))
2250 ;; Interactive part functions and their helpers
2252 (defun notmuch-show-generate-part-buffer (msg part)
2253 "Return a temporary buffer containing the specified part's content."
2254 (let ((buf (generate-new-buffer " *notmuch-part*"))
2255 (process-crypto notmuch-show-process-crypto))
2256 (with-current-buffer buf
2257 ;; This is always used in the content of mm handles, which
2258 ;; expect undecoded, binary part content.
2259 (insert (notmuch-get-bodypart-binary msg part process-crypto)))
2262 (defun notmuch-show-current-part-handle ()
2263 "Return an mm-handle for the part containing point.
2265 This creates a temporary buffer for the part's content; the
2266 caller is responsible for killing this buffer as appropriate."
2267 (let* ((msg (notmuch-show-get-message-properties))
2268 (part (notmuch-show-get-part-properties))
2269 (buf (notmuch-show-generate-part-buffer msg part))
2270 (computed-type (plist-get part :computed-type))
2271 (filename (plist-get part :filename))
2272 (disposition (if filename `(attachment (filename . ,filename)))))
2273 (mm-make-handle buf (list computed-type) nil nil disposition)))
2275 (defun notmuch-show-apply-to-current-part-handle (fn)
2276 "Apply FN to an mm-handle for the part containing point.
2278 This ensures that the temporary buffer created for the mm-handle
2279 is destroyed when FN returns."
2280 (let ((handle (notmuch-show-current-part-handle)))
2281 ;; emacs 24.3+ puts stdout/stderr into the calling buffer so we
2282 ;; call it from a temp-buffer, unless
2283 ;; notmuch-show-attachment-debug is non-nil in which case we put
2284 ;; it in " *notmuch-part*".
2286 (if notmuch-show-attachment-debug
2287 (with-current-buffer (generate-new-buffer " *notmuch-part*")
2288 (funcall fn handle))
2290 (funcall fn handle)))
2291 (kill-buffer (mm-handle-buffer handle)))))
2293 (defun notmuch-show-part-button-default (&optional button)
2295 (let ((button (or button (button-at (point)))))
2296 ;; Try to toggle the part, if that fails then call the default
2297 ;; action. The toggle fails if the part has no emacs renderable
2299 (unless (notmuch-show-toggle-part-invisibility button)
2300 (call-interactively notmuch-show-part-button-default-action))))
2302 (defun notmuch-show-save-part ()
2303 "Save the MIME part containing point to a file."
2305 (notmuch-show-apply-to-current-part-handle #'mm-save-part))
2307 (defun notmuch-show-view-part ()
2308 "View the MIME part containing point in an external viewer."
2310 ;; Set mm-inlined-types to nil to force an external viewer
2311 (let ((mm-inlined-types nil))
2312 (notmuch-show-apply-to-current-part-handle #'mm-display-part)))
2314 (defun notmuch-show-interactively-view-part ()
2315 "View the MIME part containing point, prompting for a viewer."
2317 (notmuch-show-apply-to-current-part-handle #'mm-interactively-view-part))
2319 (defun notmuch-show-pipe-part ()
2320 "Pipe the MIME part containing point to an external command."
2322 (notmuch-show-apply-to-current-part-handle #'mm-pipe-part))
2325 (provide 'notmuch-show)