ol-notmuch.el 4.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156
  1. ;;; org-notmuch.el --- Links to notmuch messages
  2. ;; Copyright (C) 2010-2014 Matthieu Lemerre
  3. ;; Author: Matthieu Lemerre <racin@free.fr>
  4. ;; Keywords: outlines, hypermedia, calendar, wp
  5. ;; Homepage: https://orgmode.org
  6. ;; This file is not part of GNU Emacs.
  7. ;; This file is free software; you can redistribute it and/or modify
  8. ;; it under the terms of the GNU General Public License as published by
  9. ;; the Free Software Foundation; either version 2, or (at your option)
  10. ;; any later version.
  11. ;; This file is distributed in the hope that it will be useful,
  12. ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  13. ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  14. ;; GNU General Public License for more details.
  15. ;; You should have received a copy of the GNU General Public License
  16. ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
  17. ;;; Commentary:
  18. ;; This file implements links to notmuch messages and "searchs". A
  19. ;; search is a query to be performed by notmuch; it is the equivalent
  20. ;; to folders in other mail clients. Similarly, mails are refered to
  21. ;; by a query, so both a link can refer to several mails.
  22. ;; Links have one the following form
  23. ;; notmuch:<search terms>
  24. ;; notmuch-search:<search terms>.
  25. ;; The first form open the queries in notmuch-show mode, whereas the
  26. ;; second link open it in notmuch-search mode. Note that queries are
  27. ;; performed at the time the link is opened, and the result may be
  28. ;; different from whet the link was stored.
  29. ;;; Code:
  30. (require 'ol)
  31. (require 'org)
  32. ;; customisable notmuch open functions
  33. (defcustom org-notmuch-open-function
  34. 'org-notmuch-follow-link
  35. "Function used to follow notmuch links.
  36. Should accept a notmuch search string as the sole argument."
  37. :group 'org-notmuch
  38. :version "24.4"
  39. :package-version '(Org . "8.0")
  40. :type 'function)
  41. (defcustom org-notmuch-search-open-function
  42. 'org-notmuch-search-follow-link
  43. "Function used to follow notmuch-search links.
  44. Should accept a notmuch search string as the sole argument."
  45. :group 'org-notmuch
  46. :version "24.4"
  47. :package-version '(Org . "8.0")
  48. :type 'function)
  49. (make-obsolete-variable 'org-notmuch-search-open-function nil "9.3")
  50. ;; Install the link type
  51. (org-link-set-parameters "notmuch"
  52. :follow #'org-notmuch-open
  53. :store #'org-notmuch-store-link)
  54. (defun org-notmuch-store-link ()
  55. "Store a link to a notmuch search or message."
  56. (when (memq major-mode '(notmuch-show-mode notmuch-tree-mode))
  57. (let* ((message-id (notmuch-show-get-message-id t))
  58. (subject (notmuch-show-get-subject))
  59. (to (notmuch-show-get-to))
  60. (from (notmuch-show-get-from))
  61. (date (org-trim (notmuch-show-get-date)))
  62. desc link)
  63. (org-store-link-props :type "notmuch" :from from :to to :date date
  64. :subject subject :message-id message-id)
  65. (setq desc (org-email-link-description))
  66. (setq link (concat "notmuch:id:" message-id))
  67. (org-add-link-props :link link :description desc)
  68. link)))
  69. (defun org-notmuch-open (path)
  70. "Follow a notmuch message link specified by PATH."
  71. (funcall org-notmuch-open-function path))
  72. (defun org-notmuch-follow-link (search)
  73. "Follow a notmuch link to SEARCH.
  74. Can link to more than one message, if so all matching messages are shown."
  75. (require 'notmuch)
  76. (notmuch-show search))
  77. (org-link-set-parameters "notmuch-search"
  78. :follow #'org-notmuch-search-open
  79. :store #'org-notmuch-search-store-link)
  80. (defun org-notmuch-search-store-link ()
  81. "Store a link to a notmuch search or message."
  82. (when (eq major-mode 'notmuch-search-mode)
  83. (let ((link (concat "notmuch-search:" notmuch-search-query-string))
  84. (desc (concat "Notmuch search: " notmuch-search-query-string)))
  85. (org-store-link-props :type "notmuch-search"
  86. :link link
  87. :description desc)
  88. link)))
  89. (defun org-notmuch-search-open (path)
  90. "Follow a notmuch message link specified by PATH."
  91. (message "%s" path)
  92. (org-notmuch-search-follow-link path))
  93. (defun org-notmuch-search-follow-link (search)
  94. "Follow a notmuch link by displaying SEARCH in notmuch-search mode."
  95. (require 'notmuch)
  96. (notmuch-search search))
  97. (org-link-set-parameters "notmuch-tree"
  98. :follow #'org-notmuch-tree-open
  99. :store #'org-notmuch-tree-store-link)
  100. (defun org-notmuch-tree-store-link ()
  101. "Store a link to a notmuch search or message."
  102. (when (eq major-mode 'notmuch-tree-mode)
  103. (let ((link (concat "notmuch-tree:" (notmuch-tree-get-query)))
  104. (desc (concat "Notmuch tree: " (notmuch-tree-get-query))))
  105. (org-store-link-props :type "notmuch-tree"
  106. :link link
  107. :description desc)
  108. link)))
  109. (defun org-notmuch-tree-open (path)
  110. "Follow a notmuch message link specified by PATH."
  111. (message "%s" path)
  112. (org-notmuch-tree-follow-link path))
  113. (defun org-notmuch-tree-follow-link (search)
  114. "Follow a notmuch link by displaying SEARCH in notmuch-tree mode."
  115. (require 'notmuch)
  116. (notmuch-tree search))
  117. (provide 'ol-notmuch)
  118. ;;; ol-notmuch.el ends here