emacs: add `notmuch-show-stash-mlarchive-link{, -and-go}'
[notmuch] / emacs / notmuch-show.el
1 ;; notmuch-show.el --- displaying notmuch forests.
2 ;;
3 ;; Copyright © Carl Worth
4 ;; Copyright © David Edmondson
5 ;;
6 ;; This file is part of Notmuch.
7 ;;
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.
12 ;;
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.
17 ;;
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/>.
20 ;;
21 ;; Authors: Carl Worth <cworth@cworth.org>
22 ;;          David Edmondson <dme@dme.org>
23
24 (eval-when-compile (require 'cl))
25 (require 'mm-view)
26 (require 'message)
27 (require 'mm-decode)
28 (require 'mailcap)
29 (require 'icalendar)
30 (require 'goto-addr)
31
32 (require 'notmuch-lib)
33 (require 'notmuch-query)
34 (require 'notmuch-wash)
35 (require 'notmuch-mua)
36 (require 'notmuch-crypto)
37 (require 'notmuch-print)
38
39 (declare-function notmuch-call-notmuch-process "notmuch" (&rest args))
40 (declare-function notmuch-fontify-headers "notmuch" nil)
41 (declare-function notmuch-read-tag-changes "notmuch" (&optional initial-input &rest search-terms))
42 (declare-function notmuch-search-next-thread "notmuch" nil)
43 (declare-function notmuch-search-show-thread "notmuch" nil)
44 (declare-function notmuch-update-tags "notmuch" (current-tags tag-changes))
45
46 (defcustom notmuch-message-headers '("Subject" "To" "Cc" "Date")
47   "Headers that should be shown in a message, in this order.
48
49 For an open message, all of these headers will be made visible
50 according to `notmuch-message-headers-visible' or can be toggled
51 with `notmuch-show-toggle-headers'. For a closed message, only
52 the first header in the list will be visible."
53   :type '(repeat string)
54   :group 'notmuch-show)
55
56 (defcustom notmuch-message-headers-visible t
57   "Should the headers be visible by default?
58
59 If this value is non-nil, then all of the headers defined in
60 `notmuch-message-headers' will be visible by default in the display
61 of each message. Otherwise, these headers will be hidden and
62 `notmuch-show-toggle-headers' can be used to make the visible for
63 any given message."
64   :type 'boolean
65   :group 'notmuch-show)
66
67 (defcustom notmuch-show-relative-dates t
68   "Display relative dates in the message summary line."
69   :type 'boolean
70   :group 'notmuch-show)
71
72 (defvar notmuch-show-markup-headers-hook '(notmuch-show-colour-headers)
73   "A list of functions called to decorate the headers listed in
74 `notmuch-message-headers'.")
75
76 (defcustom notmuch-show-hook '(notmuch-show-turn-on-visual-line-mode)
77   "Functions called after populating a `notmuch-show' buffer."
78   :type 'hook
79   :options '(notmuch-show-turn-on-visual-line-mode)
80   :group 'notmuch-show
81   :group 'notmuch-hooks)
82
83 (defcustom notmuch-show-insert-text/plain-hook '(notmuch-wash-wrap-long-lines
84                                                  notmuch-wash-tidy-citations
85                                                  notmuch-wash-elide-blank-lines
86                                                  notmuch-wash-excerpt-citations)
87   "Functions used to improve the display of text/plain parts."
88   :type 'hook
89   :options '(notmuch-wash-convert-inline-patch-to-part
90              notmuch-wash-wrap-long-lines
91              notmuch-wash-tidy-citations
92              notmuch-wash-elide-blank-lines
93              notmuch-wash-excerpt-citations)
94   :group 'notmuch-show
95   :group 'notmuch-hooks)
96
97 ;; Mostly useful for debugging.
98 (defcustom notmuch-show-all-multipart/alternative-parts t
99   "Should all parts of multipart/alternative parts be shown?"
100   :type 'boolean
101   :group 'notmuch-show)
102
103 (defcustom notmuch-show-indent-messages-width 1
104   "Width of message indentation in threads.
105
106 Messages are shown indented according to their depth in a thread.
107 This variable determines the width of this indentation measured
108 in number of blanks.  Defaults to `1', choose `0' to disable
109 indentation."
110   :type 'integer
111   :group 'notmuch-show)
112
113 (defcustom notmuch-show-indent-multipart nil
114   "Should the sub-parts of a multipart/* part be indented?"
115   ;; dme: Not sure which is a good default.
116   :type 'boolean
117   :group 'notmuch-show)
118
119 (defcustom notmuch-show-part-button-default-action 'notmuch-show-save-part
120   "Default part header button action (on ENTER or mouse click)."
121   :group 'notmuch-show
122   :type '(choice (const :tag "Save part"
123                         notmuch-show-save-part)
124                  (const :tag "View part"
125                         notmuch-show-view-part)
126                  (const :tag "View interactively"
127                         notmuch-show-interactively-view-part)))
128
129 (defcustom notmuch-show-only-matching-messages nil
130   "Only matching messages are shown by default."
131   :type 'boolean
132   :group 'notmuch-show)
133
134 (defvar notmuch-show-thread-id nil)
135 (make-variable-buffer-local 'notmuch-show-thread-id)
136 (put 'notmuch-show-thread-id 'permanent-local t)
137
138 (defvar notmuch-show-parent-buffer nil)
139 (make-variable-buffer-local 'notmuch-show-parent-buffer)
140 (put 'notmuch-show-parent-buffer 'permanent-local t)
141
142 (defvar notmuch-show-query-context nil)
143 (make-variable-buffer-local 'notmuch-show-query-context)
144 (put 'notmuch-show-query-context 'permanent-local t)
145
146 (defvar notmuch-show-process-crypto nil)
147 (make-variable-buffer-local 'notmuch-show-process-crypto)
148 (put 'notmuch-show-process-crypto 'permanent-local t)
149
150 (defvar notmuch-show-elide-non-matching-messages nil)
151 (make-variable-buffer-local 'notmuch-show-elide-non-matching-messages)
152 (put 'notmuch-show-elide-non-matching-messages 'permanent-local t)
153
154 (defvar notmuch-show-indent-content t)
155 (make-variable-buffer-local 'notmuch-show-indent-content)
156 (put 'notmuch-show-indent-content 'permanent-local t)
157
158 (defcustom notmuch-show-stash-mlarchive-link-alist
159   '(("Gmane" . "http://mid.gmane.org/")
160     ("MARC" . "http://marc.info/?i=")
161     ("Mail Archive, The" . "http://mail-archive.com/search?l=mid&q=")
162     ;; FIXME: can these services be searched by `Message-Id' ?
163     ;; ("MarkMail" . "http://markmail.org/")
164     ;; ("Nabble" . "http://nabble.com/")
165     ;; ("opensubscriber" . "http://opensubscriber.com/")
166     )
167   "List of Mailing List Archives to use when stashing links.
168
169 These URIs are concatenated with the current message's
170 Message-Id in `notmuch-show-stash-mlarchive-link'."
171   :type '(alist :key-type (string :tag "Name")
172                 :value-type (string :tag "URL"))
173   :group 'notmuch-show)
174
175 (defcustom notmuch-show-stash-mlarchive-link-default "Gmane"
176   "Default Mailing List Archive to use when stashing links.
177
178 This is used when `notmuch-show-stash-mlarchive-link' isn't
179 provided with an MLA argument nor `completing-read' input."
180   :type `(choice
181           ,@(mapcar
182              (lambda (mla)
183                (list 'const :tag (car mla) :value (car mla)))
184              notmuch-show-stash-mlarchive-link-alist))
185   :group 'notmuch-show)
186
187 (defmacro with-current-notmuch-show-message (&rest body)
188   "Evaluate body with current buffer set to the text of current message"
189   `(save-excursion
190      (let ((id (notmuch-show-get-message-id)))
191        (let ((buf (generate-new-buffer (concat "*notmuch-msg-" id "*"))))
192          (with-current-buffer buf
193             (call-process notmuch-command nil t nil "show" "--format=raw" id)
194            ,@body)
195          (kill-buffer buf)))))
196
197 (defun notmuch-show-turn-on-visual-line-mode ()
198   "Enable Visual Line mode."
199   (visual-line-mode t))
200
201 (defun notmuch-show-view-all-mime-parts ()
202   "Use external viewers to view all attachments from the current message."
203   (interactive)
204   (with-current-notmuch-show-message
205    ;; We override the mm-inline-media-tests to indicate which message
206    ;; parts are already sufficiently handled by the original
207    ;; presentation of the message in notmuch-show mode. These parts
208    ;; will be inserted directly into the temporary buffer of
209    ;; with-current-notmuch-show-message and silently discarded.
210    ;;
211    ;; Any MIME part not explicitly mentioned here will be handled by an
212    ;; external viewer as configured in the various mailcap files.
213    (let ((mm-inline-media-tests '(
214                                   ("text/.*" ignore identity)
215                                   ("application/pgp-signature" ignore identity)
216                                   ("multipart/alternative" ignore identity)
217                                   ("multipart/mixed" ignore identity)
218                                   ("multipart/related" ignore identity)
219                                  )))
220      (mm-display-parts (mm-dissect-buffer)))))
221
222 (defun notmuch-foreach-mime-part (function mm-handle)
223   (cond ((stringp (car mm-handle))
224          (dolist (part (cdr mm-handle))
225            (notmuch-foreach-mime-part function part)))
226         ((bufferp (car mm-handle))
227          (funcall function mm-handle))
228         (t (dolist (part mm-handle)
229              (notmuch-foreach-mime-part function part)))))
230
231 (defun notmuch-count-attachments (mm-handle)
232   (let ((count 0))
233     (notmuch-foreach-mime-part
234      (lambda (p)
235        (let ((disposition (mm-handle-disposition p)))
236          (and (listp disposition)
237               (or (equal (car disposition) "attachment")
238                   (and (equal (car disposition) "inline")
239                        (assq 'filename disposition)))
240               (incf count))))
241      mm-handle)
242     count))
243
244 (defun notmuch-save-attachments (mm-handle &optional queryp)
245   (notmuch-foreach-mime-part
246    (lambda (p)
247      (let ((disposition (mm-handle-disposition p)))
248        (and (listp disposition)
249             (or (equal (car disposition) "attachment")
250                 (and (equal (car disposition) "inline")
251                      (assq 'filename disposition)))
252             (or (not queryp)
253                 (y-or-n-p
254                  (concat "Save '" (cdr (assq 'filename disposition)) "' ")))
255             (mm-save-part p))))
256    mm-handle))
257
258 (defun notmuch-show-save-attachments ()
259   "Save all attachments from the current message."
260   (interactive)
261   (with-current-notmuch-show-message
262    (let ((mm-handle (mm-dissect-buffer)))
263      (notmuch-save-attachments
264       mm-handle (> (notmuch-count-attachments mm-handle) 1))))
265   (message "Done"))
266
267 (defun notmuch-show-with-message-as-text (fn)
268   "Apply FN to a text representation of the current message.
269
270 FN is called with one argument, the message properties. It should
271 operation on the contents of the current buffer."
272
273   ;; Remake the header to ensure that all information is available.
274   (let* ((to (notmuch-show-get-to))
275          (cc (notmuch-show-get-cc))
276          (from (notmuch-show-get-from))
277          (subject (notmuch-show-get-subject))
278          (date (notmuch-show-get-date))
279          (tags (notmuch-show-get-tags))
280          (depth (notmuch-show-get-depth))
281
282          (header (concat
283                   "Subject: " subject "\n"
284                   "To: " to "\n"
285                   (if (not (string= cc ""))
286                       (concat "Cc: " cc "\n")
287                     "")
288                   "From: " from "\n"
289                   "Date: " date "\n"
290                   (if tags
291                       (concat "Tags: "
292                               (mapconcat #'identity tags ", ") "\n")
293                     "")))
294          (all (buffer-substring (notmuch-show-message-top)
295                                 (notmuch-show-message-bottom)))
296
297          (props (notmuch-show-get-message-properties))
298          (indenting notmuch-show-indent-content))
299     (with-temp-buffer
300       (insert all)
301       (if indenting
302           (indent-rigidly (point-min) (point-max) (- depth)))
303       ;; Remove the original header.
304       (goto-char (point-min))
305       (re-search-forward "^$" (point-max) nil)
306       (delete-region (point-min) (point))
307       (insert header)
308       (funcall fn props))))
309
310 (defun notmuch-show-print-message ()
311   "Print the current message."
312   (interactive)
313   (notmuch-show-with-message-as-text 'notmuch-print-message))
314
315 (defun notmuch-show-fontify-header ()
316   (let ((face (cond
317                ((looking-at "[Tt]o:")
318                 'message-header-to)
319                ((looking-at "[Bb]?[Cc][Cc]:")
320                 'message-header-cc)
321                ((looking-at "[Ss]ubject:")
322                 'message-header-subject)
323                ((looking-at "[Ff]rom:")
324                 'message-header-from)
325                (t
326                 'message-header-other))))
327
328     (overlay-put (make-overlay (point) (re-search-forward ":"))
329                  'face 'message-header-name)
330     (overlay-put (make-overlay (point) (re-search-forward ".*$"))
331                  'face face)))
332
333 (defun notmuch-show-colour-headers ()
334   "Apply some colouring to the current headers."
335   (goto-char (point-min))
336   (while (looking-at "^[A-Za-z][-A-Za-z0-9]*:")
337     (notmuch-show-fontify-header)
338     (forward-line)))
339
340 (defun notmuch-show-spaces-n (n)
341   "Return a string comprised of `n' spaces."
342   (make-string n ? ))
343
344 (defun notmuch-show-update-tags (tags)
345   "Update the displayed tags of the current message."
346   (save-excursion
347     (goto-char (notmuch-show-message-top))
348     (if (re-search-forward "(\\([^()]*\\))$" (line-end-position) t)
349         (let ((inhibit-read-only t))
350           (replace-match (concat "("
351                                  (propertize (mapconcat 'identity tags " ")
352                                              'face 'notmuch-tag-face)
353                                  ")"))))))
354
355 (defun notmuch-show-clean-address (address)
356   "Try to clean a single email ADDRESS for display.  Return
357 unchanged ADDRESS if parsing fails."
358   (condition-case nil
359     (let (p-name p-address)
360       ;; It would be convenient to use `mail-header-parse-address',
361       ;; but that expects un-decoded mailbox parts, whereas our
362       ;; mailbox parts are already decoded (and hence may contain
363       ;; UTF-8). Given that notmuch should handle most of the awkward
364       ;; cases, some simple string deconstruction should be sufficient
365       ;; here.
366       (cond
367        ;; "User <user@dom.ain>" style.
368        ((string-match "\\(.*\\) <\\(.*\\)>" address)
369         (setq p-name (match-string 1 address)
370               p-address (match-string 2 address)))
371
372        ;; "<user@dom.ain>" style.
373        ((string-match "<\\(.*\\)>" address)
374         (setq p-address (match-string 1 address)))
375
376        ;; Everything else.
377        (t
378         (setq p-address address)))
379
380       (when p-name
381         ;; Remove elements of the mailbox part that are not relevant for
382         ;; display, even if they are required during transport:
383         ;;
384         ;; Backslashes.
385         (setq p-name (replace-regexp-in-string "\\\\" "" p-name))
386
387         ;; Outer single and double quotes, which might be nested.
388         (loop
389          with start-of-loop
390          do (setq start-of-loop p-name)
391
392          when (string-match "^\"\\(.*\\)\"$" p-name)
393          do (setq p-name (match-string 1 p-name))
394
395          when (string-match "^'\\(.*\\)'$" p-name)
396          do (setq p-name (match-string 1 p-name))
397
398          until (string= start-of-loop p-name)))
399
400       ;; If the address is 'foo@bar.com <foo@bar.com>' then show just
401       ;; 'foo@bar.com'.
402       (when (string= p-name p-address)
403         (setq p-name nil))
404
405       ;; If no name results, return just the address.
406       (if (not p-name)
407           p-address
408         ;; Otherwise format the name and address together.
409         (concat p-name " <" p-address ">")))
410     (error address)))
411
412 (defun notmuch-show-insert-headerline (headers date tags depth)
413   "Insert a notmuch style headerline based on HEADERS for a
414 message at DEPTH in the current thread."
415   (let ((start (point)))
416     (insert (notmuch-show-spaces-n (* notmuch-show-indent-messages-width depth))
417             (notmuch-show-clean-address (plist-get headers :From))
418             " ("
419             date
420             ") ("
421             (propertize (mapconcat 'identity tags " ")
422                         'face 'notmuch-tag-face)
423             ")\n")
424     (overlay-put (make-overlay start (point)) 'face 'notmuch-message-summary-face)))
425
426 (defun notmuch-show-insert-header (header header-value)
427   "Insert a single header."
428   (insert header ": " header-value "\n"))
429
430 (defun notmuch-show-insert-headers (headers)
431   "Insert the headers of the current message."
432   (let ((start (point)))
433     (mapc (lambda (header)
434             (let* ((header-symbol (intern (concat ":" header)))
435                    (header-value (plist-get headers header-symbol)))
436               (if (and header-value
437                        (not (string-equal "" header-value)))
438                   (notmuch-show-insert-header header header-value))))
439           notmuch-message-headers)
440     (save-excursion
441       (save-restriction
442         (narrow-to-region start (point-max))
443         (run-hooks 'notmuch-show-markup-headers-hook)))))
444
445 (define-button-type 'notmuch-show-part-button-type
446   'action 'notmuch-show-part-button-default
447   'keymap 'notmuch-show-part-button-map
448   'follow-link t
449   'face 'message-mml)
450
451 (defvar notmuch-show-part-button-map
452   (let ((map (make-sparse-keymap)))
453     (set-keymap-parent map button-map)
454     (define-key map "s" 'notmuch-show-part-button-save)
455     (define-key map "v" 'notmuch-show-part-button-view)
456     (define-key map "o" 'notmuch-show-part-button-interactively-view)
457     map)
458   "Submap for button commands")
459 (fset 'notmuch-show-part-button-map notmuch-show-part-button-map)
460
461 (defun notmuch-show-insert-part-header (nth content-type declared-type &optional name comment)
462   (let ((button))
463     (setq button
464           (insert-button
465            (concat "[ "
466                    (if name (concat name ": ") "")
467                    declared-type
468                    (if (not (string-equal declared-type content-type))
469                        (concat " (as " content-type ")")
470                      "")
471                    (or comment "")
472                    " ]")
473            :type 'notmuch-show-part-button-type
474            :notmuch-part nth
475            :notmuch-filename name
476            :notmuch-content-type content-type))
477     (insert "\n")
478     ;; return button
479     button))
480
481 ;; Functions handling particular MIME parts.
482
483 (defmacro notmuch-with-temp-part-buffer (message-id nth &rest body)
484   (declare (indent 2))
485   (let ((process-crypto (make-symbol "process-crypto")))
486     `(let ((,process-crypto notmuch-show-process-crypto))
487        (with-temp-buffer
488          (setq notmuch-show-process-crypto ,process-crypto)
489          ;; Always acquires the part via `notmuch part', even if it is
490          ;; available in the JSON output.
491          (insert (notmuch-show-get-bodypart-internal ,message-id ,nth))
492          ,@body))))
493
494 (defun notmuch-show-save-part (message-id nth &optional filename content-type)
495   (notmuch-with-temp-part-buffer message-id nth
496     (let ((file (read-file-name
497                  "Filename to save as: "
498                  (or mailcap-download-directory "~/")
499                  nil nil
500                  filename)))
501       ;; Don't re-compress .gz & al.  Arguably we should make
502       ;; `file-name-handler-alist' nil, but that would chop
503       ;; ange-ftp, which is reasonable to use here.
504       (mm-write-region (point-min) (point-max) file nil nil nil 'no-conversion t))))
505
506 (defun notmuch-show-view-part (message-id nth &optional filename content-type )
507   (notmuch-with-temp-part-buffer message-id nth
508     ;; set mm-inlined-types to nil to force an external viewer
509     (let ((handle (mm-make-handle (current-buffer) (list content-type)))
510           (mm-inlined-types nil))
511       ;; We override mm-save-part as notmuch-show-save-part is better
512       ;; since it offers the filename. We need to lexically bind
513       ;; everything we need for notmuch-show-save-part to prevent
514       ;; potential dynamic shadowing.
515       (lexical-let ((message-id message-id)
516                     (nth nth)
517                     (filename filename)
518                     (content-type content-type))
519         (flet ((mm-save-part (&rest args) (notmuch-show-save-part
520                                            message-id nth filename content-type)))
521           (mm-display-part handle))))))
522
523 (defun notmuch-show-interactively-view-part (message-id nth &optional filename content-type)
524   (notmuch-with-temp-part-buffer message-id nth
525     (let ((handle (mm-make-handle (current-buffer) (list content-type))))
526       (mm-interactively-view-part handle))))
527
528 (defun notmuch-show-mm-display-part-inline (msg part nth content-type)
529   "Use the mm-decode/mm-view functions to display a part in the
530 current buffer, if possible."
531   (let ((display-buffer (current-buffer)))
532     (with-temp-buffer
533       (let* ((charset (plist-get part :content-charset))
534              (handle (mm-make-handle (current-buffer) `(,content-type (charset . ,charset)))))
535         ;; If the user wants the part inlined, insert the content and
536         ;; test whether we are able to inline it (which includes both
537         ;; capability and suitability tests).
538         (when (mm-inlined-p handle)
539           (insert (notmuch-show-get-bodypart-content msg part nth))
540           (when (mm-inlinable-p handle)
541             (set-buffer display-buffer)
542             (mm-display-part handle)
543             t))))))
544
545 (defvar notmuch-show-multipart/alternative-discouraged
546   '(
547     ;; Avoid HTML parts.
548     "text/html"
549     ;; multipart/related usually contain a text/html part and some associated graphics.
550     "multipart/related"
551     ))
552
553 (defun notmuch-show-multipart/*-to-list (part)
554   (mapcar (lambda (inner-part) (plist-get inner-part :content-type))
555           (plist-get part :content)))
556
557 (defun notmuch-show-multipart/alternative-choose (types)
558   ;; Based on `mm-preferred-alternative-precedence'.
559   (let ((seq types))
560     (dolist (pref (reverse notmuch-show-multipart/alternative-discouraged))
561       (dolist (elem (copy-sequence seq))
562         (when (string-match pref elem)
563           (setq seq (nconc (delete elem seq) (list elem))))))
564     seq))
565
566 (defun notmuch-show-insert-part-multipart/alternative (msg part content-type nth depth declared-type)
567   (notmuch-show-insert-part-header nth declared-type content-type nil)
568   (let ((chosen-type (car (notmuch-show-multipart/alternative-choose (notmuch-show-multipart/*-to-list part))))
569         (inner-parts (plist-get part :content))
570         (start (point)))
571     ;; This inserts all parts of the chosen type rather than just one,
572     ;; but it's not clear that this is the wrong thing to do - which
573     ;; should be chosen if there are more than one that match?
574     (mapc (lambda (inner-part)
575             (let ((inner-type (plist-get inner-part :content-type)))
576               (if (or notmuch-show-all-multipart/alternative-parts
577                       (string= chosen-type inner-type))
578                   (notmuch-show-insert-bodypart msg inner-part depth)
579                 (notmuch-show-insert-part-header (plist-get inner-part :id) inner-type inner-type nil " (not shown)"))))
580           inner-parts)
581
582     (when notmuch-show-indent-multipart
583       (indent-rigidly start (point) 1)))
584   t)
585
586 (defun notmuch-show-setup-w3m ()
587   "Instruct w3m how to retrieve content from a \"related\" part of a message."
588   (interactive)
589   (if (boundp 'w3m-cid-retrieve-function-alist)
590     (unless (assq 'notmuch-show-mode w3m-cid-retrieve-function-alist)
591       (push (cons 'notmuch-show-mode 'notmuch-show-w3m-cid-retrieve)
592             w3m-cid-retrieve-function-alist)))
593   (setq mm-inline-text-html-with-images t))
594
595 (defvar w3m-current-buffer) ;; From `w3m.el'.
596 (defvar notmuch-show-w3m-cid-store nil)
597 (make-variable-buffer-local 'notmuch-show-w3m-cid-store)
598
599 (defun notmuch-show-w3m-cid-store-internal (content-id
600                                             message-id
601                                             part-number
602                                             content-type
603                                             content)
604   (push (list content-id
605               message-id
606               part-number
607               content-type
608               content)
609         notmuch-show-w3m-cid-store))
610
611 (defun notmuch-show-w3m-cid-store (msg part)
612   (let ((content-id (plist-get part :content-id)))
613     (when content-id
614       (notmuch-show-w3m-cid-store-internal (concat "cid:" content-id)
615                                            (plist-get msg :id)
616                                            (plist-get part :id)
617                                            (plist-get part :content-type)
618                                            nil))))
619
620 (defun notmuch-show-w3m-cid-retrieve (url &rest args)
621   (let ((matching-part (with-current-buffer w3m-current-buffer
622                          (assoc url notmuch-show-w3m-cid-store))))
623     (if matching-part
624         (let ((message-id (nth 1 matching-part))
625               (part-number (nth 2 matching-part))
626               (content-type (nth 3 matching-part))
627               (content (nth 4 matching-part)))
628           ;; If we don't already have the content, get it and cache
629           ;; it, as some messages reference the same cid: part many
630           ;; times (hundreds!), which results in many calls to
631           ;; `notmuch part'.
632           (unless content
633             (setq content (notmuch-show-get-bodypart-internal (concat "id:" message-id)
634                                                               part-number))
635             (with-current-buffer w3m-current-buffer
636               (notmuch-show-w3m-cid-store-internal url
637                                                    message-id
638                                                    part-number
639                                                    content-type
640                                                    content)))
641           (insert content)
642           content-type)
643       nil)))
644
645 (defun notmuch-show-insert-part-multipart/related (msg part content-type nth depth declared-type)
646   (notmuch-show-insert-part-header nth declared-type content-type nil)
647   (let ((inner-parts (plist-get part :content))
648         (start (point)))
649
650     ;; We assume that the first part is text/html and the remainder
651     ;; things that it references.
652
653     ;; Stash the non-primary parts.
654     (mapc (lambda (part)
655             (notmuch-show-w3m-cid-store msg part))
656           (cdr inner-parts))
657
658     ;; Render the primary part.
659     (notmuch-show-insert-bodypart msg (car inner-parts) depth)
660
661     (when notmuch-show-indent-multipart
662       (indent-rigidly start (point) 1)))
663   t)
664
665 (defun notmuch-show-insert-part-multipart/signed (msg part content-type nth depth declared-type)
666   (let ((button (notmuch-show-insert-part-header nth declared-type content-type nil)))
667     (button-put button 'face 'notmuch-crypto-part-header)
668     ;; add signature status button if sigstatus provided
669     (if (plist-member part :sigstatus)
670         (let* ((from (notmuch-show-get-header :From msg))
671                (sigstatus (car (plist-get part :sigstatus))))
672           (notmuch-crypto-insert-sigstatus-button sigstatus from))
673       ;; if we're not adding sigstatus, tell the user how they can get it
674       (button-put button 'help-echo "Set notmuch-crypto-process-mime to process cryptographic MIME parts.")))
675
676   (let ((inner-parts (plist-get part :content))
677         (start (point)))
678     ;; Show all of the parts.
679     (mapc (lambda (inner-part)
680             (notmuch-show-insert-bodypart msg inner-part depth))
681           inner-parts)
682
683     (when notmuch-show-indent-multipart
684       (indent-rigidly start (point) 1)))
685   t)
686
687 (defun notmuch-show-insert-part-multipart/encrypted (msg part content-type nth depth declared-type)
688   (let ((button (notmuch-show-insert-part-header nth declared-type content-type nil)))
689     (button-put button 'face 'notmuch-crypto-part-header)
690     ;; add encryption status button if encstatus specified
691     (if (plist-member part :encstatus)
692         (let ((encstatus (car (plist-get part :encstatus))))
693           (notmuch-crypto-insert-encstatus-button encstatus)
694           ;; add signature status button if sigstatus specified
695           (if (plist-member part :sigstatus)
696               (let* ((from (notmuch-show-get-header :From msg))
697                      (sigstatus (car (plist-get part :sigstatus))))
698                 (notmuch-crypto-insert-sigstatus-button sigstatus from))))
699       ;; if we're not adding encstatus, tell the user how they can get it
700       (button-put button 'help-echo "Set notmuch-crypto-process-mime to process cryptographic MIME parts.")))
701
702   (let ((inner-parts (plist-get part :content))
703         (start (point)))
704     ;; Show all of the parts.
705     (mapc (lambda (inner-part)
706             (notmuch-show-insert-bodypart msg inner-part depth))
707           inner-parts)
708
709     (when notmuch-show-indent-multipart
710       (indent-rigidly start (point) 1)))
711   t)
712
713 (defun notmuch-show-insert-part-multipart/* (msg part content-type nth depth declared-type)
714   (notmuch-show-insert-part-header nth declared-type content-type nil)
715   (let ((inner-parts (plist-get part :content))
716         (start (point)))
717     ;; Show all of the parts.
718     (mapc (lambda (inner-part)
719             (notmuch-show-insert-bodypart msg inner-part depth))
720           inner-parts)
721
722     (when notmuch-show-indent-multipart
723       (indent-rigidly start (point) 1)))
724   t)
725
726 (defun notmuch-show-insert-part-message/rfc822 (msg part content-type nth depth declared-type)
727   (notmuch-show-insert-part-header nth declared-type content-type nil)
728   (let* ((message (car (plist-get part :content)))
729          (body (car (plist-get message :body)))
730          (start (point)))
731
732     ;; Override `notmuch-message-headers' to force `From' to be
733     ;; displayed.
734     (let ((notmuch-message-headers '("From" "Subject" "To" "Cc" "Date")))
735       (notmuch-show-insert-headers (plist-get message :headers)))
736
737     ;; Blank line after headers to be compatible with the normal
738     ;; message display.
739     (insert "\n")
740
741     ;; Show the body
742     (notmuch-show-insert-bodypart msg body depth)
743
744     (when notmuch-show-indent-multipart
745       (indent-rigidly start (point) 1)))
746   t)
747
748 (defun notmuch-show-insert-part-text/plain (msg part content-type nth depth declared-type)
749   (let ((start (point)))
750     ;; If this text/plain part is not the first part in the message,
751     ;; insert a header to make this clear.
752     (if (> nth 1)
753         (notmuch-show-insert-part-header nth declared-type content-type (plist-get part :filename)))
754     (insert (notmuch-show-get-bodypart-content msg part nth))
755     (save-excursion
756       (save-restriction
757         (narrow-to-region start (point-max))
758         (run-hook-with-args 'notmuch-show-insert-text/plain-hook msg depth))))
759   t)
760
761 (defun notmuch-show-insert-part-text/calendar (msg part content-type nth depth declared-type)
762   (notmuch-show-insert-part-header nth declared-type content-type (plist-get part :filename))
763   (insert (with-temp-buffer
764             (insert (notmuch-show-get-bodypart-content msg part nth))
765             (goto-char (point-min))
766             (let ((file (make-temp-file "notmuch-ical"))
767                   result)
768               (icalendar--convert-ical-to-diary
769                (icalendar--read-element nil nil)
770                file t)
771               (set-buffer (get-file-buffer file))
772               (setq result (buffer-substring (point-min) (point-max)))
773               (set-buffer-modified-p nil)
774               (kill-buffer (current-buffer))
775               (delete-file file)
776               result)))
777   t)
778
779 ;; For backwards compatibility.
780 (defun notmuch-show-insert-part-text/x-vcalendar (msg part content-type nth depth declared-type)
781   (notmuch-show-insert-part-text/calendar msg part content-type nth depth declared-type))
782
783 (defun notmuch-show-insert-part-application/octet-stream (msg part content-type nth depth declared-type)
784   ;; If we can deduce a MIME type from the filename of the attachment,
785   ;; do so and pass it on to the handler for that type.
786   (if (plist-get part :filename)
787       (let ((extension (file-name-extension (plist-get part :filename)))
788             mime-type)
789         (if extension
790             (progn
791               (mailcap-parse-mimetypes)
792               (setq mime-type (mailcap-extension-to-mime extension))
793               (if (and mime-type
794                        (not (string-equal mime-type "application/octet-stream")))
795                   (notmuch-show-insert-bodypart-internal msg part mime-type nth depth content-type)
796                 nil))
797           nil))))
798
799 ;; Handler for wash generated inline patch fake parts.
800 (defun notmuch-show-insert-part-inline-patch-fake-part (msg part content-type nth depth declared-type)
801   (notmuch-show-insert-part-*/* msg part "text/x-diff" nth depth "inline patch"))
802
803 (defun notmuch-show-insert-part-*/* (msg part content-type nth depth declared-type)
804   ;; This handler _must_ succeed - it is the handler of last resort.
805   (notmuch-show-insert-part-header nth content-type declared-type (plist-get part :filename))
806   (notmuch-show-mm-display-part-inline msg part nth content-type)
807   t)
808
809 ;; Functions for determining how to handle MIME parts.
810
811 (defun notmuch-show-split-content-type (content-type)
812   (split-string content-type "/"))
813
814 (defun notmuch-show-handlers-for (content-type)
815   "Return a list of content handlers for a part of type CONTENT-TYPE."
816   (let (result)
817     (mapc (lambda (func)
818             (if (functionp func)
819                 (push func result)))
820           ;; Reverse order of prefrence.
821           (list (intern (concat "notmuch-show-insert-part-*/*"))
822                 (intern (concat
823                          "notmuch-show-insert-part-"
824                          (car (notmuch-show-split-content-type content-type))
825                          "/*"))
826                 (intern (concat "notmuch-show-insert-part-" content-type))))
827     result))
828
829 ;; Helper for parts which are generally not included in the default
830 ;; JSON output.
831 (defun notmuch-show-get-bodypart-internal (message-id part-number)
832   (let ((args '("show" "--format=raw"))
833         (part-arg (format "--part=%s" part-number)))
834     (setq args (append args (list part-arg)))
835     (if notmuch-show-process-crypto
836         (setq args (append args '("--decrypt"))))
837     (setq args (append args (list message-id)))
838     (with-temp-buffer
839       (let ((coding-system-for-read 'no-conversion))
840         (progn
841           (apply 'call-process (append (list notmuch-command nil (list t nil) nil) args))
842           (buffer-string))))))
843
844 (defun notmuch-show-get-bodypart-content (msg part nth)
845   (or (plist-get part :content)
846       (notmuch-show-get-bodypart-internal (concat "id:" (plist-get msg :id)) nth)))
847
848 ;; \f
849
850 (defun notmuch-show-insert-bodypart-internal (msg part content-type nth depth declared-type)
851   (let ((handlers (notmuch-show-handlers-for content-type)))
852     ;; Run the content handlers until one of them returns a non-nil
853     ;; value.
854     (while (and handlers
855                 (not (funcall (car handlers) msg part content-type nth depth declared-type)))
856       (setq handlers (cdr handlers))))
857   t)
858
859 (defun notmuch-show-insert-bodypart (msg part depth)
860   "Insert the body part PART at depth DEPTH in the current thread."
861   (let ((content-type (downcase (plist-get part :content-type)))
862         (nth (plist-get part :id)))
863     (notmuch-show-insert-bodypart-internal msg part content-type nth depth content-type))
864   ;; Some of the body part handlers leave point somewhere up in the
865   ;; part, so we make sure that we're down at the end.
866   (goto-char (point-max))
867   ;; Ensure that the part ends with a carriage return.
868   (unless (bolp)
869     (insert "\n")))
870
871 (defun notmuch-show-insert-body (msg body depth)
872   "Insert the body BODY at depth DEPTH in the current thread."
873   (mapc (lambda (part) (notmuch-show-insert-bodypart msg part depth)) body))
874
875 (defun notmuch-show-make-symbol (type)
876   (make-symbol (concat "notmuch-show-" type)))
877
878 (defun notmuch-show-strip-re (string)
879   (replace-regexp-in-string "\\([Rr]e: *\\)+" "" string))
880
881 (defvar notmuch-show-previous-subject "")
882 (make-variable-buffer-local 'notmuch-show-previous-subject)
883
884 (defun notmuch-show-insert-msg (msg depth)
885   "Insert the message MSG at depth DEPTH in the current thread."
886   (let* ((headers (plist-get msg :headers))
887          ;; Indentation causes the buffer offset of the start/end
888          ;; points to move, so we must use markers.
889          message-start message-end
890          content-start content-end
891          headers-start headers-end
892          body-start body-end
893          (headers-invis-spec (notmuch-show-make-symbol "header"))
894          (message-invis-spec (notmuch-show-make-symbol "message"))
895          (bare-subject (notmuch-show-strip-re (plist-get headers :Subject))))
896
897     ;; Set `buffer-invisibility-spec' to `nil' (a list), otherwise
898     ;; removing items from `buffer-invisibility-spec' (which is what
899     ;; `notmuch-show-headers-visible' and
900     ;; `notmuch-show-message-visible' do) is a no-op and has no
901     ;; effect. This caused threads with only matching messages to have
902     ;; those messages hidden initially because
903     ;; `buffer-invisibility-spec' stayed `t'.
904     ;;
905     ;; This needs to be set here (rather than just above the call to
906     ;; `notmuch-show-headers-visible') because some of the part
907     ;; rendering or body washing functions
908     ;; (e.g. `notmuch-wash-text/plain-citations') manipulate
909     ;; `buffer-invisibility-spec').
910     (when (eq buffer-invisibility-spec t)
911       (setq buffer-invisibility-spec nil))
912
913     (setq message-start (point-marker))
914
915     (notmuch-show-insert-headerline headers
916                                     (or (if notmuch-show-relative-dates
917                                             (plist-get msg :date_relative)
918                                           nil)
919                                         (plist-get headers :Date))
920                                     (plist-get msg :tags) depth)
921
922     (setq content-start (point-marker))
923
924     (plist-put msg :headers-invis-spec headers-invis-spec)
925     (plist-put msg :message-invis-spec message-invis-spec)
926
927     ;; Set `headers-start' to point after the 'Subject:' header to be
928     ;; compatible with the existing implementation. This just sets it
929     ;; to after the first header.
930     (notmuch-show-insert-headers headers)
931     (save-excursion
932       (goto-char content-start)
933       ;; If the subject of this message is the same as that of the
934       ;; previous message, don't display it when this message is
935       ;; collapsed.
936       (when (not (string= notmuch-show-previous-subject
937                           bare-subject))
938         (forward-line 1))
939       (setq headers-start (point-marker)))
940     (setq headers-end (point-marker))
941
942     (setq notmuch-show-previous-subject bare-subject)
943
944     (setq body-start (point-marker))
945     ;; A blank line between the headers and the body.
946     (insert "\n")
947     (notmuch-show-insert-body msg (plist-get msg :body)
948                               (if notmuch-show-indent-content depth 0))
949     ;; Ensure that the body ends with a newline.
950     (unless (bolp)
951       (insert "\n"))
952     (setq body-end (point-marker))
953     (setq content-end (point-marker))
954
955     ;; Indent according to the depth in the thread.
956     (if notmuch-show-indent-content
957         (indent-rigidly content-start content-end (* notmuch-show-indent-messages-width depth)))
958
959     (setq message-end (point-max-marker))
960
961     ;; Save the extents of this message over the whole text of the
962     ;; message.
963     (put-text-property message-start message-end :notmuch-message-extent (cons message-start message-end))
964
965     (let ((headers-overlay (make-overlay headers-start headers-end))
966           (invis-specs (list headers-invis-spec message-invis-spec)))
967       (overlay-put headers-overlay 'invisible invis-specs)
968       (overlay-put headers-overlay 'priority 10))
969     (overlay-put (make-overlay body-start body-end) 'invisible message-invis-spec)
970
971     (plist-put msg :depth depth)
972
973     ;; Save the properties for this message. Currently this saves the
974     ;; entire message (augmented it with other stuff), which seems
975     ;; like overkill. We might save a reduced subset (for example, not
976     ;; the content).
977     (notmuch-show-set-message-properties msg)
978
979     ;; Set header visibility.
980     (notmuch-show-headers-visible msg notmuch-message-headers-visible)
981
982     ;; Message visibility depends on whether it matched the search
983     ;; criteria.
984     (notmuch-show-message-visible msg (plist-get msg :match))))
985
986 (defun notmuch-show-toggle-process-crypto ()
987   "Toggle the processing of cryptographic MIME parts."
988   (interactive)
989   (setq notmuch-show-process-crypto (not notmuch-show-process-crypto))
990   (message (if notmuch-show-process-crypto
991                "Processing cryptographic MIME parts."
992              "Not processing cryptographic MIME parts."))
993   (notmuch-show-refresh-view t))
994
995 (defun notmuch-show-toggle-elide-non-matching ()
996   "Toggle the display of non-matching messages."
997   (interactive)
998   (setq notmuch-show-elide-non-matching-messages (not notmuch-show-elide-non-matching-messages))
999   (message (if notmuch-show-elide-non-matching-messages
1000                "Showing matching messages only."
1001              "Showing all messages."))
1002   (notmuch-show-refresh-view t))
1003
1004 (defun notmuch-show-toggle-thread-indentation ()
1005   "Toggle the indentation of threads."
1006   (interactive)
1007   (setq notmuch-show-indent-content (not notmuch-show-indent-content))
1008   (message (if notmuch-show-indent-content
1009                "Content is indented."
1010              "Content is not indented."))
1011   (notmuch-show-refresh-view t))
1012
1013 (defun notmuch-show-insert-tree (tree depth)
1014   "Insert the message tree TREE at depth DEPTH in the current thread."
1015   (let ((msg (car tree))
1016         (replies (cadr tree)))
1017     (if (or (not notmuch-show-elide-non-matching-messages)
1018             (plist-get msg :match))
1019         (notmuch-show-insert-msg msg depth))
1020     (notmuch-show-insert-thread replies (1+ depth))))
1021
1022 (defun notmuch-show-insert-thread (thread depth)
1023   "Insert the thread THREAD at depth DEPTH in the current forest."
1024   (mapc (lambda (tree) (notmuch-show-insert-tree tree depth)) thread))
1025
1026 (defun notmuch-show-insert-forest (forest)
1027   "Insert the forest of threads FOREST."
1028   (mapc (lambda (thread) (notmuch-show-insert-thread thread 0)) forest))
1029
1030 (defun notmuch-show-buttonise-links (start end)
1031   "Buttonise URLs and mail addresses between START and END.
1032
1033 This also turns id:\"<message id>\"-parts into buttons for
1034 a corresponding notmuch search."
1035   (goto-address-fontify-region start end)
1036   (save-excursion
1037     (goto-char start)
1038     (while (re-search-forward "id:\\(\"?\\)[^[:space:]\"]+\\1" end t)
1039       ;; remove the overlay created by goto-address-mode
1040       (remove-overlays (match-beginning 0) (match-end 0) 'goto-address t)
1041       (make-text-button (match-beginning 0) (match-end 0)
1042                         'action `(lambda (arg)
1043                                    (notmuch-show ,(match-string-no-properties 0)))
1044                         'follow-link t
1045                         'help-echo "Mouse-1, RET: search for this message"
1046                         'face goto-address-mail-face))))
1047
1048 ;;;###autoload
1049 (defun notmuch-show (thread-id &optional parent-buffer query-context buffer-name)
1050   "Run \"notmuch show\" with the given thread ID and display results.
1051
1052 The optional PARENT-BUFFER is the notmuch-search buffer from
1053 which this notmuch-show command was executed, (so that the
1054 next thread from that buffer can be show when done with this
1055 one).
1056
1057 The optional QUERY-CONTEXT is a notmuch search term. Only
1058 messages from the thread matching this search term are shown if
1059 non-nil.
1060
1061 The optional BUFFER-NAME provides the name of the buffer in
1062 which the message thread is shown. If it is nil (which occurs
1063 when the command is called interactively) the argument to the
1064 function is used."
1065   (interactive "sNotmuch show: ")
1066   (let ((buffer-name (generate-new-buffer-name
1067                       (or buffer-name
1068                           (concat "*notmuch-" thread-id "*")))))
1069     (switch-to-buffer (get-buffer-create buffer-name))
1070     ;; Set the default value for `notmuch-show-process-crypto' in this
1071     ;; buffer.
1072     (setq notmuch-show-process-crypto notmuch-crypto-process-mime)
1073     ;; Set the default value for
1074     ;; `notmuch-show-elide-non-matching-messages' in this buffer. If
1075     ;; there is a prefix argument, invert the default.
1076     (setq notmuch-show-elide-non-matching-messages notmuch-show-only-matching-messages)
1077     (if current-prefix-arg
1078         (setq notmuch-show-elide-non-matching-messages (not notmuch-show-elide-non-matching-messages)))
1079
1080     (setq notmuch-show-thread-id thread-id
1081           notmuch-show-parent-buffer parent-buffer
1082           notmuch-show-query-context query-context)
1083     (notmuch-show-worker)))
1084
1085 (defun notmuch-show-worker ()
1086   (let ((inhibit-read-only t))
1087
1088     (notmuch-show-mode)
1089     ;; Don't track undo information for this buffer
1090     (set 'buffer-undo-list t)
1091
1092     (erase-buffer)
1093     (goto-char (point-min))
1094     (save-excursion
1095       (let* ((basic-args (list notmuch-show-thread-id))
1096              (args (if notmuch-show-query-context
1097                        (append (list "\'") basic-args
1098                                (list "and (" notmuch-show-query-context ")\'"))
1099                      (append (list "\'") basic-args (list "\'")))))
1100         (notmuch-show-insert-forest (notmuch-query-get-threads args))
1101         ;; If the query context reduced the results to nothing, run
1102         ;; the basic query.
1103         (when (and (eq (buffer-size) 0)
1104                    notmuch-show-query-context)
1105           (notmuch-show-insert-forest
1106            (notmuch-query-get-threads basic-args))))
1107
1108       (jit-lock-register #'notmuch-show-buttonise-links)
1109
1110       (run-hooks 'notmuch-show-hook))
1111
1112     ;; Move straight to the first open message
1113     (unless (notmuch-show-message-visible-p)
1114       (notmuch-show-next-open-message))
1115
1116     ;; Set the header line to the subject of the first open message.
1117     (setq header-line-format (notmuch-show-strip-re (notmuch-show-get-pretty-subject)))
1118
1119     (notmuch-show-mark-read)))
1120
1121 (defun notmuch-show-capture-state ()
1122   "Capture the state of the current buffer.
1123
1124 This includes:
1125  - the list of open messages,
1126  - the current message."
1127   (list (notmuch-show-get-message-id) (notmuch-show-get-message-ids-for-open-messages)))
1128
1129 (defun notmuch-show-apply-state (state)
1130   "Apply STATE to the current buffer.
1131
1132 This includes:
1133  - opening the messages previously opened,
1134  - closing all other messages,
1135  - moving to the correct current message."
1136   (let ((current (car state))
1137         (open (cadr state)))
1138
1139     ;; Open those that were open.
1140     (goto-char (point-min))
1141     (loop do (notmuch-show-message-visible (notmuch-show-get-message-properties)
1142                                            (member (notmuch-show-get-message-id) open))
1143           until (not (notmuch-show-goto-message-next)))
1144
1145     ;; Go to the previously open message.
1146     (goto-char (point-min))
1147     (unless (loop if (string= current (notmuch-show-get-message-id))
1148                   return t
1149                   until (not (notmuch-show-goto-message-next)))
1150       (goto-char (point-min))
1151       (message "Previously current message not found."))
1152     (notmuch-show-message-adjust)))
1153
1154 (defun notmuch-show-refresh-view (&optional retain-state)
1155   "Refresh the current view.
1156
1157 Refreshes the current view, observing changes in display
1158 preferences. If RETAIN-STATE is non-nil then the state of the
1159 buffer is stored and re-applied after the refresh."
1160   (interactive "P")
1161   (let ((inhibit-read-only t)
1162         state)
1163     (if retain-state
1164         (setq state (notmuch-show-capture-state)))
1165     (erase-buffer)
1166     (notmuch-show-worker)
1167     (if state
1168         (notmuch-show-apply-state state))))
1169
1170 (defvar notmuch-show-stash-map
1171   (let ((map (make-sparse-keymap)))
1172     (define-key map "c" 'notmuch-show-stash-cc)
1173     (define-key map "d" 'notmuch-show-stash-date)
1174     (define-key map "F" 'notmuch-show-stash-filename)
1175     (define-key map "f" 'notmuch-show-stash-from)
1176     (define-key map "i" 'notmuch-show-stash-message-id)
1177     (define-key map "I" 'notmuch-show-stash-message-id-stripped)
1178     (define-key map "s" 'notmuch-show-stash-subject)
1179     (define-key map "T" 'notmuch-show-stash-tags)
1180     (define-key map "t" 'notmuch-show-stash-to)
1181     (define-key map "l" 'notmuch-show-stash-mlarchive-link)
1182     (define-key map "L" 'notmuch-show-stash-mlarchive-link-and-go)
1183     map)
1184   "Submap for stash commands")
1185 (fset 'notmuch-show-stash-map notmuch-show-stash-map)
1186
1187 (defvar notmuch-show-mode-map
1188       (let ((map (make-sparse-keymap)))
1189         (define-key map "?" 'notmuch-help)
1190         (define-key map "q" 'notmuch-kill-this-buffer)
1191         (define-key map (kbd "<C-tab>") 'widget-backward)
1192         (define-key map (kbd "M-TAB") 'notmuch-show-previous-button)
1193         (define-key map (kbd "<backtab>") 'notmuch-show-previous-button)
1194         (define-key map (kbd "TAB") 'notmuch-show-next-button)
1195         (define-key map "s" 'notmuch-search)
1196         (define-key map "m" 'notmuch-mua-new-mail)
1197         (define-key map "f" 'notmuch-show-forward-message)
1198         (define-key map "r" 'notmuch-show-reply-sender)
1199         (define-key map "R" 'notmuch-show-reply)
1200         (define-key map "|" 'notmuch-show-pipe-message)
1201         (define-key map "w" 'notmuch-show-save-attachments)
1202         (define-key map "V" 'notmuch-show-view-raw-message)
1203         (define-key map "v" 'notmuch-show-view-all-mime-parts)
1204         (define-key map "c" 'notmuch-show-stash-map)
1205         (define-key map "=" 'notmuch-show-refresh-view)
1206         (define-key map "h" 'notmuch-show-toggle-headers)
1207         (define-key map "*" 'notmuch-show-tag-all)
1208         (define-key map "-" 'notmuch-show-remove-tag)
1209         (define-key map "+" 'notmuch-show-add-tag)
1210         (define-key map "X" 'notmuch-show-archive-thread-then-exit)
1211         (define-key map "x" 'notmuch-show-archive-message-then-next-or-exit)
1212         (define-key map "A" 'notmuch-show-archive-thread-then-next)
1213         (define-key map "a" 'notmuch-show-archive-message-then-next-or-next-thread)
1214         (define-key map "N" 'notmuch-show-next-message)
1215         (define-key map "P" 'notmuch-show-previous-message)
1216         (define-key map "n" 'notmuch-show-next-open-message)
1217         (define-key map "p" 'notmuch-show-previous-open-message)
1218         (define-key map (kbd "DEL") 'notmuch-show-rewind)
1219         (define-key map " " 'notmuch-show-advance-and-archive)
1220         (define-key map (kbd "M-RET") 'notmuch-show-open-or-close-all)
1221         (define-key map (kbd "RET") 'notmuch-show-toggle-message)
1222         (define-key map "#" 'notmuch-show-print-message)
1223         (define-key map "!" 'notmuch-show-toggle-elide-non-matching)
1224         (define-key map "$" 'notmuch-show-toggle-process-crypto)
1225         (define-key map "<" 'notmuch-show-toggle-thread-indentation)
1226         (define-key map "t" 'toggle-truncate-lines)
1227         map)
1228       "Keymap for \"notmuch show\" buffers.")
1229 (fset 'notmuch-show-mode-map notmuch-show-mode-map)
1230
1231 (defun notmuch-show-mode ()
1232   "Major mode for viewing a thread with notmuch.
1233
1234 This buffer contains the results of the \"notmuch show\" command
1235 for displaying a single thread of email from your email archives.
1236
1237 By default, various components of email messages, (citations,
1238 signatures, already-read messages), are hidden. You can make
1239 these parts visible by clicking with the mouse button or by
1240 pressing RET after positioning the cursor on a hidden part, (for
1241 which \\[notmuch-show-next-button] and \\[notmuch-show-previous-button] are helpful).
1242
1243 Reading the thread sequentially is well-supported by pressing
1244 \\[notmuch-show-advance-and-archive]. This will scroll the current message (if necessary), advance
1245 to the next message, or advance to the next thread (if already on
1246 the last message of a thread).
1247
1248 Other commands are available to read or manipulate the thread
1249 more selectively, (such as '\\[notmuch-show-next-message]' and '\\[notmuch-show-previous-message]' to advance to messages
1250 without removing any tags, and '\\[notmuch-show-archive-thread]' to archive an entire thread
1251 without scrolling through with \\[notmuch-show-advance-and-archive]).
1252
1253 You can add or remove arbitrary tags from the current message with
1254 '\\[notmuch-show-add-tag]' or '\\[notmuch-show-remove-tag]'.
1255
1256 All currently available key bindings:
1257
1258 \\{notmuch-show-mode-map}"
1259   (interactive)
1260   (kill-all-local-variables)
1261   (use-local-map notmuch-show-mode-map)
1262   (setq major-mode 'notmuch-show-mode
1263         mode-name "notmuch-show")
1264   (setq buffer-read-only t
1265         truncate-lines t))
1266
1267 (defun notmuch-show-move-to-message-top ()
1268   (goto-char (notmuch-show-message-top)))
1269
1270 (defun notmuch-show-move-to-message-bottom ()
1271   (goto-char (notmuch-show-message-bottom)))
1272
1273 (defun notmuch-show-message-adjust ()
1274   (recenter 0))
1275
1276 ;; Movement related functions.
1277
1278 ;; There's some strangeness here where a text property applied to a
1279 ;; region a->b is not found when point is at b. We walk backwards
1280 ;; until finding the property.
1281 (defun notmuch-show-message-extent ()
1282   (let (r)
1283     (save-excursion
1284       (while (not (setq r (get-text-property (point) :notmuch-message-extent)))
1285         (backward-char)))
1286     r))
1287
1288 (defun notmuch-show-message-top ()
1289   (car (notmuch-show-message-extent)))
1290
1291 (defun notmuch-show-message-bottom ()
1292   (cdr (notmuch-show-message-extent)))
1293
1294 (defun notmuch-show-goto-message-next ()
1295   (let ((start (point)))
1296     (notmuch-show-move-to-message-bottom)
1297     (if (not (eobp))
1298         t
1299       (goto-char start)
1300       nil)))
1301
1302 (defun notmuch-show-goto-message-previous ()
1303   (notmuch-show-move-to-message-top)
1304   (if (bobp)
1305       nil
1306     (backward-char)
1307     (notmuch-show-move-to-message-top)
1308     t))
1309
1310 (defun notmuch-show-mapc (function)
1311   "Iterate through all messages in the current thread with
1312 `notmuch-show-goto-message-next' and call FUNCTION for side
1313 effects."
1314   (save-excursion
1315     (goto-char (point-min))
1316     (loop do (funcall function)
1317           while (notmuch-show-goto-message-next))))
1318
1319 ;; Functions relating to the visibility of messages and their
1320 ;; components.
1321
1322 (defun notmuch-show-element-visible (props visible-p spec-property)
1323   (let ((spec (plist-get props spec-property)))
1324     (if visible-p
1325         (remove-from-invisibility-spec spec)
1326       (add-to-invisibility-spec spec))))
1327
1328 (defun notmuch-show-message-visible (props visible-p)
1329   (notmuch-show-element-visible props visible-p :message-invis-spec)
1330   (notmuch-show-set-prop :message-visible visible-p props))
1331
1332 (defun notmuch-show-headers-visible (props visible-p)
1333   (notmuch-show-element-visible props visible-p :headers-invis-spec)
1334   (notmuch-show-set-prop :headers-visible visible-p props))
1335
1336 ;; Functions for setting and getting attributes of the current
1337 ;; message.
1338
1339 (defun notmuch-show-set-message-properties (props)
1340   (save-excursion
1341     (notmuch-show-move-to-message-top)
1342     (put-text-property (point) (+ (point) 1) :notmuch-message-properties props)))
1343
1344 (defun notmuch-show-get-message-properties ()
1345   "Return the properties of the current message as a plist.
1346
1347 Some useful entries are:
1348 :headers - Property list containing the headers :Date, :Subject, :From, etc.
1349 :body - Body of the message
1350 :tags - Tags for this message"
1351   (save-excursion
1352     (notmuch-show-move-to-message-top)
1353     (get-text-property (point) :notmuch-message-properties)))
1354
1355 (defun notmuch-show-set-prop (prop val &optional props)
1356   (let ((inhibit-read-only t)
1357         (props (or props
1358                    (notmuch-show-get-message-properties))))
1359     (plist-put props prop val)
1360     (notmuch-show-set-message-properties props)))
1361
1362 (defun notmuch-show-get-prop (prop &optional props)
1363   (let ((props (or props
1364                    (notmuch-show-get-message-properties))))
1365     (plist-get props prop)))
1366
1367 (defun notmuch-show-get-message-id (&optional bare)
1368   "Return the Message-Id of the current message.
1369
1370 If optional argument BARE is non-nil, return
1371 the Message-Id without prefix and quotes."
1372   (if bare
1373       (notmuch-show-get-prop :id)
1374     (concat "id:\"" (notmuch-show-get-prop :id) "\"")))
1375
1376 (defun notmuch-show-get-messages-ids ()
1377   "Return all message ids of messages in the current thread."
1378   (let ((message-ids))
1379     (notmuch-show-mapc
1380      (lambda () (push (notmuch-show-get-message-id) message-ids)))
1381     message-ids))
1382
1383 (defun notmuch-show-get-messages-ids-search ()
1384   "Return a search string for all message ids of messages in the
1385 current thread."
1386   (mapconcat 'identity (notmuch-show-get-messages-ids) " or "))
1387
1388 ;; dme: Would it make sense to use a macro for many of these?
1389
1390 (defun notmuch-show-get-filename ()
1391   "Return the filename of the current message."
1392   (notmuch-show-get-prop :filename))
1393
1394 (defun notmuch-show-get-header (header &optional props)
1395   "Return the named header of the current message, if any."
1396   (plist-get (notmuch-show-get-prop :headers props) header))
1397
1398 (defun notmuch-show-get-cc ()
1399   (notmuch-show-get-header :Cc))
1400
1401 (defun notmuch-show-get-date ()
1402   (notmuch-show-get-header :Date))
1403
1404 (defun notmuch-show-get-from ()
1405   (notmuch-show-get-header :From))
1406
1407 (defun notmuch-show-get-subject ()
1408   (notmuch-show-get-header :Subject))
1409
1410 (defun notmuch-show-get-to ()
1411   (notmuch-show-get-header :To))
1412
1413 (defun notmuch-show-get-depth ()
1414   (notmuch-show-get-prop :depth))
1415
1416 (defun notmuch-show-get-pretty-subject ()
1417   (notmuch-prettify-subject (notmuch-show-get-subject)))
1418
1419 (defun notmuch-show-set-tags (tags)
1420   "Set the tags of the current message."
1421   (notmuch-show-set-prop :tags tags)
1422   (notmuch-show-update-tags tags))
1423
1424 (defun notmuch-show-get-tags ()
1425   "Return the tags of the current message."
1426   (notmuch-show-get-prop :tags))
1427
1428 (defun notmuch-show-message-visible-p ()
1429   "Is the current message visible?"
1430   (notmuch-show-get-prop :message-visible))
1431
1432 (defun notmuch-show-headers-visible-p ()
1433   "Are the headers of the current message visible?"
1434   (notmuch-show-get-prop :headers-visible))
1435
1436 (defun notmuch-show-mark-read ()
1437   "Mark the current message as read."
1438   (notmuch-show-tag-message "-unread"))
1439
1440 ;; Functions for getting attributes of several messages in the current
1441 ;; thread.
1442
1443 (defun notmuch-show-get-message-ids-for-open-messages ()
1444   "Return a list of all message IDs for open messages in the current thread."
1445   (save-excursion
1446     (let (message-ids done)
1447       (goto-char (point-min))
1448       (while (not done)
1449         (if (notmuch-show-message-visible-p)
1450             (setq message-ids (append message-ids (list (notmuch-show-get-message-id)))))
1451         (setq done (not (notmuch-show-goto-message-next)))
1452         )
1453       message-ids
1454       )))
1455
1456 ;; Commands typically bound to keys.
1457
1458 (defun notmuch-show-advance ()
1459   "Advance through thread.
1460
1461 If the current message in the thread is not yet fully visible,
1462 scroll by a near screenful to read more of the message.
1463
1464 Otherwise, (the end of the current message is already within the
1465 current window), advance to the next open message."
1466   (interactive)
1467   (let* ((end-of-this-message (notmuch-show-message-bottom))
1468          (visible-end-of-this-message (1- end-of-this-message))
1469          (ret nil))
1470     (while (invisible-p visible-end-of-this-message)
1471       (setq visible-end-of-this-message
1472             (max (point-min)
1473                  (1- (previous-single-char-property-change
1474                       visible-end-of-this-message 'invisible)))))
1475     (cond
1476      ;; Ideally we would test `end-of-this-message' against the result
1477      ;; of `window-end', but that doesn't account for the fact that
1478      ;; the end of the message might be hidden.
1479      ((and visible-end-of-this-message
1480            (> visible-end-of-this-message (window-end)))
1481       ;; The bottom of this message is not visible - scroll.
1482       (scroll-up nil))
1483
1484      ((not (= end-of-this-message (point-max)))
1485       ;; This is not the last message - move to the next visible one.
1486       (notmuch-show-next-open-message))
1487
1488      (t
1489       ;; This is the last message - change the return value
1490       (setq ret t)))
1491     ret))
1492
1493 (defun notmuch-show-advance-and-archive ()
1494   "Advance through thread and archive.
1495
1496 This command is intended to be one of the simplest ways to
1497 process a thread of email. It works exactly like
1498 notmuch-show-advance, in that it scrolls through messages in a
1499 show buffer, except that when it gets to the end of the buffer it
1500 archives the entire current thread, (remove the \"inbox\" tag
1501 from each message), kills the buffer, and displays the next
1502 thread from the search from which this thread was originally
1503 shown."
1504   (interactive)
1505   (if (notmuch-show-advance)
1506       (notmuch-show-archive-thread-then-next)))
1507
1508 (defun notmuch-show-rewind ()
1509   "Backup through the thread, (reverse scrolling compared to \\[notmuch-show-advance-and-archive]).
1510
1511 Specifically, if the beginning of the previous email is fewer
1512 than `window-height' lines from the current point, move to it
1513 just like `notmuch-show-previous-message'.
1514
1515 Otherwise, just scroll down a screenful of the current message.
1516
1517 This command does not modify any message tags, (it does not undo
1518 any effects from previous calls to
1519 `notmuch-show-advance-and-archive'."
1520   (interactive)
1521   (let ((start-of-message (notmuch-show-message-top))
1522         (start-of-window (window-start)))
1523     (cond
1524       ;; Either this message is properly aligned with the start of the
1525       ;; window or the start of this message is not visible on the
1526       ;; screen - scroll.
1527      ((or (= start-of-message start-of-window)
1528           (< start-of-message start-of-window))
1529       (scroll-down)
1530       ;; If a small number of lines from the previous message are
1531       ;; visible, realign so that the top of the current message is at
1532       ;; the top of the screen.
1533       (when (<= (count-screen-lines (window-start) start-of-message)
1534                 next-screen-context-lines)
1535         (goto-char (notmuch-show-message-top))
1536         (notmuch-show-message-adjust))
1537       ;; Move to the top left of the window.
1538       (goto-char (window-start)))
1539      (t
1540       ;; Move to the previous message.
1541       (notmuch-show-previous-message)))))
1542
1543 (defun notmuch-show-reply (&optional prompt-for-sender)
1544   "Reply to the sender and all recipients of the current message."
1545   (interactive "P")
1546   (notmuch-mua-new-reply (notmuch-show-get-message-id) prompt-for-sender t))
1547
1548 (defun notmuch-show-reply-sender (&optional prompt-for-sender)
1549   "Reply to the sender of the current message."
1550   (interactive "P")
1551   (notmuch-mua-new-reply (notmuch-show-get-message-id) prompt-for-sender nil))
1552
1553 (defun notmuch-show-forward-message (&optional prompt-for-sender)
1554   "Forward the current message."
1555   (interactive "P")
1556   (with-current-notmuch-show-message
1557    (notmuch-mua-new-forward-message prompt-for-sender)))
1558
1559 (defun notmuch-show-next-message (&optional pop-at-end)
1560   "Show the next message.
1561
1562 If a prefix argument is given and this is the last message in the
1563 thread, navigate to the next thread in the parent search buffer."
1564   (interactive "P")
1565   (if (notmuch-show-goto-message-next)
1566       (progn
1567         (notmuch-show-mark-read)
1568         (notmuch-show-message-adjust))
1569     (if pop-at-end
1570         (notmuch-show-next-thread)
1571       (goto-char (point-max)))))
1572
1573 (defun notmuch-show-previous-message ()
1574   "Show the previous message."
1575   (interactive)
1576   (notmuch-show-goto-message-previous)
1577   (notmuch-show-mark-read)
1578   (notmuch-show-message-adjust))
1579
1580 (defun notmuch-show-next-open-message (&optional pop-at-end)
1581   "Show the next open message.
1582
1583 If a prefix argument is given and this is the last open message
1584 in the thread, navigate to the next thread in the parent search
1585 buffer. Return t if there was a next open message in the thread
1586 to show, nil otherwise."
1587   (interactive "P")
1588   (let (r)
1589     (while (and (setq r (notmuch-show-goto-message-next))
1590                 (not (notmuch-show-message-visible-p))))
1591     (if r
1592         (progn
1593           (notmuch-show-mark-read)
1594           (notmuch-show-message-adjust))
1595       (if pop-at-end
1596           (notmuch-show-next-thread)
1597         (goto-char (point-max))))
1598     r))
1599
1600 (defun notmuch-show-previous-open-message ()
1601   "Show the previous open message."
1602   (interactive)
1603   (while (and (notmuch-show-goto-message-previous)
1604               (not (notmuch-show-message-visible-p))))
1605   (notmuch-show-mark-read)
1606   (notmuch-show-message-adjust))
1607
1608 (defun notmuch-show-view-raw-message ()
1609   "View the file holding the current message."
1610   (interactive)
1611   (let* ((id (notmuch-show-get-message-id))
1612          (buf (get-buffer-create (concat "*notmuch-raw-" id "*"))))
1613     (call-process notmuch-command nil buf nil "show" "--format=raw" id)
1614     (switch-to-buffer buf)
1615     (goto-char (point-min))
1616     (set-buffer-modified-p nil)
1617     (view-buffer buf 'kill-buffer-if-not-modified)))
1618
1619 (defun notmuch-show-pipe-message (entire-thread command)
1620   "Pipe the contents of the current message (or thread) to the given command.
1621
1622 The given command will be executed with the raw contents of the
1623 current email message as stdin. Anything printed by the command
1624 to stdout or stderr will appear in the *notmuch-pipe* buffer.
1625
1626 When invoked with a prefix argument, the command will receive all
1627 open messages in the current thread (formatted as an mbox) rather
1628 than only the current message."
1629   (interactive "P\nsPipe message to command: ")
1630   (let (shell-command)
1631     (if entire-thread
1632         (setq shell-command
1633               (concat notmuch-command " show --format=mbox "
1634                       (shell-quote-argument
1635                        (mapconcat 'identity (notmuch-show-get-message-ids-for-open-messages) " OR "))
1636                       " | " command))
1637       (setq shell-command
1638             (concat notmuch-command " show --format=raw "
1639                     (shell-quote-argument (notmuch-show-get-message-id)) " | " command)))
1640     (let ((buf (get-buffer-create (concat "*notmuch-pipe*"))))
1641       (with-current-buffer buf
1642         (setq buffer-read-only nil)
1643         (erase-buffer)
1644         (let ((exit-code (call-process-shell-command shell-command nil buf)))
1645           (goto-char (point-max))
1646           (set-buffer-modified-p nil)
1647           (setq buffer-read-only t)
1648           (unless (zerop exit-code)
1649             (switch-to-buffer-other-window buf)
1650             (message (format "Command '%s' exited abnormally with code %d"
1651                              shell-command exit-code))))))))
1652
1653 (defun notmuch-show-tag-message (&rest tag-changes)
1654   "Change tags for the current message.
1655
1656 TAG-CHANGES is a list of tag operations for `notmuch-tag'."
1657   (let* ((current-tags (notmuch-show-get-tags))
1658          (new-tags (notmuch-update-tags current-tags tag-changes)))
1659     (unless (equal current-tags new-tags)
1660       (apply 'notmuch-tag (notmuch-show-get-message-id) tag-changes)
1661       (notmuch-show-set-tags new-tags))))
1662
1663 (defun notmuch-show-tag (&optional initial-input)
1664   "Change tags for the current message, read input from the minibuffer."
1665   (interactive)
1666   (let ((tag-changes (notmuch-read-tag-changes
1667                       initial-input (notmuch-show-get-message-id))))
1668     (apply 'notmuch-show-tag-message tag-changes)))
1669
1670 (defun notmuch-show-tag-all (&rest tag-changes)
1671   "Change tags for all messages in the current thread.
1672
1673 TAG-CHANGES is a list of tag operations for `notmuch-tag'."
1674   (interactive (notmuch-read-tag-changes nil notmuch-show-thread-id))
1675   (apply 'notmuch-tag (notmuch-show-get-messages-ids-search) tag-changes)
1676   (notmuch-show-mapc
1677    (lambda ()
1678      (let* ((current-tags (notmuch-show-get-tags))
1679             (new-tags (notmuch-update-tags current-tags tag-changes)))
1680        (unless (equal current-tags new-tags)
1681          (notmuch-show-set-tags new-tags))))))
1682
1683 (defun notmuch-show-add-tag ()
1684   "Same as `notmuch-show-tag' but sets initial input to '+'."
1685   (interactive)
1686   (notmuch-show-tag "+"))
1687
1688 (defun notmuch-show-remove-tag ()
1689   "Same as `notmuch-show-tag' but sets initial input to '-'."
1690   (interactive)
1691   (notmuch-show-tag "-"))
1692
1693 (defun notmuch-show-toggle-headers ()
1694   "Toggle the visibility of the current message headers."
1695   (interactive)
1696   (let ((props (notmuch-show-get-message-properties)))
1697     (notmuch-show-headers-visible
1698      props
1699      (not (plist-get props :headers-visible))))
1700   (force-window-update))
1701
1702 (defun notmuch-show-toggle-message ()
1703   "Toggle the visibility of the current message."
1704   (interactive)
1705   (let ((props (notmuch-show-get-message-properties)))
1706     (notmuch-show-message-visible
1707      props
1708      (not (plist-get props :message-visible))))
1709   (force-window-update))
1710
1711 (defun notmuch-show-open-or-close-all ()
1712   "Set the visibility all of the messages in the current thread.
1713 By default make all of the messages visible. With a prefix
1714 argument, hide all of the messages."
1715   (interactive)
1716   (save-excursion
1717     (goto-char (point-min))
1718     (loop do (notmuch-show-message-visible (notmuch-show-get-message-properties)
1719                                            (not current-prefix-arg))
1720           until (not (notmuch-show-goto-message-next))))
1721   (force-window-update))
1722
1723 (defun notmuch-show-next-button ()
1724   "Advance point to the next button in the buffer."
1725   (interactive)
1726   (forward-button 1))
1727
1728 (defun notmuch-show-previous-button ()
1729   "Move point back to the previous button in the buffer."
1730   (interactive)
1731   (backward-button 1))
1732
1733 (defun notmuch-show-next-thread (&optional show-next)
1734   "Move to the next item in the search results, if any."
1735   (interactive "P")
1736   (let ((parent-buffer notmuch-show-parent-buffer))
1737     (notmuch-kill-this-buffer)
1738     (when (buffer-live-p parent-buffer)
1739       (switch-to-buffer parent-buffer)
1740       (notmuch-search-next-thread)
1741       (if show-next
1742           (notmuch-search-show-thread)))))
1743
1744 (defun notmuch-show-archive-thread (&optional unarchive)
1745   "Archive each message in thread.
1746
1747 If a prefix argument is given, the messages will be
1748 \"unarchived\" (ie. the \"inbox\" tag will be added instead of
1749 removed).
1750
1751 Archive each message currently shown by removing the \"inbox\"
1752 tag from each. Then kill this buffer and show the next thread
1753 from the search from which this thread was originally shown.
1754
1755 Note: This command is safe from any race condition of new messages
1756 being delivered to the same thread. It does not archive the
1757 entire thread, but only the messages shown in the current
1758 buffer."
1759   (interactive "P")
1760   (let ((op (if unarchive "+" "-")))
1761     (notmuch-show-tag-all (concat op "inbox"))))
1762
1763 (defun notmuch-show-archive-thread-then-next ()
1764   "Archive each message in thread, then show next thread from search."
1765   (interactive)
1766   (notmuch-show-archive-thread)
1767   (notmuch-show-next-thread t))
1768
1769 (defun notmuch-show-archive-thread-then-exit ()
1770   "Archive each message in thread, then exit back to search results."
1771   (interactive)
1772   (notmuch-show-archive-thread)
1773   (notmuch-show-next-thread))
1774
1775 (defun notmuch-show-archive-message (&optional unarchive)
1776   "Archive the current message.
1777
1778 If a prefix argument is given, the message will be
1779 \"unarchived\" (ie. the \"inbox\" tag will be added instead of
1780 removed)."
1781   (interactive "P")
1782   (let ((op (if unarchive "+" "-")))
1783     (notmuch-show-tag-message (concat op "inbox"))))
1784
1785 (defun notmuch-show-archive-message-then-next-or-exit ()
1786   "Archive the current message, then show the next open message in the current thread.
1787
1788 If at the last open message in the current thread, then exit back
1789 to search results."
1790   (interactive)
1791   (notmuch-show-archive-message)
1792   (notmuch-show-next-open-message t))
1793
1794 (defun notmuch-show-archive-message-then-next-or-next-thread ()
1795   "Archive the current message, then show the next open message in the current thread.
1796
1797 If at the last open message in the current thread, then show next
1798 thread from search."
1799   (interactive)
1800   (notmuch-show-archive-message)
1801   (unless (notmuch-show-next-open-message)
1802     (notmuch-show-next-thread t)))
1803
1804 (defun notmuch-show-stash-cc ()
1805   "Copy CC field of current message to kill-ring."
1806   (interactive)
1807   (notmuch-common-do-stash (notmuch-show-get-cc)))
1808
1809 (defun notmuch-show-stash-date ()
1810   "Copy date of current message to kill-ring."
1811   (interactive)
1812   (notmuch-common-do-stash (notmuch-show-get-date)))
1813
1814 (defun notmuch-show-stash-filename ()
1815   "Copy filename of current message to kill-ring."
1816   (interactive)
1817   (notmuch-common-do-stash (notmuch-show-get-filename)))
1818
1819 (defun notmuch-show-stash-from ()
1820   "Copy From address of current message to kill-ring."
1821   (interactive)
1822   (notmuch-common-do-stash (notmuch-show-get-from)))
1823
1824 (defun notmuch-show-stash-message-id ()
1825   "Copy message ID of current message to kill-ring."
1826   (interactive)
1827   (notmuch-common-do-stash (notmuch-show-get-message-id)))
1828
1829 (defun notmuch-show-stash-message-id-stripped ()
1830   "Copy message ID of current message (sans `id:' prefix) to kill-ring."
1831   (interactive)
1832   (notmuch-common-do-stash (notmuch-show-get-message-id t)))
1833
1834 (defun notmuch-show-stash-subject ()
1835   "Copy Subject field of current message to kill-ring."
1836   (interactive)
1837   (notmuch-common-do-stash (notmuch-show-get-subject)))
1838
1839 (defun notmuch-show-stash-tags ()
1840   "Copy tags of current message to kill-ring as a comma separated list."
1841   (interactive)
1842   (notmuch-common-do-stash (mapconcat 'identity (notmuch-show-get-tags) ",")))
1843
1844 (defun notmuch-show-stash-to ()
1845   "Copy To address of current message to kill-ring."
1846   (interactive)
1847   (notmuch-common-do-stash (notmuch-show-get-to)))
1848
1849 (defun notmuch-show-stash-mlarchive-link (&optional mla)
1850   "Copy an ML Archive URI for the current message to the kill-ring.
1851
1852 This presumes that the message is available at the selected Mailing List Archive.
1853
1854 If optional argument MLA is non-nil, use the provided key instead of prompting
1855 the user (see `notmuch-show-stash-mlarchive-link-alist')."
1856   (interactive)
1857   (notmuch-common-do-stash
1858    (concat (cdr (assoc
1859                  (or mla
1860                      (let ((completion-ignore-case t))
1861                        (completing-read
1862                         "Mailing List Archive: "
1863                         notmuch-show-stash-mlarchive-link-alist
1864                         nil t nil nil notmuch-show-stash-mlarchive-link-default)))
1865                  notmuch-show-stash-mlarchive-link-alist))
1866            (notmuch-show-get-message-id t))))
1867
1868 (defun notmuch-show-stash-mlarchive-link-and-go (&optional mla)
1869   "Copy an ML Archive URI for the current message to the kill-ring and visit it.
1870
1871 This presumes that the message is available at the selected Mailing List Archive.
1872
1873 If optional argument MLA is non-nil, use the provided key instead of prompting
1874 the user (see `notmuch-show-stash-mlarchive-link-alist')."
1875   (interactive)
1876   (notmuch-show-stash-mlarchive-link mla)
1877   (browse-url (current-kill 0 t)))
1878
1879 ;; Commands typically bound to buttons.
1880
1881 (defun notmuch-show-part-button-default (&optional button)
1882   (interactive)
1883   (notmuch-show-part-button-internal button notmuch-show-part-button-default-action))
1884
1885 (defun notmuch-show-part-button-save (&optional button)
1886   (interactive)
1887   (notmuch-show-part-button-internal button #'notmuch-show-save-part))
1888
1889 (defun notmuch-show-part-button-view (&optional button)
1890   (interactive)
1891   (notmuch-show-part-button-internal button #'notmuch-show-view-part))
1892
1893 (defun notmuch-show-part-button-interactively-view (&optional button)
1894   (interactive)
1895   (notmuch-show-part-button-internal button #'notmuch-show-interactively-view-part))
1896
1897 (defun notmuch-show-part-button-internal (button handler)
1898   (let ((button (or button (button-at (point)))))
1899     (if button
1900         (let ((nth (button-get button :notmuch-part)))
1901           (if nth
1902               (funcall handler (notmuch-show-get-message-id) nth
1903                        (button-get button :notmuch-filename)
1904                        (button-get button :notmuch-content-type)))))))
1905
1906 ;;
1907
1908 (provide 'notmuch-show)