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     (define-key map "F" 'notmuch-folder)
 272     map)
 273   "Keymap for \"notmuch search\" buffers.")
 274 (fset 'notmuch-search-mode-map notmuch-search-mode-map)
 275
 276 (defvar notmuch-search-query-string)
 277 (defvar notmuch-search-target-thread)
 278 (defvar notmuch-search-target-line)
 279 (defvar notmuch-search-oldest-first t
 280   "Show the oldest mail first in the search-mode")
 281
 282 (defvar notmuch-search-disjunctive-regexp      "\\<[oO][rR]\\>")
 283
 284 (defun notmuch-search-scroll-up ()
 285   "Move forward through search results by one window's worth."
 286   (interactive)
 287   (condition-case nil
 288       (scroll-up nil)
 289     ((end-of-buffer) (notmuch-search-last-thread))))
 290
 291 (defun notmuch-search-scroll-down ()
 292   "Move backward through the search results by one window's worth."
 293   (interactive)
 294   ; I don't know why scroll-down doesn't signal beginning-of-buffer
 295   ; the way that scroll-up signals end-of-buffer, but c'est la vie.
 296   ;
 297   ; So instead of trapping a signal we instead check whether the
 298   ; window begins on the first line of the buffer and if so, move
 299   ; directly to that position. (We have to count lines since the
 300   ; window-start position is not the same as point-min due to the
 301   ; invisible thread-ID characters on the first line.
 302   (if (equal (count-lines (point-min) (window-start)) 0)
 303       (goto-char (point-min))
 304     (scroll-down nil)))
 305
 306 (defun notmuch-search-next-thread ()
 307   "Select the next thread in the search results."
 308   (interactive)
 309   (forward-line 1))
 310
 311 (defun notmuch-search-previous-thread ()
 312   "Select the previous thread in the search results."
 313   (interactive)
 314   (forward-line -1))
 315
 316 (defun notmuch-search-last-thread ()
 317   "Select the last thread in the search results."
 318   (interactive)
 319   (goto-char (point-max))
 320   (forward-line -2))
 321
 322 (defun notmuch-search-first-thread ()
 323   "Select the first thread in the search results."
 324   (interactive)
 325   (goto-char (point-min)))
 326
 327 (defface notmuch-message-summary-face
 328  '((((class color) (background light)) (:background "#f0f0f0"))
 329    (((class color) (background dark)) (:background "#303030")))
 330  "Face for the single-line message summary in notmuch-show-mode."
 331  :group 'notmuch)
 332
 333 (defface notmuch-tag-face
 334   '((((class color)
 335       (background dark))
 336      (:foreground "OliveDrab1"))
 337     (((class color)
 338       (background light))
 339      (:foreground "navy blue" :bold t))
 340     (t
 341      (:bold t)))
 342   "Notmuch search mode face used to highligh tags."
 343   :group 'notmuch)
 344
 345 (defvar notmuch-tag-face-alist nil
 346   "List containing the tag list that need to be highlighed")
 347
 348 (defvar notmuch-search-font-lock-keywords  nil)
 349
 350 ;;;###autoload
 351 (defun notmuch-search-mode ()
 352   "Major mode displaying results of a notmuch search.
 353
 354 This buffer contains the results of a \"notmuch search\" of your
 355 email archives. Each line in the buffer represents a single
 356 thread giving a summary of the thread (a relative date, the
 357 number of matched messages and total messages in the thread,
 358 participants in the thread, a representative subject line, and
 359 any tags).
 360
 361 Pressing \\[notmuch-search-show-thread] on any line displays that thread. The '\\[notmuch-search-add-tag]' and '\\[notmuch-search-remove-tag]'
 362 keys can be used to add or remove tags from a thread. The '\\[notmuch-search-archive-thread]' key
 363 is a convenience for archiving a thread (removing the \"inbox\"
 364 tag). The '\\[notmuch-search-operate-all]' key can be used to add or remove a tag from all
 365 threads in the current buffer.
 366
 367 Other useful commands are '\\[notmuch-search-filter]' for filtering the current search
 368 based on an additional query string, '\\[notmuch-search-filter-by-tag]' for filtering to include
 369 only messages with a given tag, and '\\[notmuch-search]' to execute a new, global
 370 search.
 371
 372 Complete list of currently available key bindings:
 373
 374 \\{notmuch-search-mode-map}"
 375   (interactive)
 376   (kill-all-local-variables)
 377   (make-local-variable 'notmuch-search-query-string)
 378   (make-local-variable 'notmuch-search-oldest-first)
 379   (make-local-variable 'notmuch-search-target-thread)
 380   (make-local-variable 'notmuch-search-target-line)
 381   (set (make-local-variable 'scroll-preserve-screen-position) t)
 382   (add-to-invisibility-spec 'notmuch-search)
 383   (use-local-map notmuch-search-mode-map)
 384   (setq truncate-lines t)
 385   (setq major-mode 'notmuch-search-mode
 386         mode-name "notmuch-search")
 387   (setq buffer-read-only t)
 388   (if (not notmuch-tag-face-alist)
 389       (add-to-list 'notmuch-search-font-lock-keywords (list
 390                 "(\\([^()]*\\))$" '(1  'notmuch-tag-face)))
 391     (let ((notmuch-search-tags (mapcar 'car notmuch-tag-face-alist)))
 392       (loop for notmuch-search-tag  in notmuch-search-tags
 393             do (add-to-list 'notmuch-search-font-lock-keywords (list
 394                         (concat "([^)]*\\(" notmuch-search-tag "\\)[^)]*)$")
 395                         `(1  ,(cdr (assoc notmuch-search-tag notmuch-tag-face-alist))))))))
 396   (set (make-local-variable 'font-lock-defaults)
 397          '(notmuch-search-font-lock-keywords t)))
 398
 399 (defun notmuch-search-find-thread-id ()
 400   "Return the thread for the current thread"
 401   (get-text-property (point) 'notmuch-search-thread-id))
 402
 403 (defun notmuch-search-find-authors ()
 404   "Return the authors for the current thread"
 405   (get-text-property (point) 'notmuch-search-authors))
 406
 407 (defun notmuch-search-find-subject ()
 408   "Return the subject for the current thread"
 409   (get-text-property (point) 'notmuch-search-subject))
 410
 411 (defun notmuch-search-show-thread ()
 412   "Display the currently selected thread."
 413   (interactive)
 414   (let ((thread-id (notmuch-search-find-thread-id)))
 415     (if (> (length thread-id) 0)
 416         (notmuch-show thread-id (current-buffer) notmuch-search-query-string)
 417       (error "End of search results"))))
 418
 419 (defun notmuch-search-reply-to-thread ()
 420   "Begin composing a reply to the entire current thread in a new buffer."
 421   (interactive)
 422   (let ((message-id (notmuch-search-find-thread-id)))
 423     (notmuch-reply message-id)))
 424
 425 (defun notmuch-call-notmuch-process (&rest args)
 426   "Synchronously invoke \"notmuch\" with the given list of arguments.
 427
 428 Output from the process will be presented to the user as an error
 429 and will also appear in a buffer named \"*Notmuch errors*\"."
 430   (let ((error-buffer (get-buffer-create "*Notmuch errors*")))
 431     (with-current-buffer error-buffer
 432         (erase-buffer))
 433     (if (eq (apply 'call-process notmuch-command nil error-buffer nil args) 0)
 434         (point)
 435       (progn
 436         (with-current-buffer error-buffer
 437           (let ((beg (point-min))
 438                 (end (- (point-max) 1)))
 439             (error (buffer-substring beg end))
 440             ))))))
 441
 442 (defun notmuch-search-set-tags (tags)
 443   (save-excursion
 444     (end-of-line)
 445     (re-search-backward "(")
 446     (forward-char)
 447     (let ((beg (point))
 448           (inhibit-read-only t))
 449       (re-search-forward ")")
 450       (backward-char)
 451       (let ((end (point)))
 452         (delete-region beg end)
 453         (insert (mapconcat  'identity tags " "))))))
 454
 455 (defun notmuch-search-get-tags ()
 456   (save-excursion
 457     (end-of-line)
 458     (re-search-backward "(")
 459     (let ((beg (+ (point) 1)))
 460       (re-search-forward ")")
 461       (let ((end (- (point) 1)))
 462         (split-string (buffer-substring beg end))))))
 463
 464 (defun notmuch-search-add-tag (tag)
 465   "Add a tag to the currently selected thread.
 466
 467 The tag is added to messages in the currently selected thread
 468 which match the current search terms."
 469   (interactive
 470    (list (notmuch-select-tag-with-completion "Tag to add: ")))
 471   (notmuch-call-notmuch-process "tag" (concat "+" tag) (notmuch-search-find-thread-id))
 472   (notmuch-search-set-tags (delete-dups (sort (cons tag (notmuch-search-get-tags)) 'string<))))
 473
 474 (defun notmuch-search-remove-tag (tag)
 475   "Remove a tag from the currently selected thread.
 476
 477 The tag is removed from all messages in the currently selected thread."
 478   (interactive
 479    (list (notmuch-select-tag-with-completion "Tag to remove: " (notmuch-search-find-thread-id))))
 480   (notmuch-call-notmuch-process "tag" (concat "-" tag) (notmuch-search-find-thread-id))
 481   (notmuch-search-set-tags (delete tag (notmuch-search-get-tags))))
 482
 483 (defun notmuch-search-archive-thread ()
 484   "Archive the currently selected thread (remove its \"inbox\" tag).
 485
 486 This function advances the next thread when finished."
 487   (interactive)
 488   (notmuch-search-remove-tag "inbox")
 489   (forward-line))
 490
 491 (defun notmuch-search-process-sentinel (proc msg)
 492   "Add a message to let user know when \"notmuch search\" exits"
 493   (let ((buffer (process-buffer proc))
 494         (status (process-status proc))
 495         (exit-status (process-exit-status proc))
 496         (never-found-target-thread nil))
 497     (if (memq status '(exit signal))
 498         (if (buffer-live-p buffer)
 499             (with-current-buffer buffer
 500               (save-excursion
 501                 (let ((inhibit-read-only t)
 502                       (atbob (bobp)))
 503                   (goto-char (point-max))
 504                   (if (eq status 'signal)
 505                       (insert "Incomplete search results (search process was killed).\n"))
 506                   (if (eq status 'exit)
 507                       (progn
 508                         (insert "End of search results.")
 509                         (if (not (= exit-status 0))
 510                             (insert (format " (process returned %d)" exit-status)))
 511                         (insert "\n")
 512                         (if (and atbob
 513                                  (not (string= notmuch-search-target-thread "found")))
 514                             (set 'never-found-target-thread t))))))
 515               (if (and never-found-target-thread
 516                        notmuch-search-target-line)
 517                   (goto-line notmuch-search-target-line)))))))
 518
 519 (defun notmuch-search-process-filter (proc string)
 520   "Process and filter the output of \"notmuch search\""
 521   (let ((buffer (process-buffer proc))
 522         (found-target nil))
 523     (if (buffer-live-p buffer)
 524         (with-current-buffer buffer
 525           (save-excursion
 526             (let ((line 0)
 527                   (more t)
 528                   (inhibit-read-only t))
 529               (while more
 530                 (if (string-match "^\\(thread:[0-9A-Fa-f]*\\) \\(.*\\) \\(\\[[0-9/]*\\]\\) \\([^;]*\\); \\(.*\\) (\\([^()]*\\))$" string line)
 531                     (let* ((thread-id (match-string 1 string))
 532                            (date (match-string 2 string))
 533                            (count (match-string 3 string))
 534                            (authors (match-string 4 string))
 535                            (authors-length (length authors))
 536                            (subject (match-string 5 string))
 537                            (tags (match-string 6 string)))
 538                       (if (> authors-length notmuch-search-authors-width)
 539                           (set 'authors (concat (substring authors 0 (- notmuch-search-authors-width 3)) "...")))
 540                       (goto-char (point-max))
 541                       (let ((beg (point-marker))
 542                             (format-string (format "%%s %%-7s %%-%ds %%s (%%s)\n" notmuch-search-authors-width)))
 543                         (insert (format format-string date count authors subject tags))
 544                         (put-text-property beg (point-marker) 'notmuch-search-thread-id thread-id)
 545                         (put-text-property beg (point-marker) 'notmuch-search-authors authors)
 546                         (put-text-property beg (point-marker) 'notmuch-search-subject subject)
 547                         (if (string= thread-id notmuch-search-target-thread)
 548                             (progn
 549                               (set 'found-target beg)
 550                               (set 'notmuch-search-target-thread "found"))))
 551                       (set 'line (match-end 0)))
 552                   (set 'more nil)))))
 553           (if found-target
 554               (goto-char found-target)))
 555       (delete-process proc))))
 556
 557 (defun notmuch-search-operate-all (action)
 558   "Add/remove tags from all matching messages.
 559
 560 Tis command adds or removes tags from all messages matching the
 561 current search terms. When called interactively, this command
 562 will prompt for tags to be added or removed. Tags prefixed with
 563 '+' will be added and tags prefixed with '-' will be removed.
 564
 565 Each character of the tag name may consist of alphanumeric
 566 characters as well as `_.+-'.
 567 "
 568   (interactive "sOperation (+add -drop): notmuch tag ")
 569   (let ((action-split (split-string action " +")))
 570     ;; Perform some validation
 571     (let ((words action-split))
 572       (when (null words) (error "No operation given"))
 573       (while words
 574         (unless (string-match-p "^[-+][-+_.[:word:]]+$" (car words))
 575           (error "Action must be of the form `+thistag -that_tag'"))
 576         (setq words (cdr words))))
 577     (apply 'notmuch-call-notmuch-process "tag"
 578            (append action-split (list notmuch-search-query-string) nil))))
 579
 580 ;;;###autoload
 581 (defun notmuch-search (query &optional oldest-first target-thread target-line)
 582   "Run \"notmuch search\" with the given query string and display results.
 583
 584 The optional parameters are used as follows:
 585
 586   oldest-first: A Boolean controlling the sort order of returned threads
 587   target-thread: A thread ID (with the thread: prefix) that will be made
 588                  current if it appears in the search results.
 589   target-line: The line number to move to if the target thread does not
 590                appear in the search results."
 591   (interactive "sNotmuch search: ")
 592   (let ((buffer (get-buffer-create (concat "*notmuch-search-" query "*"))))
 593     (switch-to-buffer buffer)
 594     (notmuch-search-mode)
 595     (set 'notmuch-search-query-string query)
 596     (set 'notmuch-search-oldest-first oldest-first)
 597     (set 'notmuch-search-target-thread target-thread)
 598     (set 'notmuch-search-target-line target-line)
 599     (let ((proc (get-buffer-process (current-buffer)))
 600           (inhibit-read-only t))
 601       (if proc
 602           (error "notmuch search process already running for query `%s'" query)
 603         )
 604       (erase-buffer)
 605       (goto-char (point-min))
 606       (save-excursion
 607         (let ((proc (start-process-shell-command
 608                      "notmuch-search" buffer notmuch-command "search"
 609                      (if oldest-first "--sort=oldest-first" "--sort=newest-first")
 610                      (shell-quote-argument query))))
 611           (set-process-sentinel proc 'notmuch-search-process-sentinel)
 612           (set-process-filter proc 'notmuch-search-process-filter))))
 613     (run-hooks 'notmuch-search-hook)))
 614
 615 (defun notmuch-search-refresh-view ()
 616   "Refresh the current view.
 617
 618 Kills the current buffer and runs a new search with the same
 619 query string as the current search. If the current thread is in
 620 the new search results, then point will be placed on the same
 621 thread. Otherwise, point will be moved to attempt to be in the
 622 same relative position within the new buffer."
 623   (interactive)
 624   (let ((target-line (line-number-at-pos))
 625         (oldest-first notmuch-search-oldest-first)
 626         (target-thread (notmuch-search-find-thread-id))
 627         (query notmuch-search-query-string))
 628     (kill-this-buffer)
 629     (notmuch-search query oldest-first target-thread target-line)
 630     (goto-char (point-min))
 631     ))
 632
 633 (defun notmuch-search-toggle-order ()
 634   "Toggle the current search order.
 635
 636 By default, the \"inbox\" view created by `notmuch' is displayed
 637 in chronological order (oldest thread at the beginning of the
 638 buffer), while any global searches created by `notmuch-search'
 639 are displayed in reverse-chronological order (newest thread at
 640 the beginning of the buffer).
 641
 642 This command toggles the sort order for the current search.
 643
 644 Note that any filtered searches created by
 645 `notmuch-search-filter' retain the search order of the parent
 646 search."
 647   (interactive)
 648   (set 'notmuch-search-oldest-first (not notmuch-search-oldest-first))
 649   (notmuch-search-refresh-view))
 650
 651 (defun notmuch-search-filter (query)
 652   "Filter the current search results based on an additional query string.
 653
 654 Runs a new search matching only messages that match both the
 655 current search results AND the additional query string provided."
 656   (interactive "sFilter search: ")
 657   (let ((grouped-query (if (string-match-p notmuch-search-disjunctive-regexp query) (concat "( " query " )") query)))
 658     (notmuch-search (concat notmuch-search-query-string " and " grouped-query) notmuch-search-oldest-first)))
 659
 660 (defun notmuch-search-filter-by-tag (tag)
 661   "Filter the current search results based on a single tag.
 662
 663 Runs a new search matching only messages that match both the
 664 current search results AND that are tagged with the given tag."
 665   (interactive
 666    (list (notmuch-select-tag-with-completion "Filter by tag: ")))
 667   (notmuch-search (concat notmuch-search-query-string " and tag:" tag) notmuch-search-oldest-first))
 668
 669 ;;;###autoload
 670 (defun notmuch ()
 671   "Run notmuch to display all mail with tag of 'inbox'"
 672   (interactive)
 673   (notmuch-search "tag:inbox" notmuch-search-oldest-first))
 674
 675 (setq mail-user-agent 'message-user-agent)
 676
 677 (defvar notmuch-folder-mode-map
 678   (let ((map (make-sparse-keymap)))
 679     (define-key map "?" 'notmuch-help)
 680     (define-key map "x" 'kill-this-buffer)
 681     (define-key map "q" 'kill-this-buffer)
 682     (define-key map "m" 'message-mail)
 683     (define-key map "e" 'notmuch-folder-show-empty-toggle)
 684     (define-key map ">" 'notmuch-folder-last)
 685     (define-key map "<" 'notmuch-folder-first)
 686     (define-key map "=" 'notmuch-folder)
 687     (define-key map "s" 'notmuch-search)
 688     (define-key map [mouse-1] 'notmuch-folder-show-search)
 689     (define-key map (kbd "RET") 'notmuch-folder-show-search)
 690     (define-key map " " 'notmuch-folder-show-search)
 691     (define-key map "p" 'notmuch-folder-previous)
 692     (define-key map "n" 'notmuch-folder-next)
 693     map)
 694   "Keymap for \"notmuch folder\" buffers.")
 695
 696 (fset 'notmuch-folder-mode-map notmuch-folder-mode-map)
 697
 698 (defcustom notmuch-folders (quote (("inbox" . "tag:inbox") ("unread" . "tag:unread")))
 699   "List of searches for the notmuch folder view"
 700   :type '(alist :key-type (string) :value-type (string))
 701   :group 'notmuch)
 702
 703 (defun notmuch-folder-mode ()
 704   "Major mode for showing notmuch 'folders'.
 705
 706 This buffer contains a list of message counts returned by a
 707 customizable set of searches of your email archives. Each line in
 708 the buffer shows the name of a saved search and the resulting
 709 message count.
 710
 711 Pressing RET on any line opens a search window containing the
 712 results for the saved search on that line.
 713
 714 Here is an example of how the search list could be
 715 customized, (the following text would be placed in your ~/.emacs
 716 file):
 717
 718 (setq notmuch-folders '((\"inbox\" . \"tag:inbox\")
 719                         (\"unread\" . \"tag:inbox AND tag:unread\")
 720                         (\"notmuch\" . \"tag:inbox AND to:notmuchmail.org\")))
 721
 722 Of course, you can have any number of folders, each configured
 723 with any supported search terms (see \"notmuch help search-terms\").
 724
 725 Currently available key bindings:
 726
 727 \\{notmuch-folder-mode-map}"
 728   (interactive)
 729   (kill-all-local-variables)
 730   (use-local-map 'notmuch-folder-mode-map)
 731   (setq truncate-lines t)
 732   (hl-line-mode 1)
 733   (setq major-mode 'notmuch-folder-mode
 734         mode-name "notmuch-folder")
 735   (setq buffer-read-only t))
 736
 737 (defun notmuch-folder-next ()
 738   "Select the next folder in the list."
 739   (interactive)
 740   (forward-line 1)
 741   (if (eobp)
 742       (forward-line -1)))
 743
 744 (defun notmuch-folder-previous ()
 745   "Select the previous folder in the list."
 746   (interactive)
 747   (forward-line -1))
 748
 749 (defun notmuch-folder-first ()
 750   "Select the first folder in the list."
 751   (interactive)
 752   (goto-char (point-min)))
 753
 754 (defun notmuch-folder-last ()
 755   "Select the last folder in the list."
 756   (interactive)
 757   (goto-char (point-max))
 758   (forward-line -1))
 759
 760 (defun notmuch-folder-count (search)
 761   (car (process-lines notmuch-command "count" search)))
 762
 763 (defvar notmuch-folder-show-empty t
 764   "Whether `notmuch-folder-mode' should display empty folders.")
 765
 766 (defun notmuch-folder-show-empty-toggle ()
 767   "Toggle the listing of empty folders"
 768   (interactive)
 769   (setq notmuch-folder-show-empty (not notmuch-folder-show-empty))
 770   (notmuch-folder))
 771
 772 (defun notmuch-folder-add (folders)
 773   (if folders
 774       (let* ((name (car (car folders)))
 775             (inhibit-read-only t)
 776             (search (cdr (car folders)))
 777             (count (notmuch-folder-count search)))
 778         (if (or notmuch-folder-show-empty
 779                 (not (equal count "0")))
 780             (progn
 781               (insert name)
 782               (indent-to 16 1)
 783               (insert count)
 784               (insert "\n")
 785               )
 786           )
 787         (notmuch-folder-add (cdr folders)))))
 788
 789 (defun notmuch-folder-find-name ()
 790   (save-excursion
 791     (beginning-of-line)
 792     (let ((beg (point)))
 793       (re-search-forward "\\([ \t]*[^ \t]+\\)")
 794       (filter-buffer-substring (match-beginning 1) (match-end 1)))))
 795
 796 (defun notmuch-folder-show-search (&optional folder)
 797   "Show a search window for the search related to the specified folder."
 798   (interactive)
 799   (if (null folder)
 800       (setq folder (notmuch-folder-find-name)))
 801   (let ((search (assoc folder notmuch-folders)))
 802     (if search
 803         (notmuch-search (cdr search) notmuch-search-oldest-first))))
 804
 805 ;;;###autoload
 806 (defun notmuch-folder ()
 807   "Show the notmuch folder view and update the displayed counts."
 808   (interactive)
 809   (let ((buffer (get-buffer-create "*notmuch-folders*")))
 810     (switch-to-buffer buffer)
 811     (let ((inhibit-read-only t)
 812           (n (line-number-at-pos)))
 813       (erase-buffer)
 814       (notmuch-folder-mode)
 815       (notmuch-folder-add notmuch-folders)
 816       (goto-char (point-min))
 817       (goto-line n))))
 818
 819 (provide 'notmuch)