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