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