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_FILE_ERROR: An error occurred trying to create the
297 * database file (such as permission denied, or file not found,
298 * etc.), or the database already exists.
300 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred.
303 notmuch_database_create (const char *path, notmuch_database_t **database);
306 * Like notmuch_database_create, except optionally return an error
307 * message. This message is allocated by malloc and should be freed by
311 notmuch_database_create_verbose (const char *path,
312 notmuch_database_t **database,
313 char **error_message);
316 * Database open mode for notmuch_database_open.
320 * Open database for reading only.
322 NOTMUCH_DATABASE_MODE_READ_ONLY = 0,
324 * Open database for reading and writing.
326 NOTMUCH_DATABASE_MODE_READ_WRITE
327 } notmuch_database_mode_t;
330 * Deprecated alias for notmuch_database_open_with_config with
331 * config_path="" and error_message=NULL
332 * @deprecated Deprecated as of libnotmuch 5.4 (notmuch 0.32)
334 NOTMUCH_DEPRECATED(5, 4)
336 notmuch_database_open (const char *path,
337 notmuch_database_mode_t mode,
338 notmuch_database_t **database);
340 * Deprecated alias for notmuch_database_open_with_config with
343 * @deprecated Deprecated as of libnotmuch 5.4 (notmuch 0.32)
346 NOTMUCH_DEPRECATED(5, 4)
348 notmuch_database_open_verbose (const char *path,
349 notmuch_database_mode_t mode,
350 notmuch_database_t **database,
351 char **error_message);
354 * Open an existing notmuch database located at 'database_path', using
355 * configuration in 'config_path'.
357 * @param[in] database_path
359 * Path to existing database.
361 * A notmuch database is a Xapian database containing appropriate
364 * The database should have been created at some time in the past,
365 * (not necessarily by this process), by calling
366 * notmuch_database_create.
368 * If 'database_path' is NULL, use the location specified
370 * - in the environment variable NOTMUCH_DATABASE, if non-empty
372 * - in a configuration file, located as described under 'config_path'
374 * - by $XDG_DATA_HOME/notmuch/$PROFILE where XDG_DATA_HOME defaults
375 * to "$HOME/.local/share" and PROFILE as as discussed in
378 * If 'database_path' is non-NULL, but does not appear to be a Xapian
379 * database, check for a directory '.notmuch/xapian' below
380 * 'database_path' (this is the behavior of
381 * notmuch_database_open_verbose pre-0.32).
386 * Mode to open database. Use one of #NOTMUCH_DATABASE_MODE_READ_WRITE
387 * or #NOTMUCH_DATABASE_MODE_READ_ONLY
390 * @param[in] config_path
392 * Path to config file.
394 * Config file is key-value, with mandatory sections. See
395 * <em>notmuch-config(5)</em> for more information. The key-value pair
396 * overrides the corresponding configuration data stored in the
397 * database (see <em>notmuch_database_get_config</em>)
399 * If <em>config_path</em> is NULL use the path specified
401 * - in environment variable <em>NOTMUCH_CONFIG</em>, if non-empty
403 * - by <em>XDG_CONFIG_HOME</em>/notmuch/ where
404 * XDG_CONFIG_HOME defaults to "$HOME/.config".
406 * - by $HOME/.notmuch-config
408 * If <em>config_path</em> is "" (empty string) then do not
409 * open any configuration file.
411 * @param[in] profile:
413 * Name of profile (configuration/database variant).
415 * If non-NULL, append to the directory / file path determined for
416 * <em>config_path</em> and <em>database_path</em>.
419 * - environment variable NOTMUCH_PROFILE if defined,
420 * - otherwise "default" for directories and "" (empty string) for paths.
423 * @param[out] database
425 * Pointer to database object. May not be NULL.
427 * The caller should call notmuch_database_destroy when finished with
430 * In case of any failure, this function returns an error status and
431 * sets *database to NULL.
434 * @param[out] error_message
435 * If non-NULL, store error message from opening the database.
436 * Any such message is allocated by \a malloc(3) and should be freed
439 * @retval NOTMUCH_STATUS_SUCCESS: Successfully opened the database.
441 * @retval NOTMUCH_STATUS_NULL_POINTER: The given \a database
444 * @retval NOTMUCH_STATUS_NO_CONFIG: No config file was found. Fatal.
446 * @retval NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory.
448 * @retval NOTMUCH_STATUS_FILE_ERROR: An error occurred trying to open the
449 * database or config file (such as permission denied, or file not found,
450 * etc.), or the database version is unknown.
452 * @retval NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred.
454 * @since libnotmuch 5.4 (notmuch 0.32)
458 notmuch_database_open_with_config (const char *database_path,
459 notmuch_database_mode_t mode,
460 const char *config_path,
462 notmuch_database_t **database,
463 char **error_message);
467 * Loads configuration from config file, database, and/or defaults
469 * For description of arguments, @see notmuch_database_open_with_config
471 * For errors other then NO_DATABASE and NO_CONFIG, *database is set to
474 * @retval NOTMUCH_STATUS_SUCCESS: Successfully loaded configuration.
476 * @retval NOTMUCH_STATUS_NO_CONFIG: No config file was loaded. Not fatal.
478 * @retval NOTMUCH_STATUS_NO_DATABASE: No config information was
479 * loaded from a database. Not fatal.
481 * @retval NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory.
483 * @retval NOTMUCH_STATUS_FILE_ERROR: An error occurred trying to open the
484 * database or config file (such as permission denied, or file not found,
487 * @retval NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred.
489 * @since libnotmuch 5.4 (notmuch 0.32)
493 notmuch_database_load_config (const char *database_path,
494 const char *config_path,
496 notmuch_database_t **database,
497 char **error_message);
500 * Create a new notmuch database located at 'database_path', using
501 * configuration in 'config_path'.
503 * For description of arguments, @see notmuch_database_open_with_config
505 * In case of any failure, this function returns an error status and
506 * sets *database to NULL.
508 * @retval NOTMUCH_STATUS_SUCCESS: Successfully created the database.
510 * @retval NOTMUCH_STATUS_DATABASE_EXISTS: Database already exists, not created
512 * @retval NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory.
514 * @retval NOTMUCH_STATUS_FILE_ERROR: An error occurred trying to open the
515 * database or config file (such as permission denied, or file not found,
518 * @retval NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred.
520 * @since libnotmuch 5.4 (notmuch 0.32)
524 notmuch_database_create_with_config (const char *database_path,
525 const char *config_path,
527 notmuch_database_t **database,
528 char **error_message);
531 * Retrieve last status string for given database.
535 notmuch_database_status_string (const notmuch_database_t *notmuch);
538 * Commit changes and close the given notmuch database.
540 * After notmuch_database_close has been called, calls to other
541 * functions on objects derived from this database may either behave
542 * as if the database had not been closed (e.g., if the required data
543 * has been cached) or may fail with a
544 * NOTMUCH_STATUS_XAPIAN_EXCEPTION. The only further operation
545 * permitted on the database itself is to call
546 * notmuch_database_destroy.
548 * notmuch_database_close can be called multiple times. Later calls
551 * For writable databases, notmuch_database_close commits all changes
552 * to disk before closing the database, unless the caller is currently
553 * in an atomic section (there was a notmuch_database_begin_atomic
554 * without a matching notmuch_database_end_atomic). In this case
555 * changes since the last commit are discarded. @see
556 * notmuch_database_end_atomic for more information.
560 * NOTMUCH_STATUS_SUCCESS: Successfully closed the database.
562 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred; the
563 * database has been closed but there are no guarantees the
564 * changes to the database, if any, have been flushed to disk.
567 notmuch_database_close (notmuch_database_t *database);
570 * A callback invoked by notmuch_database_compact to notify the user
571 * of the progress of the compaction process.
573 typedef void (*notmuch_compact_status_cb_t)(const char *message, void *closure);
576 * Compact a notmuch database, backing up the original database to the
579 * The database will be opened with NOTMUCH_DATABASE_MODE_READ_WRITE
580 * during the compaction process to ensure no writes are made.
582 * If the optional callback function 'status_cb' is non-NULL, it will
583 * be called with diagnostic and informational messages. The argument
584 * 'closure' is passed verbatim to any callback invoked.
587 notmuch_database_compact (const char *path,
588 const char *backup_path,
589 notmuch_compact_status_cb_t status_cb,
593 * Like notmuch_database_compact, but take an open database as a
596 * @since libnnotmuch 5.4 (notmuch 0.32)
599 notmuch_database_compact_db (notmuch_database_t *database,
600 const char *backup_path,
601 notmuch_compact_status_cb_t status_cb,
605 * Destroy the notmuch database, closing it if necessary and freeing
606 * all associated resources.
608 * Return value as in notmuch_database_close if the database was open;
609 * notmuch_database_destroy itself has no failure modes.
612 notmuch_database_destroy (notmuch_database_t *database);
615 * Return the database path of the given database.
617 * The return value is a string owned by notmuch so should not be
618 * modified nor freed by the caller.
621 notmuch_database_get_path (notmuch_database_t *database);
624 * Return the database format version of the given database.
629 notmuch_database_get_version (notmuch_database_t *database);
632 * Can the database be upgraded to a newer database version?
634 * If this function returns TRUE, then the caller may call
635 * notmuch_database_upgrade to upgrade the database. If the caller
636 * does not upgrade an out-of-date database, then some functions may
637 * fail with NOTMUCH_STATUS_UPGRADE_REQUIRED. This always returns
638 * FALSE for a read-only database because there's no way to upgrade a
639 * read-only database.
641 * Also returns FALSE if an error occurs accessing the database.
645 notmuch_database_needs_upgrade (notmuch_database_t *database);
648 * Upgrade the current database to the latest supported version.
650 * This ensures that all current notmuch functionality will be
651 * available on the database. After opening a database in read-write
652 * mode, it is recommended that clients check if an upgrade is needed
653 * (notmuch_database_needs_upgrade) and if so, upgrade with this
654 * function before making any modifications. If
655 * notmuch_database_needs_upgrade returns FALSE, this will be a no-op.
657 * The optional progress_notify callback can be used by the caller to
658 * provide progress indication to the user. If non-NULL it will be
659 * called periodically with 'progress' as a floating-point value in
660 * the range of [0.0 .. 1.0] indicating the progress made so far in
661 * the upgrade process. The argument 'closure' is passed verbatim to
662 * any callback invoked.
665 notmuch_database_upgrade (notmuch_database_t *database,
666 void (*progress_notify)(void *closure,
671 * Begin an atomic database operation.
673 * Any modifications performed between a successful begin and a
674 * notmuch_database_end_atomic will be applied to the database
675 * atomically. Note that, unlike a typical database transaction, this
676 * only ensures atomicity, not durability; neither begin nor end
677 * necessarily flush modifications to disk.
679 * Atomic sections may be nested. begin_atomic and end_atomic must
680 * always be called in pairs.
684 * NOTMUCH_STATUS_SUCCESS: Successfully entered atomic section.
686 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred;
687 * atomic section not entered.
690 notmuch_database_begin_atomic (notmuch_database_t *notmuch);
693 * Indicate the end of an atomic database operation. If repeated
694 * (with matching notmuch_database_begin_atomic) "database.autocommit"
695 * times, commit the the transaction and all previous (non-cancelled)
696 * transactions to the database.
700 * NOTMUCH_STATUS_SUCCESS: Successfully completed atomic section.
702 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred;
703 * atomic section not ended.
705 * NOTMUCH_STATUS_UNBALANCED_ATOMIC: The database is not currently in
709 notmuch_database_end_atomic (notmuch_database_t *notmuch);
712 * Return the committed database revision and UUID.
714 * The database revision number increases monotonically with each
715 * commit to the database. Hence, all messages and message changes
716 * committed to the database (that is, visible to readers) have a last
717 * modification revision <= the committed database revision. Any
718 * messages committed in the future will be assigned a modification
719 * revision > the committed database revision.
721 * The UUID is a NUL-terminated opaque string that uniquely identifies
722 * this database. Two revision numbers are only comparable if they
723 * have the same database UUID.
726 notmuch_database_get_revision (notmuch_database_t *notmuch,
730 * Retrieve a directory object from the database for 'path'.
732 * Here, 'path' should be a path relative to the path of 'database'
733 * (see notmuch_database_get_path), or else should be an absolute path
734 * with initial components that match the path of 'database'.
736 * If this directory object does not exist in the database, this
737 * returns NOTMUCH_STATUS_SUCCESS and sets *directory to NULL.
739 * Otherwise the returned directory object is owned by the database
740 * and as such, will only be valid until notmuch_database_destroy is
745 * NOTMUCH_STATUS_SUCCESS: Successfully retrieved directory.
747 * NOTMUCH_STATUS_NULL_POINTER: The given 'directory' argument is NULL.
749 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred;
750 * directory not retrieved.
752 * NOTMUCH_STATUS_UPGRADE_REQUIRED: The caller must upgrade the
753 * database to use this function.
756 notmuch_database_get_directory (notmuch_database_t *database,
758 notmuch_directory_t **directory);
761 * Add a message file to a database, indexing it for retrieval by
762 * future searches. If a message already exists with the same message
763 * ID as the specified file, their indexes will be merged, and this
764 * new filename will also be associated with the existing message.
766 * Here, 'filename' should be a path relative to the path of
767 * 'database' (see notmuch_database_get_path), or else should be an
768 * absolute filename with initial components that match the path of
771 * The file should be a single mail message (not a multi-message mbox)
772 * that is expected to remain at its current location, (since the
773 * notmuch database will reference the filename, and will not copy the
774 * entire contents of the file.
776 * If another message with the same message ID already exists in the
777 * database, rather than creating a new message, this adds the search
778 * terms from the identified file to the existing message's index, and
779 * adds 'filename' to the list of filenames known for the message.
781 * The 'indexopts' parameter can be NULL (meaning, use the indexing
782 * defaults from the database), or can be an explicit choice of
783 * indexing options that should govern the indexing of this specific
786 * If 'message' is not NULL, then, on successful return
787 * (NOTMUCH_STATUS_SUCCESS or NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID) '*message'
788 * will be initialized to a message object that can be used for things
789 * such as adding tags to the just-added message. The user should call
790 * notmuch_message_destroy when done with the message. On any failure
791 * '*message' will be set to NULL.
795 * NOTMUCH_STATUS_SUCCESS: Message successfully added to database.
797 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred,
800 * NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID: Message has the same message
801 * ID as another message already in the database. The new
802 * filename was successfully added to the message in the database
803 * (if not already present) and the existing message is returned.
805 * NOTMUCH_STATUS_FILE_ERROR: an error occurred trying to open the
806 * file, (such as permission denied, or file not found,
807 * etc.). Nothing added to the database.
809 * NOTMUCH_STATUS_FILE_NOT_EMAIL: the contents of filename don't look
810 * like an email message. Nothing added to the database.
812 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
813 * mode so no message can be added.
815 * NOTMUCH_STATUS_UPGRADE_REQUIRED: The caller must upgrade the
816 * database to use this function.
818 * @since libnotmuch 5.1 (notmuch 0.26)
821 notmuch_database_index_file (notmuch_database_t *database,
822 const char *filename,
823 notmuch_indexopts_t *indexopts,
824 notmuch_message_t **message);
827 * Deprecated alias for notmuch_database_index_file called with
830 * @deprecated Deprecated as of libnotmuch 5.1 (notmuch 0.26). Please
831 * use notmuch_database_index_file instead.
834 NOTMUCH_DEPRECATED (5, 1)
836 notmuch_database_add_message (notmuch_database_t *database,
837 const char *filename,
838 notmuch_message_t **message);
841 * Remove a message filename from the given notmuch database. If the
842 * message has no more filenames, remove the message.
844 * If the same message (as determined by the message ID) is still
845 * available via other filenames, then the message will persist in the
846 * database for those filenames. When the last filename is removed for
847 * a particular message, the database content for that message will be
852 * NOTMUCH_STATUS_SUCCESS: The last filename was removed and the
853 * message was removed from the database.
855 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred,
856 * message not removed.
858 * NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID: This filename was removed but
859 * the message persists in the database with at least one other
862 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
863 * mode so no message can be removed.
865 * NOTMUCH_STATUS_UPGRADE_REQUIRED: The caller must upgrade the
866 * database to use this function.
869 notmuch_database_remove_message (notmuch_database_t *database,
870 const char *filename);
873 * Find a message with the given message_id.
875 * If a message with the given message_id is found then, on successful return
876 * (NOTMUCH_STATUS_SUCCESS) '*message' will be initialized to a message
877 * object. The caller should call notmuch_message_destroy when done with the
880 * On any failure or when the message is not found, this function initializes
881 * '*message' to NULL. This means, when NOTMUCH_STATUS_SUCCESS is returned, the
882 * caller is supposed to check '*message' for NULL to find out whether the
883 * message with the given message_id was found.
887 * NOTMUCH_STATUS_SUCCESS: Successful return, check '*message'.
889 * NOTMUCH_STATUS_NULL_POINTER: The given 'message' argument is NULL
891 * NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory, creating message object
893 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred
896 notmuch_database_find_message (notmuch_database_t *database,
897 const char *message_id,
898 notmuch_message_t **message);
901 * Find a message with the given filename.
903 * If the database contains a message with the given filename then, on
904 * successful return (NOTMUCH_STATUS_SUCCESS) '*message' will be initialized to
905 * a message object. The caller should call notmuch_message_destroy when done
908 * On any failure or when the message is not found, this function initializes
909 * '*message' to NULL. This means, when NOTMUCH_STATUS_SUCCESS is returned, the
910 * caller is supposed to check '*message' for NULL to find out whether the
911 * message with the given filename is found.
915 * NOTMUCH_STATUS_SUCCESS: Successful return, check '*message'
917 * NOTMUCH_STATUS_NULL_POINTER: The given 'message' argument is NULL
919 * NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory, creating the message object
921 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred
923 * NOTMUCH_STATUS_UPGRADE_REQUIRED: The caller must upgrade the
924 * database to use this function.
927 notmuch_database_find_message_by_filename (notmuch_database_t *notmuch,
928 const char *filename,
929 notmuch_message_t **message);
932 * Return a list of all tags found in the database.
934 * This function creates a list of all tags found in the database. The
935 * resulting list contains all tags from all messages found in the database.
937 * On error this function returns NULL.
940 notmuch_database_get_all_tags (notmuch_database_t *db);
943 * Reopen an open notmuch database.
945 * @param [in] db open notmuch database
946 * @param [in] mode mode (read only or read-write) for reopened database.
948 * @retval #NOTMUCH_STATUS_SUCCESS
949 * @retval #NOTMUCH_STATUS_ILLEGAL_ARGUMENT The passed database was not open.
950 * @retval #NOTMUCH_STATUS_XAPIAN_EXCEPTION A Xapian exception occured
953 notmuch_database_reopen (notmuch_database_t *db, notmuch_database_mode_t mode);
956 * Create a new query for 'database'.
958 * Here, 'database' should be an open database, (see
959 * notmuch_database_open and notmuch_database_create).
961 * For the query string, we'll document the syntax here more
962 * completely in the future, but it's likely to be a specialized
963 * version of the general Xapian query syntax:
965 * https://xapian.org/docs/queryparser.html
967 * As a special case, passing either a length-zero string, (that is ""),
968 * or a string consisting of a single asterisk (that is "*"), will
969 * result in a query that returns all messages in the database.
971 * See notmuch_query_set_sort for controlling the order of results.
972 * See notmuch_query_search_messages and notmuch_query_search_threads
973 * to actually execute the query.
975 * User should call notmuch_query_destroy when finished with this
978 * Will return NULL if insufficient memory is available.
981 notmuch_query_create (notmuch_database_t *database,
982 const char *query_string);
985 NOTMUCH_QUERY_SYNTAX_XAPIAN,
986 NOTMUCH_QUERY_SYNTAX_SEXP
987 } notmuch_query_syntax_t;
990 notmuch_query_create_with_syntax (notmuch_database_t *database,
991 const char *query_string,
992 notmuch_query_syntax_t syntax,
993 notmuch_query_t **output);
995 * Sort values for notmuch_query_set_sort.
1001 NOTMUCH_SORT_OLDEST_FIRST,
1005 NOTMUCH_SORT_NEWEST_FIRST,
1007 * Sort by message-id.
1009 NOTMUCH_SORT_MESSAGE_ID,
1013 NOTMUCH_SORT_UNSORTED
1017 * Return the query_string of this query. See notmuch_query_create.
1020 notmuch_query_get_query_string (const notmuch_query_t *query);
1023 * Return the notmuch database of this query. See notmuch_query_create.
1025 notmuch_database_t *
1026 notmuch_query_get_database (const notmuch_query_t *query);
1029 * Exclude values for notmuch_query_set_omit_excluded. The strange
1030 * order is to maintain backward compatibility: the old FALSE/TRUE
1031 * options correspond to the new
1032 * NOTMUCH_EXCLUDE_FLAG/NOTMUCH_EXCLUDE_TRUE options.
1035 NOTMUCH_EXCLUDE_FLAG,
1036 NOTMUCH_EXCLUDE_TRUE,
1037 NOTMUCH_EXCLUDE_FALSE,
1039 } notmuch_exclude_t;
1042 * Specify whether to omit excluded results or simply flag them. By
1043 * default, this is set to TRUE.
1045 * If set to TRUE or ALL, notmuch_query_search_messages will omit excluded
1046 * messages from the results, and notmuch_query_search_threads will omit
1047 * threads that match only in excluded messages. If set to TRUE,
1048 * notmuch_query_search_threads will include all messages in threads that
1049 * match in at least one non-excluded message. Otherwise, if set to ALL,
1050 * notmuch_query_search_threads will omit excluded messages from all threads.
1052 * If set to FALSE or FLAG then both notmuch_query_search_messages and
1053 * notmuch_query_search_threads will return all matching
1054 * messages/threads regardless of exclude status. If set to FLAG then
1055 * the exclude flag will be set for any excluded message that is
1056 * returned by notmuch_query_search_messages, and the thread counts
1057 * for threads returned by notmuch_query_search_threads will be the
1058 * number of non-excluded messages/matches. Otherwise, if set to
1059 * FALSE, then the exclude status is completely ignored.
1061 * The performance difference when calling
1062 * notmuch_query_search_messages should be relatively small (and both
1063 * should be very fast). However, in some cases,
1064 * notmuch_query_search_threads is very much faster when omitting
1065 * excluded messages as it does not need to construct the threads that
1066 * only match in excluded messages.
1069 notmuch_query_set_omit_excluded (notmuch_query_t *query,
1070 notmuch_exclude_t omit_excluded);
1073 * Specify the sorting desired for this query.
1076 notmuch_query_set_sort (notmuch_query_t *query, notmuch_sort_t sort);
1079 * Return the sort specified for this query. See
1080 * notmuch_query_set_sort.
1083 notmuch_query_get_sort (const notmuch_query_t *query);
1086 * Add a tag that will be excluded from the query results by default.
1087 * This exclusion will be ignored if this tag appears explicitly in
1092 * NOTMUCH_STATUS_SUCCESS: excluded was added successfully.
1094 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: a Xapian exception occurred.
1095 * Most likely a problem lazily parsing the query string.
1097 * NOTMUCH_STATUS_IGNORED: tag is explicitly present in the query, so
1101 notmuch_query_add_tag_exclude (notmuch_query_t *query, const char *tag);
1104 * Execute a query for threads, returning a notmuch_threads_t object
1105 * which can be used to iterate over the results. The returned threads
1106 * object is owned by the query and as such, will only be valid until
1107 * notmuch_query_destroy.
1109 * Typical usage might be:
1111 * notmuch_query_t *query;
1112 * notmuch_threads_t *threads;
1113 * notmuch_thread_t *thread;
1114 * notmuch_status_t stat;
1116 * query = notmuch_query_create (database, query_string);
1118 * for (stat = notmuch_query_search_threads (query, &threads);
1119 * stat == NOTMUCH_STATUS_SUCCESS &&
1120 * notmuch_threads_valid (threads);
1121 * notmuch_threads_move_to_next (threads))
1123 * thread = notmuch_threads_get (threads);
1125 * notmuch_thread_destroy (thread);
1128 * notmuch_query_destroy (query);
1130 * Note: If you are finished with a thread before its containing
1131 * query, you can call notmuch_thread_destroy to clean up some memory
1132 * sooner (as in the above example). Otherwise, if your thread objects
1133 * are long-lived, then you don't need to call notmuch_thread_destroy
1134 * and all the memory will still be reclaimed when the query is
1137 * Note that there's no explicit destructor needed for the
1138 * notmuch_threads_t object. (For consistency, we do provide a
1139 * notmuch_threads_destroy function, but there's no good reason
1140 * to call it if the query is about to be destroyed).
1142 * @since libnotmuch 5.0 (notmuch 0.25)
1145 notmuch_query_search_threads (notmuch_query_t *query,
1146 notmuch_threads_t **out);
1149 * Deprecated alias for notmuch_query_search_threads.
1151 * @deprecated Deprecated as of libnotmuch 5 (notmuch 0.25). Please
1152 * use notmuch_query_search_threads instead.
1155 NOTMUCH_DEPRECATED (5, 0)
1157 notmuch_query_search_threads_st (notmuch_query_t *query, notmuch_threads_t **out);
1160 * Execute a query for messages, returning a notmuch_messages_t object
1161 * which can be used to iterate over the results. The returned
1162 * messages object is owned by the query and as such, will only be
1163 * valid until notmuch_query_destroy.
1165 * Typical usage might be:
1167 * notmuch_query_t *query;
1168 * notmuch_messages_t *messages;
1169 * notmuch_message_t *message;
1171 * query = notmuch_query_create (database, query_string);
1173 * for (messages = notmuch_query_search_messages (query);
1174 * notmuch_messages_valid (messages);
1175 * notmuch_messages_move_to_next (messages))
1177 * message = notmuch_messages_get (messages);
1179 * notmuch_message_destroy (message);
1182 * notmuch_query_destroy (query);
1184 * Note: If you are finished with a message before its containing
1185 * query, you can call notmuch_message_destroy to clean up some memory
1186 * sooner (as in the above example). Otherwise, if your message
1187 * objects are long-lived, then you don't need to call
1188 * notmuch_message_destroy and all the memory will still be reclaimed
1189 * when the query is destroyed.
1191 * Note that there's no explicit destructor needed for the
1192 * notmuch_messages_t object. (For consistency, we do provide a
1193 * notmuch_messages_destroy function, but there's no good
1194 * reason to call it if the query is about to be destroyed).
1196 * If a Xapian exception occurs this function will return NULL.
1198 * @since libnotmuch 5 (notmuch 0.25)
1201 notmuch_query_search_messages (notmuch_query_t *query,
1202 notmuch_messages_t **out);
1204 * Deprecated alias for notmuch_query_search_messages
1206 * @deprecated Deprecated as of libnotmuch 5 (notmuch 0.25). Please use
1207 * notmuch_query_search_messages instead.
1211 NOTMUCH_DEPRECATED (5, 0)
1213 notmuch_query_search_messages_st (notmuch_query_t *query,
1214 notmuch_messages_t **out);
1217 * Destroy a notmuch_query_t along with any associated resources.
1219 * This will in turn destroy any notmuch_threads_t and
1220 * notmuch_messages_t objects generated by this query, (and in
1221 * turn any notmuch_thread_t and notmuch_message_t objects generated
1222 * from those results, etc.), if such objects haven't already been
1226 notmuch_query_destroy (notmuch_query_t *query);
1229 * Is the given 'threads' iterator pointing at a valid thread.
1231 * When this function returns TRUE, notmuch_threads_get will return a
1232 * valid object. Whereas when this function returns FALSE,
1233 * notmuch_threads_get will return NULL.
1235 * If passed a NULL pointer, this function returns FALSE
1237 * See the documentation of notmuch_query_search_threads for example
1238 * code showing how to iterate over a notmuch_threads_t object.
1241 notmuch_threads_valid (notmuch_threads_t *threads);
1244 * Get the current thread from 'threads' as a notmuch_thread_t.
1246 * Note: The returned thread belongs to 'threads' and has a lifetime
1247 * identical to it (and the query to which it belongs).
1249 * See the documentation of notmuch_query_search_threads for example
1250 * code showing how to iterate over a notmuch_threads_t object.
1252 * If an out-of-memory situation occurs, this function will return
1256 notmuch_threads_get (notmuch_threads_t *threads);
1259 * Move the 'threads' iterator to the next thread.
1261 * If 'threads' is already pointing at the last thread then the
1262 * iterator will be moved to a point just beyond that last thread,
1263 * (where notmuch_threads_valid will return FALSE and
1264 * notmuch_threads_get will return NULL).
1266 * See the documentation of notmuch_query_search_threads for example
1267 * code showing how to iterate over a notmuch_threads_t object.
1270 notmuch_threads_move_to_next (notmuch_threads_t *threads);
1273 * Destroy a notmuch_threads_t object.
1275 * It's not strictly necessary to call this function. All memory from
1276 * the notmuch_threads_t object will be reclaimed when the
1277 * containing query object is destroyed.
1280 notmuch_threads_destroy (notmuch_threads_t *threads);
1283 * Return the number of messages matching a search.
1285 * This function performs a search and returns the number of matching
1290 * NOTMUCH_STATUS_SUCCESS: query completed successfully.
1292 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: a Xapian exception occurred. The
1293 * value of *count is not defined.
1295 * @since libnotmuch 5 (notmuch 0.25)
1298 notmuch_query_count_messages (notmuch_query_t *query, unsigned int *count);
1301 * Deprecated alias for notmuch_query_count_messages
1304 * @deprecated Deprecated since libnotmuch 5.0 (notmuch 0.25). Please
1305 * use notmuch_query_count_messages instead.
1307 NOTMUCH_DEPRECATED (5, 0)
1309 notmuch_query_count_messages_st (notmuch_query_t *query, unsigned int *count);
1312 * Return the number of threads matching a search.
1314 * This function performs a search and returns the number of unique thread IDs
1315 * in the matching messages. This is the same as number of threads matching a
1318 * Note that this is a significantly heavier operation than
1319 * notmuch_query_count_messages{_st}().
1323 * NOTMUCH_STATUS_OUT_OF_MEMORY: Memory allocation failed. The value
1324 * of *count is not defined
1326 * NOTMUCH_STATUS_SUCCESS: query completed successfully.
1328 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: a Xapian exception occurred. The
1329 * value of *count is not defined.
1331 * @since libnotmuch 5 (notmuch 0.25)
1334 notmuch_query_count_threads (notmuch_query_t *query, unsigned *count);
1337 * Deprecated alias for notmuch_query_count_threads
1339 * @deprecated Deprecated as of libnotmuch 5.0 (notmuch 0.25). Please
1340 * use notmuch_query_count_threads_st instead.
1342 NOTMUCH_DEPRECATED (5, 0)
1344 notmuch_query_count_threads_st (notmuch_query_t *query, unsigned *count);
1347 * Get the thread ID of 'thread'.
1349 * The returned string belongs to 'thread' and as such, should not be
1350 * modified by the caller and will only be valid for as long as the
1351 * thread is valid, (which is until notmuch_thread_destroy or until
1352 * the query from which it derived is destroyed).
1355 notmuch_thread_get_thread_id (notmuch_thread_t *thread);
1358 * Get the total number of messages in 'thread'.
1360 * This count consists of all messages in the database belonging to
1361 * this thread. Contrast with notmuch_thread_get_matched_messages() .
1364 notmuch_thread_get_total_messages (notmuch_thread_t *thread);
1367 * Get the total number of files in 'thread'.
1369 * This sums notmuch_message_count_files over all messages in the
1371 * @returns Non-negative integer
1372 * @since libnotmuch 5.0 (notmuch 0.25)
1376 notmuch_thread_get_total_files (notmuch_thread_t *thread);
1379 * Get a notmuch_messages_t iterator for the top-level messages in
1380 * 'thread' in oldest-first order.
1382 * This iterator will not necessarily iterate over all of the messages
1383 * in the thread. It will only iterate over the messages in the thread
1384 * which are not replies to other messages in the thread.
1386 * The returned list will be destroyed when the thread is destroyed.
1388 notmuch_messages_t *
1389 notmuch_thread_get_toplevel_messages (notmuch_thread_t *thread);
1392 * Get a notmuch_thread_t iterator for all messages in 'thread' in
1393 * oldest-first order.
1395 * The returned list will be destroyed when the thread is destroyed.
1397 notmuch_messages_t *
1398 notmuch_thread_get_messages (notmuch_thread_t *thread);
1401 * Get the number of messages in 'thread' that matched the search.
1403 * This count includes only the messages in this thread that were
1404 * matched by the search from which the thread was created and were
1405 * not excluded by any exclude tags passed in with the query (see
1406 * notmuch_query_add_tag_exclude). Contrast with
1407 * notmuch_thread_get_total_messages() .
1410 notmuch_thread_get_matched_messages (notmuch_thread_t *thread);
1413 * Get the authors of 'thread' as a UTF-8 string.
1415 * The returned string is a comma-separated list of the names of the
1416 * authors of mail messages in the query results that belong to this
1419 * The string contains authors of messages matching the query first, then
1420 * non-matched authors (with the two groups separated by '|'). Within
1421 * each group, authors are ordered by date.
1423 * The returned string belongs to 'thread' and as such, should not be
1424 * modified by the caller and will only be valid for as long as the
1425 * thread is valid, (which is until notmuch_thread_destroy or until
1426 * the query from which it derived is destroyed).
1429 notmuch_thread_get_authors (notmuch_thread_t *thread);
1432 * Get the subject of 'thread' as a UTF-8 string.
1434 * The subject is taken from the first message (according to the query
1435 * order---see notmuch_query_set_sort) in the query results that
1436 * belongs to this thread.
1438 * The returned string belongs to 'thread' and as such, should not be
1439 * modified by the caller and will only be valid for as long as the
1440 * thread is valid, (which is until notmuch_thread_destroy or until
1441 * the query from which it derived is destroyed).
1444 notmuch_thread_get_subject (notmuch_thread_t *thread);
1447 * Get the date of the oldest message in 'thread' as a time_t value.
1450 notmuch_thread_get_oldest_date (notmuch_thread_t *thread);
1453 * Get the date of the newest message in 'thread' as a time_t value.
1456 notmuch_thread_get_newest_date (notmuch_thread_t *thread);
1459 * Get the tags for 'thread', returning a notmuch_tags_t object which
1460 * can be used to iterate over all tags.
1462 * Note: In the Notmuch database, tags are stored on individual
1463 * messages, not on threads. So the tags returned here will be all
1464 * tags of the messages which matched the search and which belong to
1467 * The tags object is owned by the thread and as such, will only be
1468 * valid for as long as the thread is valid, (for example, until
1469 * notmuch_thread_destroy or until the query from which it derived is
1472 * Typical usage might be:
1474 * notmuch_thread_t *thread;
1475 * notmuch_tags_t *tags;
1478 * thread = notmuch_threads_get (threads);
1480 * for (tags = notmuch_thread_get_tags (thread);
1481 * notmuch_tags_valid (tags);
1482 * notmuch_tags_move_to_next (tags))
1484 * tag = notmuch_tags_get (tags);
1488 * notmuch_thread_destroy (thread);
1490 * Note that there's no explicit destructor needed for the
1491 * notmuch_tags_t object. (For consistency, we do provide a
1492 * notmuch_tags_destroy function, but there's no good reason to call
1493 * it if the message is about to be destroyed).
1496 notmuch_thread_get_tags (notmuch_thread_t *thread);
1499 * Destroy a notmuch_thread_t object.
1502 notmuch_thread_destroy (notmuch_thread_t *thread);
1505 * Is the given 'messages' iterator pointing at a valid message.
1507 * When this function returns TRUE, notmuch_messages_get will return a
1508 * valid object. Whereas when this function returns FALSE,
1509 * notmuch_messages_get will return NULL.
1511 * See the documentation of notmuch_query_search_messages for example
1512 * code showing how to iterate over a notmuch_messages_t object.
1515 notmuch_messages_valid (notmuch_messages_t *messages);
1518 * Get the current message from 'messages' as a notmuch_message_t.
1520 * Note: The returned message belongs to 'messages' and has a lifetime
1521 * identical to it (and the query to which it belongs).
1523 * See the documentation of notmuch_query_search_messages for example
1524 * code showing how to iterate over a notmuch_messages_t object.
1526 * If an out-of-memory situation occurs, this function will return
1530 notmuch_messages_get (notmuch_messages_t *messages);
1533 * Move the 'messages' iterator to the next message.
1535 * If 'messages' is already pointing at the last message then the
1536 * iterator will be moved to a point just beyond that last message,
1537 * (where notmuch_messages_valid will return FALSE and
1538 * notmuch_messages_get will return NULL).
1540 * See the documentation of notmuch_query_search_messages for example
1541 * code showing how to iterate over a notmuch_messages_t object.
1544 notmuch_messages_move_to_next (notmuch_messages_t *messages);
1547 * Destroy a notmuch_messages_t object.
1549 * It's not strictly necessary to call this function. All memory from
1550 * the notmuch_messages_t object will be reclaimed when the containing
1551 * query object is destroyed.
1554 notmuch_messages_destroy (notmuch_messages_t *messages);
1557 * Return a list of tags from all messages.
1559 * The resulting list is guaranteed not to contain duplicated tags.
1561 * WARNING: You can no longer iterate over messages after calling this
1562 * function, because the iterator will point at the end of the list.
1563 * We do not have a function to reset the iterator yet and the only
1564 * way how you can iterate over the list again is to recreate the
1567 * The function returns NULL on error.
1570 notmuch_messages_collect_tags (notmuch_messages_t *messages);
1573 * Get the database associated with this message.
1575 * @since libnotmuch 5.2 (notmuch 0.27)
1577 notmuch_database_t *
1578 notmuch_message_get_database (const notmuch_message_t *message);
1581 * Get the message ID of 'message'.
1583 * The returned string belongs to 'message' and as such, should not be
1584 * modified by the caller and will only be valid for as long as the
1585 * message is valid, (which is until the query from which it derived
1588 * This function will return NULL if triggers an unhandled Xapian
1592 notmuch_message_get_message_id (notmuch_message_t *message);
1595 * Get the thread ID of 'message'.
1597 * The returned string belongs to 'message' and as such, should not be
1598 * modified by the caller and will only be valid for as long as the
1599 * message is valid, (for example, until the user calls
1600 * notmuch_message_destroy on 'message' or until a query from which it
1601 * derived is destroyed).
1603 * This function will return NULL if triggers an unhandled Xapian
1607 notmuch_message_get_thread_id (notmuch_message_t *message);
1610 * Get a notmuch_messages_t iterator for all of the replies to
1613 * Note: This call only makes sense if 'message' was ultimately
1614 * obtained from a notmuch_thread_t object, (such as by coming
1615 * directly from the result of calling notmuch_thread_get_
1616 * toplevel_messages or by any number of subsequent
1617 * calls to notmuch_message_get_replies).
1619 * If 'message' was obtained through some non-thread means, (such as
1620 * by a call to notmuch_query_search_messages), then this function
1623 * If there are no replies to 'message', this function will return
1624 * NULL. (Note that notmuch_messages_valid will accept that NULL
1625 * value as legitimate, and simply return FALSE for it.)
1627 * This function also returns NULL if it triggers a Xapian exception.
1629 * The returned list will be destroyed when the thread is
1632 notmuch_messages_t *
1633 notmuch_message_get_replies (notmuch_message_t *message);
1636 * Get the total number of files associated with a message.
1637 * @returns Non-negative integer for file count.
1638 * @returns Negative integer for error.
1639 * @since libnotmuch 5.0 (notmuch 0.25)
1642 notmuch_message_count_files (notmuch_message_t *message);
1645 * Get a filename for the email corresponding to 'message'.
1647 * The returned filename is an absolute filename, (the initial
1648 * component will match notmuch_database_get_path() ).
1650 * The returned string belongs to the message so should not be
1651 * modified or freed by the caller (nor should it be referenced after
1652 * the message is destroyed).
1654 * Note: If this message corresponds to multiple files in the mail
1655 * store, (that is, multiple files contain identical message IDs),
1656 * this function will arbitrarily return a single one of those
1657 * filenames. See notmuch_message_get_filenames for returning the
1658 * complete list of filenames.
1660 * This function returns NULL if it triggers a Xapian exception.
1663 notmuch_message_get_filename (notmuch_message_t *message);
1666 * Get all filenames for the email corresponding to 'message'.
1668 * Returns a notmuch_filenames_t iterator listing all the filenames
1669 * associated with 'message'. These files may not have identical
1670 * content, but each will have the identical Message-ID.
1672 * Each filename in the iterator is an absolute filename, (the initial
1673 * component will match notmuch_database_get_path() ).
1675 * This function returns NULL if it triggers a Xapian exception.
1677 notmuch_filenames_t *
1678 notmuch_message_get_filenames (notmuch_message_t *message);
1681 * Re-index the e-mail corresponding to 'message' using the supplied index options
1683 * Returns the status of the re-index operation. (see the return
1684 * codes documented in notmuch_database_index_file)
1686 * After reindexing, the user should discard the message object passed
1687 * in here by calling notmuch_message_destroy, since it refers to the
1688 * original message, not to the reindexed message.
1691 notmuch_message_reindex (notmuch_message_t *message,
1692 notmuch_indexopts_t *indexopts);
1698 NOTMUCH_MESSAGE_FLAG_MATCH,
1699 NOTMUCH_MESSAGE_FLAG_EXCLUDED,
1701 /* This message is a "ghost message", meaning it has no filenames
1702 * or content, but we know it exists because it was referenced by
1703 * some other message. A ghost message has only a message ID and
1706 NOTMUCH_MESSAGE_FLAG_GHOST,
1707 } notmuch_message_flag_t;
1710 * Get a value of a flag for the email corresponding to 'message'.
1712 * returns FALSE in case of errors.
1714 * @deprecated Deprecated as of libnotmuch 5.3 (notmuch 0.31). Please
1715 * use notmuch_message_get_flag_st instead.
1717 NOTMUCH_DEPRECATED (5, 3)
1719 notmuch_message_get_flag (notmuch_message_t *message,
1720 notmuch_message_flag_t flag);
1723 * Get a value of a flag for the email corresponding to 'message'.
1725 * @param message a message object
1726 * @param flag flag to check
1727 * @param is_set pointer to boolean to store flag value.
1729 * @retval #NOTMUCH_STATUS_SUCCESS
1730 * @retval #NOTMUCH_STATUS_NULL_POINTER is_set is NULL
1731 * @retval #NOTMUCH_STATUS_XAPIAN_EXCEPTION Accessing the database
1732 * triggered an exception.
1734 * @since libnotmuch 5.3 (notmuch 0.31)
1737 notmuch_message_get_flag_st (notmuch_message_t *message,
1738 notmuch_message_flag_t flag,
1739 notmuch_bool_t *is_set);
1742 * Set a value of a flag for the email corresponding to 'message'.
1745 notmuch_message_set_flag (notmuch_message_t *message,
1746 notmuch_message_flag_t flag, notmuch_bool_t value);
1749 * Get the date of 'message' as a time_t value.
1751 * For the original textual representation of the Date header from the
1752 * message call notmuch_message_get_header() with a header value of
1755 * Returns 0 in case of error.
1758 notmuch_message_get_date (notmuch_message_t *message);
1761 * Get the value of the specified header from 'message' as a UTF-8 string.
1763 * Common headers are stored in the database when the message is
1764 * indexed and will be returned from the database. Other headers will
1765 * be read from the actual message file.
1767 * The header name is case insensitive.
1769 * The returned string belongs to the message so should not be
1770 * modified or freed by the caller (nor should it be referenced after
1771 * the message is destroyed).
1773 * Returns an empty string ("") if the message does not contain a
1774 * header line matching 'header'. Returns NULL if any error occurs.
1777 notmuch_message_get_header (notmuch_message_t *message, const char *header);
1780 * Get the tags for 'message', returning a notmuch_tags_t object which
1781 * can be used to iterate over all tags.
1783 * The tags object is owned by the message and as such, will only be
1784 * valid for as long as the message is valid, (which is until the
1785 * query from which it derived is destroyed).
1787 * Typical usage might be:
1789 * notmuch_message_t *message;
1790 * notmuch_tags_t *tags;
1793 * message = notmuch_database_find_message (database, message_id);
1795 * for (tags = notmuch_message_get_tags (message);
1796 * notmuch_tags_valid (tags);
1797 * notmuch_tags_move_to_next (tags))
1799 * tag = notmuch_tags_get (tags);
1803 * notmuch_message_destroy (message);
1805 * Note that there's no explicit destructor needed for the
1806 * notmuch_tags_t object. (For consistency, we do provide a
1807 * notmuch_tags_destroy function, but there's no good reason to call
1808 * it if the message is about to be destroyed).
1811 notmuch_message_get_tags (notmuch_message_t *message);
1814 * The longest possible tag value.
1816 #define NOTMUCH_TAG_MAX 200
1819 * Add a tag to the given message.
1823 * NOTMUCH_STATUS_SUCCESS: Tag successfully added to message
1825 * NOTMUCH_STATUS_NULL_POINTER: The 'tag' argument is NULL
1827 * NOTMUCH_STATUS_TAG_TOO_LONG: The length of 'tag' is too long
1828 * (exceeds NOTMUCH_TAG_MAX)
1830 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
1831 * mode so message cannot be modified.
1834 notmuch_message_add_tag (notmuch_message_t *message, const char *tag);
1837 * Remove a tag from the given message.
1841 * NOTMUCH_STATUS_SUCCESS: Tag successfully removed from message
1843 * NOTMUCH_STATUS_NULL_POINTER: The 'tag' argument is NULL
1845 * NOTMUCH_STATUS_TAG_TOO_LONG: The length of 'tag' is too long
1846 * (exceeds NOTMUCH_TAG_MAX)
1848 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
1849 * mode so message cannot be modified.
1852 notmuch_message_remove_tag (notmuch_message_t *message, const char *tag);
1855 * Remove all tags from the given message.
1857 * See notmuch_message_freeze for an example showing how to safely
1858 * replace tag values.
1860 * @retval #NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in
1861 * read-only mode so message cannot be modified.
1862 * @retval #NOTMUCH_STATUS_XAPIAN_EXCEPTION: an exception was thrown
1863 * accessing the database.
1866 notmuch_message_remove_all_tags (notmuch_message_t *message);
1869 * Add/remove tags according to maildir flags in the message filename(s).
1871 * This function examines the filenames of 'message' for maildir
1872 * flags, and adds or removes tags on 'message' as follows when these
1873 * flags are present:
1875 * Flag Action if present
1876 * ---- -----------------
1877 * 'D' Adds the "draft" tag to the message
1878 * 'F' Adds the "flagged" tag to the message
1879 * 'P' Adds the "passed" tag to the message
1880 * 'R' Adds the "replied" tag to the message
1881 * 'S' Removes the "unread" tag from the message
1883 * For each flag that is not present, the opposite action (add/remove)
1884 * is performed for the corresponding tags.
1886 * Flags are identified as trailing components of the filename after a
1887 * sequence of ":2,".
1889 * If there are multiple filenames associated with this message, the
1890 * flag is considered present if it appears in one or more
1891 * filenames. (That is, the flags from the multiple filenames are
1892 * combined with the logical OR operator.)
1894 * A client can ensure that notmuch database tags remain synchronized
1895 * with maildir flags by calling this function after each call to
1896 * notmuch_database_index_file. See also
1897 * notmuch_message_tags_to_maildir_flags for synchronizing tag changes
1898 * back to maildir flags.
1901 notmuch_message_maildir_flags_to_tags (notmuch_message_t *message);
1904 * return TRUE if any filename of 'message' has maildir flag 'flag',
1907 * Deprecated wrapper for notmuch_message_has_maildir_flag_st
1909 * @returns FALSE in case of error
1910 * @deprecated libnotmuch 5.3 (notmuch 0.31)
1912 NOTMUCH_DEPRECATED (5, 3)
1914 notmuch_message_has_maildir_flag (notmuch_message_t *message, char flag);
1917 * check message for maildir flag
1919 * @param [in,out] message message to check
1920 * @param [in] flag flag to check for
1921 * @param [out] is_set pointer to boolean
1923 * @retval #NOTMUCH_STATUS_SUCCESS
1924 * @retval #NOTMUCH_STATUS_NULL_POINTER is_set is NULL
1925 * @retval #NOTMUCH_STATUS_XAPIAN_EXCEPTION Accessing the database
1926 * triggered an exception.
1929 notmuch_message_has_maildir_flag_st (notmuch_message_t *message,
1931 notmuch_bool_t *is_set);
1934 * Rename message filename(s) to encode tags as maildir flags.
1936 * Specifically, for each filename corresponding to this message:
1938 * If the filename is not in a maildir directory, do nothing. (A
1939 * maildir directory is determined as a directory named "new" or
1940 * "cur".) Similarly, if the filename has invalid maildir info,
1941 * (repeated or outof-ASCII-order flag characters after ":2,"), then
1944 * If the filename is in a maildir directory, rename the file so that
1945 * its filename ends with the sequence ":2," followed by zero or more
1946 * of the following single-character flags (in ASCII order):
1948 * * flag 'D' iff the message has the "draft" tag
1949 * * flag 'F' iff the message has the "flagged" tag
1950 * * flag 'P' iff the message has the "passed" tag
1951 * * flag 'R' iff the message has the "replied" tag
1952 * * flag 'S' iff the message does not have the "unread" tag
1954 * Any existing flags unmentioned in the list above will be preserved
1957 * Also, if this filename is in a directory named "new", rename it to
1958 * be within the neighboring directory named "cur".
1960 * A client can ensure that maildir filename flags remain synchronized
1961 * with notmuch database tags by calling this function after changing
1962 * tags, (after calls to notmuch_message_add_tag,
1963 * notmuch_message_remove_tag, or notmuch_message_freeze/
1964 * notmuch_message_thaw). See also notmuch_message_maildir_flags_to_tags
1965 * for synchronizing maildir flag changes back to tags.
1968 notmuch_message_tags_to_maildir_flags (notmuch_message_t *message);
1971 * Freeze the current state of 'message' within the database.
1973 * This means that changes to the message state, (via
1974 * notmuch_message_add_tag, notmuch_message_remove_tag, and
1975 * notmuch_message_remove_all_tags), will not be committed to the
1976 * database until the message is thawed with notmuch_message_thaw.
1978 * Multiple calls to freeze/thaw are valid and these calls will
1979 * "stack". That is there must be as many calls to thaw as to freeze
1980 * before a message is actually thawed.
1982 * The ability to do freeze/thaw allows for safe transactions to
1983 * change tag values. For example, explicitly setting a message to
1984 * have a given set of tags might look like this:
1986 * notmuch_message_freeze (message);
1988 * notmuch_message_remove_all_tags (message);
1990 * for (i = 0; i < NUM_TAGS; i++)
1991 * notmuch_message_add_tag (message, tags[i]);
1993 * notmuch_message_thaw (message);
1995 * With freeze/thaw used like this, the message in the database is
1996 * guaranteed to have either the full set of original tag values, or
1997 * the full set of new tag values, but nothing in between.
1999 * Imagine the example above without freeze/thaw and the operation
2000 * somehow getting interrupted. This could result in the message being
2001 * left with no tags if the interruption happened after
2002 * notmuch_message_remove_all_tags but before notmuch_message_add_tag.
2006 * NOTMUCH_STATUS_SUCCESS: Message successfully frozen.
2008 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
2009 * mode so message cannot be modified.
2012 notmuch_message_freeze (notmuch_message_t *message);
2015 * Thaw the current 'message', synchronizing any changes that may have
2016 * occurred while 'message' was frozen into the notmuch database.
2018 * See notmuch_message_freeze for an example of how to use this
2019 * function to safely provide tag changes.
2021 * Multiple calls to freeze/thaw are valid and these calls with
2022 * "stack". That is there must be as many calls to thaw as to freeze
2023 * before a message is actually thawed.
2027 * NOTMUCH_STATUS_SUCCESS: Message successfully thawed, (or at least
2028 * its frozen count has successfully been reduced by 1).
2030 * NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW: An attempt was made to thaw
2031 * an unfrozen message. That is, there have been an unbalanced
2032 * number of calls to notmuch_message_freeze and
2033 * notmuch_message_thaw.
2036 notmuch_message_thaw (notmuch_message_t *message);
2039 * Destroy a notmuch_message_t object.
2041 * It can be useful to call this function in the case of a single
2042 * query object with many messages in the result, (such as iterating
2043 * over the entire database). Otherwise, it's fine to never call this
2044 * function and there will still be no memory leaks. (The memory from
2045 * the messages get reclaimed when the containing query is destroyed.)
2048 notmuch_message_destroy (notmuch_message_t *message);
2051 * @name Message Properties
2053 * This interface provides the ability to attach arbitrary (key,value)
2054 * string pairs to a message, to remove such pairs, and to iterate
2055 * over them. The caller should take some care as to what keys they
2056 * add or delete values for, as other subsystems or extensions may
2057 * depend on these properties.
2059 * Please see notmuch-properties(7) for more details about specific
2060 * properties and conventions around their use.
2065 * Retrieve the value for a single property key
2067 * *value* is set to a string owned by the message or NULL if there is
2068 * no such key. In the case of multiple values for the given key, the
2069 * first one is retrieved.
2072 * - NOTMUCH_STATUS_NULL_POINTER: *value* may not be NULL.
2073 * - NOTMUCH_STATUS_SUCCESS: No error occurred.
2074 * @since libnotmuch 4.4 (notmuch 0.23)
2077 notmuch_message_get_property (notmuch_message_t *message, const char *key, const char **value);
2080 * Add a (key,value) pair to a message
2083 * - NOTMUCH_STATUS_ILLEGAL_ARGUMENT: *key* may not contain an '=' character.
2084 * - NOTMUCH_STATUS_NULL_POINTER: Neither *key* nor *value* may be NULL.
2085 * - NOTMUCH_STATUS_SUCCESS: No error occurred.
2086 * @since libnotmuch 4.4 (notmuch 0.23)
2089 notmuch_message_add_property (notmuch_message_t *message, const char *key, const char *value);
2092 * Remove a (key,value) pair from a message.
2094 * It is not an error to remove a non-existent (key,value) pair
2097 * - NOTMUCH_STATUS_ILLEGAL_ARGUMENT: *key* may not contain an '=' character.
2098 * - NOTMUCH_STATUS_NULL_POINTER: Neither *key* nor *value* may be NULL.
2099 * - NOTMUCH_STATUS_SUCCESS: No error occurred.
2100 * @since libnotmuch 4.4 (notmuch 0.23)
2103 notmuch_message_remove_property (notmuch_message_t *message, const char *key, const char *value);
2106 * Remove all (key,value) pairs from the given message.
2108 * @param[in,out] message message to operate on.
2109 * @param[in] key key to delete properties for. If NULL, delete
2110 * properties for all keys
2112 * - NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in
2113 * read-only mode so message cannot be modified.
2114 * - NOTMUCH_STATUS_SUCCESS: No error occurred.
2116 * @since libnotmuch 4.4 (notmuch 0.23)
2119 notmuch_message_remove_all_properties (notmuch_message_t *message, const char *key);
2122 * Remove all (prefix*,value) pairs from the given message
2124 * @param[in,out] message message to operate on.
2125 * @param[in] prefix delete properties with keys that start with prefix.
2126 * If NULL, delete all properties
2128 * - NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in
2129 * read-only mode so message cannot be modified.
2130 * - NOTMUCH_STATUS_SUCCESS: No error occurred.
2132 * @since libnotmuch 5.1 (notmuch 0.26)
2135 notmuch_message_remove_all_properties_with_prefix (notmuch_message_t *message, const char *prefix);
2138 * Opaque message property iterator
2140 typedef struct _notmuch_string_map_iterator notmuch_message_properties_t;
2143 * Get the properties for *message*, returning a
2144 * notmuch_message_properties_t object which can be used to iterate
2145 * over all properties.
2147 * The notmuch_message_properties_t object is owned by the message and
2148 * as such, will only be valid for as long as the message is valid,
2149 * (which is until the query from which it derived is destroyed).
2151 * @param[in] message The message to examine
2152 * @param[in] key key or key prefix
2153 * @param[in] exact if TRUE, require exact match with key. Otherwise
2156 * Typical usage might be:
2158 * notmuch_message_properties_t *list;
2160 * for (list = notmuch_message_get_properties (message, "testkey1", TRUE);
2161 * notmuch_message_properties_valid (list); notmuch_message_properties_move_to_next (list)) {
2162 * printf("%s\n", notmuch_message_properties_value(list));
2165 * notmuch_message_properties_destroy (list);
2167 * Note that there's no explicit destructor needed for the
2168 * notmuch_message_properties_t object. (For consistency, we do
2169 * provide a notmuch_message_properities_destroy function, but there's
2170 * no good reason to call it if the message is about to be destroyed).
2172 * @since libnotmuch 4.4 (notmuch 0.23)
2174 notmuch_message_properties_t *
2175 notmuch_message_get_properties (notmuch_message_t *message, const char *key, notmuch_bool_t exact);
2178 * Return the number of properties named "key" belonging to the specific message.
2180 * @param[in] message The message to examine
2181 * @param[in] key key to count
2182 * @param[out] count The number of matching properties associated with this message.
2186 * NOTMUCH_STATUS_SUCCESS: successful count, possibly some other error.
2188 * @since libnotmuch 5.2 (notmuch 0.27)
2191 notmuch_message_count_properties (notmuch_message_t *message, const char *key, unsigned int *count);
2194 * Is the given *properties* iterator pointing at a valid (key,value)
2197 * When this function returns TRUE,
2198 * notmuch_message_properties_{key,value} will return a valid string,
2199 * and notmuch_message_properties_move_to_next will do what it
2200 * says. Whereas when this function returns FALSE, calling any of
2201 * these functions results in undefined behaviour.
2203 * See the documentation of notmuch_message_get_properties for example
2204 * code showing how to iterate over a notmuch_message_properties_t
2207 * @since libnotmuch 4.4 (notmuch 0.23)
2210 notmuch_message_properties_valid (notmuch_message_properties_t *properties);
2213 * Move the *properties* iterator to the next (key,value) pair
2215 * If *properties* is already pointing at the last pair then the iterator
2216 * will be moved to a point just beyond that last pair, (where
2217 * notmuch_message_properties_valid will return FALSE).
2219 * See the documentation of notmuch_message_get_properties for example
2220 * code showing how to iterate over a notmuch_message_properties_t object.
2222 * @since libnotmuch 4.4 (notmuch 0.23)
2225 notmuch_message_properties_move_to_next (notmuch_message_properties_t *properties);
2228 * Return the key from the current (key,value) pair.
2230 * this could be useful if iterating for a prefix
2232 * @since libnotmuch 4.4 (notmuch 0.23)
2235 notmuch_message_properties_key (notmuch_message_properties_t *properties);
2238 * Return the value from the current (key,value) pair.
2240 * This could be useful if iterating for a prefix.
2242 * @since libnotmuch 4.4 (notmuch 0.23)
2245 notmuch_message_properties_value (notmuch_message_properties_t *properties);
2249 * Destroy a notmuch_message_properties_t object.
2251 * It's not strictly necessary to call this function. All memory from
2252 * the notmuch_message_properties_t object will be reclaimed when the
2253 * containing message object is destroyed.
2255 * @since libnotmuch 4.4 (notmuch 0.23)
2258 notmuch_message_properties_destroy (notmuch_message_properties_t *properties);
2263 * Is the given 'tags' iterator pointing at a valid tag.
2265 * When this function returns TRUE, notmuch_tags_get will return a
2266 * valid string. Whereas when this function returns FALSE,
2267 * notmuch_tags_get will return NULL.
2269 * It is acceptable to pass NULL for 'tags', in which case this
2270 * function will always return FALSE.
2272 * See the documentation of notmuch_message_get_tags for example code
2273 * showing how to iterate over a notmuch_tags_t object.
2276 notmuch_tags_valid (notmuch_tags_t *tags);
2279 * Get the current tag from 'tags' as a string.
2281 * Note: The returned string belongs to 'tags' and has a lifetime
2282 * identical to it (and the query to which it ultimately belongs).
2284 * See the documentation of notmuch_message_get_tags for example code
2285 * showing how to iterate over a notmuch_tags_t object.
2288 notmuch_tags_get (notmuch_tags_t *tags);
2291 * Move the 'tags' iterator to the next tag.
2293 * If 'tags' is already pointing at the last tag then the iterator
2294 * will be moved to a point just beyond that last tag, (where
2295 * notmuch_tags_valid will return FALSE and notmuch_tags_get will
2298 * See the documentation of notmuch_message_get_tags for example code
2299 * showing how to iterate over a notmuch_tags_t object.
2302 notmuch_tags_move_to_next (notmuch_tags_t *tags);
2305 * Destroy a notmuch_tags_t object.
2307 * It's not strictly necessary to call this function. All memory from
2308 * the notmuch_tags_t object will be reclaimed when the containing
2309 * message or query objects are destroyed.
2312 notmuch_tags_destroy (notmuch_tags_t *tags);
2315 * Store an mtime within the database for 'directory'.
2317 * The 'directory' should be an object retrieved from the database
2318 * with notmuch_database_get_directory for a particular path.
2320 * The intention is for the caller to use the mtime to allow efficient
2321 * identification of new messages to be added to the database. The
2322 * recommended usage is as follows:
2324 * o Read the mtime of a directory from the filesystem
2326 * o Call index_file for all mail files in the directory
2328 * o Call notmuch_directory_set_mtime with the mtime read from the
2331 * Then, when wanting to check for updates to the directory in the
2332 * future, the client can call notmuch_directory_get_mtime and know
2333 * that it only needs to add files if the mtime of the directory and
2334 * files are newer than the stored timestamp.
2336 * Note: The notmuch_directory_get_mtime function does not allow the
2337 * caller to distinguish a timestamp of 0 from a non-existent
2338 * timestamp. So don't store a timestamp of 0 unless you are
2339 * comfortable with that.
2343 * NOTMUCH_STATUS_SUCCESS: mtime successfully stored in database.
2345 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception
2346 * occurred, mtime not stored.
2348 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
2349 * mode so directory mtime cannot be modified.
2352 notmuch_directory_set_mtime (notmuch_directory_t *directory,
2356 * Get the mtime of a directory, (as previously stored with
2357 * notmuch_directory_set_mtime).
2359 * Returns 0 if no mtime has previously been stored for this
2363 notmuch_directory_get_mtime (notmuch_directory_t *directory);
2366 * Get a notmuch_filenames_t iterator listing all the filenames of
2367 * messages in the database within the given directory.
2369 * The returned filenames will be the basename-entries only (not
2372 * Returns NULL if it triggers a Xapian exception
2374 notmuch_filenames_t *
2375 notmuch_directory_get_child_files (notmuch_directory_t *directory);
2378 * Get a notmuch_filenames_t iterator listing all the filenames of
2379 * sub-directories in the database within the given directory.
2381 * The returned filenames will be the basename-entries only (not
2384 * Returns NULL if it triggers a Xapian exception
2386 notmuch_filenames_t *
2387 notmuch_directory_get_child_directories (notmuch_directory_t *directory);
2390 * Delete directory document from the database, and destroy the
2391 * notmuch_directory_t object. Assumes any child directories and files
2392 * have been deleted by the caller.
2394 * @since libnotmuch 4.3 (notmuch 0.21)
2397 notmuch_directory_delete (notmuch_directory_t *directory);
2400 * Destroy a notmuch_directory_t object.
2403 notmuch_directory_destroy (notmuch_directory_t *directory);
2406 * Is the given 'filenames' iterator pointing at a valid filename.
2408 * When this function returns TRUE, notmuch_filenames_get will return
2409 * a valid string. Whereas when this function returns FALSE,
2410 * notmuch_filenames_get will return NULL.
2412 * It is acceptable to pass NULL for 'filenames', in which case this
2413 * function will always return FALSE.
2416 notmuch_filenames_valid (notmuch_filenames_t *filenames);
2419 * Get the current filename from 'filenames' as a string.
2421 * Note: The returned string belongs to 'filenames' and has a lifetime
2422 * identical to it (and the directory to which it ultimately belongs).
2424 * It is acceptable to pass NULL for 'filenames', in which case this
2425 * function will always return NULL.
2428 notmuch_filenames_get (notmuch_filenames_t *filenames);
2431 * Move the 'filenames' iterator to the next filename.
2433 * If 'filenames' is already pointing at the last filename then the
2434 * iterator will be moved to a point just beyond that last filename,
2435 * (where notmuch_filenames_valid will return FALSE and
2436 * notmuch_filenames_get will return NULL).
2438 * It is acceptable to pass NULL for 'filenames', in which case this
2439 * function will do nothing.
2442 notmuch_filenames_move_to_next (notmuch_filenames_t *filenames);
2445 * Destroy a notmuch_filenames_t object.
2447 * It's not strictly necessary to call this function. All memory from
2448 * the notmuch_filenames_t object will be reclaimed when the
2449 * containing directory object is destroyed.
2451 * It is acceptable to pass NULL for 'filenames', in which case this
2452 * function will do nothing.
2455 notmuch_filenames_destroy (notmuch_filenames_t *filenames);
2459 * set config 'key' to 'value'
2461 * @since libnotmuch 4.4 (notmuch 0.23)
2462 * @retval #NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in
2463 * read-only mode so message cannot be modified.
2464 * @retval #NOTMUCH_STATUS_XAPIAN_EXCEPTION: an exception was thrown
2465 * accessing the database.
2466 * @retval #NOTMUCH_STATUS_SUCCESS
2469 notmuch_database_set_config (notmuch_database_t *db, const char *key, const char *value);
2472 * retrieve config item 'key', assign to 'value'
2474 * keys which have not been previously set with n_d_set_config will
2475 * return an empty string.
2477 * return value is allocated by malloc and should be freed by the
2480 * @since libnotmuch 4.4 (notmuch 0.23)
2484 notmuch_database_get_config (notmuch_database_t *db, const char *key, char **value);
2487 * Create an iterator for all config items with keys matching a given prefix
2489 * @since libnotmuch 4.4 (notmuch 0.23)
2492 notmuch_database_get_config_list (notmuch_database_t *db, const char *prefix,
2493 notmuch_config_list_t **out);
2496 * Is 'config_list' iterator valid (i.e. _key, _value, _move_to_next can be called).
2498 * @since libnotmuch 4.4 (notmuch 0.23)
2501 notmuch_config_list_valid (notmuch_config_list_t *config_list);
2504 * return key for current config pair
2506 * return value is owned by the iterator, and will be destroyed by the
2507 * next call to notmuch_config_list_key or notmuch_config_list_destroy.
2509 * @since libnotmuch 4.4 (notmuch 0.23)
2512 notmuch_config_list_key (notmuch_config_list_t *config_list);
2515 * return 'value' for current config pair
2517 * return value is owned by the iterator, and will be destroyed by the
2518 * next call to notmuch_config_list_value or notmuch config_list_destroy
2520 * @since libnotmuch 4.4 (notmuch 0.23)
2521 * @retval NULL for errors
2524 notmuch_config_list_value (notmuch_config_list_t *config_list);
2528 * move 'config_list' iterator to the next pair
2530 * @since libnotmuch 4.4 (notmuch 0.23)
2533 notmuch_config_list_move_to_next (notmuch_config_list_t *config_list);
2536 * free any resources held by 'config_list'
2538 * @since libnotmuch 4.4 (notmuch 0.23)
2541 notmuch_config_list_destroy (notmuch_config_list_t *config_list);
2544 * Configuration keys known to libnotmuch
2547 NOTMUCH_CONFIG_FIRST,
2548 NOTMUCH_CONFIG_DATABASE_PATH = NOTMUCH_CONFIG_FIRST,
2549 NOTMUCH_CONFIG_MAIL_ROOT,
2550 NOTMUCH_CONFIG_HOOK_DIR,
2551 NOTMUCH_CONFIG_BACKUP_DIR,
2552 NOTMUCH_CONFIG_EXCLUDE_TAGS,
2553 NOTMUCH_CONFIG_NEW_TAGS,
2554 NOTMUCH_CONFIG_NEW_IGNORE,
2555 NOTMUCH_CONFIG_SYNC_MAILDIR_FLAGS,
2556 NOTMUCH_CONFIG_PRIMARY_EMAIL,
2557 NOTMUCH_CONFIG_OTHER_EMAIL,
2558 NOTMUCH_CONFIG_USER_NAME,
2559 NOTMUCH_CONFIG_AUTOCOMMIT,
2560 NOTMUCH_CONFIG_EXTRA_HEADERS,
2562 } notmuch_config_key_t;
2565 * get a configuration value from an open database.
2567 * This value reflects all configuration information given at the time
2568 * the database was opened.
2570 * @param[in] notmuch database
2571 * @param[in] key configuration key
2573 * @since libnotmuch 5.4 (notmuch 0.32)
2575 * @retval NULL if 'key' unknown or if no value is known for
2576 * 'key'. Otherwise returns a string owned by notmuch which should
2577 * not be modified nor freed by the caller.
2580 notmuch_config_get (notmuch_database_t *notmuch, notmuch_config_key_t key);
2583 * set a configuration value from in an open database.
2585 * This value reflects all configuration information given at the time
2586 * the database was opened.
2588 * @param[in,out] notmuch database open read/write
2589 * @param[in] key configuration key
2590 * @param[in] val configuration value
2592 * @since libnotmuch 5.4 (notmuch 0.32)
2594 * @retval returns any return value for notmuch_database_set_config.
2597 notmuch_config_set (notmuch_database_t *notmuch, notmuch_config_key_t key, const char *val);
2600 * Returns an iterator for a ';'-delimited list of configuration values
2602 * These values reflect all configuration information given at the
2603 * time the database was opened.
2605 * @param[in] notmuch database
2606 * @param[in] key configuration key
2608 * @since libnotmuch 5.4 (notmuch 0.32)
2610 * @retval NULL in case of error.
2612 notmuch_config_values_t *
2613 notmuch_config_get_values (notmuch_database_t *notmuch, notmuch_config_key_t key);
2616 * Returns an iterator for a ';'-delimited list of configuration values
2618 * These values reflect all configuration information given at the
2619 * time the database was opened.
2621 * @param[in] notmuch database
2622 * @param[in] key configuration key
2624 * @since libnotmuch 5.4 (notmuch 0.32)
2626 * @retval NULL in case of error.
2628 notmuch_config_values_t *
2629 notmuch_config_get_values_string (notmuch_database_t *notmuch, const char *key);
2632 * Is the given 'config_values' iterator pointing at a valid element.
2634 * @param[in] values iterator
2636 * @since libnotmuch 5.4 (notmuch 0.32)
2638 * @retval FALSE if passed a NULL pointer, or the iterator is exhausted.
2642 notmuch_config_values_valid (notmuch_config_values_t *values);
2645 * Get the current value from the 'values' iterator
2647 * @param[in] values iterator
2649 * @since libnotmuch 5.4 (notmuch 0.32)
2651 * @retval a string with the same lifetime as the iterator
2654 notmuch_config_values_get (notmuch_config_values_t *values);
2657 * Move the 'values' iterator to the next element
2659 * @param[in,out] values iterator
2661 * @since libnotmuch 5.4 (notmuch 0.32)
2665 notmuch_config_values_move_to_next (notmuch_config_values_t *values);
2669 * reset the 'values' iterator to the first element
2671 * @param[in,out] values iterator. A NULL value is ignored.
2673 * @since libnotmuch 5.4 (notmuch 0.32)
2677 notmuch_config_values_start (notmuch_config_values_t *values);
2680 * Destroy a config values iterator, along with any associated
2683 * @param[in,out] values iterator
2685 * @since libnotmuch 5.4 (notmuch 0.32)
2688 notmuch_config_values_destroy (notmuch_config_values_t *values);
2692 * Returns an iterator for a (key, value) configuration pairs
2694 * @param[in] notmuch database
2695 * @param[in] prefix prefix for keys. Pass "" for all keys.
2697 * @since libnotmuch 5.4 (notmuch 0.32)
2699 * @retval NULL in case of error.
2701 notmuch_config_pairs_t *
2702 notmuch_config_get_pairs (notmuch_database_t *notmuch,
2703 const char *prefix);
2706 * Is the given 'config_pairs' iterator pointing at a valid element.
2708 * @param[in] pairs iterator
2710 * @since libnotmuch 5.4 (notmuch 0.32)
2712 * @retval FALSE if passed a NULL pointer, or the iterator is exhausted.
2716 notmuch_config_pairs_valid (notmuch_config_pairs_t *pairs);
2719 * Move the 'config_pairs' iterator to the next element
2721 * @param[in,out] pairs iterator
2723 * @since libnotmuch 5.4 (notmuch 0.32)
2727 notmuch_config_pairs_move_to_next (notmuch_config_pairs_t *pairs);
2730 * Get the current key from the 'config_pairs' iterator
2732 * @param[in] pairs iterator
2734 * @since libnotmuch 5.4 (notmuch 0.32)
2736 * @retval a string with the same lifetime as the iterator
2739 notmuch_config_pairs_key (notmuch_config_pairs_t *pairs);
2742 * Get the current value from the 'config_pairs' iterator
2744 * @param[in] pairs iterator
2746 * @since libnotmuch 5.4 (notmuch 0.32)
2748 * @retval a string with the same lifetime as the iterator
2751 notmuch_config_pairs_value (notmuch_config_pairs_t *pairs);
2754 * Destroy a config_pairs iterator, along with any associated
2757 * @param[in,out] pairs iterator
2759 * @since libnotmuch 5.4 (notmuch 0.32)
2762 notmuch_config_pairs_destroy (notmuch_config_pairs_t *pairs);
2765 * get a configuration value from an open database as Boolean
2767 * This value reflects all configuration information given at the time
2768 * the database was opened.
2770 * @param[in] notmuch database
2771 * @param[in] key configuration key
2772 * @param[out] val configuration value, converted to Boolean
2774 * @since libnotmuch 5.4 (notmuch 0.32)
2776 * @retval #NOTMUCH_STATUS_ILLEGAL_ARGUMENT if either key is unknown
2777 * or the corresponding value does not convert to Boolean.
2780 notmuch_config_get_bool (notmuch_database_t *notmuch,
2781 notmuch_config_key_t key,
2782 notmuch_bool_t *val);
2785 * return the path of the config file loaded, if any
2787 * @retval NULL if no config file was loaded
2790 notmuch_config_path (notmuch_database_t *notmuch);
2793 * get the current default indexing options for a given database.
2795 * This object will survive until the database itself is destroyed,
2796 * but the caller may also release it earlier with
2797 * notmuch_indexopts_destroy.
2799 * This object represents a set of options on how a message can be
2800 * added to the index. At the moment it is a featureless stub.
2802 * @since libnotmuch 5.1 (notmuch 0.26)
2803 * @retval NULL in case of error
2805 notmuch_indexopts_t *
2806 notmuch_database_get_default_indexopts (notmuch_database_t *db);
2809 * Stating a policy about how to decrypt messages.
2811 * See index.decrypt in notmuch-config(1) for more details.
2814 NOTMUCH_DECRYPT_FALSE,
2815 NOTMUCH_DECRYPT_TRUE,
2816 NOTMUCH_DECRYPT_AUTO,
2817 NOTMUCH_DECRYPT_NOSTASH,
2818 } notmuch_decryption_policy_t;
2821 * Specify whether to decrypt encrypted parts while indexing.
2823 * Be aware that the index is likely sufficient to reconstruct the
2824 * cleartext of the message itself, so please ensure that the notmuch
2825 * message index is adequately protected. DO NOT SET THIS FLAG TO TRUE
2826 * without considering the security of your index.
2828 * @since libnotmuch 5.1 (notmuch 0.26)
2831 notmuch_indexopts_set_decrypt_policy (notmuch_indexopts_t *indexopts,
2832 notmuch_decryption_policy_t decrypt_policy);
2835 * Return whether to decrypt encrypted parts while indexing.
2836 * see notmuch_indexopts_set_decrypt_policy.
2838 * @since libnotmuch 5.1 (notmuch 0.26)
2840 notmuch_decryption_policy_t
2841 notmuch_indexopts_get_decrypt_policy (const notmuch_indexopts_t *indexopts);
2844 * Destroy a notmuch_indexopts_t object.
2846 * @since libnotmuch 5.1 (notmuch 0.26)
2849 notmuch_indexopts_destroy (notmuch_indexopts_t *options);
2853 * interrogate the library for compile time features
2855 * @since libnotmuch 4.4 (notmuch 0.23)
2858 notmuch_built_with (const char *name);
2861 #pragma GCC visibility pop