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:
39 ;; (autoload 'notmuch "notmuch" "Notmuch mail" t)
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-tag)
56 (require 'notmuch-show)
57 (require 'notmuch-tree)
58 (require 'notmuch-mua)
59 (require 'notmuch-hello)
60 (require 'notmuch-maildir-fcc)
61 (require 'notmuch-message)
62 (require 'notmuch-parser)
64 (unless (require 'notmuch-version nil t)
65 (defconst notmuch-emacs-version "unknown"
66 "Placeholder variable when notmuch-version.el[c] is not available."))
68 (defcustom notmuch-search-result-format
71 ("authors" . "%-20s ")
74 "Search result formatting. Supported fields are:
75 date, count, authors, subject, tags
77 (setq notmuch-search-result-format \(\(\"authors\" . \"%-40s\"\)
78 \(\"subject\" . \"%s\"\)\)\)
79 Line breaks are permitted in format strings (though this is
80 currently experimental). Note that a line break at the end of an
81 \"authors\" field will get elided if the authors list is long;
82 place it instead at the beginning of the following field. To
83 enter a line break when setting this variable with setq, use \\n.
84 To enter a line break in customize, press \\[quoted-insert] C-j."
85 :type '(alist :key-type (string) :value-type (string))
86 :group 'notmuch-search)
88 ;; The name of this variable `notmuch-init-file' is consistent with the
89 ;; convention used in e.g. emacs and gnus. The value, `notmuch-config[.el[c]]'
90 ;; is consistent with notmuch cli configuration file `~/.notmuch-config'.
91 (defcustom notmuch-init-file (locate-user-emacs-file "notmuch-config")
92 "Your Notmuch Emacs-Lisp configuration file name.
93 If a file with one of the suffixes defined by `get-load-suffixes' exists,
94 it will be read instead.
95 This file is read once when notmuch is loaded; the notmuch hooks added
96 there will be called at other points of notmuch execution."
100 (defvar notmuch-query-history nil
101 "Variable to store minibuffer history for notmuch queries")
103 (defun notmuch-foreach-mime-part (function mm-handle)
104 (cond ((stringp (car mm-handle))
105 (dolist (part (cdr mm-handle))
106 (notmuch-foreach-mime-part function part)))
107 ((bufferp (car mm-handle))
108 (funcall function mm-handle))
109 (t (dolist (part mm-handle)
110 (notmuch-foreach-mime-part function part)))))
112 (defun notmuch-count-attachments (mm-handle)
114 (notmuch-foreach-mime-part
116 (let ((disposition (mm-handle-disposition p)))
117 (and (listp disposition)
118 (or (equal (car disposition) "attachment")
119 (and (equal (car disposition) "inline")
120 (assq 'filename disposition)))
125 (defun notmuch-save-attachments (mm-handle &optional queryp)
126 (notmuch-foreach-mime-part
128 (let ((disposition (mm-handle-disposition p)))
129 (and (listp disposition)
130 (or (equal (car disposition) "attachment")
131 (and (equal (car disposition) "inline")
132 (assq 'filename disposition)))
135 (concat "Save '" (cdr (assq 'filename disposition)) "' ")))
141 (defun notmuch-hl-line-mode ()
142 (prog1 (hl-line-mode)
143 (when hl-line-overlay
144 (overlay-put hl-line-overlay 'priority 1))))
146 (defcustom notmuch-search-hook '(notmuch-hl-line-mode)
147 "List of functions to call when notmuch displays the search results."
149 :options '(notmuch-hl-line-mode)
150 :group 'notmuch-search
151 :group 'notmuch-hooks)
153 (defvar notmuch-search-mode-map
154 (let ((map (make-sparse-keymap)))
155 (set-keymap-parent map notmuch-common-keymap)
156 (define-key map "x" 'notmuch-bury-or-kill-this-buffer)
157 (define-key map (kbd "<DEL>") 'notmuch-search-scroll-down)
158 (define-key map "b" 'notmuch-search-scroll-down)
159 (define-key map " " 'notmuch-search-scroll-up)
160 (define-key map "<" 'notmuch-search-first-thread)
161 (define-key map ">" 'notmuch-search-last-thread)
162 (define-key map "p" 'notmuch-search-previous-thread)
163 (define-key map "n" 'notmuch-search-next-thread)
164 (define-key map "r" 'notmuch-search-reply-to-thread-sender)
165 (define-key map "R" 'notmuch-search-reply-to-thread)
166 (define-key map "o" 'notmuch-search-toggle-order)
167 (define-key map "c" 'notmuch-search-stash-map)
168 (define-key map "t" 'notmuch-search-filter-by-tag)
169 (define-key map "f" 'notmuch-search-filter)
170 (define-key map [mouse-1] 'notmuch-search-show-thread)
171 (define-key map "*" 'notmuch-search-tag-all)
172 (define-key map "a" 'notmuch-search-archive-thread)
173 (define-key map "-" 'notmuch-search-remove-tag)
174 (define-key map "+" 'notmuch-search-add-tag)
175 (define-key map (kbd "RET") 'notmuch-search-show-thread)
176 (define-key map "Z" 'notmuch-tree-from-search-current-query)
178 "Keymap for \"notmuch search\" buffers.")
179 (fset 'notmuch-search-mode-map notmuch-search-mode-map)
181 (defvar notmuch-search-stash-map
182 (let ((map (make-sparse-keymap)))
183 (define-key map "i" 'notmuch-search-stash-thread-id)
184 (define-key map "?" 'notmuch-subkeymap-help)
186 "Submap for stash commands")
187 (fset 'notmuch-search-stash-map notmuch-search-stash-map)
189 (defun notmuch-search-stash-thread-id ()
190 "Copy thread ID of current thread to kill-ring."
192 (notmuch-common-do-stash (notmuch-search-find-thread-id)))
194 (defvar notmuch-search-query-string)
195 (defvar notmuch-search-target-thread)
196 (defvar notmuch-search-target-line)
198 (defvar notmuch-search-disjunctive-regexp "\\<[oO][rR]\\>")
200 (defun notmuch-search-scroll-up ()
201 "Move forward through search results by one window's worth."
205 ((end-of-buffer) (notmuch-search-last-thread))))
207 (defun notmuch-search-scroll-down ()
208 "Move backward through the search results by one window's worth."
210 ;; I don't know why scroll-down doesn't signal beginning-of-buffer
211 ;; the way that scroll-up signals end-of-buffer, but c'est la vie.
213 ;; So instead of trapping a signal we instead check whether the
214 ;; window begins on the first line of the buffer and if so, move
215 ;; directly to that position. (We have to count lines since the
216 ;; window-start position is not the same as point-min due to the
217 ;; invisible thread-ID characters on the first line.
218 (if (equal (count-lines (point-min) (window-start)) 0)
219 (goto-char (point-min))
222 (defun notmuch-search-next-thread ()
223 "Select the next thread in the search results."
225 (when (notmuch-search-get-result)
226 (goto-char (notmuch-search-result-end))))
228 (defun notmuch-search-previous-thread ()
229 "Select the previous thread in the search results."
231 (if (notmuch-search-get-result)
233 (goto-char (notmuch-search-result-beginning (- (point) 1))))
234 ;; We must be past the end; jump to the last result
235 (notmuch-search-last-thread)))
237 (defun notmuch-search-last-thread ()
238 "Select the last thread in the search results."
240 (goto-char (point-max))
242 (let ((beg (notmuch-search-result-beginning)))
243 (when beg (goto-char beg))))
245 (defun notmuch-search-first-thread ()
246 "Select the first thread in the search results."
248 (goto-char (point-min)))
250 (defface notmuch-message-summary-face
251 '((((class color) (background light)) (:background "#f0f0f0"))
252 (((class color) (background dark)) (:background "#303030")))
253 "Face for the single-line message summary in notmuch-show-mode."
255 :group 'notmuch-faces)
257 (defface notmuch-search-date
258 '((t :inherit default))
259 "Face used in search mode for dates."
260 :group 'notmuch-search
261 :group 'notmuch-faces)
263 (defface notmuch-search-count
264 '((t :inherit default))
265 "Face used in search mode for the count matching the query."
266 :group 'notmuch-search
267 :group 'notmuch-faces)
269 (defface notmuch-search-subject
270 '((t :inherit default))
271 "Face used in search mode for subjects."
272 :group 'notmuch-search
273 :group 'notmuch-faces)
275 (defface notmuch-search-matching-authors
276 '((t :inherit default))
277 "Face used in search mode for authors matching the query."
278 :group 'notmuch-search
279 :group 'notmuch-faces)
281 (defface notmuch-search-non-matching-authors
284 (:foreground "grey30"))
287 (:foreground "grey60"))
290 "Face used in search mode for authors not matching the query."
291 :group 'notmuch-search
292 :group 'notmuch-faces)
294 (defface notmuch-tag-face
297 (:foreground "OliveDrab1"))
300 (:foreground "navy blue" :bold t))
303 "Face used in search mode face for tags."
304 :group 'notmuch-search
305 :group 'notmuch-faces)
307 (defun notmuch-search-mode ()
308 "Major mode displaying results of a notmuch search.
310 This buffer contains the results of a \"notmuch search\" of your
311 email archives. Each line in the buffer represents a single
312 thread giving a summary of the thread (a relative date, the
313 number of matched messages and total messages in the thread,
314 participants in the thread, a representative subject line, and
317 Pressing \\[notmuch-search-show-thread] on any line displays that
318 thread. The '\\[notmuch-search-add-tag]' and
319 '\\[notmuch-search-remove-tag]' keys can be used to add or remove
320 tags from a thread. The '\\[notmuch-search-archive-thread]' key
321 is a convenience for archiving a thread (applying changes in
322 `notmuch-archive-tags'). The '\\[notmuch-search-tag-all]' key can
323 be used to add and/or remove tags from all messages (as opposed
324 to threads) that match the current query. Use with caution, as
325 this will also tag matching messages that arrived *after*
326 constructing the buffer.
328 Other useful commands are '\\[notmuch-search-filter]' for
329 filtering the current search based on an additional query string,
330 '\\[notmuch-search-filter-by-tag]' for filtering to include only
331 messages with a given tag, and '\\[notmuch-search]' to execute a
334 Complete list of currently available key bindings:
336 \\{notmuch-search-mode-map}"
338 (kill-all-local-variables)
339 (make-local-variable 'notmuch-search-query-string)
340 (make-local-variable 'notmuch-search-oldest-first)
341 (make-local-variable 'notmuch-search-target-thread)
342 (make-local-variable 'notmuch-search-target-line)
343 (setq notmuch-buffer-refresh-function #'notmuch-search-refresh-view)
344 (set (make-local-variable 'scroll-preserve-screen-position) t)
345 (add-to-invisibility-spec (cons 'ellipsis t))
346 (use-local-map notmuch-search-mode-map)
347 (setq truncate-lines t)
348 (setq major-mode 'notmuch-search-mode
349 mode-name "notmuch-search")
350 (setq buffer-read-only t))
352 (defun notmuch-search-get-result (&optional pos)
353 "Return the result object for the thread at POS (or point).
355 If there is no thread at POS (or point), returns nil."
356 (get-text-property (or pos (point)) 'notmuch-search-result))
358 (defun notmuch-search-result-beginning (&optional pos)
359 "Return the point at the beginning of the thread at POS (or point).
361 If there is no thread at POS (or point), returns nil."
362 (when (notmuch-search-get-result pos)
363 ;; We pass 1+point because previous-single-property-change starts
364 ;; searching one before the position we give it.
365 (previous-single-property-change (1+ (or pos (point)))
366 'notmuch-search-result nil (point-min))))
368 (defun notmuch-search-result-end (&optional pos)
369 "Return the point at the end of the thread at POS (or point).
371 The returned point will be just after the newline character that
372 ends the result line. If there is no thread at POS (or point),
374 (when (notmuch-search-get-result pos)
375 (next-single-property-change (or pos (point)) 'notmuch-search-result
378 (defun notmuch-search-foreach-result (beg end function)
379 "Invoke FUNCTION for each result between BEG and END.
381 FUNCTION should take one argument. It will be applied to the
382 character position of the beginning of each result that overlaps
383 the region between points BEG and END. As a special case, if (=
384 BEG END), FUNCTION will be applied to the result containing point
387 (lexical-let ((pos (notmuch-search-result-beginning beg))
388 ;; End must be a marker in case function changes the
390 (end (copy-marker end))
391 ;; Make sure we examine at least one result, even if
394 ;; We have to be careful if the region extends beyond the results.
395 ;; In this case, pos could be null or there could be no result at
397 (while (and pos (or (< pos end) first))
398 (when (notmuch-search-get-result pos)
399 (funcall function pos))
400 (setq pos (notmuch-search-result-end pos)
402 ;; Unindent the function argument of notmuch-search-foreach-result so
403 ;; the indentation of callers doesn't get out of hand.
404 (put 'notmuch-search-foreach-result 'lisp-indent-function 2)
406 (defun notmuch-search-properties-in-region (property beg end)
408 (notmuch-search-foreach-result beg end
410 (push (plist-get (notmuch-search-get-result pos) property) output)))
413 (defun notmuch-search-find-thread-id (&optional bare)
414 "Return the thread for the current thread
416 If BARE is set then do not prefix with \"thread:\""
417 (let ((thread (plist-get (notmuch-search-get-result) :thread)))
418 (when thread (concat (unless bare "thread:") thread))))
420 (defun notmuch-search-find-stable-query ()
421 "Return the stable queries for the current thread.
423 This returns a list (MATCHED-QUERY UNMATCHED-QUERY) for the
424 matched and unmatched messages in the current thread."
425 (plist-get (notmuch-search-get-result) :query))
427 (defun notmuch-search-find-stable-query-region (beg end &optional only-matched)
428 "Return the stable query for the current region.
430 If ONLY-MATCHED is non-nil, include only matched messages. If it
431 is nil, include both matched and unmatched messages. If there are
432 no messages in the region then return nil."
433 (let ((query-list nil) (all (not only-matched)))
434 (dolist (queries (notmuch-search-properties-in-region :query beg end))
435 (when (first queries)
436 (push (first queries) query-list))
437 (when (and all (second queries))
438 (push (second queries) query-list)))
440 (concat "(" (mapconcat 'identity query-list ") or (") ")"))))
442 (defun notmuch-search-find-authors ()
443 "Return the authors for the current thread"
444 (plist-get (notmuch-search-get-result) :authors))
446 (defun notmuch-search-find-authors-region (beg end)
447 "Return a list of authors for the current region"
448 (notmuch-search-properties-in-region :authors beg end))
450 (defun notmuch-search-find-subject ()
451 "Return the subject for the current thread"
452 (plist-get (notmuch-search-get-result) :subject))
454 (defun notmuch-search-find-subject-region (beg end)
455 "Return a list of authors for the current region"
456 (notmuch-search-properties-in-region :subject beg end))
458 (defun notmuch-search-show-thread (&optional elide-toggle)
459 "Display the currently selected thread."
461 (let ((thread-id (notmuch-search-find-thread-id))
462 (subject (notmuch-search-find-subject)))
463 (if (> (length thread-id) 0)
464 (notmuch-show thread-id
467 notmuch-search-query-string
468 ;; Name the buffer based on the subject.
469 (concat "*" (truncate-string-to-width subject 30 nil nil t) "*"))
470 (message "End of search results."))))
472 (defun notmuch-tree-from-search-current-query ()
473 "Call notmuch tree with the current query"
475 (notmuch-tree notmuch-search-query-string))
477 (defun notmuch-tree-from-search-thread ()
478 "Show the selected thread with notmuch-tree"
480 (notmuch-tree (notmuch-search-find-thread-id)
481 notmuch-search-query-string
483 (notmuch-prettify-subject (notmuch-search-find-subject))
486 (defun notmuch-search-reply-to-thread (&optional prompt-for-sender)
487 "Begin composing a reply-all to the entire current thread in a new buffer."
489 (let ((message-id (notmuch-search-find-thread-id)))
490 (notmuch-mua-new-reply message-id prompt-for-sender t)))
492 (defun notmuch-search-reply-to-thread-sender (&optional prompt-for-sender)
493 "Begin composing a reply to the entire current thread in a new buffer."
495 (let ((message-id (notmuch-search-find-thread-id)))
496 (notmuch-mua-new-reply message-id prompt-for-sender nil)))
498 (defun notmuch-search-set-tags (tags &optional pos)
499 (let ((new-result (plist-put (notmuch-search-get-result pos) :tags tags)))
500 (notmuch-search-update-result new-result pos)))
502 (defun notmuch-search-get-tags (&optional pos)
503 (plist-get (notmuch-search-get-result pos) :tags))
505 (defun notmuch-search-get-tags-region (beg end)
507 (notmuch-search-foreach-result beg end
509 (setq output (append output (notmuch-search-get-tags pos)))))
512 (defun notmuch-search-interactive-region ()
513 "Return the bounds of the current interactive region.
515 This returns (BEG END), where BEG and END are the bounds of the
516 region if the region is active, or both `point' otherwise."
517 (if (region-active-p)
518 (list (region-beginning) (region-end))
519 (list (point) (point))))
521 (defun notmuch-search-interactive-tag-changes (&optional initial-input)
522 "Prompt for tag changes for the current thread or region.
524 Returns (TAG-CHANGES REGION-BEGIN REGION-END)."
525 (let* ((region (notmuch-search-interactive-region))
526 (beg (first region)) (end (second region))
527 (prompt (if (= beg end) "Tag thread" "Tag region")))
528 (cons (notmuch-read-tag-changes
529 (notmuch-search-get-tags-region beg end) prompt initial-input)
532 (defun notmuch-search-tag (tag-changes &optional beg end only-matched)
533 "Change tags for the currently selected thread or region.
535 See `notmuch-tag' for information on the format of TAG-CHANGES.
536 When called interactively, this uses the region if the region is
537 active. When called directly, BEG and END provide the region.
538 If these are nil or not provided, this applies to the thread at
541 If ONLY-MATCHED is non-nil, only tag matched messages."
542 (interactive (notmuch-search-interactive-tag-changes))
543 (unless (and beg end) (setq beg (point) end (point)))
544 (let ((search-string (notmuch-search-find-stable-query-region
545 beg end only-matched)))
546 (notmuch-tag search-string tag-changes)
547 (notmuch-search-foreach-result beg end
549 (notmuch-search-set-tags
550 (notmuch-update-tags (notmuch-search-get-tags pos) tag-changes)
553 (defun notmuch-search-add-tag (tag-changes &optional beg end)
554 "Change tags for the current thread or region (defaulting to add).
556 Same as `notmuch-search-tag' but sets initial input to '+'."
557 (interactive (notmuch-search-interactive-tag-changes "+"))
558 (notmuch-search-tag tag-changes beg end))
560 (defun notmuch-search-remove-tag (tag-changes &optional beg end)
561 "Change tags for the current thread or region (defaulting to remove).
563 Same as `notmuch-search-tag' but sets initial input to '-'."
564 (interactive (notmuch-search-interactive-tag-changes "-"))
565 (notmuch-search-tag tag-changes beg end))
567 (put 'notmuch-search-archive-thread 'notmuch-prefix-doc
568 "Un-archive the currently selected thread.")
569 (defun notmuch-search-archive-thread (&optional unarchive beg end)
570 "Archive the currently selected thread or region.
572 Archive each message in the currently selected thread by applying
573 the tag changes in `notmuch-archive-tags' to each (remove the
574 \"inbox\" tag by default). If a prefix argument is given, the
575 messages will be \"unarchived\" (i.e. the tag changes in
576 `notmuch-archive-tags' will be reversed).
578 This function advances the next thread when finished."
579 (interactive (cons current-prefix-arg (notmuch-search-interactive-region)))
580 (when notmuch-archive-tags
582 (notmuch-tag-change-list notmuch-archive-tags unarchive) beg end))
584 (notmuch-search-next-thread)))
586 (defun notmuch-search-update-result (result &optional pos)
587 "Replace the result object of the thread at POS (or point) by
588 RESULT and redraw it.
590 This will keep point in a reasonable location. However, if there
591 are enclosing save-excursions and the saved point is in the
592 result being updated, the point will be restored to the beginning
594 (let ((start (notmuch-search-result-beginning pos))
595 (end (notmuch-search-result-end pos))
597 (inhibit-read-only t))
598 ;; Delete the current thread
599 (delete-region start end)
600 ;; Insert the updated thread
601 (notmuch-search-show-result result start)
602 ;; If point was inside the old result, make an educated guess
603 ;; about where to place it now. Unfortunately, this won't work
604 ;; with save-excursion (or any other markers that would be nice to
605 ;; preserve, such as the window start), but there's nothing we can
606 ;; do about that without a way to retrieve markers in a region.
607 (when (and (>= init-point start) (<= init-point end))
608 (let* ((new-end (notmuch-search-result-end start))
609 (new-point (if (= init-point end)
611 (min init-point (- new-end 1)))))
612 (goto-char new-point)))))
614 (defun notmuch-search-process-sentinel (proc msg)
615 "Add a message to let user know when \"notmuch search\" exits"
616 (let ((buffer (process-buffer proc))
617 (status (process-status proc))
618 (exit-status (process-exit-status proc))
619 (never-found-target-thread nil))
620 (when (memq status '(exit signal))
622 (kill-buffer (process-get proc 'parse-buf))
623 (if (buffer-live-p buffer)
624 (with-current-buffer buffer
626 (let ((inhibit-read-only t)
628 (goto-char (point-max))
629 (if (eq status 'signal)
630 (insert "Incomplete search results (search process was killed).\n"))
631 (when (eq status 'exit)
632 (insert "End of search results.\n")
633 ;; For version mismatch, there's no point in
634 ;; showing the search buffer
635 (when (or (= exit-status 20) (= exit-status 21))
639 (not (string= notmuch-search-target-thread "found")))
640 (set 'never-found-target-thread t)))))
641 (when (and never-found-target-thread
642 notmuch-search-target-line)
643 (goto-char (point-min))
644 (forward-line (1- notmuch-search-target-line)))))))))
646 (defcustom notmuch-search-line-faces '(("unread" :weight bold)
647 ("flagged" :foreground "blue"))
648 "Tag/face mapping for line highlighting in notmuch-search.
650 Here is an example of how to color search results based on tags.
651 (the following text would be placed in your ~/.emacs file):
653 (setq notmuch-search-line-faces '((\"unread\" . (:foreground \"green\"))
654 (\"deleted\" . (:foreground \"red\"
655 :background \"blue\"))))
657 The attributes defined for matching tags are merged, with earlier
658 attributes overriding later. A message having both \"deleted\"
659 and \"unread\" tags with the above settings would have a green
660 foreground and blue background."
661 :type '(alist :key-type (string) :value-type (custom-face-edit))
662 :group 'notmuch-search
663 :group 'notmuch-faces)
665 (defun notmuch-search-color-line (start end line-tag-list)
666 "Colorize lines in `notmuch-show' based on tags."
668 (let ((tag (car elem))
669 (attributes (cdr elem)))
670 (when (member tag line-tag-list)
671 (notmuch-apply-face nil attributes nil start end))))
672 ;; Reverse the list so earlier entries take precedence
673 (reverse notmuch-search-line-faces)))
675 (defun notmuch-search-author-propertize (authors)
676 "Split `authors' into matching and non-matching authors and
677 propertize appropriately. If no boundary between authors and
678 non-authors is found, assume that all of the authors match."
679 (if (string-match "\\(.*\\)|\\(.*\\)" authors)
680 (concat (propertize (concat (match-string 1 authors) ",")
681 'face 'notmuch-search-matching-authors)
682 (propertize (match-string 2 authors)
683 'face 'notmuch-search-non-matching-authors))
684 (propertize authors 'face 'notmuch-search-matching-authors)))
686 (defun notmuch-search-insert-authors (format-string authors)
687 ;; Save the match data to avoid interfering with
688 ;; `notmuch-search-process-filter'.
690 (let* ((formatted-authors (format format-string authors))
691 (formatted-sample (format format-string ""))
692 (visible-string formatted-authors)
693 (invisible-string "")
696 ;; Truncate the author string to fit the specification.
697 (if (> (length formatted-authors)
698 (length formatted-sample))
699 (let ((visible-length (- (length formatted-sample)
701 ;; Truncate the visible string according to the width of
702 ;; the display string.
703 (setq visible-string (substring formatted-authors 0 visible-length)
704 invisible-string (substring formatted-authors visible-length))
705 ;; If possible, truncate the visible string at a natural
706 ;; break (comma or pipe), as incremental search doesn't
707 ;; match across the visible/invisible border.
708 (when (string-match "\\(.*\\)\\([,|] \\)\\([^,|]*\\)" visible-string)
709 ;; Second clause is destructive on `visible-string', so
710 ;; order is important.
711 (setq invisible-string (concat (match-string 3 visible-string)
713 visible-string (concat (match-string 1 visible-string)
714 (match-string 2 visible-string))))
715 ;; `visible-string' may be shorter than the space allowed
716 ;; by `format-string'. If so we must insert some padding
717 ;; after `invisible-string'.
718 (setq padding (make-string (- (length formatted-sample)
719 (length visible-string)
723 ;; Use different faces to show matching and non-matching authors.
724 (if (string-match "\\(.*\\)|\\(.*\\)" visible-string)
725 ;; The visible string contains both matching and
726 ;; non-matching authors.
727 (setq visible-string (notmuch-search-author-propertize visible-string)
728 ;; The invisible string must contain only non-matching
729 ;; authors, as the visible-string contains both.
730 invisible-string (propertize invisible-string
731 'face 'notmuch-search-non-matching-authors))
732 ;; The visible string contains only matching authors.
733 (setq visible-string (propertize visible-string
734 'face 'notmuch-search-matching-authors)
735 ;; The invisible string may contain both matching and
736 ;; non-matching authors.
737 invisible-string (notmuch-search-author-propertize invisible-string)))
739 ;; If there is any invisible text, add it as a tooltip to the
741 (when (not (string= invisible-string ""))
742 (setq visible-string (propertize visible-string 'help-echo (concat "..." invisible-string))))
744 ;; Insert the visible and, if present, invisible author strings.
745 (insert visible-string)
746 (when (not (string= invisible-string ""))
747 (let ((start (point))
749 (insert invisible-string)
750 (setq overlay (make-overlay start (point)))
751 (overlay-put overlay 'invisible 'ellipsis)
752 (overlay-put overlay 'isearch-open-invisible #'delete-overlay)))
755 (defun notmuch-search-insert-field (field format-string result)
757 ((string-equal field "date")
758 (insert (propertize (format format-string (plist-get result :date_relative))
759 'face 'notmuch-search-date)))
760 ((string-equal field "count")
761 (insert (propertize (format format-string
762 (format "[%s/%s]" (plist-get result :matched)
763 (plist-get result :total)))
764 'face 'notmuch-search-count)))
765 ((string-equal field "subject")
766 (insert (propertize (format format-string
767 (notmuch-sanitize (plist-get result :subject)))
768 'face 'notmuch-search-subject)))
770 ((string-equal field "authors")
771 (notmuch-search-insert-authors
772 format-string (notmuch-sanitize (plist-get result :authors))))
774 ((string-equal field "tags")
775 (let ((tags (plist-get result :tags))
776 (orig-tags (plist-get result :orig-tags)))
777 (insert (format format-string (notmuch-tag-format-tags tags orig-tags)))))))
779 (defun notmuch-search-show-result (result pos)
780 "Insert RESULT at POS."
781 ;; Ignore excluded matches
782 (unless (= (plist-get result :matched) 0)
785 (dolist (spec notmuch-search-result-format)
786 (notmuch-search-insert-field (car spec) (cdr spec) result))
788 (notmuch-search-color-line pos (point) (plist-get result :tags))
789 (put-text-property pos (point) 'notmuch-search-result result))))
791 (defun notmuch-search-append-result (result)
792 "Insert RESULT at the end of the buffer.
794 This is only called when a result is first inserted so it also
795 sets the :orig-tag property."
796 (let ((new-result (plist-put result :orig-tags (plist-get result :tags)))
798 (notmuch-search-show-result new-result pos)
799 (when (string= (plist-get result :thread) notmuch-search-target-thread)
800 (setq notmuch-search-target-thread "found")
803 (defun notmuch-search-process-filter (proc string)
804 "Process and filter the output of \"notmuch search\""
805 (let ((results-buf (process-buffer proc))
806 (parse-buf (process-get proc 'parse-buf))
807 (inhibit-read-only t)
809 (when (buffer-live-p results-buf)
810 (with-current-buffer parse-buf
813 (goto-char (point-max))
815 (notmuch-sexp-parse-partial-list 'notmuch-search-append-result
818 (defun notmuch-search-tag-all (tag-changes)
819 "Add/remove tags from all messages in current search buffer.
821 See `notmuch-tag' for information on the format of TAG-CHANGES."
823 (list (notmuch-read-tag-changes
824 (notmuch-search-get-tags-region (point-min) (point-max)) "Tag all")))
825 (notmuch-search-tag tag-changes (point-min) (point-max) t))
827 (defun notmuch-search-buffer-title (query)
828 "Returns the title for a buffer with notmuch search results."
832 (loop for tuple in notmuch-saved-searches
833 if (let ((quoted-query (regexp-quote (notmuch-saved-search-get tuple :query))))
834 (and (string-match (concat "^" quoted-query) query)
835 (> (length (match-string 0 query))
837 do (setq longest tuple))
839 (saved-search-name (notmuch-saved-search-get saved-search :name))
840 (saved-search-query (notmuch-saved-search-get saved-search :query)))
841 (cond ((and saved-search (equal saved-search-query query))
842 ;; Query is the same as saved search (ignoring case)
843 (concat "*notmuch-saved-search-" saved-search-name "*"))
845 (concat "*notmuch-search-"
846 (replace-regexp-in-string (concat "^" (regexp-quote saved-search-query))
847 (concat "[ " saved-search-name " ]")
851 (concat "*notmuch-search-" query "*"))
854 (defun notmuch-read-query (prompt)
855 "Read a notmuch-query from the minibuffer with completion.
857 PROMPT is the string to prompt with."
860 (append (list "folder:" "path:" "thread:" "id:" "date:" "from:" "to:"
861 "subject:" "attachment:" "mimetype:")
862 (mapcar (lambda (tag)
863 (concat "tag:" (notmuch-escape-boolean-term tag)))
864 (process-lines notmuch-command "search" "--output=tags" "*")))))
865 (let ((keymap (copy-keymap minibuffer-local-map))
866 (current-query (case major-mode
867 (notmuch-search-mode (notmuch-search-get-query))
868 (notmuch-show-mode (notmuch-show-get-query))
869 (notmuch-tree-mode (notmuch-tree-get-query))))
870 (minibuffer-completion-table
871 (completion-table-dynamic
873 ;; generate a list of possible completions for the current input
875 ;; this ugly regexp is used to get the last word of the input
876 ;; possibly preceded by a '('
877 ((string-match "\\(^\\|.* (?\\)\\([^ ]*\\)$" string)
878 (mapcar (lambda (compl)
879 (concat (match-string-no-properties 1 string) compl))
880 (all-completions (match-string-no-properties 2 string)
882 (t (list string)))))))
883 ;; this was simpler than convincing completing-read to accept spaces:
884 (define-key keymap (kbd "TAB") 'minibuffer-complete)
885 (let ((history-delete-duplicates t))
886 (read-from-minibuffer prompt nil keymap nil
887 'notmuch-search-history current-query nil)))))
889 (defun notmuch-search-get-query ()
890 "Return the current query in this search buffer"
891 notmuch-search-query-string)
894 (put 'notmuch-search 'notmuch-doc "Search for messages.")
895 (defun notmuch-search (&optional query oldest-first target-thread target-line)
896 "Display threads matching QUERY in a notmuch-search buffer.
898 If QUERY is nil, it is read interactively from the minibuffer.
899 Other optional parameters are used as follows:
901 OLDEST-FIRST: A Boolean controlling the sort order of returned threads
902 TARGET-THREAD: A thread ID (without the thread: prefix) that will be made
903 current if it appears in the search results.
904 TARGET-LINE: The line number to move to if the target thread does not
905 appear in the search results.
907 When called interactively, this will prompt for a query and use
908 the configured default sort order."
911 ;; Prompt for a query
913 ;; Use the default search order (if we're doing a search from a
914 ;; search buffer, ignore any buffer-local overrides)
915 (default-value 'notmuch-search-oldest-first)))
917 (let* ((query (or query (notmuch-read-query "Notmuch search: ")))
918 (buffer (get-buffer-create (notmuch-search-buffer-title query))))
919 (switch-to-buffer buffer)
920 (notmuch-search-mode)
921 ;; Don't track undo information for this buffer
922 (set 'buffer-undo-list t)
923 (set 'notmuch-search-query-string query)
924 (set 'notmuch-search-oldest-first oldest-first)
925 (set 'notmuch-search-target-thread target-thread)
926 (set 'notmuch-search-target-line target-line)
927 (notmuch-tag-clear-cache)
928 (let ((proc (get-buffer-process (current-buffer)))
929 (inhibit-read-only t))
931 (error "notmuch search process already running for query `%s'" query)
934 (goto-char (point-min))
936 (let ((proc (notmuch-start-notmuch
937 "notmuch-search" buffer #'notmuch-search-process-sentinel
938 "search" "--format=sexp" "--format-version=2"
940 "--sort=oldest-first"
941 "--sort=newest-first")
943 ;; Use a scratch buffer to accumulate partial output.
944 ;; This buffer will be killed by the sentinel, which
945 ;; should be called no matter how the process dies.
946 (parse-buf (generate-new-buffer " *notmuch search parse*")))
947 (process-put proc 'parse-buf parse-buf)
948 (set-process-filter proc 'notmuch-search-process-filter)
949 (set-process-query-on-exit-flag proc nil))))
950 (run-hooks 'notmuch-search-hook)))
952 (defun notmuch-search-refresh-view ()
953 "Refresh the current view.
955 Kills the current buffer and runs a new search with the same
956 query string as the current search. If the current thread is in
957 the new search results, then point will be placed on the same
958 thread. Otherwise, point will be moved to attempt to be in the
959 same relative position within the new buffer."
960 (let ((target-line (line-number-at-pos))
961 (oldest-first notmuch-search-oldest-first)
962 (target-thread (notmuch-search-find-thread-id 'bare))
963 (query notmuch-search-query-string))
964 (notmuch-bury-or-kill-this-buffer)
965 (notmuch-search query oldest-first target-thread target-line)
966 (goto-char (point-min))))
968 (defun notmuch-search-toggle-order ()
969 "Toggle the current search order.
971 This command toggles the sort order for the current search. The
972 default sort order is defined by `notmuch-search-oldest-first'."
974 (set 'notmuch-search-oldest-first (not notmuch-search-oldest-first))
975 (notmuch-search-refresh-view))
977 (defun notmuch-search-filter (query)
978 "Filter the current search results based on an additional query string.
980 Runs a new search matching only messages that match both the
981 current search results AND the additional query string provided."
982 (interactive (list (notmuch-read-query "Filter search: ")))
983 (let ((grouped-query (if (string-match-p notmuch-search-disjunctive-regexp query)
984 (concat "( " query " )")
986 (notmuch-search (if (string= notmuch-search-query-string "*")
988 (concat notmuch-search-query-string " and " grouped-query)) notmuch-search-oldest-first)))
990 (defun notmuch-search-filter-by-tag (tag)
991 "Filter the current search results based on a single tag.
993 Runs a new search matching only messages that match both the
994 current search results AND that are tagged with the given tag."
996 (list (notmuch-select-tag-with-completion "Filter by tag: ")))
997 (notmuch-search (concat notmuch-search-query-string " and tag:" tag) notmuch-search-oldest-first))
1001 "Run notmuch and display saved searches, known tags, etc."
1005 (defun notmuch-interesting-buffer (b)
1006 "Is the current buffer of interest to a notmuch user?"
1007 (with-current-buffer b
1008 (memq major-mode '(notmuch-show-mode
1014 (defun notmuch-cycle-notmuch-buffers ()
1015 "Cycle through any existing notmuch buffers (search, show or hello).
1017 If the current buffer is the only notmuch buffer, bury it. If no
1018 notmuch buffers exist, run `notmuch'."
1022 ;; If the current buffer is a notmuch buffer, remember it and then
1024 (when (notmuch-interesting-buffer (current-buffer))
1025 (setq start (current-buffer))
1028 ;; Find the first notmuch buffer.
1029 (setq first (loop for buffer in (buffer-list)
1030 if (notmuch-interesting-buffer buffer)
1034 ;; If the first one we found is any other than the starting
1035 ;; buffer, switch to it.
1036 (unless (eq first start)
1037 (switch-to-buffer first))
1040 (setq mail-user-agent 'notmuch-user-agent)
1044 ;; After provide to avoid loops if notmuch was require'd via notmuch-init-file.
1045 (if init-file-user ; don't load init file if the -q option was used.
1046 (let ((init-file (locate-file notmuch-init-file '("/")
1047 (get-load-suffixes))))
1048 (if init-file (load init-file nil t t))))