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 * Unable to load a database
218 NOTMUCH_STATUS_NO_DATABASE,
220 * Database exists, so not (re)-created
222 NOTMUCH_STATUS_DATABASE_EXISTS,
224 * Not an actual status value. Just a way to find out how many
225 * valid status values there are.
227 NOTMUCH_STATUS_LAST_STATUS
231 * Get a string representation of a notmuch_status_t value.
233 * The result is read-only.
236 notmuch_status_to_string (notmuch_status_t status);
238 /* Various opaque data types. For each notmuch_<foo>_t see the various
239 * notmuch_<foo> functions below. */
241 typedef struct _notmuch_database notmuch_database_t;
242 typedef struct _notmuch_query notmuch_query_t;
243 typedef struct _notmuch_threads notmuch_threads_t;
244 typedef struct _notmuch_thread notmuch_thread_t;
245 typedef struct _notmuch_messages notmuch_messages_t;
246 typedef struct _notmuch_message notmuch_message_t;
247 typedef struct _notmuch_tags notmuch_tags_t;
248 typedef struct _notmuch_directory notmuch_directory_t;
249 typedef struct _notmuch_filenames notmuch_filenames_t;
250 typedef struct _notmuch_config_list notmuch_config_list_t;
251 typedef struct _notmuch_config_values notmuch_config_values_t;
252 typedef struct _notmuch_config_pairs notmuch_config_pairs_t;
253 typedef struct _notmuch_indexopts notmuch_indexopts_t;
254 #endif /* __DOXYGEN__ */
257 * Create a new, empty notmuch database located at 'path'.
259 * The path should be a top-level directory to a collection of
260 * plain-text email messages (one message per file). This call will
261 * create a new ".notmuch" directory within 'path' where notmuch will
264 * After a successful call to notmuch_database_create, the returned
265 * database will be open so the caller should call
266 * notmuch_database_destroy when finished with it.
268 * The database will not yet have any data in it
269 * (notmuch_database_create itself is a very cheap function). Messages
270 * contained within 'path' can be added to the database by calling
271 * notmuch_database_index_file.
273 * In case of any failure, this function returns an error status and
274 * sets *database to NULL (after printing an error message on stderr).
278 * NOTMUCH_STATUS_SUCCESS: Successfully created the database.
280 * NOTMUCH_STATUS_NULL_POINTER: The given 'path' argument is NULL.
282 * NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory.
284 * NOTMUCH_STATUS_FILE_ERROR: An error occurred trying to create the
285 * database file (such as permission denied, or file not found,
286 * etc.), or the database already exists.
288 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred.
291 notmuch_database_create (const char *path, notmuch_database_t **database);
294 * Like notmuch_database_create, except optionally return an error
295 * message. This message is allocated by malloc and should be freed by
299 notmuch_database_create_verbose (const char *path,
300 notmuch_database_t **database,
301 char **error_message);
304 * Database open mode for notmuch_database_open.
308 * Open database for reading only.
310 NOTMUCH_DATABASE_MODE_READ_ONLY = 0,
312 * Open database for reading and writing.
314 NOTMUCH_DATABASE_MODE_READ_WRITE
315 } notmuch_database_mode_t;
318 * Deprecated alias for notmuch_database_open_with_config with
319 * config_path=error_message=NULL
320 * @deprecated Deprecated as of libnotmuch 5.4 (notmuch 0.32)
322 /* NOTMUCH_DEPRECATED(5, 4) */
324 notmuch_database_open (const char *path,
325 notmuch_database_mode_t mode,
326 notmuch_database_t **database);
328 * Deprecated alias for notmuch_database_open_with_config with
331 * @deprecated Deprecated as of libnotmuch 5.4 (notmuch 0.32)
334 /* NOTMUCH_DEPRECATED(5, 4) */
336 notmuch_database_open_verbose (const char *path,
337 notmuch_database_mode_t mode,
338 notmuch_database_t **database,
339 char **error_message);
342 * Open an existing notmuch database located at 'database_path', using
343 * configuration in 'config_path'.
345 * @param[in] database_path
347 * Path to existing database.
349 * A notmuch database is a Xapian database containing appropriate
352 * The database should have been created at some time in the past,
353 * (not necessarily by this process), by calling
354 * notmuch_database_create.
356 * If 'database_path' is NULL, use the location specified
358 * - in the environment variable NOTMUCH_DATABASE, if non-empty
360 * - in a configuration file, located as described under 'config_path'
362 * - by $XDG_DATA_HOME/notmuch/$PROFILE where XDG_DATA_HOME defaults
363 * to "$HOME/.local/share" and PROFILE as as discussed in
366 * If 'database_path' is non-NULL, but does not appear to be a Xapian
367 * database, check for a directory '.notmuch/xapian' below
368 * 'database_path' (this is the behavior of
369 * notmuch_database_open_verbose pre-0.32).
374 * Mode to open database. Use one of #NOTMUCH_DATABASE_MODE_READ_WRITE
375 * or #NOTMUCH_DATABASE_MODE_READ_ONLY
378 * @param[in] config_path
380 * Path to config file.
382 * Config file is key-value, with mandatory sections. See
383 * <em>notmuch-config(5)</em> for more information. The key-value pair
384 * overrides the corresponding configuration data stored in the
385 * database (see <em>notmuch_database_get_config</em>)
387 * If <em>config_path</em> is NULL use the path specified
389 * - in environment variable <em>NOTMUCH_CONFIG</em>, if non-empty
391 * - by <em>XDG_CONFIG_HOME</em>/notmuch/ where
392 * XDG_CONFIG_HOME defaults to "$HOME/.config".
394 * - by $HOME/.notmuch-config
396 * If <em>config_path</em> is "" (empty string) then do not
397 * open any configuration file.
399 * @param[in] profile:
401 * Name of profile (configuration/database variant).
403 * If non-NULL, append to the directory / file path determined for
404 * <em>config_path</em> and <em>database_path</em>.
407 * - environment variable NOTMUCH_PROFILE if defined,
408 * - otherwise "default" for directories and "" (empty string) for paths.
411 * @param[out] database
413 * Pointer to database object. May not be NULL.
415 * The caller should call notmuch_database_destroy when finished with
418 * In case of any failure, this function returns an error status and
419 * sets *database to NULL.
422 * @param[out] error_message
423 * If non-NULL, store error message from opening the database.
424 * Any such message is allocated by \a malloc(3) and should be freed
427 * @retval NOTMUCH_STATUS_SUCCESS: Successfully opened the database.
429 * @retval NOTMUCH_STATUS_NULL_POINTER: The given \a database
432 * @retval NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory.
434 * @retval NOTMUCH_STATUS_FILE_ERROR: An error occurred trying to open the
435 * database or config file (such as permission denied, or file not found,
436 * etc.), or the database version is unknown.
438 * @retval NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred.
440 * @since libnotmuch 5.4 (notmuch 0.32)
444 notmuch_database_open_with_config (const char *database_path,
445 notmuch_database_mode_t mode,
446 const char *config_path,
448 notmuch_database_t **database,
449 char **error_message);
453 * Loads configuration from config file, database, and/or defaults
455 * For description of arguments, @see notmuch_database_open_with_config
457 * @retval NOTMUCH_STATUS_SUCCESS: Successfully loaded (some) configuration.
459 * @retval NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory.
461 * @retval NOTMUCH_STATUS_FILE_ERROR: An error occurred trying to open the
462 * database or config file (such as permission denied, or file not found,
465 * @retval NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred.
467 * @since libnotmuch 5.4 (notmuch 0.32)
471 notmuch_database_load_config (const char *database_path,
472 const char *config_path,
474 notmuch_database_t **database,
475 char **error_message);
478 * Create a new notmuch database located at 'database_path', using
479 * configuration in 'config_path'.
481 * For description of arguments, @see notmuch_database_open_with_config
483 * @retval NOTMUCH_STATUS_SUCCESS: Successfully created the database.
485 * @retval NOTMUCH_STATUS_DATABASE_EXISTS: Database already exists, not created
487 * @retval NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory.
489 * @retval NOTMUCH_STATUS_FILE_ERROR: An error occurred trying to open the
490 * database or config file (such as permission denied, or file not found,
493 * @retval NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred.
495 * @since libnotmuch 5.4 (notmuch 0.32)
499 notmuch_database_create_with_config (const char *database_path,
500 const char *config_path,
502 notmuch_database_t **database,
503 char **error_message);
506 * Retrieve last status string for given database.
510 notmuch_database_status_string (const notmuch_database_t *notmuch);
513 * Commit changes and close the given notmuch database.
515 * After notmuch_database_close has been called, calls to other
516 * functions on objects derived from this database may either behave
517 * as if the database had not been closed (e.g., if the required data
518 * has been cached) or may fail with a
519 * NOTMUCH_STATUS_XAPIAN_EXCEPTION. The only further operation
520 * permitted on the database itself is to call
521 * notmuch_database_destroy.
523 * notmuch_database_close can be called multiple times. Later calls
526 * For writable databases, notmuch_database_close commits all changes
527 * to disk before closing the database. If the caller is currently in
528 * an atomic section (there was a notmuch_database_begin_atomic
529 * without a matching notmuch_database_end_atomic), this will discard
530 * changes made in that atomic section (but still commit changes made
531 * prior to entering the atomic section).
535 * NOTMUCH_STATUS_SUCCESS: Successfully closed the database.
537 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred; the
538 * database has been closed but there are no guarantees the
539 * changes to the database, if any, have been flushed to disk.
542 notmuch_database_close (notmuch_database_t *database);
545 * A callback invoked by notmuch_database_compact to notify the user
546 * of the progress of the compaction process.
548 typedef void (*notmuch_compact_status_cb_t)(const char *message, void *closure);
551 * Compact a notmuch database, backing up the original database to the
554 * The database will be opened with NOTMUCH_DATABASE_MODE_READ_WRITE
555 * during the compaction process to ensure no writes are made.
557 * If the optional callback function 'status_cb' is non-NULL, it will
558 * be called with diagnostic and informational messages. The argument
559 * 'closure' is passed verbatim to any callback invoked.
562 notmuch_database_compact (const char *path,
563 const char *backup_path,
564 notmuch_compact_status_cb_t status_cb,
568 * Like notmuch_database_compact, but take an open database as a
571 * @since libnnotmuch 5.4 (notmuch 0.32)
574 notmuch_database_compact_db (notmuch_database_t *database,
575 const char *backup_path,
576 notmuch_compact_status_cb_t status_cb,
580 * Destroy the notmuch database, closing it if necessary and freeing
581 * all associated resources.
583 * Return value as in notmuch_database_close if the database was open;
584 * notmuch_database_destroy itself has no failure modes.
587 notmuch_database_destroy (notmuch_database_t *database);
590 * Return the database path of the given database.
592 * The return value is a string owned by notmuch so should not be
593 * modified nor freed by the caller.
596 notmuch_database_get_path (notmuch_database_t *database);
599 * Return the database format version of the given database.
604 notmuch_database_get_version (notmuch_database_t *database);
607 * Can the database be upgraded to a newer database version?
609 * If this function returns TRUE, then the caller may call
610 * notmuch_database_upgrade to upgrade the database. If the caller
611 * does not upgrade an out-of-date database, then some functions may
612 * fail with NOTMUCH_STATUS_UPGRADE_REQUIRED. This always returns
613 * FALSE for a read-only database because there's no way to upgrade a
614 * read-only database.
616 * Also returns FALSE if an error occurs accessing the database.
620 notmuch_database_needs_upgrade (notmuch_database_t *database);
623 * Upgrade the current database to the latest supported version.
625 * This ensures that all current notmuch functionality will be
626 * available on the database. After opening a database in read-write
627 * mode, it is recommended that clients check if an upgrade is needed
628 * (notmuch_database_needs_upgrade) and if so, upgrade with this
629 * function before making any modifications. If
630 * notmuch_database_needs_upgrade returns FALSE, this will be a no-op.
632 * The optional progress_notify callback can be used by the caller to
633 * provide progress indication to the user. If non-NULL it will be
634 * called periodically with 'progress' as a floating-point value in
635 * the range of [0.0 .. 1.0] indicating the progress made so far in
636 * the upgrade process. The argument 'closure' is passed verbatim to
637 * any callback invoked.
640 notmuch_database_upgrade (notmuch_database_t *database,
641 void (*progress_notify)(void *closure,
646 * Begin an atomic database operation.
648 * Any modifications performed between a successful begin and a
649 * notmuch_database_end_atomic will be applied to the database
650 * atomically. Note that, unlike a typical database transaction, this
651 * only ensures atomicity, not durability; neither begin nor end
652 * necessarily flush modifications to disk.
654 * Atomic sections may be nested. begin_atomic and end_atomic must
655 * always be called in pairs.
659 * NOTMUCH_STATUS_SUCCESS: Successfully entered atomic section.
661 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred;
662 * atomic section not entered.
665 notmuch_database_begin_atomic (notmuch_database_t *notmuch);
668 * Indicate the end of an atomic database operation.
672 * NOTMUCH_STATUS_SUCCESS: Successfully completed atomic section.
674 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred;
675 * atomic section not ended.
677 * NOTMUCH_STATUS_UNBALANCED_ATOMIC: The database is not currently in
681 notmuch_database_end_atomic (notmuch_database_t *notmuch);
684 * Return the committed database revision and UUID.
686 * The database revision number increases monotonically with each
687 * commit to the database. Hence, all messages and message changes
688 * committed to the database (that is, visible to readers) have a last
689 * modification revision <= the committed database revision. Any
690 * messages committed in the future will be assigned a modification
691 * revision > the committed database revision.
693 * The UUID is a NUL-terminated opaque string that uniquely identifies
694 * this database. Two revision numbers are only comparable if they
695 * have the same database UUID.
698 notmuch_database_get_revision (notmuch_database_t *notmuch,
702 * Retrieve a directory object from the database for 'path'.
704 * Here, 'path' should be a path relative to the path of 'database'
705 * (see notmuch_database_get_path), or else should be an absolute path
706 * with initial components that match the path of 'database'.
708 * If this directory object does not exist in the database, this
709 * returns NOTMUCH_STATUS_SUCCESS and sets *directory to NULL.
711 * Otherwise the returned directory object is owned by the database
712 * and as such, will only be valid until notmuch_database_destroy is
717 * NOTMUCH_STATUS_SUCCESS: Successfully retrieved directory.
719 * NOTMUCH_STATUS_NULL_POINTER: The given 'directory' argument is NULL.
721 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred;
722 * directory not retrieved.
724 * NOTMUCH_STATUS_UPGRADE_REQUIRED: The caller must upgrade the
725 * database to use this function.
728 notmuch_database_get_directory (notmuch_database_t *database,
730 notmuch_directory_t **directory);
733 * Add a message file to a database, indexing it for retrieval by
734 * future searches. If a message already exists with the same message
735 * ID as the specified file, their indexes will be merged, and this
736 * new filename will also be associated with the existing message.
738 * Here, 'filename' should be a path relative to the path of
739 * 'database' (see notmuch_database_get_path), or else should be an
740 * absolute filename with initial components that match the path of
743 * The file should be a single mail message (not a multi-message mbox)
744 * that is expected to remain at its current location, (since the
745 * notmuch database will reference the filename, and will not copy the
746 * entire contents of the file.
748 * If another message with the same message ID already exists in the
749 * database, rather than creating a new message, this adds the search
750 * terms from the identified file to the existing message's index, and
751 * adds 'filename' to the list of filenames known for the message.
753 * The 'indexopts' parameter can be NULL (meaning, use the indexing
754 * defaults from the database), or can be an explicit choice of
755 * indexing options that should govern the indexing of this specific
758 * If 'message' is not NULL, then, on successful return
759 * (NOTMUCH_STATUS_SUCCESS or NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID) '*message'
760 * will be initialized to a message object that can be used for things
761 * such as adding tags to the just-added message. The user should call
762 * notmuch_message_destroy when done with the message. On any failure
763 * '*message' will be set to NULL.
767 * NOTMUCH_STATUS_SUCCESS: Message successfully added to database.
769 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred,
772 * NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID: Message has the same message
773 * ID as another message already in the database. The new
774 * filename was successfully added to the message in the database
775 * (if not already present) and the existing message is returned.
777 * NOTMUCH_STATUS_FILE_ERROR: an error occurred trying to open the
778 * file, (such as permission denied, or file not found,
779 * etc.). Nothing added to the database.
781 * NOTMUCH_STATUS_FILE_NOT_EMAIL: the contents of filename don't look
782 * like an email message. Nothing added to the database.
784 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
785 * mode so no message can be added.
787 * NOTMUCH_STATUS_UPGRADE_REQUIRED: The caller must upgrade the
788 * database to use this function.
790 * @since libnotmuch 5.1 (notmuch 0.26)
793 notmuch_database_index_file (notmuch_database_t *database,
794 const char *filename,
795 notmuch_indexopts_t *indexopts,
796 notmuch_message_t **message);
799 * Deprecated alias for notmuch_database_index_file called with
802 * @deprecated Deprecated as of libnotmuch 5.1 (notmuch 0.26). Please
803 * use notmuch_database_index_file instead.
806 NOTMUCH_DEPRECATED (5, 1)
808 notmuch_database_add_message (notmuch_database_t *database,
809 const char *filename,
810 notmuch_message_t **message);
813 * Remove a message filename from the given notmuch database. If the
814 * message has no more filenames, remove the message.
816 * If the same message (as determined by the message ID) is still
817 * available via other filenames, then the message will persist in the
818 * database for those filenames. When the last filename is removed for
819 * a particular message, the database content for that message will be
824 * NOTMUCH_STATUS_SUCCESS: The last filename was removed and the
825 * message was removed from the database.
827 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred,
828 * message not removed.
830 * NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID: This filename was removed but
831 * the message persists in the database with at least one other
834 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
835 * mode so no message can be removed.
837 * NOTMUCH_STATUS_UPGRADE_REQUIRED: The caller must upgrade the
838 * database to use this function.
841 notmuch_database_remove_message (notmuch_database_t *database,
842 const char *filename);
845 * Find a message with the given message_id.
847 * If a message with the given message_id is found then, on successful return
848 * (NOTMUCH_STATUS_SUCCESS) '*message' will be initialized to a message
849 * object. The caller should call notmuch_message_destroy when done with the
852 * On any failure or when the message is not found, this function initializes
853 * '*message' to NULL. This means, when NOTMUCH_STATUS_SUCCESS is returned, the
854 * caller is supposed to check '*message' for NULL to find out whether the
855 * message with the given message_id was found.
859 * NOTMUCH_STATUS_SUCCESS: Successful return, check '*message'.
861 * NOTMUCH_STATUS_NULL_POINTER: The given 'message' argument is NULL
863 * NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory, creating message object
865 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred
868 notmuch_database_find_message (notmuch_database_t *database,
869 const char *message_id,
870 notmuch_message_t **message);
873 * Find a message with the given filename.
875 * If the database contains a message with the given filename then, on
876 * successful return (NOTMUCH_STATUS_SUCCESS) '*message' will be initialized to
877 * a message object. The caller should call notmuch_message_destroy when done
880 * On any failure or when the message is not found, this function initializes
881 * '*message' to NULL. This means, when NOTMUCH_STATUS_SUCCESS is returned, the
882 * caller is supposed to check '*message' for NULL to find out whether the
883 * message with the given filename is found.
887 * NOTMUCH_STATUS_SUCCESS: Successful return, check '*message'
889 * NOTMUCH_STATUS_NULL_POINTER: The given 'message' argument is NULL
891 * NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory, creating the message object
893 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred
895 * NOTMUCH_STATUS_UPGRADE_REQUIRED: The caller must upgrade the
896 * database to use this function.
899 notmuch_database_find_message_by_filename (notmuch_database_t *notmuch,
900 const char *filename,
901 notmuch_message_t **message);
904 * Return a list of all tags found in the database.
906 * This function creates a list of all tags found in the database. The
907 * resulting list contains all tags from all messages found in the database.
909 * On error this function returns NULL.
912 notmuch_database_get_all_tags (notmuch_database_t *db);
915 * Reopen an open notmuch database.
917 * @param [in] db open notmuch database
918 * @param [in] mode mode (read only or read-write) for reopened database.
920 * @retval #NOTMUCH_STATUS_SUCCESS
921 * @retval #NOTMUCH_STATUS_ILLEGAL_ARGUMENT The passed database was not open.
922 * @retval #NOTMUCH_STATUS_XAPIAN_EXCEPTION A Xapian exception occured
925 notmuch_database_reopen (notmuch_database_t *db, notmuch_database_mode_t mode);
928 * Create a new query for 'database'.
930 * Here, 'database' should be an open database, (see
931 * notmuch_database_open and notmuch_database_create).
933 * For the query string, we'll document the syntax here more
934 * completely in the future, but it's likely to be a specialized
935 * version of the general Xapian query syntax:
937 * https://xapian.org/docs/queryparser.html
939 * As a special case, passing either a length-zero string, (that is ""),
940 * or a string consisting of a single asterisk (that is "*"), will
941 * result in a query that returns all messages in the database.
943 * See notmuch_query_set_sort for controlling the order of results.
944 * See notmuch_query_search_messages and notmuch_query_search_threads
945 * to actually execute the query.
947 * User should call notmuch_query_destroy when finished with this
950 * Will return NULL if insufficient memory is available.
953 notmuch_query_create (notmuch_database_t *database,
954 const char *query_string);
957 * Sort values for notmuch_query_set_sort.
963 NOTMUCH_SORT_OLDEST_FIRST,
967 NOTMUCH_SORT_NEWEST_FIRST,
969 * Sort by message-id.
971 NOTMUCH_SORT_MESSAGE_ID,
975 NOTMUCH_SORT_UNSORTED
979 * Return the query_string of this query. See notmuch_query_create.
982 notmuch_query_get_query_string (const notmuch_query_t *query);
985 * Return the notmuch database of this query. See notmuch_query_create.
988 notmuch_query_get_database (const notmuch_query_t *query);
991 * Exclude values for notmuch_query_set_omit_excluded. The strange
992 * order is to maintain backward compatibility: the old FALSE/TRUE
993 * options correspond to the new
994 * NOTMUCH_EXCLUDE_FLAG/NOTMUCH_EXCLUDE_TRUE options.
997 NOTMUCH_EXCLUDE_FLAG,
998 NOTMUCH_EXCLUDE_TRUE,
999 NOTMUCH_EXCLUDE_FALSE,
1001 } notmuch_exclude_t;
1004 * Specify whether to omit excluded results or simply flag them. By
1005 * default, this is set to TRUE.
1007 * If set to TRUE or ALL, notmuch_query_search_messages will omit excluded
1008 * messages from the results, and notmuch_query_search_threads will omit
1009 * threads that match only in excluded messages. If set to TRUE,
1010 * notmuch_query_search_threads will include all messages in threads that
1011 * match in at least one non-excluded message. Otherwise, if set to ALL,
1012 * notmuch_query_search_threads will omit excluded messages from all threads.
1014 * If set to FALSE or FLAG then both notmuch_query_search_messages and
1015 * notmuch_query_search_threads will return all matching
1016 * messages/threads regardless of exclude status. If set to FLAG then
1017 * the exclude flag will be set for any excluded message that is
1018 * returned by notmuch_query_search_messages, and the thread counts
1019 * for threads returned by notmuch_query_search_threads will be the
1020 * number of non-excluded messages/matches. Otherwise, if set to
1021 * FALSE, then the exclude status is completely ignored.
1023 * The performance difference when calling
1024 * notmuch_query_search_messages should be relatively small (and both
1025 * should be very fast). However, in some cases,
1026 * notmuch_query_search_threads is very much faster when omitting
1027 * excluded messages as it does not need to construct the threads that
1028 * only match in excluded messages.
1031 notmuch_query_set_omit_excluded (notmuch_query_t *query,
1032 notmuch_exclude_t omit_excluded);
1035 * Specify the sorting desired for this query.
1038 notmuch_query_set_sort (notmuch_query_t *query, notmuch_sort_t sort);
1041 * Return the sort specified for this query. See
1042 * notmuch_query_set_sort.
1045 notmuch_query_get_sort (const notmuch_query_t *query);
1048 * Add a tag that will be excluded from the query results by default.
1049 * This exclusion will be ignored if this tag appears explicitly in
1054 * NOTMUCH_STATUS_SUCCESS: excluded was added successfully.
1056 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: a Xapian exception occurred.
1057 * Most likely a problem lazily parsing the query string.
1059 * NOTMUCH_STATUS_IGNORED: tag is explicitly present in the query, so
1063 notmuch_query_add_tag_exclude (notmuch_query_t *query, const char *tag);
1066 * Execute a query for threads, returning a notmuch_threads_t object
1067 * which can be used to iterate over the results. The returned threads
1068 * object is owned by the query and as such, will only be valid until
1069 * notmuch_query_destroy.
1071 * Typical usage might be:
1073 * notmuch_query_t *query;
1074 * notmuch_threads_t *threads;
1075 * notmuch_thread_t *thread;
1076 * notmuch_status_t stat;
1078 * query = notmuch_query_create (database, query_string);
1080 * for (stat = notmuch_query_search_threads (query, &threads);
1081 * stat == NOTMUCH_STATUS_SUCCESS &&
1082 * notmuch_threads_valid (threads);
1083 * notmuch_threads_move_to_next (threads))
1085 * thread = notmuch_threads_get (threads);
1087 * notmuch_thread_destroy (thread);
1090 * notmuch_query_destroy (query);
1092 * Note: If you are finished with a thread before its containing
1093 * query, you can call notmuch_thread_destroy to clean up some memory
1094 * sooner (as in the above example). Otherwise, if your thread objects
1095 * are long-lived, then you don't need to call notmuch_thread_destroy
1096 * and all the memory will still be reclaimed when the query is
1099 * Note that there's no explicit destructor needed for the
1100 * notmuch_threads_t object. (For consistency, we do provide a
1101 * notmuch_threads_destroy function, but there's no good reason
1102 * to call it if the query is about to be destroyed).
1104 * @since libnotmuch 5.0 (notmuch 0.25)
1107 notmuch_query_search_threads (notmuch_query_t *query,
1108 notmuch_threads_t **out);
1111 * Deprecated alias for notmuch_query_search_threads.
1113 * @deprecated Deprecated as of libnotmuch 5 (notmuch 0.25). Please
1114 * use notmuch_query_search_threads instead.
1117 NOTMUCH_DEPRECATED (5, 0)
1119 notmuch_query_search_threads_st (notmuch_query_t *query, notmuch_threads_t **out);
1122 * Execute a query for messages, returning a notmuch_messages_t object
1123 * which can be used to iterate over the results. The returned
1124 * messages object is owned by the query and as such, will only be
1125 * valid until notmuch_query_destroy.
1127 * Typical usage might be:
1129 * notmuch_query_t *query;
1130 * notmuch_messages_t *messages;
1131 * notmuch_message_t *message;
1133 * query = notmuch_query_create (database, query_string);
1135 * for (messages = notmuch_query_search_messages (query);
1136 * notmuch_messages_valid (messages);
1137 * notmuch_messages_move_to_next (messages))
1139 * message = notmuch_messages_get (messages);
1141 * notmuch_message_destroy (message);
1144 * notmuch_query_destroy (query);
1146 * Note: If you are finished with a message before its containing
1147 * query, you can call notmuch_message_destroy to clean up some memory
1148 * sooner (as in the above example). Otherwise, if your message
1149 * objects are long-lived, then you don't need to call
1150 * notmuch_message_destroy and all the memory will still be reclaimed
1151 * when the query is destroyed.
1153 * Note that there's no explicit destructor needed for the
1154 * notmuch_messages_t object. (For consistency, we do provide a
1155 * notmuch_messages_destroy function, but there's no good
1156 * reason to call it if the query is about to be destroyed).
1158 * If a Xapian exception occurs this function will return NULL.
1160 * @since libnotmuch 5 (notmuch 0.25)
1163 notmuch_query_search_messages (notmuch_query_t *query,
1164 notmuch_messages_t **out);
1166 * Deprecated alias for notmuch_query_search_messages
1168 * @deprecated Deprecated as of libnotmuch 5 (notmuch 0.25). Please use
1169 * notmuch_query_search_messages instead.
1173 NOTMUCH_DEPRECATED (5, 0)
1175 notmuch_query_search_messages_st (notmuch_query_t *query,
1176 notmuch_messages_t **out);
1179 * Destroy a notmuch_query_t along with any associated resources.
1181 * This will in turn destroy any notmuch_threads_t and
1182 * notmuch_messages_t objects generated by this query, (and in
1183 * turn any notmuch_thread_t and notmuch_message_t objects generated
1184 * from those results, etc.), if such objects haven't already been
1188 notmuch_query_destroy (notmuch_query_t *query);
1191 * Is the given 'threads' iterator pointing at a valid thread.
1193 * When this function returns TRUE, notmuch_threads_get will return a
1194 * valid object. Whereas when this function returns FALSE,
1195 * notmuch_threads_get will return NULL.
1197 * If passed a NULL pointer, this function returns FALSE
1199 * See the documentation of notmuch_query_search_threads for example
1200 * code showing how to iterate over a notmuch_threads_t object.
1203 notmuch_threads_valid (notmuch_threads_t *threads);
1206 * Get the current thread from 'threads' as a notmuch_thread_t.
1208 * Note: The returned thread belongs to 'threads' and has a lifetime
1209 * identical to it (and the query to which it belongs).
1211 * See the documentation of notmuch_query_search_threads for example
1212 * code showing how to iterate over a notmuch_threads_t object.
1214 * If an out-of-memory situation occurs, this function will return
1218 notmuch_threads_get (notmuch_threads_t *threads);
1221 * Move the 'threads' iterator to the next thread.
1223 * If 'threads' is already pointing at the last thread then the
1224 * iterator will be moved to a point just beyond that last thread,
1225 * (where notmuch_threads_valid will return FALSE and
1226 * notmuch_threads_get will return NULL).
1228 * See the documentation of notmuch_query_search_threads for example
1229 * code showing how to iterate over a notmuch_threads_t object.
1232 notmuch_threads_move_to_next (notmuch_threads_t *threads);
1235 * Destroy a notmuch_threads_t object.
1237 * It's not strictly necessary to call this function. All memory from
1238 * the notmuch_threads_t object will be reclaimed when the
1239 * containing query object is destroyed.
1242 notmuch_threads_destroy (notmuch_threads_t *threads);
1245 * Return the number of messages matching a search.
1247 * This function performs a search and returns the number of matching
1252 * NOTMUCH_STATUS_SUCCESS: query completed successfully.
1254 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: a Xapian exception occurred. The
1255 * value of *count is not defined.
1257 * @since libnotmuch 5 (notmuch 0.25)
1260 notmuch_query_count_messages (notmuch_query_t *query, unsigned int *count);
1263 * Deprecated alias for notmuch_query_count_messages
1266 * @deprecated Deprecated since libnotmuch 5.0 (notmuch 0.25). Please
1267 * use notmuch_query_count_messages instead.
1269 NOTMUCH_DEPRECATED (5, 0)
1271 notmuch_query_count_messages_st (notmuch_query_t *query, unsigned int *count);
1274 * Return the number of threads matching a search.
1276 * This function performs a search and returns the number of unique thread IDs
1277 * in the matching messages. This is the same as number of threads matching a
1280 * Note that this is a significantly heavier operation than
1281 * notmuch_query_count_messages{_st}().
1285 * NOTMUCH_STATUS_OUT_OF_MEMORY: Memory allocation failed. The value
1286 * of *count is not defined
1288 * NOTMUCH_STATUS_SUCCESS: query completed successfully.
1290 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: a Xapian exception occurred. The
1291 * value of *count is not defined.
1293 * @since libnotmuch 5 (notmuch 0.25)
1296 notmuch_query_count_threads (notmuch_query_t *query, unsigned *count);
1299 * Deprecated alias for notmuch_query_count_threads
1301 * @deprecated Deprecated as of libnotmuch 5.0 (notmuch 0.25). Please
1302 * use notmuch_query_count_threads_st instead.
1304 NOTMUCH_DEPRECATED (5, 0)
1306 notmuch_query_count_threads_st (notmuch_query_t *query, unsigned *count);
1309 * Get the thread ID of 'thread'.
1311 * The returned string belongs to 'thread' and as such, should not be
1312 * modified by the caller and will only be valid for as long as the
1313 * thread is valid, (which is until notmuch_thread_destroy or until
1314 * the query from which it derived is destroyed).
1317 notmuch_thread_get_thread_id (notmuch_thread_t *thread);
1320 * Get the total number of messages in 'thread'.
1322 * This count consists of all messages in the database belonging to
1323 * this thread. Contrast with notmuch_thread_get_matched_messages() .
1326 notmuch_thread_get_total_messages (notmuch_thread_t *thread);
1329 * Get the total number of files in 'thread'.
1331 * This sums notmuch_message_count_files over all messages in the
1333 * @returns Non-negative integer
1334 * @since libnotmuch 5.0 (notmuch 0.25)
1338 notmuch_thread_get_total_files (notmuch_thread_t *thread);
1341 * Get a notmuch_messages_t iterator for the top-level messages in
1342 * 'thread' in oldest-first order.
1344 * This iterator will not necessarily iterate over all of the messages
1345 * in the thread. It will only iterate over the messages in the thread
1346 * which are not replies to other messages in the thread.
1348 * The returned list will be destroyed when the thread is destroyed.
1350 notmuch_messages_t *
1351 notmuch_thread_get_toplevel_messages (notmuch_thread_t *thread);
1354 * Get a notmuch_thread_t iterator for all messages in 'thread' in
1355 * oldest-first order.
1357 * The returned list will be destroyed when the thread is destroyed.
1359 notmuch_messages_t *
1360 notmuch_thread_get_messages (notmuch_thread_t *thread);
1363 * Get the number of messages in 'thread' that matched the search.
1365 * This count includes only the messages in this thread that were
1366 * matched by the search from which the thread was created and were
1367 * not excluded by any exclude tags passed in with the query (see
1368 * notmuch_query_add_tag_exclude). Contrast with
1369 * notmuch_thread_get_total_messages() .
1372 notmuch_thread_get_matched_messages (notmuch_thread_t *thread);
1375 * Get the authors of 'thread' as a UTF-8 string.
1377 * The returned string is a comma-separated list of the names of the
1378 * authors of mail messages in the query results that belong to this
1381 * The string contains authors of messages matching the query first, then
1382 * non-matched authors (with the two groups separated by '|'). Within
1383 * each group, authors are ordered by date.
1385 * The returned string belongs to 'thread' and as such, should not be
1386 * modified by the caller and will only be valid for as long as the
1387 * thread is valid, (which is until notmuch_thread_destroy or until
1388 * the query from which it derived is destroyed).
1391 notmuch_thread_get_authors (notmuch_thread_t *thread);
1394 * Get the subject of 'thread' as a UTF-8 string.
1396 * The subject is taken from the first message (according to the query
1397 * order---see notmuch_query_set_sort) in the query results that
1398 * belongs to this thread.
1400 * The returned string belongs to 'thread' and as such, should not be
1401 * modified by the caller and will only be valid for as long as the
1402 * thread is valid, (which is until notmuch_thread_destroy or until
1403 * the query from which it derived is destroyed).
1406 notmuch_thread_get_subject (notmuch_thread_t *thread);
1409 * Get the date of the oldest message in 'thread' as a time_t value.
1412 notmuch_thread_get_oldest_date (notmuch_thread_t *thread);
1415 * Get the date of the newest message in 'thread' as a time_t value.
1418 notmuch_thread_get_newest_date (notmuch_thread_t *thread);
1421 * Get the tags for 'thread', returning a notmuch_tags_t object which
1422 * can be used to iterate over all tags.
1424 * Note: In the Notmuch database, tags are stored on individual
1425 * messages, not on threads. So the tags returned here will be all
1426 * tags of the messages which matched the search and which belong to
1429 * The tags object is owned by the thread and as such, will only be
1430 * valid for as long as the thread is valid, (for example, until
1431 * notmuch_thread_destroy or until the query from which it derived is
1434 * Typical usage might be:
1436 * notmuch_thread_t *thread;
1437 * notmuch_tags_t *tags;
1440 * thread = notmuch_threads_get (threads);
1442 * for (tags = notmuch_thread_get_tags (thread);
1443 * notmuch_tags_valid (tags);
1444 * notmuch_tags_move_to_next (tags))
1446 * tag = notmuch_tags_get (tags);
1450 * notmuch_thread_destroy (thread);
1452 * Note that there's no explicit destructor needed for the
1453 * notmuch_tags_t object. (For consistency, we do provide a
1454 * notmuch_tags_destroy function, but there's no good reason to call
1455 * it if the message is about to be destroyed).
1458 notmuch_thread_get_tags (notmuch_thread_t *thread);
1461 * Destroy a notmuch_thread_t object.
1464 notmuch_thread_destroy (notmuch_thread_t *thread);
1467 * Is the given 'messages' iterator pointing at a valid message.
1469 * When this function returns TRUE, notmuch_messages_get will return a
1470 * valid object. Whereas when this function returns FALSE,
1471 * notmuch_messages_get will return NULL.
1473 * See the documentation of notmuch_query_search_messages for example
1474 * code showing how to iterate over a notmuch_messages_t object.
1477 notmuch_messages_valid (notmuch_messages_t *messages);
1480 * Get the current message from 'messages' as a notmuch_message_t.
1482 * Note: The returned message belongs to 'messages' and has a lifetime
1483 * identical to it (and the query to which it belongs).
1485 * See the documentation of notmuch_query_search_messages for example
1486 * code showing how to iterate over a notmuch_messages_t object.
1488 * If an out-of-memory situation occurs, this function will return
1492 notmuch_messages_get (notmuch_messages_t *messages);
1495 * Move the 'messages' iterator to the next message.
1497 * If 'messages' is already pointing at the last message then the
1498 * iterator will be moved to a point just beyond that last message,
1499 * (where notmuch_messages_valid will return FALSE and
1500 * notmuch_messages_get will return NULL).
1502 * See the documentation of notmuch_query_search_messages for example
1503 * code showing how to iterate over a notmuch_messages_t object.
1506 notmuch_messages_move_to_next (notmuch_messages_t *messages);
1509 * Destroy a notmuch_messages_t object.
1511 * It's not strictly necessary to call this function. All memory from
1512 * the notmuch_messages_t object will be reclaimed when the containing
1513 * query object is destroyed.
1516 notmuch_messages_destroy (notmuch_messages_t *messages);
1519 * Return a list of tags from all messages.
1521 * The resulting list is guaranteed not to contain duplicated tags.
1523 * WARNING: You can no longer iterate over messages after calling this
1524 * function, because the iterator will point at the end of the list.
1525 * We do not have a function to reset the iterator yet and the only
1526 * way how you can iterate over the list again is to recreate the
1529 * The function returns NULL on error.
1532 notmuch_messages_collect_tags (notmuch_messages_t *messages);
1535 * Get the database associated with this message.
1537 * @since libnotmuch 5.2 (notmuch 0.27)
1539 notmuch_database_t *
1540 notmuch_message_get_database (const notmuch_message_t *message);
1543 * Get the message ID of 'message'.
1545 * The returned string belongs to 'message' and as such, should not be
1546 * modified by the caller and will only be valid for as long as the
1547 * message is valid, (which is until the query from which it derived
1550 * This function will return NULL if triggers an unhandled Xapian
1554 notmuch_message_get_message_id (notmuch_message_t *message);
1557 * Get the thread ID of 'message'.
1559 * The returned string belongs to 'message' and as such, should not be
1560 * modified by the caller and will only be valid for as long as the
1561 * message is valid, (for example, until the user calls
1562 * notmuch_message_destroy on 'message' or until a query from which it
1563 * derived is destroyed).
1565 * This function will return NULL if triggers an unhandled Xapian
1569 notmuch_message_get_thread_id (notmuch_message_t *message);
1572 * Get a notmuch_messages_t iterator for all of the replies to
1575 * Note: This call only makes sense if 'message' was ultimately
1576 * obtained from a notmuch_thread_t object, (such as by coming
1577 * directly from the result of calling notmuch_thread_get_
1578 * toplevel_messages or by any number of subsequent
1579 * calls to notmuch_message_get_replies).
1581 * If 'message' was obtained through some non-thread means, (such as
1582 * by a call to notmuch_query_search_messages), then this function
1585 * If there are no replies to 'message', this function will return
1586 * NULL. (Note that notmuch_messages_valid will accept that NULL
1587 * value as legitimate, and simply return FALSE for it.)
1589 * This function also returns NULL if it triggers a Xapian exception.
1591 * The returned list will be destroyed when the thread is
1594 notmuch_messages_t *
1595 notmuch_message_get_replies (notmuch_message_t *message);
1598 * Get the total number of files associated with a message.
1599 * @returns Non-negative integer for file count.
1600 * @returns Negative integer for error.
1601 * @since libnotmuch 5.0 (notmuch 0.25)
1604 notmuch_message_count_files (notmuch_message_t *message);
1607 * Get a filename for the email corresponding to 'message'.
1609 * The returned filename is an absolute filename, (the initial
1610 * component will match notmuch_database_get_path() ).
1612 * The returned string belongs to the message so should not be
1613 * modified or freed by the caller (nor should it be referenced after
1614 * the message is destroyed).
1616 * Note: If this message corresponds to multiple files in the mail
1617 * store, (that is, multiple files contain identical message IDs),
1618 * this function will arbitrarily return a single one of those
1619 * filenames. See notmuch_message_get_filenames for returning the
1620 * complete list of filenames.
1622 * This function returns NULL if it triggers a Xapian exception.
1625 notmuch_message_get_filename (notmuch_message_t *message);
1628 * Get all filenames for the email corresponding to 'message'.
1630 * Returns a notmuch_filenames_t iterator listing all the filenames
1631 * associated with 'message'. These files may not have identical
1632 * content, but each will have the identical Message-ID.
1634 * Each filename in the iterator is an absolute filename, (the initial
1635 * component will match notmuch_database_get_path() ).
1637 * This function returns NULL if it triggers a Xapian exception.
1639 notmuch_filenames_t *
1640 notmuch_message_get_filenames (notmuch_message_t *message);
1643 * Re-index the e-mail corresponding to 'message' using the supplied index options
1645 * Returns the status of the re-index operation. (see the return
1646 * codes documented in notmuch_database_index_file)
1648 * After reindexing, the user should discard the message object passed
1649 * in here by calling notmuch_message_destroy, since it refers to the
1650 * original message, not to the reindexed message.
1653 notmuch_message_reindex (notmuch_message_t *message,
1654 notmuch_indexopts_t *indexopts);
1659 typedef enum _notmuch_message_flag {
1660 NOTMUCH_MESSAGE_FLAG_MATCH,
1661 NOTMUCH_MESSAGE_FLAG_EXCLUDED,
1663 /* This message is a "ghost message", meaning it has no filenames
1664 * or content, but we know it exists because it was referenced by
1665 * some other message. A ghost message has only a message ID and
1668 NOTMUCH_MESSAGE_FLAG_GHOST,
1669 } notmuch_message_flag_t;
1672 * Get a value of a flag for the email corresponding to 'message'.
1674 * returns FALSE in case of errors.
1676 * @deprecated Deprecated as of libnotmuch 5.3 (notmuch 0.31). Please
1677 * use notmuch_message_get_flag_st instead.
1679 NOTMUCH_DEPRECATED (5, 3)
1681 notmuch_message_get_flag (notmuch_message_t *message,
1682 notmuch_message_flag_t flag);
1685 * Get a value of a flag for the email corresponding to 'message'.
1687 * @param message a message object
1688 * @param flag flag to check
1689 * @param is_set pointer to boolean to store flag value.
1691 * @retval #NOTMUCH_STATUS_SUCCESS
1692 * @retval #NOTMUCH_STATUS_NULL_POINTER is_set is NULL
1693 * @retval #NOTMUCH_STATUS_XAPIAN_EXCEPTION Accessing the database
1694 * triggered an exception.
1696 * @since libnotmuch 5.3 (notmuch 0.31)
1699 notmuch_message_get_flag_st (notmuch_message_t *message,
1700 notmuch_message_flag_t flag,
1701 notmuch_bool_t *is_set);
1704 * Set a value of a flag for the email corresponding to 'message'.
1707 notmuch_message_set_flag (notmuch_message_t *message,
1708 notmuch_message_flag_t flag, notmuch_bool_t value);
1711 * Get the date of 'message' as a time_t value.
1713 * For the original textual representation of the Date header from the
1714 * message call notmuch_message_get_header() with a header value of
1717 * Returns 0 in case of error.
1720 notmuch_message_get_date (notmuch_message_t *message);
1723 * Get the value of the specified header from 'message' as a UTF-8 string.
1725 * Common headers are stored in the database when the message is
1726 * indexed and will be returned from the database. Other headers will
1727 * be read from the actual message file.
1729 * The header name is case insensitive.
1731 * The returned string belongs to the message so should not be
1732 * modified or freed by the caller (nor should it be referenced after
1733 * the message is destroyed).
1735 * Returns an empty string ("") if the message does not contain a
1736 * header line matching 'header'. Returns NULL if any error occurs.
1739 notmuch_message_get_header (notmuch_message_t *message, const char *header);
1742 * Get the tags for 'message', returning a notmuch_tags_t object which
1743 * can be used to iterate over all tags.
1745 * The tags object is owned by the message and as such, will only be
1746 * valid for as long as the message is valid, (which is until the
1747 * query from which it derived is destroyed).
1749 * Typical usage might be:
1751 * notmuch_message_t *message;
1752 * notmuch_tags_t *tags;
1755 * message = notmuch_database_find_message (database, message_id);
1757 * for (tags = notmuch_message_get_tags (message);
1758 * notmuch_tags_valid (tags);
1759 * notmuch_tags_move_to_next (tags))
1761 * tag = notmuch_tags_get (tags);
1765 * notmuch_message_destroy (message);
1767 * Note that there's no explicit destructor needed for the
1768 * notmuch_tags_t object. (For consistency, we do provide a
1769 * notmuch_tags_destroy function, but there's no good reason to call
1770 * it if the message is about to be destroyed).
1773 notmuch_message_get_tags (notmuch_message_t *message);
1776 * The longest possible tag value.
1778 #define NOTMUCH_TAG_MAX 200
1781 * Add a tag to the given message.
1785 * NOTMUCH_STATUS_SUCCESS: Tag successfully added to message
1787 * NOTMUCH_STATUS_NULL_POINTER: The 'tag' argument is NULL
1789 * NOTMUCH_STATUS_TAG_TOO_LONG: The length of 'tag' is too long
1790 * (exceeds NOTMUCH_TAG_MAX)
1792 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
1793 * mode so message cannot be modified.
1796 notmuch_message_add_tag (notmuch_message_t *message, const char *tag);
1799 * Remove a tag from the given message.
1803 * NOTMUCH_STATUS_SUCCESS: Tag successfully removed from message
1805 * NOTMUCH_STATUS_NULL_POINTER: The 'tag' argument is NULL
1807 * NOTMUCH_STATUS_TAG_TOO_LONG: The length of 'tag' is too long
1808 * (exceeds NOTMUCH_TAG_MAX)
1810 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
1811 * mode so message cannot be modified.
1814 notmuch_message_remove_tag (notmuch_message_t *message, const char *tag);
1817 * Remove all tags from the given message.
1819 * See notmuch_message_freeze for an example showing how to safely
1820 * replace tag values.
1822 * @retval #NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in
1823 * read-only mode so message cannot be modified.
1824 * @retval #NOTMUCH_STATUS_XAPIAN_EXCEPTION: an exception was thrown
1825 * accessing the database.
1828 notmuch_message_remove_all_tags (notmuch_message_t *message);
1831 * Add/remove tags according to maildir flags in the message filename(s).
1833 * This function examines the filenames of 'message' for maildir
1834 * flags, and adds or removes tags on 'message' as follows when these
1835 * flags are present:
1837 * Flag Action if present
1838 * ---- -----------------
1839 * 'D' Adds the "draft" tag to the message
1840 * 'F' Adds the "flagged" tag to the message
1841 * 'P' Adds the "passed" tag to the message
1842 * 'R' Adds the "replied" tag to the message
1843 * 'S' Removes the "unread" tag from the message
1845 * For each flag that is not present, the opposite action (add/remove)
1846 * is performed for the corresponding tags.
1848 * Flags are identified as trailing components of the filename after a
1849 * sequence of ":2,".
1851 * If there are multiple filenames associated with this message, the
1852 * flag is considered present if it appears in one or more
1853 * filenames. (That is, the flags from the multiple filenames are
1854 * combined with the logical OR operator.)
1856 * A client can ensure that notmuch database tags remain synchronized
1857 * with maildir flags by calling this function after each call to
1858 * notmuch_database_index_file. See also
1859 * notmuch_message_tags_to_maildir_flags for synchronizing tag changes
1860 * back to maildir flags.
1863 notmuch_message_maildir_flags_to_tags (notmuch_message_t *message);
1866 * return TRUE if any filename of 'message' has maildir flag 'flag',
1869 * Deprecated wrapper for notmuch_message_has_maildir_flag_st
1871 * @returns FALSE in case of error
1872 * @deprecated libnotmuch 5.3 (notmuch 0.31)
1874 NOTMUCH_DEPRECATED (5, 3)
1876 notmuch_message_has_maildir_flag (notmuch_message_t *message, char flag);
1879 * check message for maildir flag
1881 * @param [in,out] message message to check
1882 * @param [in] flag flag to check for
1883 * @param [out] is_set pointer to boolean
1885 * @retval #NOTMUCH_STATUS_SUCCESS
1886 * @retval #NOTMUCH_STATUS_NULL_POINTER is_set is NULL
1887 * @retval #NOTMUCH_STATUS_XAPIAN_EXCEPTION Accessing the database
1888 * triggered an exception.
1891 notmuch_message_has_maildir_flag_st (notmuch_message_t *message,
1893 notmuch_bool_t *is_set);
1896 * Rename message filename(s) to encode tags as maildir flags.
1898 * Specifically, for each filename corresponding to this message:
1900 * If the filename is not in a maildir directory, do nothing. (A
1901 * maildir directory is determined as a directory named "new" or
1902 * "cur".) Similarly, if the filename has invalid maildir info,
1903 * (repeated or outof-ASCII-order flag characters after ":2,"), then
1906 * If the filename is in a maildir directory, rename the file so that
1907 * its filename ends with the sequence ":2," followed by zero or more
1908 * of the following single-character flags (in ASCII order):
1910 * * flag 'D' iff the message has the "draft" tag
1911 * * flag 'F' iff the message has the "flagged" tag
1912 * * flag 'P' iff the message has the "passed" tag
1913 * * flag 'R' iff the message has the "replied" tag
1914 * * flag 'S' iff the message does not have the "unread" tag
1916 * Any existing flags unmentioned in the list above will be preserved
1919 * Also, if this filename is in a directory named "new", rename it to
1920 * be within the neighboring directory named "cur".
1922 * A client can ensure that maildir filename flags remain synchronized
1923 * with notmuch database tags by calling this function after changing
1924 * tags, (after calls to notmuch_message_add_tag,
1925 * notmuch_message_remove_tag, or notmuch_message_freeze/
1926 * notmuch_message_thaw). See also notmuch_message_maildir_flags_to_tags
1927 * for synchronizing maildir flag changes back to tags.
1930 notmuch_message_tags_to_maildir_flags (notmuch_message_t *message);
1933 * Freeze the current state of 'message' within the database.
1935 * This means that changes to the message state, (via
1936 * notmuch_message_add_tag, notmuch_message_remove_tag, and
1937 * notmuch_message_remove_all_tags), will not be committed to the
1938 * database until the message is thawed with notmuch_message_thaw.
1940 * Multiple calls to freeze/thaw are valid and these calls will
1941 * "stack". That is there must be as many calls to thaw as to freeze
1942 * before a message is actually thawed.
1944 * The ability to do freeze/thaw allows for safe transactions to
1945 * change tag values. For example, explicitly setting a message to
1946 * have a given set of tags might look like this:
1948 * notmuch_message_freeze (message);
1950 * notmuch_message_remove_all_tags (message);
1952 * for (i = 0; i < NUM_TAGS; i++)
1953 * notmuch_message_add_tag (message, tags[i]);
1955 * notmuch_message_thaw (message);
1957 * With freeze/thaw used like this, the message in the database is
1958 * guaranteed to have either the full set of original tag values, or
1959 * the full set of new tag values, but nothing in between.
1961 * Imagine the example above without freeze/thaw and the operation
1962 * somehow getting interrupted. This could result in the message being
1963 * left with no tags if the interruption happened after
1964 * notmuch_message_remove_all_tags but before notmuch_message_add_tag.
1968 * NOTMUCH_STATUS_SUCCESS: Message successfully frozen.
1970 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
1971 * mode so message cannot be modified.
1974 notmuch_message_freeze (notmuch_message_t *message);
1977 * Thaw the current 'message', synchronizing any changes that may have
1978 * occurred while 'message' was frozen into the notmuch database.
1980 * See notmuch_message_freeze for an example of how to use this
1981 * function to safely provide tag changes.
1983 * Multiple calls to freeze/thaw are valid and these calls with
1984 * "stack". That is there must be as many calls to thaw as to freeze
1985 * before a message is actually thawed.
1989 * NOTMUCH_STATUS_SUCCESS: Message successfully thawed, (or at least
1990 * its frozen count has successfully been reduced by 1).
1992 * NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW: An attempt was made to thaw
1993 * an unfrozen message. That is, there have been an unbalanced
1994 * number of calls to notmuch_message_freeze and
1995 * notmuch_message_thaw.
1998 notmuch_message_thaw (notmuch_message_t *message);
2001 * Destroy a notmuch_message_t object.
2003 * It can be useful to call this function in the case of a single
2004 * query object with many messages in the result, (such as iterating
2005 * over the entire database). Otherwise, it's fine to never call this
2006 * function and there will still be no memory leaks. (The memory from
2007 * the messages get reclaimed when the containing query is destroyed.)
2010 notmuch_message_destroy (notmuch_message_t *message);
2013 * @name Message Properties
2015 * This interface provides the ability to attach arbitrary (key,value)
2016 * string pairs to a message, to remove such pairs, and to iterate
2017 * over them. The caller should take some care as to what keys they
2018 * add or delete values for, as other subsystems or extensions may
2019 * depend on these properties.
2021 * Please see notmuch-properties(7) for more details about specific
2022 * properties and conventions around their use.
2027 * Retrieve the value for a single property key
2029 * *value* is set to a string owned by the message or NULL if there is
2030 * no such key. In the case of multiple values for the given key, the
2031 * first one is retrieved.
2034 * - NOTMUCH_STATUS_NULL_POINTER: *value* may not be NULL.
2035 * - NOTMUCH_STATUS_SUCCESS: No error occurred.
2036 * @since libnotmuch 4.4 (notmuch 0.23)
2039 notmuch_message_get_property (notmuch_message_t *message, const char *key, const char **value);
2042 * Add a (key,value) pair to a message
2045 * - NOTMUCH_STATUS_ILLEGAL_ARGUMENT: *key* may not contain an '=' character.
2046 * - NOTMUCH_STATUS_NULL_POINTER: Neither *key* nor *value* may be NULL.
2047 * - NOTMUCH_STATUS_SUCCESS: No error occurred.
2048 * @since libnotmuch 4.4 (notmuch 0.23)
2051 notmuch_message_add_property (notmuch_message_t *message, const char *key, const char *value);
2054 * Remove a (key,value) pair from a message.
2056 * It is not an error to remove a non-existent (key,value) pair
2059 * - NOTMUCH_STATUS_ILLEGAL_ARGUMENT: *key* may not contain an '=' character.
2060 * - NOTMUCH_STATUS_NULL_POINTER: Neither *key* nor *value* may be NULL.
2061 * - NOTMUCH_STATUS_SUCCESS: No error occurred.
2062 * @since libnotmuch 4.4 (notmuch 0.23)
2065 notmuch_message_remove_property (notmuch_message_t *message, const char *key, const char *value);
2068 * Remove all (key,value) pairs from the given message.
2070 * @param[in,out] message message to operate on.
2071 * @param[in] key key to delete properties for. If NULL, delete
2072 * properties for all keys
2074 * - NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in
2075 * read-only mode so message cannot be modified.
2076 * - NOTMUCH_STATUS_SUCCESS: No error occurred.
2078 * @since libnotmuch 4.4 (notmuch 0.23)
2081 notmuch_message_remove_all_properties (notmuch_message_t *message, const char *key);
2084 * Remove all (prefix*,value) pairs from the given message
2086 * @param[in,out] message message to operate on.
2087 * @param[in] prefix delete properties with keys that start with prefix.
2088 * If NULL, delete all properties
2090 * - NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in
2091 * read-only mode so message cannot be modified.
2092 * - NOTMUCH_STATUS_SUCCESS: No error occurred.
2094 * @since libnotmuch 5.1 (notmuch 0.26)
2097 notmuch_message_remove_all_properties_with_prefix (notmuch_message_t *message, const char *prefix);
2100 * Opaque message property iterator
2102 typedef struct _notmuch_string_map_iterator notmuch_message_properties_t;
2105 * Get the properties for *message*, returning a
2106 * notmuch_message_properties_t object which can be used to iterate
2107 * over all properties.
2109 * The notmuch_message_properties_t object is owned by the message and
2110 * as such, will only be valid for as long as the message is valid,
2111 * (which is until the query from which it derived is destroyed).
2113 * @param[in] message The message to examine
2114 * @param[in] key key or key prefix
2115 * @param[in] exact if TRUE, require exact match with key. Otherwise
2118 * Typical usage might be:
2120 * notmuch_message_properties_t *list;
2122 * for (list = notmuch_message_get_properties (message, "testkey1", TRUE);
2123 * notmuch_message_properties_valid (list); notmuch_message_properties_move_to_next (list)) {
2124 * printf("%s\n", notmuch_message_properties_value(list));
2127 * notmuch_message_properties_destroy (list);
2129 * Note that there's no explicit destructor needed for the
2130 * notmuch_message_properties_t object. (For consistency, we do
2131 * provide a notmuch_message_properities_destroy function, but there's
2132 * no good reason to call it if the message is about to be destroyed).
2134 * @since libnotmuch 4.4 (notmuch 0.23)
2136 notmuch_message_properties_t *
2137 notmuch_message_get_properties (notmuch_message_t *message, const char *key, notmuch_bool_t exact);
2140 * Return the number of properties named "key" belonging to the specific message.
2142 * @param[in] message The message to examine
2143 * @param[in] key key to count
2144 * @param[out] count The number of matching properties associated with this message.
2148 * NOTMUCH_STATUS_SUCCESS: successful count, possibly some other error.
2150 * @since libnotmuch 5.2 (notmuch 0.27)
2153 notmuch_message_count_properties (notmuch_message_t *message, const char *key, unsigned int *count);
2156 * Is the given *properties* iterator pointing at a valid (key,value)
2159 * When this function returns TRUE,
2160 * notmuch_message_properties_{key,value} will return a valid string,
2161 * and notmuch_message_properties_move_to_next will do what it
2162 * says. Whereas when this function returns FALSE, calling any of
2163 * these functions results in undefined behaviour.
2165 * See the documentation of notmuch_message_get_properties for example
2166 * code showing how to iterate over a notmuch_message_properties_t
2169 * @since libnotmuch 4.4 (notmuch 0.23)
2172 notmuch_message_properties_valid (notmuch_message_properties_t *properties);
2175 * Move the *properties* iterator to the next (key,value) pair
2177 * If *properties* is already pointing at the last pair then the iterator
2178 * will be moved to a point just beyond that last pair, (where
2179 * notmuch_message_properties_valid will return FALSE).
2181 * See the documentation of notmuch_message_get_properties for example
2182 * code showing how to iterate over a notmuch_message_properties_t object.
2184 * @since libnotmuch 4.4 (notmuch 0.23)
2187 notmuch_message_properties_move_to_next (notmuch_message_properties_t *properties);
2190 * Return the key from the current (key,value) pair.
2192 * this could be useful if iterating for a prefix
2194 * @since libnotmuch 4.4 (notmuch 0.23)
2197 notmuch_message_properties_key (notmuch_message_properties_t *properties);
2200 * Return the value from the current (key,value) pair.
2202 * This could be useful if iterating for a prefix.
2204 * @since libnotmuch 4.4 (notmuch 0.23)
2207 notmuch_message_properties_value (notmuch_message_properties_t *properties);
2211 * Destroy a notmuch_message_properties_t object.
2213 * It's not strictly necessary to call this function. All memory from
2214 * the notmuch_message_properties_t object will be reclaimed when the
2215 * containing message object is destroyed.
2217 * @since libnotmuch 4.4 (notmuch 0.23)
2220 notmuch_message_properties_destroy (notmuch_message_properties_t *properties);
2225 * Is the given 'tags' iterator pointing at a valid tag.
2227 * When this function returns TRUE, notmuch_tags_get will return a
2228 * valid string. Whereas when this function returns FALSE,
2229 * notmuch_tags_get will return NULL.
2231 * See the documentation of notmuch_message_get_tags for example code
2232 * showing how to iterate over a notmuch_tags_t object.
2235 notmuch_tags_valid (notmuch_tags_t *tags);
2238 * Get the current tag from 'tags' as a string.
2240 * Note: The returned string belongs to 'tags' and has a lifetime
2241 * identical to it (and the query to which it ultimately belongs).
2243 * See the documentation of notmuch_message_get_tags for example code
2244 * showing how to iterate over a notmuch_tags_t object.
2247 notmuch_tags_get (notmuch_tags_t *tags);
2250 * Move the 'tags' iterator to the next tag.
2252 * If 'tags' is already pointing at the last tag then the iterator
2253 * will be moved to a point just beyond that last tag, (where
2254 * notmuch_tags_valid will return FALSE and notmuch_tags_get will
2257 * See the documentation of notmuch_message_get_tags for example code
2258 * showing how to iterate over a notmuch_tags_t object.
2261 notmuch_tags_move_to_next (notmuch_tags_t *tags);
2264 * Destroy a notmuch_tags_t object.
2266 * It's not strictly necessary to call this function. All memory from
2267 * the notmuch_tags_t object will be reclaimed when the containing
2268 * message or query objects are destroyed.
2271 notmuch_tags_destroy (notmuch_tags_t *tags);
2274 * Store an mtime within the database for 'directory'.
2276 * The 'directory' should be an object retrieved from the database
2277 * with notmuch_database_get_directory for a particular path.
2279 * The intention is for the caller to use the mtime to allow efficient
2280 * identification of new messages to be added to the database. The
2281 * recommended usage is as follows:
2283 * o Read the mtime of a directory from the filesystem
2285 * o Call index_file for all mail files in the directory
2287 * o Call notmuch_directory_set_mtime with the mtime read from the
2290 * Then, when wanting to check for updates to the directory in the
2291 * future, the client can call notmuch_directory_get_mtime and know
2292 * that it only needs to add files if the mtime of the directory and
2293 * files are newer than the stored timestamp.
2295 * Note: The notmuch_directory_get_mtime function does not allow the
2296 * caller to distinguish a timestamp of 0 from a non-existent
2297 * timestamp. So don't store a timestamp of 0 unless you are
2298 * comfortable with that.
2302 * NOTMUCH_STATUS_SUCCESS: mtime successfully stored in database.
2304 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception
2305 * occurred, mtime not stored.
2307 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
2308 * mode so directory mtime cannot be modified.
2311 notmuch_directory_set_mtime (notmuch_directory_t *directory,
2315 * Get the mtime of a directory, (as previously stored with
2316 * notmuch_directory_set_mtime).
2318 * Returns 0 if no mtime has previously been stored for this
2322 notmuch_directory_get_mtime (notmuch_directory_t *directory);
2325 * Get a notmuch_filenames_t iterator listing all the filenames of
2326 * messages in the database within the given directory.
2328 * The returned filenames will be the basename-entries only (not
2331 * Returns NULL if it triggers a Xapian exception
2333 notmuch_filenames_t *
2334 notmuch_directory_get_child_files (notmuch_directory_t *directory);
2337 * Get a notmuch_filenames_t iterator listing all the filenames of
2338 * sub-directories in the database within the given directory.
2340 * The returned filenames will be the basename-entries only (not
2343 * Returns NULL if it triggers a Xapian exception
2345 notmuch_filenames_t *
2346 notmuch_directory_get_child_directories (notmuch_directory_t *directory);
2349 * Delete directory document from the database, and destroy the
2350 * notmuch_directory_t object. Assumes any child directories and files
2351 * have been deleted by the caller.
2353 * @since libnotmuch 4.3 (notmuch 0.21)
2356 notmuch_directory_delete (notmuch_directory_t *directory);
2359 * Destroy a notmuch_directory_t object.
2362 notmuch_directory_destroy (notmuch_directory_t *directory);
2365 * Is the given 'filenames' iterator pointing at a valid filename.
2367 * When this function returns TRUE, notmuch_filenames_get will return
2368 * a valid string. Whereas when this function returns FALSE,
2369 * notmuch_filenames_get will return NULL.
2371 * It is acceptable to pass NULL for 'filenames', in which case this
2372 * function will always return FALSE.
2375 notmuch_filenames_valid (notmuch_filenames_t *filenames);
2378 * Get the current filename from 'filenames' as a string.
2380 * Note: The returned string belongs to 'filenames' and has a lifetime
2381 * identical to it (and the directory to which it ultimately belongs).
2383 * It is acceptable to pass NULL for 'filenames', in which case this
2384 * function will always return NULL.
2387 notmuch_filenames_get (notmuch_filenames_t *filenames);
2390 * Move the 'filenames' iterator to the next filename.
2392 * If 'filenames' is already pointing at the last filename then the
2393 * iterator will be moved to a point just beyond that last filename,
2394 * (where notmuch_filenames_valid will return FALSE and
2395 * notmuch_filenames_get will return NULL).
2397 * It is acceptable to pass NULL for 'filenames', in which case this
2398 * function will do nothing.
2401 notmuch_filenames_move_to_next (notmuch_filenames_t *filenames);
2404 * Destroy a notmuch_filenames_t object.
2406 * It's not strictly necessary to call this function. All memory from
2407 * the notmuch_filenames_t object will be reclaimed when the
2408 * containing directory object is destroyed.
2410 * It is acceptable to pass NULL for 'filenames', in which case this
2411 * function will do nothing.
2414 notmuch_filenames_destroy (notmuch_filenames_t *filenames);
2418 * set config 'key' to 'value'
2420 * @since libnotmuch 4.4 (notmuch 0.23)
2421 * @retval #NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in
2422 * read-only mode so message cannot be modified.
2423 * @retval #NOTMUCH_STATUS_XAPIAN_EXCEPTION: an exception was thrown
2424 * accessing the database.
2425 * @retval #NOTMUCH_STATUS_SUCCESS
2428 notmuch_database_set_config (notmuch_database_t *db, const char *key, const char *value);
2431 * retrieve config item 'key', assign to 'value'
2433 * keys which have not been previously set with n_d_set_config will
2434 * return an empty string.
2436 * return value is allocated by malloc and should be freed by the
2439 * @since libnotmuch 4.4 (notmuch 0.23)
2443 notmuch_database_get_config (notmuch_database_t *db, const char *key, char **value);
2446 * Create an iterator for all config items with keys matching a given prefix
2448 * @since libnotmuch 4.4 (notmuch 0.23)
2451 notmuch_database_get_config_list (notmuch_database_t *db, const char *prefix,
2452 notmuch_config_list_t **out);
2455 * Is 'config_list' iterator valid (i.e. _key, _value, _move_to_next can be called).
2457 * @since libnotmuch 4.4 (notmuch 0.23)
2460 notmuch_config_list_valid (notmuch_config_list_t *config_list);
2463 * return key for current config pair
2465 * return value is owned by the iterator, and will be destroyed by the
2466 * next call to notmuch_config_list_key or notmuch_config_list_destroy.
2468 * @since libnotmuch 4.4 (notmuch 0.23)
2471 notmuch_config_list_key (notmuch_config_list_t *config_list);
2474 * return 'value' for current config pair
2476 * return value is owned by the iterator, and will be destroyed by the
2477 * next call to notmuch_config_list_value or notmuch config_list_destroy
2479 * @since libnotmuch 4.4 (notmuch 0.23)
2480 * @retval NULL for errors
2483 notmuch_config_list_value (notmuch_config_list_t *config_list);
2487 * move 'config_list' iterator to the next pair
2489 * @since libnotmuch 4.4 (notmuch 0.23)
2492 notmuch_config_list_move_to_next (notmuch_config_list_t *config_list);
2495 * free any resources held by 'config_list'
2497 * @since libnotmuch 4.4 (notmuch 0.23)
2500 notmuch_config_list_destroy (notmuch_config_list_t *config_list);
2503 * Configuration keys known to libnotmuch
2505 typedef enum _notmuch_config_key {
2506 NOTMUCH_CONFIG_FIRST,
2507 NOTMUCH_CONFIG_DATABASE_PATH = NOTMUCH_CONFIG_FIRST,
2508 NOTMUCH_CONFIG_MAIL_ROOT,
2509 NOTMUCH_CONFIG_HOOK_DIR,
2510 NOTMUCH_CONFIG_BACKUP_DIR,
2511 NOTMUCH_CONFIG_EXCLUDE_TAGS,
2512 NOTMUCH_CONFIG_NEW_TAGS,
2513 NOTMUCH_CONFIG_NEW_IGNORE,
2514 NOTMUCH_CONFIG_SYNC_MAILDIR_FLAGS,
2515 NOTMUCH_CONFIG_PRIMARY_EMAIL,
2516 NOTMUCH_CONFIG_OTHER_EMAIL,
2517 NOTMUCH_CONFIG_USER_NAME,
2519 } notmuch_config_key_t;
2522 * get a configuration value from an open database.
2524 * This value reflects all configuration information given at the time
2525 * the database was opened.
2527 * @param[in] notmuch database
2528 * @param[in] key configuration key
2530 * @since libnotmuch 5.4 (notmuch 0.32)
2532 * @retval NULL if 'key' unknown or if no value is known for
2533 * 'key'. Otherwise returns a string owned by notmuch which should
2534 * not be modified nor freed by the caller.
2537 notmuch_config_get (notmuch_database_t *notmuch, notmuch_config_key_t key);
2540 * set a configuration value from in an open database.
2542 * This value reflects all configuration information given at the time
2543 * the database was opened.
2545 * @param[in,out] notmuch database open read/write
2546 * @param[in] key configuration key
2547 * @param[in] val configuration value
2549 * @since libnotmuch 5.4 (notmuch 0.32)
2551 * @retval returns any return value for notmuch_database_set_config.
2554 notmuch_config_set (notmuch_database_t *notmuch, notmuch_config_key_t key, const char *val);
2557 * Returns an iterator for a ';'-delimited list of configuration values
2559 * These values reflect all configuration information given at the
2560 * time the database was opened.
2562 * @param[in] notmuch database
2563 * @param[in] key configuration key
2565 * @since libnotmuch 5.4 (notmuch 0.32)
2567 * @retval NULL in case of error.
2569 notmuch_config_values_t *
2570 notmuch_config_get_values (notmuch_database_t *notmuch, notmuch_config_key_t key);
2573 * Returns an iterator for a ';'-delimited list of configuration values
2575 * These values reflect all configuration information given at the
2576 * time the database was opened.
2578 * @param[in] notmuch database
2579 * @param[in] key configuration key
2581 * @since libnotmuch 5.4 (notmuch 0.32)
2583 * @retval NULL in case of error.
2585 notmuch_config_values_t *
2586 notmuch_config_get_values_string (notmuch_database_t *notmuch, const char *key);
2589 * Is the given 'config_values' iterator pointing at a valid element.
2591 * @param[in] values iterator
2593 * @since libnotmuch 5.4 (notmuch 0.32)
2595 * @retval FALSE if passed a NULL pointer, or the iterator is exhausted.
2599 notmuch_config_values_valid (notmuch_config_values_t *values);
2602 * Get the current value from the 'values' iterator
2604 * @param[in] values iterator
2606 * @since libnotmuch 5.4 (notmuch 0.32)
2608 * @retval a string with the same lifetime as the iterator
2611 notmuch_config_values_get (notmuch_config_values_t *values);
2614 * Move the 'values' iterator to the next element
2616 * @param[in,out] values iterator
2618 * @since libnotmuch 5.4 (notmuch 0.32)
2622 notmuch_config_values_move_to_next (notmuch_config_values_t *values);
2626 * reset the 'values' iterator to the first element
2628 * @param[in,out] values iterator. A NULL value is ignored.
2630 * @since libnotmuch 5.4 (notmuch 0.32)
2634 notmuch_config_values_start (notmuch_config_values_t *values);
2637 * Destroy a config values iterator, along with any associated
2640 * @param[in,out] values iterator
2642 * @since libnotmuch 5.4 (notmuch 0.32)
2645 notmuch_config_values_destroy (notmuch_config_values_t *values);
2649 * Returns an iterator for a (key, value) configuration pairs
2651 * @param[in] notmuch database
2652 * @param[in] prefix prefix for keys. Pass "" for all keys.
2654 * @since libnotmuch 5.4 (notmuch 0.32)
2656 * @retval NULL in case of error.
2658 notmuch_config_pairs_t *
2659 notmuch_config_get_pairs (notmuch_database_t *notmuch,
2660 const char *prefix);
2663 * Is the given 'config_pairs' iterator pointing at a valid element.
2665 * @param[in] pairs iterator
2667 * @since libnotmuch 5.4 (notmuch 0.32)
2669 * @retval FALSE if passed a NULL pointer, or the iterator is exhausted.
2673 notmuch_config_pairs_valid (notmuch_config_pairs_t *pairs);
2676 * Move the 'config_pairs' iterator to the next element
2678 * @param[in,out] pairs iterator
2680 * @since libnotmuch 5.4 (notmuch 0.32)
2684 notmuch_config_pairs_move_to_next (notmuch_config_pairs_t *pairs);
2687 * Get the current key from the 'config_pairs' iterator
2689 * @param[in] pairs iterator
2691 * @since libnotmuch 5.4 (notmuch 0.32)
2693 * @retval a string with the same lifetime as the iterator
2696 notmuch_config_pairs_key (notmuch_config_pairs_t *pairs);
2699 * Get the current value from the 'config_pairs' iterator
2701 * @param[in] pairs iterator
2703 * @since libnotmuch 5.4 (notmuch 0.32)
2705 * @retval a string with the same lifetime as the iterator
2708 notmuch_config_pairs_value (notmuch_config_pairs_t *pairs);
2711 * Destroy a config_pairs iterator, along with any associated
2714 * @param[in,out] pairs iterator
2716 * @since libnotmuch 5.4 (notmuch 0.32)
2719 notmuch_config_pairs_destroy (notmuch_config_pairs_t *pairs);
2722 * get a configuration value from an open database as Boolean
2724 * This value reflects all configuration information given at the time
2725 * the database was opened.
2727 * @param[in] notmuch database
2728 * @param[in] key configuration key
2729 * @param[out] val configuration value, converted to Boolean
2731 * @since libnotmuch 5.4 (notmuch 0.32)
2733 * @retval #NOTMUCH_STATUS_ILLEGAL_ARGUMENT if either key is unknown
2734 * or the corresponding value does not convert to Boolean.
2737 notmuch_config_get_bool (notmuch_database_t *notmuch,
2738 notmuch_config_key_t key,
2739 notmuch_bool_t *val);
2741 * get the current default indexing options for a given database.
2743 * This object will survive until the database itself is destroyed,
2744 * but the caller may also release it earlier with
2745 * notmuch_indexopts_destroy.
2747 * This object represents a set of options on how a message can be
2748 * added to the index. At the moment it is a featureless stub.
2750 * @since libnotmuch 5.1 (notmuch 0.26)
2751 * @retval NULL in case of error
2753 notmuch_indexopts_t *
2754 notmuch_database_get_default_indexopts (notmuch_database_t *db);
2757 * Stating a policy about how to decrypt messages.
2759 * See index.decrypt in notmuch-config(1) for more details.
2762 NOTMUCH_DECRYPT_FALSE,
2763 NOTMUCH_DECRYPT_TRUE,
2764 NOTMUCH_DECRYPT_AUTO,
2765 NOTMUCH_DECRYPT_NOSTASH,
2766 } notmuch_decryption_policy_t;
2769 * Specify whether to decrypt encrypted parts while indexing.
2771 * Be aware that the index is likely sufficient to reconstruct the
2772 * cleartext of the message itself, so please ensure that the notmuch
2773 * message index is adequately protected. DO NOT SET THIS FLAG TO TRUE
2774 * without considering the security of your index.
2776 * @since libnotmuch 5.1 (notmuch 0.26)
2779 notmuch_indexopts_set_decrypt_policy (notmuch_indexopts_t *indexopts,
2780 notmuch_decryption_policy_t decrypt_policy);
2783 * Return whether to decrypt encrypted parts while indexing.
2784 * see notmuch_indexopts_set_decrypt_policy.
2786 * @since libnotmuch 5.1 (notmuch 0.26)
2788 notmuch_decryption_policy_t
2789 notmuch_indexopts_get_decrypt_policy (const notmuch_indexopts_t *indexopts);
2792 * Destroy a notmuch_indexopts_t object.
2794 * @since libnotmuch 5.1 (notmuch 0.26)
2797 notmuch_indexopts_destroy (notmuch_indexopts_t *options);
2801 * interrogate the library for compile time features
2803 * @since libnotmuch 4.4 (notmuch 0.23)
2806 notmuch_built_with (const char *name);
2809 #pragma GCC visibility pop