notmuch.el: Clean up documentation of notmuch-search-mode-map commands.
[notmuch] / notmuch.el
1 ; notmuch.el --- run notmuch within emacs
2 ;
3 ; Copyright © Carl Worth
4 ;
5 ; This file is part of Notmuch.
6 ;
7 ; Notmuch is free software: you can redistribute it and/or modify it
8 ; under the terms of the GNU General Public License as published by
9 ; the Free Software Foundation, either version 3 of the License, or
10 ; (at your option) any later version.
11 ;
12 ; Notmuch is distributed in the hope that it will be useful, but
13 ; WITHOUT ANY WARRANTY; without even the implied warranty of
14 ; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15 ; General Public License for more details.
16 ;
17 ; You should have received a copy of the GNU General Public License
18 ; along with Notmuch.  If not, see <http://www.gnu.org/licenses/>.
19 ;
20 ; Authors: Carl Worth <cworth@cworth.org>
21
22 ; This is an emacs-based interface to the notmuch mail system.
23 ;
24 ; You will first need to have the notmuch program installed and have a
25 ; notmuch database built in order to use this. See
26 ; http://notmuchmail.org for details.
27 ;
28 ; To install this software, copy it to a directory that is on the
29 ; `load-path' variable within emacs (a good candidate is
30 ; /usr/local/share/emacs/site-lisp). If you are viewing this from the
31 ; notmuch source distribution then you can simply run:
32 ;
33 ;       sudo make install-emacs
34 ;
35 ; to install it.
36 ;
37 ; Then, to actually run it, add:
38 ;
39 ;       (require 'notmuch)
40 ;
41 ; to your ~/.emacs file, and then run "M-x notmuch" from within emacs,
42 ; or run:
43 ;
44 ;       emacs -f notmuch
45 ;
46 ; Have fun, and let us know if you have any comment, questions, or
47 ; kudos: Notmuch list <notmuch@notmuchmail.org> (subscription is not
48 ; required, but is available from http://notmuchmail.org).
49
50 (require 'cl)
51 (require 'mm-view)
52 (require 'message)
53
54 (defvar notmuch-show-mode-map
55   (let ((map (make-sparse-keymap)))
56     ; I don't actually want all of these toggle commands occupying
57     ; keybindings. They steal valuable key-binding space, are hard
58     ; to remember, and act globally rather than locally.
59     ;
60     ; Will be much preferable to switch to direct manipulation for
61     ; toggling visibility of these components. Probably using
62     ; overlays-at to query and manipulate the current overlay.
63     (define-key map "a" 'notmuch-show-archive-thread)
64     (define-key map "A" 'notmuch-show-mark-read-then-archive-thread)
65     (define-key map "f" 'notmuch-show-forward-current)
66     (define-key map "m" 'message-mail)
67     (define-key map "n" 'notmuch-show-next-message)
68     (define-key map "N" 'notmuch-show-mark-read-then-next-open-message)
69     (define-key map "p" 'notmuch-show-previous-message)
70     (define-key map (kbd "C-n") 'notmuch-show-next-line)
71     (define-key map (kbd "C-p") 'notmuch-show-previous-line)
72     (define-key map "q" 'kill-this-buffer)
73     (define-key map "r" 'notmuch-show-reply)
74     (define-key map "s" 'notmuch-search)
75     (define-key map "v" 'notmuch-show-view-all-mime-parts)
76     (define-key map "V" 'notmuch-show-view-raw-message)
77     (define-key map "w" 'notmuch-show-save-attachments)
78     (define-key map "x" 'kill-this-buffer)
79     (define-key map "+" 'notmuch-show-add-tag)
80     (define-key map "-" 'notmuch-show-remove-tag)
81     (define-key map (kbd "DEL") 'notmuch-show-rewind)
82     (define-key map " " 'notmuch-show-advance-marking-read-and-archiving)
83     (define-key map "|" 'notmuch-show-pipe-message)
84     (define-key map "?" 'notmuch-help)
85     (define-key map (kbd "TAB") 'notmuch-show-next-button)
86     (define-key map (kbd "M-TAB") 'notmuch-show-previous-button)
87     map)
88   "Keymap for \"notmuch show\" buffers.")
89 (fset 'notmuch-show-mode-map notmuch-show-mode-map)
90
91 (defvar notmuch-show-signature-regexp "\\(-- ?\\|_+\\)$"
92   "Pattern to match a line that separates content from signature.
93
94 The regexp can (and should) include $ to match the end of the
95 line, but should not include ^ to match the beginning of the
96 line. This is because notmuch may have inserted additional space
97 for indentation at the beginning of the line. But notmuch will
98 move past the indentation when testing this pattern, (so that the
99 pattern can still test against the entire line).")
100
101 (defvar notmuch-show-signature-lines-max 12
102   "Maximum length of signature that will be hidden by default.")
103
104 (defvar notmuch-command "notmuch"
105   "Command to run the notmuch binary.")
106
107 (defvar notmuch-show-message-begin-regexp    "\fmessage{")
108 (defvar notmuch-show-message-end-regexp      "\fmessage}")
109 (defvar notmuch-show-header-begin-regexp     "\fheader{")
110 (defvar notmuch-show-header-end-regexp       "\fheader}")
111 (defvar notmuch-show-body-begin-regexp       "\fbody{")
112 (defvar notmuch-show-body-end-regexp         "\fbody}")
113 (defvar notmuch-show-attachment-begin-regexp "\fattachment{")
114 (defvar notmuch-show-attachment-end-regexp   "\fattachment}")
115 (defvar notmuch-show-part-begin-regexp       "\fpart{")
116 (defvar notmuch-show-part-end-regexp         "\fpart}")
117 (defvar notmuch-show-marker-regexp "\f\\(message\\|header\\|body\\|attachment\\|part\\)[{}].*$")
118
119 (defvar notmuch-show-id-regexp "\\(id:[^ ]*\\)")
120 (defvar notmuch-show-depth-regexp " depth:\\([0-9]*\\) ")
121 (defvar notmuch-show-filename-regexp "filename:\\(.*\\)$")
122 (defvar notmuch-show-tags-regexp "(\\([^)]*\\))$")
123
124 (defvar notmuch-show-parent-buffer nil)
125 (defvar notmuch-show-body-read-visible nil)
126 (defvar notmuch-show-citations-visible nil)
127 (defvar notmuch-show-signatures-visible nil)
128 (defvar notmuch-show-headers-visible nil)
129
130 ; XXX: This should be a generic function in emacs somewhere, not here
131 (defun point-invisible-p ()
132   "Return whether the character at point is invisible.
133
134 Here visibility is determined by `buffer-invisibility-spec' and
135 the invisible property of any overlays for point. It doesn't have
136 anything to do with whether point is currently being displayed
137 within the current window."
138   (let ((prop (get-char-property (point) 'invisible)))
139     (if (eq buffer-invisibility-spec t)
140         prop
141       (or (memq prop buffer-invisibility-spec)
142           (assq prop buffer-invisibility-spec)))))
143
144 (defun notmuch-select-tag-with-completion (prompt &rest search-terms)
145   (let ((tag-list
146          (with-output-to-string
147            (with-current-buffer standard-output
148              (apply 'call-process notmuch-command nil t nil "search-tags" search-terms)))))
149     (completing-read prompt (split-string tag-list "\n+" t) nil nil nil)))
150
151 (defun notmuch-show-next-line ()
152   "Like builtin `next-line' but ensuring we end on a visible character.
153
154 By advancing forward until reaching a visible character.
155
156 Unlike builtin `next-line' this version accepts no arguments."
157   (interactive)
158   (set 'this-command 'next-line)
159   (call-interactively 'next-line)
160   (while (point-invisible-p)
161     (forward-char)))
162
163 (defun notmuch-show-previous-line ()
164   "Like builtin `previous-line' but ensuring we end on a visible character.
165
166 By advancing forward until reaching a visible character.
167
168 Unlike builtin `next-line' this version accepts no arguments."
169   (interactive)
170   (set 'this-command 'previous-line)
171   (call-interactively 'previous-line)
172   (while (point-invisible-p)
173     (forward-char)))
174
175 (defun notmuch-show-get-message-id ()
176   (save-excursion
177     (beginning-of-line)
178     (if (not (looking-at notmuch-show-message-begin-regexp))
179         (re-search-backward notmuch-show-message-begin-regexp))
180     (re-search-forward notmuch-show-id-regexp)
181     (buffer-substring-no-properties (match-beginning 1) (match-end 1))))
182
183 (defun notmuch-show-get-filename ()
184   (save-excursion
185     (beginning-of-line)
186     (if (not (looking-at notmuch-show-message-begin-regexp))
187         (re-search-backward notmuch-show-message-begin-regexp))
188     (re-search-forward notmuch-show-filename-regexp)
189     (buffer-substring-no-properties (match-beginning 1) (match-end 1))))
190
191 (defun notmuch-show-set-tags (tags)
192   (save-excursion
193     (beginning-of-line)
194     (if (not (looking-at notmuch-show-message-begin-regexp))
195         (re-search-backward notmuch-show-message-begin-regexp))
196     (re-search-forward notmuch-show-tags-regexp)
197     (let ((inhibit-read-only t)
198           (beg (match-beginning 1))
199           (end (match-end 1)))
200       (delete-region beg end)
201       (goto-char beg)
202       (insert (mapconcat 'identity tags " ")))))
203
204 (defun notmuch-show-get-tags ()
205   (save-excursion
206     (beginning-of-line)
207     (if (not (looking-at notmuch-show-message-begin-regexp))
208         (re-search-backward notmuch-show-message-begin-regexp))
209     (re-search-forward notmuch-show-tags-regexp)
210     (split-string (buffer-substring (match-beginning 1) (match-end 1)))))
211
212 (defun notmuch-show-add-tag (&rest toadd)
213   "Add a tag to the current message."
214   (interactive
215    (list (notmuch-select-tag-with-completion "Tag to add: ")))
216   (apply 'notmuch-call-notmuch-process
217          (append (cons "tag"
218                        (mapcar (lambda (s) (concat "+" s)) toadd))
219                  (cons (notmuch-show-get-message-id) nil)))
220   (notmuch-show-set-tags (sort (union toadd (notmuch-show-get-tags) :test 'string=) 'string<)))
221
222 (defun notmuch-show-remove-tag (&rest toremove)
223   "Remove a tag from the current message."
224   (interactive
225    (list (notmuch-select-tag-with-completion "Tag to remove: " (notmuch-show-get-message-id))))
226   (let ((tags (notmuch-show-get-tags)))
227     (if (intersection tags toremove :test 'string=)
228         (progn
229           (apply 'notmuch-call-notmuch-process
230                  (append (cons "tag"
231                                (mapcar (lambda (s) (concat "-" s)) toremove))
232                          (cons (notmuch-show-get-message-id) nil)))
233           (notmuch-show-set-tags (sort (set-difference tags toremove :test 'string=) 'string<))))))
234
235 (defun notmuch-show-archive-thread-maybe-mark-read (markread)
236   (save-excursion
237     (goto-char (point-min))
238     (while (not (eobp))
239       (if markread
240           (notmuch-show-remove-tag "unread" "inbox")
241         (notmuch-show-remove-tag "inbox"))
242       (if (not (eobp))
243           (forward-char))
244       (if (not (re-search-forward notmuch-show-message-begin-regexp nil t))
245           (goto-char (point-max)))))
246   (let ((parent-buffer notmuch-show-parent-buffer))
247     (kill-this-buffer)
248     (if parent-buffer
249         (progn
250           (switch-to-buffer parent-buffer)
251           (forward-line)
252           (notmuch-search-show-thread)))))
253
254 (defun notmuch-show-mark-read-then-archive-thread ()
255   "Remove \"unread\" tag from each message, then archive and show next thread.
256
257 Archive each message currently shown by removing the \"unread\"
258 and \"inbox\" tag from each. Then kill this buffer and show the
259 next thread from the search from which this thread was originally
260 shown.
261
262 Note: This command is safe from any race condition of new messages
263 being delivered to the same thread. It does not archive the
264 entire thread, but only the messages shown in the current
265 buffer."
266   (interactive)
267   (notmuch-show-archive-thread-maybe-mark-read t))
268
269 (defun notmuch-show-archive-thread ()
270   "Archive each message in thread, and show next thread from search.
271
272 Archive each message currently shown by removing the \"inbox\"
273 tag from each. Then kill this buffer and show the next thread
274 from the search from which this thread was originally shown.
275
276 Note: This command is safe from any race condition of new messages
277 being delivered to the same thread. It does not archive the
278 entire thread, but only the messages shown in the current
279 buffer."
280   (interactive)
281   (notmuch-show-archive-thread-maybe-mark-read nil))
282
283 (defun notmuch-show-view-raw-message ()
284   "View the raw email of the current message."
285   (interactive)
286   (view-file (notmuch-show-get-filename)))
287
288 (defmacro with-current-notmuch-show-message (&rest body)
289   "Evaluate body with current buffer set to the text of current message"
290   `(save-excursion
291      (let ((filename (notmuch-show-get-filename)))
292        (let ((buf (generate-new-buffer (concat "*notmuch-msg-" filename "*"))))
293          (with-current-buffer buf
294            (insert-file-contents filename nil nil nil t)
295            ,@body)
296         (kill-buffer buf)))))
297
298 (defun notmuch-show-view-all-mime-parts ()
299   "Use external viewers (according to mailcap) to view all MIME-encoded parts."
300   (interactive)
301   (with-current-notmuch-show-message
302    (mm-display-parts (mm-dissect-buffer))))
303
304 (defun notmuch-foreach-mime-part (function mm-handle)
305   (cond ((stringp (car mm-handle))
306          (dolist (part (cdr mm-handle))
307            (notmuch-foreach-mime-part function part)))
308         ((bufferp (car mm-handle))
309          (funcall function mm-handle))
310         (t (dolist (part mm-handle)
311              (notmuch-foreach-mime-part function part)))))
312
313 (defun notmuch-count-attachments (mm-handle)
314   (let ((count 0))
315     (notmuch-foreach-mime-part
316      (lambda (p)
317        (let ((disposition (mm-handle-disposition p)))
318          (and (listp disposition)
319               (equal (car disposition) "attachment")
320               (incf count))))
321      mm-handle)
322     count))
323
324 (defun notmuch-save-attachments (mm-handle &optional queryp)
325   (notmuch-foreach-mime-part
326    (lambda (p)
327      (let ((disposition (mm-handle-disposition p)))
328        (and (listp disposition)
329             (equal (car disposition) "attachment")
330             (or (not queryp)
331                 (y-or-n-p
332                  (concat "Save '" (cdr (assq 'filename disposition)) "' ")))
333             (mm-save-part p))))
334    mm-handle))
335
336 (defun notmuch-show-save-attachments ()
337   "Save the attachments to a message"
338   (interactive)
339   (with-current-notmuch-show-message
340    (let ((mm-handle (mm-dissect-buffer)))
341      (notmuch-save-attachments
342       mm-handle (> (notmuch-count-attachments mm-handle) 1))))
343   (message "Done"))
344
345 (defun notmuch-reply (query-string)
346   (switch-to-buffer (generate-new-buffer "notmuch-draft"))
347   (call-process notmuch-command nil t nil "reply" query-string)
348   (message-insert-signature)
349   (goto-char (point-min))
350   (if (re-search-forward "^$" nil t)
351       (progn
352         (insert "--text follows this line--")
353         (forward-line)))
354   (message-mode))
355
356 (defun notmuch-show-reply ()
357   "Begin composing a reply to the current message in a new buffer."
358   (interactive)
359   (let ((message-id (notmuch-show-get-message-id)))
360     (notmuch-reply message-id)))
361
362 (defun notmuch-show-forward-current ()
363   "Forward a the current message."
364   (interactive)
365   (with-current-notmuch-show-message
366    (message-forward)))
367
368 (defun notmuch-show-pipe-message (command)
369   "Pipe the contents of the current message to the given command.
370
371 The given command will be executed with the raw contents of the
372 current email message as stdin. Anything printed by the command
373 to stdout or stderr will appear in the *Messages* buffer."
374   (interactive "sPipe message to command: ")
375   (apply 'start-process-shell-command "notmuch-pipe-command" "*notmuch-pipe*"
376          (list command " < " (shell-quote-argument (notmuch-show-get-filename)))))
377
378 (defun notmuch-show-move-to-current-message-summary-line ()
379   "Move to the beginning of the one-line summary of the current message.
380
381 This gives us a stable place to move to and work from since the
382 summary line is always visible. This is important since moving to
383 an invisible location is unreliable, (the main command loop moves
384 point either forward or backward to the next visible character
385 when a command ends with point on an invisible character).
386
387 Emits an error if point is not within a valid message, (that is
388 not pattern of `notmuch-show-message-begin-regexp' could be found
389 by searching backward)."
390   (beginning-of-line)
391   (if (not (looking-at notmuch-show-message-begin-regexp))
392       (if (re-search-backward notmuch-show-message-begin-regexp nil t)
393           (forward-line 2)
394         (error "Not within a valid message."))
395     (forward-line 2)))
396
397 (defun notmuch-show-last-message-p ()
398   "Predicate testing whether point is within the last message."
399   (save-window-excursion
400     (save-excursion
401       (notmuch-show-move-to-current-message-summary-line)
402       (not (re-search-forward notmuch-show-message-begin-regexp nil t)))))
403
404 (defun notmuch-show-message-unread-p ()
405   "Preficate testing whether current message is unread."
406   (member "unread" (notmuch-show-get-tags)))
407
408 (defun notmuch-show-next-message ()
409   "Advance to the beginning of the next message in the buffer.
410
411 Moves to the last visible character of the current message if
412 already on the last message in the buffer."
413   (interactive)
414   (notmuch-show-move-to-current-message-summary-line)
415   (if (re-search-forward notmuch-show-message-begin-regexp nil t)
416       (notmuch-show-move-to-current-message-summary-line)
417     (goto-char (- (point-max) 1))
418     (while (point-invisible-p)
419       (backward-char)))
420   (recenter 0))
421
422 (defun notmuch-show-find-next-message ()
423   "Returns the position of the next message in the buffer.
424
425 Or the position of the last visible character of the current
426 message if already within the last message in the buffer."
427   ; save-excursion doesn't save our window position
428   ; save-window-excursion doesn't save point
429   ; Looks like we have to use both.
430   (save-excursion
431     (save-window-excursion
432       (notmuch-show-next-message)
433       (point))))
434
435 (defun notmuch-show-next-unread-message ()
436   "Advance to the beginning of the next unread message in the buffer.
437
438 Moves to the last visible character of the current message if
439 there are no more unread messages past the current point."
440   (notmuch-show-next-message)
441   (while (and (not (notmuch-show-last-message-p))
442               (not (notmuch-show-message-unread-p)))
443     (notmuch-show-next-message))
444   (if (not (notmuch-show-message-unread-p))
445       (notmuch-show-next-message)))
446
447 (defun notmuch-show-next-open-message ()
448   "Advance to the next message which is not hidden.
449
450 If read messages are currently hidden, advance to the next unread
451 message. Otherwise, advance to the next message."
452   (if (or (memq 'notmuch-show-body-read buffer-invisibility-spec)
453           (assq 'notmuch-show-body-read buffer-invisibility-spec))
454       (notmuch-show-next-unread-message)
455     (notmuch-show-next-message)))
456
457 (defun notmuch-show-previous-message ()
458   "Backup to the beginning of the previous message in the buffer.
459
460 If within a message rather than at the beginning of it, then
461 simply move to the beginning of the current message."
462   (interactive)
463   (let ((start (point)))
464     (notmuch-show-move-to-current-message-summary-line)
465     (if (not (< (point) start))
466         ; Go backward twice to skip the current message's marker
467         (progn
468           (re-search-backward notmuch-show-message-begin-regexp nil t)
469           (re-search-backward notmuch-show-message-begin-regexp nil t)
470           (notmuch-show-move-to-current-message-summary-line)
471           ))
472     (recenter 0)))
473
474 (defun notmuch-show-find-previous-message ()
475   "Returns the position of the previous message in the buffer.
476
477 Or the position of the beginning of the current message if point
478 is originally within the message rather than at the beginning of
479 it."
480   ; save-excursion doesn't save our window position
481   ; save-window-excursion doesn't save point
482   ; Looks like we have to use both.
483   (save-excursion
484     (save-window-excursion
485       (notmuch-show-previous-message)
486       (point))))
487
488 (defun notmuch-show-mark-read-then-next-open-message ()
489   "Remove unread tag from current message, then advance to next unread message."
490   (interactive)
491   (notmuch-show-remove-tag "unread")
492   (notmuch-show-next-open-message))
493
494 (defun notmuch-show-rewind ()
495   "Do reverse scrolling compared to `notmuch-show-advance-marking-read-and-archiving'
496
497 Specifically, if the beginning of the previous email is fewer
498 than `window-height' lines from the current point, move to it
499 just like `notmuch-show-previous-message'.
500
501 Otherwise, just scroll down a screenful of the current message.
502
503 This command does not modify any message tags, (it does not undo
504 any effects from previous calls to
505 `notmuch-show-advance-marking-read-and-archiving'."
506   (interactive)
507   (let ((previous (notmuch-show-find-previous-message)))
508     (if (> (count-lines previous (point)) (- (window-height) next-screen-context-lines))
509         (progn
510           (condition-case nil
511               (scroll-down nil)
512             ((beginning-of-buffer) nil))
513           (goto-char (window-start)))
514       (notmuch-show-previous-message))))
515
516 (defun notmuch-show-advance-marking-read-and-archiving ()
517   "Advance through buffer, marking read and archiving.
518
519 This command is intended to be one of the simplest ways to
520 process a thread of email. It does the following:
521
522 If the current message in the thread is not yet fully visible,
523 scroll by a near screenful to read more of the message.
524
525 Otherwise, (the end of the current message is already within the
526 current window), remove the \"unread\" tag (if present) from the
527 current message and advance to the next open message.
528
529 Finally, if there is no further message to advance to, and this
530 last message is already read, then archive the entire current
531 thread, (remove the \"inbox\" tag from each message). Also kill
532 this buffer, and display the next thread from the search from
533 which this thread was originally shown."
534   (interactive)
535   (let ((next (notmuch-show-find-next-message))
536         (unread (notmuch-show-message-unread-p)))
537     (if (> next (window-end))
538         (scroll-up nil)
539       (let ((last (notmuch-show-last-message-p)))
540         (notmuch-show-mark-read-then-next-open-message)
541         (if last
542             (notmuch-show-archive-thread))))))
543
544 (defun notmuch-show-next-button ()
545   "Advance point to the next button in the buffer."
546   (interactive)
547   (goto-char (button-start (next-button (point)))))
548
549 (defun notmuch-show-previous-button ()
550   "Move point back to the previous button in the buffer."
551   (interactive)
552   (goto-char (button-start (previous-button (point)))))
553
554 (defun notmuch-toggle-invisible-action (cite-button)
555   (let ((invis-spec (button-get button 'invisibility-spec)))
556         (if (invisible-p invis-spec)
557             (remove-from-invisibility-spec invis-spec)
558           (add-to-invisibility-spec invis-spec)
559           ))
560   (force-window-update)
561   (redisplay t))
562
563 (define-button-type 'notmuch-button-invisibility-toggle-type 'action 'notmuch-toggle-invisible-action 'follow-link t)
564 (define-button-type 'notmuch-button-citation-toggle-type 'help-echo "mouse-1, RET: Show citation"
565   :supertype 'notmuch-button-invisibility-toggle-type)
566 (define-button-type 'notmuch-button-signature-toggle-type 'help-echo "mouse-1, RET: Show signature"
567   :supertype 'notmuch-button-invisibility-toggle-type)
568 (define-button-type 'notmuch-button-headers-toggle-type 'help-echo "mouse-1, RET: Show headers"
569   :supertype 'notmuch-button-invisibility-toggle-type)
570 (define-button-type 'notmuch-button-body-toggle-type 'help-echo "mouse-1, RET: Show message"
571   :supertype 'notmuch-button-invisibility-toggle-type)
572
573 (defun notmuch-show-markup-citations-region (beg end depth)
574   (goto-char beg)
575   (beginning-of-line)
576   (while (< (point) end)
577     (let ((beg-sub (point-marker))
578           (indent (make-string depth ? ))
579           (citation "[[:space:]]*>"))
580       (if (looking-at citation)
581           (progn
582             (while (looking-at citation)
583               (forward-line))
584             (let ((overlay (make-overlay beg-sub (point)))
585                   (invis-spec (make-symbol "notmuch-citation-region")))
586               (add-to-invisibility-spec invis-spec)
587               (overlay-put overlay 'invisible invis-spec)
588               (let ((p (point))
589                     (cite-button-text
590                      (concat "["  (number-to-string (count-lines beg-sub (point)))
591                              "-line citation.]")))
592                 (goto-char (- beg-sub 1))
593                 (insert (concat "\n" indent))
594                 (insert-button cite-button-text
595                                'invisibility-spec invis-spec
596                                :type 'notmuch-button-citation-toggle-type)
597                 (insert "\n")
598                 (goto-char (+ (length cite-button-text) p))
599               ))))
600       (move-to-column depth)
601       (if (looking-at notmuch-show-signature-regexp)
602           (let ((sig-lines (- (count-lines beg-sub end) 1)))
603             (if (<= sig-lines notmuch-show-signature-lines-max)
604                 (progn
605                   (let ((invis-spec (make-symbol "notmuch-signature-region")))
606                     (add-to-invisibility-spec invis-spec)
607                     (overlay-put (make-overlay beg-sub end)
608                                  'invisible invis-spec)
609                   
610                     (goto-char (- beg-sub 1))
611                     (insert (concat "\n" indent))
612                     (let ((sig-button-text (concat "[" (number-to-string sig-lines)
613                                                    "-line signature.]")))
614                       (insert-button sig-button-text 'invisibility-spec invis-spec
615                                      :type 'notmuch-button-signature-toggle-type)
616                      )
617                     (insert "\n")
618                     (goto-char end))))))
619       (forward-line))))
620
621 (defun notmuch-show-markup-part (beg end depth mime-message)
622   (if (re-search-forward notmuch-show-part-begin-regexp nil t)
623       (progn
624         (if (eq mime-message nil)
625             (let ((filename (notmuch-show-get-filename)))
626               (with-temp-buffer
627                 (insert-file-contents filename nil nil nil t)
628                 (setq mime-message (mm-dissect-buffer)))))
629         (forward-line)
630         (let ((part-beg (point-marker)))
631           (re-search-forward notmuch-show-part-end-regexp)
632
633           (let ((part-end (copy-marker (match-beginning 0))))
634             (goto-char part-end)
635             (if (not (bolp))
636                 (insert "\n"))
637             (indent-rigidly part-beg part-end depth)
638             (save-excursion
639               (goto-char part-beg)
640               (forward-line -1)
641               (beginning-of-line)
642               (let ((handle-type (mm-handle-type mime-message))
643                     mime-type)
644                 (if (sequencep (car handle-type))
645                     (setq mime-type (car handle-type))
646                   (setq mime-type (car (car (cdr handle-type))))
647                   )
648                 (if (equal mime-type "text/html")
649                     (mm-display-part mime-message))))
650
651             (notmuch-show-markup-citations-region part-beg part-end depth)
652             ; Advance to the next part (if any) (so the outer loop can
653             ; determine whether we've left the current message.
654             (if (re-search-forward notmuch-show-part-begin-regexp nil t)
655                 (beginning-of-line)))))
656     (goto-char end))
657   mime-message)
658
659 (defun notmuch-show-markup-parts-region (beg end depth)
660   (save-excursion
661     (goto-char beg)
662     (let (mime-message)
663       (while (< (point) end)
664         (setq mime-message
665               (notmuch-show-markup-part
666                beg end depth mime-message))))))
667
668 (defun notmuch-show-markup-body (depth btn)
669   (re-search-forward notmuch-show-body-begin-regexp)
670   (forward-line)
671   (let ((beg (point-marker)))
672     (re-search-forward notmuch-show-body-end-regexp)
673     (let ((end (copy-marker (match-beginning 0))))
674       (notmuch-show-markup-parts-region beg end depth)
675       (let ((invis-spec (make-symbol "notmuch-show-body-read")))
676         (overlay-put (make-overlay beg end)
677                      'invisible invis-spec)
678         (button-put btn 'invisibility-spec invis-spec)
679         (if (not (notmuch-show-message-unread-p))
680             (add-to-invisibility-spec invis-spec)))
681       (set-marker beg nil)
682       (set-marker end nil)
683       )))
684 (defun notmuch-fontify-headers ()
685   (progn
686     (if (looking-at "[Tt]o:")
687         (progn
688           (overlay-put (make-overlay (point) (re-search-forward ":"))
689                        'face 'message-header-name)
690           (overlay-put (make-overlay (point) (re-search-forward ".*$"))
691                        'face 'message-header-to))
692     (if (looking-at "[B]?[Cc][Cc]:")
693         (progn
694           (overlay-put (make-overlay (point) (re-search-forward ":"))
695                        'face 'message-header-name)
696           (overlay-put (make-overlay (point) (re-search-forward ".*$"))
697                        'face 'message-header-cc))
698     (if (looking-at "[Ss]ubject:")
699         (progn
700           (overlay-put (make-overlay (point) (re-search-forward ":"))
701                        'face 'message-header-name)
702           (overlay-put (make-overlay (point) (re-search-forward ".*$"))
703                        'face 'message-header-subject))
704     (if (looking-at "[Ff]rom:")
705         (progn
706           (overlay-put (make-overlay (point) (re-search-forward ":"))
707                        'face 'message-header-name)
708           (overlay-put (make-overlay (point) (re-search-forward ".*$"))
709                        'face 'message-header-other))))))))
710
711 (defun notmuch-show-markup-header (depth)
712   (re-search-forward notmuch-show-header-begin-regexp)
713   (forward-line)
714   (let ((beg (point-marker))
715         (btn nil))
716     (end-of-line)
717     ; Inverse video for subject
718     (overlay-put (make-overlay beg (point)) 'face '(:inverse-video t))
719     (setq btn (make-button beg (point) :type 'notmuch-button-body-toggle-type))
720     (forward-line 1)
721     (end-of-line)
722     (let ((beg-hidden (point-marker)))
723       (re-search-forward notmuch-show-header-end-regexp)
724       (beginning-of-line)
725       (let ((end (point-marker)))
726         (goto-char beg)
727         (forward-line)
728         (while (looking-at "[A-Za-z][-A-Za-z0-9]*:")
729           (beginning-of-line)
730           (notmuch-fontify-headers)
731           (forward-line)
732           )
733         (indent-rigidly beg end depth)
734         (let ((invis-spec (make-symbol "notmuch-show-header")))
735           (add-to-invisibility-spec (cons invis-spec t))
736           (overlay-put (make-overlay beg-hidden end)
737                        'invisible invis-spec)
738           (goto-char beg)
739           (forward-line)
740           (make-button (line-beginning-position) (line-end-position)
741                         'invisibility-spec (cons invis-spec t)
742                         :type 'notmuch-button-headers-toggle-type))
743         (goto-char end)
744         (insert "\n")
745         (set-marker beg nil)
746         (set-marker beg-hidden nil)
747         (set-marker end nil)
748         ))
749     btn))
750
751 (defun notmuch-show-markup-message ()
752   (if (re-search-forward notmuch-show-message-begin-regexp nil t)
753       (progn
754         (re-search-forward notmuch-show-depth-regexp)
755         (let ((depth (string-to-number (buffer-substring (match-beginning 1) (match-end 1))))
756               (btn nil))
757           (setq btn (notmuch-show-markup-header depth))
758           (notmuch-show-markup-body depth btn)))
759     (goto-char (point-max))))
760
761 (defun notmuch-show-hide-markers ()
762   (save-excursion
763     (goto-char (point-min))
764     (while (not (eobp))
765       (if (re-search-forward notmuch-show-marker-regexp nil t)
766           (progn
767             (overlay-put (make-overlay (match-beginning 0) (+ (match-end 0) 1))
768                          'invisible 'notmuch-show-marker))
769         (goto-char (point-max))))))
770
771 (defun notmuch-show-markup-messages ()
772   (save-excursion
773     (goto-char (point-min))
774     (while (not (eobp))
775       (notmuch-show-markup-message)))
776   (notmuch-show-hide-markers))
777
778 (defun notmuch-documentation-first-line (symbol)
779   "Return the first line of the documentation string for SYMBOL."
780   (let ((doc (documentation symbol)))
781     (if doc
782         (with-temp-buffer
783           (insert (documentation symbol))
784           (goto-char (point-min))
785           (let ((beg (point)))
786             (end-of-line)
787             (buffer-substring beg (point))))
788       "")))
789
790 (defun notmuch-substitute-one-command-key (binding)
791   "For a key binding, return a string showing a human-readable representation
792 of the key as well as the first line of documentation from the bound function.
793
794 For a mouse binding, return nil."
795   (let ((key (car binding)))
796     (if (mouse-event-p key)
797         nil
798       (concat (format-kbd-macro (vector key))
799               "\t"
800               (notmuch-documentation-first-line (cdr binding))))))
801
802 (defun notmuch-substitute-command-keys (doc)
803   "Like `substitute-command-keys' but with documentation, not function names."
804   (let ((beg 0))
805     (while (string-match "\\\\{\\([^}[:space:]]*\\)}" doc beg)
806       (let ((map (substring doc (match-beginning 1) (match-end 1))))
807         (setq doc (replace-match (mapconcat 'notmuch-substitute-one-command-key
808                                             (cdr (symbol-value (intern map))) "\n") 1 1 doc)))
809       (setq beg (match-end 0)))
810     doc))
811
812 (defun notmuch-help ()
813   "Display help for the current notmuch mode."
814   (interactive)
815   (let ((mode major-mode))
816     (with-help-window (help-buffer)
817       (princ (notmuch-substitute-command-keys (documentation mode t))))))
818
819 ;;;###autoload
820 (defun notmuch-show-mode ()
821   "Major mode for viewing a thread with notmuch.
822
823 This buffer contains the results of the \"notmuch show\" command
824 for displaying a single thread of email from your email archives.
825
826 By default, various components of email messages, (citations,
827 signatures, already-read messages), are invisible to help you
828 focus on the most important things, (new text from unread
829 messages). See the various commands below for toggling the
830 visibility of hidden components.
831
832 The `notmuch-show-next-message' and
833 `notmuch-show-previous-message' commands, (bound to 'n' and 'p by
834 default), allow you to navigate to the next and previous
835 messages. Each time you navigate away from a message with
836 `notmuch-show-next-message' the current message will have its
837 \"unread\" tag removed.
838
839 You can add or remove tags from the current message with '+' and
840 '-'.  You can also archive all messages in the current
841 view, (remove the \"inbox\" tag from each), with
842 `notmuch-show-archive-thread' (bound to 'a' by default).
843
844 \\{notmuch-show-mode-map}"
845   (interactive)
846   (kill-all-local-variables)
847   (add-to-invisibility-spec 'notmuch-show-marker)
848   (use-local-map notmuch-show-mode-map)
849   (setq major-mode 'notmuch-show-mode
850         mode-name "notmuch-show")
851   (setq buffer-read-only t))
852
853 (defgroup notmuch nil
854   "Notmuch mail reader for Emacs."
855   :group 'mail)
856
857 (defcustom notmuch-show-hook nil
858   "List of functions to call when notmuch displays a message."
859   :type 'hook
860   :options '(goto-address)
861   :group 'notmuch)
862
863 (defcustom notmuch-search-hook nil
864   "List of functions to call when notmuch displays the search results."
865   :type 'hook
866   :options '(hl-line-mode)
867   :group 'notmuch)
868
869 ; Make show mode a bit prettier, highlighting URLs and using word wrap
870
871 (defun notmuch-show-pretty-hook ()
872   (goto-address-mode 1)
873   (visual-line-mode))
874
875 (add-hook 'notmuch-show-hook 'notmuch-show-pretty-hook)
876 (add-hook 'notmuch-search-hook
877           (lambda()
878             (hl-line-mode 1) ))
879
880 (defun notmuch-show (thread-id &optional parent-buffer)
881   "Run \"notmuch show\" with the given thread ID and display results.
882
883 The optional PARENT-BUFFER is the notmuch-search buffer from
884 which this notmuch-show command was executed, (so that the next
885 thread from that buffer can be show when done with this one)."
886   (interactive "sNotmuch show: ")
887   (let ((buffer (get-buffer-create (concat "*notmuch-show-" thread-id "*"))))
888     (switch-to-buffer buffer)
889     (notmuch-show-mode)
890     (set (make-local-variable 'notmuch-show-parent-buffer) parent-buffer)
891     (let ((proc (get-buffer-process (current-buffer)))
892           (inhibit-read-only t))
893       (if proc
894           (error "notmuch search process already running for query `%s'" thread-id)
895         )
896       (erase-buffer)
897       (goto-char (point-min))
898       (save-excursion
899         (call-process notmuch-command nil t nil "show" thread-id)
900         (notmuch-show-markup-messages)
901         )
902       (run-hooks 'notmuch-show-hook)
903       ; Move straight to the first unread message
904       (if (not (notmuch-show-message-unread-p))
905           (progn
906             (notmuch-show-next-unread-message)
907             ; But if there are no unread messages, go back to the
908             ; beginning of the buffer, and open up the bodies of all
909             ; read message.
910             (if (not (notmuch-show-message-unread-p))
911                 (progn
912                   (goto-char (point-min))
913                   (let ((btn (forward-button 1)))
914                     (while btn
915                       (if (button-has-type-p btn 'notmuch-button-body-toggle-type)
916                           (push-button))
917                       (condition-case err
918                           (setq btn (forward-button 1))
919                         (error (setq btn nil)))
920                     ))
921                   (goto-char (point-min))
922                   ))))
923       )))
924
925 (defvar notmuch-search-authors-width 40
926   "Number of columns to use to display authors in a notmuch-search buffer.")
927
928 (defvar notmuch-search-mode-map
929   (let ((map (make-sparse-keymap)))
930     (define-key map "?" 'notmuch-help)
931     (define-key map "q" 'kill-this-buffer)
932     (define-key map "x" 'kill-this-buffer)
933     (define-key map (kbd "<DEL>") 'notmuch-search-scroll-down)
934     (define-key map "b" 'notmuch-search-scroll-down)
935     (define-key map " " 'notmuch-search-scroll-up)
936     (define-key map "<" 'notmuch-search-first-thread)
937     (define-key map ">" 'notmuch-search-last-thread)
938     (define-key map "p" 'notmuch-search-previous-thread)
939     (define-key map "n" 'notmuch-search-next-thread)
940     (define-key map "r" 'notmuch-search-reply-to-thread)
941     (define-key map "m" 'message-mail)
942     (define-key map "s" 'notmuch-search)
943     (define-key map "o" 'notmuch-search-toggle-order)
944     (define-key map "=" 'notmuch-search-refresh-view)
945     (define-key map "t" 'notmuch-search-filter-by-tag)
946     (define-key map "f" 'notmuch-search-filter)
947     (define-key map [mouse-1] 'notmuch-search-show-thread)
948     (define-key map "*" 'notmuch-search-operate-all)
949     (define-key map "a" 'notmuch-search-archive-thread)
950     (define-key map "-" 'notmuch-search-remove-tag)
951     (define-key map "+" 'notmuch-search-add-tag)
952     (define-key map (kbd "RET") 'notmuch-search-show-thread)
953     map)
954   "Keymap for \"notmuch search\" buffers.")
955 (fset 'notmuch-search-mode-map notmuch-search-mode-map)
956
957 (defvar notmuch-search-query-string)
958 (defvar notmuch-search-oldest-first t
959   "Show the oldest mail first in the search-mode")
960
961 (defun notmuch-search-scroll-up ()
962   "Move forward through search results by one window's worth."
963   (interactive)
964   (condition-case nil
965       (scroll-up nil)
966     ((end-of-buffer) (notmuch-search-last-thread))))
967
968 (defun notmuch-search-scroll-down ()
969   "Move backward through the search results by one window's worth."
970   (interactive)
971   ; I don't know why scroll-down doesn't signal beginning-of-buffer
972   ; the way that scroll-up signals end-of-buffer, but c'est la vie.
973   ;
974   ; So instead of trapping a signal we instead check whether the
975   ; window begins on the first line of the buffer and if so, move
976   ; directly to that position. (We have to count lines since the
977   ; window-start position is not the same as point-min due to the
978   ; invisible thread-ID characters on the first line.
979   (if (equal (count-lines (point-min) (window-start)) 0)
980       (goto-char (point-min))
981     (scroll-down nil)))
982
983 (defun notmuch-search-next-thread ()
984   "Select the next thread in the search results."
985   (interactive)
986   (next-line))
987
988 (defun notmuch-search-previous-thread ()
989   "Select the previous thread in the search results."
990   (interactive)
991   (previous-line))
992
993 (defun notmuch-search-last-thread ()
994   "Select the last thread in the search results."
995   (interactive)
996   (goto-char (point-max))
997   (forward-line -2))
998
999 (defun notmuch-search-first-thread ()
1000   "Select the first thread in the search results."
1001   (interactive)
1002   (goto-char (point-min)))
1003
1004 (defface notmuch-tag-face
1005   '((((class color)
1006       (background dark))
1007      (:foreground "OliveDrab1"))
1008     (((class color)
1009       (background light))
1010      (:foreground "navy blue" :bold t))
1011     (t
1012      (:bold t)))
1013   "Notmuch search mode face used to highligh tags."
1014   :group 'notmuch)
1015
1016 (defvar notmuch-tag-face-alist nil
1017   "List containing the tag list that need to be highlighed")
1018
1019 (defvar notmuch-search-font-lock-keywords  nil)
1020
1021 ;;;###autoload
1022 (defun notmuch-search-mode ()
1023   "Major mode displaying results of a notmuch search.
1024
1025 This buffer contains the results of a \"notmuch search\" of your
1026 email archives. Each line in the buffer represents a single
1027 thread giving a summary of the thread (a relative date, the
1028 number of matched messages and total messages in the thread,
1029 participants in the thread, a representative subject line, and
1030 any tags).
1031
1032 By default, pressing RET on any line displays that thread. The
1033 '+' and '-' keys can be used to add or remove tags from a
1034 thread. The 'a' key is a convenience key for archiving a
1035 thread (removing the \"inbox\" tag). The '*' key can be used to
1036 add or remove a tag from all threads in the current buffer.
1037
1038 Other useful commands are 'f' for filtering the current search
1039 based on an additional query string, 't' for filtering to include
1040 only messages with a given tag, and 's' to execute a new, global
1041 search.
1042
1043 Complete list of currently available key bindings:
1044
1045 \\{notmuch-search-mode-map}"
1046   (interactive)
1047   (kill-all-local-variables)
1048   (make-local-variable 'notmuch-search-query-string)
1049   (make-local-variable 'notmuch-search-oldest-first)
1050   (set (make-local-variable 'scroll-preserve-screen-position) t)
1051   (add-to-invisibility-spec 'notmuch-search)
1052   (use-local-map notmuch-search-mode-map)
1053   (setq truncate-lines t)
1054   (setq major-mode 'notmuch-search-mode
1055         mode-name "notmuch-search")
1056   (setq buffer-read-only t)
1057   (if (not notmuch-tag-face-alist)
1058       (add-to-list 'notmuch-search-font-lock-keywords (list
1059                 "(\\([^)]*\\))$" '(1  'notmuch-tag-face)))
1060     (progn
1061   (setq notmuch-search-tags (mapcar 'car notmuch-tag-face-alist))
1062   (loop for notmuch-search-tag  in notmuch-search-tags
1063     do (add-to-list 'notmuch-search-font-lock-keywords (list
1064                                 (concat "([^)]*\\(" notmuch-search-tag "\\)[^)]*)$")
1065                     `(1  ,(cdr (assoc notmuch-search-tag notmuch-tag-face-alist))))))))
1066   (set (make-local-variable 'font-lock-defaults)
1067          '(notmuch-search-font-lock-keywords t)))
1068
1069 (defun notmuch-search-find-thread-id ()
1070   "Return the thread for the current thread"
1071   (get-text-property (point) 'notmuch-search-thread-id))
1072
1073 (defun notmuch-search-show-thread ()
1074   "Display the currently selected thread."
1075   (interactive)
1076   (let ((thread-id (notmuch-search-find-thread-id)))
1077     (if (> (length thread-id) 0)
1078         (notmuch-show thread-id (current-buffer))
1079       (error "End of search results"))))
1080
1081 (defun notmuch-search-reply-to-thread ()
1082   "Begin composing a reply to the entire current thread in a new buffer."
1083   (interactive)
1084   (let ((message-id (notmuch-search-find-thread-id)))
1085     (notmuch-reply message-id)))
1086
1087 (defun notmuch-call-notmuch-process (&rest args)
1088   "Synchronously invoke \"notmuch\" with the given list of arguments.
1089
1090 Output from the process will be presented to the user as an error
1091 and will also appear in a buffer named \"*Notmuch errors*\"."
1092   (let ((error-buffer (get-buffer-create "*Notmuch errors*")))
1093     (with-current-buffer error-buffer
1094         (erase-buffer))
1095     (if (eq (apply 'call-process notmuch-command nil error-buffer nil args) 0)
1096         (point)
1097       (progn
1098         (with-current-buffer error-buffer
1099           (let ((beg (point-min))
1100                 (end (- (point-max) 1)))
1101             (error (buffer-substring beg end))
1102             ))))))
1103
1104 (defun notmuch-search-set-tags (tags)
1105   (save-excursion
1106     (end-of-line)
1107     (re-search-backward "(")
1108     (forward-char)
1109     (let ((beg (point))
1110           (inhibit-read-only t))
1111       (re-search-forward ")")
1112       (backward-char)
1113       (let ((end (point)))
1114         (delete-region beg end)
1115         (insert (mapconcat  'identity tags " "))))))
1116
1117 (defun notmuch-search-get-tags ()
1118   (save-excursion
1119     (end-of-line)
1120     (re-search-backward "(")
1121     (let ((beg (+ (point) 1)))
1122       (re-search-forward ")")
1123       (let ((end (- (point) 1)))
1124         (split-string (buffer-substring beg end))))))
1125
1126 (defun notmuch-search-add-tag (tag)
1127   "Add a tag to the currently selected thread.
1128
1129 The tag is added to messages in the currently selected thread
1130 which match the current search terms."
1131   (interactive
1132    (list (notmuch-select-tag-with-completion "Tag to add: ")))
1133   (notmuch-call-notmuch-process "tag" (concat "+" tag) (notmuch-search-find-thread-id) " and " notmuch-search-query-string)
1134   (notmuch-search-set-tags (delete-dups (sort (cons tag (notmuch-search-get-tags)) 'string<))))
1135
1136 (defun notmuch-search-remove-tag (tag)
1137   "Remove a tag from the currently selected thread.
1138
1139 The tag is removed from messages in the currently selected thread
1140 which match the current search terms."
1141   (interactive
1142    (list (notmuch-select-tag-with-completion "Tag to remove: " (notmuch-search-find-thread-id))))
1143   (notmuch-call-notmuch-process "tag" (concat "-" tag) (notmuch-search-find-thread-id) " and " notmuch-search-query-string)
1144   (notmuch-search-set-tags (delete tag (notmuch-search-get-tags))))
1145
1146 (defun notmuch-search-archive-thread ()
1147   "Archive the currently selected thread (remove its \"inbox\" tag).
1148
1149 This function advances the next thread when finished."
1150   (interactive)
1151   (notmuch-search-remove-tag "inbox")
1152   (forward-line))
1153
1154 (defun notmuch-search-process-sentinel (proc msg)
1155   "Add a message to let user know when \"notmuch search\" exits"
1156   (let ((buffer (process-buffer proc))
1157         (status (process-status proc))
1158         (exit-status (process-exit-status proc)))
1159     (if (memq status '(exit signal))
1160         (if (buffer-live-p buffer)
1161             (with-current-buffer buffer
1162               (save-excursion
1163                 (let ((inhibit-read-only t))
1164                   (goto-char (point-max))
1165                   (if (eq status 'signal)
1166                       (insert "Incomplete search results (search process was killed).\n"))
1167                   (if (eq status 'exit)
1168                       (progn
1169                         (insert "End of search results.")
1170                         (if (not (= exit-status 0))
1171                             (insert (format " (process returned %d)" exit-status)))
1172                         (insert "\n"))))))))))
1173
1174 (defun notmuch-search-process-filter (proc string)
1175   "Process and filter the output of \"notmuch search\""
1176   (let ((buffer (process-buffer proc)))
1177     (if (buffer-live-p buffer)
1178         (with-current-buffer buffer
1179           (save-excursion
1180             (let ((line 0)
1181                   (more t)
1182                   (inhibit-read-only t))
1183               (while more
1184                 (if (string-match "^\\(thread:[0-9A-Fa-f]*\\) \\(.*\\) \\(\\[[0-9/]*\\]\\) \\([^:]*\\); \\(.*\\) (\\([^()]*\\))$" string line)
1185                     (let* ((thread-id (match-string 1 string))
1186                            (date (match-string 2 string))
1187                            (count (match-string 3 string))
1188                            (authors (match-string 4 string))
1189                            (authors-length (length authors))
1190                            (subject (match-string 5 string))
1191                            (tags (match-string 6 string)))
1192                       (if (> authors-length 40)
1193                           (set 'authors (concat (substring authors 0 (- 40 3)) "...")))
1194                       (goto-char (point-max))
1195                       (let ((beg (point-marker)))
1196                         (insert (format "%s %-7s %-40s %s (%s)\n" date count authors subject tags))
1197                         (put-text-property beg (point-marker) 'notmuch-search-thread-id thread-id))
1198                       (set 'line (match-end 0)))
1199                   (set 'more nil))))))
1200       (delete-process proc))))
1201
1202 (defun notmuch-search-operate-all (action)
1203   "Add/remove tags from all matching messages.
1204
1205 Tis command adds or removes tags from all messages matching the
1206 current search terms. When called interactively, this command
1207 will prompt for tags to be added or removed. Tags prefixed with
1208 '+' will be added and tags prefixed with '-' will be removed.
1209
1210 Each character of the tag name may consist of alphanumeric
1211 characters as well as `_.+-'.
1212 "
1213   (interactive "sOperation (+add -drop): notmuch tag ")
1214   (let ((action-split (split-string action " +")))
1215     ;; Perform some validation
1216     (let ((words action-split))
1217       (when (null words) (error "No operation given"))
1218       (while words
1219         (unless (string-match-p "^[-+][-+_.[:word:]]+$" (car words))
1220           (error "Action must be of the form `+thistag -that_tag'"))
1221         (setq words (cdr words))))
1222     (apply 'notmuch-call-notmuch-process "tag"
1223            (append action-split (list notmuch-search-query-string) nil))))
1224
1225 ;;;###autoload
1226 (defun notmuch-search (query &optional oldest-first)
1227   "Run \"notmuch search\" with the given query string and display results."
1228   (interactive "sNotmuch search: ")
1229   (let ((buffer (get-buffer-create (concat "*notmuch-search-" query "*"))))
1230     (switch-to-buffer buffer)
1231     (notmuch-search-mode)
1232     (set 'notmuch-search-query-string query)
1233     (set 'notmuch-search-oldest-first oldest-first)
1234     (let ((proc (get-buffer-process (current-buffer)))
1235           (inhibit-read-only t))
1236       (if proc
1237           (error "notmuch search process already running for query `%s'" query)
1238         )
1239       (erase-buffer)
1240       (goto-char (point-min))
1241       (save-excursion
1242         (let ((proc (start-process-shell-command
1243                      "notmuch-search" buffer notmuch-command "search"
1244                      (if oldest-first "--sort=oldest-first" "--sort=newest-first")
1245                      (shell-quote-argument query))))
1246           (set-process-sentinel proc 'notmuch-search-process-sentinel)
1247           (set-process-filter proc 'notmuch-search-process-filter))))
1248     (run-hooks 'notmuch-search-hook)))
1249
1250 (defun notmuch-search-refresh-view ()
1251   "Refresh the current view.
1252
1253 Kills the current buffer and runs a new search with the same
1254 query string as the current search. If the current thread is in
1255 the new search results, then point will be placed on the same
1256 thread. Otherwise, point will be moved to attempt to be in the
1257 same relative position within the new buffer."
1258   (interactive)
1259   (let ((here (point))
1260         (oldest-first notmuch-search-oldest-first)
1261         (thread (notmuch-search-find-thread-id))
1262         (query notmuch-search-query-string))
1263     (kill-this-buffer)
1264     (notmuch-search query oldest-first)
1265     (goto-char (point-min))
1266     (if (re-search-forward (concat "^" thread) nil t)
1267         (beginning-of-line)
1268       (goto-char here))))
1269
1270 (defun notmuch-search-toggle-order ()
1271   "Toggle the current search order.
1272
1273 By default, the \"inbox\" view created by `notmuch' is displayed
1274 in chronological order (oldest thread at the beginning of the
1275 buffer), while any global searches created by `notmuch-search'
1276 are displayed in reverse-chronological order (newest thread at
1277 the beginning of the buffer).
1278
1279 This command toggles the sort order for the current search.
1280
1281 Note that any filtered searches created by
1282 `notmuch-search-filter' retain the search order of the parent
1283 search."
1284   (interactive)
1285   (set 'notmuch-search-oldest-first (not notmuch-search-oldest-first))
1286   (notmuch-search-refresh-view))
1287
1288 (defun notmuch-search-filter (query)
1289   "Filter the current search results based on an additional query string.
1290
1291 Runs a new search matching only messages that match both the
1292 current search results AND the additional query string provided."
1293   (interactive "sFilter search: ")
1294   (notmuch-search (concat notmuch-search-query-string " and " query) notmuch-search-oldest-first))
1295
1296 (defun notmuch-search-filter-by-tag (tag)
1297   "Filter the current search results based on a single tag.
1298
1299 Runs a new search matching only messages that match both the
1300 current search results AND that are tagged with the given tag."
1301   (interactive
1302    (list (notmuch-select-tag-with-completion "Filter by tag: ")))
1303   (notmuch-search (concat notmuch-search-query-string " and tag:" tag) notmuch-search-oldest-first))
1304
1305
1306 ;;;###autoload
1307 (defun notmuch ()
1308   "Run notmuch to display all mail with tag of 'inbox'"
1309   (interactive)
1310   (notmuch-search "tag:inbox" notmuch-search-oldest-first))
1311
1312 (setq mail-user-agent 'message-user-agent)
1313
1314 (defvar notmuch-folder-mode-map
1315   (let ((map (make-sparse-keymap)))
1316     (define-key map "n" 'next-line)
1317     (define-key map "p" 'previous-line)
1318     (define-key map "x" 'kill-this-buffer)
1319     (define-key map "q" 'kill-this-buffer)
1320     (define-key map "s" 'notmuch-search)
1321     (define-key map (kbd "RET") 'notmuch-folder-show-search)
1322     (define-key map "<" 'beginning-of-buffer)
1323     (define-key map "=" 'notmuch-folder)
1324     (define-key map "?" 'notmuch-help)
1325     (define-key map [mouse-1] 'notmuch-folder-show-search)
1326     map)
1327   "Keymap for \"notmuch folder\" buffers.")
1328
1329 (fset 'notmuch-folder-mode-map notmuch-folder-mode-map)
1330
1331 (defcustom notmuch-folders (quote (("inbox" . "tag:inbox") ("unread" . "tag:unread")))
1332   "List of searches for the notmuch folder view"
1333   :type '(alist :key-type (string) :value-type (string))
1334   :group 'notmuch)
1335
1336 (defun notmuch-folder-mode ()
1337   "Major mode for showing notmuch 'folders'.
1338
1339 This buffer contains a list of messages counts returned by a
1340 customizable set of searches of your email archives. Each line
1341 in the buffer shows the search terms and the resulting message count.
1342
1343 Pressing RET on any line opens a search window containing the
1344 results for the search terms in that line.
1345
1346 \\{notmuch-folder-mode-map}"
1347   (interactive)
1348   (kill-all-local-variables)
1349   (use-local-map 'notmuch-folder-mode-map)
1350   (setq truncate-lines t)
1351   (hl-line-mode 1)
1352   (setq major-mode 'notmuch-folder-mode
1353         mode-name "notmuch-folder")
1354   (setq buffer-read-only t))
1355
1356 (defun notmuch-folder-add (folders)
1357   (if folders
1358       (let ((name (car (car folders)))
1359             (inhibit-read-only t)
1360             (search (cdr (car folders))))
1361         (insert name)
1362         (indent-to 16 1)
1363         (call-process notmuch-command nil t nil "count" search)
1364         (notmuch-folder-add (cdr folders)))))
1365
1366 (defun notmuch-folder-find-name ()
1367   (save-excursion
1368     (beginning-of-line)
1369     (let ((beg (point)))
1370       (forward-word)
1371       (filter-buffer-substring beg (point)))))
1372
1373 (defun notmuch-folder-show-search (&optional folder)
1374   "Show a search window for the search related to the specified folder."
1375   (interactive)
1376   (if (null folder)
1377       (setq folder (notmuch-folder-find-name)))
1378   (let ((search (assoc folder notmuch-folders)))
1379     (if search
1380         (notmuch-search (cdr search) notmuch-search-oldest-first))))
1381
1382 ;;;###autoload
1383 (defun notmuch-folder ()
1384   "Show the notmuch folder view and update the displayed counts."
1385   (interactive)
1386   (let ((buffer (get-buffer-create "*notmuch-folders*")))
1387     (switch-to-buffer buffer)
1388     (let ((inhibit-read-only t)
1389           (n (line-number-at-pos)))
1390       (erase-buffer)
1391       (notmuch-folder-mode)
1392       (notmuch-folder-add notmuch-folders)
1393       (goto-char (point-min))
1394       (goto-line n))))
1395
1396 (provide 'notmuch)