1 ; notmuch.el --- run notmuch within emacs
3 ; Copyright © Carl Worth
5 ; This file is part of Notmuch.
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.
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.
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/>.
20 ; Authors: Carl Worth <cworth@cworth.org>
22 ; This is an emacs-based interface to the notmuch mail system.
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.
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:
33 ; sudo make install-emacs
37 ; Then, to actually run it, add:
41 ; to your ~/.emacs file, and then run "M-x notmuch" from within emacs,
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).
54 (defvar notmuch-show-mode-map
55 (let ((map (make-sparse-keymap)))
56 (define-key map "?" 'notmuch-help)
57 (define-key map "q" 'kill-this-buffer)
58 (define-key map (kbd "C-p") 'notmuch-show-previous-line)
59 (define-key map (kbd "C-n") 'notmuch-show-next-line)
60 (define-key map (kbd "M-TAB") 'notmuch-show-previous-button)
61 (define-key map (kbd "TAB") 'notmuch-show-next-button)
62 (define-key map "s" 'notmuch-search)
63 (define-key map "m" 'message-mail)
64 (define-key map "f" 'notmuch-show-forward-current)
65 (define-key map "r" 'notmuch-show-reply)
66 (define-key map "|" 'notmuch-show-pipe-message)
67 (define-key map "w" 'notmuch-show-save-attachments)
68 (define-key map "V" 'notmuch-show-view-raw-message)
69 (define-key map "v" 'notmuch-show-view-all-mime-parts)
70 (define-key map "-" 'notmuch-show-remove-tag)
71 (define-key map "+" 'notmuch-show-add-tag)
72 (define-key map "X" 'notmuch-show-mark-read-then-archive-then-exit)
73 (define-key map "x" 'notmuch-show-archive-thread-then-exit)
74 (define-key map "A" 'notmuch-show-mark-read-then-archive-thread)
75 (define-key map "a" 'notmuch-show-archive-thread)
76 (define-key map "p" 'notmuch-show-previous-message)
77 (define-key map "N" 'notmuch-show-mark-read-then-next-open-message)
78 (define-key map "n" 'notmuch-show-next-message)
79 (define-key map (kbd "DEL") 'notmuch-show-rewind)
80 (define-key map " " 'notmuch-show-advance-marking-read-and-archiving)
82 "Keymap for \"notmuch show\" buffers.")
83 (fset 'notmuch-show-mode-map notmuch-show-mode-map)
85 (defvar notmuch-show-signature-regexp "\\(-- ?\\|_+\\)$"
86 "Pattern to match a line that separates content from signature.
88 The regexp can (and should) include $ to match the end of the
89 line, but should not include ^ to match the beginning of the
90 line. This is because notmuch may have inserted additional space
91 for indentation at the beginning of the line. But notmuch will
92 move past the indentation when testing this pattern, (so that the
93 pattern can still test against the entire line).")
95 (defvar notmuch-show-signature-lines-max 12
96 "Maximum length of signature that will be hidden by default.")
98 (defvar notmuch-command "notmuch"
99 "Command to run the notmuch binary.")
101 (defvar notmuch-show-message-begin-regexp "\fmessage{")
102 (defvar notmuch-show-message-end-regexp "\fmessage}")
103 (defvar notmuch-show-header-begin-regexp "\fheader{")
104 (defvar notmuch-show-header-end-regexp "\fheader}")
105 (defvar notmuch-show-body-begin-regexp "\fbody{")
106 (defvar notmuch-show-body-end-regexp "\fbody}")
107 (defvar notmuch-show-attachment-begin-regexp "\fattachment{")
108 (defvar notmuch-show-attachment-end-regexp "\fattachment}")
109 (defvar notmuch-show-part-begin-regexp "\fpart{")
110 (defvar notmuch-show-part-end-regexp "\fpart}")
111 (defvar notmuch-show-marker-regexp "\f\\(message\\|header\\|body\\|attachment\\|part\\)[{}].*$")
113 (defvar notmuch-show-id-regexp "\\(id:[^ ]*\\)")
114 (defvar notmuch-show-depth-regexp " depth:\\([0-9]*\\) ")
115 (defvar notmuch-show-filename-regexp "filename:\\(.*\\)$")
116 (defvar notmuch-show-tags-regexp "(\\([^)]*\\))$")
118 (defvar notmuch-show-parent-buffer nil)
119 (defvar notmuch-show-body-read-visible nil)
120 (defvar notmuch-show-citations-visible nil)
121 (defvar notmuch-show-signatures-visible nil)
122 (defvar notmuch-show-headers-visible nil)
124 ; XXX: This should be a generic function in emacs somewhere, not here
125 (defun point-invisible-p ()
126 "Return whether the character at point is invisible.
128 Here visibility is determined by `buffer-invisibility-spec' and
129 the invisible property of any overlays for point. It doesn't have
130 anything to do with whether point is currently being displayed
131 within the current window."
132 (let ((prop (get-char-property (point) 'invisible)))
133 (if (eq buffer-invisibility-spec t)
135 (or (memq prop buffer-invisibility-spec)
136 (assq prop buffer-invisibility-spec)))))
138 (defun notmuch-select-tag-with-completion (prompt &rest search-terms)
140 (with-output-to-string
141 (with-current-buffer standard-output
142 (apply 'call-process notmuch-command nil t nil "search-tags" search-terms)))))
143 (completing-read prompt (split-string tag-list "\n+" t) nil nil nil)))
145 (defun notmuch-show-next-line ()
146 "Like builtin `next-line' but ensuring we end on a visible character.
148 By advancing forward until reaching a visible character.
150 Unlike builtin `next-line' this version accepts no arguments."
152 (set 'this-command 'next-line)
153 (call-interactively 'next-line)
154 (while (point-invisible-p)
157 (defun notmuch-show-previous-line ()
158 "Like builtin `previous-line' but ensuring we end on a visible character.
160 By advancing forward until reaching a visible character.
162 Unlike builtin `previous-line' this version accepts no arguments."
164 (set 'this-command 'previous-line)
165 (call-interactively 'previous-line)
166 (while (point-invisible-p)
169 (defun notmuch-show-get-message-id ()
172 (if (not (looking-at notmuch-show-message-begin-regexp))
173 (re-search-backward notmuch-show-message-begin-regexp))
174 (re-search-forward notmuch-show-id-regexp)
175 (buffer-substring-no-properties (match-beginning 1) (match-end 1))))
177 (defun notmuch-show-get-filename ()
180 (if (not (looking-at notmuch-show-message-begin-regexp))
181 (re-search-backward notmuch-show-message-begin-regexp))
182 (re-search-forward notmuch-show-filename-regexp)
183 (buffer-substring-no-properties (match-beginning 1) (match-end 1))))
185 (defun notmuch-show-set-tags (tags)
188 (if (not (looking-at notmuch-show-message-begin-regexp))
189 (re-search-backward notmuch-show-message-begin-regexp))
190 (re-search-forward notmuch-show-tags-regexp)
191 (let ((inhibit-read-only t)
192 (beg (match-beginning 1))
194 (delete-region beg end)
196 (insert (mapconcat 'identity tags " ")))))
198 (defun notmuch-show-get-tags ()
201 (if (not (looking-at notmuch-show-message-begin-regexp))
202 (re-search-backward notmuch-show-message-begin-regexp))
203 (re-search-forward notmuch-show-tags-regexp)
204 (split-string (buffer-substring (match-beginning 1) (match-end 1)))))
206 (defun notmuch-show-add-tag (&rest toadd)
207 "Add a tag to the current message."
209 (list (notmuch-select-tag-with-completion "Tag to add: ")))
210 (apply 'notmuch-call-notmuch-process
212 (mapcar (lambda (s) (concat "+" s)) toadd))
213 (cons (notmuch-show-get-message-id) nil)))
214 (notmuch-show-set-tags (sort (union toadd (notmuch-show-get-tags) :test 'string=) 'string<)))
216 (defun notmuch-show-remove-tag (&rest toremove)
217 "Remove a tag from the current message."
219 (list (notmuch-select-tag-with-completion "Tag to remove: " (notmuch-show-get-message-id))))
220 (let ((tags (notmuch-show-get-tags)))
221 (if (intersection tags toremove :test 'string=)
223 (apply 'notmuch-call-notmuch-process
225 (mapcar (lambda (s) (concat "-" s)) toremove))
226 (cons (notmuch-show-get-message-id) nil)))
227 (notmuch-show-set-tags (sort (set-difference tags toremove :test 'string=) 'string<))))))
229 (defun notmuch-show-archive-thread-maybe-mark-read (markread)
231 (goto-char (point-min))
234 (notmuch-show-remove-tag "unread" "inbox")
235 (notmuch-show-remove-tag "inbox"))
238 (if (not (re-search-forward notmuch-show-message-begin-regexp nil t))
239 (goto-char (point-max)))))
240 (let ((parent-buffer notmuch-show-parent-buffer))
244 (switch-to-buffer parent-buffer)
246 (notmuch-search-show-thread)))))
248 (defun notmuch-show-mark-read-then-archive-thread ()
249 "Remove unread tags from thread, then archive and show next thread.
251 Archive each message currently shown by removing the \"unread\"
252 and \"inbox\" tag from each. Then kill this buffer and show the
253 next thread from the search from which this thread was originally
256 Note: This command is safe from any race condition of new messages
257 being delivered to the same thread. It does not archive the
258 entire thread, but only the messages shown in the current
261 (notmuch-show-archive-thread-maybe-mark-read t))
263 (defun notmuch-show-archive-thread ()
264 "Archive each message in thread, then show next thread from search.
266 Archive each message currently shown by removing the \"inbox\"
267 tag from each. Then kill this buffer and show the next thread
268 from the search from which this thread was originally shown.
270 Note: This command is safe from any race condition of new messages
271 being delivered to the same thread. It does not archive the
272 entire thread, but only the messages shown in the current
275 (notmuch-show-archive-thread-maybe-mark-read nil))
277 (defun notmuch-show-archive-thread-then-exit ()
278 "Archive each message in thread, then exit back to search results."
280 (notmuch-show-archive-thread)
283 (defun notmuch-show-mark-read-then-archive-then-exit ()
284 "Remove unread tags from thread, then archive and exit to search results."
286 (notmuch-show-mark-read-then-archive-thread)
289 (defun notmuch-show-view-raw-message ()
290 "View the raw email of the current message."
292 (view-file (notmuch-show-get-filename)))
294 (defmacro with-current-notmuch-show-message (&rest body)
295 "Evaluate body with current buffer set to the text of current message"
297 (let ((filename (notmuch-show-get-filename)))
298 (let ((buf (generate-new-buffer (concat "*notmuch-msg-" filename "*"))))
299 (with-current-buffer buf
300 (insert-file-contents filename nil nil nil t)
302 (kill-buffer buf)))))
304 (defun notmuch-show-view-all-mime-parts ()
305 "Use external viewers to view all attachments from the current message."
307 (with-current-notmuch-show-message
308 (mm-display-parts (mm-dissect-buffer))))
310 (defun notmuch-foreach-mime-part (function mm-handle)
311 (cond ((stringp (car mm-handle))
312 (dolist (part (cdr mm-handle))
313 (notmuch-foreach-mime-part function part)))
314 ((bufferp (car mm-handle))
315 (funcall function mm-handle))
316 (t (dolist (part mm-handle)
317 (notmuch-foreach-mime-part function part)))))
319 (defun notmuch-count-attachments (mm-handle)
321 (notmuch-foreach-mime-part
323 (let ((disposition (mm-handle-disposition p)))
324 (and (listp disposition)
325 (equal (car disposition) "attachment")
330 (defun notmuch-save-attachments (mm-handle &optional queryp)
331 (notmuch-foreach-mime-part
333 (let ((disposition (mm-handle-disposition p)))
334 (and (listp disposition)
335 (equal (car disposition) "attachment")
338 (concat "Save '" (cdr (assq 'filename disposition)) "' ")))
342 (defun notmuch-show-save-attachments ()
343 "Save all attachments from the current message."
345 (with-current-notmuch-show-message
346 (let ((mm-handle (mm-dissect-buffer)))
347 (notmuch-save-attachments
348 mm-handle (> (notmuch-count-attachments mm-handle) 1))))
351 (defun notmuch-reply (query-string)
352 (switch-to-buffer (generate-new-buffer "notmuch-draft"))
353 (call-process notmuch-command nil t nil "reply" query-string)
354 (message-insert-signature)
355 (goto-char (point-min))
356 (if (re-search-forward "^$" nil t)
358 (insert "--text follows this line--")
362 (defun notmuch-show-reply ()
363 "Begin composing a reply to the current message in a new buffer."
365 (let ((message-id (notmuch-show-get-message-id)))
366 (notmuch-reply message-id)))
368 (defun notmuch-show-forward-current ()
369 "Forward the current message."
371 (with-current-notmuch-show-message
374 (defun notmuch-show-pipe-message (command)
375 "Pipe the contents of the current message to the given command.
377 The given command will be executed with the raw contents of the
378 current email message as stdin. Anything printed by the command
379 to stdout or stderr will appear in the *Messages* buffer."
380 (interactive "sPipe message to command: ")
381 (apply 'start-process-shell-command "notmuch-pipe-command" "*notmuch-pipe*"
382 (list command " < " (shell-quote-argument (notmuch-show-get-filename)))))
384 (defun notmuch-show-move-to-current-message-summary-line ()
385 "Move to the beginning of the one-line summary of the current message.
387 This gives us a stable place to move to and work from since the
388 summary line is always visible. This is important since moving to
389 an invisible location is unreliable, (the main command loop moves
390 point either forward or backward to the next visible character
391 when a command ends with point on an invisible character).
393 Emits an error if point is not within a valid message, (that is
394 no pattern of `notmuch-show-message-begin-regexp' could be found
395 by searching backward)."
397 (if (not (looking-at notmuch-show-message-begin-regexp))
398 (if (re-search-backward notmuch-show-message-begin-regexp nil t)
400 (error "Not within a valid message."))
403 (defun notmuch-show-last-message-p ()
404 "Predicate testing whether point is within the last message."
405 (save-window-excursion
407 (notmuch-show-move-to-current-message-summary-line)
408 (not (re-search-forward notmuch-show-message-begin-regexp nil t)))))
410 (defun notmuch-show-message-unread-p ()
411 "Predicate testing whether current message is unread."
412 (member "unread" (notmuch-show-get-tags)))
414 (defun notmuch-show-message-open-p ()
415 "Predicate testing whether current message is open (body is visible)."
416 (let ((btn (previous-button (point) t)))
417 (while (not (button-has-type-p btn 'notmuch-button-body-toggle-type))
418 (setq btn (previous-button (button-start btn))))
419 (not (invisible-p (button-get btn 'invisibility-spec)))))
421 (defun notmuch-show-next-message ()
422 "Advance to the beginning of the next message in the buffer.
424 Moves to the last visible character of the current message if
425 already on the last message in the buffer.
427 Returns nil if already on the last message in the buffer."
429 (notmuch-show-move-to-current-message-summary-line)
430 (if (re-search-forward notmuch-show-message-begin-regexp nil t)
432 (notmuch-show-move-to-current-message-summary-line)
435 (goto-char (- (point-max) 1))
436 (while (point-invisible-p)
441 (defun notmuch-show-find-next-message ()
442 "Returns the position of the next message in the buffer.
444 Or the position of the last visible character of the current
445 message if already within the last message in the buffer."
446 ; save-excursion doesn't save our window position
447 ; save-window-excursion doesn't save point
448 ; Looks like we have to use both.
450 (save-window-excursion
451 (notmuch-show-next-message)
454 (defun notmuch-show-next-unread-message ()
455 "Advance to the beginning of the next unread message in the buffer.
457 Moves to the last visible character of the current message if
458 there are no more unread messages past the current point."
459 (notmuch-show-next-message)
460 (while (and (not (notmuch-show-last-message-p))
461 (not (notmuch-show-message-unread-p)))
462 (notmuch-show-next-message))
463 (if (not (notmuch-show-message-unread-p))
464 (notmuch-show-next-message)))
466 (defun notmuch-show-next-open-message ()
467 "Advance to the next open message (that is, body is not invisible)."
468 (while (and (notmuch-show-next-message)
469 (not (notmuch-show-message-open-p)))))
471 (defun notmuch-show-previous-message ()
472 "Backup to the beginning of the previous message in the buffer.
474 If within a message rather than at the beginning of it, then
475 simply move to the beginning of the current message."
477 (let ((start (point)))
478 (notmuch-show-move-to-current-message-summary-line)
479 (if (not (< (point) start))
480 ; Go backward twice to skip the current message's marker
482 (re-search-backward notmuch-show-message-begin-regexp nil t)
483 (re-search-backward notmuch-show-message-begin-regexp nil t)
484 (notmuch-show-move-to-current-message-summary-line)
488 (defun notmuch-show-find-previous-message ()
489 "Returns the position of the previous message in the buffer.
491 Or the position of the beginning of the current message if point
492 is originally within the message rather than at the beginning of
494 ; save-excursion doesn't save our window position
495 ; save-window-excursion doesn't save point
496 ; Looks like we have to use both.
498 (save-window-excursion
499 (notmuch-show-previous-message)
502 (defun notmuch-show-mark-read-then-next-open-message ()
503 "Remove unread tag from this message, then advance to next open message."
505 (notmuch-show-remove-tag "unread")
506 (notmuch-show-next-open-message))
508 (defun notmuch-show-rewind ()
509 "Backup through the thread, (reverse scrolling compared to \\[notmuch-show-advance-marking-read-and-archiving]).
511 Specifically, if the beginning of the previous email is fewer
512 than `window-height' lines from the current point, move to it
513 just like `notmuch-show-previous-message'.
515 Otherwise, just scroll down a screenful of the current message.
517 This command does not modify any message tags, (it does not undo
518 any effects from previous calls to
519 `notmuch-show-advance-marking-read-and-archiving'."
521 (let ((previous (notmuch-show-find-previous-message)))
522 (if (> (count-lines previous (point)) (- (window-height) next-screen-context-lines))
526 ((beginning-of-buffer) nil))
527 (goto-char (window-start)))
528 (notmuch-show-previous-message))))
530 (defun notmuch-show-advance-marking-read-and-archiving ()
531 "Advance through thread, marking read and archiving.
533 This command is intended to be one of the simplest ways to
534 process a thread of email. It does the following:
536 If the current message in the thread is not yet fully visible,
537 scroll by a near screenful to read more of the message.
539 Otherwise, (the end of the current message is already within the
540 current window), remove the \"unread\" tag (if present) from the
541 current message and advance to the next open message.
543 Finally, if there is no further message to advance to, and this
544 last message is already read, then archive the entire current
545 thread, (remove the \"inbox\" tag from each message). Also kill
546 this buffer, and display the next thread from the search from
547 which this thread was originally shown."
549 (let ((next (notmuch-show-find-next-message))
550 (unread (notmuch-show-message-unread-p)))
551 (if (> next (window-end))
553 (let ((last (notmuch-show-last-message-p)))
554 (notmuch-show-mark-read-then-next-open-message)
556 (notmuch-show-archive-thread))))))
558 (defun notmuch-show-next-button ()
559 "Advance point to the next button in the buffer."
561 (goto-char (button-start (next-button (point)))))
563 (defun notmuch-show-previous-button ()
564 "Move point back to the previous button in the buffer."
566 (goto-char (button-start (previous-button (point)))))
568 (defun notmuch-toggle-invisible-action (cite-button)
569 (let ((invis-spec (button-get cite-button 'invisibility-spec)))
570 (if (invisible-p invis-spec)
571 (remove-from-invisibility-spec invis-spec)
572 (add-to-invisibility-spec invis-spec)
574 (force-window-update)
577 (define-button-type 'notmuch-button-invisibility-toggle-type 'action 'notmuch-toggle-invisible-action 'follow-link t)
578 (define-button-type 'notmuch-button-citation-toggle-type 'help-echo "mouse-1, RET: Show citation"
579 :supertype 'notmuch-button-invisibility-toggle-type)
580 (define-button-type 'notmuch-button-signature-toggle-type 'help-echo "mouse-1, RET: Show signature"
581 :supertype 'notmuch-button-invisibility-toggle-type)
582 (define-button-type 'notmuch-button-headers-toggle-type 'help-echo "mouse-1, RET: Show headers"
583 :supertype 'notmuch-button-invisibility-toggle-type)
584 (define-button-type 'notmuch-button-body-toggle-type 'help-echo "mouse-1, RET: Show message"
585 :supertype 'notmuch-button-invisibility-toggle-type)
587 (defun notmuch-show-markup-citations-region (beg end depth)
590 (while (< (point) end)
591 (let ((beg-sub (point-marker))
592 (indent (make-string depth ? ))
593 (citation "[[:space:]]*>"))
594 (if (looking-at citation)
596 (while (looking-at citation)
598 (let ((overlay (make-overlay beg-sub (point)))
599 (invis-spec (make-symbol "notmuch-citation-region")))
600 (add-to-invisibility-spec invis-spec)
601 (overlay-put overlay 'invisible invis-spec)
604 (concat "[" (number-to-string (count-lines beg-sub (point)))
605 "-line citation.]")))
606 (goto-char (- beg-sub 1))
607 (insert (concat "\n" indent))
608 (insert-button cite-button-text
609 'invisibility-spec invis-spec
610 :type 'notmuch-button-citation-toggle-type)
612 (goto-char (+ (length cite-button-text) p))
614 (move-to-column depth)
615 (if (looking-at notmuch-show-signature-regexp)
616 (let ((sig-lines (- (count-lines beg-sub end) 1)))
617 (if (<= sig-lines notmuch-show-signature-lines-max)
619 (let ((invis-spec (make-symbol "notmuch-signature-region")))
620 (add-to-invisibility-spec invis-spec)
621 (overlay-put (make-overlay beg-sub end)
622 'invisible invis-spec)
624 (goto-char (- beg-sub 1))
625 (insert (concat "\n" indent))
626 (let ((sig-button-text (concat "[" (number-to-string sig-lines)
627 "-line signature.]")))
628 (insert-button sig-button-text 'invisibility-spec invis-spec
629 :type 'notmuch-button-signature-toggle-type)
635 (defun notmuch-show-markup-part (beg end depth mime-message)
636 (if (re-search-forward notmuch-show-part-begin-regexp nil t)
638 (if (eq mime-message nil)
639 (let ((filename (notmuch-show-get-filename)))
641 (insert-file-contents filename nil nil nil t)
642 (setq mime-message (mm-dissect-buffer)))))
644 (let ((part-beg (point-marker)))
645 (re-search-forward notmuch-show-part-end-regexp)
647 (let ((part-end (copy-marker (match-beginning 0))))
651 (indent-rigidly part-beg part-end depth)
656 (let ((handle-type (mm-handle-type mime-message))
658 (if (sequencep (car handle-type))
659 (setq mime-type (car handle-type))
660 (setq mime-type (car (car (cdr handle-type))))
662 (if (equal mime-type "text/html")
663 (mm-display-part mime-message))))
665 (notmuch-show-markup-citations-region part-beg part-end depth)
666 ; Advance to the next part (if any) (so the outer loop can
667 ; determine whether we've left the current message.
668 (if (re-search-forward notmuch-show-part-begin-regexp nil t)
669 (beginning-of-line)))))
673 (defun notmuch-show-markup-parts-region (beg end depth)
677 (while (< (point) end)
679 (notmuch-show-markup-part
680 beg end depth mime-message))))))
682 (defun notmuch-show-markup-body (depth btn)
683 (re-search-forward notmuch-show-body-begin-regexp)
685 (let ((beg (point-marker)))
686 (re-search-forward notmuch-show-body-end-regexp)
687 (let ((end (copy-marker (match-beginning 0))))
688 (notmuch-show-markup-parts-region beg end depth)
689 (let ((invis-spec (make-symbol "notmuch-show-body-read")))
690 (overlay-put (make-overlay beg end)
691 'invisible invis-spec)
692 (button-put btn 'invisibility-spec invis-spec)
693 (if (not (notmuch-show-message-unread-p))
694 (add-to-invisibility-spec invis-spec)))
698 (defun notmuch-fontify-headers ()
700 (if (looking-at "[Tt]o:")
702 (overlay-put (make-overlay (point) (re-search-forward ":"))
703 'face 'message-header-name)
704 (overlay-put (make-overlay (point) (re-search-forward ".*$"))
705 'face 'message-header-to))
706 (if (looking-at "[B]?[Cc][Cc]:")
708 (overlay-put (make-overlay (point) (re-search-forward ":"))
709 'face 'message-header-name)
710 (overlay-put (make-overlay (point) (re-search-forward ".*$"))
711 'face 'message-header-cc))
712 (if (looking-at "[Ss]ubject:")
714 (overlay-put (make-overlay (point) (re-search-forward ":"))
715 'face 'message-header-name)
716 (overlay-put (make-overlay (point) (re-search-forward ".*$"))
717 'face 'message-header-subject))
718 (if (looking-at "[Ff]rom:")
720 (overlay-put (make-overlay (point) (re-search-forward ":"))
721 'face 'message-header-name)
722 (overlay-put (make-overlay (point) (re-search-forward ".*$"))
723 'face 'message-header-other))))))))
725 (defun notmuch-show-markup-header (depth)
726 (re-search-forward notmuch-show-header-begin-regexp)
728 (let ((beg (point-marker))
729 (summary-end (copy-marker (line-beginning-position 2)))
731 ; Inverse video for subject
732 (overlay-put (make-overlay beg summary-end) 'face '(:inverse-video t))
733 (setq btn (make-button beg summary-end :type 'notmuch-button-body-toggle-type))
736 (let ((beg-hidden (point-marker)))
737 (re-search-forward notmuch-show-header-end-regexp)
739 (let ((end (point-marker)))
742 (while (looking-at "[A-Za-z][-A-Za-z0-9]*:")
744 (notmuch-fontify-headers)
747 (indent-rigidly beg end depth)
748 (let ((invis-spec (make-symbol "notmuch-show-header")))
749 (add-to-invisibility-spec (cons invis-spec t))
750 (overlay-put (make-overlay beg-hidden end)
751 'invisible invis-spec)
754 (make-button (line-beginning-position) (line-end-position)
755 'invisibility-spec (cons invis-spec t)
756 :type 'notmuch-button-headers-toggle-type))
760 (set-marker beg-hidden nil)
765 (defun notmuch-show-markup-message ()
766 (if (re-search-forward notmuch-show-message-begin-regexp nil t)
768 (re-search-forward notmuch-show-depth-regexp)
769 (let ((depth (string-to-number (buffer-substring (match-beginning 1) (match-end 1))))
771 (setq btn (notmuch-show-markup-header depth))
772 (notmuch-show-markup-body depth btn)))
773 (goto-char (point-max))))
775 (defun notmuch-show-hide-markers ()
777 (goto-char (point-min))
779 (if (re-search-forward notmuch-show-marker-regexp nil t)
781 (overlay-put (make-overlay (match-beginning 0) (+ (match-end 0) 1))
782 'invisible 'notmuch-show-marker))
783 (goto-char (point-max))))))
785 (defun notmuch-show-markup-messages ()
787 (goto-char (point-min))
789 (notmuch-show-markup-message)))
790 (notmuch-show-hide-markers))
792 (defun notmuch-documentation-first-line (symbol)
793 "Return the first line of the documentation string for SYMBOL."
794 (let ((doc (documentation symbol)))
797 (insert (documentation symbol t))
798 (goto-char (point-min))
801 (buffer-substring beg (point))))
804 (defun notmuch-prefix-key-description (key)
805 "Given a prefix key code, return a human-readable string representation.
807 This is basically just `format-kbd-macro' but we also convert ESC to M-."
808 (let ((desc (format-kbd-macro (vector key))))
809 (if (string= desc "ESC")
813 ; I would think that emacs would have code handy for walking a keymap
814 ; and generating strings for each key, and I would prefer to just call
815 ; that. But I couldn't find any (could be all implemented in C I
816 ; suppose), so I wrote my own here.
817 (defun notmuch-substitute-one-command-key-with-prefix (prefix binding)
818 "For a key binding, return a string showing a human-readable
819 representation of the prefixed key as well as the first line of
820 documentation from the bound function.
822 For a mouse binding, return nil."
823 (let ((key (car binding))
824 (action (cdr binding)))
825 (if (mouse-event-p key)
828 (let ((substitute (apply-partially 'notmuch-substitute-one-command-key-with-prefix (notmuch-prefix-key-description key))))
829 (mapconcat substitute (cdr action) "\n"))
830 (concat prefix (format-kbd-macro (vector key))
832 (notmuch-documentation-first-line action))))))
834 (defalias 'notmuch-substitute-one-command-key
835 (apply-partially 'notmuch-substitute-one-command-key-with-prefix nil))
837 (defun notmuch-substitute-command-keys (doc)
838 "Like `substitute-command-keys' but with documentation, not function names."
840 (while (string-match "\\\\{\\([^}[:space:]]*\\)}" doc beg)
841 (let ((map (substring doc (match-beginning 1) (match-end 1))))
842 (setq doc (replace-match (mapconcat 'notmuch-substitute-one-command-key
843 (cdr (symbol-value (intern map))) "\n") 1 1 doc)))
844 (setq beg (match-end 0)))
847 (defun notmuch-help ()
848 "Display help for the current notmuch mode."
850 (let* ((mode major-mode)
851 (doc (substitute-command-keys (notmuch-substitute-command-keys (documentation mode t)))))
852 (with-current-buffer (generate-new-buffer "*notmuch-help*")
854 (goto-char (point-min))
855 (set-buffer-modified-p nil)
856 (view-buffer (current-buffer) 'kill-buffer-if-not-modified))))
859 (defun notmuch-show-mode ()
860 "Major mode for viewing a thread with notmuch.
862 This buffer contains the results of the \"notmuch show\" command
863 for displaying a single thread of email from your email archives.
865 By default, various components of email messages, (citations,
866 signatures, already-read messages), are hidden. You can make
867 these parts visible by clicking with the mouse button or by
868 pressing RET after positioning the cursor on a hidden part, (for
869 which \\[notmuch-show-next-button] and \\[notmuch-show-previous-button] are helpful).
871 Reading the thread sequentially is well-supported by pressing
872 \\[notmuch-show-advance-marking-read-and-archiving]. This will scroll the current message (if necessary),
873 advance to the next message, or advance to the next thread (if
874 already on the last message of a thread). As each message is
875 scrolled away its \"unread\" tag will be removed, and as each
876 thread is scrolled away the \"inbox\" tag will be removed from
877 each message in the thread.
879 Other commands are available to read or manipulate the thread more
880 selectively, (such as '\\[notmuch-show-next-message]' and '\\[notmuch-show-previous-message]' to advance to messages without
881 removing any tags, and '\\[notmuch-show-archive-thread]' to archive an entire thread without
882 scrolling through with \\[notmuch-show-advance-marking-read-and-archiving]).
884 You can add or remove arbitary tags from the current message with
885 '\\[notmuch-show-add-tag]' or '\\[notmuch-show-remove-tag]'.
887 All currently available key bindings:
889 \\{notmuch-show-mode-map}"
891 (kill-all-local-variables)
892 (add-to-invisibility-spec 'notmuch-show-marker)
893 (use-local-map notmuch-show-mode-map)
894 (setq major-mode 'notmuch-show-mode
895 mode-name "notmuch-show")
896 (setq buffer-read-only t))
898 (defgroup notmuch nil
899 "Notmuch mail reader for Emacs."
902 (defcustom notmuch-show-hook nil
903 "List of functions to call when notmuch displays a message."
905 :options '(goto-address)
908 (defcustom notmuch-search-hook nil
909 "List of functions to call when notmuch displays the search results."
911 :options '(hl-line-mode)
914 ; Make show mode a bit prettier, highlighting URLs and using word wrap
916 (defun notmuch-show-pretty-hook ()
917 (goto-address-mode 1)
920 (add-hook 'notmuch-show-hook 'notmuch-show-pretty-hook)
921 (add-hook 'notmuch-search-hook
925 (defun notmuch-show (thread-id &optional parent-buffer)
926 "Run \"notmuch show\" with the given thread ID and display results.
928 The optional PARENT-BUFFER is the notmuch-search buffer from
929 which this notmuch-show command was executed, (so that the next
930 thread from that buffer can be show when done with this one)."
931 (interactive "sNotmuch show: ")
932 (let ((buffer (get-buffer-create (concat "*notmuch-show-" thread-id "*"))))
933 (switch-to-buffer buffer)
935 (set (make-local-variable 'notmuch-show-parent-buffer) parent-buffer)
936 (let ((proc (get-buffer-process (current-buffer)))
937 (inhibit-read-only t))
939 (error "notmuch search process already running for query `%s'" thread-id)
942 (goto-char (point-min))
944 (call-process notmuch-command nil t nil "show" "--entire-thread" thread-id)
945 (notmuch-show-markup-messages)
947 (run-hooks 'notmuch-show-hook)
948 ; Move straight to the first unread message
949 (if (not (notmuch-show-message-unread-p))
951 (notmuch-show-next-unread-message)
952 ; But if there are no unread messages, go back to the
953 ; beginning of the buffer, and open up the bodies of all
955 (if (not (notmuch-show-message-unread-p))
957 (goto-char (point-min))
958 (let ((btn (forward-button 1)))
960 (if (button-has-type-p btn 'notmuch-button-body-toggle-type)
963 (setq btn (forward-button 1))
964 (error (setq btn nil)))
966 (goto-char (point-min))
970 (defvar notmuch-search-authors-width 40
971 "Number of columns to use to display authors in a notmuch-search buffer.")
973 (defvar notmuch-search-mode-map
974 (let ((map (make-sparse-keymap)))
975 (define-key map "?" 'notmuch-help)
976 (define-key map "q" 'kill-this-buffer)
977 (define-key map "x" 'kill-this-buffer)
978 (define-key map (kbd "<DEL>") 'notmuch-search-scroll-down)
979 (define-key map "b" 'notmuch-search-scroll-down)
980 (define-key map " " 'notmuch-search-scroll-up)
981 (define-key map "<" 'notmuch-search-first-thread)
982 (define-key map ">" 'notmuch-search-last-thread)
983 (define-key map "p" 'notmuch-search-previous-thread)
984 (define-key map "n" 'notmuch-search-next-thread)
985 (define-key map "r" 'notmuch-search-reply-to-thread)
986 (define-key map "m" 'message-mail)
987 (define-key map "s" 'notmuch-search)
988 (define-key map "o" 'notmuch-search-toggle-order)
989 (define-key map "=" 'notmuch-search-refresh-view)
990 (define-key map "t" 'notmuch-search-filter-by-tag)
991 (define-key map "f" 'notmuch-search-filter)
992 (define-key map [mouse-1] 'notmuch-search-show-thread)
993 (define-key map "*" 'notmuch-search-operate-all)
994 (define-key map "a" 'notmuch-search-archive-thread)
995 (define-key map "-" 'notmuch-search-remove-tag)
996 (define-key map "+" 'notmuch-search-add-tag)
997 (define-key map (kbd "RET") 'notmuch-search-show-thread)
999 "Keymap for \"notmuch search\" buffers.")
1000 (fset 'notmuch-search-mode-map notmuch-search-mode-map)
1002 (defvar notmuch-search-query-string)
1003 (defvar notmuch-search-oldest-first t
1004 "Show the oldest mail first in the search-mode")
1006 (defun notmuch-search-scroll-up ()
1007 "Move forward through search results by one window's worth."
1011 ((end-of-buffer) (notmuch-search-last-thread))))
1013 (defun notmuch-search-scroll-down ()
1014 "Move backward through the search results by one window's worth."
1016 ; I don't know why scroll-down doesn't signal beginning-of-buffer
1017 ; the way that scroll-up signals end-of-buffer, but c'est la vie.
1019 ; So instead of trapping a signal we instead check whether the
1020 ; window begins on the first line of the buffer and if so, move
1021 ; directly to that position. (We have to count lines since the
1022 ; window-start position is not the same as point-min due to the
1023 ; invisible thread-ID characters on the first line.
1024 (if (equal (count-lines (point-min) (window-start)) 0)
1025 (goto-char (point-min))
1028 (defun notmuch-search-next-thread ()
1029 "Select the next thread in the search results."
1033 (defun notmuch-search-previous-thread ()
1034 "Select the previous thread in the search results."
1038 (defun notmuch-search-last-thread ()
1039 "Select the last thread in the search results."
1041 (goto-char (point-max))
1044 (defun notmuch-search-first-thread ()
1045 "Select the first thread in the search results."
1047 (goto-char (point-min)))
1049 (defface notmuch-tag-face
1052 (:foreground "OliveDrab1"))
1055 (:foreground "navy blue" :bold t))
1058 "Notmuch search mode face used to highligh tags."
1061 (defvar notmuch-tag-face-alist nil
1062 "List containing the tag list that need to be highlighed")
1064 (defvar notmuch-search-font-lock-keywords nil)
1067 (defun notmuch-search-mode ()
1068 "Major mode displaying results of a notmuch search.
1070 This buffer contains the results of a \"notmuch search\" of your
1071 email archives. Each line in the buffer represents a single
1072 thread giving a summary of the thread (a relative date, the
1073 number of matched messages and total messages in the thread,
1074 participants in the thread, a representative subject line, and
1077 Pressing \\[notmuch-search-show-thread] on any line displays that thread. The '\\[notmuch-search-add-tag]' and '\\[notmuch-search-remove-tag]'
1078 keys can be used to add or remove tags from a thread. The '\\[notmuch-search-archive-thread]' key
1079 is a convenience for archiving a thread (removing the \"inbox\"
1080 tag). The '\\[notmuch-search-operate-all]' key can be used to add or remove a tag from all
1081 threads in the current buffer.
1083 Other useful commands are '\\[notmuch-search-filter]' for filtering the current search
1084 based on an additional query string, '\\[notmuch-search-filter-by-tag]' for filtering to include
1085 only messages with a given tag, and '\\[notmuch-search]' to execute a new, global
1088 Complete list of currently available key bindings:
1090 \\{notmuch-search-mode-map}"
1092 (kill-all-local-variables)
1093 (make-local-variable 'notmuch-search-query-string)
1094 (make-local-variable 'notmuch-search-oldest-first)
1095 (set (make-local-variable 'scroll-preserve-screen-position) t)
1096 (add-to-invisibility-spec 'notmuch-search)
1097 (use-local-map notmuch-search-mode-map)
1098 (setq truncate-lines t)
1099 (setq major-mode 'notmuch-search-mode
1100 mode-name "notmuch-search")
1101 (setq buffer-read-only t)
1102 (if (not notmuch-tag-face-alist)
1103 (add-to-list 'notmuch-search-font-lock-keywords (list
1104 "(\\([^)]*\\))$" '(1 'notmuch-tag-face)))
1105 (let ((notmuch-search-tags (mapcar 'car notmuch-tag-face-alist)))
1106 (loop for notmuch-search-tag in notmuch-search-tags
1107 do (add-to-list 'notmuch-search-font-lock-keywords (list
1108 (concat "([^)]*\\(" notmuch-search-tag "\\)[^)]*)$")
1109 `(1 ,(cdr (assoc notmuch-search-tag notmuch-tag-face-alist))))))))
1110 (set (make-local-variable 'font-lock-defaults)
1111 '(notmuch-search-font-lock-keywords t)))
1113 (defun notmuch-search-find-thread-id ()
1114 "Return the thread for the current thread"
1115 (get-text-property (point) 'notmuch-search-thread-id))
1117 (defun notmuch-search-show-thread ()
1118 "Display the currently selected thread."
1120 (let ((thread-id (notmuch-search-find-thread-id)))
1121 (if (> (length thread-id) 0)
1122 (notmuch-show thread-id (current-buffer))
1123 (error "End of search results"))))
1125 (defun notmuch-search-reply-to-thread ()
1126 "Begin composing a reply to the entire current thread in a new buffer."
1128 (let ((message-id (notmuch-search-find-thread-id)))
1129 (notmuch-reply message-id)))
1131 (defun notmuch-call-notmuch-process (&rest args)
1132 "Synchronously invoke \"notmuch\" with the given list of arguments.
1134 Output from the process will be presented to the user as an error
1135 and will also appear in a buffer named \"*Notmuch errors*\"."
1136 (let ((error-buffer (get-buffer-create "*Notmuch errors*")))
1137 (with-current-buffer error-buffer
1139 (if (eq (apply 'call-process notmuch-command nil error-buffer nil args) 0)
1142 (with-current-buffer error-buffer
1143 (let ((beg (point-min))
1144 (end (- (point-max) 1)))
1145 (error (buffer-substring beg end))
1148 (defun notmuch-search-set-tags (tags)
1151 (re-search-backward "(")
1154 (inhibit-read-only t))
1155 (re-search-forward ")")
1157 (let ((end (point)))
1158 (delete-region beg end)
1159 (insert (mapconcat 'identity tags " "))))))
1161 (defun notmuch-search-get-tags ()
1164 (re-search-backward "(")
1165 (let ((beg (+ (point) 1)))
1166 (re-search-forward ")")
1167 (let ((end (- (point) 1)))
1168 (split-string (buffer-substring beg end))))))
1170 (defun notmuch-search-add-tag (tag)
1171 "Add a tag to the currently selected thread.
1173 The tag is added to messages in the currently selected thread
1174 which match the current search terms."
1176 (list (notmuch-select-tag-with-completion "Tag to add: ")))
1177 (notmuch-call-notmuch-process "tag" (concat "+" tag) (notmuch-search-find-thread-id) " and " notmuch-search-query-string)
1178 (notmuch-search-set-tags (delete-dups (sort (cons tag (notmuch-search-get-tags)) 'string<))))
1180 (defun notmuch-search-remove-tag (tag)
1181 "Remove a tag from the currently selected thread.
1183 The tag is removed from messages in the currently selected thread
1184 which match the current search terms."
1186 (list (notmuch-select-tag-with-completion "Tag to remove: " (notmuch-search-find-thread-id))))
1187 (notmuch-call-notmuch-process "tag" (concat "-" tag) (notmuch-search-find-thread-id) " and " notmuch-search-query-string)
1188 (notmuch-search-set-tags (delete tag (notmuch-search-get-tags))))
1190 (defun notmuch-search-archive-thread ()
1191 "Archive the currently selected thread (remove its \"inbox\" tag).
1193 This function advances the next thread when finished."
1195 (notmuch-search-remove-tag "inbox")
1198 (defun notmuch-search-process-sentinel (proc msg)
1199 "Add a message to let user know when \"notmuch search\" exits"
1200 (let ((buffer (process-buffer proc))
1201 (status (process-status proc))
1202 (exit-status (process-exit-status proc)))
1203 (if (memq status '(exit signal))
1204 (if (buffer-live-p buffer)
1205 (with-current-buffer buffer
1207 (let ((inhibit-read-only t))
1208 (goto-char (point-max))
1209 (if (eq status 'signal)
1210 (insert "Incomplete search results (search process was killed).\n"))
1211 (if (eq status 'exit)
1213 (insert "End of search results.")
1214 (if (not (= exit-status 0))
1215 (insert (format " (process returned %d)" exit-status)))
1216 (insert "\n"))))))))))
1218 (defun notmuch-search-process-filter (proc string)
1219 "Process and filter the output of \"notmuch search\""
1220 (let ((buffer (process-buffer proc)))
1221 (if (buffer-live-p buffer)
1222 (with-current-buffer buffer
1226 (inhibit-read-only t))
1228 (if (string-match "^\\(thread:[0-9A-Fa-f]*\\) \\(.*\\) \\(\\[[0-9/]*\\]\\) \\([^:]*\\); \\(.*\\) (\\([^()]*\\))$" string line)
1229 (let* ((thread-id (match-string 1 string))
1230 (date (match-string 2 string))
1231 (count (match-string 3 string))
1232 (authors (match-string 4 string))
1233 (authors-length (length authors))
1234 (subject (match-string 5 string))
1235 (tags (match-string 6 string)))
1236 (if (> authors-length 40)
1237 (set 'authors (concat (substring authors 0 (- 40 3)) "...")))
1238 (goto-char (point-max))
1239 (let ((beg (point-marker)))
1240 (insert (format "%s %-7s %-40s %s (%s)\n" date count authors subject tags))
1241 (put-text-property beg (point-marker) 'notmuch-search-thread-id thread-id))
1242 (set 'line (match-end 0)))
1243 (set 'more nil))))))
1244 (delete-process proc))))
1246 (defun notmuch-search-operate-all (action)
1247 "Add/remove tags from all matching messages.
1249 Tis command adds or removes tags from all messages matching the
1250 current search terms. When called interactively, this command
1251 will prompt for tags to be added or removed. Tags prefixed with
1252 '+' will be added and tags prefixed with '-' will be removed.
1254 Each character of the tag name may consist of alphanumeric
1255 characters as well as `_.+-'.
1257 (interactive "sOperation (+add -drop): notmuch tag ")
1258 (let ((action-split (split-string action " +")))
1259 ;; Perform some validation
1260 (let ((words action-split))
1261 (when (null words) (error "No operation given"))
1263 (unless (string-match-p "^[-+][-+_.[:word:]]+$" (car words))
1264 (error "Action must be of the form `+thistag -that_tag'"))
1265 (setq words (cdr words))))
1266 (apply 'notmuch-call-notmuch-process "tag"
1267 (append action-split (list notmuch-search-query-string) nil))))
1270 (defun notmuch-search (query &optional oldest-first)
1271 "Run \"notmuch search\" with the given query string and display results."
1272 (interactive "sNotmuch search: ")
1273 (let ((buffer (get-buffer-create (concat "*notmuch-search-" query "*"))))
1274 (switch-to-buffer buffer)
1275 (notmuch-search-mode)
1276 (set 'notmuch-search-query-string query)
1277 (set 'notmuch-search-oldest-first oldest-first)
1278 (let ((proc (get-buffer-process (current-buffer)))
1279 (inhibit-read-only t))
1281 (error "notmuch search process already running for query `%s'" query)
1284 (goto-char (point-min))
1286 (let ((proc (start-process-shell-command
1287 "notmuch-search" buffer notmuch-command "search"
1288 (if oldest-first "--sort=oldest-first" "--sort=newest-first")
1289 (shell-quote-argument query))))
1290 (set-process-sentinel proc 'notmuch-search-process-sentinel)
1291 (set-process-filter proc 'notmuch-search-process-filter))))
1292 (run-hooks 'notmuch-search-hook)))
1294 (defun notmuch-search-refresh-view ()
1295 "Refresh the current view.
1297 Kills the current buffer and runs a new search with the same
1298 query string as the current search. If the current thread is in
1299 the new search results, then point will be placed on the same
1300 thread. Otherwise, point will be moved to attempt to be in the
1301 same relative position within the new buffer."
1303 (let ((here (point))
1304 (oldest-first notmuch-search-oldest-first)
1305 (thread (notmuch-search-find-thread-id))
1306 (query notmuch-search-query-string))
1308 (notmuch-search query oldest-first)
1309 (goto-char (point-min))
1310 (if (re-search-forward (concat "^" thread) nil t)
1314 (defun notmuch-search-toggle-order ()
1315 "Toggle the current search order.
1317 By default, the \"inbox\" view created by `notmuch' is displayed
1318 in chronological order (oldest thread at the beginning of the
1319 buffer), while any global searches created by `notmuch-search'
1320 are displayed in reverse-chronological order (newest thread at
1321 the beginning of the buffer).
1323 This command toggles the sort order for the current search.
1325 Note that any filtered searches created by
1326 `notmuch-search-filter' retain the search order of the parent
1329 (set 'notmuch-search-oldest-first (not notmuch-search-oldest-first))
1330 (notmuch-search-refresh-view))
1332 (defun notmuch-search-filter (query)
1333 "Filter the current search results based on an additional query string.
1335 Runs a new search matching only messages that match both the
1336 current search results AND the additional query string provided."
1337 (interactive "sFilter search: ")
1338 (notmuch-search (concat notmuch-search-query-string " and " query) notmuch-search-oldest-first))
1340 (defun notmuch-search-filter-by-tag (tag)
1341 "Filter the current search results based on a single tag.
1343 Runs a new search matching only messages that match both the
1344 current search results AND that are tagged with the given tag."
1346 (list (notmuch-select-tag-with-completion "Filter by tag: ")))
1347 (notmuch-search (concat notmuch-search-query-string " and tag:" tag) notmuch-search-oldest-first))
1352 "Run notmuch to display all mail with tag of 'inbox'"
1354 (notmuch-search "tag:inbox" notmuch-search-oldest-first))
1356 (setq mail-user-agent 'message-user-agent)
1358 (defvar notmuch-folder-mode-map
1359 (let ((map (make-sparse-keymap)))
1360 (define-key map "?" 'notmuch-help)
1361 (define-key map "x" 'kill-this-buffer)
1362 (define-key map "q" 'kill-this-buffer)
1363 (define-key map ">" 'notmuch-folder-last)
1364 (define-key map "<" 'notmuch-folder-first)
1365 (define-key map "=" 'notmuch-folder)
1366 (define-key map "s" 'notmuch-search)
1367 (define-key map [mouse-1] 'notmuch-folder-show-search)
1368 (define-key map (kbd "RET") 'notmuch-folder-show-search)
1369 (define-key map "p" 'notmuch-folder-previous)
1370 (define-key map "n" 'notmuch-folder-next)
1372 "Keymap for \"notmuch folder\" buffers.")
1374 (fset 'notmuch-folder-mode-map notmuch-folder-mode-map)
1376 (defcustom notmuch-folders (quote (("inbox" . "tag:inbox") ("unread" . "tag:unread")))
1377 "List of searches for the notmuch folder view"
1378 :type '(alist :key-type (string) :value-type (string))
1381 (defun notmuch-folder-mode ()
1382 "Major mode for showing notmuch 'folders'.
1384 This buffer contains a list of message counts returned by a
1385 customizable set of searches of your email archives. Each line in
1386 the buffer shows the name of a saved search and the resulting
1389 Pressing RET on any line opens a search window containing the
1390 results for the saved search on that line.
1392 Here is an example of how the search list could be
1393 customized, (the following text would be placed in your ~/.emacs
1396 (setq notmuch-folders '((\"inbox\" . \"tag:inbox\")
1397 (\"unread\" . \"tag:inbox AND tag:unread\")
1398 (\"notmuch\" . \"tag:inbox AND to:notmuchmail.org\")))
1400 Of course, you can have any number of folders, each configured
1401 with any supported search terms (see \"notmuch help search-terms\").
1403 Currently available key bindings:
1405 \\{notmuch-folder-mode-map}"
1407 (kill-all-local-variables)
1408 (use-local-map 'notmuch-folder-mode-map)
1409 (setq truncate-lines t)
1411 (setq major-mode 'notmuch-folder-mode
1412 mode-name "notmuch-folder")
1413 (setq buffer-read-only t))
1415 (defun notmuch-folder-next ()
1416 "Select the next folder in the list."
1422 (defun notmuch-folder-previous ()
1423 "Select the previous folder in the list."
1427 (defun notmuch-folder-first ()
1428 "Select the first folder in the list."
1430 (goto-char (point-min)))
1432 (defun notmuch-folder-last ()
1433 "Select the last folder in the list."
1435 (goto-char (point-max))
1438 (defun notmuch-folder-add (folders)
1440 (let ((name (car (car folders)))
1441 (inhibit-read-only t)
1442 (search (cdr (car folders))))
1445 (call-process notmuch-command nil t nil "count" search)
1446 (notmuch-folder-add (cdr folders)))))
1448 (defun notmuch-folder-find-name ()
1451 (let ((beg (point)))
1453 (filter-buffer-substring beg (point)))))
1455 (defun notmuch-folder-show-search (&optional folder)
1456 "Show a search window for the search related to the specified folder."
1459 (setq folder (notmuch-folder-find-name)))
1460 (let ((search (assoc folder notmuch-folders)))
1462 (notmuch-search (cdr search) notmuch-search-oldest-first))))
1465 (defun notmuch-folder ()
1466 "Show the notmuch folder view and update the displayed counts."
1468 (let ((buffer (get-buffer-create "*notmuch-folders*")))
1469 (switch-to-buffer buffer)
1470 (let ((inhibit-read-only t)
1471 (n (line-number-at-pos)))
1473 (notmuch-folder-mode)
1474 (notmuch-folder-add notmuch-folders)
1475 (goto-char (point-min))