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 6
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.
119 NOTMUCH_STATUS_SUCCESS = 0,
123 NOTMUCH_STATUS_OUT_OF_MEMORY,
125 * An attempt was made to write to a database opened in read-only
128 NOTMUCH_STATUS_READ_ONLY_DATABASE,
130 * A Xapian exception occurred.
132 * @todo We don't really want to expose this lame XAPIAN_EXCEPTION
133 * value. Instead we should map to things like DATABASE_LOCKED or
136 NOTMUCH_STATUS_XAPIAN_EXCEPTION,
138 * An error occurred trying to read or write to a file (this could
139 * be file not found, permission denied, etc.)
141 NOTMUCH_STATUS_FILE_ERROR,
143 * A file was presented that doesn't appear to be an email
146 NOTMUCH_STATUS_FILE_NOT_EMAIL,
148 * A file contains a message ID that is identical to a message
149 * already in the database.
151 NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID,
153 * The user erroneously passed a NULL pointer to a notmuch
156 NOTMUCH_STATUS_NULL_POINTER,
158 * A tag value is too long (exceeds NOTMUCH_TAG_MAX).
160 NOTMUCH_STATUS_TAG_TOO_LONG,
162 * The notmuch_message_thaw function has been called more times
163 * than notmuch_message_freeze.
165 NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW,
167 * notmuch_database_end_atomic has been called more times than
168 * notmuch_database_begin_atomic.
170 NOTMUCH_STATUS_UNBALANCED_ATOMIC,
172 * The operation is not supported.
174 NOTMUCH_STATUS_UNSUPPORTED_OPERATION,
176 * The operation requires a database upgrade.
178 NOTMUCH_STATUS_UPGRADE_REQUIRED,
180 * There is a problem with the proposed path, e.g. a relative path
181 * passed to a function expecting an absolute path.
183 NOTMUCH_STATUS_PATH_ERROR,
185 * The requested operation was ignored. Depending on the function,
186 * this may not be an actual error.
188 NOTMUCH_STATUS_IGNORED,
190 * One of the arguments violates the preconditions for the
191 * function, in a way not covered by a more specific argument.
193 NOTMUCH_STATUS_ILLEGAL_ARGUMENT,
195 * A MIME object claimed to have cryptographic protection which
196 * notmuch tried to handle, but the protocol was not specified in
197 * an intelligible way.
199 NOTMUCH_STATUS_MALFORMED_CRYPTO_PROTOCOL,
201 * Notmuch attempted to do crypto processing, but could not
202 * initialize the engine needed to do so.
204 NOTMUCH_STATUS_FAILED_CRYPTO_CONTEXT_CREATION,
206 * A MIME object claimed to have cryptographic protection, and
207 * notmuch attempted to process it, but the specific protocol was
208 * something that notmuch doesn't know how to handle.
210 NOTMUCH_STATUS_UNKNOWN_CRYPTO_PROTOCOL,
212 * Unable to load a config file
214 NOTMUCH_STATUS_NO_CONFIG,
216 * Unable to load a database
218 NOTMUCH_STATUS_NO_DATABASE,
220 * Database exists, so not (re)-created
222 NOTMUCH_STATUS_DATABASE_EXISTS,
224 * Syntax error in query
226 NOTMUCH_STATUS_BAD_QUERY_SYNTAX,
228 * No mail root could be deduced from parameters and environment
230 NOTMUCH_STATUS_NO_MAIL_ROOT,
232 * Database is not fully opened, or has been closed
234 NOTMUCH_STATUS_CLOSED_DATABASE,
236 * Not an actual status value. Just a way to find out how many
237 * valid status values there are.
239 NOTMUCH_STATUS_LAST_STATUS
243 * Get a string representation of a notmuch_status_t value.
245 * The result is read-only.
248 notmuch_status_to_string (notmuch_status_t status);
250 /* Various opaque data types. For each notmuch_<foo>_t see the various
251 * notmuch_<foo> functions below. */
253 typedef struct _notmuch_database notmuch_database_t;
254 typedef struct _notmuch_query notmuch_query_t;
255 typedef struct _notmuch_threads notmuch_threads_t;
256 typedef struct _notmuch_thread notmuch_thread_t;
257 typedef struct _notmuch_messages notmuch_messages_t;
258 typedef struct _notmuch_message notmuch_message_t;
259 typedef struct _notmuch_tags notmuch_tags_t;
260 typedef struct _notmuch_directory notmuch_directory_t;
261 typedef struct _notmuch_filenames notmuch_filenames_t;
262 typedef struct _notmuch_config_list notmuch_config_list_t;
263 typedef struct _notmuch_config_values notmuch_config_values_t;
264 typedef struct _notmuch_config_pairs notmuch_config_pairs_t;
265 typedef struct _notmuch_indexopts notmuch_indexopts_t;
266 #endif /* __DOXYGEN__ */
269 * Create a new, empty notmuch database located at 'path'.
271 * The path should be a top-level directory to a collection of
272 * plain-text email messages (one message per file). This call will
273 * create a new ".notmuch" directory within 'path' where notmuch will
276 * After a successful call to notmuch_database_create, the returned
277 * database will be open so the caller should call
278 * notmuch_database_destroy when finished with it.
280 * The database will not yet have any data in it
281 * (notmuch_database_create itself is a very cheap function). Messages
282 * contained within 'path' can be added to the database by calling
283 * notmuch_database_index_file.
285 * In case of any failure, this function returns an error status and
286 * sets *database to NULL (after printing an error message on stderr).
290 * NOTMUCH_STATUS_SUCCESS: Successfully created the database.
292 * NOTMUCH_STATUS_NULL_POINTER: The given 'path' argument is NULL.
294 * NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory.
296 * NOTMUCH_STATUS_PATH_ERROR: filename is too long
298 * NOTMUCH_STATUS_FILE_ERROR: An error occurred trying to create the
299 * database file (such as permission denied, or file not found,
300 * etc.), or the database already exists.
302 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred.
305 notmuch_database_create (const char *path, notmuch_database_t **database);
308 * Like notmuch_database_create, except optionally return an error
309 * message. This message is allocated by malloc and should be freed by
313 notmuch_database_create_verbose (const char *path,
314 notmuch_database_t **database,
315 char **error_message);
318 * Database open mode for notmuch_database_open.
322 * Open database for reading only.
324 NOTMUCH_DATABASE_MODE_READ_ONLY = 0,
326 * Open database for reading and writing.
328 NOTMUCH_DATABASE_MODE_READ_WRITE
329 } notmuch_database_mode_t;
332 * Deprecated alias for notmuch_database_open_with_config with
333 * config_path="" and error_message=NULL
334 * @deprecated Deprecated as of libnotmuch 5.4 (notmuch 0.32)
336 NOTMUCH_DEPRECATED(5, 4)
338 notmuch_database_open (const char *path,
339 notmuch_database_mode_t mode,
340 notmuch_database_t **database);
342 * Deprecated alias for notmuch_database_open_with_config with
345 * @deprecated Deprecated as of libnotmuch 5.4 (notmuch 0.32)
348 NOTMUCH_DEPRECATED(5, 4)
350 notmuch_database_open_verbose (const char *path,
351 notmuch_database_mode_t mode,
352 notmuch_database_t **database,
353 char **error_message);
356 * Open an existing notmuch database located at 'database_path', using
357 * configuration in 'config_path'.
359 * @param[in] database_path
361 * Path to existing database.
363 * A notmuch database is a Xapian database containing appropriate
366 * The database should have been created at some time in the past,
367 * (not necessarily by this process), by calling
368 * notmuch_database_create.
370 * If 'database_path' is NULL, use the location specified
372 * - in the environment variable NOTMUCH_DATABASE, if non-empty
374 * - in a configuration file, located as described under 'config_path'
376 * - by $XDG_DATA_HOME/notmuch/$PROFILE where XDG_DATA_HOME defaults
377 * to "$HOME/.local/share" and PROFILE as as discussed in
380 * If 'database_path' is non-NULL, but does not appear to be a Xapian
381 * database, check for a directory '.notmuch/xapian' below
382 * 'database_path' (this is the behavior of
383 * notmuch_database_open_verbose pre-0.32).
388 * Mode to open database. Use one of #NOTMUCH_DATABASE_MODE_READ_WRITE
389 * or #NOTMUCH_DATABASE_MODE_READ_ONLY
392 * @param[in] config_path
394 * Path to config file.
396 * Config file is key-value, with mandatory sections. See
397 * <em>notmuch-config(5)</em> for more information. The key-value pair
398 * overrides the corresponding configuration data stored in the
399 * database (see <em>notmuch_database_get_config</em>)
401 * If <em>config_path</em> is NULL use the path specified
403 * - in environment variable <em>NOTMUCH_CONFIG</em>, if non-empty
405 * - by <em>XDG_CONFIG_HOME</em>/notmuch/ where
406 * XDG_CONFIG_HOME defaults to "$HOME/.config".
408 * - by $HOME/.notmuch-config
410 * If <em>config_path</em> is "" (empty string) then do not
411 * open any configuration file.
413 * @param[in] profile:
415 * Name of profile (configuration/database variant).
417 * If non-NULL, append to the directory / file path determined for
418 * <em>config_path</em> and <em>database_path</em>.
421 * - environment variable NOTMUCH_PROFILE if defined,
422 * - otherwise "default" for directories and "" (empty string) for paths.
425 * @param[out] database
427 * Pointer to database object. May not be NULL.
429 * The caller should call notmuch_database_destroy when finished with
432 * In case of any failure, this function returns an error status and
433 * sets *database to NULL.
436 * @param[out] error_message
437 * If non-NULL, store error message from opening the database.
438 * Any such message is allocated by \a malloc(3) and should be freed
441 * @retval NOTMUCH_STATUS_SUCCESS: Successfully opened the database.
443 * @retval NOTMUCH_STATUS_NULL_POINTER: The given \a database
446 * @retval NOTMUCH_STATUS_NO_CONFIG: No config file was found. Fatal.
448 * @retval NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory.
450 * @retval NOTMUCH_STATUS_FILE_ERROR: An error occurred trying to open the
451 * database or config file (such as permission denied, or file not found,
452 * etc.), or the database version is unknown.
454 * @retval NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred.
456 * @since libnotmuch 5.4 (notmuch 0.32)
460 notmuch_database_open_with_config (const char *database_path,
461 notmuch_database_mode_t mode,
462 const char *config_path,
464 notmuch_database_t **database,
465 char **error_message);
469 * Loads configuration from config file, database, and/or defaults
471 * For description of arguments, @see notmuch_database_open_with_config
473 * For errors other then NO_DATABASE and NO_CONFIG, *database is set to
476 * @retval NOTMUCH_STATUS_SUCCESS: Successfully loaded configuration.
478 * @retval NOTMUCH_STATUS_NO_CONFIG: No config file was loaded. Not fatal.
480 * @retval NOTMUCH_STATUS_NO_DATABASE: No config information was
481 * loaded from a database. Not fatal.
483 * @retval NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory.
485 * @retval NOTMUCH_STATUS_FILE_ERROR: An error occurred trying to open the
486 * database or config file (such as permission denied, or file not found,
489 * @retval NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred.
491 * @since libnotmuch 5.4 (notmuch 0.32)
495 notmuch_database_load_config (const char *database_path,
496 const char *config_path,
498 notmuch_database_t **database,
499 char **error_message);
502 * Create a new notmuch database located at 'database_path', using
503 * configuration in 'config_path'.
505 * For description of arguments, @see notmuch_database_open_with_config
507 * In case of any failure, this function returns an error status and
508 * sets *database to NULL.
510 * @retval NOTMUCH_STATUS_SUCCESS: Successfully created the database.
512 * @retval NOTMUCH_STATUS_DATABASE_EXISTS: Database already exists, not created
514 * @retval NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory.
516 * @retval NOTMUCH_STATUS_FILE_ERROR: An error occurred trying to open the
517 * database or config file (such as permission denied, or file not found,
520 * @retval NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred.
522 * @since libnotmuch 5.4 (notmuch 0.32)
526 notmuch_database_create_with_config (const char *database_path,
527 const char *config_path,
529 notmuch_database_t **database,
530 char **error_message);
533 * Retrieve last status string for given database.
537 notmuch_database_status_string (const notmuch_database_t *notmuch);
540 * Commit changes and close the given notmuch database.
542 * After notmuch_database_close has been called, calls to other
543 * functions on objects derived from this database may either behave
544 * as if the database had not been closed (e.g., if the required data
545 * has been cached) or may fail with a
546 * NOTMUCH_STATUS_XAPIAN_EXCEPTION. The only further operation
547 * permitted on the database itself is to call
548 * notmuch_database_destroy.
550 * notmuch_database_close can be called multiple times. Later calls
553 * For writable databases, notmuch_database_close commits all changes
554 * to disk before closing the database, unless the caller is currently
555 * in an atomic section (there was a notmuch_database_begin_atomic
556 * without a matching notmuch_database_end_atomic). In this case
557 * changes since the last commit are discarded. @see
558 * notmuch_database_end_atomic for more information.
562 * NOTMUCH_STATUS_SUCCESS: Successfully closed the database.
564 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred; the
565 * database has been closed but there are no guarantees the
566 * changes to the database, if any, have been flushed to disk.
569 notmuch_database_close (notmuch_database_t *database);
572 * A callback invoked by notmuch_database_compact to notify the user
573 * of the progress of the compaction process.
575 typedef void (*notmuch_compact_status_cb_t)(const char *message, void *closure);
578 * Compact a notmuch database, backing up the original database to the
581 * The database will be opened with NOTMUCH_DATABASE_MODE_READ_WRITE
582 * during the compaction process to ensure no writes are made.
584 * If the optional callback function 'status_cb' is non-NULL, it will
585 * be called with diagnostic and informational messages. The argument
586 * 'closure' is passed verbatim to any callback invoked.
589 notmuch_database_compact (const char *path,
590 const char *backup_path,
591 notmuch_compact_status_cb_t status_cb,
595 * Like notmuch_database_compact, but take an open database as a
598 * @since libnnotmuch 5.4 (notmuch 0.32)
601 notmuch_database_compact_db (notmuch_database_t *database,
602 const char *backup_path,
603 notmuch_compact_status_cb_t status_cb,
607 * Destroy the notmuch database, closing it if necessary and freeing
608 * all associated resources.
610 * Return value as in notmuch_database_close if the database was open;
611 * notmuch_database_destroy itself has no failure modes.
614 notmuch_database_destroy (notmuch_database_t *database);
617 * Return the database path of the given database.
619 * The return value is a string owned by notmuch so should not be
620 * modified nor freed by the caller.
623 notmuch_database_get_path (notmuch_database_t *database);
626 * Return the database format version of the given database.
631 notmuch_database_get_version (notmuch_database_t *database);
634 * Can the database be upgraded to a newer database version?
636 * If this function returns TRUE, then the caller may call
637 * notmuch_database_upgrade to upgrade the database. If the caller
638 * does not upgrade an out-of-date database, then some functions may
639 * fail with NOTMUCH_STATUS_UPGRADE_REQUIRED. This always returns
640 * FALSE for a read-only database because there's no way to upgrade a
641 * read-only database.
643 * Also returns FALSE if an error occurs accessing the database.
647 notmuch_database_needs_upgrade (notmuch_database_t *database);
650 * Upgrade the current database to the latest supported version.
652 * This ensures that all current notmuch functionality will be
653 * available on the database. After opening a database in read-write
654 * mode, it is recommended that clients check if an upgrade is needed
655 * (notmuch_database_needs_upgrade) and if so, upgrade with this
656 * function before making any modifications. If
657 * notmuch_database_needs_upgrade returns FALSE, this will be a no-op.
659 * The optional progress_notify callback can be used by the caller to
660 * provide progress indication to the user. If non-NULL it will be
661 * called periodically with 'progress' as a floating-point value in
662 * the range of [0.0 .. 1.0] indicating the progress made so far in
663 * the upgrade process. The argument 'closure' is passed verbatim to
664 * any callback invoked.
667 notmuch_database_upgrade (notmuch_database_t *database,
668 void (*progress_notify)(void *closure,
673 * Begin an atomic database operation.
675 * Any modifications performed between a successful begin and a
676 * notmuch_database_end_atomic will be applied to the database
677 * atomically. Note that, unlike a typical database transaction, this
678 * only ensures atomicity, not durability; neither begin nor end
679 * necessarily flush modifications to disk.
681 * Atomic sections may be nested. begin_atomic and end_atomic must
682 * always be called in pairs.
686 * NOTMUCH_STATUS_SUCCESS: Successfully entered atomic section.
688 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred;
689 * atomic section not entered.
692 notmuch_database_begin_atomic (notmuch_database_t *notmuch);
695 * Indicate the end of an atomic database operation. If repeated
696 * (with matching notmuch_database_begin_atomic) "database.autocommit"
697 * times, commit the the transaction and all previous (non-cancelled)
698 * transactions to the database.
702 * NOTMUCH_STATUS_SUCCESS: Successfully completed atomic section.
704 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred;
705 * atomic section not ended.
707 * NOTMUCH_STATUS_UNBALANCED_ATOMIC: The database is not currently in
711 notmuch_database_end_atomic (notmuch_database_t *notmuch);
714 * Return the committed database revision and UUID.
716 * The database revision number increases monotonically with each
717 * commit to the database. Hence, all messages and message changes
718 * committed to the database (that is, visible to readers) have a last
719 * modification revision <= the committed database revision. Any
720 * messages committed in the future will be assigned a modification
721 * revision > the committed database revision.
723 * The UUID is a NUL-terminated opaque string that uniquely identifies
724 * this database. Two revision numbers are only comparable if they
725 * have the same database UUID. The string 'uuid' is owned by notmuch
726 * and should not be freed or modified by the user.
729 notmuch_database_get_revision (notmuch_database_t *notmuch,
733 * Retrieve a directory object from the database for 'path'.
735 * Here, 'path' should be a path relative to the path of 'database'
736 * (see notmuch_database_get_path), or else should be an absolute path
737 * with initial components that match the path of 'database'.
739 * If this directory object does not exist in the database, this
740 * returns NOTMUCH_STATUS_SUCCESS and sets *directory to NULL.
742 * Otherwise the returned directory object is owned by the database
743 * and as such, will only be valid until notmuch_database_destroy is
748 * NOTMUCH_STATUS_SUCCESS: Successfully retrieved directory.
750 * NOTMUCH_STATUS_NULL_POINTER: The given 'directory' argument is NULL.
752 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred;
753 * directory not retrieved.
755 * NOTMUCH_STATUS_UPGRADE_REQUIRED: The caller must upgrade the
756 * database to use this function.
759 notmuch_database_get_directory (notmuch_database_t *database,
761 notmuch_directory_t **directory);
764 * Add a message file to a database, indexing it for retrieval by
765 * future searches. If a message already exists with the same message
766 * ID as the specified file, their indexes will be merged, and this
767 * new filename will also be associated with the existing message.
769 * Here, 'filename' should be a path relative to the path of
770 * 'database' (see notmuch_database_get_path), or else should be an
771 * absolute filename with initial components that match the path of
774 * The file should be a single mail message (not a multi-message mbox)
775 * that is expected to remain at its current location, (since the
776 * notmuch database will reference the filename, and will not copy the
777 * entire contents of the file.
779 * If another message with the same message ID already exists in the
780 * database, rather than creating a new message, this adds the search
781 * terms from the identified file to the existing message's index, and
782 * adds 'filename' to the list of filenames known for the message.
784 * The 'indexopts' parameter can be NULL (meaning, use the indexing
785 * defaults from the database), or can be an explicit choice of
786 * indexing options that should govern the indexing of this specific
789 * If 'message' is not NULL, then, on successful return
790 * (NOTMUCH_STATUS_SUCCESS or NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID) '*message'
791 * will be initialized to a message object that can be used for things
792 * such as adding tags to the just-added message. The user should call
793 * notmuch_message_destroy when done with the message. On any failure
794 * '*message' will be set to NULL.
798 * NOTMUCH_STATUS_SUCCESS: Message successfully added to database.
800 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred,
803 * NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID: Message has the same message
804 * ID as another message already in the database. The new
805 * filename was successfully added to the message in the database
806 * (if not already present) and the existing message is returned.
808 * NOTMUCH_STATUS_FILE_ERROR: an error occurred trying to open the
809 * file, (such as permission denied, or file not found,
810 * etc.). Nothing added to the database.
812 * NOTMUCH_STATUS_FILE_NOT_EMAIL: the contents of filename don't look
813 * like an email message. Nothing added to the database.
815 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
816 * mode so no message can be added.
818 * NOTMUCH_STATUS_UPGRADE_REQUIRED: The caller must upgrade the
819 * database to use this function.
821 * @since libnotmuch 5.1 (notmuch 0.26)
824 notmuch_database_index_file (notmuch_database_t *database,
825 const char *filename,
826 notmuch_indexopts_t *indexopts,
827 notmuch_message_t **message);
830 * Deprecated alias for notmuch_database_index_file called with
833 * @deprecated Deprecated as of libnotmuch 5.1 (notmuch 0.26). Please
834 * use notmuch_database_index_file instead.
837 NOTMUCH_DEPRECATED (5, 1)
839 notmuch_database_add_message (notmuch_database_t *database,
840 const char *filename,
841 notmuch_message_t **message);
844 * Remove a message filename from the given notmuch database. If the
845 * message has no more filenames, remove the message.
847 * If the same message (as determined by the message ID) is still
848 * available via other filenames, then the message will persist in the
849 * database for those filenames. When the last filename is removed for
850 * a particular message, the database content for that message will be
855 * NOTMUCH_STATUS_SUCCESS: The last filename was removed and the
856 * message was removed from the database.
858 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred,
859 * message not removed.
861 * NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID: This filename was removed but
862 * the message persists in the database with at least one other
865 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
866 * mode so no message can be removed.
868 * NOTMUCH_STATUS_UPGRADE_REQUIRED: The caller must upgrade the
869 * database to use this function.
872 notmuch_database_remove_message (notmuch_database_t *database,
873 const char *filename);
876 * Find a message with the given message_id.
878 * If a message with the given message_id is found then, on successful return
879 * (NOTMUCH_STATUS_SUCCESS) '*message' will be initialized to a message
880 * object. The caller should call notmuch_message_destroy when done with the
883 * On any failure or when the message is not found, this function initializes
884 * '*message' to NULL. This means, when NOTMUCH_STATUS_SUCCESS is returned, the
885 * caller is supposed to check '*message' for NULL to find out whether the
886 * message with the given message_id was found.
890 * NOTMUCH_STATUS_SUCCESS: Successful return, check '*message'.
892 * NOTMUCH_STATUS_NULL_POINTER: The given 'message' argument is NULL
894 * NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory, creating message object
896 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred
899 notmuch_database_find_message (notmuch_database_t *database,
900 const char *message_id,
901 notmuch_message_t **message);
904 * Find a message with the given filename.
906 * If the database contains a message with the given filename then, on
907 * successful return (NOTMUCH_STATUS_SUCCESS) '*message' will be initialized to
908 * a message object. The caller should call notmuch_message_destroy when done
911 * On any failure or when the message is not found, this function initializes
912 * '*message' to NULL. This means, when NOTMUCH_STATUS_SUCCESS is returned, the
913 * caller is supposed to check '*message' for NULL to find out whether the
914 * message with the given filename is found.
918 * NOTMUCH_STATUS_SUCCESS: Successful return, check '*message'
920 * NOTMUCH_STATUS_NULL_POINTER: The given 'message' argument is NULL
922 * NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory, creating the message object
924 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred
926 * NOTMUCH_STATUS_UPGRADE_REQUIRED: The caller must upgrade the
927 * database to use this function.
930 notmuch_database_find_message_by_filename (notmuch_database_t *notmuch,
931 const char *filename,
932 notmuch_message_t **message);
935 * Return a list of all tags found in the database.
937 * This function creates a list of all tags found in the database. The
938 * resulting list contains all tags from all messages found in the database.
940 * On error this function returns NULL.
943 notmuch_database_get_all_tags (notmuch_database_t *db);
946 * Reopen an open notmuch database.
948 * @param [in] db open notmuch database
949 * @param [in] mode mode (read only or read-write) for reopened database.
951 * @retval #NOTMUCH_STATUS_SUCCESS
952 * @retval #NOTMUCH_STATUS_ILLEGAL_ARGUMENT The passed database was not open.
953 * @retval #NOTMUCH_STATUS_XAPIAN_EXCEPTION A Xapian exception occured
956 notmuch_database_reopen (notmuch_database_t *db, notmuch_database_mode_t mode);
959 * Create a new query for 'database'.
961 * Here, 'database' should be an open database, (see
962 * notmuch_database_open and notmuch_database_create).
964 * For the query string, we'll document the syntax here more
965 * completely in the future, but it's likely to be a specialized
966 * version of the general Xapian query syntax:
968 * https://xapian.org/docs/queryparser.html
970 * As a special case, passing either a length-zero string, (that is ""),
971 * or a string consisting of a single asterisk (that is "*"), will
972 * result in a query that returns all messages in the database.
974 * See notmuch_query_set_sort for controlling the order of results.
975 * See notmuch_query_search_messages and notmuch_query_search_threads
976 * to actually execute the query.
978 * User should call notmuch_query_destroy when finished with this
981 * Will return NULL if insufficient memory is available.
984 notmuch_query_create (notmuch_database_t *database,
985 const char *query_string);
988 NOTMUCH_QUERY_SYNTAX_XAPIAN,
989 NOTMUCH_QUERY_SYNTAX_SEXP
990 } notmuch_query_syntax_t;
993 notmuch_query_create_with_syntax (notmuch_database_t *database,
994 const char *query_string,
995 notmuch_query_syntax_t syntax,
996 notmuch_query_t **output);
998 * Sort values for notmuch_query_set_sort.
1004 NOTMUCH_SORT_OLDEST_FIRST,
1008 NOTMUCH_SORT_NEWEST_FIRST,
1010 * Sort by message-id.
1012 NOTMUCH_SORT_MESSAGE_ID,
1016 NOTMUCH_SORT_UNSORTED
1020 * Return the query_string of this query. See notmuch_query_create.
1023 notmuch_query_get_query_string (const notmuch_query_t *query);
1026 * Return the notmuch database of this query. See notmuch_query_create.
1028 notmuch_database_t *
1029 notmuch_query_get_database (const notmuch_query_t *query);
1032 * Exclude values for notmuch_query_set_omit_excluded. The strange
1033 * order is to maintain backward compatibility: the old FALSE/TRUE
1034 * options correspond to the new
1035 * NOTMUCH_EXCLUDE_FLAG/NOTMUCH_EXCLUDE_TRUE options.
1038 NOTMUCH_EXCLUDE_FLAG,
1039 NOTMUCH_EXCLUDE_TRUE,
1040 NOTMUCH_EXCLUDE_FALSE,
1042 } notmuch_exclude_t;
1045 * Specify whether to omit excluded results or simply flag them. By
1046 * default, this is set to TRUE.
1048 * If set to TRUE or ALL, notmuch_query_search_messages will omit excluded
1049 * messages from the results, and notmuch_query_search_threads will omit
1050 * threads that match only in excluded messages. If set to TRUE,
1051 * notmuch_query_search_threads will include all messages in threads that
1052 * match in at least one non-excluded message. Otherwise, if set to ALL,
1053 * notmuch_query_search_threads will omit excluded messages from all threads.
1055 * If set to FALSE or FLAG then both notmuch_query_search_messages and
1056 * notmuch_query_search_threads will return all matching
1057 * messages/threads regardless of exclude status. If set to FLAG then
1058 * the exclude flag will be set for any excluded message that is
1059 * returned by notmuch_query_search_messages, and the thread counts
1060 * for threads returned by notmuch_query_search_threads will be the
1061 * number of non-excluded messages/matches. Otherwise, if set to
1062 * FALSE, then the exclude status is completely ignored.
1064 * The performance difference when calling
1065 * notmuch_query_search_messages should be relatively small (and both
1066 * should be very fast). However, in some cases,
1067 * notmuch_query_search_threads is very much faster when omitting
1068 * excluded messages as it does not need to construct the threads that
1069 * only match in excluded messages.
1072 notmuch_query_set_omit_excluded (notmuch_query_t *query,
1073 notmuch_exclude_t omit_excluded);
1076 * Specify the sorting desired for this query.
1079 notmuch_query_set_sort (notmuch_query_t *query, notmuch_sort_t sort);
1082 * Return the sort specified for this query. See
1083 * notmuch_query_set_sort.
1086 notmuch_query_get_sort (const notmuch_query_t *query);
1089 * Add a tag that will be excluded from the query results by default.
1090 * This exclusion will be ignored if this tag appears explicitly in
1095 * NOTMUCH_STATUS_SUCCESS: excluded was added successfully.
1097 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: a Xapian exception occurred.
1098 * Most likely a problem lazily parsing the query string.
1100 * NOTMUCH_STATUS_IGNORED: tag is explicitly present in the query, so
1104 notmuch_query_add_tag_exclude (notmuch_query_t *query, const char *tag);
1107 * Execute a query for threads, returning a notmuch_threads_t object
1108 * which can be used to iterate over the results. The returned threads
1109 * object is owned by the query and as such, will only be valid until
1110 * notmuch_query_destroy.
1112 * Typical usage might be:
1114 * notmuch_query_t *query;
1115 * notmuch_threads_t *threads;
1116 * notmuch_thread_t *thread;
1117 * notmuch_status_t stat;
1119 * query = notmuch_query_create (database, query_string);
1121 * for (stat = notmuch_query_search_threads (query, &threads);
1122 * stat == NOTMUCH_STATUS_SUCCESS &&
1123 * notmuch_threads_valid (threads);
1124 * notmuch_threads_move_to_next (threads))
1126 * thread = notmuch_threads_get (threads);
1128 * notmuch_thread_destroy (thread);
1131 * notmuch_query_destroy (query);
1133 * Note: If you are finished with a thread before its containing
1134 * query, you can call notmuch_thread_destroy to clean up some memory
1135 * sooner (as in the above example). Otherwise, if your thread objects
1136 * are long-lived, then you don't need to call notmuch_thread_destroy
1137 * and all the memory will still be reclaimed when the query is
1140 * Note that there's no explicit destructor needed for the
1141 * notmuch_threads_t object. (For consistency, we do provide a
1142 * notmuch_threads_destroy function, but there's no good reason
1143 * to call it if the query is about to be destroyed).
1145 * @since libnotmuch 5.0 (notmuch 0.25)
1148 notmuch_query_search_threads (notmuch_query_t *query,
1149 notmuch_threads_t **out);
1152 * Deprecated alias for notmuch_query_search_threads.
1154 * @deprecated Deprecated as of libnotmuch 5 (notmuch 0.25). Please
1155 * use notmuch_query_search_threads instead.
1158 NOTMUCH_DEPRECATED (5, 0)
1160 notmuch_query_search_threads_st (notmuch_query_t *query, notmuch_threads_t **out);
1163 * Execute a query for messages, returning a notmuch_messages_t object
1164 * which can be used to iterate over the results. The returned
1165 * messages object is owned by the query and as such, will only be
1166 * valid until notmuch_query_destroy.
1168 * Typical usage might be:
1170 * notmuch_query_t *query;
1171 * notmuch_messages_t *messages;
1172 * notmuch_message_t *message;
1174 * query = notmuch_query_create (database, query_string);
1176 * if (notmuch_query_search_messages (query, &messages) != NOTMUCH_STATUS_SUCCESS)
1177 * return EXIT_FAILURE;
1180 * notmuch_messages_valid (messages);
1181 * notmuch_messages_move_to_next (messages))
1183 * message = notmuch_messages_get (messages);
1185 * notmuch_message_destroy (message);
1188 * notmuch_query_destroy (query);
1190 * Note: If you are finished with a message before its containing
1191 * query, you can call notmuch_message_destroy to clean up some memory
1192 * sooner (as in the above example). Otherwise, if your message
1193 * objects are long-lived, then you don't need to call
1194 * notmuch_message_destroy and all the memory will still be reclaimed
1195 * when the query is destroyed.
1197 * Note that there's no explicit destructor needed for the
1198 * notmuch_messages_t object. (For consistency, we do provide a
1199 * notmuch_messages_destroy function, but there's no good
1200 * reason to call it if the query is about to be destroyed).
1202 * If a Xapian exception occurs this function will return NULL.
1204 * @since libnotmuch 5 (notmuch 0.25)
1207 notmuch_query_search_messages (notmuch_query_t *query,
1208 notmuch_messages_t **out);
1210 * Deprecated alias for notmuch_query_search_messages
1212 * @deprecated Deprecated as of libnotmuch 5 (notmuch 0.25). Please use
1213 * notmuch_query_search_messages instead.
1217 NOTMUCH_DEPRECATED (5, 0)
1219 notmuch_query_search_messages_st (notmuch_query_t *query,
1220 notmuch_messages_t **out);
1223 * Destroy a notmuch_query_t along with any associated resources.
1225 * This will in turn destroy any notmuch_threads_t and
1226 * notmuch_messages_t objects generated by this query, (and in
1227 * turn any notmuch_thread_t and notmuch_message_t objects generated
1228 * from those results, etc.), if such objects haven't already been
1232 notmuch_query_destroy (notmuch_query_t *query);
1235 * Is the given 'threads' iterator pointing at a valid thread.
1237 * When this function returns TRUE, notmuch_threads_get will return a
1238 * valid object. Whereas when this function returns FALSE,
1239 * notmuch_threads_get will return NULL.
1241 * If passed a NULL pointer, this function returns FALSE
1243 * See the documentation of notmuch_query_search_threads for example
1244 * code showing how to iterate over a notmuch_threads_t object.
1247 notmuch_threads_valid (notmuch_threads_t *threads);
1250 * Get the current thread from 'threads' as a notmuch_thread_t.
1252 * Note: The returned thread belongs to 'threads' and has a lifetime
1253 * identical to it (and the query to which it belongs).
1255 * See the documentation of notmuch_query_search_threads for example
1256 * code showing how to iterate over a notmuch_threads_t object.
1258 * If an out-of-memory situation occurs, this function will return
1262 notmuch_threads_get (notmuch_threads_t *threads);
1265 * Move the 'threads' iterator to the next thread.
1267 * If 'threads' is already pointing at the last thread then the
1268 * iterator will be moved to a point just beyond that last thread,
1269 * (where notmuch_threads_valid will return FALSE and
1270 * notmuch_threads_get will return NULL).
1272 * See the documentation of notmuch_query_search_threads for example
1273 * code showing how to iterate over a notmuch_threads_t object.
1276 notmuch_threads_move_to_next (notmuch_threads_t *threads);
1279 * Destroy a notmuch_threads_t object.
1281 * It's not strictly necessary to call this function. All memory from
1282 * the notmuch_threads_t object will be reclaimed when the
1283 * containing query object is destroyed.
1286 notmuch_threads_destroy (notmuch_threads_t *threads);
1289 * Return the number of messages matching a search.
1291 * This function performs a search and returns the number of matching
1296 * NOTMUCH_STATUS_SUCCESS: query completed successfully.
1298 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: a Xapian exception occurred. The
1299 * value of *count is not defined.
1301 * @since libnotmuch 5 (notmuch 0.25)
1304 notmuch_query_count_messages (notmuch_query_t *query, unsigned int *count);
1307 * Deprecated alias for notmuch_query_count_messages
1310 * @deprecated Deprecated since libnotmuch 5.0 (notmuch 0.25). Please
1311 * use notmuch_query_count_messages instead.
1313 NOTMUCH_DEPRECATED (5, 0)
1315 notmuch_query_count_messages_st (notmuch_query_t *query, unsigned int *count);
1318 * Return the number of threads matching a search.
1320 * This function performs a search and returns the number of unique thread IDs
1321 * in the matching messages. This is the same as number of threads matching a
1324 * Note that this is a significantly heavier operation than
1325 * notmuch_query_count_messages{_st}().
1329 * NOTMUCH_STATUS_OUT_OF_MEMORY: Memory allocation failed. The value
1330 * of *count is not defined
1332 * NOTMUCH_STATUS_SUCCESS: query completed successfully.
1334 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: a Xapian exception occurred. The
1335 * value of *count is not defined.
1337 * @since libnotmuch 5 (notmuch 0.25)
1340 notmuch_query_count_threads (notmuch_query_t *query, unsigned *count);
1343 * Deprecated alias for notmuch_query_count_threads
1345 * @deprecated Deprecated as of libnotmuch 5.0 (notmuch 0.25). Please
1346 * use notmuch_query_count_threads_st instead.
1348 NOTMUCH_DEPRECATED (5, 0)
1350 notmuch_query_count_threads_st (notmuch_query_t *query, unsigned *count);
1353 * Get the thread ID of 'thread'.
1355 * The returned string belongs to 'thread' and as such, should not be
1356 * modified by the caller and will only be valid for as long as the
1357 * thread is valid, (which is until notmuch_thread_destroy or until
1358 * the query from which it derived is destroyed).
1361 notmuch_thread_get_thread_id (notmuch_thread_t *thread);
1364 * Get the total number of messages in 'thread'.
1366 * This count consists of all messages in the database belonging to
1367 * this thread. Contrast with notmuch_thread_get_matched_messages() .
1370 notmuch_thread_get_total_messages (notmuch_thread_t *thread);
1373 * Get the total number of files in 'thread'.
1375 * This sums notmuch_message_count_files over all messages in the
1377 * @returns Non-negative integer
1378 * @since libnotmuch 5.0 (notmuch 0.25)
1382 notmuch_thread_get_total_files (notmuch_thread_t *thread);
1385 * Get a notmuch_messages_t iterator for the top-level messages in
1386 * 'thread' in oldest-first order.
1388 * This iterator will not necessarily iterate over all of the messages
1389 * in the thread. It will only iterate over the messages in the thread
1390 * which are not replies to other messages in the thread.
1392 * The returned list will be destroyed when the thread is destroyed.
1394 notmuch_messages_t *
1395 notmuch_thread_get_toplevel_messages (notmuch_thread_t *thread);
1398 * Get a notmuch_thread_t iterator for all messages in 'thread' in
1399 * oldest-first order.
1401 * The returned list will be destroyed when the thread is destroyed.
1403 notmuch_messages_t *
1404 notmuch_thread_get_messages (notmuch_thread_t *thread);
1407 * Get the number of messages in 'thread' that matched the search.
1409 * This count includes only the messages in this thread that were
1410 * matched by the search from which the thread was created and were
1411 * not excluded by any exclude tags passed in with the query (see
1412 * notmuch_query_add_tag_exclude). Contrast with
1413 * notmuch_thread_get_total_messages() .
1416 notmuch_thread_get_matched_messages (notmuch_thread_t *thread);
1419 * Get the authors of 'thread' as a UTF-8 string.
1421 * The returned string is a comma-separated list of the names of the
1422 * authors of mail messages in the query results that belong to this
1425 * The string contains authors of messages matching the query first, then
1426 * non-matched authors (with the two groups separated by '|'). Within
1427 * each group, authors are ordered by date.
1429 * The returned string belongs to 'thread' and as such, should not be
1430 * modified by the caller and will only be valid for as long as the
1431 * thread is valid, (which is until notmuch_thread_destroy or until
1432 * the query from which it derived is destroyed).
1435 notmuch_thread_get_authors (notmuch_thread_t *thread);
1438 * Get the subject of 'thread' as a UTF-8 string.
1440 * The subject is taken from the first message (according to the query
1441 * order---see notmuch_query_set_sort) in the query results that
1442 * belongs to this thread.
1444 * The returned string belongs to 'thread' and as such, should not be
1445 * modified by the caller and will only be valid for as long as the
1446 * thread is valid, (which is until notmuch_thread_destroy or until
1447 * the query from which it derived is destroyed).
1450 notmuch_thread_get_subject (notmuch_thread_t *thread);
1453 * Get the date of the oldest message in 'thread' as a time_t value.
1456 notmuch_thread_get_oldest_date (notmuch_thread_t *thread);
1459 * Get the date of the newest message in 'thread' as a time_t value.
1462 notmuch_thread_get_newest_date (notmuch_thread_t *thread);
1465 * Get the tags for 'thread', returning a notmuch_tags_t object which
1466 * can be used to iterate over all tags.
1468 * Note: In the Notmuch database, tags are stored on individual
1469 * messages, not on threads. So the tags returned here will be all
1470 * tags of the messages which matched the search and which belong to
1473 * The tags object is owned by the thread and as such, will only be
1474 * valid for as long as the thread is valid, (for example, until
1475 * notmuch_thread_destroy or until the query from which it derived is
1478 * Typical usage might be:
1480 * notmuch_thread_t *thread;
1481 * notmuch_tags_t *tags;
1484 * thread = notmuch_threads_get (threads);
1486 * for (tags = notmuch_thread_get_tags (thread);
1487 * notmuch_tags_valid (tags);
1488 * notmuch_tags_move_to_next (tags))
1490 * tag = notmuch_tags_get (tags);
1494 * notmuch_thread_destroy (thread);
1496 * Note that there's no explicit destructor needed for the
1497 * notmuch_tags_t object. (For consistency, we do provide a
1498 * notmuch_tags_destroy function, but there's no good reason to call
1499 * it if the message is about to be destroyed).
1502 notmuch_thread_get_tags (notmuch_thread_t *thread);
1505 * Destroy a notmuch_thread_t object.
1508 notmuch_thread_destroy (notmuch_thread_t *thread);
1511 * Is the given 'messages' iterator pointing at a valid message.
1513 * When this function returns TRUE, notmuch_messages_get will return a
1514 * valid object. Whereas when this function returns FALSE,
1515 * notmuch_messages_get will return NULL.
1517 * See the documentation of notmuch_query_search_messages for example
1518 * code showing how to iterate over a notmuch_messages_t object.
1521 notmuch_messages_valid (notmuch_messages_t *messages);
1524 * Get the current message from 'messages' as a notmuch_message_t.
1526 * Note: The returned message belongs to 'messages' and has a lifetime
1527 * identical to it (and the query to which it belongs).
1529 * See the documentation of notmuch_query_search_messages for example
1530 * code showing how to iterate over a notmuch_messages_t object.
1532 * If an out-of-memory situation occurs, this function will return
1536 notmuch_messages_get (notmuch_messages_t *messages);
1539 * Move the 'messages' iterator to the next message.
1541 * If 'messages' is already pointing at the last message then the
1542 * iterator will be moved to a point just beyond that last message,
1543 * (where notmuch_messages_valid will return FALSE and
1544 * notmuch_messages_get will return NULL).
1546 * See the documentation of notmuch_query_search_messages for example
1547 * code showing how to iterate over a notmuch_messages_t object.
1550 notmuch_messages_move_to_next (notmuch_messages_t *messages);
1553 * Destroy a notmuch_messages_t object.
1555 * It's not strictly necessary to call this function. All memory from
1556 * the notmuch_messages_t object will be reclaimed when the containing
1557 * query object is destroyed.
1560 notmuch_messages_destroy (notmuch_messages_t *messages);
1563 * Return a list of tags from all messages.
1565 * The resulting list is guaranteed not to contain duplicated tags.
1567 * WARNING: You can no longer iterate over messages after calling this
1568 * function, because the iterator will point at the end of the list.
1569 * We do not have a function to reset the iterator yet and the only
1570 * way how you can iterate over the list again is to recreate the
1573 * The function returns NULL on error.
1576 notmuch_messages_collect_tags (notmuch_messages_t *messages);
1579 * Get the database associated with this message.
1581 * @since libnotmuch 5.2 (notmuch 0.27)
1583 notmuch_database_t *
1584 notmuch_message_get_database (const notmuch_message_t *message);
1587 * Get the message ID of 'message'.
1589 * The returned string belongs to 'message' and as such, should not be
1590 * modified by the caller and will only be valid for as long as the
1591 * message is valid, (which is until the query from which it derived
1594 * This function will return NULL if triggers an unhandled Xapian
1598 notmuch_message_get_message_id (notmuch_message_t *message);
1601 * Get the thread ID of 'message'.
1603 * The returned string belongs to 'message' and as such, should not be
1604 * modified by the caller and will only be valid for as long as the
1605 * message is valid, (for example, until the user calls
1606 * notmuch_message_destroy on 'message' or until a query from which it
1607 * derived is destroyed).
1609 * This function will return NULL if triggers an unhandled Xapian
1613 notmuch_message_get_thread_id (notmuch_message_t *message);
1616 * Get a notmuch_messages_t iterator for all of the replies to
1619 * Note: This call only makes sense if 'message' was ultimately
1620 * obtained from a notmuch_thread_t object, (such as by coming
1621 * directly from the result of calling notmuch_thread_get_
1622 * toplevel_messages or by any number of subsequent
1623 * calls to notmuch_message_get_replies).
1625 * If 'message' was obtained through some non-thread means, (such as
1626 * by a call to notmuch_query_search_messages), then this function
1629 * If there are no replies to 'message', this function will return
1630 * NULL. (Note that notmuch_messages_valid will accept that NULL
1631 * value as legitimate, and simply return FALSE for it.)
1633 * This function also returns NULL if it triggers a Xapian exception.
1635 * The returned list will be destroyed when the thread is
1638 notmuch_messages_t *
1639 notmuch_message_get_replies (notmuch_message_t *message);
1642 * Get the total number of files associated with a message.
1643 * @returns Non-negative integer for file count.
1644 * @returns Negative integer for error.
1645 * @since libnotmuch 5.0 (notmuch 0.25)
1648 notmuch_message_count_files (notmuch_message_t *message);
1651 * Get a filename for the email corresponding to 'message'.
1653 * The returned filename is an absolute filename, (the initial
1654 * component will match notmuch_database_get_path() ).
1656 * The returned string belongs to the message so should not be
1657 * modified or freed by the caller (nor should it be referenced after
1658 * the message is destroyed).
1660 * Note: If this message corresponds to multiple files in the mail
1661 * store, (that is, multiple files contain identical message IDs),
1662 * this function will arbitrarily return a single one of those
1663 * filenames. See notmuch_message_get_filenames for returning the
1664 * complete list of filenames.
1666 * This function returns NULL if it triggers a Xapian exception.
1669 notmuch_message_get_filename (notmuch_message_t *message);
1672 * Get all filenames for the email corresponding to 'message'.
1674 * Returns a notmuch_filenames_t iterator listing all the filenames
1675 * associated with 'message'. These files may not have identical
1676 * content, but each will have the identical Message-ID.
1678 * Each filename in the iterator is an absolute filename, (the initial
1679 * component will match notmuch_database_get_path() ).
1681 * This function returns NULL if it triggers a Xapian exception.
1683 notmuch_filenames_t *
1684 notmuch_message_get_filenames (notmuch_message_t *message);
1687 * Re-index the e-mail corresponding to 'message' using the supplied index options
1689 * Returns the status of the re-index operation. (see the return
1690 * codes documented in notmuch_database_index_file)
1692 * After reindexing, the user should discard the message object passed
1693 * in here by calling notmuch_message_destroy, since it refers to the
1694 * original message, not to the reindexed message.
1697 notmuch_message_reindex (notmuch_message_t *message,
1698 notmuch_indexopts_t *indexopts);
1704 NOTMUCH_MESSAGE_FLAG_MATCH,
1705 NOTMUCH_MESSAGE_FLAG_EXCLUDED,
1707 /* This message is a "ghost message", meaning it has no filenames
1708 * or content, but we know it exists because it was referenced by
1709 * some other message. A ghost message has only a message ID and
1712 NOTMUCH_MESSAGE_FLAG_GHOST,
1713 } notmuch_message_flag_t;
1716 * Get a value of a flag for the email corresponding to 'message'.
1718 * returns FALSE in case of errors.
1720 * @deprecated Deprecated as of libnotmuch 5.3 (notmuch 0.31). Please
1721 * use notmuch_message_get_flag_st instead.
1723 NOTMUCH_DEPRECATED (5, 3)
1725 notmuch_message_get_flag (notmuch_message_t *message,
1726 notmuch_message_flag_t flag);
1729 * Get a value of a flag for the email corresponding to 'message'.
1731 * @param message a message object
1732 * @param flag flag to check
1733 * @param is_set pointer to boolean to store flag value.
1735 * @retval #NOTMUCH_STATUS_SUCCESS
1736 * @retval #NOTMUCH_STATUS_NULL_POINTER is_set is NULL
1737 * @retval #NOTMUCH_STATUS_XAPIAN_EXCEPTION Accessing the database
1738 * triggered an exception.
1740 * @since libnotmuch 5.3 (notmuch 0.31)
1743 notmuch_message_get_flag_st (notmuch_message_t *message,
1744 notmuch_message_flag_t flag,
1745 notmuch_bool_t *is_set);
1748 * Set a value of a flag for the email corresponding to 'message'.
1751 notmuch_message_set_flag (notmuch_message_t *message,
1752 notmuch_message_flag_t flag, notmuch_bool_t value);
1755 * Get the date of 'message' as a time_t value.
1757 * For the original textual representation of the Date header from the
1758 * message call notmuch_message_get_header() with a header value of
1761 * Returns 0 in case of error.
1764 notmuch_message_get_date (notmuch_message_t *message);
1767 * Get the value of the specified header from 'message' as a UTF-8 string.
1769 * Common headers are stored in the database when the message is
1770 * indexed and will be returned from the database. Other headers will
1771 * be read from the actual message file.
1773 * The header name is case insensitive.
1775 * The returned string belongs to the message so should not be
1776 * modified or freed by the caller (nor should it be referenced after
1777 * the message is destroyed).
1779 * Returns an empty string ("") if the message does not contain a
1780 * header line matching 'header'. Returns NULL if any error occurs.
1783 notmuch_message_get_header (notmuch_message_t *message, const char *header);
1786 * Get the tags for 'message', returning a notmuch_tags_t object which
1787 * can be used to iterate over all tags.
1789 * The tags object is owned by the message and as such, will only be
1790 * valid for as long as the message is valid, (which is until the
1791 * query from which it derived is destroyed).
1793 * Typical usage might be:
1795 * notmuch_message_t *message;
1796 * notmuch_tags_t *tags;
1799 * message = notmuch_database_find_message (database, message_id);
1801 * for (tags = notmuch_message_get_tags (message);
1802 * notmuch_tags_valid (tags);
1803 * notmuch_tags_move_to_next (tags))
1805 * tag = notmuch_tags_get (tags);
1809 * notmuch_message_destroy (message);
1811 * Note that there's no explicit destructor needed for the
1812 * notmuch_tags_t object. (For consistency, we do provide a
1813 * notmuch_tags_destroy function, but there's no good reason to call
1814 * it if the message is about to be destroyed).
1817 notmuch_message_get_tags (notmuch_message_t *message);
1820 * The longest possible tag value.
1822 #define NOTMUCH_TAG_MAX 200
1825 * Add a tag to the given message.
1829 * NOTMUCH_STATUS_SUCCESS: Tag successfully added to message
1831 * NOTMUCH_STATUS_NULL_POINTER: The 'tag' argument is NULL
1833 * NOTMUCH_STATUS_TAG_TOO_LONG: The length of 'tag' is too long
1834 * (exceeds NOTMUCH_TAG_MAX)
1836 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
1837 * mode so message cannot be modified.
1840 notmuch_message_add_tag (notmuch_message_t *message, const char *tag);
1843 * Remove a tag from the given message.
1847 * NOTMUCH_STATUS_SUCCESS: Tag successfully removed from message
1849 * NOTMUCH_STATUS_NULL_POINTER: The 'tag' argument is NULL
1851 * NOTMUCH_STATUS_TAG_TOO_LONG: The length of 'tag' is too long
1852 * (exceeds NOTMUCH_TAG_MAX)
1854 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
1855 * mode so message cannot be modified.
1858 notmuch_message_remove_tag (notmuch_message_t *message, const char *tag);
1861 * Remove all tags from the given message.
1863 * See notmuch_message_freeze for an example showing how to safely
1864 * replace tag values.
1866 * @retval #NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in
1867 * read-only mode so message cannot be modified.
1868 * @retval #NOTMUCH_STATUS_XAPIAN_EXCEPTION: an exception was thrown
1869 * accessing the database.
1872 notmuch_message_remove_all_tags (notmuch_message_t *message);
1875 * Add/remove tags according to maildir flags in the message filename(s).
1877 * This function examines the filenames of 'message' for maildir
1878 * flags, and adds or removes tags on 'message' as follows when these
1879 * flags are present:
1881 * Flag Action if present
1882 * ---- -----------------
1883 * 'D' Adds the "draft" tag to the message
1884 * 'F' Adds the "flagged" tag to the message
1885 * 'P' Adds the "passed" tag to the message
1886 * 'R' Adds the "replied" tag to the message
1887 * 'S' Removes the "unread" tag from the message
1889 * For each flag that is not present, the opposite action (add/remove)
1890 * is performed for the corresponding tags.
1892 * Flags are identified as trailing components of the filename after a
1893 * sequence of ":2,".
1895 * If there are multiple filenames associated with this message, the
1896 * flag is considered present if it appears in one or more
1897 * filenames. (That is, the flags from the multiple filenames are
1898 * combined with the logical OR operator.)
1900 * A client can ensure that notmuch database tags remain synchronized
1901 * with maildir flags by calling this function after each call to
1902 * notmuch_database_index_file. See also
1903 * notmuch_message_tags_to_maildir_flags for synchronizing tag changes
1904 * back to maildir flags.
1907 notmuch_message_maildir_flags_to_tags (notmuch_message_t *message);
1910 * return TRUE if any filename of 'message' has maildir flag 'flag',
1913 * Deprecated wrapper for notmuch_message_has_maildir_flag_st
1915 * @returns FALSE in case of error
1916 * @deprecated libnotmuch 5.3 (notmuch 0.31)
1918 NOTMUCH_DEPRECATED (5, 3)
1920 notmuch_message_has_maildir_flag (notmuch_message_t *message, char flag);
1923 * check message for maildir flag
1925 * @param [in,out] message message to check
1926 * @param [in] flag flag to check for
1927 * @param [out] is_set pointer to boolean
1929 * @retval #NOTMUCH_STATUS_SUCCESS
1930 * @retval #NOTMUCH_STATUS_NULL_POINTER is_set is NULL
1931 * @retval #NOTMUCH_STATUS_XAPIAN_EXCEPTION Accessing the database
1932 * triggered an exception.
1935 notmuch_message_has_maildir_flag_st (notmuch_message_t *message,
1937 notmuch_bool_t *is_set);
1940 * Rename message filename(s) to encode tags as maildir flags.
1942 * Specifically, for each filename corresponding to this message:
1944 * If the filename is not in a maildir directory, do nothing. (A
1945 * maildir directory is determined as a directory named "new" or
1946 * "cur".) Similarly, if the filename has invalid maildir info,
1947 * (repeated or outof-ASCII-order flag characters after ":2,"), then
1950 * If the filename is in a maildir directory, rename the file so that
1951 * its filename ends with the sequence ":2," followed by zero or more
1952 * of the following single-character flags (in ASCII order):
1954 * * flag 'D' iff the message has the "draft" tag
1955 * * flag 'F' iff the message has the "flagged" tag
1956 * * flag 'P' iff the message has the "passed" tag
1957 * * flag 'R' iff the message has the "replied" tag
1958 * * flag 'S' iff the message does not have the "unread" tag
1960 * Any existing flags unmentioned in the list above will be preserved
1963 * Also, if this filename is in a directory named "new", rename it to
1964 * be within the neighboring directory named "cur".
1966 * A client can ensure that maildir filename flags remain synchronized
1967 * with notmuch database tags by calling this function after changing
1968 * tags, (after calls to notmuch_message_add_tag,
1969 * notmuch_message_remove_tag, or notmuch_message_freeze/
1970 * notmuch_message_thaw). See also notmuch_message_maildir_flags_to_tags
1971 * for synchronizing maildir flag changes back to tags.
1974 notmuch_message_tags_to_maildir_flags (notmuch_message_t *message);
1977 * Freeze the current state of 'message' within the database.
1979 * This means that changes to the message state, (via
1980 * notmuch_message_add_tag, notmuch_message_remove_tag, and
1981 * notmuch_message_remove_all_tags), will not be committed to the
1982 * database until the message is thawed with notmuch_message_thaw.
1984 * Multiple calls to freeze/thaw are valid and these calls will
1985 * "stack". That is there must be as many calls to thaw as to freeze
1986 * before a message is actually thawed.
1988 * The ability to do freeze/thaw allows for safe transactions to
1989 * change tag values. For example, explicitly setting a message to
1990 * have a given set of tags might look like this:
1992 * notmuch_message_freeze (message);
1994 * notmuch_message_remove_all_tags (message);
1996 * for (i = 0; i < NUM_TAGS; i++)
1997 * notmuch_message_add_tag (message, tags[i]);
1999 * notmuch_message_thaw (message);
2001 * With freeze/thaw used like this, the message in the database is
2002 * guaranteed to have either the full set of original tag values, or
2003 * the full set of new tag values, but nothing in between.
2005 * Imagine the example above without freeze/thaw and the operation
2006 * somehow getting interrupted. This could result in the message being
2007 * left with no tags if the interruption happened after
2008 * notmuch_message_remove_all_tags but before notmuch_message_add_tag.
2012 * NOTMUCH_STATUS_SUCCESS: Message successfully frozen.
2014 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
2015 * mode so message cannot be modified.
2018 notmuch_message_freeze (notmuch_message_t *message);
2021 * Thaw the current 'message', synchronizing any changes that may have
2022 * occurred while 'message' was frozen into the notmuch database.
2024 * See notmuch_message_freeze for an example of how to use this
2025 * function to safely provide tag changes.
2027 * Multiple calls to freeze/thaw are valid and these calls with
2028 * "stack". That is there must be as many calls to thaw as to freeze
2029 * before a message is actually thawed.
2033 * NOTMUCH_STATUS_SUCCESS: Message successfully thawed, (or at least
2034 * its frozen count has successfully been reduced by 1).
2036 * NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW: An attempt was made to thaw
2037 * an unfrozen message. That is, there have been an unbalanced
2038 * number of calls to notmuch_message_freeze and
2039 * notmuch_message_thaw.
2042 notmuch_message_thaw (notmuch_message_t *message);
2045 * Destroy a notmuch_message_t object.
2047 * It can be useful to call this function in the case of a single
2048 * query object with many messages in the result, (such as iterating
2049 * over the entire database). Otherwise, it's fine to never call this
2050 * function and there will still be no memory leaks. (The memory from
2051 * the messages get reclaimed when the containing query is destroyed.)
2054 notmuch_message_destroy (notmuch_message_t *message);
2057 * @name Message Properties
2059 * This interface provides the ability to attach arbitrary (key,value)
2060 * string pairs to a message, to remove such pairs, and to iterate
2061 * over them. The caller should take some care as to what keys they
2062 * add or delete values for, as other subsystems or extensions may
2063 * depend on these properties.
2065 * Please see notmuch-properties(7) for more details about specific
2066 * properties and conventions around their use.
2071 * Retrieve the value for a single property key
2073 * *value* is set to a string owned by the message or NULL if there is
2074 * no such key. In the case of multiple values for the given key, the
2075 * first one is retrieved.
2078 * - NOTMUCH_STATUS_NULL_POINTER: *value* may not be NULL.
2079 * - NOTMUCH_STATUS_SUCCESS: No error occurred.
2080 * @since libnotmuch 4.4 (notmuch 0.23)
2083 notmuch_message_get_property (notmuch_message_t *message, const char *key, const char **value);
2086 * Add a (key,value) pair to a message
2089 * - NOTMUCH_STATUS_ILLEGAL_ARGUMENT: *key* may not contain an '=' character.
2090 * - NOTMUCH_STATUS_NULL_POINTER: Neither *key* nor *value* may be NULL.
2091 * - NOTMUCH_STATUS_SUCCESS: No error occurred.
2092 * @since libnotmuch 4.4 (notmuch 0.23)
2095 notmuch_message_add_property (notmuch_message_t *message, const char *key, const char *value);
2098 * Remove a (key,value) pair from a message.
2100 * It is not an error to remove a non-existent (key,value) pair
2103 * - NOTMUCH_STATUS_ILLEGAL_ARGUMENT: *key* may not contain an '=' character.
2104 * - NOTMUCH_STATUS_NULL_POINTER: Neither *key* nor *value* may be NULL.
2105 * - NOTMUCH_STATUS_SUCCESS: No error occurred.
2106 * @since libnotmuch 4.4 (notmuch 0.23)
2109 notmuch_message_remove_property (notmuch_message_t *message, const char *key, const char *value);
2112 * Remove all (key,value) pairs from the given message.
2114 * @param[in,out] message message to operate on.
2115 * @param[in] key key to delete properties for. If NULL, delete
2116 * properties for all keys
2118 * - NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in
2119 * read-only mode so message cannot be modified.
2120 * - NOTMUCH_STATUS_SUCCESS: No error occurred.
2122 * @since libnotmuch 4.4 (notmuch 0.23)
2125 notmuch_message_remove_all_properties (notmuch_message_t *message, const char *key);
2128 * Remove all (prefix*,value) pairs from the given message
2130 * @param[in,out] message message to operate on.
2131 * @param[in] prefix delete properties with keys that start with prefix.
2132 * If NULL, delete all properties
2134 * - NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in
2135 * read-only mode so message cannot be modified.
2136 * - NOTMUCH_STATUS_SUCCESS: No error occurred.
2138 * @since libnotmuch 5.1 (notmuch 0.26)
2141 notmuch_message_remove_all_properties_with_prefix (notmuch_message_t *message, const char *prefix);
2144 * Opaque message property iterator
2146 typedef struct _notmuch_string_map_iterator notmuch_message_properties_t;
2149 * Get the properties for *message*, returning a
2150 * notmuch_message_properties_t object which can be used to iterate
2151 * over all properties.
2153 * The notmuch_message_properties_t object is owned by the message and
2154 * as such, will only be valid for as long as the message is valid,
2155 * (which is until the query from which it derived is destroyed).
2157 * @param[in] message The message to examine
2158 * @param[in] key key or key prefix
2159 * @param[in] exact if TRUE, require exact match with key. Otherwise
2162 * Typical usage might be:
2164 * notmuch_message_properties_t *list;
2166 * for (list = notmuch_message_get_properties (message, "testkey1", TRUE);
2167 * notmuch_message_properties_valid (list); notmuch_message_properties_move_to_next (list)) {
2168 * printf("%s\n", notmuch_message_properties_value(list));
2171 * notmuch_message_properties_destroy (list);
2173 * Note that there's no explicit destructor needed for the
2174 * notmuch_message_properties_t object. (For consistency, we do
2175 * provide a notmuch_message_properities_destroy function, but there's
2176 * no good reason to call it if the message is about to be destroyed).
2178 * @since libnotmuch 4.4 (notmuch 0.23)
2180 notmuch_message_properties_t *
2181 notmuch_message_get_properties (notmuch_message_t *message, const char *key, notmuch_bool_t exact);
2184 * Return the number of properties named "key" belonging to the specific message.
2186 * @param[in] message The message to examine
2187 * @param[in] key key to count
2188 * @param[out] count The number of matching properties associated with this message.
2192 * NOTMUCH_STATUS_SUCCESS: successful count, possibly some other error.
2194 * @since libnotmuch 5.2 (notmuch 0.27)
2197 notmuch_message_count_properties (notmuch_message_t *message, const char *key, unsigned int *count);
2200 * Is the given *properties* iterator pointing at a valid (key,value)
2203 * When this function returns TRUE,
2204 * notmuch_message_properties_{key,value} will return a valid string,
2205 * and notmuch_message_properties_move_to_next will do what it
2206 * says. Whereas when this function returns FALSE, calling any of
2207 * these functions results in undefined behaviour.
2209 * See the documentation of notmuch_message_get_properties for example
2210 * code showing how to iterate over a notmuch_message_properties_t
2213 * @since libnotmuch 4.4 (notmuch 0.23)
2216 notmuch_message_properties_valid (notmuch_message_properties_t *properties);
2219 * Move the *properties* iterator to the next (key,value) pair
2221 * If *properties* is already pointing at the last pair then the iterator
2222 * will be moved to a point just beyond that last pair, (where
2223 * notmuch_message_properties_valid will return FALSE).
2225 * See the documentation of notmuch_message_get_properties for example
2226 * code showing how to iterate over a notmuch_message_properties_t object.
2228 * @since libnotmuch 4.4 (notmuch 0.23)
2231 notmuch_message_properties_move_to_next (notmuch_message_properties_t *properties);
2234 * Return the key from the current (key,value) pair.
2236 * this could be useful if iterating for a prefix
2238 * @since libnotmuch 4.4 (notmuch 0.23)
2241 notmuch_message_properties_key (notmuch_message_properties_t *properties);
2244 * Return the value from the current (key,value) pair.
2246 * This could be useful if iterating for a prefix.
2248 * @since libnotmuch 4.4 (notmuch 0.23)
2251 notmuch_message_properties_value (notmuch_message_properties_t *properties);
2255 * Destroy a notmuch_message_properties_t object.
2257 * It's not strictly necessary to call this function. All memory from
2258 * the notmuch_message_properties_t object will be reclaimed when the
2259 * containing message object is destroyed.
2261 * @since libnotmuch 4.4 (notmuch 0.23)
2264 notmuch_message_properties_destroy (notmuch_message_properties_t *properties);
2269 * Is the given 'tags' iterator pointing at a valid tag.
2271 * When this function returns TRUE, notmuch_tags_get will return a
2272 * valid string. Whereas when this function returns FALSE,
2273 * notmuch_tags_get will return NULL.
2275 * It is acceptable to pass NULL for 'tags', in which case this
2276 * function will always return FALSE.
2278 * See the documentation of notmuch_message_get_tags for example code
2279 * showing how to iterate over a notmuch_tags_t object.
2282 notmuch_tags_valid (notmuch_tags_t *tags);
2285 * Get the current tag from 'tags' as a string.
2287 * Note: The returned string belongs to 'tags' and has a lifetime
2288 * identical to it (and the query to which it ultimately belongs).
2290 * See the documentation of notmuch_message_get_tags for example code
2291 * showing how to iterate over a notmuch_tags_t object.
2294 notmuch_tags_get (notmuch_tags_t *tags);
2297 * Move the 'tags' iterator to the next tag.
2299 * If 'tags' is already pointing at the last tag then the iterator
2300 * will be moved to a point just beyond that last tag, (where
2301 * notmuch_tags_valid will return FALSE and notmuch_tags_get will
2304 * See the documentation of notmuch_message_get_tags for example code
2305 * showing how to iterate over a notmuch_tags_t object.
2308 notmuch_tags_move_to_next (notmuch_tags_t *tags);
2311 * Destroy a notmuch_tags_t object.
2313 * It's not strictly necessary to call this function. All memory from
2314 * the notmuch_tags_t object will be reclaimed when the containing
2315 * message or query objects are destroyed.
2318 notmuch_tags_destroy (notmuch_tags_t *tags);
2321 * Store an mtime within the database for 'directory'.
2323 * The 'directory' should be an object retrieved from the database
2324 * with notmuch_database_get_directory for a particular path.
2326 * The intention is for the caller to use the mtime to allow efficient
2327 * identification of new messages to be added to the database. The
2328 * recommended usage is as follows:
2330 * o Read the mtime of a directory from the filesystem
2332 * o Call index_file for all mail files in the directory
2334 * o Call notmuch_directory_set_mtime with the mtime read from the
2337 * Then, when wanting to check for updates to the directory in the
2338 * future, the client can call notmuch_directory_get_mtime and know
2339 * that it only needs to add files if the mtime of the directory and
2340 * files are newer than the stored timestamp.
2342 * Note: The notmuch_directory_get_mtime function does not allow the
2343 * caller to distinguish a timestamp of 0 from a non-existent
2344 * timestamp. So don't store a timestamp of 0 unless you are
2345 * comfortable with that.
2349 * NOTMUCH_STATUS_SUCCESS: mtime successfully stored in database.
2351 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception
2352 * occurred, mtime not stored.
2354 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
2355 * mode so directory mtime cannot be modified.
2358 notmuch_directory_set_mtime (notmuch_directory_t *directory,
2362 * Get the mtime of a directory, (as previously stored with
2363 * notmuch_directory_set_mtime).
2365 * Returns 0 if no mtime has previously been stored for this
2369 notmuch_directory_get_mtime (notmuch_directory_t *directory);
2372 * Get a notmuch_filenames_t iterator listing all the filenames of
2373 * messages in the database within the given directory.
2375 * The returned filenames will be the basename-entries only (not
2378 * Returns NULL if it triggers a Xapian exception
2380 notmuch_filenames_t *
2381 notmuch_directory_get_child_files (notmuch_directory_t *directory);
2384 * Get a notmuch_filenames_t iterator listing all the filenames of
2385 * sub-directories in the database within the given directory.
2387 * The returned filenames will be the basename-entries only (not
2390 * Returns NULL if it triggers a Xapian exception
2392 notmuch_filenames_t *
2393 notmuch_directory_get_child_directories (notmuch_directory_t *directory);
2396 * Delete directory document from the database, and destroy the
2397 * notmuch_directory_t object. Assumes any child directories and files
2398 * have been deleted by the caller.
2400 * @since libnotmuch 4.3 (notmuch 0.21)
2403 notmuch_directory_delete (notmuch_directory_t *directory);
2406 * Destroy a notmuch_directory_t object.
2409 notmuch_directory_destroy (notmuch_directory_t *directory);
2412 * Is the given 'filenames' iterator pointing at a valid filename.
2414 * When this function returns TRUE, notmuch_filenames_get will return
2415 * a valid string. Whereas when this function returns FALSE,
2416 * notmuch_filenames_get will return NULL.
2418 * It is acceptable to pass NULL for 'filenames', in which case this
2419 * function will always return FALSE.
2422 notmuch_filenames_valid (notmuch_filenames_t *filenames);
2425 * Get the current filename from 'filenames' as a string.
2427 * Note: The returned string belongs to 'filenames' and has a lifetime
2428 * identical to it (and the directory to which it ultimately belongs).
2430 * It is acceptable to pass NULL for 'filenames', in which case this
2431 * function will always return NULL.
2434 notmuch_filenames_get (notmuch_filenames_t *filenames);
2437 * Move the 'filenames' iterator to the next filename.
2439 * If 'filenames' is already pointing at the last filename then the
2440 * iterator will be moved to a point just beyond that last filename,
2441 * (where notmuch_filenames_valid will return FALSE and
2442 * notmuch_filenames_get will return NULL).
2444 * It is acceptable to pass NULL for 'filenames', in which case this
2445 * function will do nothing.
2448 notmuch_filenames_move_to_next (notmuch_filenames_t *filenames);
2451 * Destroy a notmuch_filenames_t object.
2453 * It's not strictly necessary to call this function. All memory from
2454 * the notmuch_filenames_t object will be reclaimed when the
2455 * containing directory object is destroyed.
2457 * It is acceptable to pass NULL for 'filenames', in which case this
2458 * function will do nothing.
2461 notmuch_filenames_destroy (notmuch_filenames_t *filenames);
2465 * set config 'key' to 'value'
2467 * @since libnotmuch 4.4 (notmuch 0.23)
2468 * @retval #NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in
2469 * read-only mode so message cannot be modified.
2470 * @retval #NOTMUCH_STATUS_XAPIAN_EXCEPTION: an exception was thrown
2471 * accessing the database.
2472 * @retval #NOTMUCH_STATUS_SUCCESS
2475 notmuch_database_set_config (notmuch_database_t *db, const char *key, const char *value);
2478 * retrieve config item 'key', assign to 'value'
2480 * keys which have not been previously set with n_d_set_config will
2481 * return an empty string.
2483 * return value is allocated by malloc and should be freed by the
2486 * @since libnotmuch 4.4 (notmuch 0.23)
2490 notmuch_database_get_config (notmuch_database_t *db, const char *key, char **value);
2493 * Create an iterator for all config items with keys matching a given prefix
2495 * @since libnotmuch 4.4 (notmuch 0.23)
2498 notmuch_database_get_config_list (notmuch_database_t *db, const char *prefix,
2499 notmuch_config_list_t **out);
2502 * Is 'config_list' iterator valid (i.e. _key, _value, _move_to_next can be called).
2504 * @since libnotmuch 4.4 (notmuch 0.23)
2507 notmuch_config_list_valid (notmuch_config_list_t *config_list);
2510 * return key for current config pair
2512 * return value is owned by the iterator, and will be destroyed by the
2513 * next call to notmuch_config_list_key or notmuch_config_list_destroy.
2515 * @since libnotmuch 4.4 (notmuch 0.23)
2518 notmuch_config_list_key (notmuch_config_list_t *config_list);
2521 * return 'value' for current config pair
2523 * return value is owned by the iterator, and will be destroyed by the
2524 * next call to notmuch_config_list_value or notmuch config_list_destroy
2526 * @since libnotmuch 4.4 (notmuch 0.23)
2527 * @retval NULL for errors
2530 notmuch_config_list_value (notmuch_config_list_t *config_list);
2534 * move 'config_list' iterator to the next pair
2536 * @since libnotmuch 4.4 (notmuch 0.23)
2539 notmuch_config_list_move_to_next (notmuch_config_list_t *config_list);
2542 * free any resources held by 'config_list'
2544 * @since libnotmuch 4.4 (notmuch 0.23)
2547 notmuch_config_list_destroy (notmuch_config_list_t *config_list);
2550 * Configuration keys known to libnotmuch
2553 NOTMUCH_CONFIG_FIRST,
2554 NOTMUCH_CONFIG_DATABASE_PATH = NOTMUCH_CONFIG_FIRST,
2555 NOTMUCH_CONFIG_MAIL_ROOT,
2556 NOTMUCH_CONFIG_HOOK_DIR,
2557 NOTMUCH_CONFIG_BACKUP_DIR,
2558 NOTMUCH_CONFIG_EXCLUDE_TAGS,
2559 NOTMUCH_CONFIG_NEW_TAGS,
2560 NOTMUCH_CONFIG_NEW_IGNORE,
2561 NOTMUCH_CONFIG_SYNC_MAILDIR_FLAGS,
2562 NOTMUCH_CONFIG_PRIMARY_EMAIL,
2563 NOTMUCH_CONFIG_OTHER_EMAIL,
2564 NOTMUCH_CONFIG_USER_NAME,
2565 NOTMUCH_CONFIG_AUTOCOMMIT,
2566 NOTMUCH_CONFIG_EXTRA_HEADERS,
2567 NOTMUCH_CONFIG_INDEX_AS_TEXT,
2569 } notmuch_config_key_t;
2572 * get a configuration value from an open database.
2574 * This value reflects all configuration information given at the time
2575 * the database was opened.
2577 * @param[in] notmuch database
2578 * @param[in] key configuration key
2580 * @since libnotmuch 5.4 (notmuch 0.32)
2582 * @retval NULL if 'key' unknown or if no value is known for
2583 * 'key'. Otherwise returns a string owned by notmuch which should
2584 * not be modified nor freed by the caller.
2587 notmuch_config_get (notmuch_database_t *notmuch, notmuch_config_key_t key);
2590 * set a configuration value from in an open database.
2592 * This value reflects all configuration information given at the time
2593 * the database was opened.
2595 * @param[in,out] notmuch database open read/write
2596 * @param[in] key configuration key
2597 * @param[in] val configuration value
2599 * @since libnotmuch 5.4 (notmuch 0.32)
2601 * @retval returns any return value for notmuch_database_set_config.
2604 notmuch_config_set (notmuch_database_t *notmuch, notmuch_config_key_t key, const char *val);
2607 * Returns an iterator for a ';'-delimited list of configuration values
2609 * These values reflect all configuration information given at the
2610 * time the database was opened.
2612 * @param[in] notmuch database
2613 * @param[in] key configuration key
2615 * @since libnotmuch 5.4 (notmuch 0.32)
2617 * @retval NULL in case of error.
2619 notmuch_config_values_t *
2620 notmuch_config_get_values (notmuch_database_t *notmuch, notmuch_config_key_t key);
2623 * Returns an iterator for a ';'-delimited list of configuration values
2625 * These values reflect all configuration information given at the
2626 * time the database was opened.
2628 * @param[in] notmuch database
2629 * @param[in] key configuration key
2631 * @since libnotmuch 5.4 (notmuch 0.32)
2633 * @retval NULL in case of error.
2635 notmuch_config_values_t *
2636 notmuch_config_get_values_string (notmuch_database_t *notmuch, const char *key);
2639 * Is the given 'config_values' iterator pointing at a valid element.
2641 * @param[in] values iterator
2643 * @since libnotmuch 5.4 (notmuch 0.32)
2645 * @retval FALSE if passed a NULL pointer, or the iterator is exhausted.
2649 notmuch_config_values_valid (notmuch_config_values_t *values);
2652 * Get the current value from the 'values' iterator
2654 * @param[in] values iterator
2656 * @since libnotmuch 5.4 (notmuch 0.32)
2658 * @retval a string with the same lifetime as the iterator
2661 notmuch_config_values_get (notmuch_config_values_t *values);
2664 * Move the 'values' iterator to the next element
2666 * @param[in,out] values iterator
2668 * @since libnotmuch 5.4 (notmuch 0.32)
2672 notmuch_config_values_move_to_next (notmuch_config_values_t *values);
2676 * reset the 'values' iterator to the first element
2678 * @param[in,out] values iterator. A NULL value is ignored.
2680 * @since libnotmuch 5.4 (notmuch 0.32)
2684 notmuch_config_values_start (notmuch_config_values_t *values);
2687 * Destroy a config values iterator, along with any associated
2690 * @param[in,out] values iterator
2692 * @since libnotmuch 5.4 (notmuch 0.32)
2695 notmuch_config_values_destroy (notmuch_config_values_t *values);
2699 * Returns an iterator for a (key, value) configuration pairs
2701 * @param[in] notmuch database
2702 * @param[in] prefix prefix for keys. Pass "" for all keys.
2704 * @since libnotmuch 5.4 (notmuch 0.32)
2706 * @retval NULL in case of error.
2708 notmuch_config_pairs_t *
2709 notmuch_config_get_pairs (notmuch_database_t *notmuch,
2710 const char *prefix);
2713 * Is the given 'config_pairs' iterator pointing at a valid element.
2715 * @param[in] pairs iterator
2717 * @since libnotmuch 5.4 (notmuch 0.32)
2719 * @retval FALSE if passed a NULL pointer, or the iterator is exhausted.
2723 notmuch_config_pairs_valid (notmuch_config_pairs_t *pairs);
2726 * Move the 'config_pairs' iterator to the next element
2728 * @param[in,out] pairs iterator
2730 * @since libnotmuch 5.4 (notmuch 0.32)
2734 notmuch_config_pairs_move_to_next (notmuch_config_pairs_t *pairs);
2737 * Get the current key from the 'config_pairs' iterator
2739 * @param[in] pairs iterator
2741 * @since libnotmuch 5.4 (notmuch 0.32)
2743 * @retval a string with the same lifetime as the iterator
2746 notmuch_config_pairs_key (notmuch_config_pairs_t *pairs);
2749 * Get the current value from the 'config_pairs' iterator
2751 * @param[in] pairs iterator
2753 * @since libnotmuch 5.4 (notmuch 0.32)
2755 * @retval a string with the same lifetime as the iterator
2758 notmuch_config_pairs_value (notmuch_config_pairs_t *pairs);
2761 * Destroy a config_pairs iterator, along with any associated
2764 * @param[in,out] pairs iterator
2766 * @since libnotmuch 5.4 (notmuch 0.32)
2769 notmuch_config_pairs_destroy (notmuch_config_pairs_t *pairs);
2772 * get a configuration value from an open database as Boolean
2774 * This value reflects all configuration information given at the time
2775 * the database was opened.
2777 * @param[in] notmuch database
2778 * @param[in] key configuration key
2779 * @param[out] val configuration value, converted to Boolean
2781 * @since libnotmuch 5.4 (notmuch 0.32)
2783 * @retval #NOTMUCH_STATUS_ILLEGAL_ARGUMENT if either key is unknown
2784 * or the corresponding value does not convert to Boolean.
2787 notmuch_config_get_bool (notmuch_database_t *notmuch,
2788 notmuch_config_key_t key,
2789 notmuch_bool_t *val);
2792 * return the path of the config file loaded, if any
2794 * @retval NULL if no config file was loaded
2797 notmuch_config_path (notmuch_database_t *notmuch);
2800 * get the current default indexing options for a given database.
2802 * This object will survive until the database itself is destroyed,
2803 * but the caller may also release it earlier with
2804 * notmuch_indexopts_destroy.
2806 * This object represents a set of options on how a message can be
2807 * added to the index. At the moment it is a featureless stub.
2809 * @since libnotmuch 5.1 (notmuch 0.26)
2810 * @retval NULL in case of error
2812 notmuch_indexopts_t *
2813 notmuch_database_get_default_indexopts (notmuch_database_t *db);
2816 * Stating a policy about how to decrypt messages.
2818 * See index.decrypt in notmuch-config(1) for more details.
2821 NOTMUCH_DECRYPT_FALSE,
2822 NOTMUCH_DECRYPT_TRUE,
2823 NOTMUCH_DECRYPT_AUTO,
2824 NOTMUCH_DECRYPT_NOSTASH,
2825 } notmuch_decryption_policy_t;
2828 * Specify whether to decrypt encrypted parts while indexing.
2830 * Be aware that the index is likely sufficient to reconstruct the
2831 * cleartext of the message itself, so please ensure that the notmuch
2832 * message index is adequately protected. DO NOT SET THIS FLAG TO TRUE
2833 * without considering the security of your index.
2835 * @since libnotmuch 5.1 (notmuch 0.26)
2838 notmuch_indexopts_set_decrypt_policy (notmuch_indexopts_t *indexopts,
2839 notmuch_decryption_policy_t decrypt_policy);
2842 * Return whether to decrypt encrypted parts while indexing.
2843 * see notmuch_indexopts_set_decrypt_policy.
2845 * @since libnotmuch 5.1 (notmuch 0.26)
2847 notmuch_decryption_policy_t
2848 notmuch_indexopts_get_decrypt_policy (const notmuch_indexopts_t *indexopts);
2851 * Destroy a notmuch_indexopts_t object.
2853 * @since libnotmuch 5.1 (notmuch 0.26)
2856 notmuch_indexopts_destroy (notmuch_indexopts_t *options);
2860 * interrogate the library for compile time features
2862 * @since libnotmuch 4.4 (notmuch 0.23)
2865 notmuch_built_with (const char *name);
2868 #pragma GCC visibility pop