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