1 ;;; notmuch.el --- run notmuch within emacs -*- lexical-binding: t -*-
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 <https://www.gnu.org/licenses/>.
20 ;; Authors: Carl Worth <cworth@cworth.org>
21 ;; Homepage: https://notmuchmail.org
25 ;; This is an emacs-based interface to the notmuch mail system.
27 ;; You will first need to have the notmuch program installed and have a
28 ;; notmuch database built in order to use this. See
29 ;; https://notmuchmail.org for details.
31 ;; To install this software, copy it to a directory that is on the
32 ;; `load-path' variable within emacs (a good candidate is
33 ;; /usr/local/share/emacs/site-lisp). If you are viewing this from the
34 ;; notmuch source distribution then you can simply run:
36 ;; sudo make install-emacs
40 ;; Then, to actually run it, add:
42 ;; (autoload 'notmuch "notmuch" "Notmuch mail" t)
44 ;; to your ~/.emacs file, and then run "M-x notmuch" from within emacs,
49 ;; Have fun, and let us know if you have any comment, questions, or
50 ;; kudos: Notmuch list <notmuch@notmuchmail.org> (subscription is not
51 ;; required, but is available from https://notmuchmail.org).
53 ;; Note for MELPA users (and others tracking the development version
56 ;; This emacs package needs a fairly closely matched version of the
57 ;; notmuch program. If you use the MELPA version of notmuch.el (as
58 ;; opposed to MELPA stable), you should be prepared to track the
59 ;; master development branch (i.e. build from git) for the notmuch
60 ;; program as well. Upgrading notmuch-emacs too far beyond the notmuch
61 ;; program can CAUSE YOUR EMAIL TO STOP WORKING.
63 ;; TL;DR: notmuch-emacs from MELPA and notmuch from distro packages is
68 (eval-when-compile (require 'cl-lib))
75 (require 'notmuch-lib)
76 (require 'notmuch-tag)
77 (require 'notmuch-show)
78 (require 'notmuch-tree)
79 (require 'notmuch-mua)
80 (require 'notmuch-hello)
81 (require 'notmuch-maildir-fcc)
82 (require 'notmuch-message)
83 (require 'notmuch-parser)
87 (defcustom notmuch-search-result-format
90 ("authors" . "%-20s ")
93 "Search result formatting. Supported fields are:
94 date, count, authors, subject, tags
96 (setq notmuch-search-result-format \(\(\"authors\" . \"%-40s\"\)
97 \(\"subject\" . \"%s\"\)\)\)
98 Line breaks are permitted in format strings (though this is
99 currently experimental). Note that a line break at the end of an
100 \"authors\" field will get elided if the authors list is long;
101 place it instead at the beginning of the following field. To
102 enter a line break when setting this variable with setq, use \\n.
103 To enter a line break in customize, press \\[quoted-insert] C-j."
104 :type '(alist :key-type (string) :value-type (string))
105 :group 'notmuch-search)
107 ;; The name of this variable `notmuch-init-file' is consistent with the
108 ;; convention used in e.g. emacs and gnus. The value, `notmuch-config[.el[c]]'
109 ;; is consistent with notmuch cli configuration file `~/.notmuch-config'.
110 (defcustom notmuch-init-file (locate-user-emacs-file "notmuch-config")
111 "Your Notmuch Emacs-Lisp configuration file name.
112 If a file with one of the suffixes defined by `get-load-suffixes' exists,
113 it will be read instead.
114 This file is read once when notmuch is loaded; the notmuch hooks added
115 there will be called at other points of notmuch execution."
119 (defcustom notmuch-search-hook '(notmuch-hl-line-mode)
120 "List of functions to call when notmuch displays the search results."
122 :options '(notmuch-hl-line-mode)
123 :group 'notmuch-search
124 :group 'notmuch-hooks)
128 (defun notmuch-foreach-mime-part (function mm-handle)
129 (cond ((stringp (car mm-handle))
130 (dolist (part (cdr mm-handle))
131 (notmuch-foreach-mime-part function part)))
132 ((bufferp (car mm-handle))
133 (funcall function mm-handle))
134 (t (dolist (part mm-handle)
135 (notmuch-foreach-mime-part function part)))))
137 (defun notmuch-count-attachments (mm-handle)
139 (notmuch-foreach-mime-part
141 (let ((disposition (mm-handle-disposition p)))
142 (and (listp disposition)
143 (or (equal (car disposition) "attachment")
144 (and (equal (car disposition) "inline")
145 (assq 'filename disposition)))
150 (defun notmuch-save-attachments (mm-handle &optional queryp)
151 (notmuch-foreach-mime-part
153 (let ((disposition (mm-handle-disposition p)))
154 (and (listp disposition)
155 (or (equal (car disposition) "attachment")
156 (and (equal (car disposition) "inline")
157 (assq 'filename disposition)))
160 (concat "Save '" (cdr (assq 'filename disposition)) "' ")))
166 (defvar notmuch-search-mode-map
167 (let ((map (make-sparse-keymap)))
168 (set-keymap-parent map notmuch-common-keymap)
169 (define-key map "x" 'notmuch-bury-or-kill-this-buffer)
170 (define-key map (kbd "DEL") 'notmuch-search-scroll-down)
171 (define-key map "b" 'notmuch-search-scroll-down)
172 (define-key map " " 'notmuch-search-scroll-up)
173 (define-key map "<" 'notmuch-search-first-thread)
174 (define-key map ">" 'notmuch-search-last-thread)
175 (define-key map "p" 'notmuch-search-previous-thread)
176 (define-key map "n" 'notmuch-search-next-thread)
177 (define-key map "r" 'notmuch-search-reply-to-thread-sender)
178 (define-key map "R" 'notmuch-search-reply-to-thread)
179 (define-key map "o" 'notmuch-search-toggle-order)
180 (define-key map "c" 'notmuch-search-stash-map)
181 (define-key map "t" 'notmuch-search-filter-by-tag)
182 (define-key map "l" 'notmuch-search-filter)
183 (define-key map [mouse-1] 'notmuch-search-show-thread)
184 (define-key map "k" 'notmuch-tag-jump)
185 (define-key map "*" 'notmuch-search-tag-all)
186 (define-key map "a" 'notmuch-search-archive-thread)
187 (define-key map "-" 'notmuch-search-remove-tag)
188 (define-key map "+" 'notmuch-search-add-tag)
189 (define-key map (kbd "RET") 'notmuch-search-show-thread)
190 (define-key map (kbd "M-RET") 'notmuch-tree-from-search-thread)
191 (define-key map "Z" 'notmuch-tree-from-search-current-query)
192 (define-key map "U" 'notmuch-unthreaded-from-search-current-query)
194 "Keymap for \"notmuch search\" buffers.")
196 ;;; Internal Variables
198 (defvar notmuch-query-history nil
199 "Variable to store minibuffer history for notmuch queries.")
201 (defvar-local notmuch-search-query-string nil)
202 (defvar-local notmuch-search-target-thread nil)
203 (defvar-local notmuch-search-target-line nil)
207 (defvar notmuch-search-stash-map
208 (let ((map (make-sparse-keymap)))
209 (define-key map "i" 'notmuch-search-stash-thread-id)
210 (define-key map "q" 'notmuch-stash-query)
211 (define-key map "?" 'notmuch-subkeymap-help)
213 "Submap for stash commands.")
214 (fset 'notmuch-search-stash-map notmuch-search-stash-map)
216 (defun notmuch-search-stash-thread-id ()
217 "Copy thread ID of current thread to kill-ring."
219 (notmuch-common-do-stash (notmuch-search-find-thread-id)))
221 (defun notmuch-stash-query ()
222 "Copy current query to kill-ring."
224 (notmuch-common-do-stash notmuch-search-query-string))
228 (defun notmuch-search-scroll-up ()
229 "Move forward through search results by one window's worth."
233 ((end-of-buffer) (notmuch-search-last-thread))))
235 (defun notmuch-search-scroll-down ()
236 "Move backward through the search results by one window's worth."
238 ;; I don't know why scroll-down doesn't signal beginning-of-buffer
239 ;; the way that scroll-up signals end-of-buffer, but c'est la vie.
241 ;; So instead of trapping a signal we instead check whether the
242 ;; window begins on the first line of the buffer and if so, move
243 ;; directly to that position. (We have to count lines since the
244 ;; window-start position is not the same as point-min due to the
245 ;; invisible thread-ID characters on the first line.
246 (if (equal (count-lines (point-min) (window-start)) 0)
247 (goto-char (point-min))
250 (defun notmuch-search-next-thread ()
251 "Select the next thread in the search results."
253 (when (notmuch-search-get-result)
254 (goto-char (notmuch-search-result-end))))
256 (defun notmuch-search-previous-thread ()
257 "Select the previous thread in the search results."
259 (if (notmuch-search-get-result)
261 (goto-char (notmuch-search-result-beginning (- (point) 1))))
262 ;; We must be past the end; jump to the last result
263 (notmuch-search-last-thread)))
265 (defun notmuch-search-last-thread ()
266 "Select the last thread in the search results."
268 (goto-char (point-max))
270 (let ((beg (notmuch-search-result-beginning)))
274 (defun notmuch-search-first-thread ()
275 "Select the first thread in the search results."
277 (goto-char (point-min)))
281 (defface notmuch-message-summary-face
282 `((((class color) (background light))
283 ,@(and (>= emacs-major-version 27) '(:extend t))
284 :background "#f0f0f0")
285 (((class color) (background dark))
286 ,@(and (>= emacs-major-version 27) '(:extend t))
287 :background "#303030"))
288 "Face for the single-line message summary in notmuch-show-mode."
290 :group 'notmuch-faces)
292 (defface notmuch-search-date
293 '((t :inherit default))
294 "Face used in search mode for dates."
295 :group 'notmuch-search
296 :group 'notmuch-faces)
298 (defface notmuch-search-count
299 '((t :inherit default))
300 "Face used in search mode for the count matching the query."
301 :group 'notmuch-search
302 :group 'notmuch-faces)
304 (defface notmuch-search-subject
305 '((t :inherit default))
306 "Face used in search mode for subjects."
307 :group 'notmuch-search
308 :group 'notmuch-faces)
310 (defface notmuch-search-matching-authors
311 '((t :inherit default))
312 "Face used in search mode for authors matching the query."
313 :group 'notmuch-search
314 :group 'notmuch-faces)
316 (defface notmuch-search-non-matching-authors
319 (:foreground "grey30"))
322 (:foreground "grey60"))
325 "Face used in search mode for authors not matching the query."
326 :group 'notmuch-search
327 :group 'notmuch-faces)
329 (defface notmuch-tag-face
332 (:foreground "OliveDrab1"))
335 (:foreground "navy blue" :bold t))
338 "Face used in search mode face for tags."
339 :group 'notmuch-search
340 :group 'notmuch-faces)
342 (defface notmuch-search-flagged-face
345 (:foreground "LightBlue1"))
348 (:foreground "blue")))
349 "Face used in search mode face for flagged threads.
351 This face is the default value for the \"flagged\" tag in
352 `notmuch-search-line-faces'."
353 :group 'notmuch-search
354 :group 'notmuch-faces)
356 (defface notmuch-search-unread-face
359 "Face used in search mode for unread threads.
361 This face is the default value for the \"unread\" tag in
362 `notmuch-search-line-faces'."
363 :group 'notmuch-search
364 :group 'notmuch-faces)
368 (define-derived-mode notmuch-search-mode fundamental-mode "notmuch-search"
369 "Major mode displaying results of a notmuch search.
371 This buffer contains the results of a \"notmuch search\" of your
372 email archives. Each line in the buffer represents a single
373 thread giving a summary of the thread (a relative date, the
374 number of matched messages and total messages in the thread,
375 participants in the thread, a representative subject line, and
378 Pressing \\[notmuch-search-show-thread] on any line displays that
379 thread. The '\\[notmuch-search-add-tag]' and
380 '\\[notmuch-search-remove-tag]' keys can be used to add or remove
381 tags from a thread. The '\\[notmuch-search-archive-thread]' key
382 is a convenience for archiving a thread (applying changes in
383 `notmuch-archive-tags'). The '\\[notmuch-search-tag-all]' key can
384 be used to add and/or remove tags from all messages (as opposed
385 to threads) that match the current query. Use with caution, as
386 this will also tag matching messages that arrived *after*
387 constructing the buffer.
389 Other useful commands are '\\[notmuch-search-filter]' for
390 filtering the current search based on an additional query string,
391 '\\[notmuch-search-filter-by-tag]' for filtering to include only
392 messages with a given tag, and '\\[notmuch-search]' to execute a
395 Complete list of currently available key bindings:
397 \\{notmuch-search-mode-map}"
398 (setq notmuch-buffer-refresh-function #'notmuch-search-refresh-view)
399 (setq-local scroll-preserve-screen-position t)
400 (add-to-invisibility-spec (cons 'ellipsis t))
401 (setq truncate-lines t)
402 (setq buffer-read-only t)
403 (setq imenu-prev-index-position-function
404 #'notmuch-search-imenu-prev-index-position-function)
405 (setq imenu-extract-index-name-function
406 #'notmuch-search-imenu-extract-index-name-function))
410 (defun notmuch-search-get-result (&optional pos)
411 "Return the result object for the thread at POS (or point).
413 If there is no thread at POS (or point), returns nil."
414 (get-text-property (or pos (point)) 'notmuch-search-result))
416 (defun notmuch-search-result-beginning (&optional pos)
417 "Return the point at the beginning of the thread at POS (or point).
419 If there is no thread at POS (or point), returns nil."
420 (and (notmuch-search-get-result pos)
421 ;; We pass 1+point because previous-single-property-change starts
422 ;; searching one before the position we give it.
423 (previous-single-property-change (1+ (or pos (point)))
424 'notmuch-search-result nil
427 (defun notmuch-search-result-end (&optional pos)
428 "Return the point at the end of the thread at POS (or point).
430 The returned point will be just after the newline character that
431 ends the result line. If there is no thread at POS (or point),
433 (and (notmuch-search-get-result pos)
434 (next-single-property-change (or pos (point))
435 'notmuch-search-result nil
438 (defun notmuch-search-foreach-result (beg end fn)
439 "Invoke FN for each result between BEG and END.
441 FN should take one argument. It will be applied to the character
442 position of the beginning of each result that overlaps the region
443 between points BEG and END. As a special case, if (= BEG END),
444 FN will be applied to the result containing point BEG."
445 (let ((pos (notmuch-search-result-beginning beg))
446 ;; End must be a marker in case fn changes the
448 (end (copy-marker end))
449 ;; Make sure we examine at least one result, even if
452 ;; We have to be careful if the region extends beyond the results.
453 ;; In this case, pos could be null or there could be no result at
455 (while (and pos (or (< pos end) first))
456 (when (notmuch-search-get-result pos)
458 (setq pos (notmuch-search-result-end pos))
460 ;; Unindent the function argument of notmuch-search-foreach-result so
461 ;; the indentation of callers doesn't get out of hand.
462 (put 'notmuch-search-foreach-result 'lisp-indent-function 2)
464 (defun notmuch-search-properties-in-region (property beg end)
466 (notmuch-search-foreach-result beg end
468 (push (plist-get (notmuch-search-get-result pos) property) output)))
471 (defun notmuch-search-find-thread-id (&optional bare)
472 "Return the thread for the current thread.
474 If BARE is set then do not prefix with \"thread:\"."
475 (let ((thread (plist-get (notmuch-search-get-result) :thread)))
477 (concat (and (not bare) "thread:") thread))))
479 (defun notmuch-search-find-stable-query ()
480 "Return the stable queries for the current thread.
482 Return a list (MATCHED-QUERY UNMATCHED-QUERY) for the
483 matched and unmatched messages in the current thread."
484 (plist-get (notmuch-search-get-result) :query))
486 (defun notmuch-search-find-stable-query-region (beg end &optional only-matched)
487 "Return the stable query for the current region.
489 If ONLY-MATCHED is non-nil, include only matched messages. If it
490 is nil, include both matched and unmatched messages. If there are
491 no messages in the region then return nil."
492 (let ((query-list nil) (all (not only-matched)))
493 (dolist (queries (notmuch-search-properties-in-region :query beg end))
495 (push (car queries) query-list))
496 (when (and all (cadr queries))
497 (push (cadr queries) query-list)))
499 (concat "(" (mapconcat 'identity query-list ") or (") ")"))))
501 (defun notmuch-search-find-authors ()
502 "Return the authors for the current thread."
503 (plist-get (notmuch-search-get-result) :authors))
505 (defun notmuch-search-find-authors-region (beg end)
506 "Return a list of authors for the current region."
507 (notmuch-search-properties-in-region :authors beg end))
509 (defun notmuch-search-find-subject ()
510 "Return the subject for the current thread."
511 (plist-get (notmuch-search-get-result) :subject))
513 (defun notmuch-search-find-subject-region (beg end)
514 "Return a list of authors for the current region."
515 (notmuch-search-properties-in-region :subject beg end))
517 (defun notmuch-search-show-thread (&optional elide-toggle)
518 "Display the currently selected thread.
520 With a prefix argument, invert the default value of
521 `notmuch-show-only-matching-messages' when displaying the
524 (let ((thread-id (notmuch-search-find-thread-id)))
526 (notmuch-show thread-id
529 notmuch-search-query-string
530 ;; Name the buffer based on the subject.
531 (format "*%s*" (truncate-string-to-width
532 (notmuch-search-find-subject)
534 (message "End of search results."))))
536 (defun notmuch-tree-from-search-current-query ()
537 "Call notmuch tree with the current query."
539 (notmuch-tree notmuch-search-query-string))
541 (defun notmuch-unthreaded-from-search-current-query ()
542 "Call notmuch tree with the current query."
544 (notmuch-unthreaded notmuch-search-query-string))
546 (defun notmuch-tree-from-search-thread ()
547 "Show the selected thread with notmuch-tree."
549 (notmuch-tree (notmuch-search-find-thread-id)
550 notmuch-search-query-string
552 (notmuch-prettify-subject (notmuch-search-find-subject))
553 t nil (current-buffer)))
555 (defun notmuch-search-reply-to-thread (&optional prompt-for-sender)
556 "Begin composing a reply-all to the entire current thread in a new buffer."
558 (notmuch-mua-new-reply (notmuch-search-find-thread-id)
559 prompt-for-sender t))
561 (defun notmuch-search-reply-to-thread-sender (&optional prompt-for-sender)
562 "Begin composing a reply to the entire current thread in a new buffer."
564 (notmuch-mua-new-reply (notmuch-search-find-thread-id)
565 prompt-for-sender nil))
569 (defun notmuch-search-set-tags (tags &optional pos)
570 (notmuch-search-update-result
571 (plist-put (notmuch-search-get-result pos) :tags tags)
574 (defun notmuch-search-get-tags (&optional pos)
575 (plist-get (notmuch-search-get-result pos) :tags))
577 (defun notmuch-search-get-tags-region (beg end)
579 (notmuch-search-foreach-result beg end
581 (setq output (append output (notmuch-search-get-tags pos)))))
584 (defun notmuch-search-interactive-tag-changes (&optional initial-input)
585 "Prompt for tag changes for the current thread or region.
587 Return (TAG-CHANGES REGION-BEGIN REGION-END)."
588 (pcase-let ((`(,beg ,end) (notmuch-interactive-region)))
589 (list (notmuch-read-tag-changes (notmuch-search-get-tags-region beg end)
590 (if (= beg end) "Tag thread" "Tag region")
594 (defun notmuch-search-tag (tag-changes &optional beg end only-matched)
595 "Change tags for the currently selected thread or region.
597 See `notmuch-tag' for information on the format of TAG-CHANGES.
598 When called interactively, this uses the region if the region is
599 active. When called directly, BEG and END provide the region.
600 If these are nil or not provided, then, if the region is active
601 this applied to all threads meeting the region, and if the region
602 is inactive this applies to the thread at point.
604 If ONLY-MATCHED is non-nil, only tag matched messages."
605 (interactive (notmuch-search-interactive-tag-changes))
606 (unless (and beg end)
607 (setq beg (car (notmuch-interactive-region)))
608 (setq end (cadr (notmuch-interactive-region))))
609 (let ((search-string (notmuch-search-find-stable-query-region
610 beg end only-matched)))
611 (notmuch-tag search-string tag-changes)
612 (notmuch-search-foreach-result beg end
614 (notmuch-search-set-tags
615 (notmuch-update-tags (notmuch-search-get-tags pos) tag-changes)
618 (defun notmuch-search-add-tag (tag-changes &optional beg end)
619 "Change tags for the current thread or region (defaulting to add).
621 Same as `notmuch-search-tag' but sets initial input to '+'."
622 (interactive (notmuch-search-interactive-tag-changes "+"))
623 (notmuch-search-tag tag-changes beg end))
625 (defun notmuch-search-remove-tag (tag-changes &optional beg end)
626 "Change tags for the current thread or region (defaulting to remove).
628 Same as `notmuch-search-tag' but sets initial input to '-'."
629 (interactive (notmuch-search-interactive-tag-changes "-"))
630 (notmuch-search-tag tag-changes beg end))
632 (put 'notmuch-search-archive-thread 'notmuch-prefix-doc
633 "Un-archive the currently selected thread.")
634 (defun notmuch-search-archive-thread (&optional unarchive beg end)
635 "Archive the currently selected thread or region.
637 Archive each message in the currently selected thread by applying
638 the tag changes in `notmuch-archive-tags' to each (remove the
639 \"inbox\" tag by default). If a prefix argument is given, the
640 messages will be \"unarchived\" (i.e. the tag changes in
641 `notmuch-archive-tags' will be reversed).
643 This function advances the next thread when finished."
644 (interactive (cons current-prefix-arg (notmuch-interactive-region)))
645 (when notmuch-archive-tags
647 (notmuch-tag-change-list notmuch-archive-tags unarchive) beg end))
649 (notmuch-search-next-thread)))
653 (defun notmuch-search-update-result (result &optional pos)
654 "Replace the result object of the thread at POS (or point) by
655 RESULT and redraw it.
657 This will keep point in a reasonable location. However, if there
658 are enclosing save-excursions and the saved point is in the
659 result being updated, the point will be restored to the beginning
661 (let ((start (notmuch-search-result-beginning pos))
662 (end (notmuch-search-result-end pos))
664 (inhibit-read-only t))
665 ;; Delete the current thread
666 (delete-region start end)
667 ;; Insert the updated thread
668 (notmuch-search-show-result result start)
669 ;; If point was inside the old result, make an educated guess
670 ;; about where to place it now. Unfortunately, this won't work
671 ;; with save-excursion (or any other markers that would be nice to
672 ;; preserve, such as the window start), but there's nothing we can
673 ;; do about that without a way to retrieve markers in a region.
674 (when (and (>= init-point start) (<= init-point end))
675 (let* ((new-end (notmuch-search-result-end start))
676 (new-point (if (= init-point end)
678 (min init-point (- new-end 1)))))
679 (goto-char new-point)))))
681 (defun notmuch-search-process-sentinel (proc _msg)
682 "Add a message to let user know when \"notmuch search\" exits."
683 (let ((buffer (process-buffer proc))
684 (status (process-status proc))
685 (exit-status (process-exit-status proc))
686 (never-found-target-thread nil))
687 (when (memq status '(exit signal))
689 (kill-buffer (process-get proc 'parse-buf))
690 (when (buffer-live-p buffer)
691 (with-current-buffer buffer
693 (let ((inhibit-read-only t)
695 (goto-char (point-max))
696 (when (eq status 'signal)
697 (insert "Incomplete search results (search process was killed).\n"))
698 (when (eq status 'exit)
699 (insert "End of search results.\n")
700 ;; For version mismatch, there's no point in
701 ;; showing the search buffer
702 (when (or (= exit-status 20) (= exit-status 21))
706 (not (string= notmuch-search-target-thread "found")))
707 (setq never-found-target-thread t)))))
708 (when (and never-found-target-thread
709 notmuch-search-target-line)
710 (goto-char (point-min))
711 (forward-line (1- notmuch-search-target-line)))))))))
713 (define-widget 'notmuch--custom-face-edit 'lazy
714 "Custom face edit with a tag Edit Face"
715 ;; I could not persuage custom-face-edit to respect the :tag
716 ;; property so create a widget specially
717 :tag "Manually specify face"
718 :type 'custom-face-edit)
720 (defcustom notmuch-search-line-faces
721 '(("unread" . notmuch-search-unread-face)
722 ("flagged" . notmuch-search-flagged-face))
723 "Alist of tags to faces for line highlighting in notmuch-search.
724 Each element looks like (TAG . FACE).
725 A thread with TAG will have FACE applied.
727 Here is an example of how to color search results based on tags.
728 (the following text would be placed in your ~/.emacs file):
730 (setq notmuch-search-line-faces \\='((\"unread\" . (:foreground \"green\"))
731 (\"deleted\" . (:foreground \"red\"
732 :background \"blue\"))))
734 The FACE must be a face name (a symbol or string), a property
735 list of face attributes, or a list of these. The faces for
736 matching tags are merged, with earlier attributes overriding
737 later. A message having both \"deleted\" and \"unread\" tags with
738 the above settings would have a green foreground and blue
740 :type '(alist :key-type (string)
741 :value-type (radio (face :tag "Face name")
742 (notmuch--custom-face-edit)))
743 :group 'notmuch-search
744 :group 'notmuch-faces)
746 (defun notmuch-search-color-line (start end line-tag-list)
747 "Colorize lines in `notmuch-show' based on tags."
748 ;; Reverse the list so earlier entries take precedence
749 (dolist (elem (reverse notmuch-search-line-faces))
750 (let ((tag (car elem))
752 (when (member tag line-tag-list)
753 (notmuch-apply-face nil face nil start end)))))
755 (defun notmuch-search-author-propertize (authors)
756 "Split `authors' into matching and non-matching authors and
757 propertize appropriately. If no boundary between authors and
758 non-authors is found, assume that all of the authors match."
759 (if (string-match "\\(.*\\)|\\(.*\\)" authors)
760 (concat (propertize (concat (match-string 1 authors) ",")
761 'face 'notmuch-search-matching-authors)
762 (propertize (match-string 2 authors)
763 'face 'notmuch-search-non-matching-authors))
764 (propertize authors 'face 'notmuch-search-matching-authors)))
766 (defun notmuch-search-insert-authors (format-string authors)
767 ;; Save the match data to avoid interfering with
768 ;; `notmuch-search-process-filter'.
770 (let* ((formatted-authors (format format-string authors))
771 (formatted-sample (format format-string ""))
772 (visible-string formatted-authors)
773 (invisible-string "")
775 ;; Truncate the author string to fit the specification.
776 (when (> (length formatted-authors)
777 (length formatted-sample))
778 (let ((visible-length (- (length formatted-sample)
780 ;; Truncate the visible string according to the width of
781 ;; the display string.
782 (setq visible-string (substring formatted-authors 0 visible-length))
783 (setq invisible-string (substring formatted-authors visible-length))
784 ;; If possible, truncate the visible string at a natural
785 ;; break (comma or pipe), as incremental search doesn't
786 ;; match across the visible/invisible border.
787 (when (string-match "\\(.*\\)\\([,|] \\)\\([^,|]*\\)" visible-string)
788 ;; Second clause is destructive on `visible-string', so
789 ;; order is important.
790 (setq invisible-string (concat (match-string 3 visible-string)
792 (setq visible-string (concat (match-string 1 visible-string)
793 (match-string 2 visible-string))))
794 ;; `visible-string' may be shorter than the space allowed
795 ;; by `format-string'. If so we must insert some padding
796 ;; after `invisible-string'.
797 (setq padding (make-string (- (length formatted-sample)
798 (length visible-string)
801 ;; Use different faces to show matching and non-matching authors.
802 (if (string-match "\\(.*\\)|\\(.*\\)" visible-string)
803 ;; The visible string contains both matching and
804 ;; non-matching authors.
806 (setq visible-string (notmuch-search-author-propertize visible-string))
807 ;; The invisible string must contain only non-matching
808 ;; authors, as the visible-string contains both.
809 (setq invisible-string (propertize invisible-string
810 'face 'notmuch-search-non-matching-authors)))
811 ;; The visible string contains only matching authors.
812 (setq visible-string (propertize visible-string
813 'face 'notmuch-search-matching-authors))
814 ;; The invisible string may contain both matching and
815 ;; non-matching authors.
816 (setq invisible-string (notmuch-search-author-propertize invisible-string)))
817 ;; If there is any invisible text, add it as a tooltip to the
819 (unless (string= invisible-string "")
821 (propertize visible-string
822 'help-echo (concat "..." invisible-string))))
823 ;; Insert the visible and, if present, invisible author strings.
824 (insert visible-string)
825 (unless (string= invisible-string "")
826 (let ((start (point))
828 (insert invisible-string)
829 (setq overlay (make-overlay start (point)))
830 (overlay-put overlay 'invisible 'ellipsis)
831 (overlay-put overlay 'isearch-open-invisible #'delete-overlay)))
834 (defun notmuch-search-insert-field (field format-string result)
836 ((string-equal field "date")
837 (insert (propertize (format format-string (plist-get result :date_relative))
838 'face 'notmuch-search-date)))
839 ((string-equal field "count")
840 (insert (propertize (format format-string
841 (format "[%s/%s]" (plist-get result :matched)
842 (plist-get result :total)))
843 'face 'notmuch-search-count)))
844 ((string-equal field "subject")
845 (insert (propertize (format format-string
846 (notmuch-sanitize (plist-get result :subject)))
847 'face 'notmuch-search-subject)))
848 ((string-equal field "authors")
849 (notmuch-search-insert-authors
850 format-string (notmuch-sanitize (plist-get result :authors))))
851 ((string-equal field "tags")
852 (let ((tags (plist-get result :tags))
853 (orig-tags (plist-get result :orig-tags)))
854 (insert (format format-string (notmuch-tag-format-tags tags orig-tags)))))))
856 (defun notmuch-search-show-result (result pos)
857 "Insert RESULT at POS."
858 ;; Ignore excluded matches
859 (unless (= (plist-get result :matched) 0)
862 (dolist (spec notmuch-search-result-format)
863 (notmuch-search-insert-field (car spec) (cdr spec) result))
865 (notmuch-search-color-line pos (point) (plist-get result :tags))
866 (put-text-property pos (point) 'notmuch-search-result result))))
868 (defun notmuch-search-append-result (result)
869 "Insert RESULT at the end of the buffer.
871 This is only called when a result is first inserted so it also
872 sets the :orig-tag property."
873 (let ((new-result (plist-put result :orig-tags (plist-get result :tags)))
875 (notmuch-search-show-result new-result pos)
876 (when (string= (plist-get result :thread) notmuch-search-target-thread)
877 (setq notmuch-search-target-thread "found")
880 (defun notmuch-search-process-filter (proc string)
881 "Process and filter the output of \"notmuch search\"."
882 (let ((results-buf (process-buffer proc))
883 (parse-buf (process-get proc 'parse-buf))
884 (inhibit-read-only t))
885 (when (buffer-live-p results-buf)
886 (with-current-buffer parse-buf
889 (goto-char (point-max))
891 (notmuch-sexp-parse-partial-list 'notmuch-search-append-result
894 ;;; Commands (and some helper functions used by them)
896 (defun notmuch-search-tag-all (tag-changes)
897 "Add/remove tags from all messages in current search buffer.
899 See `notmuch-tag' for information on the format of TAG-CHANGES."
901 (list (notmuch-read-tag-changes
902 (notmuch-search-get-tags-region (point-min) (point-max)) "Tag all")))
903 (notmuch-search-tag tag-changes (point-min) (point-max) t))
905 (defun notmuch-search-buffer-title (query)
906 "Returns the title for a buffer with notmuch search results."
910 (cl-loop for tuple in notmuch-saved-searches
911 if (let ((quoted-query
913 (notmuch-saved-search-get tuple :query))))
914 (and (string-match (concat "^" quoted-query) query)
915 (> (length (match-string 0 query))
917 do (setq longest tuple))
919 (saved-search-name (notmuch-saved-search-get saved-search :name))
920 (saved-search-query (notmuch-saved-search-get saved-search :query)))
921 (cond ((and saved-search (equal saved-search-query query))
922 ;; Query is the same as saved search (ignoring case)
923 (concat "*notmuch-saved-search-" saved-search-name "*"))
925 (concat "*notmuch-search-"
926 (replace-regexp-in-string
927 (concat "^" (regexp-quote saved-search-query))
928 (concat "[ " saved-search-name " ]")
932 (concat "*notmuch-search-" query "*")))))
934 (defun notmuch-read-query (prompt)
935 "Read a notmuch-query from the minibuffer with completion.
937 PROMPT is the string to prompt with."
939 (mapcar (lambda (tag) (notmuch-escape-boolean-term tag))
940 (process-lines notmuch-command "search" "--output=tags" "*")))
942 (append (list "folder:" "path:" "thread:" "id:" "date:" "from:" "to:"
943 "subject:" "attachment:")
944 (mapcar (lambda (tag) (concat "tag:" tag)) all-tags)
945 (mapcar (lambda (tag) (concat "is:" tag)) all-tags)
946 (mapcar (lambda (mimetype) (concat "mimetype:" mimetype))
947 (mailcap-mime-types))))
948 (keymap (copy-keymap minibuffer-local-map))
949 (current-query (cl-case major-mode
950 (notmuch-search-mode (notmuch-search-get-query))
951 (notmuch-show-mode (notmuch-show-get-query))
952 (notmuch-tree-mode (notmuch-tree-get-query))))
953 (minibuffer-completion-table
954 (completion-table-dynamic
956 ;; Generate a list of possible completions for the current input.
958 ;; This ugly regexp is used to get the last word of the input
959 ;; possibly preceded by a '('.
960 ((string-match "\\(^\\|.* (?\\)\\([^ ]*\\)$" string)
961 (mapcar (lambda (compl)
962 (concat (match-string-no-properties 1 string) compl))
963 (all-completions (match-string-no-properties 2 string)
965 (t (list string)))))))
966 ;; This was simpler than convincing completing-read to accept spaces:
967 (define-key keymap (kbd "TAB") 'minibuffer-complete)
968 (let ((history-delete-duplicates t))
969 (read-from-minibuffer prompt nil keymap nil
970 'notmuch-search-history current-query nil))))
972 (defun notmuch-search-get-query ()
973 "Return the current query in this search buffer."
974 notmuch-search-query-string)
976 (put 'notmuch-search 'notmuch-doc "Search for messages.")
978 (defun notmuch-search (&optional query oldest-first target-thread target-line no-display)
979 "Display threads matching QUERY in a notmuch-search buffer.
981 If QUERY is nil, it is read interactively from the minibuffer.
982 Other optional parameters are used as follows:
984 OLDEST-FIRST: A Boolean controlling the sort order of returned threads
985 TARGET-THREAD: A thread ID (without the thread: prefix) that will be made
986 current if it appears in the search results.
987 TARGET-LINE: The line number to move to if the target thread does not
988 appear in the search results.
989 NO-DISPLAY: Do not try to foreground the search results buffer. If it is
990 already foregrounded i.e. displayed in a window, this has no
991 effect, meaning the buffer will remain visible.
993 When called interactively, this will prompt for a query and use
994 the configured default sort order."
997 ;; Prompt for a query
999 ;; Use the default search order (if we're doing a search from a
1000 ;; search buffer, ignore any buffer-local overrides)
1001 (default-value 'notmuch-search-oldest-first)))
1003 (let* ((query (or query (notmuch-read-query "Notmuch search: ")))
1004 (buffer (get-buffer-create (notmuch-search-buffer-title query))))
1007 (pop-to-buffer-same-window buffer))
1008 (notmuch-search-mode)
1009 ;; Don't track undo information for this buffer
1010 (setq buffer-undo-list t)
1011 (setq notmuch-search-query-string query)
1012 (setq notmuch-search-oldest-first oldest-first)
1013 (setq notmuch-search-target-thread target-thread)
1014 (setq notmuch-search-target-line target-line)
1015 (notmuch-tag-clear-cache)
1016 (when (get-buffer-process buffer)
1017 (error "notmuch search process already running for query `%s'" query))
1018 (let ((inhibit-read-only t))
1020 (goto-char (point-min))
1022 (let ((proc (notmuch-start-notmuch
1023 "notmuch-search" buffer #'notmuch-search-process-sentinel
1024 "search" "--format=sexp" "--format-version=4"
1026 "--sort=oldest-first"
1027 "--sort=newest-first")
1029 ;; Use a scratch buffer to accumulate partial output.
1030 ;; This buffer will be killed by the sentinel, which
1031 ;; should be called no matter how the process dies.
1032 (process-put proc 'parse-buf
1033 (generate-new-buffer " *notmuch search parse*"))
1034 (set-process-filter proc 'notmuch-search-process-filter)
1035 (set-process-query-on-exit-flag proc nil))))
1036 (run-hooks 'notmuch-search-hook)))
1038 (defun notmuch-search-refresh-view ()
1039 "Refresh the current view.
1041 Erases the current buffer and runs a new search with the same
1042 query string as the current search. If the current thread is in
1043 the new search results, then point will be placed on the same
1044 thread. Otherwise, point will be moved to attempt to be in the
1045 same relative position within the new buffer."
1047 (notmuch-search notmuch-search-query-string
1048 notmuch-search-oldest-first
1049 (notmuch-search-find-thread-id 'bare)
1050 (line-number-at-pos)
1052 (goto-char (point-min)))
1054 (defun notmuch-search-toggle-order ()
1055 "Toggle the current search order.
1057 This command toggles the sort order for the current search. The
1058 default sort order is defined by `notmuch-search-oldest-first'."
1060 (setq notmuch-search-oldest-first (not notmuch-search-oldest-first))
1061 (notmuch-search-refresh-view))
1063 (defun notmuch-group-disjunctive-query-string (query-string)
1064 "Group query if it contains a complex expression.
1065 Enclose QUERY-STRING in parentheses if contains \"OR\" operators."
1066 (if (string-match-p "\\<[oO][rR]\\>" query-string)
1067 (concat "( " query-string " )")
1070 (defun notmuch-search-filter (query)
1071 "Filter or LIMIT the current search results based on an additional query string.
1073 Runs a new search matching only messages that match both the
1074 current search results AND the additional query string provided."
1075 (interactive (list (notmuch-read-query "Filter search: ")))
1076 (let ((grouped-query (notmuch-group-disjunctive-query-string query))
1077 (grouped-original-query (notmuch-group-disjunctive-query-string
1078 notmuch-search-query-string)))
1079 (notmuch-search (if (string= grouped-original-query "*")
1081 (concat grouped-original-query " and " grouped-query))
1082 notmuch-search-oldest-first)))
1084 (defun notmuch-search-filter-by-tag (tag)
1085 "Filter the current search results based on a single TAG.
1087 Run a new search matching only messages that match the current
1088 search results and that are also tagged with the given TAG."
1090 (list (notmuch-select-tag-with-completion "Filter by tag: "
1091 notmuch-search-query-string)))
1092 (notmuch-search (concat notmuch-search-query-string " and tag:" tag)
1093 notmuch-search-oldest-first))
1095 (defun notmuch-search-by-tag (tag)
1096 "Display threads matching TAG in a notmuch-search buffer."
1098 (list (notmuch-select-tag-with-completion "Notmuch search tag: ")))
1099 (notmuch-search (concat "tag:" tag)))
1103 "Run notmuch and display saved searches, known tags, etc."
1107 (defun notmuch-interesting-buffer (b)
1108 "Whether the current buffer's major-mode is a notmuch mode."
1109 (with-current-buffer b
1110 (memq major-mode '(notmuch-show-mode
1114 notmuch-message-mode))))
1117 (defun notmuch-cycle-notmuch-buffers ()
1118 "Cycle through any existing notmuch buffers (search, show or hello).
1120 If the current buffer is the only notmuch buffer, bury it.
1121 If no notmuch buffers exist, run `notmuch'."
1124 ;; If the current buffer is a notmuch buffer, remember it and then
1126 (when (notmuch-interesting-buffer (current-buffer))
1127 (setq start (current-buffer))
1130 ;; Find the first notmuch buffer.
1131 (setq first (cl-loop for buffer in (buffer-list)
1132 if (notmuch-interesting-buffer buffer)
1136 ;; If the first one we found is any other than the starting
1137 ;; buffer, switch to it.
1138 (unless (eq first start)
1139 (pop-to-buffer-same-window first))
1143 ;;;; Hl-line Support
1145 (defun notmuch-hl-line-mode ()
1146 (prog1 (hl-line-mode)
1147 (when hl-line-overlay
1148 (overlay-put hl-line-overlay 'priority 1))))
1152 (defun notmuch-search-imenu-prev-index-position-function ()
1153 "Move point to previous message in notmuch-search buffer.
1154 Used as`imenu-prev-index-position-function' in notmuch buffers."
1155 (notmuch-search-previous-thread))
1157 (defun notmuch-search-imenu-extract-index-name-function ()
1158 "Return imenu name for line at point.
1159 Used as `imenu-extract-index-name-function' in notmuch buffers.
1160 Point should be at the beginning of the line."
1162 (notmuch-search-find-subject)
1163 (notmuch-search-find-authors)))
1167 (setq mail-user-agent 'notmuch-user-agent)
1171 ;; After provide to avoid loops if notmuch was require'd via notmuch-init-file.
1172 (when init-file-user ; don't load init file if the -q option was used.
1173 (load notmuch-init-file t t nil t))
1175 ;;; notmuch.el ends here