lib: Perform the same transformation to _notmuch_database_find_directory_id
[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  * Note: Currently this will create the directory object if it doesn't
304  * exist.  In the future, when a directory object does not exist this
305  * will return NOTMUCH_STATUS_SUCCESS and set *directory to NULL.
306  * Callers should be prepared for this.
307  *
308  * Return value:
309  *
310  * NOTMUCH_STATUS_SUCCESS: Successfully retrieved directory.
311  *
312  * NOTMUCH_STATUS_NULL_POINTER: The given 'directory' argument is NULL.
313  *
314  * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred;
315  *      directory not retrieved.
316  *
317  * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
318  *      mode so the directory cannot be created (this case will be
319  *      removed in the future).
320  */
321 notmuch_status_t
322 notmuch_database_get_directory (notmuch_database_t *database,
323                                 const char *path,
324                                 notmuch_directory_t **directory);
325
326 /* Add a new message to the given notmuch database or associate an
327  * additional filename with an existing message.
328  *
329  * Here, 'filename' should be a path relative to the path of
330  * 'database' (see notmuch_database_get_path), or else should be an
331  * absolute filename with initial components that match the path of
332  * 'database'.
333  *
334  * The file should be a single mail message (not a multi-message mbox)
335  * that is expected to remain at its current location, (since the
336  * notmuch database will reference the filename, and will not copy the
337  * entire contents of the file.
338  *
339  * If another message with the same message ID already exists in the
340  * database, rather than creating a new message, this adds 'filename'
341  * to the list of the filenames for the existing message.
342  *
343  * If 'message' is not NULL, then, on successful return
344  * (NOTMUCH_STATUS_SUCCESS or NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID) '*message'
345  * will be initialized to a message object that can be used for things
346  * such as adding tags to the just-added message. The user should call
347  * notmuch_message_destroy when done with the message. On any failure
348  * '*message' will be set to NULL.
349  *
350  * Return value:
351  *
352  * NOTMUCH_STATUS_SUCCESS: Message successfully added to database.
353  *
354  * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred,
355  *      message not added.
356  *
357  * NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID: Message has the same message
358  *      ID as another message already in the database. The new
359  *      filename was successfully added to the message in the database
360  *      (if not already present) and the existing message is returned.
361  *
362  * NOTMUCH_STATUS_FILE_ERROR: an error occurred trying to open the
363  *      file, (such as permission denied, or file not found,
364  *      etc.). Nothing added to the database.
365  *
366  * NOTMUCH_STATUS_FILE_NOT_EMAIL: the contents of filename don't look
367  *      like an email message. Nothing added to the database.
368  *
369  * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
370  *      mode so no message can be added.
371  */
372 notmuch_status_t
373 notmuch_database_add_message (notmuch_database_t *database,
374                               const char *filename,
375                               notmuch_message_t **message);
376
377 /* Remove a message filename from the given notmuch database. If the
378  * message has no more filenames, remove the message.
379  *
380  * If the same message (as determined by the message ID) is still
381  * available via other filenames, then the message will persist in the
382  * database for those filenames. When the last filename is removed for
383  * a particular message, the database content for that message will be
384  * entirely removed.
385  *
386  * Return value:
387  *
388  * NOTMUCH_STATUS_SUCCESS: The last filename was removed and the
389  *      message was removed from the database.
390  *
391  * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred,
392  *      message not removed.
393  *
394  * NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID: This filename was removed but
395  *      the message persists in the database with at least one other
396  *      filename.
397  *
398  * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
399  *      mode so no message can be removed.
400  */
401 notmuch_status_t
402 notmuch_database_remove_message (notmuch_database_t *database,
403                                  const char *filename);
404
405 /* Find a message with the given message_id.
406  *
407  * If a message with the given message_id is found then, on successful return
408  * (NOTMUCH_STATUS_SUCCESS) '*message' will be initialized to a message
409  * object.  The caller should call notmuch_message_destroy when done with the
410  * message.
411  *
412  * On any failure or when the message is not found, this function initializes
413  * '*message' to NULL. This means, when NOTMUCH_STATUS_SUCCESS is returned, the
414  * caller is supposed to check '*message' for NULL to find out whether the
415  * message with the given message_id was found.
416  *
417  * Return value:
418  *
419  * NOTMUCH_STATUS_SUCCESS: Successful return, check '*message'.
420  *
421  * NOTMUCH_STATUS_NULL_POINTER: The given 'message' argument is NULL
422  *
423  * NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory, creating message object
424  *
425  * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred
426  */
427 notmuch_status_t
428 notmuch_database_find_message (notmuch_database_t *database,
429                                const char *message_id,
430                                notmuch_message_t **message);
431
432 /* Find a message with the given filename.
433  *
434  * If the database contains a message with the given filename then, on
435  * successful return (NOTMUCH_STATUS_SUCCESS) '*message' will be initialized to
436  * a message object. The caller should call notmuch_message_destroy when done
437  * with the message.
438  *
439  * On any failure or when the message is not found, this function initializes
440  * '*message' to NULL. This means, when NOTMUCH_STATUS_SUCCESS is returned, the
441  * caller is supposed to check '*message' for NULL to find out whether the
442  * message with the given filename is found.
443  *
444  * Return value:
445  *
446  * NOTMUCH_STATUS_SUCCESS: Successful return, check '*message'
447  *
448  * NOTMUCH_STATUS_NULL_POINTER: The given 'message' argument is NULL
449  *
450  * NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory, creating the message object
451  *
452  * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred
453  */
454 notmuch_status_t
455 notmuch_database_find_message_by_filename (notmuch_database_t *notmuch,
456                                            const char *filename,
457                                            notmuch_message_t **message);
458
459 /* Return a list of all tags found in the database.
460  *
461  * This function creates a list of all tags found in the database. The
462  * resulting list contains all tags from all messages found in the database.
463  *
464  * On error this function returns NULL.
465  */
466 notmuch_tags_t *
467 notmuch_database_get_all_tags (notmuch_database_t *db);
468
469 /* Create a new query for 'database'.
470  *
471  * Here, 'database' should be an open database, (see
472  * notmuch_database_open and notmuch_database_create).
473  *
474  * For the query string, we'll document the syntax here more
475  * completely in the future, but it's likely to be a specialized
476  * version of the general Xapian query syntax:
477  *
478  * http://xapian.org/docs/queryparser.html
479  *
480  * As a special case, passing either a length-zero string, (that is ""),
481  * or a string consisting of a single asterisk (that is "*"), will
482  * result in a query that returns all messages in the database.
483  *
484  * See notmuch_query_set_sort for controlling the order of results.
485  * See notmuch_query_search_messages and notmuch_query_search_threads
486  * to actually execute the query.
487  *
488  * User should call notmuch_query_destroy when finished with this
489  * query.
490  *
491  * Will return NULL if insufficient memory is available.
492  */
493 notmuch_query_t *
494 notmuch_query_create (notmuch_database_t *database,
495                       const char *query_string);
496
497 /* Sort values for notmuch_query_set_sort */
498 typedef enum {
499     NOTMUCH_SORT_OLDEST_FIRST,
500     NOTMUCH_SORT_NEWEST_FIRST,
501     NOTMUCH_SORT_MESSAGE_ID,
502     NOTMUCH_SORT_UNSORTED
503 } notmuch_sort_t;
504
505 /* Return the query_string of this query. See notmuch_query_create. */
506 const char *
507 notmuch_query_get_query_string (notmuch_query_t *query);
508
509 /* Specify whether to omit excluded results or simply flag them.  By
510  * default, this is set to TRUE.
511  *
512  * If this is TRUE, notmuch_query_search_messages will omit excluded
513  * messages from the results.  notmuch_query_search_threads will omit
514  * threads that match only in excluded messages, but will include all
515  * messages in threads that match in at least one non-excluded
516  * message.
517  *
518  * The performance difference when calling
519  * notmuch_query_search_messages should be relatively small (and both
520  * should be very fast).  However, in some cases,
521  * notmuch_query_search_threads is very much faster when omitting
522  * excluded messages as it does not need to construct the threads that
523  * only match in excluded messages.
524  */
525
526 void
527 notmuch_query_set_omit_excluded (notmuch_query_t *query, notmuch_bool_t omit_excluded);
528
529 /* Specify the sorting desired for this query. */
530 void
531 notmuch_query_set_sort (notmuch_query_t *query, notmuch_sort_t sort);
532
533 /* Return the sort specified for this query. See notmuch_query_set_sort. */
534 notmuch_sort_t
535 notmuch_query_get_sort (notmuch_query_t *query);
536
537 /* Add a tag that will be excluded from the query results by default.
538  * This exclusion will be overridden if this tag appears explicitly in
539  * the query. */
540 void
541 notmuch_query_add_tag_exclude (notmuch_query_t *query, const char *tag);
542
543 /* Execute a query for threads, returning a notmuch_threads_t object
544  * which can be used to iterate over the results. The returned threads
545  * object is owned by the query and as such, will only be valid until
546  * notmuch_query_destroy.
547  *
548  * Typical usage might be:
549  *
550  *     notmuch_query_t *query;
551  *     notmuch_threads_t *threads;
552  *     notmuch_thread_t *thread;
553  *
554  *     query = notmuch_query_create (database, query_string);
555  *
556  *     for (threads = notmuch_query_search_threads (query);
557  *          notmuch_threads_valid (threads);
558  *          notmuch_threads_move_to_next (threads))
559  *     {
560  *         thread = notmuch_threads_get (threads);
561  *         ....
562  *         notmuch_thread_destroy (thread);
563  *     }
564  *
565  *     notmuch_query_destroy (query);
566  *
567  * Note: If you are finished with a thread before its containing
568  * query, you can call notmuch_thread_destroy to clean up some memory
569  * sooner (as in the above example). Otherwise, if your thread objects
570  * are long-lived, then you don't need to call notmuch_thread_destroy
571  * and all the memory will still be reclaimed when the query is
572  * destroyed.
573  *
574  * Note that there's no explicit destructor needed for the
575  * notmuch_threads_t object. (For consistency, we do provide a
576  * notmuch_threads_destroy function, but there's no good reason
577  * to call it if the query is about to be destroyed).
578  *
579  * If a Xapian exception occurs this function will return NULL.
580  */
581 notmuch_threads_t *
582 notmuch_query_search_threads (notmuch_query_t *query);
583
584 /* Execute a query for messages, returning a notmuch_messages_t object
585  * which can be used to iterate over the results. The returned
586  * messages object is owned by the query and as such, will only be
587  * valid until notmuch_query_destroy.
588  *
589  * Typical usage might be:
590  *
591  *     notmuch_query_t *query;
592  *     notmuch_messages_t *messages;
593  *     notmuch_message_t *message;
594  *
595  *     query = notmuch_query_create (database, query_string);
596  *
597  *     for (messages = notmuch_query_search_messages (query);
598  *          notmuch_messages_valid (messages);
599  *          notmuch_messages_move_to_next (messages))
600  *     {
601  *         message = notmuch_messages_get (messages);
602  *         ....
603  *         notmuch_message_destroy (message);
604  *     }
605  *
606  *     notmuch_query_destroy (query);
607  *
608  * Note: If you are finished with a message before its containing
609  * query, you can call notmuch_message_destroy to clean up some memory
610  * sooner (as in the above example). Otherwise, if your message
611  * objects are long-lived, then you don't need to call
612  * notmuch_message_destroy and all the memory will still be reclaimed
613  * when the query is destroyed.
614  *
615  * Note that there's no explicit destructor needed for the
616  * notmuch_messages_t object. (For consistency, we do provide a
617  * notmuch_messages_destroy function, but there's no good
618  * reason to call it if the query is about to be destroyed).
619  *
620  * If a Xapian exception occurs this function will return NULL.
621  */
622 notmuch_messages_t *
623 notmuch_query_search_messages (notmuch_query_t *query);
624
625 /* Destroy a notmuch_query_t along with any associated resources.
626  *
627  * This will in turn destroy any notmuch_threads_t and
628  * notmuch_messages_t objects generated by this query, (and in
629  * turn any notmuch_thread_t and notmuch_message_t objects generated
630  * from those results, etc.), if such objects haven't already been
631  * destroyed.
632  */
633 void
634 notmuch_query_destroy (notmuch_query_t *query);
635
636 /* Is the given 'threads' iterator pointing at a valid thread.
637  *
638  * When this function returns TRUE, notmuch_threads_get will return a
639  * valid object. Whereas when this function returns FALSE,
640  * notmuch_threads_get will return NULL.
641  *
642  * See the documentation of notmuch_query_search_threads for example
643  * code showing how to iterate over a notmuch_threads_t object.
644  */
645 notmuch_bool_t
646 notmuch_threads_valid (notmuch_threads_t *threads);
647
648 /* Get the current thread from 'threads' as a notmuch_thread_t.
649  *
650  * Note: The returned thread belongs to 'threads' and has a lifetime
651  * identical to it (and the query to which it belongs).
652  *
653  * See the documentation of notmuch_query_search_threads for example
654  * code showing how to iterate over a notmuch_threads_t object.
655  *
656  * If an out-of-memory situation occurs, this function will return
657  * NULL.
658  */
659 notmuch_thread_t *
660 notmuch_threads_get (notmuch_threads_t *threads);
661
662 /* Move the 'threads' iterator to the next thread.
663  *
664  * If 'threads' is already pointing at the last thread then the
665  * iterator will be moved to a point just beyond that last thread,
666  * (where notmuch_threads_valid will return FALSE and
667  * notmuch_threads_get will return NULL).
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 void
673 notmuch_threads_move_to_next (notmuch_threads_t *threads);
674
675 /* Destroy a notmuch_threads_t object.
676  *
677  * It's not strictly necessary to call this function. All memory from
678  * the notmuch_threads_t object will be reclaimed when the
679  * containing query object is destroyed.
680  */
681 void
682 notmuch_threads_destroy (notmuch_threads_t *threads);
683
684 /* Return an estimate of the number of messages matching a search
685  *
686  * This function performs a search and returns Xapian's best
687  * guess as to number of matching messages.
688  *
689  * If a Xapian exception occurs, this function may return 0 (after
690  * printing a message).
691  */
692 unsigned
693 notmuch_query_count_messages (notmuch_query_t *query);
694  
695 /* Return the number of threads matching a search.
696  *
697  * This function performs a search and returns the number of unique thread IDs
698  * in the matching messages. This is the same as number of threads matching a
699  * search.
700  *
701  * Note that this is a significantly heavier operation than
702  * notmuch_query_count_messages().
703  *
704  * If an error occurs, this function may return 0.
705  */
706 unsigned
707 notmuch_query_count_threads (notmuch_query_t *query);
708
709 /* Get the thread ID of 'thread'.
710  *
711  * The returned string belongs to 'thread' and as such, should not be
712  * modified by the caller and will only be valid for as long as the
713  * thread is valid, (which is until notmuch_thread_destroy or until
714  * the query from which it derived is destroyed).
715  */
716 const char *
717 notmuch_thread_get_thread_id (notmuch_thread_t *thread);
718
719 /* Get the total number of messages in 'thread'.
720  *
721  * This count consists of all messages in the database belonging to
722  * this thread. Contrast with notmuch_thread_get_matched_messages() .
723  */
724 int
725 notmuch_thread_get_total_messages (notmuch_thread_t *thread);
726
727 /* Get a notmuch_messages_t iterator for the top-level messages in
728  * 'thread'.
729  *
730  * This iterator will not necessarily iterate over all of the messages
731  * in the thread. It will only iterate over the messages in the thread
732  * which are not replies to other messages in the thread.
733  *
734  * To iterate over all messages in the thread, the caller will need to
735  * iterate over the result of notmuch_message_get_replies for each
736  * top-level message (and do that recursively for the resulting
737  * messages, etc.).
738  */
739 notmuch_messages_t *
740 notmuch_thread_get_toplevel_messages (notmuch_thread_t *thread);
741
742 /* Get the number of messages in 'thread' that matched the search.
743  *
744  * This count includes only the messages in this thread that were
745  * matched by the search from which the thread was created and were
746  * not excluded by any exclude tags passed in with the query (see
747  * notmuch_query_add_tag_exclude). Contrast with
748  * notmuch_thread_get_total_messages() .
749  */
750 int
751 notmuch_thread_get_matched_messages (notmuch_thread_t *thread);
752
753 /* Get the authors of 'thread'
754  *
755  * The returned string is a comma-separated list of the names of the
756  * authors of mail messages in the query results that belong to this
757  * thread.
758  *
759  * The returned string belongs to 'thread' and as such, should not be
760  * modified by the caller and will only be valid for as long as the
761  * thread is valid, (which is until notmuch_thread_destroy or until
762  * the query from which it derived is destroyed).
763  */
764 const char *
765 notmuch_thread_get_authors (notmuch_thread_t *thread);
766
767 /* Get the subject of 'thread'
768  *
769  * The subject is taken from the first message (according to the query
770  * order---see notmuch_query_set_sort) in the query results that
771  * belongs to this thread.
772  *
773  * The returned string belongs to 'thread' and as such, should not be
774  * modified by the caller and will only be valid for as long as the
775  * thread is valid, (which is until notmuch_thread_destroy or until
776  * the query from which it derived is destroyed).
777  */
778 const char *
779 notmuch_thread_get_subject (notmuch_thread_t *thread);
780
781 /* Get the date of the oldest message in 'thread' as a time_t value.
782  */
783 time_t
784 notmuch_thread_get_oldest_date (notmuch_thread_t *thread);
785
786 /* Get the date of the newest message in 'thread' as a time_t value.
787  */
788 time_t
789 notmuch_thread_get_newest_date (notmuch_thread_t *thread);
790
791 /* Get the tags for 'thread', returning a notmuch_tags_t object which
792  * can be used to iterate over all tags.
793  *
794  * Note: In the Notmuch database, tags are stored on individual
795  * messages, not on threads. So the tags returned here will be all
796  * tags of the messages which matched the search and which belong to
797  * this thread.
798  *
799  * The tags object is owned by the thread and as such, will only be
800  * valid for as long as the thread is valid, (for example, until
801  * notmuch_thread_destroy or until the query from which it derived is
802  * destroyed).
803  *
804  * Typical usage might be:
805  *
806  *     notmuch_thread_t *thread;
807  *     notmuch_tags_t *tags;
808  *     const char *tag;
809  *
810  *     thread = notmuch_threads_get (threads);
811  *
812  *     for (tags = notmuch_thread_get_tags (thread);
813  *          notmuch_tags_valid (tags);
814  *          notmuch_result_move_to_next (tags))
815  *     {
816  *         tag = notmuch_tags_get (tags);
817  *         ....
818  *     }
819  *
820  *     notmuch_thread_destroy (thread);
821  *
822  * Note that there's no explicit destructor needed for the
823  * notmuch_tags_t object. (For consistency, we do provide a
824  * notmuch_tags_destroy function, but there's no good reason to call
825  * it if the message is about to be destroyed).
826  */
827 notmuch_tags_t *
828 notmuch_thread_get_tags (notmuch_thread_t *thread);
829
830 /* Destroy a notmuch_thread_t object. */
831 void
832 notmuch_thread_destroy (notmuch_thread_t *thread);
833
834 /* Is the given 'messages' iterator pointing at a valid message.
835  *
836  * When this function returns TRUE, notmuch_messages_get will return a
837  * valid object. Whereas when this function returns FALSE,
838  * notmuch_messages_get will return NULL.
839  *
840  * See the documentation of notmuch_query_search_messages for example
841  * code showing how to iterate over a notmuch_messages_t object.
842  */
843 notmuch_bool_t
844 notmuch_messages_valid (notmuch_messages_t *messages);
845
846 /* Get the current message from 'messages' as a notmuch_message_t.
847  *
848  * Note: The returned message belongs to 'messages' and has a lifetime
849  * identical to it (and the query to which it belongs).
850  *
851  * See the documentation of notmuch_query_search_messages for example
852  * code showing how to iterate over a notmuch_messages_t object.
853  *
854  * If an out-of-memory situation occurs, this function will return
855  * NULL.
856  */
857 notmuch_message_t *
858 notmuch_messages_get (notmuch_messages_t *messages);
859
860 /* Move the 'messages' iterator to the next message.
861  *
862  * If 'messages' is already pointing at the last message then the
863  * iterator will be moved to a point just beyond that last message,
864  * (where notmuch_messages_valid will return FALSE and
865  * notmuch_messages_get will return NULL).
866  *
867  * See the documentation of notmuch_query_search_messages for example
868  * code showing how to iterate over a notmuch_messages_t object.
869  */
870 void
871 notmuch_messages_move_to_next (notmuch_messages_t *messages);
872
873 /* Destroy a notmuch_messages_t object.
874  *
875  * It's not strictly necessary to call this function. All memory from
876  * the notmuch_messages_t object will be reclaimed when the containing
877  * query object is destroyed.
878  */
879 void
880 notmuch_messages_destroy (notmuch_messages_t *messages);
881
882 /* Return a list of tags from all messages.
883  *
884  * The resulting list is guaranteed not to contain duplicated tags.
885  *
886  * WARNING: You can no longer iterate over messages after calling this
887  * function, because the iterator will point at the end of the list.
888  * We do not have a function to reset the iterator yet and the only
889  * way how you can iterate over the list again is to recreate the
890  * message list.
891  *
892  * The function returns NULL on error.
893  */
894 notmuch_tags_t *
895 notmuch_messages_collect_tags (notmuch_messages_t *messages);
896
897 /* Get the message ID of 'message'.
898  *
899  * The returned string belongs to 'message' and as such, should not be
900  * modified by the caller and will only be valid for as long as the
901  * message is valid, (which is until the query from which it derived
902  * is destroyed).
903  *
904  * This function will not return NULL since Notmuch ensures that every
905  * message has a unique message ID, (Notmuch will generate an ID for a
906  * message if the original file does not contain one).
907  */
908 const char *
909 notmuch_message_get_message_id (notmuch_message_t *message);
910
911 /* Get the thread ID of 'message'.
912  *
913  * The returned string belongs to 'message' and as such, should not be
914  * modified by the caller and will only be valid for as long as the
915  * message is valid, (for example, until the user calls
916  * notmuch_message_destroy on 'message' or until a query from which it
917  * derived is destroyed).
918  *
919  * This function will not return NULL since Notmuch ensures that every
920  * message belongs to a single thread.
921  */
922 const char *
923 notmuch_message_get_thread_id (notmuch_message_t *message);
924
925 /* Get a notmuch_messages_t iterator for all of the replies to
926  * 'message'.
927  *
928  * Note: This call only makes sense if 'message' was ultimately
929  * obtained from a notmuch_thread_t object, (such as by coming
930  * directly from the result of calling notmuch_thread_get_
931  * toplevel_messages or by any number of subsequent
932  * calls to notmuch_message_get_replies).
933  *
934  * If 'message' was obtained through some non-thread means, (such as
935  * by a call to notmuch_query_search_messages), then this function
936  * will return NULL.
937  *
938  * If there are no replies to 'message', this function will return
939  * NULL. (Note that notmuch_messages_valid will accept that NULL
940  * value as legitimate, and simply return FALSE for it.)
941  */
942 notmuch_messages_t *
943 notmuch_message_get_replies (notmuch_message_t *message);
944
945 /* Get a filename for the email corresponding to 'message'.
946  *
947  * The returned filename is an absolute filename, (the initial
948  * component will match notmuch_database_get_path() ).
949  *
950  * The returned string belongs to the message so should not be
951  * modified or freed by the caller (nor should it be referenced after
952  * the message is destroyed).
953  *
954  * Note: If this message corresponds to multiple files in the mail
955  * store, (that is, multiple files contain identical message IDs),
956  * this function will arbitrarily return a single one of those
957  * filenames. See notmuch_message_get_filenames for returning the
958  * complete list of filenames.
959  */
960 const char *
961 notmuch_message_get_filename (notmuch_message_t *message);
962
963 /* Get all filenames for the email corresponding to 'message'.
964  *
965  * Returns a notmuch_filenames_t iterator listing all the filenames
966  * associated with 'message'. These files may not have identical
967  * content, but each will have the identical Message-ID.
968  *
969  * Each filename in the iterator is an absolute filename, (the initial
970  * component will match notmuch_database_get_path() ).
971  */
972 notmuch_filenames_t *
973 notmuch_message_get_filenames (notmuch_message_t *message);
974
975 /* Message flags */
976 typedef enum _notmuch_message_flag {
977     NOTMUCH_MESSAGE_FLAG_MATCH,
978     NOTMUCH_MESSAGE_FLAG_EXCLUDED
979 } notmuch_message_flag_t;
980
981 /* Get a value of a flag for the email corresponding to 'message'. */
982 notmuch_bool_t
983 notmuch_message_get_flag (notmuch_message_t *message,
984                           notmuch_message_flag_t flag);
985
986 /* Set a value of a flag for the email corresponding to 'message'. */
987 void
988 notmuch_message_set_flag (notmuch_message_t *message,
989                           notmuch_message_flag_t flag, notmuch_bool_t value);
990
991 /* Get the date of 'message' as a time_t value.
992  *
993  * For the original textual representation of the Date header from the
994  * message call notmuch_message_get_header() with a header value of
995  * "date". */
996 time_t
997 notmuch_message_get_date  (notmuch_message_t *message);
998
999 /* Get the value of the specified header from 'message'.
1000  *
1001  * The value will be read from the actual message file, not from the
1002  * notmuch database. The header name is case insensitive.
1003  *
1004  * The returned string belongs to the message so should not be
1005  * modified or freed by the caller (nor should it be referenced after
1006  * the message is destroyed).
1007  *
1008  * Returns an empty string ("") if the message does not contain a
1009  * header line matching 'header'. Returns NULL if any error occurs.
1010  */
1011 const char *
1012 notmuch_message_get_header (notmuch_message_t *message, const char *header);
1013
1014 /* Get the tags for 'message', returning a notmuch_tags_t object which
1015  * can be used to iterate over all tags.
1016  *
1017  * The tags object is owned by the message and as such, will only be
1018  * valid for as long as the message is valid, (which is until the
1019  * query from which it derived is destroyed).
1020  *
1021  * Typical usage might be:
1022  *
1023  *     notmuch_message_t *message;
1024  *     notmuch_tags_t *tags;
1025  *     const char *tag;
1026  *
1027  *     message = notmuch_database_find_message (database, message_id);
1028  *
1029  *     for (tags = notmuch_message_get_tags (message);
1030  *          notmuch_tags_valid (tags);
1031  *          notmuch_result_move_to_next (tags))
1032  *     {
1033  *         tag = notmuch_tags_get (tags);
1034  *         ....
1035  *     }
1036  *
1037  *     notmuch_message_destroy (message);
1038  *
1039  * Note that there's no explicit destructor needed for the
1040  * notmuch_tags_t object. (For consistency, we do provide a
1041  * notmuch_tags_destroy function, but there's no good reason to call
1042  * it if the message is about to be destroyed).
1043  */
1044 notmuch_tags_t *
1045 notmuch_message_get_tags (notmuch_message_t *message);
1046
1047 /* The longest possible tag value. */
1048 #define NOTMUCH_TAG_MAX 200
1049
1050 /* Add a tag to the given message.
1051  *
1052  * Return value:
1053  *
1054  * NOTMUCH_STATUS_SUCCESS: Tag successfully added to message
1055  *
1056  * NOTMUCH_STATUS_NULL_POINTER: The 'tag' argument is NULL
1057  *
1058  * NOTMUCH_STATUS_TAG_TOO_LONG: The length of 'tag' is too long
1059  *      (exceeds NOTMUCH_TAG_MAX)
1060  *
1061  * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
1062  *      mode so message cannot be modified.
1063  */
1064 notmuch_status_t
1065 notmuch_message_add_tag (notmuch_message_t *message, const char *tag);
1066
1067 /* Remove a tag from the given message.
1068  *
1069  * Return value:
1070  *
1071  * NOTMUCH_STATUS_SUCCESS: Tag successfully removed from message
1072  *
1073  * NOTMUCH_STATUS_NULL_POINTER: The 'tag' argument is NULL
1074  *
1075  * NOTMUCH_STATUS_TAG_TOO_LONG: The length of 'tag' is too long
1076  *      (exceeds NOTMUCH_TAG_MAX)
1077  *
1078  * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
1079  *      mode so message cannot be modified.
1080  */
1081 notmuch_status_t
1082 notmuch_message_remove_tag (notmuch_message_t *message, const char *tag);
1083
1084 /* Remove all tags from the given message.
1085  *
1086  * See notmuch_message_freeze for an example showing how to safely
1087  * replace tag values.
1088  *
1089  * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
1090  *      mode so message cannot be modified.
1091  */
1092 notmuch_status_t
1093 notmuch_message_remove_all_tags (notmuch_message_t *message);
1094
1095 /* Add/remove tags according to maildir flags in the message filename(s)
1096  *
1097  * This function examines the filenames of 'message' for maildir
1098  * flags, and adds or removes tags on 'message' as follows when these
1099  * flags are present:
1100  *
1101  *      Flag    Action if present
1102  *      ----    -----------------
1103  *      'D'     Adds the "draft" tag to the message
1104  *      'F'     Adds the "flagged" tag to the message
1105  *      'P'     Adds the "passed" tag to the message
1106  *      'R'     Adds the "replied" tag to the message
1107  *      'S'     Removes the "unread" tag from the message
1108  *
1109  * For each flag that is not present, the opposite action (add/remove)
1110  * is performed for the corresponding tags.
1111  *
1112  * Flags are identified as trailing components of the filename after a
1113  * sequence of ":2,".
1114  *
1115  * If there are multiple filenames associated with this message, the
1116  * flag is considered present if it appears in one or more
1117  * filenames. (That is, the flags from the multiple filenames are
1118  * combined with the logical OR operator.)
1119  *
1120  * A client can ensure that notmuch database tags remain synchronized
1121  * with maildir flags by calling this function after each call to
1122  * notmuch_database_add_message. See also
1123  * notmuch_message_tags_to_maildir_flags for synchronizing tag changes
1124  * back to maildir flags.
1125  */
1126 notmuch_status_t
1127 notmuch_message_maildir_flags_to_tags (notmuch_message_t *message);
1128
1129 /* Rename message filename(s) to encode tags as maildir flags
1130  *
1131  * Specifically, for each filename corresponding to this message:
1132  *
1133  * If the filename is not in a maildir directory, do nothing.  (A
1134  * maildir directory is determined as a directory named "new" or
1135  * "cur".) Similarly, if the filename has invalid maildir info,
1136  * (repeated or outof-ASCII-order flag characters after ":2,"), then
1137  * do nothing.
1138  *
1139  * If the filename is in a maildir directory, rename the file so that
1140  * its filename ends with the sequence ":2," followed by zero or more
1141  * of the following single-character flags (in ASCII order):
1142  *
1143  *   'D' iff the message has the "draft" tag
1144  *   'F' iff the message has the "flagged" tag
1145  *   'P' iff the message has the "passed" tag
1146  *   'R' iff the message has the "replied" tag
1147  *   'S' iff the message does not have the "unread" tag
1148  *
1149  * Any existing flags unmentioned in the list above will be preserved
1150  * in the renaming.
1151  *
1152  * Also, if this filename is in a directory named "new", rename it to
1153  * be within the neighboring directory named "cur".
1154  *
1155  * A client can ensure that maildir filename flags remain synchronized
1156  * with notmuch database tags by calling this function after changing
1157  * tags, (after calls to notmuch_message_add_tag,
1158  * notmuch_message_remove_tag, or notmuch_message_freeze/
1159  * notmuch_message_thaw). See also notmuch_message_maildir_flags_to_tags
1160  * for synchronizing maildir flag changes back to tags.
1161  */
1162 notmuch_status_t
1163 notmuch_message_tags_to_maildir_flags (notmuch_message_t *message);
1164
1165 /* Freeze the current state of 'message' within the database.
1166  *
1167  * This means that changes to the message state, (via
1168  * notmuch_message_add_tag, notmuch_message_remove_tag, and
1169  * notmuch_message_remove_all_tags), will not be committed to the
1170  * database until the message is thawed with notmuch_message_thaw.
1171  *
1172  * Multiple calls to freeze/thaw are valid and these calls will
1173  * "stack". That is there must be as many calls to thaw as to freeze
1174  * before a message is actually thawed.
1175  *
1176  * The ability to do freeze/thaw allows for safe transactions to
1177  * change tag values. For example, explicitly setting a message to
1178  * have a given set of tags might look like this:
1179  *
1180  *    notmuch_message_freeze (message);
1181  *
1182  *    notmuch_message_remove_all_tags (message);
1183  *
1184  *    for (i = 0; i < NUM_TAGS; i++)
1185  *        notmuch_message_add_tag (message, tags[i]);
1186  *
1187  *    notmuch_message_thaw (message);
1188  *
1189  * With freeze/thaw used like this, the message in the database is
1190  * guaranteed to have either the full set of original tag values, or
1191  * the full set of new tag values, but nothing in between.
1192  *
1193  * Imagine the example above without freeze/thaw and the operation
1194  * somehow getting interrupted. This could result in the message being
1195  * left with no tags if the interruption happened after
1196  * notmuch_message_remove_all_tags but before notmuch_message_add_tag.
1197  *
1198  * Return value:
1199  *
1200  * NOTMUCH_STATUS_SUCCESS: Message successfully frozen.
1201  *
1202  * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
1203  *      mode so message cannot be modified.
1204  */
1205 notmuch_status_t
1206 notmuch_message_freeze (notmuch_message_t *message);
1207
1208 /* Thaw the current 'message', synchronizing any changes that may have
1209  * occurred while 'message' was frozen into the notmuch database.
1210  *
1211  * See notmuch_message_freeze for an example of how to use this
1212  * function to safely provide tag changes.
1213  *
1214  * Multiple calls to freeze/thaw are valid and these calls with
1215  * "stack". That is there must be as many calls to thaw as to freeze
1216  * before a message is actually thawed.
1217  *
1218  * Return value:
1219  *
1220  * NOTMUCH_STATUS_SUCCESS: Message successfully thawed, (or at least
1221  *      its frozen count has successfully been reduced by 1).
1222  *
1223  * NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW: An attempt was made to thaw
1224  *      an unfrozen message. That is, there have been an unbalanced
1225  *      number of calls to notmuch_message_freeze and
1226  *      notmuch_message_thaw.
1227  */
1228 notmuch_status_t
1229 notmuch_message_thaw (notmuch_message_t *message);
1230
1231 /* Destroy a notmuch_message_t object.
1232  *
1233  * It can be useful to call this function in the case of a single
1234  * query object with many messages in the result, (such as iterating
1235  * over the entire database). Otherwise, it's fine to never call this
1236  * function and there will still be no memory leaks. (The memory from
1237  * the messages get reclaimed when the containing query is destroyed.)
1238  */
1239 void
1240 notmuch_message_destroy (notmuch_message_t *message);
1241
1242 /* Is the given 'tags' iterator pointing at a valid tag.
1243  *
1244  * When this function returns TRUE, notmuch_tags_get will return a
1245  * valid string. Whereas when this function returns FALSE,
1246  * notmuch_tags_get will return NULL.
1247  *
1248  * See the documentation of notmuch_message_get_tags for example code
1249  * showing how to iterate over a notmuch_tags_t object.
1250  */
1251 notmuch_bool_t
1252 notmuch_tags_valid (notmuch_tags_t *tags);
1253
1254 /* Get the current tag from 'tags' as a string.
1255  *
1256  * Note: The returned string belongs to 'tags' and has a lifetime
1257  * identical to it (and the query to which it ultimately belongs).
1258  *
1259  * See the documentation of notmuch_message_get_tags for example code
1260  * showing how to iterate over a notmuch_tags_t object.
1261  */
1262 const char *
1263 notmuch_tags_get (notmuch_tags_t *tags);
1264
1265 /* Move the 'tags' iterator to the next tag.
1266  *
1267  * If 'tags' is already pointing at the last tag then the iterator
1268  * will be moved to a point just beyond that last tag, (where
1269  * notmuch_tags_valid will return FALSE and notmuch_tags_get will
1270  * return NULL).
1271  *
1272  * See the documentation of notmuch_message_get_tags for example code
1273  * showing how to iterate over a notmuch_tags_t object.
1274  */
1275 void
1276 notmuch_tags_move_to_next (notmuch_tags_t *tags);
1277
1278 /* Destroy a notmuch_tags_t object.
1279  *
1280  * It's not strictly necessary to call this function. All memory from
1281  * the notmuch_tags_t object will be reclaimed when the containing
1282  * message or query objects are destroyed.
1283  */
1284 void
1285 notmuch_tags_destroy (notmuch_tags_t *tags);
1286
1287 /* Store an mtime within the database for 'directory'.
1288  *
1289  * The 'directory' should be an object retrieved from the database
1290  * with notmuch_database_get_directory for a particular path.
1291  *
1292  * The intention is for the caller to use the mtime to allow efficient
1293  * identification of new messages to be added to the database. The
1294  * recommended usage is as follows:
1295  *
1296  *   o Read the mtime of a directory from the filesystem
1297  *
1298  *   o Call add_message for all mail files in the directory
1299  *
1300  *   o Call notmuch_directory_set_mtime with the mtime read from the
1301  *     filesystem.
1302  *
1303  * Then, when wanting to check for updates to the directory in the
1304  * future, the client can call notmuch_directory_get_mtime and know
1305  * that it only needs to add files if the mtime of the directory and
1306  * files are newer than the stored timestamp.
1307  *
1308  * Note: The notmuch_directory_get_mtime function does not allow the
1309  * caller to distinguish a timestamp of 0 from a non-existent
1310  * timestamp. So don't store a timestamp of 0 unless you are
1311  * comfortable with that.
1312  *
1313  * Return value:
1314  *
1315  * NOTMUCH_STATUS_SUCCESS: mtime successfully stored in database.
1316  *
1317  * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception
1318  *      occurred, mtime not stored.
1319  *
1320  * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
1321  *      mode so directory mtime cannot be modified.
1322  */
1323 notmuch_status_t
1324 notmuch_directory_set_mtime (notmuch_directory_t *directory,
1325                              time_t mtime);
1326
1327 /* Get the mtime of a directory, (as previously stored with
1328  * notmuch_directory_set_mtime).
1329  *
1330  * Returns 0 if no mtime has previously been stored for this
1331  * directory.*/
1332 time_t
1333 notmuch_directory_get_mtime (notmuch_directory_t *directory);
1334
1335 /* Get a notmuch_filenames_t iterator listing all the filenames of
1336  * messages in the database within the given directory.
1337  *
1338  * The returned filenames will be the basename-entries only (not
1339  * complete paths). */
1340 notmuch_filenames_t *
1341 notmuch_directory_get_child_files (notmuch_directory_t *directory);
1342
1343 /* Get a notmuch_filenams_t iterator listing all the filenames of
1344  * sub-directories in the database within the given directory.
1345  *
1346  * The returned filenames will be the basename-entries only (not
1347  * complete paths). */
1348 notmuch_filenames_t *
1349 notmuch_directory_get_child_directories (notmuch_directory_t *directory);
1350
1351 /* Destroy a notmuch_directory_t object. */
1352 void
1353 notmuch_directory_destroy (notmuch_directory_t *directory);
1354
1355 /* Is the given 'filenames' iterator pointing at a valid filename.
1356  *
1357  * When this function returns TRUE, notmuch_filenames_get will return
1358  * a valid string. Whereas when this function returns FALSE,
1359  * notmuch_filenames_get will return NULL.
1360  *
1361  * It is acceptable to pass NULL for 'filenames', in which case this
1362  * function will always return FALSE.
1363  */
1364 notmuch_bool_t
1365 notmuch_filenames_valid (notmuch_filenames_t *filenames);
1366
1367 /* Get the current filename from 'filenames' as a string.
1368  *
1369  * Note: The returned string belongs to 'filenames' and has a lifetime
1370  * identical to it (and the directory to which it ultimately belongs).
1371  *
1372  * It is acceptable to pass NULL for 'filenames', in which case this
1373  * function will always return NULL.
1374  */
1375 const char *
1376 notmuch_filenames_get (notmuch_filenames_t *filenames);
1377
1378 /* Move the 'filenames' iterator to the next filename.
1379  *
1380  * If 'filenames' is already pointing at the last filename then the
1381  * iterator will be moved to a point just beyond that last filename,
1382  * (where notmuch_filenames_valid will return FALSE and
1383  * notmuch_filenames_get will return NULL).
1384  *
1385  * It is acceptable to pass NULL for 'filenames', in which case this
1386  * function will do nothing.
1387  */
1388 void
1389 notmuch_filenames_move_to_next (notmuch_filenames_t *filenames);
1390
1391 /* Destroy a notmuch_filenames_t object.
1392  *
1393  * It's not strictly necessary to call this function. All memory from
1394  * the notmuch_filenames_t object will be reclaimed when the
1395  * containing directory object is destroyed.
1396  *
1397  * It is acceptable to pass NULL for 'filenames', in which case this
1398  * function will do nothing.
1399  */
1400 void
1401 notmuch_filenames_destroy (notmuch_filenames_t *filenames);
1402
1403 NOTMUCH_END_DECLS
1404
1405 #endif