b79618f6127e78040104dbc9e8a754ba1329c849
[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 4.3 (notmuch 0.21)
1048  */
1049 notmuch_status_t
1050 notmuch_query_count_threads_st (notmuch_query_t *query, unsigned *count);
1051
1052 /**
1053  * like notmuch_query_count_threads, but without a status return.
1054  *
1055  * May return 0 in case of errors.
1056  *
1057  * @deprecated Deprecated as of libnotmuch 4.3 (notmuch 0.21). Please
1058  * use notmuch_query_count_threads_st instead.
1059  */
1060 NOTMUCH_DEPRECATED(4,3)
1061 unsigned int
1062 notmuch_query_count_threads (notmuch_query_t *query);
1063
1064 /**
1065  * Get the thread ID of 'thread'.
1066  *
1067  * The returned string belongs to 'thread' and as such, should not be
1068  * modified by the caller and will only be valid for as long as the
1069  * thread is valid, (which is until notmuch_thread_destroy or until
1070  * the query from which it derived is destroyed).
1071  */
1072 const char *
1073 notmuch_thread_get_thread_id (notmuch_thread_t *thread);
1074
1075 /**
1076  * Get the total number of messages in 'thread'.
1077  *
1078  * This count consists of all messages in the database belonging to
1079  * this thread. Contrast with notmuch_thread_get_matched_messages() .
1080  */
1081 int
1082 notmuch_thread_get_total_messages (notmuch_thread_t *thread);
1083
1084 /**
1085  * Get a notmuch_messages_t iterator for the top-level messages in
1086  * 'thread' in oldest-first order.
1087  *
1088  * This iterator will not necessarily iterate over all of the messages
1089  * in the thread. It will only iterate over the messages in the thread
1090  * which are not replies to other messages in the thread.
1091  *
1092  * The returned list will be destroyed when the thread is destroyed.
1093  */
1094 notmuch_messages_t *
1095 notmuch_thread_get_toplevel_messages (notmuch_thread_t *thread);
1096
1097 /**
1098  * Get a notmuch_thread_t iterator for all messages in 'thread' in
1099  * oldest-first order.
1100  *
1101  * The returned list will be destroyed when the thread is destroyed.
1102  */
1103 notmuch_messages_t *
1104 notmuch_thread_get_messages (notmuch_thread_t *thread);
1105
1106 /**
1107  * Get the number of messages in 'thread' that matched the search.
1108  *
1109  * This count includes only the messages in this thread that were
1110  * matched by the search from which the thread was created and were
1111  * not excluded by any exclude tags passed in with the query (see
1112  * notmuch_query_add_tag_exclude). Contrast with
1113  * notmuch_thread_get_total_messages() .
1114  */
1115 int
1116 notmuch_thread_get_matched_messages (notmuch_thread_t *thread);
1117
1118 /**
1119  * Get the authors of 'thread' as a UTF-8 string.
1120  *
1121  * The returned string is a comma-separated list of the names of the
1122  * authors of mail messages in the query results that belong to this
1123  * thread.
1124  *
1125  * The string contains authors of messages matching the query first, then
1126  * non-matched authors (with the two groups separated by '|'). Within
1127  * each group, authors are ordered by date.
1128  *
1129  * The returned string belongs to 'thread' and as such, should not be
1130  * modified by the caller and will only be valid for as long as the
1131  * thread is valid, (which is until notmuch_thread_destroy or until
1132  * the query from which it derived is destroyed).
1133  */
1134 const char *
1135 notmuch_thread_get_authors (notmuch_thread_t *thread);
1136
1137 /**
1138  * Get the subject of 'thread' as a UTF-8 string.
1139  *
1140  * The subject is taken from the first message (according to the query
1141  * order---see notmuch_query_set_sort) in the query results that
1142  * belongs to this thread.
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_subject (notmuch_thread_t *thread);
1151
1152 /**
1153  * Get the date of the oldest message in 'thread' as a time_t value.
1154  */
1155 time_t
1156 notmuch_thread_get_oldest_date (notmuch_thread_t *thread);
1157
1158 /**
1159  * Get the date of the newest message in 'thread' as a time_t value.
1160  */
1161 time_t
1162 notmuch_thread_get_newest_date (notmuch_thread_t *thread);
1163
1164 /**
1165  * Get the tags for 'thread', returning a notmuch_tags_t object which
1166  * can be used to iterate over all tags.
1167  *
1168  * Note: In the Notmuch database, tags are stored on individual
1169  * messages, not on threads. So the tags returned here will be all
1170  * tags of the messages which matched the search and which belong to
1171  * this thread.
1172  *
1173  * The tags object is owned by the thread and as such, will only be
1174  * valid for as long as the thread is valid, (for example, until
1175  * notmuch_thread_destroy or until the query from which it derived is
1176  * destroyed).
1177  *
1178  * Typical usage might be:
1179  *
1180  *     notmuch_thread_t *thread;
1181  *     notmuch_tags_t *tags;
1182  *     const char *tag;
1183  *
1184  *     thread = notmuch_threads_get (threads);
1185  *
1186  *     for (tags = notmuch_thread_get_tags (thread);
1187  *          notmuch_tags_valid (tags);
1188  *          notmuch_tags_move_to_next (tags))
1189  *     {
1190  *         tag = notmuch_tags_get (tags);
1191  *         ....
1192  *     }
1193  *
1194  *     notmuch_thread_destroy (thread);
1195  *
1196  * Note that there's no explicit destructor needed for the
1197  * notmuch_tags_t object. (For consistency, we do provide a
1198  * notmuch_tags_destroy function, but there's no good reason to call
1199  * it if the message is about to be destroyed).
1200  */
1201 notmuch_tags_t *
1202 notmuch_thread_get_tags (notmuch_thread_t *thread);
1203
1204 /**
1205  * Destroy a notmuch_thread_t object.
1206  */
1207 void
1208 notmuch_thread_destroy (notmuch_thread_t *thread);
1209
1210 /**
1211  * Is the given 'messages' iterator pointing at a valid message.
1212  *
1213  * When this function returns TRUE, notmuch_messages_get will return a
1214  * valid object. Whereas when this function returns FALSE,
1215  * notmuch_messages_get will return NULL.
1216  *
1217  * See the documentation of notmuch_query_search_messages for example
1218  * code showing how to iterate over a notmuch_messages_t object.
1219  */
1220 notmuch_bool_t
1221 notmuch_messages_valid (notmuch_messages_t *messages);
1222
1223 /**
1224  * Get the current message from 'messages' as a notmuch_message_t.
1225  *
1226  * Note: The returned message belongs to 'messages' and has a lifetime
1227  * identical to it (and the query to which it belongs).
1228  *
1229  * See the documentation of notmuch_query_search_messages for example
1230  * code showing how to iterate over a notmuch_messages_t object.
1231  *
1232  * If an out-of-memory situation occurs, this function will return
1233  * NULL.
1234  */
1235 notmuch_message_t *
1236 notmuch_messages_get (notmuch_messages_t *messages);
1237
1238 /**
1239  * Move the 'messages' iterator to the next message.
1240  *
1241  * If 'messages' is already pointing at the last message then the
1242  * iterator will be moved to a point just beyond that last message,
1243  * (where notmuch_messages_valid will return FALSE and
1244  * notmuch_messages_get will return NULL).
1245  *
1246  * See the documentation of notmuch_query_search_messages for example
1247  * code showing how to iterate over a notmuch_messages_t object.
1248  */
1249 void
1250 notmuch_messages_move_to_next (notmuch_messages_t *messages);
1251
1252 /**
1253  * Destroy a notmuch_messages_t object.
1254  *
1255  * It's not strictly necessary to call this function. All memory from
1256  * the notmuch_messages_t object will be reclaimed when the containing
1257  * query object is destroyed.
1258  */
1259 void
1260 notmuch_messages_destroy (notmuch_messages_t *messages);
1261
1262 /**
1263  * Return a list of tags from all messages.
1264  *
1265  * The resulting list is guaranteed not to contain duplicated tags.
1266  *
1267  * WARNING: You can no longer iterate over messages after calling this
1268  * function, because the iterator will point at the end of the list.
1269  * We do not have a function to reset the iterator yet and the only
1270  * way how you can iterate over the list again is to recreate the
1271  * message list.
1272  *
1273  * The function returns NULL on error.
1274  */
1275 notmuch_tags_t *
1276 notmuch_messages_collect_tags (notmuch_messages_t *messages);
1277
1278 /**
1279  * Get the message ID of 'message'.
1280  *
1281  * The returned string belongs to 'message' and as such, should not be
1282  * modified by the caller and will only be valid for as long as the
1283  * message is valid, (which is until the query from which it derived
1284  * is destroyed).
1285  *
1286  * This function will not return NULL since Notmuch ensures that every
1287  * message has a unique message ID, (Notmuch will generate an ID for a
1288  * message if the original file does not contain one).
1289  */
1290 const char *
1291 notmuch_message_get_message_id (notmuch_message_t *message);
1292
1293 /**
1294  * Get the thread 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, (for example, until the user calls
1299  * notmuch_message_destroy on 'message' or until a query from which it
1300  * derived is destroyed).
1301  *
1302  * This function will not return NULL since Notmuch ensures that every
1303  * message belongs to a single thread.
1304  */
1305 const char *
1306 notmuch_message_get_thread_id (notmuch_message_t *message);
1307
1308 /**
1309  * Get a notmuch_messages_t iterator for all of the replies to
1310  * 'message'.
1311  *
1312  * Note: This call only makes sense if 'message' was ultimately
1313  * obtained from a notmuch_thread_t object, (such as by coming
1314  * directly from the result of calling notmuch_thread_get_
1315  * toplevel_messages or by any number of subsequent
1316  * calls to notmuch_message_get_replies).
1317  *
1318  * If 'message' was obtained through some non-thread means, (such as
1319  * by a call to notmuch_query_search_messages), then this function
1320  * will return NULL.
1321  *
1322  * If there are no replies to 'message', this function will return
1323  * NULL. (Note that notmuch_messages_valid will accept that NULL
1324  * value as legitimate, and simply return FALSE for it.)
1325  */
1326 notmuch_messages_t *
1327 notmuch_message_get_replies (notmuch_message_t *message);
1328
1329 /**
1330  * Get a filename for the email corresponding to 'message'.
1331  *
1332  * The returned filename is an absolute filename, (the initial
1333  * component will match notmuch_database_get_path() ).
1334  *
1335  * The returned string belongs to the message so should not be
1336  * modified or freed by the caller (nor should it be referenced after
1337  * the message is destroyed).
1338  *
1339  * Note: If this message corresponds to multiple files in the mail
1340  * store, (that is, multiple files contain identical message IDs),
1341  * this function will arbitrarily return a single one of those
1342  * filenames. See notmuch_message_get_filenames for returning the
1343  * complete list of filenames.
1344  */
1345 const char *
1346 notmuch_message_get_filename (notmuch_message_t *message);
1347
1348 /**
1349  * Get all filenames for the email corresponding to 'message'.
1350  *
1351  * Returns a notmuch_filenames_t iterator listing all the filenames
1352  * associated with 'message'. These files may not have identical
1353  * content, but each will have the identical Message-ID.
1354  *
1355  * Each filename in the iterator is an absolute filename, (the initial
1356  * component will match notmuch_database_get_path() ).
1357  */
1358 notmuch_filenames_t *
1359 notmuch_message_get_filenames (notmuch_message_t *message);
1360
1361 /**
1362  * Message flags.
1363  */
1364 typedef enum _notmuch_message_flag {
1365     NOTMUCH_MESSAGE_FLAG_MATCH,
1366     NOTMUCH_MESSAGE_FLAG_EXCLUDED,
1367
1368     /* This message is a "ghost message", meaning it has no filenames
1369      * or content, but we know it exists because it was referenced by
1370      * some other message.  A ghost message has only a message ID and
1371      * thread ID.
1372      */
1373     NOTMUCH_MESSAGE_FLAG_GHOST,
1374 } notmuch_message_flag_t;
1375
1376 /**
1377  * Get a value of a flag for the email corresponding to 'message'.
1378  */
1379 notmuch_bool_t
1380 notmuch_message_get_flag (notmuch_message_t *message,
1381                           notmuch_message_flag_t flag);
1382
1383 /**
1384  * Set a value of a flag for the email corresponding to 'message'.
1385  */
1386 void
1387 notmuch_message_set_flag (notmuch_message_t *message,
1388                           notmuch_message_flag_t flag, notmuch_bool_t value);
1389
1390 /**
1391  * Get the date of 'message' as a time_t value.
1392  *
1393  * For the original textual representation of the Date header from the
1394  * message call notmuch_message_get_header() with a header value of
1395  * "date".
1396  */
1397 time_t
1398 notmuch_message_get_date  (notmuch_message_t *message);
1399
1400 /**
1401  * Get the value of the specified header from 'message' as a UTF-8 string.
1402  *
1403  * Common headers are stored in the database when the message is
1404  * indexed and will be returned from the database.  Other headers will
1405  * be read from the actual message file.
1406  *
1407  * The header name is case insensitive.
1408  *
1409  * The returned string belongs to the message so should not be
1410  * modified or freed by the caller (nor should it be referenced after
1411  * the message is destroyed).
1412  *
1413  * Returns an empty string ("") if the message does not contain a
1414  * header line matching 'header'. Returns NULL if any error occurs.
1415  */
1416 const char *
1417 notmuch_message_get_header (notmuch_message_t *message, const char *header);
1418
1419 /**
1420  * Get the tags for 'message', returning a notmuch_tags_t object which
1421  * can be used to iterate over all tags.
1422  *
1423  * The tags object is owned by the message and as such, will only be
1424  * valid for as long as the message is valid, (which is until the
1425  * query from which it derived is destroyed).
1426  *
1427  * Typical usage might be:
1428  *
1429  *     notmuch_message_t *message;
1430  *     notmuch_tags_t *tags;
1431  *     const char *tag;
1432  *
1433  *     message = notmuch_database_find_message (database, message_id);
1434  *
1435  *     for (tags = notmuch_message_get_tags (message);
1436  *          notmuch_tags_valid (tags);
1437  *          notmuch_tags_move_to_next (tags))
1438  *     {
1439  *         tag = notmuch_tags_get (tags);
1440  *         ....
1441  *     }
1442  *
1443  *     notmuch_message_destroy (message);
1444  *
1445  * Note that there's no explicit destructor needed for the
1446  * notmuch_tags_t object. (For consistency, we do provide a
1447  * notmuch_tags_destroy function, but there's no good reason to call
1448  * it if the message is about to be destroyed).
1449  */
1450 notmuch_tags_t *
1451 notmuch_message_get_tags (notmuch_message_t *message);
1452
1453 /**
1454  * The longest possible tag value.
1455  */
1456 #define NOTMUCH_TAG_MAX 200
1457
1458 /**
1459  * Add a tag to the given message.
1460  *
1461  * Return value:
1462  *
1463  * NOTMUCH_STATUS_SUCCESS: Tag successfully added to message
1464  *
1465  * NOTMUCH_STATUS_NULL_POINTER: The 'tag' argument is NULL
1466  *
1467  * NOTMUCH_STATUS_TAG_TOO_LONG: The length of 'tag' is too long
1468  *      (exceeds NOTMUCH_TAG_MAX)
1469  *
1470  * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
1471  *      mode so message cannot be modified.
1472  */
1473 notmuch_status_t
1474 notmuch_message_add_tag (notmuch_message_t *message, const char *tag);
1475
1476 /**
1477  * Remove a tag from the given message.
1478  *
1479  * Return value:
1480  *
1481  * NOTMUCH_STATUS_SUCCESS: Tag successfully removed from message
1482  *
1483  * NOTMUCH_STATUS_NULL_POINTER: The 'tag' argument is NULL
1484  *
1485  * NOTMUCH_STATUS_TAG_TOO_LONG: The length of 'tag' is too long
1486  *      (exceeds NOTMUCH_TAG_MAX)
1487  *
1488  * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
1489  *      mode so message cannot be modified.
1490  */
1491 notmuch_status_t
1492 notmuch_message_remove_tag (notmuch_message_t *message, const char *tag);
1493
1494 /**
1495  * Remove all tags from the given message.
1496  *
1497  * See notmuch_message_freeze for an example showing how to safely
1498  * replace tag values.
1499  *
1500  * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
1501  *      mode so message cannot be modified.
1502  */
1503 notmuch_status_t
1504 notmuch_message_remove_all_tags (notmuch_message_t *message);
1505
1506 /**
1507  * Add/remove tags according to maildir flags in the message filename(s).
1508  *
1509  * This function examines the filenames of 'message' for maildir
1510  * flags, and adds or removes tags on 'message' as follows when these
1511  * flags are present:
1512  *
1513  *      Flag    Action if present
1514  *      ----    -----------------
1515  *      'D'     Adds the "draft" tag to the message
1516  *      'F'     Adds the "flagged" tag to the message
1517  *      'P'     Adds the "passed" tag to the message
1518  *      'R'     Adds the "replied" tag to the message
1519  *      'S'     Removes the "unread" tag from the message
1520  *
1521  * For each flag that is not present, the opposite action (add/remove)
1522  * is performed for the corresponding tags.
1523  *
1524  * Flags are identified as trailing components of the filename after a
1525  * sequence of ":2,".
1526  *
1527  * If there are multiple filenames associated with this message, the
1528  * flag is considered present if it appears in one or more
1529  * filenames. (That is, the flags from the multiple filenames are
1530  * combined with the logical OR operator.)
1531  *
1532  * A client can ensure that notmuch database tags remain synchronized
1533  * with maildir flags by calling this function after each call to
1534  * notmuch_database_add_message. See also
1535  * notmuch_message_tags_to_maildir_flags for synchronizing tag changes
1536  * back to maildir flags.
1537  */
1538 notmuch_status_t
1539 notmuch_message_maildir_flags_to_tags (notmuch_message_t *message);
1540
1541 /**
1542  * Rename message filename(s) to encode tags as maildir flags.
1543  *
1544  * Specifically, for each filename corresponding to this message:
1545  *
1546  * If the filename is not in a maildir directory, do nothing.  (A
1547  * maildir directory is determined as a directory named "new" or
1548  * "cur".) Similarly, if the filename has invalid maildir info,
1549  * (repeated or outof-ASCII-order flag characters after ":2,"), then
1550  * do nothing.
1551  *
1552  * If the filename is in a maildir directory, rename the file so that
1553  * its filename ends with the sequence ":2," followed by zero or more
1554  * of the following single-character flags (in ASCII order):
1555  *
1556  *   'D' iff the message has the "draft" tag
1557  *   'F' iff the message has the "flagged" tag
1558  *   'P' iff the message has the "passed" tag
1559  *   'R' iff the message has the "replied" tag
1560  *   'S' iff the message does not have the "unread" tag
1561  *
1562  * Any existing flags unmentioned in the list above will be preserved
1563  * in the renaming.
1564  *
1565  * Also, if this filename is in a directory named "new", rename it to
1566  * be within the neighboring directory named "cur".
1567  *
1568  * A client can ensure that maildir filename flags remain synchronized
1569  * with notmuch database tags by calling this function after changing
1570  * tags, (after calls to notmuch_message_add_tag,
1571  * notmuch_message_remove_tag, or notmuch_message_freeze/
1572  * notmuch_message_thaw). See also notmuch_message_maildir_flags_to_tags
1573  * for synchronizing maildir flag changes back to tags.
1574  */
1575 notmuch_status_t
1576 notmuch_message_tags_to_maildir_flags (notmuch_message_t *message);
1577
1578 /**
1579  * Freeze the current state of 'message' within the database.
1580  *
1581  * This means that changes to the message state, (via
1582  * notmuch_message_add_tag, notmuch_message_remove_tag, and
1583  * notmuch_message_remove_all_tags), will not be committed to the
1584  * database until the message is thawed with notmuch_message_thaw.
1585  *
1586  * Multiple calls to freeze/thaw are valid and these calls will
1587  * "stack". That is there must be as many calls to thaw as to freeze
1588  * before a message is actually thawed.
1589  *
1590  * The ability to do freeze/thaw allows for safe transactions to
1591  * change tag values. For example, explicitly setting a message to
1592  * have a given set of tags might look like this:
1593  *
1594  *    notmuch_message_freeze (message);
1595  *
1596  *    notmuch_message_remove_all_tags (message);
1597  *
1598  *    for (i = 0; i < NUM_TAGS; i++)
1599  *        notmuch_message_add_tag (message, tags[i]);
1600  *
1601  *    notmuch_message_thaw (message);
1602  *
1603  * With freeze/thaw used like this, the message in the database is
1604  * guaranteed to have either the full set of original tag values, or
1605  * the full set of new tag values, but nothing in between.
1606  *
1607  * Imagine the example above without freeze/thaw and the operation
1608  * somehow getting interrupted. This could result in the message being
1609  * left with no tags if the interruption happened after
1610  * notmuch_message_remove_all_tags but before notmuch_message_add_tag.
1611  *
1612  * Return value:
1613  *
1614  * NOTMUCH_STATUS_SUCCESS: Message successfully frozen.
1615  *
1616  * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
1617  *      mode so message cannot be modified.
1618  */
1619 notmuch_status_t
1620 notmuch_message_freeze (notmuch_message_t *message);
1621
1622 /**
1623  * Thaw the current 'message', synchronizing any changes that may have
1624  * occurred while 'message' was frozen into the notmuch database.
1625  *
1626  * See notmuch_message_freeze for an example of how to use this
1627  * function to safely provide tag changes.
1628  *
1629  * Multiple calls to freeze/thaw are valid and these calls with
1630  * "stack". That is there must be as many calls to thaw as to freeze
1631  * before a message is actually thawed.
1632  *
1633  * Return value:
1634  *
1635  * NOTMUCH_STATUS_SUCCESS: Message successfully thawed, (or at least
1636  *      its frozen count has successfully been reduced by 1).
1637  *
1638  * NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW: An attempt was made to thaw
1639  *      an unfrozen message. That is, there have been an unbalanced
1640  *      number of calls to notmuch_message_freeze and
1641  *      notmuch_message_thaw.
1642  */
1643 notmuch_status_t
1644 notmuch_message_thaw (notmuch_message_t *message);
1645
1646 /**
1647  * Destroy a notmuch_message_t object.
1648  *
1649  * It can be useful to call this function in the case of a single
1650  * query object with many messages in the result, (such as iterating
1651  * over the entire database). Otherwise, it's fine to never call this
1652  * function and there will still be no memory leaks. (The memory from
1653  * the messages get reclaimed when the containing query is destroyed.)
1654  */
1655 void
1656 notmuch_message_destroy (notmuch_message_t *message);
1657
1658 /**
1659  * @name Message Properties
1660  *
1661  * This interface provides the ability to attach arbitrary (key,value)
1662  * string pairs to a message, to remove such pairs, and to iterate
1663  * over them.  The caller should take some care as to what keys they
1664  * add or delete values for, as other subsystems or extensions may
1665  * depend on these properties.
1666  *
1667  */
1668 /**@{*/
1669 /**
1670  * Retrieve the value for a single property key
1671  *
1672  * *value* is set to a string owned by the message or NULL if there is
1673  * no such key. In the case of multiple values for the given key, the
1674  * first one is retrieved.
1675  *
1676  * @returns
1677  * - NOTMUCH_STATUS_NULL_POINTER: *value* may not be NULL.
1678  * - NOTMUCH_STATUS_SUCCESS: No error occured.
1679  * @since libnotmuch 4.4 (notmuch 0.23)
1680  */
1681 notmuch_status_t
1682 notmuch_message_get_property (notmuch_message_t *message, const char *key, const char **value);
1683
1684 /**
1685  * Add a (key,value) pair to a message
1686  *
1687  * @returns
1688  * - NOTMUCH_STATUS_ILLEGAL_ARGUMENT: *key* may not contain an '=' character.
1689  * - NOTMUCH_STATUS_NULL_POINTER: Neither *key* nor *value* may be NULL.
1690  * - NOTMUCH_STATUS_SUCCESS: No error occured.
1691  * @since libnotmuch 4.4 (notmuch 0.23)
1692  */
1693 notmuch_status_t
1694 notmuch_message_add_property (notmuch_message_t *message, const char *key, const char *value);
1695
1696 /**
1697  * Remove a (key,value) pair from a message.
1698  *
1699  * It is not an error to remove a non-existant (key,value) pair
1700  *
1701  * @returns
1702  * - NOTMUCH_STATUS_ILLEGAL_ARGUMENT: *key* may not contain an '=' character.
1703  * - NOTMUCH_STATUS_NULL_POINTER: Neither *key* nor *value* may be NULL.
1704  * - NOTMUCH_STATUS_SUCCESS: No error occured.
1705  * @since libnotmuch 4.4 (notmuch 0.23)
1706  */
1707 notmuch_status_t
1708 notmuch_message_remove_property (notmuch_message_t *message, const char *key, const char *value);
1709
1710 /**
1711  * Remove all (key,value) pairs from the given message.
1712  *
1713  * @param[in,out] message  message to operate on.
1714  * @param[in]     key      key to delete properties for. If NULL, delete
1715  *                         properties for all keys
1716  * @returns
1717  * - NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in
1718  *   read-only mode so message cannot be modified.
1719  * - NOTMUCH_STATUS_SUCCESS: No error occured.
1720  *
1721  * @since libnotmuch 4.4 (notmuch 0.23)
1722  */
1723 notmuch_status_t
1724 notmuch_message_remove_all_properties (notmuch_message_t *message, const char *key);
1725
1726 /**
1727  * Opaque message property iterator
1728  */
1729 typedef struct _notmuch_string_map_iterator notmuch_message_properties_t;
1730
1731 /**
1732  * Get the properties for *message*, returning a
1733  * notmuch_message_properties_t object which can be used to iterate
1734  * over all properties.
1735  *
1736  * The notmuch_message_properties_t object is owned by the message and
1737  * as such, will only be valid for as long as the message is valid,
1738  * (which is until the query from which it derived is destroyed).
1739  *
1740  * @param[in] message  The message to examine
1741  * @param[in] key      key or key prefix
1742  * @param[in] exact    if TRUE, require exact match with key. Otherwise
1743  *                     treat as prefix.
1744  *
1745  * Typical usage might be:
1746  *
1747  *     notmuch_message_properties_t *list;
1748  *
1749  *     for (list = notmuch_message_get_properties (message, "testkey1", TRUE);
1750  *          notmuch_message_properties_valid (list); notmuch_message_properties_move_to_next (list)) {
1751  *        printf("%s\n", notmuch_message_properties_value(list));
1752  *     }
1753  *
1754  *     notmuch_message_properties_destroy (list);
1755  *
1756  * Note that there's no explicit destructor needed for the
1757  * notmuch_message_properties_t object. (For consistency, we do
1758  * provide a notmuch_message_properities_destroy function, but there's
1759  * no good reason to call it if the message is about to be destroyed).
1760  *
1761  * @since libnotmuch 4.4 (notmuch 0.23)
1762  */
1763 notmuch_message_properties_t *
1764 notmuch_message_get_properties (notmuch_message_t *message, const char *key, notmuch_bool_t exact);
1765
1766 /**
1767  * Is the given *properties* iterator pointing at a valid (key,value)
1768  * pair.
1769  *
1770  * When this function returns TRUE,
1771  * notmuch_message_properties_{key,value} will return a valid string,
1772  * and notmuch_message_properties_move_to_next will do what it
1773  * says. Whereas when this function returns FALSE, calling any of
1774  * these functions results in undefined behaviour.
1775  *
1776  * See the documentation of notmuch_message_properties_get for example
1777  * code showing how to iterate over a notmuch_message_properties_t
1778  * object.
1779  *
1780  * @since libnotmuch 4.4 (notmuch 0.23)
1781  */
1782 notmuch_bool_t
1783 notmuch_message_properties_valid (notmuch_message_properties_t *properties);
1784
1785 /**
1786  * Move the *properties* iterator to the next (key,value) pair
1787  *
1788  * If *properties* is already pointing at the last pair then the iterator
1789  * will be moved to a point just beyond that last pair, (where
1790  * notmuch_message_properties_valid will return FALSE).
1791  *
1792  * See the documentation of notmuch_message_get_properties for example
1793  * code showing how to iterate over a notmuch_message_properties_t object.
1794  *
1795  * @since libnotmuch 4.4 (notmuch 0.23)
1796  */
1797 void
1798 notmuch_message_properties_move_to_next (notmuch_message_properties_t *properties);
1799
1800 /**
1801  * Return the key from the current (key,value) pair.
1802  *
1803  * this could be useful if iterating for a prefix
1804  *
1805  * @since libnotmuch 4.4 (notmuch 0.23)
1806  */
1807 const char *
1808 notmuch_message_properties_key (notmuch_message_properties_t *properties);
1809
1810 /**
1811  * Return the value from the current (key,value) pair.
1812  *
1813  * This could be useful if iterating for a prefix.
1814  *
1815  * @since libnotmuch 4.4 (notmuch 0.23)
1816  */
1817 const char *
1818 notmuch_message_properties_value (notmuch_message_properties_t *properties);
1819
1820
1821 /**
1822  * Destroy a notmuch_message_properties_t object.
1823  *
1824  * It's not strictly necessary to call this function. All memory from
1825  * the notmuch_message_properties_t object will be reclaimed when the
1826  * containing message object is destroyed.
1827  *
1828  * @since libnotmuch 4.4 (notmuch 0.23)
1829  */
1830 void
1831 notmuch_message_properties_destroy (notmuch_message_properties_t *properties);
1832
1833 /**@}*/
1834
1835 /**
1836  * Is the given 'tags' iterator pointing at a valid tag.
1837  *
1838  * When this function returns TRUE, notmuch_tags_get will return a
1839  * valid string. Whereas when this function returns FALSE,
1840  * notmuch_tags_get will return NULL.
1841  *
1842  * See the documentation of notmuch_message_get_tags for example code
1843  * showing how to iterate over a notmuch_tags_t object.
1844  */
1845 notmuch_bool_t
1846 notmuch_tags_valid (notmuch_tags_t *tags);
1847
1848 /**
1849  * Get the current tag from 'tags' as a string.
1850  *
1851  * Note: The returned string belongs to 'tags' and has a lifetime
1852  * identical to it (and the query to which it ultimately belongs).
1853  *
1854  * See the documentation of notmuch_message_get_tags for example code
1855  * showing how to iterate over a notmuch_tags_t object.
1856  */
1857 const char *
1858 notmuch_tags_get (notmuch_tags_t *tags);
1859
1860 /**
1861  * Move the 'tags' iterator to the next tag.
1862  *
1863  * If 'tags' is already pointing at the last tag then the iterator
1864  * will be moved to a point just beyond that last tag, (where
1865  * notmuch_tags_valid will return FALSE and notmuch_tags_get will
1866  * return NULL).
1867  *
1868  * See the documentation of notmuch_message_get_tags for example code
1869  * showing how to iterate over a notmuch_tags_t object.
1870  */
1871 void
1872 notmuch_tags_move_to_next (notmuch_tags_t *tags);
1873
1874 /**
1875  * Destroy a notmuch_tags_t object.
1876  *
1877  * It's not strictly necessary to call this function. All memory from
1878  * the notmuch_tags_t object will be reclaimed when the containing
1879  * message or query objects are destroyed.
1880  */
1881 void
1882 notmuch_tags_destroy (notmuch_tags_t *tags);
1883
1884 /**
1885  * Store an mtime within the database for 'directory'.
1886  *
1887  * The 'directory' should be an object retrieved from the database
1888  * with notmuch_database_get_directory for a particular path.
1889  *
1890  * The intention is for the caller to use the mtime to allow efficient
1891  * identification of new messages to be added to the database. The
1892  * recommended usage is as follows:
1893  *
1894  *   o Read the mtime of a directory from the filesystem
1895  *
1896  *   o Call add_message for all mail files in the directory
1897  *
1898  *   o Call notmuch_directory_set_mtime with the mtime read from the
1899  *     filesystem.
1900  *
1901  * Then, when wanting to check for updates to the directory in the
1902  * future, the client can call notmuch_directory_get_mtime and know
1903  * that it only needs to add files if the mtime of the directory and
1904  * files are newer than the stored timestamp.
1905  *
1906  * Note: The notmuch_directory_get_mtime function does not allow the
1907  * caller to distinguish a timestamp of 0 from a non-existent
1908  * timestamp. So don't store a timestamp of 0 unless you are
1909  * comfortable with that.
1910  *
1911  * Return value:
1912  *
1913  * NOTMUCH_STATUS_SUCCESS: mtime successfully stored in database.
1914  *
1915  * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception
1916  *      occurred, mtime not stored.
1917  *
1918  * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
1919  *      mode so directory mtime cannot be modified.
1920  */
1921 notmuch_status_t
1922 notmuch_directory_set_mtime (notmuch_directory_t *directory,
1923                              time_t mtime);
1924
1925 /**
1926  * Get the mtime of a directory, (as previously stored with
1927  * notmuch_directory_set_mtime).
1928  *
1929  * Returns 0 if no mtime has previously been stored for this
1930  * directory.
1931  */
1932 time_t
1933 notmuch_directory_get_mtime (notmuch_directory_t *directory);
1934
1935 /**
1936  * Get a notmuch_filenames_t iterator listing all the filenames of
1937  * messages in the database within the given directory.
1938  *
1939  * The returned filenames will be the basename-entries only (not
1940  * complete paths).
1941  */
1942 notmuch_filenames_t *
1943 notmuch_directory_get_child_files (notmuch_directory_t *directory);
1944
1945 /**
1946  * Get a notmuch_filenames_t iterator listing all the filenames of
1947  * sub-directories in the database within the given directory.
1948  *
1949  * The returned filenames will be the basename-entries only (not
1950  * complete paths).
1951  */
1952 notmuch_filenames_t *
1953 notmuch_directory_get_child_directories (notmuch_directory_t *directory);
1954
1955 /**
1956  * Delete directory document from the database, and destroy the
1957  * notmuch_directory_t object. Assumes any child directories and files
1958  * have been deleted by the caller.
1959  *
1960  * @since libnotmuch 4.3 (notmuch 0.21)
1961  */
1962 notmuch_status_t
1963 notmuch_directory_delete (notmuch_directory_t *directory);
1964
1965 /**
1966  * Destroy a notmuch_directory_t object.
1967  */
1968 void
1969 notmuch_directory_destroy (notmuch_directory_t *directory);
1970
1971 /**
1972  * Is the given 'filenames' iterator pointing at a valid filename.
1973  *
1974  * When this function returns TRUE, notmuch_filenames_get will return
1975  * a valid string. Whereas when this function returns FALSE,
1976  * notmuch_filenames_get will return NULL.
1977  *
1978  * It is acceptable to pass NULL for 'filenames', in which case this
1979  * function will always return FALSE.
1980  */
1981 notmuch_bool_t
1982 notmuch_filenames_valid (notmuch_filenames_t *filenames);
1983
1984 /**
1985  * Get the current filename from 'filenames' as a string.
1986  *
1987  * Note: The returned string belongs to 'filenames' and has a lifetime
1988  * identical to it (and the directory to which it ultimately belongs).
1989  *
1990  * It is acceptable to pass NULL for 'filenames', in which case this
1991  * function will always return NULL.
1992  */
1993 const char *
1994 notmuch_filenames_get (notmuch_filenames_t *filenames);
1995
1996 /**
1997  * Move the 'filenames' iterator to the next filename.
1998  *
1999  * If 'filenames' is already pointing at the last filename then the
2000  * iterator will be moved to a point just beyond that last filename,
2001  * (where notmuch_filenames_valid will return FALSE and
2002  * notmuch_filenames_get will return NULL).
2003  *
2004  * It is acceptable to pass NULL for 'filenames', in which case this
2005  * function will do nothing.
2006  */
2007 void
2008 notmuch_filenames_move_to_next (notmuch_filenames_t *filenames);
2009
2010 /**
2011  * Destroy a notmuch_filenames_t object.
2012  *
2013  * It's not strictly necessary to call this function. All memory from
2014  * the notmuch_filenames_t object will be reclaimed when the
2015  * containing directory object is destroyed.
2016  *
2017  * It is acceptable to pass NULL for 'filenames', in which case this
2018  * function will do nothing.
2019  */
2020 void
2021 notmuch_filenames_destroy (notmuch_filenames_t *filenames);
2022
2023
2024 /**
2025  * set config 'key' to 'value'
2026  *
2027  * @since libnotmuch 4.4 (notmuch 0.23)
2028  */
2029 notmuch_status_t
2030 notmuch_database_set_config (notmuch_database_t *db, const char *key, const char *value);
2031
2032 /**
2033  * retrieve config item 'key', assign to  'value'
2034  *
2035  * keys which have not been previously set with n_d_set_config will
2036  * return an empty string.
2037  *
2038  * return value is allocated by malloc and should be freed by the
2039  * caller.
2040  *
2041  * @since libnotmuch 4.4 (notmuch 0.23)
2042  */
2043 notmuch_status_t
2044 notmuch_database_get_config (notmuch_database_t *db, const char *key, char **value);
2045
2046 /**
2047  * Create an iterator for all config items with keys matching a given prefix
2048  *
2049  * @since libnotmuch 4.4 (notmuch 0.23)
2050  */
2051 notmuch_status_t
2052 notmuch_database_get_config_list (notmuch_database_t *db, const char *prefix, notmuch_config_list_t **out);
2053
2054 /**
2055  * Is 'config_list' iterator valid (i.e. _key, _value, _move_to_next can be called).
2056  *
2057  * @since libnotmuch 4.4 (notmuch 0.23)
2058  */
2059 notmuch_bool_t
2060 notmuch_config_list_valid (notmuch_config_list_t *config_list);
2061
2062 /**
2063  * return key for current config pair
2064  *
2065  * return value is owned by the iterator, and will be destroyed by the
2066  * next call to notmuch_config_list_key or notmuch_config_list_destroy.
2067  *
2068  * @since libnotmuch 4.4 (notmuch 0.23)
2069  */
2070 const char *
2071 notmuch_config_list_key (notmuch_config_list_t *config_list);
2072
2073 /**
2074  * return 'value' for current config pair
2075  *
2076  * return value is owned by the iterator, and will be destroyed by the
2077  * next call to notmuch_config_list_value or notmuch config_list_destroy
2078  *
2079  * @since libnotmuch 4.4 (notmuch 0.23)
2080  */
2081 const char *
2082 notmuch_config_list_value (notmuch_config_list_t *config_list);
2083
2084
2085 /**
2086  * move 'config_list' iterator to the next pair
2087  *
2088  * @since libnotmuch 4.4 (notmuch 0.23)
2089  */
2090 void
2091 notmuch_config_list_move_to_next (notmuch_config_list_t *config_list);
2092
2093 /**
2094  * free any resources held by 'config_list'
2095  *
2096  * @since libnotmuch 4.4 (notmuch 0.23)
2097  */
2098 void
2099 notmuch_config_list_destroy (notmuch_config_list_t *config_list);
2100
2101 /**
2102  * interrogate the library for compile time features
2103  *
2104  * @since libnotmuch 4.4 (notmuch 0.23)
2105  */
2106 notmuch_bool_t
2107 notmuch_built_with (const char *name);
2108 /* @} */
2109
2110 NOTMUCH_END_DECLS
2111
2112 #endif