summaryrefslogtreecommitdiff
path: root/lisp/org/ol-notmuch.el
diff options
context:
space:
mode:
Diffstat (limited to 'lisp/org/ol-notmuch.el')
-rw-r--r--lisp/org/ol-notmuch.el154
1 files changed, 154 insertions, 0 deletions
diff --git a/lisp/org/ol-notmuch.el b/lisp/org/ol-notmuch.el
new file mode 100644
index 00000000000..0fa0c5a2cbc
--- /dev/null
+++ b/lisp/org/ol-notmuch.el
@@ -0,0 +1,154 @@
+;;; ol-notmuch.el --- Links to notmuch messages
+
+;; Copyright (C) 2010-2014 Matthieu Lemerre
+
+;; Author: Matthieu Lemerre <racin@free.fr>
+;; Keywords: outlines, hypermedia, calendar, wp
+;; Homepage: https://orgmode.org
+
+;; 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
+;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+;; GNU General Public License for more details.
+
+;; You should have received a copy of the GNU General Public License
+;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
+
+;;; Commentary:
+
+;; This file implements links to notmuch messages and "searches". A
+;; search is a query to be performed by notmuch; it is the equivalent
+;; to folders in other mail clients. Similarly, mails are referred 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 when the link was stored.
+
+;;; Code:
+
+(require 'ol)
+
+;; customisable notmuch open functions
+(defcustom org-notmuch-open-function
+ 'org-notmuch-follow-link
+ "Function used to follow notmuch links.
+
+Should accept a notmuch search string as the sole argument."
+ :group 'org-notmuch
+ :version "24.4"
+ :package-version '(Org . "8.0")
+ :type 'function)
+
+(defcustom org-notmuch-search-open-function
+ 'org-notmuch-search-follow-link
+ "Function used to follow notmuch-search links.
+Should accept a notmuch search string as the sole argument."
+ :group 'org-notmuch
+ :version "24.4"
+ :package-version '(Org . "8.0")
+ :type 'function)
+
+(make-obsolete-variable 'org-notmuch-search-open-function nil "9.3")
+
+
+
+;; Install the link type
+(org-link-set-parameters "notmuch"
+ :follow #'org-notmuch-open
+ :store #'org-notmuch-store-link)
+
+(defun org-notmuch-store-link ()
+ "Store a link to a notmuch search or message."
+ (when (memq major-mode '(notmuch-show-mode notmuch-tree-mode))
+ (let* ((message-id (notmuch-show-get-message-id t))
+ (subject (notmuch-show-get-subject))
+ (to (notmuch-show-get-to))
+ (from (notmuch-show-get-from))
+ (date (org-trim (notmuch-show-get-date)))
+ desc link)
+ (org-link-store-props :type "notmuch" :from from :to to :date date
+ :subject subject :message-id message-id)
+ (setq desc (org-link-email-description))
+ (setq link (concat "notmuch:id:" message-id))
+ (org-link-add-props :link link :description desc)
+ link)))
+
+(defun org-notmuch-open (path _)
+ "Follow a notmuch message link specified by PATH."
+ (funcall org-notmuch-open-function 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 search))
+
+
+
+(org-link-set-parameters "notmuch-search"
+ :follow #'org-notmuch-search-open
+ :store #'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 (concat "notmuch-search:" notmuch-search-query-string))
+ (desc (concat "Notmuch search: " notmuch-search-query-string)))
+ (org-link-store-props :type "notmuch-search"
+ :link link
+ :description desc)
+ link)))
+
+(defun org-notmuch-search-open (path _)
+ "Follow a notmuch message link specified by PATH."
+ (message "%s" 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 search))
+
+
+
+(org-link-set-parameters "notmuch-tree"
+ :follow #'org-notmuch-tree-open
+ :store #'org-notmuch-tree-store-link)
+
+(defun org-notmuch-tree-store-link ()
+ "Store a link to a notmuch search or message."
+ (when (eq major-mode 'notmuch-tree-mode)
+ (let ((link (concat "notmuch-tree:" (notmuch-tree-get-query)))
+ (desc (concat "Notmuch tree: " (notmuch-tree-get-query))))
+ (org-link-store-props :type "notmuch-tree"
+ :link link
+ :description desc)
+ link)))
+
+(defun org-notmuch-tree-open (path _)
+ "Follow a notmuch message link specified by PATH."
+ (message "%s" path)
+ (org-notmuch-tree-follow-link path))
+
+(defun org-notmuch-tree-follow-link (search)
+ "Follow a notmuch link by displaying SEARCH in notmuch-tree mode."
+ (require 'notmuch)
+ (notmuch-tree search))
+
+(provide 'ol-notmuch)
+
+;;; ol-notmuch.el ends here