git.notmuchmail.org Git - notmuch/blob - emacs/notmuch.el

   1 ; notmuch.el --- run notmuch within emacs
   2 ;
   3 ; Copyright © Carl Worth
   4 ;
   5 ; This file is part of Notmuch.
   6 ;
   7 ; Notmuch is free software: you can redistribute it and/or modify it
   8 ; under the terms of the GNU General Public License as published by
   9 ; the Free Software Foundation, either version 3 of the License, or
  10 ; (at your option) any later version.
  11 ;
  12 ; Notmuch is distributed in the hope that it will be useful, but
  13 ; WITHOUT ANY WARRANTY; without even the implied warranty of
  14 ; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15 ; General Public License for more details.
  16 ;
  17 ; You should have received a copy of the GNU General Public License
  18 ; along with Notmuch.  If not, see <http://www.gnu.org/licenses/>.
  19 ;
  20 ; Authors: Carl Worth <cworth@cworth.org>
  21
  22 ; This is an emacs-based interface to the notmuch mail system.
  23 ;
  24 ; You will first need to have the notmuch program installed and have a
  25 ; notmuch database built in order to use this. See
  26 ; http://notmuchmail.org for details.
  27 ;
  28 ; To install this software, copy it to a directory that is on the
  29 ; `load-path' variable within emacs (a good candidate is
  30 ; /usr/local/share/emacs/site-lisp). If you are viewing this from the
  31 ; notmuch source distribution then you can simply run:
  32 ;
  33 ;       sudo make install-emacs
  34 ;
  35 ; to install it.
  36 ;
  37 ; Then, to actually run it, add:
  38 ;
  39 ;       (require 'notmuch)
  40 ;
  41 ; to your ~/.emacs file, and then run "M-x notmuch" from within emacs,
  42 ; or run:
  43 ;
  44 ;       emacs -f notmuch
  45 ;
  46 ; Have fun, and let us know if you have any comment, questions, or
  47 ; kudos: Notmuch list <notmuch@notmuchmail.org> (subscription is not
  48 ; required, but is available from http://notmuchmail.org).
  49
  50 (require 'cl)
  51 (require 'mm-view)
  52 (require 'message)
  53
  54 (require 'notmuch-lib)
  55 (require 'notmuch-show)
  56
  57 (defun notmuch-select-tag-with-completion (prompt &rest search-terms)
  58   (let ((tag-list
  59          (with-output-to-string
  60            (with-current-buffer standard-output
  61              (apply 'call-process notmuch-command nil t nil "search-tags" search-terms)))))
  62     (completing-read prompt (split-string tag-list "\n+" t) nil nil nil)))
  63
  64 (defun notmuch-foreach-mime-part (function mm-handle)
  65   (cond ((stringp (car mm-handle))
  66          (dolist (part (cdr mm-handle))
  67            (notmuch-foreach-mime-part function part)))
  68         ((bufferp (car mm-handle))
  69          (funcall function mm-handle))
  70         (t (dolist (part mm-handle)
  71              (notmuch-foreach-mime-part function part)))))
  72
  73 (defun notmuch-count-attachments (mm-handle)
  74   (let ((count 0))
  75     (notmuch-foreach-mime-part
  76      (lambda (p)
  77        (let ((disposition (mm-handle-disposition p)))
  78          (and (listp disposition)
  79               (or (equal (car disposition) "attachment")
  80                   (and (equal (car disposition) "inline")
  81                        (assq 'filename disposition)))
  82               (incf count))))
  83      mm-handle)
  84     count))
  85
  86 (defun notmuch-save-attachments (mm-handle &optional queryp)
  87   (notmuch-foreach-mime-part
  88    (lambda (p)
  89      (let ((disposition (mm-handle-disposition p)))
  90        (and (listp disposition)
  91             (or (equal (car disposition) "attachment")
  92                 (and (equal (car disposition) "inline")
  93                      (assq 'filename disposition)))
  94             (or (not queryp)
  95                 (y-or-n-p
  96                  (concat "Save '" (cdr (assq 'filename disposition)) "' ")))
  97             (mm-save-part p))))
  98    mm-handle))
  99
 100 (defun notmuch-reply (query-string)
 101   (switch-to-buffer (generate-new-buffer "notmuch-draft"))
 102   (call-process notmuch-command nil t nil "reply" query-string)
 103   (message-insert-signature)
 104   (goto-char (point-min))
 105   (if (re-search-forward "^$" nil t)
 106       (progn
 107         (insert "--text follows this line--")
 108         (forward-line)))
 109   (message-mode))
 110
 111 (defun notmuch-toggle-invisible-action (cite-button)
 112   (let ((invis-spec (button-get cite-button 'invisibility-spec)))
 113         (if (invisible-p invis-spec)
 114             (remove-from-invisibility-spec invis-spec)
 115           (add-to-invisibility-spec invis-spec)
 116           ))
 117   (force-window-update)
 118   (redisplay t))
 119
 120 (define-button-type 'notmuch-button-citation-toggle-type 'help-echo "mouse-1, RET: Show citation"
 121   :supertype 'notmuch-button-invisibility-toggle-type)
 122 (define-button-type 'notmuch-button-signature-toggle-type 'help-echo "mouse-1, RET: Show signature"
 123   :supertype 'notmuch-button-invisibility-toggle-type)
 124 (define-button-type 'notmuch-button-body-toggle-type
 125   'help-echo "mouse-1, RET: Show message"
 126   'face 'notmuch-message-summary-face
 127   :supertype 'notmuch-button-invisibility-toggle-type)
 128
 129 (defun notmuch-fontify-headers ()
 130   (while (looking-at "[[:space:]]")
 131     (forward-char))
 132   (if (looking-at "[Tt]o:")
 133       (progn
 134         (overlay-put (make-overlay (point) (re-search-forward ":"))
 135                      'face 'message-header-name)
 136         (overlay-put (make-overlay (point) (re-search-forward ".*$"))
 137                      'face 'message-header-to))
 138     (if (looking-at "[B]?[Cc][Cc]:")
 139         (progn
 140           (overlay-put (make-overlay (point) (re-search-forward ":"))
 141                        'face 'message-header-name)
 142           (overlay-put (make-overlay (point) (re-search-forward ".*$"))
 143                        'face 'message-header-cc))
 144       (if (looking-at "[Ss]ubject:")
 145           (progn
 146             (overlay-put (make-overlay (point) (re-search-forward ":"))
 147                          'face 'message-header-name)
 148             (overlay-put (make-overlay (point) (re-search-forward ".*$"))
 149                          'face 'message-header-subject))
 150         (if (looking-at "[Ff]rom:")
 151             (progn
 152               (overlay-put (make-overlay (point) (re-search-forward ":"))
 153                            'face 'message-header-name)
 154               (overlay-put (make-overlay (point) (re-search-forward ".*$"))
 155                            'face 'message-header-other))
 156           (if (looking-at "[Dd]ate:")
 157              (progn
 158                (overlay-put (make-overlay (point) (re-search-forward ":"))
 159                             'face 'message-header-name)
 160                (overlay-put (make-overlay (point) (re-search-forward ".*$"))
 161                             'face 'message-header-other))))))))
 162
 163 (defun notmuch-documentation-first-line (symbol)
 164   "Return the first line of the documentation string for SYMBOL."
 165   (let ((doc (documentation symbol)))
 166     (if doc
 167         (with-temp-buffer
 168           (insert (documentation symbol t))
 169           (goto-char (point-min))
 170           (let ((beg (point)))
 171             (end-of-line)
 172             (buffer-substring beg (point))))
 173       "")))
 174
 175 (defun notmuch-prefix-key-description (key)
 176   "Given a prefix key code, return a human-readable string representation.
 177
 178 This is basically just `format-kbd-macro' but we also convert ESC to M-."
 179   (let ((desc (format-kbd-macro (vector key))))
 180     (if (string= desc "ESC")
 181         "M-"
 182       (concat desc " "))))
 183
 184 ; I would think that emacs would have code handy for walking a keymap
 185 ; and generating strings for each key, and I would prefer to just call
 186 ; that. But I couldn't find any (could be all implemented in C I
 187 ; suppose), so I wrote my own here.
 188 (defun notmuch-substitute-one-command-key-with-prefix (prefix binding)
 189   "For a key binding, return a string showing a human-readable
 190 representation of the prefixed key as well as the first line of
 191 documentation from the bound function.
 192
 193 For a mouse binding, return nil."
 194   (let ((key (car binding))
 195         (action (cdr binding)))
 196     (if (mouse-event-p key)
 197         nil
 198       (if (keymapp action)
 199           (let ((substitute (apply-partially 'notmuch-substitute-one-command-key-with-prefix (notmuch-prefix-key-description key)))
 200                 (as-list))
 201             (map-keymap (lambda (a b)
 202                           (push (cons a b) as-list))
 203                         action)
 204             (mapconcat substitute as-list "\n"))
 205         (concat prefix (format-kbd-macro (vector key))
 206                 "\t"
 207                 (notmuch-documentation-first-line action))))))
 208
 209 (defalias 'notmuch-substitute-one-command-key
 210   (apply-partially 'notmuch-substitute-one-command-key-with-prefix nil))
 211
 212 (defun notmuch-substitute-command-keys (doc)
 213   "Like `substitute-command-keys' but with documentation, not function names."
 214   (let ((beg 0))
 215     (while (string-match "\\\\{\\([^}[:space:]]*\\)}" doc beg)
 216       (let ((map (substring doc (match-beginning 1) (match-end 1))))
 217         (setq doc (replace-match (mapconcat 'notmuch-substitute-one-command-key
 218                                             (cdr (symbol-value (intern map))) "\n") 1 1 doc)))
 219       (setq beg (match-end 0)))
 220     doc))
 221
 222 (defun notmuch-help ()
 223   "Display help for the current notmuch mode."
 224   (interactive)
 225   (let* ((mode major-mode)
 226          (doc (substitute-command-keys (notmuch-substitute-command-keys (documentation mode t)))))
 227     (with-current-buffer (generate-new-buffer "*notmuch-help*")
 228       (insert doc)
 229       (goto-char (point-min))
 230       (set-buffer-modified-p nil)
 231       (view-buffer (current-buffer) 'kill-buffer-if-not-modified))))
 232
 233 (defgroup notmuch nil
 234   "Notmuch mail reader for Emacs."
 235   :group 'mail)
 236
 237 (defcustom notmuch-search-hook nil
 238   "List of functions to call when notmuch displays the search results."
 239   :type 'hook
 240   :options '(hl-line-mode)
 241   :group 'notmuch)
 242
 243 (defvar notmuch-search-authors-width 20
 244   "Number of columns to use to display authors in a notmuch-search buffer.")
 245
 246 (defvar notmuch-search-mode-map
 247   (let ((map (make-sparse-keymap)))
 248     (define-key map "?" 'notmuch-help)
 249     (define-key map "q" 'kill-this-buffer)
 250     (define-key map "x" 'kill-this-buffer)
 251     (define-key map (kbd "<DEL>") 'notmuch-search-scroll-down)
 252     (define-key map "b" 'notmuch-search-scroll-down)
 253     (define-key map " " 'notmuch-search-scroll-up)
 254     (define-key map "<" 'notmuch-search-first-thread)
 255     (define-key map ">" 'notmuch-search-last-thread)
 256     (define-key map "p" 'notmuch-search-previous-thread)
 257     (define-key map "n" 'notmuch-search-next-thread)
 258     (define-key map "r" 'notmuch-search-reply-to-thread)
 259     (define-key map "m" 'message-mail)
 260     (define-key map "s" 'notmuch-search)
 261     (define-key map "o" 'notmuch-search-toggle-order)
 262     (define-key map "=" 'notmuch-search-refresh-view)
 263     (define-key map "t" 'notmuch-search-filter-by-tag)
 264     (define-key map "f" 'notmuch-search-filter)
 265     (define-key map [mouse-1] 'notmuch-search-show-thread)
 266     (define-key map "*" 'notmuch-search-operate-all)
 267     (define-key map "a" 'notmuch-search-archive-thread)
 268     (define-key map "-" 'notmuch-search-remove-tag)
 269     (define-key map "+" 'notmuch-search-add-tag)
 270     (define-key map (kbd "RET") 'notmuch-search-show-thread)
 271     map)
 272   "Keymap for \"notmuch search\" buffers.")
 273 (fset 'notmuch-search-mode-map notmuch-search-mode-map)
 274
 275 (defvar notmuch-search-query-string)
 276 (defvar notmuch-search-target-thread)
 277 (defvar notmuch-search-target-line)
 278 (defvar notmuch-search-oldest-first t
 279   "Show the oldest mail first in the search-mode")
 280
 281 (defvar notmuch-search-disjunctive-regexp      "\\<[oO][rR]\\>")
 282
 283 (defun notmuch-search-scroll-up ()
 284   "Move forward through search results by one window's worth."
 285   (interactive)
 286   (condition-case nil
 287       (scroll-up nil)
 288     ((end-of-buffer) (notmuch-search-last-thread))))
 289
 290 (defun notmuch-search-scroll-down ()
 291   "Move backward through the search results by one window's worth."
 292   (interactive)
 293   ; I don't know why scroll-down doesn't signal beginning-of-buffer
 294   ; the way that scroll-up signals end-of-buffer, but c'est la vie.
 295   ;
 296   ; So instead of trapping a signal we instead check whether the
 297   ; window begins on the first line of the buffer and if so, move
 298   ; directly to that position. (We have to count lines since the
 299   ; window-start position is not the same as point-min due to the
 300   ; invisible thread-ID characters on the first line.
 301   (if (equal (count-lines (point-min) (window-start)) 0)
 302       (goto-char (point-min))
 303     (scroll-down nil)))
 304
 305 (defun notmuch-search-next-thread ()
 306   "Select the next thread in the search results."
 307   (interactive)
 308   (forward-line 1))
 309
 310 (defun notmuch-search-previous-thread ()
 311   "Select the previous thread in the search results."
 312   (interactive)
 313   (forward-line -1))
 314
 315 (defun notmuch-search-last-thread ()
 316   "Select the last thread in the search results."
 317   (interactive)
 318   (goto-char (point-max))
 319   (forward-line -2))
 320
 321 (defun notmuch-search-first-thread ()
 322   "Select the first thread in the search results."
 323   (interactive)
 324   (goto-char (point-min)))
 325
 326 (defface notmuch-message-summary-face
 327  '((((class color) (background light)) (:background "#f0f0f0"))
 328    (((class color) (background dark)) (:background "#303030")))
 329  "Face for the single-line message summary in notmuch-show-mode."
 330  :group 'notmuch)
 331
 332 (defface notmuch-tag-face
 333   '((((class color)
 334       (background dark))
 335      (:foreground "OliveDrab1"))
 336     (((class color)
 337       (background light))
 338      (:foreground "navy blue" :bold t))
 339     (t
 340      (:bold t)))
 341   "Notmuch search mode face used to highligh tags."
 342   :group 'notmuch)
 343
 344 (defvar notmuch-tag-face-alist nil
 345   "List containing the tag list that need to be highlighed")
 346
 347 (defvar notmuch-search-font-lock-keywords  nil)
 348
 349 ;;;###autoload
 350 (defun notmuch-search-mode ()
 351   "Major mode displaying results of a notmuch search.
 352
 353 This buffer contains the results of a \"notmuch search\" of your
 354 email archives. Each line in the buffer represents a single
 355 thread giving a summary of the thread (a relative date, the
 356 number of matched messages and total messages in the thread,
 357 participants in the thread, a representative subject line, and
 358 any tags).
 359
 360 Pressing \\[notmuch-search-show-thread] on any line displays that thread. The '\\[notmuch-search-add-tag]' and '\\[notmuch-search-remove-tag]'
 361 keys can be used to add or remove tags from a thread. The '\\[notmuch-search-archive-thread]' key
 362 is a convenience for archiving a thread (removing the \"inbox\"
 363 tag). The '\\[notmuch-search-operate-all]' key can be used to add or remove a tag from all
 364 threads in the current buffer.
 365
 366 Other useful commands are '\\[notmuch-search-filter]' for filtering the current search
 367 based on an additional query string, '\\[notmuch-search-filter-by-tag]' for filtering to include
 368 only messages with a given tag, and '\\[notmuch-search]' to execute a new, global
 369 search.
 370
 371 Complete list of currently available key bindings:
 372
 373 \\{notmuch-search-mode-map}"
 374   (interactive)
 375   (kill-all-local-variables)
 376   (make-local-variable 'notmuch-search-query-string)
 377   (make-local-variable 'notmuch-search-oldest-first)
 378   (make-local-variable 'notmuch-search-target-thread)
 379   (make-local-variable 'notmuch-search-target-line)
 380   (set (make-local-variable 'scroll-preserve-screen-position) t)
 381   (add-to-invisibility-spec 'notmuch-search)
 382   (use-local-map notmuch-search-mode-map)
 383   (setq truncate-lines t)
 384   (setq major-mode 'notmuch-search-mode
 385         mode-name "notmuch-search")
 386   (setq buffer-read-only t)
 387   (if (not notmuch-tag-face-alist)
 388       (add-to-list 'notmuch-search-font-lock-keywords (list
 389                 "(\\([^()]*\\))$" '(1  'notmuch-tag-face)))
 390     (let ((notmuch-search-tags (mapcar 'car notmuch-tag-face-alist)))
 391       (loop for notmuch-search-tag  in notmuch-search-tags
 392             do (add-to-list 'notmuch-search-font-lock-keywords (list
 393                         (concat "([^)]*\\(" notmuch-search-tag "\\)[^)]*)$")
 394                         `(1  ,(cdr (assoc notmuch-search-tag notmuch-tag-face-alist))))))))
 395   (set (make-local-variable 'font-lock-defaults)
 396          '(notmuch-search-font-lock-keywords t)))
 397
 398 (defun notmuch-search-find-thread-id ()
 399   "Return the thread for the current thread"
 400   (get-text-property (point) 'notmuch-search-thread-id))
 401
 402 (defun notmuch-search-find-authors ()
 403   "Return the authors for the current thread"
 404   (get-text-property (point) 'notmuch-search-authors))
 405
 406 (defun notmuch-search-find-subject ()
 407   "Return the subject for the current thread"
 408   (get-text-property (point) 'notmuch-search-subject))
 409
 410 (defun notmuch-search-show-thread ()
 411   "Display the currently selected thread."
 412   (interactive)
 413   (let ((thread-id (notmuch-search-find-thread-id)))
 414     (if (> (length thread-id) 0)
 415         (notmuch-show thread-id (current-buffer) notmuch-search-query-string)
 416       (error "End of search results"))))
 417
 418 (defun notmuch-search-reply-to-thread ()
 419   "Begin composing a reply to the entire current thread in a new buffer."
 420   (interactive)
 421   (let ((message-id (notmuch-search-find-thread-id)))
 422     (notmuch-reply message-id)))
 423
 424 (defun notmuch-call-notmuch-process (&rest args)
 425   "Synchronously invoke \"notmuch\" with the given list of arguments.
 426
 427 Output from the process will be presented to the user as an error
 428 and will also appear in a buffer named \"*Notmuch errors*\"."
 429   (let ((error-buffer (get-buffer-create "*Notmuch errors*")))
 430     (with-current-buffer error-buffer
 431         (erase-buffer))
 432     (if (eq (apply 'call-process notmuch-command nil error-buffer nil args) 0)
 433         (point)
 434       (progn
 435         (with-current-buffer error-buffer
 436           (let ((beg (point-min))
 437                 (end (- (point-max) 1)))
 438             (error (buffer-substring beg end))
 439             ))))))
 440
 441 (defun notmuch-search-set-tags (tags)
 442   (save-excursion
 443     (end-of-line)
 444     (re-search-backward "(")
 445     (forward-char)
 446     (let ((beg (point))
 447           (inhibit-read-only t))
 448       (re-search-forward ")")
 449       (backward-char)
 450       (let ((end (point)))
 451         (delete-region beg end)
 452         (insert (mapconcat  'identity tags " "))))))
 453
 454 (defun notmuch-search-get-tags ()
 455   (save-excursion
 456     (end-of-line)
 457     (re-search-backward "(")
 458     (let ((beg (+ (point) 1)))
 459       (re-search-forward ")")
 460       (let ((end (- (point) 1)))
 461         (split-string (buffer-substring beg end))))))
 462
 463 (defun notmuch-search-add-tag (tag)
 464   "Add a tag to the currently selected thread.
 465
 466 The tag is added to messages in the currently selected thread
 467 which match the current search terms."
 468   (interactive
 469    (list (notmuch-select-tag-with-completion "Tag to add: ")))
 470   (notmuch-call-notmuch-process "tag" (concat "+" tag) (notmuch-search-find-thread-id))
 471   (notmuch-search-set-tags (delete-dups (sort (cons tag (notmuch-search-get-tags)) 'string<))))
 472
 473 (defun notmuch-search-remove-tag (tag)
 474   "Remove a tag from the currently selected thread.
 475
 476 The tag is removed from all messages in the currently selected thread."
 477   (interactive
 478    (list (notmuch-select-tag-with-completion "Tag to remove: " (notmuch-search-find-thread-id))))
 479   (notmuch-call-notmuch-process "tag" (concat "-" tag) (notmuch-search-find-thread-id))
 480   (notmuch-search-set-tags (delete tag (notmuch-search-get-tags))))
 481
 482 (defun notmuch-search-archive-thread ()
 483   "Archive the currently selected thread (remove its \"inbox\" tag).
 484
 485 This function advances the next thread when finished."
 486   (interactive)
 487   (notmuch-search-remove-tag "inbox")
 488   (forward-line))
 489
 490 (defun notmuch-search-process-sentinel (proc msg)
 491   "Add a message to let user know when \"notmuch search\" exits"
 492   (let ((buffer (process-buffer proc))
 493         (status (process-status proc))
 494         (exit-status (process-exit-status proc))
 495         (never-found-target-thread nil))
 496     (if (memq status '(exit signal))
 497         (if (buffer-live-p buffer)
 498             (with-current-buffer buffer
 499               (save-excursion
 500                 (let ((inhibit-read-only t)
 501                       (atbob (bobp)))
 502                   (goto-char (point-max))
 503                   (if (eq status 'signal)
 504                       (insert "Incomplete search results (search process was killed).\n"))
 505                   (if (eq status 'exit)
 506                       (progn
 507                         (insert "End of search results.")
 508                         (if (not (= exit-status 0))
 509                             (insert (format " (process returned %d)" exit-status)))
 510                         (insert "\n")
 511                         (if (and atbob
 512                                  (not (string= notmuch-search-target-thread "found")))
 513                             (set 'never-found-target-thread t))))))
 514               (if (and never-found-target-thread
 515                        notmuch-search-target-line)
 516                   (goto-line notmuch-search-target-line)))))))
 517
 518 (defun notmuch-search-process-filter (proc string)
 519   "Process and filter the output of \"notmuch search\""
 520   (let ((buffer (process-buffer proc))
 521         (found-target nil))
 522     (if (buffer-live-p buffer)
 523         (with-current-buffer buffer
 524           (save-excursion
 525             (let ((line 0)
 526                   (more t)
 527                   (inhibit-read-only t))
 528               (while more
 529                 (if (string-match "^\\(thread:[0-9A-Fa-f]*\\) \\(.*\\) \\(\\[[0-9/]*\\]\\) \\([^;]*\\); \\(.*\\) (\\([^()]*\\))$" string line)
 530                     (let* ((thread-id (match-string 1 string))
 531                            (date (match-string 2 string))
 532                            (count (match-string 3 string))
 533                            (authors (match-string 4 string))
 534                            (authors-length (length authors))
 535                            (subject (match-string 5 string))
 536                            (tags (match-string 6 string)))
 537                       (if (> authors-length notmuch-search-authors-width)
 538                           (set 'authors (concat (substring authors 0 (- notmuch-search-authors-width 3)) "...")))
 539                       (goto-char (point-max))
 540                       (let ((beg (point-marker))
 541                             (format-string (format "%%s %%-7s %%-%ds %%s (%%s)\n" notmuch-search-authors-width)))
 542                         (insert (format format-string date count authors subject tags))
 543                         (put-text-property beg (point-marker) 'notmuch-search-thread-id thread-id)
 544                         (put-text-property beg (point-marker) 'notmuch-search-authors authors)
 545                         (put-text-property beg (point-marker) 'notmuch-search-subject subject)
 546                         (if (string= thread-id notmuch-search-target-thread)
 547                             (progn
 548                               (set 'found-target beg)
 549                               (set 'notmuch-search-target-thread "found"))))
 550                       (set 'line (match-end 0)))
 551                   (set 'more nil)))))
 552           (if found-target
 553               (goto-char found-target)))
 554       (delete-process proc))))
 555
 556 (defun notmuch-search-operate-all (action)
 557   "Add/remove tags from all matching messages.
 558
 559 Tis command adds or removes tags from all messages matching the
 560 current search terms. When called interactively, this command
 561 will prompt for tags to be added or removed. Tags prefixed with
 562 '+' will be added and tags prefixed with '-' will be removed.
 563
 564 Each character of the tag name may consist of alphanumeric
 565 characters as well as `_.+-'.
 566 "
 567   (interactive "sOperation (+add -drop): notmuch tag ")
 568   (let ((action-split (split-string action " +")))
 569     ;; Perform some validation
 570     (let ((words action-split))
 571       (when (null words) (error "No operation given"))
 572       (while words
 573         (unless (string-match-p "^[-+][-+_.[:word:]]+$" (car words))
 574           (error "Action must be of the form `+thistag -that_tag'"))
 575         (setq words (cdr words))))
 576     (apply 'notmuch-call-notmuch-process "tag"
 577            (append action-split (list notmuch-search-query-string) nil))))
 578
 579 ;;;###autoload
 580 (defun notmuch-search (query &optional oldest-first target-thread target-line)
 581   "Run \"notmuch search\" with the given query string and display results.
 582
 583 The optional parameters are used as follows:
 584
 585   oldest-first: A Boolean controlling the sort order of returned threads
 586   target-thread: A thread ID (with the thread: prefix) that will be made
 587                  current if it appears in the search results.
 588   target-line: The line number to move to if the target thread does not
 589                appear in the search results."
 590   (interactive "sNotmuch search: ")
 591   (let ((buffer (get-buffer-create (concat "*notmuch-search-" query "*"))))
 592     (switch-to-buffer buffer)
 593     (notmuch-search-mode)
 594     (set 'notmuch-search-query-string query)
 595     (set 'notmuch-search-oldest-first oldest-first)
 596     (set 'notmuch-search-target-thread target-thread)
 597     (set 'notmuch-search-target-line target-line)
 598     (let ((proc (get-buffer-process (current-buffer)))
 599           (inhibit-read-only t))
 600       (if proc
 601           (error "notmuch search process already running for query `%s'" query)
 602         )
 603       (erase-buffer)
 604       (goto-char (point-min))
 605       (save-excursion
 606         (let ((proc (start-process-shell-command
 607                      "notmuch-search" buffer notmuch-command "search"
 608                      (if oldest-first "--sort=oldest-first" "--sort=newest-first")
 609                      (shell-quote-argument query))))
 610           (set-process-sentinel proc 'notmuch-search-process-sentinel)
 611           (set-process-filter proc 'notmuch-search-process-filter))))
 612     (run-hooks 'notmuch-search-hook)))
 613
 614 (defun notmuch-search-refresh-view ()
 615   "Refresh the current view.
 616
 617 Kills the current buffer and runs a new search with the same
 618 query string as the current search. If the current thread is in
 619 the new search results, then point will be placed on the same
 620 thread. Otherwise, point will be moved to attempt to be in the
 621 same relative position within the new buffer."
 622   (interactive)
 623   (let ((target-line (line-number-at-pos))
 624         (oldest-first notmuch-search-oldest-first)
 625         (target-thread (notmuch-search-find-thread-id))
 626         (query notmuch-search-query-string))
 627     (kill-this-buffer)
 628     (notmuch-search query oldest-first target-thread target-line)
 629     (goto-char (point-min))
 630     ))
 631
 632 (defun notmuch-search-toggle-order ()
 633   "Toggle the current search order.
 634
 635 By default, the \"inbox\" view created by `notmuch' is displayed
 636 in chronological order (oldest thread at the beginning of the
 637 buffer), while any global searches created by `notmuch-search'
 638 are displayed in reverse-chronological order (newest thread at
 639 the beginning of the buffer).
 640
 641 This command toggles the sort order for the current search.
 642
 643 Note that any filtered searches created by
 644 `notmuch-search-filter' retain the search order of the parent
 645 search."
 646   (interactive)
 647   (set 'notmuch-search-oldest-first (not notmuch-search-oldest-first))
 648   (notmuch-search-refresh-view))
 649
 650 (defun notmuch-search-filter (query)
 651   "Filter the current search results based on an additional query string.
 652
 653 Runs a new search matching only messages that match both the
 654 current search results AND the additional query string provided."
 655   (interactive "sFilter search: ")
 656   (let ((grouped-query (if (string-match-p notmuch-search-disjunctive-regexp query) (concat "( " query " )") query)))
 657     (notmuch-search (concat notmuch-search-query-string " and " grouped-query) notmuch-search-oldest-first)))
 658
 659 (defun notmuch-search-filter-by-tag (tag)
 660   "Filter the current search results based on a single tag.
 661
 662 Runs a new search matching only messages that match both the
 663 current search results AND that are tagged with the given tag."
 664   (interactive
 665    (list (notmuch-select-tag-with-completion "Filter by tag: ")))
 666   (notmuch-search (concat notmuch-search-query-string " and tag:" tag) notmuch-search-oldest-first))
 667
 668 ;;;###autoload
 669 (defun notmuch ()
 670   "Run notmuch to display all mail with tag of 'inbox'"
 671   (interactive)
 672   (notmuch-search "tag:inbox" notmuch-search-oldest-first))
 673
 674 (setq mail-user-agent 'message-user-agent)
 675
 676 (defvar notmuch-folder-mode-map
 677   (let ((map (make-sparse-keymap)))
 678     (define-key map "?" 'notmuch-help)
 679     (define-key map "x" 'kill-this-buffer)
 680     (define-key map "q" 'kill-this-buffer)
 681     (define-key map "m" 'message-mail)
 682     (define-key map "e" 'notmuch-folder-show-empty-toggle)
 683     (define-key map ">" 'notmuch-folder-last)
 684     (define-key map "<" 'notmuch-folder-first)
 685     (define-key map "=" 'notmuch-folder)
 686     (define-key map "s" 'notmuch-search)
 687     (define-key map [mouse-1] 'notmuch-folder-show-search)
 688     (define-key map (kbd "RET") 'notmuch-folder-show-search)
 689     (define-key map " " 'notmuch-folder-show-search)
 690     (define-key map "p" 'notmuch-folder-previous)
 691     (define-key map "n" 'notmuch-folder-next)
 692     map)
 693   "Keymap for \"notmuch folder\" buffers.")
 694
 695 (fset 'notmuch-folder-mode-map notmuch-folder-mode-map)
 696
 697 (defcustom notmuch-folders (quote (("inbox" . "tag:inbox") ("unread" . "tag:unread")))
 698   "List of searches for the notmuch folder view"
 699   :type '(alist :key-type (string) :value-type (string))
 700   :group 'notmuch)
 701
 702 (defun notmuch-folder-mode ()
 703   "Major mode for showing notmuch 'folders'.
 704
 705 This buffer contains a list of message counts returned by a
 706 customizable set of searches of your email archives. Each line in
 707 the buffer shows the name of a saved search and the resulting
 708 message count.
 709
 710 Pressing RET on any line opens a search window containing the
 711 results for the saved search on that line.
 712
 713 Here is an example of how the search list could be
 714 customized, (the following text would be placed in your ~/.emacs
 715 file):
 716
 717 (setq notmuch-folders '((\"inbox\" . \"tag:inbox\")
 718                         (\"unread\" . \"tag:inbox AND tag:unread\")
 719                         (\"notmuch\" . \"tag:inbox AND to:notmuchmail.org\")))
 720
 721 Of course, you can have any number of folders, each configured
 722 with any supported search terms (see \"notmuch help search-terms\").
 723
 724 Currently available key bindings:
 725
 726 \\{notmuch-folder-mode-map}"
 727   (interactive)
 728   (kill-all-local-variables)
 729   (use-local-map 'notmuch-folder-mode-map)
 730   (setq truncate-lines t)
 731   (hl-line-mode 1)
 732   (setq major-mode 'notmuch-folder-mode
 733         mode-name "notmuch-folder")
 734   (setq buffer-read-only t))
 735
 736 (defun notmuch-folder-next ()
 737   "Select the next folder in the list."
 738   (interactive)
 739   (forward-line 1)
 740   (if (eobp)
 741       (forward-line -1)))
 742
 743 (defun notmuch-folder-previous ()
 744   "Select the previous folder in the list."
 745   (interactive)
 746   (forward-line -1))
 747
 748 (defun notmuch-folder-first ()
 749   "Select the first folder in the list."
 750   (interactive)
 751   (goto-char (point-min)))
 752
 753 (defun notmuch-folder-last ()
 754   "Select the last folder in the list."
 755   (interactive)
 756   (goto-char (point-max))
 757   (forward-line -1))
 758
 759 (defun notmuch-folder-count (search)
 760   (car (process-lines notmuch-command "count" search)))
 761
 762 (defvar notmuch-folder-show-empty t
 763   "Whether `notmuch-folder-mode' should display empty folders.")
 764
 765 (defun notmuch-folder-show-empty-toggle ()
 766   "Toggle the listing of empty folders"
 767   (interactive)
 768   (setq notmuch-folder-show-empty (not notmuch-folder-show-empty))
 769   (notmuch-folder))
 770
 771 (defun notmuch-folder-add (folders)
 772   (if folders
 773       (let* ((name (car (car folders)))
 774             (inhibit-read-only t)
 775             (search (cdr (car folders)))
 776             (count (notmuch-folder-count search)))
 777         (if (or notmuch-folder-show-empty
 778                 (not (equal count "0")))
 779             (progn
 780               (insert name)
 781               (indent-to 16 1)
 782               (insert count)
 783               (insert "\n")
 784               )
 785           )
 786         (notmuch-folder-add (cdr folders)))))
 787
 788 (defun notmuch-folder-find-name ()
 789   (save-excursion
 790     (beginning-of-line)
 791     (let ((beg (point)))
 792       (re-search-forward "\\([ \t]*[^ \t]+\\)")
 793       (filter-buffer-substring (match-beginning 1) (match-end 1)))))
 794
 795 (defun notmuch-folder-show-search (&optional folder)
 796   "Show a search window for the search related to the specified folder."
 797   (interactive)
 798   (if (null folder)
 799       (setq folder (notmuch-folder-find-name)))
 800   (let ((search (assoc folder notmuch-folders)))
 801     (if search
 802         (notmuch-search (cdr search) notmuch-search-oldest-first))))
 803
 804 ;;;###autoload
 805 (defun notmuch-folder ()
 806   "Show the notmuch folder view and update the displayed counts."
 807   (interactive)
 808   (let ((buffer (get-buffer-create "*notmuch-folders*")))
 809     (switch-to-buffer buffer)
 810     (let ((inhibit-read-only t)
 811           (n (line-number-at-pos)))
 812       (erase-buffer)
 813       (notmuch-folder-mode)
 814       (notmuch-folder-add notmuch-folders)
 815       (goto-char (point-min))
 816       (goto-line n))))
 817
 818 (provide 'notmuch)