aboutsummaryrefslogtreecommitdiffhomepage
path: root/lib/notmuch.h
diff options
context:
space:
mode:
authorGravatar Mark Walters <markwalters1009@gmail.com>2013-05-11 20:50:02 +0100
committerGravatar David Bremner <bremner@unb.ca>2013-05-13 21:32:03 -0300
commit38698d86596af64fa25c118dafef0249155ca7a4 (patch)
treee4bda30218f4afe74e77e892927398f3ccd5a31a /lib/notmuch.h
parentcf8aaafbad6815ebdfcd9b3b36cfe3ca5ff2764b (diff)
lib: add --exclude=all option
Adds a exclude all option to the lib which means that excluded messages are completely ignored (as if they had actually been deleted).
Diffstat (limited to 'lib/notmuch.h')
-rw-r--r--lib/notmuch.h22
1 files changed, 15 insertions, 7 deletions
diff --git a/lib/notmuch.h b/lib/notmuch.h
index 37393367..27b43ff6 100644
--- a/lib/notmuch.h
+++ b/lib/notmuch.h
@@ -500,14 +500,22 @@ typedef enum {
const char *
notmuch_query_get_query_string (notmuch_query_t *query);
+/* Exclude values for notmuch_query_set_omit_excluded */
+typedef enum {
+ NOTMUCH_EXCLUDE_FALSE,
+ NOTMUCH_EXCLUDE_TRUE,
+ NOTMUCH_EXCLUDE_ALL
+} notmuch_exclude_t;
+
/* Specify whether to omit excluded results or simply flag them. By
* default, this is set to TRUE.
*
- * If this is TRUE, notmuch_query_search_messages will omit excluded
- * messages from the results. notmuch_query_search_threads will omit
- * threads that match only in excluded messages, but will include all
- * messages in threads that match in at least one non-excluded
- * message.
+ * If set to TRUE or ALL, notmuch_query_search_messages will omit excluded
+ * messages from the results, and notmuch_query_search_threads will omit
+ * threads that match only in excluded messages. If set to TRUE,
+ * notmuch_query_search_threads will include all messages in threads that
+ * match in at least one non-excluded message. Otherwise, if set to ALL,
+ * notmuch_query_search_threads will omit excluded messages from all threads.
*
* The performance difference when calling
* notmuch_query_search_messages should be relatively small (and both
@@ -516,9 +524,9 @@ notmuch_query_get_query_string (notmuch_query_t *query);
* excluded messages as it does not need to construct the threads that
* only match in excluded messages.
*/
-
void
-notmuch_query_set_omit_excluded (notmuch_query_t *query, notmuch_bool_t omit_excluded);
+notmuch_query_set_omit_excluded (notmuch_query_t *query,
+ notmuch_exclude_t omit_excluded);
/* Specify the sorting desired for this query. */
void