lib: Correct out-of-date doc comment
[notmuch] / lib / notmuch.h
1 /* notmuch - Not much of an email library, (just index and search)
2  *
3  * Copyright © 2009 Carl Worth
4  *
5  * This program is free software: you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License as published by
7  * the Free Software Foundation, either version 3 of the License, or
8  * (at your option) any later version.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this program.  If not, see http://www.gnu.org/licenses/ .
17  *
18  * Author: Carl Worth <cworth@cworth.org>
19  */
20
21 #ifndef NOTMUCH_H
22 #define NOTMUCH_H
23
24 #ifdef  __cplusplus
25 # define NOTMUCH_BEGIN_DECLS  extern "C" {
26 # define NOTMUCH_END_DECLS    }
27 #else
28 # define NOTMUCH_BEGIN_DECLS
29 # define NOTMUCH_END_DECLS
30 #endif
31
32 NOTMUCH_BEGIN_DECLS
33
34 #include <time.h>
35
36 #ifndef FALSE
37 #define FALSE 0
38 #endif
39
40 #ifndef TRUE
41 #define TRUE 1
42 #endif
43
44 typedef int notmuch_bool_t;
45
46 /* Status codes used for the return values of most functions.
47  *
48  * A zero value (NOTMUCH_STATUS_SUCCESS) indicates that the function
49  * completed without error. Any other value indicates an error as
50  * follows:
51  *
52  * NOTMUCH_STATUS_SUCCESS: No error occurred.
53  *
54  * NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory
55  *
56  * XXX: We don't really want to expose this lame XAPIAN_EXCEPTION
57  * value. Instead we should map to things like DATABASE_LOCKED or
58  * whatever.
59  *
60  * NOTMUCH_STATUS_READ_ONLY_DATABASE: An attempt was made to write to
61  *      a database opened in read-only mode.
62  *
63  * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred
64  *
65  * NOTMUCH_STATUS_FILE_ERROR: An error occurred trying to read or
66  *      write to a file (this could be file not found, permission
67  *      denied, etc.)
68  *
69  * NOTMUCH_STATUS_FILE_NOT_EMAIL: A file was presented that doesn't
70  *      appear to be an email message.
71  *
72  * NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID: A file contains a message ID
73  *      that is identical to a message already in the database.
74  *
75  * NOTMUCH_STATUS_NULL_POINTER: The user erroneously passed a NULL
76  *      pointer to a notmuch function.
77  *
78  * NOTMUCH_STATUS_TAG_TOO_LONG: A tag value is too long (exceeds
79  *      NOTMUCH_TAG_MAX)
80  *
81  * NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW: The notmuch_message_thaw
82  *      function has been called more times than notmuch_message_freeze.
83  *
84  * NOTMUCH_STATUS_UNBALANCED_ATOMIC: notmuch_database_end_atomic has
85  *      been called more times than notmuch_database_begin_atomic.
86  *
87  * And finally:
88  *
89  * NOTMUCH_STATUS_LAST_STATUS: Not an actual status value. Just a way
90  *      to find out how many valid status values there are.
91  */
92 typedef enum _notmuch_status {
93     NOTMUCH_STATUS_SUCCESS = 0,
94     NOTMUCH_STATUS_OUT_OF_MEMORY,
95     NOTMUCH_STATUS_READ_ONLY_DATABASE,
96     NOTMUCH_STATUS_XAPIAN_EXCEPTION,
97     NOTMUCH_STATUS_FILE_ERROR,
98     NOTMUCH_STATUS_FILE_NOT_EMAIL,
99     NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID,
100     NOTMUCH_STATUS_NULL_POINTER,
101     NOTMUCH_STATUS_TAG_TOO_LONG,
102     NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW,
103     NOTMUCH_STATUS_UNBALANCED_ATOMIC,
104
105     NOTMUCH_STATUS_LAST_STATUS
106 } notmuch_status_t;
107
108 /* Get a string representation of a notmuch_status_t value.
109  *
110  * The result is read-only.
111  */
112 const char *
113 notmuch_status_to_string (notmuch_status_t status);
114
115 /* Various opaque data types. For each notmuch_<foo>_t see the various
116  * notmuch_<foo> functions below. */
117 typedef struct _notmuch_database notmuch_database_t;
118 typedef struct _notmuch_query notmuch_query_t;
119 typedef struct _notmuch_threads notmuch_threads_t;
120 typedef struct _notmuch_thread notmuch_thread_t;
121 typedef struct _notmuch_messages notmuch_messages_t;
122 typedef struct _notmuch_message notmuch_message_t;
123 typedef struct _notmuch_tags notmuch_tags_t;
124 typedef struct _notmuch_directory notmuch_directory_t;
125 typedef struct _notmuch_filenames notmuch_filenames_t;
126
127 /* Create a new, empty notmuch database located at 'path'.
128  *
129  * The path should be a top-level directory to a collection of
130  * plain-text email messages (one message per file). This call will
131  * create a new ".notmuch" directory within 'path' where notmuch will
132  * store its data.
133  *
134  * After a successful call to notmuch_database_create, the returned
135  * database will be open so the caller should call
136  * notmuch_database_destroy when finished with it.
137  *
138  * The database will not yet have any data in it
139  * (notmuch_database_create itself is a very cheap function). Messages
140  * contained within 'path' can be added to the database by calling
141  * notmuch_database_add_message.
142  *
143  * In case of any failure, this function returns an error status and
144  * sets *database to NULL (after printing an error message on stderr).
145  *
146  * Return value:
147  *
148  * NOTMUCH_STATUS_SUCCESS: Successfully created the database.
149  *
150  * NOTMUCH_STATUS_NULL_POINTER: The given 'path' argument is NULL.
151  *
152  * NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory.
153  *
154  * NOTMUCH_STATUS_FILE_ERROR: An error occurred trying to create the
155  *      database file (such as permission denied, or file not found,
156  *      etc.), or the database already exists.
157  *
158  * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred.
159  */
160 notmuch_status_t
161 notmuch_database_create (const char *path, notmuch_database_t **database);
162
163 typedef enum {
164     NOTMUCH_DATABASE_MODE_READ_ONLY = 0,
165     NOTMUCH_DATABASE_MODE_READ_WRITE
166 } notmuch_database_mode_t;
167
168 /* Open an existing notmuch database located at 'path'.
169  *
170  * The database should have been created at some time in the past,
171  * (not necessarily by this process), by calling
172  * notmuch_database_create with 'path'. By default the database should be
173  * opened for reading only. In order to write to the database you need to
174  * pass the NOTMUCH_DATABASE_MODE_READ_WRITE mode.
175  *
176  * An existing notmuch database can be identified by the presence of a
177  * directory named ".notmuch" below 'path'.
178  *
179  * The caller should call notmuch_database_destroy when finished with
180  * this database.
181  *
182  * In case of any failure, this function returns an error status and
183  * sets *database to NULL (after printing an error message on stderr).
184  *
185  * Return value:
186  *
187  * NOTMUCH_STATUS_SUCCESS: Successfully opened the database.
188  *
189  * NOTMUCH_STATUS_NULL_POINTER: The given 'path' argument is NULL.
190  *
191  * NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory.
192  *
193  * NOTMUCH_STATUS_FILE_ERROR: An error occurred trying to open the
194  *      database file (such as permission denied, or file not found,
195  *      etc.), or the database version is unknown.
196  *
197  * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred.
198  */
199 notmuch_status_t
200 notmuch_database_open (const char *path,
201                        notmuch_database_mode_t mode,
202                        notmuch_database_t **database);
203
204 /* Close the given notmuch database.
205  *
206  * After notmuch_database_close has been called, calls to other
207  * functions on objects derived from this database may either behave
208  * as if the database had not been closed (e.g., if the required data
209  * has been cached) or may fail with a
210  * NOTMUCH_STATUS_XAPIAN_EXCEPTION.
211  *
212  * notmuch_database_close can be called multiple times.  Later calls
213  * have no effect.
214  */
215 void
216 notmuch_database_close (notmuch_database_t *database);
217
218 /* Destroy the notmuch database, closing it if necessary and freeing
219 * all associated resources. */
220 void
221 notmuch_database_destroy (notmuch_database_t *database);
222
223 /* Return the database path of the given database.
224  *
225  * The return value is a string owned by notmuch so should not be
226  * modified nor freed by the caller. */
227 const char *
228 notmuch_database_get_path (notmuch_database_t *database);
229
230 /* Return the database format version of the given database. */
231 unsigned int
232 notmuch_database_get_version (notmuch_database_t *database);
233
234 /* Does this database need to be upgraded before writing to it?
235  *
236  * If this function returns TRUE then no functions that modify the
237  * database (notmuch_database_add_message, notmuch_message_add_tag,
238  * notmuch_directory_set_mtime, etc.) will work unless the function
239  * notmuch_database_upgrade is called successfully first. */
240 notmuch_bool_t
241 notmuch_database_needs_upgrade (notmuch_database_t *database);
242
243 /* Upgrade the current database.
244  *
245  * After opening a database in read-write mode, the client should
246  * check if an upgrade is needed (notmuch_database_needs_upgrade) and
247  * if so, upgrade with this function before making any modifications.
248  *
249  * The optional progress_notify callback can be used by the caller to
250  * provide progress indication to the user. If non-NULL it will be
251  * called periodically with 'progress' as a floating-point value in
252  * the range of [0.0 .. 1.0] indicating the progress made so far in
253  * the upgrade process.
254  */
255 notmuch_status_t
256 notmuch_database_upgrade (notmuch_database_t *database,
257                           void (*progress_notify) (void *closure,
258                                                    double progress),
259                           void *closure);
260
261 /* Begin an atomic database operation.
262  *
263  * Any modifications performed between a successful begin and a
264  * notmuch_database_end_atomic will be applied to the database
265  * atomically.  Note that, unlike a typical database transaction, this
266  * only ensures atomicity, not durability; neither begin nor end
267  * necessarily flush modifications to disk.
268  *
269  * Atomic sections may be nested.  begin_atomic and end_atomic must
270  * always be called in pairs.
271  *
272  * Return value:
273  *
274  * NOTMUCH_STATUS_SUCCESS: Successfully entered atomic section.
275  *
276  * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred;
277  *      atomic section not entered.
278  */
279 notmuch_status_t
280 notmuch_database_begin_atomic (notmuch_database_t *notmuch);
281
282 /* Indicate the end of an atomic database operation.
283  *
284  * Return value:
285  *
286  * NOTMUCH_STATUS_SUCCESS: Successfully completed atomic section.
287  *
288  * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred;
289  *      atomic section not ended.
290  *
291  * NOTMUCH_STATUS_UNBALANCED_ATOMIC: The database is not currently in
292  *      an atomic section.
293  */
294 notmuch_status_t
295 notmuch_database_end_atomic (notmuch_database_t *notmuch);
296
297 /* Retrieve a directory object from the database for 'path'.
298  *
299  * Here, 'path' should be a path relative to the path of 'database'
300  * (see notmuch_database_get_path), or else should be an absolute path
301  * with initial components that match the path of 'database'.
302  *
303  * If this directory object does not exist in the database, this
304  * returns NOTMUCH_STATUS_SUCCESS and sets *directory to NULL.
305  *
306  * Return value:
307  *
308  * NOTMUCH_STATUS_SUCCESS: Successfully retrieved directory.
309  *
310  * NOTMUCH_STATUS_NULL_POINTER: The given 'directory' argument is NULL.
311  *
312  * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred;
313  *      directory not retrieved.
314  */
315 notmuch_status_t
316 notmuch_database_get_directory (notmuch_database_t *database,
317                                 const char *path,
318                                 notmuch_directory_t **directory);
319
320 /* Add a new message to the given notmuch database or associate an
321  * additional filename with an existing message.
322  *
323  * Here, 'filename' should be a path relative to the path of
324  * 'database' (see notmuch_database_get_path), or else should be an
325  * absolute filename with initial components that match the path of
326  * 'database'.
327  *
328  * The file should be a single mail message (not a multi-message mbox)
329  * that is expected to remain at its current location, (since the
330  * notmuch database will reference the filename, and will not copy the
331  * entire contents of the file.
332  *
333  * If another message with the same message ID already exists in the
334  * database, rather than creating a new message, this adds 'filename'
335  * to the list of the filenames for the existing message.
336  *
337  * If 'message' is not NULL, then, on successful return
338  * (NOTMUCH_STATUS_SUCCESS or NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID) '*message'
339  * will be initialized to a message object that can be used for things
340  * such as adding tags to the just-added message. The user should call
341  * notmuch_message_destroy when done with the message. On any failure
342  * '*message' will be set to NULL.
343  *
344  * Return value:
345  *
346  * NOTMUCH_STATUS_SUCCESS: Message successfully added to database.
347  *
348  * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred,
349  *      message not added.
350  *
351  * NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID: Message has the same message
352  *      ID as another message already in the database. The new
353  *      filename was successfully added to the message in the database
354  *      (if not already present) and the existing message is returned.
355  *
356  * NOTMUCH_STATUS_FILE_ERROR: an error occurred trying to open the
357  *      file, (such as permission denied, or file not found,
358  *      etc.). Nothing added to the database.
359  *
360  * NOTMUCH_STATUS_FILE_NOT_EMAIL: the contents of filename don't look
361  *      like an email message. Nothing added to the database.
362  *
363  * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
364  *      mode so no message can be added.
365  */
366 notmuch_status_t
367 notmuch_database_add_message (notmuch_database_t *database,
368                               const char *filename,
369                               notmuch_message_t **message);
370
371 /* Remove a message filename from the given notmuch database. If the
372  * message has no more filenames, remove the message.
373  *
374  * If the same message (as determined by the message ID) is still
375  * available via other filenames, then the message will persist in the
376  * database for those filenames. When the last filename is removed for
377  * a particular message, the database content for that message will be
378  * entirely removed.
379  *
380  * Return value:
381  *
382  * NOTMUCH_STATUS_SUCCESS: The last filename was removed and the
383  *      message was removed from the database.
384  *
385  * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred,
386  *      message not removed.
387  *
388  * NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID: This filename was removed but
389  *      the message persists in the database with at least one other
390  *      filename.
391  *
392  * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
393  *      mode so no message can be removed.
394  */
395 notmuch_status_t
396 notmuch_database_remove_message (notmuch_database_t *database,
397                                  const char *filename);
398
399 /* Find a message with the given message_id.
400  *
401  * If a message with the given message_id is found then, on successful return
402  * (NOTMUCH_STATUS_SUCCESS) '*message' will be initialized to a message
403  * object.  The caller should call notmuch_message_destroy when done with the
404  * message.
405  *
406  * On any failure or when the message is not found, this function initializes
407  * '*message' to NULL. This means, when NOTMUCH_STATUS_SUCCESS is returned, the
408  * caller is supposed to check '*message' for NULL to find out whether the
409  * message with the given message_id was found.
410  *
411  * Return value:
412  *
413  * NOTMUCH_STATUS_SUCCESS: Successful return, check '*message'.
414  *
415  * NOTMUCH_STATUS_NULL_POINTER: The given 'message' argument is NULL
416  *
417  * NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory, creating message object
418  *
419  * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred
420  */
421 notmuch_status_t
422 notmuch_database_find_message (notmuch_database_t *database,
423                                const char *message_id,
424                                notmuch_message_t **message);
425
426 /* Find a message with the given filename.
427  *
428  * If the database contains a message with the given filename then, on
429  * successful return (NOTMUCH_STATUS_SUCCESS) '*message' will be initialized to
430  * a message object. The caller should call notmuch_message_destroy when done
431  * with the message.
432  *
433  * On any failure or when the message is not found, this function initializes
434  * '*message' to NULL. This means, when NOTMUCH_STATUS_SUCCESS is returned, the
435  * caller is supposed to check '*message' for NULL to find out whether the
436  * message with the given filename is found.
437  *
438  * Return value:
439  *
440  * NOTMUCH_STATUS_SUCCESS: Successful return, check '*message'
441  *
442  * NOTMUCH_STATUS_NULL_POINTER: The given 'message' argument is NULL
443  *
444  * NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory, creating the message object
445  *
446  * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred
447  */
448 notmuch_status_t
449 notmuch_database_find_message_by_filename (notmuch_database_t *notmuch,
450                                            const char *filename,
451                                            notmuch_message_t **message);
452
453 /* Return a list of all tags found in the database.
454  *
455  * This function creates a list of all tags found in the database. The
456  * resulting list contains all tags from all messages found in the database.
457  *
458  * On error this function returns NULL.
459  */
460 notmuch_tags_t *
461 notmuch_database_get_all_tags (notmuch_database_t *db);
462
463 /* Create a new query for 'database'.
464  *
465  * Here, 'database' should be an open database, (see
466  * notmuch_database_open and notmuch_database_create).
467  *
468  * For the query string, we'll document the syntax here more
469  * completely in the future, but it's likely to be a specialized
470  * version of the general Xapian query syntax:
471  *
472  * http://xapian.org/docs/queryparser.html
473  *
474  * As a special case, passing either a length-zero string, (that is ""),
475  * or a string consisting of a single asterisk (that is "*"), will
476  * result in a query that returns all messages in the database.
477  *
478  * See notmuch_query_set_sort for controlling the order of results.
479  * See notmuch_query_search_messages and notmuch_query_search_threads
480  * to actually execute the query.
481  *
482  * User should call notmuch_query_destroy when finished with this
483  * query.
484  *
485  * Will return NULL if insufficient memory is available.
486  */
487 notmuch_query_t *
488 notmuch_query_create (notmuch_database_t *database,
489                       const char *query_string);
490
491 /* Sort values for notmuch_query_set_sort */
492 typedef enum {
493     NOTMUCH_SORT_OLDEST_FIRST,
494     NOTMUCH_SORT_NEWEST_FIRST,
495     NOTMUCH_SORT_MESSAGE_ID,
496     NOTMUCH_SORT_UNSORTED
497 } notmuch_sort_t;
498
499 /* Return the query_string of this query. See notmuch_query_create. */
500 const char *
501 notmuch_query_get_query_string (notmuch_query_t *query);
502
503 /* Exclude values for notmuch_query_set_omit_excluded. The strange
504  * order is to maintain backward compatibility: the old FALSE/TRUE
505  * options correspond to the new
506  * NOTMUCH_EXCLUDE_FLAG/NOTMUCH_EXCLUDE_TRUE options.
507  */
508 typedef enum {
509     NOTMUCH_EXCLUDE_FLAG,
510     NOTMUCH_EXCLUDE_TRUE,
511     NOTMUCH_EXCLUDE_FALSE,
512     NOTMUCH_EXCLUDE_ALL
513 } notmuch_exclude_t;
514
515 /* Specify whether to omit excluded results or simply flag them.  By
516  * default, this is set to TRUE.
517  *
518  * If set to TRUE or ALL, notmuch_query_search_messages will omit excluded
519  * messages from the results, and notmuch_query_search_threads will omit
520  * threads that match only in excluded messages.  If set to TRUE,
521  * notmuch_query_search_threads will include all messages in threads that
522  * match in at least one non-excluded message.  Otherwise, if set to ALL,
523  * notmuch_query_search_threads will omit excluded messages from all threads.
524  *
525  * If set to FALSE or FLAG then both notmuch_query_search_messages and
526  * notmuch_query_search_threads will return all matching
527  * messages/threads regardless of exclude status. If set to FLAG then
528  * the exclude flag will be set for any excluded message that is
529  * returned by notmuch_query_search_messages, and the thread counts
530  * for threads returned by notmuch_query_search_threads will be the
531  * number of non-excluded messages/matches. Otherwise, if set to
532  * FALSE, then the exclude status is completely ignored.
533  *
534  * The performance difference when calling
535  * notmuch_query_search_messages should be relatively small (and both
536  * should be very fast).  However, in some cases,
537  * notmuch_query_search_threads is very much faster when omitting
538  * excluded messages as it does not need to construct the threads that
539  * only match in excluded messages.
540  */
541 void
542 notmuch_query_set_omit_excluded (notmuch_query_t *query,
543                                  notmuch_exclude_t omit_excluded);
544
545 /* Specify the sorting desired for this query. */
546 void
547 notmuch_query_set_sort (notmuch_query_t *query, notmuch_sort_t sort);
548
549 /* Return the sort specified for this query. See notmuch_query_set_sort. */
550 notmuch_sort_t
551 notmuch_query_get_sort (notmuch_query_t *query);
552
553 /* Add a tag that will be excluded from the query results by default.
554  * This exclusion will be overridden if this tag appears explicitly in
555  * the query. */
556 void
557 notmuch_query_add_tag_exclude (notmuch_query_t *query, const char *tag);
558
559 /* Execute a query for threads, returning a notmuch_threads_t object
560  * which can be used to iterate over the results. The returned threads
561  * object is owned by the query and as such, will only be valid until
562  * notmuch_query_destroy.
563  *
564  * Typical usage might be:
565  *
566  *     notmuch_query_t *query;
567  *     notmuch_threads_t *threads;
568  *     notmuch_thread_t *thread;
569  *
570  *     query = notmuch_query_create (database, query_string);
571  *
572  *     for (threads = notmuch_query_search_threads (query);
573  *          notmuch_threads_valid (threads);
574  *          notmuch_threads_move_to_next (threads))
575  *     {
576  *         thread = notmuch_threads_get (threads);
577  *         ....
578  *         notmuch_thread_destroy (thread);
579  *     }
580  *
581  *     notmuch_query_destroy (query);
582  *
583  * Note: If you are finished with a thread before its containing
584  * query, you can call notmuch_thread_destroy to clean up some memory
585  * sooner (as in the above example). Otherwise, if your thread objects
586  * are long-lived, then you don't need to call notmuch_thread_destroy
587  * and all the memory will still be reclaimed when the query is
588  * destroyed.
589  *
590  * Note that there's no explicit destructor needed for the
591  * notmuch_threads_t object. (For consistency, we do provide a
592  * notmuch_threads_destroy function, but there's no good reason
593  * to call it if the query is about to be destroyed).
594  *
595  * If a Xapian exception occurs this function will return NULL.
596  */
597 notmuch_threads_t *
598 notmuch_query_search_threads (notmuch_query_t *query);
599
600 /* Execute a query for messages, returning a notmuch_messages_t object
601  * which can be used to iterate over the results. The returned
602  * messages object is owned by the query and as such, will only be
603  * valid until notmuch_query_destroy.
604  *
605  * Typical usage might be:
606  *
607  *     notmuch_query_t *query;
608  *     notmuch_messages_t *messages;
609  *     notmuch_message_t *message;
610  *
611  *     query = notmuch_query_create (database, query_string);
612  *
613  *     for (messages = notmuch_query_search_messages (query);
614  *          notmuch_messages_valid (messages);
615  *          notmuch_messages_move_to_next (messages))
616  *     {
617  *         message = notmuch_messages_get (messages);
618  *         ....
619  *         notmuch_message_destroy (message);
620  *     }
621  *
622  *     notmuch_query_destroy (query);
623  *
624  * Note: If you are finished with a message before its containing
625  * query, you can call notmuch_message_destroy to clean up some memory
626  * sooner (as in the above example). Otherwise, if your message
627  * objects are long-lived, then you don't need to call
628  * notmuch_message_destroy and all the memory will still be reclaimed
629  * when the query is destroyed.
630  *
631  * Note that there's no explicit destructor needed for the
632  * notmuch_messages_t object. (For consistency, we do provide a
633  * notmuch_messages_destroy function, but there's no good
634  * reason to call it if the query is about to be destroyed).
635  *
636  * If a Xapian exception occurs this function will return NULL.
637  */
638 notmuch_messages_t *
639 notmuch_query_search_messages (notmuch_query_t *query);
640
641 /* Destroy a notmuch_query_t along with any associated resources.
642  *
643  * This will in turn destroy any notmuch_threads_t and
644  * notmuch_messages_t objects generated by this query, (and in
645  * turn any notmuch_thread_t and notmuch_message_t objects generated
646  * from those results, etc.), if such objects haven't already been
647  * destroyed.
648  */
649 void
650 notmuch_query_destroy (notmuch_query_t *query);
651
652 /* Is the given 'threads' iterator pointing at a valid thread.
653  *
654  * When this function returns TRUE, notmuch_threads_get will return a
655  * valid object. Whereas when this function returns FALSE,
656  * notmuch_threads_get will return NULL.
657  *
658  * See the documentation of notmuch_query_search_threads for example
659  * code showing how to iterate over a notmuch_threads_t object.
660  */
661 notmuch_bool_t
662 notmuch_threads_valid (notmuch_threads_t *threads);
663
664 /* Get the current thread from 'threads' as a notmuch_thread_t.
665  *
666  * Note: The returned thread belongs to 'threads' and has a lifetime
667  * identical to it (and the query to which it belongs).
668  *
669  * See the documentation of notmuch_query_search_threads for example
670  * code showing how to iterate over a notmuch_threads_t object.
671  *
672  * If an out-of-memory situation occurs, this function will return
673  * NULL.
674  */
675 notmuch_thread_t *
676 notmuch_threads_get (notmuch_threads_t *threads);
677
678 /* Move the 'threads' iterator to the next thread.
679  *
680  * If 'threads' is already pointing at the last thread then the
681  * iterator will be moved to a point just beyond that last thread,
682  * (where notmuch_threads_valid will return FALSE and
683  * notmuch_threads_get will return NULL).
684  *
685  * See the documentation of notmuch_query_search_threads for example
686  * code showing how to iterate over a notmuch_threads_t object.
687  */
688 void
689 notmuch_threads_move_to_next (notmuch_threads_t *threads);
690
691 /* Destroy a notmuch_threads_t object.
692  *
693  * It's not strictly necessary to call this function. All memory from
694  * the notmuch_threads_t object will be reclaimed when the
695  * containing query object is destroyed.
696  */
697 void
698 notmuch_threads_destroy (notmuch_threads_t *threads);
699
700 /* Return an estimate of the number of messages matching a search
701  *
702  * This function performs a search and returns Xapian's best
703  * guess as to number of matching messages.
704  *
705  * If a Xapian exception occurs, this function may return 0 (after
706  * printing a message).
707  */
708 unsigned
709 notmuch_query_count_messages (notmuch_query_t *query);
710  
711 /* Return the number of threads matching a search.
712  *
713  * This function performs a search and returns the number of unique thread IDs
714  * in the matching messages. This is the same as number of threads matching a
715  * search.
716  *
717  * Note that this is a significantly heavier operation than
718  * notmuch_query_count_messages().
719  *
720  * If an error occurs, this function may return 0.
721  */
722 unsigned
723 notmuch_query_count_threads (notmuch_query_t *query);
724
725 /* Get the thread ID of 'thread'.
726  *
727  * The returned string belongs to 'thread' and as such, should not be
728  * modified by the caller and will only be valid for as long as the
729  * thread is valid, (which is until notmuch_thread_destroy or until
730  * the query from which it derived is destroyed).
731  */
732 const char *
733 notmuch_thread_get_thread_id (notmuch_thread_t *thread);
734
735 /* Get the total number of messages in 'thread'.
736  *
737  * This count consists of all messages in the database belonging to
738  * this thread. Contrast with notmuch_thread_get_matched_messages() .
739  */
740 int
741 notmuch_thread_get_total_messages (notmuch_thread_t *thread);
742
743 /* Get a notmuch_messages_t iterator for the top-level messages in
744  * 'thread' in oldest-first order.
745  *
746  * This iterator will not necessarily iterate over all of the messages
747  * in the thread. It will only iterate over the messages in the thread
748  * which are not replies to other messages in the thread.
749  */
750 notmuch_messages_t *
751 notmuch_thread_get_toplevel_messages (notmuch_thread_t *thread);
752
753 /* Get a notmuch_thread_t iterator for all messages in 'thread' in
754  * oldest-first order.
755  */
756 notmuch_messages_t *
757 notmuch_thread_get_messages (notmuch_thread_t *thread);
758
759 /* Get the number of messages in 'thread' that matched the search.
760  *
761  * This count includes only the messages in this thread that were
762  * matched by the search from which the thread was created and were
763  * not excluded by any exclude tags passed in with the query (see
764  * notmuch_query_add_tag_exclude). Contrast with
765  * notmuch_thread_get_total_messages() .
766  */
767 int
768 notmuch_thread_get_matched_messages (notmuch_thread_t *thread);
769
770 /* Get the authors of 'thread'
771  *
772  * The returned string is a comma-separated list of the names of the
773  * authors of mail messages in the query results that belong to this
774  * thread.
775  *
776  * The returned string belongs to 'thread' and as such, should not be
777  * modified by the caller and will only be valid for as long as the
778  * thread is valid, (which is until notmuch_thread_destroy or until
779  * the query from which it derived is destroyed).
780  */
781 const char *
782 notmuch_thread_get_authors (notmuch_thread_t *thread);
783
784 /* Get the subject of 'thread'
785  *
786  * The subject is taken from the first message (according to the query
787  * order---see notmuch_query_set_sort) in the query results that
788  * belongs to this thread.
789  *
790  * The returned string belongs to 'thread' and as such, should not be
791  * modified by the caller and will only be valid for as long as the
792  * thread is valid, (which is until notmuch_thread_destroy or until
793  * the query from which it derived is destroyed).
794  */
795 const char *
796 notmuch_thread_get_subject (notmuch_thread_t *thread);
797
798 /* Get the date of the oldest message in 'thread' as a time_t value.
799  */
800 time_t
801 notmuch_thread_get_oldest_date (notmuch_thread_t *thread);
802
803 /* Get the date of the newest message in 'thread' as a time_t value.
804  */
805 time_t
806 notmuch_thread_get_newest_date (notmuch_thread_t *thread);
807
808 /* Get the tags for 'thread', returning a notmuch_tags_t object which
809  * can be used to iterate over all tags.
810  *
811  * Note: In the Notmuch database, tags are stored on individual
812  * messages, not on threads. So the tags returned here will be all
813  * tags of the messages which matched the search and which belong to
814  * this thread.
815  *
816  * The tags object is owned by the thread and as such, will only be
817  * valid for as long as the thread is valid, (for example, until
818  * notmuch_thread_destroy or until the query from which it derived is
819  * destroyed).
820  *
821  * Typical usage might be:
822  *
823  *     notmuch_thread_t *thread;
824  *     notmuch_tags_t *tags;
825  *     const char *tag;
826  *
827  *     thread = notmuch_threads_get (threads);
828  *
829  *     for (tags = notmuch_thread_get_tags (thread);
830  *          notmuch_tags_valid (tags);
831  *          notmuch_result_move_to_next (tags))
832  *     {
833  *         tag = notmuch_tags_get (tags);
834  *         ....
835  *     }
836  *
837  *     notmuch_thread_destroy (thread);
838  *
839  * Note that there's no explicit destructor needed for the
840  * notmuch_tags_t object. (For consistency, we do provide a
841  * notmuch_tags_destroy function, but there's no good reason to call
842  * it if the message is about to be destroyed).
843  */
844 notmuch_tags_t *
845 notmuch_thread_get_tags (notmuch_thread_t *thread);
846
847 /* Destroy a notmuch_thread_t object. */
848 void
849 notmuch_thread_destroy (notmuch_thread_t *thread);
850
851 /* Is the given 'messages' iterator pointing at a valid message.
852  *
853  * When this function returns TRUE, notmuch_messages_get will return a
854  * valid object. Whereas when this function returns FALSE,
855  * notmuch_messages_get will return NULL.
856  *
857  * See the documentation of notmuch_query_search_messages for example
858  * code showing how to iterate over a notmuch_messages_t object.
859  */
860 notmuch_bool_t
861 notmuch_messages_valid (notmuch_messages_t *messages);
862
863 /* Get the current message from 'messages' as a notmuch_message_t.
864  *
865  * Note: The returned message belongs to 'messages' and has a lifetime
866  * identical to it (and the query to which it belongs).
867  *
868  * See the documentation of notmuch_query_search_messages for example
869  * code showing how to iterate over a notmuch_messages_t object.
870  *
871  * If an out-of-memory situation occurs, this function will return
872  * NULL.
873  */
874 notmuch_message_t *
875 notmuch_messages_get (notmuch_messages_t *messages);
876
877 /* Move the 'messages' iterator to the next message.
878  *
879  * If 'messages' is already pointing at the last message then the
880  * iterator will be moved to a point just beyond that last message,
881  * (where notmuch_messages_valid will return FALSE and
882  * notmuch_messages_get will return NULL).
883  *
884  * See the documentation of notmuch_query_search_messages for example
885  * code showing how to iterate over a notmuch_messages_t object.
886  */
887 void
888 notmuch_messages_move_to_next (notmuch_messages_t *messages);
889
890 /* Destroy a notmuch_messages_t object.
891  *
892  * It's not strictly necessary to call this function. All memory from
893  * the notmuch_messages_t object will be reclaimed when the containing
894  * query object is destroyed.
895  */
896 void
897 notmuch_messages_destroy (notmuch_messages_t *messages);
898
899 /* Return a list of tags from all messages.
900  *
901  * The resulting list is guaranteed not to contain duplicated tags.
902  *
903  * WARNING: You can no longer iterate over messages after calling this
904  * function, because the iterator will point at the end of the list.
905  * We do not have a function to reset the iterator yet and the only
906  * way how you can iterate over the list again is to recreate the
907  * message list.
908  *
909  * The function returns NULL on error.
910  */
911 notmuch_tags_t *
912 notmuch_messages_collect_tags (notmuch_messages_t *messages);
913
914 /* Get the message ID of 'message'.
915  *
916  * The returned string belongs to 'message' and as such, should not be
917  * modified by the caller and will only be valid for as long as the
918  * message is valid, (which is until the query from which it derived
919  * is destroyed).
920  *
921  * This function will not return NULL since Notmuch ensures that every
922  * message has a unique message ID, (Notmuch will generate an ID for a
923  * message if the original file does not contain one).
924  */
925 const char *
926 notmuch_message_get_message_id (notmuch_message_t *message);
927
928 /* Get the thread ID of 'message'.
929  *
930  * The returned string belongs to 'message' and as such, should not be
931  * modified by the caller and will only be valid for as long as the
932  * message is valid, (for example, until the user calls
933  * notmuch_message_destroy on 'message' or until a query from which it
934  * derived is destroyed).
935  *
936  * This function will not return NULL since Notmuch ensures that every
937  * message belongs to a single thread.
938  */
939 const char *
940 notmuch_message_get_thread_id (notmuch_message_t *message);
941
942 /* Get a notmuch_messages_t iterator for all of the replies to
943  * 'message'.
944  *
945  * Note: This call only makes sense if 'message' was ultimately
946  * obtained from a notmuch_thread_t object, (such as by coming
947  * directly from the result of calling notmuch_thread_get_
948  * toplevel_messages or by any number of subsequent
949  * calls to notmuch_message_get_replies).
950  *
951  * If 'message' was obtained through some non-thread means, (such as
952  * by a call to notmuch_query_search_messages), then this function
953  * will return NULL.
954  *
955  * If there are no replies to 'message', this function will return
956  * NULL. (Note that notmuch_messages_valid will accept that NULL
957  * value as legitimate, and simply return FALSE for it.)
958  */
959 notmuch_messages_t *
960 notmuch_message_get_replies (notmuch_message_t *message);
961
962 /* Get a filename for the email corresponding to 'message'.
963  *
964  * The returned filename is an absolute filename, (the initial
965  * component will match notmuch_database_get_path() ).
966  *
967  * The returned string belongs to the message so should not be
968  * modified or freed by the caller (nor should it be referenced after
969  * the message is destroyed).
970  *
971  * Note: If this message corresponds to multiple files in the mail
972  * store, (that is, multiple files contain identical message IDs),
973  * this function will arbitrarily return a single one of those
974  * filenames. See notmuch_message_get_filenames for returning the
975  * complete list of filenames.
976  */
977 const char *
978 notmuch_message_get_filename (notmuch_message_t *message);
979
980 /* Get all filenames for the email corresponding to 'message'.
981  *
982  * Returns a notmuch_filenames_t iterator listing all the filenames
983  * associated with 'message'. These files may not have identical
984  * content, but each will have the identical Message-ID.
985  *
986  * Each filename in the iterator is an absolute filename, (the initial
987  * component will match notmuch_database_get_path() ).
988  */
989 notmuch_filenames_t *
990 notmuch_message_get_filenames (notmuch_message_t *message);
991
992 /* Message flags */
993 typedef enum _notmuch_message_flag {
994     NOTMUCH_MESSAGE_FLAG_MATCH,
995     NOTMUCH_MESSAGE_FLAG_EXCLUDED
996 } notmuch_message_flag_t;
997
998 /* Get a value of a flag for the email corresponding to 'message'. */
999 notmuch_bool_t
1000 notmuch_message_get_flag (notmuch_message_t *message,
1001                           notmuch_message_flag_t flag);
1002
1003 /* Set a value of a flag for the email corresponding to 'message'. */
1004 void
1005 notmuch_message_set_flag (notmuch_message_t *message,
1006                           notmuch_message_flag_t flag, notmuch_bool_t value);
1007
1008 /* Get the date of 'message' as a time_t value.
1009  *
1010  * For the original textual representation of the Date header from the
1011  * message call notmuch_message_get_header() with a header value of
1012  * "date". */
1013 time_t
1014 notmuch_message_get_date  (notmuch_message_t *message);
1015
1016 /* Get the value of the specified header from 'message'.
1017  *
1018  * Common headers are stored in the database when the message is
1019  * indexed and will be returned from the database.  Other headers will
1020  * be read from the actual message file.
1021  *
1022  * The header name is case insensitive.
1023  *
1024  * The returned string belongs to the message so should not be
1025  * modified or freed by the caller (nor should it be referenced after
1026  * the message is destroyed).
1027  *
1028  * Returns an empty string ("") if the message does not contain a
1029  * header line matching 'header'. Returns NULL if any error occurs.
1030  */
1031 const char *
1032 notmuch_message_get_header (notmuch_message_t *message, const char *header);
1033
1034 /* Get the tags for 'message', returning a notmuch_tags_t object which
1035  * can be used to iterate over all tags.
1036  *
1037  * The tags object is owned by the message and as such, will only be
1038  * valid for as long as the message is valid, (which is until the
1039  * query from which it derived is destroyed).
1040  *
1041  * Typical usage might be:
1042  *
1043  *     notmuch_message_t *message;
1044  *     notmuch_tags_t *tags;
1045  *     const char *tag;
1046  *
1047  *     message = notmuch_database_find_message (database, message_id);
1048  *
1049  *     for (tags = notmuch_message_get_tags (message);
1050  *          notmuch_tags_valid (tags);
1051  *          notmuch_result_move_to_next (tags))
1052  *     {
1053  *         tag = notmuch_tags_get (tags);
1054  *         ....
1055  *     }
1056  *
1057  *     notmuch_message_destroy (message);
1058  *
1059  * Note that there's no explicit destructor needed for the
1060  * notmuch_tags_t object. (For consistency, we do provide a
1061  * notmuch_tags_destroy function, but there's no good reason to call
1062  * it if the message is about to be destroyed).
1063  */
1064 notmuch_tags_t *
1065 notmuch_message_get_tags (notmuch_message_t *message);
1066
1067 /* The longest possible tag value. */
1068 #define NOTMUCH_TAG_MAX 200
1069
1070 /* Add a tag to the given message.
1071  *
1072  * Return value:
1073  *
1074  * NOTMUCH_STATUS_SUCCESS: Tag successfully added to message
1075  *
1076  * NOTMUCH_STATUS_NULL_POINTER: The 'tag' argument is NULL
1077  *
1078  * NOTMUCH_STATUS_TAG_TOO_LONG: The length of 'tag' is too long
1079  *      (exceeds NOTMUCH_TAG_MAX)
1080  *
1081  * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
1082  *      mode so message cannot be modified.
1083  */
1084 notmuch_status_t
1085 notmuch_message_add_tag (notmuch_message_t *message, const char *tag);
1086
1087 /* Remove a tag from the given message.
1088  *
1089  * Return value:
1090  *
1091  * NOTMUCH_STATUS_SUCCESS: Tag successfully removed from message
1092  *
1093  * NOTMUCH_STATUS_NULL_POINTER: The 'tag' argument is NULL
1094  *
1095  * NOTMUCH_STATUS_TAG_TOO_LONG: The length of 'tag' is too long
1096  *      (exceeds NOTMUCH_TAG_MAX)
1097  *
1098  * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
1099  *      mode so message cannot be modified.
1100  */
1101 notmuch_status_t
1102 notmuch_message_remove_tag (notmuch_message_t *message, const char *tag);
1103
1104 /* Remove all tags from the given message.
1105  *
1106  * See notmuch_message_freeze for an example showing how to safely
1107  * replace tag values.
1108  *
1109  * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
1110  *      mode so message cannot be modified.
1111  */
1112 notmuch_status_t
1113 notmuch_message_remove_all_tags (notmuch_message_t *message);
1114
1115 /* Add/remove tags according to maildir flags in the message filename(s)
1116  *
1117  * This function examines the filenames of 'message' for maildir
1118  * flags, and adds or removes tags on 'message' as follows when these
1119  * flags are present:
1120  *
1121  *      Flag    Action if present
1122  *      ----    -----------------
1123  *      'D'     Adds the "draft" tag to the message
1124  *      'F'     Adds the "flagged" tag to the message
1125  *      'P'     Adds the "passed" tag to the message
1126  *      'R'     Adds the "replied" tag to the message
1127  *      'S'     Removes the "unread" tag from the message
1128  *
1129  * For each flag that is not present, the opposite action (add/remove)
1130  * is performed for the corresponding tags.
1131  *
1132  * Flags are identified as trailing components of the filename after a
1133  * sequence of ":2,".
1134  *
1135  * If there are multiple filenames associated with this message, the
1136  * flag is considered present if it appears in one or more
1137  * filenames. (That is, the flags from the multiple filenames are
1138  * combined with the logical OR operator.)
1139  *
1140  * A client can ensure that notmuch database tags remain synchronized
1141  * with maildir flags by calling this function after each call to
1142  * notmuch_database_add_message. See also
1143  * notmuch_message_tags_to_maildir_flags for synchronizing tag changes
1144  * back to maildir flags.
1145  */
1146 notmuch_status_t
1147 notmuch_message_maildir_flags_to_tags (notmuch_message_t *message);
1148
1149 /* Rename message filename(s) to encode tags as maildir flags
1150  *
1151  * Specifically, for each filename corresponding to this message:
1152  *
1153  * If the filename is not in a maildir directory, do nothing.  (A
1154  * maildir directory is determined as a directory named "new" or
1155  * "cur".) Similarly, if the filename has invalid maildir info,
1156  * (repeated or outof-ASCII-order flag characters after ":2,"), then
1157  * do nothing.
1158  *
1159  * If the filename is in a maildir directory, rename the file so that
1160  * its filename ends with the sequence ":2," followed by zero or more
1161  * of the following single-character flags (in ASCII order):
1162  *
1163  *   'D' iff the message has the "draft" tag
1164  *   'F' iff the message has the "flagged" tag
1165  *   'P' iff the message has the "passed" tag
1166  *   'R' iff the message has the "replied" tag
1167  *   'S' iff the message does not have the "unread" tag
1168  *
1169  * Any existing flags unmentioned in the list above will be preserved
1170  * in the renaming.
1171  *
1172  * Also, if this filename is in a directory named "new", rename it to
1173  * be within the neighboring directory named "cur".
1174  *
1175  * A client can ensure that maildir filename flags remain synchronized
1176  * with notmuch database tags by calling this function after changing
1177  * tags, (after calls to notmuch_message_add_tag,
1178  * notmuch_message_remove_tag, or notmuch_message_freeze/
1179  * notmuch_message_thaw). See also notmuch_message_maildir_flags_to_tags
1180  * for synchronizing maildir flag changes back to tags.
1181  */
1182 notmuch_status_t
1183 notmuch_message_tags_to_maildir_flags (notmuch_message_t *message);
1184
1185 /* Freeze the current state of 'message' within the database.
1186  *
1187  * This means that changes to the message state, (via
1188  * notmuch_message_add_tag, notmuch_message_remove_tag, and
1189  * notmuch_message_remove_all_tags), will not be committed to the
1190  * database until the message is thawed with notmuch_message_thaw.
1191  *
1192  * Multiple calls to freeze/thaw are valid and these calls will
1193  * "stack". That is there must be as many calls to thaw as to freeze
1194  * before a message is actually thawed.
1195  *
1196  * The ability to do freeze/thaw allows for safe transactions to
1197  * change tag values. For example, explicitly setting a message to
1198  * have a given set of tags might look like this:
1199  *
1200  *    notmuch_message_freeze (message);
1201  *
1202  *    notmuch_message_remove_all_tags (message);
1203  *
1204  *    for (i = 0; i < NUM_TAGS; i++)
1205  *        notmuch_message_add_tag (message, tags[i]);
1206  *
1207  *    notmuch_message_thaw (message);
1208  *
1209  * With freeze/thaw used like this, the message in the database is
1210  * guaranteed to have either the full set of original tag values, or
1211  * the full set of new tag values, but nothing in between.
1212  *
1213  * Imagine the example above without freeze/thaw and the operation
1214  * somehow getting interrupted. This could result in the message being
1215  * left with no tags if the interruption happened after
1216  * notmuch_message_remove_all_tags but before notmuch_message_add_tag.
1217  *
1218  * Return value:
1219  *
1220  * NOTMUCH_STATUS_SUCCESS: Message successfully frozen.
1221  *
1222  * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
1223  *      mode so message cannot be modified.
1224  */
1225 notmuch_status_t
1226 notmuch_message_freeze (notmuch_message_t *message);
1227
1228 /* Thaw the current 'message', synchronizing any changes that may have
1229  * occurred while 'message' was frozen into the notmuch database.
1230  *
1231  * See notmuch_message_freeze for an example of how to use this
1232  * function to safely provide tag changes.
1233  *
1234  * Multiple calls to freeze/thaw are valid and these calls with
1235  * "stack". That is there must be as many calls to thaw as to freeze
1236  * before a message is actually thawed.
1237  *
1238  * Return value:
1239  *
1240  * NOTMUCH_STATUS_SUCCESS: Message successfully thawed, (or at least
1241  *      its frozen count has successfully been reduced by 1).
1242  *
1243  * NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW: An attempt was made to thaw
1244  *      an unfrozen message. That is, there have been an unbalanced
1245  *      number of calls to notmuch_message_freeze and
1246  *      notmuch_message_thaw.
1247  */
1248 notmuch_status_t
1249 notmuch_message_thaw (notmuch_message_t *message);
1250
1251 /* Destroy a notmuch_message_t object.
1252  *
1253  * It can be useful to call this function in the case of a single
1254  * query object with many messages in the result, (such as iterating
1255  * over the entire database). Otherwise, it's fine to never call this
1256  * function and there will still be no memory leaks. (The memory from
1257  * the messages get reclaimed when the containing query is destroyed.)
1258  */
1259 void
1260 notmuch_message_destroy (notmuch_message_t *message);
1261
1262 /* Is the given 'tags' iterator pointing at a valid tag.
1263  *
1264  * When this function returns TRUE, notmuch_tags_get will return a
1265  * valid string. Whereas when this function returns FALSE,
1266  * notmuch_tags_get will return NULL.
1267  *
1268  * See the documentation of notmuch_message_get_tags for example code
1269  * showing how to iterate over a notmuch_tags_t object.
1270  */
1271 notmuch_bool_t
1272 notmuch_tags_valid (notmuch_tags_t *tags);
1273
1274 /* Get the current tag from 'tags' as a string.
1275  *
1276  * Note: The returned string belongs to 'tags' and has a lifetime
1277  * identical to it (and the query to which it ultimately belongs).
1278  *
1279  * See the documentation of notmuch_message_get_tags for example code
1280  * showing how to iterate over a notmuch_tags_t object.
1281  */
1282 const char *
1283 notmuch_tags_get (notmuch_tags_t *tags);
1284
1285 /* Move the 'tags' iterator to the next tag.
1286  *
1287  * If 'tags' is already pointing at the last tag then the iterator
1288  * will be moved to a point just beyond that last tag, (where
1289  * notmuch_tags_valid will return FALSE and notmuch_tags_get will
1290  * return NULL).
1291  *
1292  * See the documentation of notmuch_message_get_tags for example code
1293  * showing how to iterate over a notmuch_tags_t object.
1294  */
1295 void
1296 notmuch_tags_move_to_next (notmuch_tags_t *tags);
1297
1298 /* Destroy a notmuch_tags_t object.
1299  *
1300  * It's not strictly necessary to call this function. All memory from
1301  * the notmuch_tags_t object will be reclaimed when the containing
1302  * message or query objects are destroyed.
1303  */
1304 void
1305 notmuch_tags_destroy (notmuch_tags_t *tags);
1306
1307 /* Store an mtime within the database for 'directory'.
1308  *
1309  * The 'directory' should be an object retrieved from the database
1310  * with notmuch_database_get_directory for a particular path.
1311  *
1312  * The intention is for the caller to use the mtime to allow efficient
1313  * identification of new messages to be added to the database. The
1314  * recommended usage is as follows:
1315  *
1316  *   o Read the mtime of a directory from the filesystem
1317  *
1318  *   o Call add_message for all mail files in the directory
1319  *
1320  *   o Call notmuch_directory_set_mtime with the mtime read from the
1321  *     filesystem.
1322  *
1323  * Then, when wanting to check for updates to the directory in the
1324  * future, the client can call notmuch_directory_get_mtime and know
1325  * that it only needs to add files if the mtime of the directory and
1326  * files are newer than the stored timestamp.
1327  *
1328  * Note: The notmuch_directory_get_mtime function does not allow the
1329  * caller to distinguish a timestamp of 0 from a non-existent
1330  * timestamp. So don't store a timestamp of 0 unless you are
1331  * comfortable with that.
1332  *
1333  * Return value:
1334  *
1335  * NOTMUCH_STATUS_SUCCESS: mtime successfully stored in database.
1336  *
1337  * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception
1338  *      occurred, mtime not stored.
1339  *
1340  * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
1341  *      mode so directory mtime cannot be modified.
1342  */
1343 notmuch_status_t
1344 notmuch_directory_set_mtime (notmuch_directory_t *directory,
1345                              time_t mtime);
1346
1347 /* Get the mtime of a directory, (as previously stored with
1348  * notmuch_directory_set_mtime).
1349  *
1350  * Returns 0 if no mtime has previously been stored for this
1351  * directory.*/
1352 time_t
1353 notmuch_directory_get_mtime (notmuch_directory_t *directory);
1354
1355 /* Get a notmuch_filenames_t iterator listing all the filenames of
1356  * messages in the database within the given directory.
1357  *
1358  * The returned filenames will be the basename-entries only (not
1359  * complete paths). */
1360 notmuch_filenames_t *
1361 notmuch_directory_get_child_files (notmuch_directory_t *directory);
1362
1363 /* Get a notmuch_filenams_t iterator listing all the filenames of
1364  * sub-directories in the database within the given directory.
1365  *
1366  * The returned filenames will be the basename-entries only (not
1367  * complete paths). */
1368 notmuch_filenames_t *
1369 notmuch_directory_get_child_directories (notmuch_directory_t *directory);
1370
1371 /* Destroy a notmuch_directory_t object. */
1372 void
1373 notmuch_directory_destroy (notmuch_directory_t *directory);
1374
1375 /* Is the given 'filenames' iterator pointing at a valid filename.
1376  *
1377  * When this function returns TRUE, notmuch_filenames_get will return
1378  * a valid string. Whereas when this function returns FALSE,
1379  * notmuch_filenames_get will return NULL.
1380  *
1381  * It is acceptable to pass NULL for 'filenames', in which case this
1382  * function will always return FALSE.
1383  */
1384 notmuch_bool_t
1385 notmuch_filenames_valid (notmuch_filenames_t *filenames);
1386
1387 /* Get the current filename from 'filenames' as a string.
1388  *
1389  * Note: The returned string belongs to 'filenames' and has a lifetime
1390  * identical to it (and the directory to which it ultimately belongs).
1391  *
1392  * It is acceptable to pass NULL for 'filenames', in which case this
1393  * function will always return NULL.
1394  */
1395 const char *
1396 notmuch_filenames_get (notmuch_filenames_t *filenames);
1397
1398 /* Move the 'filenames' iterator to the next filename.
1399  *
1400  * If 'filenames' is already pointing at the last filename then the
1401  * iterator will be moved to a point just beyond that last filename,
1402  * (where notmuch_filenames_valid will return FALSE and
1403  * notmuch_filenames_get will return NULL).
1404  *
1405  * It is acceptable to pass NULL for 'filenames', in which case this
1406  * function will do nothing.
1407  */
1408 void
1409 notmuch_filenames_move_to_next (notmuch_filenames_t *filenames);
1410
1411 /* Destroy a notmuch_filenames_t object.
1412  *
1413  * It's not strictly necessary to call this function. All memory from
1414  * the notmuch_filenames_t object will be reclaimed when the
1415  * containing directory object is destroyed.
1416  *
1417  * It is acceptable to pass NULL for 'filenames', in which case this
1418  * function will do nothing.
1419  */
1420 void
1421 notmuch_filenames_destroy (notmuch_filenames_t *filenames);
1422
1423 NOTMUCH_END_DECLS
1424
1425 #endif