debian: add dependency on libsexp-dev
[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        5
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      * A MIME object claimed to have cryptographic protection which
196      * notmuch tried to handle, but the protocol was not specified in
197      * an intelligible way.
198      */
199     NOTMUCH_STATUS_MALFORMED_CRYPTO_PROTOCOL,
200     /**
201      * Notmuch attempted to do crypto processing, but could not
202      * initialize the engine needed to do so.
203      */
204     NOTMUCH_STATUS_FAILED_CRYPTO_CONTEXT_CREATION,
205     /**
206      * A MIME object claimed to have cryptographic protection, and
207      * notmuch attempted to process it, but the specific protocol was
208      * something that notmuch doesn't know how to handle.
209      */
210     NOTMUCH_STATUS_UNKNOWN_CRYPTO_PROTOCOL,
211     /**
212      * Unable to load a config file
213      */
214     NOTMUCH_STATUS_NO_CONFIG,
215     /**
216      * Unable to load a database
217      */
218     NOTMUCH_STATUS_NO_DATABASE,
219     /**
220      * Database exists, so not (re)-created
221      */
222     NOTMUCH_STATUS_DATABASE_EXISTS,
223     /**
224      * Syntax error in query
225      */
226     NOTMUCH_STATUS_BAD_QUERY_SYNTAX,
227     /**
228      * Not an actual status value. Just a way to find out how many
229      * valid status values there are.
230      */
231     NOTMUCH_STATUS_LAST_STATUS
232 } notmuch_status_t;
233
234 /**
235  * Get a string representation of a notmuch_status_t value.
236  *
237  * The result is read-only.
238  */
239 const char *
240 notmuch_status_to_string (notmuch_status_t status);
241
242 /* Various opaque data types. For each notmuch_<foo>_t see the various
243  * notmuch_<foo> functions below. */
244 #ifndef __DOXYGEN__
245 typedef struct _notmuch_database notmuch_database_t;
246 typedef struct _notmuch_query notmuch_query_t;
247 typedef struct _notmuch_threads notmuch_threads_t;
248 typedef struct _notmuch_thread notmuch_thread_t;
249 typedef struct _notmuch_messages notmuch_messages_t;
250 typedef struct _notmuch_message notmuch_message_t;
251 typedef struct _notmuch_tags notmuch_tags_t;
252 typedef struct _notmuch_directory notmuch_directory_t;
253 typedef struct _notmuch_filenames notmuch_filenames_t;
254 typedef struct _notmuch_config_list notmuch_config_list_t;
255 typedef struct _notmuch_config_values notmuch_config_values_t;
256 typedef struct _notmuch_config_pairs notmuch_config_pairs_t;
257 typedef struct _notmuch_indexopts notmuch_indexopts_t;
258 #endif /* __DOXYGEN__ */
259
260 /**
261  * Create a new, empty notmuch database located at 'path'.
262  *
263  * The path should be a top-level directory to a collection of
264  * plain-text email messages (one message per file). This call will
265  * create a new ".notmuch" directory within 'path' where notmuch will
266  * store its data.
267  *
268  * After a successful call to notmuch_database_create, the returned
269  * database will be open so the caller should call
270  * notmuch_database_destroy when finished with it.
271  *
272  * The database will not yet have any data in it
273  * (notmuch_database_create itself is a very cheap function). Messages
274  * contained within 'path' can be added to the database by calling
275  * notmuch_database_index_file.
276  *
277  * In case of any failure, this function returns an error status and
278  * sets *database to NULL (after printing an error message on stderr).
279  *
280  * Return value:
281  *
282  * NOTMUCH_STATUS_SUCCESS: Successfully created the database.
283  *
284  * NOTMUCH_STATUS_NULL_POINTER: The given 'path' argument is NULL.
285  *
286  * NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory.
287  *
288  * NOTMUCH_STATUS_FILE_ERROR: An error occurred trying to create the
289  *      database file (such as permission denied, or file not found,
290  *      etc.), or the database already exists.
291  *
292  * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred.
293  */
294 notmuch_status_t
295 notmuch_database_create (const char *path, notmuch_database_t **database);
296
297 /**
298  * Like notmuch_database_create, except optionally return an error
299  * message. This message is allocated by malloc and should be freed by
300  * the caller.
301  */
302 notmuch_status_t
303 notmuch_database_create_verbose (const char *path,
304                                  notmuch_database_t **database,
305                                  char **error_message);
306
307 /**
308  * Database open mode for notmuch_database_open.
309  */
310 typedef enum {
311     /**
312      * Open database for reading only.
313      */
314     NOTMUCH_DATABASE_MODE_READ_ONLY = 0,
315     /**
316      * Open database for reading and writing.
317      */
318     NOTMUCH_DATABASE_MODE_READ_WRITE
319 } notmuch_database_mode_t;
320
321 /**
322  * Deprecated alias for notmuch_database_open_with_config with
323  * config_path="" and error_message=NULL
324  * @deprecated Deprecated as of libnotmuch 5.4 (notmuch 0.32)
325  */
326 /* NOTMUCH_DEPRECATED(5, 4) */
327 notmuch_status_t
328 notmuch_database_open (const char *path,
329                        notmuch_database_mode_t mode,
330                        notmuch_database_t **database);
331 /**
332  * Deprecated alias for notmuch_database_open_with_config with
333  * config_path=""
334  *
335  * @deprecated Deprecated as of libnotmuch 5.4 (notmuch 0.32)
336  *
337  */
338 /* NOTMUCH_DEPRECATED(5, 4) */
339 notmuch_status_t
340 notmuch_database_open_verbose (const char *path,
341                                notmuch_database_mode_t mode,
342                                notmuch_database_t **database,
343                                char **error_message);
344
345 /**
346  * Open an existing notmuch database located at 'database_path', using
347  * configuration in 'config_path'.
348  *
349  * @param[in]   database_path
350  * @parblock
351  * Path to existing database.
352  *
353  * A notmuch database is a Xapian database containing appropriate
354  * metadata.
355  *
356  * The database should have been created at some time in the past,
357  * (not necessarily by this process), by calling
358  * notmuch_database_create.
359  *
360  * If 'database_path' is NULL, use the location specified
361  *
362  * - in the environment variable NOTMUCH_DATABASE, if non-empty
363  *
364  * - in a configuration file, located as described under 'config_path'
365  *
366  * - by $XDG_DATA_HOME/notmuch/$PROFILE where XDG_DATA_HOME defaults
367  *   to "$HOME/.local/share" and PROFILE as as discussed in
368  *   'profile'
369  *
370  * If 'database_path' is non-NULL, but does not appear to be a Xapian
371  * database, check for a directory '.notmuch/xapian' below
372  * 'database_path' (this is the behavior of
373  * notmuch_database_open_verbose pre-0.32).
374  *
375  * @endparblock
376  * @param[in]   mode
377  * @parblock
378  * Mode to open database. Use one of #NOTMUCH_DATABASE_MODE_READ_WRITE
379  * or #NOTMUCH_DATABASE_MODE_READ_ONLY
380  *
381  * @endparblock
382  * @param[in]  config_path
383  * @parblock
384  * Path to config file.
385  *
386  * Config file is key-value, with mandatory sections. See
387  * <em>notmuch-config(5)</em> for more information. The key-value pair
388  * overrides the corresponding configuration data stored in the
389  * database (see <em>notmuch_database_get_config</em>)
390  *
391  * If <em>config_path</em> is NULL use the path specified
392  *
393  * - in environment variable <em>NOTMUCH_CONFIG</em>, if non-empty
394  *
395  * - by  <em>XDG_CONFIG_HOME</em>/notmuch/ where
396  *   XDG_CONFIG_HOME defaults to "$HOME/.config".
397  *
398  * - by $HOME/.notmuch-config
399  *
400  * If <em>config_path</em> is "" (empty string) then do not
401  * open any configuration file.
402  * @endparblock
403  * @param[in] profile:
404  * @parblock
405  * Name of profile (configuration/database variant).
406  *
407  * If non-NULL, append to the directory / file path determined for
408  * <em>config_path</em> and <em>database_path</em>.
409  *
410  * If NULL then use
411  * - environment variable NOTMUCH_PROFILE if defined,
412  * - otherwise "default" for directories and "" (empty string) for paths.
413  *
414  * @endparblock
415  * @param[out] database
416  * @parblock
417  * Pointer to database object. May not be NULL.
418  *
419  * The caller should call notmuch_database_destroy when finished with
420  * this database.
421  *
422  * In case of any failure, this function returns an error status and
423  * sets *database to NULL.
424  *
425  * @endparblock
426  * @param[out] error_message
427  * If non-NULL, store error message from opening the database.
428  * Any such message is allocated by \a malloc(3) and should be freed
429  * by the caller.
430  *
431  * @retval NOTMUCH_STATUS_SUCCESS: Successfully opened the database.
432  *
433  * @retval NOTMUCH_STATUS_NULL_POINTER: The given \a database
434  * argument is NULL.
435  *
436  * @retval NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory.
437  *
438  * @retval NOTMUCH_STATUS_FILE_ERROR: An error occurred trying to open the
439  *      database or config file (such as permission denied, or file not found,
440  *      etc.), or the database version is unknown.
441  *
442  * @retval NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred.
443  *
444  * @since libnotmuch 5.4 (notmuch 0.32)
445  */
446
447 notmuch_status_t
448 notmuch_database_open_with_config (const char *database_path,
449                                    notmuch_database_mode_t mode,
450                                    const char *config_path,
451                                    const char *profile,
452                                    notmuch_database_t **database,
453                                    char **error_message);
454
455
456 /**
457  * Loads configuration from config file, database, and/or defaults
458  *
459  * For description of arguments, @see notmuch_database_open_with_config
460  *
461  * @retval NOTMUCH_STATUS_SUCCESS: Successfully loaded configuration.
462  *
463  * @retval NOTMUCH_STATUS_NO_CONFIG: No config file was loaded. Not fatal.
464  *
465  * @retval NOTMUCH_STATUS_NO_DATABASE: No config information was
466  *      loaded from a database. Not fatal.
467  *
468  * @retval NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory.
469  *
470  * @retval NOTMUCH_STATUS_FILE_ERROR: An error occurred trying to open the
471  *      database or config file (such as permission denied, or file not found,
472  *      etc.)
473  *
474  * @retval NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred.
475  *
476  * @since libnotmuch 5.4 (notmuch 0.32)
477  */
478
479 notmuch_status_t
480 notmuch_database_load_config (const char *database_path,
481                               const char *config_path,
482                               const char *profile,
483                               notmuch_database_t **database,
484                               char **error_message);
485
486 /**
487  * Create a new notmuch database located at 'database_path', using
488  * configuration in 'config_path'.
489  *
490  * For description of arguments, @see notmuch_database_open_with_config
491  *
492  * @retval NOTMUCH_STATUS_SUCCESS: Successfully created the database.
493  *
494  * @retval NOTMUCH_STATUS_DATABASE_EXISTS: Database already exists, not created
495  *
496  * @retval NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory.
497  *
498  * @retval NOTMUCH_STATUS_FILE_ERROR: An error occurred trying to open the
499  *      database or config file (such as permission denied, or file not found,
500  *      etc.)
501  *
502  * @retval NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred.
503  *
504  * @since libnotmuch 5.4 (notmuch 0.32)
505  */
506
507 notmuch_status_t
508 notmuch_database_create_with_config (const char *database_path,
509                                      const char *config_path,
510                                      const char *profile,
511                                      notmuch_database_t **database,
512                                      char **error_message);
513
514 /**
515  * Retrieve last status string for given database.
516  *
517  */
518 const char *
519 notmuch_database_status_string (const notmuch_database_t *notmuch);
520
521 /**
522  * Commit changes and close the given notmuch database.
523  *
524  * After notmuch_database_close has been called, calls to other
525  * functions on objects derived from this database may either behave
526  * as if the database had not been closed (e.g., if the required data
527  * has been cached) or may fail with a
528  * NOTMUCH_STATUS_XAPIAN_EXCEPTION. The only further operation
529  * permitted on the database itself is to call
530  * notmuch_database_destroy.
531  *
532  * notmuch_database_close can be called multiple times.  Later calls
533  * have no effect.
534  *
535  * For writable databases, notmuch_database_close commits all changes
536  * to disk before closing the database, unless the caller is currently
537  * in an atomic section (there was a notmuch_database_begin_atomic
538  * without a matching notmuch_database_end_atomic). In this case
539  * changes since the last commit are discarded. @see
540  * notmuch_database_end_atomic for more information.
541  *
542  * Return value:
543  *
544  * NOTMUCH_STATUS_SUCCESS: Successfully closed the database.
545  *
546  * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred; the
547  *      database has been closed but there are no guarantees the
548  *      changes to the database, if any, have been flushed to disk.
549  */
550 notmuch_status_t
551 notmuch_database_close (notmuch_database_t *database);
552
553 /**
554  * A callback invoked by notmuch_database_compact to notify the user
555  * of the progress of the compaction process.
556  */
557 typedef void (*notmuch_compact_status_cb_t)(const char *message, void *closure);
558
559 /**
560  * Compact a notmuch database, backing up the original database to the
561  * given path.
562  *
563  * The database will be opened with NOTMUCH_DATABASE_MODE_READ_WRITE
564  * during the compaction process to ensure no writes are made.
565  *
566  * If the optional callback function 'status_cb' is non-NULL, it will
567  * be called with diagnostic and informational messages. The argument
568  * 'closure' is passed verbatim to any callback invoked.
569  */
570 notmuch_status_t
571 notmuch_database_compact (const char *path,
572                           const char *backup_path,
573                           notmuch_compact_status_cb_t status_cb,
574                           void *closure);
575
576 /**
577  * Like notmuch_database_compact, but take an open database as a
578  * parameter.
579  *
580  * @since libnnotmuch 5.4 (notmuch 0.32)
581  */
582 notmuch_status_t
583 notmuch_database_compact_db (notmuch_database_t *database,
584                              const char *backup_path,
585                              notmuch_compact_status_cb_t status_cb,
586                              void *closure);
587
588 /**
589  * Destroy the notmuch database, closing it if necessary and freeing
590  * all associated resources.
591  *
592  * Return value as in notmuch_database_close if the database was open;
593  * notmuch_database_destroy itself has no failure modes.
594  */
595 notmuch_status_t
596 notmuch_database_destroy (notmuch_database_t *database);
597
598 /**
599  * Return the database path of the given database.
600  *
601  * The return value is a string owned by notmuch so should not be
602  * modified nor freed by the caller.
603  */
604 const char *
605 notmuch_database_get_path (notmuch_database_t *database);
606
607 /**
608  * Return the database format version of the given database.
609  *
610  * @retval 0 on error
611  */
612 unsigned int
613 notmuch_database_get_version (notmuch_database_t *database);
614
615 /**
616  * Can the database be upgraded to a newer database version?
617  *
618  * If this function returns TRUE, then the caller may call
619  * notmuch_database_upgrade to upgrade the database.  If the caller
620  * does not upgrade an out-of-date database, then some functions may
621  * fail with NOTMUCH_STATUS_UPGRADE_REQUIRED.  This always returns
622  * FALSE for a read-only database because there's no way to upgrade a
623  * read-only database.
624  *
625  * Also returns FALSE if an error occurs accessing the database.
626  *
627  */
628 notmuch_bool_t
629 notmuch_database_needs_upgrade (notmuch_database_t *database);
630
631 /**
632  * Upgrade the current database to the latest supported version.
633  *
634  * This ensures that all current notmuch functionality will be
635  * available on the database.  After opening a database in read-write
636  * mode, it is recommended that clients check if an upgrade is needed
637  * (notmuch_database_needs_upgrade) and if so, upgrade with this
638  * function before making any modifications.  If
639  * notmuch_database_needs_upgrade returns FALSE, this will be a no-op.
640  *
641  * The optional progress_notify callback can be used by the caller to
642  * provide progress indication to the user. If non-NULL it will be
643  * called periodically with 'progress' as a floating-point value in
644  * the range of [0.0 .. 1.0] indicating the progress made so far in
645  * the upgrade process.  The argument 'closure' is passed verbatim to
646  * any callback invoked.
647  */
648 notmuch_status_t
649 notmuch_database_upgrade (notmuch_database_t *database,
650                           void (*progress_notify)(void *closure,
651                                                   double progress),
652                           void *closure);
653
654 /**
655  * Begin an atomic database operation.
656  *
657  * Any modifications performed between a successful begin and a
658  * notmuch_database_end_atomic will be applied to the database
659  * atomically.  Note that, unlike a typical database transaction, this
660  * only ensures atomicity, not durability; neither begin nor end
661  * necessarily flush modifications to disk.
662  *
663  * Atomic sections may be nested.  begin_atomic and end_atomic must
664  * always be called in pairs.
665  *
666  * Return value:
667  *
668  * NOTMUCH_STATUS_SUCCESS: Successfully entered atomic section.
669  *
670  * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred;
671  *      atomic section not entered.
672  */
673 notmuch_status_t
674 notmuch_database_begin_atomic (notmuch_database_t *notmuch);
675
676 /**
677  * Indicate the end of an atomic database operation.  If repeated
678  * (with matching notmuch_database_begin_atomic) "database.autocommit"
679  * times, commit the the transaction and all previous (non-cancelled)
680  * transactions to the database.
681  *
682  * Return value:
683  *
684  * NOTMUCH_STATUS_SUCCESS: Successfully completed atomic section.
685  *
686  * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred;
687  *      atomic section not ended.
688  *
689  * NOTMUCH_STATUS_UNBALANCED_ATOMIC: The database is not currently in
690  *      an atomic section.
691  */
692 notmuch_status_t
693 notmuch_database_end_atomic (notmuch_database_t *notmuch);
694
695 /**
696  * Return the committed database revision and UUID.
697  *
698  * The database revision number increases monotonically with each
699  * commit to the database.  Hence, all messages and message changes
700  * committed to the database (that is, visible to readers) have a last
701  * modification revision <= the committed database revision.  Any
702  * messages committed in the future will be assigned a modification
703  * revision > the committed database revision.
704  *
705  * The UUID is a NUL-terminated opaque string that uniquely identifies
706  * this database.  Two revision numbers are only comparable if they
707  * have the same database UUID.
708  */
709 unsigned long
710 notmuch_database_get_revision (notmuch_database_t *notmuch,
711                                const char **uuid);
712
713 /**
714  * Retrieve a directory object from the database for 'path'.
715  *
716  * Here, 'path' should be a path relative to the path of 'database'
717  * (see notmuch_database_get_path), or else should be an absolute path
718  * with initial components that match the path of 'database'.
719  *
720  * If this directory object does not exist in the database, this
721  * returns NOTMUCH_STATUS_SUCCESS and sets *directory to NULL.
722  *
723  * Otherwise the returned directory object is owned by the database
724  * and as such, will only be valid until notmuch_database_destroy is
725  * called.
726  *
727  * Return value:
728  *
729  * NOTMUCH_STATUS_SUCCESS: Successfully retrieved directory.
730  *
731  * NOTMUCH_STATUS_NULL_POINTER: The given 'directory' argument is NULL.
732  *
733  * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred;
734  *      directory not retrieved.
735  *
736  * NOTMUCH_STATUS_UPGRADE_REQUIRED: The caller must upgrade the
737  *      database to use this function.
738  */
739 notmuch_status_t
740 notmuch_database_get_directory (notmuch_database_t *database,
741                                 const char *path,
742                                 notmuch_directory_t **directory);
743
744 /**
745  * Add a message file to a database, indexing it for retrieval by
746  * future searches.  If a message already exists with the same message
747  * ID as the specified file, their indexes will be merged, and this
748  * new filename will also be associated with the existing message.
749  *
750  * Here, 'filename' should be a path relative to the path of
751  * 'database' (see notmuch_database_get_path), or else should be an
752  * absolute filename with initial components that match the path of
753  * 'database'.
754  *
755  * The file should be a single mail message (not a multi-message mbox)
756  * that is expected to remain at its current location, (since the
757  * notmuch database will reference the filename, and will not copy the
758  * entire contents of the file.
759  *
760  * If another message with the same message ID already exists in the
761  * database, rather than creating a new message, this adds the search
762  * terms from the identified file to the existing message's index, and
763  * adds 'filename' to the list of filenames known for the message.
764  *
765  * The 'indexopts' parameter can be NULL (meaning, use the indexing
766  * defaults from the database), or can be an explicit choice of
767  * indexing options that should govern the indexing of this specific
768  * 'filename'.
769  *
770  * If 'message' is not NULL, then, on successful return
771  * (NOTMUCH_STATUS_SUCCESS or NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID) '*message'
772  * will be initialized to a message object that can be used for things
773  * such as adding tags to the just-added message. The user should call
774  * notmuch_message_destroy when done with the message. On any failure
775  * '*message' will be set to NULL.
776  *
777  * Return value:
778  *
779  * NOTMUCH_STATUS_SUCCESS: Message successfully added to database.
780  *
781  * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred,
782  *      message not added.
783  *
784  * NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID: Message has the same message
785  *      ID as another message already in the database. The new
786  *      filename was successfully added to the message in the database
787  *      (if not already present) and the existing message is returned.
788  *
789  * NOTMUCH_STATUS_FILE_ERROR: an error occurred trying to open the
790  *      file, (such as permission denied, or file not found,
791  *      etc.). Nothing added to the database.
792  *
793  * NOTMUCH_STATUS_FILE_NOT_EMAIL: the contents of filename don't look
794  *      like an email message. Nothing added to the database.
795  *
796  * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
797  *      mode so no message can be added.
798  *
799  * NOTMUCH_STATUS_UPGRADE_REQUIRED: The caller must upgrade the
800  *      database to use this function.
801  *
802  * @since libnotmuch 5.1 (notmuch 0.26)
803  */
804 notmuch_status_t
805 notmuch_database_index_file (notmuch_database_t *database,
806                              const char *filename,
807                              notmuch_indexopts_t *indexopts,
808                              notmuch_message_t **message);
809
810 /**
811  * Deprecated alias for notmuch_database_index_file called with
812  * NULL indexopts.
813  *
814  * @deprecated Deprecated as of libnotmuch 5.1 (notmuch 0.26). Please
815  * use notmuch_database_index_file instead.
816  *
817  */
818 NOTMUCH_DEPRECATED (5, 1)
819 notmuch_status_t
820 notmuch_database_add_message (notmuch_database_t *database,
821                               const char *filename,
822                               notmuch_message_t **message);
823
824 /**
825  * Remove a message filename from the given notmuch database. If the
826  * message has no more filenames, remove the message.
827  *
828  * If the same message (as determined by the message ID) is still
829  * available via other filenames, then the message will persist in the
830  * database for those filenames. When the last filename is removed for
831  * a particular message, the database content for that message will be
832  * entirely removed.
833  *
834  * Return value:
835  *
836  * NOTMUCH_STATUS_SUCCESS: The last filename was removed and the
837  *      message was removed from the database.
838  *
839  * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred,
840  *      message not removed.
841  *
842  * NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID: This filename was removed but
843  *      the message persists in the database with at least one other
844  *      filename.
845  *
846  * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
847  *      mode so no message can be removed.
848  *
849  * NOTMUCH_STATUS_UPGRADE_REQUIRED: The caller must upgrade the
850  *      database to use this function.
851  */
852 notmuch_status_t
853 notmuch_database_remove_message (notmuch_database_t *database,
854                                  const char *filename);
855
856 /**
857  * Find a message with the given message_id.
858  *
859  * If a message with the given message_id is found then, on successful return
860  * (NOTMUCH_STATUS_SUCCESS) '*message' will be initialized to a message
861  * object.  The caller should call notmuch_message_destroy when done with the
862  * message.
863  *
864  * On any failure or when the message is not found, this function initializes
865  * '*message' to NULL. This means, when NOTMUCH_STATUS_SUCCESS is returned, the
866  * caller is supposed to check '*message' for NULL to find out whether the
867  * message with the given message_id was found.
868  *
869  * Return value:
870  *
871  * NOTMUCH_STATUS_SUCCESS: Successful return, check '*message'.
872  *
873  * NOTMUCH_STATUS_NULL_POINTER: The given 'message' argument is NULL
874  *
875  * NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory, creating message object
876  *
877  * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred
878  */
879 notmuch_status_t
880 notmuch_database_find_message (notmuch_database_t *database,
881                                const char *message_id,
882                                notmuch_message_t **message);
883
884 /**
885  * Find a message with the given filename.
886  *
887  * If the database contains a message with the given filename then, on
888  * successful return (NOTMUCH_STATUS_SUCCESS) '*message' will be initialized to
889  * a message object. The caller should call notmuch_message_destroy when done
890  * with the message.
891  *
892  * On any failure or when the message is not found, this function initializes
893  * '*message' to NULL. This means, when NOTMUCH_STATUS_SUCCESS is returned, the
894  * caller is supposed to check '*message' for NULL to find out whether the
895  * message with the given filename is found.
896  *
897  * Return value:
898  *
899  * NOTMUCH_STATUS_SUCCESS: Successful return, check '*message'
900  *
901  * NOTMUCH_STATUS_NULL_POINTER: The given 'message' argument is NULL
902  *
903  * NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory, creating the message object
904  *
905  * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred
906  *
907  * NOTMUCH_STATUS_UPGRADE_REQUIRED: The caller must upgrade the
908  *      database to use this function.
909  */
910 notmuch_status_t
911 notmuch_database_find_message_by_filename (notmuch_database_t *notmuch,
912                                            const char *filename,
913                                            notmuch_message_t **message);
914
915 /**
916  * Return a list of all tags found in the database.
917  *
918  * This function creates a list of all tags found in the database. The
919  * resulting list contains all tags from all messages found in the database.
920  *
921  * On error this function returns NULL.
922  */
923 notmuch_tags_t *
924 notmuch_database_get_all_tags (notmuch_database_t *db);
925
926 /**
927  * Reopen an open notmuch database.
928  *
929  * @param [in] db       open notmuch database
930  * @param [in] mode     mode (read only or read-write) for reopened database.
931  *
932  * @retval #NOTMUCH_STATUS_SUCCESS
933  * @retval #NOTMUCH_STATUS_ILLEGAL_ARGUMENT     The passed database was not open.
934  * @retval #NOTMUCH_STATUS_XAPIAN_EXCEPTION     A Xapian exception occured
935  */
936 notmuch_status_t
937 notmuch_database_reopen (notmuch_database_t *db, notmuch_database_mode_t mode);
938
939 /**
940  * Create a new query for 'database'.
941  *
942  * Here, 'database' should be an open database, (see
943  * notmuch_database_open and notmuch_database_create).
944  *
945  * For the query string, we'll document the syntax here more
946  * completely in the future, but it's likely to be a specialized
947  * version of the general Xapian query syntax:
948  *
949  * https://xapian.org/docs/queryparser.html
950  *
951  * As a special case, passing either a length-zero string, (that is ""),
952  * or a string consisting of a single asterisk (that is "*"), will
953  * result in a query that returns all messages in the database.
954  *
955  * See notmuch_query_set_sort for controlling the order of results.
956  * See notmuch_query_search_messages and notmuch_query_search_threads
957  * to actually execute the query.
958  *
959  * User should call notmuch_query_destroy when finished with this
960  * query.
961  *
962  * Will return NULL if insufficient memory is available.
963  */
964 notmuch_query_t *
965 notmuch_query_create (notmuch_database_t *database,
966                       const char *query_string);
967
968 typedef enum {
969     NOTMUCH_QUERY_SYNTAX_XAPIAN,
970     NOTMUCH_QUERY_SYNTAX_SEXP
971 } notmuch_query_syntax_t;
972
973 notmuch_status_t
974 notmuch_query_create_with_syntax (notmuch_database_t *database,
975                                   const char *query_string,
976                                   notmuch_query_syntax_t syntax,
977                                   notmuch_query_t **output);
978 /**
979  * Sort values for notmuch_query_set_sort.
980  */
981 typedef enum {
982     /**
983      * Oldest first.
984      */
985     NOTMUCH_SORT_OLDEST_FIRST,
986     /**
987      * Newest first.
988      */
989     NOTMUCH_SORT_NEWEST_FIRST,
990     /**
991      * Sort by message-id.
992      */
993     NOTMUCH_SORT_MESSAGE_ID,
994     /**
995      * Do not sort.
996      */
997     NOTMUCH_SORT_UNSORTED
998 } notmuch_sort_t;
999
1000 /**
1001  * Return the query_string of this query. See notmuch_query_create.
1002  */
1003 const char *
1004 notmuch_query_get_query_string (const notmuch_query_t *query);
1005
1006 /**
1007  * Return the notmuch database of this query. See notmuch_query_create.
1008  */
1009 notmuch_database_t *
1010 notmuch_query_get_database (const notmuch_query_t *query);
1011
1012 /**
1013  * Exclude values for notmuch_query_set_omit_excluded. The strange
1014  * order is to maintain backward compatibility: the old FALSE/TRUE
1015  * options correspond to the new
1016  * NOTMUCH_EXCLUDE_FLAG/NOTMUCH_EXCLUDE_TRUE options.
1017  */
1018 typedef enum {
1019     NOTMUCH_EXCLUDE_FLAG,
1020     NOTMUCH_EXCLUDE_TRUE,
1021     NOTMUCH_EXCLUDE_FALSE,
1022     NOTMUCH_EXCLUDE_ALL
1023 } notmuch_exclude_t;
1024
1025 /**
1026  * Specify whether to omit excluded results or simply flag them.  By
1027  * default, this is set to TRUE.
1028  *
1029  * If set to TRUE or ALL, notmuch_query_search_messages will omit excluded
1030  * messages from the results, and notmuch_query_search_threads will omit
1031  * threads that match only in excluded messages.  If set to TRUE,
1032  * notmuch_query_search_threads will include all messages in threads that
1033  * match in at least one non-excluded message.  Otherwise, if set to ALL,
1034  * notmuch_query_search_threads will omit excluded messages from all threads.
1035  *
1036  * If set to FALSE or FLAG then both notmuch_query_search_messages and
1037  * notmuch_query_search_threads will return all matching
1038  * messages/threads regardless of exclude status. If set to FLAG then
1039  * the exclude flag will be set for any excluded message that is
1040  * returned by notmuch_query_search_messages, and the thread counts
1041  * for threads returned by notmuch_query_search_threads will be the
1042  * number of non-excluded messages/matches. Otherwise, if set to
1043  * FALSE, then the exclude status is completely ignored.
1044  *
1045  * The performance difference when calling
1046  * notmuch_query_search_messages should be relatively small (and both
1047  * should be very fast).  However, in some cases,
1048  * notmuch_query_search_threads is very much faster when omitting
1049  * excluded messages as it does not need to construct the threads that
1050  * only match in excluded messages.
1051  */
1052 void
1053 notmuch_query_set_omit_excluded (notmuch_query_t *query,
1054                                  notmuch_exclude_t omit_excluded);
1055
1056 /**
1057  * Specify the sorting desired for this query.
1058  */
1059 void
1060 notmuch_query_set_sort (notmuch_query_t *query, notmuch_sort_t sort);
1061
1062 /**
1063  * Return the sort specified for this query. See
1064  * notmuch_query_set_sort.
1065  */
1066 notmuch_sort_t
1067 notmuch_query_get_sort (const notmuch_query_t *query);
1068
1069 /**
1070  * Add a tag that will be excluded from the query results by default.
1071  * This exclusion will be ignored if this tag appears explicitly in
1072  * the query.
1073  *
1074  * @returns
1075  *
1076  * NOTMUCH_STATUS_SUCCESS: excluded was added successfully.
1077  *
1078  * NOTMUCH_STATUS_XAPIAN_EXCEPTION: a Xapian exception occurred.
1079  *      Most likely a problem lazily parsing the query string.
1080  *
1081  * NOTMUCH_STATUS_IGNORED: tag is explicitly present in the query, so
1082  *              not excluded.
1083  */
1084 notmuch_status_t
1085 notmuch_query_add_tag_exclude (notmuch_query_t *query, const char *tag);
1086
1087 /**
1088  * Execute a query for threads, returning a notmuch_threads_t object
1089  * which can be used to iterate over the results. The returned threads
1090  * object is owned by the query and as such, will only be valid until
1091  * notmuch_query_destroy.
1092  *
1093  * Typical usage might be:
1094  *
1095  *     notmuch_query_t *query;
1096  *     notmuch_threads_t *threads;
1097  *     notmuch_thread_t *thread;
1098  *     notmuch_status_t stat;
1099  *
1100  *     query = notmuch_query_create (database, query_string);
1101  *
1102  *     for (stat = notmuch_query_search_threads (query, &threads);
1103  *          stat == NOTMUCH_STATUS_SUCCESS &&
1104  *          notmuch_threads_valid (threads);
1105  *          notmuch_threads_move_to_next (threads))
1106  *     {
1107  *         thread = notmuch_threads_get (threads);
1108  *         ....
1109  *         notmuch_thread_destroy (thread);
1110  *     }
1111  *
1112  *     notmuch_query_destroy (query);
1113  *
1114  * Note: If you are finished with a thread before its containing
1115  * query, you can call notmuch_thread_destroy to clean up some memory
1116  * sooner (as in the above example). Otherwise, if your thread objects
1117  * are long-lived, then you don't need to call notmuch_thread_destroy
1118  * and all the memory will still be reclaimed when the query is
1119  * destroyed.
1120  *
1121  * Note that there's no explicit destructor needed for the
1122  * notmuch_threads_t object. (For consistency, we do provide a
1123  * notmuch_threads_destroy function, but there's no good reason
1124  * to call it if the query is about to be destroyed).
1125  *
1126  * @since libnotmuch 5.0 (notmuch 0.25)
1127  */
1128 notmuch_status_t
1129 notmuch_query_search_threads (notmuch_query_t *query,
1130                               notmuch_threads_t **out);
1131
1132 /**
1133  * Deprecated alias for notmuch_query_search_threads.
1134  *
1135  * @deprecated Deprecated as of libnotmuch 5 (notmuch 0.25). Please
1136  * use notmuch_query_search_threads instead.
1137  *
1138  */
1139 NOTMUCH_DEPRECATED (5, 0)
1140 notmuch_status_t
1141 notmuch_query_search_threads_st (notmuch_query_t *query, notmuch_threads_t **out);
1142
1143 /**
1144  * Execute a query for messages, returning a notmuch_messages_t object
1145  * which can be used to iterate over the results. The returned
1146  * messages object is owned by the query and as such, will only be
1147  * valid until notmuch_query_destroy.
1148  *
1149  * Typical usage might be:
1150  *
1151  *     notmuch_query_t *query;
1152  *     notmuch_messages_t *messages;
1153  *     notmuch_message_t *message;
1154  *
1155  *     query = notmuch_query_create (database, query_string);
1156  *
1157  *     for (messages = notmuch_query_search_messages (query);
1158  *          notmuch_messages_valid (messages);
1159  *          notmuch_messages_move_to_next (messages))
1160  *     {
1161  *         message = notmuch_messages_get (messages);
1162  *         ....
1163  *         notmuch_message_destroy (message);
1164  *     }
1165  *
1166  *     notmuch_query_destroy (query);
1167  *
1168  * Note: If you are finished with a message before its containing
1169  * query, you can call notmuch_message_destroy to clean up some memory
1170  * sooner (as in the above example). Otherwise, if your message
1171  * objects are long-lived, then you don't need to call
1172  * notmuch_message_destroy and all the memory will still be reclaimed
1173  * when the query is destroyed.
1174  *
1175  * Note that there's no explicit destructor needed for the
1176  * notmuch_messages_t object. (For consistency, we do provide a
1177  * notmuch_messages_destroy function, but there's no good
1178  * reason to call it if the query is about to be destroyed).
1179  *
1180  * If a Xapian exception occurs this function will return NULL.
1181  *
1182  * @since libnotmuch 5 (notmuch 0.25)
1183  */
1184 notmuch_status_t
1185 notmuch_query_search_messages (notmuch_query_t *query,
1186                                notmuch_messages_t **out);
1187 /**
1188  * Deprecated alias for notmuch_query_search_messages
1189  *
1190  * @deprecated Deprecated as of libnotmuch 5 (notmuch 0.25). Please use
1191  * notmuch_query_search_messages instead.
1192  *
1193  */
1194
1195 NOTMUCH_DEPRECATED (5, 0)
1196 notmuch_status_t
1197 notmuch_query_search_messages_st (notmuch_query_t *query,
1198                                   notmuch_messages_t **out);
1199
1200 /**
1201  * Destroy a notmuch_query_t along with any associated resources.
1202  *
1203  * This will in turn destroy any notmuch_threads_t and
1204  * notmuch_messages_t objects generated by this query, (and in
1205  * turn any notmuch_thread_t and notmuch_message_t objects generated
1206  * from those results, etc.), if such objects haven't already been
1207  * destroyed.
1208  */
1209 void
1210 notmuch_query_destroy (notmuch_query_t *query);
1211
1212 /**
1213  * Is the given 'threads' iterator pointing at a valid thread.
1214  *
1215  * When this function returns TRUE, notmuch_threads_get will return a
1216  * valid object. Whereas when this function returns FALSE,
1217  * notmuch_threads_get will return NULL.
1218  *
1219  * If passed a NULL pointer, this function returns FALSE
1220  *
1221  * See the documentation of notmuch_query_search_threads for example
1222  * code showing how to iterate over a notmuch_threads_t object.
1223  */
1224 notmuch_bool_t
1225 notmuch_threads_valid (notmuch_threads_t *threads);
1226
1227 /**
1228  * Get the current thread from 'threads' as a notmuch_thread_t.
1229  *
1230  * Note: The returned thread belongs to 'threads' and has a lifetime
1231  * identical to it (and the query to which it belongs).
1232  *
1233  * See the documentation of notmuch_query_search_threads for example
1234  * code showing how to iterate over a notmuch_threads_t object.
1235  *
1236  * If an out-of-memory situation occurs, this function will return
1237  * NULL.
1238  */
1239 notmuch_thread_t *
1240 notmuch_threads_get (notmuch_threads_t *threads);
1241
1242 /**
1243  * Move the 'threads' iterator to the next thread.
1244  *
1245  * If 'threads' is already pointing at the last thread then the
1246  * iterator will be moved to a point just beyond that last thread,
1247  * (where notmuch_threads_valid will return FALSE and
1248  * notmuch_threads_get will return NULL).
1249  *
1250  * See the documentation of notmuch_query_search_threads for example
1251  * code showing how to iterate over a notmuch_threads_t object.
1252  */
1253 void
1254 notmuch_threads_move_to_next (notmuch_threads_t *threads);
1255
1256 /**
1257  * Destroy a notmuch_threads_t object.
1258  *
1259  * It's not strictly necessary to call this function. All memory from
1260  * the notmuch_threads_t object will be reclaimed when the
1261  * containing query object is destroyed.
1262  */
1263 void
1264 notmuch_threads_destroy (notmuch_threads_t *threads);
1265
1266 /**
1267  * Return the number of messages matching a search.
1268  *
1269  * This function performs a search and returns the number of matching
1270  * messages.
1271  *
1272  * @returns
1273  *
1274  * NOTMUCH_STATUS_SUCCESS: query completed successfully.
1275  *
1276  * NOTMUCH_STATUS_XAPIAN_EXCEPTION: a Xapian exception occurred. The
1277  *      value of *count is not defined.
1278  *
1279  * @since libnotmuch 5 (notmuch 0.25)
1280  */
1281 notmuch_status_t
1282 notmuch_query_count_messages (notmuch_query_t *query, unsigned int *count);
1283
1284 /**
1285  * Deprecated alias for notmuch_query_count_messages
1286  *
1287  *
1288  * @deprecated Deprecated since libnotmuch 5.0 (notmuch 0.25). Please
1289  * use notmuch_query_count_messages instead.
1290  */
1291 NOTMUCH_DEPRECATED (5, 0)
1292 notmuch_status_t
1293 notmuch_query_count_messages_st (notmuch_query_t *query, unsigned int *count);
1294
1295 /**
1296  * Return the number of threads matching a search.
1297  *
1298  * This function performs a search and returns the number of unique thread IDs
1299  * in the matching messages. This is the same as number of threads matching a
1300  * search.
1301  *
1302  * Note that this is a significantly heavier operation than
1303  * notmuch_query_count_messages{_st}().
1304  *
1305  * @returns
1306  *
1307  * NOTMUCH_STATUS_OUT_OF_MEMORY: Memory allocation failed. The value
1308  *      of *count is not defined
1309  *
1310  * NOTMUCH_STATUS_SUCCESS: query completed successfully.
1311  *
1312  * NOTMUCH_STATUS_XAPIAN_EXCEPTION: a Xapian exception occurred. The
1313  *      value of *count is not defined.
1314  *
1315  * @since libnotmuch 5 (notmuch 0.25)
1316  */
1317 notmuch_status_t
1318 notmuch_query_count_threads (notmuch_query_t *query, unsigned *count);
1319
1320 /**
1321  * Deprecated alias for notmuch_query_count_threads
1322  *
1323  * @deprecated Deprecated as of libnotmuch 5.0 (notmuch 0.25). Please
1324  * use notmuch_query_count_threads_st instead.
1325  */
1326 NOTMUCH_DEPRECATED (5, 0)
1327 notmuch_status_t
1328 notmuch_query_count_threads_st (notmuch_query_t *query, unsigned *count);
1329
1330 /**
1331  * Get the thread ID of 'thread'.
1332  *
1333  * The returned string belongs to 'thread' and as such, should not be
1334  * modified by the caller and will only be valid for as long as the
1335  * thread is valid, (which is until notmuch_thread_destroy or until
1336  * the query from which it derived is destroyed).
1337  */
1338 const char *
1339 notmuch_thread_get_thread_id (notmuch_thread_t *thread);
1340
1341 /**
1342  * Get the total number of messages in 'thread'.
1343  *
1344  * This count consists of all messages in the database belonging to
1345  * this thread. Contrast with notmuch_thread_get_matched_messages() .
1346  */
1347 int
1348 notmuch_thread_get_total_messages (notmuch_thread_t *thread);
1349
1350 /**
1351  * Get the total number of files in 'thread'.
1352  *
1353  * This sums notmuch_message_count_files over all messages in the
1354  * thread
1355  * @returns Non-negative integer
1356  * @since libnotmuch 5.0 (notmuch 0.25)
1357  */
1358
1359 int
1360 notmuch_thread_get_total_files (notmuch_thread_t *thread);
1361
1362 /**
1363  * Get a notmuch_messages_t iterator for the top-level messages in
1364  * 'thread' in oldest-first order.
1365  *
1366  * This iterator will not necessarily iterate over all of the messages
1367  * in the thread. It will only iterate over the messages in the thread
1368  * which are not replies to other messages in the thread.
1369  *
1370  * The returned list will be destroyed when the thread is destroyed.
1371  */
1372 notmuch_messages_t *
1373 notmuch_thread_get_toplevel_messages (notmuch_thread_t *thread);
1374
1375 /**
1376  * Get a notmuch_thread_t iterator for all messages in 'thread' in
1377  * oldest-first order.
1378  *
1379  * The returned list will be destroyed when the thread is destroyed.
1380  */
1381 notmuch_messages_t *
1382 notmuch_thread_get_messages (notmuch_thread_t *thread);
1383
1384 /**
1385  * Get the number of messages in 'thread' that matched the search.
1386  *
1387  * This count includes only the messages in this thread that were
1388  * matched by the search from which the thread was created and were
1389  * not excluded by any exclude tags passed in with the query (see
1390  * notmuch_query_add_tag_exclude). Contrast with
1391  * notmuch_thread_get_total_messages() .
1392  */
1393 int
1394 notmuch_thread_get_matched_messages (notmuch_thread_t *thread);
1395
1396 /**
1397  * Get the authors of 'thread' as a UTF-8 string.
1398  *
1399  * The returned string is a comma-separated list of the names of the
1400  * authors of mail messages in the query results that belong to this
1401  * thread.
1402  *
1403  * The string contains authors of messages matching the query first, then
1404  * non-matched authors (with the two groups separated by '|'). Within
1405  * each group, authors are ordered by date.
1406  *
1407  * The returned string belongs to 'thread' and as such, should not be
1408  * modified by the caller and will only be valid for as long as the
1409  * thread is valid, (which is until notmuch_thread_destroy or until
1410  * the query from which it derived is destroyed).
1411  */
1412 const char *
1413 notmuch_thread_get_authors (notmuch_thread_t *thread);
1414
1415 /**
1416  * Get the subject of 'thread' as a UTF-8 string.
1417  *
1418  * The subject is taken from the first message (according to the query
1419  * order---see notmuch_query_set_sort) in the query results that
1420  * belongs to this thread.
1421  *
1422  * The returned string belongs to 'thread' and as such, should not be
1423  * modified by the caller and will only be valid for as long as the
1424  * thread is valid, (which is until notmuch_thread_destroy or until
1425  * the query from which it derived is destroyed).
1426  */
1427 const char *
1428 notmuch_thread_get_subject (notmuch_thread_t *thread);
1429
1430 /**
1431  * Get the date of the oldest message in 'thread' as a time_t value.
1432  */
1433 time_t
1434 notmuch_thread_get_oldest_date (notmuch_thread_t *thread);
1435
1436 /**
1437  * Get the date of the newest message in 'thread' as a time_t value.
1438  */
1439 time_t
1440 notmuch_thread_get_newest_date (notmuch_thread_t *thread);
1441
1442 /**
1443  * Get the tags for 'thread', returning a notmuch_tags_t object which
1444  * can be used to iterate over all tags.
1445  *
1446  * Note: In the Notmuch database, tags are stored on individual
1447  * messages, not on threads. So the tags returned here will be all
1448  * tags of the messages which matched the search and which belong to
1449  * this thread.
1450  *
1451  * The tags object is owned by the thread and as such, will only be
1452  * valid for as long as the thread is valid, (for example, until
1453  * notmuch_thread_destroy or until the query from which it derived is
1454  * destroyed).
1455  *
1456  * Typical usage might be:
1457  *
1458  *     notmuch_thread_t *thread;
1459  *     notmuch_tags_t *tags;
1460  *     const char *tag;
1461  *
1462  *     thread = notmuch_threads_get (threads);
1463  *
1464  *     for (tags = notmuch_thread_get_tags (thread);
1465  *          notmuch_tags_valid (tags);
1466  *          notmuch_tags_move_to_next (tags))
1467  *     {
1468  *         tag = notmuch_tags_get (tags);
1469  *         ....
1470  *     }
1471  *
1472  *     notmuch_thread_destroy (thread);
1473  *
1474  * Note that there's no explicit destructor needed for the
1475  * notmuch_tags_t object. (For consistency, we do provide a
1476  * notmuch_tags_destroy function, but there's no good reason to call
1477  * it if the message is about to be destroyed).
1478  */
1479 notmuch_tags_t *
1480 notmuch_thread_get_tags (notmuch_thread_t *thread);
1481
1482 /**
1483  * Destroy a notmuch_thread_t object.
1484  */
1485 void
1486 notmuch_thread_destroy (notmuch_thread_t *thread);
1487
1488 /**
1489  * Is the given 'messages' iterator pointing at a valid message.
1490  *
1491  * When this function returns TRUE, notmuch_messages_get will return a
1492  * valid object. Whereas when this function returns FALSE,
1493  * notmuch_messages_get will return NULL.
1494  *
1495  * See the documentation of notmuch_query_search_messages for example
1496  * code showing how to iterate over a notmuch_messages_t object.
1497  */
1498 notmuch_bool_t
1499 notmuch_messages_valid (notmuch_messages_t *messages);
1500
1501 /**
1502  * Get the current message from 'messages' as a notmuch_message_t.
1503  *
1504  * Note: The returned message belongs to 'messages' and has a lifetime
1505  * identical to it (and the query to which it belongs).
1506  *
1507  * See the documentation of notmuch_query_search_messages for example
1508  * code showing how to iterate over a notmuch_messages_t object.
1509  *
1510  * If an out-of-memory situation occurs, this function will return
1511  * NULL.
1512  */
1513 notmuch_message_t *
1514 notmuch_messages_get (notmuch_messages_t *messages);
1515
1516 /**
1517  * Move the 'messages' iterator to the next message.
1518  *
1519  * If 'messages' is already pointing at the last message then the
1520  * iterator will be moved to a point just beyond that last message,
1521  * (where notmuch_messages_valid will return FALSE and
1522  * notmuch_messages_get will return NULL).
1523  *
1524  * See the documentation of notmuch_query_search_messages for example
1525  * code showing how to iterate over a notmuch_messages_t object.
1526  */
1527 void
1528 notmuch_messages_move_to_next (notmuch_messages_t *messages);
1529
1530 /**
1531  * Destroy a notmuch_messages_t object.
1532  *
1533  * It's not strictly necessary to call this function. All memory from
1534  * the notmuch_messages_t object will be reclaimed when the containing
1535  * query object is destroyed.
1536  */
1537 void
1538 notmuch_messages_destroy (notmuch_messages_t *messages);
1539
1540 /**
1541  * Return a list of tags from all messages.
1542  *
1543  * The resulting list is guaranteed not to contain duplicated tags.
1544  *
1545  * WARNING: You can no longer iterate over messages after calling this
1546  * function, because the iterator will point at the end of the list.
1547  * We do not have a function to reset the iterator yet and the only
1548  * way how you can iterate over the list again is to recreate the
1549  * message list.
1550  *
1551  * The function returns NULL on error.
1552  */
1553 notmuch_tags_t *
1554 notmuch_messages_collect_tags (notmuch_messages_t *messages);
1555
1556 /**
1557  * Get the database associated with this message.
1558  *
1559  * @since libnotmuch 5.2 (notmuch 0.27)
1560  */
1561 notmuch_database_t *
1562 notmuch_message_get_database (const notmuch_message_t *message);
1563
1564 /**
1565  * Get the message ID of 'message'.
1566  *
1567  * The returned string belongs to 'message' and as such, should not be
1568  * modified by the caller and will only be valid for as long as the
1569  * message is valid, (which is until the query from which it derived
1570  * is destroyed).
1571  *
1572  * This function will return NULL if triggers an unhandled Xapian
1573  * exception.
1574  */
1575 const char *
1576 notmuch_message_get_message_id (notmuch_message_t *message);
1577
1578 /**
1579  * Get the thread ID of 'message'.
1580  *
1581  * The returned string belongs to 'message' and as such, should not be
1582  * modified by the caller and will only be valid for as long as the
1583  * message is valid, (for example, until the user calls
1584  * notmuch_message_destroy on 'message' or until a query from which it
1585  * derived is destroyed).
1586  *
1587  * This function will return NULL if triggers an unhandled Xapian
1588  * exception.
1589  */
1590 const char *
1591 notmuch_message_get_thread_id (notmuch_message_t *message);
1592
1593 /**
1594  * Get a notmuch_messages_t iterator for all of the replies to
1595  * 'message'.
1596  *
1597  * Note: This call only makes sense if 'message' was ultimately
1598  * obtained from a notmuch_thread_t object, (such as by coming
1599  * directly from the result of calling notmuch_thread_get_
1600  * toplevel_messages or by any number of subsequent
1601  * calls to notmuch_message_get_replies).
1602  *
1603  * If 'message' was obtained through some non-thread means, (such as
1604  * by a call to notmuch_query_search_messages), then this function
1605  * will return NULL.
1606  *
1607  * If there are no replies to 'message', this function will return
1608  * NULL. (Note that notmuch_messages_valid will accept that NULL
1609  * value as legitimate, and simply return FALSE for it.)
1610  *
1611  * This function also returns NULL if it triggers a Xapian exception.
1612  *
1613  * The returned list will be destroyed when the thread is
1614  * destroyed.
1615  */
1616 notmuch_messages_t *
1617 notmuch_message_get_replies (notmuch_message_t *message);
1618
1619 /**
1620  * Get the total number of files associated with a message.
1621  * @returns Non-negative integer for file count.
1622  * @returns Negative integer for error.
1623  * @since libnotmuch 5.0 (notmuch 0.25)
1624  */
1625 int
1626 notmuch_message_count_files (notmuch_message_t *message);
1627
1628 /**
1629  * Get a filename for the email corresponding to 'message'.
1630  *
1631  * The returned filename is an absolute filename, (the initial
1632  * component will match notmuch_database_get_path() ).
1633  *
1634  * The returned string belongs to the message so should not be
1635  * modified or freed by the caller (nor should it be referenced after
1636  * the message is destroyed).
1637  *
1638  * Note: If this message corresponds to multiple files in the mail
1639  * store, (that is, multiple files contain identical message IDs),
1640  * this function will arbitrarily return a single one of those
1641  * filenames. See notmuch_message_get_filenames for returning the
1642  * complete list of filenames.
1643  *
1644  * This function returns NULL if it triggers a Xapian exception.
1645  */
1646 const char *
1647 notmuch_message_get_filename (notmuch_message_t *message);
1648
1649 /**
1650  * Get all filenames for the email corresponding to 'message'.
1651  *
1652  * Returns a notmuch_filenames_t iterator listing all the filenames
1653  * associated with 'message'. These files may not have identical
1654  * content, but each will have the identical Message-ID.
1655  *
1656  * Each filename in the iterator is an absolute filename, (the initial
1657  * component will match notmuch_database_get_path() ).
1658  *
1659  * This function returns NULL if it triggers a Xapian exception.
1660  */
1661 notmuch_filenames_t *
1662 notmuch_message_get_filenames (notmuch_message_t *message);
1663
1664 /**
1665  * Re-index the e-mail corresponding to 'message' using the supplied index options
1666  *
1667  * Returns the status of the re-index operation.  (see the return
1668  * codes documented in notmuch_database_index_file)
1669  *
1670  * After reindexing, the user should discard the message object passed
1671  * in here by calling notmuch_message_destroy, since it refers to the
1672  * original message, not to the reindexed message.
1673  */
1674 notmuch_status_t
1675 notmuch_message_reindex (notmuch_message_t *message,
1676                          notmuch_indexopts_t *indexopts);
1677
1678 /**
1679  * Message flags.
1680  */
1681 typedef enum _notmuch_message_flag {
1682     NOTMUCH_MESSAGE_FLAG_MATCH,
1683     NOTMUCH_MESSAGE_FLAG_EXCLUDED,
1684
1685     /* This message is a "ghost message", meaning it has no filenames
1686      * or content, but we know it exists because it was referenced by
1687      * some other message.  A ghost message has only a message ID and
1688      * thread ID.
1689      */
1690     NOTMUCH_MESSAGE_FLAG_GHOST,
1691 } notmuch_message_flag_t;
1692
1693 /**
1694  * Get a value of a flag for the email corresponding to 'message'.
1695  *
1696  * returns FALSE in case of errors.
1697  *
1698  * @deprecated Deprecated as of libnotmuch 5.3 (notmuch 0.31). Please
1699  * use notmuch_message_get_flag_st instead.
1700  */
1701 NOTMUCH_DEPRECATED (5, 3)
1702 notmuch_bool_t
1703 notmuch_message_get_flag (notmuch_message_t *message,
1704                           notmuch_message_flag_t flag);
1705
1706 /**
1707  * Get a value of a flag for the email corresponding to 'message'.
1708  *
1709  * @param message a message object
1710  * @param flag flag to check
1711  * @param is_set pointer to boolean to store flag value.
1712  *
1713  * @retval #NOTMUCH_STATUS_SUCCESS
1714  * @retval #NOTMUCH_STATUS_NULL_POINTER is_set is NULL
1715  * @retval #NOTMUCH_STATUS_XAPIAN_EXCEPTION Accessing the database
1716  * triggered an exception.
1717  *
1718  * @since libnotmuch 5.3 (notmuch 0.31)
1719  */
1720 notmuch_status_t
1721 notmuch_message_get_flag_st (notmuch_message_t *message,
1722                              notmuch_message_flag_t flag,
1723                              notmuch_bool_t *is_set);
1724
1725 /**
1726  * Set a value of a flag for the email corresponding to 'message'.
1727  */
1728 void
1729 notmuch_message_set_flag (notmuch_message_t *message,
1730                           notmuch_message_flag_t flag, notmuch_bool_t value);
1731
1732 /**
1733  * Get the date of 'message' as a time_t value.
1734  *
1735  * For the original textual representation of the Date header from the
1736  * message call notmuch_message_get_header() with a header value of
1737  * "date".
1738  *
1739  * Returns 0 in case of error.
1740  */
1741 time_t
1742 notmuch_message_get_date (notmuch_message_t *message);
1743
1744 /**
1745  * Get the value of the specified header from 'message' as a UTF-8 string.
1746  *
1747  * Common headers are stored in the database when the message is
1748  * indexed and will be returned from the database.  Other headers will
1749  * be read from the actual message file.
1750  *
1751  * The header name is case insensitive.
1752  *
1753  * The returned string belongs to the message so should not be
1754  * modified or freed by the caller (nor should it be referenced after
1755  * the message is destroyed).
1756  *
1757  * Returns an empty string ("") if the message does not contain a
1758  * header line matching 'header'. Returns NULL if any error occurs.
1759  */
1760 const char *
1761 notmuch_message_get_header (notmuch_message_t *message, const char *header);
1762
1763 /**
1764  * Get the tags for 'message', returning a notmuch_tags_t object which
1765  * can be used to iterate over all tags.
1766  *
1767  * The tags object is owned by the message and as such, will only be
1768  * valid for as long as the message is valid, (which is until the
1769  * query from which it derived is destroyed).
1770  *
1771  * Typical usage might be:
1772  *
1773  *     notmuch_message_t *message;
1774  *     notmuch_tags_t *tags;
1775  *     const char *tag;
1776  *
1777  *     message = notmuch_database_find_message (database, message_id);
1778  *
1779  *     for (tags = notmuch_message_get_tags (message);
1780  *          notmuch_tags_valid (tags);
1781  *          notmuch_tags_move_to_next (tags))
1782  *     {
1783  *         tag = notmuch_tags_get (tags);
1784  *         ....
1785  *     }
1786  *
1787  *     notmuch_message_destroy (message);
1788  *
1789  * Note that there's no explicit destructor needed for the
1790  * notmuch_tags_t object. (For consistency, we do provide a
1791  * notmuch_tags_destroy function, but there's no good reason to call
1792  * it if the message is about to be destroyed).
1793  */
1794 notmuch_tags_t *
1795 notmuch_message_get_tags (notmuch_message_t *message);
1796
1797 /**
1798  * The longest possible tag value.
1799  */
1800 #define NOTMUCH_TAG_MAX 200
1801
1802 /**
1803  * Add a tag to the given message.
1804  *
1805  * Return value:
1806  *
1807  * NOTMUCH_STATUS_SUCCESS: Tag successfully added to message
1808  *
1809  * NOTMUCH_STATUS_NULL_POINTER: The 'tag' argument is NULL
1810  *
1811  * NOTMUCH_STATUS_TAG_TOO_LONG: The length of 'tag' is too long
1812  *      (exceeds NOTMUCH_TAG_MAX)
1813  *
1814  * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
1815  *      mode so message cannot be modified.
1816  */
1817 notmuch_status_t
1818 notmuch_message_add_tag (notmuch_message_t *message, const char *tag);
1819
1820 /**
1821  * Remove a tag from the given message.
1822  *
1823  * Return value:
1824  *
1825  * NOTMUCH_STATUS_SUCCESS: Tag successfully removed from message
1826  *
1827  * NOTMUCH_STATUS_NULL_POINTER: The 'tag' argument is NULL
1828  *
1829  * NOTMUCH_STATUS_TAG_TOO_LONG: The length of 'tag' is too long
1830  *      (exceeds NOTMUCH_TAG_MAX)
1831  *
1832  * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
1833  *      mode so message cannot be modified.
1834  */
1835 notmuch_status_t
1836 notmuch_message_remove_tag (notmuch_message_t *message, const char *tag);
1837
1838 /**
1839  * Remove all tags from the given message.
1840  *
1841  * See notmuch_message_freeze for an example showing how to safely
1842  * replace tag values.
1843  *
1844  * @retval #NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in
1845  *      read-only mode so message cannot be modified.
1846  * @retval #NOTMUCH_STATUS_XAPIAN_EXCEPTION: an exception was thrown
1847  *      accessing the database.
1848  */
1849 notmuch_status_t
1850 notmuch_message_remove_all_tags (notmuch_message_t *message);
1851
1852 /**
1853  * Add/remove tags according to maildir flags in the message filename(s).
1854  *
1855  * This function examines the filenames of 'message' for maildir
1856  * flags, and adds or removes tags on 'message' as follows when these
1857  * flags are present:
1858  *
1859  *      Flag    Action if present
1860  *      ----    -----------------
1861  *      'D'     Adds the "draft" tag to the message
1862  *      'F'     Adds the "flagged" tag to the message
1863  *      'P'     Adds the "passed" tag to the message
1864  *      'R'     Adds the "replied" tag to the message
1865  *      'S'     Removes the "unread" tag from the message
1866  *
1867  * For each flag that is not present, the opposite action (add/remove)
1868  * is performed for the corresponding tags.
1869  *
1870  * Flags are identified as trailing components of the filename after a
1871  * sequence of ":2,".
1872  *
1873  * If there are multiple filenames associated with this message, the
1874  * flag is considered present if it appears in one or more
1875  * filenames. (That is, the flags from the multiple filenames are
1876  * combined with the logical OR operator.)
1877  *
1878  * A client can ensure that notmuch database tags remain synchronized
1879  * with maildir flags by calling this function after each call to
1880  * notmuch_database_index_file. See also
1881  * notmuch_message_tags_to_maildir_flags for synchronizing tag changes
1882  * back to maildir flags.
1883  */
1884 notmuch_status_t
1885 notmuch_message_maildir_flags_to_tags (notmuch_message_t *message);
1886
1887 /**
1888  * return TRUE if any filename of 'message' has maildir flag 'flag',
1889  * FALSE otherwise.
1890  *
1891  * Deprecated wrapper for notmuch_message_has_maildir_flag_st
1892  *
1893  * @returns FALSE in case of error
1894  * @deprecated libnotmuch 5.3 (notmuch 0.31)
1895  */
1896 NOTMUCH_DEPRECATED (5, 3)
1897 notmuch_bool_t
1898 notmuch_message_has_maildir_flag (notmuch_message_t *message, char flag);
1899
1900 /**
1901  * check message for maildir flag
1902  *
1903  * @param [in,out]      message message to check
1904  * @param [in] flag     flag to check for
1905  * @param [out] is_set  pointer to boolean
1906  *
1907  * @retval #NOTMUCH_STATUS_SUCCESS
1908  * @retval #NOTMUCH_STATUS_NULL_POINTER is_set is NULL
1909  * @retval #NOTMUCH_STATUS_XAPIAN_EXCEPTION Accessing the database
1910  * triggered an exception.
1911  */
1912 notmuch_status_t
1913 notmuch_message_has_maildir_flag_st (notmuch_message_t *message,
1914                                      char flag,
1915                                      notmuch_bool_t *is_set);
1916
1917 /**
1918  * Rename message filename(s) to encode tags as maildir flags.
1919  *
1920  * Specifically, for each filename corresponding to this message:
1921  *
1922  * If the filename is not in a maildir directory, do nothing.  (A
1923  * maildir directory is determined as a directory named "new" or
1924  * "cur".) Similarly, if the filename has invalid maildir info,
1925  * (repeated or outof-ASCII-order flag characters after ":2,"), then
1926  * do nothing.
1927  *
1928  * If the filename is in a maildir directory, rename the file so that
1929  * its filename ends with the sequence ":2," followed by zero or more
1930  * of the following single-character flags (in ASCII order):
1931  *
1932  *   * flag 'D' iff the message has the "draft" tag
1933  *   * flag 'F' iff the message has the "flagged" tag
1934  *   * flag 'P' iff the message has the "passed" tag
1935  *   * flag 'R' iff the message has the "replied" tag
1936  *   * flag 'S' iff the message does not have the "unread" tag
1937  *
1938  * Any existing flags unmentioned in the list above will be preserved
1939  * in the renaming.
1940  *
1941  * Also, if this filename is in a directory named "new", rename it to
1942  * be within the neighboring directory named "cur".
1943  *
1944  * A client can ensure that maildir filename flags remain synchronized
1945  * with notmuch database tags by calling this function after changing
1946  * tags, (after calls to notmuch_message_add_tag,
1947  * notmuch_message_remove_tag, or notmuch_message_freeze/
1948  * notmuch_message_thaw). See also notmuch_message_maildir_flags_to_tags
1949  * for synchronizing maildir flag changes back to tags.
1950  */
1951 notmuch_status_t
1952 notmuch_message_tags_to_maildir_flags (notmuch_message_t *message);
1953
1954 /**
1955  * Freeze the current state of 'message' within the database.
1956  *
1957  * This means that changes to the message state, (via
1958  * notmuch_message_add_tag, notmuch_message_remove_tag, and
1959  * notmuch_message_remove_all_tags), will not be committed to the
1960  * database until the message is thawed with notmuch_message_thaw.
1961  *
1962  * Multiple calls to freeze/thaw are valid and these calls will
1963  * "stack". That is there must be as many calls to thaw as to freeze
1964  * before a message is actually thawed.
1965  *
1966  * The ability to do freeze/thaw allows for safe transactions to
1967  * change tag values. For example, explicitly setting a message to
1968  * have a given set of tags might look like this:
1969  *
1970  *    notmuch_message_freeze (message);
1971  *
1972  *    notmuch_message_remove_all_tags (message);
1973  *
1974  *    for (i = 0; i < NUM_TAGS; i++)
1975  *        notmuch_message_add_tag (message, tags[i]);
1976  *
1977  *    notmuch_message_thaw (message);
1978  *
1979  * With freeze/thaw used like this, the message in the database is
1980  * guaranteed to have either the full set of original tag values, or
1981  * the full set of new tag values, but nothing in between.
1982  *
1983  * Imagine the example above without freeze/thaw and the operation
1984  * somehow getting interrupted. This could result in the message being
1985  * left with no tags if the interruption happened after
1986  * notmuch_message_remove_all_tags but before notmuch_message_add_tag.
1987  *
1988  * Return value:
1989  *
1990  * NOTMUCH_STATUS_SUCCESS: Message successfully frozen.
1991  *
1992  * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
1993  *      mode so message cannot be modified.
1994  */
1995 notmuch_status_t
1996 notmuch_message_freeze (notmuch_message_t *message);
1997
1998 /**
1999  * Thaw the current 'message', synchronizing any changes that may have
2000  * occurred while 'message' was frozen into the notmuch database.
2001  *
2002  * See notmuch_message_freeze for an example of how to use this
2003  * function to safely provide tag changes.
2004  *
2005  * Multiple calls to freeze/thaw are valid and these calls with
2006  * "stack". That is there must be as many calls to thaw as to freeze
2007  * before a message is actually thawed.
2008  *
2009  * Return value:
2010  *
2011  * NOTMUCH_STATUS_SUCCESS: Message successfully thawed, (or at least
2012  *      its frozen count has successfully been reduced by 1).
2013  *
2014  * NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW: An attempt was made to thaw
2015  *      an unfrozen message. That is, there have been an unbalanced
2016  *      number of calls to notmuch_message_freeze and
2017  *      notmuch_message_thaw.
2018  */
2019 notmuch_status_t
2020 notmuch_message_thaw (notmuch_message_t *message);
2021
2022 /**
2023  * Destroy a notmuch_message_t object.
2024  *
2025  * It can be useful to call this function in the case of a single
2026  * query object with many messages in the result, (such as iterating
2027  * over the entire database). Otherwise, it's fine to never call this
2028  * function and there will still be no memory leaks. (The memory from
2029  * the messages get reclaimed when the containing query is destroyed.)
2030  */
2031 void
2032 notmuch_message_destroy (notmuch_message_t *message);
2033
2034 /**
2035  * @name Message Properties
2036  *
2037  * This interface provides the ability to attach arbitrary (key,value)
2038  * string pairs to a message, to remove such pairs, and to iterate
2039  * over them.  The caller should take some care as to what keys they
2040  * add or delete values for, as other subsystems or extensions may
2041  * depend on these properties.
2042  *
2043  * Please see notmuch-properties(7) for more details about specific
2044  * properties and conventions around their use.
2045  *
2046  */
2047 /**@{*/
2048 /**
2049  * Retrieve the value for a single property key
2050  *
2051  * *value* is set to a string owned by the message or NULL if there is
2052  * no such key. In the case of multiple values for the given key, the
2053  * first one is retrieved.
2054  *
2055  * @returns
2056  * - NOTMUCH_STATUS_NULL_POINTER: *value* may not be NULL.
2057  * - NOTMUCH_STATUS_SUCCESS: No error occurred.
2058  * @since libnotmuch 4.4 (notmuch 0.23)
2059  */
2060 notmuch_status_t
2061 notmuch_message_get_property (notmuch_message_t *message, const char *key, const char **value);
2062
2063 /**
2064  * Add a (key,value) pair to a message
2065  *
2066  * @returns
2067  * - NOTMUCH_STATUS_ILLEGAL_ARGUMENT: *key* may not contain an '=' character.
2068  * - NOTMUCH_STATUS_NULL_POINTER: Neither *key* nor *value* may be NULL.
2069  * - NOTMUCH_STATUS_SUCCESS: No error occurred.
2070  * @since libnotmuch 4.4 (notmuch 0.23)
2071  */
2072 notmuch_status_t
2073 notmuch_message_add_property (notmuch_message_t *message, const char *key, const char *value);
2074
2075 /**
2076  * Remove a (key,value) pair from a message.
2077  *
2078  * It is not an error to remove a non-existent (key,value) pair
2079  *
2080  * @returns
2081  * - NOTMUCH_STATUS_ILLEGAL_ARGUMENT: *key* may not contain an '=' character.
2082  * - NOTMUCH_STATUS_NULL_POINTER: Neither *key* nor *value* may be NULL.
2083  * - NOTMUCH_STATUS_SUCCESS: No error occurred.
2084  * @since libnotmuch 4.4 (notmuch 0.23)
2085  */
2086 notmuch_status_t
2087 notmuch_message_remove_property (notmuch_message_t *message, const char *key, const char *value);
2088
2089 /**
2090  * Remove all (key,value) pairs from the given message.
2091  *
2092  * @param[in,out] message  message to operate on.
2093  * @param[in]     key      key to delete properties for. If NULL, delete
2094  *                         properties for all keys
2095  * @returns
2096  * - NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in
2097  *   read-only mode so message cannot be modified.
2098  * - NOTMUCH_STATUS_SUCCESS: No error occurred.
2099  *
2100  * @since libnotmuch 4.4 (notmuch 0.23)
2101  */
2102 notmuch_status_t
2103 notmuch_message_remove_all_properties (notmuch_message_t *message, const char *key);
2104
2105 /**
2106  * Remove all (prefix*,value) pairs from the given message
2107  *
2108  * @param[in,out] message  message to operate on.
2109  * @param[in]     prefix   delete properties with keys that start with prefix.
2110  *                         If NULL, delete all properties
2111  * @returns
2112  * - NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in
2113  *   read-only mode so message cannot be modified.
2114  * - NOTMUCH_STATUS_SUCCESS: No error occurred.
2115  *
2116  * @since libnotmuch 5.1 (notmuch 0.26)
2117  */
2118 notmuch_status_t
2119 notmuch_message_remove_all_properties_with_prefix (notmuch_message_t *message, const char *prefix);
2120
2121 /**
2122  * Opaque message property iterator
2123  */
2124 typedef struct _notmuch_string_map_iterator notmuch_message_properties_t;
2125
2126 /**
2127  * Get the properties for *message*, returning a
2128  * notmuch_message_properties_t object which can be used to iterate
2129  * over all properties.
2130  *
2131  * The notmuch_message_properties_t object is owned by the message and
2132  * as such, will only be valid for as long as the message is valid,
2133  * (which is until the query from which it derived is destroyed).
2134  *
2135  * @param[in] message  The message to examine
2136  * @param[in] key      key or key prefix
2137  * @param[in] exact    if TRUE, require exact match with key. Otherwise
2138  *                     treat as prefix.
2139  *
2140  * Typical usage might be:
2141  *
2142  *     notmuch_message_properties_t *list;
2143  *
2144  *     for (list = notmuch_message_get_properties (message, "testkey1", TRUE);
2145  *          notmuch_message_properties_valid (list); notmuch_message_properties_move_to_next (list)) {
2146  *        printf("%s\n", notmuch_message_properties_value(list));
2147  *     }
2148  *
2149  *     notmuch_message_properties_destroy (list);
2150  *
2151  * Note that there's no explicit destructor needed for the
2152  * notmuch_message_properties_t object. (For consistency, we do
2153  * provide a notmuch_message_properities_destroy function, but there's
2154  * no good reason to call it if the message is about to be destroyed).
2155  *
2156  * @since libnotmuch 4.4 (notmuch 0.23)
2157  */
2158 notmuch_message_properties_t *
2159 notmuch_message_get_properties (notmuch_message_t *message, const char *key, notmuch_bool_t exact);
2160
2161 /**
2162  * Return the number of properties named "key" belonging to the specific message.
2163  *
2164  * @param[in] message  The message to examine
2165  * @param[in] key      key to count
2166  * @param[out] count   The number of matching properties associated with this message.
2167  *
2168  * @returns
2169  *
2170  * NOTMUCH_STATUS_SUCCESS: successful count, possibly some other error.
2171  *
2172  * @since libnotmuch 5.2 (notmuch 0.27)
2173  */
2174 notmuch_status_t
2175 notmuch_message_count_properties (notmuch_message_t *message, const char *key, unsigned int *count);
2176
2177 /**
2178  * Is the given *properties* iterator pointing at a valid (key,value)
2179  * pair.
2180  *
2181  * When this function returns TRUE,
2182  * notmuch_message_properties_{key,value} will return a valid string,
2183  * and notmuch_message_properties_move_to_next will do what it
2184  * says. Whereas when this function returns FALSE, calling any of
2185  * these functions results in undefined behaviour.
2186  *
2187  * See the documentation of notmuch_message_get_properties for example
2188  * code showing how to iterate over a notmuch_message_properties_t
2189  * object.
2190  *
2191  * @since libnotmuch 4.4 (notmuch 0.23)
2192  */
2193 notmuch_bool_t
2194 notmuch_message_properties_valid (notmuch_message_properties_t *properties);
2195
2196 /**
2197  * Move the *properties* iterator to the next (key,value) pair
2198  *
2199  * If *properties* is already pointing at the last pair then the iterator
2200  * will be moved to a point just beyond that last pair, (where
2201  * notmuch_message_properties_valid will return FALSE).
2202  *
2203  * See the documentation of notmuch_message_get_properties for example
2204  * code showing how to iterate over a notmuch_message_properties_t object.
2205  *
2206  * @since libnotmuch 4.4 (notmuch 0.23)
2207  */
2208 void
2209 notmuch_message_properties_move_to_next (notmuch_message_properties_t *properties);
2210
2211 /**
2212  * Return the key from the current (key,value) pair.
2213  *
2214  * this could be useful if iterating for a prefix
2215  *
2216  * @since libnotmuch 4.4 (notmuch 0.23)
2217  */
2218 const char *
2219 notmuch_message_properties_key (notmuch_message_properties_t *properties);
2220
2221 /**
2222  * Return the value from the current (key,value) pair.
2223  *
2224  * This could be useful if iterating for a prefix.
2225  *
2226  * @since libnotmuch 4.4 (notmuch 0.23)
2227  */
2228 const char *
2229 notmuch_message_properties_value (notmuch_message_properties_t *properties);
2230
2231
2232 /**
2233  * Destroy a notmuch_message_properties_t object.
2234  *
2235  * It's not strictly necessary to call this function. All memory from
2236  * the notmuch_message_properties_t object will be reclaimed when the
2237  * containing message object is destroyed.
2238  *
2239  * @since libnotmuch 4.4 (notmuch 0.23)
2240  */
2241 void
2242 notmuch_message_properties_destroy (notmuch_message_properties_t *properties);
2243
2244 /**@}*/
2245
2246 /**
2247  * Is the given 'tags' iterator pointing at a valid tag.
2248  *
2249  * When this function returns TRUE, notmuch_tags_get will return a
2250  * valid string. Whereas when this function returns FALSE,
2251  * notmuch_tags_get will return NULL.
2252  *
2253  * See the documentation of notmuch_message_get_tags for example code
2254  * showing how to iterate over a notmuch_tags_t object.
2255  */
2256 notmuch_bool_t
2257 notmuch_tags_valid (notmuch_tags_t *tags);
2258
2259 /**
2260  * Get the current tag from 'tags' as a string.
2261  *
2262  * Note: The returned string belongs to 'tags' and has a lifetime
2263  * identical to it (and the query to which it ultimately belongs).
2264  *
2265  * See the documentation of notmuch_message_get_tags for example code
2266  * showing how to iterate over a notmuch_tags_t object.
2267  */
2268 const char *
2269 notmuch_tags_get (notmuch_tags_t *tags);
2270
2271 /**
2272  * Move the 'tags' iterator to the next tag.
2273  *
2274  * If 'tags' is already pointing at the last tag then the iterator
2275  * will be moved to a point just beyond that last tag, (where
2276  * notmuch_tags_valid will return FALSE and notmuch_tags_get will
2277  * return NULL).
2278  *
2279  * See the documentation of notmuch_message_get_tags for example code
2280  * showing how to iterate over a notmuch_tags_t object.
2281  */
2282 void
2283 notmuch_tags_move_to_next (notmuch_tags_t *tags);
2284
2285 /**
2286  * Destroy a notmuch_tags_t object.
2287  *
2288  * It's not strictly necessary to call this function. All memory from
2289  * the notmuch_tags_t object will be reclaimed when the containing
2290  * message or query objects are destroyed.
2291  */
2292 void
2293 notmuch_tags_destroy (notmuch_tags_t *tags);
2294
2295 /**
2296  * Store an mtime within the database for 'directory'.
2297  *
2298  * The 'directory' should be an object retrieved from the database
2299  * with notmuch_database_get_directory for a particular path.
2300  *
2301  * The intention is for the caller to use the mtime to allow efficient
2302  * identification of new messages to be added to the database. The
2303  * recommended usage is as follows:
2304  *
2305  *   o Read the mtime of a directory from the filesystem
2306  *
2307  *   o Call index_file for all mail files in the directory
2308  *
2309  *   o Call notmuch_directory_set_mtime with the mtime read from the
2310  *     filesystem.
2311  *
2312  * Then, when wanting to check for updates to the directory in the
2313  * future, the client can call notmuch_directory_get_mtime and know
2314  * that it only needs to add files if the mtime of the directory and
2315  * files are newer than the stored timestamp.
2316  *
2317  * Note: The notmuch_directory_get_mtime function does not allow the
2318  * caller to distinguish a timestamp of 0 from a non-existent
2319  * timestamp. So don't store a timestamp of 0 unless you are
2320  * comfortable with that.
2321  *
2322  * Return value:
2323  *
2324  * NOTMUCH_STATUS_SUCCESS: mtime successfully stored in database.
2325  *
2326  * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception
2327  *      occurred, mtime not stored.
2328  *
2329  * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
2330  *      mode so directory mtime cannot be modified.
2331  */
2332 notmuch_status_t
2333 notmuch_directory_set_mtime (notmuch_directory_t *directory,
2334                              time_t mtime);
2335
2336 /**
2337  * Get the mtime of a directory, (as previously stored with
2338  * notmuch_directory_set_mtime).
2339  *
2340  * Returns 0 if no mtime has previously been stored for this
2341  * directory.
2342  */
2343 time_t
2344 notmuch_directory_get_mtime (notmuch_directory_t *directory);
2345
2346 /**
2347  * Get a notmuch_filenames_t iterator listing all the filenames of
2348  * messages in the database within the given directory.
2349  *
2350  * The returned filenames will be the basename-entries only (not
2351  * complete paths).
2352  *
2353  * Returns NULL if it triggers a Xapian exception
2354  */
2355 notmuch_filenames_t *
2356 notmuch_directory_get_child_files (notmuch_directory_t *directory);
2357
2358 /**
2359  * Get a notmuch_filenames_t iterator listing all the filenames of
2360  * sub-directories in the database within the given directory.
2361  *
2362  * The returned filenames will be the basename-entries only (not
2363  * complete paths).
2364  *
2365  * Returns NULL if it triggers a Xapian exception
2366  */
2367 notmuch_filenames_t *
2368 notmuch_directory_get_child_directories (notmuch_directory_t *directory);
2369
2370 /**
2371  * Delete directory document from the database, and destroy the
2372  * notmuch_directory_t object. Assumes any child directories and files
2373  * have been deleted by the caller.
2374  *
2375  * @since libnotmuch 4.3 (notmuch 0.21)
2376  */
2377 notmuch_status_t
2378 notmuch_directory_delete (notmuch_directory_t *directory);
2379
2380 /**
2381  * Destroy a notmuch_directory_t object.
2382  */
2383 void
2384 notmuch_directory_destroy (notmuch_directory_t *directory);
2385
2386 /**
2387  * Is the given 'filenames' iterator pointing at a valid filename.
2388  *
2389  * When this function returns TRUE, notmuch_filenames_get will return
2390  * a valid string. Whereas when this function returns FALSE,
2391  * notmuch_filenames_get will return NULL.
2392  *
2393  * It is acceptable to pass NULL for 'filenames', in which case this
2394  * function will always return FALSE.
2395  */
2396 notmuch_bool_t
2397 notmuch_filenames_valid (notmuch_filenames_t *filenames);
2398
2399 /**
2400  * Get the current filename from 'filenames' as a string.
2401  *
2402  * Note: The returned string belongs to 'filenames' and has a lifetime
2403  * identical to it (and the directory to which it ultimately belongs).
2404  *
2405  * It is acceptable to pass NULL for 'filenames', in which case this
2406  * function will always return NULL.
2407  */
2408 const char *
2409 notmuch_filenames_get (notmuch_filenames_t *filenames);
2410
2411 /**
2412  * Move the 'filenames' iterator to the next filename.
2413  *
2414  * If 'filenames' is already pointing at the last filename then the
2415  * iterator will be moved to a point just beyond that last filename,
2416  * (where notmuch_filenames_valid will return FALSE and
2417  * notmuch_filenames_get will return NULL).
2418  *
2419  * It is acceptable to pass NULL for 'filenames', in which case this
2420  * function will do nothing.
2421  */
2422 void
2423 notmuch_filenames_move_to_next (notmuch_filenames_t *filenames);
2424
2425 /**
2426  * Destroy a notmuch_filenames_t object.
2427  *
2428  * It's not strictly necessary to call this function. All memory from
2429  * the notmuch_filenames_t object will be reclaimed when the
2430  * containing directory object is destroyed.
2431  *
2432  * It is acceptable to pass NULL for 'filenames', in which case this
2433  * function will do nothing.
2434  */
2435 void
2436 notmuch_filenames_destroy (notmuch_filenames_t *filenames);
2437
2438
2439 /**
2440  * set config 'key' to 'value'
2441  *
2442  * @since libnotmuch 4.4 (notmuch 0.23)
2443  * @retval #NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in
2444  *      read-only mode so message cannot be modified.
2445  * @retval #NOTMUCH_STATUS_XAPIAN_EXCEPTION: an exception was thrown
2446  *      accessing the database.
2447  * @retval #NOTMUCH_STATUS_SUCCESS
2448  */
2449 notmuch_status_t
2450 notmuch_database_set_config (notmuch_database_t *db, const char *key, const char *value);
2451
2452 /**
2453  * retrieve config item 'key', assign to  'value'
2454  *
2455  * keys which have not been previously set with n_d_set_config will
2456  * return an empty string.
2457  *
2458  * return value is allocated by malloc and should be freed by the
2459  * caller.
2460  *
2461  * @since libnotmuch 4.4 (notmuch 0.23)
2462  *
2463  */
2464 notmuch_status_t
2465 notmuch_database_get_config (notmuch_database_t *db, const char *key, char **value);
2466
2467 /**
2468  * Create an iterator for all config items with keys matching a given prefix
2469  *
2470  * @since libnotmuch 4.4 (notmuch 0.23)
2471  */
2472 notmuch_status_t
2473 notmuch_database_get_config_list (notmuch_database_t *db, const char *prefix,
2474                                   notmuch_config_list_t **out);
2475
2476 /**
2477  * Is 'config_list' iterator valid (i.e. _key, _value, _move_to_next can be called).
2478  *
2479  * @since libnotmuch 4.4 (notmuch 0.23)
2480  */
2481 notmuch_bool_t
2482 notmuch_config_list_valid (notmuch_config_list_t *config_list);
2483
2484 /**
2485  * return key for current config pair
2486  *
2487  * return value is owned by the iterator, and will be destroyed by the
2488  * next call to notmuch_config_list_key or notmuch_config_list_destroy.
2489  *
2490  * @since libnotmuch 4.4 (notmuch 0.23)
2491  */
2492 const char *
2493 notmuch_config_list_key (notmuch_config_list_t *config_list);
2494
2495 /**
2496  * return 'value' for current config pair
2497  *
2498  * return value is owned by the iterator, and will be destroyed by the
2499  * next call to notmuch_config_list_value or notmuch config_list_destroy
2500  *
2501  * @since libnotmuch 4.4 (notmuch 0.23)
2502  * @retval NULL for errors
2503  */
2504 const char *
2505 notmuch_config_list_value (notmuch_config_list_t *config_list);
2506
2507
2508 /**
2509  * move 'config_list' iterator to the next pair
2510  *
2511  * @since libnotmuch 4.4 (notmuch 0.23)
2512  */
2513 void
2514 notmuch_config_list_move_to_next (notmuch_config_list_t *config_list);
2515
2516 /**
2517  * free any resources held by 'config_list'
2518  *
2519  * @since libnotmuch 4.4 (notmuch 0.23)
2520  */
2521 void
2522 notmuch_config_list_destroy (notmuch_config_list_t *config_list);
2523
2524 /**
2525  * Configuration keys known to libnotmuch
2526  */
2527 typedef enum _notmuch_config_key {
2528     NOTMUCH_CONFIG_FIRST,
2529     NOTMUCH_CONFIG_DATABASE_PATH = NOTMUCH_CONFIG_FIRST,
2530     NOTMUCH_CONFIG_MAIL_ROOT,
2531     NOTMUCH_CONFIG_HOOK_DIR,
2532     NOTMUCH_CONFIG_BACKUP_DIR,
2533     NOTMUCH_CONFIG_EXCLUDE_TAGS,
2534     NOTMUCH_CONFIG_NEW_TAGS,
2535     NOTMUCH_CONFIG_NEW_IGNORE,
2536     NOTMUCH_CONFIG_SYNC_MAILDIR_FLAGS,
2537     NOTMUCH_CONFIG_PRIMARY_EMAIL,
2538     NOTMUCH_CONFIG_OTHER_EMAIL,
2539     NOTMUCH_CONFIG_USER_NAME,
2540     NOTMUCH_CONFIG_AUTOCOMMIT,
2541     NOTMUCH_CONFIG_LAST
2542 } notmuch_config_key_t;
2543
2544 /**
2545  * get a configuration value from an open database.
2546  *
2547  * This value reflects all configuration information given at the time
2548  * the database was opened.
2549  *
2550  * @param[in] notmuch database
2551  * @param[in] key configuration key
2552  *
2553  * @since libnotmuch 5.4 (notmuch 0.32)
2554  *
2555  * @retval NULL if 'key' unknown or if no value is known for
2556  *         'key'.  Otherwise returns a string owned by notmuch which should
2557  *         not be modified nor freed by the caller.
2558  */
2559 const char *
2560 notmuch_config_get (notmuch_database_t *notmuch, notmuch_config_key_t key);
2561
2562 /**
2563  * set a configuration value from in an open database.
2564  *
2565  * This value reflects all configuration information given at the time
2566  * the database was opened.
2567  *
2568  * @param[in,out] notmuch database open read/write
2569  * @param[in] key configuration key
2570  * @param[in] val configuration value
2571  *
2572  * @since libnotmuch 5.4 (notmuch 0.32)
2573  *
2574  * @retval returns any return value for notmuch_database_set_config.
2575  */
2576 notmuch_status_t
2577 notmuch_config_set (notmuch_database_t *notmuch, notmuch_config_key_t key, const char *val);
2578
2579 /**
2580  * Returns an iterator for a ';'-delimited list of configuration values
2581  *
2582  * These values reflect all configuration information given at the
2583  * time the database was opened.
2584  *
2585  * @param[in] notmuch database
2586  * @param[in] key configuration key
2587  *
2588  * @since libnotmuch 5.4 (notmuch 0.32)
2589  *
2590  * @retval NULL in case of error.
2591  */
2592 notmuch_config_values_t *
2593 notmuch_config_get_values (notmuch_database_t *notmuch, notmuch_config_key_t key);
2594
2595 /**
2596  * Returns an iterator for a ';'-delimited list of configuration values
2597  *
2598  * These values reflect all configuration information given at the
2599  * time the database was opened.
2600  *
2601  * @param[in] notmuch database
2602  * @param[in] key configuration key
2603  *
2604  * @since libnotmuch 5.4 (notmuch 0.32)
2605  *
2606  * @retval NULL in case of error.
2607  */
2608 notmuch_config_values_t *
2609 notmuch_config_get_values_string (notmuch_database_t *notmuch, const char *key);
2610
2611 /**
2612  * Is the given 'config_values' iterator pointing at a valid element.
2613  *
2614  * @param[in] values iterator
2615  *
2616  * @since libnotmuch 5.4 (notmuch 0.32)
2617  *
2618  * @retval FALSE if passed a NULL pointer, or the iterator is exhausted.
2619  *
2620  */
2621 notmuch_bool_t
2622 notmuch_config_values_valid (notmuch_config_values_t *values);
2623
2624 /**
2625  * Get the current value from the 'values' iterator
2626  *
2627  * @param[in] values iterator
2628  *
2629  * @since libnotmuch 5.4 (notmuch 0.32)
2630  *
2631  * @retval a string with the same lifetime as the iterator
2632  */
2633 const char *
2634 notmuch_config_values_get (notmuch_config_values_t *values);
2635
2636 /**
2637  * Move the 'values' iterator to the next element
2638  *
2639  * @param[in,out] values iterator
2640  *
2641  * @since libnotmuch 5.4 (notmuch 0.32)
2642  *
2643  */
2644 void
2645 notmuch_config_values_move_to_next (notmuch_config_values_t *values);
2646
2647
2648 /**
2649  * reset the 'values' iterator to the first element
2650  *
2651  * @param[in,out] values iterator. A NULL value is ignored.
2652  *
2653  * @since libnotmuch 5.4 (notmuch 0.32)
2654  *
2655  */
2656 void
2657 notmuch_config_values_start (notmuch_config_values_t *values);
2658
2659 /**
2660  * Destroy a config values iterator, along with any associated
2661  * resources.
2662  *
2663  * @param[in,out] values iterator
2664  *
2665  * @since libnotmuch 5.4 (notmuch 0.32)
2666  */
2667 void
2668 notmuch_config_values_destroy (notmuch_config_values_t *values);
2669
2670
2671 /**
2672  * Returns an iterator for a (key, value) configuration pairs
2673  *
2674  * @param[in] notmuch database
2675  * @param[in] prefix prefix for keys. Pass "" for all keys.
2676  *
2677  * @since libnotmuch 5.4 (notmuch 0.32)
2678  *
2679  * @retval NULL in case of error.
2680  */
2681 notmuch_config_pairs_t *
2682 notmuch_config_get_pairs (notmuch_database_t *notmuch,
2683                           const char *prefix);
2684
2685 /**
2686  * Is the given 'config_pairs' iterator pointing at a valid element.
2687  *
2688  * @param[in] pairs iterator
2689  *
2690  * @since libnotmuch 5.4 (notmuch 0.32)
2691  *
2692  * @retval FALSE if passed a NULL pointer, or the iterator is exhausted.
2693  *
2694  */
2695 notmuch_bool_t
2696 notmuch_config_pairs_valid (notmuch_config_pairs_t *pairs);
2697
2698 /**
2699  * Move the 'config_pairs' iterator to the next element
2700  *
2701  * @param[in,out] pairs iterator
2702  *
2703  * @since libnotmuch 5.4 (notmuch 0.32)
2704  *
2705  */
2706 void
2707 notmuch_config_pairs_move_to_next (notmuch_config_pairs_t *pairs);
2708
2709 /**
2710  * Get the current key from the 'config_pairs' iterator
2711  *
2712  * @param[in] pairs iterator
2713  *
2714  * @since libnotmuch 5.4 (notmuch 0.32)
2715  *
2716  * @retval a string with the same lifetime as the iterator
2717  */
2718 const char *
2719 notmuch_config_pairs_key (notmuch_config_pairs_t *pairs);
2720
2721 /**
2722  * Get the current value from the 'config_pairs' iterator
2723  *
2724  * @param[in] pairs iterator
2725  *
2726  * @since libnotmuch 5.4 (notmuch 0.32)
2727  *
2728  * @retval a string with the same lifetime as the iterator
2729  */
2730 const char *
2731 notmuch_config_pairs_value (notmuch_config_pairs_t *pairs);
2732
2733 /**
2734  * Destroy a config_pairs iterator, along with any associated
2735  * resources.
2736  *
2737  * @param[in,out] pairs iterator
2738  *
2739  * @since libnotmuch 5.4 (notmuch 0.32)
2740  */
2741 void
2742 notmuch_config_pairs_destroy (notmuch_config_pairs_t *pairs);
2743
2744 /**
2745  * get a configuration value from an open database as Boolean
2746  *
2747  * This value reflects all configuration information given at the time
2748  * the database was opened.
2749  *
2750  * @param[in] notmuch database
2751  * @param[in] key configuration key
2752  * @param[out] val configuration value, converted to Boolean
2753  *
2754  * @since libnotmuch 5.4 (notmuch 0.32)
2755  *
2756  * @retval #NOTMUCH_STATUS_ILLEGAL_ARGUMENT if either key is unknown
2757  * or the corresponding value does not convert to Boolean.
2758  */
2759 notmuch_status_t
2760 notmuch_config_get_bool (notmuch_database_t *notmuch,
2761                          notmuch_config_key_t key,
2762                          notmuch_bool_t *val);
2763
2764 /**
2765  * return the path of the config file loaded, if any
2766  *
2767  * @retval NULL if no config file was loaded
2768  */
2769 const char *
2770 notmuch_config_path (notmuch_database_t *notmuch);
2771
2772 /**
2773  * get the current default indexing options for a given database.
2774  *
2775  * This object will survive until the database itself is destroyed,
2776  * but the caller may also release it earlier with
2777  * notmuch_indexopts_destroy.
2778  *
2779  * This object represents a set of options on how a message can be
2780  * added to the index.  At the moment it is a featureless stub.
2781  *
2782  * @since libnotmuch 5.1 (notmuch 0.26)
2783  * @retval NULL in case of error
2784  */
2785 notmuch_indexopts_t *
2786 notmuch_database_get_default_indexopts (notmuch_database_t *db);
2787
2788 /**
2789  * Stating a policy about how to decrypt messages.
2790  *
2791  * See index.decrypt in notmuch-config(1) for more details.
2792  */
2793 typedef enum {
2794     NOTMUCH_DECRYPT_FALSE,
2795     NOTMUCH_DECRYPT_TRUE,
2796     NOTMUCH_DECRYPT_AUTO,
2797     NOTMUCH_DECRYPT_NOSTASH,
2798 } notmuch_decryption_policy_t;
2799
2800 /**
2801  * Specify whether to decrypt encrypted parts while indexing.
2802  *
2803  * Be aware that the index is likely sufficient to reconstruct the
2804  * cleartext of the message itself, so please ensure that the notmuch
2805  * message index is adequately protected. DO NOT SET THIS FLAG TO TRUE
2806  * without considering the security of your index.
2807  *
2808  * @since libnotmuch 5.1 (notmuch 0.26)
2809  */
2810 notmuch_status_t
2811 notmuch_indexopts_set_decrypt_policy (notmuch_indexopts_t *indexopts,
2812                                       notmuch_decryption_policy_t decrypt_policy);
2813
2814 /**
2815  * Return whether to decrypt encrypted parts while indexing.
2816  * see notmuch_indexopts_set_decrypt_policy.
2817  *
2818  * @since libnotmuch 5.1 (notmuch 0.26)
2819  */
2820 notmuch_decryption_policy_t
2821 notmuch_indexopts_get_decrypt_policy (const notmuch_indexopts_t *indexopts);
2822
2823 /**
2824  * Destroy a notmuch_indexopts_t object.
2825  *
2826  * @since libnotmuch 5.1 (notmuch 0.26)
2827  */
2828 void
2829 notmuch_indexopts_destroy (notmuch_indexopts_t *options);
2830
2831
2832 /**
2833  * interrogate the library for compile time features
2834  *
2835  * @since libnotmuch 4.4 (notmuch 0.23)
2836  */
2837 notmuch_bool_t
2838 notmuch_built_with (const char *name);
2839 /**@}*/
2840
2841 #pragma GCC visibility pop
2842
2843 NOTMUCH_END_DECLS
2844
2845 #endif