;
; Authors: Carl Worth <cworth@cworth.org>
+; This is an emacs-based interface to the notmuch mail system.
+;
+; You will first need to have the notmuch program installed and have a
+; notmuch database built in order to use this. See
+; http://notmuchmail.org for details.
+;
+; To install this software, copy it to a directory that is on the
+; `load-path' variable within emacs (a good candidate is
+; /usr/local/share/emacs/site-lisp). If you are viewing this from the
+; notmuch source distribution then you can simply run:
+;
+; sudo make install-emacs
+;
+; to install it.
+;
+; Then, to actually run it, add:
+;
+; (require 'notmuch)
+;
+; to your ~/.emacs file, and then run "M-x notmuch" from within emacs,
+; or run:
+;
+; emacs -f notmuch
+;
+; Have fun, and let us know if you have any comment, questions, or
+; kudos: Notmuch list <notmuch@notmuchmail.org> (subscription is not
+; required, but is available from http://notmuchmail.org).
+
(require 'cl)
(require 'mm-view)
(defvar notmuch-show-signature-lines-max 12
"Maximum length of signature that will be hidden by default.")
-(set 'notmuch-show-message-begin-regexp "\fmessage{")
-(set 'notmuch-show-message-end-regexp "\fmessage}")
-(set 'notmuch-show-header-begin-regexp "\fheader{")
-(set 'notmuch-show-header-end-regexp "\fheader}")
-(set 'notmuch-show-body-begin-regexp "\fbody{")
-(set 'notmuch-show-body-end-regexp "\fbody}")
-(set 'notmuch-show-attachment-begin-regexp "\fattachment{")
-(set 'notmuch-show-attachment-end-regexp "\fattachment}")
-(set 'notmuch-show-part-begin-regexp "\fpart{")
-(set 'notmuch-show-part-end-regexp "\fpart}")
-(set 'notmuch-show-marker-regexp "\f\\(message\\|header\\|body\\|attachment\\|part\\)[{}].*$")
-
-(set 'notmuch-show-id-regexp "\\(id:[^ ]*\\)")
-(set 'notmuch-show-depth-regexp " depth:\\([0-9]*\\) ")
-(set 'notmuch-show-filename-regexp "filename:\\(.*\\)$")
-(set 'notmuch-show-tags-regexp "(\\([^)]*\\))$")
+(defvar notmuch-command "notmuch"
+ "Command to run the notmuch binary.")
+
+(defvar notmuch-show-message-begin-regexp "\fmessage{")
+(defvar notmuch-show-message-end-regexp "\fmessage}")
+(defvar notmuch-show-header-begin-regexp "\fheader{")
+(defvar notmuch-show-header-end-regexp "\fheader}")
+(defvar notmuch-show-body-begin-regexp "\fbody{")
+(defvar notmuch-show-body-end-regexp "\fbody}")
+(defvar notmuch-show-attachment-begin-regexp "\fattachment{")
+(defvar notmuch-show-attachment-end-regexp "\fattachment}")
+(defvar notmuch-show-part-begin-regexp "\fpart{")
+(defvar notmuch-show-part-end-regexp "\fpart}")
+(defvar notmuch-show-marker-regexp "\f\\(message\\|header\\|body\\|attachment\\|part\\)[{}].*$")
+
+(defvar notmuch-show-id-regexp "\\(id:[^ ]*\\)")
+(defvar notmuch-show-depth-regexp " depth:\\([0-9]*\\) ")
+(defvar notmuch-show-filename-regexp "filename:\\(.*\\)$")
+(defvar notmuch-show-tags-regexp "(\\([^)]*\\))$")
+
+(defvar notmuch-show-parent-buffer nil)
+(defvar notmuch-show-body-read-visible nil)
+(defvar notmuch-show-citations-visible nil)
+(defvar notmuch-show-signatures-visible nil)
+(defvar notmuch-show-headers-visible nil)
; XXX: This should be a generic function in emacs somewhere, not here
(defun point-invisible-p ()
(mm-display-parts (mm-dissect-buffer))
(kill-this-buffer))))
+(defun notmuch-reply (query-string)
+ (switch-to-buffer (generate-new-buffer "notmuch-draft"))
+ (call-process notmuch-command nil t nil "reply" query-string)
+ (goto-char (point-min))
+ (if (re-search-forward "^$" nil t)
+ (progn
+ (insert "--text follows this line--")
+ (forward-line)))
+ (message-mode))
+
(defun notmuch-show-reply ()
"Begin composing a reply to the current message in a new buffer."
(interactive)
(let ((message-id (notmuch-show-get-message-id)))
- (switch-to-buffer (generate-new-buffer "notmuch-draft"))
- (call-process "notmuch" nil t nil "reply" message-id)
- (goto-char (point-min))
- (if (re-search-forward "^$" nil t)
- (progn
- (insert "--text follows this line--")
- (forward-line)))
- (message-mode)))
+ (notmuch-reply message-id)))
(defun notmuch-show-pipe-message (command)
"Pipe the contents of the current message to the given command.
(if last
(notmuch-show-archive-thread))))))
+(defun notmuch-toggle-invisible-action (cite-button)
+ (let ((invis-spec (button-get button 'invisibility-spec)))
+ (if (invisible-p invis-spec)
+ (remove-from-invisibility-spec invis-spec)
+ (add-to-invisibility-spec invis-spec)
+ ))
+ (goto-char (button-end cite-button)))
+
(defun notmuch-show-markup-citations-region (beg end depth)
(goto-char beg)
(beginning-of-line)
(progn
(while (looking-at citation)
(forward-line))
- (let ((overlay (make-overlay beg-sub (point))))
- (overlay-put overlay 'invisible 'notmuch-show-citation)
- (overlay-put overlay 'before-string
- (concat indent
- "[" (number-to-string (count-lines beg-sub (point)))
- "-line citation. Press 'c' to show.]\n")))))
+ (let ((overlay (make-overlay beg-sub (point)))
+ (invis-spec (make-symbol "notmuch-citation-region")))
+ (add-to-invisibility-spec invis-spec)
+ (overlay-put overlay 'invisible invis-spec)
+ (let (
+ (p (point))
+ (cite-button-text
+ (concat "[" (number-to-string (count-lines beg-sub (point)))
+ "-line citation.]"))
+ )
+ (goto-char (- beg-sub 1))
+ (insert (concat "\n" indent))
+ (let ((cite-button (insert-button cite-button-text)))
+ (button-put cite-button 'invisibility-spec invis-spec)
+ (button-put cite-button 'action 'notmuch-toggle-invisible-action)
+ (button-put cite-button 'help-echo
+ "mouse-2, RET: Show citation")
+
+ )
+ (insert "\n")
+ (goto-char (+ (length cite-button-text) p))
+ ))))
(move-to-column depth)
(if (looking-at notmuch-show-signature-regexp)
(let ((sig-lines (- (count-lines beg-sub end) 1)))
(if (<= sig-lines notmuch-show-signature-lines-max)
(progn
- (overlay-put (make-overlay beg-sub end)
- 'invisible 'notmuch-show-signature)
- (overlay-put (make-overlay beg (- beg-sub 1))
- 'after-string
- (concat "\n" indent
- "[" (number-to-string sig-lines)
- "-line signature. Press 's' to show.]"))
- (goto-char end)))))
+ (let ((invis-spec (make-symbol "notmuch-signature-region")))
+ (add-to-invisibility-spec invis-spec)
+ (overlay-put (make-overlay beg-sub end)
+ 'invisible invis-spec)
+
+ (goto-char (- beg-sub 1))
+ (insert (concat "\n" indent))
+ (let ((sig-button (insert-button
+ (concat "[" (number-to-string sig-lines)
+ "-line signature.]"))))
+ (button-put sig-button 'invisibility-spec invis-spec)
+ (button-put sig-button 'action
+ 'notmuch-toggle-invisible-action)
+ (button-put sig-button 'help-echo
+ "mouse-2, RET: Show signature")
+ )
+ (insert "\n")
+ (goto-char end))))))
(forward-line))))
(defun notmuch-show-markup-part (beg end depth)
(let ((beg (point-marker)))
(end-of-line)
; Inverse video for subject
- (overlay-put (make-overlay beg (point)) 'face '((cons :inverse-video t)))
+ (overlay-put (make-overlay beg (point)) 'face '(:inverse-video t))
(forward-line 2)
(let ((beg-hidden (point-marker)))
(re-search-forward notmuch-show-header-end-regexp)
(beginning-of-line)
(let ((end (point-marker)))
+ (goto-char beg)
+ (forward-line)
+ (while (looking-at "[A-Za-z][-A-Za-z0-9]*:")
+ (beginning-of-line)
+ (overlay-put (make-overlay (point) (re-search-forward ":"))
+ 'face 'bold)
+ (forward-line)
+ )
(indent-rigidly beg end depth)
(overlay-put (make-overlay beg-hidden end)
'invisible 'notmuch-show-header)
+ (goto-char end)
+ (insert "\n")
(set-marker beg nil)
(set-marker beg-hidden nil)
(set-marker end nil)
:options '(goto-address)
:group 'notmuch)
+(defcustom notmuch-search-hook nil
+ "List of functions to call when notmuch displays the search results."
+ :type 'hook
+ :options '(hl-line-mode)
+ :group 'notmuch)
+
+; Make show mode a bit prettier, highlighting URLs and using word wrap
+
+(defun notmuch-show-pretty-hook ()
+ (goto-address-mode 1)
+ (visual-line-mode))
+
+(add-hook 'notmuch-show-hook 'notmuch-show-pretty-hook)
+(add-hook 'notmuch-search-hook
+ (lambda()
+ (hl-line-mode 1) ))
+
(defun notmuch-show (thread-id &optional parent-buffer)
"Run \"notmuch show\" with the given thread ID and display results.
(let ((proc (get-buffer-process (current-buffer)))
(inhibit-read-only t))
(if proc
- (error "notmuch search process already running for query `%s'" query)
+ (error "notmuch search process already running for query `%s'" thread-id)
)
(erase-buffer)
(goto-char (point-min))
(save-excursion
- (call-process "notmuch" nil t nil "show" thread-id)
+ (call-process notmuch-command nil t nil "show" thread-id)
(notmuch-show-markup-messages)
)
(run-hooks 'notmuch-show-hook)
(define-key map "o" 'notmuch-search-toggle-order)
(define-key map "p" 'previous-line)
(define-key map "q" 'kill-this-buffer)
+ (define-key map "r" 'notmuch-search-reply-to-thread)
(define-key map "s" 'notmuch-search)
(define-key map "t" 'notmuch-search-filter-by-tag)
(define-key map "x" 'kill-this-buffer)
"Keymap for \"notmuch search\" buffers.")
(fset 'notmuch-search-mode-map notmuch-search-mode-map)
+(defvar notmuch-search-query-string)
+(defvar notmuch-search-oldest-first)
+
(defun notmuch-search-scroll-up ()
"Scroll up, moving point to last message in thread if at end."
(interactive)
(goto-char (window-start))
(scroll-down nil)))
-(defun notmuch-search-goto-last-thread (&optional arg)
+(defun notmuch-search-goto-last-thread ()
"Move point to the last thread in the buffer."
- (interactive "^P")
- (end-of-buffer arg)
+ (interactive)
+ (goto-char (point-max))
(forward-line -1))
;;;###autoload
(notmuch-show thread-id (current-buffer))
(error "End of search results"))))
+(defun notmuch-search-reply-to-thread ()
+ "Begin composing a reply to the entire current thread in a new buffer."
+ (interactive)
+ (let ((message-id (notmuch-search-find-thread-id)))
+ (notmuch-reply message-id)))
+
(defun notmuch-call-notmuch-process (&rest args)
"Synchronously invoke \"notmuch\" with the given list of arguments.
(let ((error-buffer (get-buffer-create "*Notmuch errors*")))
(with-current-buffer error-buffer
(erase-buffer))
- (if (eq (apply 'call-process "notmuch" nil error-buffer nil args) 0)
+ (if (eq (apply 'call-process notmuch-command nil error-buffer nil args) 0)
(point)
(progn
(with-current-buffer error-buffer
(goto-char (point-min))
(save-excursion
(if oldest-first
- (call-process "notmuch" nil t nil "search" "--sort=oldest-first" query)
- (call-process "notmuch" nil t nil "search" "--sort=newest-first" query))
+ (call-process notmuch-command nil t nil "search" "--sort=oldest-first" query)
+ (call-process notmuch-command nil t nil "search" "--sort=newest-first" query))
(notmuch-search-markup-thread-ids)
- ))))
+ ))
+ (run-hooks 'notmuch-search-hook)))
(defun notmuch-search-refresh-view ()
"Refresh the current view.
(interactive)
(notmuch-search "tag:inbox" t))
+(setq mail-user-agent 'message-user-agent)
+
(provide 'notmuch)