-;; notmuch-query.el --- provide an emacs api to query notmuch
+;;; notmuch-query.el --- provide an emacs api to query notmuch -*- lexical-binding: t -*-
;;
;; Copyright © David Bremner
;;
;; General Public License for more details.
;;
;; You should have received a copy of the GNU General Public License
-;; along with Notmuch. If not, see <http://www.gnu.org/licenses/>.
+;; along with Notmuch. If not, see <https://www.gnu.org/licenses/>.
;;
;; Authors: David Bremner <david@tethera.net>
+;;; Code:
+
(require 'notmuch-lib)
-(require 'json)
-(defun notmuch-query-get-threads (search-terms &rest options)
- "Return a list of threads of messages matching SEARCH-TERMS.
+;;; Basic query function
-A thread is a forest or list of trees. A tree is a two element
-list where the first element is a message, and the second element
-is a possibly empty forest of replies.
-"
- (let ((args (append '("show" "--format=json") search-terms))
- (json-object-type 'plist)
- (json-array-type 'list)
- (json-false 'nil))
- (with-temp-buffer
- (progn
- (apply 'call-process (append (list notmuch-command nil t nil) args))
- (goto-char (point-min))
- (json-read)))))
+(define-obsolete-function-alias
+ 'notmuch-query-get-threads
+ #'notmuch--run-show
+ "notmuch 0.37")
-;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
-;; Mapping functions across collections of messages.
+;;; Mapping functions across collections of messages
(defun notmuch-query-map-aux (mapper function seq)
- "private function to do the actual mapping and flattening"
- (apply 'append
- (mapcar
- (lambda (tree)
- (funcall mapper fn tree))
- seq)))
+ "Private function to do the actual mapping and flattening."
+ (cl-mapcan (lambda (tree)
+ (funcall mapper function tree))
+ seq))
(defun notmuch-query-map-threads (fn threads)
- "apply FN to every thread in THREADS. Flatten results to a list.
-
-See the function notmuch-query-get-threads for more information."
+ "Apply function FN to every thread in THREADS.
+Flatten results to a list. See the function
+`notmuch-query-get-threads' for more information."
(notmuch-query-map-aux 'notmuch-query-map-forest fn threads))
(defun notmuch-query-map-forest (fn forest)
- "apply function to every message in a forest. Flatten results to a list.
-
-See the function notmuch-query-get-threads for more information.
-"
+ "Apply function FN to every message in FOREST.
+Flatten results to a list. See the function
+`notmuch-query-get-threads' for more information."
(notmuch-query-map-aux 'notmuch-query-map-tree fn forest))
(defun notmuch-query-map-tree (fn tree)
- "Apply function FN to every message in TREE. Flatten results to a list
+ "Apply function FN to every message in TREE.
+Flatten results to a list. See the function
+`notmuch--run-show' for more information."
+ (cons (funcall fn (car tree))
+ (notmuch-query-map-forest fn (cadr tree))))
-See the function notmuch-query-get-threads for more information."
- (cons (funcall fn (car tree)) (notmuch-query-map-forest fn (cadr tree))))
-
-;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
-;; Predefined queries
+;;; Predefined queries
(defun notmuch-query-get-message-ids (&rest search-terms)
- "Return a list of message-ids of messages that match SEARCH-TERMS"
+ "Return a list of message-ids of messages that match SEARCH-TERMS."
(notmuch-query-map-threads
(lambda (msg) (plist-get msg :id))
- (notmuch-query-get-threads search-terms)))
+ (notmuch--run-show search-terms)))
+
+;;; Everything in this library is obsolete
+(dolist (fun '(map-aux map-threads map-forest map-tree get-message-ids))
+ (make-obsolete (intern (format "notmuch-query-%s" fun)) nil "notmuch 0.37"))
(provide 'notmuch-query)
+
+;;; notmuch-query.el ends here