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