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