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 5
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 * Unable to load a database
218 NOTMUCH_STATUS_NO_DATABASE,
220 * Database exists, so not (re)-created
222 NOTMUCH_STATUS_DATABASE_EXISTS,
224 * Syntax error in query
226 NOTMUCH_STATUS_BAD_QUERY_SYNTAX,
228 * Not an actual status value. Just a way to find out how many
229 * valid status values there are.
231 NOTMUCH_STATUS_LAST_STATUS
235 * Get a string representation of a notmuch_status_t value.
237 * The result is read-only.
240 notmuch_status_to_string (notmuch_status_t status);
242 /* Various opaque data types. For each notmuch_<foo>_t see the various
243 * notmuch_<foo> functions below. */
245 typedef struct _notmuch_database notmuch_database_t;
246 typedef struct _notmuch_query notmuch_query_t;
247 typedef struct _notmuch_threads notmuch_threads_t;
248 typedef struct _notmuch_thread notmuch_thread_t;
249 typedef struct _notmuch_messages notmuch_messages_t;
250 typedef struct _notmuch_message notmuch_message_t;
251 typedef struct _notmuch_tags notmuch_tags_t;
252 typedef struct _notmuch_directory notmuch_directory_t;
253 typedef struct _notmuch_filenames notmuch_filenames_t;
254 typedef struct _notmuch_config_list notmuch_config_list_t;
255 typedef struct _notmuch_config_values notmuch_config_values_t;
256 typedef struct _notmuch_config_pairs notmuch_config_pairs_t;
257 typedef struct _notmuch_indexopts notmuch_indexopts_t;
258 #endif /* __DOXYGEN__ */
261 * Create a new, empty notmuch database located at 'path'.
263 * The path should be a top-level directory to a collection of
264 * plain-text email messages (one message per file). This call will
265 * create a new ".notmuch" directory within 'path' where notmuch will
268 * After a successful call to notmuch_database_create, the returned
269 * database will be open so the caller should call
270 * notmuch_database_destroy when finished with it.
272 * The database will not yet have any data in it
273 * (notmuch_database_create itself is a very cheap function). Messages
274 * contained within 'path' can be added to the database by calling
275 * notmuch_database_index_file.
277 * In case of any failure, this function returns an error status and
278 * sets *database to NULL (after printing an error message on stderr).
282 * NOTMUCH_STATUS_SUCCESS: Successfully created the database.
284 * NOTMUCH_STATUS_NULL_POINTER: The given 'path' argument is NULL.
286 * NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory.
288 * NOTMUCH_STATUS_FILE_ERROR: An error occurred trying to create the
289 * database file (such as permission denied, or file not found,
290 * etc.), or the database already exists.
292 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred.
295 notmuch_database_create (const char *path, notmuch_database_t **database);
298 * Like notmuch_database_create, except optionally return an error
299 * message. This message is allocated by malloc and should be freed by
303 notmuch_database_create_verbose (const char *path,
304 notmuch_database_t **database,
305 char **error_message);
308 * Database open mode for notmuch_database_open.
312 * Open database for reading only.
314 NOTMUCH_DATABASE_MODE_READ_ONLY = 0,
316 * Open database for reading and writing.
318 NOTMUCH_DATABASE_MODE_READ_WRITE
319 } notmuch_database_mode_t;
322 * Deprecated alias for notmuch_database_open_with_config with
323 * config_path="" and error_message=NULL
324 * @deprecated Deprecated as of libnotmuch 5.4 (notmuch 0.32)
326 /* NOTMUCH_DEPRECATED(5, 4) */
328 notmuch_database_open (const char *path,
329 notmuch_database_mode_t mode,
330 notmuch_database_t **database);
332 * Deprecated alias for notmuch_database_open_with_config with
335 * @deprecated Deprecated as of libnotmuch 5.4 (notmuch 0.32)
338 /* NOTMUCH_DEPRECATED(5, 4) */
340 notmuch_database_open_verbose (const char *path,
341 notmuch_database_mode_t mode,
342 notmuch_database_t **database,
343 char **error_message);
346 * Open an existing notmuch database located at 'database_path', using
347 * configuration in 'config_path'.
349 * @param[in] database_path
351 * Path to existing database.
353 * A notmuch database is a Xapian database containing appropriate
356 * The database should have been created at some time in the past,
357 * (not necessarily by this process), by calling
358 * notmuch_database_create.
360 * If 'database_path' is NULL, use the location specified
362 * - in the environment variable NOTMUCH_DATABASE, if non-empty
364 * - in a configuration file, located as described under 'config_path'
366 * - by $XDG_DATA_HOME/notmuch/$PROFILE where XDG_DATA_HOME defaults
367 * to "$HOME/.local/share" and PROFILE as as discussed in
370 * If 'database_path' is non-NULL, but does not appear to be a Xapian
371 * database, check for a directory '.notmuch/xapian' below
372 * 'database_path' (this is the behavior of
373 * notmuch_database_open_verbose pre-0.32).
378 * Mode to open database. Use one of #NOTMUCH_DATABASE_MODE_READ_WRITE
379 * or #NOTMUCH_DATABASE_MODE_READ_ONLY
382 * @param[in] config_path
384 * Path to config file.
386 * Config file is key-value, with mandatory sections. See
387 * <em>notmuch-config(5)</em> for more information. The key-value pair
388 * overrides the corresponding configuration data stored in the
389 * database (see <em>notmuch_database_get_config</em>)
391 * If <em>config_path</em> is NULL use the path specified
393 * - in environment variable <em>NOTMUCH_CONFIG</em>, if non-empty
395 * - by <em>XDG_CONFIG_HOME</em>/notmuch/ where
396 * XDG_CONFIG_HOME defaults to "$HOME/.config".
398 * - by $HOME/.notmuch-config
400 * If <em>config_path</em> is "" (empty string) then do not
401 * open any configuration file.
403 * @param[in] profile:
405 * Name of profile (configuration/database variant).
407 * If non-NULL, append to the directory / file path determined for
408 * <em>config_path</em> and <em>database_path</em>.
411 * - environment variable NOTMUCH_PROFILE if defined,
412 * - otherwise "default" for directories and "" (empty string) for paths.
415 * @param[out] database
417 * Pointer to database object. May not be NULL.
419 * The caller should call notmuch_database_destroy when finished with
422 * In case of any failure, this function returns an error status and
423 * sets *database to NULL.
426 * @param[out] error_message
427 * If non-NULL, store error message from opening the database.
428 * Any such message is allocated by \a malloc(3) and should be freed
431 * @retval NOTMUCH_STATUS_SUCCESS: Successfully opened the database.
433 * @retval NOTMUCH_STATUS_NULL_POINTER: The given \a database
436 * @retval NOTMUCH_STATUS_NO_CONFIG: No config file was found. Fatal.
438 * @retval NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory.
440 * @retval NOTMUCH_STATUS_FILE_ERROR: An error occurred trying to open the
441 * database or config file (such as permission denied, or file not found,
442 * etc.), or the database version is unknown.
444 * @retval NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred.
446 * @since libnotmuch 5.4 (notmuch 0.32)
450 notmuch_database_open_with_config (const char *database_path,
451 notmuch_database_mode_t mode,
452 const char *config_path,
454 notmuch_database_t **database,
455 char **error_message);
459 * Loads configuration from config file, database, and/or defaults
461 * For description of arguments, @see notmuch_database_open_with_config
463 * @retval NOTMUCH_STATUS_SUCCESS: Successfully loaded configuration.
465 * @retval NOTMUCH_STATUS_NO_CONFIG: No config file was loaded. Not fatal.
467 * @retval NOTMUCH_STATUS_NO_DATABASE: No config information was
468 * loaded from a database. Not fatal.
470 * @retval NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory.
472 * @retval NOTMUCH_STATUS_FILE_ERROR: An error occurred trying to open the
473 * database or config file (such as permission denied, or file not found,
476 * @retval NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred.
478 * @since libnotmuch 5.4 (notmuch 0.32)
482 notmuch_database_load_config (const char *database_path,
483 const char *config_path,
485 notmuch_database_t **database,
486 char **error_message);
489 * Create a new notmuch database located at 'database_path', using
490 * configuration in 'config_path'.
492 * For description of arguments, @see notmuch_database_open_with_config
494 * @retval NOTMUCH_STATUS_SUCCESS: Successfully created the database.
496 * @retval NOTMUCH_STATUS_DATABASE_EXISTS: Database already exists, not created
498 * @retval NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory.
500 * @retval NOTMUCH_STATUS_FILE_ERROR: An error occurred trying to open the
501 * database or config file (such as permission denied, or file not found,
504 * @retval NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred.
506 * @since libnotmuch 5.4 (notmuch 0.32)
510 notmuch_database_create_with_config (const char *database_path,
511 const char *config_path,
513 notmuch_database_t **database,
514 char **error_message);
517 * Retrieve last status string for given database.
521 notmuch_database_status_string (const notmuch_database_t *notmuch);
524 * Commit changes and close the given notmuch database.
526 * After notmuch_database_close has been called, calls to other
527 * functions on objects derived from this database may either behave
528 * as if the database had not been closed (e.g., if the required data
529 * has been cached) or may fail with a
530 * NOTMUCH_STATUS_XAPIAN_EXCEPTION. The only further operation
531 * permitted on the database itself is to call
532 * notmuch_database_destroy.
534 * notmuch_database_close can be called multiple times. Later calls
537 * For writable databases, notmuch_database_close commits all changes
538 * to disk before closing the database, unless the caller is currently
539 * in an atomic section (there was a notmuch_database_begin_atomic
540 * without a matching notmuch_database_end_atomic). In this case
541 * changes since the last commit are discarded. @see
542 * notmuch_database_end_atomic for more information.
546 * NOTMUCH_STATUS_SUCCESS: Successfully closed the database.
548 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred; the
549 * database has been closed but there are no guarantees the
550 * changes to the database, if any, have been flushed to disk.
553 notmuch_database_close (notmuch_database_t *database);
556 * A callback invoked by notmuch_database_compact to notify the user
557 * of the progress of the compaction process.
559 typedef void (*notmuch_compact_status_cb_t)(const char *message, void *closure);
562 * Compact a notmuch database, backing up the original database to the
565 * The database will be opened with NOTMUCH_DATABASE_MODE_READ_WRITE
566 * during the compaction process to ensure no writes are made.
568 * If the optional callback function 'status_cb' is non-NULL, it will
569 * be called with diagnostic and informational messages. The argument
570 * 'closure' is passed verbatim to any callback invoked.
573 notmuch_database_compact (const char *path,
574 const char *backup_path,
575 notmuch_compact_status_cb_t status_cb,
579 * Like notmuch_database_compact, but take an open database as a
582 * @since libnnotmuch 5.4 (notmuch 0.32)
585 notmuch_database_compact_db (notmuch_database_t *database,
586 const char *backup_path,
587 notmuch_compact_status_cb_t status_cb,
591 * Destroy the notmuch database, closing it if necessary and freeing
592 * all associated resources.
594 * Return value as in notmuch_database_close if the database was open;
595 * notmuch_database_destroy itself has no failure modes.
598 notmuch_database_destroy (notmuch_database_t *database);
601 * Return the database path of the given database.
603 * The return value is a string owned by notmuch so should not be
604 * modified nor freed by the caller.
607 notmuch_database_get_path (notmuch_database_t *database);
610 * Return the database format version of the given database.
615 notmuch_database_get_version (notmuch_database_t *database);
618 * Can the database be upgraded to a newer database version?
620 * If this function returns TRUE, then the caller may call
621 * notmuch_database_upgrade to upgrade the database. If the caller
622 * does not upgrade an out-of-date database, then some functions may
623 * fail with NOTMUCH_STATUS_UPGRADE_REQUIRED. This always returns
624 * FALSE for a read-only database because there's no way to upgrade a
625 * read-only database.
627 * Also returns FALSE if an error occurs accessing the database.
631 notmuch_database_needs_upgrade (notmuch_database_t *database);
634 * Upgrade the current database to the latest supported version.
636 * This ensures that all current notmuch functionality will be
637 * available on the database. After opening a database in read-write
638 * mode, it is recommended that clients check if an upgrade is needed
639 * (notmuch_database_needs_upgrade) and if so, upgrade with this
640 * function before making any modifications. If
641 * notmuch_database_needs_upgrade returns FALSE, this will be a no-op.
643 * The optional progress_notify callback can be used by the caller to
644 * provide progress indication to the user. If non-NULL it will be
645 * called periodically with 'progress' as a floating-point value in
646 * the range of [0.0 .. 1.0] indicating the progress made so far in
647 * the upgrade process. The argument 'closure' is passed verbatim to
648 * any callback invoked.
651 notmuch_database_upgrade (notmuch_database_t *database,
652 void (*progress_notify)(void *closure,
657 * Begin an atomic database operation.
659 * Any modifications performed between a successful begin and a
660 * notmuch_database_end_atomic will be applied to the database
661 * atomically. Note that, unlike a typical database transaction, this
662 * only ensures atomicity, not durability; neither begin nor end
663 * necessarily flush modifications to disk.
665 * Atomic sections may be nested. begin_atomic and end_atomic must
666 * always be called in pairs.
670 * NOTMUCH_STATUS_SUCCESS: Successfully entered atomic section.
672 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred;
673 * atomic section not entered.
676 notmuch_database_begin_atomic (notmuch_database_t *notmuch);
679 * Indicate the end of an atomic database operation. If repeated
680 * (with matching notmuch_database_begin_atomic) "database.autocommit"
681 * times, commit the the transaction and all previous (non-cancelled)
682 * transactions to the database.
686 * NOTMUCH_STATUS_SUCCESS: Successfully completed atomic section.
688 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred;
689 * atomic section not ended.
691 * NOTMUCH_STATUS_UNBALANCED_ATOMIC: The database is not currently in
695 notmuch_database_end_atomic (notmuch_database_t *notmuch);
698 * Return the committed database revision and UUID.
700 * The database revision number increases monotonically with each
701 * commit to the database. Hence, all messages and message changes
702 * committed to the database (that is, visible to readers) have a last
703 * modification revision <= the committed database revision. Any
704 * messages committed in the future will be assigned a modification
705 * revision > the committed database revision.
707 * The UUID is a NUL-terminated opaque string that uniquely identifies
708 * this database. Two revision numbers are only comparable if they
709 * have the same database UUID.
712 notmuch_database_get_revision (notmuch_database_t *notmuch,
716 * Retrieve a directory object from the database for 'path'.
718 * Here, 'path' should be a path relative to the path of 'database'
719 * (see notmuch_database_get_path), or else should be an absolute path
720 * with initial components that match the path of 'database'.
722 * If this directory object does not exist in the database, this
723 * returns NOTMUCH_STATUS_SUCCESS and sets *directory to NULL.
725 * Otherwise the returned directory object is owned by the database
726 * and as such, will only be valid until notmuch_database_destroy is
731 * NOTMUCH_STATUS_SUCCESS: Successfully retrieved directory.
733 * NOTMUCH_STATUS_NULL_POINTER: The given 'directory' argument is NULL.
735 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred;
736 * directory not retrieved.
738 * NOTMUCH_STATUS_UPGRADE_REQUIRED: The caller must upgrade the
739 * database to use this function.
742 notmuch_database_get_directory (notmuch_database_t *database,
744 notmuch_directory_t **directory);
747 * Add a message file to a database, indexing it for retrieval by
748 * future searches. If a message already exists with the same message
749 * ID as the specified file, their indexes will be merged, and this
750 * new filename will also be associated with the existing message.
752 * Here, 'filename' should be a path relative to the path of
753 * 'database' (see notmuch_database_get_path), or else should be an
754 * absolute filename with initial components that match the path of
757 * The file should be a single mail message (not a multi-message mbox)
758 * that is expected to remain at its current location, (since the
759 * notmuch database will reference the filename, and will not copy the
760 * entire contents of the file.
762 * If another message with the same message ID already exists in the
763 * database, rather than creating a new message, this adds the search
764 * terms from the identified file to the existing message's index, and
765 * adds 'filename' to the list of filenames known for the message.
767 * The 'indexopts' parameter can be NULL (meaning, use the indexing
768 * defaults from the database), or can be an explicit choice of
769 * indexing options that should govern the indexing of this specific
772 * If 'message' is not NULL, then, on successful return
773 * (NOTMUCH_STATUS_SUCCESS or NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID) '*message'
774 * will be initialized to a message object that can be used for things
775 * such as adding tags to the just-added message. The user should call
776 * notmuch_message_destroy when done with the message. On any failure
777 * '*message' will be set to NULL.
781 * NOTMUCH_STATUS_SUCCESS: Message successfully added to database.
783 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred,
786 * NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID: Message has the same message
787 * ID as another message already in the database. The new
788 * filename was successfully added to the message in the database
789 * (if not already present) and the existing message is returned.
791 * NOTMUCH_STATUS_FILE_ERROR: an error occurred trying to open the
792 * file, (such as permission denied, or file not found,
793 * etc.). Nothing added to the database.
795 * NOTMUCH_STATUS_FILE_NOT_EMAIL: the contents of filename don't look
796 * like an email message. Nothing added to the database.
798 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
799 * mode so no message can be added.
801 * NOTMUCH_STATUS_UPGRADE_REQUIRED: The caller must upgrade the
802 * database to use this function.
804 * @since libnotmuch 5.1 (notmuch 0.26)
807 notmuch_database_index_file (notmuch_database_t *database,
808 const char *filename,
809 notmuch_indexopts_t *indexopts,
810 notmuch_message_t **message);
813 * Deprecated alias for notmuch_database_index_file called with
816 * @deprecated Deprecated as of libnotmuch 5.1 (notmuch 0.26). Please
817 * use notmuch_database_index_file instead.
820 NOTMUCH_DEPRECATED (5, 1)
822 notmuch_database_add_message (notmuch_database_t *database,
823 const char *filename,
824 notmuch_message_t **message);
827 * Remove a message filename from the given notmuch database. If the
828 * message has no more filenames, remove the message.
830 * If the same message (as determined by the message ID) is still
831 * available via other filenames, then the message will persist in the
832 * database for those filenames. When the last filename is removed for
833 * a particular message, the database content for that message will be
838 * NOTMUCH_STATUS_SUCCESS: The last filename was removed and the
839 * message was removed from the database.
841 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred,
842 * message not removed.
844 * NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID: This filename was removed but
845 * the message persists in the database with at least one other
848 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
849 * mode so no message can be removed.
851 * NOTMUCH_STATUS_UPGRADE_REQUIRED: The caller must upgrade the
852 * database to use this function.
855 notmuch_database_remove_message (notmuch_database_t *database,
856 const char *filename);
859 * Find a message with the given message_id.
861 * If a message with the given message_id is found then, on successful return
862 * (NOTMUCH_STATUS_SUCCESS) '*message' will be initialized to a message
863 * object. The caller should call notmuch_message_destroy when done with the
866 * On any failure or when the message is not found, this function initializes
867 * '*message' to NULL. This means, when NOTMUCH_STATUS_SUCCESS is returned, the
868 * caller is supposed to check '*message' for NULL to find out whether the
869 * message with the given message_id was found.
873 * NOTMUCH_STATUS_SUCCESS: Successful return, check '*message'.
875 * NOTMUCH_STATUS_NULL_POINTER: The given 'message' argument is NULL
877 * NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory, creating message object
879 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred
882 notmuch_database_find_message (notmuch_database_t *database,
883 const char *message_id,
884 notmuch_message_t **message);
887 * Find a message with the given filename.
889 * If the database contains a message with the given filename then, on
890 * successful return (NOTMUCH_STATUS_SUCCESS) '*message' will be initialized to
891 * a message object. The caller should call notmuch_message_destroy when done
894 * On any failure or when the message is not found, this function initializes
895 * '*message' to NULL. This means, when NOTMUCH_STATUS_SUCCESS is returned, the
896 * caller is supposed to check '*message' for NULL to find out whether the
897 * message with the given filename is found.
901 * NOTMUCH_STATUS_SUCCESS: Successful return, check '*message'
903 * NOTMUCH_STATUS_NULL_POINTER: The given 'message' argument is NULL
905 * NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory, creating the message object
907 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred
909 * NOTMUCH_STATUS_UPGRADE_REQUIRED: The caller must upgrade the
910 * database to use this function.
913 notmuch_database_find_message_by_filename (notmuch_database_t *notmuch,
914 const char *filename,
915 notmuch_message_t **message);
918 * Return a list of all tags found in the database.
920 * This function creates a list of all tags found in the database. The
921 * resulting list contains all tags from all messages found in the database.
923 * On error this function returns NULL.
926 notmuch_database_get_all_tags (notmuch_database_t *db);
929 * Reopen an open notmuch database.
931 * @param [in] db open notmuch database
932 * @param [in] mode mode (read only or read-write) for reopened database.
934 * @retval #NOTMUCH_STATUS_SUCCESS
935 * @retval #NOTMUCH_STATUS_ILLEGAL_ARGUMENT The passed database was not open.
936 * @retval #NOTMUCH_STATUS_XAPIAN_EXCEPTION A Xapian exception occured
939 notmuch_database_reopen (notmuch_database_t *db, notmuch_database_mode_t mode);
942 * Create a new query for 'database'.
944 * Here, 'database' should be an open database, (see
945 * notmuch_database_open and notmuch_database_create).
947 * For the query string, we'll document the syntax here more
948 * completely in the future, but it's likely to be a specialized
949 * version of the general Xapian query syntax:
951 * https://xapian.org/docs/queryparser.html
953 * As a special case, passing either a length-zero string, (that is ""),
954 * or a string consisting of a single asterisk (that is "*"), will
955 * result in a query that returns all messages in the database.
957 * See notmuch_query_set_sort for controlling the order of results.
958 * See notmuch_query_search_messages and notmuch_query_search_threads
959 * to actually execute the query.
961 * User should call notmuch_query_destroy when finished with this
964 * Will return NULL if insufficient memory is available.
967 notmuch_query_create (notmuch_database_t *database,
968 const char *query_string);
971 NOTMUCH_QUERY_SYNTAX_XAPIAN,
972 NOTMUCH_QUERY_SYNTAX_SEXP
973 } notmuch_query_syntax_t;
976 notmuch_query_create_with_syntax (notmuch_database_t *database,
977 const char *query_string,
978 notmuch_query_syntax_t syntax,
979 notmuch_query_t **output);
981 * Sort values for notmuch_query_set_sort.
987 NOTMUCH_SORT_OLDEST_FIRST,
991 NOTMUCH_SORT_NEWEST_FIRST,
993 * Sort by message-id.
995 NOTMUCH_SORT_MESSAGE_ID,
999 NOTMUCH_SORT_UNSORTED
1003 * Return the query_string of this query. See notmuch_query_create.
1006 notmuch_query_get_query_string (const notmuch_query_t *query);
1009 * Return the notmuch database of this query. See notmuch_query_create.
1011 notmuch_database_t *
1012 notmuch_query_get_database (const notmuch_query_t *query);
1015 * Exclude values for notmuch_query_set_omit_excluded. The strange
1016 * order is to maintain backward compatibility: the old FALSE/TRUE
1017 * options correspond to the new
1018 * NOTMUCH_EXCLUDE_FLAG/NOTMUCH_EXCLUDE_TRUE options.
1021 NOTMUCH_EXCLUDE_FLAG,
1022 NOTMUCH_EXCLUDE_TRUE,
1023 NOTMUCH_EXCLUDE_FALSE,
1025 } notmuch_exclude_t;
1028 * Specify whether to omit excluded results or simply flag them. By
1029 * default, this is set to TRUE.
1031 * If set to TRUE or ALL, notmuch_query_search_messages will omit excluded
1032 * messages from the results, and notmuch_query_search_threads will omit
1033 * threads that match only in excluded messages. If set to TRUE,
1034 * notmuch_query_search_threads will include all messages in threads that
1035 * match in at least one non-excluded message. Otherwise, if set to ALL,
1036 * notmuch_query_search_threads will omit excluded messages from all threads.
1038 * If set to FALSE or FLAG then both notmuch_query_search_messages and
1039 * notmuch_query_search_threads will return all matching
1040 * messages/threads regardless of exclude status. If set to FLAG then
1041 * the exclude flag will be set for any excluded message that is
1042 * returned by notmuch_query_search_messages, and the thread counts
1043 * for threads returned by notmuch_query_search_threads will be the
1044 * number of non-excluded messages/matches. Otherwise, if set to
1045 * FALSE, then the exclude status is completely ignored.
1047 * The performance difference when calling
1048 * notmuch_query_search_messages should be relatively small (and both
1049 * should be very fast). However, in some cases,
1050 * notmuch_query_search_threads is very much faster when omitting
1051 * excluded messages as it does not need to construct the threads that
1052 * only match in excluded messages.
1055 notmuch_query_set_omit_excluded (notmuch_query_t *query,
1056 notmuch_exclude_t omit_excluded);
1059 * Specify the sorting desired for this query.
1062 notmuch_query_set_sort (notmuch_query_t *query, notmuch_sort_t sort);
1065 * Return the sort specified for this query. See
1066 * notmuch_query_set_sort.
1069 notmuch_query_get_sort (const notmuch_query_t *query);
1072 * Add a tag that will be excluded from the query results by default.
1073 * This exclusion will be ignored if this tag appears explicitly in
1078 * NOTMUCH_STATUS_SUCCESS: excluded was added successfully.
1080 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: a Xapian exception occurred.
1081 * Most likely a problem lazily parsing the query string.
1083 * NOTMUCH_STATUS_IGNORED: tag is explicitly present in the query, so
1087 notmuch_query_add_tag_exclude (notmuch_query_t *query, const char *tag);
1090 * Execute a query for threads, returning a notmuch_threads_t object
1091 * which can be used to iterate over the results. The returned threads
1092 * object is owned by the query and as such, will only be valid until
1093 * notmuch_query_destroy.
1095 * Typical usage might be:
1097 * notmuch_query_t *query;
1098 * notmuch_threads_t *threads;
1099 * notmuch_thread_t *thread;
1100 * notmuch_status_t stat;
1102 * query = notmuch_query_create (database, query_string);
1104 * for (stat = notmuch_query_search_threads (query, &threads);
1105 * stat == NOTMUCH_STATUS_SUCCESS &&
1106 * notmuch_threads_valid (threads);
1107 * notmuch_threads_move_to_next (threads))
1109 * thread = notmuch_threads_get (threads);
1111 * notmuch_thread_destroy (thread);
1114 * notmuch_query_destroy (query);
1116 * Note: If you are finished with a thread before its containing
1117 * query, you can call notmuch_thread_destroy to clean up some memory
1118 * sooner (as in the above example). Otherwise, if your thread objects
1119 * are long-lived, then you don't need to call notmuch_thread_destroy
1120 * and all the memory will still be reclaimed when the query is
1123 * Note that there's no explicit destructor needed for the
1124 * notmuch_threads_t object. (For consistency, we do provide a
1125 * notmuch_threads_destroy function, but there's no good reason
1126 * to call it if the query is about to be destroyed).
1128 * @since libnotmuch 5.0 (notmuch 0.25)
1131 notmuch_query_search_threads (notmuch_query_t *query,
1132 notmuch_threads_t **out);
1135 * Deprecated alias for notmuch_query_search_threads.
1137 * @deprecated Deprecated as of libnotmuch 5 (notmuch 0.25). Please
1138 * use notmuch_query_search_threads instead.
1141 NOTMUCH_DEPRECATED (5, 0)
1143 notmuch_query_search_threads_st (notmuch_query_t *query, notmuch_threads_t **out);
1146 * Execute a query for messages, returning a notmuch_messages_t object
1147 * which can be used to iterate over the results. The returned
1148 * messages object is owned by the query and as such, will only be
1149 * valid until notmuch_query_destroy.
1151 * Typical usage might be:
1153 * notmuch_query_t *query;
1154 * notmuch_messages_t *messages;
1155 * notmuch_message_t *message;
1157 * query = notmuch_query_create (database, query_string);
1159 * for (messages = notmuch_query_search_messages (query);
1160 * notmuch_messages_valid (messages);
1161 * notmuch_messages_move_to_next (messages))
1163 * message = notmuch_messages_get (messages);
1165 * notmuch_message_destroy (message);
1168 * notmuch_query_destroy (query);
1170 * Note: If you are finished with a message before its containing
1171 * query, you can call notmuch_message_destroy to clean up some memory
1172 * sooner (as in the above example). Otherwise, if your message
1173 * objects are long-lived, then you don't need to call
1174 * notmuch_message_destroy and all the memory will still be reclaimed
1175 * when the query is destroyed.
1177 * Note that there's no explicit destructor needed for the
1178 * notmuch_messages_t object. (For consistency, we do provide a
1179 * notmuch_messages_destroy function, but there's no good
1180 * reason to call it if the query is about to be destroyed).
1182 * If a Xapian exception occurs this function will return NULL.
1184 * @since libnotmuch 5 (notmuch 0.25)
1187 notmuch_query_search_messages (notmuch_query_t *query,
1188 notmuch_messages_t **out);
1190 * Deprecated alias for notmuch_query_search_messages
1192 * @deprecated Deprecated as of libnotmuch 5 (notmuch 0.25). Please use
1193 * notmuch_query_search_messages instead.
1197 NOTMUCH_DEPRECATED (5, 0)
1199 notmuch_query_search_messages_st (notmuch_query_t *query,
1200 notmuch_messages_t **out);
1203 * Destroy a notmuch_query_t along with any associated resources.
1205 * This will in turn destroy any notmuch_threads_t and
1206 * notmuch_messages_t objects generated by this query, (and in
1207 * turn any notmuch_thread_t and notmuch_message_t objects generated
1208 * from those results, etc.), if such objects haven't already been
1212 notmuch_query_destroy (notmuch_query_t *query);
1215 * Is the given 'threads' iterator pointing at a valid thread.
1217 * When this function returns TRUE, notmuch_threads_get will return a
1218 * valid object. Whereas when this function returns FALSE,
1219 * notmuch_threads_get will return NULL.
1221 * If passed a NULL pointer, this function returns FALSE
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_valid (notmuch_threads_t *threads);
1230 * Get the current thread from 'threads' as a notmuch_thread_t.
1232 * Note: The returned thread belongs to 'threads' and has a lifetime
1233 * identical to it (and the query to which it belongs).
1235 * See the documentation of notmuch_query_search_threads for example
1236 * code showing how to iterate over a notmuch_threads_t object.
1238 * If an out-of-memory situation occurs, this function will return
1242 notmuch_threads_get (notmuch_threads_t *threads);
1245 * Move the 'threads' iterator to the next thread.
1247 * If 'threads' is already pointing at the last thread then the
1248 * iterator will be moved to a point just beyond that last thread,
1249 * (where notmuch_threads_valid will return FALSE and
1250 * notmuch_threads_get will return NULL).
1252 * See the documentation of notmuch_query_search_threads for example
1253 * code showing how to iterate over a notmuch_threads_t object.
1256 notmuch_threads_move_to_next (notmuch_threads_t *threads);
1259 * Destroy a notmuch_threads_t object.
1261 * It's not strictly necessary to call this function. All memory from
1262 * the notmuch_threads_t object will be reclaimed when the
1263 * containing query object is destroyed.
1266 notmuch_threads_destroy (notmuch_threads_t *threads);
1269 * Return the number of messages matching a search.
1271 * This function performs a search and returns the number of matching
1276 * NOTMUCH_STATUS_SUCCESS: query completed successfully.
1278 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: a Xapian exception occurred. The
1279 * value of *count is not defined.
1281 * @since libnotmuch 5 (notmuch 0.25)
1284 notmuch_query_count_messages (notmuch_query_t *query, unsigned int *count);
1287 * Deprecated alias for notmuch_query_count_messages
1290 * @deprecated Deprecated since libnotmuch 5.0 (notmuch 0.25). Please
1291 * use notmuch_query_count_messages instead.
1293 NOTMUCH_DEPRECATED (5, 0)
1295 notmuch_query_count_messages_st (notmuch_query_t *query, unsigned int *count);
1298 * Return the number of threads matching a search.
1300 * This function performs a search and returns the number of unique thread IDs
1301 * in the matching messages. This is the same as number of threads matching a
1304 * Note that this is a significantly heavier operation than
1305 * notmuch_query_count_messages{_st}().
1309 * NOTMUCH_STATUS_OUT_OF_MEMORY: Memory allocation failed. The value
1310 * of *count is not defined
1312 * NOTMUCH_STATUS_SUCCESS: query completed successfully.
1314 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: a Xapian exception occurred. The
1315 * value of *count is not defined.
1317 * @since libnotmuch 5 (notmuch 0.25)
1320 notmuch_query_count_threads (notmuch_query_t *query, unsigned *count);
1323 * Deprecated alias for notmuch_query_count_threads
1325 * @deprecated Deprecated as of libnotmuch 5.0 (notmuch 0.25). Please
1326 * use notmuch_query_count_threads_st instead.
1328 NOTMUCH_DEPRECATED (5, 0)
1330 notmuch_query_count_threads_st (notmuch_query_t *query, unsigned *count);
1333 * Get the thread ID of 'thread'.
1335 * The returned string belongs to 'thread' and as such, should not be
1336 * modified by the caller and will only be valid for as long as the
1337 * thread is valid, (which is until notmuch_thread_destroy or until
1338 * the query from which it derived is destroyed).
1341 notmuch_thread_get_thread_id (notmuch_thread_t *thread);
1344 * Get the total number of messages in 'thread'.
1346 * This count consists of all messages in the database belonging to
1347 * this thread. Contrast with notmuch_thread_get_matched_messages() .
1350 notmuch_thread_get_total_messages (notmuch_thread_t *thread);
1353 * Get the total number of files in 'thread'.
1355 * This sums notmuch_message_count_files over all messages in the
1357 * @returns Non-negative integer
1358 * @since libnotmuch 5.0 (notmuch 0.25)
1362 notmuch_thread_get_total_files (notmuch_thread_t *thread);
1365 * Get a notmuch_messages_t iterator for the top-level messages in
1366 * 'thread' in oldest-first order.
1368 * This iterator will not necessarily iterate over all of the messages
1369 * in the thread. It will only iterate over the messages in the thread
1370 * which are not replies to other messages in the thread.
1372 * The returned list will be destroyed when the thread is destroyed.
1374 notmuch_messages_t *
1375 notmuch_thread_get_toplevel_messages (notmuch_thread_t *thread);
1378 * Get a notmuch_thread_t iterator for all messages in 'thread' in
1379 * oldest-first order.
1381 * The returned list will be destroyed when the thread is destroyed.
1383 notmuch_messages_t *
1384 notmuch_thread_get_messages (notmuch_thread_t *thread);
1387 * Get the number of messages in 'thread' that matched the search.
1389 * This count includes only the messages in this thread that were
1390 * matched by the search from which the thread was created and were
1391 * not excluded by any exclude tags passed in with the query (see
1392 * notmuch_query_add_tag_exclude). Contrast with
1393 * notmuch_thread_get_total_messages() .
1396 notmuch_thread_get_matched_messages (notmuch_thread_t *thread);
1399 * Get the authors of 'thread' as a UTF-8 string.
1401 * The returned string is a comma-separated list of the names of the
1402 * authors of mail messages in the query results that belong to this
1405 * The string contains authors of messages matching the query first, then
1406 * non-matched authors (with the two groups separated by '|'). Within
1407 * each group, authors are ordered by date.
1409 * The returned string belongs to 'thread' and as such, should not be
1410 * modified by the caller and will only be valid for as long as the
1411 * thread is valid, (which is until notmuch_thread_destroy or until
1412 * the query from which it derived is destroyed).
1415 notmuch_thread_get_authors (notmuch_thread_t *thread);
1418 * Get the subject of 'thread' as a UTF-8 string.
1420 * The subject is taken from the first message (according to the query
1421 * order---see notmuch_query_set_sort) in the query results that
1422 * belongs to this thread.
1424 * The returned string belongs to 'thread' and as such, should not be
1425 * modified by the caller and will only be valid for as long as the
1426 * thread is valid, (which is until notmuch_thread_destroy or until
1427 * the query from which it derived is destroyed).
1430 notmuch_thread_get_subject (notmuch_thread_t *thread);
1433 * Get the date of the oldest message in 'thread' as a time_t value.
1436 notmuch_thread_get_oldest_date (notmuch_thread_t *thread);
1439 * Get the date of the newest message in 'thread' as a time_t value.
1442 notmuch_thread_get_newest_date (notmuch_thread_t *thread);
1445 * Get the tags for 'thread', returning a notmuch_tags_t object which
1446 * can be used to iterate over all tags.
1448 * Note: In the Notmuch database, tags are stored on individual
1449 * messages, not on threads. So the tags returned here will be all
1450 * tags of the messages which matched the search and which belong to
1453 * The tags object is owned by the thread and as such, will only be
1454 * valid for as long as the thread is valid, (for example, until
1455 * notmuch_thread_destroy or until the query from which it derived is
1458 * Typical usage might be:
1460 * notmuch_thread_t *thread;
1461 * notmuch_tags_t *tags;
1464 * thread = notmuch_threads_get (threads);
1466 * for (tags = notmuch_thread_get_tags (thread);
1467 * notmuch_tags_valid (tags);
1468 * notmuch_tags_move_to_next (tags))
1470 * tag = notmuch_tags_get (tags);
1474 * notmuch_thread_destroy (thread);
1476 * Note that there's no explicit destructor needed for the
1477 * notmuch_tags_t object. (For consistency, we do provide a
1478 * notmuch_tags_destroy function, but there's no good reason to call
1479 * it if the message is about to be destroyed).
1482 notmuch_thread_get_tags (notmuch_thread_t *thread);
1485 * Destroy a notmuch_thread_t object.
1488 notmuch_thread_destroy (notmuch_thread_t *thread);
1491 * Is the given 'messages' iterator pointing at a valid message.
1493 * When this function returns TRUE, notmuch_messages_get will return a
1494 * valid object. Whereas when this function returns FALSE,
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_valid (notmuch_messages_t *messages);
1504 * Get the current message from 'messages' as a notmuch_message_t.
1506 * Note: The returned message belongs to 'messages' and has a lifetime
1507 * identical to it (and the query to which it belongs).
1509 * See the documentation of notmuch_query_search_messages for example
1510 * code showing how to iterate over a notmuch_messages_t object.
1512 * If an out-of-memory situation occurs, this function will return
1516 notmuch_messages_get (notmuch_messages_t *messages);
1519 * Move the 'messages' iterator to the next message.
1521 * If 'messages' is already pointing at the last message then the
1522 * iterator will be moved to a point just beyond that last message,
1523 * (where notmuch_messages_valid will return FALSE and
1524 * notmuch_messages_get will return NULL).
1526 * See the documentation of notmuch_query_search_messages for example
1527 * code showing how to iterate over a notmuch_messages_t object.
1530 notmuch_messages_move_to_next (notmuch_messages_t *messages);
1533 * Destroy a notmuch_messages_t object.
1535 * It's not strictly necessary to call this function. All memory from
1536 * the notmuch_messages_t object will be reclaimed when the containing
1537 * query object is destroyed.
1540 notmuch_messages_destroy (notmuch_messages_t *messages);
1543 * Return a list of tags from all messages.
1545 * The resulting list is guaranteed not to contain duplicated tags.
1547 * WARNING: You can no longer iterate over messages after calling this
1548 * function, because the iterator will point at the end of the list.
1549 * We do not have a function to reset the iterator yet and the only
1550 * way how you can iterate over the list again is to recreate the
1553 * The function returns NULL on error.
1556 notmuch_messages_collect_tags (notmuch_messages_t *messages);
1559 * Get the database associated with this message.
1561 * @since libnotmuch 5.2 (notmuch 0.27)
1563 notmuch_database_t *
1564 notmuch_message_get_database (const notmuch_message_t *message);
1567 * Get the message ID of 'message'.
1569 * The returned string belongs to 'message' and as such, should not be
1570 * modified by the caller and will only be valid for as long as the
1571 * message is valid, (which is until the query from which it derived
1574 * This function will return NULL if triggers an unhandled Xapian
1578 notmuch_message_get_message_id (notmuch_message_t *message);
1581 * Get the thread ID of 'message'.
1583 * The returned string belongs to 'message' and as such, should not be
1584 * modified by the caller and will only be valid for as long as the
1585 * message is valid, (for example, until the user calls
1586 * notmuch_message_destroy on 'message' or until a query from which it
1587 * derived is destroyed).
1589 * This function will return NULL if triggers an unhandled Xapian
1593 notmuch_message_get_thread_id (notmuch_message_t *message);
1596 * Get a notmuch_messages_t iterator for all of the replies to
1599 * Note: This call only makes sense if 'message' was ultimately
1600 * obtained from a notmuch_thread_t object, (such as by coming
1601 * directly from the result of calling notmuch_thread_get_
1602 * toplevel_messages or by any number of subsequent
1603 * calls to notmuch_message_get_replies).
1605 * If 'message' was obtained through some non-thread means, (such as
1606 * by a call to notmuch_query_search_messages), then this function
1609 * If there are no replies to 'message', this function will return
1610 * NULL. (Note that notmuch_messages_valid will accept that NULL
1611 * value as legitimate, and simply return FALSE for it.)
1613 * This function also returns NULL if it triggers a Xapian exception.
1615 * The returned list will be destroyed when the thread is
1618 notmuch_messages_t *
1619 notmuch_message_get_replies (notmuch_message_t *message);
1622 * Get the total number of files associated with a message.
1623 * @returns Non-negative integer for file count.
1624 * @returns Negative integer for error.
1625 * @since libnotmuch 5.0 (notmuch 0.25)
1628 notmuch_message_count_files (notmuch_message_t *message);
1631 * Get a filename for the email corresponding to 'message'.
1633 * The returned filename is an absolute filename, (the initial
1634 * component will match notmuch_database_get_path() ).
1636 * The returned string belongs to the message so should not be
1637 * modified or freed by the caller (nor should it be referenced after
1638 * the message is destroyed).
1640 * Note: If this message corresponds to multiple files in the mail
1641 * store, (that is, multiple files contain identical message IDs),
1642 * this function will arbitrarily return a single one of those
1643 * filenames. See notmuch_message_get_filenames for returning the
1644 * complete list of filenames.
1646 * This function returns NULL if it triggers a Xapian exception.
1649 notmuch_message_get_filename (notmuch_message_t *message);
1652 * Get all filenames for the email corresponding to 'message'.
1654 * Returns a notmuch_filenames_t iterator listing all the filenames
1655 * associated with 'message'. These files may not have identical
1656 * content, but each will have the identical Message-ID.
1658 * Each filename in the iterator is an absolute filename, (the initial
1659 * component will match notmuch_database_get_path() ).
1661 * This function returns NULL if it triggers a Xapian exception.
1663 notmuch_filenames_t *
1664 notmuch_message_get_filenames (notmuch_message_t *message);
1667 * Re-index the e-mail corresponding to 'message' using the supplied index options
1669 * Returns the status of the re-index operation. (see the return
1670 * codes documented in notmuch_database_index_file)
1672 * After reindexing, the user should discard the message object passed
1673 * in here by calling notmuch_message_destroy, since it refers to the
1674 * original message, not to the reindexed message.
1677 notmuch_message_reindex (notmuch_message_t *message,
1678 notmuch_indexopts_t *indexopts);
1683 typedef enum _notmuch_message_flag {
1684 NOTMUCH_MESSAGE_FLAG_MATCH,
1685 NOTMUCH_MESSAGE_FLAG_EXCLUDED,
1687 /* This message is a "ghost message", meaning it has no filenames
1688 * or content, but we know it exists because it was referenced by
1689 * some other message. A ghost message has only a message ID and
1692 NOTMUCH_MESSAGE_FLAG_GHOST,
1693 } notmuch_message_flag_t;
1696 * Get a value of a flag for the email corresponding to 'message'.
1698 * returns FALSE in case of errors.
1700 * @deprecated Deprecated as of libnotmuch 5.3 (notmuch 0.31). Please
1701 * use notmuch_message_get_flag_st instead.
1703 NOTMUCH_DEPRECATED (5, 3)
1705 notmuch_message_get_flag (notmuch_message_t *message,
1706 notmuch_message_flag_t flag);
1709 * Get a value of a flag for the email corresponding to 'message'.
1711 * @param message a message object
1712 * @param flag flag to check
1713 * @param is_set pointer to boolean to store flag value.
1715 * @retval #NOTMUCH_STATUS_SUCCESS
1716 * @retval #NOTMUCH_STATUS_NULL_POINTER is_set is NULL
1717 * @retval #NOTMUCH_STATUS_XAPIAN_EXCEPTION Accessing the database
1718 * triggered an exception.
1720 * @since libnotmuch 5.3 (notmuch 0.31)
1723 notmuch_message_get_flag_st (notmuch_message_t *message,
1724 notmuch_message_flag_t flag,
1725 notmuch_bool_t *is_set);
1728 * Set a value of a flag for the email corresponding to 'message'.
1731 notmuch_message_set_flag (notmuch_message_t *message,
1732 notmuch_message_flag_t flag, notmuch_bool_t value);
1735 * Get the date of 'message' as a time_t value.
1737 * For the original textual representation of the Date header from the
1738 * message call notmuch_message_get_header() with a header value of
1741 * Returns 0 in case of error.
1744 notmuch_message_get_date (notmuch_message_t *message);
1747 * Get the value of the specified header from 'message' as a UTF-8 string.
1749 * Common headers are stored in the database when the message is
1750 * indexed and will be returned from the database. Other headers will
1751 * be read from the actual message file.
1753 * The header name is case insensitive.
1755 * The returned string belongs to the message so should not be
1756 * modified or freed by the caller (nor should it be referenced after
1757 * the message is destroyed).
1759 * Returns an empty string ("") if the message does not contain a
1760 * header line matching 'header'. Returns NULL if any error occurs.
1763 notmuch_message_get_header (notmuch_message_t *message, const char *header);
1766 * Get the tags for 'message', returning a notmuch_tags_t object which
1767 * can be used to iterate over all tags.
1769 * The tags object is owned by the message and as such, will only be
1770 * valid for as long as the message is valid, (which is until the
1771 * query from which it derived is destroyed).
1773 * Typical usage might be:
1775 * notmuch_message_t *message;
1776 * notmuch_tags_t *tags;
1779 * message = notmuch_database_find_message (database, message_id);
1781 * for (tags = notmuch_message_get_tags (message);
1782 * notmuch_tags_valid (tags);
1783 * notmuch_tags_move_to_next (tags))
1785 * tag = notmuch_tags_get (tags);
1789 * notmuch_message_destroy (message);
1791 * Note that there's no explicit destructor needed for the
1792 * notmuch_tags_t object. (For consistency, we do provide a
1793 * notmuch_tags_destroy function, but there's no good reason to call
1794 * it if the message is about to be destroyed).
1797 notmuch_message_get_tags (notmuch_message_t *message);
1800 * The longest possible tag value.
1802 #define NOTMUCH_TAG_MAX 200
1805 * Add a tag to the given message.
1809 * NOTMUCH_STATUS_SUCCESS: Tag successfully added to message
1811 * NOTMUCH_STATUS_NULL_POINTER: The 'tag' argument is NULL
1813 * NOTMUCH_STATUS_TAG_TOO_LONG: The length of 'tag' is too long
1814 * (exceeds NOTMUCH_TAG_MAX)
1816 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
1817 * mode so message cannot be modified.
1820 notmuch_message_add_tag (notmuch_message_t *message, const char *tag);
1823 * Remove a tag from the given message.
1827 * NOTMUCH_STATUS_SUCCESS: Tag successfully removed from message
1829 * NOTMUCH_STATUS_NULL_POINTER: The 'tag' argument is NULL
1831 * NOTMUCH_STATUS_TAG_TOO_LONG: The length of 'tag' is too long
1832 * (exceeds NOTMUCH_TAG_MAX)
1834 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
1835 * mode so message cannot be modified.
1838 notmuch_message_remove_tag (notmuch_message_t *message, const char *tag);
1841 * Remove all tags from the given message.
1843 * See notmuch_message_freeze for an example showing how to safely
1844 * replace tag values.
1846 * @retval #NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in
1847 * read-only mode so message cannot be modified.
1848 * @retval #NOTMUCH_STATUS_XAPIAN_EXCEPTION: an exception was thrown
1849 * accessing the database.
1852 notmuch_message_remove_all_tags (notmuch_message_t *message);
1855 * Add/remove tags according to maildir flags in the message filename(s).
1857 * This function examines the filenames of 'message' for maildir
1858 * flags, and adds or removes tags on 'message' as follows when these
1859 * flags are present:
1861 * Flag Action if present
1862 * ---- -----------------
1863 * 'D' Adds the "draft" tag to the message
1864 * 'F' Adds the "flagged" tag to the message
1865 * 'P' Adds the "passed" tag to the message
1866 * 'R' Adds the "replied" tag to the message
1867 * 'S' Removes the "unread" tag from the message
1869 * For each flag that is not present, the opposite action (add/remove)
1870 * is performed for the corresponding tags.
1872 * Flags are identified as trailing components of the filename after a
1873 * sequence of ":2,".
1875 * If there are multiple filenames associated with this message, the
1876 * flag is considered present if it appears in one or more
1877 * filenames. (That is, the flags from the multiple filenames are
1878 * combined with the logical OR operator.)
1880 * A client can ensure that notmuch database tags remain synchronized
1881 * with maildir flags by calling this function after each call to
1882 * notmuch_database_index_file. See also
1883 * notmuch_message_tags_to_maildir_flags for synchronizing tag changes
1884 * back to maildir flags.
1887 notmuch_message_maildir_flags_to_tags (notmuch_message_t *message);
1890 * return TRUE if any filename of 'message' has maildir flag 'flag',
1893 * Deprecated wrapper for notmuch_message_has_maildir_flag_st
1895 * @returns FALSE in case of error
1896 * @deprecated libnotmuch 5.3 (notmuch 0.31)
1898 NOTMUCH_DEPRECATED (5, 3)
1900 notmuch_message_has_maildir_flag (notmuch_message_t *message, char flag);
1903 * check message for maildir flag
1905 * @param [in,out] message message to check
1906 * @param [in] flag flag to check for
1907 * @param [out] is_set pointer to boolean
1909 * @retval #NOTMUCH_STATUS_SUCCESS
1910 * @retval #NOTMUCH_STATUS_NULL_POINTER is_set is NULL
1911 * @retval #NOTMUCH_STATUS_XAPIAN_EXCEPTION Accessing the database
1912 * triggered an exception.
1915 notmuch_message_has_maildir_flag_st (notmuch_message_t *message,
1917 notmuch_bool_t *is_set);
1920 * Rename message filename(s) to encode tags as maildir flags.
1922 * Specifically, for each filename corresponding to this message:
1924 * If the filename is not in a maildir directory, do nothing. (A
1925 * maildir directory is determined as a directory named "new" or
1926 * "cur".) Similarly, if the filename has invalid maildir info,
1927 * (repeated or outof-ASCII-order flag characters after ":2,"), then
1930 * If the filename is in a maildir directory, rename the file so that
1931 * its filename ends with the sequence ":2," followed by zero or more
1932 * of the following single-character flags (in ASCII order):
1934 * * flag 'D' iff the message has the "draft" tag
1935 * * flag 'F' iff the message has the "flagged" tag
1936 * * flag 'P' iff the message has the "passed" tag
1937 * * flag 'R' iff the message has the "replied" tag
1938 * * flag 'S' iff the message does not have the "unread" tag
1940 * Any existing flags unmentioned in the list above will be preserved
1943 * Also, if this filename is in a directory named "new", rename it to
1944 * be within the neighboring directory named "cur".
1946 * A client can ensure that maildir filename flags remain synchronized
1947 * with notmuch database tags by calling this function after changing
1948 * tags, (after calls to notmuch_message_add_tag,
1949 * notmuch_message_remove_tag, or notmuch_message_freeze/
1950 * notmuch_message_thaw). See also notmuch_message_maildir_flags_to_tags
1951 * for synchronizing maildir flag changes back to tags.
1954 notmuch_message_tags_to_maildir_flags (notmuch_message_t *message);
1957 * Freeze the current state of 'message' within the database.
1959 * This means that changes to the message state, (via
1960 * notmuch_message_add_tag, notmuch_message_remove_tag, and
1961 * notmuch_message_remove_all_tags), will not be committed to the
1962 * database until the message is thawed with notmuch_message_thaw.
1964 * Multiple calls to freeze/thaw are valid and these calls will
1965 * "stack". That is there must be as many calls to thaw as to freeze
1966 * before a message is actually thawed.
1968 * The ability to do freeze/thaw allows for safe transactions to
1969 * change tag values. For example, explicitly setting a message to
1970 * have a given set of tags might look like this:
1972 * notmuch_message_freeze (message);
1974 * notmuch_message_remove_all_tags (message);
1976 * for (i = 0; i < NUM_TAGS; i++)
1977 * notmuch_message_add_tag (message, tags[i]);
1979 * notmuch_message_thaw (message);
1981 * With freeze/thaw used like this, the message in the database is
1982 * guaranteed to have either the full set of original tag values, or
1983 * the full set of new tag values, but nothing in between.
1985 * Imagine the example above without freeze/thaw and the operation
1986 * somehow getting interrupted. This could result in the message being
1987 * left with no tags if the interruption happened after
1988 * notmuch_message_remove_all_tags but before notmuch_message_add_tag.
1992 * NOTMUCH_STATUS_SUCCESS: Message successfully frozen.
1994 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
1995 * mode so message cannot be modified.
1998 notmuch_message_freeze (notmuch_message_t *message);
2001 * Thaw the current 'message', synchronizing any changes that may have
2002 * occurred while 'message' was frozen into the notmuch database.
2004 * See notmuch_message_freeze for an example of how to use this
2005 * function to safely provide tag changes.
2007 * Multiple calls to freeze/thaw are valid and these calls with
2008 * "stack". That is there must be as many calls to thaw as to freeze
2009 * before a message is actually thawed.
2013 * NOTMUCH_STATUS_SUCCESS: Message successfully thawed, (or at least
2014 * its frozen count has successfully been reduced by 1).
2016 * NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW: An attempt was made to thaw
2017 * an unfrozen message. That is, there have been an unbalanced
2018 * number of calls to notmuch_message_freeze and
2019 * notmuch_message_thaw.
2022 notmuch_message_thaw (notmuch_message_t *message);
2025 * Destroy a notmuch_message_t object.
2027 * It can be useful to call this function in the case of a single
2028 * query object with many messages in the result, (such as iterating
2029 * over the entire database). Otherwise, it's fine to never call this
2030 * function and there will still be no memory leaks. (The memory from
2031 * the messages get reclaimed when the containing query is destroyed.)
2034 notmuch_message_destroy (notmuch_message_t *message);
2037 * @name Message Properties
2039 * This interface provides the ability to attach arbitrary (key,value)
2040 * string pairs to a message, to remove such pairs, and to iterate
2041 * over them. The caller should take some care as to what keys they
2042 * add or delete values for, as other subsystems or extensions may
2043 * depend on these properties.
2045 * Please see notmuch-properties(7) for more details about specific
2046 * properties and conventions around their use.
2051 * Retrieve the value for a single property key
2053 * *value* is set to a string owned by the message or NULL if there is
2054 * no such key. In the case of multiple values for the given key, the
2055 * first one is retrieved.
2058 * - NOTMUCH_STATUS_NULL_POINTER: *value* may not be NULL.
2059 * - NOTMUCH_STATUS_SUCCESS: No error occurred.
2060 * @since libnotmuch 4.4 (notmuch 0.23)
2063 notmuch_message_get_property (notmuch_message_t *message, const char *key, const char **value);
2066 * Add a (key,value) pair to a message
2069 * - NOTMUCH_STATUS_ILLEGAL_ARGUMENT: *key* may not contain an '=' character.
2070 * - NOTMUCH_STATUS_NULL_POINTER: Neither *key* nor *value* may be NULL.
2071 * - NOTMUCH_STATUS_SUCCESS: No error occurred.
2072 * @since libnotmuch 4.4 (notmuch 0.23)
2075 notmuch_message_add_property (notmuch_message_t *message, const char *key, const char *value);
2078 * Remove a (key,value) pair from a message.
2080 * It is not an error to remove a non-existent (key,value) pair
2083 * - NOTMUCH_STATUS_ILLEGAL_ARGUMENT: *key* may not contain an '=' character.
2084 * - NOTMUCH_STATUS_NULL_POINTER: Neither *key* nor *value* may be NULL.
2085 * - NOTMUCH_STATUS_SUCCESS: No error occurred.
2086 * @since libnotmuch 4.4 (notmuch 0.23)
2089 notmuch_message_remove_property (notmuch_message_t *message, const char *key, const char *value);
2092 * Remove all (key,value) pairs from the given message.
2094 * @param[in,out] message message to operate on.
2095 * @param[in] key key to delete properties for. If NULL, delete
2096 * properties for all keys
2098 * - NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in
2099 * read-only mode so message cannot be modified.
2100 * - NOTMUCH_STATUS_SUCCESS: No error occurred.
2102 * @since libnotmuch 4.4 (notmuch 0.23)
2105 notmuch_message_remove_all_properties (notmuch_message_t *message, const char *key);
2108 * Remove all (prefix*,value) pairs from the given message
2110 * @param[in,out] message message to operate on.
2111 * @param[in] prefix delete properties with keys that start with prefix.
2112 * If NULL, delete all properties
2114 * - NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in
2115 * read-only mode so message cannot be modified.
2116 * - NOTMUCH_STATUS_SUCCESS: No error occurred.
2118 * @since libnotmuch 5.1 (notmuch 0.26)
2121 notmuch_message_remove_all_properties_with_prefix (notmuch_message_t *message, const char *prefix);
2124 * Opaque message property iterator
2126 typedef struct _notmuch_string_map_iterator notmuch_message_properties_t;
2129 * Get the properties for *message*, returning a
2130 * notmuch_message_properties_t object which can be used to iterate
2131 * over all properties.
2133 * The notmuch_message_properties_t object is owned by the message and
2134 * as such, will only be valid for as long as the message is valid,
2135 * (which is until the query from which it derived is destroyed).
2137 * @param[in] message The message to examine
2138 * @param[in] key key or key prefix
2139 * @param[in] exact if TRUE, require exact match with key. Otherwise
2142 * Typical usage might be:
2144 * notmuch_message_properties_t *list;
2146 * for (list = notmuch_message_get_properties (message, "testkey1", TRUE);
2147 * notmuch_message_properties_valid (list); notmuch_message_properties_move_to_next (list)) {
2148 * printf("%s\n", notmuch_message_properties_value(list));
2151 * notmuch_message_properties_destroy (list);
2153 * Note that there's no explicit destructor needed for the
2154 * notmuch_message_properties_t object. (For consistency, we do
2155 * provide a notmuch_message_properities_destroy function, but there's
2156 * no good reason to call it if the message is about to be destroyed).
2158 * @since libnotmuch 4.4 (notmuch 0.23)
2160 notmuch_message_properties_t *
2161 notmuch_message_get_properties (notmuch_message_t *message, const char *key, notmuch_bool_t exact);
2164 * Return the number of properties named "key" belonging to the specific message.
2166 * @param[in] message The message to examine
2167 * @param[in] key key to count
2168 * @param[out] count The number of matching properties associated with this message.
2172 * NOTMUCH_STATUS_SUCCESS: successful count, possibly some other error.
2174 * @since libnotmuch 5.2 (notmuch 0.27)
2177 notmuch_message_count_properties (notmuch_message_t *message, const char *key, unsigned int *count);
2180 * Is the given *properties* iterator pointing at a valid (key,value)
2183 * When this function returns TRUE,
2184 * notmuch_message_properties_{key,value} will return a valid string,
2185 * and notmuch_message_properties_move_to_next will do what it
2186 * says. Whereas when this function returns FALSE, calling any of
2187 * these functions results in undefined behaviour.
2189 * See the documentation of notmuch_message_get_properties for example
2190 * code showing how to iterate over a notmuch_message_properties_t
2193 * @since libnotmuch 4.4 (notmuch 0.23)
2196 notmuch_message_properties_valid (notmuch_message_properties_t *properties);
2199 * Move the *properties* iterator to the next (key,value) pair
2201 * If *properties* is already pointing at the last pair then the iterator
2202 * will be moved to a point just beyond that last pair, (where
2203 * notmuch_message_properties_valid will return FALSE).
2205 * See the documentation of notmuch_message_get_properties for example
2206 * code showing how to iterate over a notmuch_message_properties_t object.
2208 * @since libnotmuch 4.4 (notmuch 0.23)
2211 notmuch_message_properties_move_to_next (notmuch_message_properties_t *properties);
2214 * Return the key from the current (key,value) pair.
2216 * this could be useful if iterating for a prefix
2218 * @since libnotmuch 4.4 (notmuch 0.23)
2221 notmuch_message_properties_key (notmuch_message_properties_t *properties);
2224 * Return the value from the current (key,value) pair.
2226 * This could be useful if iterating for a prefix.
2228 * @since libnotmuch 4.4 (notmuch 0.23)
2231 notmuch_message_properties_value (notmuch_message_properties_t *properties);
2235 * Destroy a notmuch_message_properties_t object.
2237 * It's not strictly necessary to call this function. All memory from
2238 * the notmuch_message_properties_t object will be reclaimed when the
2239 * containing message object is destroyed.
2241 * @since libnotmuch 4.4 (notmuch 0.23)
2244 notmuch_message_properties_destroy (notmuch_message_properties_t *properties);
2249 * Is the given 'tags' iterator pointing at a valid tag.
2251 * When this function returns TRUE, notmuch_tags_get will return a
2252 * valid string. Whereas when this function returns FALSE,
2253 * notmuch_tags_get will return NULL.
2255 * See the documentation of notmuch_message_get_tags for example code
2256 * showing how to iterate over a notmuch_tags_t object.
2259 notmuch_tags_valid (notmuch_tags_t *tags);
2262 * Get the current tag from 'tags' as a string.
2264 * Note: The returned string belongs to 'tags' and has a lifetime
2265 * identical to it (and the query to which it ultimately belongs).
2267 * See the documentation of notmuch_message_get_tags for example code
2268 * showing how to iterate over a notmuch_tags_t object.
2271 notmuch_tags_get (notmuch_tags_t *tags);
2274 * Move the 'tags' iterator to the next tag.
2276 * If 'tags' is already pointing at the last tag then the iterator
2277 * will be moved to a point just beyond that last tag, (where
2278 * notmuch_tags_valid will return FALSE and notmuch_tags_get will
2281 * See the documentation of notmuch_message_get_tags for example code
2282 * showing how to iterate over a notmuch_tags_t object.
2285 notmuch_tags_move_to_next (notmuch_tags_t *tags);
2288 * Destroy a notmuch_tags_t object.
2290 * It's not strictly necessary to call this function. All memory from
2291 * the notmuch_tags_t object will be reclaimed when the containing
2292 * message or query objects are destroyed.
2295 notmuch_tags_destroy (notmuch_tags_t *tags);
2298 * Store an mtime within the database for 'directory'.
2300 * The 'directory' should be an object retrieved from the database
2301 * with notmuch_database_get_directory for a particular path.
2303 * The intention is for the caller to use the mtime to allow efficient
2304 * identification of new messages to be added to the database. The
2305 * recommended usage is as follows:
2307 * o Read the mtime of a directory from the filesystem
2309 * o Call index_file for all mail files in the directory
2311 * o Call notmuch_directory_set_mtime with the mtime read from the
2314 * Then, when wanting to check for updates to the directory in the
2315 * future, the client can call notmuch_directory_get_mtime and know
2316 * that it only needs to add files if the mtime of the directory and
2317 * files are newer than the stored timestamp.
2319 * Note: The notmuch_directory_get_mtime function does not allow the
2320 * caller to distinguish a timestamp of 0 from a non-existent
2321 * timestamp. So don't store a timestamp of 0 unless you are
2322 * comfortable with that.
2326 * NOTMUCH_STATUS_SUCCESS: mtime successfully stored in database.
2328 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception
2329 * occurred, mtime not stored.
2331 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
2332 * mode so directory mtime cannot be modified.
2335 notmuch_directory_set_mtime (notmuch_directory_t *directory,
2339 * Get the mtime of a directory, (as previously stored with
2340 * notmuch_directory_set_mtime).
2342 * Returns 0 if no mtime has previously been stored for this
2346 notmuch_directory_get_mtime (notmuch_directory_t *directory);
2349 * Get a notmuch_filenames_t iterator listing all the filenames of
2350 * messages in the database within the given directory.
2352 * The returned filenames will be the basename-entries only (not
2355 * Returns NULL if it triggers a Xapian exception
2357 notmuch_filenames_t *
2358 notmuch_directory_get_child_files (notmuch_directory_t *directory);
2361 * Get a notmuch_filenames_t iterator listing all the filenames of
2362 * sub-directories in the database within the given directory.
2364 * The returned filenames will be the basename-entries only (not
2367 * Returns NULL if it triggers a Xapian exception
2369 notmuch_filenames_t *
2370 notmuch_directory_get_child_directories (notmuch_directory_t *directory);
2373 * Delete directory document from the database, and destroy the
2374 * notmuch_directory_t object. Assumes any child directories and files
2375 * have been deleted by the caller.
2377 * @since libnotmuch 4.3 (notmuch 0.21)
2380 notmuch_directory_delete (notmuch_directory_t *directory);
2383 * Destroy a notmuch_directory_t object.
2386 notmuch_directory_destroy (notmuch_directory_t *directory);
2389 * Is the given 'filenames' iterator pointing at a valid filename.
2391 * When this function returns TRUE, notmuch_filenames_get will return
2392 * a valid string. Whereas when this function returns FALSE,
2393 * notmuch_filenames_get will return NULL.
2395 * It is acceptable to pass NULL for 'filenames', in which case this
2396 * function will always return FALSE.
2399 notmuch_filenames_valid (notmuch_filenames_t *filenames);
2402 * Get the current filename from 'filenames' as a string.
2404 * Note: The returned string belongs to 'filenames' and has a lifetime
2405 * identical to it (and the directory to which it ultimately belongs).
2407 * It is acceptable to pass NULL for 'filenames', in which case this
2408 * function will always return NULL.
2411 notmuch_filenames_get (notmuch_filenames_t *filenames);
2414 * Move the 'filenames' iterator to the next filename.
2416 * If 'filenames' is already pointing at the last filename then the
2417 * iterator will be moved to a point just beyond that last filename,
2418 * (where notmuch_filenames_valid will return FALSE and
2419 * notmuch_filenames_get will return NULL).
2421 * It is acceptable to pass NULL for 'filenames', in which case this
2422 * function will do nothing.
2425 notmuch_filenames_move_to_next (notmuch_filenames_t *filenames);
2428 * Destroy a notmuch_filenames_t object.
2430 * It's not strictly necessary to call this function. All memory from
2431 * the notmuch_filenames_t object will be reclaimed when the
2432 * containing directory object is destroyed.
2434 * It is acceptable to pass NULL for 'filenames', in which case this
2435 * function will do nothing.
2438 notmuch_filenames_destroy (notmuch_filenames_t *filenames);
2442 * set config 'key' to 'value'
2444 * @since libnotmuch 4.4 (notmuch 0.23)
2445 * @retval #NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in
2446 * read-only mode so message cannot be modified.
2447 * @retval #NOTMUCH_STATUS_XAPIAN_EXCEPTION: an exception was thrown
2448 * accessing the database.
2449 * @retval #NOTMUCH_STATUS_SUCCESS
2452 notmuch_database_set_config (notmuch_database_t *db, const char *key, const char *value);
2455 * retrieve config item 'key', assign to 'value'
2457 * keys which have not been previously set with n_d_set_config will
2458 * return an empty string.
2460 * return value is allocated by malloc and should be freed by the
2463 * @since libnotmuch 4.4 (notmuch 0.23)
2467 notmuch_database_get_config (notmuch_database_t *db, const char *key, char **value);
2470 * Create an iterator for all config items with keys matching a given prefix
2472 * @since libnotmuch 4.4 (notmuch 0.23)
2475 notmuch_database_get_config_list (notmuch_database_t *db, const char *prefix,
2476 notmuch_config_list_t **out);
2479 * Is 'config_list' iterator valid (i.e. _key, _value, _move_to_next can be called).
2481 * @since libnotmuch 4.4 (notmuch 0.23)
2484 notmuch_config_list_valid (notmuch_config_list_t *config_list);
2487 * return key for current config pair
2489 * return value is owned by the iterator, and will be destroyed by the
2490 * next call to notmuch_config_list_key or notmuch_config_list_destroy.
2492 * @since libnotmuch 4.4 (notmuch 0.23)
2495 notmuch_config_list_key (notmuch_config_list_t *config_list);
2498 * return 'value' for current config pair
2500 * return value is owned by the iterator, and will be destroyed by the
2501 * next call to notmuch_config_list_value or notmuch config_list_destroy
2503 * @since libnotmuch 4.4 (notmuch 0.23)
2504 * @retval NULL for errors
2507 notmuch_config_list_value (notmuch_config_list_t *config_list);
2511 * move 'config_list' iterator to the next pair
2513 * @since libnotmuch 4.4 (notmuch 0.23)
2516 notmuch_config_list_move_to_next (notmuch_config_list_t *config_list);
2519 * free any resources held by 'config_list'
2521 * @since libnotmuch 4.4 (notmuch 0.23)
2524 notmuch_config_list_destroy (notmuch_config_list_t *config_list);
2527 * Configuration keys known to libnotmuch
2529 typedef enum _notmuch_config_key {
2530 NOTMUCH_CONFIG_FIRST,
2531 NOTMUCH_CONFIG_DATABASE_PATH = NOTMUCH_CONFIG_FIRST,
2532 NOTMUCH_CONFIG_MAIL_ROOT,
2533 NOTMUCH_CONFIG_HOOK_DIR,
2534 NOTMUCH_CONFIG_BACKUP_DIR,
2535 NOTMUCH_CONFIG_EXCLUDE_TAGS,
2536 NOTMUCH_CONFIG_NEW_TAGS,
2537 NOTMUCH_CONFIG_NEW_IGNORE,
2538 NOTMUCH_CONFIG_SYNC_MAILDIR_FLAGS,
2539 NOTMUCH_CONFIG_PRIMARY_EMAIL,
2540 NOTMUCH_CONFIG_OTHER_EMAIL,
2541 NOTMUCH_CONFIG_USER_NAME,
2542 NOTMUCH_CONFIG_AUTOCOMMIT,
2544 } notmuch_config_key_t;
2547 * get a configuration value from an open database.
2549 * This value reflects all configuration information given at the time
2550 * the database was opened.
2552 * @param[in] notmuch database
2553 * @param[in] key configuration key
2555 * @since libnotmuch 5.4 (notmuch 0.32)
2557 * @retval NULL if 'key' unknown or if no value is known for
2558 * 'key'. Otherwise returns a string owned by notmuch which should
2559 * not be modified nor freed by the caller.
2562 notmuch_config_get (notmuch_database_t *notmuch, notmuch_config_key_t key);
2565 * set a configuration value from in an open database.
2567 * This value reflects all configuration information given at the time
2568 * the database was opened.
2570 * @param[in,out] notmuch database open read/write
2571 * @param[in] key configuration key
2572 * @param[in] val configuration value
2574 * @since libnotmuch 5.4 (notmuch 0.32)
2576 * @retval returns any return value for notmuch_database_set_config.
2579 notmuch_config_set (notmuch_database_t *notmuch, notmuch_config_key_t key, const char *val);
2582 * Returns an iterator for a ';'-delimited list of configuration values
2584 * These values reflect all configuration information given at the
2585 * time the database was opened.
2587 * @param[in] notmuch database
2588 * @param[in] key configuration key
2590 * @since libnotmuch 5.4 (notmuch 0.32)
2592 * @retval NULL in case of error.
2594 notmuch_config_values_t *
2595 notmuch_config_get_values (notmuch_database_t *notmuch, notmuch_config_key_t key);
2598 * Returns an iterator for a ';'-delimited list of configuration values
2600 * These values reflect all configuration information given at the
2601 * time the database was opened.
2603 * @param[in] notmuch database
2604 * @param[in] key configuration key
2606 * @since libnotmuch 5.4 (notmuch 0.32)
2608 * @retval NULL in case of error.
2610 notmuch_config_values_t *
2611 notmuch_config_get_values_string (notmuch_database_t *notmuch, const char *key);
2614 * Is the given 'config_values' iterator pointing at a valid element.
2616 * @param[in] values iterator
2618 * @since libnotmuch 5.4 (notmuch 0.32)
2620 * @retval FALSE if passed a NULL pointer, or the iterator is exhausted.
2624 notmuch_config_values_valid (notmuch_config_values_t *values);
2627 * Get the current value from the 'values' iterator
2629 * @param[in] values iterator
2631 * @since libnotmuch 5.4 (notmuch 0.32)
2633 * @retval a string with the same lifetime as the iterator
2636 notmuch_config_values_get (notmuch_config_values_t *values);
2639 * Move the 'values' iterator to the next element
2641 * @param[in,out] values iterator
2643 * @since libnotmuch 5.4 (notmuch 0.32)
2647 notmuch_config_values_move_to_next (notmuch_config_values_t *values);
2651 * reset the 'values' iterator to the first element
2653 * @param[in,out] values iterator. A NULL value is ignored.
2655 * @since libnotmuch 5.4 (notmuch 0.32)
2659 notmuch_config_values_start (notmuch_config_values_t *values);
2662 * Destroy a config values iterator, along with any associated
2665 * @param[in,out] values iterator
2667 * @since libnotmuch 5.4 (notmuch 0.32)
2670 notmuch_config_values_destroy (notmuch_config_values_t *values);
2674 * Returns an iterator for a (key, value) configuration pairs
2676 * @param[in] notmuch database
2677 * @param[in] prefix prefix for keys. Pass "" for all keys.
2679 * @since libnotmuch 5.4 (notmuch 0.32)
2681 * @retval NULL in case of error.
2683 notmuch_config_pairs_t *
2684 notmuch_config_get_pairs (notmuch_database_t *notmuch,
2685 const char *prefix);
2688 * Is the given 'config_pairs' iterator pointing at a valid element.
2690 * @param[in] pairs iterator
2692 * @since libnotmuch 5.4 (notmuch 0.32)
2694 * @retval FALSE if passed a NULL pointer, or the iterator is exhausted.
2698 notmuch_config_pairs_valid (notmuch_config_pairs_t *pairs);
2701 * Move the 'config_pairs' iterator to the next element
2703 * @param[in,out] pairs iterator
2705 * @since libnotmuch 5.4 (notmuch 0.32)
2709 notmuch_config_pairs_move_to_next (notmuch_config_pairs_t *pairs);
2712 * Get the current key from the 'config_pairs' iterator
2714 * @param[in] pairs iterator
2716 * @since libnotmuch 5.4 (notmuch 0.32)
2718 * @retval a string with the same lifetime as the iterator
2721 notmuch_config_pairs_key (notmuch_config_pairs_t *pairs);
2724 * Get the current value from the 'config_pairs' iterator
2726 * @param[in] pairs iterator
2728 * @since libnotmuch 5.4 (notmuch 0.32)
2730 * @retval a string with the same lifetime as the iterator
2733 notmuch_config_pairs_value (notmuch_config_pairs_t *pairs);
2736 * Destroy a config_pairs iterator, along with any associated
2739 * @param[in,out] pairs iterator
2741 * @since libnotmuch 5.4 (notmuch 0.32)
2744 notmuch_config_pairs_destroy (notmuch_config_pairs_t *pairs);
2747 * get a configuration value from an open database as Boolean
2749 * This value reflects all configuration information given at the time
2750 * the database was opened.
2752 * @param[in] notmuch database
2753 * @param[in] key configuration key
2754 * @param[out] val configuration value, converted to Boolean
2756 * @since libnotmuch 5.4 (notmuch 0.32)
2758 * @retval #NOTMUCH_STATUS_ILLEGAL_ARGUMENT if either key is unknown
2759 * or the corresponding value does not convert to Boolean.
2762 notmuch_config_get_bool (notmuch_database_t *notmuch,
2763 notmuch_config_key_t key,
2764 notmuch_bool_t *val);
2767 * return the path of the config file loaded, if any
2769 * @retval NULL if no config file was loaded
2772 notmuch_config_path (notmuch_database_t *notmuch);
2775 * get the current default indexing options for a given database.
2777 * This object will survive until the database itself is destroyed,
2778 * but the caller may also release it earlier with
2779 * notmuch_indexopts_destroy.
2781 * This object represents a set of options on how a message can be
2782 * added to the index. At the moment it is a featureless stub.
2784 * @since libnotmuch 5.1 (notmuch 0.26)
2785 * @retval NULL in case of error
2787 notmuch_indexopts_t *
2788 notmuch_database_get_default_indexopts (notmuch_database_t *db);
2791 * Stating a policy about how to decrypt messages.
2793 * See index.decrypt in notmuch-config(1) for more details.
2796 NOTMUCH_DECRYPT_FALSE,
2797 NOTMUCH_DECRYPT_TRUE,
2798 NOTMUCH_DECRYPT_AUTO,
2799 NOTMUCH_DECRYPT_NOSTASH,
2800 } notmuch_decryption_policy_t;
2803 * Specify whether to decrypt encrypted parts while indexing.
2805 * Be aware that the index is likely sufficient to reconstruct the
2806 * cleartext of the message itself, so please ensure that the notmuch
2807 * message index is adequately protected. DO NOT SET THIS FLAG TO TRUE
2808 * without considering the security of your index.
2810 * @since libnotmuch 5.1 (notmuch 0.26)
2813 notmuch_indexopts_set_decrypt_policy (notmuch_indexopts_t *indexopts,
2814 notmuch_decryption_policy_t decrypt_policy);
2817 * Return whether to decrypt encrypted parts while indexing.
2818 * see notmuch_indexopts_set_decrypt_policy.
2820 * @since libnotmuch 5.1 (notmuch 0.26)
2822 notmuch_decryption_policy_t
2823 notmuch_indexopts_get_decrypt_policy (const notmuch_indexopts_t *indexopts);
2826 * Destroy a notmuch_indexopts_t object.
2828 * @since libnotmuch 5.1 (notmuch 0.26)
2831 notmuch_indexopts_destroy (notmuch_indexopts_t *options);
2835 * interrogate the library for compile time features
2837 * @since libnotmuch 4.4 (notmuch 0.23)
2840 notmuch_built_with (const char *name);
2843 #pragma GCC visibility pop