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).
50 (eval-when-compile (require 'cl))
54 (require 'notmuch-lib)
55 (require 'notmuch-show)
56 (require 'notmuch-mua)
57 (require 'notmuch-hello)
58 (require 'notmuch-maildir-fcc)
59 (require 'notmuch-message)
61 (defcustom notmuch-search-result-format
64 ("authors" . "%-20s ")
67 "Search result formatting. Supported fields are:
68 date, count, authors, subject, tags
70 (setq notmuch-search-result-format \(\(\"authors\" . \"%-40s\"\)
71 \(\"subject\" . \"%s\"\)\)\)"
72 :type '(alist :key-type (string) :value-type (string))
73 :group 'notmuch-search)
75 (defvar notmuch-query-history nil
76 "Variable to store minibuffer history for notmuch queries")
78 (defun notmuch-select-tag-with-completion (prompt &rest search-terms)
80 (with-output-to-string
81 (with-current-buffer standard-output
82 (apply 'call-process notmuch-command nil t nil "search-tags" search-terms)))))
83 (completing-read prompt (split-string tag-list "\n+" t) nil nil nil)))
85 (defun notmuch-foreach-mime-part (function mm-handle)
86 (cond ((stringp (car mm-handle))
87 (dolist (part (cdr mm-handle))
88 (notmuch-foreach-mime-part function part)))
89 ((bufferp (car mm-handle))
90 (funcall function mm-handle))
91 (t (dolist (part mm-handle)
92 (notmuch-foreach-mime-part function part)))))
94 (defun notmuch-count-attachments (mm-handle)
96 (notmuch-foreach-mime-part
98 (let ((disposition (mm-handle-disposition p)))
99 (and (listp disposition)
100 (or (equal (car disposition) "attachment")
101 (and (equal (car disposition) "inline")
102 (assq 'filename disposition)))
107 (defun notmuch-save-attachments (mm-handle &optional queryp)
108 (notmuch-foreach-mime-part
110 (let ((disposition (mm-handle-disposition p)))
111 (and (listp disposition)
112 (or (equal (car disposition) "attachment")
113 (and (equal (car disposition) "inline")
114 (assq 'filename disposition)))
117 (concat "Save '" (cdr (assq 'filename disposition)) "' ")))
121 (defun notmuch-documentation-first-line (symbol)
122 "Return the first line of the documentation string for SYMBOL."
123 (let ((doc (documentation symbol)))
126 (insert (documentation symbol t))
127 (goto-char (point-min))
130 (buffer-substring beg (point))))
133 (defun notmuch-prefix-key-description (key)
134 "Given a prefix key code, return a human-readable string representation.
136 This is basically just `format-kbd-macro' but we also convert ESC to M-."
137 (let ((desc (format-kbd-macro (vector key))))
138 (if (string= desc "ESC")
142 ;; I would think that emacs would have code handy for walking a keymap
143 ;; and generating strings for each key, and I would prefer to just call
144 ;; that. But I couldn't find any (could be all implemented in C I
145 ;; suppose), so I wrote my own here.
146 (defun notmuch-substitute-one-command-key-with-prefix (prefix binding)
147 "For a key binding, return a string showing a human-readable
148 representation of the prefixed key as well as the first line of
149 documentation from the bound function.
151 For a mouse binding, return nil."
152 (let ((key (car binding))
153 (action (cdr binding)))
154 (if (mouse-event-p key)
157 (let ((substitute (apply-partially 'notmuch-substitute-one-command-key-with-prefix (notmuch-prefix-key-description key)))
159 (map-keymap (lambda (a b)
160 (push (cons a b) as-list))
162 (mapconcat substitute as-list "\n"))
163 (concat prefix (format-kbd-macro (vector key))
165 (notmuch-documentation-first-line action))))))
167 (defun notmuch-substitute-command-keys-one (key)
168 ;; A `keymap' key indicates inheritance from a parent keymap - the
169 ;; inherited mappings follow, so there is nothing to print for
171 (when (not (eq key 'keymap))
172 (notmuch-substitute-one-command-key-with-prefix nil key)))
174 (defun notmuch-substitute-command-keys (doc)
175 "Like `substitute-command-keys' but with documentation, not function names."
177 (while (string-match "\\\\{\\([^}[:space:]]*\\)}" doc beg)
178 (let* ((keymap-name (substring doc (match-beginning 1) (match-end 1)))
179 (keymap (symbol-value (intern keymap-name))))
180 (setq doc (replace-match
181 (mapconcat #'notmuch-substitute-command-keys-one
184 (setq beg (match-end 0)))
187 (defun notmuch-help ()
188 "Display help for the current notmuch mode."
190 (let* ((mode major-mode)
191 (doc (substitute-command-keys (notmuch-substitute-command-keys (documentation mode t)))))
192 (with-current-buffer (generate-new-buffer "*notmuch-help*")
194 (goto-char (point-min))
195 (set-buffer-modified-p nil)
196 (view-buffer (current-buffer) 'kill-buffer-if-not-modified))))
198 (defcustom notmuch-search-hook '(hl-line-mode)
199 "List of functions to call when notmuch displays the search results."
201 :options '(hl-line-mode)
202 :group 'notmuch-search
203 :group 'notmuch-hooks)
205 (defvar notmuch-search-mode-map
206 (let ((map (make-sparse-keymap)))
207 (define-key map "?" 'notmuch-help)
208 (define-key map "q" 'notmuch-search-quit)
209 (define-key map "x" 'notmuch-search-quit)
210 (define-key map (kbd "<DEL>") 'notmuch-search-scroll-down)
211 (define-key map "b" 'notmuch-search-scroll-down)
212 (define-key map " " 'notmuch-search-scroll-up)
213 (define-key map "<" 'notmuch-search-first-thread)
214 (define-key map ">" 'notmuch-search-last-thread)
215 (define-key map "p" 'notmuch-search-previous-thread)
216 (define-key map "n" 'notmuch-search-next-thread)
217 (define-key map "r" 'notmuch-search-reply-to-thread-sender)
218 (define-key map "R" 'notmuch-search-reply-to-thread)
219 (define-key map "m" 'notmuch-mua-new-mail)
220 (define-key map "s" 'notmuch-search)
221 (define-key map "o" 'notmuch-search-toggle-order)
222 (define-key map "c" 'notmuch-search-stash-map)
223 (define-key map "=" 'notmuch-search-refresh-view)
224 (define-key map "G" 'notmuch-search-poll-and-refresh-view)
225 (define-key map "t" 'notmuch-search-filter-by-tag)
226 (define-key map "f" 'notmuch-search-filter)
227 (define-key map [mouse-1] 'notmuch-search-show-thread)
228 (define-key map "*" 'notmuch-search-operate-all)
229 (define-key map "a" 'notmuch-search-archive-thread)
230 (define-key map "-" 'notmuch-search-remove-tag)
231 (define-key map "+" 'notmuch-search-add-tag)
232 (define-key map (kbd "RET") 'notmuch-search-show-thread)
234 "Keymap for \"notmuch search\" buffers.")
235 (fset 'notmuch-search-mode-map notmuch-search-mode-map)
237 (defvar notmuch-search-stash-map
238 (let ((map (make-sparse-keymap)))
239 (define-key map "i" 'notmuch-search-stash-thread-id)
241 "Submap for stash commands")
242 (fset 'notmuch-search-stash-map notmuch-search-stash-map)
244 (defun notmuch-search-stash-thread-id ()
245 "Copy thread ID of current thread to kill-ring."
247 (notmuch-common-do-stash (notmuch-search-find-thread-id)))
249 (defvar notmuch-search-query-string)
250 (defvar notmuch-search-target-thread)
251 (defvar notmuch-search-target-line)
252 (defvar notmuch-search-continuation)
254 (defvar notmuch-search-disjunctive-regexp "\\<[oO][rR]\\>")
256 (defun notmuch-search-quit ()
257 "Exit the search buffer, calling any defined continuation function."
259 (let ((continuation notmuch-search-continuation))
260 (notmuch-kill-this-buffer)
262 (funcall continuation))))
264 (defun notmuch-search-scroll-up ()
265 "Move forward through search results by one window's worth."
269 ((end-of-buffer) (notmuch-search-last-thread))))
271 (defun notmuch-search-scroll-down ()
272 "Move backward through the search results by one window's worth."
274 ;; I don't know why scroll-down doesn't signal beginning-of-buffer
275 ;; the way that scroll-up signals end-of-buffer, but c'est la vie.
277 ;; So instead of trapping a signal we instead check whether the
278 ;; window begins on the first line of the buffer and if so, move
279 ;; directly to that position. (We have to count lines since the
280 ;; window-start position is not the same as point-min due to the
281 ;; invisible thread-ID characters on the first line.
282 (if (equal (count-lines (point-min) (window-start)) 0)
283 (goto-char (point-min))
286 (defun notmuch-search-next-thread ()
287 "Select the next thread in the search results."
291 (defun notmuch-search-previous-thread ()
292 "Select the previous thread in the search results."
296 (defun notmuch-search-last-thread ()
297 "Select the last thread in the search results."
299 (goto-char (point-max))
302 (defun notmuch-search-first-thread ()
303 "Select the first thread in the search results."
305 (goto-char (point-min)))
307 (defface notmuch-message-summary-face
308 '((((class color) (background light)) (:background "#f0f0f0"))
309 (((class color) (background dark)) (:background "#303030")))
310 "Face for the single-line message summary in notmuch-show-mode."
312 :group 'notmuch-faces)
314 (defface notmuch-search-date
315 '((t :inherit default))
316 "Face used in search mode for dates."
317 :group 'notmuch-search
318 :group 'notmuch-faces)
320 (defface notmuch-search-count
321 '((t :inherit default))
322 "Face used in search mode for the count matching the query."
323 :group 'notmuch-search
324 :group 'notmuch-faces)
326 (defface notmuch-search-subject
327 '((t :inherit default))
328 "Face used in search mode for subjects."
329 :group 'notmuch-search
330 :group 'notmuch-faces)
332 (defface notmuch-search-matching-authors
333 '((t :inherit default))
334 "Face used in search mode for authors matching the query."
335 :group 'notmuch-search
336 :group 'notmuch-faces)
338 (defface notmuch-search-non-matching-authors
341 (:foreground "grey30"))
344 (:foreground "grey60"))
347 "Face used in search mode for authors not matching the query."
348 :group 'notmuch-search
349 :group 'notmuch-faces)
351 (defface notmuch-tag-face
354 (:foreground "OliveDrab1"))
357 (:foreground "navy blue" :bold t))
360 "Face used in search mode face for tags."
361 :group 'notmuch-search
362 :group 'notmuch-faces)
364 (defun notmuch-search-mode ()
365 "Major mode displaying results of a notmuch search.
367 This buffer contains the results of a \"notmuch search\" of your
368 email archives. Each line in the buffer represents a single
369 thread giving a summary of the thread (a relative date, the
370 number of matched messages and total messages in the thread,
371 participants in the thread, a representative subject line, and
374 Pressing \\[notmuch-search-show-thread] on any line displays that thread. The '\\[notmuch-search-add-tag]' and '\\[notmuch-search-remove-tag]'
375 keys can be used to add or remove tags from a thread. The '\\[notmuch-search-archive-thread]' key
376 is a convenience for archiving a thread (removing the \"inbox\"
377 tag). The '\\[notmuch-search-operate-all]' key can be used to add or remove a tag from all
378 threads in the current buffer.
380 Other useful commands are '\\[notmuch-search-filter]' for filtering the current search
381 based on an additional query string, '\\[notmuch-search-filter-by-tag]' for filtering to include
382 only messages with a given tag, and '\\[notmuch-search]' to execute a new, global
385 Complete list of currently available key bindings:
387 \\{notmuch-search-mode-map}"
389 (kill-all-local-variables)
390 (make-local-variable 'notmuch-search-query-string)
391 (make-local-variable 'notmuch-search-oldest-first)
392 (make-local-variable 'notmuch-search-target-thread)
393 (make-local-variable 'notmuch-search-target-line)
394 (set (make-local-variable 'notmuch-search-continuation) nil)
395 (set (make-local-variable 'scroll-preserve-screen-position) t)
396 (add-to-invisibility-spec (cons 'ellipsis t))
397 (use-local-map notmuch-search-mode-map)
398 (setq truncate-lines t)
399 (setq major-mode 'notmuch-search-mode
400 mode-name "notmuch-search")
401 (setq buffer-read-only t))
403 (defun notmuch-search-properties-in-region (property beg end)
406 (last-line (line-number-at-pos end))
407 (max-line (- (line-number-at-pos (point-max)) 2)))
410 (while (<= (line-number-at-pos) (min last-line max-line))
411 (setq output (cons (get-text-property (point) property) output))
415 (defun notmuch-search-find-thread-id ()
416 "Return the thread for the current thread"
417 (get-text-property (point) 'notmuch-search-thread-id))
419 (defun notmuch-search-find-thread-id-region (beg end)
420 "Return a list of threads for the current region"
421 (notmuch-search-properties-in-region 'notmuch-search-thread-id beg end))
423 (defun notmuch-search-find-authors ()
424 "Return the authors for the current thread"
425 (get-text-property (point) 'notmuch-search-authors))
427 (defun notmuch-search-find-authors-region (beg end)
428 "Return a list of authors for the current region"
429 (notmuch-search-properties-in-region 'notmuch-search-authors beg end))
431 (defun notmuch-search-find-subject ()
432 "Return the subject for the current thread"
433 (get-text-property (point) 'notmuch-search-subject))
435 (defun notmuch-search-find-subject-region (beg end)
436 "Return a list of authors for the current region"
437 (notmuch-search-properties-in-region 'notmuch-search-subject beg end))
439 (defun notmuch-search-show-thread (&optional crypto-switch)
440 "Display the currently selected thread."
442 (let ((thread-id (notmuch-search-find-thread-id))
443 (subject (notmuch-search-find-subject)))
444 (if (> (length thread-id) 0)
445 (notmuch-show thread-id
447 notmuch-search-query-string
448 ;; name the buffer based on notmuch-search-find-subject
449 (if (string-match "^[ \t]*$" subject)
451 (truncate-string-to-width
453 (truncate-string-to-width subject 32 nil nil t)
457 (message "End of search results."))))
459 (defun notmuch-search-reply-to-thread (&optional prompt-for-sender)
460 "Begin composing a reply-all to the entire current thread in a new buffer."
462 (let ((message-id (notmuch-search-find-thread-id)))
463 (notmuch-mua-new-reply message-id prompt-for-sender t)))
465 (defun notmuch-search-reply-to-thread-sender (&optional prompt-for-sender)
466 "Begin composing a reply to the entire current thread in a new buffer."
468 (let ((message-id (notmuch-search-find-thread-id)))
469 (notmuch-mua-new-reply message-id prompt-for-sender nil)))
471 (defun notmuch-call-notmuch-process (&rest args)
472 "Synchronously invoke \"notmuch\" with the given list of arguments.
474 Output from the process will be presented to the user as an error
475 and will also appear in a buffer named \"*Notmuch errors*\"."
476 (let ((error-buffer (get-buffer-create "*Notmuch errors*")))
477 (with-current-buffer error-buffer
479 (if (eq (apply 'call-process notmuch-command nil error-buffer nil args) 0)
482 (with-current-buffer error-buffer
483 (let ((beg (point-min))
484 (end (- (point-max) 1)))
485 (error (buffer-substring beg end))
488 (defun notmuch-tag (query &rest tags)
489 "Add/remove tags in TAGS to messages matching QUERY.
491 TAGS should be a list of strings of the form \"+TAG\" or \"-TAG\" and
492 QUERY should be a string containing the search-query.
494 Note: Other code should always use this function alter tags of
495 messages instead of running (notmuch-call-notmuch-process \"tag\" ..)
496 directly, so that hooks specified in notmuch-before-tag-hook and
497 notmuch-after-tag-hook will be run."
498 (run-hooks 'notmuch-before-tag-hook)
499 (apply 'notmuch-call-notmuch-process
500 (append (list "tag") tags (list "--" query)))
501 (run-hooks 'notmuch-after-tag-hook))
503 (defcustom notmuch-before-tag-hook nil
504 "Hooks that are run before tags of a message are modified.
506 'tags' will contain the tags that are about to be added or removed as
507 a list of strings of the form \"+TAG\" or \"-TAG\".
508 'query' will be a string containing the search query that determines
509 the messages that are about to be tagged"
512 :options '(hl-line-mode)
513 :group 'notmuch-hooks)
515 (defcustom notmuch-after-tag-hook nil
516 "Hooks that are run after tags of a message are modified.
518 'tags' will contain the tags that were added or removed as
519 a list of strings of the form \"+TAG\" or \"-TAG\".
520 'query' will be a string containing the search query that determines
521 the messages that were tagged"
523 :options '(hl-line-mode)
524 :group 'notmuch-hooks)
526 (defun notmuch-search-set-tags (tags)
529 (re-search-backward "(")
532 (inhibit-read-only t))
533 (re-search-forward ")")
536 (delete-region beg end)
537 (insert (propertize (mapconcat 'identity tags " ")
538 'face 'notmuch-tag-face))))))
540 (defun notmuch-search-get-tags ()
543 (re-search-backward "(")
544 (let ((beg (+ (point) 1)))
545 (re-search-forward ")")
546 (let ((end (- (point) 1)))
547 (split-string (buffer-substring beg end))))))
549 (defun notmuch-search-get-tags-region (beg end)
552 (last-line (line-number-at-pos end))
553 (max-line (- (line-number-at-pos (point-max)) 2)))
555 (while (<= (line-number-at-pos) (min last-line max-line))
556 (setq output (append output (notmuch-search-get-tags)))
560 (defun notmuch-search-add-tag-thread (tag)
561 (notmuch-search-add-tag-region tag (point) (point)))
563 (defun notmuch-search-add-tag-region (tag beg end)
564 (let ((search-id-string (mapconcat 'identity (notmuch-search-find-thread-id-region beg end) " or ")))
565 (notmuch-tag search-id-string (concat "+" tag))
567 (let ((last-line (line-number-at-pos end))
568 (max-line (- (line-number-at-pos (point-max)) 2)))
570 (while (<= (line-number-at-pos) (min last-line max-line))
571 (notmuch-search-set-tags (delete-dups (sort (cons tag (notmuch-search-get-tags)) 'string<)))
574 (defun notmuch-search-remove-tag-thread (tag)
575 (notmuch-search-remove-tag-region tag (point) (point)))
577 (defun notmuch-search-remove-tag-region (tag beg end)
578 (let ((search-id-string (mapconcat 'identity (notmuch-search-find-thread-id-region beg end) " or ")))
579 (notmuch-tag search-id-string (concat "-" tag))
581 (let ((last-line (line-number-at-pos end))
582 (max-line (- (line-number-at-pos (point-max)) 2)))
584 (while (<= (line-number-at-pos) (min last-line max-line))
585 (notmuch-search-set-tags (delete tag (notmuch-search-get-tags)))
588 (defun notmuch-search-add-tag (tag)
589 "Add a tag to the currently selected thread or region.
591 The tag is added to all messages in the currently selected thread
592 or threads in the current region."
594 (list (notmuch-select-tag-with-completion "Tag to add: ")))
596 (if (region-active-p)
597 (let* ((beg (region-beginning))
599 (notmuch-search-add-tag-region tag beg end))
600 (notmuch-search-add-tag-thread tag))))
602 (defun notmuch-search-remove-tag (tag)
603 "Remove a tag from the currently selected thread or region.
605 The tag is removed from all messages in the currently selected
606 thread or threads in the current region."
608 (list (notmuch-select-tag-with-completion
610 (if (region-active-p)
612 (notmuch-search-find-thread-id-region (region-beginning) (region-end))
614 (notmuch-search-find-thread-id)))))
616 (if (region-active-p)
617 (let* ((beg (region-beginning))
619 (notmuch-search-remove-tag-region tag beg end))
620 (notmuch-search-remove-tag-thread tag))))
622 (defun notmuch-search-archive-thread ()
623 "Archive the currently selected thread (remove its \"inbox\" tag).
625 This function advances the next thread when finished."
627 (notmuch-search-remove-tag-thread "inbox")
628 (notmuch-search-next-thread))
630 (defvar notmuch-search-process-filter-data nil
631 "Data that has not yet been processed.")
632 (make-variable-buffer-local 'notmuch-search-process-filter-data)
634 (defun notmuch-search-process-sentinel (proc msg)
635 "Add a message to let user know when \"notmuch search\" exits"
636 (let ((buffer (process-buffer proc))
637 (status (process-status proc))
638 (exit-status (process-exit-status proc))
639 (never-found-target-thread nil))
640 (if (memq status '(exit signal))
641 (if (buffer-live-p buffer)
642 (with-current-buffer buffer
644 (let ((inhibit-read-only t)
646 (goto-char (point-max))
647 (if (eq status 'signal)
648 (insert "Incomplete search results (search process was killed).\n"))
649 (if (eq status 'exit)
651 (if notmuch-search-process-filter-data
652 (insert (concat "Error: Unexpected output from notmuch search:\n" notmuch-search-process-filter-data)))
653 (insert "End of search results.")
654 (unless (= exit-status 0)
655 (insert (format " (process returned %d)" exit-status)))
658 (not (string= notmuch-search-target-thread "found")))
659 (set 'never-found-target-thread t))))))
660 (when (and never-found-target-thread
661 notmuch-search-target-line)
662 (goto-char (point-min))
663 (forward-line (1- notmuch-search-target-line))))))))
665 (defcustom notmuch-search-line-faces nil
666 "Tag/face mapping for line highlighting in notmuch-search.
668 Here is an example of how to color search results based on tags.
669 (the following text would be placed in your ~/.emacs file):
671 (setq notmuch-search-line-faces '((\"delete\" . (:foreground \"red\"
672 :background \"blue\"))
673 (\"unread\" . (:foreground \"green\"))))
675 The attributes defined for matching tags are merged, with later
676 attributes overriding earlier. A message having both \"delete\"
677 and \"unread\" tags with the above settings would have a green
678 foreground and blue background."
679 :type '(alist :key-type (string) :value-type (custom-face-edit))
680 :group 'notmuch-search
681 :group 'notmuch-faces)
683 (defun notmuch-search-color-line (start end line-tag-list)
684 "Colorize lines in `notmuch-show' based on tags."
685 ;; Create the overlay only if the message has tags which match one
686 ;; of those specified in `notmuch-search-line-faces'.
689 (let ((tag (car elem))
690 (attributes (cdr elem)))
691 (when (member tag line-tag-list)
693 (setq overlay (make-overlay start end)))
694 ;; Merge the specified properties with any already
695 ;; applied from an earlier match.
696 (overlay-put overlay 'face
697 (append (overlay-get overlay 'face) attributes)))))
698 notmuch-search-line-faces)))
700 (defun notmuch-search-author-propertize (authors)
701 "Split `authors' into matching and non-matching authors and
702 propertize appropriately. If no boundary between authors and
703 non-authors is found, assume that all of the authors match."
704 (if (string-match "\\(.*\\)|\\(.*\\)" authors)
705 (concat (propertize (concat (match-string 1 authors) ",")
706 'face 'notmuch-search-matching-authors)
707 (propertize (match-string 2 authors)
708 'face 'notmuch-search-non-matching-authors))
709 (propertize authors 'face 'notmuch-search-matching-authors)))
711 (defun notmuch-search-insert-authors (format-string authors)
712 ;; Save the match data to avoid interfering with
713 ;; `notmuch-search-process-filter'.
715 (let* ((formatted-authors (format format-string authors))
716 (formatted-sample (format format-string ""))
717 (visible-string formatted-authors)
718 (invisible-string "")
721 ;; Truncate the author string to fit the specification.
722 (if (> (length formatted-authors)
723 (length formatted-sample))
724 (let ((visible-length (- (length formatted-sample)
726 ;; Truncate the visible string according to the width of
727 ;; the display string.
728 (setq visible-string (substring formatted-authors 0 visible-length)
729 invisible-string (substring formatted-authors visible-length))
730 ;; If possible, truncate the visible string at a natural
731 ;; break (comma or pipe), as incremental search doesn't
732 ;; match across the visible/invisible border.
733 (when (string-match "\\(.*\\)\\([,|] \\)\\([^,|]*\\)" visible-string)
734 ;; Second clause is destructive on `visible-string', so
735 ;; order is important.
736 (setq invisible-string (concat (match-string 3 visible-string)
738 visible-string (concat (match-string 1 visible-string)
739 (match-string 2 visible-string))))
740 ;; `visible-string' may be shorter than the space allowed
741 ;; by `format-string'. If so we must insert some padding
742 ;; after `invisible-string'.
743 (setq padding (make-string (- (length formatted-sample)
744 (length visible-string)
748 ;; Use different faces to show matching and non-matching authors.
749 (if (string-match "\\(.*\\)|\\(.*\\)" visible-string)
750 ;; The visible string contains both matching and
751 ;; non-matching authors.
752 (setq visible-string (notmuch-search-author-propertize visible-string)
753 ;; The invisible string must contain only non-matching
754 ;; authors, as the visible-string contains both.
755 invisible-string (propertize invisible-string
756 'face 'notmuch-search-non-matching-authors))
757 ;; The visible string contains only matching authors.
758 (setq visible-string (propertize visible-string
759 'face 'notmuch-search-matching-authors)
760 ;; The invisible string may contain both matching and
761 ;; non-matching authors.
762 invisible-string (notmuch-search-author-propertize invisible-string)))
764 ;; If there is any invisible text, add it as a tooltip to the
766 (when (not (string= invisible-string ""))
767 (setq visible-string (propertize visible-string 'help-echo (concat "..." invisible-string))))
769 ;; Insert the visible and, if present, invisible author strings.
770 (insert visible-string)
771 (when (not (string= invisible-string ""))
772 (let ((start (point))
774 (insert invisible-string)
775 (setq overlay (make-overlay start (point)))
776 (overlay-put overlay 'invisible 'ellipsis)
777 (overlay-put overlay 'isearch-open-invisible #'delete-overlay)))
780 (defun notmuch-search-insert-field (field date count authors subject tags)
782 ((string-equal field "date")
783 (insert (propertize (format (cdr (assoc field notmuch-search-result-format)) date)
784 'face 'notmuch-search-date)))
785 ((string-equal field "count")
786 (insert (propertize (format (cdr (assoc field notmuch-search-result-format)) count)
787 'face 'notmuch-search-count)))
788 ((string-equal field "subject")
789 (insert (propertize (format (cdr (assoc field notmuch-search-result-format)) subject)
790 'face 'notmuch-search-subject)))
792 ((string-equal field "authors")
793 (notmuch-search-insert-authors (cdr (assoc field notmuch-search-result-format)) authors))
795 ((string-equal field "tags")
796 (insert (concat "(" (propertize tags 'font-lock-face 'notmuch-tag-face) ")")))))
798 (defun notmuch-search-show-result (date count authors subject tags)
799 (let ((fields) (field))
800 (setq fields (mapcar 'car notmuch-search-result-format))
801 (loop for field in fields
802 do (notmuch-search-insert-field field date count authors subject tags)))
805 (defun notmuch-search-process-filter (proc string)
806 "Process and filter the output of \"notmuch search\""
807 (let ((buffer (process-buffer proc))
809 (if (buffer-live-p buffer)
810 (with-current-buffer buffer
814 (inhibit-read-only t)
815 (string (concat notmuch-search-process-filter-data string)))
816 (setq notmuch-search-process-filter-data nil)
818 (while (and (< line (length string)) (= (elt string line) ?\n))
819 (setq line (1+ line)))
820 (if (string-match "^\\(thread:[0-9A-Fa-f]*\\) \\([^][]*\\) \\(\\[[0-9/]*\\]\\) \\([^;]*\\); \\(.*\\) (\\([^()]*\\))$" string line)
821 (let* ((thread-id (match-string 1 string))
822 (date (match-string 2 string))
823 (count (match-string 3 string))
824 (authors (match-string 4 string))
825 (subject (match-string 5 string))
826 (tags (match-string 6 string))
827 (tag-list (if tags (save-match-data (split-string tags)))))
828 (goto-char (point-max))
829 (if (/= (match-beginning 1) line)
830 (insert (concat "Error: Unexpected output from notmuch search:\n" (substring string line (match-beginning 1)) "\n")))
832 (notmuch-search-show-result date count authors subject tags)
833 (notmuch-search-color-line beg (point) tag-list)
834 (put-text-property beg (point) 'notmuch-search-thread-id thread-id)
835 (put-text-property beg (point) 'notmuch-search-authors authors)
836 (put-text-property beg (point) 'notmuch-search-subject subject)
837 (if (string= thread-id notmuch-search-target-thread)
839 (set 'found-target beg)
840 (set 'notmuch-search-target-thread "found"))))
841 (set 'line (match-end 0)))
843 (while (and (< line (length string)) (= (elt string line) ?\n))
844 (setq line (1+ line)))
845 (if (< line (length string))
846 (setq notmuch-search-process-filter-data (substring string line)))
849 (goto-char found-target)))
850 (delete-process proc))))
852 (defun notmuch-search-operate-all (action)
853 "Add/remove tags from all matching messages.
855 This command adds or removes tags from all messages matching the
856 current search terms. When called interactively, this command
857 will prompt for tags to be added or removed. Tags prefixed with
858 '+' will be added and tags prefixed with '-' will be removed.
860 Each character of the tag name may consist of alphanumeric
861 characters as well as `_.+-'.
863 (interactive "sOperation (+add -drop): notmuch tag ")
864 (let ((action-split (split-string action " +")))
865 ;; Perform some validation
866 (let ((words action-split))
867 (when (null words) (error "No operation given"))
869 (unless (string-match-p "^[-+][-+_.[:word:]]+$" (car words))
870 (error "Action must be of the form `+thistag -that_tag'"))
871 (setq words (cdr words))))
872 (apply 'notmuch-tag notmuch-search-query-string action-split)))
874 (defun notmuch-search-buffer-title (query)
875 "Returns the title for a buffer with notmuch search results."
879 (loop for tuple in notmuch-saved-searches
880 if (let ((quoted-query (regexp-quote (cdr tuple))))
881 (and (string-match (concat "^" quoted-query) query)
882 (> (length (match-string 0 query))
884 do (setq longest tuple))
886 (saved-search-name (car saved-search))
887 (saved-search-query (cdr saved-search)))
888 (cond ((and saved-search (equal saved-search-query query))
889 ;; Query is the same as saved search (ignoring case)
890 (concat "*notmuch-saved-search-" saved-search-name "*"))
892 (concat "*notmuch-search-"
893 (replace-regexp-in-string (concat "^" (regexp-quote saved-search-query))
894 (concat "[ " saved-search-name " ]")
898 (concat "*notmuch-search-" query "*"))
901 (defun notmuch-read-query (prompt)
902 "Read a notmuch-query from the minibuffer with completion.
904 PROMPT is the string to prompt with."
907 (append (list "folder:" "thread:" "id:" "date:" "from:" "to:"
908 "subject:" "attachment:")
909 (mapcar (lambda (tag)
911 (process-lines notmuch-command "search" "--output=tags" "*")))))
912 (let ((keymap (copy-keymap minibuffer-local-map))
913 (minibuffer-completion-table
914 (completion-table-dynamic
916 ;; generate a list of possible completions for the current input
918 ;; this ugly regexp is used to get the last word of the input
919 ;; possibly preceded by a '('
920 ((string-match "\\(^\\|.* (?\\)\\([^ ]*\\)$" string)
921 (mapcar (lambda (compl)
922 (concat (match-string-no-properties 1 string) compl))
923 (all-completions (match-string-no-properties 2 string)
925 (t (list string)))))))
926 ;; this was simpler than convincing completing-read to accept spaces:
927 (define-key keymap (kbd "<tab>") 'minibuffer-complete)
928 (let ((history-delete-duplicates t))
929 (read-from-minibuffer prompt nil keymap nil
930 'notmuch-search-history nil nil)))))
933 (defun notmuch-search (&optional query oldest-first target-thread target-line continuation)
934 "Run \"notmuch search\" with the given `query' and display results.
936 If `query' is nil, it is read interactively from the minibuffer.
937 Other optional parameters are used as follows:
939 oldest-first: A Boolean controlling the sort order of returned threads
940 target-thread: A thread ID (with the thread: prefix) that will be made
941 current if it appears in the search results.
942 target-line: The line number to move to if the target thread does not
943 appear in the search results."
946 (setq query (notmuch-read-query "Notmuch search: ")))
947 (let ((buffer (get-buffer-create (notmuch-search-buffer-title query))))
948 (switch-to-buffer buffer)
949 (notmuch-search-mode)
950 ;; Don't track undo information for this buffer
951 (set 'buffer-undo-list t)
952 (set 'notmuch-search-query-string query)
953 (set 'notmuch-search-oldest-first oldest-first)
954 (set 'notmuch-search-target-thread target-thread)
955 (set 'notmuch-search-target-line target-line)
956 (set 'notmuch-search-continuation continuation)
957 (let ((proc (get-buffer-process (current-buffer)))
958 (inhibit-read-only t))
960 (error "notmuch search process already running for query `%s'" query)
963 (goto-char (point-min))
965 (let ((proc (start-process
966 "notmuch-search" buffer
967 notmuch-command "search"
969 "--sort=oldest-first"
970 "--sort=newest-first")
972 (set-process-sentinel proc 'notmuch-search-process-sentinel)
973 (set-process-filter proc 'notmuch-search-process-filter)
974 (set-process-query-on-exit-flag proc nil))))
975 (run-hooks 'notmuch-search-hook)))
977 (defun notmuch-search-refresh-view ()
978 "Refresh the current view.
980 Kills the current buffer and runs a new search with the same
981 query string as the current search. If the current thread is in
982 the new search results, then point will be placed on the same
983 thread. Otherwise, point will be moved to attempt to be in the
984 same relative position within the new buffer."
986 (let ((target-line (line-number-at-pos))
987 (oldest-first notmuch-search-oldest-first)
988 (target-thread (notmuch-search-find-thread-id))
989 (query notmuch-search-query-string)
990 (continuation notmuch-search-continuation))
991 (notmuch-kill-this-buffer)
992 (notmuch-search query oldest-first target-thread target-line continuation)
993 (goto-char (point-min))))
995 (defcustom notmuch-poll-script nil
996 "An external script to incorporate new mail into the notmuch database.
998 This variable controls the action invoked by
999 `notmuch-search-poll-and-refresh-view' and
1000 `notmuch-hello-poll-and-update' (each have a default keybinding
1001 of 'G') to incorporate new mail into the notmuch database.
1003 If set to nil (the default), new mail is processed by invoking
1004 \"notmuch new\". Otherwise, this should be set to a string that
1005 gives the name of an external script that processes new mail. If
1006 set to the empty string, no command will be run.
1008 The external script could do any of the following depending on
1011 1. Invoke a program to transfer mail to the local mail store
1012 2. Invoke \"notmuch new\" to incorporate the new mail
1013 3. Invoke one or more \"notmuch tag\" commands to classify the mail
1015 Note that the recommended way of achieving the same is using
1016 \"notmuch new\" hooks."
1017 :type '(choice (const :tag "notmuch new" nil)
1018 (const :tag "Disabled" "")
1019 (string :tag "Custom script"))
1020 :group 'notmuch-external)
1022 (defun notmuch-poll ()
1023 "Run \"notmuch new\" or an external script to import mail.
1025 Invokes `notmuch-poll-script', \"notmuch new\", or does nothing
1026 depending on the value of `notmuch-poll-script'."
1028 (if (stringp notmuch-poll-script)
1029 (unless (string= notmuch-poll-script "")
1030 (call-process notmuch-poll-script nil nil))
1031 (call-process notmuch-command nil nil nil "new")))
1033 (defun notmuch-search-poll-and-refresh-view ()
1034 "Invoke `notmuch-poll' to import mail, then refresh the current view."
1037 (notmuch-search-refresh-view))
1039 (defun notmuch-search-toggle-order ()
1040 "Toggle the current search order.
1042 By default, the \"inbox\" view created by `notmuch' is displayed
1043 in chronological order (oldest thread at the beginning of the
1044 buffer), while any global searches created by `notmuch-search'
1045 are displayed in reverse-chronological order (newest thread at
1046 the beginning of the buffer).
1048 This command toggles the sort order for the current search.
1050 Note that any filtered searches created by
1051 `notmuch-search-filter' retain the search order of the parent
1054 (set 'notmuch-search-oldest-first (not notmuch-search-oldest-first))
1055 (notmuch-search-refresh-view))
1057 (defun notmuch-search-filter (query)
1058 "Filter the current search results based on an additional query string.
1060 Runs a new search matching only messages that match both the
1061 current search results AND the additional query string provided."
1062 (interactive (list (notmuch-read-query "Filter search: ")))
1063 (let ((grouped-query (if (string-match-p notmuch-search-disjunctive-regexp query)
1064 (concat "( " query " )")
1066 (notmuch-search (if (string= notmuch-search-query-string "*")
1068 (concat notmuch-search-query-string " and " grouped-query)) notmuch-search-oldest-first)))
1070 (defun notmuch-search-filter-by-tag (tag)
1071 "Filter the current search results based on a single tag.
1073 Runs a new search matching only messages that match both the
1074 current search results AND that are tagged with the given tag."
1076 (list (notmuch-select-tag-with-completion "Filter by tag: ")))
1077 (notmuch-search (concat notmuch-search-query-string " and tag:" tag) notmuch-search-oldest-first))
1081 "Run notmuch and display saved searches, known tags, etc."
1085 (defun notmuch-interesting-buffer (b)
1086 "Is the current buffer of interest to a notmuch user?"
1087 (with-current-buffer b
1088 (memq major-mode '(notmuch-show-mode
1094 (defun notmuch-cycle-notmuch-buffers ()
1095 "Cycle through any existing notmuch buffers (search, show or hello).
1097 If the current buffer is the only notmuch buffer, bury it. If no
1098 notmuch buffers exist, run `notmuch'."
1102 ;; If the current buffer is a notmuch buffer, remember it and then
1104 (when (notmuch-interesting-buffer (current-buffer))
1105 (setq start (current-buffer))
1108 ;; Find the first notmuch buffer.
1109 (setq first (loop for buffer in (buffer-list)
1110 if (notmuch-interesting-buffer buffer)
1114 ;; If the first one we found is any other than the starting
1115 ;; buffer, switch to it.
1116 (unless (eq first start)
1117 (switch-to-buffer first))
1120 (setq mail-user-agent 'notmuch-user-agent)