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 * Not an actual status value. Just a way to find out how many
213 * valid status values there are.
215 NOTMUCH_STATUS_LAST_STATUS
219 * Get a string representation of a notmuch_status_t value.
221 * The result is read-only.
224 notmuch_status_to_string (notmuch_status_t status);
226 /* Various opaque data types. For each notmuch_<foo>_t see the various
227 * notmuch_<foo> functions below. */
229 typedef struct _notmuch_database notmuch_database_t;
230 typedef struct _notmuch_query notmuch_query_t;
231 typedef struct _notmuch_threads notmuch_threads_t;
232 typedef struct _notmuch_thread notmuch_thread_t;
233 typedef struct _notmuch_messages notmuch_messages_t;
234 typedef struct _notmuch_message notmuch_message_t;
235 typedef struct _notmuch_tags notmuch_tags_t;
236 typedef struct _notmuch_directory notmuch_directory_t;
237 typedef struct _notmuch_filenames notmuch_filenames_t;
238 typedef struct _notmuch_config_list notmuch_config_list_t;
239 typedef struct _notmuch_indexopts notmuch_indexopts_t;
240 #endif /* __DOXYGEN__ */
243 * Create a new, empty notmuch database located at 'path'.
245 * The path should be a top-level directory to a collection of
246 * plain-text email messages (one message per file). This call will
247 * create a new ".notmuch" directory within 'path' where notmuch will
250 * After a successful call to notmuch_database_create, the returned
251 * database will be open so the caller should call
252 * notmuch_database_destroy when finished with it.
254 * The database will not yet have any data in it
255 * (notmuch_database_create itself is a very cheap function). Messages
256 * contained within 'path' can be added to the database by calling
257 * notmuch_database_index_file.
259 * In case of any failure, this function returns an error status and
260 * sets *database to NULL (after printing an error message on stderr).
264 * NOTMUCH_STATUS_SUCCESS: Successfully created the database.
266 * NOTMUCH_STATUS_NULL_POINTER: The given 'path' argument is NULL.
268 * NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory.
270 * NOTMUCH_STATUS_FILE_ERROR: An error occurred trying to create the
271 * database file (such as permission denied, or file not found,
272 * etc.), or the database already exists.
274 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred.
277 notmuch_database_create (const char *path, notmuch_database_t **database);
280 * Like notmuch_database_create, except optionally return an error
281 * message. This message is allocated by malloc and should be freed by
285 notmuch_database_create_verbose (const char *path,
286 notmuch_database_t **database,
287 char **error_message);
290 * Database open mode for notmuch_database_open.
294 * Open database for reading only.
296 NOTMUCH_DATABASE_MODE_READ_ONLY = 0,
298 * Open database for reading and writing.
300 NOTMUCH_DATABASE_MODE_READ_WRITE
301 } notmuch_database_mode_t;
304 * Deprecated alias for notmuch_database_open_with_config with
305 * config_path=error_message=NULL
306 * @deprecated Deprecated as of libnotmuch 5.4 (notmuch 0.32)
308 /* NOTMUCH_DEPRECATED(5, 4) */
310 notmuch_database_open (const char *path,
311 notmuch_database_mode_t mode,
312 notmuch_database_t **database);
314 * Deprecated alias for notmuch_database_open_with_config with
317 * @deprecated Deprecated as of libnotmuch 5.4 (notmuch 0.32)
320 /* NOTMUCH_DEPRECATED(5, 4) */
322 notmuch_database_open_verbose (const char *path,
323 notmuch_database_mode_t mode,
324 notmuch_database_t **database,
325 char **error_message);
328 * Open an existing notmuch database located at 'database_path', using
329 * configuration in 'config_path'.
331 * @param[in] database_path
333 * Path to existing database.
335 * A notmuch database is a Xapian database containing appropriate
338 * The database should have been created at some time in the past,
339 * (not necessarily by this process), by calling
340 * notmuch_database_create.
342 * If 'database_path' is NULL, use the location specified
344 * - in the environment variable NOTMUCH_DATABASE, if non-empty
346 * - in a configuration file, located as described under 'config_path'
348 * - by $XDG_DATA_HOME/notmuch/$PROFILE where XDG_DATA_HOME defaults
349 * to "$HOME/.local/share" and PROFILE as as discussed in
352 * If 'database_path' is non-NULL, but does not appear to be a Xapian
353 * database, check for a directory '.notmuch/xapian' below
354 * 'database_path' (this is the behavior of
355 * notmuch_database_open_verbose pre-0.32).
360 * Mode to open database. Use one of #NOTMUCH_DATABASE_MODE_READ_WRITE
361 * or #NOTMUCH_DATABASE_MODE_READ_ONLY
364 * @param[in] config_path
366 * Path to config file.
368 * Config file is key-value, with mandatory sections. See
369 * <em>notmuch-config(5)</em> for more information. The key-value pair
370 * overrides the corresponding configuration data stored in the
371 * database (see <em>notmuch_database_get_config</em>)
373 * If <em>config_path</em> is NULL use the path specified
375 * - in environment variable <em>NOTMUCH_CONFIG</em>, if non-empty
377 * - by <em>XDG_CONFIG_HOME</em>/notmuch/ where
378 * XDG_CONFIG_HOME defaults to "$HOME/.config".
380 * - by $HOME/.notmuch-config
382 * If <em>config_path</em> is "" (empty string) then do not
383 * open any configuration file.
385 * @param[in] profile:
387 * Name of profile (configuration/database variant).
389 * If non-NULL, append to the directory / file path determined for
390 * <em>config_path</em> and <em>database_path</em>.
393 * - environment variable NOTMUCH_PROFILE if defined,
394 * - otherwise "default" for directories and "" (empty string) for paths.
397 * @param[out] database
399 * Pointer to database object. May not be NULL.
401 * The caller should call notmuch_database_destroy when finished with
404 * In case of any failure, this function returns an error status and
405 * sets *database to NULL.
408 * @param[out] error_message
409 * If non-NULL, store error message from opening the database.
410 * Any such message is allocated by \a malloc(3) and should be freed
413 * @retval NOTMUCH_STATUS_SUCCESS: Successfully opened the database.
415 * @retval NOTMUCH_STATUS_NULL_POINTER: The given \a database
418 * @retval NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory.
420 * @retval NOTMUCH_STATUS_FILE_ERROR: An error occurred trying to open the
421 * database or config file (such as permission denied, or file not found,
422 * etc.), or the database version is unknown.
424 * @retval NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred.
426 * @since libnotmuch 5.4 (notmuch 0.32)
430 notmuch_database_open_with_config (const char *database_path,
431 notmuch_database_mode_t mode,
432 const char *config_path,
434 notmuch_database_t **database,
435 char **error_message);
438 * Retrieve last status string for given database.
442 notmuch_database_status_string (const notmuch_database_t *notmuch);
445 * Commit changes and close the given notmuch database.
447 * After notmuch_database_close has been called, calls to other
448 * functions on objects derived from this database may either behave
449 * as if the database had not been closed (e.g., if the required data
450 * has been cached) or may fail with a
451 * NOTMUCH_STATUS_XAPIAN_EXCEPTION. The only further operation
452 * permitted on the database itself is to call
453 * notmuch_database_destroy.
455 * notmuch_database_close can be called multiple times. Later calls
458 * For writable databases, notmuch_database_close commits all changes
459 * to disk before closing the database. If the caller is currently in
460 * an atomic section (there was a notmuch_database_begin_atomic
461 * without a matching notmuch_database_end_atomic), this will discard
462 * changes made in that atomic section (but still commit changes made
463 * prior to entering the atomic section).
467 * NOTMUCH_STATUS_SUCCESS: Successfully closed the database.
469 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred; the
470 * database has been closed but there are no guarantees the
471 * changes to the database, if any, have been flushed to disk.
474 notmuch_database_close (notmuch_database_t *database);
477 * A callback invoked by notmuch_database_compact to notify the user
478 * of the progress of the compaction process.
480 typedef void (*notmuch_compact_status_cb_t)(const char *message, void *closure);
483 * Compact a notmuch database, backing up the original database to the
486 * The database will be opened with NOTMUCH_DATABASE_MODE_READ_WRITE
487 * during the compaction process to ensure no writes are made.
489 * If the optional callback function 'status_cb' is non-NULL, it will
490 * be called with diagnostic and informational messages. The argument
491 * 'closure' is passed verbatim to any callback invoked.
494 notmuch_database_compact (const char *path,
495 const char *backup_path,
496 notmuch_compact_status_cb_t status_cb,
500 * Destroy the notmuch database, closing it if necessary and freeing
501 * all associated resources.
503 * Return value as in notmuch_database_close if the database was open;
504 * notmuch_database_destroy itself has no failure modes.
507 notmuch_database_destroy (notmuch_database_t *database);
510 * Return the database path of the given database.
512 * The return value is a string owned by notmuch so should not be
513 * modified nor freed by the caller.
516 notmuch_database_get_path (notmuch_database_t *database);
519 * Return the database format version of the given database.
524 notmuch_database_get_version (notmuch_database_t *database);
527 * Can the database be upgraded to a newer database version?
529 * If this function returns TRUE, then the caller may call
530 * notmuch_database_upgrade to upgrade the database. If the caller
531 * does not upgrade an out-of-date database, then some functions may
532 * fail with NOTMUCH_STATUS_UPGRADE_REQUIRED. This always returns
533 * FALSE for a read-only database because there's no way to upgrade a
534 * read-only database.
536 * Also returns FALSE if an error occurs accessing the database.
540 notmuch_database_needs_upgrade (notmuch_database_t *database);
543 * Upgrade the current database to the latest supported version.
545 * This ensures that all current notmuch functionality will be
546 * available on the database. After opening a database in read-write
547 * mode, it is recommended that clients check if an upgrade is needed
548 * (notmuch_database_needs_upgrade) and if so, upgrade with this
549 * function before making any modifications. If
550 * notmuch_database_needs_upgrade returns FALSE, this will be a no-op.
552 * The optional progress_notify callback can be used by the caller to
553 * provide progress indication to the user. If non-NULL it will be
554 * called periodically with 'progress' as a floating-point value in
555 * the range of [0.0 .. 1.0] indicating the progress made so far in
556 * the upgrade process. The argument 'closure' is passed verbatim to
557 * any callback invoked.
560 notmuch_database_upgrade (notmuch_database_t *database,
561 void (*progress_notify)(void *closure,
566 * Begin an atomic database operation.
568 * Any modifications performed between a successful begin and a
569 * notmuch_database_end_atomic will be applied to the database
570 * atomically. Note that, unlike a typical database transaction, this
571 * only ensures atomicity, not durability; neither begin nor end
572 * necessarily flush modifications to disk.
574 * Atomic sections may be nested. begin_atomic and end_atomic must
575 * always be called in pairs.
579 * NOTMUCH_STATUS_SUCCESS: Successfully entered atomic section.
581 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred;
582 * atomic section not entered.
585 notmuch_database_begin_atomic (notmuch_database_t *notmuch);
588 * Indicate the end of an atomic database operation.
592 * NOTMUCH_STATUS_SUCCESS: Successfully completed atomic section.
594 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred;
595 * atomic section not ended.
597 * NOTMUCH_STATUS_UNBALANCED_ATOMIC: The database is not currently in
601 notmuch_database_end_atomic (notmuch_database_t *notmuch);
604 * Return the committed database revision and UUID.
606 * The database revision number increases monotonically with each
607 * commit to the database. Hence, all messages and message changes
608 * committed to the database (that is, visible to readers) have a last
609 * modification revision <= the committed database revision. Any
610 * messages committed in the future will be assigned a modification
611 * revision > the committed database revision.
613 * The UUID is a NUL-terminated opaque string that uniquely identifies
614 * this database. Two revision numbers are only comparable if they
615 * have the same database UUID.
618 notmuch_database_get_revision (notmuch_database_t *notmuch,
622 * Retrieve a directory object from the database for 'path'.
624 * Here, 'path' should be a path relative to the path of 'database'
625 * (see notmuch_database_get_path), or else should be an absolute path
626 * with initial components that match the path of 'database'.
628 * If this directory object does not exist in the database, this
629 * returns NOTMUCH_STATUS_SUCCESS and sets *directory to NULL.
631 * Otherwise the returned directory object is owned by the database
632 * and as such, will only be valid until notmuch_database_destroy is
637 * NOTMUCH_STATUS_SUCCESS: Successfully retrieved directory.
639 * NOTMUCH_STATUS_NULL_POINTER: The given 'directory' argument is NULL.
641 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred;
642 * directory not retrieved.
644 * NOTMUCH_STATUS_UPGRADE_REQUIRED: The caller must upgrade the
645 * database to use this function.
648 notmuch_database_get_directory (notmuch_database_t *database,
650 notmuch_directory_t **directory);
653 * Add a message file to a database, indexing it for retrieval by
654 * future searches. If a message already exists with the same message
655 * ID as the specified file, their indexes will be merged, and this
656 * new filename will also be associated with the existing message.
658 * Here, 'filename' should be a path relative to the path of
659 * 'database' (see notmuch_database_get_path), or else should be an
660 * absolute filename with initial components that match the path of
663 * The file should be a single mail message (not a multi-message mbox)
664 * that is expected to remain at its current location, (since the
665 * notmuch database will reference the filename, and will not copy the
666 * entire contents of the file.
668 * If another message with the same message ID already exists in the
669 * database, rather than creating a new message, this adds the search
670 * terms from the identified file to the existing message's index, and
671 * adds 'filename' to the list of filenames known for the message.
673 * The 'indexopts' parameter can be NULL (meaning, use the indexing
674 * defaults from the database), or can be an explicit choice of
675 * indexing options that should govern the indexing of this specific
678 * If 'message' is not NULL, then, on successful return
679 * (NOTMUCH_STATUS_SUCCESS or NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID) '*message'
680 * will be initialized to a message object that can be used for things
681 * such as adding tags to the just-added message. The user should call
682 * notmuch_message_destroy when done with the message. On any failure
683 * '*message' will be set to NULL.
687 * NOTMUCH_STATUS_SUCCESS: Message successfully added to database.
689 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred,
692 * NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID: Message has the same message
693 * ID as another message already in the database. The new
694 * filename was successfully added to the message in the database
695 * (if not already present) and the existing message is returned.
697 * NOTMUCH_STATUS_FILE_ERROR: an error occurred trying to open the
698 * file, (such as permission denied, or file not found,
699 * etc.). Nothing added to the database.
701 * NOTMUCH_STATUS_FILE_NOT_EMAIL: the contents of filename don't look
702 * like an email message. Nothing added to the database.
704 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
705 * mode so no message can be added.
707 * NOTMUCH_STATUS_UPGRADE_REQUIRED: The caller must upgrade the
708 * database to use this function.
710 * @since libnotmuch 5.1 (notmuch 0.26)
713 notmuch_database_index_file (notmuch_database_t *database,
714 const char *filename,
715 notmuch_indexopts_t *indexopts,
716 notmuch_message_t **message);
719 * Deprecated alias for notmuch_database_index_file called with
722 * @deprecated Deprecated as of libnotmuch 5.1 (notmuch 0.26). Please
723 * use notmuch_database_index_file instead.
726 NOTMUCH_DEPRECATED (5, 1)
728 notmuch_database_add_message (notmuch_database_t *database,
729 const char *filename,
730 notmuch_message_t **message);
733 * Remove a message filename from the given notmuch database. If the
734 * message has no more filenames, remove the message.
736 * If the same message (as determined by the message ID) is still
737 * available via other filenames, then the message will persist in the
738 * database for those filenames. When the last filename is removed for
739 * a particular message, the database content for that message will be
744 * NOTMUCH_STATUS_SUCCESS: The last filename was removed and the
745 * message was removed from the database.
747 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred,
748 * message not removed.
750 * NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID: This filename was removed but
751 * the message persists in the database with at least one other
754 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
755 * mode so no message can be removed.
757 * NOTMUCH_STATUS_UPGRADE_REQUIRED: The caller must upgrade the
758 * database to use this function.
761 notmuch_database_remove_message (notmuch_database_t *database,
762 const char *filename);
765 * Find a message with the given message_id.
767 * If a message with the given message_id is found then, on successful return
768 * (NOTMUCH_STATUS_SUCCESS) '*message' will be initialized to a message
769 * object. The caller should call notmuch_message_destroy when done with the
772 * On any failure or when the message is not found, this function initializes
773 * '*message' to NULL. This means, when NOTMUCH_STATUS_SUCCESS is returned, the
774 * caller is supposed to check '*message' for NULL to find out whether the
775 * message with the given message_id was found.
779 * NOTMUCH_STATUS_SUCCESS: Successful return, check '*message'.
781 * NOTMUCH_STATUS_NULL_POINTER: The given 'message' argument is NULL
783 * NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory, creating message object
785 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred
788 notmuch_database_find_message (notmuch_database_t *database,
789 const char *message_id,
790 notmuch_message_t **message);
793 * Find a message with the given filename.
795 * If the database contains a message with the given filename then, on
796 * successful return (NOTMUCH_STATUS_SUCCESS) '*message' will be initialized to
797 * a message object. The caller should call notmuch_message_destroy when done
800 * On any failure or when the message is not found, this function initializes
801 * '*message' to NULL. This means, when NOTMUCH_STATUS_SUCCESS is returned, the
802 * caller is supposed to check '*message' for NULL to find out whether the
803 * message with the given filename is found.
807 * NOTMUCH_STATUS_SUCCESS: Successful return, check '*message'
809 * NOTMUCH_STATUS_NULL_POINTER: The given 'message' argument is NULL
811 * NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory, creating the message object
813 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred
815 * NOTMUCH_STATUS_UPGRADE_REQUIRED: The caller must upgrade the
816 * database to use this function.
819 notmuch_database_find_message_by_filename (notmuch_database_t *notmuch,
820 const char *filename,
821 notmuch_message_t **message);
824 * Return a list of all tags found in the database.
826 * This function creates a list of all tags found in the database. The
827 * resulting list contains all tags from all messages found in the database.
829 * On error this function returns NULL.
832 notmuch_database_get_all_tags (notmuch_database_t *db);
835 * Create a new query for 'database'.
837 * Here, 'database' should be an open database, (see
838 * notmuch_database_open and notmuch_database_create).
840 * For the query string, we'll document the syntax here more
841 * completely in the future, but it's likely to be a specialized
842 * version of the general Xapian query syntax:
844 * https://xapian.org/docs/queryparser.html
846 * As a special case, passing either a length-zero string, (that is ""),
847 * or a string consisting of a single asterisk (that is "*"), will
848 * result in a query that returns all messages in the database.
850 * See notmuch_query_set_sort for controlling the order of results.
851 * See notmuch_query_search_messages and notmuch_query_search_threads
852 * to actually execute the query.
854 * User should call notmuch_query_destroy when finished with this
857 * Will return NULL if insufficient memory is available.
860 notmuch_query_create (notmuch_database_t *database,
861 const char *query_string);
864 * Sort values for notmuch_query_set_sort.
870 NOTMUCH_SORT_OLDEST_FIRST,
874 NOTMUCH_SORT_NEWEST_FIRST,
876 * Sort by message-id.
878 NOTMUCH_SORT_MESSAGE_ID,
882 NOTMUCH_SORT_UNSORTED
886 * Return the query_string of this query. See notmuch_query_create.
889 notmuch_query_get_query_string (const notmuch_query_t *query);
892 * Return the notmuch database of this query. See notmuch_query_create.
895 notmuch_query_get_database (const notmuch_query_t *query);
898 * Exclude values for notmuch_query_set_omit_excluded. The strange
899 * order is to maintain backward compatibility: the old FALSE/TRUE
900 * options correspond to the new
901 * NOTMUCH_EXCLUDE_FLAG/NOTMUCH_EXCLUDE_TRUE options.
904 NOTMUCH_EXCLUDE_FLAG,
905 NOTMUCH_EXCLUDE_TRUE,
906 NOTMUCH_EXCLUDE_FALSE,
911 * Specify whether to omit excluded results or simply flag them. By
912 * default, this is set to TRUE.
914 * If set to TRUE or ALL, notmuch_query_search_messages will omit excluded
915 * messages from the results, and notmuch_query_search_threads will omit
916 * threads that match only in excluded messages. If set to TRUE,
917 * notmuch_query_search_threads will include all messages in threads that
918 * match in at least one non-excluded message. Otherwise, if set to ALL,
919 * notmuch_query_search_threads will omit excluded messages from all threads.
921 * If set to FALSE or FLAG then both notmuch_query_search_messages and
922 * notmuch_query_search_threads will return all matching
923 * messages/threads regardless of exclude status. If set to FLAG then
924 * the exclude flag will be set for any excluded message that is
925 * returned by notmuch_query_search_messages, and the thread counts
926 * for threads returned by notmuch_query_search_threads will be the
927 * number of non-excluded messages/matches. Otherwise, if set to
928 * FALSE, then the exclude status is completely ignored.
930 * The performance difference when calling
931 * notmuch_query_search_messages should be relatively small (and both
932 * should be very fast). However, in some cases,
933 * notmuch_query_search_threads is very much faster when omitting
934 * excluded messages as it does not need to construct the threads that
935 * only match in excluded messages.
938 notmuch_query_set_omit_excluded (notmuch_query_t *query,
939 notmuch_exclude_t omit_excluded);
942 * Specify the sorting desired for this query.
945 notmuch_query_set_sort (notmuch_query_t *query, notmuch_sort_t sort);
948 * Return the sort specified for this query. See
949 * notmuch_query_set_sort.
952 notmuch_query_get_sort (const notmuch_query_t *query);
955 * Add a tag that will be excluded from the query results by default.
956 * This exclusion will be ignored if this tag appears explicitly in
961 * NOTMUCH_STATUS_SUCCESS: excluded was added successfully.
963 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: a Xapian exception occurred.
964 * Most likely a problem lazily parsing the query string.
966 * NOTMUCH_STATUS_IGNORED: tag is explicitly present in the query, so
970 notmuch_query_add_tag_exclude (notmuch_query_t *query, const char *tag);
973 * Execute a query for threads, returning a notmuch_threads_t object
974 * which can be used to iterate over the results. The returned threads
975 * object is owned by the query and as such, will only be valid until
976 * notmuch_query_destroy.
978 * Typical usage might be:
980 * notmuch_query_t *query;
981 * notmuch_threads_t *threads;
982 * notmuch_thread_t *thread;
983 * notmuch_status_t stat;
985 * query = notmuch_query_create (database, query_string);
987 * for (stat = notmuch_query_search_threads (query, &threads);
988 * stat == NOTMUCH_STATUS_SUCCESS &&
989 * notmuch_threads_valid (threads);
990 * notmuch_threads_move_to_next (threads))
992 * thread = notmuch_threads_get (threads);
994 * notmuch_thread_destroy (thread);
997 * notmuch_query_destroy (query);
999 * Note: If you are finished with a thread before its containing
1000 * query, you can call notmuch_thread_destroy to clean up some memory
1001 * sooner (as in the above example). Otherwise, if your thread objects
1002 * are long-lived, then you don't need to call notmuch_thread_destroy
1003 * and all the memory will still be reclaimed when the query is
1006 * Note that there's no explicit destructor needed for the
1007 * notmuch_threads_t object. (For consistency, we do provide a
1008 * notmuch_threads_destroy function, but there's no good reason
1009 * to call it if the query is about to be destroyed).
1011 * @since libnotmuch 5.0 (notmuch 0.25)
1014 notmuch_query_search_threads (notmuch_query_t *query,
1015 notmuch_threads_t **out);
1018 * Deprecated alias for notmuch_query_search_threads.
1020 * @deprecated Deprecated as of libnotmuch 5 (notmuch 0.25). Please
1021 * use notmuch_query_search_threads instead.
1024 NOTMUCH_DEPRECATED (5, 0)
1026 notmuch_query_search_threads_st (notmuch_query_t *query, notmuch_threads_t **out);
1029 * Execute a query for messages, returning a notmuch_messages_t object
1030 * which can be used to iterate over the results. The returned
1031 * messages object is owned by the query and as such, will only be
1032 * valid until notmuch_query_destroy.
1034 * Typical usage might be:
1036 * notmuch_query_t *query;
1037 * notmuch_messages_t *messages;
1038 * notmuch_message_t *message;
1040 * query = notmuch_query_create (database, query_string);
1042 * for (messages = notmuch_query_search_messages (query);
1043 * notmuch_messages_valid (messages);
1044 * notmuch_messages_move_to_next (messages))
1046 * message = notmuch_messages_get (messages);
1048 * notmuch_message_destroy (message);
1051 * notmuch_query_destroy (query);
1053 * Note: If you are finished with a message before its containing
1054 * query, you can call notmuch_message_destroy to clean up some memory
1055 * sooner (as in the above example). Otherwise, if your message
1056 * objects are long-lived, then you don't need to call
1057 * notmuch_message_destroy and all the memory will still be reclaimed
1058 * when the query is destroyed.
1060 * Note that there's no explicit destructor needed for the
1061 * notmuch_messages_t object. (For consistency, we do provide a
1062 * notmuch_messages_destroy function, but there's no good
1063 * reason to call it if the query is about to be destroyed).
1065 * If a Xapian exception occurs this function will return NULL.
1067 * @since libnotmuch 5 (notmuch 0.25)
1070 notmuch_query_search_messages (notmuch_query_t *query,
1071 notmuch_messages_t **out);
1073 * Deprecated alias for notmuch_query_search_messages
1075 * @deprecated Deprecated as of libnotmuch 5 (notmuch 0.25). Please use
1076 * notmuch_query_search_messages instead.
1080 NOTMUCH_DEPRECATED (5, 0)
1082 notmuch_query_search_messages_st (notmuch_query_t *query,
1083 notmuch_messages_t **out);
1086 * Destroy a notmuch_query_t along with any associated resources.
1088 * This will in turn destroy any notmuch_threads_t and
1089 * notmuch_messages_t objects generated by this query, (and in
1090 * turn any notmuch_thread_t and notmuch_message_t objects generated
1091 * from those results, etc.), if such objects haven't already been
1095 notmuch_query_destroy (notmuch_query_t *query);
1098 * Is the given 'threads' iterator pointing at a valid thread.
1100 * When this function returns TRUE, notmuch_threads_get will return a
1101 * valid object. Whereas when this function returns FALSE,
1102 * notmuch_threads_get will return NULL.
1104 * If passed a NULL pointer, this function returns FALSE
1106 * See the documentation of notmuch_query_search_threads for example
1107 * code showing how to iterate over a notmuch_threads_t object.
1110 notmuch_threads_valid (notmuch_threads_t *threads);
1113 * Get the current thread from 'threads' as a notmuch_thread_t.
1115 * Note: The returned thread belongs to 'threads' and has a lifetime
1116 * identical to it (and the query to which it belongs).
1118 * See the documentation of notmuch_query_search_threads for example
1119 * code showing how to iterate over a notmuch_threads_t object.
1121 * If an out-of-memory situation occurs, this function will return
1125 notmuch_threads_get (notmuch_threads_t *threads);
1128 * Move the 'threads' iterator to the next thread.
1130 * If 'threads' is already pointing at the last thread then the
1131 * iterator will be moved to a point just beyond that last thread,
1132 * (where notmuch_threads_valid will return FALSE and
1133 * notmuch_threads_get will return NULL).
1135 * See the documentation of notmuch_query_search_threads for example
1136 * code showing how to iterate over a notmuch_threads_t object.
1139 notmuch_threads_move_to_next (notmuch_threads_t *threads);
1142 * Destroy a notmuch_threads_t object.
1144 * It's not strictly necessary to call this function. All memory from
1145 * the notmuch_threads_t object will be reclaimed when the
1146 * containing query object is destroyed.
1149 notmuch_threads_destroy (notmuch_threads_t *threads);
1152 * Return the number of messages matching a search.
1154 * This function performs a search and returns the number of matching
1159 * NOTMUCH_STATUS_SUCCESS: query completed successfully.
1161 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: a Xapian exception occurred. The
1162 * value of *count is not defined.
1164 * @since libnotmuch 5 (notmuch 0.25)
1167 notmuch_query_count_messages (notmuch_query_t *query, unsigned int *count);
1170 * Deprecated alias for notmuch_query_count_messages
1173 * @deprecated Deprecated since libnotmuch 5.0 (notmuch 0.25). Please
1174 * use notmuch_query_count_messages instead.
1176 NOTMUCH_DEPRECATED (5, 0)
1178 notmuch_query_count_messages_st (notmuch_query_t *query, unsigned int *count);
1181 * Return the number of threads matching a search.
1183 * This function performs a search and returns the number of unique thread IDs
1184 * in the matching messages. This is the same as number of threads matching a
1187 * Note that this is a significantly heavier operation than
1188 * notmuch_query_count_messages{_st}().
1192 * NOTMUCH_STATUS_OUT_OF_MEMORY: Memory allocation failed. The value
1193 * of *count is not defined
1195 * NOTMUCH_STATUS_SUCCESS: query completed successfully.
1197 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: a Xapian exception occurred. The
1198 * value of *count is not defined.
1200 * @since libnotmuch 5 (notmuch 0.25)
1203 notmuch_query_count_threads (notmuch_query_t *query, unsigned *count);
1206 * Deprecated alias for notmuch_query_count_threads
1208 * @deprecated Deprecated as of libnotmuch 5.0 (notmuch 0.25). Please
1209 * use notmuch_query_count_threads_st instead.
1211 NOTMUCH_DEPRECATED (5, 0)
1213 notmuch_query_count_threads_st (notmuch_query_t *query, unsigned *count);
1216 * Get the thread ID of 'thread'.
1218 * The returned string belongs to 'thread' and as such, should not be
1219 * modified by the caller and will only be valid for as long as the
1220 * thread is valid, (which is until notmuch_thread_destroy or until
1221 * the query from which it derived is destroyed).
1224 notmuch_thread_get_thread_id (notmuch_thread_t *thread);
1227 * Get the total number of messages in 'thread'.
1229 * This count consists of all messages in the database belonging to
1230 * this thread. Contrast with notmuch_thread_get_matched_messages() .
1233 notmuch_thread_get_total_messages (notmuch_thread_t *thread);
1236 * Get the total number of files in 'thread'.
1238 * This sums notmuch_message_count_files over all messages in the
1240 * @returns Non-negative integer
1241 * @since libnotmuch 5.0 (notmuch 0.25)
1245 notmuch_thread_get_total_files (notmuch_thread_t *thread);
1248 * Get a notmuch_messages_t iterator for the top-level messages in
1249 * 'thread' in oldest-first order.
1251 * This iterator will not necessarily iterate over all of the messages
1252 * in the thread. It will only iterate over the messages in the thread
1253 * which are not replies to other messages in the thread.
1255 * The returned list will be destroyed when the thread is destroyed.
1257 notmuch_messages_t *
1258 notmuch_thread_get_toplevel_messages (notmuch_thread_t *thread);
1261 * Get a notmuch_thread_t iterator for all messages in 'thread' in
1262 * oldest-first order.
1264 * The returned list will be destroyed when the thread is destroyed.
1266 notmuch_messages_t *
1267 notmuch_thread_get_messages (notmuch_thread_t *thread);
1270 * Get the number of messages in 'thread' that matched the search.
1272 * This count includes only the messages in this thread that were
1273 * matched by the search from which the thread was created and were
1274 * not excluded by any exclude tags passed in with the query (see
1275 * notmuch_query_add_tag_exclude). Contrast with
1276 * notmuch_thread_get_total_messages() .
1279 notmuch_thread_get_matched_messages (notmuch_thread_t *thread);
1282 * Get the authors of 'thread' as a UTF-8 string.
1284 * The returned string is a comma-separated list of the names of the
1285 * authors of mail messages in the query results that belong to this
1288 * The string contains authors of messages matching the query first, then
1289 * non-matched authors (with the two groups separated by '|'). Within
1290 * each group, authors are ordered by date.
1292 * The returned string belongs to 'thread' and as such, should not be
1293 * modified by the caller and will only be valid for as long as the
1294 * thread is valid, (which is until notmuch_thread_destroy or until
1295 * the query from which it derived is destroyed).
1298 notmuch_thread_get_authors (notmuch_thread_t *thread);
1301 * Get the subject of 'thread' as a UTF-8 string.
1303 * The subject is taken from the first message (according to the query
1304 * order---see notmuch_query_set_sort) in the query results that
1305 * belongs to this 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_subject (notmuch_thread_t *thread);
1316 * Get the date of the oldest message in 'thread' as a time_t value.
1319 notmuch_thread_get_oldest_date (notmuch_thread_t *thread);
1322 * Get the date of the newest message in 'thread' as a time_t value.
1325 notmuch_thread_get_newest_date (notmuch_thread_t *thread);
1328 * Get the tags for 'thread', returning a notmuch_tags_t object which
1329 * can be used to iterate over all tags.
1331 * Note: In the Notmuch database, tags are stored on individual
1332 * messages, not on threads. So the tags returned here will be all
1333 * tags of the messages which matched the search and which belong to
1336 * The tags object is owned by the thread and as such, will only be
1337 * valid for as long as the thread is valid, (for example, until
1338 * notmuch_thread_destroy or until the query from which it derived is
1341 * Typical usage might be:
1343 * notmuch_thread_t *thread;
1344 * notmuch_tags_t *tags;
1347 * thread = notmuch_threads_get (threads);
1349 * for (tags = notmuch_thread_get_tags (thread);
1350 * notmuch_tags_valid (tags);
1351 * notmuch_tags_move_to_next (tags))
1353 * tag = notmuch_tags_get (tags);
1357 * notmuch_thread_destroy (thread);
1359 * Note that there's no explicit destructor needed for the
1360 * notmuch_tags_t object. (For consistency, we do provide a
1361 * notmuch_tags_destroy function, but there's no good reason to call
1362 * it if the message is about to be destroyed).
1365 notmuch_thread_get_tags (notmuch_thread_t *thread);
1368 * Destroy a notmuch_thread_t object.
1371 notmuch_thread_destroy (notmuch_thread_t *thread);
1374 * Is the given 'messages' iterator pointing at a valid message.
1376 * When this function returns TRUE, notmuch_messages_get will return a
1377 * valid object. Whereas when this function returns FALSE,
1378 * notmuch_messages_get will return NULL.
1380 * See the documentation of notmuch_query_search_messages for example
1381 * code showing how to iterate over a notmuch_messages_t object.
1384 notmuch_messages_valid (notmuch_messages_t *messages);
1387 * Get the current message from 'messages' as a notmuch_message_t.
1389 * Note: The returned message belongs to 'messages' and has a lifetime
1390 * identical to it (and the query to which it belongs).
1392 * See the documentation of notmuch_query_search_messages for example
1393 * code showing how to iterate over a notmuch_messages_t object.
1395 * If an out-of-memory situation occurs, this function will return
1399 notmuch_messages_get (notmuch_messages_t *messages);
1402 * Move the 'messages' iterator to the next message.
1404 * If 'messages' is already pointing at the last message then the
1405 * iterator will be moved to a point just beyond that last message,
1406 * (where notmuch_messages_valid will return FALSE and
1407 * notmuch_messages_get will return NULL).
1409 * See the documentation of notmuch_query_search_messages for example
1410 * code showing how to iterate over a notmuch_messages_t object.
1413 notmuch_messages_move_to_next (notmuch_messages_t *messages);
1416 * Destroy a notmuch_messages_t object.
1418 * It's not strictly necessary to call this function. All memory from
1419 * the notmuch_messages_t object will be reclaimed when the containing
1420 * query object is destroyed.
1423 notmuch_messages_destroy (notmuch_messages_t *messages);
1426 * Return a list of tags from all messages.
1428 * The resulting list is guaranteed not to contain duplicated tags.
1430 * WARNING: You can no longer iterate over messages after calling this
1431 * function, because the iterator will point at the end of the list.
1432 * We do not have a function to reset the iterator yet and the only
1433 * way how you can iterate over the list again is to recreate the
1436 * The function returns NULL on error.
1439 notmuch_messages_collect_tags (notmuch_messages_t *messages);
1442 * Get the database associated with this message.
1444 * @since libnotmuch 5.2 (notmuch 0.27)
1446 notmuch_database_t *
1447 notmuch_message_get_database (const notmuch_message_t *message);
1450 * Get the message ID of 'message'.
1452 * The returned string belongs to 'message' and as such, should not be
1453 * modified by the caller and will only be valid for as long as the
1454 * message is valid, (which is until the query from which it derived
1457 * This function will return NULL if triggers an unhandled Xapian
1461 notmuch_message_get_message_id (notmuch_message_t *message);
1464 * Get the thread ID of 'message'.
1466 * The returned string belongs to 'message' and as such, should not be
1467 * modified by the caller and will only be valid for as long as the
1468 * message is valid, (for example, until the user calls
1469 * notmuch_message_destroy on 'message' or until a query from which it
1470 * derived is destroyed).
1472 * This function will return NULL if triggers an unhandled Xapian
1476 notmuch_message_get_thread_id (notmuch_message_t *message);
1479 * Get a notmuch_messages_t iterator for all of the replies to
1482 * Note: This call only makes sense if 'message' was ultimately
1483 * obtained from a notmuch_thread_t object, (such as by coming
1484 * directly from the result of calling notmuch_thread_get_
1485 * toplevel_messages or by any number of subsequent
1486 * calls to notmuch_message_get_replies).
1488 * If 'message' was obtained through some non-thread means, (such as
1489 * by a call to notmuch_query_search_messages), then this function
1492 * If there are no replies to 'message', this function will return
1493 * NULL. (Note that notmuch_messages_valid will accept that NULL
1494 * value as legitimate, and simply return FALSE for it.)
1496 * This function also returns NULL if it triggers a Xapian exception.
1498 * The returned list will be destroyed when the thread is
1501 notmuch_messages_t *
1502 notmuch_message_get_replies (notmuch_message_t *message);
1505 * Get the total number of files associated with a message.
1506 * @returns Non-negative integer for file count.
1507 * @returns Negative integer for error.
1508 * @since libnotmuch 5.0 (notmuch 0.25)
1511 notmuch_message_count_files (notmuch_message_t *message);
1514 * Get a filename for the email corresponding to 'message'.
1516 * The returned filename is an absolute filename, (the initial
1517 * component will match notmuch_database_get_path() ).
1519 * The returned string belongs to the message so should not be
1520 * modified or freed by the caller (nor should it be referenced after
1521 * the message is destroyed).
1523 * Note: If this message corresponds to multiple files in the mail
1524 * store, (that is, multiple files contain identical message IDs),
1525 * this function will arbitrarily return a single one of those
1526 * filenames. See notmuch_message_get_filenames for returning the
1527 * complete list of filenames.
1529 * This function returns NULL if it triggers a Xapian exception.
1532 notmuch_message_get_filename (notmuch_message_t *message);
1535 * Get all filenames for the email corresponding to 'message'.
1537 * Returns a notmuch_filenames_t iterator listing all the filenames
1538 * associated with 'message'. These files may not have identical
1539 * content, but each will have the identical Message-ID.
1541 * Each filename in the iterator is an absolute filename, (the initial
1542 * component will match notmuch_database_get_path() ).
1544 * This function returns NULL if it triggers a Xapian exception.
1546 notmuch_filenames_t *
1547 notmuch_message_get_filenames (notmuch_message_t *message);
1550 * Re-index the e-mail corresponding to 'message' using the supplied index options
1552 * Returns the status of the re-index operation. (see the return
1553 * codes documented in notmuch_database_index_file)
1555 * After reindexing, the user should discard the message object passed
1556 * in here by calling notmuch_message_destroy, since it refers to the
1557 * original message, not to the reindexed message.
1560 notmuch_message_reindex (notmuch_message_t *message,
1561 notmuch_indexopts_t *indexopts);
1566 typedef enum _notmuch_message_flag {
1567 NOTMUCH_MESSAGE_FLAG_MATCH,
1568 NOTMUCH_MESSAGE_FLAG_EXCLUDED,
1570 /* This message is a "ghost message", meaning it has no filenames
1571 * or content, but we know it exists because it was referenced by
1572 * some other message. A ghost message has only a message ID and
1575 NOTMUCH_MESSAGE_FLAG_GHOST,
1576 } notmuch_message_flag_t;
1579 * Get a value of a flag for the email corresponding to 'message'.
1581 * returns FALSE in case of errors.
1583 * @deprecated Deprecated as of libnotmuch 5.3 (notmuch 0.31). Please
1584 * use notmuch_message_get_flag_st instead.
1586 NOTMUCH_DEPRECATED(5,3)
1588 notmuch_message_get_flag (notmuch_message_t *message,
1589 notmuch_message_flag_t flag);
1592 * Get a value of a flag for the email corresponding to 'message'.
1594 * @param message a message object
1595 * @param flag flag to check
1596 * @param is_set pointer to boolean to store flag value.
1598 * @retval #NOTMUCH_STATUS_SUCCESS
1599 * @retval #NOTMUCH_STATUS_NULL_POINTER is_set is NULL
1600 * @retval #NOTMUCH_STATUS_XAPIAN_EXCEPTION Accessing the database
1601 * triggered an exception.
1603 * @since libnotmuch 5.3 (notmuch 0.31)
1606 notmuch_message_get_flag_st (notmuch_message_t *message,
1607 notmuch_message_flag_t flag,
1608 notmuch_bool_t *is_set);
1611 * Set a value of a flag for the email corresponding to 'message'.
1614 notmuch_message_set_flag (notmuch_message_t *message,
1615 notmuch_message_flag_t flag, notmuch_bool_t value);
1618 * Get the date of 'message' as a time_t value.
1620 * For the original textual representation of the Date header from the
1621 * message call notmuch_message_get_header() with a header value of
1624 * Returns 0 in case of error.
1627 notmuch_message_get_date (notmuch_message_t *message);
1630 * Get the value of the specified header from 'message' as a UTF-8 string.
1632 * Common headers are stored in the database when the message is
1633 * indexed and will be returned from the database. Other headers will
1634 * be read from the actual message file.
1636 * The header name is case insensitive.
1638 * The returned string belongs to the message so should not be
1639 * modified or freed by the caller (nor should it be referenced after
1640 * the message is destroyed).
1642 * Returns an empty string ("") if the message does not contain a
1643 * header line matching 'header'. Returns NULL if any error occurs.
1646 notmuch_message_get_header (notmuch_message_t *message, const char *header);
1649 * Get the tags for 'message', returning a notmuch_tags_t object which
1650 * can be used to iterate over all tags.
1652 * The tags object is owned by the message and as such, will only be
1653 * valid for as long as the message is valid, (which is until the
1654 * query from which it derived is destroyed).
1656 * Typical usage might be:
1658 * notmuch_message_t *message;
1659 * notmuch_tags_t *tags;
1662 * message = notmuch_database_find_message (database, message_id);
1664 * for (tags = notmuch_message_get_tags (message);
1665 * notmuch_tags_valid (tags);
1666 * notmuch_tags_move_to_next (tags))
1668 * tag = notmuch_tags_get (tags);
1672 * notmuch_message_destroy (message);
1674 * Note that there's no explicit destructor needed for the
1675 * notmuch_tags_t object. (For consistency, we do provide a
1676 * notmuch_tags_destroy function, but there's no good reason to call
1677 * it if the message is about to be destroyed).
1680 notmuch_message_get_tags (notmuch_message_t *message);
1683 * The longest possible tag value.
1685 #define NOTMUCH_TAG_MAX 200
1688 * Add a tag to the given message.
1692 * NOTMUCH_STATUS_SUCCESS: Tag successfully added to message
1694 * NOTMUCH_STATUS_NULL_POINTER: The 'tag' argument is NULL
1696 * NOTMUCH_STATUS_TAG_TOO_LONG: The length of 'tag' is too long
1697 * (exceeds NOTMUCH_TAG_MAX)
1699 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
1700 * mode so message cannot be modified.
1703 notmuch_message_add_tag (notmuch_message_t *message, const char *tag);
1706 * Remove a tag from the given message.
1710 * NOTMUCH_STATUS_SUCCESS: Tag successfully removed from message
1712 * NOTMUCH_STATUS_NULL_POINTER: The 'tag' argument is NULL
1714 * NOTMUCH_STATUS_TAG_TOO_LONG: The length of 'tag' is too long
1715 * (exceeds NOTMUCH_TAG_MAX)
1717 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
1718 * mode so message cannot be modified.
1721 notmuch_message_remove_tag (notmuch_message_t *message, const char *tag);
1724 * Remove all tags from the given message.
1726 * See notmuch_message_freeze for an example showing how to safely
1727 * replace tag values.
1729 * @retval #NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in
1730 * read-only mode so message cannot be modified.
1731 * @retval #NOTMUCH_STATUS_XAPIAN_EXCEPTION: an exception was thrown
1732 * accessing the database.
1735 notmuch_message_remove_all_tags (notmuch_message_t *message);
1738 * Add/remove tags according to maildir flags in the message filename(s).
1740 * This function examines the filenames of 'message' for maildir
1741 * flags, and adds or removes tags on 'message' as follows when these
1742 * flags are present:
1744 * Flag Action if present
1745 * ---- -----------------
1746 * 'D' Adds the "draft" tag to the message
1747 * 'F' Adds the "flagged" tag to the message
1748 * 'P' Adds the "passed" tag to the message
1749 * 'R' Adds the "replied" tag to the message
1750 * 'S' Removes the "unread" tag from the message
1752 * For each flag that is not present, the opposite action (add/remove)
1753 * is performed for the corresponding tags.
1755 * Flags are identified as trailing components of the filename after a
1756 * sequence of ":2,".
1758 * If there are multiple filenames associated with this message, the
1759 * flag is considered present if it appears in one or more
1760 * filenames. (That is, the flags from the multiple filenames are
1761 * combined with the logical OR operator.)
1763 * A client can ensure that notmuch database tags remain synchronized
1764 * with maildir flags by calling this function after each call to
1765 * notmuch_database_index_file. See also
1766 * notmuch_message_tags_to_maildir_flags for synchronizing tag changes
1767 * back to maildir flags.
1770 notmuch_message_maildir_flags_to_tags (notmuch_message_t *message);
1773 * return TRUE if any filename of 'message' has maildir flag 'flag',
1776 * Deprecated wrapper for notmuch_message_has_maildir_flag_st
1778 * @returns FALSE in case of error
1779 * @deprecated libnotmuch 5.3 (notmuch 0.31)
1781 NOTMUCH_DEPRECATED(5, 3)
1783 notmuch_message_has_maildir_flag (notmuch_message_t *message, char flag);
1786 * check message for maildir flag
1788 * @param [in,out] message message to check
1789 * @param [in] flag flag to check for
1790 * @param [out] is_set pointer to boolean
1792 * @retval #NOTMUCH_STATUS_SUCCESS
1793 * @retval #NOTMUCH_STATUS_NULL_POINTER is_set is NULL
1794 * @retval #NOTMUCH_STATUS_XAPIAN_EXCEPTION Accessing the database
1795 * triggered an exception.
1798 notmuch_message_has_maildir_flag_st (notmuch_message_t *message,
1800 notmuch_bool_t *is_set);
1803 * Rename message filename(s) to encode tags as maildir flags.
1805 * Specifically, for each filename corresponding to this message:
1807 * If the filename is not in a maildir directory, do nothing. (A
1808 * maildir directory is determined as a directory named "new" or
1809 * "cur".) Similarly, if the filename has invalid maildir info,
1810 * (repeated or outof-ASCII-order flag characters after ":2,"), then
1813 * If the filename is in a maildir directory, rename the file so that
1814 * its filename ends with the sequence ":2," followed by zero or more
1815 * of the following single-character flags (in ASCII order):
1817 * * flag 'D' iff the message has the "draft" tag
1818 * * flag 'F' iff the message has the "flagged" tag
1819 * * flag 'P' iff the message has the "passed" tag
1820 * * flag 'R' iff the message has the "replied" tag
1821 * * flag 'S' iff the message does not have the "unread" tag
1823 * Any existing flags unmentioned in the list above will be preserved
1826 * Also, if this filename is in a directory named "new", rename it to
1827 * be within the neighboring directory named "cur".
1829 * A client can ensure that maildir filename flags remain synchronized
1830 * with notmuch database tags by calling this function after changing
1831 * tags, (after calls to notmuch_message_add_tag,
1832 * notmuch_message_remove_tag, or notmuch_message_freeze/
1833 * notmuch_message_thaw). See also notmuch_message_maildir_flags_to_tags
1834 * for synchronizing maildir flag changes back to tags.
1837 notmuch_message_tags_to_maildir_flags (notmuch_message_t *message);
1840 * Freeze the current state of 'message' within the database.
1842 * This means that changes to the message state, (via
1843 * notmuch_message_add_tag, notmuch_message_remove_tag, and
1844 * notmuch_message_remove_all_tags), will not be committed to the
1845 * database until the message is thawed with notmuch_message_thaw.
1847 * Multiple calls to freeze/thaw are valid and these calls will
1848 * "stack". That is there must be as many calls to thaw as to freeze
1849 * before a message is actually thawed.
1851 * The ability to do freeze/thaw allows for safe transactions to
1852 * change tag values. For example, explicitly setting a message to
1853 * have a given set of tags might look like this:
1855 * notmuch_message_freeze (message);
1857 * notmuch_message_remove_all_tags (message);
1859 * for (i = 0; i < NUM_TAGS; i++)
1860 * notmuch_message_add_tag (message, tags[i]);
1862 * notmuch_message_thaw (message);
1864 * With freeze/thaw used like this, the message in the database is
1865 * guaranteed to have either the full set of original tag values, or
1866 * the full set of new tag values, but nothing in between.
1868 * Imagine the example above without freeze/thaw and the operation
1869 * somehow getting interrupted. This could result in the message being
1870 * left with no tags if the interruption happened after
1871 * notmuch_message_remove_all_tags but before notmuch_message_add_tag.
1875 * NOTMUCH_STATUS_SUCCESS: Message successfully frozen.
1877 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
1878 * mode so message cannot be modified.
1881 notmuch_message_freeze (notmuch_message_t *message);
1884 * Thaw the current 'message', synchronizing any changes that may have
1885 * occurred while 'message' was frozen into the notmuch database.
1887 * See notmuch_message_freeze for an example of how to use this
1888 * function to safely provide tag changes.
1890 * Multiple calls to freeze/thaw are valid and these calls with
1891 * "stack". That is there must be as many calls to thaw as to freeze
1892 * before a message is actually thawed.
1896 * NOTMUCH_STATUS_SUCCESS: Message successfully thawed, (or at least
1897 * its frozen count has successfully been reduced by 1).
1899 * NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW: An attempt was made to thaw
1900 * an unfrozen message. That is, there have been an unbalanced
1901 * number of calls to notmuch_message_freeze and
1902 * notmuch_message_thaw.
1905 notmuch_message_thaw (notmuch_message_t *message);
1908 * Destroy a notmuch_message_t object.
1910 * It can be useful to call this function in the case of a single
1911 * query object with many messages in the result, (such as iterating
1912 * over the entire database). Otherwise, it's fine to never call this
1913 * function and there will still be no memory leaks. (The memory from
1914 * the messages get reclaimed when the containing query is destroyed.)
1917 notmuch_message_destroy (notmuch_message_t *message);
1920 * @name Message Properties
1922 * This interface provides the ability to attach arbitrary (key,value)
1923 * string pairs to a message, to remove such pairs, and to iterate
1924 * over them. The caller should take some care as to what keys they
1925 * add or delete values for, as other subsystems or extensions may
1926 * depend on these properties.
1928 * Please see notmuch-properties(7) for more details about specific
1929 * properties and conventions around their use.
1934 * Retrieve the value for a single property key
1936 * *value* is set to a string owned by the message or NULL if there is
1937 * no such key. In the case of multiple values for the given key, the
1938 * first one is retrieved.
1941 * - NOTMUCH_STATUS_NULL_POINTER: *value* may not be NULL.
1942 * - NOTMUCH_STATUS_SUCCESS: No error occurred.
1943 * @since libnotmuch 4.4 (notmuch 0.23)
1946 notmuch_message_get_property (notmuch_message_t *message, const char *key, const char **value);
1949 * Add a (key,value) pair to a message
1952 * - NOTMUCH_STATUS_ILLEGAL_ARGUMENT: *key* may not contain an '=' character.
1953 * - NOTMUCH_STATUS_NULL_POINTER: Neither *key* nor *value* may be NULL.
1954 * - NOTMUCH_STATUS_SUCCESS: No error occurred.
1955 * @since libnotmuch 4.4 (notmuch 0.23)
1958 notmuch_message_add_property (notmuch_message_t *message, const char *key, const char *value);
1961 * Remove a (key,value) pair from a message.
1963 * It is not an error to remove a non-existent (key,value) pair
1966 * - NOTMUCH_STATUS_ILLEGAL_ARGUMENT: *key* may not contain an '=' character.
1967 * - NOTMUCH_STATUS_NULL_POINTER: Neither *key* nor *value* may be NULL.
1968 * - NOTMUCH_STATUS_SUCCESS: No error occurred.
1969 * @since libnotmuch 4.4 (notmuch 0.23)
1972 notmuch_message_remove_property (notmuch_message_t *message, const char *key, const char *value);
1975 * Remove all (key,value) pairs from the given message.
1977 * @param[in,out] message message to operate on.
1978 * @param[in] key key to delete properties for. If NULL, delete
1979 * properties for all keys
1981 * - NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in
1982 * read-only mode so message cannot be modified.
1983 * - NOTMUCH_STATUS_SUCCESS: No error occurred.
1985 * @since libnotmuch 4.4 (notmuch 0.23)
1988 notmuch_message_remove_all_properties (notmuch_message_t *message, const char *key);
1991 * Remove all (prefix*,value) pairs from the given message
1993 * @param[in,out] message message to operate on.
1994 * @param[in] prefix delete properties with keys that start with prefix.
1995 * If NULL, delete all properties
1997 * - NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in
1998 * read-only mode so message cannot be modified.
1999 * - NOTMUCH_STATUS_SUCCESS: No error occurred.
2001 * @since libnotmuch 5.1 (notmuch 0.26)
2004 notmuch_message_remove_all_properties_with_prefix (notmuch_message_t *message, const char *prefix);
2007 * Opaque message property iterator
2009 typedef struct _notmuch_string_map_iterator notmuch_message_properties_t;
2012 * Get the properties for *message*, returning a
2013 * notmuch_message_properties_t object which can be used to iterate
2014 * over all properties.
2016 * The notmuch_message_properties_t object is owned by the message and
2017 * as such, will only be valid for as long as the message is valid,
2018 * (which is until the query from which it derived is destroyed).
2020 * @param[in] message The message to examine
2021 * @param[in] key key or key prefix
2022 * @param[in] exact if TRUE, require exact match with key. Otherwise
2025 * Typical usage might be:
2027 * notmuch_message_properties_t *list;
2029 * for (list = notmuch_message_get_properties (message, "testkey1", TRUE);
2030 * notmuch_message_properties_valid (list); notmuch_message_properties_move_to_next (list)) {
2031 * printf("%s\n", notmuch_message_properties_value(list));
2034 * notmuch_message_properties_destroy (list);
2036 * Note that there's no explicit destructor needed for the
2037 * notmuch_message_properties_t object. (For consistency, we do
2038 * provide a notmuch_message_properities_destroy function, but there's
2039 * no good reason to call it if the message is about to be destroyed).
2041 * @since libnotmuch 4.4 (notmuch 0.23)
2043 notmuch_message_properties_t *
2044 notmuch_message_get_properties (notmuch_message_t *message, const char *key, notmuch_bool_t exact);
2047 * Return the number of properties named "key" belonging to the specific message.
2049 * @param[in] message The message to examine
2050 * @param[in] key key to count
2051 * @param[out] count The number of matching properties associated with this message.
2055 * NOTMUCH_STATUS_SUCCESS: successful count, possibly some other error.
2057 * @since libnotmuch 5.2 (notmuch 0.27)
2060 notmuch_message_count_properties (notmuch_message_t *message, const char *key, unsigned int *count);
2063 * Is the given *properties* iterator pointing at a valid (key,value)
2066 * When this function returns TRUE,
2067 * notmuch_message_properties_{key,value} will return a valid string,
2068 * and notmuch_message_properties_move_to_next will do what it
2069 * says. Whereas when this function returns FALSE, calling any of
2070 * these functions results in undefined behaviour.
2072 * See the documentation of notmuch_message_get_properties for example
2073 * code showing how to iterate over a notmuch_message_properties_t
2076 * @since libnotmuch 4.4 (notmuch 0.23)
2079 notmuch_message_properties_valid (notmuch_message_properties_t *properties);
2082 * Move the *properties* iterator to the next (key,value) pair
2084 * If *properties* is already pointing at the last pair then the iterator
2085 * will be moved to a point just beyond that last pair, (where
2086 * notmuch_message_properties_valid will return FALSE).
2088 * See the documentation of notmuch_message_get_properties for example
2089 * code showing how to iterate over a notmuch_message_properties_t object.
2091 * @since libnotmuch 4.4 (notmuch 0.23)
2094 notmuch_message_properties_move_to_next (notmuch_message_properties_t *properties);
2097 * Return the key from the current (key,value) pair.
2099 * this could be useful if iterating for a prefix
2101 * @since libnotmuch 4.4 (notmuch 0.23)
2104 notmuch_message_properties_key (notmuch_message_properties_t *properties);
2107 * Return the value from the current (key,value) pair.
2109 * This could be useful if iterating for a prefix.
2111 * @since libnotmuch 4.4 (notmuch 0.23)
2114 notmuch_message_properties_value (notmuch_message_properties_t *properties);
2118 * Destroy a notmuch_message_properties_t object.
2120 * It's not strictly necessary to call this function. All memory from
2121 * the notmuch_message_properties_t object will be reclaimed when the
2122 * containing message object is destroyed.
2124 * @since libnotmuch 4.4 (notmuch 0.23)
2127 notmuch_message_properties_destroy (notmuch_message_properties_t *properties);
2132 * Is the given 'tags' iterator pointing at a valid tag.
2134 * When this function returns TRUE, notmuch_tags_get will return a
2135 * valid string. Whereas when this function returns FALSE,
2136 * notmuch_tags_get will return NULL.
2138 * See the documentation of notmuch_message_get_tags for example code
2139 * showing how to iterate over a notmuch_tags_t object.
2142 notmuch_tags_valid (notmuch_tags_t *tags);
2145 * Get the current tag from 'tags' as a string.
2147 * Note: The returned string belongs to 'tags' and has a lifetime
2148 * identical to it (and the query to which it ultimately belongs).
2150 * See the documentation of notmuch_message_get_tags for example code
2151 * showing how to iterate over a notmuch_tags_t object.
2154 notmuch_tags_get (notmuch_tags_t *tags);
2157 * Move the 'tags' iterator to the next tag.
2159 * If 'tags' is already pointing at the last tag then the iterator
2160 * will be moved to a point just beyond that last tag, (where
2161 * notmuch_tags_valid will return FALSE and notmuch_tags_get will
2164 * See the documentation of notmuch_message_get_tags for example code
2165 * showing how to iterate over a notmuch_tags_t object.
2168 notmuch_tags_move_to_next (notmuch_tags_t *tags);
2171 * Destroy a notmuch_tags_t object.
2173 * It's not strictly necessary to call this function. All memory from
2174 * the notmuch_tags_t object will be reclaimed when the containing
2175 * message or query objects are destroyed.
2178 notmuch_tags_destroy (notmuch_tags_t *tags);
2181 * Store an mtime within the database for 'directory'.
2183 * The 'directory' should be an object retrieved from the database
2184 * with notmuch_database_get_directory for a particular path.
2186 * The intention is for the caller to use the mtime to allow efficient
2187 * identification of new messages to be added to the database. The
2188 * recommended usage is as follows:
2190 * o Read the mtime of a directory from the filesystem
2192 * o Call index_file for all mail files in the directory
2194 * o Call notmuch_directory_set_mtime with the mtime read from the
2197 * Then, when wanting to check for updates to the directory in the
2198 * future, the client can call notmuch_directory_get_mtime and know
2199 * that it only needs to add files if the mtime of the directory and
2200 * files are newer than the stored timestamp.
2202 * Note: The notmuch_directory_get_mtime function does not allow the
2203 * caller to distinguish a timestamp of 0 from a non-existent
2204 * timestamp. So don't store a timestamp of 0 unless you are
2205 * comfortable with that.
2209 * NOTMUCH_STATUS_SUCCESS: mtime successfully stored in database.
2211 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception
2212 * occurred, mtime not stored.
2214 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
2215 * mode so directory mtime cannot be modified.
2218 notmuch_directory_set_mtime (notmuch_directory_t *directory,
2222 * Get the mtime of a directory, (as previously stored with
2223 * notmuch_directory_set_mtime).
2225 * Returns 0 if no mtime has previously been stored for this
2229 notmuch_directory_get_mtime (notmuch_directory_t *directory);
2232 * Get a notmuch_filenames_t iterator listing all the filenames of
2233 * messages in the database within the given directory.
2235 * The returned filenames will be the basename-entries only (not
2238 * Returns NULL if it triggers a Xapian exception
2240 notmuch_filenames_t *
2241 notmuch_directory_get_child_files (notmuch_directory_t *directory);
2244 * Get a notmuch_filenames_t iterator listing all the filenames of
2245 * sub-directories in the database within the given directory.
2247 * The returned filenames will be the basename-entries only (not
2250 * Returns NULL if it triggers a Xapian exception
2252 notmuch_filenames_t *
2253 notmuch_directory_get_child_directories (notmuch_directory_t *directory);
2256 * Delete directory document from the database, and destroy the
2257 * notmuch_directory_t object. Assumes any child directories and files
2258 * have been deleted by the caller.
2260 * @since libnotmuch 4.3 (notmuch 0.21)
2263 notmuch_directory_delete (notmuch_directory_t *directory);
2266 * Destroy a notmuch_directory_t object.
2269 notmuch_directory_destroy (notmuch_directory_t *directory);
2272 * Is the given 'filenames' iterator pointing at a valid filename.
2274 * When this function returns TRUE, notmuch_filenames_get will return
2275 * a valid string. Whereas when this function returns FALSE,
2276 * notmuch_filenames_get will return NULL.
2278 * It is acceptable to pass NULL for 'filenames', in which case this
2279 * function will always return FALSE.
2282 notmuch_filenames_valid (notmuch_filenames_t *filenames);
2285 * Get the current filename from 'filenames' as a string.
2287 * Note: The returned string belongs to 'filenames' and has a lifetime
2288 * identical to it (and the directory to which it ultimately belongs).
2290 * It is acceptable to pass NULL for 'filenames', in which case this
2291 * function will always return NULL.
2294 notmuch_filenames_get (notmuch_filenames_t *filenames);
2297 * Move the 'filenames' iterator to the next filename.
2299 * If 'filenames' is already pointing at the last filename then the
2300 * iterator will be moved to a point just beyond that last filename,
2301 * (where notmuch_filenames_valid will return FALSE and
2302 * notmuch_filenames_get will return NULL).
2304 * It is acceptable to pass NULL for 'filenames', in which case this
2305 * function will do nothing.
2308 notmuch_filenames_move_to_next (notmuch_filenames_t *filenames);
2311 * Destroy a notmuch_filenames_t object.
2313 * It's not strictly necessary to call this function. All memory from
2314 * the notmuch_filenames_t object will be reclaimed when the
2315 * containing directory object is destroyed.
2317 * It is acceptable to pass NULL for 'filenames', in which case this
2318 * function will do nothing.
2321 notmuch_filenames_destroy (notmuch_filenames_t *filenames);
2325 * set config 'key' to 'value'
2327 * @since libnotmuch 4.4 (notmuch 0.23)
2330 notmuch_database_set_config (notmuch_database_t *db, const char *key, const char *value);
2333 * retrieve config item 'key', assign to 'value'
2335 * keys which have not been previously set with n_d_set_config will
2336 * return an empty string.
2338 * return value is allocated by malloc and should be freed by the
2341 * @since libnotmuch 4.4 (notmuch 0.23)
2344 notmuch_database_get_config (notmuch_database_t *db, const char *key, char **value);
2347 * Create an iterator for all config items with keys matching a given prefix
2349 * @since libnotmuch 4.4 (notmuch 0.23)
2352 notmuch_database_get_config_list (notmuch_database_t *db, const char *prefix, notmuch_config_list_t **out);
2355 * Is 'config_list' iterator valid (i.e. _key, _value, _move_to_next can be called).
2357 * @since libnotmuch 4.4 (notmuch 0.23)
2360 notmuch_config_list_valid (notmuch_config_list_t *config_list);
2363 * return key for current config pair
2365 * return value is owned by the iterator, and will be destroyed by the
2366 * next call to notmuch_config_list_key or notmuch_config_list_destroy.
2368 * @since libnotmuch 4.4 (notmuch 0.23)
2371 notmuch_config_list_key (notmuch_config_list_t *config_list);
2374 * return 'value' for current config pair
2376 * return value is owned by the iterator, and will be destroyed by the
2377 * next call to notmuch_config_list_value or notmuch config_list_destroy
2379 * @since libnotmuch 4.4 (notmuch 0.23)
2380 * @retval NULL for errors
2383 notmuch_config_list_value (notmuch_config_list_t *config_list);
2387 * move 'config_list' iterator to the next pair
2389 * @since libnotmuch 4.4 (notmuch 0.23)
2392 notmuch_config_list_move_to_next (notmuch_config_list_t *config_list);
2395 * free any resources held by 'config_list'
2397 * @since libnotmuch 4.4 (notmuch 0.23)
2400 notmuch_config_list_destroy (notmuch_config_list_t *config_list);
2404 * get the current default indexing options for a given database.
2406 * This object will survive until the database itself is destroyed,
2407 * but the caller may also release it earlier with
2408 * notmuch_indexopts_destroy.
2410 * This object represents a set of options on how a message can be
2411 * added to the index. At the moment it is a featureless stub.
2413 * @since libnotmuch 5.1 (notmuch 0.26)
2414 * @retval NULL in case of error
2416 notmuch_indexopts_t *
2417 notmuch_database_get_default_indexopts (notmuch_database_t *db);
2420 * Stating a policy about how to decrypt messages.
2422 * See index.decrypt in notmuch-config(1) for more details.
2425 NOTMUCH_DECRYPT_FALSE,
2426 NOTMUCH_DECRYPT_TRUE,
2427 NOTMUCH_DECRYPT_AUTO,
2428 NOTMUCH_DECRYPT_NOSTASH,
2429 } notmuch_decryption_policy_t;
2432 * Specify whether to decrypt encrypted parts while indexing.
2434 * Be aware that the index is likely sufficient to reconstruct the
2435 * cleartext of the message itself, so please ensure that the notmuch
2436 * message index is adequately protected. DO NOT SET THIS FLAG TO TRUE
2437 * without considering the security of your index.
2439 * @since libnotmuch 5.1 (notmuch 0.26)
2442 notmuch_indexopts_set_decrypt_policy (notmuch_indexopts_t *indexopts,
2443 notmuch_decryption_policy_t decrypt_policy);
2446 * Return whether to decrypt encrypted parts while indexing.
2447 * see notmuch_indexopts_set_decrypt_policy.
2449 * @since libnotmuch 5.1 (notmuch 0.26)
2451 notmuch_decryption_policy_t
2452 notmuch_indexopts_get_decrypt_policy (const notmuch_indexopts_t *indexopts);
2455 * Destroy a notmuch_indexopts_t object.
2457 * @since libnotmuch 5.1 (notmuch 0.26)
2460 notmuch_indexopts_destroy (notmuch_indexopts_t *options);
2464 * interrogate the library for compile time features
2466 * @since libnotmuch 4.4 (notmuch 0.23)
2469 notmuch_built_with (const char *name);
2472 #pragma GCC visibility pop