lib: replace deprecated n_q_count_threads with status returning version
[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 https://www.gnu.org/licenses/ .
17  *
18  * Author: Carl Worth <cworth@cworth.org>
19  */
20
21 /**
22  * @defgroup notmuch The notmuch API
23  *
24  * Not much of an email library, (just index and search)
25  *
26  * @{
27  */
28
29 #ifndef NOTMUCH_H
30 #define NOTMUCH_H
31
32 #ifndef __DOXYGEN__
33
34 #ifdef  __cplusplus
35 # define NOTMUCH_BEGIN_DECLS  extern "C" {
36 # define NOTMUCH_END_DECLS    }
37 #else
38 # define NOTMUCH_BEGIN_DECLS
39 # define NOTMUCH_END_DECLS
40 #endif
41
42 NOTMUCH_BEGIN_DECLS
43
44 #include <time.h>
45
46 #ifndef FALSE
47 #define FALSE 0
48 #endif
49
50 #ifndef TRUE
51 #define TRUE 1
52 #endif
53
54 /*
55  * The library version number.  This must agree with the soname
56  * version in Makefile.local.
57  */
58 #define LIBNOTMUCH_MAJOR_VERSION        5
59 #define LIBNOTMUCH_MINOR_VERSION        0
60 #define LIBNOTMUCH_MICRO_VERSION        0
61
62
63 #if defined (__clang_major__) && __clang_major__ >= 3 \
64     || defined (__GNUC__) && __GNUC__ >= 5 \
65     || defined (__GNUC__) && __GNUC__ == 4 && __GNUC_MINOR__ >= 5
66 #define NOTMUCH_DEPRECATED(major,minor) \
67     __attribute__ ((deprecated ("function deprecated as of libnotmuch " #major "." #minor)))
68 #else
69 #define NOTMUCH_DEPRECATED(major,minor) __attribute__ ((deprecated))
70 #endif
71
72
73 #endif /* __DOXYGEN__ */
74
75 /**
76  * Check the version of the notmuch library being compiled against.
77  *
78  * Return true if the library being compiled against is of the
79  * specified version or above. For example:
80  *
81  * @code
82  * #if LIBNOTMUCH_CHECK_VERSION(3, 1, 0)
83  *     (code requiring libnotmuch 3.1.0 or above)
84  * #endif
85  * @endcode
86  *
87  * LIBNOTMUCH_CHECK_VERSION has been defined since version 3.1.0; to
88  * check for versions prior to that, use:
89  *
90  * @code
91  * #if !defined(NOTMUCH_CHECK_VERSION)
92  *     (code requiring libnotmuch prior to 3.1.0)
93  * #endif
94  * @endcode
95  */
96 #define LIBNOTMUCH_CHECK_VERSION(major, minor, micro)                   \
97     (LIBNOTMUCH_MAJOR_VERSION > (major) ||                                      \
98      (LIBNOTMUCH_MAJOR_VERSION == (major) && LIBNOTMUCH_MINOR_VERSION > (minor)) || \
99      (LIBNOTMUCH_MAJOR_VERSION == (major) && LIBNOTMUCH_MINOR_VERSION == (minor) && \
100       LIBNOTMUCH_MICRO_VERSION >= (micro)))
101
102 /**
103  * Notmuch boolean type.
104  */
105 typedef int notmuch_bool_t;
106
107 /**
108  * Status codes used for the return values of most functions.
109  *
110  * A zero value (NOTMUCH_STATUS_SUCCESS) indicates that the function
111  * completed without error. Any other value indicates an error.
112  */
113 typedef enum _notmuch_status {
114     /**
115      * No error occurred.
116      */
117     NOTMUCH_STATUS_SUCCESS = 0,
118     /**
119      * Out of memory.
120      */
121     NOTMUCH_STATUS_OUT_OF_MEMORY,
122     /**
123      * An attempt was made to write to a database opened in read-only
124      * mode.
125      */
126     NOTMUCH_STATUS_READ_ONLY_DATABASE,
127     /**
128      * A Xapian exception occurred.
129      *
130      * @todo We don't really want to expose this lame XAPIAN_EXCEPTION
131      * value. Instead we should map to things like DATABASE_LOCKED or
132      * whatever.
133      */
134     NOTMUCH_STATUS_XAPIAN_EXCEPTION,
135     /**
136      * An error occurred trying to read or write to a file (this could
137      * be file not found, permission denied, etc.)
138      */
139     NOTMUCH_STATUS_FILE_ERROR,
140     /**
141      * A file was presented that doesn't appear to be an email
142      * message.
143      */
144     NOTMUCH_STATUS_FILE_NOT_EMAIL,
145     /**
146      * A file contains a message ID that is identical to a message
147      * already in the database.
148      */
149     NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID,
150     /**
151      * The user erroneously passed a NULL pointer to a notmuch
152      * function.
153      */
154     NOTMUCH_STATUS_NULL_POINTER,
155     /**
156      * A tag value is too long (exceeds NOTMUCH_TAG_MAX).
157      */
158     NOTMUCH_STATUS_TAG_TOO_LONG,
159     /**
160      * The notmuch_message_thaw function has been called more times
161      * than notmuch_message_freeze.
162      */
163     NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW,
164     /**
165      * notmuch_database_end_atomic has been called more times than
166      * notmuch_database_begin_atomic.
167      */
168     NOTMUCH_STATUS_UNBALANCED_ATOMIC,
169     /**
170      * The operation is not supported.
171      */
172     NOTMUCH_STATUS_UNSUPPORTED_OPERATION,
173     /**
174      * The operation requires a database upgrade.
175      */
176     NOTMUCH_STATUS_UPGRADE_REQUIRED,
177     /**
178      * There is a problem with the proposed path, e.g. a relative path
179      * passed to a function expecting an absolute path.
180      */
181     NOTMUCH_STATUS_PATH_ERROR,
182     /**
183      * One of the arguments violates the preconditions for the
184      * function, in a way not covered by a more specific argument.
185      */
186     NOTMUCH_STATUS_ILLEGAL_ARGUMENT,
187     /**
188      * Not an actual status value. Just a way to find out how many
189      * valid status values there are.
190      */
191     NOTMUCH_STATUS_LAST_STATUS
192 } notmuch_status_t;
193
194 /**
195  * Get a string representation of a notmuch_status_t value.
196  *
197  * The result is read-only.
198  */
199 const char *
200 notmuch_status_to_string (notmuch_status_t status);
201
202 /* Various opaque data types. For each notmuch_<foo>_t see the various
203  * notmuch_<foo> functions below. */
204 #ifndef __DOXYGEN__
205 typedef struct _notmuch_database notmuch_database_t;
206 typedef struct _notmuch_query notmuch_query_t;
207 typedef struct _notmuch_threads notmuch_threads_t;
208 typedef struct _notmuch_thread notmuch_thread_t;
209 typedef struct _notmuch_messages notmuch_messages_t;
210 typedef struct _notmuch_message notmuch_message_t;
211 typedef struct _notmuch_tags notmuch_tags_t;
212 typedef struct _notmuch_directory notmuch_directory_t;
213 typedef struct _notmuch_filenames notmuch_filenames_t;
214 typedef struct _notmuch_config_list notmuch_config_list_t;
215 #endif /* __DOXYGEN__ */
216
217 /**
218  * Create a new, empty notmuch database located at 'path'.
219  *
220  * The path should be a top-level directory to a collection of
221  * plain-text email messages (one message per file). This call will
222  * create a new ".notmuch" directory within 'path' where notmuch will
223  * store its data.
224  *
225  * After a successful call to notmuch_database_create, the returned
226  * database will be open so the caller should call
227  * notmuch_database_destroy when finished with it.
228  *
229  * The database will not yet have any data in it
230  * (notmuch_database_create itself is a very cheap function). Messages
231  * contained within 'path' can be added to the database by calling
232  * notmuch_database_add_message.
233  *
234  * In case of any failure, this function returns an error status and
235  * sets *database to NULL (after printing an error message on stderr).
236  *
237  * Return value:
238  *
239  * NOTMUCH_STATUS_SUCCESS: Successfully created the database.
240  *
241  * NOTMUCH_STATUS_NULL_POINTER: The given 'path' argument is NULL.
242  *
243  * NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory.
244  *
245  * NOTMUCH_STATUS_FILE_ERROR: An error occurred trying to create the
246  *      database file (such as permission denied, or file not found,
247  *      etc.), or the database already exists.
248  *
249  * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred.
250  */
251 notmuch_status_t
252 notmuch_database_create (const char *path, notmuch_database_t **database);
253
254 /**
255  * Like notmuch_database_create, except optionally return an error
256  * message. This message is allocated by malloc and should be freed by
257  * the caller.
258  */
259 notmuch_status_t
260 notmuch_database_create_verbose (const char *path,
261                                  notmuch_database_t **database,
262                                  char **error_message);
263
264 /**
265  * Database open mode for notmuch_database_open.
266  */
267 typedef enum {
268     /**
269      * Open database for reading only.
270      */
271     NOTMUCH_DATABASE_MODE_READ_ONLY = 0,
272     /**
273      * Open database for reading and writing.
274      */
275     NOTMUCH_DATABASE_MODE_READ_WRITE
276 } notmuch_database_mode_t;
277
278 /**
279  * Open an existing notmuch database located at 'path'.
280  *
281  * The database should have been created at some time in the past,
282  * (not necessarily by this process), by calling
283  * notmuch_database_create with 'path'. By default the database should be
284  * opened for reading only. In order to write to the database you need to
285  * pass the NOTMUCH_DATABASE_MODE_READ_WRITE mode.
286  *
287  * An existing notmuch database can be identified by the presence of a
288  * directory named ".notmuch" below 'path'.
289  *
290  * The caller should call notmuch_database_destroy when finished with
291  * this database.
292  *
293  * In case of any failure, this function returns an error status and
294  * sets *database to NULL (after printing an error message on stderr).
295  *
296  * Return value:
297  *
298  * NOTMUCH_STATUS_SUCCESS: Successfully opened the database.
299  *
300  * NOTMUCH_STATUS_NULL_POINTER: The given 'path' argument is NULL.
301  *
302  * NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory.
303  *
304  * NOTMUCH_STATUS_FILE_ERROR: An error occurred trying to open the
305  *      database file (such as permission denied, or file not found,
306  *      etc.), or the database version is unknown.
307  *
308  * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred.
309  */
310 notmuch_status_t
311 notmuch_database_open (const char *path,
312                        notmuch_database_mode_t mode,
313                        notmuch_database_t **database);
314 /**
315  * Like notmuch_database_open, except optionally return an error
316  * message. This message is allocated by malloc and should be freed by
317  * the caller.
318  */
319
320 notmuch_status_t
321 notmuch_database_open_verbose (const char *path,
322                                notmuch_database_mode_t mode,
323                                notmuch_database_t **database,
324                                char **error_message);
325
326 /**
327  * Retrieve last status string for given database.
328  *
329  */
330 const char *
331 notmuch_database_status_string (const notmuch_database_t *notmuch);
332
333 /**
334  * Commit changes and close the given notmuch database.
335  *
336  * After notmuch_database_close has been called, calls to other
337  * functions on objects derived from this database may either behave
338  * as if the database had not been closed (e.g., if the required data
339  * has been cached) or may fail with a
340  * NOTMUCH_STATUS_XAPIAN_EXCEPTION. The only further operation
341  * permitted on the database itself is to call
342  * notmuch_database_destroy.
343  *
344  * notmuch_database_close can be called multiple times.  Later calls
345  * have no effect.
346  *
347  * For writable databases, notmuch_database_close commits all changes
348  * to disk before closing the database.  If the caller is currently in
349  * an atomic section (there was a notmuch_database_begin_atomic
350  * without a matching notmuch_database_end_atomic), this will discard
351  * changes made in that atomic section (but still commit changes made
352  * prior to entering the atomic section).
353  *
354  * Return value:
355  *
356  * NOTMUCH_STATUS_SUCCESS: Successfully closed the database.
357  *
358  * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred; the
359  *      database has been closed but there are no guarantees the
360  *      changes to the database, if any, have been flushed to disk.
361  */
362 notmuch_status_t
363 notmuch_database_close (notmuch_database_t *database);
364
365 /**
366  * A callback invoked by notmuch_database_compact to notify the user
367  * of the progress of the compaction process.
368  */
369 typedef void (*notmuch_compact_status_cb_t)(const char *message, void *closure);
370
371 /**
372  * Compact a notmuch database, backing up the original database to the
373  * given path.
374  *
375  * The database will be opened with NOTMUCH_DATABASE_MODE_READ_WRITE
376  * during the compaction process to ensure no writes are made.
377  *
378  * If the optional callback function 'status_cb' is non-NULL, it will
379  * be called with diagnostic and informational messages. The argument
380  * 'closure' is passed verbatim to any callback invoked.
381  */
382 notmuch_status_t
383 notmuch_database_compact (const char* path,
384                           const char* backup_path,
385                           notmuch_compact_status_cb_t status_cb,
386                           void *closure);
387
388 /**
389  * Destroy the notmuch database, closing it if necessary and freeing
390  * all associated resources.
391  *
392  * Return value as in notmuch_database_close if the database was open;
393  * notmuch_database_destroy itself has no failure modes.
394  */
395 notmuch_status_t
396 notmuch_database_destroy (notmuch_database_t *database);
397
398 /**
399  * Return the database path of the given database.
400  *
401  * The return value is a string owned by notmuch so should not be
402  * modified nor freed by the caller.
403  */
404 const char *
405 notmuch_database_get_path (notmuch_database_t *database);
406
407 /**
408  * Return the database format version of the given database.
409  */
410 unsigned int
411 notmuch_database_get_version (notmuch_database_t *database);
412
413 /**
414  * Can the database be upgraded to a newer database version?
415  *
416  * If this function returns TRUE, then the caller may call
417  * notmuch_database_upgrade to upgrade the database.  If the caller
418  * does not upgrade an out-of-date database, then some functions may
419  * fail with NOTMUCH_STATUS_UPGRADE_REQUIRED.  This always returns
420  * FALSE for a read-only database because there's no way to upgrade a
421  * read-only database.
422  */
423 notmuch_bool_t
424 notmuch_database_needs_upgrade (notmuch_database_t *database);
425
426 /**
427  * Upgrade the current database to the latest supported version.
428  *
429  * This ensures that all current notmuch functionality will be
430  * available on the database.  After opening a database in read-write
431  * mode, it is recommended that clients check if an upgrade is needed
432  * (notmuch_database_needs_upgrade) and if so, upgrade with this
433  * function before making any modifications.  If
434  * notmuch_database_needs_upgrade returns FALSE, this will be a no-op.
435  *
436  * The optional progress_notify callback can be used by the caller to
437  * provide progress indication to the user. If non-NULL it will be
438  * called periodically with 'progress' as a floating-point value in
439  * the range of [0.0 .. 1.0] indicating the progress made so far in
440  * the upgrade process.  The argument 'closure' is passed verbatim to
441  * any callback invoked.
442  */
443 notmuch_status_t
444 notmuch_database_upgrade (notmuch_database_t *database,
445                           void (*progress_notify) (void *closure,
446                                                    double progress),
447                           void *closure);
448
449 /**
450  * Begin an atomic database operation.
451  *
452  * Any modifications performed between a successful begin and a
453  * notmuch_database_end_atomic will be applied to the database
454  * atomically.  Note that, unlike a typical database transaction, this
455  * only ensures atomicity, not durability; neither begin nor end
456  * necessarily flush modifications to disk.
457  *
458  * Atomic sections may be nested.  begin_atomic and end_atomic must
459  * always be called in pairs.
460  *
461  * Return value:
462  *
463  * NOTMUCH_STATUS_SUCCESS: Successfully entered atomic section.
464  *
465  * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred;
466  *      atomic section not entered.
467  */
468 notmuch_status_t
469 notmuch_database_begin_atomic (notmuch_database_t *notmuch);
470
471 /**
472  * Indicate the end of an atomic database operation.
473  *
474  * Return value:
475  *
476  * NOTMUCH_STATUS_SUCCESS: Successfully completed atomic section.
477  *
478  * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred;
479  *      atomic section not ended.
480  *
481  * NOTMUCH_STATUS_UNBALANCED_ATOMIC: The database is not currently in
482  *      an atomic section.
483  */
484 notmuch_status_t
485 notmuch_database_end_atomic (notmuch_database_t *notmuch);
486
487 /**
488  * Return the committed database revision and UUID.
489  *
490  * The database revision number increases monotonically with each
491  * commit to the database.  Hence, all messages and message changes
492  * committed to the database (that is, visible to readers) have a last
493  * modification revision <= the committed database revision.  Any
494  * messages committed in the future will be assigned a modification
495  * revision > the committed database revision.
496  *
497  * The UUID is a NUL-terminated opaque string that uniquely identifies
498  * this database.  Two revision numbers are only comparable if they
499  * have the same database UUID.
500  */
501 unsigned long
502 notmuch_database_get_revision (notmuch_database_t *notmuch,
503                                 const char **uuid);
504
505 /**
506  * Retrieve a directory object from the database for 'path'.
507  *
508  * Here, 'path' should be a path relative to the path of 'database'
509  * (see notmuch_database_get_path), or else should be an absolute path
510  * with initial components that match the path of 'database'.
511  *
512  * If this directory object does not exist in the database, this
513  * returns NOTMUCH_STATUS_SUCCESS and sets *directory to NULL.
514  *
515  * Otherwise the returned directory object is owned by the database
516  * and as such, will only be valid until notmuch_database_destroy is
517  * called.
518  *
519  * Return value:
520  *
521  * NOTMUCH_STATUS_SUCCESS: Successfully retrieved directory.
522  *
523  * NOTMUCH_STATUS_NULL_POINTER: The given 'directory' argument is NULL.
524  *
525  * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred;
526  *      directory not retrieved.
527  *
528  * NOTMUCH_STATUS_UPGRADE_REQUIRED: The caller must upgrade the
529  *      database to use this function.
530  */
531 notmuch_status_t
532 notmuch_database_get_directory (notmuch_database_t *database,
533                                 const char *path,
534                                 notmuch_directory_t **directory);
535
536 /**
537  * Add a new message to the given notmuch database or associate an
538  * additional filename with an existing message.
539  *
540  * Here, 'filename' should be a path relative to the path of
541  * 'database' (see notmuch_database_get_path), or else should be an
542  * absolute filename with initial components that match the path of
543  * 'database'.
544  *
545  * The file should be a single mail message (not a multi-message mbox)
546  * that is expected to remain at its current location, (since the
547  * notmuch database will reference the filename, and will not copy the
548  * entire contents of the file.
549  *
550  * If another message with the same message ID already exists in the
551  * database, rather than creating a new message, this adds 'filename'
552  * to the list of the filenames for the existing message.
553  *
554  * If 'message' is not NULL, then, on successful return
555  * (NOTMUCH_STATUS_SUCCESS or NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID) '*message'
556  * will be initialized to a message object that can be used for things
557  * such as adding tags to the just-added message. The user should call
558  * notmuch_message_destroy when done with the message. On any failure
559  * '*message' will be set to NULL.
560  *
561  * Return value:
562  *
563  * NOTMUCH_STATUS_SUCCESS: Message successfully added to database.
564  *
565  * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred,
566  *      message not added.
567  *
568  * NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID: Message has the same message
569  *      ID as another message already in the database. The new
570  *      filename was successfully added to the message in the database
571  *      (if not already present) and the existing message is returned.
572  *
573  * NOTMUCH_STATUS_FILE_ERROR: an error occurred trying to open the
574  *      file, (such as permission denied, or file not found,
575  *      etc.). Nothing added to the database.
576  *
577  * NOTMUCH_STATUS_FILE_NOT_EMAIL: the contents of filename don't look
578  *      like an email message. Nothing added to the database.
579  *
580  * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
581  *      mode so no message can be added.
582  *
583  * NOTMUCH_STATUS_UPGRADE_REQUIRED: The caller must upgrade the
584  *      database to use this function.
585  */
586 notmuch_status_t
587 notmuch_database_add_message (notmuch_database_t *database,
588                               const char *filename,
589                               notmuch_message_t **message);
590
591 /**
592  * Remove a message filename from the given notmuch database. If the
593  * message has no more filenames, remove the message.
594  *
595  * If the same message (as determined by the message ID) is still
596  * available via other filenames, then the message will persist in the
597  * database for those filenames. When the last filename is removed for
598  * a particular message, the database content for that message will be
599  * entirely removed.
600  *
601  * Return value:
602  *
603  * NOTMUCH_STATUS_SUCCESS: The last filename was removed and the
604  *      message was removed from the database.
605  *
606  * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred,
607  *      message not removed.
608  *
609  * NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID: This filename was removed but
610  *      the message persists in the database with at least one other
611  *      filename.
612  *
613  * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
614  *      mode so no message can be removed.
615  *
616  * NOTMUCH_STATUS_UPGRADE_REQUIRED: The caller must upgrade the
617  *      database to use this function.
618  */
619 notmuch_status_t
620 notmuch_database_remove_message (notmuch_database_t *database,
621                                  const char *filename);
622
623 /**
624  * Find a message with the given message_id.
625  *
626  * If a message with the given message_id is found then, on successful return
627  * (NOTMUCH_STATUS_SUCCESS) '*message' will be initialized to a message
628  * object.  The caller should call notmuch_message_destroy when done with the
629  * message.
630  *
631  * On any failure or when the message is not found, this function initializes
632  * '*message' to NULL. This means, when NOTMUCH_STATUS_SUCCESS is returned, the
633  * caller is supposed to check '*message' for NULL to find out whether the
634  * message with the given message_id was found.
635  *
636  * Return value:
637  *
638  * NOTMUCH_STATUS_SUCCESS: Successful return, check '*message'.
639  *
640  * NOTMUCH_STATUS_NULL_POINTER: The given 'message' argument is NULL
641  *
642  * NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory, creating message object
643  *
644  * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred
645  */
646 notmuch_status_t
647 notmuch_database_find_message (notmuch_database_t *database,
648                                const char *message_id,
649                                notmuch_message_t **message);
650
651 /**
652  * Find a message with the given filename.
653  *
654  * If the database contains a message with the given filename then, on
655  * successful return (NOTMUCH_STATUS_SUCCESS) '*message' will be initialized to
656  * a message object. The caller should call notmuch_message_destroy when done
657  * with the message.
658  *
659  * On any failure or when the message is not found, this function initializes
660  * '*message' to NULL. This means, when NOTMUCH_STATUS_SUCCESS is returned, the
661  * caller is supposed to check '*message' for NULL to find out whether the
662  * message with the given filename is found.
663  *
664  * Return value:
665  *
666  * NOTMUCH_STATUS_SUCCESS: Successful return, check '*message'
667  *
668  * NOTMUCH_STATUS_NULL_POINTER: The given 'message' argument is NULL
669  *
670  * NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory, creating the message object
671  *
672  * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred
673  *
674  * NOTMUCH_STATUS_UPGRADE_REQUIRED: The caller must upgrade the
675  *      database to use this function.
676  */
677 notmuch_status_t
678 notmuch_database_find_message_by_filename (notmuch_database_t *notmuch,
679                                            const char *filename,
680                                            notmuch_message_t **message);
681
682 /**
683  * Return a list of all tags found in the database.
684  *
685  * This function creates a list of all tags found in the database. The
686  * resulting list contains all tags from all messages found in the database.
687  *
688  * On error this function returns NULL.
689  */
690 notmuch_tags_t *
691 notmuch_database_get_all_tags (notmuch_database_t *db);
692
693 /**
694  * Create a new query for 'database'.
695  *
696  * Here, 'database' should be an open database, (see
697  * notmuch_database_open and notmuch_database_create).
698  *
699  * For the query string, we'll document the syntax here more
700  * completely in the future, but it's likely to be a specialized
701  * version of the general Xapian query syntax:
702  *
703  * https://xapian.org/docs/queryparser.html
704  *
705  * As a special case, passing either a length-zero string, (that is ""),
706  * or a string consisting of a single asterisk (that is "*"), will
707  * result in a query that returns all messages in the database.
708  *
709  * See notmuch_query_set_sort for controlling the order of results.
710  * See notmuch_query_search_messages and notmuch_query_search_threads
711  * to actually execute the query.
712  *
713  * User should call notmuch_query_destroy when finished with this
714  * query.
715  *
716  * Will return NULL if insufficient memory is available.
717  */
718 notmuch_query_t *
719 notmuch_query_create (notmuch_database_t *database,
720                       const char *query_string);
721
722 /**
723  * Sort values for notmuch_query_set_sort.
724  */
725 typedef enum {
726     /**
727      * Oldest first.
728      */
729     NOTMUCH_SORT_OLDEST_FIRST,
730     /**
731      * Newest first.
732      */
733     NOTMUCH_SORT_NEWEST_FIRST,
734     /**
735      * Sort by message-id.
736      */
737     NOTMUCH_SORT_MESSAGE_ID,
738     /**
739      * Do not sort.
740      */
741     NOTMUCH_SORT_UNSORTED
742 } notmuch_sort_t;
743
744 /**
745  * Return the query_string of this query. See notmuch_query_create.
746  */
747 const char *
748 notmuch_query_get_query_string (const notmuch_query_t *query);
749
750 /**
751  * Return the notmuch database of this query. See notmuch_query_create.
752  */
753 notmuch_database_t *
754 notmuch_query_get_database (const notmuch_query_t *query);
755
756 /**
757  * Exclude values for notmuch_query_set_omit_excluded. The strange
758  * order is to maintain backward compatibility: the old FALSE/TRUE
759  * options correspond to the new
760  * NOTMUCH_EXCLUDE_FLAG/NOTMUCH_EXCLUDE_TRUE options.
761  */
762 typedef enum {
763     NOTMUCH_EXCLUDE_FLAG,
764     NOTMUCH_EXCLUDE_TRUE,
765     NOTMUCH_EXCLUDE_FALSE,
766     NOTMUCH_EXCLUDE_ALL
767 } notmuch_exclude_t;
768
769 /**
770  * Specify whether to omit excluded results or simply flag them.  By
771  * default, this is set to TRUE.
772  *
773  * If set to TRUE or ALL, notmuch_query_search_messages will omit excluded
774  * messages from the results, and notmuch_query_search_threads will omit
775  * threads that match only in excluded messages.  If set to TRUE,
776  * notmuch_query_search_threads will include all messages in threads that
777  * match in at least one non-excluded message.  Otherwise, if set to ALL,
778  * notmuch_query_search_threads will omit excluded messages from all threads.
779  *
780  * If set to FALSE or FLAG then both notmuch_query_search_messages and
781  * notmuch_query_search_threads will return all matching
782  * messages/threads regardless of exclude status. If set to FLAG then
783  * the exclude flag will be set for any excluded message that is
784  * returned by notmuch_query_search_messages, and the thread counts
785  * for threads returned by notmuch_query_search_threads will be the
786  * number of non-excluded messages/matches. Otherwise, if set to
787  * FALSE, then the exclude status is completely ignored.
788  *
789  * The performance difference when calling
790  * notmuch_query_search_messages should be relatively small (and both
791  * should be very fast).  However, in some cases,
792  * notmuch_query_search_threads is very much faster when omitting
793  * excluded messages as it does not need to construct the threads that
794  * only match in excluded messages.
795  */
796 void
797 notmuch_query_set_omit_excluded (notmuch_query_t *query,
798                                  notmuch_exclude_t omit_excluded);
799
800 /**
801  * Specify the sorting desired for this query.
802  */
803 void
804 notmuch_query_set_sort (notmuch_query_t *query, notmuch_sort_t sort);
805
806 /**
807  * Return the sort specified for this query. See
808  * notmuch_query_set_sort.
809  */
810 notmuch_sort_t
811 notmuch_query_get_sort (const notmuch_query_t *query);
812
813 /**
814  * Add a tag that will be excluded from the query results by default.
815  * This exclusion will be overridden if this tag appears explicitly in
816  * the query.
817  */
818 void
819 notmuch_query_add_tag_exclude (notmuch_query_t *query, const char *tag);
820
821 /**
822  * Execute a query for threads, returning a notmuch_threads_t object
823  * which can be used to iterate over the results. The returned threads
824  * object is owned by the query and as such, will only be valid until
825  * notmuch_query_destroy.
826  *
827  * Typical usage might be:
828  *
829  *     notmuch_query_t *query;
830  *     notmuch_threads_t *threads;
831  *     notmuch_thread_t *thread;
832  *
833  *     query = notmuch_query_create (database, query_string);
834  *
835  *     for (threads = notmuch_query_search_threads (query);
836  *          notmuch_threads_valid (threads);
837  *          notmuch_threads_move_to_next (threads))
838  *     {
839  *         thread = notmuch_threads_get (threads);
840  *         ....
841  *         notmuch_thread_destroy (thread);
842  *     }
843  *
844  *     notmuch_query_destroy (query);
845  *
846  * Note: If you are finished with a thread before its containing
847  * query, you can call notmuch_thread_destroy to clean up some memory
848  * sooner (as in the above example). Otherwise, if your thread objects
849  * are long-lived, then you don't need to call notmuch_thread_destroy
850  * and all the memory will still be reclaimed when the query is
851  * destroyed.
852  *
853  * Note that there's no explicit destructor needed for the
854  * notmuch_threads_t object. (For consistency, we do provide a
855  * notmuch_threads_destroy function, but there's no good reason
856  * to call it if the query is about to be destroyed).
857  *
858  * @since libnotmuch 5.0 (notmuch 0.25)
859  */
860 notmuch_status_t
861 notmuch_query_search_threads (notmuch_query_t *query,
862                               notmuch_threads_t **out);
863
864 /**
865  * Deprecated alias for notmuch_query_search_threads.
866  *
867  * @deprecated Deprecated as of libnotmuch 5 (notmuch 0.25). Please
868  * use notmuch_query_search_threads instead.
869  *
870  */
871 NOTMUCH_DEPRECATED(5,0)
872 notmuch_status_t
873 notmuch_query_search_threads_st (notmuch_query_t *query, notmuch_threads_t **out);
874
875 /**
876  * Execute a query for messages, returning a notmuch_messages_t object
877  * which can be used to iterate over the results. The returned
878  * messages object is owned by the query and as such, will only be
879  * valid until notmuch_query_destroy.
880  *
881  * Typical usage might be:
882  *
883  *     notmuch_query_t *query;
884  *     notmuch_messages_t *messages;
885  *     notmuch_message_t *message;
886  *
887  *     query = notmuch_query_create (database, query_string);
888  *
889  *     for (messages = notmuch_query_search_messages (query);
890  *          notmuch_messages_valid (messages);
891  *          notmuch_messages_move_to_next (messages))
892  *     {
893  *         message = notmuch_messages_get (messages);
894  *         ....
895  *         notmuch_message_destroy (message);
896  *     }
897  *
898  *     notmuch_query_destroy (query);
899  *
900  * Note: If you are finished with a message before its containing
901  * query, you can call notmuch_message_destroy to clean up some memory
902  * sooner (as in the above example). Otherwise, if your message
903  * objects are long-lived, then you don't need to call
904  * notmuch_message_destroy and all the memory will still be reclaimed
905  * when the query is destroyed.
906  *
907  * Note that there's no explicit destructor needed for the
908  * notmuch_messages_t object. (For consistency, we do provide a
909  * notmuch_messages_destroy function, but there's no good
910  * reason to call it if the query is about to be destroyed).
911  *
912  * If a Xapian exception occurs this function will return NULL.
913  *
914  * @since libnotmuch 5 (notmuch 0.25)
915  */
916 notmuch_status_t
917 notmuch_query_search_messages (notmuch_query_t *query,
918                                notmuch_messages_t **out);
919 /**
920  * Deprecated alias for notmuch_query_search_messages
921  *
922  * @deprecated Deprecated as of libnotmuch 5 (notmuch 0.25). Please use
923  * notmuch_query_search_messages instead.
924  *
925  */
926
927 NOTMUCH_DEPRECATED(5,0)
928 notmuch_status_t
929 notmuch_query_search_messages_st (notmuch_query_t *query,
930                                   notmuch_messages_t **out);
931
932 /**
933  * Destroy a notmuch_query_t along with any associated resources.
934  *
935  * This will in turn destroy any notmuch_threads_t and
936  * notmuch_messages_t objects generated by this query, (and in
937  * turn any notmuch_thread_t and notmuch_message_t objects generated
938  * from those results, etc.), if such objects haven't already been
939  * destroyed.
940  */
941 void
942 notmuch_query_destroy (notmuch_query_t *query);
943
944 /**
945  * Is the given 'threads' iterator pointing at a valid thread.
946  *
947  * When this function returns TRUE, notmuch_threads_get will return a
948  * valid object. Whereas when this function returns FALSE,
949  * notmuch_threads_get will return NULL.
950  *
951  * If passed a NULL pointer, this function returns FALSE
952  *
953  * See the documentation of notmuch_query_search_threads for example
954  * code showing how to iterate over a notmuch_threads_t object.
955  */
956 notmuch_bool_t
957 notmuch_threads_valid (notmuch_threads_t *threads);
958
959 /**
960  * Get the current thread from 'threads' as a notmuch_thread_t.
961  *
962  * Note: The returned thread belongs to 'threads' and has a lifetime
963  * identical to it (and the query to which it belongs).
964  *
965  * See the documentation of notmuch_query_search_threads for example
966  * code showing how to iterate over a notmuch_threads_t object.
967  *
968  * If an out-of-memory situation occurs, this function will return
969  * NULL.
970  */
971 notmuch_thread_t *
972 notmuch_threads_get (notmuch_threads_t *threads);
973
974 /**
975  * Move the 'threads' iterator to the next thread.
976  *
977  * If 'threads' is already pointing at the last thread then the
978  * iterator will be moved to a point just beyond that last thread,
979  * (where notmuch_threads_valid will return FALSE and
980  * notmuch_threads_get will return NULL).
981  *
982  * See the documentation of notmuch_query_search_threads for example
983  * code showing how to iterate over a notmuch_threads_t object.
984  */
985 void
986 notmuch_threads_move_to_next (notmuch_threads_t *threads);
987
988 /**
989  * Destroy a notmuch_threads_t object.
990  *
991  * It's not strictly necessary to call this function. All memory from
992  * the notmuch_threads_t object will be reclaimed when the
993  * containing query object is destroyed.
994  */
995 void
996 notmuch_threads_destroy (notmuch_threads_t *threads);
997
998 /**
999  * Return the number of messages matching a search.
1000  *
1001  * This function performs a search and returns the number of matching
1002  * messages.
1003  *
1004  * @returns
1005  *
1006  * NOTMUCH_STATUS_SUCCESS: query completed successfully.
1007  *
1008  * NOTMUCH_STATUS_XAPIAN_EXCEPTION: a Xapian exception occured. The
1009  *      value of *count is not defined.
1010  *
1011  * @since libnotmuch 5 (notmuch 0.25)
1012  */
1013 notmuch_status_t
1014 notmuch_query_count_messages (notmuch_query_t *query, unsigned int *count);
1015
1016 /**
1017  * Deprecated alias for notmuch_query_count_messages
1018  *
1019  *
1020  * @deprecated Deprecated since libnotmuch 5.0 (notmuch 0.25). Please
1021  * use notmuch_query_count_messages instead.
1022  */
1023 NOTMUCH_DEPRECATED(5,0)
1024 notmuch_status_t
1025 notmuch_query_count_messages_st (notmuch_query_t *query, unsigned int *count);
1026
1027 /**
1028  * Return the number of threads matching a search.
1029  *
1030  * This function performs a search and returns the number of unique thread IDs
1031  * in the matching messages. This is the same as number of threads matching a
1032  * search.
1033  *
1034  * Note that this is a significantly heavier operation than
1035  * notmuch_query_count_messages{_st}().
1036  *
1037  * @returns
1038  *
1039  * NOTMUCH_STATUS_OUT_OF_MEMORY: Memory allocation failed. The value
1040  *      of *count is not defined
1041
1042  * NOTMUCH_STATUS_SUCCESS: query completed successfully.
1043  *
1044  * NOTMUCH_STATUS_XAPIAN_EXCEPTION: a Xapian exception occured. The
1045  *      value of *count is not defined.
1046  *
1047  * @since libnotmuch 5 (notmuch 0.25)
1048  */
1049 notmuch_status_t
1050 notmuch_query_count_threads (notmuch_query_t *query, unsigned *count);
1051
1052 /**
1053  * Deprecated alias for notmuch_query_count_threads
1054  *
1055  * @deprecated Deprecated as of libnotmuch 5.0 (notmuch 0.25). Please
1056  * use notmuch_query_count_threads_st instead.
1057  */
1058 NOTMUCH_DEPRECATED(5,0)
1059 notmuch_status_t
1060 notmuch_query_count_threads_st (notmuch_query_t *query, unsigned *count);
1061
1062 /**
1063  * Get the thread ID of 'thread'.
1064  *
1065  * The returned string belongs to 'thread' and as such, should not be
1066  * modified by the caller and will only be valid for as long as the
1067  * thread is valid, (which is until notmuch_thread_destroy or until
1068  * the query from which it derived is destroyed).
1069  */
1070 const char *
1071 notmuch_thread_get_thread_id (notmuch_thread_t *thread);
1072
1073 /**
1074  * Get the total number of messages in 'thread'.
1075  *
1076  * This count consists of all messages in the database belonging to
1077  * this thread. Contrast with notmuch_thread_get_matched_messages() .
1078  */
1079 int
1080 notmuch_thread_get_total_messages (notmuch_thread_t *thread);
1081
1082 /**
1083  * Get a notmuch_messages_t iterator for the top-level messages in
1084  * 'thread' in oldest-first order.
1085  *
1086  * This iterator will not necessarily iterate over all of the messages
1087  * in the thread. It will only iterate over the messages in the thread
1088  * which are not replies to other messages in the thread.
1089  *
1090  * The returned list will be destroyed when the thread is destroyed.
1091  */
1092 notmuch_messages_t *
1093 notmuch_thread_get_toplevel_messages (notmuch_thread_t *thread);
1094
1095 /**
1096  * Get a notmuch_thread_t iterator for all messages in 'thread' in
1097  * oldest-first order.
1098  *
1099  * The returned list will be destroyed when the thread is destroyed.
1100  */
1101 notmuch_messages_t *
1102 notmuch_thread_get_messages (notmuch_thread_t *thread);
1103
1104 /**
1105  * Get the number of messages in 'thread' that matched the search.
1106  *
1107  * This count includes only the messages in this thread that were
1108  * matched by the search from which the thread was created and were
1109  * not excluded by any exclude tags passed in with the query (see
1110  * notmuch_query_add_tag_exclude). Contrast with
1111  * notmuch_thread_get_total_messages() .
1112  */
1113 int
1114 notmuch_thread_get_matched_messages (notmuch_thread_t *thread);
1115
1116 /**
1117  * Get the authors of 'thread' as a UTF-8 string.
1118  *
1119  * The returned string is a comma-separated list of the names of the
1120  * authors of mail messages in the query results that belong to this
1121  * thread.
1122  *
1123  * The string contains authors of messages matching the query first, then
1124  * non-matched authors (with the two groups separated by '|'). Within
1125  * each group, authors are ordered by date.
1126  *
1127  * The returned string belongs to 'thread' and as such, should not be
1128  * modified by the caller and will only be valid for as long as the
1129  * thread is valid, (which is until notmuch_thread_destroy or until
1130  * the query from which it derived is destroyed).
1131  */
1132 const char *
1133 notmuch_thread_get_authors (notmuch_thread_t *thread);
1134
1135 /**
1136  * Get the subject of 'thread' as a UTF-8 string.
1137  *
1138  * The subject is taken from the first message (according to the query
1139  * order---see notmuch_query_set_sort) in the query results that
1140  * belongs to this thread.
1141  *
1142  * The returned string belongs to 'thread' and as such, should not be
1143  * modified by the caller and will only be valid for as long as the
1144  * thread is valid, (which is until notmuch_thread_destroy or until
1145  * the query from which it derived is destroyed).
1146  */
1147 const char *
1148 notmuch_thread_get_subject (notmuch_thread_t *thread);
1149
1150 /**
1151  * Get the date of the oldest message in 'thread' as a time_t value.
1152  */
1153 time_t
1154 notmuch_thread_get_oldest_date (notmuch_thread_t *thread);
1155
1156 /**
1157  * Get the date of the newest message in 'thread' as a time_t value.
1158  */
1159 time_t
1160 notmuch_thread_get_newest_date (notmuch_thread_t *thread);
1161
1162 /**
1163  * Get the tags for 'thread', returning a notmuch_tags_t object which
1164  * can be used to iterate over all tags.
1165  *
1166  * Note: In the Notmuch database, tags are stored on individual
1167  * messages, not on threads. So the tags returned here will be all
1168  * tags of the messages which matched the search and which belong to
1169  * this thread.
1170  *
1171  * The tags object is owned by the thread and as such, will only be
1172  * valid for as long as the thread is valid, (for example, until
1173  * notmuch_thread_destroy or until the query from which it derived is
1174  * destroyed).
1175  *
1176  * Typical usage might be:
1177  *
1178  *     notmuch_thread_t *thread;
1179  *     notmuch_tags_t *tags;
1180  *     const char *tag;
1181  *
1182  *     thread = notmuch_threads_get (threads);
1183  *
1184  *     for (tags = notmuch_thread_get_tags (thread);
1185  *          notmuch_tags_valid (tags);
1186  *          notmuch_tags_move_to_next (tags))
1187  *     {
1188  *         tag = notmuch_tags_get (tags);
1189  *         ....
1190  *     }
1191  *
1192  *     notmuch_thread_destroy (thread);
1193  *
1194  * Note that there's no explicit destructor needed for the
1195  * notmuch_tags_t object. (For consistency, we do provide a
1196  * notmuch_tags_destroy function, but there's no good reason to call
1197  * it if the message is about to be destroyed).
1198  */
1199 notmuch_tags_t *
1200 notmuch_thread_get_tags (notmuch_thread_t *thread);
1201
1202 /**
1203  * Destroy a notmuch_thread_t object.
1204  */
1205 void
1206 notmuch_thread_destroy (notmuch_thread_t *thread);
1207
1208 /**
1209  * Is the given 'messages' iterator pointing at a valid message.
1210  *
1211  * When this function returns TRUE, notmuch_messages_get will return a
1212  * valid object. Whereas when this function returns FALSE,
1213  * notmuch_messages_get will return NULL.
1214  *
1215  * See the documentation of notmuch_query_search_messages for example
1216  * code showing how to iterate over a notmuch_messages_t object.
1217  */
1218 notmuch_bool_t
1219 notmuch_messages_valid (notmuch_messages_t *messages);
1220
1221 /**
1222  * Get the current message from 'messages' as a notmuch_message_t.
1223  *
1224  * Note: The returned message belongs to 'messages' and has a lifetime
1225  * identical to it (and the query to which it belongs).
1226  *
1227  * See the documentation of notmuch_query_search_messages for example
1228  * code showing how to iterate over a notmuch_messages_t object.
1229  *
1230  * If an out-of-memory situation occurs, this function will return
1231  * NULL.
1232  */
1233 notmuch_message_t *
1234 notmuch_messages_get (notmuch_messages_t *messages);
1235
1236 /**
1237  * Move the 'messages' iterator to the next message.
1238  *
1239  * If 'messages' is already pointing at the last message then the
1240  * iterator will be moved to a point just beyond that last message,
1241  * (where notmuch_messages_valid will return FALSE and
1242  * notmuch_messages_get will return NULL).
1243  *
1244  * See the documentation of notmuch_query_search_messages for example
1245  * code showing how to iterate over a notmuch_messages_t object.
1246  */
1247 void
1248 notmuch_messages_move_to_next (notmuch_messages_t *messages);
1249
1250 /**
1251  * Destroy a notmuch_messages_t object.
1252  *
1253  * It's not strictly necessary to call this function. All memory from
1254  * the notmuch_messages_t object will be reclaimed when the containing
1255  * query object is destroyed.
1256  */
1257 void
1258 notmuch_messages_destroy (notmuch_messages_t *messages);
1259
1260 /**
1261  * Return a list of tags from all messages.
1262  *
1263  * The resulting list is guaranteed not to contain duplicated tags.
1264  *
1265  * WARNING: You can no longer iterate over messages after calling this
1266  * function, because the iterator will point at the end of the list.
1267  * We do not have a function to reset the iterator yet and the only
1268  * way how you can iterate over the list again is to recreate the
1269  * message list.
1270  *
1271  * The function returns NULL on error.
1272  */
1273 notmuch_tags_t *
1274 notmuch_messages_collect_tags (notmuch_messages_t *messages);
1275
1276 /**
1277  * Get the message ID of 'message'.
1278  *
1279  * The returned string belongs to 'message' and as such, should not be
1280  * modified by the caller and will only be valid for as long as the
1281  * message is valid, (which is until the query from which it derived
1282  * is destroyed).
1283  *
1284  * This function will not return NULL since Notmuch ensures that every
1285  * message has a unique message ID, (Notmuch will generate an ID for a
1286  * message if the original file does not contain one).
1287  */
1288 const char *
1289 notmuch_message_get_message_id (notmuch_message_t *message);
1290
1291 /**
1292  * Get the thread ID of 'message'.
1293  *
1294  * The returned string belongs to 'message' and as such, should not be
1295  * modified by the caller and will only be valid for as long as the
1296  * message is valid, (for example, until the user calls
1297  * notmuch_message_destroy on 'message' or until a query from which it
1298  * derived is destroyed).
1299  *
1300  * This function will not return NULL since Notmuch ensures that every
1301  * message belongs to a single thread.
1302  */
1303 const char *
1304 notmuch_message_get_thread_id (notmuch_message_t *message);
1305
1306 /**
1307  * Get a notmuch_messages_t iterator for all of the replies to
1308  * 'message'.
1309  *
1310  * Note: This call only makes sense if 'message' was ultimately
1311  * obtained from a notmuch_thread_t object, (such as by coming
1312  * directly from the result of calling notmuch_thread_get_
1313  * toplevel_messages or by any number of subsequent
1314  * calls to notmuch_message_get_replies).
1315  *
1316  * If 'message' was obtained through some non-thread means, (such as
1317  * by a call to notmuch_query_search_messages), then this function
1318  * will return NULL.
1319  *
1320  * If there are no replies to 'message', this function will return
1321  * NULL. (Note that notmuch_messages_valid will accept that NULL
1322  * value as legitimate, and simply return FALSE for it.)
1323  */
1324 notmuch_messages_t *
1325 notmuch_message_get_replies (notmuch_message_t *message);
1326
1327 /**
1328  * Get a filename for the email corresponding to 'message'.
1329  *
1330  * The returned filename is an absolute filename, (the initial
1331  * component will match notmuch_database_get_path() ).
1332  *
1333  * The returned string belongs to the message so should not be
1334  * modified or freed by the caller (nor should it be referenced after
1335  * the message is destroyed).
1336  *
1337  * Note: If this message corresponds to multiple files in the mail
1338  * store, (that is, multiple files contain identical message IDs),
1339  * this function will arbitrarily return a single one of those
1340  * filenames. See notmuch_message_get_filenames for returning the
1341  * complete list of filenames.
1342  */
1343 const char *
1344 notmuch_message_get_filename (notmuch_message_t *message);
1345
1346 /**
1347  * Get all filenames for the email corresponding to 'message'.
1348  *
1349  * Returns a notmuch_filenames_t iterator listing all the filenames
1350  * associated with 'message'. These files may not have identical
1351  * content, but each will have the identical Message-ID.
1352  *
1353  * Each filename in the iterator is an absolute filename, (the initial
1354  * component will match notmuch_database_get_path() ).
1355  */
1356 notmuch_filenames_t *
1357 notmuch_message_get_filenames (notmuch_message_t *message);
1358
1359 /**
1360  * Message flags.
1361  */
1362 typedef enum _notmuch_message_flag {
1363     NOTMUCH_MESSAGE_FLAG_MATCH,
1364     NOTMUCH_MESSAGE_FLAG_EXCLUDED,
1365
1366     /* This message is a "ghost message", meaning it has no filenames
1367      * or content, but we know it exists because it was referenced by
1368      * some other message.  A ghost message has only a message ID and
1369      * thread ID.
1370      */
1371     NOTMUCH_MESSAGE_FLAG_GHOST,
1372 } notmuch_message_flag_t;
1373
1374 /**
1375  * Get a value of a flag for the email corresponding to 'message'.
1376  */
1377 notmuch_bool_t
1378 notmuch_message_get_flag (notmuch_message_t *message,
1379                           notmuch_message_flag_t flag);
1380
1381 /**
1382  * Set a value of a flag for the email corresponding to 'message'.
1383  */
1384 void
1385 notmuch_message_set_flag (notmuch_message_t *message,
1386                           notmuch_message_flag_t flag, notmuch_bool_t value);
1387
1388 /**
1389  * Get the date of 'message' as a time_t value.
1390  *
1391  * For the original textual representation of the Date header from the
1392  * message call notmuch_message_get_header() with a header value of
1393  * "date".
1394  */
1395 time_t
1396 notmuch_message_get_date  (notmuch_message_t *message);
1397
1398 /**
1399  * Get the value of the specified header from 'message' as a UTF-8 string.
1400  *
1401  * Common headers are stored in the database when the message is
1402  * indexed and will be returned from the database.  Other headers will
1403  * be read from the actual message file.
1404  *
1405  * The header name is case insensitive.
1406  *
1407  * The returned string belongs to the message so should not be
1408  * modified or freed by the caller (nor should it be referenced after
1409  * the message is destroyed).
1410  *
1411  * Returns an empty string ("") if the message does not contain a
1412  * header line matching 'header'. Returns NULL if any error occurs.
1413  */
1414 const char *
1415 notmuch_message_get_header (notmuch_message_t *message, const char *header);
1416
1417 /**
1418  * Get the tags for 'message', returning a notmuch_tags_t object which
1419  * can be used to iterate over all tags.
1420  *
1421  * The tags object is owned by the message and as such, will only be
1422  * valid for as long as the message is valid, (which is until the
1423  * query from which it derived is destroyed).
1424  *
1425  * Typical usage might be:
1426  *
1427  *     notmuch_message_t *message;
1428  *     notmuch_tags_t *tags;
1429  *     const char *tag;
1430  *
1431  *     message = notmuch_database_find_message (database, message_id);
1432  *
1433  *     for (tags = notmuch_message_get_tags (message);
1434  *          notmuch_tags_valid (tags);
1435  *          notmuch_tags_move_to_next (tags))
1436  *     {
1437  *         tag = notmuch_tags_get (tags);
1438  *         ....
1439  *     }
1440  *
1441  *     notmuch_message_destroy (message);
1442  *
1443  * Note that there's no explicit destructor needed for the
1444  * notmuch_tags_t object. (For consistency, we do provide a
1445  * notmuch_tags_destroy function, but there's no good reason to call
1446  * it if the message is about to be destroyed).
1447  */
1448 notmuch_tags_t *
1449 notmuch_message_get_tags (notmuch_message_t *message);
1450
1451 /**
1452  * The longest possible tag value.
1453  */
1454 #define NOTMUCH_TAG_MAX 200
1455
1456 /**
1457  * Add a tag to the given message.
1458  *
1459  * Return value:
1460  *
1461  * NOTMUCH_STATUS_SUCCESS: Tag successfully added to message
1462  *
1463  * NOTMUCH_STATUS_NULL_POINTER: The 'tag' argument is NULL
1464  *
1465  * NOTMUCH_STATUS_TAG_TOO_LONG: The length of 'tag' is too long
1466  *      (exceeds NOTMUCH_TAG_MAX)
1467  *
1468  * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
1469  *      mode so message cannot be modified.
1470  */
1471 notmuch_status_t
1472 notmuch_message_add_tag (notmuch_message_t *message, const char *tag);
1473
1474 /**
1475  * Remove a tag from the given message.
1476  *
1477  * Return value:
1478  *
1479  * NOTMUCH_STATUS_SUCCESS: Tag successfully removed from message
1480  *
1481  * NOTMUCH_STATUS_NULL_POINTER: The 'tag' argument is NULL
1482  *
1483  * NOTMUCH_STATUS_TAG_TOO_LONG: The length of 'tag' is too long
1484  *      (exceeds NOTMUCH_TAG_MAX)
1485  *
1486  * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
1487  *      mode so message cannot be modified.
1488  */
1489 notmuch_status_t
1490 notmuch_message_remove_tag (notmuch_message_t *message, const char *tag);
1491
1492 /**
1493  * Remove all tags from the given message.
1494  *
1495  * See notmuch_message_freeze for an example showing how to safely
1496  * replace tag values.
1497  *
1498  * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
1499  *      mode so message cannot be modified.
1500  */
1501 notmuch_status_t
1502 notmuch_message_remove_all_tags (notmuch_message_t *message);
1503
1504 /**
1505  * Add/remove tags according to maildir flags in the message filename(s).
1506  *
1507  * This function examines the filenames of 'message' for maildir
1508  * flags, and adds or removes tags on 'message' as follows when these
1509  * flags are present:
1510  *
1511  *      Flag    Action if present
1512  *      ----    -----------------
1513  *      'D'     Adds the "draft" tag to the message
1514  *      'F'     Adds the "flagged" tag to the message
1515  *      'P'     Adds the "passed" tag to the message
1516  *      'R'     Adds the "replied" tag to the message
1517  *      'S'     Removes the "unread" tag from the message
1518  *
1519  * For each flag that is not present, the opposite action (add/remove)
1520  * is performed for the corresponding tags.
1521  *
1522  * Flags are identified as trailing components of the filename after a
1523  * sequence of ":2,".
1524  *
1525  * If there are multiple filenames associated with this message, the
1526  * flag is considered present if it appears in one or more
1527  * filenames. (That is, the flags from the multiple filenames are
1528  * combined with the logical OR operator.)
1529  *
1530  * A client can ensure that notmuch database tags remain synchronized
1531  * with maildir flags by calling this function after each call to
1532  * notmuch_database_add_message. See also
1533  * notmuch_message_tags_to_maildir_flags for synchronizing tag changes
1534  * back to maildir flags.
1535  */
1536 notmuch_status_t
1537 notmuch_message_maildir_flags_to_tags (notmuch_message_t *message);
1538
1539 /**
1540  * Rename message filename(s) to encode tags as maildir flags.
1541  *
1542  * Specifically, for each filename corresponding to this message:
1543  *
1544  * If the filename is not in a maildir directory, do nothing.  (A
1545  * maildir directory is determined as a directory named "new" or
1546  * "cur".) Similarly, if the filename has invalid maildir info,
1547  * (repeated or outof-ASCII-order flag characters after ":2,"), then
1548  * do nothing.
1549  *
1550  * If the filename is in a maildir directory, rename the file so that
1551  * its filename ends with the sequence ":2," followed by zero or more
1552  * of the following single-character flags (in ASCII order):
1553  *
1554  *   'D' iff the message has the "draft" tag
1555  *   'F' iff the message has the "flagged" tag
1556  *   'P' iff the message has the "passed" tag
1557  *   'R' iff the message has the "replied" tag
1558  *   'S' iff the message does not have the "unread" tag
1559  *
1560  * Any existing flags unmentioned in the list above will be preserved
1561  * in the renaming.
1562  *
1563  * Also, if this filename is in a directory named "new", rename it to
1564  * be within the neighboring directory named "cur".
1565  *
1566  * A client can ensure that maildir filename flags remain synchronized
1567  * with notmuch database tags by calling this function after changing
1568  * tags, (after calls to notmuch_message_add_tag,
1569  * notmuch_message_remove_tag, or notmuch_message_freeze/
1570  * notmuch_message_thaw). See also notmuch_message_maildir_flags_to_tags
1571  * for synchronizing maildir flag changes back to tags.
1572  */
1573 notmuch_status_t
1574 notmuch_message_tags_to_maildir_flags (notmuch_message_t *message);
1575
1576 /**
1577  * Freeze the current state of 'message' within the database.
1578  *
1579  * This means that changes to the message state, (via
1580  * notmuch_message_add_tag, notmuch_message_remove_tag, and
1581  * notmuch_message_remove_all_tags), will not be committed to the
1582  * database until the message is thawed with notmuch_message_thaw.
1583  *
1584  * Multiple calls to freeze/thaw are valid and these calls will
1585  * "stack". That is there must be as many calls to thaw as to freeze
1586  * before a message is actually thawed.
1587  *
1588  * The ability to do freeze/thaw allows for safe transactions to
1589  * change tag values. For example, explicitly setting a message to
1590  * have a given set of tags might look like this:
1591  *
1592  *    notmuch_message_freeze (message);
1593  *
1594  *    notmuch_message_remove_all_tags (message);
1595  *
1596  *    for (i = 0; i < NUM_TAGS; i++)
1597  *        notmuch_message_add_tag (message, tags[i]);
1598  *
1599  *    notmuch_message_thaw (message);
1600  *
1601  * With freeze/thaw used like this, the message in the database is
1602  * guaranteed to have either the full set of original tag values, or
1603  * the full set of new tag values, but nothing in between.
1604  *
1605  * Imagine the example above without freeze/thaw and the operation
1606  * somehow getting interrupted. This could result in the message being
1607  * left with no tags if the interruption happened after
1608  * notmuch_message_remove_all_tags but before notmuch_message_add_tag.
1609  *
1610  * Return value:
1611  *
1612  * NOTMUCH_STATUS_SUCCESS: Message successfully frozen.
1613  *
1614  * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
1615  *      mode so message cannot be modified.
1616  */
1617 notmuch_status_t
1618 notmuch_message_freeze (notmuch_message_t *message);
1619
1620 /**
1621  * Thaw the current 'message', synchronizing any changes that may have
1622  * occurred while 'message' was frozen into the notmuch database.
1623  *
1624  * See notmuch_message_freeze for an example of how to use this
1625  * function to safely provide tag changes.
1626  *
1627  * Multiple calls to freeze/thaw are valid and these calls with
1628  * "stack". That is there must be as many calls to thaw as to freeze
1629  * before a message is actually thawed.
1630  *
1631  * Return value:
1632  *
1633  * NOTMUCH_STATUS_SUCCESS: Message successfully thawed, (or at least
1634  *      its frozen count has successfully been reduced by 1).
1635  *
1636  * NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW: An attempt was made to thaw
1637  *      an unfrozen message. That is, there have been an unbalanced
1638  *      number of calls to notmuch_message_freeze and
1639  *      notmuch_message_thaw.
1640  */
1641 notmuch_status_t
1642 notmuch_message_thaw (notmuch_message_t *message);
1643
1644 /**
1645  * Destroy a notmuch_message_t object.
1646  *
1647  * It can be useful to call this function in the case of a single
1648  * query object with many messages in the result, (such as iterating
1649  * over the entire database). Otherwise, it's fine to never call this
1650  * function and there will still be no memory leaks. (The memory from
1651  * the messages get reclaimed when the containing query is destroyed.)
1652  */
1653 void
1654 notmuch_message_destroy (notmuch_message_t *message);
1655
1656 /**
1657  * @name Message Properties
1658  *
1659  * This interface provides the ability to attach arbitrary (key,value)
1660  * string pairs to a message, to remove such pairs, and to iterate
1661  * over them.  The caller should take some care as to what keys they
1662  * add or delete values for, as other subsystems or extensions may
1663  * depend on these properties.
1664  *
1665  */
1666 /**@{*/
1667 /**
1668  * Retrieve the value for a single property key
1669  *
1670  * *value* is set to a string owned by the message or NULL if there is
1671  * no such key. In the case of multiple values for the given key, the
1672  * first one is retrieved.
1673  *
1674  * @returns
1675  * - NOTMUCH_STATUS_NULL_POINTER: *value* may not be NULL.
1676  * - NOTMUCH_STATUS_SUCCESS: No error occured.
1677  * @since libnotmuch 4.4 (notmuch 0.23)
1678  */
1679 notmuch_status_t
1680 notmuch_message_get_property (notmuch_message_t *message, const char *key, const char **value);
1681
1682 /**
1683  * Add a (key,value) pair to a message
1684  *
1685  * @returns
1686  * - NOTMUCH_STATUS_ILLEGAL_ARGUMENT: *key* may not contain an '=' character.
1687  * - NOTMUCH_STATUS_NULL_POINTER: Neither *key* nor *value* may be NULL.
1688  * - NOTMUCH_STATUS_SUCCESS: No error occured.
1689  * @since libnotmuch 4.4 (notmuch 0.23)
1690  */
1691 notmuch_status_t
1692 notmuch_message_add_property (notmuch_message_t *message, const char *key, const char *value);
1693
1694 /**
1695  * Remove a (key,value) pair from a message.
1696  *
1697  * It is not an error to remove a non-existant (key,value) pair
1698  *
1699  * @returns
1700  * - NOTMUCH_STATUS_ILLEGAL_ARGUMENT: *key* may not contain an '=' character.
1701  * - NOTMUCH_STATUS_NULL_POINTER: Neither *key* nor *value* may be NULL.
1702  * - NOTMUCH_STATUS_SUCCESS: No error occured.
1703  * @since libnotmuch 4.4 (notmuch 0.23)
1704  */
1705 notmuch_status_t
1706 notmuch_message_remove_property (notmuch_message_t *message, const char *key, const char *value);
1707
1708 /**
1709  * Remove all (key,value) pairs from the given message.
1710  *
1711  * @param[in,out] message  message to operate on.
1712  * @param[in]     key      key to delete properties for. If NULL, delete
1713  *                         properties for all keys
1714  * @returns
1715  * - NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in
1716  *   read-only mode so message cannot be modified.
1717  * - NOTMUCH_STATUS_SUCCESS: No error occured.
1718  *
1719  * @since libnotmuch 4.4 (notmuch 0.23)
1720  */
1721 notmuch_status_t
1722 notmuch_message_remove_all_properties (notmuch_message_t *message, const char *key);
1723
1724 /**
1725  * Opaque message property iterator
1726  */
1727 typedef struct _notmuch_string_map_iterator notmuch_message_properties_t;
1728
1729 /**
1730  * Get the properties for *message*, returning a
1731  * notmuch_message_properties_t object which can be used to iterate
1732  * over all properties.
1733  *
1734  * The notmuch_message_properties_t object is owned by the message and
1735  * as such, will only be valid for as long as the message is valid,
1736  * (which is until the query from which it derived is destroyed).
1737  *
1738  * @param[in] message  The message to examine
1739  * @param[in] key      key or key prefix
1740  * @param[in] exact    if TRUE, require exact match with key. Otherwise
1741  *                     treat as prefix.
1742  *
1743  * Typical usage might be:
1744  *
1745  *     notmuch_message_properties_t *list;
1746  *
1747  *     for (list = notmuch_message_get_properties (message, "testkey1", TRUE);
1748  *          notmuch_message_properties_valid (list); notmuch_message_properties_move_to_next (list)) {
1749  *        printf("%s\n", notmuch_message_properties_value(list));
1750  *     }
1751  *
1752  *     notmuch_message_properties_destroy (list);
1753  *
1754  * Note that there's no explicit destructor needed for the
1755  * notmuch_message_properties_t object. (For consistency, we do
1756  * provide a notmuch_message_properities_destroy function, but there's
1757  * no good reason to call it if the message is about to be destroyed).
1758  *
1759  * @since libnotmuch 4.4 (notmuch 0.23)
1760  */
1761 notmuch_message_properties_t *
1762 notmuch_message_get_properties (notmuch_message_t *message, const char *key, notmuch_bool_t exact);
1763
1764 /**
1765  * Is the given *properties* iterator pointing at a valid (key,value)
1766  * pair.
1767  *
1768  * When this function returns TRUE,
1769  * notmuch_message_properties_{key,value} will return a valid string,
1770  * and notmuch_message_properties_move_to_next will do what it
1771  * says. Whereas when this function returns FALSE, calling any of
1772  * these functions results in undefined behaviour.
1773  *
1774  * See the documentation of notmuch_message_properties_get for example
1775  * code showing how to iterate over a notmuch_message_properties_t
1776  * object.
1777  *
1778  * @since libnotmuch 4.4 (notmuch 0.23)
1779  */
1780 notmuch_bool_t
1781 notmuch_message_properties_valid (notmuch_message_properties_t *properties);
1782
1783 /**
1784  * Move the *properties* iterator to the next (key,value) pair
1785  *
1786  * If *properties* is already pointing at the last pair then the iterator
1787  * will be moved to a point just beyond that last pair, (where
1788  * notmuch_message_properties_valid will return FALSE).
1789  *
1790  * See the documentation of notmuch_message_get_properties for example
1791  * code showing how to iterate over a notmuch_message_properties_t object.
1792  *
1793  * @since libnotmuch 4.4 (notmuch 0.23)
1794  */
1795 void
1796 notmuch_message_properties_move_to_next (notmuch_message_properties_t *properties);
1797
1798 /**
1799  * Return the key from the current (key,value) pair.
1800  *
1801  * this could be useful if iterating for a prefix
1802  *
1803  * @since libnotmuch 4.4 (notmuch 0.23)
1804  */
1805 const char *
1806 notmuch_message_properties_key (notmuch_message_properties_t *properties);
1807
1808 /**
1809  * Return the value from the current (key,value) pair.
1810  *
1811  * This could be useful if iterating for a prefix.
1812  *
1813  * @since libnotmuch 4.4 (notmuch 0.23)
1814  */
1815 const char *
1816 notmuch_message_properties_value (notmuch_message_properties_t *properties);
1817
1818
1819 /**
1820  * Destroy a notmuch_message_properties_t object.
1821  *
1822  * It's not strictly necessary to call this function. All memory from
1823  * the notmuch_message_properties_t object will be reclaimed when the
1824  * containing message object is destroyed.
1825  *
1826  * @since libnotmuch 4.4 (notmuch 0.23)
1827  */
1828 void
1829 notmuch_message_properties_destroy (notmuch_message_properties_t *properties);
1830
1831 /**@}*/
1832
1833 /**
1834  * Is the given 'tags' iterator pointing at a valid tag.
1835  *
1836  * When this function returns TRUE, notmuch_tags_get will return a
1837  * valid string. Whereas when this function returns FALSE,
1838  * notmuch_tags_get will return NULL.
1839  *
1840  * See the documentation of notmuch_message_get_tags for example code
1841  * showing how to iterate over a notmuch_tags_t object.
1842  */
1843 notmuch_bool_t
1844 notmuch_tags_valid (notmuch_tags_t *tags);
1845
1846 /**
1847  * Get the current tag from 'tags' as a string.
1848  *
1849  * Note: The returned string belongs to 'tags' and has a lifetime
1850  * identical to it (and the query to which it ultimately belongs).
1851  *
1852  * See the documentation of notmuch_message_get_tags for example code
1853  * showing how to iterate over a notmuch_tags_t object.
1854  */
1855 const char *
1856 notmuch_tags_get (notmuch_tags_t *tags);
1857
1858 /**
1859  * Move the 'tags' iterator to the next tag.
1860  *
1861  * If 'tags' is already pointing at the last tag then the iterator
1862  * will be moved to a point just beyond that last tag, (where
1863  * notmuch_tags_valid will return FALSE and notmuch_tags_get will
1864  * return NULL).
1865  *
1866  * See the documentation of notmuch_message_get_tags for example code
1867  * showing how to iterate over a notmuch_tags_t object.
1868  */
1869 void
1870 notmuch_tags_move_to_next (notmuch_tags_t *tags);
1871
1872 /**
1873  * Destroy a notmuch_tags_t object.
1874  *
1875  * It's not strictly necessary to call this function. All memory from
1876  * the notmuch_tags_t object will be reclaimed when the containing
1877  * message or query objects are destroyed.
1878  */
1879 void
1880 notmuch_tags_destroy (notmuch_tags_t *tags);
1881
1882 /**
1883  * Store an mtime within the database for 'directory'.
1884  *
1885  * The 'directory' should be an object retrieved from the database
1886  * with notmuch_database_get_directory for a particular path.
1887  *
1888  * The intention is for the caller to use the mtime to allow efficient
1889  * identification of new messages to be added to the database. The
1890  * recommended usage is as follows:
1891  *
1892  *   o Read the mtime of a directory from the filesystem
1893  *
1894  *   o Call add_message for all mail files in the directory
1895  *
1896  *   o Call notmuch_directory_set_mtime with the mtime read from the
1897  *     filesystem.
1898  *
1899  * Then, when wanting to check for updates to the directory in the
1900  * future, the client can call notmuch_directory_get_mtime and know
1901  * that it only needs to add files if the mtime of the directory and
1902  * files are newer than the stored timestamp.
1903  *
1904  * Note: The notmuch_directory_get_mtime function does not allow the
1905  * caller to distinguish a timestamp of 0 from a non-existent
1906  * timestamp. So don't store a timestamp of 0 unless you are
1907  * comfortable with that.
1908  *
1909  * Return value:
1910  *
1911  * NOTMUCH_STATUS_SUCCESS: mtime successfully stored in database.
1912  *
1913  * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception
1914  *      occurred, mtime not stored.
1915  *
1916  * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
1917  *      mode so directory mtime cannot be modified.
1918  */
1919 notmuch_status_t
1920 notmuch_directory_set_mtime (notmuch_directory_t *directory,
1921                              time_t mtime);
1922
1923 /**
1924  * Get the mtime of a directory, (as previously stored with
1925  * notmuch_directory_set_mtime).
1926  *
1927  * Returns 0 if no mtime has previously been stored for this
1928  * directory.
1929  */
1930 time_t
1931 notmuch_directory_get_mtime (notmuch_directory_t *directory);
1932
1933 /**
1934  * Get a notmuch_filenames_t iterator listing all the filenames of
1935  * messages in the database within the given directory.
1936  *
1937  * The returned filenames will be the basename-entries only (not
1938  * complete paths).
1939  */
1940 notmuch_filenames_t *
1941 notmuch_directory_get_child_files (notmuch_directory_t *directory);
1942
1943 /**
1944  * Get a notmuch_filenames_t iterator listing all the filenames of
1945  * sub-directories in the database within the given directory.
1946  *
1947  * The returned filenames will be the basename-entries only (not
1948  * complete paths).
1949  */
1950 notmuch_filenames_t *
1951 notmuch_directory_get_child_directories (notmuch_directory_t *directory);
1952
1953 /**
1954  * Delete directory document from the database, and destroy the
1955  * notmuch_directory_t object. Assumes any child directories and files
1956  * have been deleted by the caller.
1957  *
1958  * @since libnotmuch 4.3 (notmuch 0.21)
1959  */
1960 notmuch_status_t
1961 notmuch_directory_delete (notmuch_directory_t *directory);
1962
1963 /**
1964  * Destroy a notmuch_directory_t object.
1965  */
1966 void
1967 notmuch_directory_destroy (notmuch_directory_t *directory);
1968
1969 /**
1970  * Is the given 'filenames' iterator pointing at a valid filename.
1971  *
1972  * When this function returns TRUE, notmuch_filenames_get will return
1973  * a valid string. Whereas when this function returns FALSE,
1974  * notmuch_filenames_get will return NULL.
1975  *
1976  * It is acceptable to pass NULL for 'filenames', in which case this
1977  * function will always return FALSE.
1978  */
1979 notmuch_bool_t
1980 notmuch_filenames_valid (notmuch_filenames_t *filenames);
1981
1982 /**
1983  * Get the current filename from 'filenames' as a string.
1984  *
1985  * Note: The returned string belongs to 'filenames' and has a lifetime
1986  * identical to it (and the directory to which it ultimately belongs).
1987  *
1988  * It is acceptable to pass NULL for 'filenames', in which case this
1989  * function will always return NULL.
1990  */
1991 const char *
1992 notmuch_filenames_get (notmuch_filenames_t *filenames);
1993
1994 /**
1995  * Move the 'filenames' iterator to the next filename.
1996  *
1997  * If 'filenames' is already pointing at the last filename then the
1998  * iterator will be moved to a point just beyond that last filename,
1999  * (where notmuch_filenames_valid will return FALSE and
2000  * notmuch_filenames_get will return NULL).
2001  *
2002  * It is acceptable to pass NULL for 'filenames', in which case this
2003  * function will do nothing.
2004  */
2005 void
2006 notmuch_filenames_move_to_next (notmuch_filenames_t *filenames);
2007
2008 /**
2009  * Destroy a notmuch_filenames_t object.
2010  *
2011  * It's not strictly necessary to call this function. All memory from
2012  * the notmuch_filenames_t object will be reclaimed when the
2013  * containing directory object is destroyed.
2014  *
2015  * It is acceptable to pass NULL for 'filenames', in which case this
2016  * function will do nothing.
2017  */
2018 void
2019 notmuch_filenames_destroy (notmuch_filenames_t *filenames);
2020
2021
2022 /**
2023  * set config 'key' to 'value'
2024  *
2025  * @since libnotmuch 4.4 (notmuch 0.23)
2026  */
2027 notmuch_status_t
2028 notmuch_database_set_config (notmuch_database_t *db, const char *key, const char *value);
2029
2030 /**
2031  * retrieve config item 'key', assign to  'value'
2032  *
2033  * keys which have not been previously set with n_d_set_config will
2034  * return an empty string.
2035  *
2036  * return value is allocated by malloc and should be freed by the
2037  * caller.
2038  *
2039  * @since libnotmuch 4.4 (notmuch 0.23)
2040  */
2041 notmuch_status_t
2042 notmuch_database_get_config (notmuch_database_t *db, const char *key, char **value);
2043
2044 /**
2045  * Create an iterator for all config items with keys matching a given prefix
2046  *
2047  * @since libnotmuch 4.4 (notmuch 0.23)
2048  */
2049 notmuch_status_t
2050 notmuch_database_get_config_list (notmuch_database_t *db, const char *prefix, notmuch_config_list_t **out);
2051
2052 /**
2053  * Is 'config_list' iterator valid (i.e. _key, _value, _move_to_next can be called).
2054  *
2055  * @since libnotmuch 4.4 (notmuch 0.23)
2056  */
2057 notmuch_bool_t
2058 notmuch_config_list_valid (notmuch_config_list_t *config_list);
2059
2060 /**
2061  * return key for current config pair
2062  *
2063  * return value is owned by the iterator, and will be destroyed by the
2064  * next call to notmuch_config_list_key or notmuch_config_list_destroy.
2065  *
2066  * @since libnotmuch 4.4 (notmuch 0.23)
2067  */
2068 const char *
2069 notmuch_config_list_key (notmuch_config_list_t *config_list);
2070
2071 /**
2072  * return 'value' for current config pair
2073  *
2074  * return value is owned by the iterator, and will be destroyed by the
2075  * next call to notmuch_config_list_value or notmuch config_list_destroy
2076  *
2077  * @since libnotmuch 4.4 (notmuch 0.23)
2078  */
2079 const char *
2080 notmuch_config_list_value (notmuch_config_list_t *config_list);
2081
2082
2083 /**
2084  * move 'config_list' iterator to the next pair
2085  *
2086  * @since libnotmuch 4.4 (notmuch 0.23)
2087  */
2088 void
2089 notmuch_config_list_move_to_next (notmuch_config_list_t *config_list);
2090
2091 /**
2092  * free any resources held by 'config_list'
2093  *
2094  * @since libnotmuch 4.4 (notmuch 0.23)
2095  */
2096 void
2097 notmuch_config_list_destroy (notmuch_config_list_t *config_list);
2098
2099 /**
2100  * interrogate the library for compile time features
2101  *
2102  * @since libnotmuch 4.4 (notmuch 0.23)
2103  */
2104 notmuch_bool_t
2105 notmuch_built_with (const char *name);
2106 /* @} */
2107
2108 NOTMUCH_END_DECLS
2109
2110 #endif