Browse Source

Add org-notmuch.el by Matthieu Lemerre to contrib/lisp/.

Bastien Guerry 10 years ago
2 changed files with 104 additions and 0 deletions
  1. 103 0
  2. 1 0

+ 103 - 0

@@ -0,0 +1,103 @@
+;;; org-notmuch.el --- Support for links to notmuch messages from within Org-mode
+;; Copyright (C) 2010  Matthieu Lemerre
+;; Author: Matthieu Lemerre <>
+;; Keywords: outlines, hypermedia, calendar, wp
+;; Homepage:
+;; This file is not part of GNU Emacs.
+;; This file is free software; you can redistribute it and/or modify
+;; it under the terms of the GNU General Public License as published by
+;; the Free Software Foundation; either version 2, or (at your option)
+;; any later version.
+;; This file is distributed in the hope that it will be useful,
+;; but WITHOUT ANY WARRANTY; without even the implied warranty of
+;; GNU General Public License for more details.
+;; You should have received a copy of the GNU General Public License
+;; along with GNU Emacs; see the file COPYING.  If not, write to
+;; the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+;; Boston, MA 02110-1301, USA.
+;;; Commentary:
+;; This file implements links to notmuch messages and "searchs". A
+;; search is a query to be performed by notmuch; it is the equivalent
+;; to folders in other mail clients. Similarly, mails are refered to
+;; by a query, so both a link can refer to several mails.
+;; Links have one the following form
+;; notmuch:<search terms>
+;; notmuch-search:<search terms>. 
+;; The first form open the queries in notmuch-show mode, whereas the
+;; second link open it in notmuch-search mode. Note that queries are
+;; performed at the time the link is opened, and the result may be
+;; different from whet the link was stored.
+;;; Code:
+;; Install the link type
+(org-add-link-type "notmuch" 'org-notmuch-open)
+(add-hook 'org-store-link-functions 'org-notmuch-store-link)
+(defun org-notmuch-store-link ()
+  "Store a link to a notmuch search or message."
+  (when (eq major-mode 'notmuch-show-mode)
+    (let* ((message-id (notmuch-show-get-prop :id))
+	   (subject (notmuch-show-get-subject))
+	   (to (notmuch-show-get-to))
+	   (from (notmuch-show-get-from))
+	   desc link)
+      (org-store-link-props :type "notmuch" :from from :to to
+       			    :subject subject :message-id message-id)
+      (setq desc (org-email-link-description))
+      (setq link (org-make-link "notmuch:"  "id:" message-id))
+      (org-add-link-props :link link :description desc)
+      link)))
+(defun org-notmuch-open (path)
+  "Follow a notmuch message link specified by PATH."
+  (org-notmuch-follow-link path))
+(defun org-notmuch-follow-link (search)
+  "Follow a notmuch link to SEARCH. 
+Can link to more than one message, if so all matching messages are shown."
+  (require 'notmuch)
+  (notmuch-show (org-link-unescape search)))
+(org-add-link-type "notmuch-search" 'org-notmuch-search-open)
+(add-hook 'org-store-link-functions 'org-notmuch-search-store-link)
+(defun org-notmuch-search-store-link ()
+  "Store a link to a notmuch search or message."
+  (when (eq major-mode 'notmuch-search-mode)
+    (let ((link (org-make-link "notmuch-search:" 
+			       (org-link-escape notmuch-search-query-string)))
+	  (desc (concat "Notmuch search: " notmuch-search-query-string)))
+      (org-store-link-props :type "notmuch-search" 
+			    :link link
+			    :description desc)
+      link)))
+(defun org-notmuch-search-open (path)
+  "Follow a notmuch message link specified by PATH."
+  (message path)
+  (org-notmuch-search-follow-link path))
+(defun org-notmuch-search-follow-link (search)
+  "Follow a notmuch link by displaying SEARCH in notmuch-search mode."
+  (require 'notmuch)
+  (notmuch-search (org-link-unescape search)))
+(provide 'org-notmuch)
+;;; org-notmuch.el ends here

+ 1 - 0

@@ -322,6 +322,7 @@ to add the symbol `xyz', and the package must have a call to
 	(const :tag "C  jira:              Add a jira:ticket protocol to Org-mode" org-jira)
 	(const :tag "C  learn:             SuperMemo's incremental learning algorithm" org-learn)
 	(const :tag "C  mairix:            Hook mairix search into Org-mode for different MUAs" org-mairix)
+	(const :tag "C  notmuch:           Provide org links to notmuch searches or messages" org-notmuch)
 	(const :tag "C  mac-iCal           Imports events from to the Emacs diary" org-mac-iCal)
 	(const :tag "C  mac-link-grabber   Grab links and URLs from various Mac applications" org-mac-link-grabber)
 	(const :tag "C  man:               Support for links to manpages in Org-mode" org-man)