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 (message-id (plist-get msg :id))
583 (part-number (plist-get part :id))
584 (content-type (plist-get part :content-type)))
585 ;; If we don't already have the content, get it and cache
586 ;; it, as some messages reference the same cid: part many
587 ;; times (hundreds!), which results in many calls to
590 (setq content (notmuch-get-bodypart-internal (notmuch-id-to-query message-id)
591 part-number notmuch-show-process-crypto))
592 (with-current-buffer w3m-current-buffer
593 (notmuch-show-w3m-cid-store-internal url msg part content)))
598 (defun notmuch-show-insert-part-multipart/related (msg part content-type nth depth button)
599 (let ((inner-parts (plist-get part :content))
602 ;; We assume that the first part is text/html and the remainder
603 ;; things that it references.
605 ;; Stash the non-primary parts.
607 (notmuch-show-w3m-cid-store msg part))
610 ;; Render the primary part.
611 (notmuch-show-insert-bodypart msg (car inner-parts) depth)
612 ;; Add hidden buttons for the rest
613 (mapc (lambda (inner-part)
614 (notmuch-show-insert-bodypart msg inner-part depth t))
617 (when notmuch-show-indent-multipart
618 (indent-rigidly start (point) 1)))
621 (defun notmuch-show-insert-part-multipart/signed (msg part content-type nth depth button)
622 (button-put button 'face 'notmuch-crypto-part-header)
623 ;; add signature status button if sigstatus provided
624 (if (plist-member part :sigstatus)
625 (let* ((from (notmuch-show-get-header :From msg))
626 (sigstatus (car (plist-get part :sigstatus))))
627 (notmuch-crypto-insert-sigstatus-button sigstatus from))
628 ;; if we're not adding sigstatus, tell the user how they can get it
629 (button-put button 'help-echo "Set notmuch-crypto-process-mime to process cryptographic MIME parts."))
631 (let ((inner-parts (plist-get part :content))
633 ;; Show all of the parts.
634 (mapc (lambda (inner-part)
635 (notmuch-show-insert-bodypart msg inner-part depth))
638 (when notmuch-show-indent-multipart
639 (indent-rigidly start (point) 1)))
642 (defun notmuch-show-insert-part-multipart/encrypted (msg part content-type nth depth button)
643 (button-put button 'face 'notmuch-crypto-part-header)
644 ;; add encryption status button if encstatus specified
645 (if (plist-member part :encstatus)
646 (let ((encstatus (car (plist-get part :encstatus))))
647 (notmuch-crypto-insert-encstatus-button encstatus)
648 ;; add signature status button if sigstatus specified
649 (if (plist-member part :sigstatus)
650 (let* ((from (notmuch-show-get-header :From msg))
651 (sigstatus (car (plist-get part :sigstatus))))
652 (notmuch-crypto-insert-sigstatus-button sigstatus from))))
653 ;; if we're not adding encstatus, tell the user how they can get it
654 (button-put button 'help-echo "Set notmuch-crypto-process-mime to process cryptographic MIME parts."))
656 (let ((inner-parts (plist-get part :content))
658 ;; Show all of the parts.
659 (mapc (lambda (inner-part)
660 (notmuch-show-insert-bodypart msg inner-part depth))
663 (when notmuch-show-indent-multipart
664 (indent-rigidly start (point) 1)))
667 (defun notmuch-show-insert-part-multipart/* (msg part content-type nth depth button)
668 (let ((inner-parts (plist-get part :content))
670 ;; Show all of the parts.
671 (mapc (lambda (inner-part)
672 (notmuch-show-insert-bodypart msg inner-part depth))
675 (when notmuch-show-indent-multipart
676 (indent-rigidly start (point) 1)))
679 (defun notmuch-show-insert-part-message/rfc822 (msg part content-type nth depth button)
680 (let* ((message (car (plist-get part :content)))
681 (body (car (plist-get message :body)))
684 ;; Override `notmuch-message-headers' to force `From' to be
686 (let ((notmuch-message-headers '("From" "Subject" "To" "Cc" "Date")))
687 (notmuch-show-insert-headers (plist-get message :headers)))
689 ;; Blank line after headers to be compatible with the normal
694 (notmuch-show-insert-bodypart msg body depth)
696 (when notmuch-show-indent-multipart
697 (indent-rigidly start (point) 1)))
700 (defun notmuch-show-insert-part-text/plain (msg part content-type nth depth button)
701 ;; For backward compatibility we want to apply the text/plain hook
702 ;; to the whole of the part including the part button if there is
704 (let ((start (if button
705 (button-start button)
707 (insert (notmuch-get-bodypart-content msg part notmuch-show-process-crypto))
710 (narrow-to-region start (point-max))
711 (run-hook-with-args 'notmuch-show-insert-text/plain-hook msg depth))))
714 (defun notmuch-show-insert-part-text/calendar (msg part content-type nth depth button)
715 (insert (with-temp-buffer
716 (insert (notmuch-get-bodypart-content msg part notmuch-show-process-crypto))
717 ;; notmuch-get-bodypart-content provides "raw", non-converted
718 ;; data. Replace CRLF with LF before icalendar can use it.
719 (goto-char (point-min))
720 (while (re-search-forward "\r\n" nil t)
721 (replace-match "\n" nil nil))
722 (let ((file (make-temp-file "notmuch-ical"))
726 (unless (icalendar-import-buffer file t)
727 (error "Icalendar import error. See *icalendar-errors* for more information"))
728 (set-buffer (get-file-buffer file))
729 (setq result (buffer-substring (point-min) (point-max)))
730 (set-buffer-modified-p nil)
731 (kill-buffer (current-buffer)))
736 ;; For backwards compatibility.
737 (defun notmuch-show-insert-part-text/x-vcalendar (msg part content-type nth depth button)
738 (notmuch-show-insert-part-text/calendar msg part content-type nth depth button))
740 (defun notmuch-show-get-mime-type-of-application/octet-stream (part)
741 ;; If we can deduce a MIME type from the filename of the attachment,
743 (if (plist-get part :filename)
744 (let ((extension (file-name-extension (plist-get part :filename)))
748 (mailcap-parse-mimetypes)
749 (setq mime-type (mailcap-extension-to-mime extension))
751 (not (string-equal mime-type "application/octet-stream")))
756 (defun notmuch-show-insert-part-text/html (msg part content-type nth depth button)
757 ;; text/html handler to work around bugs in renderers and our
758 ;; invisibile parts code. In particular w3m sets up a keymap which
759 ;; "leaks" outside the invisible region and causes strange effects
760 ;; in notmuch. We set mm-inline-text-html-with-w3m-keymap to nil to
761 ;; tell w3m not to set a keymap (so the normal notmuch-show-mode-map
763 (let ((mm-inline-text-html-with-w3m-keymap nil))
764 (notmuch-show-insert-part-*/* msg part content-type nth depth button)))
766 (defun notmuch-show-insert-part-*/* (msg part content-type nth depth button)
767 ;; This handler _must_ succeed - it is the handler of last resort.
768 (notmuch-mm-display-part-inline msg part content-type notmuch-show-process-crypto)
771 ;; Functions for determining how to handle MIME parts.
773 (defun notmuch-show-handlers-for (content-type)
774 "Return a list of content handlers for a part of type CONTENT-TYPE."
779 ;; Reverse order of prefrence.
780 (list (intern (concat "notmuch-show-insert-part-*/*"))
782 "notmuch-show-insert-part-"
783 (car (notmuch-split-content-type content-type))
785 (intern (concat "notmuch-show-insert-part-" content-type))))
790 (defun notmuch-show-insert-bodypart-internal (msg part content-type nth depth button)
791 (let ((handlers (notmuch-show-handlers-for content-type)))
792 ;; Run the content handlers until one of them returns a non-nil
795 (not (condition-case err
796 (funcall (car handlers) msg part content-type nth depth button)
797 ;; Specifying `debug' here lets the debugger
798 ;; run if `debug-on-error' is non-nil.
801 (insert "!!! Bodypart insert error: ")
802 (insert (error-message-string err))
803 (insert " !!!\n") nil)))))
804 (setq handlers (cdr handlers))))
807 (defun notmuch-show-create-part-overlays (button beg end)
808 "Add an overlay to the part between BEG and END"
810 ;; If there is no button (i.e., the part is text/plain and the first
811 ;; part) or if the part has no content then we don't make the part
813 (when (and button (/= beg end))
814 (button-put button 'overlay (make-overlay beg end))
815 ;; Return true if we created an overlay.
818 (defun notmuch-show-record-part-information (part beg end)
819 "Store PART as a text property from BEG to END"
821 ;; Record part information. Since we already inserted subparts,
822 ;; don't override existing :notmuch-part properties.
823 (notmuch-map-text-property beg end :notmuch-part
824 (lambda (v) (or v part)))
825 ;; Make :notmuch-part front sticky and rear non-sticky so it stays
826 ;; applied to the beginning of each line when we indent the
827 ;; message. Since we're operating on arbitrary renderer output,
828 ;; watch out for sticky specs of t, which means all properties are
829 ;; front-sticky/rear-nonsticky.
830 (notmuch-map-text-property beg end 'front-sticky
831 (lambda (v) (if (listp v)
832 (pushnew :notmuch-part v)
834 (notmuch-map-text-property beg end 'rear-nonsticky
835 (lambda (v) (if (listp v)
836 (pushnew :notmuch-part v)
839 (defun notmuch-show-lazy-part (part-args button)
840 ;; Insert the lazy part after the button for the part. We would just
841 ;; move to the start of the new line following the button and insert
842 ;; the part but that point might have text properties (eg colours
843 ;; from a message header etc) so instead we start from the last
844 ;; character of the button by adding a newline and finish by
845 ;; removing the extra newline from the end of the part.
847 (goto-char (button-end button))
849 (let* ((inhibit-read-only t)
850 ;; We need to use markers for the start and end of the part
851 ;; because the part insertion functions do not guarantee
852 ;; to leave point at the end of the part.
853 (part-beg (copy-marker (point) nil))
854 (part-end (copy-marker (point) t))
855 ;; We have to save the depth as we can't find the depth
857 (depth (notmuch-show-get-depth)))
859 (narrow-to-region part-beg part-end)
860 (delete-region part-beg part-end)
861 (apply #'notmuch-show-insert-bodypart-internal part-args)
862 (indent-rigidly part-beg part-end depth))
865 (notmuch-show-record-part-information (second part-args)
866 (button-start button)
868 ;; Create the overlay. If the lazy-part turned out to be empty/not
869 ;; showable this returns nil.
870 (notmuch-show-create-part-overlays button part-beg part-end))))
872 (defun notmuch-show-insert-bodypart (msg part depth &optional hide)
873 "Insert the body part PART at depth DEPTH in the current thread.
875 HIDE determines whether to show or hide the part and the button
876 as follows: If HIDE is nil, show the part and the button. If HIDE
877 is t, hide the part initially and show the button. If HIDE is
878 'no-buttons, show the part but do not add any buttons (this is
879 useful for quoting in replies)."
881 (let* ((content-type (downcase (plist-get part :content-type)))
882 (mime-type (or (and (string= content-type "application/octet-stream")
883 (notmuch-show-get-mime-type-of-application/octet-stream part))
884 (and (string= content-type "inline patch")
887 (nth (plist-get part :id))
889 ;; Hide the part initially if HIDE is t.
890 (show-part (not (equal hide t)))
891 ;; We omit the part button for the first (or only) part if
892 ;; this is text/plain, or HIDE is 'no-buttons.
893 (button (unless (or (equal hide 'no-buttons)
894 (and (string= mime-type "text/plain") (<= nth 1)))
895 (notmuch-show-insert-part-header nth mime-type content-type (plist-get part :filename))))
896 (content-beg (point)))
898 ;; Store the computed mime-type for later use (e.g. by attachment handlers).
899 (plist-put part :computed-type mime-type)
902 (notmuch-show-insert-bodypart-internal msg part mime-type nth depth button)
903 (button-put button :notmuch-lazy-part
904 (list msg part mime-type nth depth button)))
906 ;; Some of the body part handlers leave point somewhere up in the
907 ;; part, so we make sure that we're down at the end.
908 (goto-char (point-max))
909 ;; Ensure that the part ends with a carriage return.
912 ;; We do not create the overlay for hidden (lazy) parts until
913 ;; they are inserted.
915 (notmuch-show-create-part-overlays button content-beg (point))
917 (notmuch-show-toggle-part-invisibility button)))
918 (notmuch-show-record-part-information part beg (point))))
920 (defun notmuch-show-insert-body (msg body depth)
921 "Insert the body BODY at depth DEPTH in the current thread."
922 (mapc (lambda (part) (notmuch-show-insert-bodypart msg part depth)) body))
924 (defun notmuch-show-make-symbol (type)
925 (make-symbol (concat "notmuch-show-" type)))
927 (defun notmuch-show-strip-re (string)
928 (replace-regexp-in-string "^\\([Rr]e: *\\)+" "" string))
930 (defvar notmuch-show-previous-subject "")
931 (make-variable-buffer-local 'notmuch-show-previous-subject)
933 (defun notmuch-show-insert-msg (msg depth)
934 "Insert the message MSG at depth DEPTH in the current thread."
935 (let* ((headers (plist-get msg :headers))
936 ;; Indentation causes the buffer offset of the start/end
937 ;; points to move, so we must use markers.
938 message-start message-end
939 content-start content-end
940 headers-start headers-end
941 (bare-subject (notmuch-show-strip-re (plist-get headers :Subject))))
943 (setq message-start (point-marker))
945 (notmuch-show-insert-headerline headers
946 (or (if notmuch-show-relative-dates
947 (plist-get msg :date_relative)
949 (plist-get headers :Date))
950 (plist-get msg :tags) depth)
952 (setq content-start (point-marker))
954 ;; Set `headers-start' to point after the 'Subject:' header to be
955 ;; compatible with the existing implementation. This just sets it
956 ;; to after the first header.
957 (notmuch-show-insert-headers headers)
959 (goto-char content-start)
960 ;; If the subject of this message is the same as that of the
961 ;; previous message, don't display it when this message is
963 (when (not (string= notmuch-show-previous-subject
966 (setq headers-start (point-marker)))
967 (setq headers-end (point-marker))
969 (setq notmuch-show-previous-subject bare-subject)
971 ;; A blank line between the headers and the body.
973 (notmuch-show-insert-body msg (plist-get msg :body)
974 (if notmuch-show-indent-content depth 0))
975 ;; Ensure that the body ends with a newline.
978 (setq content-end (point-marker))
980 ;; Indent according to the depth in the thread.
981 (if notmuch-show-indent-content
982 (indent-rigidly content-start content-end (* notmuch-show-indent-messages-width depth)))
984 (setq message-end (point-max-marker))
986 ;; Save the extents of this message over the whole text of the
988 (put-text-property message-start message-end :notmuch-message-extent (cons message-start message-end))
990 ;; Create overlays used to control visibility
991 (plist-put msg :headers-overlay (make-overlay headers-start headers-end))
992 (plist-put msg :message-overlay (make-overlay headers-start content-end))
994 (plist-put msg :depth depth)
996 ;; Save the properties for this message. Currently this saves the
997 ;; entire message (augmented it with other stuff), which seems
998 ;; like overkill. We might save a reduced subset (for example, not
1000 (notmuch-show-set-message-properties msg)
1002 ;; Set header visibility.
1003 (notmuch-show-headers-visible msg notmuch-message-headers-visible)
1005 ;; Message visibility depends on whether it matched the search
1007 (notmuch-show-message-visible msg (and (plist-get msg :match)
1008 (not (plist-get msg :excluded))))))
1010 (defun notmuch-show-toggle-process-crypto ()
1011 "Toggle the processing of cryptographic MIME parts."
1013 (setq notmuch-show-process-crypto (not notmuch-show-process-crypto))
1014 (message (if notmuch-show-process-crypto
1015 "Processing cryptographic MIME parts."
1016 "Not processing cryptographic MIME parts."))
1017 (notmuch-show-refresh-view))
1019 (defun notmuch-show-toggle-elide-non-matching ()
1020 "Toggle the display of non-matching messages."
1022 (setq notmuch-show-elide-non-matching-messages (not notmuch-show-elide-non-matching-messages))
1023 (message (if notmuch-show-elide-non-matching-messages
1024 "Showing matching messages only."
1025 "Showing all messages."))
1026 (notmuch-show-refresh-view))
1028 (defun notmuch-show-toggle-thread-indentation ()
1029 "Toggle the indentation of threads."
1031 (setq notmuch-show-indent-content (not notmuch-show-indent-content))
1032 (message (if notmuch-show-indent-content
1033 "Content is indented."
1034 "Content is not indented."))
1035 (notmuch-show-refresh-view))
1037 (defun notmuch-show-insert-tree (tree depth)
1038 "Insert the message tree TREE at depth DEPTH in the current thread."
1039 (let ((msg (car tree))
1040 (replies (cadr tree)))
1041 ;; We test whether there is a message or just some replies.
1043 (notmuch-show-insert-msg msg depth))
1044 (notmuch-show-insert-thread replies (1+ depth))))
1046 (defun notmuch-show-insert-thread (thread depth)
1047 "Insert the thread THREAD at depth DEPTH in the current forest."
1048 (mapc (lambda (tree) (notmuch-show-insert-tree tree depth)) thread))
1050 (defun notmuch-show-insert-forest (forest)
1051 "Insert the forest of threads FOREST."
1052 (mapc (lambda (thread) (notmuch-show-insert-thread thread 0)) forest))
1054 (defvar notmuch-id-regexp
1056 ;; Match the id: prefix only if it begins a word (to disallow, for
1057 ;; example, matching cid:).
1059 ;; If the term starts with a ", then parse Xapian's quoted boolean
1060 ;; term syntax, which allows for anything as long as embedded
1061 ;; double quotes escaped by doubling them. We also disallow
1062 ;; newlines (which Xapian allows) to prevent runaway terms.
1063 "\"\\([^\"\n]\\|\"\"\\)*\""
1064 ;; Otherwise, parse Xapian's unquoted syntax, which goes up to the
1065 ;; next space or ). We disallow [.,;] as the last character
1066 ;; because these are probably part of the surrounding text, and not
1067 ;; part of the id. This doesn't match single character ids; meh.
1068 "\\|[^\"[:space:])][^[:space:])]*[^])[:space:].,:;?!]"
1070 "The regexp used to match id: links in messages.")
1072 (defvar notmuch-mid-regexp
1073 ;; goto-address-url-regexp matched cid: links, which have the same
1074 ;; grammar as the message ID part of a mid: link. Construct the
1075 ;; regexp using the same technique as goto-address-url-regexp.
1076 (concat "\\<mid:\\(" thing-at-point-url-path-regexp "\\)")
1077 "The regexp used to match mid: links in messages.
1081 (defun notmuch-show-buttonise-links (start end)
1082 "Buttonise URLs and mail addresses between START and END.
1084 This also turns id:\"<message id>\"-parts and mid: links into
1085 buttons for a corresponding notmuch search."
1086 (goto-address-fontify-region start end)
1090 (while (re-search-forward notmuch-id-regexp end t)
1091 (push (list (match-beginning 0) (match-end 0)
1092 (match-string-no-properties 0)) links))
1094 (while (re-search-forward notmuch-mid-regexp end t)
1095 (let* ((mid-cid (match-string-no-properties 1))
1096 (mid (save-match-data
1097 (string-match "^[^/]*" mid-cid)
1098 (url-unhex-string (match-string 0 mid-cid)))))
1099 (push (list (match-beginning 0) (match-end 0)
1100 (notmuch-id-to-query mid)) links)))
1101 (dolist (link links)
1102 ;; Remove the overlay created by goto-address-mode
1103 (remove-overlays (first link) (second link) 'goto-address t)
1104 (make-text-button (first link) (second link)
1105 :type 'notmuch-button-type
1106 'action `(lambda (arg)
1107 (notmuch-show ,(third link) current-prefix-arg))
1109 'help-echo "Mouse-1, RET: search for this message"
1110 'face goto-address-mail-face)))))
1113 (defun notmuch-show (thread-id &optional elide-toggle parent-buffer query-context buffer-name)
1114 "Run \"notmuch show\" with the given thread ID and display results.
1116 ELIDE-TOGGLE, if non-nil, inverts the default elide behavior.
1118 The optional PARENT-BUFFER is the notmuch-search buffer from
1119 which this notmuch-show command was executed, (so that the
1120 next thread from that buffer can be show when done with this
1123 The optional QUERY-CONTEXT is a notmuch search term. Only
1124 messages from the thread matching this search term are shown if
1127 The optional BUFFER-NAME provides the name of the buffer in
1128 which the message thread is shown. If it is nil (which occurs
1129 when the command is called interactively) the argument to the
1131 (interactive "sNotmuch show: \nP")
1132 (let ((buffer-name (generate-new-buffer-name
1134 (concat "*notmuch-" thread-id "*")))))
1135 (switch-to-buffer (get-buffer-create buffer-name))
1136 ;; Set the default value for `notmuch-show-process-crypto' in this
1138 (setq notmuch-show-process-crypto notmuch-crypto-process-mime)
1139 ;; Set the default value for
1140 ;; `notmuch-show-elide-non-matching-messages' in this buffer. If
1141 ;; elide-toggle is set, invert the default.
1142 (setq notmuch-show-elide-non-matching-messages notmuch-show-only-matching-messages)
1144 (setq notmuch-show-elide-non-matching-messages (not notmuch-show-elide-non-matching-messages)))
1146 (setq notmuch-show-thread-id thread-id
1147 notmuch-show-parent-buffer parent-buffer
1148 notmuch-show-query-context query-context)
1149 (notmuch-show-build-buffer)
1150 (notmuch-show-goto-first-wanted-message)
1153 (defun notmuch-show-build-buffer ()
1154 (let ((inhibit-read-only t))
1157 (add-hook 'post-command-hook #'notmuch-show-command-hook nil t)
1159 ;; Don't track undo information for this buffer
1160 (set 'buffer-undo-list t)
1162 (notmuch-tag-clear-cache)
1164 (goto-char (point-min))
1166 (let* ((basic-args (list notmuch-show-thread-id))
1167 (args (if notmuch-show-query-context
1168 (append (list "\'") basic-args
1169 (list "and (" notmuch-show-query-context ")\'"))
1170 (append (list "\'") basic-args (list "\'"))))
1171 (cli-args (cons "--exclude=false"
1172 (when notmuch-show-elide-non-matching-messages
1173 (list "--entire-thread=false")))))
1175 (notmuch-show-insert-forest (notmuch-query-get-threads (append cli-args args)))
1176 ;; If the query context reduced the results to nothing, run
1178 (when (and (eq (buffer-size) 0)
1179 notmuch-show-query-context)
1180 (notmuch-show-insert-forest
1181 (notmuch-query-get-threads (append cli-args basic-args)))))
1183 (jit-lock-register #'notmuch-show-buttonise-links)
1185 (notmuch-show-mapc (lambda () (notmuch-show-set-prop :orig-tags (notmuch-show-get-tags))))
1187 ;; Set the header line to the subject of the first message.
1188 (setq header-line-format
1189 (replace-regexp-in-string "%" "%%"
1191 (notmuch-show-strip-re
1192 (notmuch-show-get-subject)))))
1194 (run-hooks 'notmuch-show-hook))))
1196 (defun notmuch-show-capture-state ()
1197 "Capture the state of the current buffer.
1200 - the list of open messages,
1201 - the current message."
1202 (list (notmuch-show-get-message-id) (notmuch-show-get-message-ids-for-open-messages)))
1204 (defun notmuch-show-get-query ()
1205 "Return the current query in this show buffer"
1206 (if notmuch-show-query-context
1207 (concat notmuch-show-thread-id
1209 notmuch-show-query-context
1211 notmuch-show-thread-id))
1213 (defun notmuch-show-apply-state (state)
1214 "Apply STATE to the current buffer.
1217 - opening the messages previously opened,
1218 - closing all other messages,
1219 - moving to the correct current message."
1220 (let ((current (car state))
1221 (open (cadr state)))
1223 ;; Open those that were open.
1224 (goto-char (point-min))
1225 (loop do (notmuch-show-message-visible (notmuch-show-get-message-properties)
1226 (member (notmuch-show-get-message-id) open))
1227 until (not (notmuch-show-goto-message-next)))
1229 ;; Go to the previously open message.
1230 (goto-char (point-min))
1231 (unless (loop if (string= current (notmuch-show-get-message-id))
1233 until (not (notmuch-show-goto-message-next)))
1234 (goto-char (point-min))
1235 (message "Previously current message not found."))
1236 (notmuch-show-message-adjust)))
1238 (defun notmuch-show-refresh-view (&optional reset-state)
1239 "Refresh the current view.
1241 Refreshes the current view, observing changes in display
1242 preferences. If invoked with a prefix argument (or RESET-STATE is
1243 non-nil) then the state of the buffer (open/closed messages) is
1244 reset based on the original query."
1246 (let ((inhibit-read-only t)
1247 (state (unless reset-state
1248 (notmuch-show-capture-state))))
1249 ;; erase-buffer does not seem to remove overlays, which can lead
1250 ;; to weird effects such as remaining images, so remove them
1254 (notmuch-show-build-buffer)
1256 (notmuch-show-apply-state state)
1257 ;; We're resetting state, so navigate to the first open message
1258 ;; and mark it read, just like opening a new show buffer.
1259 (notmuch-show-goto-first-wanted-message))))
1261 (defvar notmuch-show-stash-map
1262 (let ((map (make-sparse-keymap)))
1263 (define-key map "c" 'notmuch-show-stash-cc)
1264 (define-key map "d" 'notmuch-show-stash-date)
1265 (define-key map "F" 'notmuch-show-stash-filename)
1266 (define-key map "f" 'notmuch-show-stash-from)
1267 (define-key map "i" 'notmuch-show-stash-message-id)
1268 (define-key map "I" 'notmuch-show-stash-message-id-stripped)
1269 (define-key map "s" 'notmuch-show-stash-subject)
1270 (define-key map "T" 'notmuch-show-stash-tags)
1271 (define-key map "t" 'notmuch-show-stash-to)
1272 (define-key map "l" 'notmuch-show-stash-mlarchive-link)
1273 (define-key map "L" 'notmuch-show-stash-mlarchive-link-and-go)
1274 (define-key map "G" 'notmuch-show-stash-git-send-email)
1275 (define-key map "?" 'notmuch-subkeymap-help)
1277 "Submap for stash commands")
1278 (fset 'notmuch-show-stash-map notmuch-show-stash-map)
1280 (defvar notmuch-show-part-map
1281 (let ((map (make-sparse-keymap)))
1282 (define-key map "s" 'notmuch-show-save-part)
1283 (define-key map "v" 'notmuch-show-view-part)
1284 (define-key map "o" 'notmuch-show-interactively-view-part)
1285 (define-key map "|" 'notmuch-show-pipe-part)
1286 (define-key map "?" 'notmuch-subkeymap-help)
1288 "Submap for part commands")
1289 (fset 'notmuch-show-part-map notmuch-show-part-map)
1291 (defvar notmuch-show-mode-map
1292 (let ((map (make-sparse-keymap)))
1293 (set-keymap-parent map notmuch-common-keymap)
1294 (define-key map "Z" 'notmuch-tree-from-show-current-query)
1295 (define-key map (kbd "<C-tab>") 'widget-backward)
1296 (define-key map (kbd "M-TAB") 'notmuch-show-previous-button)
1297 (define-key map (kbd "<backtab>") 'notmuch-show-previous-button)
1298 (define-key map (kbd "TAB") 'notmuch-show-next-button)
1299 (define-key map "f" 'notmuch-show-forward-message)
1300 (define-key map "r" 'notmuch-show-reply-sender)
1301 (define-key map "R" 'notmuch-show-reply)
1302 (define-key map "|" 'notmuch-show-pipe-message)
1303 (define-key map "w" 'notmuch-show-save-attachments)
1304 (define-key map "V" 'notmuch-show-view-raw-message)
1305 (define-key map "c" 'notmuch-show-stash-map)
1306 (define-key map "h" 'notmuch-show-toggle-visibility-headers)
1307 (define-key map "*" 'notmuch-show-tag-all)
1308 (define-key map "-" 'notmuch-show-remove-tag)
1309 (define-key map "+" 'notmuch-show-add-tag)
1310 (define-key map "X" 'notmuch-show-archive-thread-then-exit)
1311 (define-key map "x" 'notmuch-show-archive-message-then-next-or-exit)
1312 (define-key map "A" 'notmuch-show-archive-thread-then-next)
1313 (define-key map "a" 'notmuch-show-archive-message-then-next-or-next-thread)
1314 (define-key map "N" 'notmuch-show-next-message)
1315 (define-key map "P" 'notmuch-show-previous-message)
1316 (define-key map "n" 'notmuch-show-next-open-message)
1317 (define-key map "p" 'notmuch-show-previous-open-message)
1318 (define-key map (kbd "M-n") 'notmuch-show-next-thread-show)
1319 (define-key map (kbd "M-p") 'notmuch-show-previous-thread-show)
1320 (define-key map (kbd "DEL") 'notmuch-show-rewind)
1321 (define-key map " " 'notmuch-show-advance-and-archive)
1322 (define-key map (kbd "M-RET") 'notmuch-show-open-or-close-all)
1323 (define-key map (kbd "RET") 'notmuch-show-toggle-message)
1324 (define-key map "#" 'notmuch-show-print-message)
1325 (define-key map "!" 'notmuch-show-toggle-elide-non-matching)
1326 (define-key map "$" 'notmuch-show-toggle-process-crypto)
1327 (define-key map "<" 'notmuch-show-toggle-thread-indentation)
1328 (define-key map "t" 'toggle-truncate-lines)
1329 (define-key map "." 'notmuch-show-part-map)
1331 "Keymap for \"notmuch show\" buffers.")
1332 (fset 'notmuch-show-mode-map notmuch-show-mode-map)
1334 (defun notmuch-show-mode ()
1335 "Major mode for viewing a thread with notmuch.
1337 This buffer contains the results of the \"notmuch show\" command
1338 for displaying a single thread of email from your email archives.
1340 By default, various components of email messages, (citations,
1341 signatures, already-read messages), are hidden. You can make
1342 these parts visible by clicking with the mouse button or by
1343 pressing RET after positioning the cursor on a hidden part, (for
1344 which \\[notmuch-show-next-button] and \\[notmuch-show-previous-button] are helpful).
1346 Reading the thread sequentially is well-supported by pressing
1347 \\[notmuch-show-advance-and-archive]. This will scroll the current message (if necessary), advance
1348 to the next message, or advance to the next thread (if already on
1349 the last message of a thread).
1351 Other commands are available to read or manipulate the thread
1352 more selectively, (such as '\\[notmuch-show-next-message]' and '\\[notmuch-show-previous-message]' to advance to messages
1353 without removing any tags, and '\\[notmuch-show-archive-thread]' to archive an entire thread
1354 without scrolling through with \\[notmuch-show-advance-and-archive]).
1356 You can add or remove arbitrary tags from the current message with
1357 '\\[notmuch-show-add-tag]' or '\\[notmuch-show-remove-tag]'.
1359 All currently available key bindings:
1361 \\{notmuch-show-mode-map}"
1363 (kill-all-local-variables)
1364 (setq notmuch-buffer-refresh-function #'notmuch-show-refresh-view)
1365 (use-local-map notmuch-show-mode-map)
1366 (setq major-mode 'notmuch-show-mode
1367 mode-name "notmuch-show")
1368 (setq buffer-read-only t
1371 (defun notmuch-tree-from-show-current-query ()
1372 "Call notmuch tree with the current query"
1374 (notmuch-tree notmuch-show-thread-id
1375 notmuch-show-query-context
1376 (notmuch-show-get-message-id)))
1378 (defun notmuch-show-move-to-message-top ()
1379 (goto-char (notmuch-show-message-top)))
1381 (defun notmuch-show-move-to-message-bottom ()
1382 (goto-char (notmuch-show-message-bottom)))
1384 (defun notmuch-show-message-adjust ()
1387 ;; Movement related functions.
1389 ;; There's some strangeness here where a text property applied to a
1390 ;; region a->b is not found when point is at b. We walk backwards
1391 ;; until finding the property.
1392 (defun notmuch-show-message-extent ()
1395 (while (not (setq r (get-text-property (point) :notmuch-message-extent)))
1399 (defun notmuch-show-message-top ()
1400 (car (notmuch-show-message-extent)))
1402 (defun notmuch-show-message-bottom ()
1403 (cdr (notmuch-show-message-extent)))
1405 (defun notmuch-show-goto-message-next ()
1406 (let ((start (point)))
1407 (notmuch-show-move-to-message-bottom)
1413 (defun notmuch-show-goto-message-previous ()
1414 (notmuch-show-move-to-message-top)
1418 (notmuch-show-move-to-message-top)
1421 (defun notmuch-show-mapc (function)
1422 "Iterate through all messages in the current thread with
1423 `notmuch-show-goto-message-next' and call FUNCTION for side
1426 (goto-char (point-min))
1427 (loop do (funcall function)
1428 while (notmuch-show-goto-message-next))))
1430 ;; Functions relating to the visibility of messages and their
1433 (defun notmuch-show-message-visible (props visible-p)
1434 (overlay-put (plist-get props :message-overlay) 'invisible (not visible-p))
1435 (notmuch-show-set-prop :message-visible visible-p props))
1437 (defun notmuch-show-headers-visible (props visible-p)
1438 (overlay-put (plist-get props :headers-overlay) 'invisible (not visible-p))
1439 (notmuch-show-set-prop :headers-visible visible-p props))
1441 ;; Functions for setting and getting attributes of the current
1444 (defun notmuch-show-set-message-properties (props)
1446 (notmuch-show-move-to-message-top)
1447 (put-text-property (point) (+ (point) 1) :notmuch-message-properties props)))
1449 (defun notmuch-show-get-message-properties ()
1450 "Return the properties of the current message as a plist.
1452 Some useful entries are:
1453 :headers - Property list containing the headers :Date, :Subject, :From, etc.
1454 :body - Body of the message
1455 :tags - Tags for this message"
1457 (notmuch-show-move-to-message-top)
1458 (get-text-property (point) :notmuch-message-properties)))
1460 (defun notmuch-show-get-part-properties ()
1461 "Return the properties of the innermost part containing point.
1463 This is the part property list retrieved from the CLI. Signals
1464 an error if there is no part containing point."
1465 (or (get-text-property (point) :notmuch-part)
1466 (error "No message part here")))
1468 (defun notmuch-show-set-prop (prop val &optional props)
1469 (let ((inhibit-read-only t)
1471 (notmuch-show-get-message-properties))))
1472 (plist-put props prop val)
1473 (notmuch-show-set-message-properties props)))
1475 (defun notmuch-show-get-prop (prop &optional props)
1476 "Get property PROP from current message in show or tree mode.
1478 It gets property PROP from PROPS or, if PROPS is nil, the current
1479 message in either tree or show. This means that several utility
1480 functions in notmuch-show can be used directly by notmuch-tree as
1481 they just need the correct message properties."
1482 (let ((props (or props
1483 (cond ((eq major-mode 'notmuch-show-mode)
1484 (notmuch-show-get-message-properties))
1485 ((eq major-mode 'notmuch-tree-mode)
1486 (notmuch-tree-get-message-properties))
1488 (plist-get props prop)))
1490 (defun notmuch-show-get-message-id (&optional bare)
1491 "Return an id: query for the Message-Id of the current message.
1493 If optional argument BARE is non-nil, return
1494 the Message-Id without id: prefix and escaping."
1496 (notmuch-show-get-prop :id)
1497 (notmuch-id-to-query (notmuch-show-get-prop :id))))
1499 (defun notmuch-show-get-messages-ids ()
1500 "Return all id: queries of messages in the current thread."
1501 (let ((message-ids))
1503 (lambda () (push (notmuch-show-get-message-id) message-ids)))
1506 (defun notmuch-show-get-messages-ids-search ()
1507 "Return a search string for all message ids of messages in the
1509 (mapconcat 'identity (notmuch-show-get-messages-ids) " or "))
1511 ;; dme: Would it make sense to use a macro for many of these?
1513 (defun notmuch-show-get-filename ()
1514 "Return the filename of the current message."
1515 (notmuch-show-get-prop :filename))
1517 (defun notmuch-show-get-header (header &optional props)
1518 "Return the named header of the current message, if any."
1519 (plist-get (notmuch-show-get-prop :headers props) header))
1521 (defun notmuch-show-get-cc ()
1522 (notmuch-show-get-header :Cc))
1524 (defun notmuch-show-get-date ()
1525 (notmuch-show-get-header :Date))
1527 (defun notmuch-show-get-from ()
1528 (notmuch-show-get-header :From))
1530 (defun notmuch-show-get-subject ()
1531 (notmuch-show-get-header :Subject))
1533 (defun notmuch-show-get-to ()
1534 (notmuch-show-get-header :To))
1536 (defun notmuch-show-get-depth ()
1537 (notmuch-show-get-prop :depth))
1539 (defun notmuch-show-set-tags (tags)
1540 "Set the tags of the current message."
1541 (notmuch-show-set-prop :tags tags)
1542 (notmuch-show-update-tags tags))
1544 (defun notmuch-show-get-tags ()
1545 "Return the tags of the current message."
1546 (notmuch-show-get-prop :tags))
1548 (defun notmuch-show-message-visible-p ()
1549 "Is the current message visible?"
1550 (notmuch-show-get-prop :message-visible))
1552 (defun notmuch-show-headers-visible-p ()
1553 "Are the headers of the current message visible?"
1554 (notmuch-show-get-prop :headers-visible))
1556 (put 'notmuch-show-mark-read 'notmuch-prefix-doc
1557 "Mark the current message as unread.")
1558 (defun notmuch-show-mark-read (&optional unread)
1559 "Mark the current message as read.
1561 Mark the current message as read by applying the tag changes in
1562 `notmuch-show-mark-read-tags' to it (remove the \"unread\" tag by
1563 default). If a prefix argument is given, the message will be
1564 marked as unread, i.e. the tag changes in
1565 `notmuch-show-mark-read-tags' will be reversed."
1567 (when notmuch-show-mark-read-tags
1568 (apply 'notmuch-show-tag-message
1569 (notmuch-tag-change-list notmuch-show-mark-read-tags unread))))
1571 (defun notmuch-show-seen-current-message (start end)
1572 "Mark the current message read if it is open.
1574 We only mark it read once: if it is changed back then that is a
1575 user decision and we should not override it."
1576 (when (and (notmuch-show-message-visible-p)
1577 (not (notmuch-show-get-prop :seen)))
1578 (notmuch-show-mark-read)
1579 (notmuch-show-set-prop :seen t)))
1581 (defun notmuch-show-command-hook ()
1582 (when (eq major-mode 'notmuch-show-mode)
1583 ;; We need to redisplay to get window-start and window-end correct.
1586 (funcall notmuch-show-mark-read-function (window-start) (window-end)))))
1588 ;; Functions for getting attributes of several messages in the current
1591 (defun notmuch-show-get-message-ids-for-open-messages ()
1592 "Return a list of all id: queries for open messages in the current thread."
1594 (let (message-ids done)
1595 (goto-char (point-min))
1597 (if (notmuch-show-message-visible-p)
1598 (setq message-ids (append message-ids (list (notmuch-show-get-message-id)))))
1599 (setq done (not (notmuch-show-goto-message-next)))
1604 ;; Commands typically bound to keys.
1606 (defun notmuch-show-advance ()
1607 "Advance through thread.
1609 If the current message in the thread is not yet fully visible,
1610 scroll by a near screenful to read more of the message.
1612 Otherwise, (the end of the current message is already within the
1613 current window), advance to the next open message."
1615 (let* ((end-of-this-message (notmuch-show-message-bottom))
1616 (visible-end-of-this-message (1- end-of-this-message))
1618 (while (invisible-p visible-end-of-this-message)
1619 (setq visible-end-of-this-message
1621 (1- (previous-single-char-property-change
1622 visible-end-of-this-message 'invisible)))))
1624 ;; Ideally we would test `end-of-this-message' against the result
1625 ;; of `window-end', but that doesn't account for the fact that
1626 ;; the end of the message might be hidden.
1627 ((and visible-end-of-this-message
1628 (> visible-end-of-this-message (window-end)))
1629 ;; The bottom of this message is not visible - scroll.
1632 ((not (= end-of-this-message (point-max)))
1633 ;; This is not the last message - move to the next visible one.
1634 (notmuch-show-next-open-message))
1636 ((not (= (point) (point-max)))
1637 ;; This is the last message, but the cursor is not at the end of
1638 ;; the buffer. Move it there.
1639 (goto-char (point-max)))
1642 ;; This is the last message - change the return value
1646 (defun notmuch-show-advance-and-archive ()
1647 "Advance through thread and archive.
1649 This command is intended to be one of the simplest ways to
1650 process a thread of email. It works exactly like
1651 notmuch-show-advance, in that it scrolls through messages in a
1652 show buffer, except that when it gets to the end of the buffer it
1653 archives the entire current thread, (apply changes in
1654 `notmuch-archive-tags'), kills the buffer, and displays the next
1655 thread from the search from which this thread was originally
1658 (if (notmuch-show-advance)
1659 (notmuch-show-archive-thread-then-next)))
1661 (defun notmuch-show-rewind ()
1662 "Backup through the thread (reverse scrolling compared to \\[notmuch-show-advance-and-archive]).
1664 Specifically, if the beginning of the previous email is fewer
1665 than `window-height' lines from the current point, move to it
1666 just like `notmuch-show-previous-message'.
1668 Otherwise, just scroll down a screenful of the current message.
1670 This command does not modify any message tags, (it does not undo
1671 any effects from previous calls to
1672 `notmuch-show-advance-and-archive'."
1674 (let ((start-of-message (notmuch-show-message-top))
1675 (start-of-window (window-start)))
1677 ;; Either this message is properly aligned with the start of the
1678 ;; window or the start of this message is not visible on the
1680 ((or (= start-of-message start-of-window)
1681 (< start-of-message start-of-window))
1683 ;; If a small number of lines from the previous message are
1684 ;; visible, realign so that the top of the current message is at
1685 ;; the top of the screen.
1686 (when (<= (count-screen-lines (window-start) start-of-message)
1687 next-screen-context-lines)
1688 (goto-char (notmuch-show-message-top))
1689 (notmuch-show-message-adjust))
1690 ;; Move to the top left of the window.
1691 (goto-char (window-start)))
1693 ;; Move to the previous message.
1694 (notmuch-show-previous-message)))))
1696 (put 'notmuch-show-reply 'notmuch-prefix-doc "... and prompt for sender")
1697 (defun notmuch-show-reply (&optional prompt-for-sender)
1698 "Reply to the sender and all recipients of the current message."
1700 (notmuch-mua-new-reply (notmuch-show-get-message-id) prompt-for-sender t))
1702 (put 'notmuch-show-reply-sender 'notmuch-prefix-doc "... and prompt for sender")
1703 (defun notmuch-show-reply-sender (&optional prompt-for-sender)
1704 "Reply to the sender of the current message."
1706 (notmuch-mua-new-reply (notmuch-show-get-message-id) prompt-for-sender nil))
1708 (put 'notmuch-show-forward-message 'notmuch-prefix-doc
1709 "... and prompt for sender")
1710 (defun notmuch-show-forward-message (&optional prompt-for-sender)
1711 "Forward the current message."
1713 (with-current-notmuch-show-message
1714 (notmuch-mua-new-forward-message prompt-for-sender)))
1716 (defun notmuch-show-next-message (&optional pop-at-end)
1717 "Show the next message.
1719 If a prefix argument is given and this is the last message in the
1720 thread, navigate to the next thread in the parent search buffer."
1722 (if (notmuch-show-goto-message-next)
1723 (notmuch-show-message-adjust)
1725 (notmuch-show-next-thread)
1726 (goto-char (point-max)))))
1728 (defun notmuch-show-previous-message ()
1729 "Show the previous message or the start of the current message."
1731 (if (= (point) (notmuch-show-message-top))
1732 (notmuch-show-goto-message-previous)
1733 (notmuch-show-move-to-message-top))
1734 (notmuch-show-message-adjust))
1736 (defun notmuch-show-next-open-message (&optional pop-at-end)
1737 "Show the next open message.
1739 If a prefix argument is given and this is the last open message
1740 in the thread, navigate to the next thread in the parent search
1741 buffer. Return t if there was a next open message in the thread
1742 to show, nil otherwise."
1745 (while (and (setq r (notmuch-show-goto-message-next))
1746 (not (notmuch-show-message-visible-p))))
1748 (notmuch-show-message-adjust)
1750 (notmuch-show-next-thread)
1751 (goto-char (point-max))))
1754 (defun notmuch-show-next-matching-message ()
1755 "Show the next matching message."
1758 (while (and (setq r (notmuch-show-goto-message-next))
1759 (not (notmuch-show-get-prop :match))))
1761 (notmuch-show-message-adjust)
1762 (goto-char (point-max)))))
1764 (defun notmuch-show-open-if-matched ()
1765 "Open a message if it is matched (whether or not excluded)."
1766 (let ((props (notmuch-show-get-message-properties)))
1767 (notmuch-show-message-visible props (plist-get props :match))))
1769 (defun notmuch-show-goto-first-wanted-message ()
1770 "Move to the first open message and mark it read"
1771 (goto-char (point-min))
1772 (unless (notmuch-show-message-visible-p)
1773 (notmuch-show-next-open-message))
1775 ;; There are no matched non-excluded messages so open all matched
1776 ;; (necessarily excluded) messages and go to the first.
1777 (notmuch-show-mapc 'notmuch-show-open-if-matched)
1778 (force-window-update)
1779 (goto-char (point-min))
1780 (unless (notmuch-show-message-visible-p)
1781 (notmuch-show-next-open-message))))
1783 (defun notmuch-show-previous-open-message ()
1784 "Show the previous open message."
1786 (while (and (if (= (point) (notmuch-show-message-top))
1787 (notmuch-show-goto-message-previous)
1788 (notmuch-show-move-to-message-top))
1789 (not (notmuch-show-message-visible-p))))
1790 (notmuch-show-message-adjust))
1792 (defun notmuch-show-view-raw-message ()
1793 "View the original source of the current message."
1795 (let* ((id (notmuch-show-get-message-id))
1796 (buf (get-buffer-create (concat "*notmuch-raw-" id "*"))))
1797 (let ((coding-system-for-read 'no-conversion))
1798 (call-process notmuch-command nil buf nil "show" "--format=raw" id))
1799 (switch-to-buffer buf)
1800 (goto-char (point-min))
1801 (set-buffer-modified-p nil)
1802 (view-buffer buf 'kill-buffer-if-not-modified)))
1804 (put 'notmuch-show-pipe-message 'notmuch-doc
1805 "Pipe the contents of the current message to a command.")
1806 (put 'notmuch-show-pipe-message 'notmuch-prefix-doc
1807 "Pipe the thread as an mbox to a command.")
1808 (defun notmuch-show-pipe-message (entire-thread command)
1809 "Pipe the contents of the current message (or thread) to COMMAND.
1811 COMMAND will be executed with the raw contents of the current
1812 email message as stdin. Anything printed by the command to stdout
1813 or stderr will appear in the *notmuch-pipe* buffer.
1815 If ENTIRE-THREAD is non-nil (or when invoked with a prefix
1816 argument), COMMAND will receive all open messages in the current
1817 thread (formatted as an mbox) rather than only the current
1819 (interactive (let ((query-string (if current-prefix-arg
1820 "Pipe all open messages to command: "
1821 "Pipe message to command: ")))
1822 (list current-prefix-arg (read-string query-string))))
1823 (let (shell-command)
1826 (concat notmuch-command " show --format=mbox --exclude=false "
1827 (shell-quote-argument
1828 (mapconcat 'identity (notmuch-show-get-message-ids-for-open-messages) " OR "))
1831 (concat notmuch-command " show --format=raw "
1832 (shell-quote-argument (notmuch-show-get-message-id)) " | " command)))
1833 (let ((cwd default-directory)
1834 (buf (get-buffer-create (concat "*notmuch-pipe*"))))
1835 (with-current-buffer buf
1836 (setq buffer-read-only nil)
1838 ;; Use the originating buffer's working directory instead of
1839 ;; that of the pipe buffer.
1841 (let ((exit-code (call-process-shell-command shell-command nil buf)))
1842 (goto-char (point-max))
1843 (set-buffer-modified-p nil)
1844 (setq buffer-read-only t)
1845 (unless (zerop exit-code)
1846 (switch-to-buffer-other-window buf)
1847 (message (format "Command '%s' exited abnormally with code %d"
1848 shell-command exit-code))))))))
1850 (defun notmuch-show-tag-message (&rest tag-changes)
1851 "Change tags for the current message.
1853 TAG-CHANGES is a list of tag operations for `notmuch-tag'."
1854 (let* ((current-tags (notmuch-show-get-tags))
1855 (new-tags (notmuch-update-tags current-tags tag-changes)))
1856 (unless (equal current-tags new-tags)
1857 (notmuch-tag (notmuch-show-get-message-id) tag-changes)
1858 (notmuch-show-set-tags new-tags))))
1860 (defun notmuch-show-tag (tag-changes)
1861 "Change tags for the current message.
1863 See `notmuch-tag' for information on the format of TAG-CHANGES."
1864 (interactive (list (notmuch-read-tag-changes (notmuch-show-get-tags)
1866 (notmuch-tag (notmuch-show-get-message-id) tag-changes)
1867 (let* ((current-tags (notmuch-show-get-tags))
1868 (new-tags (notmuch-update-tags current-tags tag-changes)))
1869 (unless (equal current-tags new-tags)
1870 (notmuch-show-set-tags new-tags))))
1872 (defun notmuch-show-tag-all (tag-changes)
1873 "Change tags for all messages in the current show buffer.
1875 See `notmuch-tag' for information on the format of TAG-CHANGES."
1879 (lambda () (setq tags (append (notmuch-show-get-tags) tags))))
1880 (notmuch-read-tag-changes tags "Tag thread"))))
1881 (notmuch-tag (notmuch-show-get-messages-ids-search) tag-changes)
1884 (let* ((current-tags (notmuch-show-get-tags))
1885 (new-tags (notmuch-update-tags current-tags tag-changes)))
1886 (unless (equal current-tags new-tags)
1887 (notmuch-show-set-tags new-tags))))))
1889 (defun notmuch-show-add-tag (tag-changes)
1890 "Change tags for the current message (defaulting to add).
1892 Same as `notmuch-show-tag' but sets initial input to '+'."
1894 (list (notmuch-read-tag-changes (notmuch-show-get-tags) "Tag message" "+")))
1895 (notmuch-show-tag tag-changes))
1897 (defun notmuch-show-remove-tag (tag-changes)
1898 "Change tags for the current message (defaulting to remove).
1900 Same as `notmuch-show-tag' but sets initial input to '-'."
1902 (list (notmuch-read-tag-changes (notmuch-show-get-tags) "Tag message" "-")))
1903 (notmuch-show-tag tag-changes))
1905 (defun notmuch-show-toggle-visibility-headers ()
1906 "Toggle the visibility of the current message headers."
1908 (let ((props (notmuch-show-get-message-properties)))
1909 (notmuch-show-headers-visible
1911 (not (plist-get props :headers-visible))))
1912 (force-window-update))
1914 (defun notmuch-show-toggle-message ()
1915 "Toggle the visibility of the current message."
1917 (let ((props (notmuch-show-get-message-properties)))
1918 (notmuch-show-message-visible
1920 (not (plist-get props :message-visible))))
1921 (force-window-update))
1923 (put 'notmuch-show-open-or-close-all 'notmuch-doc "Show all messages.")
1924 (put 'notmuch-show-open-or-close-all 'notmuch-prefix-doc "Hide all messages.")
1925 (defun notmuch-show-open-or-close-all ()
1926 "Set the visibility all of the messages in the current thread.
1928 By default make all of the messages visible. With a prefix
1929 argument, hide all of the messages."
1932 (goto-char (point-min))
1933 (loop do (notmuch-show-message-visible (notmuch-show-get-message-properties)
1934 (not current-prefix-arg))
1935 until (not (notmuch-show-goto-message-next))))
1936 (force-window-update))
1938 (defun notmuch-show-next-button ()
1939 "Advance point to the next button in the buffer."
1943 (defun notmuch-show-previous-button ()
1944 "Move point back to the previous button in the buffer."
1946 (backward-button 1))
1948 (defun notmuch-show-next-thread (&optional show previous)
1949 "Move to the next item in the search results, if any.
1951 If SHOW is non-nil, open the next item in a show
1952 buffer. Otherwise just highlight the next item in the search
1953 buffer. If PREVIOUS is non-nil, move to the previous item in the
1954 search results instead."
1956 (let ((parent-buffer notmuch-show-parent-buffer))
1957 (notmuch-bury-or-kill-this-buffer)
1958 (when (buffer-live-p parent-buffer)
1959 (switch-to-buffer parent-buffer)
1961 (notmuch-search-previous-thread)
1962 (notmuch-search-next-thread))
1964 (notmuch-search-show-thread)))))
1966 (defun notmuch-show-next-thread-show ()
1967 "Show the next thread in the search results, if any."
1969 (notmuch-show-next-thread t))
1971 (defun notmuch-show-previous-thread-show ()
1972 "Show the previous thread in the search results, if any."
1974 (notmuch-show-next-thread t t))
1976 (put 'notmuch-show-archive-thread 'notmuch-prefix-doc
1977 "Un-archive each message in thread.")
1978 (defun notmuch-show-archive-thread (&optional unarchive)
1979 "Archive each message in thread.
1981 Archive each message currently shown by applying the tag changes
1982 in `notmuch-archive-tags' to each. If a prefix argument is given,
1983 the messages will be \"unarchived\", i.e. the tag changes in
1984 `notmuch-archive-tags' will be reversed.
1986 Note: This command is safe from any race condition of new messages
1987 being delivered to the same thread. It does not archive the
1988 entire thread, but only the messages shown in the current
1991 (when notmuch-archive-tags
1992 (notmuch-show-tag-all
1993 (notmuch-tag-change-list notmuch-archive-tags unarchive))))
1995 (defun notmuch-show-archive-thread-then-next ()
1996 "Archive all messages in the current buffer, then show next thread from search."
1998 (notmuch-show-archive-thread)
1999 (notmuch-show-next-thread t))
2001 (defun notmuch-show-archive-thread-then-exit ()
2002 "Archive all messages in the current buffer, then exit back to search results."
2004 (notmuch-show-archive-thread)
2005 (notmuch-show-next-thread))
2007 (put 'notmuch-show-archive-message 'notmuch-prefix-doc
2008 "Un-archive the current message.")
2009 (defun notmuch-show-archive-message (&optional unarchive)
2010 "Archive the current message.
2012 Archive the current message by applying the tag changes in
2013 `notmuch-archive-tags' to it. If a prefix argument is given, the
2014 message will be \"unarchived\", i.e. the tag changes in
2015 `notmuch-archive-tags' will be reversed."
2017 (when notmuch-archive-tags
2018 (apply 'notmuch-show-tag-message
2019 (notmuch-tag-change-list notmuch-archive-tags unarchive))))
2021 (defun notmuch-show-archive-message-then-next-or-exit ()
2022 "Archive the current message, then show the next open message in the current thread.
2024 If at the last open message in the current thread, then exit back
2027 (notmuch-show-archive-message)
2028 (notmuch-show-next-open-message t))
2030 (defun notmuch-show-archive-message-then-next-or-next-thread ()
2031 "Archive the current message, then show the next open message in the current thread.
2033 If at the last open message in the current thread, then show next
2034 thread from search."
2036 (notmuch-show-archive-message)
2037 (unless (notmuch-show-next-open-message)
2038 (notmuch-show-next-thread t)))
2040 (defun notmuch-show-stash-cc ()
2041 "Copy CC field of current message to kill-ring."
2043 (notmuch-common-do-stash (notmuch-show-get-cc)))
2045 (defun notmuch-show-stash-date ()
2046 "Copy date of current message to kill-ring."
2048 (notmuch-common-do-stash (notmuch-show-get-date)))
2050 (defun notmuch-show-stash-filename ()
2051 "Copy filename of current message to kill-ring."
2053 (notmuch-common-do-stash (notmuch-show-get-filename)))
2055 (defun notmuch-show-stash-from ()
2056 "Copy From address of current message to kill-ring."
2058 (notmuch-common-do-stash (notmuch-show-get-from)))
2060 (put 'notmuch-show-stash-message-id 'notmuch-prefix-doc
2061 "Copy thread: query matching current thread to kill-ring.")
2062 (defun notmuch-show-stash-message-id (&optional stash-thread-id)
2063 "Copy id: query matching the current message to kill-ring.
2065 If invoked with a prefix argument (or STASH-THREAD-ID is
2066 non-nil), copy thread: query matching the current thread to
2070 (notmuch-common-do-stash notmuch-show-thread-id)
2071 (notmuch-common-do-stash (notmuch-show-get-message-id))))
2073 (defun notmuch-show-stash-message-id-stripped ()
2074 "Copy message ID of current message (sans `id:' prefix) to kill-ring."
2076 (notmuch-common-do-stash (notmuch-show-get-message-id t)))
2078 (defun notmuch-show-stash-subject ()
2079 "Copy Subject field of current message to kill-ring."
2081 (notmuch-common-do-stash (notmuch-show-get-subject)))
2083 (defun notmuch-show-stash-tags ()
2084 "Copy tags of current message to kill-ring as a comma separated list."
2086 (notmuch-common-do-stash (mapconcat 'identity (notmuch-show-get-tags) ",")))
2088 (defun notmuch-show-stash-to ()
2089 "Copy To address of current message to kill-ring."
2091 (notmuch-common-do-stash (notmuch-show-get-to)))
2093 (defun notmuch-show-stash-mlarchive-link (&optional mla)
2094 "Copy an ML Archive URI for the current message to the kill-ring.
2096 This presumes that the message is available at the selected Mailing List Archive.
2098 If optional argument MLA is non-nil, use the provided key instead of prompting
2099 the user (see `notmuch-show-stash-mlarchive-link-alist')."
2101 (let ((url (cdr (assoc
2103 (let ((completion-ignore-case t))
2105 "Mailing List Archive: "
2106 notmuch-show-stash-mlarchive-link-alist
2108 notmuch-show-stash-mlarchive-link-default)))
2109 notmuch-show-stash-mlarchive-link-alist))))
2110 (notmuch-common-do-stash
2112 (funcall url (notmuch-show-get-message-id t))
2113 (concat url (notmuch-show-get-message-id t))))))
2115 (defun notmuch-show-stash-mlarchive-link-and-go (&optional mla)
2116 "Copy an ML Archive URI for the current message to the kill-ring and visit it.
2118 This presumes that the message is available at the selected Mailing List Archive.
2120 If optional argument MLA is non-nil, use the provided key instead of prompting
2121 the user (see `notmuch-show-stash-mlarchive-link-alist')."
2123 (notmuch-show-stash-mlarchive-link mla)
2124 (browse-url (current-kill 0 t)))
2126 (defun notmuch-show-stash-git-helper (addresses prefix)
2127 "Escape, trim, quote, and add PREFIX to each address in list of ADDRESSES, and return the result as a single string."
2128 (mapconcat (lambda (x)
2130 ;; escape double-quotes
2131 (replace-regexp-in-string
2133 ;; trim leading and trailing spaces
2134 (replace-regexp-in-string
2135 "\\(^ *\\| *$\\)" ""
2139 (put 'notmuch-show-stash-git-send-email 'notmuch-prefix-doc
2140 "Copy From/To/Cc of current message to kill-ring in a form suitable for pasting to git send-email command line.")
2142 (defun notmuch-show-stash-git-send-email (&optional no-in-reply-to)
2143 "Copy From/To/Cc/Message-Id of current message to kill-ring in a form suitable for pasting to git send-email command line.
2145 If invoked with a prefix argument (or NO-IN-REPLY-TO is non-nil),
2146 omit --in-reply-to=<Message-Id>."
2148 (notmuch-common-do-stash
2149 (mapconcat 'identity
2152 (notmuch-show-stash-git-helper
2153 (message-tokenize-header (notmuch-show-get-from)) "--to=")
2154 (notmuch-show-stash-git-helper
2155 (message-tokenize-header (notmuch-show-get-to)) "--to=")
2156 (notmuch-show-stash-git-helper
2157 (message-tokenize-header (notmuch-show-get-cc)) "--cc=")
2158 (unless no-in-reply-to
2159 (notmuch-show-stash-git-helper
2160 (list (notmuch-show-get-message-id t)) "--in-reply-to="))))
2163 ;; Interactive part functions and their helpers
2165 (defun notmuch-show-generate-part-buffer (message-id nth)
2166 "Return a temporary buffer containing the specified part's content."
2167 (let ((buf (generate-new-buffer " *notmuch-part*"))
2168 (process-crypto notmuch-show-process-crypto))
2169 (with-current-buffer buf
2170 (setq notmuch-show-process-crypto process-crypto)
2171 ;; Always acquires the part via `notmuch part', even if it is
2172 ;; available in the SEXP output.
2173 (insert (notmuch-get-bodypart-internal message-id nth notmuch-show-process-crypto)))
2176 (defun notmuch-show-current-part-handle ()
2177 "Return an mm-handle for the part containing point.
2179 This creates a temporary buffer for the part's content; the
2180 caller is responsible for killing this buffer as appropriate."
2181 (let* ((part (notmuch-show-get-part-properties))
2182 (message-id (notmuch-show-get-message-id))
2183 (nth (plist-get part :id))
2184 (buf (notmuch-show-generate-part-buffer message-id nth))
2185 (computed-type (plist-get part :computed-type))
2186 (filename (plist-get part :filename))
2187 (disposition (if filename `(attachment (filename . ,filename)))))
2188 (mm-make-handle buf (list computed-type) nil nil disposition)))
2190 (defun notmuch-show-apply-to-current-part-handle (fn)
2191 "Apply FN to an mm-handle for the part containing point.
2193 This ensures that the temporary buffer created for the mm-handle
2194 is destroyed when FN returns."
2195 (let ((handle (notmuch-show-current-part-handle)))
2196 ;; emacs 24.3+ puts stdout/stderr into the calling buffer so we
2197 ;; call it from a temp-buffer, unless
2198 ;; notmuch-show-attachment-debug is non-nil in which case we put
2199 ;; it in " *notmuch-part*".
2201 (if notmuch-show-attachment-debug
2202 (with-current-buffer (generate-new-buffer " *notmuch-part*")
2203 (funcall fn handle))
2205 (funcall fn handle)))
2206 (kill-buffer (mm-handle-buffer handle)))))
2208 (defun notmuch-show-part-button-default (&optional button)
2210 (let ((button (or button (button-at (point)))))
2211 ;; Try to toggle the part, if that fails then call the default
2212 ;; action. The toggle fails if the part has no emacs renderable
2214 (unless (notmuch-show-toggle-part-invisibility button)
2215 (call-interactively notmuch-show-part-button-default-action))))
2217 (defun notmuch-show-save-part ()
2218 "Save the MIME part containing point to a file."
2220 (notmuch-show-apply-to-current-part-handle #'mm-save-part))
2222 (defun notmuch-show-view-part ()
2223 "View the MIME part containing point in an external viewer."
2225 ;; Set mm-inlined-types to nil to force an external viewer
2226 (let ((mm-inlined-types nil))
2227 (notmuch-show-apply-to-current-part-handle #'mm-display-part)))
2229 (defun notmuch-show-interactively-view-part ()
2230 "View the MIME part containing point, prompting for a viewer."
2232 (notmuch-show-apply-to-current-part-handle #'mm-interactively-view-part))
2234 (defun notmuch-show-pipe-part ()
2235 "Pipe the MIME part containing point to an external command."
2237 (notmuch-show-apply-to-current-part-handle #'mm-pipe-part))
2240 (provide 'notmuch-show)