1 /* notmuch - Not much of an email library, (just index and search)
3 * Copyright © 2009 Carl Worth
5 * This program is free software: you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation, either version 3 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program. If not, see https://www.gnu.org/licenses/ .
18 * Author: Carl Worth <cworth@cworth.org>
22 * @defgroup notmuch The notmuch API
24 * Not much of an email library, (just index and search)
35 # define NOTMUCH_BEGIN_DECLS extern "C" {
36 # define NOTMUCH_END_DECLS }
38 # define NOTMUCH_BEGIN_DECLS
39 # define NOTMUCH_END_DECLS
46 #pragma GCC visibility push(default)
57 * The library version number. This must agree with the soname
58 * version in Makefile.local.
60 #define LIBNOTMUCH_MAJOR_VERSION 5
61 #define LIBNOTMUCH_MINOR_VERSION 3
62 #define LIBNOTMUCH_MICRO_VERSION 0
65 #if defined (__clang_major__) && __clang_major__ >= 3 \
66 || defined (__GNUC__) && __GNUC__ >= 5 \
67 || defined (__GNUC__) && __GNUC__ == 4 && __GNUC_MINOR__ >= 5
68 #define NOTMUCH_DEPRECATED(major, minor) \
69 __attribute__ ((deprecated ("function deprecated as of libnotmuch " #major "." #minor)))
71 #define NOTMUCH_DEPRECATED(major, minor) __attribute__ ((deprecated))
75 #endif /* __DOXYGEN__ */
78 * Check the version of the notmuch library being compiled against.
80 * Return true if the library being compiled against is of the
81 * specified version or above. For example:
84 * #if LIBNOTMUCH_CHECK_VERSION(3, 1, 0)
85 * (code requiring libnotmuch 3.1.0 or above)
89 * LIBNOTMUCH_CHECK_VERSION has been defined since version 3.1.0; to
90 * check for versions prior to that, use:
93 * #if !defined(NOTMUCH_CHECK_VERSION)
94 * (code requiring libnotmuch prior to 3.1.0)
98 #define LIBNOTMUCH_CHECK_VERSION(major, minor, micro) \
99 (LIBNOTMUCH_MAJOR_VERSION > (major) || \
100 (LIBNOTMUCH_MAJOR_VERSION == (major) && LIBNOTMUCH_MINOR_VERSION > (minor)) || \
101 (LIBNOTMUCH_MAJOR_VERSION == (major) && LIBNOTMUCH_MINOR_VERSION == (minor) && \
102 LIBNOTMUCH_MICRO_VERSION >= (micro)))
105 * Notmuch boolean type.
107 typedef int notmuch_bool_t;
110 * Status codes used for the return values of most functions.
112 * A zero value (NOTMUCH_STATUS_SUCCESS) indicates that the function
113 * completed without error. Any other value indicates an error.
115 typedef enum _notmuch_status {
119 NOTMUCH_STATUS_SUCCESS = 0,
123 NOTMUCH_STATUS_OUT_OF_MEMORY,
125 * An attempt was made to write to a database opened in read-only
128 NOTMUCH_STATUS_READ_ONLY_DATABASE,
130 * A Xapian exception occurred.
132 * @todo We don't really want to expose this lame XAPIAN_EXCEPTION
133 * value. Instead we should map to things like DATABASE_LOCKED or
136 NOTMUCH_STATUS_XAPIAN_EXCEPTION,
138 * An error occurred trying to read or write to a file (this could
139 * be file not found, permission denied, etc.)
141 NOTMUCH_STATUS_FILE_ERROR,
143 * A file was presented that doesn't appear to be an email
146 NOTMUCH_STATUS_FILE_NOT_EMAIL,
148 * A file contains a message ID that is identical to a message
149 * already in the database.
151 NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID,
153 * The user erroneously passed a NULL pointer to a notmuch
156 NOTMUCH_STATUS_NULL_POINTER,
158 * A tag value is too long (exceeds NOTMUCH_TAG_MAX).
160 NOTMUCH_STATUS_TAG_TOO_LONG,
162 * The notmuch_message_thaw function has been called more times
163 * than notmuch_message_freeze.
165 NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW,
167 * notmuch_database_end_atomic has been called more times than
168 * notmuch_database_begin_atomic.
170 NOTMUCH_STATUS_UNBALANCED_ATOMIC,
172 * The operation is not supported.
174 NOTMUCH_STATUS_UNSUPPORTED_OPERATION,
176 * The operation requires a database upgrade.
178 NOTMUCH_STATUS_UPGRADE_REQUIRED,
180 * There is a problem with the proposed path, e.g. a relative path
181 * passed to a function expecting an absolute path.
183 NOTMUCH_STATUS_PATH_ERROR,
185 * The requested operation was ignored. Depending on the function,
186 * this may not be an actual error.
188 NOTMUCH_STATUS_IGNORED,
190 * One of the arguments violates the preconditions for the
191 * function, in a way not covered by a more specific argument.
193 NOTMUCH_STATUS_ILLEGAL_ARGUMENT,
195 * A MIME object claimed to have cryptographic protection which
196 * notmuch tried to handle, but the protocol was not specified in
197 * an intelligible way.
199 NOTMUCH_STATUS_MALFORMED_CRYPTO_PROTOCOL,
201 * Notmuch attempted to do crypto processing, but could not
202 * initialize the engine needed to do so.
204 NOTMUCH_STATUS_FAILED_CRYPTO_CONTEXT_CREATION,
206 * A MIME object claimed to have cryptographic protection, and
207 * notmuch attempted to process it, but the specific protocol was
208 * something that notmuch doesn't know how to handle.
210 NOTMUCH_STATUS_UNKNOWN_CRYPTO_PROTOCOL,
212 * Unable to load a config file
214 NOTMUCH_STATUS_NO_CONFIG,
216 * Database exists, so not (re)-created
218 NOTMUCH_STATUS_DATABASE_EXISTS,
220 * Not an actual status value. Just a way to find out how many
221 * valid status values there are.
223 NOTMUCH_STATUS_LAST_STATUS
227 * Get a string representation of a notmuch_status_t value.
229 * The result is read-only.
232 notmuch_status_to_string (notmuch_status_t status);
234 /* Various opaque data types. For each notmuch_<foo>_t see the various
235 * notmuch_<foo> functions below. */
237 typedef struct _notmuch_database notmuch_database_t;
238 typedef struct _notmuch_query notmuch_query_t;
239 typedef struct _notmuch_threads notmuch_threads_t;
240 typedef struct _notmuch_thread notmuch_thread_t;
241 typedef struct _notmuch_messages notmuch_messages_t;
242 typedef struct _notmuch_message notmuch_message_t;
243 typedef struct _notmuch_tags notmuch_tags_t;
244 typedef struct _notmuch_directory notmuch_directory_t;
245 typedef struct _notmuch_filenames notmuch_filenames_t;
246 typedef struct _notmuch_config_list notmuch_config_list_t;
247 typedef struct _notmuch_config_values notmuch_config_values_t;
248 typedef struct _notmuch_config_pairs notmuch_config_pairs_t;
249 typedef struct _notmuch_indexopts notmuch_indexopts_t;
250 #endif /* __DOXYGEN__ */
253 * Create a new, empty notmuch database located at 'path'.
255 * The path should be a top-level directory to a collection of
256 * plain-text email messages (one message per file). This call will
257 * create a new ".notmuch" directory within 'path' where notmuch will
260 * After a successful call to notmuch_database_create, the returned
261 * database will be open so the caller should call
262 * notmuch_database_destroy when finished with it.
264 * The database will not yet have any data in it
265 * (notmuch_database_create itself is a very cheap function). Messages
266 * contained within 'path' can be added to the database by calling
267 * notmuch_database_index_file.
269 * In case of any failure, this function returns an error status and
270 * sets *database to NULL (after printing an error message on stderr).
274 * NOTMUCH_STATUS_SUCCESS: Successfully created the database.
276 * NOTMUCH_STATUS_NULL_POINTER: The given 'path' argument is NULL.
278 * NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory.
280 * NOTMUCH_STATUS_FILE_ERROR: An error occurred trying to create the
281 * database file (such as permission denied, or file not found,
282 * etc.), or the database already exists.
284 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred.
287 notmuch_database_create (const char *path, notmuch_database_t **database);
290 * Like notmuch_database_create, except optionally return an error
291 * message. This message is allocated by malloc and should be freed by
295 notmuch_database_create_verbose (const char *path,
296 notmuch_database_t **database,
297 char **error_message);
300 * Database open mode for notmuch_database_open.
304 * Open database for reading only.
306 NOTMUCH_DATABASE_MODE_READ_ONLY = 0,
308 * Open database for reading and writing.
310 NOTMUCH_DATABASE_MODE_READ_WRITE
311 } notmuch_database_mode_t;
314 * Deprecated alias for notmuch_database_open_with_config with
315 * config_path=error_message=NULL
316 * @deprecated Deprecated as of libnotmuch 5.4 (notmuch 0.32)
318 /* NOTMUCH_DEPRECATED(5, 4) */
320 notmuch_database_open (const char *path,
321 notmuch_database_mode_t mode,
322 notmuch_database_t **database);
324 * Deprecated alias for notmuch_database_open_with_config with
327 * @deprecated Deprecated as of libnotmuch 5.4 (notmuch 0.32)
330 /* NOTMUCH_DEPRECATED(5, 4) */
332 notmuch_database_open_verbose (const char *path,
333 notmuch_database_mode_t mode,
334 notmuch_database_t **database,
335 char **error_message);
338 * Open an existing notmuch database located at 'database_path', using
339 * configuration in 'config_path'.
341 * @param[in] database_path
343 * Path to existing database.
345 * A notmuch database is a Xapian database containing appropriate
348 * The database should have been created at some time in the past,
349 * (not necessarily by this process), by calling
350 * notmuch_database_create.
352 * If 'database_path' is NULL, use the location specified
354 * - in the environment variable NOTMUCH_DATABASE, if non-empty
356 * - in a configuration file, located as described under 'config_path'
358 * - by $XDG_DATA_HOME/notmuch/$PROFILE where XDG_DATA_HOME defaults
359 * to "$HOME/.local/share" and PROFILE as as discussed in
362 * If 'database_path' is non-NULL, but does not appear to be a Xapian
363 * database, check for a directory '.notmuch/xapian' below
364 * 'database_path' (this is the behavior of
365 * notmuch_database_open_verbose pre-0.32).
370 * Mode to open database. Use one of #NOTMUCH_DATABASE_MODE_READ_WRITE
371 * or #NOTMUCH_DATABASE_MODE_READ_ONLY
374 * @param[in] config_path
376 * Path to config file.
378 * Config file is key-value, with mandatory sections. See
379 * <em>notmuch-config(5)</em> for more information. The key-value pair
380 * overrides the corresponding configuration data stored in the
381 * database (see <em>notmuch_database_get_config</em>)
383 * If <em>config_path</em> is NULL use the path specified
385 * - in environment variable <em>NOTMUCH_CONFIG</em>, if non-empty
387 * - by <em>XDG_CONFIG_HOME</em>/notmuch/ where
388 * XDG_CONFIG_HOME defaults to "$HOME/.config".
390 * - by $HOME/.notmuch-config
392 * If <em>config_path</em> is "" (empty string) then do not
393 * open any configuration file.
395 * @param[in] profile:
397 * Name of profile (configuration/database variant).
399 * If non-NULL, append to the directory / file path determined for
400 * <em>config_path</em> and <em>database_path</em>.
403 * - environment variable NOTMUCH_PROFILE if defined,
404 * - otherwise "default" for directories and "" (empty string) for paths.
407 * @param[out] database
409 * Pointer to database object. May not be NULL.
411 * The caller should call notmuch_database_destroy when finished with
414 * In case of any failure, this function returns an error status and
415 * sets *database to NULL.
418 * @param[out] error_message
419 * If non-NULL, store error message from opening the database.
420 * Any such message is allocated by \a malloc(3) and should be freed
423 * @retval NOTMUCH_STATUS_SUCCESS: Successfully opened the database.
425 * @retval NOTMUCH_STATUS_NULL_POINTER: The given \a database
428 * @retval NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory.
430 * @retval NOTMUCH_STATUS_FILE_ERROR: An error occurred trying to open the
431 * database or config file (such as permission denied, or file not found,
432 * etc.), or the database version is unknown.
434 * @retval NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred.
436 * @since libnotmuch 5.4 (notmuch 0.32)
440 notmuch_database_open_with_config (const char *database_path,
441 notmuch_database_mode_t mode,
442 const char *config_path,
444 notmuch_database_t **database,
445 char **error_message);
449 * Loads configuration from config file, database, and/or defaults
451 * For description of arguments, @see notmuch_database_open_with_config
453 * @retval NOTMUCH_STATUS_SUCCESS: Successfully loaded (some) configuration.
455 * @retval NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory.
457 * @retval NOTMUCH_STATUS_FILE_ERROR: An error occurred trying to open the
458 * database or config file (such as permission denied, or file not found,
461 * @retval NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred.
463 * @since libnotmuch 5.4 (notmuch 0.32)
467 notmuch_database_load_config (const char *database_path,
468 const char *config_path,
470 notmuch_database_t **database,
471 char **error_message);
474 * Create a new notmuch database located at 'database_path', using
475 * configuration in 'config_path'.
477 * For description of arguments, @see notmuch_database_open_with_config
479 * @retval NOTMUCH_STATUS_SUCCESS: Successfully created the database.
481 * @retval NOTMUCH_STATUS_DATABASE_EXISTS: Database already exists, not created
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_create_with_config (const char *database_path,
496 const char *config_path,
498 notmuch_database_t **database,
499 char **error_message);
502 * Retrieve last status string for given database.
506 notmuch_database_status_string (const notmuch_database_t *notmuch);
509 * Commit changes and close the given notmuch database.
511 * After notmuch_database_close has been called, calls to other
512 * functions on objects derived from this database may either behave
513 * as if the database had not been closed (e.g., if the required data
514 * has been cached) or may fail with a
515 * NOTMUCH_STATUS_XAPIAN_EXCEPTION. The only further operation
516 * permitted on the database itself is to call
517 * notmuch_database_destroy.
519 * notmuch_database_close can be called multiple times. Later calls
522 * For writable databases, notmuch_database_close commits all changes
523 * to disk before closing the database. If the caller is currently in
524 * an atomic section (there was a notmuch_database_begin_atomic
525 * without a matching notmuch_database_end_atomic), this will discard
526 * changes made in that atomic section (but still commit changes made
527 * prior to entering the atomic section).
531 * NOTMUCH_STATUS_SUCCESS: Successfully closed the database.
533 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred; the
534 * database has been closed but there are no guarantees the
535 * changes to the database, if any, have been flushed to disk.
538 notmuch_database_close (notmuch_database_t *database);
541 * A callback invoked by notmuch_database_compact to notify the user
542 * of the progress of the compaction process.
544 typedef void (*notmuch_compact_status_cb_t)(const char *message, void *closure);
547 * Compact a notmuch database, backing up the original database to the
550 * The database will be opened with NOTMUCH_DATABASE_MODE_READ_WRITE
551 * during the compaction process to ensure no writes are made.
553 * If the optional callback function 'status_cb' is non-NULL, it will
554 * be called with diagnostic and informational messages. The argument
555 * 'closure' is passed verbatim to any callback invoked.
558 notmuch_database_compact (const char *path,
559 const char *backup_path,
560 notmuch_compact_status_cb_t status_cb,
564 * Like notmuch_database_compact, but take an open database as a
567 * @since libnnotmuch 5.4 (notmuch 0.32)
570 notmuch_database_compact_db (notmuch_database_t *database,
571 const char *backup_path,
572 notmuch_compact_status_cb_t status_cb,
576 * Destroy the notmuch database, closing it if necessary and freeing
577 * all associated resources.
579 * Return value as in notmuch_database_close if the database was open;
580 * notmuch_database_destroy itself has no failure modes.
583 notmuch_database_destroy (notmuch_database_t *database);
586 * Return the database path of the given database.
588 * The return value is a string owned by notmuch so should not be
589 * modified nor freed by the caller.
592 notmuch_database_get_path (notmuch_database_t *database);
595 * Return the database format version of the given database.
600 notmuch_database_get_version (notmuch_database_t *database);
603 * Can the database be upgraded to a newer database version?
605 * If this function returns TRUE, then the caller may call
606 * notmuch_database_upgrade to upgrade the database. If the caller
607 * does not upgrade an out-of-date database, then some functions may
608 * fail with NOTMUCH_STATUS_UPGRADE_REQUIRED. This always returns
609 * FALSE for a read-only database because there's no way to upgrade a
610 * read-only database.
612 * Also returns FALSE if an error occurs accessing the database.
616 notmuch_database_needs_upgrade (notmuch_database_t *database);
619 * Upgrade the current database to the latest supported version.
621 * This ensures that all current notmuch functionality will be
622 * available on the database. After opening a database in read-write
623 * mode, it is recommended that clients check if an upgrade is needed
624 * (notmuch_database_needs_upgrade) and if so, upgrade with this
625 * function before making any modifications. If
626 * notmuch_database_needs_upgrade returns FALSE, this will be a no-op.
628 * The optional progress_notify callback can be used by the caller to
629 * provide progress indication to the user. If non-NULL it will be
630 * called periodically with 'progress' as a floating-point value in
631 * the range of [0.0 .. 1.0] indicating the progress made so far in
632 * the upgrade process. The argument 'closure' is passed verbatim to
633 * any callback invoked.
636 notmuch_database_upgrade (notmuch_database_t *database,
637 void (*progress_notify)(void *closure,
642 * Begin an atomic database operation.
644 * Any modifications performed between a successful begin and a
645 * notmuch_database_end_atomic will be applied to the database
646 * atomically. Note that, unlike a typical database transaction, this
647 * only ensures atomicity, not durability; neither begin nor end
648 * necessarily flush modifications to disk.
650 * Atomic sections may be nested. begin_atomic and end_atomic must
651 * always be called in pairs.
655 * NOTMUCH_STATUS_SUCCESS: Successfully entered atomic section.
657 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred;
658 * atomic section not entered.
661 notmuch_database_begin_atomic (notmuch_database_t *notmuch);
664 * Indicate the end of an atomic database operation.
668 * NOTMUCH_STATUS_SUCCESS: Successfully completed atomic section.
670 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred;
671 * atomic section not ended.
673 * NOTMUCH_STATUS_UNBALANCED_ATOMIC: The database is not currently in
677 notmuch_database_end_atomic (notmuch_database_t *notmuch);
680 * Return the committed database revision and UUID.
682 * The database revision number increases monotonically with each
683 * commit to the database. Hence, all messages and message changes
684 * committed to the database (that is, visible to readers) have a last
685 * modification revision <= the committed database revision. Any
686 * messages committed in the future will be assigned a modification
687 * revision > the committed database revision.
689 * The UUID is a NUL-terminated opaque string that uniquely identifies
690 * this database. Two revision numbers are only comparable if they
691 * have the same database UUID.
694 notmuch_database_get_revision (notmuch_database_t *notmuch,
698 * Retrieve a directory object from the database for 'path'.
700 * Here, 'path' should be a path relative to the path of 'database'
701 * (see notmuch_database_get_path), or else should be an absolute path
702 * with initial components that match the path of 'database'.
704 * If this directory object does not exist in the database, this
705 * returns NOTMUCH_STATUS_SUCCESS and sets *directory to NULL.
707 * Otherwise the returned directory object is owned by the database
708 * and as such, will only be valid until notmuch_database_destroy is
713 * NOTMUCH_STATUS_SUCCESS: Successfully retrieved directory.
715 * NOTMUCH_STATUS_NULL_POINTER: The given 'directory' argument is NULL.
717 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred;
718 * directory not retrieved.
720 * NOTMUCH_STATUS_UPGRADE_REQUIRED: The caller must upgrade the
721 * database to use this function.
724 notmuch_database_get_directory (notmuch_database_t *database,
726 notmuch_directory_t **directory);
729 * Add a message file to a database, indexing it for retrieval by
730 * future searches. If a message already exists with the same message
731 * ID as the specified file, their indexes will be merged, and this
732 * new filename will also be associated with the existing message.
734 * Here, 'filename' should be a path relative to the path of
735 * 'database' (see notmuch_database_get_path), or else should be an
736 * absolute filename with initial components that match the path of
739 * The file should be a single mail message (not a multi-message mbox)
740 * that is expected to remain at its current location, (since the
741 * notmuch database will reference the filename, and will not copy the
742 * entire contents of the file.
744 * If another message with the same message ID already exists in the
745 * database, rather than creating a new message, this adds the search
746 * terms from the identified file to the existing message's index, and
747 * adds 'filename' to the list of filenames known for the message.
749 * The 'indexopts' parameter can be NULL (meaning, use the indexing
750 * defaults from the database), or can be an explicit choice of
751 * indexing options that should govern the indexing of this specific
754 * If 'message' is not NULL, then, on successful return
755 * (NOTMUCH_STATUS_SUCCESS or NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID) '*message'
756 * will be initialized to a message object that can be used for things
757 * such as adding tags to the just-added message. The user should call
758 * notmuch_message_destroy when done with the message. On any failure
759 * '*message' will be set to NULL.
763 * NOTMUCH_STATUS_SUCCESS: Message successfully added to database.
765 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred,
768 * NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID: Message has the same message
769 * ID as another message already in the database. The new
770 * filename was successfully added to the message in the database
771 * (if not already present) and the existing message is returned.
773 * NOTMUCH_STATUS_FILE_ERROR: an error occurred trying to open the
774 * file, (such as permission denied, or file not found,
775 * etc.). Nothing added to the database.
777 * NOTMUCH_STATUS_FILE_NOT_EMAIL: the contents of filename don't look
778 * like an email message. Nothing added to the database.
780 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
781 * mode so no message can be added.
783 * NOTMUCH_STATUS_UPGRADE_REQUIRED: The caller must upgrade the
784 * database to use this function.
786 * @since libnotmuch 5.1 (notmuch 0.26)
789 notmuch_database_index_file (notmuch_database_t *database,
790 const char *filename,
791 notmuch_indexopts_t *indexopts,
792 notmuch_message_t **message);
795 * Deprecated alias for notmuch_database_index_file called with
798 * @deprecated Deprecated as of libnotmuch 5.1 (notmuch 0.26). Please
799 * use notmuch_database_index_file instead.
802 NOTMUCH_DEPRECATED (5, 1)
804 notmuch_database_add_message (notmuch_database_t *database,
805 const char *filename,
806 notmuch_message_t **message);
809 * Remove a message filename from the given notmuch database. If the
810 * message has no more filenames, remove the message.
812 * If the same message (as determined by the message ID) is still
813 * available via other filenames, then the message will persist in the
814 * database for those filenames. When the last filename is removed for
815 * a particular message, the database content for that message will be
820 * NOTMUCH_STATUS_SUCCESS: The last filename was removed and the
821 * message was removed from the database.
823 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred,
824 * message not removed.
826 * NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID: This filename was removed but
827 * the message persists in the database with at least one other
830 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
831 * mode so no message can be removed.
833 * NOTMUCH_STATUS_UPGRADE_REQUIRED: The caller must upgrade the
834 * database to use this function.
837 notmuch_database_remove_message (notmuch_database_t *database,
838 const char *filename);
841 * Find a message with the given message_id.
843 * If a message with the given message_id is found then, on successful return
844 * (NOTMUCH_STATUS_SUCCESS) '*message' will be initialized to a message
845 * object. The caller should call notmuch_message_destroy when done with the
848 * On any failure or when the message is not found, this function initializes
849 * '*message' to NULL. This means, when NOTMUCH_STATUS_SUCCESS is returned, the
850 * caller is supposed to check '*message' for NULL to find out whether the
851 * message with the given message_id was found.
855 * NOTMUCH_STATUS_SUCCESS: Successful return, check '*message'.
857 * NOTMUCH_STATUS_NULL_POINTER: The given 'message' argument is NULL
859 * NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory, creating message object
861 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred
864 notmuch_database_find_message (notmuch_database_t *database,
865 const char *message_id,
866 notmuch_message_t **message);
869 * Find a message with the given filename.
871 * If the database contains a message with the given filename then, on
872 * successful return (NOTMUCH_STATUS_SUCCESS) '*message' will be initialized to
873 * a message object. The caller should call notmuch_message_destroy when done
876 * On any failure or when the message is not found, this function initializes
877 * '*message' to NULL. This means, when NOTMUCH_STATUS_SUCCESS is returned, the
878 * caller is supposed to check '*message' for NULL to find out whether the
879 * message with the given filename is found.
883 * NOTMUCH_STATUS_SUCCESS: Successful return, check '*message'
885 * NOTMUCH_STATUS_NULL_POINTER: The given 'message' argument is NULL
887 * NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory, creating the message object
889 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred
891 * NOTMUCH_STATUS_UPGRADE_REQUIRED: The caller must upgrade the
892 * database to use this function.
895 notmuch_database_find_message_by_filename (notmuch_database_t *notmuch,
896 const char *filename,
897 notmuch_message_t **message);
900 * Return a list of all tags found in the database.
902 * This function creates a list of all tags found in the database. The
903 * resulting list contains all tags from all messages found in the database.
905 * On error this function returns NULL.
908 notmuch_database_get_all_tags (notmuch_database_t *db);
911 * Reopen an open notmuch database.
913 * @param [in] db open notmuch database
914 * @param [in] mode mode (read only or read-write) for reopened database.
916 * @retval #NOTMUCH_STATUS_SUCCESS
917 * @retval #NOTMUCH_STATUS_ILLEGAL_ARGUMENT The passed database was not open.
918 * @retval #NOTMUCH_STATUS_XAPIAN_EXCEPTION A Xapian exception occured
921 notmuch_database_reopen (notmuch_database_t *db, notmuch_database_mode_t mode);
924 * Create a new query for 'database'.
926 * Here, 'database' should be an open database, (see
927 * notmuch_database_open and notmuch_database_create).
929 * For the query string, we'll document the syntax here more
930 * completely in the future, but it's likely to be a specialized
931 * version of the general Xapian query syntax:
933 * https://xapian.org/docs/queryparser.html
935 * As a special case, passing either a length-zero string, (that is ""),
936 * or a string consisting of a single asterisk (that is "*"), will
937 * result in a query that returns all messages in the database.
939 * See notmuch_query_set_sort for controlling the order of results.
940 * See notmuch_query_search_messages and notmuch_query_search_threads
941 * to actually execute the query.
943 * User should call notmuch_query_destroy when finished with this
946 * Will return NULL if insufficient memory is available.
949 notmuch_query_create (notmuch_database_t *database,
950 const char *query_string);
953 * Sort values for notmuch_query_set_sort.
959 NOTMUCH_SORT_OLDEST_FIRST,
963 NOTMUCH_SORT_NEWEST_FIRST,
965 * Sort by message-id.
967 NOTMUCH_SORT_MESSAGE_ID,
971 NOTMUCH_SORT_UNSORTED
975 * Return the query_string of this query. See notmuch_query_create.
978 notmuch_query_get_query_string (const notmuch_query_t *query);
981 * Return the notmuch database of this query. See notmuch_query_create.
984 notmuch_query_get_database (const notmuch_query_t *query);
987 * Exclude values for notmuch_query_set_omit_excluded. The strange
988 * order is to maintain backward compatibility: the old FALSE/TRUE
989 * options correspond to the new
990 * NOTMUCH_EXCLUDE_FLAG/NOTMUCH_EXCLUDE_TRUE options.
993 NOTMUCH_EXCLUDE_FLAG,
994 NOTMUCH_EXCLUDE_TRUE,
995 NOTMUCH_EXCLUDE_FALSE,
1000 * Specify whether to omit excluded results or simply flag them. By
1001 * default, this is set to TRUE.
1003 * If set to TRUE or ALL, notmuch_query_search_messages will omit excluded
1004 * messages from the results, and notmuch_query_search_threads will omit
1005 * threads that match only in excluded messages. If set to TRUE,
1006 * notmuch_query_search_threads will include all messages in threads that
1007 * match in at least one non-excluded message. Otherwise, if set to ALL,
1008 * notmuch_query_search_threads will omit excluded messages from all threads.
1010 * If set to FALSE or FLAG then both notmuch_query_search_messages and
1011 * notmuch_query_search_threads will return all matching
1012 * messages/threads regardless of exclude status. If set to FLAG then
1013 * the exclude flag will be set for any excluded message that is
1014 * returned by notmuch_query_search_messages, and the thread counts
1015 * for threads returned by notmuch_query_search_threads will be the
1016 * number of non-excluded messages/matches. Otherwise, if set to
1017 * FALSE, then the exclude status is completely ignored.
1019 * The performance difference when calling
1020 * notmuch_query_search_messages should be relatively small (and both
1021 * should be very fast). However, in some cases,
1022 * notmuch_query_search_threads is very much faster when omitting
1023 * excluded messages as it does not need to construct the threads that
1024 * only match in excluded messages.
1027 notmuch_query_set_omit_excluded (notmuch_query_t *query,
1028 notmuch_exclude_t omit_excluded);
1031 * Specify the sorting desired for this query.
1034 notmuch_query_set_sort (notmuch_query_t *query, notmuch_sort_t sort);
1037 * Return the sort specified for this query. See
1038 * notmuch_query_set_sort.
1041 notmuch_query_get_sort (const notmuch_query_t *query);
1044 * Add a tag that will be excluded from the query results by default.
1045 * This exclusion will be ignored if this tag appears explicitly in
1050 * NOTMUCH_STATUS_SUCCESS: excluded was added successfully.
1052 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: a Xapian exception occurred.
1053 * Most likely a problem lazily parsing the query string.
1055 * NOTMUCH_STATUS_IGNORED: tag is explicitly present in the query, so
1059 notmuch_query_add_tag_exclude (notmuch_query_t *query, const char *tag);
1062 * Execute a query for threads, returning a notmuch_threads_t object
1063 * which can be used to iterate over the results. The returned threads
1064 * object is owned by the query and as such, will only be valid until
1065 * notmuch_query_destroy.
1067 * Typical usage might be:
1069 * notmuch_query_t *query;
1070 * notmuch_threads_t *threads;
1071 * notmuch_thread_t *thread;
1072 * notmuch_status_t stat;
1074 * query = notmuch_query_create (database, query_string);
1076 * for (stat = notmuch_query_search_threads (query, &threads);
1077 * stat == NOTMUCH_STATUS_SUCCESS &&
1078 * notmuch_threads_valid (threads);
1079 * notmuch_threads_move_to_next (threads))
1081 * thread = notmuch_threads_get (threads);
1083 * notmuch_thread_destroy (thread);
1086 * notmuch_query_destroy (query);
1088 * Note: If you are finished with a thread before its containing
1089 * query, you can call notmuch_thread_destroy to clean up some memory
1090 * sooner (as in the above example). Otherwise, if your thread objects
1091 * are long-lived, then you don't need to call notmuch_thread_destroy
1092 * and all the memory will still be reclaimed when the query is
1095 * Note that there's no explicit destructor needed for the
1096 * notmuch_threads_t object. (For consistency, we do provide a
1097 * notmuch_threads_destroy function, but there's no good reason
1098 * to call it if the query is about to be destroyed).
1100 * @since libnotmuch 5.0 (notmuch 0.25)
1103 notmuch_query_search_threads (notmuch_query_t *query,
1104 notmuch_threads_t **out);
1107 * Deprecated alias for notmuch_query_search_threads.
1109 * @deprecated Deprecated as of libnotmuch 5 (notmuch 0.25). Please
1110 * use notmuch_query_search_threads instead.
1113 NOTMUCH_DEPRECATED (5, 0)
1115 notmuch_query_search_threads_st (notmuch_query_t *query, notmuch_threads_t **out);
1118 * Execute a query for messages, returning a notmuch_messages_t object
1119 * which can be used to iterate over the results. The returned
1120 * messages object is owned by the query and as such, will only be
1121 * valid until notmuch_query_destroy.
1123 * Typical usage might be:
1125 * notmuch_query_t *query;
1126 * notmuch_messages_t *messages;
1127 * notmuch_message_t *message;
1129 * query = notmuch_query_create (database, query_string);
1131 * for (messages = notmuch_query_search_messages (query);
1132 * notmuch_messages_valid (messages);
1133 * notmuch_messages_move_to_next (messages))
1135 * message = notmuch_messages_get (messages);
1137 * notmuch_message_destroy (message);
1140 * notmuch_query_destroy (query);
1142 * Note: If you are finished with a message before its containing
1143 * query, you can call notmuch_message_destroy to clean up some memory
1144 * sooner (as in the above example). Otherwise, if your message
1145 * objects are long-lived, then you don't need to call
1146 * notmuch_message_destroy and all the memory will still be reclaimed
1147 * when the query is destroyed.
1149 * Note that there's no explicit destructor needed for the
1150 * notmuch_messages_t object. (For consistency, we do provide a
1151 * notmuch_messages_destroy function, but there's no good
1152 * reason to call it if the query is about to be destroyed).
1154 * If a Xapian exception occurs this function will return NULL.
1156 * @since libnotmuch 5 (notmuch 0.25)
1159 notmuch_query_search_messages (notmuch_query_t *query,
1160 notmuch_messages_t **out);
1162 * Deprecated alias for notmuch_query_search_messages
1164 * @deprecated Deprecated as of libnotmuch 5 (notmuch 0.25). Please use
1165 * notmuch_query_search_messages instead.
1169 NOTMUCH_DEPRECATED (5, 0)
1171 notmuch_query_search_messages_st (notmuch_query_t *query,
1172 notmuch_messages_t **out);
1175 * Destroy a notmuch_query_t along with any associated resources.
1177 * This will in turn destroy any notmuch_threads_t and
1178 * notmuch_messages_t objects generated by this query, (and in
1179 * turn any notmuch_thread_t and notmuch_message_t objects generated
1180 * from those results, etc.), if such objects haven't already been
1184 notmuch_query_destroy (notmuch_query_t *query);
1187 * Is the given 'threads' iterator pointing at a valid thread.
1189 * When this function returns TRUE, notmuch_threads_get will return a
1190 * valid object. Whereas when this function returns FALSE,
1191 * notmuch_threads_get will return NULL.
1193 * If passed a NULL pointer, this function returns FALSE
1195 * See the documentation of notmuch_query_search_threads for example
1196 * code showing how to iterate over a notmuch_threads_t object.
1199 notmuch_threads_valid (notmuch_threads_t *threads);
1202 * Get the current thread from 'threads' as a notmuch_thread_t.
1204 * Note: The returned thread belongs to 'threads' and has a lifetime
1205 * identical to it (and the query to which it belongs).
1207 * See the documentation of notmuch_query_search_threads for example
1208 * code showing how to iterate over a notmuch_threads_t object.
1210 * If an out-of-memory situation occurs, this function will return
1214 notmuch_threads_get (notmuch_threads_t *threads);
1217 * Move the 'threads' iterator to the next thread.
1219 * If 'threads' is already pointing at the last thread then the
1220 * iterator will be moved to a point just beyond that last thread,
1221 * (where notmuch_threads_valid will return FALSE and
1222 * notmuch_threads_get will return NULL).
1224 * See the documentation of notmuch_query_search_threads for example
1225 * code showing how to iterate over a notmuch_threads_t object.
1228 notmuch_threads_move_to_next (notmuch_threads_t *threads);
1231 * Destroy a notmuch_threads_t object.
1233 * It's not strictly necessary to call this function. All memory from
1234 * the notmuch_threads_t object will be reclaimed when the
1235 * containing query object is destroyed.
1238 notmuch_threads_destroy (notmuch_threads_t *threads);
1241 * Return the number of messages matching a search.
1243 * This function performs a search and returns the number of matching
1248 * NOTMUCH_STATUS_SUCCESS: query completed successfully.
1250 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: a Xapian exception occurred. The
1251 * value of *count is not defined.
1253 * @since libnotmuch 5 (notmuch 0.25)
1256 notmuch_query_count_messages (notmuch_query_t *query, unsigned int *count);
1259 * Deprecated alias for notmuch_query_count_messages
1262 * @deprecated Deprecated since libnotmuch 5.0 (notmuch 0.25). Please
1263 * use notmuch_query_count_messages instead.
1265 NOTMUCH_DEPRECATED (5, 0)
1267 notmuch_query_count_messages_st (notmuch_query_t *query, unsigned int *count);
1270 * Return the number of threads matching a search.
1272 * This function performs a search and returns the number of unique thread IDs
1273 * in the matching messages. This is the same as number of threads matching a
1276 * Note that this is a significantly heavier operation than
1277 * notmuch_query_count_messages{_st}().
1281 * NOTMUCH_STATUS_OUT_OF_MEMORY: Memory allocation failed. The value
1282 * of *count is not defined
1284 * NOTMUCH_STATUS_SUCCESS: query completed successfully.
1286 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: a Xapian exception occurred. The
1287 * value of *count is not defined.
1289 * @since libnotmuch 5 (notmuch 0.25)
1292 notmuch_query_count_threads (notmuch_query_t *query, unsigned *count);
1295 * Deprecated alias for notmuch_query_count_threads
1297 * @deprecated Deprecated as of libnotmuch 5.0 (notmuch 0.25). Please
1298 * use notmuch_query_count_threads_st instead.
1300 NOTMUCH_DEPRECATED (5, 0)
1302 notmuch_query_count_threads_st (notmuch_query_t *query, unsigned *count);
1305 * Get the thread ID of 'thread'.
1307 * The returned string belongs to 'thread' and as such, should not be
1308 * modified by the caller and will only be valid for as long as the
1309 * thread is valid, (which is until notmuch_thread_destroy or until
1310 * the query from which it derived is destroyed).
1313 notmuch_thread_get_thread_id (notmuch_thread_t *thread);
1316 * Get the total number of messages in 'thread'.
1318 * This count consists of all messages in the database belonging to
1319 * this thread. Contrast with notmuch_thread_get_matched_messages() .
1322 notmuch_thread_get_total_messages (notmuch_thread_t *thread);
1325 * Get the total number of files in 'thread'.
1327 * This sums notmuch_message_count_files over all messages in the
1329 * @returns Non-negative integer
1330 * @since libnotmuch 5.0 (notmuch 0.25)
1334 notmuch_thread_get_total_files (notmuch_thread_t *thread);
1337 * Get a notmuch_messages_t iterator for the top-level messages in
1338 * 'thread' in oldest-first order.
1340 * This iterator will not necessarily iterate over all of the messages
1341 * in the thread. It will only iterate over the messages in the thread
1342 * which are not replies to other messages in the thread.
1344 * The returned list will be destroyed when the thread is destroyed.
1346 notmuch_messages_t *
1347 notmuch_thread_get_toplevel_messages (notmuch_thread_t *thread);
1350 * Get a notmuch_thread_t iterator for all messages in 'thread' in
1351 * oldest-first order.
1353 * The returned list will be destroyed when the thread is destroyed.
1355 notmuch_messages_t *
1356 notmuch_thread_get_messages (notmuch_thread_t *thread);
1359 * Get the number of messages in 'thread' that matched the search.
1361 * This count includes only the messages in this thread that were
1362 * matched by the search from which the thread was created and were
1363 * not excluded by any exclude tags passed in with the query (see
1364 * notmuch_query_add_tag_exclude). Contrast with
1365 * notmuch_thread_get_total_messages() .
1368 notmuch_thread_get_matched_messages (notmuch_thread_t *thread);
1371 * Get the authors of 'thread' as a UTF-8 string.
1373 * The returned string is a comma-separated list of the names of the
1374 * authors of mail messages in the query results that belong to this
1377 * The string contains authors of messages matching the query first, then
1378 * non-matched authors (with the two groups separated by '|'). Within
1379 * each group, authors are ordered by date.
1381 * The returned string belongs to 'thread' and as such, should not be
1382 * modified by the caller and will only be valid for as long as the
1383 * thread is valid, (which is until notmuch_thread_destroy or until
1384 * the query from which it derived is destroyed).
1387 notmuch_thread_get_authors (notmuch_thread_t *thread);
1390 * Get the subject of 'thread' as a UTF-8 string.
1392 * The subject is taken from the first message (according to the query
1393 * order---see notmuch_query_set_sort) in the query results that
1394 * belongs to this thread.
1396 * The returned string belongs to 'thread' and as such, should not be
1397 * modified by the caller and will only be valid for as long as the
1398 * thread is valid, (which is until notmuch_thread_destroy or until
1399 * the query from which it derived is destroyed).
1402 notmuch_thread_get_subject (notmuch_thread_t *thread);
1405 * Get the date of the oldest message in 'thread' as a time_t value.
1408 notmuch_thread_get_oldest_date (notmuch_thread_t *thread);
1411 * Get the date of the newest message in 'thread' as a time_t value.
1414 notmuch_thread_get_newest_date (notmuch_thread_t *thread);
1417 * Get the tags for 'thread', returning a notmuch_tags_t object which
1418 * can be used to iterate over all tags.
1420 * Note: In the Notmuch database, tags are stored on individual
1421 * messages, not on threads. So the tags returned here will be all
1422 * tags of the messages which matched the search and which belong to
1425 * The tags object is owned by the thread and as such, will only be
1426 * valid for as long as the thread is valid, (for example, until
1427 * notmuch_thread_destroy or until the query from which it derived is
1430 * Typical usage might be:
1432 * notmuch_thread_t *thread;
1433 * notmuch_tags_t *tags;
1436 * thread = notmuch_threads_get (threads);
1438 * for (tags = notmuch_thread_get_tags (thread);
1439 * notmuch_tags_valid (tags);
1440 * notmuch_tags_move_to_next (tags))
1442 * tag = notmuch_tags_get (tags);
1446 * notmuch_thread_destroy (thread);
1448 * Note that there's no explicit destructor needed for the
1449 * notmuch_tags_t object. (For consistency, we do provide a
1450 * notmuch_tags_destroy function, but there's no good reason to call
1451 * it if the message is about to be destroyed).
1454 notmuch_thread_get_tags (notmuch_thread_t *thread);
1457 * Destroy a notmuch_thread_t object.
1460 notmuch_thread_destroy (notmuch_thread_t *thread);
1463 * Is the given 'messages' iterator pointing at a valid message.
1465 * When this function returns TRUE, notmuch_messages_get will return a
1466 * valid object. Whereas when this function returns FALSE,
1467 * notmuch_messages_get will return NULL.
1469 * See the documentation of notmuch_query_search_messages for example
1470 * code showing how to iterate over a notmuch_messages_t object.
1473 notmuch_messages_valid (notmuch_messages_t *messages);
1476 * Get the current message from 'messages' as a notmuch_message_t.
1478 * Note: The returned message belongs to 'messages' and has a lifetime
1479 * identical to it (and the query to which it belongs).
1481 * See the documentation of notmuch_query_search_messages for example
1482 * code showing how to iterate over a notmuch_messages_t object.
1484 * If an out-of-memory situation occurs, this function will return
1488 notmuch_messages_get (notmuch_messages_t *messages);
1491 * Move the 'messages' iterator to the next message.
1493 * If 'messages' is already pointing at the last message then the
1494 * iterator will be moved to a point just beyond that last message,
1495 * (where notmuch_messages_valid will return FALSE and
1496 * notmuch_messages_get will return NULL).
1498 * See the documentation of notmuch_query_search_messages for example
1499 * code showing how to iterate over a notmuch_messages_t object.
1502 notmuch_messages_move_to_next (notmuch_messages_t *messages);
1505 * Destroy a notmuch_messages_t object.
1507 * It's not strictly necessary to call this function. All memory from
1508 * the notmuch_messages_t object will be reclaimed when the containing
1509 * query object is destroyed.
1512 notmuch_messages_destroy (notmuch_messages_t *messages);
1515 * Return a list of tags from all messages.
1517 * The resulting list is guaranteed not to contain duplicated tags.
1519 * WARNING: You can no longer iterate over messages after calling this
1520 * function, because the iterator will point at the end of the list.
1521 * We do not have a function to reset the iterator yet and the only
1522 * way how you can iterate over the list again is to recreate the
1525 * The function returns NULL on error.
1528 notmuch_messages_collect_tags (notmuch_messages_t *messages);
1531 * Get the database associated with this message.
1533 * @since libnotmuch 5.2 (notmuch 0.27)
1535 notmuch_database_t *
1536 notmuch_message_get_database (const notmuch_message_t *message);
1539 * Get the message ID of 'message'.
1541 * The returned string belongs to 'message' and as such, should not be
1542 * modified by the caller and will only be valid for as long as the
1543 * message is valid, (which is until the query from which it derived
1546 * This function will return NULL if triggers an unhandled Xapian
1550 notmuch_message_get_message_id (notmuch_message_t *message);
1553 * Get the thread ID of 'message'.
1555 * The returned string belongs to 'message' and as such, should not be
1556 * modified by the caller and will only be valid for as long as the
1557 * message is valid, (for example, until the user calls
1558 * notmuch_message_destroy on 'message' or until a query from which it
1559 * derived is destroyed).
1561 * This function will return NULL if triggers an unhandled Xapian
1565 notmuch_message_get_thread_id (notmuch_message_t *message);
1568 * Get a notmuch_messages_t iterator for all of the replies to
1571 * Note: This call only makes sense if 'message' was ultimately
1572 * obtained from a notmuch_thread_t object, (such as by coming
1573 * directly from the result of calling notmuch_thread_get_
1574 * toplevel_messages or by any number of subsequent
1575 * calls to notmuch_message_get_replies).
1577 * If 'message' was obtained through some non-thread means, (such as
1578 * by a call to notmuch_query_search_messages), then this function
1581 * If there are no replies to 'message', this function will return
1582 * NULL. (Note that notmuch_messages_valid will accept that NULL
1583 * value as legitimate, and simply return FALSE for it.)
1585 * This function also returns NULL if it triggers a Xapian exception.
1587 * The returned list will be destroyed when the thread is
1590 notmuch_messages_t *
1591 notmuch_message_get_replies (notmuch_message_t *message);
1594 * Get the total number of files associated with a message.
1595 * @returns Non-negative integer for file count.
1596 * @returns Negative integer for error.
1597 * @since libnotmuch 5.0 (notmuch 0.25)
1600 notmuch_message_count_files (notmuch_message_t *message);
1603 * Get a filename for the email corresponding to 'message'.
1605 * The returned filename is an absolute filename, (the initial
1606 * component will match notmuch_database_get_path() ).
1608 * The returned string belongs to the message so should not be
1609 * modified or freed by the caller (nor should it be referenced after
1610 * the message is destroyed).
1612 * Note: If this message corresponds to multiple files in the mail
1613 * store, (that is, multiple files contain identical message IDs),
1614 * this function will arbitrarily return a single one of those
1615 * filenames. See notmuch_message_get_filenames for returning the
1616 * complete list of filenames.
1618 * This function returns NULL if it triggers a Xapian exception.
1621 notmuch_message_get_filename (notmuch_message_t *message);
1624 * Get all filenames for the email corresponding to 'message'.
1626 * Returns a notmuch_filenames_t iterator listing all the filenames
1627 * associated with 'message'. These files may not have identical
1628 * content, but each will have the identical Message-ID.
1630 * Each filename in the iterator is an absolute filename, (the initial
1631 * component will match notmuch_database_get_path() ).
1633 * This function returns NULL if it triggers a Xapian exception.
1635 notmuch_filenames_t *
1636 notmuch_message_get_filenames (notmuch_message_t *message);
1639 * Re-index the e-mail corresponding to 'message' using the supplied index options
1641 * Returns the status of the re-index operation. (see the return
1642 * codes documented in notmuch_database_index_file)
1644 * After reindexing, the user should discard the message object passed
1645 * in here by calling notmuch_message_destroy, since it refers to the
1646 * original message, not to the reindexed message.
1649 notmuch_message_reindex (notmuch_message_t *message,
1650 notmuch_indexopts_t *indexopts);
1655 typedef enum _notmuch_message_flag {
1656 NOTMUCH_MESSAGE_FLAG_MATCH,
1657 NOTMUCH_MESSAGE_FLAG_EXCLUDED,
1659 /* This message is a "ghost message", meaning it has no filenames
1660 * or content, but we know it exists because it was referenced by
1661 * some other message. A ghost message has only a message ID and
1664 NOTMUCH_MESSAGE_FLAG_GHOST,
1665 } notmuch_message_flag_t;
1668 * Get a value of a flag for the email corresponding to 'message'.
1670 * returns FALSE in case of errors.
1672 * @deprecated Deprecated as of libnotmuch 5.3 (notmuch 0.31). Please
1673 * use notmuch_message_get_flag_st instead.
1675 NOTMUCH_DEPRECATED (5, 3)
1677 notmuch_message_get_flag (notmuch_message_t *message,
1678 notmuch_message_flag_t flag);
1681 * Get a value of a flag for the email corresponding to 'message'.
1683 * @param message a message object
1684 * @param flag flag to check
1685 * @param is_set pointer to boolean to store flag value.
1687 * @retval #NOTMUCH_STATUS_SUCCESS
1688 * @retval #NOTMUCH_STATUS_NULL_POINTER is_set is NULL
1689 * @retval #NOTMUCH_STATUS_XAPIAN_EXCEPTION Accessing the database
1690 * triggered an exception.
1692 * @since libnotmuch 5.3 (notmuch 0.31)
1695 notmuch_message_get_flag_st (notmuch_message_t *message,
1696 notmuch_message_flag_t flag,
1697 notmuch_bool_t *is_set);
1700 * Set a value of a flag for the email corresponding to 'message'.
1703 notmuch_message_set_flag (notmuch_message_t *message,
1704 notmuch_message_flag_t flag, notmuch_bool_t value);
1707 * Get the date of 'message' as a time_t value.
1709 * For the original textual representation of the Date header from the
1710 * message call notmuch_message_get_header() with a header value of
1713 * Returns 0 in case of error.
1716 notmuch_message_get_date (notmuch_message_t *message);
1719 * Get the value of the specified header from 'message' as a UTF-8 string.
1721 * Common headers are stored in the database when the message is
1722 * indexed and will be returned from the database. Other headers will
1723 * be read from the actual message file.
1725 * The header name is case insensitive.
1727 * The returned string belongs to the message so should not be
1728 * modified or freed by the caller (nor should it be referenced after
1729 * the message is destroyed).
1731 * Returns an empty string ("") if the message does not contain a
1732 * header line matching 'header'. Returns NULL if any error occurs.
1735 notmuch_message_get_header (notmuch_message_t *message, const char *header);
1738 * Get the tags for 'message', returning a notmuch_tags_t object which
1739 * can be used to iterate over all tags.
1741 * The tags object is owned by the message and as such, will only be
1742 * valid for as long as the message is valid, (which is until the
1743 * query from which it derived is destroyed).
1745 * Typical usage might be:
1747 * notmuch_message_t *message;
1748 * notmuch_tags_t *tags;
1751 * message = notmuch_database_find_message (database, message_id);
1753 * for (tags = notmuch_message_get_tags (message);
1754 * notmuch_tags_valid (tags);
1755 * notmuch_tags_move_to_next (tags))
1757 * tag = notmuch_tags_get (tags);
1761 * notmuch_message_destroy (message);
1763 * Note that there's no explicit destructor needed for the
1764 * notmuch_tags_t object. (For consistency, we do provide a
1765 * notmuch_tags_destroy function, but there's no good reason to call
1766 * it if the message is about to be destroyed).
1769 notmuch_message_get_tags (notmuch_message_t *message);
1772 * The longest possible tag value.
1774 #define NOTMUCH_TAG_MAX 200
1777 * Add a tag to the given message.
1781 * NOTMUCH_STATUS_SUCCESS: Tag successfully added to message
1783 * NOTMUCH_STATUS_NULL_POINTER: The 'tag' argument is NULL
1785 * NOTMUCH_STATUS_TAG_TOO_LONG: The length of 'tag' is too long
1786 * (exceeds NOTMUCH_TAG_MAX)
1788 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
1789 * mode so message cannot be modified.
1792 notmuch_message_add_tag (notmuch_message_t *message, const char *tag);
1795 * Remove a tag from the given message.
1799 * NOTMUCH_STATUS_SUCCESS: Tag successfully removed from message
1801 * NOTMUCH_STATUS_NULL_POINTER: The 'tag' argument is NULL
1803 * NOTMUCH_STATUS_TAG_TOO_LONG: The length of 'tag' is too long
1804 * (exceeds NOTMUCH_TAG_MAX)
1806 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
1807 * mode so message cannot be modified.
1810 notmuch_message_remove_tag (notmuch_message_t *message, const char *tag);
1813 * Remove all tags from the given message.
1815 * See notmuch_message_freeze for an example showing how to safely
1816 * replace tag values.
1818 * @retval #NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in
1819 * read-only mode so message cannot be modified.
1820 * @retval #NOTMUCH_STATUS_XAPIAN_EXCEPTION: an exception was thrown
1821 * accessing the database.
1824 notmuch_message_remove_all_tags (notmuch_message_t *message);
1827 * Add/remove tags according to maildir flags in the message filename(s).
1829 * This function examines the filenames of 'message' for maildir
1830 * flags, and adds or removes tags on 'message' as follows when these
1831 * flags are present:
1833 * Flag Action if present
1834 * ---- -----------------
1835 * 'D' Adds the "draft" tag to the message
1836 * 'F' Adds the "flagged" tag to the message
1837 * 'P' Adds the "passed" tag to the message
1838 * 'R' Adds the "replied" tag to the message
1839 * 'S' Removes the "unread" tag from the message
1841 * For each flag that is not present, the opposite action (add/remove)
1842 * is performed for the corresponding tags.
1844 * Flags are identified as trailing components of the filename after a
1845 * sequence of ":2,".
1847 * If there are multiple filenames associated with this message, the
1848 * flag is considered present if it appears in one or more
1849 * filenames. (That is, the flags from the multiple filenames are
1850 * combined with the logical OR operator.)
1852 * A client can ensure that notmuch database tags remain synchronized
1853 * with maildir flags by calling this function after each call to
1854 * notmuch_database_index_file. See also
1855 * notmuch_message_tags_to_maildir_flags for synchronizing tag changes
1856 * back to maildir flags.
1859 notmuch_message_maildir_flags_to_tags (notmuch_message_t *message);
1862 * return TRUE if any filename of 'message' has maildir flag 'flag',
1865 * Deprecated wrapper for notmuch_message_has_maildir_flag_st
1867 * @returns FALSE in case of error
1868 * @deprecated libnotmuch 5.3 (notmuch 0.31)
1870 NOTMUCH_DEPRECATED (5, 3)
1872 notmuch_message_has_maildir_flag (notmuch_message_t *message, char flag);
1875 * check message for maildir flag
1877 * @param [in,out] message message to check
1878 * @param [in] flag flag to check for
1879 * @param [out] is_set pointer to boolean
1881 * @retval #NOTMUCH_STATUS_SUCCESS
1882 * @retval #NOTMUCH_STATUS_NULL_POINTER is_set is NULL
1883 * @retval #NOTMUCH_STATUS_XAPIAN_EXCEPTION Accessing the database
1884 * triggered an exception.
1887 notmuch_message_has_maildir_flag_st (notmuch_message_t *message,
1889 notmuch_bool_t *is_set);
1892 * Rename message filename(s) to encode tags as maildir flags.
1894 * Specifically, for each filename corresponding to this message:
1896 * If the filename is not in a maildir directory, do nothing. (A
1897 * maildir directory is determined as a directory named "new" or
1898 * "cur".) Similarly, if the filename has invalid maildir info,
1899 * (repeated or outof-ASCII-order flag characters after ":2,"), then
1902 * If the filename is in a maildir directory, rename the file so that
1903 * its filename ends with the sequence ":2," followed by zero or more
1904 * of the following single-character flags (in ASCII order):
1906 * * flag 'D' iff the message has the "draft" tag
1907 * * flag 'F' iff the message has the "flagged" tag
1908 * * flag 'P' iff the message has the "passed" tag
1909 * * flag 'R' iff the message has the "replied" tag
1910 * * flag 'S' iff the message does not have the "unread" tag
1912 * Any existing flags unmentioned in the list above will be preserved
1915 * Also, if this filename is in a directory named "new", rename it to
1916 * be within the neighboring directory named "cur".
1918 * A client can ensure that maildir filename flags remain synchronized
1919 * with notmuch database tags by calling this function after changing
1920 * tags, (after calls to notmuch_message_add_tag,
1921 * notmuch_message_remove_tag, or notmuch_message_freeze/
1922 * notmuch_message_thaw). See also notmuch_message_maildir_flags_to_tags
1923 * for synchronizing maildir flag changes back to tags.
1926 notmuch_message_tags_to_maildir_flags (notmuch_message_t *message);
1929 * Freeze the current state of 'message' within the database.
1931 * This means that changes to the message state, (via
1932 * notmuch_message_add_tag, notmuch_message_remove_tag, and
1933 * notmuch_message_remove_all_tags), will not be committed to the
1934 * database until the message is thawed with notmuch_message_thaw.
1936 * Multiple calls to freeze/thaw are valid and these calls will
1937 * "stack". That is there must be as many calls to thaw as to freeze
1938 * before a message is actually thawed.
1940 * The ability to do freeze/thaw allows for safe transactions to
1941 * change tag values. For example, explicitly setting a message to
1942 * have a given set of tags might look like this:
1944 * notmuch_message_freeze (message);
1946 * notmuch_message_remove_all_tags (message);
1948 * for (i = 0; i < NUM_TAGS; i++)
1949 * notmuch_message_add_tag (message, tags[i]);
1951 * notmuch_message_thaw (message);
1953 * With freeze/thaw used like this, the message in the database is
1954 * guaranteed to have either the full set of original tag values, or
1955 * the full set of new tag values, but nothing in between.
1957 * Imagine the example above without freeze/thaw and the operation
1958 * somehow getting interrupted. This could result in the message being
1959 * left with no tags if the interruption happened after
1960 * notmuch_message_remove_all_tags but before notmuch_message_add_tag.
1964 * NOTMUCH_STATUS_SUCCESS: Message successfully frozen.
1966 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
1967 * mode so message cannot be modified.
1970 notmuch_message_freeze (notmuch_message_t *message);
1973 * Thaw the current 'message', synchronizing any changes that may have
1974 * occurred while 'message' was frozen into the notmuch database.
1976 * See notmuch_message_freeze for an example of how to use this
1977 * function to safely provide tag changes.
1979 * Multiple calls to freeze/thaw are valid and these calls with
1980 * "stack". That is there must be as many calls to thaw as to freeze
1981 * before a message is actually thawed.
1985 * NOTMUCH_STATUS_SUCCESS: Message successfully thawed, (or at least
1986 * its frozen count has successfully been reduced by 1).
1988 * NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW: An attempt was made to thaw
1989 * an unfrozen message. That is, there have been an unbalanced
1990 * number of calls to notmuch_message_freeze and
1991 * notmuch_message_thaw.
1994 notmuch_message_thaw (notmuch_message_t *message);
1997 * Destroy a notmuch_message_t object.
1999 * It can be useful to call this function in the case of a single
2000 * query object with many messages in the result, (such as iterating
2001 * over the entire database). Otherwise, it's fine to never call this
2002 * function and there will still be no memory leaks. (The memory from
2003 * the messages get reclaimed when the containing query is destroyed.)
2006 notmuch_message_destroy (notmuch_message_t *message);
2009 * @name Message Properties
2011 * This interface provides the ability to attach arbitrary (key,value)
2012 * string pairs to a message, to remove such pairs, and to iterate
2013 * over them. The caller should take some care as to what keys they
2014 * add or delete values for, as other subsystems or extensions may
2015 * depend on these properties.
2017 * Please see notmuch-properties(7) for more details about specific
2018 * properties and conventions around their use.
2023 * Retrieve the value for a single property key
2025 * *value* is set to a string owned by the message or NULL if there is
2026 * no such key. In the case of multiple values for the given key, the
2027 * first one is retrieved.
2030 * - NOTMUCH_STATUS_NULL_POINTER: *value* may not be NULL.
2031 * - NOTMUCH_STATUS_SUCCESS: No error occurred.
2032 * @since libnotmuch 4.4 (notmuch 0.23)
2035 notmuch_message_get_property (notmuch_message_t *message, const char *key, const char **value);
2038 * Add a (key,value) pair to a message
2041 * - NOTMUCH_STATUS_ILLEGAL_ARGUMENT: *key* may not contain an '=' character.
2042 * - NOTMUCH_STATUS_NULL_POINTER: Neither *key* nor *value* may be NULL.
2043 * - NOTMUCH_STATUS_SUCCESS: No error occurred.
2044 * @since libnotmuch 4.4 (notmuch 0.23)
2047 notmuch_message_add_property (notmuch_message_t *message, const char *key, const char *value);
2050 * Remove a (key,value) pair from a message.
2052 * It is not an error to remove a non-existent (key,value) pair
2055 * - NOTMUCH_STATUS_ILLEGAL_ARGUMENT: *key* may not contain an '=' character.
2056 * - NOTMUCH_STATUS_NULL_POINTER: Neither *key* nor *value* may be NULL.
2057 * - NOTMUCH_STATUS_SUCCESS: No error occurred.
2058 * @since libnotmuch 4.4 (notmuch 0.23)
2061 notmuch_message_remove_property (notmuch_message_t *message, const char *key, const char *value);
2064 * Remove all (key,value) pairs from the given message.
2066 * @param[in,out] message message to operate on.
2067 * @param[in] key key to delete properties for. If NULL, delete
2068 * properties for all keys
2070 * - NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in
2071 * read-only mode so message cannot be modified.
2072 * - NOTMUCH_STATUS_SUCCESS: No error occurred.
2074 * @since libnotmuch 4.4 (notmuch 0.23)
2077 notmuch_message_remove_all_properties (notmuch_message_t *message, const char *key);
2080 * Remove all (prefix*,value) pairs from the given message
2082 * @param[in,out] message message to operate on.
2083 * @param[in] prefix delete properties with keys that start with prefix.
2084 * If NULL, delete all properties
2086 * - NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in
2087 * read-only mode so message cannot be modified.
2088 * - NOTMUCH_STATUS_SUCCESS: No error occurred.
2090 * @since libnotmuch 5.1 (notmuch 0.26)
2093 notmuch_message_remove_all_properties_with_prefix (notmuch_message_t *message, const char *prefix);
2096 * Opaque message property iterator
2098 typedef struct _notmuch_string_map_iterator notmuch_message_properties_t;
2101 * Get the properties for *message*, returning a
2102 * notmuch_message_properties_t object which can be used to iterate
2103 * over all properties.
2105 * The notmuch_message_properties_t object is owned by the message and
2106 * as such, will only be valid for as long as the message is valid,
2107 * (which is until the query from which it derived is destroyed).
2109 * @param[in] message The message to examine
2110 * @param[in] key key or key prefix
2111 * @param[in] exact if TRUE, require exact match with key. Otherwise
2114 * Typical usage might be:
2116 * notmuch_message_properties_t *list;
2118 * for (list = notmuch_message_get_properties (message, "testkey1", TRUE);
2119 * notmuch_message_properties_valid (list); notmuch_message_properties_move_to_next (list)) {
2120 * printf("%s\n", notmuch_message_properties_value(list));
2123 * notmuch_message_properties_destroy (list);
2125 * Note that there's no explicit destructor needed for the
2126 * notmuch_message_properties_t object. (For consistency, we do
2127 * provide a notmuch_message_properities_destroy function, but there's
2128 * no good reason to call it if the message is about to be destroyed).
2130 * @since libnotmuch 4.4 (notmuch 0.23)
2132 notmuch_message_properties_t *
2133 notmuch_message_get_properties (notmuch_message_t *message, const char *key, notmuch_bool_t exact);
2136 * Return the number of properties named "key" belonging to the specific message.
2138 * @param[in] message The message to examine
2139 * @param[in] key key to count
2140 * @param[out] count The number of matching properties associated with this message.
2144 * NOTMUCH_STATUS_SUCCESS: successful count, possibly some other error.
2146 * @since libnotmuch 5.2 (notmuch 0.27)
2149 notmuch_message_count_properties (notmuch_message_t *message, const char *key, unsigned int *count);
2152 * Is the given *properties* iterator pointing at a valid (key,value)
2155 * When this function returns TRUE,
2156 * notmuch_message_properties_{key,value} will return a valid string,
2157 * and notmuch_message_properties_move_to_next will do what it
2158 * says. Whereas when this function returns FALSE, calling any of
2159 * these functions results in undefined behaviour.
2161 * See the documentation of notmuch_message_get_properties for example
2162 * code showing how to iterate over a notmuch_message_properties_t
2165 * @since libnotmuch 4.4 (notmuch 0.23)
2168 notmuch_message_properties_valid (notmuch_message_properties_t *properties);
2171 * Move the *properties* iterator to the next (key,value) pair
2173 * If *properties* is already pointing at the last pair then the iterator
2174 * will be moved to a point just beyond that last pair, (where
2175 * notmuch_message_properties_valid will return FALSE).
2177 * See the documentation of notmuch_message_get_properties for example
2178 * code showing how to iterate over a notmuch_message_properties_t object.
2180 * @since libnotmuch 4.4 (notmuch 0.23)
2183 notmuch_message_properties_move_to_next (notmuch_message_properties_t *properties);
2186 * Return the key from the current (key,value) pair.
2188 * this could be useful if iterating for a prefix
2190 * @since libnotmuch 4.4 (notmuch 0.23)
2193 notmuch_message_properties_key (notmuch_message_properties_t *properties);
2196 * Return the value from the current (key,value) pair.
2198 * This could be useful if iterating for a prefix.
2200 * @since libnotmuch 4.4 (notmuch 0.23)
2203 notmuch_message_properties_value (notmuch_message_properties_t *properties);
2207 * Destroy a notmuch_message_properties_t object.
2209 * It's not strictly necessary to call this function. All memory from
2210 * the notmuch_message_properties_t object will be reclaimed when the
2211 * containing message object is destroyed.
2213 * @since libnotmuch 4.4 (notmuch 0.23)
2216 notmuch_message_properties_destroy (notmuch_message_properties_t *properties);
2221 * Is the given 'tags' iterator pointing at a valid tag.
2223 * When this function returns TRUE, notmuch_tags_get will return a
2224 * valid string. Whereas when this function returns FALSE,
2225 * notmuch_tags_get will return NULL.
2227 * See the documentation of notmuch_message_get_tags for example code
2228 * showing how to iterate over a notmuch_tags_t object.
2231 notmuch_tags_valid (notmuch_tags_t *tags);
2234 * Get the current tag from 'tags' as a string.
2236 * Note: The returned string belongs to 'tags' and has a lifetime
2237 * identical to it (and the query to which it ultimately belongs).
2239 * See the documentation of notmuch_message_get_tags for example code
2240 * showing how to iterate over a notmuch_tags_t object.
2243 notmuch_tags_get (notmuch_tags_t *tags);
2246 * Move the 'tags' iterator to the next tag.
2248 * If 'tags' is already pointing at the last tag then the iterator
2249 * will be moved to a point just beyond that last tag, (where
2250 * notmuch_tags_valid will return FALSE and notmuch_tags_get will
2253 * See the documentation of notmuch_message_get_tags for example code
2254 * showing how to iterate over a notmuch_tags_t object.
2257 notmuch_tags_move_to_next (notmuch_tags_t *tags);
2260 * Destroy a notmuch_tags_t object.
2262 * It's not strictly necessary to call this function. All memory from
2263 * the notmuch_tags_t object will be reclaimed when the containing
2264 * message or query objects are destroyed.
2267 notmuch_tags_destroy (notmuch_tags_t *tags);
2270 * Store an mtime within the database for 'directory'.
2272 * The 'directory' should be an object retrieved from the database
2273 * with notmuch_database_get_directory for a particular path.
2275 * The intention is for the caller to use the mtime to allow efficient
2276 * identification of new messages to be added to the database. The
2277 * recommended usage is as follows:
2279 * o Read the mtime of a directory from the filesystem
2281 * o Call index_file for all mail files in the directory
2283 * o Call notmuch_directory_set_mtime with the mtime read from the
2286 * Then, when wanting to check for updates to the directory in the
2287 * future, the client can call notmuch_directory_get_mtime and know
2288 * that it only needs to add files if the mtime of the directory and
2289 * files are newer than the stored timestamp.
2291 * Note: The notmuch_directory_get_mtime function does not allow the
2292 * caller to distinguish a timestamp of 0 from a non-existent
2293 * timestamp. So don't store a timestamp of 0 unless you are
2294 * comfortable with that.
2298 * NOTMUCH_STATUS_SUCCESS: mtime successfully stored in database.
2300 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception
2301 * occurred, mtime not stored.
2303 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
2304 * mode so directory mtime cannot be modified.
2307 notmuch_directory_set_mtime (notmuch_directory_t *directory,
2311 * Get the mtime of a directory, (as previously stored with
2312 * notmuch_directory_set_mtime).
2314 * Returns 0 if no mtime has previously been stored for this
2318 notmuch_directory_get_mtime (notmuch_directory_t *directory);
2321 * Get a notmuch_filenames_t iterator listing all the filenames of
2322 * messages in the database within the given directory.
2324 * The returned filenames will be the basename-entries only (not
2327 * Returns NULL if it triggers a Xapian exception
2329 notmuch_filenames_t *
2330 notmuch_directory_get_child_files (notmuch_directory_t *directory);
2333 * Get a notmuch_filenames_t iterator listing all the filenames of
2334 * sub-directories in the database within the given directory.
2336 * The returned filenames will be the basename-entries only (not
2339 * Returns NULL if it triggers a Xapian exception
2341 notmuch_filenames_t *
2342 notmuch_directory_get_child_directories (notmuch_directory_t *directory);
2345 * Delete directory document from the database, and destroy the
2346 * notmuch_directory_t object. Assumes any child directories and files
2347 * have been deleted by the caller.
2349 * @since libnotmuch 4.3 (notmuch 0.21)
2352 notmuch_directory_delete (notmuch_directory_t *directory);
2355 * Destroy a notmuch_directory_t object.
2358 notmuch_directory_destroy (notmuch_directory_t *directory);
2361 * Is the given 'filenames' iterator pointing at a valid filename.
2363 * When this function returns TRUE, notmuch_filenames_get will return
2364 * a valid string. Whereas when this function returns FALSE,
2365 * notmuch_filenames_get will return NULL.
2367 * It is acceptable to pass NULL for 'filenames', in which case this
2368 * function will always return FALSE.
2371 notmuch_filenames_valid (notmuch_filenames_t *filenames);
2374 * Get the current filename from 'filenames' as a string.
2376 * Note: The returned string belongs to 'filenames' and has a lifetime
2377 * identical to it (and the directory to which it ultimately belongs).
2379 * It is acceptable to pass NULL for 'filenames', in which case this
2380 * function will always return NULL.
2383 notmuch_filenames_get (notmuch_filenames_t *filenames);
2386 * Move the 'filenames' iterator to the next filename.
2388 * If 'filenames' is already pointing at the last filename then the
2389 * iterator will be moved to a point just beyond that last filename,
2390 * (where notmuch_filenames_valid will return FALSE and
2391 * notmuch_filenames_get will return NULL).
2393 * It is acceptable to pass NULL for 'filenames', in which case this
2394 * function will do nothing.
2397 notmuch_filenames_move_to_next (notmuch_filenames_t *filenames);
2400 * Destroy a notmuch_filenames_t object.
2402 * It's not strictly necessary to call this function. All memory from
2403 * the notmuch_filenames_t object will be reclaimed when the
2404 * containing directory object is destroyed.
2406 * It is acceptable to pass NULL for 'filenames', in which case this
2407 * function will do nothing.
2410 notmuch_filenames_destroy (notmuch_filenames_t *filenames);
2414 * set config 'key' to 'value'
2416 * @since libnotmuch 4.4 (notmuch 0.23)
2417 * @retval #NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in
2418 * read-only mode so message cannot be modified.
2419 * @retval #NOTMUCH_STATUS_XAPIAN_EXCEPTION: an exception was thrown
2420 * accessing the database.
2421 * @retval #NOTMUCH_STATUS_SUCCESS
2424 notmuch_database_set_config (notmuch_database_t *db, const char *key, const char *value);
2427 * retrieve config item 'key', assign to 'value'
2429 * keys which have not been previously set with n_d_set_config will
2430 * return an empty string.
2432 * return value is allocated by malloc and should be freed by the
2435 * @since libnotmuch 4.4 (notmuch 0.23)
2439 notmuch_database_get_config (notmuch_database_t *db, const char *key, char **value);
2442 * Create an iterator for all config items with keys matching a given prefix
2444 * @since libnotmuch 4.4 (notmuch 0.23)
2447 notmuch_database_get_config_list (notmuch_database_t *db, const char *prefix,
2448 notmuch_config_list_t **out);
2451 * Is 'config_list' iterator valid (i.e. _key, _value, _move_to_next can be called).
2453 * @since libnotmuch 4.4 (notmuch 0.23)
2456 notmuch_config_list_valid (notmuch_config_list_t *config_list);
2459 * return key for current config pair
2461 * return value is owned by the iterator, and will be destroyed by the
2462 * next call to notmuch_config_list_key or notmuch_config_list_destroy.
2464 * @since libnotmuch 4.4 (notmuch 0.23)
2467 notmuch_config_list_key (notmuch_config_list_t *config_list);
2470 * return 'value' for current config pair
2472 * return value is owned by the iterator, and will be destroyed by the
2473 * next call to notmuch_config_list_value or notmuch config_list_destroy
2475 * @since libnotmuch 4.4 (notmuch 0.23)
2476 * @retval NULL for errors
2479 notmuch_config_list_value (notmuch_config_list_t *config_list);
2483 * move 'config_list' iterator to the next pair
2485 * @since libnotmuch 4.4 (notmuch 0.23)
2488 notmuch_config_list_move_to_next (notmuch_config_list_t *config_list);
2491 * free any resources held by 'config_list'
2493 * @since libnotmuch 4.4 (notmuch 0.23)
2496 notmuch_config_list_destroy (notmuch_config_list_t *config_list);
2499 * Configuration keys known to libnotmuch
2501 typedef enum _notmuch_config_key {
2502 NOTMUCH_CONFIG_FIRST,
2503 NOTMUCH_CONFIG_DATABASE_PATH = NOTMUCH_CONFIG_FIRST,
2504 NOTMUCH_CONFIG_MAIL_ROOT,
2505 NOTMUCH_CONFIG_HOOK_DIR,
2506 NOTMUCH_CONFIG_BACKUP_DIR,
2507 NOTMUCH_CONFIG_EXCLUDE_TAGS,
2508 NOTMUCH_CONFIG_NEW_TAGS,
2509 NOTMUCH_CONFIG_NEW_IGNORE,
2510 NOTMUCH_CONFIG_SYNC_MAILDIR_FLAGS,
2511 NOTMUCH_CONFIG_PRIMARY_EMAIL,
2512 NOTMUCH_CONFIG_OTHER_EMAIL,
2513 NOTMUCH_CONFIG_USER_NAME,
2515 } notmuch_config_key_t;
2518 * get a configuration value from an open database.
2520 * This value reflects all configuration information given at the time
2521 * the database was opened.
2523 * @param[in] notmuch database
2524 * @param[in] key configuration key
2526 * @since libnotmuch 5.4 (notmuch 0.32)
2528 * @retval NULL if 'key' unknown or if no value is known for
2529 * 'key'. Otherwise returns a string owned by notmuch which should
2530 * not be modified nor freed by the caller.
2533 notmuch_config_get (notmuch_database_t *notmuch, notmuch_config_key_t key);
2536 * set a configuration value from in an open database.
2538 * This value reflects all configuration information given at the time
2539 * the database was opened.
2541 * @param[in,out] notmuch database open read/write
2542 * @param[in] key configuration key
2543 * @param[in] val configuration value
2545 * @since libnotmuch 5.4 (notmuch 0.32)
2547 * @retval returns any return value for notmuch_database_set_config.
2550 notmuch_config_set (notmuch_database_t *notmuch, notmuch_config_key_t key, const char *val);
2553 * Returns an iterator for a ';'-delimited list of configuration values
2555 * These values reflect all configuration information given at the
2556 * time the database was opened.
2558 * @param[in] notmuch database
2559 * @param[in] key configuration key
2561 * @since libnotmuch 5.4 (notmuch 0.32)
2563 * @retval NULL in case of error.
2565 notmuch_config_values_t *
2566 notmuch_config_get_values (notmuch_database_t *notmuch, notmuch_config_key_t key);
2569 * Returns an iterator for a ';'-delimited list of configuration values
2571 * These values reflect all configuration information given at the
2572 * time the database was opened.
2574 * @param[in] notmuch database
2575 * @param[in] key configuration key
2577 * @since libnotmuch 5.4 (notmuch 0.32)
2579 * @retval NULL in case of error.
2581 notmuch_config_values_t *
2582 notmuch_config_get_values_string (notmuch_database_t *notmuch, const char *key);
2585 * Is the given 'config_values' iterator pointing at a valid element.
2587 * @param[in] values iterator
2589 * @since libnotmuch 5.4 (notmuch 0.32)
2591 * @retval FALSE if passed a NULL pointer, or the iterator is exhausted.
2595 notmuch_config_values_valid (notmuch_config_values_t *values);
2598 * Get the current value from the 'values' iterator
2600 * @param[in] values iterator
2602 * @since libnotmuch 5.4 (notmuch 0.32)
2604 * @retval a string with the same lifetime as the iterator
2607 notmuch_config_values_get (notmuch_config_values_t *values);
2610 * Move the 'values' iterator to the next element
2612 * @param[in,out] values iterator
2614 * @since libnotmuch 5.4 (notmuch 0.32)
2618 notmuch_config_values_move_to_next (notmuch_config_values_t *values);
2622 * reset the 'values' iterator to the first element
2624 * @param[in,out] values iterator. A NULL value is ignored.
2626 * @since libnotmuch 5.4 (notmuch 0.32)
2630 notmuch_config_values_start (notmuch_config_values_t *values);
2633 * Destroy a config values iterator, along with any associated
2636 * @param[in,out] values iterator
2638 * @since libnotmuch 5.4 (notmuch 0.32)
2641 notmuch_config_values_destroy (notmuch_config_values_t *values);
2645 * Returns an iterator for a (key, value) configuration pairs
2647 * @param[in] notmuch database
2648 * @param[in] prefix prefix for keys. Pass "" for all keys.
2650 * @since libnotmuch 5.4 (notmuch 0.32)
2652 * @retval NULL in case of error.
2654 notmuch_config_pairs_t *
2655 notmuch_config_get_pairs (notmuch_database_t *notmuch,
2656 const char *prefix);
2659 * Is the given 'config_pairs' iterator pointing at a valid element.
2661 * @param[in] pairs iterator
2663 * @since libnotmuch 5.4 (notmuch 0.32)
2665 * @retval FALSE if passed a NULL pointer, or the iterator is exhausted.
2669 notmuch_config_pairs_valid (notmuch_config_pairs_t *pairs);
2672 * Move the 'config_pairs' iterator to the next element
2674 * @param[in,out] pairs iterator
2676 * @since libnotmuch 5.4 (notmuch 0.32)
2680 notmuch_config_pairs_move_to_next (notmuch_config_pairs_t *pairs);
2683 * Get the current key from the 'config_pairs' iterator
2685 * @param[in] pairs iterator
2687 * @since libnotmuch 5.4 (notmuch 0.32)
2689 * @retval a string with the same lifetime as the iterator
2692 notmuch_config_pairs_key (notmuch_config_pairs_t *pairs);
2695 * Get the current value from the 'config_pairs' iterator
2697 * @param[in] pairs iterator
2699 * @since libnotmuch 5.4 (notmuch 0.32)
2701 * @retval a string with the same lifetime as the iterator
2704 notmuch_config_pairs_value (notmuch_config_pairs_t *pairs);
2707 * Destroy a config_pairs iterator, along with any associated
2710 * @param[in,out] pairs iterator
2712 * @since libnotmuch 5.4 (notmuch 0.32)
2715 notmuch_config_pairs_destroy (notmuch_config_pairs_t *pairs);
2718 * get a configuration value from an open database as Boolean
2720 * This value reflects all configuration information given at the time
2721 * the database was opened.
2723 * @param[in] notmuch database
2724 * @param[in] key configuration key
2725 * @param[out] val configuration value, converted to Boolean
2727 * @since libnotmuch 5.4 (notmuch 0.32)
2729 * @retval #NOTMUCH_STATUS_ILLEGAL_ARGUMENT if either key is unknown
2730 * or the corresponding value does not convert to Boolean.
2733 notmuch_config_get_bool (notmuch_database_t *notmuch,
2734 notmuch_config_key_t key,
2735 notmuch_bool_t *val);
2737 * get the current default indexing options for a given database.
2739 * This object will survive until the database itself is destroyed,
2740 * but the caller may also release it earlier with
2741 * notmuch_indexopts_destroy.
2743 * This object represents a set of options on how a message can be
2744 * added to the index. At the moment it is a featureless stub.
2746 * @since libnotmuch 5.1 (notmuch 0.26)
2747 * @retval NULL in case of error
2749 notmuch_indexopts_t *
2750 notmuch_database_get_default_indexopts (notmuch_database_t *db);
2753 * Stating a policy about how to decrypt messages.
2755 * See index.decrypt in notmuch-config(1) for more details.
2758 NOTMUCH_DECRYPT_FALSE,
2759 NOTMUCH_DECRYPT_TRUE,
2760 NOTMUCH_DECRYPT_AUTO,
2761 NOTMUCH_DECRYPT_NOSTASH,
2762 } notmuch_decryption_policy_t;
2765 * Specify whether to decrypt encrypted parts while indexing.
2767 * Be aware that the index is likely sufficient to reconstruct the
2768 * cleartext of the message itself, so please ensure that the notmuch
2769 * message index is adequately protected. DO NOT SET THIS FLAG TO TRUE
2770 * without considering the security of your index.
2772 * @since libnotmuch 5.1 (notmuch 0.26)
2775 notmuch_indexopts_set_decrypt_policy (notmuch_indexopts_t *indexopts,
2776 notmuch_decryption_policy_t decrypt_policy);
2779 * Return whether to decrypt encrypted parts while indexing.
2780 * see notmuch_indexopts_set_decrypt_policy.
2782 * @since libnotmuch 5.1 (notmuch 0.26)
2784 notmuch_decryption_policy_t
2785 notmuch_indexopts_get_decrypt_policy (const notmuch_indexopts_t *indexopts);
2788 * Destroy a notmuch_indexopts_t object.
2790 * @since libnotmuch 5.1 (notmuch 0.26)
2793 notmuch_indexopts_destroy (notmuch_indexopts_t *options);
2797 * interrogate the library for compile time features
2799 * @since libnotmuch 4.4 (notmuch 0.23)
2802 notmuch_built_with (const char *name);
2805 #pragma GCC visibility pop