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)
51 (defcustom notmuch-message-headers '("Subject" "To" "Cc" "Date")
52 "Headers that should be shown in a message, in this order.
54 For an open message, all of these headers will be made visible
55 according to `notmuch-message-headers-visible' or can be toggled
56 with `notmuch-show-toggle-visibility-headers'. For a closed message,
57 only the first header in the list will be visible."
58 :type '(repeat string)
61 (defcustom notmuch-message-headers-visible t
62 "Should the headers be visible by default?
64 If this value is non-nil, then all of the headers defined in
65 `notmuch-message-headers' will be visible by default in the display
66 of each message. Otherwise, these headers will be hidden and
67 `notmuch-show-toggle-visibility-headers' can be used to make them
68 visible for any given message."
72 (defcustom notmuch-show-relative-dates t
73 "Display relative dates in the message summary line."
77 (defvar notmuch-show-markup-headers-hook '(notmuch-show-colour-headers)
78 "A list of functions called to decorate the headers listed in
79 `notmuch-message-headers'.")
81 (defcustom notmuch-show-hook '(notmuch-show-turn-on-visual-line-mode)
82 "Functions called after populating a `notmuch-show' buffer."
84 :options '(notmuch-show-turn-on-visual-line-mode)
86 :group 'notmuch-hooks)
88 (defcustom notmuch-show-insert-text/plain-hook '(notmuch-wash-wrap-long-lines
89 notmuch-wash-tidy-citations
90 notmuch-wash-elide-blank-lines
91 notmuch-wash-excerpt-citations)
92 "Functions used to improve the display of text/plain parts."
94 :options '(notmuch-wash-convert-inline-patch-to-part
95 notmuch-wash-wrap-long-lines
96 notmuch-wash-tidy-citations
97 notmuch-wash-elide-blank-lines
98 notmuch-wash-excerpt-citations)
100 :group 'notmuch-hooks)
102 ;; Mostly useful for debugging.
103 (defcustom notmuch-show-all-multipart/alternative-parts nil
104 "Should all parts of multipart/alternative parts be shown?"
106 :group 'notmuch-show)
108 (defcustom notmuch-show-indent-messages-width 1
109 "Width of message indentation in threads.
111 Messages are shown indented according to their depth in a thread.
112 This variable determines the width of this indentation measured
113 in number of blanks. Defaults to `1', choose `0' to disable
116 :group 'notmuch-show)
118 (defcustom notmuch-show-indent-multipart nil
119 "Should the sub-parts of a multipart/* part be indented?"
120 ;; dme: Not sure which is a good default.
122 :group 'notmuch-show)
124 (defcustom notmuch-show-part-button-default-action 'notmuch-show-save-part
125 "Default part header button action (on ENTER or mouse click)."
127 :type '(choice (const :tag "Save part"
128 notmuch-show-save-part)
129 (const :tag "View part"
130 notmuch-show-view-part)
131 (const :tag "View interactively"
132 notmuch-show-interactively-view-part)))
134 (defcustom notmuch-show-only-matching-messages nil
135 "Only matching messages are shown by default."
137 :group 'notmuch-show)
139 (defvar notmuch-show-thread-id nil)
140 (make-variable-buffer-local 'notmuch-show-thread-id)
141 (put 'notmuch-show-thread-id 'permanent-local t)
143 (defvar notmuch-show-parent-buffer nil)
144 (make-variable-buffer-local 'notmuch-show-parent-buffer)
145 (put 'notmuch-show-parent-buffer 'permanent-local t)
147 (defvar notmuch-show-query-context nil)
148 (make-variable-buffer-local 'notmuch-show-query-context)
149 (put 'notmuch-show-query-context 'permanent-local t)
151 (defvar notmuch-show-process-crypto nil)
152 (make-variable-buffer-local 'notmuch-show-process-crypto)
153 (put 'notmuch-show-process-crypto 'permanent-local t)
155 (defvar notmuch-show-elide-non-matching-messages nil)
156 (make-variable-buffer-local 'notmuch-show-elide-non-matching-messages)
157 (put 'notmuch-show-elide-non-matching-messages 'permanent-local t)
159 (defvar notmuch-show-indent-content t)
160 (make-variable-buffer-local 'notmuch-show-indent-content)
161 (put 'notmuch-show-indent-content 'permanent-local t)
163 (defvar notmuch-show-attachment-debug nil
164 "If t log stdout and stderr from attachment handlers
166 When set to nil (the default) stdout and stderr from attachment
167 handlers is discarded. When set to t the stdout and stderr from
168 each attachment handler is logged in buffers with names beginning
169 \" *notmuch-part*\". This option requires emacs version at least
172 (defcustom notmuch-show-stash-mlarchive-link-alist
173 '(("Gmane" . "http://mid.gmane.org/")
174 ("MARC" . "http://marc.info/?i=")
175 ("Mail Archive, The" . "http://mid.mail-archive.com/")
176 ("LKML" . "http://lkml.kernel.org/r/")
177 ;; FIXME: can these services be searched by `Message-Id' ?
178 ;; ("MarkMail" . "http://markmail.org/")
179 ;; ("Nabble" . "http://nabble.com/")
180 ;; ("opensubscriber" . "http://opensubscriber.com/")
182 "List of Mailing List Archives to use when stashing links.
184 This list is used for generating a Mailing List Archive reference
185 URI with the current message's Message-Id in
186 `notmuch-show-stash-mlarchive-link'.
188 If the cdr of the alist element is not a function, the cdr is
189 expected to contain a URI that is concatenated with the current
190 message's Message-Id to create a ML archive reference URI.
192 If the cdr is a function, the function is called with the
193 Message-Id as the argument, and the function is expected to
194 return the ML archive reference URI."
195 :type '(alist :key-type (string :tag "Name")
198 (function :tag "Function returning the URL")))
199 :group 'notmuch-show)
201 (defcustom notmuch-show-stash-mlarchive-link-default "Gmane"
202 "Default Mailing List Archive to use when stashing links.
204 This is used when `notmuch-show-stash-mlarchive-link' isn't
205 provided with an MLA argument nor `completing-read' input."
209 (list 'const :tag (car mla) :value (car mla)))
210 notmuch-show-stash-mlarchive-link-alist))
211 :group 'notmuch-show)
213 (defcustom notmuch-show-mark-read-tags '("-unread")
214 "List of tag changes to apply to a message when it is marked as read.
216 Tags starting with \"+\" (or not starting with either \"+\" or
217 \"-\") in the list will be added, and tags starting with \"-\"
218 will be removed from the message being marked as read.
220 For example, if you wanted to remove an \"unread\" tag and add a
221 \"read\" tag (which would make little sense), you would set:
222 (\"-unread\" \"+read\")"
223 :type '(repeat string)
224 :group 'notmuch-show)
226 (defcustom notmuch-show-mark-read-function #'notmuch-show-seen-current-message
227 "Function to control which messages are marked read.
229 The function should take two arguments START and END which will
230 be the start and end of the visible portion of the buffer and
231 should mark the appropriate messages read by applying
232 `notmuch-show-mark-read'. This function will be called after
233 every user interaction with notmuch."
235 :group 'notmuch-show)
237 (defmacro with-current-notmuch-show-message (&rest body)
238 "Evaluate body with current buffer set to the text of current message"
240 (let ((id (notmuch-show-get-message-id)))
241 (let ((buf (generate-new-buffer (concat "*notmuch-msg-" id "*"))))
242 (with-current-buffer buf
243 (let ((coding-system-for-read 'no-conversion))
244 (call-process notmuch-command nil t nil "show" "--format=raw" id))
246 (kill-buffer buf)))))
248 (defun notmuch-show-turn-on-visual-line-mode ()
249 "Enable Visual Line mode."
250 (visual-line-mode t))
252 ;; DEPRECATED in Notmuch 0.16 since we now have convenient part
253 ;; commands. We'll keep the command around for a version or two in
254 ;; case people want to bind it themselves.
255 (defun notmuch-show-view-all-mime-parts ()
256 "Use external viewers to view all attachments from the current message."
258 (with-current-notmuch-show-message
259 ;; We override the mm-inline-media-tests to indicate which message
260 ;; parts are already sufficiently handled by the original
261 ;; presentation of the message in notmuch-show mode. These parts
262 ;; will be inserted directly into the temporary buffer of
263 ;; with-current-notmuch-show-message and silently discarded.
265 ;; Any MIME part not explicitly mentioned here will be handled by an
266 ;; external viewer as configured in the various mailcap files.
267 (let ((mm-inline-media-tests '(
268 ("text/.*" ignore identity)
269 ("application/pgp-signature" ignore identity)
270 ("multipart/alternative" ignore identity)
271 ("multipart/mixed" ignore identity)
272 ("multipart/related" ignore identity)
274 (mm-display-parts (mm-dissect-buffer)))))
276 (defun notmuch-show-save-attachments ()
277 "Save all attachments from the current message."
279 (with-current-notmuch-show-message
280 (let ((mm-handle (mm-dissect-buffer)))
281 (notmuch-save-attachments
282 mm-handle (> (notmuch-count-attachments mm-handle) 1))))
285 (defun notmuch-show-with-message-as-text (fn)
286 "Apply FN to a text representation of the current message.
288 FN is called with one argument, the message properties. It should
289 operation on the contents of the current buffer."
291 ;; Remake the header to ensure that all information is available.
292 (let* ((to (notmuch-show-get-to))
293 (cc (notmuch-show-get-cc))
294 (from (notmuch-show-get-from))
295 (subject (notmuch-show-get-subject))
296 (date (notmuch-show-get-date))
297 (tags (notmuch-show-get-tags))
298 (depth (notmuch-show-get-depth))
301 "Subject: " subject "\n"
303 (if (not (string= cc ""))
304 (concat "Cc: " cc "\n")
310 (mapconcat #'identity tags ", ") "\n")
312 (all (buffer-substring (notmuch-show-message-top)
313 (notmuch-show-message-bottom)))
315 (props (notmuch-show-get-message-properties))
316 (indenting notmuch-show-indent-content))
320 (indent-rigidly (point-min) (point-max) (- depth)))
321 ;; Remove the original header.
322 (goto-char (point-min))
323 (re-search-forward "^$" (point-max) nil)
324 (delete-region (point-min) (point))
326 (funcall fn props))))
328 (defun notmuch-show-print-message ()
329 "Print the current message."
331 (notmuch-show-with-message-as-text 'notmuch-print-message))
333 (defun notmuch-show-fontify-header ()
335 ((looking-at "[Tt]o:")
337 ((looking-at "[Bb]?[Cc][Cc]:")
339 ((looking-at "[Ss]ubject:")
340 'message-header-subject)
341 ((looking-at "[Ff]rom:")
342 'message-header-from)
344 'message-header-other))))
346 (overlay-put (make-overlay (point) (re-search-forward ":"))
347 'face 'message-header-name)
348 (overlay-put (make-overlay (point) (re-search-forward ".*$"))
351 (defun notmuch-show-colour-headers ()
352 "Apply some colouring to the current headers."
353 (goto-char (point-min))
354 (while (looking-at "^[A-Za-z][-A-Za-z0-9]*:")
355 (notmuch-show-fontify-header)
358 (defun notmuch-show-spaces-n (n)
359 "Return a string comprised of `n' spaces."
362 (defun notmuch-show-update-tags (tags)
363 "Update the displayed tags of the current message."
365 (goto-char (notmuch-show-message-top))
366 (if (re-search-forward "(\\([^()]*\\))$" (line-end-position) t)
367 (let ((inhibit-read-only t))
368 (replace-match (concat "("
369 (notmuch-tag-format-tags tags (notmuch-show-get-prop :orig-tags))
372 (defun notmuch-clean-address (address)
373 "Try to clean a single email ADDRESS for display. Return a cons
374 cell of (AUTHOR_EMAIL AUTHOR_NAME). Return (ADDRESS nil) if
377 (let (p-name p-address)
378 ;; It would be convenient to use `mail-header-parse-address',
379 ;; but that expects un-decoded mailbox parts, whereas our
380 ;; mailbox parts are already decoded (and hence may contain
381 ;; UTF-8). Given that notmuch should handle most of the awkward
382 ;; cases, some simple string deconstruction should be sufficient
385 ;; "User <user@dom.ain>" style.
386 ((string-match "\\(.*\\) <\\(.*\\)>" address)
387 (setq p-name (match-string 1 address)
388 p-address (match-string 2 address)))
390 ;; "<user@dom.ain>" style.
391 ((string-match "<\\(.*\\)>" address)
392 (setq p-address (match-string 1 address)))
396 (setq p-address address)))
399 ;; Remove elements of the mailbox part that are not relevant for
400 ;; display, even if they are required during transport:
403 (setq p-name (replace-regexp-in-string "\\\\" "" p-name))
405 ;; Outer single and double quotes, which might be nested.
408 do (setq start-of-loop p-name)
410 when (string-match "^\"\\(.*\\)\"$" p-name)
411 do (setq p-name (match-string 1 p-name))
413 when (string-match "^'\\(.*\\)'$" p-name)
414 do (setq p-name (match-string 1 p-name))
416 until (string= start-of-loop p-name)))
418 ;; If the address is 'foo@bar.com <foo@bar.com>' then show just
420 (when (string= p-name p-address)
423 (cons p-address p-name))
424 (error (cons address nil))))
426 (defun notmuch-show-clean-address (address)
427 "Try to clean a single email ADDRESS for display. Return
428 unchanged ADDRESS if parsing fails."
429 (let* ((clean-address (notmuch-clean-address address))
430 (p-address (car clean-address))
431 (p-name (cdr clean-address)))
432 ;; If no name, return just the address.
435 ;; Otherwise format the name and address together.
436 (concat p-name " <" p-address ">"))))
438 (defun notmuch-show-insert-headerline (headers date tags depth)
439 "Insert a notmuch style headerline based on HEADERS for a
440 message at DEPTH in the current thread."
441 (let ((start (point)))
442 (insert (notmuch-show-spaces-n (* notmuch-show-indent-messages-width depth))
444 (notmuch-show-clean-address (plist-get headers :From)))
448 (notmuch-tag-format-tags tags tags)
450 (overlay-put (make-overlay start (point)) 'face 'notmuch-message-summary-face)))
452 (defun notmuch-show-insert-header (header header-value)
453 "Insert a single header."
454 (insert header ": " (notmuch-sanitize header-value) "\n"))
456 (defun notmuch-show-insert-headers (headers)
457 "Insert the headers of the current message."
458 (let ((start (point)))
459 (mapc (lambda (header)
460 (let* ((header-symbol (intern (concat ":" header)))
461 (header-value (plist-get headers header-symbol)))
462 (if (and header-value
463 (not (string-equal "" header-value)))
464 (notmuch-show-insert-header header header-value))))
465 notmuch-message-headers)
468 (narrow-to-region start (point-max))
469 (run-hooks 'notmuch-show-markup-headers-hook)))))
471 (define-button-type 'notmuch-show-part-button-type
472 'action 'notmuch-show-part-button-default
475 :supertype 'notmuch-button-type)
477 (defun notmuch-show-insert-part-header (nth content-type declared-type &optional name comment)
479 (base-label (concat (when name (concat name ": "))
481 (unless (string-equal declared-type content-type)
482 (concat " (as " content-type ")"))
487 (concat "[ " base-label " ]")
488 :base-label base-label
489 :type 'notmuch-show-part-button-type
490 :notmuch-part-hidden nil))
495 (defun notmuch-show-toggle-part-invisibility (&optional button)
497 (let* ((button (or button (button-at (point))))
498 (overlay (button-get button 'overlay))
499 (lazy-part (button-get button :notmuch-lazy-part)))
500 ;; We have a part to toggle if there is an overlay or if there is a lazy part.
501 ;; If neither is present we cannot toggle the part so we just return nil.
502 (when (or overlay lazy-part)
503 (let* ((show (button-get button :notmuch-part-hidden))
504 (new-start (button-start button))
505 (button-label (button-get button :base-label))
507 (properties (text-properties-at (button-start button)))
508 (inhibit-read-only t))
509 ;; Toggle the button itself.
510 (button-put button :notmuch-part-hidden (not show))
511 (goto-char new-start)
512 (insert "[ " button-label (if show " ]" " (hidden) ]"))
513 (set-text-properties new-start (point) properties)
514 (let ((old-end (button-end button)))
515 (move-overlay button new-start (point))
516 (delete-region (point) old-end))
517 (goto-char (min old-point (1- (button-end button))))
518 ;; Return nil if there is a lazy-part, it is empty, and we are
519 ;; trying to show it. In all other cases return t.
522 (button-put button :notmuch-lazy-part nil)
523 (notmuch-show-lazy-part lazy-part button))
524 ;; else there must be an overlay.
525 (overlay-put overlay 'invisible (not show))
528 ;; MIME part renderers
530 (defun notmuch-show-multipart/*-to-list (part)
531 (mapcar (lambda (inner-part) (plist-get inner-part :content-type))
532 (plist-get part :content)))
534 (defun notmuch-show-insert-part-multipart/alternative (msg part content-type nth depth button)
535 (let ((chosen-type (car (notmuch-multipart/alternative-choose (notmuch-show-multipart/*-to-list part))))
536 (inner-parts (plist-get part :content))
538 ;; This inserts all parts of the chosen type rather than just one,
539 ;; but it's not clear that this is the wrong thing to do - which
540 ;; should be chosen if there are more than one that match?
541 (mapc (lambda (inner-part)
542 (let* ((inner-type (plist-get inner-part :content-type))
543 (hide (not (or notmuch-show-all-multipart/alternative-parts
544 (string= chosen-type inner-type)))))
545 (notmuch-show-insert-bodypart msg inner-part depth hide)))
548 (when notmuch-show-indent-multipart
549 (indent-rigidly start (point) 1)))
552 (defun notmuch-show-setup-w3m ()
553 "Instruct w3m how to retrieve content from a \"related\" part of a message."
555 (if (boundp 'w3m-cid-retrieve-function-alist)
556 (unless (assq 'notmuch-show-mode w3m-cid-retrieve-function-alist)
557 (push (cons 'notmuch-show-mode 'notmuch-show-w3m-cid-retrieve)
558 w3m-cid-retrieve-function-alist)))
559 (setq mm-inline-text-html-with-images t))
561 (defvar w3m-current-buffer) ;; From `w3m.el'.
562 (defvar notmuch-show-w3m-cid-store nil)
563 (make-variable-buffer-local 'notmuch-show-w3m-cid-store)
565 (defun notmuch-show-w3m-cid-store-internal (content-id msg part content)
566 (push (list content-id msg part content)
567 notmuch-show-w3m-cid-store))
569 (defun notmuch-show-w3m-cid-store (msg part)
570 (let ((content-id (plist-get part :content-id)))
572 (notmuch-show-w3m-cid-store-internal (concat "cid:" content-id)
575 (defun notmuch-show-w3m-cid-retrieve (url &rest args)
576 (let ((matching-part (with-current-buffer w3m-current-buffer
577 (assoc url notmuch-show-w3m-cid-store))))
579 (let* ((msg (nth 1 matching-part))
580 (part (nth 2 matching-part))
581 (content (nth 3 matching-part))
582 (content-type (plist-get part :content-type)))
583 ;; If we don't already have the content, get it and cache
584 ;; it, as some messages reference the same cid: part many
585 ;; times (hundreds!), which results in many calls to
588 (setq content (notmuch-get-bodypart-binary
589 msg part notmuch-show-process-crypto))
590 (with-current-buffer w3m-current-buffer
591 (notmuch-show-w3m-cid-store-internal url msg part content)))
596 (defun notmuch-show-insert-part-multipart/related (msg part content-type nth depth button)
597 (let ((inner-parts (plist-get part :content))
600 ;; We assume that the first part is text/html and the remainder
601 ;; things that it references.
603 ;; Stash the non-primary parts.
605 (notmuch-show-w3m-cid-store msg part))
608 ;; Render the primary part.
609 (notmuch-show-insert-bodypart msg (car inner-parts) depth)
610 ;; Add hidden buttons for the rest
611 (mapc (lambda (inner-part)
612 (notmuch-show-insert-bodypart msg inner-part depth t))
615 (when notmuch-show-indent-multipart
616 (indent-rigidly start (point) 1)))
619 (defun notmuch-show-insert-part-multipart/signed (msg part content-type nth depth button)
620 (button-put button 'face 'notmuch-crypto-part-header)
621 ;; add signature status button if sigstatus provided
622 (if (plist-member part :sigstatus)
623 (let* ((from (notmuch-show-get-header :From msg))
624 (sigstatus (car (plist-get part :sigstatus))))
625 (notmuch-crypto-insert-sigstatus-button sigstatus from))
626 ;; if we're not adding sigstatus, tell the user how they can get it
627 (button-put button 'help-echo "Set notmuch-crypto-process-mime to process cryptographic MIME parts."))
629 (let ((inner-parts (plist-get part :content))
631 ;; Show all of the parts.
632 (mapc (lambda (inner-part)
633 (notmuch-show-insert-bodypart msg inner-part depth))
636 (when notmuch-show-indent-multipart
637 (indent-rigidly start (point) 1)))
640 (defun notmuch-show-insert-part-multipart/encrypted (msg part content-type nth depth button)
641 (button-put button 'face 'notmuch-crypto-part-header)
642 ;; add encryption status button if encstatus specified
643 (if (plist-member part :encstatus)
644 (let ((encstatus (car (plist-get part :encstatus))))
645 (notmuch-crypto-insert-encstatus-button encstatus)
646 ;; add signature status button if sigstatus specified
647 (if (plist-member part :sigstatus)
648 (let* ((from (notmuch-show-get-header :From msg))
649 (sigstatus (car (plist-get part :sigstatus))))
650 (notmuch-crypto-insert-sigstatus-button sigstatus from))))
651 ;; if we're not adding encstatus, tell the user how they can get it
652 (button-put button 'help-echo "Set notmuch-crypto-process-mime to process cryptographic MIME parts."))
654 (let ((inner-parts (plist-get part :content))
656 ;; Show all of the parts.
657 (mapc (lambda (inner-part)
658 (notmuch-show-insert-bodypart msg inner-part depth))
661 (when notmuch-show-indent-multipart
662 (indent-rigidly start (point) 1)))
665 (defun notmuch-show-insert-part-multipart/* (msg part content-type nth depth button)
666 (let ((inner-parts (plist-get part :content))
668 ;; Show all of the parts.
669 (mapc (lambda (inner-part)
670 (notmuch-show-insert-bodypart msg inner-part depth))
673 (when notmuch-show-indent-multipart
674 (indent-rigidly start (point) 1)))
677 (defun notmuch-show-insert-part-message/rfc822 (msg part content-type nth depth button)
678 (let* ((message (car (plist-get part :content)))
679 (body (car (plist-get message :body)))
682 ;; Override `notmuch-message-headers' to force `From' to be
684 (let ((notmuch-message-headers '("From" "Subject" "To" "Cc" "Date")))
685 (notmuch-show-insert-headers (plist-get message :headers)))
687 ;; Blank line after headers to be compatible with the normal
692 (notmuch-show-insert-bodypart msg body depth)
694 (when notmuch-show-indent-multipart
695 (indent-rigidly start (point) 1)))
698 (defun notmuch-show-insert-part-text/plain (msg part content-type nth depth button)
699 ;; For backward compatibility we want to apply the text/plain hook
700 ;; to the whole of the part including the part button if there is
702 (let ((start (if button
703 (button-start button)
705 (insert (notmuch-get-bodypart-text msg part notmuch-show-process-crypto))
708 (narrow-to-region start (point-max))
709 (run-hook-with-args 'notmuch-show-insert-text/plain-hook msg depth))))
712 (defun notmuch-show-insert-part-text/calendar (msg part content-type nth depth button)
713 (insert (with-temp-buffer
714 (insert (notmuch-get-bodypart-text msg part notmuch-show-process-crypto))
715 ;; notmuch-get-bodypart-text does no newline conversion.
716 ;; Replace CRLF with LF before icalendar can use it.
717 (goto-char (point-min))
718 (while (re-search-forward "\r\n" nil t)
719 (replace-match "\n" nil nil))
720 (let ((file (make-temp-file "notmuch-ical"))
724 (unless (icalendar-import-buffer file t)
725 (error "Icalendar import error. See *icalendar-errors* for more information"))
726 (set-buffer (get-file-buffer file))
727 (setq result (buffer-substring (point-min) (point-max)))
728 (set-buffer-modified-p nil)
729 (kill-buffer (current-buffer)))
734 ;; For backwards compatibility.
735 (defun notmuch-show-insert-part-text/x-vcalendar (msg part content-type nth depth button)
736 (notmuch-show-insert-part-text/calendar msg part content-type nth depth button))
738 (defun notmuch-show-get-mime-type-of-application/octet-stream (part)
739 ;; If we can deduce a MIME type from the filename of the attachment,
741 (if (plist-get part :filename)
742 (let ((extension (file-name-extension (plist-get part :filename)))
746 (mailcap-parse-mimetypes)
747 (setq mime-type (mailcap-extension-to-mime extension))
749 (not (string-equal mime-type "application/octet-stream")))
754 (defun notmuch-show-insert-part-text/html (msg part content-type nth depth button)
755 ;; text/html handler to work around bugs in renderers and our
756 ;; invisibile parts code. In particular w3m sets up a keymap which
757 ;; "leaks" outside the invisible region and causes strange effects
758 ;; in notmuch. We set mm-inline-text-html-with-w3m-keymap to nil to
759 ;; tell w3m not to set a keymap (so the normal notmuch-show-mode-map
761 (let ((mm-inline-text-html-with-w3m-keymap nil))
762 (notmuch-show-insert-part-*/* msg part content-type nth depth button)))
764 (defun notmuch-show-insert-part-*/* (msg part content-type nth depth button)
765 ;; This handler _must_ succeed - it is the handler of last resort.
766 (notmuch-mm-display-part-inline msg part content-type notmuch-show-process-crypto)
769 ;; Functions for determining how to handle MIME parts.
771 (defun notmuch-show-handlers-for (content-type)
772 "Return a list of content handlers for a part of type CONTENT-TYPE."
777 ;; Reverse order of prefrence.
778 (list (intern (concat "notmuch-show-insert-part-*/*"))
780 "notmuch-show-insert-part-"
781 (car (notmuch-split-content-type content-type))
783 (intern (concat "notmuch-show-insert-part-" content-type))))
788 (defun notmuch-show-insert-bodypart-internal (msg part content-type nth depth button)
789 (let ((handlers (notmuch-show-handlers-for content-type)))
790 ;; Run the content handlers until one of them returns a non-nil
793 (not (condition-case err
794 (funcall (car handlers) msg part content-type nth depth button)
795 ;; Specifying `debug' here lets the debugger
796 ;; run if `debug-on-error' is non-nil.
799 (insert "!!! Bodypart insert error: ")
800 (insert (error-message-string err))
801 (insert " !!!\n") nil)))))
802 (setq handlers (cdr handlers))))
805 (defun notmuch-show-create-part-overlays (button beg end)
806 "Add an overlay to the part between BEG and END"
808 ;; If there is no button (i.e., the part is text/plain and the first
809 ;; part) or if the part has no content then we don't make the part
811 (when (and button (/= beg end))
812 (button-put button 'overlay (make-overlay beg end))
813 ;; Return true if we created an overlay.
816 (defun notmuch-show-record-part-information (part beg end)
817 "Store PART as a text property from BEG to END"
819 ;; Record part information. Since we already inserted subparts,
820 ;; don't override existing :notmuch-part properties.
821 (notmuch-map-text-property beg end :notmuch-part
822 (lambda (v) (or v part)))
823 ;; Make :notmuch-part front sticky and rear non-sticky so it stays
824 ;; applied to the beginning of each line when we indent the
825 ;; message. Since we're operating on arbitrary renderer output,
826 ;; watch out for sticky specs of t, which means all properties are
827 ;; front-sticky/rear-nonsticky.
828 (notmuch-map-text-property beg end 'front-sticky
829 (lambda (v) (if (listp v)
830 (pushnew :notmuch-part v)
832 (notmuch-map-text-property beg end 'rear-nonsticky
833 (lambda (v) (if (listp v)
834 (pushnew :notmuch-part v)
837 (defun notmuch-show-lazy-part (part-args button)
838 ;; Insert the lazy part after the button for the part. We would just
839 ;; move to the start of the new line following the button and insert
840 ;; the part but that point might have text properties (eg colours
841 ;; from a message header etc) so instead we start from the last
842 ;; character of the button by adding a newline and finish by
843 ;; removing the extra newline from the end of the part.
845 (goto-char (button-end button))
847 (let* ((inhibit-read-only t)
848 ;; We need to use markers for the start and end of the part
849 ;; because the part insertion functions do not guarantee
850 ;; to leave point at the end of the part.
851 (part-beg (copy-marker (point) nil))
852 (part-end (copy-marker (point) t))
853 ;; We have to save the depth as we can't find the depth
855 (depth (notmuch-show-get-depth)))
857 (narrow-to-region part-beg part-end)
858 (delete-region part-beg part-end)
859 (apply #'notmuch-show-insert-bodypart-internal part-args)
860 (indent-rigidly part-beg part-end depth))
863 (notmuch-show-record-part-information (second part-args)
864 (button-start button)
866 ;; Create the overlay. If the lazy-part turned out to be empty/not
867 ;; showable this returns nil.
868 (notmuch-show-create-part-overlays button part-beg part-end))))
870 (defun notmuch-show-insert-bodypart (msg part depth &optional hide)
871 "Insert the body part PART at depth DEPTH in the current thread.
873 HIDE determines whether to show or hide the part and the button
874 as follows: If HIDE is nil, show the part and the button. If HIDE
875 is t, hide the part initially and show the button. If HIDE is
876 'no-buttons, show the part but do not add any buttons (this is
877 useful for quoting in replies)."
879 (let* ((content-type (downcase (plist-get part :content-type)))
880 (mime-type (or (and (string= content-type "application/octet-stream")
881 (notmuch-show-get-mime-type-of-application/octet-stream part))
882 (and (string= content-type "inline patch")
885 (nth (plist-get part :id))
887 ;; Hide the part initially if HIDE is t.
888 (show-part (not (equal hide t)))
889 ;; We omit the part button for the first (or only) part if
890 ;; this is text/plain, or HIDE is 'no-buttons.
891 (button (unless (or (equal hide 'no-buttons)
892 (and (string= mime-type "text/plain") (<= nth 1)))
893 (notmuch-show-insert-part-header nth mime-type content-type (plist-get part :filename))))
894 (content-beg (point)))
896 ;; Store the computed mime-type for later use (e.g. by attachment handlers).
897 (plist-put part :computed-type mime-type)
900 (notmuch-show-insert-bodypart-internal msg part mime-type nth depth button)
901 (button-put button :notmuch-lazy-part
902 (list msg part mime-type nth depth button)))
904 ;; Some of the body part handlers leave point somewhere up in the
905 ;; part, so we make sure that we're down at the end.
906 (goto-char (point-max))
907 ;; Ensure that the part ends with a carriage return.
910 ;; We do not create the overlay for hidden (lazy) parts until
911 ;; they are inserted.
913 (notmuch-show-create-part-overlays button content-beg (point))
915 (notmuch-show-toggle-part-invisibility button)))
916 (notmuch-show-record-part-information part beg (point))))
918 (defun notmuch-show-insert-body (msg body depth)
919 "Insert the body BODY at depth DEPTH in the current thread."
920 (mapc (lambda (part) (notmuch-show-insert-bodypart msg part depth)) body))
922 (defun notmuch-show-make-symbol (type)
923 (make-symbol (concat "notmuch-show-" type)))
925 (defun notmuch-show-strip-re (string)
926 (replace-regexp-in-string "^\\([Rr]e: *\\)+" "" string))
928 (defvar notmuch-show-previous-subject "")
929 (make-variable-buffer-local 'notmuch-show-previous-subject)
931 (defun notmuch-show-insert-msg (msg depth)
932 "Insert the message MSG at depth DEPTH in the current thread."
933 (let* ((headers (plist-get msg :headers))
934 ;; Indentation causes the buffer offset of the start/end
935 ;; points to move, so we must use markers.
936 message-start message-end
937 content-start content-end
938 headers-start headers-end
939 (bare-subject (notmuch-show-strip-re (plist-get headers :Subject))))
941 (setq message-start (point-marker))
943 (notmuch-show-insert-headerline headers
944 (or (if notmuch-show-relative-dates
945 (plist-get msg :date_relative)
947 (plist-get headers :Date))
948 (plist-get msg :tags) depth)
950 (setq content-start (point-marker))
952 ;; Set `headers-start' to point after the 'Subject:' header to be
953 ;; compatible with the existing implementation. This just sets it
954 ;; to after the first header.
955 (notmuch-show-insert-headers headers)
957 (goto-char content-start)
958 ;; If the subject of this message is the same as that of the
959 ;; previous message, don't display it when this message is
961 (when (not (string= notmuch-show-previous-subject
964 (setq headers-start (point-marker)))
965 (setq headers-end (point-marker))
967 (setq notmuch-show-previous-subject bare-subject)
969 ;; A blank line between the headers and the body.
971 (notmuch-show-insert-body msg (plist-get msg :body)
972 (if notmuch-show-indent-content depth 0))
973 ;; Ensure that the body ends with a newline.
976 (setq content-end (point-marker))
978 ;; Indent according to the depth in the thread.
979 (if notmuch-show-indent-content
980 (indent-rigidly content-start content-end (* notmuch-show-indent-messages-width depth)))
982 (setq message-end (point-max-marker))
984 ;; Save the extents of this message over the whole text of the
986 (put-text-property message-start message-end :notmuch-message-extent (cons message-start message-end))
988 ;; Create overlays used to control visibility
989 (plist-put msg :headers-overlay (make-overlay headers-start headers-end))
990 (plist-put msg :message-overlay (make-overlay headers-start content-end))
992 (plist-put msg :depth depth)
994 ;; Save the properties for this message. Currently this saves the
995 ;; entire message (augmented it with other stuff), which seems
996 ;; like overkill. We might save a reduced subset (for example, not
998 (notmuch-show-set-message-properties msg)
1000 ;; Set header visibility.
1001 (notmuch-show-headers-visible msg notmuch-message-headers-visible)
1003 ;; Message visibility depends on whether it matched the search
1005 (notmuch-show-message-visible msg (and (plist-get msg :match)
1006 (not (plist-get msg :excluded))))))
1008 (defun notmuch-show-toggle-process-crypto ()
1009 "Toggle the processing of cryptographic MIME parts."
1011 (setq notmuch-show-process-crypto (not notmuch-show-process-crypto))
1012 (message (if notmuch-show-process-crypto
1013 "Processing cryptographic MIME parts."
1014 "Not processing cryptographic MIME parts."))
1015 (notmuch-show-refresh-view))
1017 (defun notmuch-show-toggle-elide-non-matching ()
1018 "Toggle the display of non-matching messages."
1020 (setq notmuch-show-elide-non-matching-messages (not notmuch-show-elide-non-matching-messages))
1021 (message (if notmuch-show-elide-non-matching-messages
1022 "Showing matching messages only."
1023 "Showing all messages."))
1024 (notmuch-show-refresh-view))
1026 (defun notmuch-show-toggle-thread-indentation ()
1027 "Toggle the indentation of threads."
1029 (setq notmuch-show-indent-content (not notmuch-show-indent-content))
1030 (message (if notmuch-show-indent-content
1031 "Content is indented."
1032 "Content is not indented."))
1033 (notmuch-show-refresh-view))
1035 (defun notmuch-show-insert-tree (tree depth)
1036 "Insert the message tree TREE at depth DEPTH in the current thread."
1037 (let ((msg (car tree))
1038 (replies (cadr tree)))
1039 ;; We test whether there is a message or just some replies.
1041 (notmuch-show-insert-msg msg depth))
1042 (notmuch-show-insert-thread replies (1+ depth))))
1044 (defun notmuch-show-insert-thread (thread depth)
1045 "Insert the thread THREAD at depth DEPTH in the current forest."
1046 (mapc (lambda (tree) (notmuch-show-insert-tree tree depth)) thread))
1048 (defun notmuch-show-insert-forest (forest)
1049 "Insert the forest of threads FOREST."
1050 (mapc (lambda (thread) (notmuch-show-insert-thread thread 0)) forest))
1052 (defvar notmuch-id-regexp
1054 ;; Match the id: prefix only if it begins a word (to disallow, for
1055 ;; example, matching cid:).
1057 ;; If the term starts with a ", then parse Xapian's quoted boolean
1058 ;; term syntax, which allows for anything as long as embedded
1059 ;; double quotes escaped by doubling them. We also disallow
1060 ;; newlines (which Xapian allows) to prevent runaway terms.
1061 "\"\\([^\"\n]\\|\"\"\\)*\""
1062 ;; Otherwise, parse Xapian's unquoted syntax, which goes up to the
1063 ;; next space or ). We disallow [.,;] as the last character
1064 ;; because these are probably part of the surrounding text, and not
1065 ;; part of the id. This doesn't match single character ids; meh.
1066 "\\|[^\"[:space:])][^[:space:])]*[^])[:space:].,:;?!]"
1068 "The regexp used to match id: links in messages.")
1070 (defvar notmuch-mid-regexp
1071 ;; goto-address-url-regexp matched cid: links, which have the same
1072 ;; grammar as the message ID part of a mid: link. Construct the
1073 ;; regexp using the same technique as goto-address-url-regexp.
1074 (concat "\\<mid:\\(" thing-at-point-url-path-regexp "\\)")
1075 "The regexp used to match mid: links in messages.
1079 (defun notmuch-show-buttonise-links (start end)
1080 "Buttonise URLs and mail addresses between START and END.
1082 This also turns id:\"<message id>\"-parts and mid: links into
1083 buttons for a corresponding notmuch search."
1084 (goto-address-fontify-region start end)
1088 (while (re-search-forward notmuch-id-regexp end t)
1089 (push (list (match-beginning 0) (match-end 0)
1090 (match-string-no-properties 0)) links))
1092 (while (re-search-forward notmuch-mid-regexp end t)
1093 (let* ((mid-cid (match-string-no-properties 1))
1094 (mid (save-match-data
1095 (string-match "^[^/]*" mid-cid)
1096 (url-unhex-string (match-string 0 mid-cid)))))
1097 (push (list (match-beginning 0) (match-end 0)
1098 (notmuch-id-to-query mid)) links)))
1099 (dolist (link links)
1100 ;; Remove the overlay created by goto-address-mode
1101 (remove-overlays (first link) (second link) 'goto-address t)
1102 (make-text-button (first link) (second link)
1103 :type 'notmuch-button-type
1104 'action `(lambda (arg)
1105 (notmuch-show ,(third link) current-prefix-arg))
1107 'help-echo "Mouse-1, RET: search for this message"
1108 'face goto-address-mail-face)))))
1111 (defun notmuch-show (thread-id &optional elide-toggle parent-buffer query-context buffer-name)
1112 "Run \"notmuch show\" with the given thread ID and display results.
1114 ELIDE-TOGGLE, if non-nil, inverts the default elide behavior.
1116 The optional PARENT-BUFFER is the notmuch-search buffer from
1117 which this notmuch-show command was executed, (so that the
1118 next thread from that buffer can be show when done with this
1121 The optional QUERY-CONTEXT is a notmuch search term. Only
1122 messages from the thread matching this search term are shown if
1125 The optional BUFFER-NAME provides the name of the buffer in
1126 which the message thread is shown. If it is nil (which occurs
1127 when the command is called interactively) the argument to the
1129 (interactive "sNotmuch show: \nP")
1130 (let ((buffer-name (generate-new-buffer-name
1132 (concat "*notmuch-" thread-id "*")))))
1133 (switch-to-buffer (get-buffer-create buffer-name))
1134 ;; Set the default value for `notmuch-show-process-crypto' in this
1136 (setq notmuch-show-process-crypto notmuch-crypto-process-mime)
1137 ;; Set the default value for
1138 ;; `notmuch-show-elide-non-matching-messages' in this buffer. If
1139 ;; elide-toggle is set, invert the default.
1140 (setq notmuch-show-elide-non-matching-messages notmuch-show-only-matching-messages)
1142 (setq notmuch-show-elide-non-matching-messages (not notmuch-show-elide-non-matching-messages)))
1144 (setq notmuch-show-thread-id thread-id
1145 notmuch-show-parent-buffer parent-buffer
1146 notmuch-show-query-context query-context)
1147 (notmuch-show-build-buffer)
1148 (notmuch-show-goto-first-wanted-message)
1151 (defun notmuch-show-build-buffer ()
1152 (let ((inhibit-read-only t))
1155 (add-hook 'post-command-hook #'notmuch-show-command-hook nil t)
1157 ;; Don't track undo information for this buffer
1158 (set 'buffer-undo-list t)
1160 (notmuch-tag-clear-cache)
1162 (goto-char (point-min))
1164 (let* ((basic-args (list notmuch-show-thread-id))
1165 (args (if notmuch-show-query-context
1166 (append (list "\'") basic-args
1167 (list "and (" notmuch-show-query-context ")\'"))
1168 (append (list "\'") basic-args (list "\'"))))
1169 (cli-args (cons "--exclude=false"
1170 (when notmuch-show-elide-non-matching-messages
1171 (list "--entire-thread=false")))))
1173 (notmuch-show-insert-forest (notmuch-query-get-threads (append cli-args args)))
1174 ;; If the query context reduced the results to nothing, run
1176 (when (and (eq (buffer-size) 0)
1177 notmuch-show-query-context)
1178 (notmuch-show-insert-forest
1179 (notmuch-query-get-threads (append cli-args basic-args)))))
1181 (jit-lock-register #'notmuch-show-buttonise-links)
1183 (notmuch-show-mapc (lambda () (notmuch-show-set-prop :orig-tags (notmuch-show-get-tags))))
1185 ;; Set the header line to the subject of the first message.
1186 (setq header-line-format
1187 (replace-regexp-in-string "%" "%%"
1189 (notmuch-show-strip-re
1190 (notmuch-show-get-subject)))))
1192 (run-hooks 'notmuch-show-hook))))
1194 (defun notmuch-show-capture-state ()
1195 "Capture the state of the current buffer.
1198 - the list of open messages,
1199 - the current message."
1200 (list (notmuch-show-get-message-id) (notmuch-show-get-message-ids-for-open-messages)))
1202 (defun notmuch-show-get-query ()
1203 "Return the current query in this show buffer"
1204 (if notmuch-show-query-context
1205 (concat notmuch-show-thread-id
1207 notmuch-show-query-context
1209 notmuch-show-thread-id))
1211 (defun notmuch-show-apply-state (state)
1212 "Apply STATE to the current buffer.
1215 - opening the messages previously opened,
1216 - closing all other messages,
1217 - moving to the correct current message."
1218 (let ((current (car state))
1219 (open (cadr state)))
1221 ;; Open those that were open.
1222 (goto-char (point-min))
1223 (loop do (notmuch-show-message-visible (notmuch-show-get-message-properties)
1224 (member (notmuch-show-get-message-id) open))
1225 until (not (notmuch-show-goto-message-next)))
1227 ;; Go to the previously open message.
1228 (goto-char (point-min))
1229 (unless (loop if (string= current (notmuch-show-get-message-id))
1231 until (not (notmuch-show-goto-message-next)))
1232 (goto-char (point-min))
1233 (message "Previously current message not found."))
1234 (notmuch-show-message-adjust)))
1236 (defun notmuch-show-refresh-view (&optional reset-state)
1237 "Refresh the current view.
1239 Refreshes the current view, observing changes in display
1240 preferences. If invoked with a prefix argument (or RESET-STATE is
1241 non-nil) then the state of the buffer (open/closed messages) is
1242 reset based on the original query."
1244 (let ((inhibit-read-only t)
1245 (state (unless reset-state
1246 (notmuch-show-capture-state))))
1247 ;; erase-buffer does not seem to remove overlays, which can lead
1248 ;; to weird effects such as remaining images, so remove them
1252 (notmuch-show-build-buffer)
1254 (notmuch-show-apply-state state)
1255 ;; We're resetting state, so navigate to the first open message
1256 ;; and mark it read, just like opening a new show buffer.
1257 (notmuch-show-goto-first-wanted-message))))
1259 (defvar notmuch-show-stash-map
1260 (let ((map (make-sparse-keymap)))
1261 (define-key map "c" 'notmuch-show-stash-cc)
1262 (define-key map "d" 'notmuch-show-stash-date)
1263 (define-key map "F" 'notmuch-show-stash-filename)
1264 (define-key map "f" 'notmuch-show-stash-from)
1265 (define-key map "i" 'notmuch-show-stash-message-id)
1266 (define-key map "I" 'notmuch-show-stash-message-id-stripped)
1267 (define-key map "s" 'notmuch-show-stash-subject)
1268 (define-key map "T" 'notmuch-show-stash-tags)
1269 (define-key map "t" 'notmuch-show-stash-to)
1270 (define-key map "l" 'notmuch-show-stash-mlarchive-link)
1271 (define-key map "L" 'notmuch-show-stash-mlarchive-link-and-go)
1272 (define-key map "G" 'notmuch-show-stash-git-send-email)
1273 (define-key map "?" 'notmuch-subkeymap-help)
1275 "Submap for stash commands")
1276 (fset 'notmuch-show-stash-map notmuch-show-stash-map)
1278 (defvar notmuch-show-part-map
1279 (let ((map (make-sparse-keymap)))
1280 (define-key map "s" 'notmuch-show-save-part)
1281 (define-key map "v" 'notmuch-show-view-part)
1282 (define-key map "o" 'notmuch-show-interactively-view-part)
1283 (define-key map "|" 'notmuch-show-pipe-part)
1284 (define-key map "?" 'notmuch-subkeymap-help)
1286 "Submap for part commands")
1287 (fset 'notmuch-show-part-map notmuch-show-part-map)
1289 (defvar notmuch-show-mode-map
1290 (let ((map (make-sparse-keymap)))
1291 (set-keymap-parent map notmuch-common-keymap)
1292 (define-key map "Z" 'notmuch-tree-from-show-current-query)
1293 (define-key map (kbd "<C-tab>") 'widget-backward)
1294 (define-key map (kbd "M-TAB") 'notmuch-show-previous-button)
1295 (define-key map (kbd "<backtab>") 'notmuch-show-previous-button)
1296 (define-key map (kbd "TAB") 'notmuch-show-next-button)
1297 (define-key map "f" 'notmuch-show-forward-message)
1298 (define-key map "r" 'notmuch-show-reply-sender)
1299 (define-key map "R" 'notmuch-show-reply)
1300 (define-key map "|" 'notmuch-show-pipe-message)
1301 (define-key map "w" 'notmuch-show-save-attachments)
1302 (define-key map "V" 'notmuch-show-view-raw-message)
1303 (define-key map "c" 'notmuch-show-stash-map)
1304 (define-key map "h" 'notmuch-show-toggle-visibility-headers)
1305 (define-key map "*" 'notmuch-show-tag-all)
1306 (define-key map "-" 'notmuch-show-remove-tag)
1307 (define-key map "+" 'notmuch-show-add-tag)
1308 (define-key map "X" 'notmuch-show-archive-thread-then-exit)
1309 (define-key map "x" 'notmuch-show-archive-message-then-next-or-exit)
1310 (define-key map "A" 'notmuch-show-archive-thread-then-next)
1311 (define-key map "a" 'notmuch-show-archive-message-then-next-or-next-thread)
1312 (define-key map "N" 'notmuch-show-next-message)
1313 (define-key map "P" 'notmuch-show-previous-message)
1314 (define-key map "n" 'notmuch-show-next-open-message)
1315 (define-key map "p" 'notmuch-show-previous-open-message)
1316 (define-key map (kbd "M-n") 'notmuch-show-next-thread-show)
1317 (define-key map (kbd "M-p") 'notmuch-show-previous-thread-show)
1318 (define-key map (kbd "DEL") 'notmuch-show-rewind)
1319 (define-key map " " 'notmuch-show-advance-and-archive)
1320 (define-key map (kbd "M-RET") 'notmuch-show-open-or-close-all)
1321 (define-key map (kbd "RET") 'notmuch-show-toggle-message)
1322 (define-key map "#" 'notmuch-show-print-message)
1323 (define-key map "!" 'notmuch-show-toggle-elide-non-matching)
1324 (define-key map "$" 'notmuch-show-toggle-process-crypto)
1325 (define-key map "<" 'notmuch-show-toggle-thread-indentation)
1326 (define-key map "t" 'toggle-truncate-lines)
1327 (define-key map "." 'notmuch-show-part-map)
1329 "Keymap for \"notmuch show\" buffers.")
1330 (fset 'notmuch-show-mode-map notmuch-show-mode-map)
1332 (defun notmuch-show-mode ()
1333 "Major mode for viewing a thread with notmuch.
1335 This buffer contains the results of the \"notmuch show\" command
1336 for displaying a single thread of email from your email archives.
1338 By default, various components of email messages, (citations,
1339 signatures, already-read messages), are hidden. You can make
1340 these parts visible by clicking with the mouse button or by
1341 pressing RET after positioning the cursor on a hidden part, (for
1342 which \\[notmuch-show-next-button] and \\[notmuch-show-previous-button] are helpful).
1344 Reading the thread sequentially is well-supported by pressing
1345 \\[notmuch-show-advance-and-archive]. This will scroll the current message (if necessary), advance
1346 to the next message, or advance to the next thread (if already on
1347 the last message of a thread).
1349 Other commands are available to read or manipulate the thread
1350 more selectively, (such as '\\[notmuch-show-next-message]' and '\\[notmuch-show-previous-message]' to advance to messages
1351 without removing any tags, and '\\[notmuch-show-archive-thread]' to archive an entire thread
1352 without scrolling through with \\[notmuch-show-advance-and-archive]).
1354 You can add or remove arbitrary tags from the current message with
1355 '\\[notmuch-show-add-tag]' or '\\[notmuch-show-remove-tag]'.
1357 All currently available key bindings:
1359 \\{notmuch-show-mode-map}"
1361 (kill-all-local-variables)
1362 (setq notmuch-buffer-refresh-function #'notmuch-show-refresh-view)
1363 (use-local-map notmuch-show-mode-map)
1364 (setq major-mode 'notmuch-show-mode
1365 mode-name "notmuch-show")
1366 (setq buffer-read-only t
1369 (defun notmuch-tree-from-show-current-query ()
1370 "Call notmuch tree with the current query"
1372 (notmuch-tree notmuch-show-thread-id
1373 notmuch-show-query-context
1374 (notmuch-show-get-message-id)))
1376 (defun notmuch-show-move-to-message-top ()
1377 (goto-char (notmuch-show-message-top)))
1379 (defun notmuch-show-move-to-message-bottom ()
1380 (goto-char (notmuch-show-message-bottom)))
1382 (defun notmuch-show-message-adjust ()
1385 ;; Movement related functions.
1387 ;; There's some strangeness here where a text property applied to a
1388 ;; region a->b is not found when point is at b. We walk backwards
1389 ;; until finding the property.
1390 (defun notmuch-show-message-extent ()
1393 (while (not (setq r (get-text-property (point) :notmuch-message-extent)))
1397 (defun notmuch-show-message-top ()
1398 (car (notmuch-show-message-extent)))
1400 (defun notmuch-show-message-bottom ()
1401 (cdr (notmuch-show-message-extent)))
1403 (defun notmuch-show-goto-message-next ()
1404 (let ((start (point)))
1405 (notmuch-show-move-to-message-bottom)
1411 (defun notmuch-show-goto-message-previous ()
1412 (notmuch-show-move-to-message-top)
1416 (notmuch-show-move-to-message-top)
1419 (defun notmuch-show-mapc (function)
1420 "Iterate through all messages in the current thread with
1421 `notmuch-show-goto-message-next' and call FUNCTION for side
1424 (goto-char (point-min))
1425 (loop do (funcall function)
1426 while (notmuch-show-goto-message-next))))
1428 ;; Functions relating to the visibility of messages and their
1431 (defun notmuch-show-message-visible (props visible-p)
1432 (overlay-put (plist-get props :message-overlay) 'invisible (not visible-p))
1433 (notmuch-show-set-prop :message-visible visible-p props))
1435 (defun notmuch-show-headers-visible (props visible-p)
1436 (overlay-put (plist-get props :headers-overlay) 'invisible (not visible-p))
1437 (notmuch-show-set-prop :headers-visible visible-p props))
1439 ;; Functions for setting and getting attributes of the current
1442 (defun notmuch-show-set-message-properties (props)
1444 (notmuch-show-move-to-message-top)
1445 (put-text-property (point) (+ (point) 1) :notmuch-message-properties props)))
1447 (defun notmuch-show-get-message-properties ()
1448 "Return the properties of the current message as a plist.
1450 Some useful entries are:
1451 :headers - Property list containing the headers :Date, :Subject, :From, etc.
1452 :body - Body of the message
1453 :tags - Tags for this message"
1455 (notmuch-show-move-to-message-top)
1456 (get-text-property (point) :notmuch-message-properties)))
1458 (defun notmuch-show-get-part-properties ()
1459 "Return the properties of the innermost part containing point.
1461 This is the part property list retrieved from the CLI. Signals
1462 an error if there is no part containing point."
1463 (or (get-text-property (point) :notmuch-part)
1464 (error "No message part here")))
1466 (defun notmuch-show-set-prop (prop val &optional props)
1467 (let ((inhibit-read-only t)
1469 (notmuch-show-get-message-properties))))
1470 (plist-put props prop val)
1471 (notmuch-show-set-message-properties props)))
1473 (defun notmuch-show-get-prop (prop &optional props)
1474 "Get property PROP from current message in show or tree mode.
1476 It gets property PROP from PROPS or, if PROPS is nil, the current
1477 message in either tree or show. This means that several utility
1478 functions in notmuch-show can be used directly by notmuch-tree as
1479 they just need the correct message properties."
1480 (let ((props (or props
1481 (cond ((eq major-mode 'notmuch-show-mode)
1482 (notmuch-show-get-message-properties))
1483 ((eq major-mode 'notmuch-tree-mode)
1484 (notmuch-tree-get-message-properties))
1486 (plist-get props prop)))
1488 (defun notmuch-show-get-message-id (&optional bare)
1489 "Return an id: query for the Message-Id of the current message.
1491 If optional argument BARE is non-nil, return
1492 the Message-Id without id: prefix and escaping."
1494 (notmuch-show-get-prop :id)
1495 (notmuch-id-to-query (notmuch-show-get-prop :id))))
1497 (defun notmuch-show-get-messages-ids ()
1498 "Return all id: queries of messages in the current thread."
1499 (let ((message-ids))
1501 (lambda () (push (notmuch-show-get-message-id) message-ids)))
1504 (defun notmuch-show-get-messages-ids-search ()
1505 "Return a search string for all message ids of messages in the
1507 (mapconcat 'identity (notmuch-show-get-messages-ids) " or "))
1509 ;; dme: Would it make sense to use a macro for many of these?
1511 (defun notmuch-show-get-filename ()
1512 "Return the filename of the current message."
1513 (notmuch-show-get-prop :filename))
1515 (defun notmuch-show-get-header (header &optional props)
1516 "Return the named header of the current message, if any."
1517 (plist-get (notmuch-show-get-prop :headers props) header))
1519 (defun notmuch-show-get-cc ()
1520 (notmuch-show-get-header :Cc))
1522 (defun notmuch-show-get-date ()
1523 (notmuch-show-get-header :Date))
1525 (defun notmuch-show-get-from ()
1526 (notmuch-show-get-header :From))
1528 (defun notmuch-show-get-subject ()
1529 (notmuch-show-get-header :Subject))
1531 (defun notmuch-show-get-to ()
1532 (notmuch-show-get-header :To))
1534 (defun notmuch-show-get-depth ()
1535 (notmuch-show-get-prop :depth))
1537 (defun notmuch-show-set-tags (tags)
1538 "Set the tags of the current message."
1539 (notmuch-show-set-prop :tags tags)
1540 (notmuch-show-update-tags tags))
1542 (defun notmuch-show-get-tags ()
1543 "Return the tags of the current message."
1544 (notmuch-show-get-prop :tags))
1546 (defun notmuch-show-message-visible-p ()
1547 "Is the current message visible?"
1548 (notmuch-show-get-prop :message-visible))
1550 (defun notmuch-show-headers-visible-p ()
1551 "Are the headers of the current message visible?"
1552 (notmuch-show-get-prop :headers-visible))
1554 (put 'notmuch-show-mark-read 'notmuch-prefix-doc
1555 "Mark the current message as unread.")
1556 (defun notmuch-show-mark-read (&optional unread)
1557 "Mark the current message as read.
1559 Mark the current message as read by applying the tag changes in
1560 `notmuch-show-mark-read-tags' to it (remove the \"unread\" tag by
1561 default). If a prefix argument is given, the message will be
1562 marked as unread, i.e. the tag changes in
1563 `notmuch-show-mark-read-tags' will be reversed."
1565 (when notmuch-show-mark-read-tags
1566 (apply 'notmuch-show-tag-message
1567 (notmuch-tag-change-list notmuch-show-mark-read-tags unread))))
1569 (defun notmuch-show-seen-current-message (start end)
1570 "Mark the current message read if it is open.
1572 We only mark it read once: if it is changed back then that is a
1573 user decision and we should not override it."
1574 (when (and (notmuch-show-message-visible-p)
1575 (not (notmuch-show-get-prop :seen)))
1576 (notmuch-show-mark-read)
1577 (notmuch-show-set-prop :seen t)))
1579 (defun notmuch-show-command-hook ()
1580 (when (eq major-mode 'notmuch-show-mode)
1581 ;; We need to redisplay to get window-start and window-end correct.
1584 (funcall notmuch-show-mark-read-function (window-start) (window-end)))))
1586 ;; Functions for getting attributes of several messages in the current
1589 (defun notmuch-show-get-message-ids-for-open-messages ()
1590 "Return a list of all id: queries for open messages in the current thread."
1592 (let (message-ids done)
1593 (goto-char (point-min))
1595 (if (notmuch-show-message-visible-p)
1596 (setq message-ids (append message-ids (list (notmuch-show-get-message-id)))))
1597 (setq done (not (notmuch-show-goto-message-next)))
1602 ;; Commands typically bound to keys.
1604 (defun notmuch-show-advance ()
1605 "Advance through thread.
1607 If the current message in the thread is not yet fully visible,
1608 scroll by a near screenful to read more of the message.
1610 Otherwise, (the end of the current message is already within the
1611 current window), advance to the next open message."
1613 (let* ((end-of-this-message (notmuch-show-message-bottom))
1614 (visible-end-of-this-message (1- end-of-this-message))
1616 (while (invisible-p visible-end-of-this-message)
1617 (setq visible-end-of-this-message
1619 (1- (previous-single-char-property-change
1620 visible-end-of-this-message 'invisible)))))
1622 ;; Ideally we would test `end-of-this-message' against the result
1623 ;; of `window-end', but that doesn't account for the fact that
1624 ;; the end of the message might be hidden.
1625 ((and visible-end-of-this-message
1626 (> visible-end-of-this-message (window-end)))
1627 ;; The bottom of this message is not visible - scroll.
1630 ((not (= end-of-this-message (point-max)))
1631 ;; This is not the last message - move to the next visible one.
1632 (notmuch-show-next-open-message))
1634 ((not (= (point) (point-max)))
1635 ;; This is the last message, but the cursor is not at the end of
1636 ;; the buffer. Move it there.
1637 (goto-char (point-max)))
1640 ;; This is the last message - change the return value
1644 (defun notmuch-show-advance-and-archive ()
1645 "Advance through thread and archive.
1647 This command is intended to be one of the simplest ways to
1648 process a thread of email. It works exactly like
1649 notmuch-show-advance, in that it scrolls through messages in a
1650 show buffer, except that when it gets to the end of the buffer it
1651 archives the entire current thread, (apply changes in
1652 `notmuch-archive-tags'), kills the buffer, and displays the next
1653 thread from the search from which this thread was originally
1656 (if (notmuch-show-advance)
1657 (notmuch-show-archive-thread-then-next)))
1659 (defun notmuch-show-rewind ()
1660 "Backup through the thread (reverse scrolling compared to \\[notmuch-show-advance-and-archive]).
1662 Specifically, if the beginning of the previous email is fewer
1663 than `window-height' lines from the current point, move to it
1664 just like `notmuch-show-previous-message'.
1666 Otherwise, just scroll down a screenful of the current message.
1668 This command does not modify any message tags, (it does not undo
1669 any effects from previous calls to
1670 `notmuch-show-advance-and-archive'."
1672 (let ((start-of-message (notmuch-show-message-top))
1673 (start-of-window (window-start)))
1675 ;; Either this message is properly aligned with the start of the
1676 ;; window or the start of this message is not visible on the
1678 ((or (= start-of-message start-of-window)
1679 (< start-of-message start-of-window))
1681 ;; If a small number of lines from the previous message are
1682 ;; visible, realign so that the top of the current message is at
1683 ;; the top of the screen.
1684 (when (<= (count-screen-lines (window-start) start-of-message)
1685 next-screen-context-lines)
1686 (goto-char (notmuch-show-message-top))
1687 (notmuch-show-message-adjust))
1688 ;; Move to the top left of the window.
1689 (goto-char (window-start)))
1691 ;; Move to the previous message.
1692 (notmuch-show-previous-message)))))
1694 (put 'notmuch-show-reply 'notmuch-prefix-doc "... and prompt for sender")
1695 (defun notmuch-show-reply (&optional prompt-for-sender)
1696 "Reply to the sender and all recipients of the current message."
1698 (notmuch-mua-new-reply (notmuch-show-get-message-id) prompt-for-sender t))
1700 (put 'notmuch-show-reply-sender 'notmuch-prefix-doc "... and prompt for sender")
1701 (defun notmuch-show-reply-sender (&optional prompt-for-sender)
1702 "Reply to the sender of the current message."
1704 (notmuch-mua-new-reply (notmuch-show-get-message-id) prompt-for-sender nil))
1706 (put 'notmuch-show-forward-message 'notmuch-prefix-doc
1707 "... and prompt for sender")
1708 (defun notmuch-show-forward-message (&optional prompt-for-sender)
1709 "Forward the current message."
1711 (with-current-notmuch-show-message
1712 (notmuch-mua-new-forward-message prompt-for-sender)))
1714 (defun notmuch-show-next-message (&optional pop-at-end)
1715 "Show the next message.
1717 If a prefix argument is given and this is the last message in the
1718 thread, navigate to the next thread in the parent search buffer."
1720 (if (notmuch-show-goto-message-next)
1721 (notmuch-show-message-adjust)
1723 (notmuch-show-next-thread)
1724 (goto-char (point-max)))))
1726 (defun notmuch-show-previous-message ()
1727 "Show the previous message or the start of the current message."
1729 (if (= (point) (notmuch-show-message-top))
1730 (notmuch-show-goto-message-previous)
1731 (notmuch-show-move-to-message-top))
1732 (notmuch-show-message-adjust))
1734 (defun notmuch-show-next-open-message (&optional pop-at-end)
1735 "Show the next open message.
1737 If a prefix argument is given and this is the last open message
1738 in the thread, navigate to the next thread in the parent search
1739 buffer. Return t if there was a next open message in the thread
1740 to show, nil otherwise."
1743 (while (and (setq r (notmuch-show-goto-message-next))
1744 (not (notmuch-show-message-visible-p))))
1746 (notmuch-show-message-adjust)
1748 (notmuch-show-next-thread)
1749 (goto-char (point-max))))
1752 (defun notmuch-show-next-matching-message ()
1753 "Show the next matching message."
1756 (while (and (setq r (notmuch-show-goto-message-next))
1757 (not (notmuch-show-get-prop :match))))
1759 (notmuch-show-message-adjust)
1760 (goto-char (point-max)))))
1762 (defun notmuch-show-open-if-matched ()
1763 "Open a message if it is matched (whether or not excluded)."
1764 (let ((props (notmuch-show-get-message-properties)))
1765 (notmuch-show-message-visible props (plist-get props :match))))
1767 (defun notmuch-show-goto-first-wanted-message ()
1768 "Move to the first open message and mark it read"
1769 (goto-char (point-min))
1770 (unless (notmuch-show-message-visible-p)
1771 (notmuch-show-next-open-message))
1773 ;; There are no matched non-excluded messages so open all matched
1774 ;; (necessarily excluded) messages and go to the first.
1775 (notmuch-show-mapc 'notmuch-show-open-if-matched)
1776 (force-window-update)
1777 (goto-char (point-min))
1778 (unless (notmuch-show-message-visible-p)
1779 (notmuch-show-next-open-message))))
1781 (defun notmuch-show-previous-open-message ()
1782 "Show the previous open message."
1784 (while (and (if (= (point) (notmuch-show-message-top))
1785 (notmuch-show-goto-message-previous)
1786 (notmuch-show-move-to-message-top))
1787 (not (notmuch-show-message-visible-p))))
1788 (notmuch-show-message-adjust))
1790 (defun notmuch-show-view-raw-message ()
1791 "View the original source of the current message."
1793 (let* ((id (notmuch-show-get-message-id))
1794 (buf (get-buffer-create (concat "*notmuch-raw-" id "*"))))
1795 (let ((coding-system-for-read 'no-conversion))
1796 (call-process notmuch-command nil buf nil "show" "--format=raw" id))
1797 (switch-to-buffer buf)
1798 (goto-char (point-min))
1799 (set-buffer-modified-p nil)
1800 (view-buffer buf 'kill-buffer-if-not-modified)))
1802 (put 'notmuch-show-pipe-message 'notmuch-doc
1803 "Pipe the contents of the current message to a command.")
1804 (put 'notmuch-show-pipe-message 'notmuch-prefix-doc
1805 "Pipe the thread as an mbox to a command.")
1806 (defun notmuch-show-pipe-message (entire-thread command)
1807 "Pipe the contents of the current message (or thread) to COMMAND.
1809 COMMAND will be executed with the raw contents of the current
1810 email message as stdin. Anything printed by the command to stdout
1811 or stderr will appear in the *notmuch-pipe* buffer.
1813 If ENTIRE-THREAD is non-nil (or when invoked with a prefix
1814 argument), COMMAND will receive all open messages in the current
1815 thread (formatted as an mbox) rather than only the current
1817 (interactive (let ((query-string (if current-prefix-arg
1818 "Pipe all open messages to command: "
1819 "Pipe message to command: ")))
1820 (list current-prefix-arg (read-string query-string))))
1821 (let (shell-command)
1824 (concat notmuch-command " show --format=mbox --exclude=false "
1825 (shell-quote-argument
1826 (mapconcat 'identity (notmuch-show-get-message-ids-for-open-messages) " OR "))
1829 (concat notmuch-command " show --format=raw "
1830 (shell-quote-argument (notmuch-show-get-message-id)) " | " command)))
1831 (let ((cwd default-directory)
1832 (buf (get-buffer-create (concat "*notmuch-pipe*"))))
1833 (with-current-buffer buf
1834 (setq buffer-read-only nil)
1836 ;; Use the originating buffer's working directory instead of
1837 ;; that of the pipe buffer.
1839 (let ((exit-code (call-process-shell-command shell-command nil buf)))
1840 (goto-char (point-max))
1841 (set-buffer-modified-p nil)
1842 (setq buffer-read-only t)
1843 (unless (zerop exit-code)
1844 (switch-to-buffer-other-window buf)
1845 (message (format "Command '%s' exited abnormally with code %d"
1846 shell-command exit-code))))))))
1848 (defun notmuch-show-tag-message (&rest tag-changes)
1849 "Change tags for the current message.
1851 TAG-CHANGES is a list of tag operations for `notmuch-tag'."
1852 (let* ((current-tags (notmuch-show-get-tags))
1853 (new-tags (notmuch-update-tags current-tags tag-changes)))
1854 (unless (equal current-tags new-tags)
1855 (notmuch-tag (notmuch-show-get-message-id) tag-changes)
1856 (notmuch-show-set-tags new-tags))))
1858 (defun notmuch-show-tag (tag-changes)
1859 "Change tags for the current message.
1861 See `notmuch-tag' for information on the format of TAG-CHANGES."
1862 (interactive (list (notmuch-read-tag-changes (notmuch-show-get-tags)
1864 (notmuch-tag (notmuch-show-get-message-id) tag-changes)
1865 (let* ((current-tags (notmuch-show-get-tags))
1866 (new-tags (notmuch-update-tags current-tags tag-changes)))
1867 (unless (equal current-tags new-tags)
1868 (notmuch-show-set-tags new-tags))))
1870 (defun notmuch-show-tag-all (tag-changes)
1871 "Change tags for all messages in the current show buffer.
1873 See `notmuch-tag' for information on the format of TAG-CHANGES."
1877 (lambda () (setq tags (append (notmuch-show-get-tags) tags))))
1878 (notmuch-read-tag-changes tags "Tag thread"))))
1879 (notmuch-tag (notmuch-show-get-messages-ids-search) tag-changes)
1882 (let* ((current-tags (notmuch-show-get-tags))
1883 (new-tags (notmuch-update-tags current-tags tag-changes)))
1884 (unless (equal current-tags new-tags)
1885 (notmuch-show-set-tags new-tags))))))
1887 (defun notmuch-show-add-tag (tag-changes)
1888 "Change tags for the current message (defaulting to add).
1890 Same as `notmuch-show-tag' but sets initial input to '+'."
1892 (list (notmuch-read-tag-changes (notmuch-show-get-tags) "Tag message" "+")))
1893 (notmuch-show-tag tag-changes))
1895 (defun notmuch-show-remove-tag (tag-changes)
1896 "Change tags for the current message (defaulting to remove).
1898 Same as `notmuch-show-tag' but sets initial input to '-'."
1900 (list (notmuch-read-tag-changes (notmuch-show-get-tags) "Tag message" "-")))
1901 (notmuch-show-tag tag-changes))
1903 (defun notmuch-show-toggle-visibility-headers ()
1904 "Toggle the visibility of the current message headers."
1906 (let ((props (notmuch-show-get-message-properties)))
1907 (notmuch-show-headers-visible
1909 (not (plist-get props :headers-visible))))
1910 (force-window-update))
1912 (defun notmuch-show-toggle-message ()
1913 "Toggle the visibility of the current message."
1915 (let ((props (notmuch-show-get-message-properties)))
1916 (notmuch-show-message-visible
1918 (not (plist-get props :message-visible))))
1919 (force-window-update))
1921 (put 'notmuch-show-open-or-close-all 'notmuch-doc "Show all messages.")
1922 (put 'notmuch-show-open-or-close-all 'notmuch-prefix-doc "Hide all messages.")
1923 (defun notmuch-show-open-or-close-all ()
1924 "Set the visibility all of the messages in the current thread.
1926 By default make all of the messages visible. With a prefix
1927 argument, hide all of the messages."
1930 (goto-char (point-min))
1931 (loop do (notmuch-show-message-visible (notmuch-show-get-message-properties)
1932 (not current-prefix-arg))
1933 until (not (notmuch-show-goto-message-next))))
1934 (force-window-update))
1936 (defun notmuch-show-next-button ()
1937 "Advance point to the next button in the buffer."
1941 (defun notmuch-show-previous-button ()
1942 "Move point back to the previous button in the buffer."
1944 (backward-button 1))
1946 (defun notmuch-show-next-thread (&optional show previous)
1947 "Move to the next item in the search results, if any.
1949 If SHOW is non-nil, open the next item in a show
1950 buffer. Otherwise just highlight the next item in the search
1951 buffer. If PREVIOUS is non-nil, move to the previous item in the
1952 search results instead."
1954 (let ((parent-buffer notmuch-show-parent-buffer))
1955 (notmuch-bury-or-kill-this-buffer)
1956 (when (buffer-live-p parent-buffer)
1957 (switch-to-buffer parent-buffer)
1959 (notmuch-search-previous-thread)
1960 (notmuch-search-next-thread))
1962 (notmuch-search-show-thread)))))
1964 (defun notmuch-show-next-thread-show ()
1965 "Show the next thread in the search results, if any."
1967 (notmuch-show-next-thread t))
1969 (defun notmuch-show-previous-thread-show ()
1970 "Show the previous thread in the search results, if any."
1972 (notmuch-show-next-thread t t))
1974 (put 'notmuch-show-archive-thread 'notmuch-prefix-doc
1975 "Un-archive each message in thread.")
1976 (defun notmuch-show-archive-thread (&optional unarchive)
1977 "Archive each message in thread.
1979 Archive each message currently shown by applying the tag changes
1980 in `notmuch-archive-tags' to each. If a prefix argument is given,
1981 the messages will be \"unarchived\", i.e. the tag changes in
1982 `notmuch-archive-tags' will be reversed.
1984 Note: This command is safe from any race condition of new messages
1985 being delivered to the same thread. It does not archive the
1986 entire thread, but only the messages shown in the current
1989 (when notmuch-archive-tags
1990 (notmuch-show-tag-all
1991 (notmuch-tag-change-list notmuch-archive-tags unarchive))))
1993 (defun notmuch-show-archive-thread-then-next ()
1994 "Archive all messages in the current buffer, then show next thread from search."
1996 (notmuch-show-archive-thread)
1997 (notmuch-show-next-thread t))
1999 (defun notmuch-show-archive-thread-then-exit ()
2000 "Archive all messages in the current buffer, then exit back to search results."
2002 (notmuch-show-archive-thread)
2003 (notmuch-show-next-thread))
2005 (put 'notmuch-show-archive-message 'notmuch-prefix-doc
2006 "Un-archive the current message.")
2007 (defun notmuch-show-archive-message (&optional unarchive)
2008 "Archive the current message.
2010 Archive the current message by applying the tag changes in
2011 `notmuch-archive-tags' to it. If a prefix argument is given, the
2012 message will be \"unarchived\", i.e. the tag changes in
2013 `notmuch-archive-tags' will be reversed."
2015 (when notmuch-archive-tags
2016 (apply 'notmuch-show-tag-message
2017 (notmuch-tag-change-list notmuch-archive-tags unarchive))))
2019 (defun notmuch-show-archive-message-then-next-or-exit ()
2020 "Archive the current message, then show the next open message in the current thread.
2022 If at the last open message in the current thread, then exit back
2025 (notmuch-show-archive-message)
2026 (notmuch-show-next-open-message t))
2028 (defun notmuch-show-archive-message-then-next-or-next-thread ()
2029 "Archive the current message, then show the next open message in the current thread.
2031 If at the last open message in the current thread, then show next
2032 thread from search."
2034 (notmuch-show-archive-message)
2035 (unless (notmuch-show-next-open-message)
2036 (notmuch-show-next-thread t)))
2038 (defun notmuch-show-stash-cc ()
2039 "Copy CC field of current message to kill-ring."
2041 (notmuch-common-do-stash (notmuch-show-get-cc)))
2043 (defun notmuch-show-stash-date ()
2044 "Copy date of current message to kill-ring."
2046 (notmuch-common-do-stash (notmuch-show-get-date)))
2048 (defun notmuch-show-stash-filename ()
2049 "Copy filename of current message to kill-ring."
2051 (notmuch-common-do-stash (notmuch-show-get-filename)))
2053 (defun notmuch-show-stash-from ()
2054 "Copy From address of current message to kill-ring."
2056 (notmuch-common-do-stash (notmuch-show-get-from)))
2058 (put 'notmuch-show-stash-message-id 'notmuch-prefix-doc
2059 "Copy thread: query matching current thread to kill-ring.")
2060 (defun notmuch-show-stash-message-id (&optional stash-thread-id)
2061 "Copy id: query matching the current message to kill-ring.
2063 If invoked with a prefix argument (or STASH-THREAD-ID is
2064 non-nil), copy thread: query matching the current thread to
2068 (notmuch-common-do-stash notmuch-show-thread-id)
2069 (notmuch-common-do-stash (notmuch-show-get-message-id))))
2071 (defun notmuch-show-stash-message-id-stripped ()
2072 "Copy message ID of current message (sans `id:' prefix) to kill-ring."
2074 (notmuch-common-do-stash (notmuch-show-get-message-id t)))
2076 (defun notmuch-show-stash-subject ()
2077 "Copy Subject field of current message to kill-ring."
2079 (notmuch-common-do-stash (notmuch-show-get-subject)))
2081 (defun notmuch-show-stash-tags ()
2082 "Copy tags of current message to kill-ring as a comma separated list."
2084 (notmuch-common-do-stash (mapconcat 'identity (notmuch-show-get-tags) ",")))
2086 (defun notmuch-show-stash-to ()
2087 "Copy To address of current message to kill-ring."
2089 (notmuch-common-do-stash (notmuch-show-get-to)))
2091 (defun notmuch-show-stash-mlarchive-link (&optional mla)
2092 "Copy an ML Archive URI for the current message to the kill-ring.
2094 This presumes that the message is available at the selected Mailing List Archive.
2096 If optional argument MLA is non-nil, use the provided key instead of prompting
2097 the user (see `notmuch-show-stash-mlarchive-link-alist')."
2099 (let ((url (cdr (assoc
2101 (let ((completion-ignore-case t))
2103 "Mailing List Archive: "
2104 notmuch-show-stash-mlarchive-link-alist
2106 notmuch-show-stash-mlarchive-link-default)))
2107 notmuch-show-stash-mlarchive-link-alist))))
2108 (notmuch-common-do-stash
2110 (funcall url (notmuch-show-get-message-id t))
2111 (concat url (notmuch-show-get-message-id t))))))
2113 (defun notmuch-show-stash-mlarchive-link-and-go (&optional mla)
2114 "Copy an ML Archive URI for the current message to the kill-ring and visit it.
2116 This presumes that the message is available at the selected Mailing List Archive.
2118 If optional argument MLA is non-nil, use the provided key instead of prompting
2119 the user (see `notmuch-show-stash-mlarchive-link-alist')."
2121 (notmuch-show-stash-mlarchive-link mla)
2122 (browse-url (current-kill 0 t)))
2124 (defun notmuch-show-stash-git-helper (addresses prefix)
2125 "Escape, trim, quote, and add PREFIX to each address in list of ADDRESSES, and return the result as a single string."
2126 (mapconcat (lambda (x)
2128 ;; escape double-quotes
2129 (replace-regexp-in-string
2131 ;; trim leading and trailing spaces
2132 (replace-regexp-in-string
2133 "\\(^ *\\| *$\\)" ""
2137 (put 'notmuch-show-stash-git-send-email 'notmuch-prefix-doc
2138 "Copy From/To/Cc of current message to kill-ring in a form suitable for pasting to git send-email command line.")
2140 (defun notmuch-show-stash-git-send-email (&optional no-in-reply-to)
2141 "Copy From/To/Cc/Message-Id of current message to kill-ring in a form suitable for pasting to git send-email command line.
2143 If invoked with a prefix argument (or NO-IN-REPLY-TO is non-nil),
2144 omit --in-reply-to=<Message-Id>."
2146 (notmuch-common-do-stash
2147 (mapconcat 'identity
2150 (notmuch-show-stash-git-helper
2151 (message-tokenize-header (notmuch-show-get-from)) "--to=")
2152 (notmuch-show-stash-git-helper
2153 (message-tokenize-header (notmuch-show-get-to)) "--to=")
2154 (notmuch-show-stash-git-helper
2155 (message-tokenize-header (notmuch-show-get-cc)) "--cc=")
2156 (unless no-in-reply-to
2157 (notmuch-show-stash-git-helper
2158 (list (notmuch-show-get-message-id t)) "--in-reply-to="))))
2161 ;; Interactive part functions and their helpers
2163 (defun notmuch-show-generate-part-buffer (msg part)
2164 "Return a temporary buffer containing the specified part's content."
2165 (let ((buf (generate-new-buffer " *notmuch-part*"))
2166 (process-crypto notmuch-show-process-crypto))
2167 (with-current-buffer buf
2168 ;; This is always used in the content of mm handles, which
2169 ;; expect undecoded, binary part content.
2170 (insert (notmuch-get-bodypart-binary msg part process-crypto)))
2173 (defun notmuch-show-current-part-handle ()
2174 "Return an mm-handle for the part containing point.
2176 This creates a temporary buffer for the part's content; the
2177 caller is responsible for killing this buffer as appropriate."
2178 (let* ((msg (notmuch-show-get-message-properties))
2179 (part (notmuch-show-get-part-properties))
2180 (buf (notmuch-show-generate-part-buffer msg part))
2181 (computed-type (plist-get part :computed-type))
2182 (filename (plist-get part :filename))
2183 (disposition (if filename `(attachment (filename . ,filename)))))
2184 (mm-make-handle buf (list computed-type) nil nil disposition)))
2186 (defun notmuch-show-apply-to-current-part-handle (fn)
2187 "Apply FN to an mm-handle for the part containing point.
2189 This ensures that the temporary buffer created for the mm-handle
2190 is destroyed when FN returns."
2191 (let ((handle (notmuch-show-current-part-handle)))
2192 ;; emacs 24.3+ puts stdout/stderr into the calling buffer so we
2193 ;; call it from a temp-buffer, unless
2194 ;; notmuch-show-attachment-debug is non-nil in which case we put
2195 ;; it in " *notmuch-part*".
2197 (if notmuch-show-attachment-debug
2198 (with-current-buffer (generate-new-buffer " *notmuch-part*")
2199 (funcall fn handle))
2201 (funcall fn handle)))
2202 (kill-buffer (mm-handle-buffer handle)))))
2204 (defun notmuch-show-part-button-default (&optional button)
2206 (let ((button (or button (button-at (point)))))
2207 ;; Try to toggle the part, if that fails then call the default
2208 ;; action. The toggle fails if the part has no emacs renderable
2210 (unless (notmuch-show-toggle-part-invisibility button)
2211 (call-interactively notmuch-show-part-button-default-action))))
2213 (defun notmuch-show-save-part ()
2214 "Save the MIME part containing point to a file."
2216 (notmuch-show-apply-to-current-part-handle #'mm-save-part))
2218 (defun notmuch-show-view-part ()
2219 "View the MIME part containing point in an external viewer."
2221 ;; Set mm-inlined-types to nil to force an external viewer
2222 (let ((mm-inlined-types nil))
2223 (notmuch-show-apply-to-current-part-handle #'mm-display-part)))
2225 (defun notmuch-show-interactively-view-part ()
2226 "View the MIME part containing point, prompting for a viewer."
2228 (notmuch-show-apply-to-current-part-handle #'mm-interactively-view-part))
2230 (defun notmuch-show-pipe-part ()
2231 "Pipe the MIME part containing point to an external command."
2233 (notmuch-show-apply-to-current-part-handle #'mm-pipe-part))
2236 (provide 'notmuch-show)