1 /* notmuch - Not much of an email library, (just index and search)
3 * Copyright © 2009 Carl Worth
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.
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.
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/ .
18 * Author: Carl Worth <cworth@cworth.org>
22 * @defgroup notmuch The notmuch API
24 * Not much of an email library, (just index and search)
35 # define NOTMUCH_BEGIN_DECLS extern "C" {
36 # define NOTMUCH_END_DECLS }
38 # define NOTMUCH_BEGIN_DECLS
39 # define NOTMUCH_END_DECLS
46 #pragma GCC visibility push(default)
57 * The library version number. This must agree with the soname
58 * version in Makefile.local.
60 #define LIBNOTMUCH_MAJOR_VERSION 5
61 #define LIBNOTMUCH_MINOR_VERSION 3
62 #define LIBNOTMUCH_MICRO_VERSION 0
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)))
71 #define NOTMUCH_DEPRECATED(major, minor) __attribute__ ((deprecated))
75 #endif /* __DOXYGEN__ */
78 * Check the version of the notmuch library being compiled against.
80 * Return true if the library being compiled against is of the
81 * specified version or above. For example:
84 * #if LIBNOTMUCH_CHECK_VERSION(3, 1, 0)
85 * (code requiring libnotmuch 3.1.0 or above)
89 * LIBNOTMUCH_CHECK_VERSION has been defined since version 3.1.0; to
90 * check for versions prior to that, use:
93 * #if !defined(NOTMUCH_CHECK_VERSION)
94 * (code requiring libnotmuch prior to 3.1.0)
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)))
105 * Notmuch boolean type.
107 typedef int notmuch_bool_t;
110 * Status codes used for the return values of most functions.
112 * A zero value (NOTMUCH_STATUS_SUCCESS) indicates that the function
113 * completed without error. Any other value indicates an error.
115 typedef enum _notmuch_status {
119 NOTMUCH_STATUS_SUCCESS = 0,
123 NOTMUCH_STATUS_OUT_OF_MEMORY,
125 * An attempt was made to write to a database opened in read-only
128 NOTMUCH_STATUS_READ_ONLY_DATABASE,
130 * A Xapian exception occurred.
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
136 NOTMUCH_STATUS_XAPIAN_EXCEPTION,
138 * An error occurred trying to read or write to a file (this could
139 * be file not found, permission denied, etc.)
141 NOTMUCH_STATUS_FILE_ERROR,
143 * A file was presented that doesn't appear to be an email
146 NOTMUCH_STATUS_FILE_NOT_EMAIL,
148 * A file contains a message ID that is identical to a message
149 * already in the database.
151 NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID,
153 * The user erroneously passed a NULL pointer to a notmuch
156 NOTMUCH_STATUS_NULL_POINTER,
158 * A tag value is too long (exceeds NOTMUCH_TAG_MAX).
160 NOTMUCH_STATUS_TAG_TOO_LONG,
162 * The notmuch_message_thaw function has been called more times
163 * than notmuch_message_freeze.
165 NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW,
167 * notmuch_database_end_atomic has been called more times than
168 * notmuch_database_begin_atomic.
170 NOTMUCH_STATUS_UNBALANCED_ATOMIC,
172 * The operation is not supported.
174 NOTMUCH_STATUS_UNSUPPORTED_OPERATION,
176 * The operation requires a database upgrade.
178 NOTMUCH_STATUS_UPGRADE_REQUIRED,
180 * There is a problem with the proposed path, e.g. a relative path
181 * passed to a function expecting an absolute path.
183 NOTMUCH_STATUS_PATH_ERROR,
185 * The requested operation was ignored. Depending on the function,
186 * this may not be an actual error.
188 NOTMUCH_STATUS_IGNORED,
190 * One of the arguments violates the preconditions for the
191 * function, in a way not covered by a more specific argument.
193 NOTMUCH_STATUS_ILLEGAL_ARGUMENT,
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.
199 NOTMUCH_STATUS_MALFORMED_CRYPTO_PROTOCOL,
201 * Notmuch attempted to do crypto processing, but could not
202 * initialize the engine needed to do so.
204 NOTMUCH_STATUS_FAILED_CRYPTO_CONTEXT_CREATION,
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.
210 NOTMUCH_STATUS_UNKNOWN_CRYPTO_PROTOCOL,
212 * Unable to load a config file
214 NOTMUCH_STATUS_NO_CONFIG,
216 * Database exists, so not (re)-created
218 NOTMUCH_STATUS_DATABASE_EXISTS,
220 * Not an actual status value. Just a way to find out how many
221 * valid status values there are.
223 NOTMUCH_STATUS_LAST_STATUS
227 * Get a string representation of a notmuch_status_t value.
229 * The result is read-only.
232 notmuch_status_to_string (notmuch_status_t status);
234 /* Various opaque data types. For each notmuch_<foo>_t see the various
235 * notmuch_<foo> functions below. */
237 typedef struct _notmuch_database notmuch_database_t;
238 typedef struct _notmuch_query notmuch_query_t;
239 typedef struct _notmuch_threads notmuch_threads_t;
240 typedef struct _notmuch_thread notmuch_thread_t;
241 typedef struct _notmuch_messages notmuch_messages_t;
242 typedef struct _notmuch_message notmuch_message_t;
243 typedef struct _notmuch_tags notmuch_tags_t;
244 typedef struct _notmuch_directory notmuch_directory_t;
245 typedef struct _notmuch_filenames notmuch_filenames_t;
246 typedef struct _notmuch_config_list notmuch_config_list_t;
247 typedef struct _notmuch_config_values notmuch_config_values_t;
248 typedef struct _notmuch_indexopts notmuch_indexopts_t;
249 #endif /* __DOXYGEN__ */
252 * Create a new, empty notmuch database located at 'path'.
254 * The path should be a top-level directory to a collection of
255 * plain-text email messages (one message per file). This call will
256 * create a new ".notmuch" directory within 'path' where notmuch will
259 * After a successful call to notmuch_database_create, the returned
260 * database will be open so the caller should call
261 * notmuch_database_destroy when finished with it.
263 * The database will not yet have any data in it
264 * (notmuch_database_create itself is a very cheap function). Messages
265 * contained within 'path' can be added to the database by calling
266 * notmuch_database_index_file.
268 * In case of any failure, this function returns an error status and
269 * sets *database to NULL (after printing an error message on stderr).
273 * NOTMUCH_STATUS_SUCCESS: Successfully created the database.
275 * NOTMUCH_STATUS_NULL_POINTER: The given 'path' argument is NULL.
277 * NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory.
279 * NOTMUCH_STATUS_FILE_ERROR: An error occurred trying to create the
280 * database file (such as permission denied, or file not found,
281 * etc.), or the database already exists.
283 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred.
286 notmuch_database_create (const char *path, notmuch_database_t **database);
289 * Like notmuch_database_create, except optionally return an error
290 * message. This message is allocated by malloc and should be freed by
294 notmuch_database_create_verbose (const char *path,
295 notmuch_database_t **database,
296 char **error_message);
299 * Database open mode for notmuch_database_open.
303 * Open database for reading only.
305 NOTMUCH_DATABASE_MODE_READ_ONLY = 0,
307 * Open database for reading and writing.
309 NOTMUCH_DATABASE_MODE_READ_WRITE
310 } notmuch_database_mode_t;
313 * Deprecated alias for notmuch_database_open_with_config with
314 * config_path=error_message=NULL
315 * @deprecated Deprecated as of libnotmuch 5.4 (notmuch 0.32)
317 /* NOTMUCH_DEPRECATED(5, 4) */
319 notmuch_database_open (const char *path,
320 notmuch_database_mode_t mode,
321 notmuch_database_t **database);
323 * Deprecated alias for notmuch_database_open_with_config with
326 * @deprecated Deprecated as of libnotmuch 5.4 (notmuch 0.32)
329 /* NOTMUCH_DEPRECATED(5, 4) */
331 notmuch_database_open_verbose (const char *path,
332 notmuch_database_mode_t mode,
333 notmuch_database_t **database,
334 char **error_message);
337 * Open an existing notmuch database located at 'database_path', using
338 * configuration in 'config_path'.
340 * @param[in] database_path
342 * Path to existing database.
344 * A notmuch database is a Xapian database containing appropriate
347 * The database should have been created at some time in the past,
348 * (not necessarily by this process), by calling
349 * notmuch_database_create.
351 * If 'database_path' is NULL, use the location specified
353 * - in the environment variable NOTMUCH_DATABASE, if non-empty
355 * - in a configuration file, located as described under 'config_path'
357 * - by $XDG_DATA_HOME/notmuch/$PROFILE where XDG_DATA_HOME defaults
358 * to "$HOME/.local/share" and PROFILE as as discussed in
361 * If 'database_path' is non-NULL, but does not appear to be a Xapian
362 * database, check for a directory '.notmuch/xapian' below
363 * 'database_path' (this is the behavior of
364 * notmuch_database_open_verbose pre-0.32).
369 * Mode to open database. Use one of #NOTMUCH_DATABASE_MODE_READ_WRITE
370 * or #NOTMUCH_DATABASE_MODE_READ_ONLY
373 * @param[in] config_path
375 * Path to config file.
377 * Config file is key-value, with mandatory sections. See
378 * <em>notmuch-config(5)</em> for more information. The key-value pair
379 * overrides the corresponding configuration data stored in the
380 * database (see <em>notmuch_database_get_config</em>)
382 * If <em>config_path</em> is NULL use the path specified
384 * - in environment variable <em>NOTMUCH_CONFIG</em>, if non-empty
386 * - by <em>XDG_CONFIG_HOME</em>/notmuch/ where
387 * XDG_CONFIG_HOME defaults to "$HOME/.config".
389 * - by $HOME/.notmuch-config
391 * If <em>config_path</em> is "" (empty string) then do not
392 * open any configuration file.
394 * @param[in] profile:
396 * Name of profile (configuration/database variant).
398 * If non-NULL, append to the directory / file path determined for
399 * <em>config_path</em> and <em>database_path</em>.
402 * - environment variable NOTMUCH_PROFILE if defined,
403 * - otherwise "default" for directories and "" (empty string) for paths.
406 * @param[out] database
408 * Pointer to database object. May not be NULL.
410 * The caller should call notmuch_database_destroy when finished with
413 * In case of any failure, this function returns an error status and
414 * sets *database to NULL.
417 * @param[out] error_message
418 * If non-NULL, store error message from opening the database.
419 * Any such message is allocated by \a malloc(3) and should be freed
422 * @retval NOTMUCH_STATUS_SUCCESS: Successfully opened the database.
424 * @retval NOTMUCH_STATUS_NULL_POINTER: The given \a database
427 * @retval NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory.
429 * @retval NOTMUCH_STATUS_FILE_ERROR: An error occurred trying to open the
430 * database or config file (such as permission denied, or file not found,
431 * etc.), or the database version is unknown.
433 * @retval NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred.
435 * @since libnotmuch 5.4 (notmuch 0.32)
439 notmuch_database_open_with_config (const char *database_path,
440 notmuch_database_mode_t mode,
441 const char *config_path,
443 notmuch_database_t **database,
444 char **error_message);
448 * Loads configuration from config file, database, and/or defaults
450 * For description of arguments, @see notmuch_database_open_with_config
452 * @retval NOTMUCH_STATUS_SUCCESS: Successfully loaded (some) configuration.
454 * @retval NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory.
456 * @retval NOTMUCH_STATUS_FILE_ERROR: An error occurred trying to open the
457 * database or config file (such as permission denied, or file not found,
460 * @retval NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred.
462 * @since libnotmuch 5.4 (notmuch 0.32)
466 notmuch_database_load_config (const char *database_path,
467 const char *config_path,
469 notmuch_database_t **database,
470 char **error_message);
473 * Create a new notmuch database located at 'database_path', using
474 * configuration in 'config_path'.
476 * For description of arguments, @see notmuch_database_open_with_config
478 * @retval NOTMUCH_STATUS_SUCCESS: Successfully created the database.
480 * @retval NOTMUCH_STATUS_DATABASE_EXISTS: Database already exists, not created
482 * @retval NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory.
484 * @retval NOTMUCH_STATUS_FILE_ERROR: An error occurred trying to open the
485 * database or config file (such as permission denied, or file not found,
488 * @retval NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred.
490 * @since libnotmuch 5.4 (notmuch 0.32)
494 notmuch_database_create_with_config (const char *database_path,
495 const char *config_path,
497 notmuch_database_t **database,
498 char **error_message);
501 * Retrieve last status string for given database.
505 notmuch_database_status_string (const notmuch_database_t *notmuch);
508 * Commit changes and close the given notmuch database.
510 * After notmuch_database_close has been called, calls to other
511 * functions on objects derived from this database may either behave
512 * as if the database had not been closed (e.g., if the required data
513 * has been cached) or may fail with a
514 * NOTMUCH_STATUS_XAPIAN_EXCEPTION. The only further operation
515 * permitted on the database itself is to call
516 * notmuch_database_destroy.
518 * notmuch_database_close can be called multiple times. Later calls
521 * For writable databases, notmuch_database_close commits all changes
522 * to disk before closing the database. If the caller is currently in
523 * an atomic section (there was a notmuch_database_begin_atomic
524 * without a matching notmuch_database_end_atomic), this will discard
525 * changes made in that atomic section (but still commit changes made
526 * prior to entering the atomic section).
530 * NOTMUCH_STATUS_SUCCESS: Successfully closed the database.
532 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred; the
533 * database has been closed but there are no guarantees the
534 * changes to the database, if any, have been flushed to disk.
537 notmuch_database_close (notmuch_database_t *database);
540 * A callback invoked by notmuch_database_compact to notify the user
541 * of the progress of the compaction process.
543 typedef void (*notmuch_compact_status_cb_t)(const char *message, void *closure);
546 * Compact a notmuch database, backing up the original database to the
549 * The database will be opened with NOTMUCH_DATABASE_MODE_READ_WRITE
550 * during the compaction process to ensure no writes are made.
552 * If the optional callback function 'status_cb' is non-NULL, it will
553 * be called with diagnostic and informational messages. The argument
554 * 'closure' is passed verbatim to any callback invoked.
557 notmuch_database_compact (const char *path,
558 const char *backup_path,
559 notmuch_compact_status_cb_t status_cb,
563 * Like notmuch_database_compact, but take an open database as a
566 * @since libnnotmuch 5.4 (notmuch 0.32)
569 notmuch_database_compact_db (notmuch_database_t *database,
570 const char *backup_path,
571 notmuch_compact_status_cb_t status_cb,
575 * Destroy the notmuch database, closing it if necessary and freeing
576 * all associated resources.
578 * Return value as in notmuch_database_close if the database was open;
579 * notmuch_database_destroy itself has no failure modes.
582 notmuch_database_destroy (notmuch_database_t *database);
585 * Return the database path of the given database.
587 * The return value is a string owned by notmuch so should not be
588 * modified nor freed by the caller.
591 notmuch_database_get_path (notmuch_database_t *database);
594 * Return the database format version of the given database.
599 notmuch_database_get_version (notmuch_database_t *database);
602 * Can the database be upgraded to a newer database version?
604 * If this function returns TRUE, then the caller may call
605 * notmuch_database_upgrade to upgrade the database. If the caller
606 * does not upgrade an out-of-date database, then some functions may
607 * fail with NOTMUCH_STATUS_UPGRADE_REQUIRED. This always returns
608 * FALSE for a read-only database because there's no way to upgrade a
609 * read-only database.
611 * Also returns FALSE if an error occurs accessing the database.
615 notmuch_database_needs_upgrade (notmuch_database_t *database);
618 * Upgrade the current database to the latest supported version.
620 * This ensures that all current notmuch functionality will be
621 * available on the database. After opening a database in read-write
622 * mode, it is recommended that clients check if an upgrade is needed
623 * (notmuch_database_needs_upgrade) and if so, upgrade with this
624 * function before making any modifications. If
625 * notmuch_database_needs_upgrade returns FALSE, this will be a no-op.
627 * The optional progress_notify callback can be used by the caller to
628 * provide progress indication to the user. If non-NULL it will be
629 * called periodically with 'progress' as a floating-point value in
630 * the range of [0.0 .. 1.0] indicating the progress made so far in
631 * the upgrade process. The argument 'closure' is passed verbatim to
632 * any callback invoked.
635 notmuch_database_upgrade (notmuch_database_t *database,
636 void (*progress_notify)(void *closure,
641 * Begin an atomic database operation.
643 * Any modifications performed between a successful begin and a
644 * notmuch_database_end_atomic will be applied to the database
645 * atomically. Note that, unlike a typical database transaction, this
646 * only ensures atomicity, not durability; neither begin nor end
647 * necessarily flush modifications to disk.
649 * Atomic sections may be nested. begin_atomic and end_atomic must
650 * always be called in pairs.
654 * NOTMUCH_STATUS_SUCCESS: Successfully entered atomic section.
656 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred;
657 * atomic section not entered.
660 notmuch_database_begin_atomic (notmuch_database_t *notmuch);
663 * Indicate the end of an atomic database operation.
667 * NOTMUCH_STATUS_SUCCESS: Successfully completed atomic section.
669 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred;
670 * atomic section not ended.
672 * NOTMUCH_STATUS_UNBALANCED_ATOMIC: The database is not currently in
676 notmuch_database_end_atomic (notmuch_database_t *notmuch);
679 * Return the committed database revision and UUID.
681 * The database revision number increases monotonically with each
682 * commit to the database. Hence, all messages and message changes
683 * committed to the database (that is, visible to readers) have a last
684 * modification revision <= the committed database revision. Any
685 * messages committed in the future will be assigned a modification
686 * revision > the committed database revision.
688 * The UUID is a NUL-terminated opaque string that uniquely identifies
689 * this database. Two revision numbers are only comparable if they
690 * have the same database UUID.
693 notmuch_database_get_revision (notmuch_database_t *notmuch,
697 * Retrieve a directory object from the database for 'path'.
699 * Here, 'path' should be a path relative to the path of 'database'
700 * (see notmuch_database_get_path), or else should be an absolute path
701 * with initial components that match the path of 'database'.
703 * If this directory object does not exist in the database, this
704 * returns NOTMUCH_STATUS_SUCCESS and sets *directory to NULL.
706 * Otherwise the returned directory object is owned by the database
707 * and as such, will only be valid until notmuch_database_destroy is
712 * NOTMUCH_STATUS_SUCCESS: Successfully retrieved directory.
714 * NOTMUCH_STATUS_NULL_POINTER: The given 'directory' argument is NULL.
716 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred;
717 * directory not retrieved.
719 * NOTMUCH_STATUS_UPGRADE_REQUIRED: The caller must upgrade the
720 * database to use this function.
723 notmuch_database_get_directory (notmuch_database_t *database,
725 notmuch_directory_t **directory);
728 * Add a message file to a database, indexing it for retrieval by
729 * future searches. If a message already exists with the same message
730 * ID as the specified file, their indexes will be merged, and this
731 * new filename will also be associated with the existing message.
733 * Here, 'filename' should be a path relative to the path of
734 * 'database' (see notmuch_database_get_path), or else should be an
735 * absolute filename with initial components that match the path of
738 * The file should be a single mail message (not a multi-message mbox)
739 * that is expected to remain at its current location, (since the
740 * notmuch database will reference the filename, and will not copy the
741 * entire contents of the file.
743 * If another message with the same message ID already exists in the
744 * database, rather than creating a new message, this adds the search
745 * terms from the identified file to the existing message's index, and
746 * adds 'filename' to the list of filenames known for the message.
748 * The 'indexopts' parameter can be NULL (meaning, use the indexing
749 * defaults from the database), or can be an explicit choice of
750 * indexing options that should govern the indexing of this specific
753 * If 'message' is not NULL, then, on successful return
754 * (NOTMUCH_STATUS_SUCCESS or NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID) '*message'
755 * will be initialized to a message object that can be used for things
756 * such as adding tags to the just-added message. The user should call
757 * notmuch_message_destroy when done with the message. On any failure
758 * '*message' will be set to NULL.
762 * NOTMUCH_STATUS_SUCCESS: Message successfully added to database.
764 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred,
767 * NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID: Message has the same message
768 * ID as another message already in the database. The new
769 * filename was successfully added to the message in the database
770 * (if not already present) and the existing message is returned.
772 * NOTMUCH_STATUS_FILE_ERROR: an error occurred trying to open the
773 * file, (such as permission denied, or file not found,
774 * etc.). Nothing added to the database.
776 * NOTMUCH_STATUS_FILE_NOT_EMAIL: the contents of filename don't look
777 * like an email message. Nothing added to the database.
779 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
780 * mode so no message can be added.
782 * NOTMUCH_STATUS_UPGRADE_REQUIRED: The caller must upgrade the
783 * database to use this function.
785 * @since libnotmuch 5.1 (notmuch 0.26)
788 notmuch_database_index_file (notmuch_database_t *database,
789 const char *filename,
790 notmuch_indexopts_t *indexopts,
791 notmuch_message_t **message);
794 * Deprecated alias for notmuch_database_index_file called with
797 * @deprecated Deprecated as of libnotmuch 5.1 (notmuch 0.26). Please
798 * use notmuch_database_index_file instead.
801 NOTMUCH_DEPRECATED (5, 1)
803 notmuch_database_add_message (notmuch_database_t *database,
804 const char *filename,
805 notmuch_message_t **message);
808 * Remove a message filename from the given notmuch database. If the
809 * message has no more filenames, remove the message.
811 * If the same message (as determined by the message ID) is still
812 * available via other filenames, then the message will persist in the
813 * database for those filenames. When the last filename is removed for
814 * a particular message, the database content for that message will be
819 * NOTMUCH_STATUS_SUCCESS: The last filename was removed and the
820 * message was removed from the database.
822 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred,
823 * message not removed.
825 * NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID: This filename was removed but
826 * the message persists in the database with at least one other
829 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
830 * mode so no message can be removed.
832 * NOTMUCH_STATUS_UPGRADE_REQUIRED: The caller must upgrade the
833 * database to use this function.
836 notmuch_database_remove_message (notmuch_database_t *database,
837 const char *filename);
840 * Find a message with the given message_id.
842 * If a message with the given message_id is found then, on successful return
843 * (NOTMUCH_STATUS_SUCCESS) '*message' will be initialized to a message
844 * object. The caller should call notmuch_message_destroy when done with the
847 * On any failure or when the message is not found, this function initializes
848 * '*message' to NULL. This means, when NOTMUCH_STATUS_SUCCESS is returned, the
849 * caller is supposed to check '*message' for NULL to find out whether the
850 * message with the given message_id was found.
854 * NOTMUCH_STATUS_SUCCESS: Successful return, check '*message'.
856 * NOTMUCH_STATUS_NULL_POINTER: The given 'message' argument is NULL
858 * NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory, creating message object
860 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred
863 notmuch_database_find_message (notmuch_database_t *database,
864 const char *message_id,
865 notmuch_message_t **message);
868 * Find a message with the given filename.
870 * If the database contains a message with the given filename then, on
871 * successful return (NOTMUCH_STATUS_SUCCESS) '*message' will be initialized to
872 * a message object. The caller should call notmuch_message_destroy when done
875 * On any failure or when the message is not found, this function initializes
876 * '*message' to NULL. This means, when NOTMUCH_STATUS_SUCCESS is returned, the
877 * caller is supposed to check '*message' for NULL to find out whether the
878 * message with the given filename is found.
882 * NOTMUCH_STATUS_SUCCESS: Successful return, check '*message'
884 * NOTMUCH_STATUS_NULL_POINTER: The given 'message' argument is NULL
886 * NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory, creating the message object
888 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred
890 * NOTMUCH_STATUS_UPGRADE_REQUIRED: The caller must upgrade the
891 * database to use this function.
894 notmuch_database_find_message_by_filename (notmuch_database_t *notmuch,
895 const char *filename,
896 notmuch_message_t **message);
899 * Return a list of all tags found in the database.
901 * This function creates a list of all tags found in the database. The
902 * resulting list contains all tags from all messages found in the database.
904 * On error this function returns NULL.
907 notmuch_database_get_all_tags (notmuch_database_t *db);
910 * Reopen an open notmuch database.
912 * @param [in] db open notmuch database
913 * @param [in] mode mode (read only or read-write) for reopened database.
915 * @retval #NOTMUCH_STATUS_SUCCESS
916 * @retval #NOTMUCH_STATUS_ILLEGAL_ARGUMENT The passed database was not open.
917 * @retval #NOTMUCH_STATUS_XAPIAN_EXCEPTION A Xapian exception occured
920 notmuch_database_reopen (notmuch_database_t *db, notmuch_database_mode_t mode);
923 * Create a new query for 'database'.
925 * Here, 'database' should be an open database, (see
926 * notmuch_database_open and notmuch_database_create).
928 * For the query string, we'll document the syntax here more
929 * completely in the future, but it's likely to be a specialized
930 * version of the general Xapian query syntax:
932 * https://xapian.org/docs/queryparser.html
934 * As a special case, passing either a length-zero string, (that is ""),
935 * or a string consisting of a single asterisk (that is "*"), will
936 * result in a query that returns all messages in the database.
938 * See notmuch_query_set_sort for controlling the order of results.
939 * See notmuch_query_search_messages and notmuch_query_search_threads
940 * to actually execute the query.
942 * User should call notmuch_query_destroy when finished with this
945 * Will return NULL if insufficient memory is available.
948 notmuch_query_create (notmuch_database_t *database,
949 const char *query_string);
952 * Sort values for notmuch_query_set_sort.
958 NOTMUCH_SORT_OLDEST_FIRST,
962 NOTMUCH_SORT_NEWEST_FIRST,
964 * Sort by message-id.
966 NOTMUCH_SORT_MESSAGE_ID,
970 NOTMUCH_SORT_UNSORTED
974 * Return the query_string of this query. See notmuch_query_create.
977 notmuch_query_get_query_string (const notmuch_query_t *query);
980 * Return the notmuch database of this query. See notmuch_query_create.
983 notmuch_query_get_database (const notmuch_query_t *query);
986 * Exclude values for notmuch_query_set_omit_excluded. The strange
987 * order is to maintain backward compatibility: the old FALSE/TRUE
988 * options correspond to the new
989 * NOTMUCH_EXCLUDE_FLAG/NOTMUCH_EXCLUDE_TRUE options.
992 NOTMUCH_EXCLUDE_FLAG,
993 NOTMUCH_EXCLUDE_TRUE,
994 NOTMUCH_EXCLUDE_FALSE,
999 * Specify whether to omit excluded results or simply flag them. By
1000 * default, this is set to TRUE.
1002 * If set to TRUE or ALL, notmuch_query_search_messages will omit excluded
1003 * messages from the results, and notmuch_query_search_threads will omit
1004 * threads that match only in excluded messages. If set to TRUE,
1005 * notmuch_query_search_threads will include all messages in threads that
1006 * match in at least one non-excluded message. Otherwise, if set to ALL,
1007 * notmuch_query_search_threads will omit excluded messages from all threads.
1009 * If set to FALSE or FLAG then both notmuch_query_search_messages and
1010 * notmuch_query_search_threads will return all matching
1011 * messages/threads regardless of exclude status. If set to FLAG then
1012 * the exclude flag will be set for any excluded message that is
1013 * returned by notmuch_query_search_messages, and the thread counts
1014 * for threads returned by notmuch_query_search_threads will be the
1015 * number of non-excluded messages/matches. Otherwise, if set to
1016 * FALSE, then the exclude status is completely ignored.
1018 * The performance difference when calling
1019 * notmuch_query_search_messages should be relatively small (and both
1020 * should be very fast). However, in some cases,
1021 * notmuch_query_search_threads is very much faster when omitting
1022 * excluded messages as it does not need to construct the threads that
1023 * only match in excluded messages.
1026 notmuch_query_set_omit_excluded (notmuch_query_t *query,
1027 notmuch_exclude_t omit_excluded);
1030 * Specify the sorting desired for this query.
1033 notmuch_query_set_sort (notmuch_query_t *query, notmuch_sort_t sort);
1036 * Return the sort specified for this query. See
1037 * notmuch_query_set_sort.
1040 notmuch_query_get_sort (const notmuch_query_t *query);
1043 * Add a tag that will be excluded from the query results by default.
1044 * This exclusion will be ignored if this tag appears explicitly in
1049 * NOTMUCH_STATUS_SUCCESS: excluded was added successfully.
1051 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: a Xapian exception occurred.
1052 * Most likely a problem lazily parsing the query string.
1054 * NOTMUCH_STATUS_IGNORED: tag is explicitly present in the query, so
1058 notmuch_query_add_tag_exclude (notmuch_query_t *query, const char *tag);
1061 * Execute a query for threads, returning a notmuch_threads_t object
1062 * which can be used to iterate over the results. The returned threads
1063 * object is owned by the query and as such, will only be valid until
1064 * notmuch_query_destroy.
1066 * Typical usage might be:
1068 * notmuch_query_t *query;
1069 * notmuch_threads_t *threads;
1070 * notmuch_thread_t *thread;
1071 * notmuch_status_t stat;
1073 * query = notmuch_query_create (database, query_string);
1075 * for (stat = notmuch_query_search_threads (query, &threads);
1076 * stat == NOTMUCH_STATUS_SUCCESS &&
1077 * notmuch_threads_valid (threads);
1078 * notmuch_threads_move_to_next (threads))
1080 * thread = notmuch_threads_get (threads);
1082 * notmuch_thread_destroy (thread);
1085 * notmuch_query_destroy (query);
1087 * Note: If you are finished with a thread before its containing
1088 * query, you can call notmuch_thread_destroy to clean up some memory
1089 * sooner (as in the above example). Otherwise, if your thread objects
1090 * are long-lived, then you don't need to call notmuch_thread_destroy
1091 * and all the memory will still be reclaimed when the query is
1094 * Note that there's no explicit destructor needed for the
1095 * notmuch_threads_t object. (For consistency, we do provide a
1096 * notmuch_threads_destroy function, but there's no good reason
1097 * to call it if the query is about to be destroyed).
1099 * @since libnotmuch 5.0 (notmuch 0.25)
1102 notmuch_query_search_threads (notmuch_query_t *query,
1103 notmuch_threads_t **out);
1106 * Deprecated alias for notmuch_query_search_threads.
1108 * @deprecated Deprecated as of libnotmuch 5 (notmuch 0.25). Please
1109 * use notmuch_query_search_threads instead.
1112 NOTMUCH_DEPRECATED (5, 0)
1114 notmuch_query_search_threads_st (notmuch_query_t *query, notmuch_threads_t **out);
1117 * Execute a query for messages, returning a notmuch_messages_t object
1118 * which can be used to iterate over the results. The returned
1119 * messages object is owned by the query and as such, will only be
1120 * valid until notmuch_query_destroy.
1122 * Typical usage might be:
1124 * notmuch_query_t *query;
1125 * notmuch_messages_t *messages;
1126 * notmuch_message_t *message;
1128 * query = notmuch_query_create (database, query_string);
1130 * for (messages = notmuch_query_search_messages (query);
1131 * notmuch_messages_valid (messages);
1132 * notmuch_messages_move_to_next (messages))
1134 * message = notmuch_messages_get (messages);
1136 * notmuch_message_destroy (message);
1139 * notmuch_query_destroy (query);
1141 * Note: If you are finished with a message before its containing
1142 * query, you can call notmuch_message_destroy to clean up some memory
1143 * sooner (as in the above example). Otherwise, if your message
1144 * objects are long-lived, then you don't need to call
1145 * notmuch_message_destroy and all the memory will still be reclaimed
1146 * when the query is destroyed.
1148 * Note that there's no explicit destructor needed for the
1149 * notmuch_messages_t object. (For consistency, we do provide a
1150 * notmuch_messages_destroy function, but there's no good
1151 * reason to call it if the query is about to be destroyed).
1153 * If a Xapian exception occurs this function will return NULL.
1155 * @since libnotmuch 5 (notmuch 0.25)
1158 notmuch_query_search_messages (notmuch_query_t *query,
1159 notmuch_messages_t **out);
1161 * Deprecated alias for notmuch_query_search_messages
1163 * @deprecated Deprecated as of libnotmuch 5 (notmuch 0.25). Please use
1164 * notmuch_query_search_messages instead.
1168 NOTMUCH_DEPRECATED (5, 0)
1170 notmuch_query_search_messages_st (notmuch_query_t *query,
1171 notmuch_messages_t **out);
1174 * Destroy a notmuch_query_t along with any associated resources.
1176 * This will in turn destroy any notmuch_threads_t and
1177 * notmuch_messages_t objects generated by this query, (and in
1178 * turn any notmuch_thread_t and notmuch_message_t objects generated
1179 * from those results, etc.), if such objects haven't already been
1183 notmuch_query_destroy (notmuch_query_t *query);
1186 * Is the given 'threads' iterator pointing at a valid thread.
1188 * When this function returns TRUE, notmuch_threads_get will return a
1189 * valid object. Whereas when this function returns FALSE,
1190 * notmuch_threads_get will return NULL.
1192 * If passed a NULL pointer, this function returns FALSE
1194 * See the documentation of notmuch_query_search_threads for example
1195 * code showing how to iterate over a notmuch_threads_t object.
1198 notmuch_threads_valid (notmuch_threads_t *threads);
1201 * Get the current thread from 'threads' as a notmuch_thread_t.
1203 * Note: The returned thread belongs to 'threads' and has a lifetime
1204 * identical to it (and the query to which it belongs).
1206 * See the documentation of notmuch_query_search_threads for example
1207 * code showing how to iterate over a notmuch_threads_t object.
1209 * If an out-of-memory situation occurs, this function will return
1213 notmuch_threads_get (notmuch_threads_t *threads);
1216 * Move the 'threads' iterator to the next thread.
1218 * If 'threads' is already pointing at the last thread then the
1219 * iterator will be moved to a point just beyond that last thread,
1220 * (where notmuch_threads_valid will return FALSE and
1221 * notmuch_threads_get will return NULL).
1223 * See the documentation of notmuch_query_search_threads for example
1224 * code showing how to iterate over a notmuch_threads_t object.
1227 notmuch_threads_move_to_next (notmuch_threads_t *threads);
1230 * Destroy a notmuch_threads_t object.
1232 * It's not strictly necessary to call this function. All memory from
1233 * the notmuch_threads_t object will be reclaimed when the
1234 * containing query object is destroyed.
1237 notmuch_threads_destroy (notmuch_threads_t *threads);
1240 * Return the number of messages matching a search.
1242 * This function performs a search and returns the number of matching
1247 * NOTMUCH_STATUS_SUCCESS: query completed successfully.
1249 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: a Xapian exception occurred. The
1250 * value of *count is not defined.
1252 * @since libnotmuch 5 (notmuch 0.25)
1255 notmuch_query_count_messages (notmuch_query_t *query, unsigned int *count);
1258 * Deprecated alias for notmuch_query_count_messages
1261 * @deprecated Deprecated since libnotmuch 5.0 (notmuch 0.25). Please
1262 * use notmuch_query_count_messages instead.
1264 NOTMUCH_DEPRECATED (5, 0)
1266 notmuch_query_count_messages_st (notmuch_query_t *query, unsigned int *count);
1269 * Return the number of threads matching a search.
1271 * This function performs a search and returns the number of unique thread IDs
1272 * in the matching messages. This is the same as number of threads matching a
1275 * Note that this is a significantly heavier operation than
1276 * notmuch_query_count_messages{_st}().
1280 * NOTMUCH_STATUS_OUT_OF_MEMORY: Memory allocation failed. The value
1281 * of *count is not defined
1283 * NOTMUCH_STATUS_SUCCESS: query completed successfully.
1285 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: a Xapian exception occurred. The
1286 * value of *count is not defined.
1288 * @since libnotmuch 5 (notmuch 0.25)
1291 notmuch_query_count_threads (notmuch_query_t *query, unsigned *count);
1294 * Deprecated alias for notmuch_query_count_threads
1296 * @deprecated Deprecated as of libnotmuch 5.0 (notmuch 0.25). Please
1297 * use notmuch_query_count_threads_st instead.
1299 NOTMUCH_DEPRECATED (5, 0)
1301 notmuch_query_count_threads_st (notmuch_query_t *query, unsigned *count);
1304 * Get the thread ID of 'thread'.
1306 * The returned string belongs to 'thread' and as such, should not be
1307 * modified by the caller and will only be valid for as long as the
1308 * thread is valid, (which is until notmuch_thread_destroy or until
1309 * the query from which it derived is destroyed).
1312 notmuch_thread_get_thread_id (notmuch_thread_t *thread);
1315 * Get the total number of messages in 'thread'.
1317 * This count consists of all messages in the database belonging to
1318 * this thread. Contrast with notmuch_thread_get_matched_messages() .
1321 notmuch_thread_get_total_messages (notmuch_thread_t *thread);
1324 * Get the total number of files in 'thread'.
1326 * This sums notmuch_message_count_files over all messages in the
1328 * @returns Non-negative integer
1329 * @since libnotmuch 5.0 (notmuch 0.25)
1333 notmuch_thread_get_total_files (notmuch_thread_t *thread);
1336 * Get a notmuch_messages_t iterator for the top-level messages in
1337 * 'thread' in oldest-first order.
1339 * This iterator will not necessarily iterate over all of the messages
1340 * in the thread. It will only iterate over the messages in the thread
1341 * which are not replies to other messages in the thread.
1343 * The returned list will be destroyed when the thread is destroyed.
1345 notmuch_messages_t *
1346 notmuch_thread_get_toplevel_messages (notmuch_thread_t *thread);
1349 * Get a notmuch_thread_t iterator for all messages in 'thread' in
1350 * oldest-first order.
1352 * The returned list will be destroyed when the thread is destroyed.
1354 notmuch_messages_t *
1355 notmuch_thread_get_messages (notmuch_thread_t *thread);
1358 * Get the number of messages in 'thread' that matched the search.
1360 * This count includes only the messages in this thread that were
1361 * matched by the search from which the thread was created and were
1362 * not excluded by any exclude tags passed in with the query (see
1363 * notmuch_query_add_tag_exclude). Contrast with
1364 * notmuch_thread_get_total_messages() .
1367 notmuch_thread_get_matched_messages (notmuch_thread_t *thread);
1370 * Get the authors of 'thread' as a UTF-8 string.
1372 * The returned string is a comma-separated list of the names of the
1373 * authors of mail messages in the query results that belong to this
1376 * The string contains authors of messages matching the query first, then
1377 * non-matched authors (with the two groups separated by '|'). Within
1378 * each group, authors are ordered by date.
1380 * The returned string belongs to 'thread' and as such, should not be
1381 * modified by the caller and will only be valid for as long as the
1382 * thread is valid, (which is until notmuch_thread_destroy or until
1383 * the query from which it derived is destroyed).
1386 notmuch_thread_get_authors (notmuch_thread_t *thread);
1389 * Get the subject of 'thread' as a UTF-8 string.
1391 * The subject is taken from the first message (according to the query
1392 * order---see notmuch_query_set_sort) in the query results that
1393 * belongs to this thread.
1395 * The returned string belongs to 'thread' and as such, should not be
1396 * modified by the caller and will only be valid for as long as the
1397 * thread is valid, (which is until notmuch_thread_destroy or until
1398 * the query from which it derived is destroyed).
1401 notmuch_thread_get_subject (notmuch_thread_t *thread);
1404 * Get the date of the oldest message in 'thread' as a time_t value.
1407 notmuch_thread_get_oldest_date (notmuch_thread_t *thread);
1410 * Get the date of the newest message in 'thread' as a time_t value.
1413 notmuch_thread_get_newest_date (notmuch_thread_t *thread);
1416 * Get the tags for 'thread', returning a notmuch_tags_t object which
1417 * can be used to iterate over all tags.
1419 * Note: In the Notmuch database, tags are stored on individual
1420 * messages, not on threads. So the tags returned here will be all
1421 * tags of the messages which matched the search and which belong to
1424 * The tags object is owned by the thread and as such, will only be
1425 * valid for as long as the thread is valid, (for example, until
1426 * notmuch_thread_destroy or until the query from which it derived is
1429 * Typical usage might be:
1431 * notmuch_thread_t *thread;
1432 * notmuch_tags_t *tags;
1435 * thread = notmuch_threads_get (threads);
1437 * for (tags = notmuch_thread_get_tags (thread);
1438 * notmuch_tags_valid (tags);
1439 * notmuch_tags_move_to_next (tags))
1441 * tag = notmuch_tags_get (tags);
1445 * notmuch_thread_destroy (thread);
1447 * Note that there's no explicit destructor needed for the
1448 * notmuch_tags_t object. (For consistency, we do provide a
1449 * notmuch_tags_destroy function, but there's no good reason to call
1450 * it if the message is about to be destroyed).
1453 notmuch_thread_get_tags (notmuch_thread_t *thread);
1456 * Destroy a notmuch_thread_t object.
1459 notmuch_thread_destroy (notmuch_thread_t *thread);
1462 * Is the given 'messages' iterator pointing at a valid message.
1464 * When this function returns TRUE, notmuch_messages_get will return a
1465 * valid object. Whereas when this function returns FALSE,
1466 * notmuch_messages_get will return NULL.
1468 * See the documentation of notmuch_query_search_messages for example
1469 * code showing how to iterate over a notmuch_messages_t object.
1472 notmuch_messages_valid (notmuch_messages_t *messages);
1475 * Get the current message from 'messages' as a notmuch_message_t.
1477 * Note: The returned message belongs to 'messages' and has a lifetime
1478 * identical to it (and the query to which it belongs).
1480 * See the documentation of notmuch_query_search_messages for example
1481 * code showing how to iterate over a notmuch_messages_t object.
1483 * If an out-of-memory situation occurs, this function will return
1487 notmuch_messages_get (notmuch_messages_t *messages);
1490 * Move the 'messages' iterator to the next message.
1492 * If 'messages' is already pointing at the last message then the
1493 * iterator will be moved to a point just beyond that last message,
1494 * (where notmuch_messages_valid will return FALSE and
1495 * notmuch_messages_get will return NULL).
1497 * See the documentation of notmuch_query_search_messages for example
1498 * code showing how to iterate over a notmuch_messages_t object.
1501 notmuch_messages_move_to_next (notmuch_messages_t *messages);
1504 * Destroy a notmuch_messages_t object.
1506 * It's not strictly necessary to call this function. All memory from
1507 * the notmuch_messages_t object will be reclaimed when the containing
1508 * query object is destroyed.
1511 notmuch_messages_destroy (notmuch_messages_t *messages);
1514 * Return a list of tags from all messages.
1516 * The resulting list is guaranteed not to contain duplicated tags.
1518 * WARNING: You can no longer iterate over messages after calling this
1519 * function, because the iterator will point at the end of the list.
1520 * We do not have a function to reset the iterator yet and the only
1521 * way how you can iterate over the list again is to recreate the
1524 * The function returns NULL on error.
1527 notmuch_messages_collect_tags (notmuch_messages_t *messages);
1530 * Get the database associated with this message.
1532 * @since libnotmuch 5.2 (notmuch 0.27)
1534 notmuch_database_t *
1535 notmuch_message_get_database (const notmuch_message_t *message);
1538 * Get the message ID of 'message'.
1540 * The returned string belongs to 'message' and as such, should not be
1541 * modified by the caller and will only be valid for as long as the
1542 * message is valid, (which is until the query from which it derived
1545 * This function will return NULL if triggers an unhandled Xapian
1549 notmuch_message_get_message_id (notmuch_message_t *message);
1552 * Get the thread ID of 'message'.
1554 * The returned string belongs to 'message' and as such, should not be
1555 * modified by the caller and will only be valid for as long as the
1556 * message is valid, (for example, until the user calls
1557 * notmuch_message_destroy on 'message' or until a query from which it
1558 * derived is destroyed).
1560 * This function will return NULL if triggers an unhandled Xapian
1564 notmuch_message_get_thread_id (notmuch_message_t *message);
1567 * Get a notmuch_messages_t iterator for all of the replies to
1570 * Note: This call only makes sense if 'message' was ultimately
1571 * obtained from a notmuch_thread_t object, (such as by coming
1572 * directly from the result of calling notmuch_thread_get_
1573 * toplevel_messages or by any number of subsequent
1574 * calls to notmuch_message_get_replies).
1576 * If 'message' was obtained through some non-thread means, (such as
1577 * by a call to notmuch_query_search_messages), then this function
1580 * If there are no replies to 'message', this function will return
1581 * NULL. (Note that notmuch_messages_valid will accept that NULL
1582 * value as legitimate, and simply return FALSE for it.)
1584 * This function also returns NULL if it triggers a Xapian exception.
1586 * The returned list will be destroyed when the thread is
1589 notmuch_messages_t *
1590 notmuch_message_get_replies (notmuch_message_t *message);
1593 * Get the total number of files associated with a message.
1594 * @returns Non-negative integer for file count.
1595 * @returns Negative integer for error.
1596 * @since libnotmuch 5.0 (notmuch 0.25)
1599 notmuch_message_count_files (notmuch_message_t *message);
1602 * Get a filename for the email corresponding to 'message'.
1604 * The returned filename is an absolute filename, (the initial
1605 * component will match notmuch_database_get_path() ).
1607 * The returned string belongs to the message so should not be
1608 * modified or freed by the caller (nor should it be referenced after
1609 * the message is destroyed).
1611 * Note: If this message corresponds to multiple files in the mail
1612 * store, (that is, multiple files contain identical message IDs),
1613 * this function will arbitrarily return a single one of those
1614 * filenames. See notmuch_message_get_filenames for returning the
1615 * complete list of filenames.
1617 * This function returns NULL if it triggers a Xapian exception.
1620 notmuch_message_get_filename (notmuch_message_t *message);
1623 * Get all filenames for the email corresponding to 'message'.
1625 * Returns a notmuch_filenames_t iterator listing all the filenames
1626 * associated with 'message'. These files may not have identical
1627 * content, but each will have the identical Message-ID.
1629 * Each filename in the iterator is an absolute filename, (the initial
1630 * component will match notmuch_database_get_path() ).
1632 * This function returns NULL if it triggers a Xapian exception.
1634 notmuch_filenames_t *
1635 notmuch_message_get_filenames (notmuch_message_t *message);
1638 * Re-index the e-mail corresponding to 'message' using the supplied index options
1640 * Returns the status of the re-index operation. (see the return
1641 * codes documented in notmuch_database_index_file)
1643 * After reindexing, the user should discard the message object passed
1644 * in here by calling notmuch_message_destroy, since it refers to the
1645 * original message, not to the reindexed message.
1648 notmuch_message_reindex (notmuch_message_t *message,
1649 notmuch_indexopts_t *indexopts);
1654 typedef enum _notmuch_message_flag {
1655 NOTMUCH_MESSAGE_FLAG_MATCH,
1656 NOTMUCH_MESSAGE_FLAG_EXCLUDED,
1658 /* This message is a "ghost message", meaning it has no filenames
1659 * or content, but we know it exists because it was referenced by
1660 * some other message. A ghost message has only a message ID and
1663 NOTMUCH_MESSAGE_FLAG_GHOST,
1664 } notmuch_message_flag_t;
1667 * Get a value of a flag for the email corresponding to 'message'.
1669 * returns FALSE in case of errors.
1671 * @deprecated Deprecated as of libnotmuch 5.3 (notmuch 0.31). Please
1672 * use notmuch_message_get_flag_st instead.
1674 NOTMUCH_DEPRECATED (5, 3)
1676 notmuch_message_get_flag (notmuch_message_t *message,
1677 notmuch_message_flag_t flag);
1680 * Get a value of a flag for the email corresponding to 'message'.
1682 * @param message a message object
1683 * @param flag flag to check
1684 * @param is_set pointer to boolean to store flag value.
1686 * @retval #NOTMUCH_STATUS_SUCCESS
1687 * @retval #NOTMUCH_STATUS_NULL_POINTER is_set is NULL
1688 * @retval #NOTMUCH_STATUS_XAPIAN_EXCEPTION Accessing the database
1689 * triggered an exception.
1691 * @since libnotmuch 5.3 (notmuch 0.31)
1694 notmuch_message_get_flag_st (notmuch_message_t *message,
1695 notmuch_message_flag_t flag,
1696 notmuch_bool_t *is_set);
1699 * Set a value of a flag for the email corresponding to 'message'.
1702 notmuch_message_set_flag (notmuch_message_t *message,
1703 notmuch_message_flag_t flag, notmuch_bool_t value);
1706 * Get the date of 'message' as a time_t value.
1708 * For the original textual representation of the Date header from the
1709 * message call notmuch_message_get_header() with a header value of
1712 * Returns 0 in case of error.
1715 notmuch_message_get_date (notmuch_message_t *message);
1718 * Get the value of the specified header from 'message' as a UTF-8 string.
1720 * Common headers are stored in the database when the message is
1721 * indexed and will be returned from the database. Other headers will
1722 * be read from the actual message file.
1724 * The header name is case insensitive.
1726 * The returned string belongs to the message so should not be
1727 * modified or freed by the caller (nor should it be referenced after
1728 * the message is destroyed).
1730 * Returns an empty string ("") if the message does not contain a
1731 * header line matching 'header'. Returns NULL if any error occurs.
1734 notmuch_message_get_header (notmuch_message_t *message, const char *header);
1737 * Get the tags for 'message', returning a notmuch_tags_t object which
1738 * can be used to iterate over all tags.
1740 * The tags object is owned by the message and as such, will only be
1741 * valid for as long as the message is valid, (which is until the
1742 * query from which it derived is destroyed).
1744 * Typical usage might be:
1746 * notmuch_message_t *message;
1747 * notmuch_tags_t *tags;
1750 * message = notmuch_database_find_message (database, message_id);
1752 * for (tags = notmuch_message_get_tags (message);
1753 * notmuch_tags_valid (tags);
1754 * notmuch_tags_move_to_next (tags))
1756 * tag = notmuch_tags_get (tags);
1760 * notmuch_message_destroy (message);
1762 * Note that there's no explicit destructor needed for the
1763 * notmuch_tags_t object. (For consistency, we do provide a
1764 * notmuch_tags_destroy function, but there's no good reason to call
1765 * it if the message is about to be destroyed).
1768 notmuch_message_get_tags (notmuch_message_t *message);
1771 * The longest possible tag value.
1773 #define NOTMUCH_TAG_MAX 200
1776 * Add a tag to the given message.
1780 * NOTMUCH_STATUS_SUCCESS: Tag successfully added to message
1782 * NOTMUCH_STATUS_NULL_POINTER: The 'tag' argument is NULL
1784 * NOTMUCH_STATUS_TAG_TOO_LONG: The length of 'tag' is too long
1785 * (exceeds NOTMUCH_TAG_MAX)
1787 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
1788 * mode so message cannot be modified.
1791 notmuch_message_add_tag (notmuch_message_t *message, const char *tag);
1794 * Remove a tag from the given message.
1798 * NOTMUCH_STATUS_SUCCESS: Tag successfully removed from message
1800 * NOTMUCH_STATUS_NULL_POINTER: The 'tag' argument is NULL
1802 * NOTMUCH_STATUS_TAG_TOO_LONG: The length of 'tag' is too long
1803 * (exceeds NOTMUCH_TAG_MAX)
1805 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
1806 * mode so message cannot be modified.
1809 notmuch_message_remove_tag (notmuch_message_t *message, const char *tag);
1812 * Remove all tags from the given message.
1814 * See notmuch_message_freeze for an example showing how to safely
1815 * replace tag values.
1817 * @retval #NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in
1818 * read-only mode so message cannot be modified.
1819 * @retval #NOTMUCH_STATUS_XAPIAN_EXCEPTION: an exception was thrown
1820 * accessing the database.
1823 notmuch_message_remove_all_tags (notmuch_message_t *message);
1826 * Add/remove tags according to maildir flags in the message filename(s).
1828 * This function examines the filenames of 'message' for maildir
1829 * flags, and adds or removes tags on 'message' as follows when these
1830 * flags are present:
1832 * Flag Action if present
1833 * ---- -----------------
1834 * 'D' Adds the "draft" tag to the message
1835 * 'F' Adds the "flagged" tag to the message
1836 * 'P' Adds the "passed" tag to the message
1837 * 'R' Adds the "replied" tag to the message
1838 * 'S' Removes the "unread" tag from the message
1840 * For each flag that is not present, the opposite action (add/remove)
1841 * is performed for the corresponding tags.
1843 * Flags are identified as trailing components of the filename after a
1844 * sequence of ":2,".
1846 * If there are multiple filenames associated with this message, the
1847 * flag is considered present if it appears in one or more
1848 * filenames. (That is, the flags from the multiple filenames are
1849 * combined with the logical OR operator.)
1851 * A client can ensure that notmuch database tags remain synchronized
1852 * with maildir flags by calling this function after each call to
1853 * notmuch_database_index_file. See also
1854 * notmuch_message_tags_to_maildir_flags for synchronizing tag changes
1855 * back to maildir flags.
1858 notmuch_message_maildir_flags_to_tags (notmuch_message_t *message);
1861 * return TRUE if any filename of 'message' has maildir flag 'flag',
1864 * Deprecated wrapper for notmuch_message_has_maildir_flag_st
1866 * @returns FALSE in case of error
1867 * @deprecated libnotmuch 5.3 (notmuch 0.31)
1869 NOTMUCH_DEPRECATED (5, 3)
1871 notmuch_message_has_maildir_flag (notmuch_message_t *message, char flag);
1874 * check message for maildir flag
1876 * @param [in,out] message message to check
1877 * @param [in] flag flag to check for
1878 * @param [out] is_set pointer to boolean
1880 * @retval #NOTMUCH_STATUS_SUCCESS
1881 * @retval #NOTMUCH_STATUS_NULL_POINTER is_set is NULL
1882 * @retval #NOTMUCH_STATUS_XAPIAN_EXCEPTION Accessing the database
1883 * triggered an exception.
1886 notmuch_message_has_maildir_flag_st (notmuch_message_t *message,
1888 notmuch_bool_t *is_set);
1891 * Rename message filename(s) to encode tags as maildir flags.
1893 * Specifically, for each filename corresponding to this message:
1895 * If the filename is not in a maildir directory, do nothing. (A
1896 * maildir directory is determined as a directory named "new" or
1897 * "cur".) Similarly, if the filename has invalid maildir info,
1898 * (repeated or outof-ASCII-order flag characters after ":2,"), then
1901 * If the filename is in a maildir directory, rename the file so that
1902 * its filename ends with the sequence ":2," followed by zero or more
1903 * of the following single-character flags (in ASCII order):
1905 * * flag 'D' iff the message has the "draft" tag
1906 * * flag 'F' iff the message has the "flagged" tag
1907 * * flag 'P' iff the message has the "passed" tag
1908 * * flag 'R' iff the message has the "replied" tag
1909 * * flag 'S' iff the message does not have the "unread" tag
1911 * Any existing flags unmentioned in the list above will be preserved
1914 * Also, if this filename is in a directory named "new", rename it to
1915 * be within the neighboring directory named "cur".
1917 * A client can ensure that maildir filename flags remain synchronized
1918 * with notmuch database tags by calling this function after changing
1919 * tags, (after calls to notmuch_message_add_tag,
1920 * notmuch_message_remove_tag, or notmuch_message_freeze/
1921 * notmuch_message_thaw). See also notmuch_message_maildir_flags_to_tags
1922 * for synchronizing maildir flag changes back to tags.
1925 notmuch_message_tags_to_maildir_flags (notmuch_message_t *message);
1928 * Freeze the current state of 'message' within the database.
1930 * This means that changes to the message state, (via
1931 * notmuch_message_add_tag, notmuch_message_remove_tag, and
1932 * notmuch_message_remove_all_tags), will not be committed to the
1933 * database until the message is thawed with notmuch_message_thaw.
1935 * Multiple calls to freeze/thaw are valid and these calls will
1936 * "stack". That is there must be as many calls to thaw as to freeze
1937 * before a message is actually thawed.
1939 * The ability to do freeze/thaw allows for safe transactions to
1940 * change tag values. For example, explicitly setting a message to
1941 * have a given set of tags might look like this:
1943 * notmuch_message_freeze (message);
1945 * notmuch_message_remove_all_tags (message);
1947 * for (i = 0; i < NUM_TAGS; i++)
1948 * notmuch_message_add_tag (message, tags[i]);
1950 * notmuch_message_thaw (message);
1952 * With freeze/thaw used like this, the message in the database is
1953 * guaranteed to have either the full set of original tag values, or
1954 * the full set of new tag values, but nothing in between.
1956 * Imagine the example above without freeze/thaw and the operation
1957 * somehow getting interrupted. This could result in the message being
1958 * left with no tags if the interruption happened after
1959 * notmuch_message_remove_all_tags but before notmuch_message_add_tag.
1963 * NOTMUCH_STATUS_SUCCESS: Message successfully frozen.
1965 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
1966 * mode so message cannot be modified.
1969 notmuch_message_freeze (notmuch_message_t *message);
1972 * Thaw the current 'message', synchronizing any changes that may have
1973 * occurred while 'message' was frozen into the notmuch database.
1975 * See notmuch_message_freeze for an example of how to use this
1976 * function to safely provide tag changes.
1978 * Multiple calls to freeze/thaw are valid and these calls with
1979 * "stack". That is there must be as many calls to thaw as to freeze
1980 * before a message is actually thawed.
1984 * NOTMUCH_STATUS_SUCCESS: Message successfully thawed, (or at least
1985 * its frozen count has successfully been reduced by 1).
1987 * NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW: An attempt was made to thaw
1988 * an unfrozen message. That is, there have been an unbalanced
1989 * number of calls to notmuch_message_freeze and
1990 * notmuch_message_thaw.
1993 notmuch_message_thaw (notmuch_message_t *message);
1996 * Destroy a notmuch_message_t object.
1998 * It can be useful to call this function in the case of a single
1999 * query object with many messages in the result, (such as iterating
2000 * over the entire database). Otherwise, it's fine to never call this
2001 * function and there will still be no memory leaks. (The memory from
2002 * the messages get reclaimed when the containing query is destroyed.)
2005 notmuch_message_destroy (notmuch_message_t *message);
2008 * @name Message Properties
2010 * This interface provides the ability to attach arbitrary (key,value)
2011 * string pairs to a message, to remove such pairs, and to iterate
2012 * over them. The caller should take some care as to what keys they
2013 * add or delete values for, as other subsystems or extensions may
2014 * depend on these properties.
2016 * Please see notmuch-properties(7) for more details about specific
2017 * properties and conventions around their use.
2022 * Retrieve the value for a single property key
2024 * *value* is set to a string owned by the message or NULL if there is
2025 * no such key. In the case of multiple values for the given key, the
2026 * first one is retrieved.
2029 * - NOTMUCH_STATUS_NULL_POINTER: *value* may not be NULL.
2030 * - NOTMUCH_STATUS_SUCCESS: No error occurred.
2031 * @since libnotmuch 4.4 (notmuch 0.23)
2034 notmuch_message_get_property (notmuch_message_t *message, const char *key, const char **value);
2037 * Add a (key,value) pair to a message
2040 * - NOTMUCH_STATUS_ILLEGAL_ARGUMENT: *key* may not contain an '=' character.
2041 * - NOTMUCH_STATUS_NULL_POINTER: Neither *key* nor *value* may be NULL.
2042 * - NOTMUCH_STATUS_SUCCESS: No error occurred.
2043 * @since libnotmuch 4.4 (notmuch 0.23)
2046 notmuch_message_add_property (notmuch_message_t *message, const char *key, const char *value);
2049 * Remove a (key,value) pair from a message.
2051 * It is not an error to remove a non-existent (key,value) pair
2054 * - NOTMUCH_STATUS_ILLEGAL_ARGUMENT: *key* may not contain an '=' character.
2055 * - NOTMUCH_STATUS_NULL_POINTER: Neither *key* nor *value* may be NULL.
2056 * - NOTMUCH_STATUS_SUCCESS: No error occurred.
2057 * @since libnotmuch 4.4 (notmuch 0.23)
2060 notmuch_message_remove_property (notmuch_message_t *message, const char *key, const char *value);
2063 * Remove all (key,value) pairs from the given message.
2065 * @param[in,out] message message to operate on.
2066 * @param[in] key key to delete properties for. If NULL, delete
2067 * properties for all keys
2069 * - NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in
2070 * read-only mode so message cannot be modified.
2071 * - NOTMUCH_STATUS_SUCCESS: No error occurred.
2073 * @since libnotmuch 4.4 (notmuch 0.23)
2076 notmuch_message_remove_all_properties (notmuch_message_t *message, const char *key);
2079 * Remove all (prefix*,value) pairs from the given message
2081 * @param[in,out] message message to operate on.
2082 * @param[in] prefix delete properties with keys that start with prefix.
2083 * If NULL, delete all properties
2085 * - NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in
2086 * read-only mode so message cannot be modified.
2087 * - NOTMUCH_STATUS_SUCCESS: No error occurred.
2089 * @since libnotmuch 5.1 (notmuch 0.26)
2092 notmuch_message_remove_all_properties_with_prefix (notmuch_message_t *message, const char *prefix);
2095 * Opaque message property iterator
2097 typedef struct _notmuch_string_map_iterator notmuch_message_properties_t;
2100 * Get the properties for *message*, returning a
2101 * notmuch_message_properties_t object which can be used to iterate
2102 * over all properties.
2104 * The notmuch_message_properties_t object is owned by the message and
2105 * as such, will only be valid for as long as the message is valid,
2106 * (which is until the query from which it derived is destroyed).
2108 * @param[in] message The message to examine
2109 * @param[in] key key or key prefix
2110 * @param[in] exact if TRUE, require exact match with key. Otherwise
2113 * Typical usage might be:
2115 * notmuch_message_properties_t *list;
2117 * for (list = notmuch_message_get_properties (message, "testkey1", TRUE);
2118 * notmuch_message_properties_valid (list); notmuch_message_properties_move_to_next (list)) {
2119 * printf("%s\n", notmuch_message_properties_value(list));
2122 * notmuch_message_properties_destroy (list);
2124 * Note that there's no explicit destructor needed for the
2125 * notmuch_message_properties_t object. (For consistency, we do
2126 * provide a notmuch_message_properities_destroy function, but there's
2127 * no good reason to call it if the message is about to be destroyed).
2129 * @since libnotmuch 4.4 (notmuch 0.23)
2131 notmuch_message_properties_t *
2132 notmuch_message_get_properties (notmuch_message_t *message, const char *key, notmuch_bool_t exact);
2135 * Return the number of properties named "key" belonging to the specific message.
2137 * @param[in] message The message to examine
2138 * @param[in] key key to count
2139 * @param[out] count The number of matching properties associated with this message.
2143 * NOTMUCH_STATUS_SUCCESS: successful count, possibly some other error.
2145 * @since libnotmuch 5.2 (notmuch 0.27)
2148 notmuch_message_count_properties (notmuch_message_t *message, const char *key, unsigned int *count);
2151 * Is the given *properties* iterator pointing at a valid (key,value)
2154 * When this function returns TRUE,
2155 * notmuch_message_properties_{key,value} will return a valid string,
2156 * and notmuch_message_properties_move_to_next will do what it
2157 * says. Whereas when this function returns FALSE, calling any of
2158 * these functions results in undefined behaviour.
2160 * See the documentation of notmuch_message_get_properties for example
2161 * code showing how to iterate over a notmuch_message_properties_t
2164 * @since libnotmuch 4.4 (notmuch 0.23)
2167 notmuch_message_properties_valid (notmuch_message_properties_t *properties);
2170 * Move the *properties* iterator to the next (key,value) pair
2172 * If *properties* is already pointing at the last pair then the iterator
2173 * will be moved to a point just beyond that last pair, (where
2174 * notmuch_message_properties_valid will return FALSE).
2176 * See the documentation of notmuch_message_get_properties for example
2177 * code showing how to iterate over a notmuch_message_properties_t object.
2179 * @since libnotmuch 4.4 (notmuch 0.23)
2182 notmuch_message_properties_move_to_next (notmuch_message_properties_t *properties);
2185 * Return the key from the current (key,value) pair.
2187 * this could be useful if iterating for a prefix
2189 * @since libnotmuch 4.4 (notmuch 0.23)
2192 notmuch_message_properties_key (notmuch_message_properties_t *properties);
2195 * Return the value from the current (key,value) pair.
2197 * This could be useful if iterating for a prefix.
2199 * @since libnotmuch 4.4 (notmuch 0.23)
2202 notmuch_message_properties_value (notmuch_message_properties_t *properties);
2206 * Destroy a notmuch_message_properties_t object.
2208 * It's not strictly necessary to call this function. All memory from
2209 * the notmuch_message_properties_t object will be reclaimed when the
2210 * containing message object is destroyed.
2212 * @since libnotmuch 4.4 (notmuch 0.23)
2215 notmuch_message_properties_destroy (notmuch_message_properties_t *properties);
2220 * Is the given 'tags' iterator pointing at a valid tag.
2222 * When this function returns TRUE, notmuch_tags_get will return a
2223 * valid string. Whereas when this function returns FALSE,
2224 * notmuch_tags_get will return NULL.
2226 * See the documentation of notmuch_message_get_tags for example code
2227 * showing how to iterate over a notmuch_tags_t object.
2230 notmuch_tags_valid (notmuch_tags_t *tags);
2233 * Get the current tag from 'tags' as a string.
2235 * Note: The returned string belongs to 'tags' and has a lifetime
2236 * identical to it (and the query to which it ultimately belongs).
2238 * See the documentation of notmuch_message_get_tags for example code
2239 * showing how to iterate over a notmuch_tags_t object.
2242 notmuch_tags_get (notmuch_tags_t *tags);
2245 * Move the 'tags' iterator to the next tag.
2247 * If 'tags' is already pointing at the last tag then the iterator
2248 * will be moved to a point just beyond that last tag, (where
2249 * notmuch_tags_valid will return FALSE and notmuch_tags_get will
2252 * See the documentation of notmuch_message_get_tags for example code
2253 * showing how to iterate over a notmuch_tags_t object.
2256 notmuch_tags_move_to_next (notmuch_tags_t *tags);
2259 * Destroy a notmuch_tags_t object.
2261 * It's not strictly necessary to call this function. All memory from
2262 * the notmuch_tags_t object will be reclaimed when the containing
2263 * message or query objects are destroyed.
2266 notmuch_tags_destroy (notmuch_tags_t *tags);
2269 * Store an mtime within the database for 'directory'.
2271 * The 'directory' should be an object retrieved from the database
2272 * with notmuch_database_get_directory for a particular path.
2274 * The intention is for the caller to use the mtime to allow efficient
2275 * identification of new messages to be added to the database. The
2276 * recommended usage is as follows:
2278 * o Read the mtime of a directory from the filesystem
2280 * o Call index_file for all mail files in the directory
2282 * o Call notmuch_directory_set_mtime with the mtime read from the
2285 * Then, when wanting to check for updates to the directory in the
2286 * future, the client can call notmuch_directory_get_mtime and know
2287 * that it only needs to add files if the mtime of the directory and
2288 * files are newer than the stored timestamp.
2290 * Note: The notmuch_directory_get_mtime function does not allow the
2291 * caller to distinguish a timestamp of 0 from a non-existent
2292 * timestamp. So don't store a timestamp of 0 unless you are
2293 * comfortable with that.
2297 * NOTMUCH_STATUS_SUCCESS: mtime successfully stored in database.
2299 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception
2300 * occurred, mtime not stored.
2302 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
2303 * mode so directory mtime cannot be modified.
2306 notmuch_directory_set_mtime (notmuch_directory_t *directory,
2310 * Get the mtime of a directory, (as previously stored with
2311 * notmuch_directory_set_mtime).
2313 * Returns 0 if no mtime has previously been stored for this
2317 notmuch_directory_get_mtime (notmuch_directory_t *directory);
2320 * Get a notmuch_filenames_t iterator listing all the filenames of
2321 * messages in the database within the given directory.
2323 * The returned filenames will be the basename-entries only (not
2326 * Returns NULL if it triggers a Xapian exception
2328 notmuch_filenames_t *
2329 notmuch_directory_get_child_files (notmuch_directory_t *directory);
2332 * Get a notmuch_filenames_t iterator listing all the filenames of
2333 * sub-directories in the database within the given directory.
2335 * The returned filenames will be the basename-entries only (not
2338 * Returns NULL if it triggers a Xapian exception
2340 notmuch_filenames_t *
2341 notmuch_directory_get_child_directories (notmuch_directory_t *directory);
2344 * Delete directory document from the database, and destroy the
2345 * notmuch_directory_t object. Assumes any child directories and files
2346 * have been deleted by the caller.
2348 * @since libnotmuch 4.3 (notmuch 0.21)
2351 notmuch_directory_delete (notmuch_directory_t *directory);
2354 * Destroy a notmuch_directory_t object.
2357 notmuch_directory_destroy (notmuch_directory_t *directory);
2360 * Is the given 'filenames' iterator pointing at a valid filename.
2362 * When this function returns TRUE, notmuch_filenames_get will return
2363 * a valid string. Whereas when this function returns FALSE,
2364 * notmuch_filenames_get will return NULL.
2366 * It is acceptable to pass NULL for 'filenames', in which case this
2367 * function will always return FALSE.
2370 notmuch_filenames_valid (notmuch_filenames_t *filenames);
2373 * Get the current filename from 'filenames' as a string.
2375 * Note: The returned string belongs to 'filenames' and has a lifetime
2376 * identical to it (and the directory to which it ultimately belongs).
2378 * It is acceptable to pass NULL for 'filenames', in which case this
2379 * function will always return NULL.
2382 notmuch_filenames_get (notmuch_filenames_t *filenames);
2385 * Move the 'filenames' iterator to the next filename.
2387 * If 'filenames' is already pointing at the last filename then the
2388 * iterator will be moved to a point just beyond that last filename,
2389 * (where notmuch_filenames_valid will return FALSE and
2390 * notmuch_filenames_get will return NULL).
2392 * It is acceptable to pass NULL for 'filenames', in which case this
2393 * function will do nothing.
2396 notmuch_filenames_move_to_next (notmuch_filenames_t *filenames);
2399 * Destroy a notmuch_filenames_t object.
2401 * It's not strictly necessary to call this function. All memory from
2402 * the notmuch_filenames_t object will be reclaimed when the
2403 * containing directory object is destroyed.
2405 * It is acceptable to pass NULL for 'filenames', in which case this
2406 * function will do nothing.
2409 notmuch_filenames_destroy (notmuch_filenames_t *filenames);
2413 * set config 'key' to 'value'
2415 * @since libnotmuch 4.4 (notmuch 0.23)
2416 * @retval #NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in
2417 * read-only mode so message cannot be modified.
2418 * @retval #NOTMUCH_STATUS_XAPIAN_EXCEPTION: an exception was thrown
2419 * accessing the database.
2420 * @retval #NOTMUCH_STATUS_SUCCESS
2423 notmuch_database_set_config (notmuch_database_t *db, const char *key, const char *value);
2426 * retrieve config item 'key', assign to 'value'
2428 * keys which have not been previously set with n_d_set_config will
2429 * return an empty string.
2431 * return value is allocated by malloc and should be freed by the
2434 * @since libnotmuch 4.4 (notmuch 0.23)
2438 notmuch_database_get_config (notmuch_database_t *db, const char *key, char **value);
2441 * Create an iterator for all config items with keys matching a given prefix
2443 * @since libnotmuch 4.4 (notmuch 0.23)
2446 notmuch_database_get_config_list (notmuch_database_t *db, const char *prefix,
2447 notmuch_config_list_t **out);
2450 * Is 'config_list' iterator valid (i.e. _key, _value, _move_to_next can be called).
2452 * @since libnotmuch 4.4 (notmuch 0.23)
2455 notmuch_config_list_valid (notmuch_config_list_t *config_list);
2458 * return key for current config pair
2460 * return value is owned by the iterator, and will be destroyed by the
2461 * next call to notmuch_config_list_key or notmuch_config_list_destroy.
2463 * @since libnotmuch 4.4 (notmuch 0.23)
2466 notmuch_config_list_key (notmuch_config_list_t *config_list);
2469 * return 'value' for current config pair
2471 * return value is owned by the iterator, and will be destroyed by the
2472 * next call to notmuch_config_list_value or notmuch config_list_destroy
2474 * @since libnotmuch 4.4 (notmuch 0.23)
2475 * @retval NULL for errors
2478 notmuch_config_list_value (notmuch_config_list_t *config_list);
2482 * move 'config_list' iterator to the next pair
2484 * @since libnotmuch 4.4 (notmuch 0.23)
2487 notmuch_config_list_move_to_next (notmuch_config_list_t *config_list);
2490 * free any resources held by 'config_list'
2492 * @since libnotmuch 4.4 (notmuch 0.23)
2495 notmuch_config_list_destroy (notmuch_config_list_t *config_list);
2499 * Configuration keys known to libnotmuch
2501 typedef enum _notmuch_config_key {
2502 NOTMUCH_CONFIG_FIRST,
2503 NOTMUCH_CONFIG_DATABASE_PATH = NOTMUCH_CONFIG_FIRST,
2504 NOTMUCH_CONFIG_MAIL_ROOT,
2505 NOTMUCH_CONFIG_HOOK_DIR,
2506 NOTMUCH_CONFIG_BACKUP_DIR,
2507 NOTMUCH_CONFIG_EXCLUDE_TAGS,
2508 NOTMUCH_CONFIG_NEW_TAGS,
2509 NOTMUCH_CONFIG_NEW_IGNORE,
2510 NOTMUCH_CONFIG_SYNC_MAILDIR_FLAGS,
2511 NOTMUCH_CONFIG_PRIMARY_EMAIL,
2512 NOTMUCH_CONFIG_OTHER_EMAIL,
2513 NOTMUCH_CONFIG_USER_NAME,
2515 } notmuch_config_key_t;
2518 * get a configuration value from an open database.
2520 * This value reflects all configuration information given at the time
2521 * the database was opened.
2523 * @param[in] notmuch database
2524 * @param[in] key configuration key
2526 * @since libnotmuch 5.4 (notmuch 0.32)
2528 * @retval NULL if 'key' unknown or if no value is known for
2529 * 'key'. Otherwise returns a string owned by notmuch which should
2530 * not be modified nor freed by the caller.
2533 notmuch_config_get (notmuch_database_t *notmuch, notmuch_config_key_t key);
2536 * set a configuration value from in an open database.
2538 * This value reflects all configuration information given at the time
2539 * the database was opened.
2541 * @param[in,out] notmuch database open read/write
2542 * @param[in] key configuration key
2543 * @param[in] val configuration value
2545 * @since libnotmuch 5.4 (notmuch 0.32)
2547 * @retval returns any return value for notmuch_database_set_config.
2550 notmuch_config_set (notmuch_database_t *notmuch, notmuch_config_key_t key, const char *val);
2553 * Returns an iterator for a ';'-delimited list of configuration values
2555 * These values reflect all configuration information given at the
2556 * time the database was opened.
2558 * @param[in] notmuch database
2559 * @param[in] key configuration key
2561 * @since libnotmuch 5.4 (notmuch 0.32)
2563 * @retval NULL in case of error.
2565 notmuch_config_values_t *
2566 notmuch_config_get_values (notmuch_database_t *notmuch, notmuch_config_key_t key);
2569 * Is the given 'config_values' iterator pointing at a valid element.
2571 * @param[in] values iterator
2573 * @since libnotmuch 5.4 (notmuch 0.32)
2575 * @retval FALSE if passed a NULL pointer, or the iterator is exhausted.
2579 notmuch_config_values_valid (notmuch_config_values_t *values);
2582 * Get the current value from the 'values' iterator
2584 * @param[in] values iterator
2586 * @since libnotmuch 5.4 (notmuch 0.32)
2588 * @retval a string with the same lifetime as the iterator
2591 notmuch_config_values_get (notmuch_config_values_t *values);
2594 * Move the 'values' iterator to the next element
2596 * @param[in,out] values iterator
2598 * @since libnotmuch 5.4 (notmuch 0.32)
2602 notmuch_config_values_move_to_next (notmuch_config_values_t *values);
2606 * reset the 'values' iterator to the first element
2608 * @param[in,out] values iterator. A NULL value is ignored.
2610 * @since libnotmuch 5.4 (notmuch 0.32)
2614 notmuch_config_values_start (notmuch_config_values_t *values);
2617 * Destroy a config values iterator, along with any associated
2620 * @param[in,out] values iterator
2622 * @since libnotmuch 5.4 (notmuch 0.32)
2625 notmuch_config_values_destroy (notmuch_config_values_t *values);
2628 * get a configuration value from an open database as Boolean
2630 * This value reflects all configuration information given at the time
2631 * the database was opened.
2633 * @param[in] notmuch database
2634 * @param[in] key configuration key
2635 * @param[out] val configuration value, converted to Boolean
2637 * @since libnotmuch 5.4 (notmuch 0.32)
2639 * @retval #NOTMUCH_STATUS_ILLEGAL_ARGUMENT if either key is unknown
2640 * or the corresponding value does not convert to Boolean.
2643 notmuch_config_get_bool (notmuch_database_t *notmuch,
2644 notmuch_config_key_t key,
2645 notmuch_bool_t *val);
2647 * get the current default indexing options for a given database.
2649 * This object will survive until the database itself is destroyed,
2650 * but the caller may also release it earlier with
2651 * notmuch_indexopts_destroy.
2653 * This object represents a set of options on how a message can be
2654 * added to the index. At the moment it is a featureless stub.
2656 * @since libnotmuch 5.1 (notmuch 0.26)
2657 * @retval NULL in case of error
2659 notmuch_indexopts_t *
2660 notmuch_database_get_default_indexopts (notmuch_database_t *db);
2663 * Stating a policy about how to decrypt messages.
2665 * See index.decrypt in notmuch-config(1) for more details.
2668 NOTMUCH_DECRYPT_FALSE,
2669 NOTMUCH_DECRYPT_TRUE,
2670 NOTMUCH_DECRYPT_AUTO,
2671 NOTMUCH_DECRYPT_NOSTASH,
2672 } notmuch_decryption_policy_t;
2675 * Specify whether to decrypt encrypted parts while indexing.
2677 * Be aware that the index is likely sufficient to reconstruct the
2678 * cleartext of the message itself, so please ensure that the notmuch
2679 * message index is adequately protected. DO NOT SET THIS FLAG TO TRUE
2680 * without considering the security of your index.
2682 * @since libnotmuch 5.1 (notmuch 0.26)
2685 notmuch_indexopts_set_decrypt_policy (notmuch_indexopts_t *indexopts,
2686 notmuch_decryption_policy_t decrypt_policy);
2689 * Return whether to decrypt encrypted parts while indexing.
2690 * see notmuch_indexopts_set_decrypt_policy.
2692 * @since libnotmuch 5.1 (notmuch 0.26)
2694 notmuch_decryption_policy_t
2695 notmuch_indexopts_get_decrypt_policy (const notmuch_indexopts_t *indexopts);
2698 * Destroy a notmuch_indexopts_t object.
2700 * @since libnotmuch 5.1 (notmuch 0.26)
2703 notmuch_indexopts_destroy (notmuch_indexopts_t *options);
2707 * interrogate the library for compile time features
2709 * @since libnotmuch 4.4 (notmuch 0.23)
2712 notmuch_built_with (const char *name);
2715 #pragma GCC visibility pop