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