1 /* notmuch - Not much of an email library, (just index and search)
3 * Copyright © 2009 Carl Worth
5 * This program is free software: you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation, either version 3 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program. If not, see https://www.gnu.org/licenses/ .
18 * Author: Carl Worth <cworth@cworth.org>
22 * @defgroup notmuch The notmuch API
24 * Not much of an email library, (just index and search)
35 # define NOTMUCH_BEGIN_DECLS extern "C" {
36 # define NOTMUCH_END_DECLS }
38 # define NOTMUCH_BEGIN_DECLS
39 # define NOTMUCH_END_DECLS
46 #pragma GCC visibility push(default)
57 * The library version number. This must agree with the soname
58 * version in Makefile.local.
60 #define LIBNOTMUCH_MAJOR_VERSION 5
61 #define LIBNOTMUCH_MINOR_VERSION 3
62 #define LIBNOTMUCH_MICRO_VERSION 0
65 #if defined (__clang_major__) && __clang_major__ >= 3 \
66 || defined (__GNUC__) && __GNUC__ >= 5 \
67 || defined (__GNUC__) && __GNUC__ == 4 && __GNUC_MINOR__ >= 5
68 #define NOTMUCH_DEPRECATED(major, minor) \
69 __attribute__ ((deprecated ("function deprecated as of libnotmuch " #major "." #minor)))
71 #define NOTMUCH_DEPRECATED(major, minor) __attribute__ ((deprecated))
75 #endif /* __DOXYGEN__ */
78 * Check the version of the notmuch library being compiled against.
80 * Return true if the library being compiled against is of the
81 * specified version or above. For example:
84 * #if LIBNOTMUCH_CHECK_VERSION(3, 1, 0)
85 * (code requiring libnotmuch 3.1.0 or above)
89 * LIBNOTMUCH_CHECK_VERSION has been defined since version 3.1.0; to
90 * check for versions prior to that, use:
93 * #if !defined(NOTMUCH_CHECK_VERSION)
94 * (code requiring libnotmuch prior to 3.1.0)
98 #define LIBNOTMUCH_CHECK_VERSION(major, minor, micro) \
99 (LIBNOTMUCH_MAJOR_VERSION > (major) || \
100 (LIBNOTMUCH_MAJOR_VERSION == (major) && LIBNOTMUCH_MINOR_VERSION > (minor)) || \
101 (LIBNOTMUCH_MAJOR_VERSION == (major) && LIBNOTMUCH_MINOR_VERSION == (minor) && \
102 LIBNOTMUCH_MICRO_VERSION >= (micro)))
105 * Notmuch boolean type.
107 typedef int notmuch_bool_t;
110 * Status codes used for the return values of most functions.
112 * A zero value (NOTMUCH_STATUS_SUCCESS) indicates that the function
113 * completed without error. Any other value indicates an error.
115 typedef enum _notmuch_status {
119 NOTMUCH_STATUS_SUCCESS = 0,
123 NOTMUCH_STATUS_OUT_OF_MEMORY,
125 * An attempt was made to write to a database opened in read-only
128 NOTMUCH_STATUS_READ_ONLY_DATABASE,
130 * A Xapian exception occurred.
132 * @todo We don't really want to expose this lame XAPIAN_EXCEPTION
133 * value. Instead we should map to things like DATABASE_LOCKED or
136 NOTMUCH_STATUS_XAPIAN_EXCEPTION,
138 * An error occurred trying to read or write to a file (this could
139 * be file not found, permission denied, etc.)
141 NOTMUCH_STATUS_FILE_ERROR,
143 * A file was presented that doesn't appear to be an email
146 NOTMUCH_STATUS_FILE_NOT_EMAIL,
148 * A file contains a message ID that is identical to a message
149 * already in the database.
151 NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID,
153 * The user erroneously passed a NULL pointer to a notmuch
156 NOTMUCH_STATUS_NULL_POINTER,
158 * A tag value is too long (exceeds NOTMUCH_TAG_MAX).
160 NOTMUCH_STATUS_TAG_TOO_LONG,
162 * The notmuch_message_thaw function has been called more times
163 * than notmuch_message_freeze.
165 NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW,
167 * notmuch_database_end_atomic has been called more times than
168 * notmuch_database_begin_atomic.
170 NOTMUCH_STATUS_UNBALANCED_ATOMIC,
172 * The operation is not supported.
174 NOTMUCH_STATUS_UNSUPPORTED_OPERATION,
176 * The operation requires a database upgrade.
178 NOTMUCH_STATUS_UPGRADE_REQUIRED,
180 * There is a problem with the proposed path, e.g. a relative path
181 * passed to a function expecting an absolute path.
183 NOTMUCH_STATUS_PATH_ERROR,
185 * The requested operation was ignored. Depending on the function,
186 * this may not be an actual error.
188 NOTMUCH_STATUS_IGNORED,
190 * One of the arguments violates the preconditions for the
191 * function, in a way not covered by a more specific argument.
193 NOTMUCH_STATUS_ILLEGAL_ARGUMENT,
195 * A MIME object claimed to have cryptographic protection which
196 * notmuch tried to handle, but the protocol was not specified in
197 * an intelligible way.
199 NOTMUCH_STATUS_MALFORMED_CRYPTO_PROTOCOL,
201 * Notmuch attempted to do crypto processing, but could not
202 * initialize the engine needed to do so.
204 NOTMUCH_STATUS_FAILED_CRYPTO_CONTEXT_CREATION,
206 * A MIME object claimed to have cryptographic protection, and
207 * notmuch attempted to process it, but the specific protocol was
208 * something that notmuch doesn't know how to handle.
210 NOTMUCH_STATUS_UNKNOWN_CRYPTO_PROTOCOL,
212 * Unable to load a config file
214 NOTMUCH_STATUS_NO_CONFIG,
216 * Database exists, so not (re)-created
218 NOTMUCH_STATUS_DATABASE_EXISTS,
220 * Not an actual status value. Just a way to find out how many
221 * valid status values there are.
223 NOTMUCH_STATUS_LAST_STATUS
227 * Get a string representation of a notmuch_status_t value.
229 * The result is read-only.
232 notmuch_status_to_string (notmuch_status_t status);
234 /* Various opaque data types. For each notmuch_<foo>_t see the various
235 * notmuch_<foo> functions below. */
237 typedef struct _notmuch_database notmuch_database_t;
238 typedef struct _notmuch_query notmuch_query_t;
239 typedef struct _notmuch_threads notmuch_threads_t;
240 typedef struct _notmuch_thread notmuch_thread_t;
241 typedef struct _notmuch_messages notmuch_messages_t;
242 typedef struct _notmuch_message notmuch_message_t;
243 typedef struct _notmuch_tags notmuch_tags_t;
244 typedef struct _notmuch_directory notmuch_directory_t;
245 typedef struct _notmuch_filenames notmuch_filenames_t;
246 typedef struct _notmuch_config_list notmuch_config_list_t;
247 typedef struct _notmuch_config_values notmuch_config_values_t;
248 typedef struct _notmuch_indexopts notmuch_indexopts_t;
249 #endif /* __DOXYGEN__ */
252 * Create a new, empty notmuch database located at 'path'.
254 * The path should be a top-level directory to a collection of
255 * plain-text email messages (one message per file). This call will
256 * create a new ".notmuch" directory within 'path' where notmuch will
259 * After a successful call to notmuch_database_create, the returned
260 * database will be open so the caller should call
261 * notmuch_database_destroy when finished with it.
263 * The database will not yet have any data in it
264 * (notmuch_database_create itself is a very cheap function). Messages
265 * contained within 'path' can be added to the database by calling
266 * notmuch_database_index_file.
268 * In case of any failure, this function returns an error status and
269 * sets *database to NULL (after printing an error message on stderr).
273 * NOTMUCH_STATUS_SUCCESS: Successfully created the database.
275 * NOTMUCH_STATUS_NULL_POINTER: The given 'path' argument is NULL.
277 * NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory.
279 * NOTMUCH_STATUS_FILE_ERROR: An error occurred trying to create the
280 * database file (such as permission denied, or file not found,
281 * etc.), or the database already exists.
283 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred.
286 notmuch_database_create (const char *path, notmuch_database_t **database);
289 * Like notmuch_database_create, except optionally return an error
290 * message. This message is allocated by malloc and should be freed by
294 notmuch_database_create_verbose (const char *path,
295 notmuch_database_t **database,
296 char **error_message);
299 * Database open mode for notmuch_database_open.
303 * Open database for reading only.
305 NOTMUCH_DATABASE_MODE_READ_ONLY = 0,
307 * Open database for reading and writing.
309 NOTMUCH_DATABASE_MODE_READ_WRITE
310 } notmuch_database_mode_t;
313 * Deprecated alias for notmuch_database_open_with_config with
314 * config_path=error_message=NULL
315 * @deprecated Deprecated as of libnotmuch 5.4 (notmuch 0.32)
317 /* NOTMUCH_DEPRECATED(5, 4) */
319 notmuch_database_open (const char *path,
320 notmuch_database_mode_t mode,
321 notmuch_database_t **database);
323 * Deprecated alias for notmuch_database_open_with_config with
326 * @deprecated Deprecated as of libnotmuch 5.4 (notmuch 0.32)
329 /* NOTMUCH_DEPRECATED(5, 4) */
331 notmuch_database_open_verbose (const char *path,
332 notmuch_database_mode_t mode,
333 notmuch_database_t **database,
334 char **error_message);
337 * Open an existing notmuch database located at 'database_path', using
338 * configuration in 'config_path'.
340 * @param[in] database_path
342 * Path to existing database.
344 * A notmuch database is a Xapian database containing appropriate
347 * The database should have been created at some time in the past,
348 * (not necessarily by this process), by calling
349 * notmuch_database_create.
351 * If 'database_path' is NULL, use the location specified
353 * - in the environment variable NOTMUCH_DATABASE, if non-empty
355 * - in a configuration file, located as described under 'config_path'
357 * - by $XDG_DATA_HOME/notmuch/$PROFILE where XDG_DATA_HOME defaults
358 * to "$HOME/.local/share" and PROFILE as as discussed in
361 * If 'database_path' is non-NULL, but does not appear to be a Xapian
362 * database, check for a directory '.notmuch/xapian' below
363 * 'database_path' (this is the behavior of
364 * notmuch_database_open_verbose pre-0.32).
369 * Mode to open database. Use one of #NOTMUCH_DATABASE_MODE_READ_WRITE
370 * or #NOTMUCH_DATABASE_MODE_READ_ONLY
373 * @param[in] config_path
375 * Path to config file.
377 * Config file is key-value, with mandatory sections. See
378 * <em>notmuch-config(5)</em> for more information. The key-value pair
379 * overrides the corresponding configuration data stored in the
380 * database (see <em>notmuch_database_get_config</em>)
382 * If <em>config_path</em> is NULL use the path specified
384 * - in environment variable <em>NOTMUCH_CONFIG</em>, if non-empty
386 * - by <em>XDG_CONFIG_HOME</em>/notmuch/ where
387 * XDG_CONFIG_HOME defaults to "$HOME/.config".
389 * - by $HOME/.notmuch-config
391 * If <em>config_path</em> is "" (empty string) then do not
392 * open any configuration file.
394 * @param[in] profile:
396 * Name of profile (configuration/database variant).
398 * If non-NULL, append to the directory / file path determined for
399 * <em>config_path</em> and <em>database_path</em>.
402 * - environment variable NOTMUCH_PROFILE if defined,
403 * - otherwise "default" for directories and "" (empty string) for paths.
406 * @param[out] database
408 * Pointer to database object. May not be NULL.
410 * The caller should call notmuch_database_destroy when finished with
413 * In case of any failure, this function returns an error status and
414 * sets *database to NULL.
417 * @param[out] error_message
418 * If non-NULL, store error message from opening the database.
419 * Any such message is allocated by \a malloc(3) and should be freed
422 * @retval NOTMUCH_STATUS_SUCCESS: Successfully opened the database.
424 * @retval NOTMUCH_STATUS_NULL_POINTER: The given \a database
427 * @retval NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory.
429 * @retval NOTMUCH_STATUS_FILE_ERROR: An error occurred trying to open the
430 * database or config file (such as permission denied, or file not found,
431 * etc.), or the database version is unknown.
433 * @retval NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred.
435 * @since libnotmuch 5.4 (notmuch 0.32)
439 notmuch_database_open_with_config (const char *database_path,
440 notmuch_database_mode_t mode,
441 const char *config_path,
443 notmuch_database_t **database,
444 char **error_message);
446 * Create a new notmuch database located at 'database_path', using
447 * configuration in 'config_path'.
449 * For description of arguments, @see notmuch_database_open_with_config
451 * @retval NOTMUCH_STATUS_SUCCESS: Successfully created the database.
453 * @retval NOTMUCH_STATUS_DATABASE_EXISTS: Database already exists, not created
455 * @retval NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory.
457 * @retval NOTMUCH_STATUS_FILE_ERROR: An error occurred trying to open the
458 * database or config file (such as permission denied, or file not found,
461 * @retval NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred.
463 * @since libnotmuch 5.4 (notmuch 0.32)
467 notmuch_database_create_with_config (const char *database_path,
468 const char *config_path,
470 notmuch_database_t **database,
471 char **error_message);
474 * Retrieve last status string for given database.
478 notmuch_database_status_string (const notmuch_database_t *notmuch);
481 * Commit changes and close the given notmuch database.
483 * After notmuch_database_close has been called, calls to other
484 * functions on objects derived from this database may either behave
485 * as if the database had not been closed (e.g., if the required data
486 * has been cached) or may fail with a
487 * NOTMUCH_STATUS_XAPIAN_EXCEPTION. The only further operation
488 * permitted on the database itself is to call
489 * notmuch_database_destroy.
491 * notmuch_database_close can be called multiple times. Later calls
494 * For writable databases, notmuch_database_close commits all changes
495 * to disk before closing the database. If the caller is currently in
496 * an atomic section (there was a notmuch_database_begin_atomic
497 * without a matching notmuch_database_end_atomic), this will discard
498 * changes made in that atomic section (but still commit changes made
499 * prior to entering the atomic section).
503 * NOTMUCH_STATUS_SUCCESS: Successfully closed the database.
505 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred; the
506 * database has been closed but there are no guarantees the
507 * changes to the database, if any, have been flushed to disk.
510 notmuch_database_close (notmuch_database_t *database);
513 * A callback invoked by notmuch_database_compact to notify the user
514 * of the progress of the compaction process.
516 typedef void (*notmuch_compact_status_cb_t)(const char *message, void *closure);
519 * Compact a notmuch database, backing up the original database to the
522 * The database will be opened with NOTMUCH_DATABASE_MODE_READ_WRITE
523 * during the compaction process to ensure no writes are made.
525 * If the optional callback function 'status_cb' is non-NULL, it will
526 * be called with diagnostic and informational messages. The argument
527 * 'closure' is passed verbatim to any callback invoked.
530 notmuch_database_compact (const char *path,
531 const char *backup_path,
532 notmuch_compact_status_cb_t status_cb,
536 * Like notmuch_database_compact, but take an open database as a
539 * @since libnnotmuch 5.4 (notmuch 0.32)
542 notmuch_database_compact_db (notmuch_database_t *database,
543 const char *backup_path,
544 notmuch_compact_status_cb_t status_cb,
548 * Destroy the notmuch database, closing it if necessary and freeing
549 * all associated resources.
551 * Return value as in notmuch_database_close if the database was open;
552 * notmuch_database_destroy itself has no failure modes.
555 notmuch_database_destroy (notmuch_database_t *database);
558 * Return the database path of the given database.
560 * The return value is a string owned by notmuch so should not be
561 * modified nor freed by the caller.
564 notmuch_database_get_path (notmuch_database_t *database);
567 * Return the database format version of the given database.
572 notmuch_database_get_version (notmuch_database_t *database);
575 * Can the database be upgraded to a newer database version?
577 * If this function returns TRUE, then the caller may call
578 * notmuch_database_upgrade to upgrade the database. If the caller
579 * does not upgrade an out-of-date database, then some functions may
580 * fail with NOTMUCH_STATUS_UPGRADE_REQUIRED. This always returns
581 * FALSE for a read-only database because there's no way to upgrade a
582 * read-only database.
584 * Also returns FALSE if an error occurs accessing the database.
588 notmuch_database_needs_upgrade (notmuch_database_t *database);
591 * Upgrade the current database to the latest supported version.
593 * This ensures that all current notmuch functionality will be
594 * available on the database. After opening a database in read-write
595 * mode, it is recommended that clients check if an upgrade is needed
596 * (notmuch_database_needs_upgrade) and if so, upgrade with this
597 * function before making any modifications. If
598 * notmuch_database_needs_upgrade returns FALSE, this will be a no-op.
600 * The optional progress_notify callback can be used by the caller to
601 * provide progress indication to the user. If non-NULL it will be
602 * called periodically with 'progress' as a floating-point value in
603 * the range of [0.0 .. 1.0] indicating the progress made so far in
604 * the upgrade process. The argument 'closure' is passed verbatim to
605 * any callback invoked.
608 notmuch_database_upgrade (notmuch_database_t *database,
609 void (*progress_notify)(void *closure,
614 * Begin an atomic database operation.
616 * Any modifications performed between a successful begin and a
617 * notmuch_database_end_atomic will be applied to the database
618 * atomically. Note that, unlike a typical database transaction, this
619 * only ensures atomicity, not durability; neither begin nor end
620 * necessarily flush modifications to disk.
622 * Atomic sections may be nested. begin_atomic and end_atomic must
623 * always be called in pairs.
627 * NOTMUCH_STATUS_SUCCESS: Successfully entered atomic section.
629 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred;
630 * atomic section not entered.
633 notmuch_database_begin_atomic (notmuch_database_t *notmuch);
636 * Indicate the end of an atomic database operation.
640 * NOTMUCH_STATUS_SUCCESS: Successfully completed atomic section.
642 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred;
643 * atomic section not ended.
645 * NOTMUCH_STATUS_UNBALANCED_ATOMIC: The database is not currently in
649 notmuch_database_end_atomic (notmuch_database_t *notmuch);
652 * Return the committed database revision and UUID.
654 * The database revision number increases monotonically with each
655 * commit to the database. Hence, all messages and message changes
656 * committed to the database (that is, visible to readers) have a last
657 * modification revision <= the committed database revision. Any
658 * messages committed in the future will be assigned a modification
659 * revision > the committed database revision.
661 * The UUID is a NUL-terminated opaque string that uniquely identifies
662 * this database. Two revision numbers are only comparable if they
663 * have the same database UUID.
666 notmuch_database_get_revision (notmuch_database_t *notmuch,
670 * Retrieve a directory object from the database for 'path'.
672 * Here, 'path' should be a path relative to the path of 'database'
673 * (see notmuch_database_get_path), or else should be an absolute path
674 * with initial components that match the path of 'database'.
676 * If this directory object does not exist in the database, this
677 * returns NOTMUCH_STATUS_SUCCESS and sets *directory to NULL.
679 * Otherwise the returned directory object is owned by the database
680 * and as such, will only be valid until notmuch_database_destroy is
685 * NOTMUCH_STATUS_SUCCESS: Successfully retrieved directory.
687 * NOTMUCH_STATUS_NULL_POINTER: The given 'directory' argument is NULL.
689 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred;
690 * directory not retrieved.
692 * NOTMUCH_STATUS_UPGRADE_REQUIRED: The caller must upgrade the
693 * database to use this function.
696 notmuch_database_get_directory (notmuch_database_t *database,
698 notmuch_directory_t **directory);
701 * Add a message file to a database, indexing it for retrieval by
702 * future searches. If a message already exists with the same message
703 * ID as the specified file, their indexes will be merged, and this
704 * new filename will also be associated with the existing message.
706 * Here, 'filename' should be a path relative to the path of
707 * 'database' (see notmuch_database_get_path), or else should be an
708 * absolute filename with initial components that match the path of
711 * The file should be a single mail message (not a multi-message mbox)
712 * that is expected to remain at its current location, (since the
713 * notmuch database will reference the filename, and will not copy the
714 * entire contents of the file.
716 * If another message with the same message ID already exists in the
717 * database, rather than creating a new message, this adds the search
718 * terms from the identified file to the existing message's index, and
719 * adds 'filename' to the list of filenames known for the message.
721 * The 'indexopts' parameter can be NULL (meaning, use the indexing
722 * defaults from the database), or can be an explicit choice of
723 * indexing options that should govern the indexing of this specific
726 * If 'message' is not NULL, then, on successful return
727 * (NOTMUCH_STATUS_SUCCESS or NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID) '*message'
728 * will be initialized to a message object that can be used for things
729 * such as adding tags to the just-added message. The user should call
730 * notmuch_message_destroy when done with the message. On any failure
731 * '*message' will be set to NULL.
735 * NOTMUCH_STATUS_SUCCESS: Message successfully added to database.
737 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred,
740 * NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID: Message has the same message
741 * ID as another message already in the database. The new
742 * filename was successfully added to the message in the database
743 * (if not already present) and the existing message is returned.
745 * NOTMUCH_STATUS_FILE_ERROR: an error occurred trying to open the
746 * file, (such as permission denied, or file not found,
747 * etc.). Nothing added to the database.
749 * NOTMUCH_STATUS_FILE_NOT_EMAIL: the contents of filename don't look
750 * like an email message. Nothing added to the database.
752 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
753 * mode so no message can be added.
755 * NOTMUCH_STATUS_UPGRADE_REQUIRED: The caller must upgrade the
756 * database to use this function.
758 * @since libnotmuch 5.1 (notmuch 0.26)
761 notmuch_database_index_file (notmuch_database_t *database,
762 const char *filename,
763 notmuch_indexopts_t *indexopts,
764 notmuch_message_t **message);
767 * Deprecated alias for notmuch_database_index_file called with
770 * @deprecated Deprecated as of libnotmuch 5.1 (notmuch 0.26). Please
771 * use notmuch_database_index_file instead.
774 NOTMUCH_DEPRECATED (5, 1)
776 notmuch_database_add_message (notmuch_database_t *database,
777 const char *filename,
778 notmuch_message_t **message);
781 * Remove a message filename from the given notmuch database. If the
782 * message has no more filenames, remove the message.
784 * If the same message (as determined by the message ID) is still
785 * available via other filenames, then the message will persist in the
786 * database for those filenames. When the last filename is removed for
787 * a particular message, the database content for that message will be
792 * NOTMUCH_STATUS_SUCCESS: The last filename was removed and the
793 * message was removed from the database.
795 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred,
796 * message not removed.
798 * NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID: This filename was removed but
799 * the message persists in the database with at least one other
802 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
803 * mode so no message can be removed.
805 * NOTMUCH_STATUS_UPGRADE_REQUIRED: The caller must upgrade the
806 * database to use this function.
809 notmuch_database_remove_message (notmuch_database_t *database,
810 const char *filename);
813 * Find a message with the given message_id.
815 * If a message with the given message_id is found then, on successful return
816 * (NOTMUCH_STATUS_SUCCESS) '*message' will be initialized to a message
817 * object. The caller should call notmuch_message_destroy when done with the
820 * On any failure or when the message is not found, this function initializes
821 * '*message' to NULL. This means, when NOTMUCH_STATUS_SUCCESS is returned, the
822 * caller is supposed to check '*message' for NULL to find out whether the
823 * message with the given message_id was found.
827 * NOTMUCH_STATUS_SUCCESS: Successful return, check '*message'.
829 * NOTMUCH_STATUS_NULL_POINTER: The given 'message' argument is NULL
831 * NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory, creating message object
833 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred
836 notmuch_database_find_message (notmuch_database_t *database,
837 const char *message_id,
838 notmuch_message_t **message);
841 * Find a message with the given filename.
843 * If the database contains a message with the given filename then, on
844 * successful return (NOTMUCH_STATUS_SUCCESS) '*message' will be initialized to
845 * a message object. The caller should call notmuch_message_destroy when done
848 * On any failure or when the message is not found, this function initializes
849 * '*message' to NULL. This means, when NOTMUCH_STATUS_SUCCESS is returned, the
850 * caller is supposed to check '*message' for NULL to find out whether the
851 * message with the given filename is found.
855 * NOTMUCH_STATUS_SUCCESS: Successful return, check '*message'
857 * NOTMUCH_STATUS_NULL_POINTER: The given 'message' argument is NULL
859 * NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory, creating the message object
861 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred
863 * NOTMUCH_STATUS_UPGRADE_REQUIRED: The caller must upgrade the
864 * database to use this function.
867 notmuch_database_find_message_by_filename (notmuch_database_t *notmuch,
868 const char *filename,
869 notmuch_message_t **message);
872 * Return a list of all tags found in the database.
874 * This function creates a list of all tags found in the database. The
875 * resulting list contains all tags from all messages found in the database.
877 * On error this function returns NULL.
880 notmuch_database_get_all_tags (notmuch_database_t *db);
883 * Reopen an open notmuch database.
885 * @param [in] db open notmuch database
886 * @param [in] mode mode (read only or read-write) for reopened database.
888 * @retval #NOTMUCH_STATUS_SUCCESS
889 * @retval #NOTMUCH_STATUS_ILLEGAL_ARGUMENT The passed database was not open.
890 * @retval #NOTMUCH_STATUS_XAPIAN_EXCEPTION A Xapian exception occured
893 notmuch_database_reopen (notmuch_database_t *db, notmuch_database_mode_t mode);
896 * Create a new query for 'database'.
898 * Here, 'database' should be an open database, (see
899 * notmuch_database_open and notmuch_database_create).
901 * For the query string, we'll document the syntax here more
902 * completely in the future, but it's likely to be a specialized
903 * version of the general Xapian query syntax:
905 * https://xapian.org/docs/queryparser.html
907 * As a special case, passing either a length-zero string, (that is ""),
908 * or a string consisting of a single asterisk (that is "*"), will
909 * result in a query that returns all messages in the database.
911 * See notmuch_query_set_sort for controlling the order of results.
912 * See notmuch_query_search_messages and notmuch_query_search_threads
913 * to actually execute the query.
915 * User should call notmuch_query_destroy when finished with this
918 * Will return NULL if insufficient memory is available.
921 notmuch_query_create (notmuch_database_t *database,
922 const char *query_string);
925 * Sort values for notmuch_query_set_sort.
931 NOTMUCH_SORT_OLDEST_FIRST,
935 NOTMUCH_SORT_NEWEST_FIRST,
937 * Sort by message-id.
939 NOTMUCH_SORT_MESSAGE_ID,
943 NOTMUCH_SORT_UNSORTED
947 * Return the query_string of this query. See notmuch_query_create.
950 notmuch_query_get_query_string (const notmuch_query_t *query);
953 * Return the notmuch database of this query. See notmuch_query_create.
956 notmuch_query_get_database (const notmuch_query_t *query);
959 * Exclude values for notmuch_query_set_omit_excluded. The strange
960 * order is to maintain backward compatibility: the old FALSE/TRUE
961 * options correspond to the new
962 * NOTMUCH_EXCLUDE_FLAG/NOTMUCH_EXCLUDE_TRUE options.
965 NOTMUCH_EXCLUDE_FLAG,
966 NOTMUCH_EXCLUDE_TRUE,
967 NOTMUCH_EXCLUDE_FALSE,
972 * Specify whether to omit excluded results or simply flag them. By
973 * default, this is set to TRUE.
975 * If set to TRUE or ALL, notmuch_query_search_messages will omit excluded
976 * messages from the results, and notmuch_query_search_threads will omit
977 * threads that match only in excluded messages. If set to TRUE,
978 * notmuch_query_search_threads will include all messages in threads that
979 * match in at least one non-excluded message. Otherwise, if set to ALL,
980 * notmuch_query_search_threads will omit excluded messages from all threads.
982 * If set to FALSE or FLAG then both notmuch_query_search_messages and
983 * notmuch_query_search_threads will return all matching
984 * messages/threads regardless of exclude status. If set to FLAG then
985 * the exclude flag will be set for any excluded message that is
986 * returned by notmuch_query_search_messages, and the thread counts
987 * for threads returned by notmuch_query_search_threads will be the
988 * number of non-excluded messages/matches. Otherwise, if set to
989 * FALSE, then the exclude status is completely ignored.
991 * The performance difference when calling
992 * notmuch_query_search_messages should be relatively small (and both
993 * should be very fast). However, in some cases,
994 * notmuch_query_search_threads is very much faster when omitting
995 * excluded messages as it does not need to construct the threads that
996 * only match in excluded messages.
999 notmuch_query_set_omit_excluded (notmuch_query_t *query,
1000 notmuch_exclude_t omit_excluded);
1003 * Specify the sorting desired for this query.
1006 notmuch_query_set_sort (notmuch_query_t *query, notmuch_sort_t sort);
1009 * Return the sort specified for this query. See
1010 * notmuch_query_set_sort.
1013 notmuch_query_get_sort (const notmuch_query_t *query);
1016 * Add a tag that will be excluded from the query results by default.
1017 * This exclusion will be ignored if this tag appears explicitly in
1022 * NOTMUCH_STATUS_SUCCESS: excluded was added successfully.
1024 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: a Xapian exception occurred.
1025 * Most likely a problem lazily parsing the query string.
1027 * NOTMUCH_STATUS_IGNORED: tag is explicitly present in the query, so
1031 notmuch_query_add_tag_exclude (notmuch_query_t *query, const char *tag);
1034 * Execute a query for threads, returning a notmuch_threads_t object
1035 * which can be used to iterate over the results. The returned threads
1036 * object is owned by the query and as such, will only be valid until
1037 * notmuch_query_destroy.
1039 * Typical usage might be:
1041 * notmuch_query_t *query;
1042 * notmuch_threads_t *threads;
1043 * notmuch_thread_t *thread;
1044 * notmuch_status_t stat;
1046 * query = notmuch_query_create (database, query_string);
1048 * for (stat = notmuch_query_search_threads (query, &threads);
1049 * stat == NOTMUCH_STATUS_SUCCESS &&
1050 * notmuch_threads_valid (threads);
1051 * notmuch_threads_move_to_next (threads))
1053 * thread = notmuch_threads_get (threads);
1055 * notmuch_thread_destroy (thread);
1058 * notmuch_query_destroy (query);
1060 * Note: If you are finished with a thread before its containing
1061 * query, you can call notmuch_thread_destroy to clean up some memory
1062 * sooner (as in the above example). Otherwise, if your thread objects
1063 * are long-lived, then you don't need to call notmuch_thread_destroy
1064 * and all the memory will still be reclaimed when the query is
1067 * Note that there's no explicit destructor needed for the
1068 * notmuch_threads_t object. (For consistency, we do provide a
1069 * notmuch_threads_destroy function, but there's no good reason
1070 * to call it if the query is about to be destroyed).
1072 * @since libnotmuch 5.0 (notmuch 0.25)
1075 notmuch_query_search_threads (notmuch_query_t *query,
1076 notmuch_threads_t **out);
1079 * Deprecated alias for notmuch_query_search_threads.
1081 * @deprecated Deprecated as of libnotmuch 5 (notmuch 0.25). Please
1082 * use notmuch_query_search_threads instead.
1085 NOTMUCH_DEPRECATED (5, 0)
1087 notmuch_query_search_threads_st (notmuch_query_t *query, notmuch_threads_t **out);
1090 * Execute a query for messages, returning a notmuch_messages_t object
1091 * which can be used to iterate over the results. The returned
1092 * messages object is owned by the query and as such, will only be
1093 * valid until notmuch_query_destroy.
1095 * Typical usage might be:
1097 * notmuch_query_t *query;
1098 * notmuch_messages_t *messages;
1099 * notmuch_message_t *message;
1101 * query = notmuch_query_create (database, query_string);
1103 * for (messages = notmuch_query_search_messages (query);
1104 * notmuch_messages_valid (messages);
1105 * notmuch_messages_move_to_next (messages))
1107 * message = notmuch_messages_get (messages);
1109 * notmuch_message_destroy (message);
1112 * notmuch_query_destroy (query);
1114 * Note: If you are finished with a message before its containing
1115 * query, you can call notmuch_message_destroy to clean up some memory
1116 * sooner (as in the above example). Otherwise, if your message
1117 * objects are long-lived, then you don't need to call
1118 * notmuch_message_destroy and all the memory will still be reclaimed
1119 * when the query is destroyed.
1121 * Note that there's no explicit destructor needed for the
1122 * notmuch_messages_t object. (For consistency, we do provide a
1123 * notmuch_messages_destroy function, but there's no good
1124 * reason to call it if the query is about to be destroyed).
1126 * If a Xapian exception occurs this function will return NULL.
1128 * @since libnotmuch 5 (notmuch 0.25)
1131 notmuch_query_search_messages (notmuch_query_t *query,
1132 notmuch_messages_t **out);
1134 * Deprecated alias for notmuch_query_search_messages
1136 * @deprecated Deprecated as of libnotmuch 5 (notmuch 0.25). Please use
1137 * notmuch_query_search_messages instead.
1141 NOTMUCH_DEPRECATED (5, 0)
1143 notmuch_query_search_messages_st (notmuch_query_t *query,
1144 notmuch_messages_t **out);
1147 * Destroy a notmuch_query_t along with any associated resources.
1149 * This will in turn destroy any notmuch_threads_t and
1150 * notmuch_messages_t objects generated by this query, (and in
1151 * turn any notmuch_thread_t and notmuch_message_t objects generated
1152 * from those results, etc.), if such objects haven't already been
1156 notmuch_query_destroy (notmuch_query_t *query);
1159 * Is the given 'threads' iterator pointing at a valid thread.
1161 * When this function returns TRUE, notmuch_threads_get will return a
1162 * valid object. Whereas when this function returns FALSE,
1163 * notmuch_threads_get will return NULL.
1165 * If passed a NULL pointer, this function returns FALSE
1167 * See the documentation of notmuch_query_search_threads for example
1168 * code showing how to iterate over a notmuch_threads_t object.
1171 notmuch_threads_valid (notmuch_threads_t *threads);
1174 * Get the current thread from 'threads' as a notmuch_thread_t.
1176 * Note: The returned thread belongs to 'threads' and has a lifetime
1177 * identical to it (and the query to which it belongs).
1179 * See the documentation of notmuch_query_search_threads for example
1180 * code showing how to iterate over a notmuch_threads_t object.
1182 * If an out-of-memory situation occurs, this function will return
1186 notmuch_threads_get (notmuch_threads_t *threads);
1189 * Move the 'threads' iterator to the next thread.
1191 * If 'threads' is already pointing at the last thread then the
1192 * iterator will be moved to a point just beyond that last thread,
1193 * (where notmuch_threads_valid will return FALSE and
1194 * notmuch_threads_get will return NULL).
1196 * See the documentation of notmuch_query_search_threads for example
1197 * code showing how to iterate over a notmuch_threads_t object.
1200 notmuch_threads_move_to_next (notmuch_threads_t *threads);
1203 * Destroy a notmuch_threads_t object.
1205 * It's not strictly necessary to call this function. All memory from
1206 * the notmuch_threads_t object will be reclaimed when the
1207 * containing query object is destroyed.
1210 notmuch_threads_destroy (notmuch_threads_t *threads);
1213 * Return the number of messages matching a search.
1215 * This function performs a search and returns the number of matching
1220 * NOTMUCH_STATUS_SUCCESS: query completed successfully.
1222 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: a Xapian exception occurred. The
1223 * value of *count is not defined.
1225 * @since libnotmuch 5 (notmuch 0.25)
1228 notmuch_query_count_messages (notmuch_query_t *query, unsigned int *count);
1231 * Deprecated alias for notmuch_query_count_messages
1234 * @deprecated Deprecated since libnotmuch 5.0 (notmuch 0.25). Please
1235 * use notmuch_query_count_messages instead.
1237 NOTMUCH_DEPRECATED (5, 0)
1239 notmuch_query_count_messages_st (notmuch_query_t *query, unsigned int *count);
1242 * Return the number of threads matching a search.
1244 * This function performs a search and returns the number of unique thread IDs
1245 * in the matching messages. This is the same as number of threads matching a
1248 * Note that this is a significantly heavier operation than
1249 * notmuch_query_count_messages{_st}().
1253 * NOTMUCH_STATUS_OUT_OF_MEMORY: Memory allocation failed. The value
1254 * of *count is not defined
1256 * NOTMUCH_STATUS_SUCCESS: query completed successfully.
1258 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: a Xapian exception occurred. The
1259 * value of *count is not defined.
1261 * @since libnotmuch 5 (notmuch 0.25)
1264 notmuch_query_count_threads (notmuch_query_t *query, unsigned *count);
1267 * Deprecated alias for notmuch_query_count_threads
1269 * @deprecated Deprecated as of libnotmuch 5.0 (notmuch 0.25). Please
1270 * use notmuch_query_count_threads_st instead.
1272 NOTMUCH_DEPRECATED (5, 0)
1274 notmuch_query_count_threads_st (notmuch_query_t *query, unsigned *count);
1277 * Get the thread ID of 'thread'.
1279 * The returned string belongs to 'thread' and as such, should not be
1280 * modified by the caller and will only be valid for as long as the
1281 * thread is valid, (which is until notmuch_thread_destroy or until
1282 * the query from which it derived is destroyed).
1285 notmuch_thread_get_thread_id (notmuch_thread_t *thread);
1288 * Get the total number of messages in 'thread'.
1290 * This count consists of all messages in the database belonging to
1291 * this thread. Contrast with notmuch_thread_get_matched_messages() .
1294 notmuch_thread_get_total_messages (notmuch_thread_t *thread);
1297 * Get the total number of files in 'thread'.
1299 * This sums notmuch_message_count_files over all messages in the
1301 * @returns Non-negative integer
1302 * @since libnotmuch 5.0 (notmuch 0.25)
1306 notmuch_thread_get_total_files (notmuch_thread_t *thread);
1309 * Get a notmuch_messages_t iterator for the top-level messages in
1310 * 'thread' in oldest-first order.
1312 * This iterator will not necessarily iterate over all of the messages
1313 * in the thread. It will only iterate over the messages in the thread
1314 * which are not replies to other messages in the thread.
1316 * The returned list will be destroyed when the thread is destroyed.
1318 notmuch_messages_t *
1319 notmuch_thread_get_toplevel_messages (notmuch_thread_t *thread);
1322 * Get a notmuch_thread_t iterator for all messages in 'thread' in
1323 * oldest-first order.
1325 * The returned list will be destroyed when the thread is destroyed.
1327 notmuch_messages_t *
1328 notmuch_thread_get_messages (notmuch_thread_t *thread);
1331 * Get the number of messages in 'thread' that matched the search.
1333 * This count includes only the messages in this thread that were
1334 * matched by the search from which the thread was created and were
1335 * not excluded by any exclude tags passed in with the query (see
1336 * notmuch_query_add_tag_exclude). Contrast with
1337 * notmuch_thread_get_total_messages() .
1340 notmuch_thread_get_matched_messages (notmuch_thread_t *thread);
1343 * Get the authors of 'thread' as a UTF-8 string.
1345 * The returned string is a comma-separated list of the names of the
1346 * authors of mail messages in the query results that belong to this
1349 * The string contains authors of messages matching the query first, then
1350 * non-matched authors (with the two groups separated by '|'). Within
1351 * each group, authors are ordered by date.
1353 * The returned string belongs to 'thread' and as such, should not be
1354 * modified by the caller and will only be valid for as long as the
1355 * thread is valid, (which is until notmuch_thread_destroy or until
1356 * the query from which it derived is destroyed).
1359 notmuch_thread_get_authors (notmuch_thread_t *thread);
1362 * Get the subject of 'thread' as a UTF-8 string.
1364 * The subject is taken from the first message (according to the query
1365 * order---see notmuch_query_set_sort) in the query results that
1366 * belongs to this thread.
1368 * The returned string belongs to 'thread' and as such, should not be
1369 * modified by the caller and will only be valid for as long as the
1370 * thread is valid, (which is until notmuch_thread_destroy or until
1371 * the query from which it derived is destroyed).
1374 notmuch_thread_get_subject (notmuch_thread_t *thread);
1377 * Get the date of the oldest message in 'thread' as a time_t value.
1380 notmuch_thread_get_oldest_date (notmuch_thread_t *thread);
1383 * Get the date of the newest message in 'thread' as a time_t value.
1386 notmuch_thread_get_newest_date (notmuch_thread_t *thread);
1389 * Get the tags for 'thread', returning a notmuch_tags_t object which
1390 * can be used to iterate over all tags.
1392 * Note: In the Notmuch database, tags are stored on individual
1393 * messages, not on threads. So the tags returned here will be all
1394 * tags of the messages which matched the search and which belong to
1397 * The tags object is owned by the thread and as such, will only be
1398 * valid for as long as the thread is valid, (for example, until
1399 * notmuch_thread_destroy or until the query from which it derived is
1402 * Typical usage might be:
1404 * notmuch_thread_t *thread;
1405 * notmuch_tags_t *tags;
1408 * thread = notmuch_threads_get (threads);
1410 * for (tags = notmuch_thread_get_tags (thread);
1411 * notmuch_tags_valid (tags);
1412 * notmuch_tags_move_to_next (tags))
1414 * tag = notmuch_tags_get (tags);
1418 * notmuch_thread_destroy (thread);
1420 * Note that there's no explicit destructor needed for the
1421 * notmuch_tags_t object. (For consistency, we do provide a
1422 * notmuch_tags_destroy function, but there's no good reason to call
1423 * it if the message is about to be destroyed).
1426 notmuch_thread_get_tags (notmuch_thread_t *thread);
1429 * Destroy a notmuch_thread_t object.
1432 notmuch_thread_destroy (notmuch_thread_t *thread);
1435 * Is the given 'messages' iterator pointing at a valid message.
1437 * When this function returns TRUE, notmuch_messages_get will return a
1438 * valid object. Whereas when this function returns FALSE,
1439 * notmuch_messages_get will return NULL.
1441 * See the documentation of notmuch_query_search_messages for example
1442 * code showing how to iterate over a notmuch_messages_t object.
1445 notmuch_messages_valid (notmuch_messages_t *messages);
1448 * Get the current message from 'messages' as a notmuch_message_t.
1450 * Note: The returned message belongs to 'messages' and has a lifetime
1451 * identical to it (and the query to which it belongs).
1453 * See the documentation of notmuch_query_search_messages for example
1454 * code showing how to iterate over a notmuch_messages_t object.
1456 * If an out-of-memory situation occurs, this function will return
1460 notmuch_messages_get (notmuch_messages_t *messages);
1463 * Move the 'messages' iterator to the next message.
1465 * If 'messages' is already pointing at the last message then the
1466 * iterator will be moved to a point just beyond that last message,
1467 * (where notmuch_messages_valid will return FALSE and
1468 * notmuch_messages_get will return NULL).
1470 * See the documentation of notmuch_query_search_messages for example
1471 * code showing how to iterate over a notmuch_messages_t object.
1474 notmuch_messages_move_to_next (notmuch_messages_t *messages);
1477 * Destroy a notmuch_messages_t object.
1479 * It's not strictly necessary to call this function. All memory from
1480 * the notmuch_messages_t object will be reclaimed when the containing
1481 * query object is destroyed.
1484 notmuch_messages_destroy (notmuch_messages_t *messages);
1487 * Return a list of tags from all messages.
1489 * The resulting list is guaranteed not to contain duplicated tags.
1491 * WARNING: You can no longer iterate over messages after calling this
1492 * function, because the iterator will point at the end of the list.
1493 * We do not have a function to reset the iterator yet and the only
1494 * way how you can iterate over the list again is to recreate the
1497 * The function returns NULL on error.
1500 notmuch_messages_collect_tags (notmuch_messages_t *messages);
1503 * Get the database associated with this message.
1505 * @since libnotmuch 5.2 (notmuch 0.27)
1507 notmuch_database_t *
1508 notmuch_message_get_database (const notmuch_message_t *message);
1511 * Get the message ID of 'message'.
1513 * The returned string belongs to 'message' and as such, should not be
1514 * modified by the caller and will only be valid for as long as the
1515 * message is valid, (which is until the query from which it derived
1518 * This function will return NULL if triggers an unhandled Xapian
1522 notmuch_message_get_message_id (notmuch_message_t *message);
1525 * Get the thread ID of 'message'.
1527 * The returned string belongs to 'message' and as such, should not be
1528 * modified by the caller and will only be valid for as long as the
1529 * message is valid, (for example, until the user calls
1530 * notmuch_message_destroy on 'message' or until a query from which it
1531 * derived is destroyed).
1533 * This function will return NULL if triggers an unhandled Xapian
1537 notmuch_message_get_thread_id (notmuch_message_t *message);
1540 * Get a notmuch_messages_t iterator for all of the replies to
1543 * Note: This call only makes sense if 'message' was ultimately
1544 * obtained from a notmuch_thread_t object, (such as by coming
1545 * directly from the result of calling notmuch_thread_get_
1546 * toplevel_messages or by any number of subsequent
1547 * calls to notmuch_message_get_replies).
1549 * If 'message' was obtained through some non-thread means, (such as
1550 * by a call to notmuch_query_search_messages), then this function
1553 * If there are no replies to 'message', this function will return
1554 * NULL. (Note that notmuch_messages_valid will accept that NULL
1555 * value as legitimate, and simply return FALSE for it.)
1557 * This function also returns NULL if it triggers a Xapian exception.
1559 * The returned list will be destroyed when the thread is
1562 notmuch_messages_t *
1563 notmuch_message_get_replies (notmuch_message_t *message);
1566 * Get the total number of files associated with a message.
1567 * @returns Non-negative integer for file count.
1568 * @returns Negative integer for error.
1569 * @since libnotmuch 5.0 (notmuch 0.25)
1572 notmuch_message_count_files (notmuch_message_t *message);
1575 * Get a filename for the email corresponding to 'message'.
1577 * The returned filename is an absolute filename, (the initial
1578 * component will match notmuch_database_get_path() ).
1580 * The returned string belongs to the message so should not be
1581 * modified or freed by the caller (nor should it be referenced after
1582 * the message is destroyed).
1584 * Note: If this message corresponds to multiple files in the mail
1585 * store, (that is, multiple files contain identical message IDs),
1586 * this function will arbitrarily return a single one of those
1587 * filenames. See notmuch_message_get_filenames for returning the
1588 * complete list of filenames.
1590 * This function returns NULL if it triggers a Xapian exception.
1593 notmuch_message_get_filename (notmuch_message_t *message);
1596 * Get all filenames for the email corresponding to 'message'.
1598 * Returns a notmuch_filenames_t iterator listing all the filenames
1599 * associated with 'message'. These files may not have identical
1600 * content, but each will have the identical Message-ID.
1602 * Each filename in the iterator is an absolute filename, (the initial
1603 * component will match notmuch_database_get_path() ).
1605 * This function returns NULL if it triggers a Xapian exception.
1607 notmuch_filenames_t *
1608 notmuch_message_get_filenames (notmuch_message_t *message);
1611 * Re-index the e-mail corresponding to 'message' using the supplied index options
1613 * Returns the status of the re-index operation. (see the return
1614 * codes documented in notmuch_database_index_file)
1616 * After reindexing, the user should discard the message object passed
1617 * in here by calling notmuch_message_destroy, since it refers to the
1618 * original message, not to the reindexed message.
1621 notmuch_message_reindex (notmuch_message_t *message,
1622 notmuch_indexopts_t *indexopts);
1627 typedef enum _notmuch_message_flag {
1628 NOTMUCH_MESSAGE_FLAG_MATCH,
1629 NOTMUCH_MESSAGE_FLAG_EXCLUDED,
1631 /* This message is a "ghost message", meaning it has no filenames
1632 * or content, but we know it exists because it was referenced by
1633 * some other message. A ghost message has only a message ID and
1636 NOTMUCH_MESSAGE_FLAG_GHOST,
1637 } notmuch_message_flag_t;
1640 * Get a value of a flag for the email corresponding to 'message'.
1642 * returns FALSE in case of errors.
1644 * @deprecated Deprecated as of libnotmuch 5.3 (notmuch 0.31). Please
1645 * use notmuch_message_get_flag_st instead.
1647 NOTMUCH_DEPRECATED (5, 3)
1649 notmuch_message_get_flag (notmuch_message_t *message,
1650 notmuch_message_flag_t flag);
1653 * Get a value of a flag for the email corresponding to 'message'.
1655 * @param message a message object
1656 * @param flag flag to check
1657 * @param is_set pointer to boolean to store flag value.
1659 * @retval #NOTMUCH_STATUS_SUCCESS
1660 * @retval #NOTMUCH_STATUS_NULL_POINTER is_set is NULL
1661 * @retval #NOTMUCH_STATUS_XAPIAN_EXCEPTION Accessing the database
1662 * triggered an exception.
1664 * @since libnotmuch 5.3 (notmuch 0.31)
1667 notmuch_message_get_flag_st (notmuch_message_t *message,
1668 notmuch_message_flag_t flag,
1669 notmuch_bool_t *is_set);
1672 * Set a value of a flag for the email corresponding to 'message'.
1675 notmuch_message_set_flag (notmuch_message_t *message,
1676 notmuch_message_flag_t flag, notmuch_bool_t value);
1679 * Get the date of 'message' as a time_t value.
1681 * For the original textual representation of the Date header from the
1682 * message call notmuch_message_get_header() with a header value of
1685 * Returns 0 in case of error.
1688 notmuch_message_get_date (notmuch_message_t *message);
1691 * Get the value of the specified header from 'message' as a UTF-8 string.
1693 * Common headers are stored in the database when the message is
1694 * indexed and will be returned from the database. Other headers will
1695 * be read from the actual message file.
1697 * The header name is case insensitive.
1699 * The returned string belongs to the message so should not be
1700 * modified or freed by the caller (nor should it be referenced after
1701 * the message is destroyed).
1703 * Returns an empty string ("") if the message does not contain a
1704 * header line matching 'header'. Returns NULL if any error occurs.
1707 notmuch_message_get_header (notmuch_message_t *message, const char *header);
1710 * Get the tags for 'message', returning a notmuch_tags_t object which
1711 * can be used to iterate over all tags.
1713 * The tags object is owned by the message and as such, will only be
1714 * valid for as long as the message is valid, (which is until the
1715 * query from which it derived is destroyed).
1717 * Typical usage might be:
1719 * notmuch_message_t *message;
1720 * notmuch_tags_t *tags;
1723 * message = notmuch_database_find_message (database, message_id);
1725 * for (tags = notmuch_message_get_tags (message);
1726 * notmuch_tags_valid (tags);
1727 * notmuch_tags_move_to_next (tags))
1729 * tag = notmuch_tags_get (tags);
1733 * notmuch_message_destroy (message);
1735 * Note that there's no explicit destructor needed for the
1736 * notmuch_tags_t object. (For consistency, we do provide a
1737 * notmuch_tags_destroy function, but there's no good reason to call
1738 * it if the message is about to be destroyed).
1741 notmuch_message_get_tags (notmuch_message_t *message);
1744 * The longest possible tag value.
1746 #define NOTMUCH_TAG_MAX 200
1749 * Add a tag to the given message.
1753 * NOTMUCH_STATUS_SUCCESS: Tag successfully added to message
1755 * NOTMUCH_STATUS_NULL_POINTER: The 'tag' argument is NULL
1757 * NOTMUCH_STATUS_TAG_TOO_LONG: The length of 'tag' is too long
1758 * (exceeds NOTMUCH_TAG_MAX)
1760 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
1761 * mode so message cannot be modified.
1764 notmuch_message_add_tag (notmuch_message_t *message, const char *tag);
1767 * Remove a tag from the given message.
1771 * NOTMUCH_STATUS_SUCCESS: Tag successfully removed from message
1773 * NOTMUCH_STATUS_NULL_POINTER: The 'tag' argument is NULL
1775 * NOTMUCH_STATUS_TAG_TOO_LONG: The length of 'tag' is too long
1776 * (exceeds NOTMUCH_TAG_MAX)
1778 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
1779 * mode so message cannot be modified.
1782 notmuch_message_remove_tag (notmuch_message_t *message, const char *tag);
1785 * Remove all tags from the given message.
1787 * See notmuch_message_freeze for an example showing how to safely
1788 * replace tag values.
1790 * @retval #NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in
1791 * read-only mode so message cannot be modified.
1792 * @retval #NOTMUCH_STATUS_XAPIAN_EXCEPTION: an exception was thrown
1793 * accessing the database.
1796 notmuch_message_remove_all_tags (notmuch_message_t *message);
1799 * Add/remove tags according to maildir flags in the message filename(s).
1801 * This function examines the filenames of 'message' for maildir
1802 * flags, and adds or removes tags on 'message' as follows when these
1803 * flags are present:
1805 * Flag Action if present
1806 * ---- -----------------
1807 * 'D' Adds the "draft" tag to the message
1808 * 'F' Adds the "flagged" tag to the message
1809 * 'P' Adds the "passed" tag to the message
1810 * 'R' Adds the "replied" tag to the message
1811 * 'S' Removes the "unread" tag from the message
1813 * For each flag that is not present, the opposite action (add/remove)
1814 * is performed for the corresponding tags.
1816 * Flags are identified as trailing components of the filename after a
1817 * sequence of ":2,".
1819 * If there are multiple filenames associated with this message, the
1820 * flag is considered present if it appears in one or more
1821 * filenames. (That is, the flags from the multiple filenames are
1822 * combined with the logical OR operator.)
1824 * A client can ensure that notmuch database tags remain synchronized
1825 * with maildir flags by calling this function after each call to
1826 * notmuch_database_index_file. See also
1827 * notmuch_message_tags_to_maildir_flags for synchronizing tag changes
1828 * back to maildir flags.
1831 notmuch_message_maildir_flags_to_tags (notmuch_message_t *message);
1834 * return TRUE if any filename of 'message' has maildir flag 'flag',
1837 * Deprecated wrapper for notmuch_message_has_maildir_flag_st
1839 * @returns FALSE in case of error
1840 * @deprecated libnotmuch 5.3 (notmuch 0.31)
1842 NOTMUCH_DEPRECATED (5, 3)
1844 notmuch_message_has_maildir_flag (notmuch_message_t *message, char flag);
1847 * check message for maildir flag
1849 * @param [in,out] message message to check
1850 * @param [in] flag flag to check for
1851 * @param [out] is_set pointer to boolean
1853 * @retval #NOTMUCH_STATUS_SUCCESS
1854 * @retval #NOTMUCH_STATUS_NULL_POINTER is_set is NULL
1855 * @retval #NOTMUCH_STATUS_XAPIAN_EXCEPTION Accessing the database
1856 * triggered an exception.
1859 notmuch_message_has_maildir_flag_st (notmuch_message_t *message,
1861 notmuch_bool_t *is_set);
1864 * Rename message filename(s) to encode tags as maildir flags.
1866 * Specifically, for each filename corresponding to this message:
1868 * If the filename is not in a maildir directory, do nothing. (A
1869 * maildir directory is determined as a directory named "new" or
1870 * "cur".) Similarly, if the filename has invalid maildir info,
1871 * (repeated or outof-ASCII-order flag characters after ":2,"), then
1874 * If the filename is in a maildir directory, rename the file so that
1875 * its filename ends with the sequence ":2," followed by zero or more
1876 * of the following single-character flags (in ASCII order):
1878 * * flag 'D' iff the message has the "draft" tag
1879 * * flag 'F' iff the message has the "flagged" tag
1880 * * flag 'P' iff the message has the "passed" tag
1881 * * flag 'R' iff the message has the "replied" tag
1882 * * flag 'S' iff the message does not have the "unread" tag
1884 * Any existing flags unmentioned in the list above will be preserved
1887 * Also, if this filename is in a directory named "new", rename it to
1888 * be within the neighboring directory named "cur".
1890 * A client can ensure that maildir filename flags remain synchronized
1891 * with notmuch database tags by calling this function after changing
1892 * tags, (after calls to notmuch_message_add_tag,
1893 * notmuch_message_remove_tag, or notmuch_message_freeze/
1894 * notmuch_message_thaw). See also notmuch_message_maildir_flags_to_tags
1895 * for synchronizing maildir flag changes back to tags.
1898 notmuch_message_tags_to_maildir_flags (notmuch_message_t *message);
1901 * Freeze the current state of 'message' within the database.
1903 * This means that changes to the message state, (via
1904 * notmuch_message_add_tag, notmuch_message_remove_tag, and
1905 * notmuch_message_remove_all_tags), will not be committed to the
1906 * database until the message is thawed with notmuch_message_thaw.
1908 * Multiple calls to freeze/thaw are valid and these calls will
1909 * "stack". That is there must be as many calls to thaw as to freeze
1910 * before a message is actually thawed.
1912 * The ability to do freeze/thaw allows for safe transactions to
1913 * change tag values. For example, explicitly setting a message to
1914 * have a given set of tags might look like this:
1916 * notmuch_message_freeze (message);
1918 * notmuch_message_remove_all_tags (message);
1920 * for (i = 0; i < NUM_TAGS; i++)
1921 * notmuch_message_add_tag (message, tags[i]);
1923 * notmuch_message_thaw (message);
1925 * With freeze/thaw used like this, the message in the database is
1926 * guaranteed to have either the full set of original tag values, or
1927 * the full set of new tag values, but nothing in between.
1929 * Imagine the example above without freeze/thaw and the operation
1930 * somehow getting interrupted. This could result in the message being
1931 * left with no tags if the interruption happened after
1932 * notmuch_message_remove_all_tags but before notmuch_message_add_tag.
1936 * NOTMUCH_STATUS_SUCCESS: Message successfully frozen.
1938 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
1939 * mode so message cannot be modified.
1942 notmuch_message_freeze (notmuch_message_t *message);
1945 * Thaw the current 'message', synchronizing any changes that may have
1946 * occurred while 'message' was frozen into the notmuch database.
1948 * See notmuch_message_freeze for an example of how to use this
1949 * function to safely provide tag changes.
1951 * Multiple calls to freeze/thaw are valid and these calls with
1952 * "stack". That is there must be as many calls to thaw as to freeze
1953 * before a message is actually thawed.
1957 * NOTMUCH_STATUS_SUCCESS: Message successfully thawed, (or at least
1958 * its frozen count has successfully been reduced by 1).
1960 * NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW: An attempt was made to thaw
1961 * an unfrozen message. That is, there have been an unbalanced
1962 * number of calls to notmuch_message_freeze and
1963 * notmuch_message_thaw.
1966 notmuch_message_thaw (notmuch_message_t *message);
1969 * Destroy a notmuch_message_t object.
1971 * It can be useful to call this function in the case of a single
1972 * query object with many messages in the result, (such as iterating
1973 * over the entire database). Otherwise, it's fine to never call this
1974 * function and there will still be no memory leaks. (The memory from
1975 * the messages get reclaimed when the containing query is destroyed.)
1978 notmuch_message_destroy (notmuch_message_t *message);
1981 * @name Message Properties
1983 * This interface provides the ability to attach arbitrary (key,value)
1984 * string pairs to a message, to remove such pairs, and to iterate
1985 * over them. The caller should take some care as to what keys they
1986 * add or delete values for, as other subsystems or extensions may
1987 * depend on these properties.
1989 * Please see notmuch-properties(7) for more details about specific
1990 * properties and conventions around their use.
1995 * Retrieve the value for a single property key
1997 * *value* is set to a string owned by the message or NULL if there is
1998 * no such key. In the case of multiple values for the given key, the
1999 * first one is retrieved.
2002 * - NOTMUCH_STATUS_NULL_POINTER: *value* may not be NULL.
2003 * - NOTMUCH_STATUS_SUCCESS: No error occurred.
2004 * @since libnotmuch 4.4 (notmuch 0.23)
2007 notmuch_message_get_property (notmuch_message_t *message, const char *key, const char **value);
2010 * Add a (key,value) pair to a message
2013 * - NOTMUCH_STATUS_ILLEGAL_ARGUMENT: *key* may not contain an '=' character.
2014 * - NOTMUCH_STATUS_NULL_POINTER: Neither *key* nor *value* may be NULL.
2015 * - NOTMUCH_STATUS_SUCCESS: No error occurred.
2016 * @since libnotmuch 4.4 (notmuch 0.23)
2019 notmuch_message_add_property (notmuch_message_t *message, const char *key, const char *value);
2022 * Remove a (key,value) pair from a message.
2024 * It is not an error to remove a non-existent (key,value) pair
2027 * - NOTMUCH_STATUS_ILLEGAL_ARGUMENT: *key* may not contain an '=' character.
2028 * - NOTMUCH_STATUS_NULL_POINTER: Neither *key* nor *value* may be NULL.
2029 * - NOTMUCH_STATUS_SUCCESS: No error occurred.
2030 * @since libnotmuch 4.4 (notmuch 0.23)
2033 notmuch_message_remove_property (notmuch_message_t *message, const char *key, const char *value);
2036 * Remove all (key,value) pairs from the given message.
2038 * @param[in,out] message message to operate on.
2039 * @param[in] key key to delete properties for. If NULL, delete
2040 * properties for all keys
2042 * - NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in
2043 * read-only mode so message cannot be modified.
2044 * - NOTMUCH_STATUS_SUCCESS: No error occurred.
2046 * @since libnotmuch 4.4 (notmuch 0.23)
2049 notmuch_message_remove_all_properties (notmuch_message_t *message, const char *key);
2052 * Remove all (prefix*,value) pairs from the given message
2054 * @param[in,out] message message to operate on.
2055 * @param[in] prefix delete properties with keys that start with prefix.
2056 * If NULL, delete all properties
2058 * - NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in
2059 * read-only mode so message cannot be modified.
2060 * - NOTMUCH_STATUS_SUCCESS: No error occurred.
2062 * @since libnotmuch 5.1 (notmuch 0.26)
2065 notmuch_message_remove_all_properties_with_prefix (notmuch_message_t *message, const char *prefix);
2068 * Opaque message property iterator
2070 typedef struct _notmuch_string_map_iterator notmuch_message_properties_t;
2073 * Get the properties for *message*, returning a
2074 * notmuch_message_properties_t object which can be used to iterate
2075 * over all properties.
2077 * The notmuch_message_properties_t object is owned by the message and
2078 * as such, will only be valid for as long as the message is valid,
2079 * (which is until the query from which it derived is destroyed).
2081 * @param[in] message The message to examine
2082 * @param[in] key key or key prefix
2083 * @param[in] exact if TRUE, require exact match with key. Otherwise
2086 * Typical usage might be:
2088 * notmuch_message_properties_t *list;
2090 * for (list = notmuch_message_get_properties (message, "testkey1", TRUE);
2091 * notmuch_message_properties_valid (list); notmuch_message_properties_move_to_next (list)) {
2092 * printf("%s\n", notmuch_message_properties_value(list));
2095 * notmuch_message_properties_destroy (list);
2097 * Note that there's no explicit destructor needed for the
2098 * notmuch_message_properties_t object. (For consistency, we do
2099 * provide a notmuch_message_properities_destroy function, but there's
2100 * no good reason to call it if the message is about to be destroyed).
2102 * @since libnotmuch 4.4 (notmuch 0.23)
2104 notmuch_message_properties_t *
2105 notmuch_message_get_properties (notmuch_message_t *message, const char *key, notmuch_bool_t exact);
2108 * Return the number of properties named "key" belonging to the specific message.
2110 * @param[in] message The message to examine
2111 * @param[in] key key to count
2112 * @param[out] count The number of matching properties associated with this message.
2116 * NOTMUCH_STATUS_SUCCESS: successful count, possibly some other error.
2118 * @since libnotmuch 5.2 (notmuch 0.27)
2121 notmuch_message_count_properties (notmuch_message_t *message, const char *key, unsigned int *count);
2124 * Is the given *properties* iterator pointing at a valid (key,value)
2127 * When this function returns TRUE,
2128 * notmuch_message_properties_{key,value} will return a valid string,
2129 * and notmuch_message_properties_move_to_next will do what it
2130 * says. Whereas when this function returns FALSE, calling any of
2131 * these functions results in undefined behaviour.
2133 * See the documentation of notmuch_message_get_properties for example
2134 * code showing how to iterate over a notmuch_message_properties_t
2137 * @since libnotmuch 4.4 (notmuch 0.23)
2140 notmuch_message_properties_valid (notmuch_message_properties_t *properties);
2143 * Move the *properties* iterator to the next (key,value) pair
2145 * If *properties* is already pointing at the last pair then the iterator
2146 * will be moved to a point just beyond that last pair, (where
2147 * notmuch_message_properties_valid will return FALSE).
2149 * See the documentation of notmuch_message_get_properties for example
2150 * code showing how to iterate over a notmuch_message_properties_t object.
2152 * @since libnotmuch 4.4 (notmuch 0.23)
2155 notmuch_message_properties_move_to_next (notmuch_message_properties_t *properties);
2158 * Return the key from the current (key,value) pair.
2160 * this could be useful if iterating for a prefix
2162 * @since libnotmuch 4.4 (notmuch 0.23)
2165 notmuch_message_properties_key (notmuch_message_properties_t *properties);
2168 * Return the value from the current (key,value) pair.
2170 * This could be useful if iterating for a prefix.
2172 * @since libnotmuch 4.4 (notmuch 0.23)
2175 notmuch_message_properties_value (notmuch_message_properties_t *properties);
2179 * Destroy a notmuch_message_properties_t object.
2181 * It's not strictly necessary to call this function. All memory from
2182 * the notmuch_message_properties_t object will be reclaimed when the
2183 * containing message object is destroyed.
2185 * @since libnotmuch 4.4 (notmuch 0.23)
2188 notmuch_message_properties_destroy (notmuch_message_properties_t *properties);
2193 * Is the given 'tags' iterator pointing at a valid tag.
2195 * When this function returns TRUE, notmuch_tags_get will return a
2196 * valid string. Whereas when this function returns FALSE,
2197 * notmuch_tags_get will return NULL.
2199 * See the documentation of notmuch_message_get_tags for example code
2200 * showing how to iterate over a notmuch_tags_t object.
2203 notmuch_tags_valid (notmuch_tags_t *tags);
2206 * Get the current tag from 'tags' as a string.
2208 * Note: The returned string belongs to 'tags' and has a lifetime
2209 * identical to it (and the query to which it ultimately belongs).
2211 * See the documentation of notmuch_message_get_tags for example code
2212 * showing how to iterate over a notmuch_tags_t object.
2215 notmuch_tags_get (notmuch_tags_t *tags);
2218 * Move the 'tags' iterator to the next tag.
2220 * If 'tags' is already pointing at the last tag then the iterator
2221 * will be moved to a point just beyond that last tag, (where
2222 * notmuch_tags_valid will return FALSE and notmuch_tags_get will
2225 * See the documentation of notmuch_message_get_tags for example code
2226 * showing how to iterate over a notmuch_tags_t object.
2229 notmuch_tags_move_to_next (notmuch_tags_t *tags);
2232 * Destroy a notmuch_tags_t object.
2234 * It's not strictly necessary to call this function. All memory from
2235 * the notmuch_tags_t object will be reclaimed when the containing
2236 * message or query objects are destroyed.
2239 notmuch_tags_destroy (notmuch_tags_t *tags);
2242 * Store an mtime within the database for 'directory'.
2244 * The 'directory' should be an object retrieved from the database
2245 * with notmuch_database_get_directory for a particular path.
2247 * The intention is for the caller to use the mtime to allow efficient
2248 * identification of new messages to be added to the database. The
2249 * recommended usage is as follows:
2251 * o Read the mtime of a directory from the filesystem
2253 * o Call index_file for all mail files in the directory
2255 * o Call notmuch_directory_set_mtime with the mtime read from the
2258 * Then, when wanting to check for updates to the directory in the
2259 * future, the client can call notmuch_directory_get_mtime and know
2260 * that it only needs to add files if the mtime of the directory and
2261 * files are newer than the stored timestamp.
2263 * Note: The notmuch_directory_get_mtime function does not allow the
2264 * caller to distinguish a timestamp of 0 from a non-existent
2265 * timestamp. So don't store a timestamp of 0 unless you are
2266 * comfortable with that.
2270 * NOTMUCH_STATUS_SUCCESS: mtime successfully stored in database.
2272 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception
2273 * occurred, mtime not stored.
2275 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
2276 * mode so directory mtime cannot be modified.
2279 notmuch_directory_set_mtime (notmuch_directory_t *directory,
2283 * Get the mtime of a directory, (as previously stored with
2284 * notmuch_directory_set_mtime).
2286 * Returns 0 if no mtime has previously been stored for this
2290 notmuch_directory_get_mtime (notmuch_directory_t *directory);
2293 * Get a notmuch_filenames_t iterator listing all the filenames of
2294 * messages in the database within the given directory.
2296 * The returned filenames will be the basename-entries only (not
2299 * Returns NULL if it triggers a Xapian exception
2301 notmuch_filenames_t *
2302 notmuch_directory_get_child_files (notmuch_directory_t *directory);
2305 * Get a notmuch_filenames_t iterator listing all the filenames of
2306 * sub-directories in the database within the given directory.
2308 * The returned filenames will be the basename-entries only (not
2311 * Returns NULL if it triggers a Xapian exception
2313 notmuch_filenames_t *
2314 notmuch_directory_get_child_directories (notmuch_directory_t *directory);
2317 * Delete directory document from the database, and destroy the
2318 * notmuch_directory_t object. Assumes any child directories and files
2319 * have been deleted by the caller.
2321 * @since libnotmuch 4.3 (notmuch 0.21)
2324 notmuch_directory_delete (notmuch_directory_t *directory);
2327 * Destroy a notmuch_directory_t object.
2330 notmuch_directory_destroy (notmuch_directory_t *directory);
2333 * Is the given 'filenames' iterator pointing at a valid filename.
2335 * When this function returns TRUE, notmuch_filenames_get will return
2336 * a valid string. Whereas when this function returns FALSE,
2337 * notmuch_filenames_get will return NULL.
2339 * It is acceptable to pass NULL for 'filenames', in which case this
2340 * function will always return FALSE.
2343 notmuch_filenames_valid (notmuch_filenames_t *filenames);
2346 * Get the current filename from 'filenames' as a string.
2348 * Note: The returned string belongs to 'filenames' and has a lifetime
2349 * identical to it (and the directory to which it ultimately belongs).
2351 * It is acceptable to pass NULL for 'filenames', in which case this
2352 * function will always return NULL.
2355 notmuch_filenames_get (notmuch_filenames_t *filenames);
2358 * Move the 'filenames' iterator to the next filename.
2360 * If 'filenames' is already pointing at the last filename then the
2361 * iterator will be moved to a point just beyond that last filename,
2362 * (where notmuch_filenames_valid will return FALSE and
2363 * notmuch_filenames_get will return NULL).
2365 * It is acceptable to pass NULL for 'filenames', in which case this
2366 * function will do nothing.
2369 notmuch_filenames_move_to_next (notmuch_filenames_t *filenames);
2372 * Destroy a notmuch_filenames_t object.
2374 * It's not strictly necessary to call this function. All memory from
2375 * the notmuch_filenames_t object will be reclaimed when the
2376 * containing directory object is destroyed.
2378 * It is acceptable to pass NULL for 'filenames', in which case this
2379 * function will do nothing.
2382 notmuch_filenames_destroy (notmuch_filenames_t *filenames);
2386 * set config 'key' to 'value'
2388 * @since libnotmuch 4.4 (notmuch 0.23)
2389 * @retval #NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in
2390 * read-only mode so message cannot be modified.
2391 * @retval #NOTMUCH_STATUS_XAPIAN_EXCEPTION: an exception was thrown
2392 * accessing the database.
2393 * @retval #NOTMUCH_STATUS_SUCCESS
2396 notmuch_database_set_config (notmuch_database_t *db, const char *key, const char *value);
2399 * retrieve config item 'key', assign to 'value'
2401 * keys which have not been previously set with n_d_set_config will
2402 * return an empty string.
2404 * return value is allocated by malloc and should be freed by the
2407 * @since libnotmuch 4.4 (notmuch 0.23)
2411 notmuch_database_get_config (notmuch_database_t *db, const char *key, char **value);
2414 * Create an iterator for all config items with keys matching a given prefix
2416 * @since libnotmuch 4.4 (notmuch 0.23)
2419 notmuch_database_get_config_list (notmuch_database_t *db, const char *prefix,
2420 notmuch_config_list_t **out);
2423 * Is 'config_list' iterator valid (i.e. _key, _value, _move_to_next can be called).
2425 * @since libnotmuch 4.4 (notmuch 0.23)
2428 notmuch_config_list_valid (notmuch_config_list_t *config_list);
2431 * return key for current config pair
2433 * return value is owned by the iterator, and will be destroyed by the
2434 * next call to notmuch_config_list_key or notmuch_config_list_destroy.
2436 * @since libnotmuch 4.4 (notmuch 0.23)
2439 notmuch_config_list_key (notmuch_config_list_t *config_list);
2442 * return 'value' for current config pair
2444 * return value is owned by the iterator, and will be destroyed by the
2445 * next call to notmuch_config_list_value or notmuch config_list_destroy
2447 * @since libnotmuch 4.4 (notmuch 0.23)
2448 * @retval NULL for errors
2451 notmuch_config_list_value (notmuch_config_list_t *config_list);
2455 * move 'config_list' iterator to the next pair
2457 * @since libnotmuch 4.4 (notmuch 0.23)
2460 notmuch_config_list_move_to_next (notmuch_config_list_t *config_list);
2463 * free any resources held by 'config_list'
2465 * @since libnotmuch 4.4 (notmuch 0.23)
2468 notmuch_config_list_destroy (notmuch_config_list_t *config_list);
2472 * Configuration keys known to libnotmuch
2474 typedef enum _notmuch_config_key {
2475 NOTMUCH_CONFIG_FIRST,
2476 NOTMUCH_CONFIG_DATABASE_PATH = NOTMUCH_CONFIG_FIRST,
2477 NOTMUCH_CONFIG_MAIL_ROOT,
2478 NOTMUCH_CONFIG_HOOK_DIR,
2479 NOTMUCH_CONFIG_EXCLUDE_TAGS,
2480 NOTMUCH_CONFIG_NEW_TAGS,
2481 NOTMUCH_CONFIG_NEW_IGNORE,
2482 NOTMUCH_CONFIG_SYNC_MAILDIR_FLAGS,
2483 NOTMUCH_CONFIG_PRIMARY_EMAIL,
2484 NOTMUCH_CONFIG_OTHER_EMAIL,
2485 NOTMUCH_CONFIG_USER_NAME,
2487 } notmuch_config_key_t;
2490 * get a configuration value from an open database.
2492 * This value reflects all configuration information given at the time
2493 * the database was opened.
2495 * @param[in] notmuch database
2496 * @param[in] key configuration key
2498 * @since libnotmuch 5.4 (notmuch 0.32)
2500 * @retval NULL if 'key' unknown or if no value is known for
2501 * 'key'. Otherwise returns a string owned by notmuch which should
2502 * not be modified nor freed by the caller.
2505 notmuch_config_get (notmuch_database_t *notmuch, notmuch_config_key_t key);
2508 * set a configuration value from in an open database.
2510 * This value reflects all configuration information given at the time
2511 * the database was opened.
2513 * @param[in,out] notmuch database open read/write
2514 * @param[in] key configuration key
2515 * @param[in] val configuration value
2517 * @since libnotmuch 5.4 (notmuch 0.32)
2519 * @retval returns any return value for notmuch_database_set_config.
2522 notmuch_config_set (notmuch_database_t *notmuch, notmuch_config_key_t key, const char *val);
2525 * Returns an iterator for a ';'-delimited list of configuration values
2527 * These values reflect all configuration information given at the
2528 * time the database was opened.
2530 * @param[in] notmuch database
2531 * @param[in] key configuration key
2533 * @since libnotmuch 5.4 (notmuch 0.32)
2535 * @retval NULL in case of error.
2537 notmuch_config_values_t *
2538 notmuch_config_get_values (notmuch_database_t *notmuch, notmuch_config_key_t key);
2541 * Is the given 'config_values' iterator pointing at a valid element.
2543 * @param[in] values iterator
2545 * @since libnotmuch 5.4 (notmuch 0.32)
2547 * @retval FALSE if passed a NULL pointer, or the iterator is exhausted.
2551 notmuch_config_values_valid (notmuch_config_values_t *values);
2554 * Get the current value from the 'values' iterator
2556 * @param[in] values iterator
2558 * @since libnotmuch 5.4 (notmuch 0.32)
2560 * @retval a string with the same lifetime as the iterator
2563 notmuch_config_values_get (notmuch_config_values_t *values);
2566 * Move the 'values' iterator to the next element
2568 * @param[in,out] values iterator
2570 * @since libnotmuch 5.4 (notmuch 0.32)
2574 notmuch_config_values_move_to_next (notmuch_config_values_t *values);
2578 * reset the 'values' iterator to the first element
2580 * @param[in,out] values iterator. A NULL value is ignored.
2582 * @since libnotmuch 5.4 (notmuch 0.32)
2586 notmuch_config_values_start (notmuch_config_values_t *values);
2589 * Destroy a config values iterator, along with any associated
2592 * @param[in,out] values iterator
2594 * @since libnotmuch 5.4 (notmuch 0.32)
2597 notmuch_config_values_destroy (notmuch_config_values_t *values);
2600 * get a configuration value from an open database as Boolean
2602 * This value reflects all configuration information given at the time
2603 * the database was opened.
2605 * @param[in] notmuch database
2606 * @param[in] key configuration key
2607 * @param[out] val configuration value, converted to Boolean
2609 * @since libnotmuch 5.4 (notmuch 0.32)
2611 * @retval #NOTMUCH_STATUS_ILLEGAL_ARGUMENT if either key is unknown
2612 * or the corresponding value does not convert to Boolean.
2615 notmuch_config_get_bool (notmuch_database_t *notmuch,
2616 notmuch_config_key_t key,
2617 notmuch_bool_t *val);
2619 * get the current default indexing options for a given database.
2621 * This object will survive until the database itself is destroyed,
2622 * but the caller may also release it earlier with
2623 * notmuch_indexopts_destroy.
2625 * This object represents a set of options on how a message can be
2626 * added to the index. At the moment it is a featureless stub.
2628 * @since libnotmuch 5.1 (notmuch 0.26)
2629 * @retval NULL in case of error
2631 notmuch_indexopts_t *
2632 notmuch_database_get_default_indexopts (notmuch_database_t *db);
2635 * Stating a policy about how to decrypt messages.
2637 * See index.decrypt in notmuch-config(1) for more details.
2640 NOTMUCH_DECRYPT_FALSE,
2641 NOTMUCH_DECRYPT_TRUE,
2642 NOTMUCH_DECRYPT_AUTO,
2643 NOTMUCH_DECRYPT_NOSTASH,
2644 } notmuch_decryption_policy_t;
2647 * Specify whether to decrypt encrypted parts while indexing.
2649 * Be aware that the index is likely sufficient to reconstruct the
2650 * cleartext of the message itself, so please ensure that the notmuch
2651 * message index is adequately protected. DO NOT SET THIS FLAG TO TRUE
2652 * without considering the security of your index.
2654 * @since libnotmuch 5.1 (notmuch 0.26)
2657 notmuch_indexopts_set_decrypt_policy (notmuch_indexopts_t *indexopts,
2658 notmuch_decryption_policy_t decrypt_policy);
2661 * Return whether to decrypt encrypted parts while indexing.
2662 * see notmuch_indexopts_set_decrypt_policy.
2664 * @since libnotmuch 5.1 (notmuch 0.26)
2666 notmuch_decryption_policy_t
2667 notmuch_indexopts_get_decrypt_policy (const notmuch_indexopts_t *indexopts);
2670 * Destroy a notmuch_indexopts_t object.
2672 * @since libnotmuch 5.1 (notmuch 0.26)
2675 notmuch_indexopts_destroy (notmuch_indexopts_t *options);
2679 * interrogate the library for compile time features
2681 * @since libnotmuch 4.4 (notmuch 0.23)
2684 notmuch_built_with (const char *name);
2687 #pragma GCC visibility pop