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