1 ;; notmuch-show.el --- displaying notmuch forests.
3 ;; Copyright © Carl Worth
4 ;; Copyright © David Edmondson
6 ;; This file is part of Notmuch.
8 ;; Notmuch is free software: you can redistribute it and/or modify it
9 ;; under the terms of the GNU General Public License as published by
10 ;; the Free Software Foundation, either version 3 of the License, or
11 ;; (at your option) any later version.
13 ;; Notmuch is distributed in the hope that it will be useful, but
14 ;; WITHOUT ANY WARRANTY; without even the implied warranty of
15 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 ;; General Public License for more details.
18 ;; You should have received a copy of the GNU General Public License
19 ;; along with Notmuch. If not, see <http://www.gnu.org/licenses/>.
21 ;; Authors: Carl Worth <cworth@cworth.org>
22 ;; David Edmondson <dme@dme.org>
24 (eval-when-compile (require 'cl))
32 (require 'notmuch-lib)
33 (require 'notmuch-tag)
34 (require 'notmuch-query)
35 (require 'notmuch-wash)
36 (require 'notmuch-mua)
37 (require 'notmuch-crypto)
38 (require 'notmuch-print)
40 (declare-function notmuch-call-notmuch-process "notmuch" (&rest args))
41 (declare-function notmuch-search-next-thread "notmuch" nil)
42 (declare-function notmuch-search-previous-thread "notmuch" nil)
43 (declare-function notmuch-search-show-thread "notmuch" nil)
44 (declare-function notmuch-foreach-mime-part "notmuch" (function mm-handle))
45 (declare-function notmuch-count-attachments "notmuch" (mm-handle))
46 (declare-function notmuch-save-attachments "notmuch" (mm-handle &optional queryp))
47 (declare-function notmuch-tree "notmuch-tree"
48 (&optional query query-context target buffer-name open-target))
49 (declare-function notmuch-tree-get-message-properties "notmuch-tree" nil)
50 (declare-function notmuch-read-query "notmuch" (prompt))
52 (defcustom notmuch-message-headers '("Subject" "To" "Cc" "Date")
53 "Headers that should be shown in a message, in this order.
55 For an open message, all of these headers will be made visible
56 according to `notmuch-message-headers-visible' or can be toggled
57 with `notmuch-show-toggle-visibility-headers'. For a closed message,
58 only the first header in the list will be visible."
59 :type '(repeat string)
62 (defcustom notmuch-message-headers-visible t
63 "Should the headers be visible by default?
65 If this value is non-nil, then all of the headers defined in
66 `notmuch-message-headers' will be visible by default in the display
67 of each message. Otherwise, these headers will be hidden and
68 `notmuch-show-toggle-visibility-headers' can be used to make them
69 visible for any given message."
73 (defcustom notmuch-show-relative-dates t
74 "Display relative dates in the message summary line."
78 (defvar notmuch-show-markup-headers-hook '(notmuch-show-colour-headers)
79 "A list of functions called to decorate the headers listed in
80 `notmuch-message-headers'.")
82 (defcustom notmuch-show-hook '(notmuch-show-turn-on-visual-line-mode)
83 "Functions called after populating a `notmuch-show' buffer."
85 :options '(notmuch-show-turn-on-visual-line-mode)
87 :group 'notmuch-hooks)
89 (defcustom notmuch-show-insert-text/plain-hook '(notmuch-wash-wrap-long-lines
90 notmuch-wash-tidy-citations
91 notmuch-wash-elide-blank-lines
92 notmuch-wash-excerpt-citations)
93 "Functions used to improve the display of text/plain parts."
95 :options '(notmuch-wash-convert-inline-patch-to-part
96 notmuch-wash-wrap-long-lines
97 notmuch-wash-tidy-citations
98 notmuch-wash-elide-blank-lines
99 notmuch-wash-excerpt-citations)
101 :group 'notmuch-hooks)
103 (defcustom notmuch-show-max-text-part-size 100000
104 "Maximum size of a text part to be shown by default in characters.
106 Set to 0 to show the part regardless of size."
108 :group 'notmuch-show)
110 ;; Mostly useful for debugging.
111 (defcustom notmuch-show-all-multipart/alternative-parts nil
112 "Should all parts of multipart/alternative parts be shown?"
114 :group 'notmuch-show)
116 (defcustom notmuch-show-indent-messages-width 1
117 "Width of message indentation in threads.
119 Messages are shown indented according to their depth in a thread.
120 This variable determines the width of this indentation measured
121 in number of blanks. Defaults to `1', choose `0' to disable
124 :group 'notmuch-show)
126 (defcustom notmuch-show-indent-multipart nil
127 "Should the sub-parts of a multipart/* part be indented?"
128 ;; dme: Not sure which is a good default.
130 :group 'notmuch-show)
132 (defcustom notmuch-show-part-button-default-action 'notmuch-show-save-part
133 "Default part header button action (on ENTER or mouse click)."
135 :type '(choice (const :tag "Save part"
136 notmuch-show-save-part)
137 (const :tag "View part"
138 notmuch-show-view-part)
139 (const :tag "View interactively"
140 notmuch-show-interactively-view-part)))
142 (defcustom notmuch-show-only-matching-messages nil
143 "Only matching messages are shown by default."
145 :group 'notmuch-show)
147 ;; By default, block all external images to prevent privacy leaks and
148 ;; potential attacks.
149 (defcustom notmuch-show-text/html-blocked-images "."
150 "Remote images that have URLs matching this regexp will be blocked."
151 :type '(choice (const nil) regexp)
152 :group 'notmuch-show)
154 (defvar notmuch-show-thread-id nil)
155 (make-variable-buffer-local 'notmuch-show-thread-id)
157 (defvar notmuch-show-parent-buffer nil)
158 (make-variable-buffer-local 'notmuch-show-parent-buffer)
160 (defvar notmuch-show-query-context nil)
161 (make-variable-buffer-local 'notmuch-show-query-context)
163 (defvar notmuch-show-process-crypto nil)
164 (make-variable-buffer-local 'notmuch-show-process-crypto)
166 (defvar notmuch-show-elide-non-matching-messages nil)
167 (make-variable-buffer-local 'notmuch-show-elide-non-matching-messages)
169 (defvar notmuch-show-indent-content t)
170 (make-variable-buffer-local 'notmuch-show-indent-content)
172 (defvar notmuch-show-attachment-debug nil
173 "If t log stdout and stderr from attachment handlers
175 When set to nil (the default) stdout and stderr from attachment
176 handlers is discarded. When set to t the stdout and stderr from
177 each attachment handler is logged in buffers with names beginning
178 \" *notmuch-part*\". This option requires emacs version at least
181 (defcustom notmuch-show-stash-mlarchive-link-alist
182 '(("Gmane" . "http://mid.gmane.org/")
183 ("MARC" . "http://marc.info/?i=")
184 ("Mail Archive, The" . "http://mid.mail-archive.com/")
185 ("LKML" . "http://lkml.kernel.org/r/")
186 ;; FIXME: can these services be searched by `Message-Id' ?
187 ;; ("MarkMail" . "http://markmail.org/")
188 ;; ("Nabble" . "http://nabble.com/")
189 ;; ("opensubscriber" . "http://opensubscriber.com/")
191 "List of Mailing List Archives to use when stashing links.
193 This list is used for generating a Mailing List Archive reference
194 URI with the current message's Message-Id in
195 `notmuch-show-stash-mlarchive-link'.
197 If the cdr of the alist element is not a function, the cdr is
198 expected to contain a URI that is concatenated with the current
199 message's Message-Id to create a ML archive reference URI.
201 If the cdr is a function, the function is called with the
202 Message-Id as the argument, and the function is expected to
203 return the ML archive reference URI."
204 :type '(alist :key-type (string :tag "Name")
207 (function :tag "Function returning the URL")))
208 :group 'notmuch-show)
210 (defcustom notmuch-show-stash-mlarchive-link-default "Gmane"
211 "Default Mailing List Archive to use when stashing links.
213 This is used when `notmuch-show-stash-mlarchive-link' isn't
214 provided with an MLA argument nor `completing-read' input."
218 (list 'const :tag (car mla) :value (car mla)))
219 notmuch-show-stash-mlarchive-link-alist))
220 :group 'notmuch-show)
222 (defcustom notmuch-show-mark-read-tags '("-unread")
223 "List of tag changes to apply to a message when it is marked as read.
225 Tags starting with \"+\" (or not starting with either \"+\" or
226 \"-\") in the list will be added, and tags starting with \"-\"
227 will be removed from the message being marked as read.
229 For example, if you wanted to remove an \"unread\" tag and add a
230 \"read\" tag (which would make little sense), you would set:
231 (\"-unread\" \"+read\")"
232 :type '(repeat string)
233 :group 'notmuch-show)
235 (defcustom notmuch-show-mark-read-function #'notmuch-show-seen-current-message
236 "Function to control which messages are marked read.
238 The function should take two arguments START and END which will
239 be the start and end of the visible portion of the buffer and
240 should mark the appropriate messages read by applying
241 `notmuch-show-mark-read'. This function will be called after
242 every user interaction with notmuch."
244 :group 'notmuch-show)
246 (defmacro with-current-notmuch-show-message (&rest body)
247 "Evaluate body with current buffer set to the text of current message"
249 (let ((id (notmuch-show-get-message-id)))
250 (let ((buf (generate-new-buffer (concat "*notmuch-msg-" id "*"))))
251 (with-current-buffer buf
252 (let ((coding-system-for-read 'no-conversion))
253 (call-process notmuch-command nil t nil "show" "--format=raw" id))
255 (kill-buffer buf)))))
257 (defun notmuch-show-turn-on-visual-line-mode ()
258 "Enable Visual Line mode."
259 (visual-line-mode t))
261 ;; DEPRECATED in Notmuch 0.16 since we now have convenient part
262 ;; commands. We'll keep the command around for a version or two in
263 ;; case people want to bind it themselves.
264 (defun notmuch-show-view-all-mime-parts ()
265 "Use external viewers to view all attachments from the current message."
267 (with-current-notmuch-show-message
268 ;; We override the mm-inline-media-tests to indicate which message
269 ;; parts are already sufficiently handled by the original
270 ;; presentation of the message in notmuch-show mode. These parts
271 ;; will be inserted directly into the temporary buffer of
272 ;; with-current-notmuch-show-message and silently discarded.
274 ;; Any MIME part not explicitly mentioned here will be handled by an
275 ;; external viewer as configured in the various mailcap files.
276 (let ((mm-inline-media-tests '(
277 ("text/.*" ignore identity)
278 ("application/pgp-signature" ignore identity)
279 ("multipart/alternative" ignore identity)
280 ("multipart/mixed" ignore identity)
281 ("multipart/related" ignore identity)
283 (mm-display-parts (mm-dissect-buffer)))))
285 (defun notmuch-show-save-attachments ()
286 "Save all attachments from the current message."
288 (with-current-notmuch-show-message
289 (let ((mm-handle (mm-dissect-buffer)))
290 (notmuch-save-attachments
291 mm-handle (> (notmuch-count-attachments mm-handle) 1))))
294 (defun notmuch-show-with-message-as-text (fn)
295 "Apply FN to a text representation of the current message.
297 FN is called with one argument, the message properties. It should
298 operation on the contents of the current buffer."
300 ;; Remake the header to ensure that all information is available.
301 (let* ((to (notmuch-show-get-to))
302 (cc (notmuch-show-get-cc))
303 (from (notmuch-show-get-from))
304 (subject (notmuch-show-get-subject))
305 (date (notmuch-show-get-date))
306 (tags (notmuch-show-get-tags))
307 (depth (notmuch-show-get-depth))
310 "Subject: " subject "\n"
312 (if (not (string= cc ""))
313 (concat "Cc: " cc "\n")
319 (mapconcat #'identity tags ", ") "\n")
321 (all (buffer-substring (notmuch-show-message-top)
322 (notmuch-show-message-bottom)))
324 (props (notmuch-show-get-message-properties))
325 (indenting notmuch-show-indent-content))
329 (indent-rigidly (point-min) (point-max) (- depth)))
330 ;; Remove the original header.
331 (goto-char (point-min))
332 (re-search-forward "^$" (point-max) nil)
333 (delete-region (point-min) (point))
335 (funcall fn props))))
337 (defun notmuch-show-print-message ()
338 "Print the current message."
340 (notmuch-show-with-message-as-text 'notmuch-print-message))
342 (defun notmuch-show-fontify-header ()
344 ((looking-at "[Tt]o:")
346 ((looking-at "[Bb]?[Cc][Cc]:")
348 ((looking-at "[Ss]ubject:")
349 'message-header-subject)
351 'message-header-other))))
353 (overlay-put (make-overlay (point) (re-search-forward ":"))
354 'face 'message-header-name)
355 (overlay-put (make-overlay (point) (re-search-forward ".*$"))
358 (defun notmuch-show-colour-headers ()
359 "Apply some colouring to the current headers."
360 (goto-char (point-min))
361 (while (looking-at "^[A-Za-z][-A-Za-z0-9]*:")
362 (notmuch-show-fontify-header)
365 (defun notmuch-show-spaces-n (n)
366 "Return a string comprised of `n' spaces."
369 (defun notmuch-show-update-tags (tags)
370 "Update the displayed tags of the current message."
372 (goto-char (notmuch-show-message-top))
373 (if (re-search-forward "(\\([^()]*\\))$" (line-end-position) t)
374 (let ((inhibit-read-only t))
375 (replace-match (concat "("
376 (notmuch-tag-format-tags tags (notmuch-show-get-prop :orig-tags))
379 (defun notmuch-clean-address (address)
380 "Try to clean a single email ADDRESS for display. Return a cons
381 cell of (AUTHOR_EMAIL AUTHOR_NAME). Return (ADDRESS nil) if
384 (let (p-name p-address)
385 ;; It would be convenient to use `mail-header-parse-address',
386 ;; but that expects un-decoded mailbox parts, whereas our
387 ;; mailbox parts are already decoded (and hence may contain
388 ;; UTF-8). Given that notmuch should handle most of the awkward
389 ;; cases, some simple string deconstruction should be sufficient
392 ;; "User <user@dom.ain>" style.
393 ((string-match "\\(.*\\) <\\(.*\\)>" address)
394 (setq p-name (match-string 1 address)
395 p-address (match-string 2 address)))
397 ;; "<user@dom.ain>" style.
398 ((string-match "<\\(.*\\)>" address)
399 (setq p-address (match-string 1 address)))
403 (setq p-address address)))
406 ;; Remove elements of the mailbox part that are not relevant for
407 ;; display, even if they are required during transport:
410 (setq p-name (replace-regexp-in-string "\\\\" "" p-name))
412 ;; Outer single and double quotes, which might be nested.
415 do (setq start-of-loop p-name)
417 when (string-match "^\"\\(.*\\)\"$" p-name)
418 do (setq p-name (match-string 1 p-name))
420 when (string-match "^'\\(.*\\)'$" p-name)
421 do (setq p-name (match-string 1 p-name))
423 until (string= start-of-loop p-name)))
425 ;; If the address is 'foo@bar.com <foo@bar.com>' then show just
427 (when (string= p-name p-address)
430 (cons p-address p-name))
431 (error (cons address nil))))
433 (defun notmuch-show-clean-address (address)
434 "Try to clean a single email ADDRESS for display. Return
435 unchanged ADDRESS if parsing fails."
436 (let* ((clean-address (notmuch-clean-address address))
437 (p-address (car clean-address))
438 (p-name (cdr clean-address)))
439 ;; If no name, return just the address.
442 ;; Otherwise format the name and address together.
443 (concat p-name " <" p-address ">"))))
445 (defun notmuch-show-insert-headerline (headers date tags depth)
446 "Insert a notmuch style headerline based on HEADERS for a
447 message at DEPTH in the current thread."
448 (let ((start (point)))
449 (insert (notmuch-show-spaces-n (* notmuch-show-indent-messages-width depth))
451 (notmuch-show-clean-address (plist-get headers :From)))
455 (notmuch-tag-format-tags tags tags)
457 (overlay-put (make-overlay start (point)) 'face 'notmuch-message-summary-face)))
459 (defun notmuch-show-insert-header (header header-value)
460 "Insert a single header."
461 (insert header ": " (notmuch-sanitize header-value) "\n"))
463 (defun notmuch-show-insert-headers (headers)
464 "Insert the headers of the current message."
465 (let ((start (point)))
466 (mapc (lambda (header)
467 (let* ((header-symbol (intern (concat ":" header)))
468 (header-value (plist-get headers header-symbol)))
469 (if (and header-value
470 (not (string-equal "" header-value)))
471 (notmuch-show-insert-header header header-value))))
472 notmuch-message-headers)
475 (narrow-to-region start (point-max))
476 (run-hooks 'notmuch-show-markup-headers-hook)))))
478 (define-button-type 'notmuch-show-part-button-type
479 'action 'notmuch-show-part-button-default
482 :supertype 'notmuch-button-type)
484 (defun notmuch-show-insert-part-header (nth content-type declared-type &optional name comment)
486 (base-label (concat (when name (concat name ": "))
488 (unless (string-equal declared-type content-type)
489 (concat " (as " content-type ")"))
494 (concat "[ " base-label " ]")
495 :base-label base-label
496 :type 'notmuch-show-part-button-type
497 :notmuch-part-hidden nil))
502 (defun notmuch-show-toggle-part-invisibility (&optional button)
504 (let ((button (or button (button-at (point)))))
506 (let ((overlay (button-get button 'overlay))
507 (lazy-part (button-get button :notmuch-lazy-part)))
508 ;; We have a part to toggle if there is an overlay or if there is a lazy part.
509 ;; If neither is present we cannot toggle the part so we just return nil.
510 (when (or overlay lazy-part)
511 (let* ((show (button-get button :notmuch-part-hidden))
512 (new-start (button-start button))
513 (button-label (button-get button :base-label))
515 (properties (text-properties-at (button-start button)))
516 (inhibit-read-only t))
517 ;; Toggle the button itself.
518 (button-put button :notmuch-part-hidden (not show))
519 (goto-char new-start)
520 (insert "[ " button-label (if show " ]" " (hidden) ]"))
521 (set-text-properties new-start (point) properties)
522 (let ((old-end (button-end button)))
523 (move-overlay button new-start (point))
524 (delete-region (point) old-end))
525 (goto-char (min old-point (1- (button-end button))))
526 ;; Return nil if there is a lazy-part, it is empty, and we are
527 ;; trying to show it. In all other cases return t.
530 (button-put button :notmuch-lazy-part nil)
531 (notmuch-show-lazy-part lazy-part button))
532 ;; else there must be an overlay.
533 (overlay-put overlay 'invisible (not show))
536 ;; Part content ID handling
538 (defvar notmuch-show--cids nil
539 "Alist from raw content ID to (MSG PART).")
540 (make-variable-buffer-local 'notmuch-show--cids)
542 (defun notmuch-show--register-cids (msg part)
543 "Register content-IDs in PART and all of PART's sub-parts."
544 (let ((content-id (plist-get part :content-id)))
546 ;; Note that content-IDs are globally unique, except when they
547 ;; aren't: RFC 2046 section 5.1.4 permits children of a
548 ;; multipart/alternative to have the same content-ID, in which
549 ;; case the MUA is supposed to pick the best one it can render.
550 ;; We simply add the content-ID to the beginning of our alist;
551 ;; so if this happens, we'll take the last (and "best")
552 ;; alternative (even if we can't render it).
553 (push (list content-id msg part) notmuch-show--cids)))
554 ;; Recurse on sub-parts
555 (let ((ctype (notmuch-split-content-type
556 (downcase (plist-get part :content-type)))))
557 (cond ((equal (first ctype) "multipart")
558 (mapc (apply-partially #'notmuch-show--register-cids msg)
559 (plist-get part :content)))
560 ((equal ctype '("message" "rfc822"))
561 (notmuch-show--register-cids
563 (first (plist-get (first (plist-get part :content)) :body)))))))
565 (defun notmuch-show--get-cid-content (cid)
566 "Return a list (CID-content content-type) or nil.
568 This will only find parts from messages that have been inserted
569 into the current buffer. CID must be a raw content ID, without
570 enclosing angle brackets, a cid: prefix, or URL encoding. This
571 will return nil if the CID is unknown or cannot be retrieved."
572 (let ((descriptor (cdr (assoc cid notmuch-show--cids))))
574 (let* ((msg (first descriptor))
575 (part (second descriptor))
576 ;; Request caching for this content, as some messages
577 ;; reference the same cid: part many times (hundreds!).
578 (content (notmuch-get-bodypart-binary
579 msg part notmuch-show-process-crypto 'cache))
580 (content-type (plist-get part :content-type)))
581 (list content content-type)))))
583 (defun notmuch-show-setup-w3m ()
584 "Instruct w3m how to retrieve content from a \"related\" part of a message."
586 (if (boundp 'w3m-cid-retrieve-function-alist)
587 (unless (assq 'notmuch-show-mode w3m-cid-retrieve-function-alist)
588 (push (cons 'notmuch-show-mode #'notmuch-show--cid-w3m-retrieve)
589 w3m-cid-retrieve-function-alist)))
590 (setq mm-inline-text-html-with-images t))
592 (defvar w3m-current-buffer) ;; From `w3m.el'.
593 (defun notmuch-show--cid-w3m-retrieve (url &rest args)
594 ;; url includes the cid: prefix and is URL encoded (see RFC 2392).
595 (let* ((cid (url-unhex-string (substring url 4)))
597 (with-current-buffer w3m-current-buffer
598 (notmuch-show--get-cid-content cid))))
599 (when content-and-type
600 (insert (first content-and-type))
601 (second content-and-type))))
603 ;; MIME part renderers
605 (defun notmuch-show-multipart/*-to-list (part)
606 (mapcar (lambda (inner-part) (plist-get inner-part :content-type))
607 (plist-get part :content)))
609 (defun notmuch-show-insert-part-multipart/alternative (msg part content-type nth depth button)
610 (let ((chosen-type (car (notmuch-multipart/alternative-choose (notmuch-show-multipart/*-to-list part))))
611 (inner-parts (plist-get part :content))
613 ;; This inserts all parts of the chosen type rather than just one,
614 ;; but it's not clear that this is the wrong thing to do - which
615 ;; should be chosen if there are more than one that match?
616 (mapc (lambda (inner-part)
617 (let* ((inner-type (plist-get inner-part :content-type))
618 (hide (not (or notmuch-show-all-multipart/alternative-parts
619 (string= chosen-type inner-type)))))
620 (notmuch-show-insert-bodypart msg inner-part depth hide)))
623 (when notmuch-show-indent-multipart
624 (indent-rigidly start (point) 1)))
627 (defun notmuch-show-insert-part-multipart/related (msg part content-type nth depth button)
628 (let ((inner-parts (plist-get part :content))
631 ;; Render the primary part. FIXME: Support RFC 2387 Start header.
632 (notmuch-show-insert-bodypart msg (car inner-parts) depth)
633 ;; Add hidden buttons for the rest
634 (mapc (lambda (inner-part)
635 (notmuch-show-insert-bodypart msg inner-part depth t))
638 (when notmuch-show-indent-multipart
639 (indent-rigidly start (point) 1)))
642 (defun notmuch-show-insert-part-multipart/signed (msg part content-type nth depth button)
644 (button-put button 'face 'notmuch-crypto-part-header))
645 ;; Add signature status button if sigstatus provided.
646 (if (plist-member part :sigstatus)
647 (let* ((from (notmuch-show-get-header :From msg))
648 (sigstatus (car (plist-get part :sigstatus))))
649 (notmuch-crypto-insert-sigstatus-button sigstatus from))
650 ;; If we're not adding the signature status, tell the user how
653 (button-put button 'help-echo "Set notmuch-crypto-process-mime to process cryptographic MIME parts.")))
655 (let ((inner-parts (plist-get part :content))
657 ;; Show all of the parts.
658 (mapc (lambda (inner-part)
659 (notmuch-show-insert-bodypart msg inner-part depth))
662 (when notmuch-show-indent-multipart
663 (indent-rigidly start (point) 1)))
666 (defun notmuch-show-insert-part-multipart/encrypted (msg part content-type nth depth button)
668 (button-put button 'face 'notmuch-crypto-part-header))
669 ;; Add encryption status button if encryption status is specified.
670 (if (plist-member part :encstatus)
671 (let ((encstatus (car (plist-get part :encstatus))))
672 (notmuch-crypto-insert-encstatus-button encstatus)
673 ;; Add signature status button if signature status is
675 (if (plist-member part :sigstatus)
676 (let* ((from (notmuch-show-get-header :From msg))
677 (sigstatus (car (plist-get part :sigstatus))))
678 (notmuch-crypto-insert-sigstatus-button sigstatus from))))
679 ;; If we're not adding the encryption status, tell the user how
681 (button-put button 'help-echo "Set notmuch-crypto-process-mime to process cryptographic MIME parts."))
683 (let ((inner-parts (plist-get part :content))
685 ;; Show all of the parts.
686 (mapc (lambda (inner-part)
687 (notmuch-show-insert-bodypart msg inner-part depth))
690 (when notmuch-show-indent-multipart
691 (indent-rigidly start (point) 1)))
694 (defun notmuch-show-insert-part-multipart/* (msg part content-type nth depth button)
695 (let ((inner-parts (plist-get part :content))
697 ;; Show all of the parts.
698 (mapc (lambda (inner-part)
699 (notmuch-show-insert-bodypart msg inner-part depth))
702 (when notmuch-show-indent-multipart
703 (indent-rigidly start (point) 1)))
706 (defun notmuch-show-insert-part-message/rfc822 (msg part content-type nth depth button)
707 (let* ((message (car (plist-get part :content)))
708 (body (car (plist-get message :body)))
711 ;; Override `notmuch-message-headers' to force `From' to be
713 (let ((notmuch-message-headers '("From" "Subject" "To" "Cc" "Date")))
714 (notmuch-show-insert-headers (plist-get message :headers)))
716 ;; Blank line after headers to be compatible with the normal
721 (notmuch-show-insert-bodypart msg body depth)
723 (when notmuch-show-indent-multipart
724 (indent-rigidly start (point) 1)))
727 (defun notmuch-show-insert-part-text/plain (msg part content-type nth depth button)
728 ;; For backward compatibility we want to apply the text/plain hook
729 ;; to the whole of the part including the part button if there is
731 (let ((start (if button
732 (button-start button)
734 (insert (notmuch-get-bodypart-text msg part notmuch-show-process-crypto))
737 (narrow-to-region start (point-max))
738 (run-hook-with-args 'notmuch-show-insert-text/plain-hook msg depth))))
741 (defun notmuch-show-insert-part-text/calendar (msg part content-type nth depth button)
742 (insert (with-temp-buffer
743 (insert (notmuch-get-bodypart-text msg part notmuch-show-process-crypto))
744 ;; notmuch-get-bodypart-text does no newline conversion.
745 ;; Replace CRLF with LF before icalendar can use it.
746 (goto-char (point-min))
747 (while (re-search-forward "\r\n" nil t)
748 (replace-match "\n" nil nil))
749 (let ((file (make-temp-file "notmuch-ical"))
753 (unless (icalendar-import-buffer file t)
754 (error "Icalendar import error. See *icalendar-errors* for more information"))
755 (set-buffer (get-file-buffer file))
756 (setq result (buffer-substring (point-min) (point-max)))
757 (set-buffer-modified-p nil)
758 (kill-buffer (current-buffer)))
763 ;; For backwards compatibility.
764 (defun notmuch-show-insert-part-text/x-vcalendar (msg part content-type nth depth button)
765 (notmuch-show-insert-part-text/calendar msg part content-type nth depth button))
767 (defun notmuch-show-get-mime-type-of-application/octet-stream (part)
768 ;; If we can deduce a MIME type from the filename of the attachment,
770 (if (plist-get part :filename)
771 (let ((extension (file-name-extension (plist-get part :filename)))
775 (mailcap-parse-mimetypes)
776 (setq mime-type (mailcap-extension-to-mime extension))
778 (not (string-equal mime-type "application/octet-stream")))
783 (defun notmuch-show-insert-part-text/html (msg part content-type nth depth button)
784 (if (eq mm-text-html-renderer 'shr)
785 ;; It's easier to drive shr ourselves than to work around the
786 ;; goofy things `mm-shr' does (like irreversibly taking over
787 ;; content ID handling).
789 ;; FIXME: If we block an image, offer a button to load external
791 (let ((shr-blocked-images notmuch-show-text/html-blocked-images))
792 (notmuch-show--insert-part-text/html-shr msg part))
793 ;; Otherwise, let message-mode do the heavy lifting
795 ;; w3m sets up a keymap which "leaks" outside the invisible region
796 ;; and causes strange effects in notmuch. We set
797 ;; mm-inline-text-html-with-w3m-keymap to nil to tell w3m not to
798 ;; set a keymap (so the normal notmuch-show-mode-map remains).
799 (let ((mm-inline-text-html-with-w3m-keymap nil)
800 ;; FIXME: If we block an image, offer a button to load external
802 (gnus-blocked-images notmuch-show-text/html-blocked-images))
803 (notmuch-show-insert-part-*/* msg part content-type nth depth button))))
805 ;; These functions are used by notmuch-show--insert-part-text/html-shr
806 (declare-function libxml-parse-html-region "xml.c")
807 (declare-function shr-insert-document "shr")
809 (defun notmuch-show--insert-part-text/html-shr (msg part)
810 ;; Make sure shr is loaded before we start let-binding its globals
812 (let ((dom (let ((process-crypto notmuch-show-process-crypto))
814 (insert (notmuch-get-bodypart-text msg part process-crypto))
815 (libxml-parse-html-region (point-min) (point-max)))))
816 (shr-content-function
818 ;; shr strips the "cid:" part of URL, but doesn't
819 ;; URL-decode it (see RFC 2392).
820 (let ((cid (url-unhex-string url)))
821 (first (notmuch-show--get-cid-content cid))))))
822 (shr-insert-document dom)
825 (defun notmuch-show-insert-part-*/* (msg part content-type nth depth button)
826 ;; This handler _must_ succeed - it is the handler of last resort.
827 (notmuch-mm-display-part-inline msg part content-type notmuch-show-process-crypto)
830 ;; Functions for determining how to handle MIME parts.
832 (defun notmuch-show-handlers-for (content-type)
833 "Return a list of content handlers for a part of type CONTENT-TYPE."
838 ;; Reverse order of prefrence.
839 (list (intern (concat "notmuch-show-insert-part-*/*"))
841 "notmuch-show-insert-part-"
842 (car (notmuch-split-content-type content-type))
844 (intern (concat "notmuch-show-insert-part-" content-type))))
849 (defun notmuch-show-insert-bodypart-internal (msg part content-type nth depth button)
850 (let ((handlers (notmuch-show-handlers-for content-type)))
851 ;; Run the content handlers until one of them returns a non-nil
854 (not (condition-case err
855 (funcall (car handlers) msg part content-type nth depth button)
856 ;; Specifying `debug' here lets the debugger
857 ;; run if `debug-on-error' is non-nil.
860 (insert "!!! Bodypart insert error: ")
861 (insert (error-message-string err))
862 (insert " !!!\n") nil)))))
863 (setq handlers (cdr handlers))))
866 (defun notmuch-show-create-part-overlays (button beg end)
867 "Add an overlay to the part between BEG and END"
869 ;; If there is no button (i.e., the part is text/plain and the first
870 ;; part) or if the part has no content then we don't make the part
872 (when (and button (/= beg end))
873 (button-put button 'overlay (make-overlay beg end))
874 ;; Return true if we created an overlay.
877 (defun notmuch-show-record-part-information (part beg end)
878 "Store PART as a text property from BEG to END"
880 ;; Record part information. Since we already inserted subparts,
881 ;; don't override existing :notmuch-part properties.
882 (notmuch-map-text-property beg end :notmuch-part
883 (lambda (v) (or v part)))
884 ;; Make :notmuch-part front sticky and rear non-sticky so it stays
885 ;; applied to the beginning of each line when we indent the
886 ;; message. Since we're operating on arbitrary renderer output,
887 ;; watch out for sticky specs of t, which means all properties are
888 ;; front-sticky/rear-nonsticky.
889 (notmuch-map-text-property beg end 'front-sticky
890 (lambda (v) (if (listp v)
891 (pushnew :notmuch-part v)
893 (notmuch-map-text-property beg end 'rear-nonsticky
894 (lambda (v) (if (listp v)
895 (pushnew :notmuch-part v)
898 (defun notmuch-show-lazy-part (part-args button)
899 ;; Insert the lazy part after the button for the part. We would just
900 ;; move to the start of the new line following the button and insert
901 ;; the part but that point might have text properties (eg colours
902 ;; from a message header etc) so instead we start from the last
903 ;; character of the button by adding a newline and finish by
904 ;; removing the extra newline from the end of the part.
906 (goto-char (button-end button))
908 (let* ((inhibit-read-only t)
909 ;; We need to use markers for the start and end of the part
910 ;; because the part insertion functions do not guarantee
911 ;; to leave point at the end of the part.
912 (part-beg (copy-marker (point) nil))
913 (part-end (copy-marker (point) t))
914 ;; We have to save the depth as we can't find the depth
916 (depth (notmuch-show-get-depth)))
918 (narrow-to-region part-beg part-end)
919 (delete-region part-beg part-end)
920 (apply #'notmuch-show-insert-bodypart-internal part-args)
921 (indent-rigidly part-beg part-end depth))
924 (notmuch-show-record-part-information (second part-args)
925 (button-start button)
927 ;; Create the overlay. If the lazy-part turned out to be empty/not
928 ;; showable this returns nil.
929 (notmuch-show-create-part-overlays button part-beg part-end))))
931 (defun notmuch-show-mime-type (part)
932 "Return the correct mime-type to use for PART."
933 (let ((content-type (downcase (plist-get part :content-type))))
934 (or (and (string= content-type "application/octet-stream")
935 (notmuch-show-get-mime-type-of-application/octet-stream part))
936 (and (string= content-type "inline patch")
940 ;; The following variable can be overridden by let bindings.
941 (defvar notmuch-show-insert-header-p-function 'notmuch-show-insert-header-p
942 "Specify which function decides which part headers get inserted.
944 The function should take two parameters, PART and HIDE, and
945 should return non-NIL if a header button should be inserted for
948 (defun notmuch-show-insert-header-p (part hide)
949 ;; Show all part buttons except for the first part if it is text/plain.
950 (let ((mime-type (notmuch-show-mime-type part)))
951 (not (and (string= mime-type "text/plain")
952 (<= (plist-get part :id) 1)))))
954 (defun notmuch-show-reply-insert-header-p-never (part hide)
957 (defun notmuch-show-insert-bodypart (msg part depth &optional hide)
958 "Insert the body part PART at depth DEPTH in the current thread.
960 HIDE determines whether to show or hide the part and the button
961 as follows: If HIDE is nil, show the part and the button. If HIDE
962 is t, hide the part initially and show the button."
964 (let* ((content-type (downcase (plist-get part :content-type)))
965 (mime-type (notmuch-show-mime-type part))
966 (nth (plist-get part :id))
967 (long (and (notmuch-match-content-type mime-type "text/*")
968 (> notmuch-show-max-text-part-size 0)
969 (> (length (plist-get part :content)) notmuch-show-max-text-part-size)))
971 ;; This default header-p function omits the part button for
972 ;; the first (or only) part if this is text/plain.
973 (button (when (funcall notmuch-show-insert-header-p-function part hide)
974 (notmuch-show-insert-part-header nth mime-type content-type (plist-get part :filename))))
975 ;; Hide the part initially if HIDE is t, or if it is too long
976 ;; and we have a button to allow toggling.
977 (show-part (not (or (equal hide t)
979 (content-beg (point)))
981 ;; Store the computed mime-type for later use (e.g. by attachment handlers).
982 (plist-put part :computed-type mime-type)
985 (notmuch-show-insert-bodypart-internal msg part mime-type nth depth button)
987 (button-put button :notmuch-lazy-part
988 (list msg part mime-type nth depth button))))
990 ;; Some of the body part handlers leave point somewhere up in the
991 ;; part, so we make sure that we're down at the end.
992 (goto-char (point-max))
993 ;; Ensure that the part ends with a carriage return.
996 ;; We do not create the overlay for hidden (lazy) parts until
997 ;; they are inserted.
999 (notmuch-show-create-part-overlays button content-beg (point))
1001 (notmuch-show-toggle-part-invisibility button)))
1002 (notmuch-show-record-part-information part beg (point))))
1004 (defun notmuch-show-insert-body (msg body depth)
1005 "Insert the body BODY at depth DEPTH in the current thread."
1007 ;; Register all content IDs for this message. According to RFC
1008 ;; 2392, content IDs are *global*, but it's okay if an MUA treats
1009 ;; them as only global within a message.
1010 (notmuch-show--register-cids msg (first body))
1012 (mapc (lambda (part) (notmuch-show-insert-bodypart msg part depth)) body))
1014 (defun notmuch-show-make-symbol (type)
1015 (make-symbol (concat "notmuch-show-" type)))
1017 (defun notmuch-show-strip-re (string)
1018 (replace-regexp-in-string "^\\([Rr]e: *\\)+" "" string))
1020 (defvar notmuch-show-previous-subject "")
1021 (make-variable-buffer-local 'notmuch-show-previous-subject)
1023 (defun notmuch-show-insert-msg (msg depth)
1024 "Insert the message MSG at depth DEPTH in the current thread."
1025 (let* ((headers (plist-get msg :headers))
1026 ;; Indentation causes the buffer offset of the start/end
1027 ;; points to move, so we must use markers.
1028 message-start message-end
1029 content-start content-end
1030 headers-start headers-end
1031 (bare-subject (notmuch-show-strip-re (plist-get headers :Subject))))
1033 (setq message-start (point-marker))
1035 (notmuch-show-insert-headerline headers
1036 (or (if notmuch-show-relative-dates
1037 (plist-get msg :date_relative)
1039 (plist-get headers :Date))
1040 (plist-get msg :tags) depth)
1042 (setq content-start (point-marker))
1044 ;; Set `headers-start' to point after the 'Subject:' header to be
1045 ;; compatible with the existing implementation. This just sets it
1046 ;; to after the first header.
1047 (notmuch-show-insert-headers headers)
1049 (goto-char content-start)
1050 ;; If the subject of this message is the same as that of the
1051 ;; previous message, don't display it when this message is
1053 (when (not (string= notmuch-show-previous-subject
1056 (setq headers-start (point-marker)))
1057 (setq headers-end (point-marker))
1059 (setq notmuch-show-previous-subject bare-subject)
1061 ;; A blank line between the headers and the body.
1063 (notmuch-show-insert-body msg (plist-get msg :body)
1064 (if notmuch-show-indent-content depth 0))
1065 ;; Ensure that the body ends with a newline.
1068 (setq content-end (point-marker))
1070 ;; Indent according to the depth in the thread.
1071 (if notmuch-show-indent-content
1072 (indent-rigidly content-start content-end (* notmuch-show-indent-messages-width depth)))
1074 (setq message-end (point-max-marker))
1076 ;; Save the extents of this message over the whole text of the
1078 (put-text-property message-start message-end :notmuch-message-extent (cons message-start message-end))
1080 ;; Create overlays used to control visibility
1081 (plist-put msg :headers-overlay (make-overlay headers-start headers-end))
1082 (plist-put msg :message-overlay (make-overlay headers-start content-end))
1084 (plist-put msg :depth depth)
1086 ;; Save the properties for this message. Currently this saves the
1087 ;; entire message (augmented it with other stuff), which seems
1088 ;; like overkill. We might save a reduced subset (for example, not
1090 (notmuch-show-set-message-properties msg)
1092 ;; Set header visibility.
1093 (notmuch-show-headers-visible msg notmuch-message-headers-visible)
1095 ;; Message visibility depends on whether it matched the search
1097 (notmuch-show-message-visible msg (and (plist-get msg :match)
1098 (not (plist-get msg :excluded))))))
1100 (defun notmuch-show-toggle-process-crypto ()
1101 "Toggle the processing of cryptographic MIME parts."
1103 (setq notmuch-show-process-crypto (not notmuch-show-process-crypto))
1104 (message (if notmuch-show-process-crypto
1105 "Processing cryptographic MIME parts."
1106 "Not processing cryptographic MIME parts."))
1107 (notmuch-show-refresh-view))
1109 (defun notmuch-show-toggle-elide-non-matching ()
1110 "Toggle the display of non-matching messages."
1112 (setq notmuch-show-elide-non-matching-messages (not notmuch-show-elide-non-matching-messages))
1113 (message (if notmuch-show-elide-non-matching-messages
1114 "Showing matching messages only."
1115 "Showing all messages."))
1116 (notmuch-show-refresh-view))
1118 (defun notmuch-show-toggle-thread-indentation ()
1119 "Toggle the indentation of threads."
1121 (setq notmuch-show-indent-content (not notmuch-show-indent-content))
1122 (message (if notmuch-show-indent-content
1123 "Content is indented."
1124 "Content is not indented."))
1125 (notmuch-show-refresh-view))
1127 (defun notmuch-show-insert-tree (tree depth)
1128 "Insert the message tree TREE at depth DEPTH in the current thread."
1129 (let ((msg (car tree))
1130 (replies (cadr tree)))
1131 ;; We test whether there is a message or just some replies.
1133 (notmuch-show-insert-msg msg depth))
1134 (notmuch-show-insert-thread replies (1+ depth))))
1136 (defun notmuch-show-insert-thread (thread depth)
1137 "Insert the thread THREAD at depth DEPTH in the current forest."
1138 (mapc (lambda (tree) (notmuch-show-insert-tree tree depth)) thread))
1140 (defun notmuch-show-insert-forest (forest)
1141 "Insert the forest of threads FOREST."
1142 (mapc (lambda (thread) (notmuch-show-insert-thread thread 0)) forest))
1144 (defvar notmuch-id-regexp
1146 ;; Match the id: prefix only if it begins a word (to disallow, for
1147 ;; example, matching cid:).
1149 ;; If the term starts with a ", then parse Xapian's quoted boolean
1150 ;; term syntax, which allows for anything as long as embedded
1151 ;; double quotes escaped by doubling them. We also disallow
1152 ;; newlines (which Xapian allows) to prevent runaway terms.
1153 "\"\\([^\"\n]\\|\"\"\\)*\""
1154 ;; Otherwise, parse Xapian's unquoted syntax, which goes up to the
1155 ;; next space or ). We disallow [.,;] as the last character
1156 ;; because these are probably part of the surrounding text, and not
1157 ;; part of the id. This doesn't match single character ids; meh.
1158 "\\|[^\"[:space:])][^[:space:])]*[^])[:space:].,:;?!]"
1160 "The regexp used to match id: links in messages.")
1162 (defvar notmuch-mid-regexp
1163 ;; goto-address-url-regexp matched cid: links, which have the same
1164 ;; grammar as the message ID part of a mid: link. Construct the
1165 ;; regexp using the same technique as goto-address-url-regexp.
1166 (concat "\\<mid:\\(" thing-at-point-url-path-regexp "\\)")
1167 "The regexp used to match mid: links in messages.
1171 (defun notmuch-show-buttonise-links (start end)
1172 "Buttonise URLs and mail addresses between START and END.
1174 This also turns id:\"<message id>\"-parts and mid: links into
1175 buttons for a corresponding notmuch search."
1176 (goto-address-fontify-region start end)
1180 (while (re-search-forward notmuch-id-regexp end t)
1181 (push (list (match-beginning 0) (match-end 0)
1182 (match-string-no-properties 0)) links))
1184 (while (re-search-forward notmuch-mid-regexp end t)
1185 (let* ((mid-cid (match-string-no-properties 1))
1186 (mid (save-match-data
1187 (string-match "^[^/]*" mid-cid)
1188 (url-unhex-string (match-string 0 mid-cid)))))
1189 (push (list (match-beginning 0) (match-end 0)
1190 (notmuch-id-to-query mid)) links)))
1191 (dolist (link links)
1192 ;; Remove the overlay created by goto-address-mode
1193 (remove-overlays (first link) (second link) 'goto-address t)
1194 (make-text-button (first link) (second link)
1195 :type 'notmuch-button-type
1196 'action `(lambda (arg)
1197 (notmuch-show ,(third link) current-prefix-arg))
1199 'help-echo "Mouse-1, RET: search for this message"
1200 'face goto-address-mail-face)))))
1203 (defun notmuch-show (thread-id &optional elide-toggle parent-buffer query-context buffer-name)
1204 "Run \"notmuch show\" with the given thread ID and display results.
1206 ELIDE-TOGGLE, if non-nil, inverts the default elide behavior.
1208 The optional PARENT-BUFFER is the notmuch-search buffer from
1209 which this notmuch-show command was executed, (so that the
1210 next thread from that buffer can be show when done with this
1213 The optional QUERY-CONTEXT is a notmuch search term. Only
1214 messages from the thread matching this search term are shown if
1217 The optional BUFFER-NAME provides the name of the buffer in
1218 which the message thread is shown. If it is nil (which occurs
1219 when the command is called interactively) the argument to the
1222 Returns the buffer containing the messages, or NIL if no messages
1224 (interactive "sNotmuch show: \nP")
1225 (let ((buffer-name (generate-new-buffer-name
1227 (concat "*notmuch-" thread-id "*")))))
1228 (switch-to-buffer (get-buffer-create buffer-name))
1229 ;; No need to track undo information for this buffer.
1230 (setq buffer-undo-list t)
1234 ;; Set various buffer local variables to their appropriate initial
1235 ;; state. Do this after enabling `notmuch-show-mode' so that they
1236 ;; aren't wiped out.
1237 (setq notmuch-show-thread-id thread-id
1238 notmuch-show-parent-buffer parent-buffer
1239 notmuch-show-query-context query-context
1241 notmuch-show-process-crypto notmuch-crypto-process-mime
1242 ;; If `elide-toggle', invert the default value.
1243 notmuch-show-elide-non-matching-messages
1245 (not notmuch-show-only-matching-messages)
1246 notmuch-show-only-matching-messages))
1248 (add-hook 'post-command-hook #'notmuch-show-command-hook nil t)
1249 (jit-lock-register #'notmuch-show-buttonise-links)
1251 (notmuch-tag-clear-cache)
1253 (let ((inhibit-read-only t))
1254 (if (notmuch-show--build-buffer)
1255 ;; Messages were inserted into the buffer.
1258 ;; No messages were inserted - presumably none matched the
1260 (kill-buffer (current-buffer))
1262 (message "No messages matched the query!")
1265 (defun notmuch-show--build-buffer (&optional state)
1266 "Display messages matching the current buffer context.
1268 Apply the previously saved STATE if supplied, otherwise show the
1269 first relevant message.
1271 If no messages match the query return NIL."
1272 (let* ((basic-args (list notmuch-show-thread-id))
1273 (args (if notmuch-show-query-context
1274 (append (list "\'") basic-args
1275 (list "and (" notmuch-show-query-context ")\'"))
1276 (append (list "\'") basic-args (list "\'"))))
1277 (cli-args (cons "--exclude=false"
1278 (when notmuch-show-elide-non-matching-messages
1279 (list "--entire-thread=false"))))
1281 (forest (or (notmuch-query-get-threads (append cli-args args))
1282 ;; If a query context reduced the number of
1283 ;; results to zero, try again without it.
1284 (and notmuch-show-query-context
1285 (notmuch-query-get-threads (append cli-args basic-args)))))
1287 ;; Must be reset every time we are going to start inserting
1288 ;; messages into the buffer.
1289 (notmuch-show-previous-subject ""))
1292 (notmuch-show-insert-forest forest)
1294 ;; Store the original tags for each message so that we can
1297 (lambda () (notmuch-show-set-prop :orig-tags (notmuch-show-get-tags))))
1299 ;; Set the header line to the subject of the first message.
1300 (setq header-line-format
1301 (replace-regexp-in-string "%" "%%"
1303 (notmuch-show-strip-re
1304 (notmuch-show-get-subject)))))
1306 (run-hooks 'notmuch-show-hook)
1309 (notmuch-show-apply-state state)
1310 ;; With no state to apply, just go to the first message.
1311 (notmuch-show-goto-first-wanted-message)))
1313 ;; Report back to the caller whether any messages matched.
1316 (defun notmuch-show-capture-state ()
1317 "Capture the state of the current buffer.
1320 - the list of open messages,
1321 - the current message."
1322 (list (notmuch-show-get-message-id) (notmuch-show-get-message-ids-for-open-messages)))
1324 (defun notmuch-show-get-query ()
1325 "Return the current query in this show buffer"
1326 (if notmuch-show-query-context
1327 (concat notmuch-show-thread-id
1329 notmuch-show-query-context
1331 notmuch-show-thread-id))
1333 (defun notmuch-show-goto-message (msg-id)
1334 "Go to message with msg-id."
1335 (goto-char (point-min))
1336 (unless (loop if (string= msg-id (notmuch-show-get-message-id))
1338 until (not (notmuch-show-goto-message-next)))
1339 (goto-char (point-min))
1340 (message "Message-id not found."))
1341 (notmuch-show-message-adjust))
1343 (defun notmuch-show-apply-state (state)
1344 "Apply STATE to the current buffer.
1347 - opening the messages previously opened,
1348 - closing all other messages,
1349 - moving to the correct current message."
1350 (let ((current (car state))
1351 (open (cadr state)))
1353 ;; Open those that were open.
1354 (goto-char (point-min))
1355 (loop do (notmuch-show-message-visible (notmuch-show-get-message-properties)
1356 (member (notmuch-show-get-message-id) open))
1357 until (not (notmuch-show-goto-message-next)))
1359 ;; Go to the previously open message.
1360 (notmuch-show-goto-message current)))
1362 (defun notmuch-show-refresh-view (&optional reset-state)
1363 "Refresh the current view.
1365 Refreshes the current view, observing changes in display
1366 preferences. If invoked with a prefix argument (or RESET-STATE is
1367 non-nil) then the state of the buffer (open/closed messages) is
1368 reset based on the original query."
1370 (let ((inhibit-read-only t)
1371 (state (unless reset-state
1372 (notmuch-show-capture-state))))
1373 ;; `erase-buffer' does not seem to remove overlays, which can lead
1374 ;; to weird effects such as remaining images, so remove them
1379 (unless (notmuch-show--build-buffer state)
1380 ;; No messages were inserted.
1381 (kill-buffer (current-buffer))
1383 (message "Refreshing the buffer resulted in no messages!"))))
1385 (defvar notmuch-show-stash-map
1386 (let ((map (make-sparse-keymap)))
1387 (define-key map "c" 'notmuch-show-stash-cc)
1388 (define-key map "d" 'notmuch-show-stash-date)
1389 (define-key map "F" 'notmuch-show-stash-filename)
1390 (define-key map "f" 'notmuch-show-stash-from)
1391 (define-key map "i" 'notmuch-show-stash-message-id)
1392 (define-key map "I" 'notmuch-show-stash-message-id-stripped)
1393 (define-key map "s" 'notmuch-show-stash-subject)
1394 (define-key map "T" 'notmuch-show-stash-tags)
1395 (define-key map "t" 'notmuch-show-stash-to)
1396 (define-key map "l" 'notmuch-show-stash-mlarchive-link)
1397 (define-key map "L" 'notmuch-show-stash-mlarchive-link-and-go)
1398 (define-key map "G" 'notmuch-show-stash-git-send-email)
1399 (define-key map "?" 'notmuch-subkeymap-help)
1401 "Submap for stash commands")
1402 (fset 'notmuch-show-stash-map notmuch-show-stash-map)
1404 (defvar notmuch-show-part-map
1405 (let ((map (make-sparse-keymap)))
1406 (define-key map "s" 'notmuch-show-save-part)
1407 (define-key map "v" 'notmuch-show-view-part)
1408 (define-key map "o" 'notmuch-show-interactively-view-part)
1409 (define-key map "|" 'notmuch-show-pipe-part)
1410 (define-key map "?" 'notmuch-subkeymap-help)
1412 "Submap for part commands")
1413 (fset 'notmuch-show-part-map notmuch-show-part-map)
1415 (defvar notmuch-show-mode-map
1416 (let ((map (make-sparse-keymap)))
1417 (set-keymap-parent map notmuch-common-keymap)
1418 (define-key map "Z" 'notmuch-tree-from-show-current-query)
1419 (define-key map (kbd "<C-tab>") 'widget-backward)
1420 (define-key map (kbd "M-TAB") 'notmuch-show-previous-button)
1421 (define-key map (kbd "<backtab>") 'notmuch-show-previous-button)
1422 (define-key map (kbd "TAB") 'notmuch-show-next-button)
1423 (define-key map "f" 'notmuch-show-forward-message)
1424 (define-key map "l" 'notmuch-show-filter-thread)
1425 (define-key map "r" 'notmuch-show-reply-sender)
1426 (define-key map "R" 'notmuch-show-reply)
1427 (define-key map "|" 'notmuch-show-pipe-message)
1428 (define-key map "w" 'notmuch-show-save-attachments)
1429 (define-key map "V" 'notmuch-show-view-raw-message)
1430 (define-key map "c" 'notmuch-show-stash-map)
1431 (define-key map "h" 'notmuch-show-toggle-visibility-headers)
1432 (define-key map "*" 'notmuch-show-tag-all)
1433 (define-key map "-" 'notmuch-show-remove-tag)
1434 (define-key map "+" 'notmuch-show-add-tag)
1435 (define-key map "X" 'notmuch-show-archive-thread-then-exit)
1436 (define-key map "x" 'notmuch-show-archive-message-then-next-or-exit)
1437 (define-key map "A" 'notmuch-show-archive-thread-then-next)
1438 (define-key map "a" 'notmuch-show-archive-message-then-next-or-next-thread)
1439 (define-key map "N" 'notmuch-show-next-message)
1440 (define-key map "P" 'notmuch-show-previous-message)
1441 (define-key map "n" 'notmuch-show-next-open-message)
1442 (define-key map "p" 'notmuch-show-previous-open-message)
1443 (define-key map (kbd "M-n") 'notmuch-show-next-thread-show)
1444 (define-key map (kbd "M-p") 'notmuch-show-previous-thread-show)
1445 (define-key map (kbd "DEL") 'notmuch-show-rewind)
1446 (define-key map " " 'notmuch-show-advance-and-archive)
1447 (define-key map (kbd "M-RET") 'notmuch-show-open-or-close-all)
1448 (define-key map (kbd "RET") 'notmuch-show-toggle-message)
1449 (define-key map "#" 'notmuch-show-print-message)
1450 (define-key map "!" 'notmuch-show-toggle-elide-non-matching)
1451 (define-key map "$" 'notmuch-show-toggle-process-crypto)
1452 (define-key map "<" 'notmuch-show-toggle-thread-indentation)
1453 (define-key map "t" 'toggle-truncate-lines)
1454 (define-key map "." 'notmuch-show-part-map)
1456 "Keymap for \"notmuch show\" buffers.")
1457 (fset 'notmuch-show-mode-map notmuch-show-mode-map)
1459 (defun notmuch-show-mode ()
1460 "Major mode for viewing a thread with notmuch.
1462 This buffer contains the results of the \"notmuch show\" command
1463 for displaying a single thread of email from your email archives.
1465 By default, various components of email messages, (citations,
1466 signatures, already-read messages), are hidden. You can make
1467 these parts visible by clicking with the mouse button or by
1468 pressing RET after positioning the cursor on a hidden part, (for
1469 which \\[notmuch-show-next-button] and \\[notmuch-show-previous-button] are helpful).
1471 Reading the thread sequentially is well-supported by pressing
1472 \\[notmuch-show-advance-and-archive]. This will scroll the current message (if necessary), advance
1473 to the next message, or advance to the next thread (if already on
1474 the last message of a thread).
1476 Other commands are available to read or manipulate the thread
1477 more selectively, (such as '\\[notmuch-show-next-message]' and '\\[notmuch-show-previous-message]' to advance to messages
1478 without removing any tags, and '\\[notmuch-show-archive-thread]' to archive an entire thread
1479 without scrolling through with \\[notmuch-show-advance-and-archive]).
1481 You can add or remove arbitrary tags from the current message with
1482 '\\[notmuch-show-add-tag]' or '\\[notmuch-show-remove-tag]'.
1484 All currently available key bindings:
1486 \\{notmuch-show-mode-map}"
1488 (kill-all-local-variables)
1489 (setq notmuch-buffer-refresh-function #'notmuch-show-refresh-view)
1490 (use-local-map notmuch-show-mode-map)
1491 (setq major-mode 'notmuch-show-mode
1492 mode-name "notmuch-show")
1493 (setq buffer-read-only t
1496 (defun notmuch-tree-from-show-current-query ()
1497 "Call notmuch tree with the current query"
1499 (notmuch-tree notmuch-show-thread-id
1500 notmuch-show-query-context
1501 (notmuch-show-get-message-id)))
1503 (defun notmuch-show-move-to-message-top ()
1504 (goto-char (notmuch-show-message-top)))
1506 (defun notmuch-show-move-to-message-bottom ()
1507 (goto-char (notmuch-show-message-bottom)))
1509 (defun notmuch-show-message-adjust ()
1512 ;; Movement related functions.
1514 ;; There's some strangeness here where a text property applied to a
1515 ;; region a->b is not found when point is at b. We walk backwards
1516 ;; until finding the property.
1517 (defun notmuch-show-message-extent ()
1520 (while (not (setq r (get-text-property (point) :notmuch-message-extent)))
1524 (defun notmuch-show-message-top ()
1525 (car (notmuch-show-message-extent)))
1527 (defun notmuch-show-message-bottom ()
1528 (cdr (notmuch-show-message-extent)))
1530 (defun notmuch-show-goto-message-next ()
1531 (let ((start (point)))
1532 (notmuch-show-move-to-message-bottom)
1538 (defun notmuch-show-goto-message-previous ()
1539 (notmuch-show-move-to-message-top)
1543 (notmuch-show-move-to-message-top)
1546 (defun notmuch-show-mapc (function)
1547 "Iterate through all messages in the current thread with
1548 `notmuch-show-goto-message-next' and call FUNCTION for side
1551 (goto-char (point-min))
1552 (loop do (funcall function)
1553 while (notmuch-show-goto-message-next))))
1555 ;; Functions relating to the visibility of messages and their
1558 (defun notmuch-show-message-visible (props visible-p)
1559 (overlay-put (plist-get props :message-overlay) 'invisible (not visible-p))
1560 (notmuch-show-set-prop :message-visible visible-p props))
1562 (defun notmuch-show-headers-visible (props visible-p)
1563 (overlay-put (plist-get props :headers-overlay) 'invisible (not visible-p))
1564 (notmuch-show-set-prop :headers-visible visible-p props))
1566 ;; Functions for setting and getting attributes of the current
1569 (defun notmuch-show-set-message-properties (props)
1571 (notmuch-show-move-to-message-top)
1572 (put-text-property (point) (+ (point) 1) :notmuch-message-properties props)))
1574 (defun notmuch-show-get-message-properties ()
1575 "Return the properties of the current message as a plist.
1577 Some useful entries are:
1578 :headers - Property list containing the headers :Date, :Subject, :From, etc.
1579 :body - Body of the message
1580 :tags - Tags for this message"
1582 (notmuch-show-move-to-message-top)
1583 (get-text-property (point) :notmuch-message-properties)))
1585 (defun notmuch-show-get-part-properties ()
1586 "Return the properties of the innermost part containing point.
1588 This is the part property list retrieved from the CLI. Signals
1589 an error if there is no part containing point."
1590 (or (get-text-property (point) :notmuch-part)
1591 (error "No message part here")))
1593 (defun notmuch-show-set-prop (prop val &optional props)
1594 (let ((inhibit-read-only t)
1596 (notmuch-show-get-message-properties))))
1597 (plist-put props prop val)
1598 (notmuch-show-set-message-properties props)))
1600 (defun notmuch-show-get-prop (prop &optional props)
1601 "Get property PROP from current message in show or tree mode.
1603 It gets property PROP from PROPS or, if PROPS is nil, the current
1604 message in either tree or show. This means that several utility
1605 functions in notmuch-show can be used directly by notmuch-tree as
1606 they just need the correct message properties."
1607 (let ((props (or props
1608 (cond ((eq major-mode 'notmuch-show-mode)
1609 (notmuch-show-get-message-properties))
1610 ((eq major-mode 'notmuch-tree-mode)
1611 (notmuch-tree-get-message-properties))
1613 (plist-get props prop)))
1615 (defun notmuch-show-get-message-id (&optional bare)
1616 "Return an id: query for the Message-Id of the current message.
1618 If optional argument BARE is non-nil, return
1619 the Message-Id without id: prefix and escaping."
1621 (notmuch-show-get-prop :id)
1622 (notmuch-id-to-query (notmuch-show-get-prop :id))))
1624 (defun notmuch-show-get-messages-ids ()
1625 "Return all id: queries of messages in the current thread."
1626 (let ((message-ids))
1628 (lambda () (push (notmuch-show-get-message-id) message-ids)))
1631 (defun notmuch-show-get-messages-ids-search ()
1632 "Return a search string for all message ids of messages in the
1634 (mapconcat 'identity (notmuch-show-get-messages-ids) " or "))
1636 ;; dme: Would it make sense to use a macro for many of these?
1638 (defun notmuch-show-get-filename ()
1639 "Return the filename of the current message."
1640 (notmuch-show-get-prop :filename))
1642 (defun notmuch-show-get-header (header &optional props)
1643 "Return the named header of the current message, if any."
1644 (plist-get (notmuch-show-get-prop :headers props) header))
1646 (defun notmuch-show-get-cc ()
1647 (notmuch-show-get-header :Cc))
1649 (defun notmuch-show-get-date ()
1650 (notmuch-show-get-header :Date))
1652 (defun notmuch-show-get-from ()
1653 (notmuch-show-get-header :From))
1655 (defun notmuch-show-get-subject ()
1656 (notmuch-show-get-header :Subject))
1658 (defun notmuch-show-get-to ()
1659 (notmuch-show-get-header :To))
1661 (defun notmuch-show-get-depth ()
1662 (notmuch-show-get-prop :depth))
1664 (defun notmuch-show-set-tags (tags)
1665 "Set the tags of the current message."
1666 (notmuch-show-set-prop :tags tags)
1667 (notmuch-show-update-tags tags))
1669 (defun notmuch-show-get-tags ()
1670 "Return the tags of the current message."
1671 (notmuch-show-get-prop :tags))
1673 (defun notmuch-show-message-visible-p ()
1674 "Is the current message visible?"
1675 (notmuch-show-get-prop :message-visible))
1677 (defun notmuch-show-headers-visible-p ()
1678 "Are the headers of the current message visible?"
1679 (notmuch-show-get-prop :headers-visible))
1681 (put 'notmuch-show-mark-read 'notmuch-prefix-doc
1682 "Mark the current message as unread.")
1683 (defun notmuch-show-mark-read (&optional unread)
1684 "Mark the current message as read.
1686 Mark the current message as read by applying the tag changes in
1687 `notmuch-show-mark-read-tags' to it (remove the \"unread\" tag by
1688 default). If a prefix argument is given, the message will be
1689 marked as unread, i.e. the tag changes in
1690 `notmuch-show-mark-read-tags' will be reversed."
1692 (when notmuch-show-mark-read-tags
1693 (apply 'notmuch-show-tag-message
1694 (notmuch-tag-change-list notmuch-show-mark-read-tags unread))))
1696 (defun notmuch-show-seen-current-message (start end)
1697 "Mark the current message read if it is open.
1699 We only mark it read once: if it is changed back then that is a
1700 user decision and we should not override it."
1701 (when (and (notmuch-show-message-visible-p)
1702 (not (notmuch-show-get-prop :seen)))
1703 (notmuch-show-mark-read)
1704 (notmuch-show-set-prop :seen t)))
1706 (defun notmuch-show-command-hook ()
1707 (when (eq major-mode 'notmuch-show-mode)
1708 ;; We need to redisplay to get window-start and window-end correct.
1711 (funcall notmuch-show-mark-read-function (window-start) (window-end)))))
1713 (defun notmuch-show-filter-thread (query)
1714 "Filter or LIMIT the current thread based on a new query string.
1716 Reshows the current thread with matches defined by the new query-string."
1717 (interactive (list (notmuch-read-query "Filter thread: ")))
1718 (let ((msg-id (notmuch-show-get-message-id)))
1719 (setq notmuch-show-query-context (if (string= query "") nil query))
1720 (notmuch-show-refresh-view t)
1721 (notmuch-show-goto-message msg-id)))
1723 ;; Functions for getting attributes of several messages in the current
1726 (defun notmuch-show-get-message-ids-for-open-messages ()
1727 "Return a list of all id: queries for open messages in the current thread."
1729 (let (message-ids done)
1730 (goto-char (point-min))
1732 (if (notmuch-show-message-visible-p)
1733 (setq message-ids (append message-ids (list (notmuch-show-get-message-id)))))
1734 (setq done (not (notmuch-show-goto-message-next)))
1739 ;; Commands typically bound to keys.
1741 (defun notmuch-show-advance ()
1742 "Advance through thread.
1744 If the current message in the thread is not yet fully visible,
1745 scroll by a near screenful to read more of the message.
1747 Otherwise, (the end of the current message is already within the
1748 current window), advance to the next open message."
1750 (let* ((end-of-this-message (notmuch-show-message-bottom))
1751 (visible-end-of-this-message (1- end-of-this-message))
1753 (while (invisible-p visible-end-of-this-message)
1754 (setq visible-end-of-this-message
1756 (1- (previous-single-char-property-change
1757 visible-end-of-this-message 'invisible)))))
1759 ;; Ideally we would test `end-of-this-message' against the result
1760 ;; of `window-end', but that doesn't account for the fact that
1761 ;; the end of the message might be hidden.
1762 ((and visible-end-of-this-message
1763 (> visible-end-of-this-message (window-end)))
1764 ;; The bottom of this message is not visible - scroll.
1767 ((not (= end-of-this-message (point-max)))
1768 ;; This is not the last message - move to the next visible one.
1769 (notmuch-show-next-open-message))
1771 ((not (= (point) (point-max)))
1772 ;; This is the last message, but the cursor is not at the end of
1773 ;; the buffer. Move it there.
1774 (goto-char (point-max)))
1777 ;; This is the last message - change the return value
1781 (defun notmuch-show-advance-and-archive ()
1782 "Advance through thread and archive.
1784 This command is intended to be one of the simplest ways to
1785 process a thread of email. It works exactly like
1786 notmuch-show-advance, in that it scrolls through messages in a
1787 show buffer, except that when it gets to the end of the buffer it
1788 archives the entire current thread, (apply changes in
1789 `notmuch-archive-tags'), kills the buffer, and displays the next
1790 thread from the search from which this thread was originally
1793 (if (notmuch-show-advance)
1794 (notmuch-show-archive-thread-then-next)))
1796 (defun notmuch-show-rewind ()
1797 "Backup through the thread (reverse scrolling compared to \\[notmuch-show-advance-and-archive]).
1799 Specifically, if the beginning of the previous email is fewer
1800 than `window-height' lines from the current point, move to it
1801 just like `notmuch-show-previous-message'.
1803 Otherwise, just scroll down a screenful of the current message.
1805 This command does not modify any message tags, (it does not undo
1806 any effects from previous calls to
1807 `notmuch-show-advance-and-archive'."
1809 (let ((start-of-message (notmuch-show-message-top))
1810 (start-of-window (window-start)))
1812 ;; Either this message is properly aligned with the start of the
1813 ;; window or the start of this message is not visible on the
1815 ((or (= start-of-message start-of-window)
1816 (< start-of-message start-of-window))
1818 ;; If a small number of lines from the previous message are
1819 ;; visible, realign so that the top of the current message is at
1820 ;; the top of the screen.
1821 (when (<= (count-screen-lines (window-start) start-of-message)
1822 next-screen-context-lines)
1823 (goto-char (notmuch-show-message-top))
1824 (notmuch-show-message-adjust))
1825 ;; Move to the top left of the window.
1826 (goto-char (window-start)))
1828 ;; Move to the previous message.
1829 (notmuch-show-previous-message)))))
1831 (put 'notmuch-show-reply 'notmuch-prefix-doc "... and prompt for sender")
1832 (defun notmuch-show-reply (&optional prompt-for-sender)
1833 "Reply to the sender and all recipients of the current message."
1835 (notmuch-mua-new-reply (notmuch-show-get-message-id) prompt-for-sender t))
1837 (put 'notmuch-show-reply-sender 'notmuch-prefix-doc "... and prompt for sender")
1838 (defun notmuch-show-reply-sender (&optional prompt-for-sender)
1839 "Reply to the sender of the current message."
1841 (notmuch-mua-new-reply (notmuch-show-get-message-id) prompt-for-sender nil))
1843 (put 'notmuch-show-forward-message 'notmuch-prefix-doc
1844 "... and prompt for sender")
1845 (defun notmuch-show-forward-message (&optional prompt-for-sender)
1846 "Forward the current message."
1848 (with-current-notmuch-show-message
1849 (notmuch-mua-new-forward-message prompt-for-sender)))
1851 (defun notmuch-show-next-message (&optional pop-at-end)
1852 "Show the next message.
1854 If a prefix argument is given and this is the last message in the
1855 thread, navigate to the next thread in the parent search buffer."
1857 (if (notmuch-show-goto-message-next)
1858 (notmuch-show-message-adjust)
1860 (notmuch-show-next-thread)
1861 (goto-char (point-max)))))
1863 (defun notmuch-show-previous-message ()
1864 "Show the previous message or the start of the current message."
1866 (if (= (point) (notmuch-show-message-top))
1867 (notmuch-show-goto-message-previous)
1868 (notmuch-show-move-to-message-top))
1869 (notmuch-show-message-adjust))
1871 (defun notmuch-show-next-open-message (&optional pop-at-end)
1872 "Show the next open message.
1874 If a prefix argument is given and this is the last open message
1875 in the thread, navigate to the next thread in the parent search
1876 buffer. Return t if there was a next open message in the thread
1877 to show, nil otherwise."
1880 (while (and (setq r (notmuch-show-goto-message-next))
1881 (not (notmuch-show-message-visible-p))))
1883 (notmuch-show-message-adjust)
1885 (notmuch-show-next-thread)
1886 (goto-char (point-max))))
1889 (defun notmuch-show-next-matching-message ()
1890 "Show the next matching message."
1893 (while (and (setq r (notmuch-show-goto-message-next))
1894 (not (notmuch-show-get-prop :match))))
1896 (notmuch-show-message-adjust)
1897 (goto-char (point-max)))))
1899 (defun notmuch-show-open-if-matched ()
1900 "Open a message if it is matched (whether or not excluded)."
1901 (let ((props (notmuch-show-get-message-properties)))
1902 (notmuch-show-message-visible props (plist-get props :match))))
1904 (defun notmuch-show-goto-first-wanted-message ()
1905 "Move to the first open message and mark it read"
1906 (goto-char (point-min))
1907 (unless (notmuch-show-message-visible-p)
1908 (notmuch-show-next-open-message))
1910 ;; There are no matched non-excluded messages so open all matched
1911 ;; (necessarily excluded) messages and go to the first.
1912 (notmuch-show-mapc 'notmuch-show-open-if-matched)
1913 (force-window-update)
1914 (goto-char (point-min))
1915 (unless (notmuch-show-message-visible-p)
1916 (notmuch-show-next-open-message))))
1918 (defun notmuch-show-previous-open-message ()
1919 "Show the previous open message."
1921 (while (and (if (= (point) (notmuch-show-message-top))
1922 (notmuch-show-goto-message-previous)
1923 (notmuch-show-move-to-message-top))
1924 (not (notmuch-show-message-visible-p))))
1925 (notmuch-show-message-adjust))
1927 (defun notmuch-show-view-raw-message ()
1928 "View the original source of the current message."
1930 (let* ((id (notmuch-show-get-message-id))
1931 (buf (get-buffer-create (concat "*notmuch-raw-" id "*")))
1932 (inhibit-read-only t))
1933 (switch-to-buffer buf)
1935 (let ((coding-system-for-read 'no-conversion))
1936 (call-process notmuch-command nil t nil "show" "--format=raw" id))
1937 (goto-char (point-min))
1938 (set-buffer-modified-p nil)
1939 (setq buffer-read-only t)
1940 (view-buffer buf 'kill-buffer-if-not-modified)))
1942 (put 'notmuch-show-pipe-message 'notmuch-doc
1943 "Pipe the contents of the current message to a command.")
1944 (put 'notmuch-show-pipe-message 'notmuch-prefix-doc
1945 "Pipe the thread as an mbox to a command.")
1946 (defun notmuch-show-pipe-message (entire-thread command)
1947 "Pipe the contents of the current message (or thread) to COMMAND.
1949 COMMAND will be executed with the raw contents of the current
1950 email message as stdin. Anything printed by the command to stdout
1951 or stderr will appear in the *notmuch-pipe* buffer.
1953 If ENTIRE-THREAD is non-nil (or when invoked with a prefix
1954 argument), COMMAND will receive all open messages in the current
1955 thread (formatted as an mbox) rather than only the current
1957 (interactive (let ((query-string (if current-prefix-arg
1958 "Pipe all open messages to command: "
1959 "Pipe message to command: ")))
1960 (list current-prefix-arg (read-string query-string))))
1961 (let (shell-command)
1964 (concat notmuch-command " show --format=mbox --exclude=false "
1965 (shell-quote-argument
1966 (mapconcat 'identity (notmuch-show-get-message-ids-for-open-messages) " OR "))
1969 (concat notmuch-command " show --format=raw "
1970 (shell-quote-argument (notmuch-show-get-message-id)) " | " command)))
1971 (let ((cwd default-directory)
1972 (buf (get-buffer-create (concat "*notmuch-pipe*"))))
1973 (with-current-buffer buf
1974 (setq buffer-read-only nil)
1976 ;; Use the originating buffer's working directory instead of
1977 ;; that of the pipe buffer.
1979 (let ((exit-code (call-process-shell-command shell-command nil buf)))
1980 (goto-char (point-max))
1981 (set-buffer-modified-p nil)
1982 (setq buffer-read-only t)
1983 (unless (zerop exit-code)
1984 (switch-to-buffer-other-window buf)
1985 (message (format "Command '%s' exited abnormally with code %d"
1986 shell-command exit-code))))))))
1988 (defun notmuch-show-tag-message (&rest tag-changes)
1989 "Change tags for the current message.
1991 TAG-CHANGES is a list of tag operations for `notmuch-tag'."
1992 (let* ((current-tags (notmuch-show-get-tags))
1993 (new-tags (notmuch-update-tags current-tags tag-changes)))
1994 (unless (equal current-tags new-tags)
1995 (notmuch-tag (notmuch-show-get-message-id) tag-changes)
1996 (notmuch-show-set-tags new-tags))))
1998 (defun notmuch-show-tag (tag-changes)
1999 "Change tags for the current message.
2001 See `notmuch-tag' for information on the format of TAG-CHANGES."
2002 (interactive (list (notmuch-read-tag-changes (notmuch-show-get-tags)
2004 (notmuch-tag (notmuch-show-get-message-id) tag-changes)
2005 (let* ((current-tags (notmuch-show-get-tags))
2006 (new-tags (notmuch-update-tags current-tags tag-changes)))
2007 (unless (equal current-tags new-tags)
2008 (notmuch-show-set-tags new-tags))))
2010 (defun notmuch-show-tag-all (tag-changes)
2011 "Change tags for all messages in the current show buffer.
2013 See `notmuch-tag' for information on the format of TAG-CHANGES."
2017 (lambda () (setq tags (append (notmuch-show-get-tags) tags))))
2018 (notmuch-read-tag-changes tags "Tag thread"))))
2019 (notmuch-tag (notmuch-show-get-messages-ids-search) tag-changes)
2022 (let* ((current-tags (notmuch-show-get-tags))
2023 (new-tags (notmuch-update-tags current-tags tag-changes)))
2024 (unless (equal current-tags new-tags)
2025 (notmuch-show-set-tags new-tags))))))
2027 (defun notmuch-show-add-tag (tag-changes)
2028 "Change tags for the current message (defaulting to add).
2030 Same as `notmuch-show-tag' but sets initial input to '+'."
2032 (list (notmuch-read-tag-changes (notmuch-show-get-tags) "Tag message" "+")))
2033 (notmuch-show-tag tag-changes))
2035 (defun notmuch-show-remove-tag (tag-changes)
2036 "Change tags for the current message (defaulting to remove).
2038 Same as `notmuch-show-tag' but sets initial input to '-'."
2040 (list (notmuch-read-tag-changes (notmuch-show-get-tags) "Tag message" "-")))
2041 (notmuch-show-tag tag-changes))
2043 (defun notmuch-show-toggle-visibility-headers ()
2044 "Toggle the visibility of the current message headers."
2046 (let ((props (notmuch-show-get-message-properties)))
2047 (notmuch-show-headers-visible
2049 (not (plist-get props :headers-visible))))
2050 (force-window-update))
2052 (defun notmuch-show-toggle-message ()
2053 "Toggle the visibility of the current message."
2055 (let ((props (notmuch-show-get-message-properties)))
2056 (notmuch-show-message-visible
2058 (not (plist-get props :message-visible))))
2059 (force-window-update))
2061 (put 'notmuch-show-open-or-close-all 'notmuch-doc "Show all messages.")
2062 (put 'notmuch-show-open-or-close-all 'notmuch-prefix-doc "Hide all messages.")
2063 (defun notmuch-show-open-or-close-all ()
2064 "Set the visibility all of the messages in the current thread.
2066 By default make all of the messages visible. With a prefix
2067 argument, hide all of the messages."
2070 (goto-char (point-min))
2071 (loop do (notmuch-show-message-visible (notmuch-show-get-message-properties)
2072 (not current-prefix-arg))
2073 until (not (notmuch-show-goto-message-next))))
2074 (force-window-update))
2076 (defun notmuch-show-next-button ()
2077 "Advance point to the next button in the buffer."
2081 (defun notmuch-show-previous-button ()
2082 "Move point back to the previous button in the buffer."
2084 (backward-button 1))
2086 (defun notmuch-show-next-thread (&optional show previous)
2087 "Move to the next item in the search results, if any.
2089 If SHOW is non-nil, open the next item in a show
2090 buffer. Otherwise just highlight the next item in the search
2091 buffer. If PREVIOUS is non-nil, move to the previous item in the
2092 search results instead."
2094 (let ((parent-buffer notmuch-show-parent-buffer))
2095 (notmuch-bury-or-kill-this-buffer)
2096 (when (buffer-live-p parent-buffer)
2097 (switch-to-buffer parent-buffer)
2099 (notmuch-search-previous-thread)
2100 (notmuch-search-next-thread))
2102 (notmuch-search-show-thread)))))
2104 (defun notmuch-show-next-thread-show ()
2105 "Show the next thread in the search results, if any."
2107 (notmuch-show-next-thread t))
2109 (defun notmuch-show-previous-thread-show ()
2110 "Show the previous thread in the search results, if any."
2112 (notmuch-show-next-thread t t))
2114 (put 'notmuch-show-archive-thread 'notmuch-prefix-doc
2115 "Un-archive each message in thread.")
2116 (defun notmuch-show-archive-thread (&optional unarchive)
2117 "Archive each message in thread.
2119 Archive each message currently shown by applying the tag changes
2120 in `notmuch-archive-tags' to each. If a prefix argument is given,
2121 the messages will be \"unarchived\", i.e. the tag changes in
2122 `notmuch-archive-tags' will be reversed.
2124 Note: This command is safe from any race condition of new messages
2125 being delivered to the same thread. It does not archive the
2126 entire thread, but only the messages shown in the current
2129 (when notmuch-archive-tags
2130 (notmuch-show-tag-all
2131 (notmuch-tag-change-list notmuch-archive-tags unarchive))))
2133 (defun notmuch-show-archive-thread-then-next ()
2134 "Archive all messages in the current buffer, then show next thread from search."
2136 (notmuch-show-archive-thread)
2137 (notmuch-show-next-thread t))
2139 (defun notmuch-show-archive-thread-then-exit ()
2140 "Archive all messages in the current buffer, then exit back to search results."
2142 (notmuch-show-archive-thread)
2143 (notmuch-show-next-thread))
2145 (put 'notmuch-show-archive-message 'notmuch-prefix-doc
2146 "Un-archive the current message.")
2147 (defun notmuch-show-archive-message (&optional unarchive)
2148 "Archive the current message.
2150 Archive the current message by applying the tag changes in
2151 `notmuch-archive-tags' to it. If a prefix argument is given, the
2152 message will be \"unarchived\", i.e. the tag changes in
2153 `notmuch-archive-tags' will be reversed."
2155 (when notmuch-archive-tags
2156 (apply 'notmuch-show-tag-message
2157 (notmuch-tag-change-list notmuch-archive-tags unarchive))))
2159 (defun notmuch-show-archive-message-then-next-or-exit ()
2160 "Archive the current message, then show the next open message in the current thread.
2162 If at the last open message in the current thread, then exit back
2165 (notmuch-show-archive-message)
2166 (notmuch-show-next-open-message t))
2168 (defun notmuch-show-archive-message-then-next-or-next-thread ()
2169 "Archive the current message, then show the next open message in the current thread.
2171 If at the last open message in the current thread, then show next
2172 thread from search."
2174 (notmuch-show-archive-message)
2175 (unless (notmuch-show-next-open-message)
2176 (notmuch-show-next-thread t)))
2178 (defun notmuch-show-stash-cc ()
2179 "Copy CC field of current message to kill-ring."
2181 (notmuch-common-do-stash (notmuch-show-get-cc)))
2183 (defun notmuch-show-stash-date ()
2184 "Copy date of current message to kill-ring."
2186 (notmuch-common-do-stash (notmuch-show-get-date)))
2188 (defun notmuch-show-stash-filename ()
2189 "Copy filename of current message to kill-ring."
2191 (notmuch-common-do-stash (notmuch-show-get-filename)))
2193 (defun notmuch-show-stash-from ()
2194 "Copy From address of current message to kill-ring."
2196 (notmuch-common-do-stash (notmuch-show-get-from)))
2198 (put 'notmuch-show-stash-message-id 'notmuch-prefix-doc
2199 "Copy thread: query matching current thread to kill-ring.")
2200 (defun notmuch-show-stash-message-id (&optional stash-thread-id)
2201 "Copy id: query matching the current message to kill-ring.
2203 If invoked with a prefix argument (or STASH-THREAD-ID is
2204 non-nil), copy thread: query matching the current thread to
2208 (notmuch-common-do-stash notmuch-show-thread-id)
2209 (notmuch-common-do-stash (notmuch-show-get-message-id))))
2211 (defun notmuch-show-stash-message-id-stripped ()
2212 "Copy message ID of current message (sans `id:' prefix) to kill-ring."
2214 (notmuch-common-do-stash (notmuch-show-get-message-id t)))
2216 (defun notmuch-show-stash-subject ()
2217 "Copy Subject field of current message to kill-ring."
2219 (notmuch-common-do-stash (notmuch-show-get-subject)))
2221 (defun notmuch-show-stash-tags ()
2222 "Copy tags of current message to kill-ring as a comma separated list."
2224 (notmuch-common-do-stash (mapconcat 'identity (notmuch-show-get-tags) ",")))
2226 (defun notmuch-show-stash-to ()
2227 "Copy To address of current message to kill-ring."
2229 (notmuch-common-do-stash (notmuch-show-get-to)))
2231 (defun notmuch-show-stash-mlarchive-link (&optional mla)
2232 "Copy an ML Archive URI for the current message to the kill-ring.
2234 This presumes that the message is available at the selected Mailing List Archive.
2236 If optional argument MLA is non-nil, use the provided key instead of prompting
2237 the user (see `notmuch-show-stash-mlarchive-link-alist')."
2239 (let ((url (cdr (assoc
2241 (let ((completion-ignore-case t))
2243 "Mailing List Archive: "
2244 notmuch-show-stash-mlarchive-link-alist
2246 notmuch-show-stash-mlarchive-link-default)))
2247 notmuch-show-stash-mlarchive-link-alist))))
2248 (notmuch-common-do-stash
2250 (funcall url (notmuch-show-get-message-id t))
2251 (concat url (notmuch-show-get-message-id t))))))
2253 (defun notmuch-show-stash-mlarchive-link-and-go (&optional mla)
2254 "Copy an ML Archive URI for the current message to the kill-ring and visit it.
2256 This presumes that the message is available at the selected Mailing List Archive.
2258 If optional argument MLA is non-nil, use the provided key instead of prompting
2259 the user (see `notmuch-show-stash-mlarchive-link-alist')."
2261 (notmuch-show-stash-mlarchive-link mla)
2262 (browse-url (current-kill 0 t)))
2264 (defun notmuch-show-stash-git-helper (addresses prefix)
2265 "Escape, trim, quote, and add PREFIX to each address in list of ADDRESSES, and return the result as a single string."
2266 (mapconcat (lambda (x)
2268 ;; escape double-quotes
2269 (replace-regexp-in-string
2271 ;; trim leading and trailing spaces
2272 (replace-regexp-in-string
2273 "\\(^ *\\| *$\\)" ""
2277 (put 'notmuch-show-stash-git-send-email 'notmuch-prefix-doc
2278 "Copy From/To/Cc of current message to kill-ring in a form suitable for pasting to git send-email command line.")
2280 (defun notmuch-show-stash-git-send-email (&optional no-in-reply-to)
2281 "Copy From/To/Cc/Message-Id of current message to kill-ring in a form suitable for pasting to git send-email command line.
2283 If invoked with a prefix argument (or NO-IN-REPLY-TO is non-nil),
2284 omit --in-reply-to=<Message-Id>."
2286 (notmuch-common-do-stash
2287 (mapconcat 'identity
2290 (notmuch-show-stash-git-helper
2291 (message-tokenize-header (notmuch-show-get-from)) "--to=")
2292 (notmuch-show-stash-git-helper
2293 (message-tokenize-header (notmuch-show-get-to)) "--to=")
2294 (notmuch-show-stash-git-helper
2295 (message-tokenize-header (notmuch-show-get-cc)) "--cc=")
2296 (unless no-in-reply-to
2297 (notmuch-show-stash-git-helper
2298 (list (notmuch-show-get-message-id t)) "--in-reply-to="))))
2301 ;; Interactive part functions and their helpers
2303 (defun notmuch-show-generate-part-buffer (msg part)
2304 "Return a temporary buffer containing the specified part's content."
2305 (let ((buf (generate-new-buffer " *notmuch-part*"))
2306 (process-crypto notmuch-show-process-crypto))
2307 (with-current-buffer buf
2308 ;; This is always used in the content of mm handles, which
2309 ;; expect undecoded, binary part content.
2310 (insert (notmuch-get-bodypart-binary msg part process-crypto)))
2313 (defun notmuch-show-current-part-handle ()
2314 "Return an mm-handle for the part containing point.
2316 This creates a temporary buffer for the part's content; the
2317 caller is responsible for killing this buffer as appropriate."
2318 (let* ((msg (notmuch-show-get-message-properties))
2319 (part (notmuch-show-get-part-properties))
2320 (buf (notmuch-show-generate-part-buffer msg part))
2321 (computed-type (plist-get part :computed-type))
2322 (filename (plist-get part :filename))
2323 (disposition (if filename `(attachment (filename . ,filename)))))
2324 (mm-make-handle buf (list computed-type) nil nil disposition)))
2326 (defun notmuch-show-apply-to-current-part-handle (fn)
2327 "Apply FN to an mm-handle for the part containing point.
2329 This ensures that the temporary buffer created for the mm-handle
2330 is destroyed when FN returns."
2331 (let ((handle (notmuch-show-current-part-handle)))
2332 ;; emacs 24.3+ puts stdout/stderr into the calling buffer so we
2333 ;; call it from a temp-buffer, unless
2334 ;; notmuch-show-attachment-debug is non-nil in which case we put
2335 ;; it in " *notmuch-part*".
2337 (if notmuch-show-attachment-debug
2338 (with-current-buffer (generate-new-buffer " *notmuch-part*")
2339 (funcall fn handle))
2341 (funcall fn handle)))
2342 (kill-buffer (mm-handle-buffer handle)))))
2344 (defun notmuch-show-part-button-default (&optional button)
2346 (let ((button (or button (button-at (point)))))
2347 ;; Try to toggle the part, if that fails then call the default
2348 ;; action. The toggle fails if the part has no emacs renderable
2350 (unless (notmuch-show-toggle-part-invisibility button)
2351 (call-interactively notmuch-show-part-button-default-action))))
2353 (defun notmuch-show-save-part ()
2354 "Save the MIME part containing point to a file."
2356 (notmuch-show-apply-to-current-part-handle #'mm-save-part))
2358 (defun notmuch-show-view-part ()
2359 "View the MIME part containing point in an external viewer."
2361 ;; Set mm-inlined-types to nil to force an external viewer
2362 (let ((mm-inlined-types nil))
2363 (notmuch-show-apply-to-current-part-handle #'mm-display-part)))
2365 (defun notmuch-show-interactively-view-part ()
2366 "View the MIME part containing point, prompting for a viewer."
2368 (notmuch-show-apply-to-current-part-handle #'mm-interactively-view-part))
2370 (defun notmuch-show-pipe-part ()
2371 "Pipe the MIME part containing point to an external command."
2373 (notmuch-show-apply-to-current-part-handle #'mm-pipe-part))
2376 (provide 'notmuch-show)