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