notmuch(3)

NAME
notmuch - The notmuch API

 - Not much of an email library, (just index and search)

SYNOPSIS

  Macros

#define LIBNOTMUCH_CHECK_VERSION(major, minor, micro)
Check the version of the notmuch library being compiled against.
#define NOTMUCH_TAG_MAX 200
The longest possible tag value.

  Typedefs

typedef int notmuch_bool_t
Notmuch boolean type.
typedef void(* notmuch_compact_status_cb_t) (const char *message, void *closure)
A callback invoked by notmuch_database_compact to notify the user of the progress of the compaction process.

  Enumerations

enum notmuch_status_t { NOTMUCH_STATUS_SUCCESS = 0, NOTMUCH_STATUS_OUT_OF_MEMORY, NOTMUCH_STATUS_READ_ONLY_DATABASE, NOTMUCH_STATUS_XAPIAN_EXCEPTION, NOTMUCH_STATUS_FILE_ERROR, NOTMUCH_STATUS_FILE_NOT_EMAIL, NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID, NOTMUCH_STATUS_NULL_POINTER, NOTMUCH_STATUS_TAG_TOO_LONG, NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW, NOTMUCH_STATUS_UNBALANCED_ATOMIC, NOTMUCH_STATUS_UNSUPPORTED_OPERATION, NOTMUCH_STATUS_UPGRADE_REQUIRED, NOTMUCH_STATUS_PATH_ERROR, NOTMUCH_STATUS_IGNORED, NOTMUCH_STATUS_ILLEGAL_ARGUMENT, NOTMUCH_STATUS_MALFORMED_CRYPTO_PROTOCOL, NOTMUCH_STATUS_FAILED_CRYPTO_CONTEXT_CREATION, NOTMUCH_STATUS_UNKNOWN_CRYPTO_PROTOCOL, NOTMUCH_STATUS_NO_CONFIG, NOTMUCH_STATUS_NO_DATABASE, NOTMUCH_STATUS_DATABASE_EXISTS, NOTMUCH_STATUS_BAD_QUERY_SYNTAX, NOTMUCH_STATUS_NO_MAIL_ROOT, NOTMUCH_STATUS_CLOSED_DATABASE, NOTMUCH_STATUS_LAST_STATUS }
Status codes used for the return values of most functions.
enum notmuch_database_mode_t { NOTMUCH_DATABASE_MODE_READ_ONLY = 0, NOTMUCH_DATABASE_MODE_READ_WRITE }
Database open mode for notmuch_database_open.
enum notmuch_query_syntax_t { NOTMUCH_QUERY_SYNTAX_XAPIAN, NOTMUCH_QUERY_SYNTAX_SEXP }
enum notmuch_sort_t { NOTMUCH_SORT_OLDEST_FIRST, NOTMUCH_SORT_NEWEST_FIRST, NOTMUCH_SORT_MESSAGE_ID, NOTMUCH_SORT_UNSORTED }
Sort values for notmuch_query_set_sort.
enum notmuch_exclude_t { NOTMUCH_EXCLUDE_FLAG, NOTMUCH_EXCLUDE_TRUE, NOTMUCH_EXCLUDE_FALSE, NOTMUCH_EXCLUDE_ALL }
Exclude values for notmuch_query_set_omit_excluded.
enum notmuch_message_flag_t { NOTMUCH_MESSAGE_FLAG_MATCH, NOTMUCH_MESSAGE_FLAG_EXCLUDED, NOTMUCH_MESSAGE_FLAG_GHOST }
Message flags.
enum notmuch_config_key_t { NOTMUCH_CONFIG_FIRST, NOTMUCH_CONFIG_DATABASE_PATH = NOTMUCH_CONFIG_FIRST, NOTMUCH_CONFIG_MAIL_ROOT, NOTMUCH_CONFIG_HOOK_DIR, NOTMUCH_CONFIG_BACKUP_DIR, NOTMUCH_CONFIG_EXCLUDE_TAGS, NOTMUCH_CONFIG_NEW_TAGS, NOTMUCH_CONFIG_NEW_IGNORE, NOTMUCH_CONFIG_SYNC_MAILDIR_FLAGS, NOTMUCH_CONFIG_PRIMARY_EMAIL, NOTMUCH_CONFIG_OTHER_EMAIL, NOTMUCH_CONFIG_USER_NAME, NOTMUCH_CONFIG_AUTOCOMMIT, NOTMUCH_CONFIG_EXTRA_HEADERS, NOTMUCH_CONFIG_INDEX_AS_TEXT, NOTMUCH_CONFIG_AUTHORS_SEPARATOR, NOTMUCH_CONFIG_AUTHORS_MATCHED_SEPARATOR, NOTMUCH_CONFIG_LAST }
Configuration keys known to libnotmuch.
enum notmuch_decryption_policy_t { NOTMUCH_DECRYPT_FALSE, NOTMUCH_DECRYPT_TRUE, NOTMUCH_DECRYPT_AUTO, NOTMUCH_DECRYPT_NOSTASH }
Stating a policy about how to decrypt messages.

  Functions

const char * notmuch_status_to_string (notmuch_status_t status)
Get a string representation of a notmuch_status_t value.
notmuch_status_t notmuch_database_create (const char *path, notmuch_database_t **database)
Create a new, empty notmuch database located at 'path'.
notmuch_status_t notmuch_database_create_verbose (const char *path, notmuch_database_t **database, char **error_message)
Like notmuch_database_create, except optionally return an error message.
notmuch_status_t notmuch_database_open (const char *path, notmuch_database_mode_t mode, notmuch_database_t **database)
Deprecated alias for notmuch_database_open_with_config with config_path='' and error_message=NULL.
notmuch_status_t notmuch_database_open_verbose (const char *path, notmuch_database_mode_t mode, notmuch_database_t **database, char **error_message)
Deprecated alias for notmuch_database_open_with_config with config_path=''.
notmuch_status_t notmuch_database_open_with_config (const char *database_path, notmuch_database_mode_t mode, const char *config_path, const char *profile, notmuch_database_t **database, char **error_message)
Open an existing notmuch database located at 'database_path', using configuration in 'config_path'.
notmuch_status_t notmuch_database_load_config (const char *database_path, const char *config_path, const char *profile, notmuch_database_t **database, char **error_message)
Loads configuration from config file, database, and/or defaults.
notmuch_status_t notmuch_database_create_with_config (const char *database_path, const char *config_path, const char *profile, notmuch_database_t **database, char **error_message)
Create a new notmuch database located at 'database_path', using configuration in 'config_path'.
const char * notmuch_database_status_string (const notmuch_database_t *notmuch)
Retrieve last status string for given database.
notmuch_status_t notmuch_database_close (notmuch_database_t *database)
Commit changes and close the given notmuch database.
notmuch_status_t notmuch_database_compact (const char *path, const char *backup_path, notmuch_compact_status_cb_t status_cb, void *closure)
Compact a notmuch database, backing up the original database to the given path.
notmuch_status_t notmuch_database_compact_db (notmuch_database_t *database, const char *backup_path, notmuch_compact_status_cb_t status_cb, void *closure)
Like notmuch_database_compact, but take an open database as a parameter.
notmuch_status_t notmuch_database_destroy (notmuch_database_t *database)
Destroy the notmuch database, closing it if necessary and freeing all associated resources.
const char * notmuch_database_get_path (notmuch_database_t *database)
Return the database path of the given database.
unsigned int notmuch_database_get_version (notmuch_database_t *database)
Return the database format version of the given database.
notmuch_bool_t notmuch_database_needs_upgrade (notmuch_database_t *database)
Can the database be upgraded to a newer database version?
notmuch_status_t notmuch_database_upgrade (notmuch_database_t *database, void(*progress_notify)(void *closure, double progress), void *closure)
Upgrade the current database to the latest supported version.
notmuch_status_t notmuch_database_begin_atomic (notmuch_database_t *notmuch)
Begin an atomic database operation.
notmuch_status_t notmuch_database_end_atomic (notmuch_database_t *notmuch)
Indicate the end of an atomic database operation.
unsigned long notmuch_database_get_revision (notmuch_database_t *notmuch, const char **uuid)
Return the committed database revision and UUID.
notmuch_status_t notmuch_database_get_directory (notmuch_database_t *database, const char *path, notmuch_directory_t **directory)
Retrieve a directory object from the database for 'path'.
notmuch_status_t notmuch_database_index_file (notmuch_database_t *database, const char *filename, notmuch_indexopts_t *indexopts, notmuch_message_t **message)
Add a message file to a database, indexing it for retrieval by future searches.
notmuch_status_t notmuch_database_add_message (notmuch_database_t *database, const char *filename, notmuch_message_t **message)
Deprecated alias for notmuch_database_index_file called with NULL indexopts.
notmuch_status_t notmuch_database_remove_message (notmuch_database_t *database, const char *filename)
Remove a message filename from the given notmuch database.
notmuch_status_t notmuch_database_find_message (notmuch_database_t *database, const char *message_id, notmuch_message_t **message)
Find a message with the given message_id.
notmuch_status_t notmuch_database_find_message_by_filename (notmuch_database_t *notmuch, const char *filename, notmuch_message_t **message)
Find a message with the given filename.
notmuch_tags_t * notmuch_database_get_all_tags (notmuch_database_t *db)
Return a list of all tags found in the database.
notmuch_status_t notmuch_database_reopen (notmuch_database_t *db, notmuch_database_mode_t mode)
Reopen an open notmuch database.
notmuch_query_t * notmuch_query_create (notmuch_database_t *database, const char *query_string)
Create a new query for 'database'.
notmuch_status_t notmuch_query_create_with_syntax (notmuch_database_t *database, const char *query_string, notmuch_query_syntax_t syntax, notmuch_query_t **output)
const char * notmuch_query_get_query_string (const notmuch_query_t *query)
Return the query_string of this query.
notmuch_database_t * notmuch_query_get_database (const notmuch_query_t *query)
Return the notmuch database of this query.
void notmuch_query_set_omit_excluded (notmuch_query_t *query, notmuch_exclude_t omit_excluded)
Specify whether to omit excluded results or simply flag them.
void notmuch_query_set_sort (notmuch_query_t *query, notmuch_sort_t sort)
Specify the sorting desired for this query.
notmuch_sort_t notmuch_query_get_sort (const notmuch_query_t *query)
Return the sort specified for this query.
notmuch_status_t notmuch_query_add_tag_exclude (notmuch_query_t *query, const char *tag)
Add a tag that will be excluded from the query results by default.
notmuch_status_t notmuch_query_search_threads (notmuch_query_t *query, notmuch_threads_t **out)
Execute a query for threads, returning a notmuch_threads_t object which can be used to iterate over the results.
notmuch_status_t notmuch_query_search_threads_st (notmuch_query_t *query, notmuch_threads_t **out)
Deprecated alias for notmuch_query_search_threads.
notmuch_status_t notmuch_query_search_messages (notmuch_query_t *query, notmuch_messages_t **out)
Execute a query for messages, returning a notmuch_messages_t object which can be used to iterate over the results.
notmuch_status_t notmuch_query_search_messages_st (notmuch_query_t *query, notmuch_messages_t **out)
Deprecated alias for notmuch_query_search_messages.
void notmuch_query_destroy (notmuch_query_t *query)
Destroy a notmuch_query_t along with any associated resources.
notmuch_bool_t notmuch_threads_valid (notmuch_threads_t *threads)
Is the given 'threads' iterator pointing at a valid thread.
notmuch_thread_t * notmuch_threads_get (notmuch_threads_t *threads)
Get the current thread from 'threads' as a notmuch_thread_t.
void notmuch_threads_move_to_next (notmuch_threads_t *threads)
Move the 'threads' iterator to the next thread.
void notmuch_threads_destroy (notmuch_threads_t *threads)
Destroy a notmuch_threads_t object.
notmuch_status_t notmuch_query_count_messages (notmuch_query_t *query, unsigned int *count)
Return the number of messages matching a search.
notmuch_status_t notmuch_query_count_messages_st (notmuch_query_t *query, unsigned int *count)
Deprecated alias for notmuch_query_count_messages.
notmuch_status_t notmuch_query_count_threads (notmuch_query_t *query, unsigned *count)
Return the number of threads matching a search.
notmuch_status_t notmuch_query_count_threads_st (notmuch_query_t *query, unsigned *count)
Deprecated alias for notmuch_query_count_threads.
const char * notmuch_thread_get_thread_id (notmuch_thread_t *thread)
Get the thread ID of 'thread'.
int notmuch_thread_get_total_messages (notmuch_thread_t *thread)
Get the total number of messages in 'thread'.
int notmuch_thread_get_total_files (notmuch_thread_t *thread)
Get the total number of files in 'thread'.
notmuch_messages_t * notmuch_thread_get_toplevel_messages (notmuch_thread_t *thread)
Get a notmuch_messages_t iterator for the top-level messages in 'thread' in oldest-first order.
notmuch_messages_t * notmuch_thread_get_messages (notmuch_thread_t *thread)
Get a notmuch_thread_t iterator for all messages in 'thread' in oldest-first order.
int notmuch_thread_get_matched_messages (notmuch_thread_t *thread)
Get the number of messages in 'thread' that matched the search.
const char * notmuch_thread_get_authors (notmuch_thread_t *thread)
Get the authors of 'thread' as a UTF-8 string.
const char * notmuch_thread_get_subject (notmuch_thread_t *thread)
Get the subject of 'thread' as a UTF-8 string.
time_t notmuch_thread_get_oldest_date (notmuch_thread_t *thread)
Get the date of the oldest message in 'thread' as a time_t value.
time_t notmuch_thread_get_newest_date (notmuch_thread_t *thread)
Get the date of the newest message in 'thread' as a time_t value.
notmuch_tags_t * notmuch_thread_get_tags (notmuch_thread_t *thread)
Get the tags for 'thread', returning a notmuch_tags_t object which can be used to iterate over all tags.
void notmuch_thread_destroy (notmuch_thread_t *thread)
Destroy a notmuch_thread_t object.
notmuch_bool_t notmuch_messages_valid (notmuch_messages_t *messages)
Is the given 'messages' iterator pointing at a valid message.
notmuch_message_t * notmuch_messages_get (notmuch_messages_t *messages)
Get the current message from 'messages' as a notmuch_message_t.
void notmuch_messages_move_to_next (notmuch_messages_t *messages)
Move the 'messages' iterator to the next message.
void notmuch_messages_destroy (notmuch_messages_t *messages)
Destroy a notmuch_messages_t object.
notmuch_tags_t * notmuch_messages_collect_tags (notmuch_messages_t *messages)
Return a list of tags from all messages.
notmuch_database_t * notmuch_message_get_database (const notmuch_message_t *message)
Get the database associated with this message.
const char * notmuch_message_get_message_id (notmuch_message_t *message)
Get the message ID of 'message'.
const char * notmuch_message_get_thread_id (notmuch_message_t *message)
Get the thread ID of 'message'.
notmuch_messages_t * notmuch_message_get_replies (notmuch_message_t *message)
Get a notmuch_messages_t iterator for all of the replies to 'message'.
int notmuch_message_count_files (notmuch_message_t *message)
Get the total number of files associated with a message.
const char * notmuch_message_get_filename (notmuch_message_t *message)
Get a filename for the email corresponding to 'message'.
notmuch_filenames_t * notmuch_message_get_filenames (notmuch_message_t *message)
Get all filenames for the email corresponding to 'message'.
notmuch_status_t notmuch_message_reindex (notmuch_message_t *message, notmuch_indexopts_t *indexopts)
Re-index the e-mail corresponding to 'message' using the supplied index options.
notmuch_bool_t notmuch_message_get_flag (notmuch_message_t *message, notmuch_message_flag_t flag)
Get a value of a flag for the email corresponding to 'message'.
notmuch_status_t notmuch_message_get_flag_st (notmuch_message_t *message, notmuch_message_flag_t flag, notmuch_bool_t *is_set)
Get a value of a flag for the email corresponding to 'message'.
void notmuch_message_set_flag (notmuch_message_t *message, notmuch_message_flag_t flag, notmuch_bool_t value)
Set a value of a flag for the email corresponding to 'message'.
time_t notmuch_message_get_date (notmuch_message_t *message)
Get the date of 'message' as a time_t value.
const char * notmuch_message_get_header (notmuch_message_t *message, const char *header)
Get the value of the specified header from 'message' as a UTF-8 string.
notmuch_tags_t * notmuch_message_get_tags (notmuch_message_t *message)
Get the tags for 'message', returning a notmuch_tags_t object which can be used to iterate over all tags.
notmuch_status_t notmuch_message_add_tag (notmuch_message_t *message, const char *tag)
Add a tag to the given message.
notmuch_status_t notmuch_message_remove_tag (notmuch_message_t *message, const char *tag)
Remove a tag from the given message.
notmuch_status_t notmuch_message_remove_all_tags (notmuch_message_t *message)
Remove all tags from the given message.
notmuch_status_t notmuch_message_maildir_flags_to_tags (notmuch_message_t *message)
Add/remove tags according to maildir flags in the message filename(s).
notmuch_bool_t notmuch_message_has_maildir_flag (notmuch_message_t *message, char flag)
return TRUE if any filename of 'message' has maildir flag 'flag', FALSE otherwise.
notmuch_status_t notmuch_message_has_maildir_flag_st (notmuch_message_t *message, char flag, notmuch_bool_t *is_set)
check message for maildir flag
notmuch_status_t notmuch_message_tags_to_maildir_flags (notmuch_message_t *message)
Rename message filename(s) to encode tags as maildir flags.
notmuch_status_t notmuch_message_freeze (notmuch_message_t *message)
Freeze the current state of 'message' within the database.
notmuch_status_t notmuch_message_thaw (notmuch_message_t *message)
Thaw the current 'message', synchronizing any changes that may have occurred while 'message' was frozen into the notmuch database.
void notmuch_message_destroy (notmuch_message_t *message)
Destroy a notmuch_message_t object.
notmuch_bool_t notmuch_tags_valid (notmuch_tags_t *tags)
Is the given 'tags' iterator pointing at a valid tag.
const char * notmuch_tags_get (notmuch_tags_t *tags)
Get the current tag from 'tags' as a string.
void notmuch_tags_move_to_next (notmuch_tags_t *tags)
Move the 'tags' iterator to the next tag.
void notmuch_tags_destroy (notmuch_tags_t *tags)
Destroy a notmuch_tags_t object.
notmuch_status_t notmuch_directory_set_mtime (notmuch_directory_t *directory, time_t mtime)
Store an mtime within the database for 'directory'.
time_t notmuch_directory_get_mtime (notmuch_directory_t *directory)
Get the mtime of a directory, (as previously stored with notmuch_directory_set_mtime).
notmuch_filenames_t * notmuch_directory_get_child_files (notmuch_directory_t *directory)
Get a notmuch_filenames_t iterator listing all the filenames of messages in the database within the given directory.
notmuch_filenames_t * notmuch_directory_get_child_directories (notmuch_directory_t *directory)
Get a notmuch_filenames_t iterator listing all the filenames of sub-directories in the database within the given directory.
notmuch_status_t notmuch_directory_delete (notmuch_directory_t *directory)
Delete directory document from the database, and destroy the notmuch_directory_t object.
void notmuch_directory_destroy (notmuch_directory_t *directory)
Destroy a notmuch_directory_t object.
notmuch_bool_t notmuch_filenames_valid (notmuch_filenames_t *filenames)
Is the given 'filenames' iterator pointing at a valid filename.
const char * notmuch_filenames_get (notmuch_filenames_t *filenames)
Get the current filename from 'filenames' as a string.
void notmuch_filenames_move_to_next (notmuch_filenames_t *filenames)
Move the 'filenames' iterator to the next filename.
void notmuch_filenames_destroy (notmuch_filenames_t *filenames)
Destroy a notmuch_filenames_t object.
notmuch_status_t notmuch_database_set_config (notmuch_database_t *db, const char *key, const char *value)
set config 'key' to 'value'
notmuch_status_t notmuch_database_get_config (notmuch_database_t *db, const char *key, char **value)
retrieve config item 'key', assign to 'value'
notmuch_status_t notmuch_database_get_config_list (notmuch_database_t *db, const char *prefix, notmuch_config_list_t **out)
Create an iterator for all config items with keys matching a given prefix.
notmuch_bool_t notmuch_config_list_valid (notmuch_config_list_t *config_list)
Is 'config_list' iterator valid (i.e.
const char * notmuch_config_list_key (notmuch_config_list_t *config_list)
return key for current config pair
const char * notmuch_config_list_value (notmuch_config_list_t *config_list)
return 'value' for current config pair
void notmuch_config_list_move_to_next (notmuch_config_list_t *config_list)
move 'config_list' iterator to the next pair
void notmuch_config_list_destroy (notmuch_config_list_t *config_list)
free any resources held by 'config_list'
const char * notmuch_config_get (notmuch_database_t *notmuch, notmuch_config_key_t key)
get a configuration value from an open database.
notmuch_status_t notmuch_config_set (notmuch_database_t *notmuch, notmuch_config_key_t key, const char *val)
set a configuration value from in an open database.
notmuch_config_values_t * notmuch_config_get_values (notmuch_database_t *notmuch, notmuch_config_key_t key)
Returns an iterator for a ';'-delimited list of configuration values.
notmuch_config_values_t * notmuch_config_get_values_string (notmuch_database_t *notmuch, const char *key)
Returns an iterator for a ';'-delimited list of configuration values.
notmuch_bool_t notmuch_config_values_valid (notmuch_config_values_t *values)
Is the given 'config_values' iterator pointing at a valid element.
const char * notmuch_config_values_get (notmuch_config_values_t *values)
Get the current value from the 'values' iterator.
void notmuch_config_values_move_to_next (notmuch_config_values_t *values)
Move the 'values' iterator to the next element.
void notmuch_config_values_start (notmuch_config_values_t *values)
reset the 'values' iterator to the first element
void notmuch_config_values_destroy (notmuch_config_values_t *values)
Destroy a config values iterator, along with any associated resources.
notmuch_config_pairs_t * notmuch_config_get_pairs (notmuch_database_t *notmuch, const char *prefix)
Returns an iterator for a (key, value) configuration pairs.
notmuch_bool_t notmuch_config_pairs_valid (notmuch_config_pairs_t *pairs)
Is the given 'config_pairs' iterator pointing at a valid element.
void notmuch_config_pairs_move_to_next (notmuch_config_pairs_t *pairs)
Move the 'config_pairs' iterator to the next element.
const char * notmuch_config_pairs_key (notmuch_config_pairs_t *pairs)
Get the current key from the 'config_pairs' iterator.
const char * notmuch_config_pairs_value (notmuch_config_pairs_t *pairs)
Get the current value from the 'config_pairs' iterator.
void notmuch_config_pairs_destroy (notmuch_config_pairs_t *pairs)
Destroy a config_pairs iterator, along with any associated resources.
notmuch_status_t notmuch_config_get_bool (notmuch_database_t *notmuch, notmuch_config_key_t key, notmuch_bool_t *val)
get a configuration value from an open database as Boolean
const char * notmuch_config_path (notmuch_database_t *notmuch)
return the path of the config file loaded, if any
notmuch_indexopts_t * notmuch_database_get_default_indexopts (notmuch_database_t *db)
get the current default indexing options for a given database.
notmuch_status_t notmuch_indexopts_set_decrypt_policy (notmuch_indexopts_t *indexopts, notmuch_decryption_policy_t decrypt_policy)
Specify whether to decrypt encrypted parts while indexing.
notmuch_decryption_policy_t notmuch_indexopts_get_decrypt_policy (const notmuch_indexopts_t *indexopts)
Return whether to decrypt encrypted parts while indexing.
void notmuch_indexopts_destroy (notmuch_indexopts_t *options)
Destroy a notmuch_indexopts_t object.
notmuch_bool_t notmuch_built_with (const char *name)
interrogate the library for compile time features

  Message Properties
This interface provides the ability to attach arbitrary (key,value) string pairs to a message, to remove such pairs, and to iterate over them.

The caller should take some care as to what keys they add or delete values for, as other subsystems or extensions may depend on these properties.

Please see notmuch-properties(7) for more details about specific properties and conventions around their use.
typedef struct _notmuch_string_map_iterator notmuch_message_properties_t
Opaque message property iterator.
notmuch_status_t notmuch_message_get_property (notmuch_message_t *message, const char *key, const char **value)
Retrieve the value for a single property key.
notmuch_status_t notmuch_message_add_property (notmuch_message_t *message, const char *key, const char *value)
Add a (key,value) pair to a message.
notmuch_status_t notmuch_message_remove_property (notmuch_message_t *message, const char *key, const char *value)
Remove a (key,value) pair from a message.
notmuch_status_t notmuch_message_remove_all_properties (notmuch_message_t *message, const char *key)
Remove all (key,value) pairs from the given message.
notmuch_status_t notmuch_message_remove_all_properties_with_prefix (notmuch_message_t *message, const char *prefix)
Remove all (prefix*,value) pairs from the given message.
notmuch_message_properties_t * notmuch_message_get_properties (notmuch_message_t *message, const char *key, notmuch_bool_t exact)
Get the properties for message, returning a notmuch_message_properties_t object which can be used to iterate over all properties.
notmuch_status_t notmuch_message_count_properties (notmuch_message_t *message, const char *key, unsigned int *count)
Return the number of properties named 'key' belonging to the specific message.
notmuch_bool_t notmuch_message_properties_valid (notmuch_message_properties_t *properties)
Is the given properties iterator pointing at a valid (key,value) pair.
void notmuch_message_properties_move_to_next (notmuch_message_properties_t *properties)
Move the properties iterator to the next (key,value) pair.
const char * notmuch_message_properties_key (notmuch_message_properties_t *properties)
Return the key from the current (key,value) pair.
const char * notmuch_message_properties_value (notmuch_message_properties_t *properties)
Return the value from the current (key,value) pair.
void notmuch_message_properties_destroy (notmuch_message_properties_t *properties)
Destroy a notmuch_message_properties_t object.

Detailed Description

Not much of an email library, (just index and search)

Macro Definition Documentation

  #define LIBNOTMUCH_CHECK_VERSION(major, minor, micro)
Value:.PP
    (LIBNOTMUCH_MAJOR_VERSION > (major) ||                                      \
     (LIBNOTMUCH_MAJOR_VERSION == (major) && LIBNOTMUCH_MINOR_VERSION > (minor)) || \
     (LIBNOTMUCH_MAJOR_VERSION == (major) && LIBNOTMUCH_MINOR_VERSION == (minor) && \
      LIBNOTMUCH_MICRO_VERSION >= (micro)))

Check the version of the notmuch library being compiled against. Return true if the library being compiled against is of the specified version or above. For example:

#if LIBNOTMUCH_CHECK_VERSION(3, 1, 0)
    (code requiring libnotmuch 3.1.0 or above)
#endif

LIBNOTMUCH_CHECK_VERSION has been defined since version 3.1.0; to check for versions prior to that, use:

#if !defined(NOTMUCH_CHECK_VERSION)
    (code requiring libnotmuch prior to 3.1.0)
#endif

Enumeration Type Documentation

  enum notmuch_status_t

Status codes used for the return values of most functions. A zero value (NOTMUCH_STATUS_SUCCESS) indicates that the function completed without error. Any other value indicates an error.

Enumerator

NOTMUCH_STATUS_SUCCESS
    No error occurred.

NOTMUCH_STATUS_OUT_OF_MEMORY
    Out of memory.

NOTMUCH_STATUS_READ_ONLY_DATABASE
    An attempt was made to write to a database opened in read-only mode.

NOTMUCH_STATUS_XAPIAN_EXCEPTION
    A Xapian exception occurred.

NOTMUCH_STATUS_FILE_ERROR
    An error occurred trying to read or write to a file (this could be file not found, permission denied, etc.)

NOTMUCH_STATUS_FILE_NOT_EMAIL
    A file was presented that doesn't appear to be an email message.

NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID
    A file contains a message ID that is identical to a message already in the database.

NOTMUCH_STATUS_NULL_POINTER
    The user erroneously passed a NULL pointer to a notmuch function.

NOTMUCH_STATUS_TAG_TOO_LONG
    A tag value is too long (exceeds NOTMUCH_TAG_MAX).

NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW
    The notmuch_message_thaw function has been called more times than notmuch_message_freeze.

NOTMUCH_STATUS_UNBALANCED_ATOMIC
    notmuch_database_end_atomic has been called more times than notmuch_database_begin_atomic.

NOTMUCH_STATUS_UNSUPPORTED_OPERATION
    The operation is not supported.

NOTMUCH_STATUS_UPGRADE_REQUIRED
    The operation requires a database upgrade.

NOTMUCH_STATUS_PATH_ERROR
    There is a problem with the proposed path, e.g. a relative path passed to a function expecting an absolute path.

NOTMUCH_STATUS_IGNORED
    The requested operation was ignored. Depending on the function, this may not be an actual error.

NOTMUCH_STATUS_ILLEGAL_ARGUMENT
    One of the arguments violates the preconditions for the function, in a way not covered by a more specific argument.

NOTMUCH_STATUS_MALFORMED_CRYPTO_PROTOCOL
    A MIME object claimed to have cryptographic protection which notmuch tried to handle, but the protocol was not specified in an intelligible way.

NOTMUCH_STATUS_FAILED_CRYPTO_CONTEXT_CREATION
    Notmuch attempted to do crypto processing, but could not initialize the engine needed to do so.

NOTMUCH_STATUS_UNKNOWN_CRYPTO_PROTOCOL
    A MIME object claimed to have cryptographic protection, and notmuch attempted to process it, but the specific protocol was something that notmuch doesn't know how to handle.

NOTMUCH_STATUS_NO_CONFIG
    Unable to load a config file.

NOTMUCH_STATUS_NO_DATABASE
    Unable to load a database.

NOTMUCH_STATUS_DATABASE_EXISTS
    Database exists, so not (re)-created.

NOTMUCH_STATUS_BAD_QUERY_SYNTAX
    Syntax error in query.

NOTMUCH_STATUS_NO_MAIL_ROOT
    No mail root could be deduced from parameters and environment.

NOTMUCH_STATUS_CLOSED_DATABASE
    Database is not fully opened, or has been closed.

NOTMUCH_STATUS_LAST_STATUS
    Not an actual status value. Just a way to find out how many valid status values there are.

  enum notmuch_database_mode_t

Database open mode for notmuch_database_open.

Enumerator

NOTMUCH_DATABASE_MODE_READ_ONLY
    Open database for reading only.

NOTMUCH_DATABASE_MODE_READ_WRITE
    Open database for reading and writing.

  enum notmuch_sort_t

Sort values for notmuch_query_set_sort.

Enumerator

NOTMUCH_SORT_OLDEST_FIRST
    Oldest first.

NOTMUCH_SORT_NEWEST_FIRST
    Newest first.

NOTMUCH_SORT_MESSAGE_ID
    Sort by message-id.

NOTMUCH_SORT_UNSORTED
    Do not sort.

  enum notmuch_exclude_t

Exclude values for notmuch_query_set_omit_excluded. The strange order is to maintain backward compatibility: the old FALSE/TRUE options correspond to the new NOTMUCH_EXCLUDE_FLAG/NOTMUCH_EXCLUDE_TRUE options.

  enum notmuch_decryption_policy_t

Stating a policy about how to decrypt messages. See index.decrypt in notmuch-config(1) for more details.

Function Documentation

  const char * notmuch_status_to_string (notmuch_status_t status)

Get a string representation of a notmuch_status_t value. The result is read-only.

  notmuch_status_t notmuch_database_create (const char * path, notmuch_database_t ** database)

Create a new, empty notmuch database located at 'path'. The path should be a top-level directory to a collection of plain-text email messages (one message per file). This call will create a new '.notmuch' directory within 'path' where notmuch will store its data.

After a successful call to notmuch_database_create, the returned database will be open so the caller should call notmuch_database_destroy when finished with it.

The database will not yet have any data in it (notmuch_database_create itself is a very cheap function). Messages contained within 'path' can be added to the database by calling notmuch_database_index_file.

In case of any failure, this function returns an error status and sets *database to NULL (after printing an error message on stderr).

Return value:

NOTMUCH_STATUS_SUCCESS: Successfully created the database.

NOTMUCH_STATUS_NULL_POINTER: The given 'path' argument is NULL.

NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory.

NOTMUCH_STATUS_PATH_ERROR: filename is too long

NOTMUCH_STATUS_FILE_ERROR: An error occurred trying to create the database file (such as permission denied, or file not found, etc.), or the database already exists.

NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred.

  notmuch_status_t notmuch_database_create_verbose (const char * path, notmuch_database_t ** database, char ** error_message)

Like notmuch_database_create, except optionally return an error message. This message is allocated by malloc and should be freed by the caller.

  notmuch_status_t notmuch_database_open (const char * path, notmuch_database_mode_t mode, notmuch_database_t ** database)

Deprecated alias for notmuch_database_open_with_config with config_path='' and error_message=NULL.

Deprecated
    Deprecated as of libnotmuch 5.4 (notmuch 0.32)

  notmuch_status_t notmuch_database_open_verbose (const char * path, notmuch_database_mode_t mode, notmuch_database_t ** database, char ** error_message)

Deprecated alias for notmuch_database_open_with_config with config_path=''.

Deprecated
    Deprecated as of libnotmuch 5.4 (notmuch 0.32)

  notmuch_status_t notmuch_database_open_with_config (const char * database_path, notmuch_database_mode_t mode, const char * config_path, const char * profile, notmuch_database_t ** database, char ** error_message)

Open an existing notmuch database located at 'database_path', using configuration in 'config_path'.

Parameters
    database_path Path to existing database.

    A notmuch database is a Xapian database containing appropriate metadata.

    The database should have been created at some time in the past, (not necessarily by this process), by calling notmuch_database_create.

    If 'database_path' is NULL, use the location specified

    •   in the environment variable NOTMUCH_DATABASE, if non-empty

    •   in a configuration file, located as described under 'config_path'

    •   by $XDG_DATA_HOME/notmuch/$PROFILE where XDG_DATA_HOME defaults to '$HOME/.local/share' and PROFILE as as discussed in 'profile'

    If 'database_path' is non-NULL, but does not appear to be a Xapian database, check for a directory '.notmuch/xapian' below 'database_path' (this is the behavior of notmuch_database_open_verbose pre-0.32).

    mode Mode to open database. Use one of NOTMUCH_DATABASE_MODE_READ_WRITE or NOTMUCH_DATABASE_MODE_READ_ONLY

    config_path Path to config file.

    Config file is key-value, with mandatory sections. See notmuch-config(5) for more information. The key-value pair overrides the corresponding configuration data stored in the database (see notmuch_database_get_config)

    If config_path is NULL use the path specified

    •   in environment variable NOTMUCH_CONFIG, if non-empty

    •   by XDG_CONFIG_HOME/notmuch/ where XDG_CONFIG_HOME defaults to '$HOME/.config'.

    •   by $HOME/.notmuch-config

    If config_path is '' (empty string) then do not open any configuration file.
    profile Name of profile (configuration/database variant).

    If non-NULL, append to the directory / file path determined for config_path and database_path.

    If NULL then use

    •   environment variable NOTMUCH_PROFILE if defined,

    •   otherwise 'default' for directories and '' (empty string) for paths.

    database Pointer to database object. May not be NULL.

    The caller should call notmuch_database_destroy when finished with this database.

    In case of any failure, this function returns an error status and sets *database to NULL.

    error_message If non-NULL, store error message from opening the database. Any such message is allocated by malloc(3) and should be freed by the caller.

Return values
    NOTMUCH_STATUS_SUCCESS Successfully opened the database.
    NOTMUCH_STATUS_NULL_POINTER The given database argument is NULL.
    NOTMUCH_STATUS_NO_CONFIG No config file was found. Fatal.
    NOTMUCH_STATUS_OUT_OF_MEMORY Out of memory.
    NOTMUCH_STATUS_FILE_ERROR An error occurred trying to open the database or config file (such as permission denied, or file not found, etc.), or the database version is unknown.
    NOTMUCH_STATUS_XAPIAN_EXCEPTION A Xapian exception occurred.

Since
    libnotmuch 5.4 (notmuch 0.32)

  notmuch_status_t notmuch_database_load_config (const char * database_path, const char * config_path, const char * profile, notmuch_database_t ** database, char ** error_message)

Loads configuration from config file, database, and/or defaults. For description of arguments,

See also
    notmuch_database_open_with_config

For errors other then NO_DATABASE and NO_CONFIG, *database is set to NULL.

Return values
    NOTMUCH_STATUS_SUCCESS Successfully loaded configuration.
    NOTMUCH_STATUS_NO_CONFIG No config file was loaded. Not fatal.
    NOTMUCH_STATUS_NO_DATABASE No config information was loaded from a database. Not fatal.
    NOTMUCH_STATUS_OUT_OF_MEMORY Out of memory.
    NOTMUCH_STATUS_FILE_ERROR An error occurred trying to open the database or config file (such as permission denied, or file not found, etc.)
    NOTMUCH_STATUS_XAPIAN_EXCEPTION A Xapian exception occurred.

Since
    libnotmuch 5.4 (notmuch 0.32)

  notmuch_status_t notmuch_database_create_with_config (const char * database_path, const char * config_path, const char * profile, notmuch_database_t ** database, char ** error_message)

Create a new notmuch database located at 'database_path', using configuration in 'config_path'. For description of arguments,

See also
    notmuch_database_open_with_config

In case of any failure, this function returns an error status and sets *database to NULL.

Return values
    NOTMUCH_STATUS_SUCCESS Successfully created the database.
    NOTMUCH_STATUS_DATABASE_EXISTS Database already exists, not created
    NOTMUCH_STATUS_OUT_OF_MEMORY Out of memory.
    NOTMUCH_STATUS_FILE_ERROR An error occurred trying to open the database or config file (such as permission denied, or file not found, etc.)
    NOTMUCH_STATUS_XAPIAN_EXCEPTION A Xapian exception occurred.

Since
    libnotmuch 5.4 (notmuch 0.32)

  notmuch_status_t notmuch_database_close (notmuch_database_t * database)

Commit changes and close the given notmuch database. After notmuch_database_close has been called, calls to other functions on objects derived from this database may either behave as if the database had not been closed (e.g., if the required data has been cached) or may fail with a NOTMUCH_STATUS_XAPIAN_EXCEPTION. The only further operation permitted on the database itself is to call notmuch_database_destroy.

notmuch_database_close can be called multiple times. Later calls have no effect.

For writable databases, notmuch_database_close commits all changes to disk before closing the database, unless the caller is currently in an atomic section (there was a notmuch_database_begin_atomic without a matching notmuch_database_end_atomic). In this case changes since the last commit are discarded.

See also
    notmuch_database_end_atomic for more information.

Return value:

NOTMUCH_STATUS_SUCCESS: Successfully closed the database.

NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred; the database has been closed but there are no guarantees the changes to the database, if any, have been flushed to disk.

  notmuch_status_t notmuch_database_compact (const char * path, const char * backup_path, notmuch_compact_status_cb_t status_cb, void * closure)

Compact a notmuch database, backing up the original database to the given path. The database will be opened with NOTMUCH_DATABASE_MODE_READ_WRITE during the compaction process to ensure no writes are made.

If the optional callback function 'status_cb' is non-NULL, it will be called with diagnostic and informational messages. The argument 'closure' is passed verbatim to any callback invoked.

  notmuch_status_t notmuch_database_compact_db (notmuch_database_t * database, const char * backup_path, notmuch_compact_status_cb_t status_cb, void * closure)

Like notmuch_database_compact, but take an open database as a parameter.

Since
    libnnotmuch 5.4 (notmuch 0.32)

  notmuch_status_t notmuch_database_destroy (notmuch_database_t * database)

Destroy the notmuch database, closing it if necessary and freeing all associated resources. Return value as in notmuch_database_close if the database was open; notmuch_database_destroy itself has no failure modes.

  const char * notmuch_database_get_path (notmuch_database_t * database)

Return the database path of the given database. The return value is a string owned by notmuch so should not be modified nor freed by the caller.

  unsigned int notmuch_database_get_version (notmuch_database_t * database)

Return the database format version of the given database.

Return values
    0 on error

  notmuch_bool_t notmuch_database_needs_upgrade (notmuch_database_t * database)

Can the database be upgraded to a newer database version? If this function returns TRUE, then the caller may call notmuch_database_upgrade to upgrade the database. If the caller does not upgrade an out-of-date database, then some functions may fail with NOTMUCH_STATUS_UPGRADE_REQUIRED. This always returns FALSE for a read-only database because there's no way to upgrade a read-only database.

Also returns FALSE if an error occurs accessing the database.

  notmuch_status_t notmuch_database_upgrade (notmuch_database_t * database, void(*)(void *closure, double progress) progress_notify, void * closure)

Upgrade the current database to the latest supported version. This ensures that all current notmuch functionality will be available on the database. After opening a database in read-write mode, it is recommended that clients check if an upgrade is needed (notmuch_database_needs_upgrade) and if so, upgrade with this function before making any modifications. If notmuch_database_needs_upgrade returns FALSE, this will be a no-op.

The optional progress_notify callback can be used by the caller to provide progress indication to the user. If non-NULL it will be called periodically with 'progress' as a floating-point value in the range of [0.0 .. 1.0] indicating the progress made so far in the upgrade process. The argument 'closure' is passed verbatim to any callback invoked.

  notmuch_status_t notmuch_database_begin_atomic (notmuch_database_t * notmuch)

Begin an atomic database operation. Any modifications performed between a successful begin and a notmuch_database_end_atomic will be applied to the database atomically. Note that, unlike a typical database transaction, this only ensures atomicity, not durability; neither begin nor end necessarily flush modifications to disk.

Atomic sections may be nested. begin_atomic and end_atomic must always be called in pairs.

Return value:

NOTMUCH_STATUS_SUCCESS: Successfully entered atomic section.

NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred; atomic section not entered.

  notmuch_status_t notmuch_database_end_atomic (notmuch_database_t * notmuch)

Indicate the end of an atomic database operation. If repeated (with matching notmuch_database_begin_atomic) 'database.autocommit' times, commit the the transaction and all previous (non-cancelled) transactions to the database.

Return value:

NOTMUCH_STATUS_SUCCESS: Successfully completed atomic section.

NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred; atomic section not ended.

NOTMUCH_STATUS_UNBALANCED_ATOMIC: The database is not currently in an atomic section.

  unsigned long notmuch_database_get_revision (notmuch_database_t * notmuch, const char ** uuid)

Return the committed database revision and UUID. The database revision number increases monotonically with each commit to the database. Hence, all messages and message changes committed to the database (that is, visible to readers) have a last modification revision <= the committed database revision. Any messages committed in the future will be assigned a modification revision > the committed database revision.

The UUID is a NUL-terminated opaque string that uniquely identifies this database. Two revision numbers are only comparable if they have the same database UUID. The string 'uuid' is owned by notmuch and should not be freed or modified by the user.

  notmuch_status_t notmuch_database_get_directory (notmuch_database_t * database, const char * path, notmuch_directory_t ** directory)

Retrieve a directory object from the database for 'path'. Here, 'path' should be a path relative to the path of 'database' (see notmuch_database_get_path), or else should be an absolute path with initial components that match the path of 'database'.

If this directory object does not exist in the database, this returns NOTMUCH_STATUS_SUCCESS and sets *directory to NULL.

Otherwise the returned directory object is owned by the database and as such, will only be valid until notmuch_database_destroy is called.

Return value:

NOTMUCH_STATUS_SUCCESS: Successfully retrieved directory.

NOTMUCH_STATUS_NULL_POINTER: The given 'directory' argument is NULL.

NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred; directory not retrieved.

NOTMUCH_STATUS_UPGRADE_REQUIRED: The caller must upgrade the database to use this function.

  notmuch_status_t notmuch_database_index_file (notmuch_database_t * database, const char * filename, notmuch_indexopts_t * indexopts, notmuch_message_t ** message)

Add a message file to a database, indexing it for retrieval by future searches. If a message already exists with the same message ID as the specified file, their indexes will be merged, and this new filename will also be associated with the existing message.

Here, 'filename' should be a path relative to the path of 'database' (see notmuch_database_get_path), or else should be an absolute filename with initial components that match the path of 'database'.

The file should be a single mail message (not a multi-message mbox) that is expected to remain at its current location, (since the notmuch database will reference the filename, and will not copy the entire contents of the file.

If another message with the same message ID already exists in the database, rather than creating a new message, this adds the search terms from the identified file to the existing message's index, and adds 'filename' to the list of filenames known for the message.

The 'indexopts' parameter can be NULL (meaning, use the indexing defaults from the database), or can be an explicit choice of indexing options that should govern the indexing of this specific 'filename'.

If 'message' is not NULL, then, on successful return (NOTMUCH_STATUS_SUCCESS or NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID) '*message' will be initialized to a message object that can be used for things such as adding tags to the just-added message. The user should call notmuch_message_destroy when done with the message. On any failure '*message' will be set to NULL.

Return value:

NOTMUCH_STATUS_SUCCESS: Message successfully added to database.

NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred, message not added.

NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID: Message has the same message ID as another message already in the database. The new filename was successfully added to the message in the database (if not already present) and the existing message is returned.

NOTMUCH_STATUS_FILE_ERROR: an error occurred trying to open the file, (such as permission denied, or file not found, etc.). Nothing added to the database.

NOTMUCH_STATUS_FILE_NOT_EMAIL: the contents of filename don't look like an email message. Nothing added to the database.

NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only mode so no message can be added.

NOTMUCH_STATUS_UPGRADE_REQUIRED: The caller must upgrade the database to use this function.

Since
    libnotmuch 5.1 (notmuch 0.26)

  notmuch_status_t notmuch_database_add_message (notmuch_database_t * database, const char * filename, notmuch_message_t ** message)

Deprecated alias for notmuch_database_index_file called with NULL indexopts.

Deprecated
    Deprecated as of libnotmuch 5.1 (notmuch 0.26). Please use notmuch_database_index_file instead.

  notmuch_status_t notmuch_database_remove_message (notmuch_database_t * database, const char * filename)

Remove a message filename from the given notmuch database. If the message has no more filenames, remove the message.

If the same message (as determined by the message ID) is still available via other filenames, then the message will persist in the database for those filenames. When the last filename is removed for a particular message, the database content for that message will be entirely removed.

Return value:

NOTMUCH_STATUS_SUCCESS: The last filename was removed and the message was removed from the database.

NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred, message not removed.

NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID: This filename was removed but the message persists in the database with at least one other filename.

NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only mode so no message can be removed.

NOTMUCH_STATUS_UPGRADE_REQUIRED: The caller must upgrade the database to use this function.

  notmuch_status_t notmuch_database_find_message (notmuch_database_t * database, const char * message_id, notmuch_message_t ** message)

Find a message with the given message_id. If a message with the given message_id is found then, on successful return (NOTMUCH_STATUS_SUCCESS) '*message' will be initialized to a message object. The caller should call notmuch_message_destroy when done with the message.

On any failure or when the message is not found, this function initializes '*message' to NULL. This means, when NOTMUCH_STATUS_SUCCESS is returned, the caller is supposed to check '*message' for NULL to find out whether the message with the given message_id was found.

Return value:

NOTMUCH_STATUS_SUCCESS: Successful return, check '*message'.

NOTMUCH_STATUS_NULL_POINTER: The given 'message' argument is NULL

NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory, creating message object

NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred

  notmuch_status_t notmuch_database_find_message_by_filename (notmuch_database_t * notmuch, const char * filename, notmuch_message_t ** message)

Find a message with the given filename. If the database contains a message with the given filename then, on successful return (NOTMUCH_STATUS_SUCCESS) '*message' will be initialized to a message object. The caller should call notmuch_message_destroy when done with the message.

On any failure or when the message is not found, this function initializes '*message' to NULL. This means, when NOTMUCH_STATUS_SUCCESS is returned, the caller is supposed to check '*message' for NULL to find out whether the message with the given filename is found.

Return value:

NOTMUCH_STATUS_SUCCESS: Successful return, check '*message'

NOTMUCH_STATUS_NULL_POINTER: The given 'message' argument is NULL

NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory, creating the message object

NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred

NOTMUCH_STATUS_UPGRADE_REQUIRED: The caller must upgrade the database to use this function.

  notmuch_tags_t * notmuch_database_get_all_tags (notmuch_database_t * db)

Return a list of all tags found in the database. This function creates a list of all tags found in the database. The resulting list contains all tags from all messages found in the database.

On error this function returns NULL.

  notmuch_status_t notmuch_database_reopen (notmuch_database_t * db, notmuch_database_mode_t mode)

Reopen an open notmuch database.

Parameters
    db open notmuch database
    mode mode (read only or read-write) for reopened database.

Return values
    NOTMUCH_STATUS_SUCCESS
    NOTMUCH_STATUS_ILLEGAL_ARGUMENT The passed database was not open.
    NOTMUCH_STATUS_XAPIAN_EXCEPTION A Xapian exception occured

  notmuch_query_t * notmuch_query_create (notmuch_database_t * database, const char * query_string)

Create a new query for 'database'. Here, 'database' should be an open database, (see notmuch_database_open and notmuch_database_create).

For the query string, we'll document the syntax here more completely in the future, but it's likely to be a specialized version of the general Xapian query syntax:

https://xapian.org/docs/queryparser.html

As a special case, passing either a length-zero string, (that is ''), or a string consisting of a single asterisk (that is '*'), will result in a query that returns all messages in the database.

See notmuch_query_set_sort for controlling the order of results. See notmuch_query_search_messages and notmuch_query_search_threads to actually execute the query.

User should call notmuch_query_destroy when finished with this query.

Will return NULL if insufficient memory is available.

  const char * notmuch_query_get_query_string (const notmuch_query_t * query)

Return the query_string of this query. See notmuch_query_create.

  notmuch_database_t * notmuch_query_get_database (const notmuch_query_t * query)

Return the notmuch database of this query. See notmuch_query_create.

  void notmuch_query_set_omit_excluded (notmuch_query_t * query, notmuch_exclude_t omit_excluded)

Specify whether to omit excluded results or simply flag them. By default, this is set to TRUE.

If set to TRUE or ALL, notmuch_query_search_messages will omit excluded messages from the results, and notmuch_query_search_threads will omit threads that match only in excluded messages. If set to TRUE, notmuch_query_search_threads will include all messages in threads that match in at least one non-excluded message. Otherwise, if set to ALL, notmuch_query_search_threads will omit excluded messages from all threads.

If set to FALSE or FLAG then both notmuch_query_search_messages and notmuch_query_search_threads will return all matching messages/threads regardless of exclude status. If set to FLAG then the exclude flag will be set for any excluded message that is returned by notmuch_query_search_messages, and the thread counts for threads returned by notmuch_query_search_threads will be the number of non-excluded messages/matches. Otherwise, if set to FALSE, then the exclude status is completely ignored.

The performance difference when calling notmuch_query_search_messages should be relatively small (and both should be very fast). However, in some cases, notmuch_query_search_threads is very much faster when omitting excluded messages as it does not need to construct the threads that only match in excluded messages.

  notmuch_sort_t notmuch_query_get_sort (const notmuch_query_t * query)

Return the sort specified for this query. See notmuch_query_set_sort.

  notmuch_status_t notmuch_query_add_tag_exclude (notmuch_query_t * query, const char * tag)

Add a tag that will be excluded from the query results by default. This exclusion will be ignored if this tag appears explicitly in the query.

Returns

NOTMUCH_STATUS_SUCCESS: excluded was added successfully.

NOTMUCH_STATUS_XAPIAN_EXCEPTION: a Xapian exception occurred. Most likely a problem lazily parsing the query string.

NOTMUCH_STATUS_IGNORED: tag is explicitly present in the query, so not excluded.

  notmuch_status_t notmuch_query_search_threads (notmuch_query_t * query, notmuch_threads_t ** out)

Execute a query for threads, returning a notmuch_threads_t object which can be used to iterate over the results. The returned threads object is owned by the query and as such, will only be valid until notmuch_query_destroy.

Typical usage might be:

notmuch_query_t *query;
notmuch_threads_t *threads;
notmuch_thread_t *thread;
notmuch_status_t stat;

query = notmuch_query_create (database, query_string);

for (stat = notmuch_query_search_threads (query, &threads);
     stat == NOTMUCH_STATUS_SUCCESS &&
     notmuch_threads_valid (threads);
     notmuch_threads_move_to_next (threads))
{
    thread = notmuch_threads_get (threads);
    ....
    notmuch_thread_destroy (thread);
}

notmuch_query_destroy (query);

 Note: If you are finished with a thread before its containing query, you can call notmuch_thread_destroy to clean up some memory sooner (as in the above example). Otherwise, if your thread objects are long-lived, then you don't need to call notmuch_thread_destroy and all the memory will still be reclaimed when the query is destroyed.

Note that there's no explicit destructor needed for the notmuch_threads_t object. (For consistency, we do provide a notmuch_threads_destroy function, but there's no good reason to call it if the query is about to be destroyed).

Since
    libnotmuch 5.0 (notmuch 0.25)

  notmuch_status_t notmuch_query_search_threads_st (notmuch_query_t * query, notmuch_threads_t ** out)

Deprecated alias for notmuch_query_search_threads.

Deprecated
    Deprecated as of libnotmuch 5 (notmuch 0.25). Please use notmuch_query_search_threads instead.

  notmuch_status_t notmuch_query_search_messages (notmuch_query_t * query, notmuch_messages_t ** out)

Execute a query for messages, returning a notmuch_messages_t object which can be used to iterate over the results. The returned messages object is owned by the query and as such, will only be valid until notmuch_query_destroy.

Typical usage might be:

notmuch_query_t *query;
notmuch_messages_t *messages;
notmuch_message_t *message;

query = notmuch_query_create (database, query_string);

if (notmuch_query_search_messages (query, &messages) != NOTMUCH_STATUS_SUCCESS)
    return EXIT_FAILURE;

for (;
     notmuch_messages_valid (messages);
     notmuch_messages_move_to_next (messages))
{
    message = notmuch_messages_get (messages);
    ....
    notmuch_message_destroy (message);
}

notmuch_query_destroy (query);

 Note: If you are finished with a message before its containing query, you can call notmuch_message_destroy to clean up some memory sooner (as in the above example). Otherwise, if your message objects are long-lived, then you don't need to call notmuch_message_destroy and all the memory will still be reclaimed when the query is destroyed.

Note that there's no explicit destructor needed for the notmuch_messages_t object. (For consistency, we do provide a notmuch_messages_destroy function, but there's no good reason to call it if the query is about to be destroyed).

If a Xapian exception occurs this function will return NULL.

Since
    libnotmuch 5 (notmuch 0.25)

  notmuch_status_t notmuch_query_search_messages_st (notmuch_query_t * query, notmuch_messages_t ** out)

Deprecated alias for notmuch_query_search_messages.

Deprecated
    Deprecated as of libnotmuch 5 (notmuch 0.25). Please use notmuch_query_search_messages instead.

  void notmuch_query_destroy (notmuch_query_t * query)

Destroy a notmuch_query_t along with any associated resources. This will in turn destroy any notmuch_threads_t and notmuch_messages_t objects generated by this query, (and in turn any notmuch_thread_t and notmuch_message_t objects generated from those results, etc.), if such objects haven't already been destroyed.

  notmuch_bool_t notmuch_threads_valid (notmuch_threads_t * threads)

Is the given 'threads' iterator pointing at a valid thread. When this function returns TRUE, notmuch_threads_get will return a valid object. Whereas when this function returns FALSE, notmuch_threads_get will return NULL.

If passed a NULL pointer, this function returns FALSE

See the documentation of notmuch_query_search_threads for example code showing how to iterate over a notmuch_threads_t object.

  notmuch_thread_t * notmuch_threads_get (notmuch_threads_t * threads)

Get the current thread from 'threads' as a notmuch_thread_t. Note: The returned thread belongs to 'threads' and has a lifetime identical to it (and the query to which it belongs).

See the documentation of notmuch_query_search_threads for example code showing how to iterate over a notmuch_threads_t object.

If an out-of-memory situation occurs, this function will return NULL.

  void notmuch_threads_move_to_next (notmuch_threads_t * threads)

Move the 'threads' iterator to the next thread. If 'threads' is already pointing at the last thread then the iterator will be moved to a point just beyond that last thread, (where notmuch_threads_valid will return FALSE and notmuch_threads_get will return NULL).

See the documentation of notmuch_query_search_threads for example code showing how to iterate over a notmuch_threads_t object.

  void notmuch_threads_destroy (notmuch_threads_t * threads)

Destroy a notmuch_threads_t object. It's not strictly necessary to call this function. All memory from the notmuch_threads_t object will be reclaimed when the containing query object is destroyed.

  notmuch_status_t notmuch_query_count_messages (notmuch_query_t * query, unsigned int * count)

Return the number of messages matching a search. This function performs a search and returns the number of matching messages.

Returns

NOTMUCH_STATUS_SUCCESS: query completed successfully.

NOTMUCH_STATUS_XAPIAN_EXCEPTION: a Xapian exception occurred. The value of *count is not defined.

Since
    libnotmuch 5 (notmuch 0.25)

  notmuch_status_t notmuch_query_count_messages_st (notmuch_query_t * query, unsigned int * count)

Deprecated alias for notmuch_query_count_messages.

Deprecated
    Deprecated since libnotmuch 5.0 (notmuch 0.25). Please use notmuch_query_count_messages instead.

  notmuch_status_t notmuch_query_count_threads (notmuch_query_t * query, unsigned * count)

Return the number of threads matching a search. This function performs a search and returns the number of unique thread IDs in the matching messages. This is the same as number of threads matching a search.

Note that this is a significantly heavier operation than notmuch_query_count_messages{_st}().

Returns

NOTMUCH_STATUS_OUT_OF_MEMORY: Memory allocation failed. The value of *count is not defined

NOTMUCH_STATUS_SUCCESS: query completed successfully.

NOTMUCH_STATUS_XAPIAN_EXCEPTION: a Xapian exception occurred. The value of *count is not defined.

Since
    libnotmuch 5 (notmuch 0.25)

  notmuch_status_t notmuch_query_count_threads_st (notmuch_query_t * query, unsigned * count)

Deprecated alias for notmuch_query_count_threads.

Deprecated
    Deprecated as of libnotmuch 5.0 (notmuch 0.25). Please use notmuch_query_count_threads_st instead.

  const char * notmuch_thread_get_thread_id (notmuch_thread_t * thread)

Get the thread ID of 'thread'. The returned string belongs to 'thread' and as such, should not be modified by the caller and will only be valid for as long as the thread is valid, (which is until notmuch_thread_destroy or until the query from which it derived is destroyed).

  int notmuch_thread_get_total_messages (notmuch_thread_t * thread)

Get the total number of messages in 'thread'. This count consists of all messages in the database belonging to this thread. Contrast with notmuch_thread_get_matched_messages() .

  int notmuch_thread_get_total_files (notmuch_thread_t * thread)

Get the total number of files in 'thread'. This sums notmuch_message_count_files over all messages in the thread

Returns
    Non-negative integer

Since
    libnotmuch 5.0 (notmuch 0.25)

  notmuch_messages_t * notmuch_thread_get_toplevel_messages (notmuch_thread_t * thread)

Get a notmuch_messages_t iterator for the top-level messages in 'thread' in oldest-first order. This iterator will not necessarily iterate over all of the messages in the thread. It will only iterate over the messages in the thread which are not replies to other messages in the thread.

The returned list will be destroyed when the thread is destroyed.

  notmuch_messages_t * notmuch_thread_get_messages (notmuch_thread_t * thread)

Get a notmuch_thread_t iterator for all messages in 'thread' in oldest-first order. The returned list will be destroyed when the thread is destroyed.

  int notmuch_thread_get_matched_messages (notmuch_thread_t * thread)

Get the number of messages in 'thread' that matched the search. This count includes only the messages in this thread that were matched by the search from which the thread was created and were not excluded by any exclude tags passed in with the query (see notmuch_query_add_tag_exclude). Contrast with notmuch_thread_get_total_messages() .

  const char * notmuch_thread_get_authors (notmuch_thread_t * thread)

Get the authors of 'thread' as a UTF-8 string. The returned string is a comma-separated list of the names of the authors of mail messages in the query results that belong to this thread.

The string contains authors of messages matching the query first, then non-matched authors (with the two groups separated by '|'). Within each group, authors are ordered by date.

The returned string belongs to 'thread' and as such, should not be modified by the caller and will only be valid for as long as the thread is valid, (which is until notmuch_thread_destroy or until the query from which it derived is destroyed).

  const char * notmuch_thread_get_subject (notmuch_thread_t * thread)

Get the subject of 'thread' as a UTF-8 string. The subject is taken from the first message (according to the query order---see notmuch_query_set_sort) in the query results that belongs to this thread.

The returned string belongs to 'thread' and as such, should not be modified by the caller and will only be valid for as long as the thread is valid, (which is until notmuch_thread_destroy or until the query from which it derived is destroyed).

  notmuch_tags_t * notmuch_thread_get_tags (notmuch_thread_t * thread)

Get the tags for 'thread', returning a notmuch_tags_t object which can be used to iterate over all tags. Note: In the Notmuch database, tags are stored on individual messages, not on threads. So the tags returned here will be all tags of the messages which matched the search and which belong to this thread.

The tags object is owned by the thread and as such, will only be valid for as long as the thread is valid, (for example, until notmuch_thread_destroy or until the query from which it derived is destroyed).

Typical usage might be:

notmuch_thread_t *thread;
notmuch_tags_t *tags;
const char *tag;

thread = notmuch_threads_get (threads);

for (tags = notmuch_thread_get_tags (thread);
     notmuch_tags_valid (tags);
     notmuch_tags_move_to_next (tags))
{
    tag = notmuch_tags_get (tags);
    ....
}

notmuch_thread_destroy (thread);

 Note that there's no explicit destructor needed for the notmuch_tags_t object. (For consistency, we do provide a notmuch_tags_destroy function, but there's no good reason to call it if the message is about to be destroyed).

  notmuch_bool_t notmuch_messages_valid (notmuch_messages_t * messages)

Is the given 'messages' iterator pointing at a valid message. When this function returns TRUE, notmuch_messages_get will return a valid object. Whereas when this function returns FALSE, notmuch_messages_get will return NULL.

See the documentation of notmuch_query_search_messages for example code showing how to iterate over a notmuch_messages_t object.

  notmuch_message_t * notmuch_messages_get (notmuch_messages_t * messages)

Get the current message from 'messages' as a notmuch_message_t. Note: The returned message belongs to 'messages' and has a lifetime identical to it (and the query to which it belongs).

See the documentation of notmuch_query_search_messages for example code showing how to iterate over a notmuch_messages_t object.

If an out-of-memory situation occurs, this function will return NULL.

  void notmuch_messages_move_to_next (notmuch_messages_t * messages)

Move the 'messages' iterator to the next message. If 'messages' is already pointing at the last message then the iterator will be moved to a point just beyond that last message, (where notmuch_messages_valid will return FALSE and notmuch_messages_get will return NULL).

See the documentation of notmuch_query_search_messages for example code showing how to iterate over a notmuch_messages_t object.

  void notmuch_messages_destroy (notmuch_messages_t * messages)

Destroy a notmuch_messages_t object. It's not strictly necessary to call this function. All memory from the notmuch_messages_t object will be reclaimed when the containing query object is destroyed.

  notmuch_tags_t * notmuch_messages_collect_tags (notmuch_messages_t * messages)

Return a list of tags from all messages. The resulting list is guaranteed not to contain duplicated tags.

WARNING: You can no longer iterate over messages after calling this function, because the iterator will point at the end of the list. We do not have a function to reset the iterator yet and the only way how you can iterate over the list again is to recreate the message list.

The function returns NULL on error.

  notmuch_database_t * notmuch_message_get_database (const notmuch_message_t * message)

Get the database associated with this message.

Since
    libnotmuch 5.2 (notmuch 0.27)

  const char * notmuch_message_get_message_id (notmuch_message_t * message)

Get the message ID of 'message'. The returned string belongs to 'message' and as such, should not be modified by the caller and will only be valid for as long as the message is valid, (which is until the query from which it derived is destroyed).

This function will return NULL if triggers an unhandled Xapian exception.

  const char * notmuch_message_get_thread_id (notmuch_message_t * message)

Get the thread ID of 'message'. The returned string belongs to 'message' and as such, should not be modified by the caller and will only be valid for as long as the message is valid, (for example, until the user calls notmuch_message_destroy on 'message' or until a query from which it derived is destroyed).

This function will return NULL if triggers an unhandled Xapian exception.

  notmuch_messages_t * notmuch_message_get_replies (notmuch_message_t * message)

Get a notmuch_messages_t iterator for all of the replies to 'message'. Note: This call only makes sense if 'message' was ultimately obtained from a notmuch_thread_t object, (such as by coming directly from the result of calling notmuch_thread_get_ toplevel_messages or by any number of subsequent calls to notmuch_message_get_replies).

If 'message' was obtained through some non-thread means, (such as by a call to notmuch_query_search_messages), then this function will return NULL.

If there are no replies to 'message', this function will return NULL. (Note that notmuch_messages_valid will accept that NULL value as legitimate, and simply return FALSE for it.)

This function also returns NULL if it triggers a Xapian exception.

The returned list will be destroyed when the thread is destroyed.

  int notmuch_message_count_files (notmuch_message_t * message)

Get the total number of files associated with a message.

Returns
    Non-negative integer for file count.

    Negative integer for error.

Since
    libnotmuch 5.0 (notmuch 0.25)

  const char * notmuch_message_get_filename (notmuch_message_t * message)

Get a filename for the email corresponding to 'message'. The returned filename is an absolute filename, (the initial component will match notmuch_database_get_path() ).

The returned string belongs to the message so should not be modified or freed by the caller (nor should it be referenced after the message is destroyed).

Note: If this message corresponds to multiple files in the mail store, (that is, multiple files contain identical message IDs), this function will arbitrarily return a single one of those filenames. See notmuch_message_get_filenames for returning the complete list of filenames.

This function returns NULL if it triggers a Xapian exception.

  notmuch_filenames_t * notmuch_message_get_filenames (notmuch_message_t * message)

Get all filenames for the email corresponding to 'message'. Returns a notmuch_filenames_t iterator listing all the filenames associated with 'message'. These files may not have identical content, but each will have the identical Message-ID.

Each filename in the iterator is an absolute filename, (the initial component will match notmuch_database_get_path() ).

This function returns NULL if it triggers a Xapian exception.

  notmuch_status_t notmuch_message_reindex (notmuch_message_t * message, notmuch_indexopts_t * indexopts)

Re-index the e-mail corresponding to 'message' using the supplied index options. Returns the status of the re-index operation. (see the return codes documented in notmuch_database_index_file)

After reindexing, the user should discard the message object passed in here by calling notmuch_message_destroy, since it refers to the original message, not to the reindexed message.

  notmuch_bool_t notmuch_message_get_flag (notmuch_message_t * message, notmuch_message_flag_t flag)

Get a value of a flag for the email corresponding to 'message'. returns FALSE in case of errors.

Deprecated
    Deprecated as of libnotmuch 5.3 (notmuch 0.31). Please use notmuch_message_get_flag_st instead.

  notmuch_status_t notmuch_message_get_flag_st (notmuch_message_t * message, notmuch_message_flag_t flag, notmuch_bool_t * is_set)

Get a value of a flag for the email corresponding to 'message'.

Parameters
    message a message object
    flag flag to check
    is_set pointer to boolean to store flag value.

Return values
    NOTMUCH_STATUS_SUCCESS
    NOTMUCH_STATUS_NULL_POINTER is_set is NULL
    NOTMUCH_STATUS_XAPIAN_EXCEPTION Accessing the database triggered an exception.

Since
    libnotmuch 5.3 (notmuch 0.31)

  time_t notmuch_message_get_date (notmuch_message_t * message)

Get the date of 'message' as a time_t value. For the original textual representation of the Date header from the message call notmuch_message_get_header() with a header value of 'date'.

Returns 0 in case of error.

  const char * notmuch_message_get_header (notmuch_message_t * message, const char * header)

Get the value of the specified header from 'message' as a UTF-8 string. Common headers are stored in the database when the message is indexed and will be returned from the database. Other headers will be read from the actual message file.

The header name is case insensitive.

The returned string belongs to the message so should not be modified or freed by the caller (nor should it be referenced after the message is destroyed).

Returns an empty string ('') if the message does not contain a header line matching 'header'. Returns NULL if any error occurs.

  notmuch_tags_t * notmuch_message_get_tags (notmuch_message_t * message)

Get the tags for 'message', returning a notmuch_tags_t object which can be used to iterate over all tags. The tags object is owned by the message and as such, will only be valid for as long as the message is valid, (which is until the query from which it derived is destroyed).

Typical usage might be:

notmuch_message_t *message;
notmuch_tags_t *tags;
const char *tag;

message = notmuch_database_find_message (database, message_id);

for (tags = notmuch_message_get_tags (message);
     notmuch_tags_valid (tags);
     notmuch_tags_move_to_next (tags))
{
    tag = notmuch_tags_get (tags);
    ....
}

notmuch_message_destroy (message);

 Note that there's no explicit destructor needed for the notmuch_tags_t object. (For consistency, we do provide a notmuch_tags_destroy function, but there's no good reason to call it if the message is about to be destroyed).

  notmuch_status_t notmuch_message_add_tag (notmuch_message_t * message, const char * tag)

Add a tag to the given message. Return value:

NOTMUCH_STATUS_SUCCESS: Tag successfully added to message

NOTMUCH_STATUS_NULL_POINTER: The 'tag' argument is NULL

NOTMUCH_STATUS_TAG_TOO_LONG: The length of 'tag' is too long (exceeds NOTMUCH_TAG_MAX)

NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only mode so message cannot be modified.

  notmuch_status_t notmuch_message_remove_tag (notmuch_message_t * message, const char * tag)

Remove a tag from the given message. Return value:

NOTMUCH_STATUS_SUCCESS: Tag successfully removed from message

NOTMUCH_STATUS_NULL_POINTER: The 'tag' argument is NULL

NOTMUCH_STATUS_TAG_TOO_LONG: The length of 'tag' is too long (exceeds NOTMUCH_TAG_MAX)

NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only mode so message cannot be modified.

  notmuch_status_t notmuch_message_remove_all_tags (notmuch_message_t * message)

Remove all tags from the given message. See notmuch_message_freeze for an example showing how to safely replace tag values.

Return values
    NOTMUCH_STATUS_READ_ONLY_DATABASE Database was opened in read-only mode so message cannot be modified.
    NOTMUCH_STATUS_XAPIAN_EXCEPTION an exception was thrown accessing the database.

  notmuch_status_t notmuch_message_maildir_flags_to_tags (notmuch_message_t * message)

Add/remove tags according to maildir flags in the message filename(s). This function examines the filenames of 'message' for maildir flags, and adds or removes tags on 'message' as follows when these flags are present:

 Flag       Action if present
 ----       -----------------
 'D'        Adds the 'draft' tag to the message
 'F'        Adds the 'flagged' tag to the message
 'P'        Adds the 'passed' tag to the message
 'R'        Adds the 'replied' tag to the message
 'S'        Removes the 'unread' tag from the message

 For each flag that is not present, the opposite action (add/remove) is performed for the corresponding tags.

Flags are identified as trailing components of the filename after a sequence of ':2,'.

If there are multiple filenames associated with this message, the flag is considered present if it appears in one or more filenames. (That is, the flags from the multiple filenames are combined with the logical OR operator.)

A client can ensure that notmuch database tags remain synchronized with maildir flags by calling this function after each call to notmuch_database_index_file. See also notmuch_message_tags_to_maildir_flags for synchronizing tag changes back to maildir flags.

  notmuch_bool_t notmuch_message_has_maildir_flag (notmuch_message_t * message, char flag)

return TRUE if any filename of 'message' has maildir flag 'flag', FALSE otherwise. Deprecated wrapper for notmuch_message_has_maildir_flag_st

Returns
    FALSE in case of error

Deprecated
    libnotmuch 5.3 (notmuch 0.31)

  notmuch_status_t notmuch_message_has_maildir_flag_st (notmuch_message_t * message, char flag, notmuch_bool_t * is_set)

check message for maildir flag

Parameters
    message message to check
    flag flag to check for
    is_set pointer to boolean

Return values
    NOTMUCH_STATUS_SUCCESS
    NOTMUCH_STATUS_NULL_POINTER is_set is NULL
    NOTMUCH_STATUS_XAPIAN_EXCEPTION Accessing the database triggered an exception.

  notmuch_status_t notmuch_message_tags_to_maildir_flags (notmuch_message_t * message)

Rename message filename(s) to encode tags as maildir flags. Specifically, for each filename corresponding to this message:

If the filename is not in a maildir directory, do nothing. (A maildir directory is determined as a directory named 'new' or 'cur'.) Similarly, if the filename has invalid maildir info, (repeated or outof-ASCII-order flag characters after ':2,'), then do nothing.

If the filename is in a maildir directory, rename the file so that its filename ends with the sequence ':2,' followed by zero or more of the following single-character flags (in ASCII order):

•   flag 'D' iff the message has the 'draft' tag

•   flag 'F' iff the message has the 'flagged' tag

•   flag 'P' iff the message has the 'passed' tag

•   flag 'R' iff the message has the 'replied' tag

•   flag 'S' iff the message does not have the 'unread' tag

Any existing flags unmentioned in the list above will be preserved in the renaming.

Also, if this filename is in a directory named 'new', rename it to be within the neighboring directory named 'cur'.

A client can ensure that maildir filename flags remain synchronized with notmuch database tags by calling this function after changing tags, (after calls to notmuch_message_add_tag, notmuch_message_remove_tag, or notmuch_message_freeze/ notmuch_message_thaw). See also notmuch_message_maildir_flags_to_tags for synchronizing maildir flag changes back to tags.

  notmuch_status_t notmuch_message_freeze (notmuch_message_t * message)

Freeze the current state of 'message' within the database. This means that changes to the message state, (via notmuch_message_add_tag, notmuch_message_remove_tag, and notmuch_message_remove_all_tags), will not be committed to the database until the message is thawed with notmuch_message_thaw.

Multiple calls to freeze/thaw are valid and these calls will 'stack'. That is there must be as many calls to thaw as to freeze before a message is actually thawed.

The ability to do freeze/thaw allows for safe transactions to change tag values. For example, explicitly setting a message to have a given set of tags might look like this:

notmuch_message_freeze (message);

notmuch_message_remove_all_tags (message);

for (i = 0; i < NUM_TAGS; i++) notmuch_message_add_tag (message, tags[i]);

notmuch_message_thaw (message);

With freeze/thaw used like this, the message in the database is guaranteed to have either the full set of original tag values, or the full set of new tag values, but nothing in between.

Imagine the example above without freeze/thaw and the operation somehow getting interrupted. This could result in the message being left with no tags if the interruption happened after notmuch_message_remove_all_tags but before notmuch_message_add_tag.

Return value:

NOTMUCH_STATUS_SUCCESS: Message successfully frozen.

NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only mode so message cannot be modified.

  notmuch_status_t notmuch_message_thaw (notmuch_message_t * message)

Thaw the current 'message', synchronizing any changes that may have occurred while 'message' was frozen into the notmuch database. See notmuch_message_freeze for an example of how to use this function to safely provide tag changes.

Multiple calls to freeze/thaw are valid and these calls with 'stack'. That is there must be as many calls to thaw as to freeze before a message is actually thawed.

Return value:

NOTMUCH_STATUS_SUCCESS: Message successfully thawed, (or at least its frozen count has successfully been reduced by 1).

NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW: An attempt was made to thaw an unfrozen message. That is, there have been an unbalanced number of calls to notmuch_message_freeze and notmuch_message_thaw.

  void notmuch_message_destroy (notmuch_message_t * message)

Destroy a notmuch_message_t object. It can be useful to call this function in the case of a single query object with many messages in the result, (such as iterating over the entire database). Otherwise, it's fine to never call this function and there will still be no memory leaks. (The memory from the messages get reclaimed when the containing query is destroyed.)

  notmuch_status_t notmuch_message_get_property (notmuch_message_t * message, const char * key, const char ** value)

Retrieve the value for a single property key. value is set to a string owned by the message or NULL if there is no such key. In the case of multiple values for the given key, the first one is retrieved.

Returns

    •   NOTMUCH_STATUS_NULL_POINTER: value may not be NULL.

    •   NOTMUCH_STATUS_SUCCESS: No error occurred.

Since
    libnotmuch 4.4 (notmuch 0.23)

  notmuch_status_t notmuch_message_add_property (notmuch_message_t * message, const char * key, const char * value)

Add a (key,value) pair to a message.

Returns

    •   NOTMUCH_STATUS_ILLEGAL_ARGUMENT: key may not contain an '=' character.

    •   NOTMUCH_STATUS_NULL_POINTER: Neither key nor value may be NULL.

    •   NOTMUCH_STATUS_SUCCESS: No error occurred.

Since
    libnotmuch 4.4 (notmuch 0.23)

  notmuch_status_t notmuch_message_remove_property (notmuch_message_t * message, const char * key, const char * value)

Remove a (key,value) pair from a message. It is not an error to remove a non-existent (key,value) pair

Returns

    •   NOTMUCH_STATUS_ILLEGAL_ARGUMENT: key may not contain an '=' character.

    •   NOTMUCH_STATUS_NULL_POINTER: Neither key nor value may be NULL.

    •   NOTMUCH_STATUS_SUCCESS: No error occurred.

Since
    libnotmuch 4.4 (notmuch 0.23)

  notmuch_status_t notmuch_message_remove_all_properties (notmuch_message_t * message, const char * key)

Remove all (key,value) pairs from the given message.

Parameters
    message message to operate on.
    key key to delete properties for. If NULL, delete properties for all keys

Returns

    •   NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only mode so message cannot be modified.

    •   NOTMUCH_STATUS_SUCCESS: No error occurred.

Since
    libnotmuch 4.4 (notmuch 0.23)

  notmuch_status_t notmuch_message_remove_all_properties_with_prefix (notmuch_message_t * message, const char * prefix)

Remove all (prefix*,value) pairs from the given message.

Parameters
    message message to operate on.
    prefix delete properties with keys that start with prefix. If NULL, delete all properties

Returns

    •   NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only mode so message cannot be modified.

    •   NOTMUCH_STATUS_SUCCESS: No error occurred.

Since
    libnotmuch 5.1 (notmuch 0.26)

  notmuch_message_properties_t * notmuch_message_get_properties (notmuch_message_t * message, const char * key, notmuch_bool_t exact)

Get the properties for message, returning a notmuch_message_properties_t object which can be used to iterate over all properties. The notmuch_message_properties_t object is owned by the message and as such, will only be valid for as long as the message is valid, (which is until the query from which it derived is destroyed).

Parameters
    message The message to examine
    key key or key prefix
    exact if TRUE, require exact match with key. Otherwise treat as prefix.

Typical usage might be:

notmuch_message_properties_t *list;

for (list = notmuch_message_get_properties (message, 'testkey1', TRUE);
     notmuch_message_properties_valid (list); notmuch_message_properties_move_to_next (list)) {
   printf('%s\n', notmuch_message_properties_value(list));
}

notmuch_message_properties_destroy (list);

 Note that there's no explicit destructor needed for the notmuch_message_properties_t object. (For consistency, we do provide a notmuch_message_properities_destroy function, but there's no good reason to call it if the message is about to be destroyed).

Since
    libnotmuch 4.4 (notmuch 0.23)

  notmuch_status_t notmuch_message_count_properties (notmuch_message_t * message, const char * key, unsigned int * count)

Return the number of properties named 'key' belonging to the specific message.

Parameters
    message The message to examine
    key key to count
    count The number of matching properties associated with this message.

Returns

NOTMUCH_STATUS_SUCCESS: successful count, possibly some other error.

Since
    libnotmuch 5.2 (notmuch 0.27)

  notmuch_bool_t notmuch_message_properties_valid (notmuch_message_properties_t * properties)

Is the given properties iterator pointing at a valid (key,value) pair. When this function returns TRUE, notmuch_message_properties_{key,value} will return a valid string, and notmuch_message_properties_move_to_next will do what it says. Whereas when this function returns FALSE, calling any of these functions results in undefined behaviour.

See the documentation of notmuch_message_get_properties for example code showing how to iterate over a notmuch_message_properties_t object.

Since
    libnotmuch 4.4 (notmuch 0.23)

  void notmuch_message_properties_move_to_next (notmuch_message_properties_t * properties)

Move the properties iterator to the next (key,value) pair. If properties is already pointing at the last pair then the iterator will be moved to a point just beyond that last pair, (where notmuch_message_properties_valid will return FALSE).

See the documentation of notmuch_message_get_properties for example code showing how to iterate over a notmuch_message_properties_t object.

Since
    libnotmuch 4.4 (notmuch 0.23)

  const char * notmuch_message_properties_key (notmuch_message_properties_t * properties)

Return the key from the current (key,value) pair. this could be useful if iterating for a prefix

Since
    libnotmuch 4.4 (notmuch 0.23)

  const char * notmuch_message_properties_value (notmuch_message_properties_t * properties)

Return the value from the current (key,value) pair. This could be useful if iterating for a prefix.

Since
    libnotmuch 4.4 (notmuch 0.23)

  void notmuch_message_properties_destroy (notmuch_message_properties_t * properties)

Destroy a notmuch_message_properties_t object. It's not strictly necessary to call this function. All memory from the notmuch_message_properties_t object will be reclaimed when the containing message object is destroyed.

Since
    libnotmuch 4.4 (notmuch 0.23)

  notmuch_bool_t notmuch_tags_valid (notmuch_tags_t * tags)

Is the given 'tags' iterator pointing at a valid tag. When this function returns TRUE, notmuch_tags_get will return a valid string. Whereas when this function returns FALSE, notmuch_tags_get will return NULL.

It is acceptable to pass NULL for 'tags', in which case this function will always return FALSE.

See the documentation of notmuch_message_get_tags for example code showing how to iterate over a notmuch_tags_t object.

  const char * notmuch_tags_get (notmuch_tags_t * tags)

Get the current tag from 'tags' as a string. Note: The returned string belongs to 'tags' and has a lifetime identical to it (and the query to which it ultimately belongs).

See the documentation of notmuch_message_get_tags for example code showing how to iterate over a notmuch_tags_t object.

  void notmuch_tags_move_to_next (notmuch_tags_t * tags)

Move the 'tags' iterator to the next tag. If 'tags' is already pointing at the last tag then the iterator will be moved to a point just beyond that last tag, (where notmuch_tags_valid will return FALSE and notmuch_tags_get will return NULL).

See the documentation of notmuch_message_get_tags for example code showing how to iterate over a notmuch_tags_t object.

  void notmuch_tags_destroy (notmuch_tags_t * tags)

Destroy a notmuch_tags_t object. It's not strictly necessary to call this function. All memory from the notmuch_tags_t object will be reclaimed when the containing message or query objects are destroyed.

  notmuch_status_t notmuch_directory_set_mtime (notmuch_directory_t * directory, time_t mtime)

Store an mtime within the database for 'directory'. The 'directory' should be an object retrieved from the database with notmuch_database_get_directory for a particular path.

The intention is for the caller to use the mtime to allow efficient identification of new messages to be added to the database. The recommended usage is as follows:

o Read the mtime of a directory from the filesystem

o Call index_file for all mail files in the directory

o Call notmuch_directory_set_mtime with the mtime read from the filesystem.

Then, when wanting to check for updates to the directory in the future, the client can call notmuch_directory_get_mtime and know that it only needs to add files if the mtime of the directory and files are newer than the stored timestamp.

Note: The notmuch_directory_get_mtime function does not allow the caller to distinguish a timestamp of 0 from a non-existent timestamp. So don't store a timestamp of 0 unless you are comfortable with that.

Return value:

NOTMUCH_STATUS_SUCCESS: mtime successfully stored in database.

NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred, mtime not stored.

NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only mode so directory mtime cannot be modified.

  time_t notmuch_directory_get_mtime (notmuch_directory_t * directory)

Get the mtime of a directory, (as previously stored with notmuch_directory_set_mtime). Returns 0 if no mtime has previously been stored for this directory.

  notmuch_filenames_t * notmuch_directory_get_child_files (notmuch_directory_t * directory)

Get a notmuch_filenames_t iterator listing all the filenames of messages in the database within the given directory. The returned filenames will be the basename-entries only (not complete paths).

Returns NULL if it triggers a Xapian exception

  notmuch_filenames_t * notmuch_directory_get_child_directories (notmuch_directory_t * directory)

Get a notmuch_filenames_t iterator listing all the filenames of sub-directories in the database within the given directory. The returned filenames will be the basename-entries only (not complete paths).

Returns NULL if it triggers a Xapian exception

  notmuch_status_t notmuch_directory_delete (notmuch_directory_t * directory)

Delete directory document from the database, and destroy the notmuch_directory_t object. Assumes any child directories and files have been deleted by the caller.

Since
    libnotmuch 4.3 (notmuch 0.21)

  notmuch_bool_t notmuch_filenames_valid (notmuch_filenames_t * filenames)

Is the given 'filenames' iterator pointing at a valid filename. When this function returns TRUE, notmuch_filenames_get will return a valid string. Whereas when this function returns FALSE, notmuch_filenames_get will return NULL.

It is acceptable to pass NULL for 'filenames', in which case this function will always return FALSE.

  const char * notmuch_filenames_get (notmuch_filenames_t * filenames)

Get the current filename from 'filenames' as a string. Note: The returned string belongs to 'filenames' and has a lifetime identical to it (and the directory to which it ultimately belongs).

It is acceptable to pass NULL for 'filenames', in which case this function will always return NULL.

  void notmuch_filenames_move_to_next (notmuch_filenames_t * filenames)

Move the 'filenames' iterator to the next filename. If 'filenames' is already pointing at the last filename then the iterator will be moved to a point just beyond that last filename, (where notmuch_filenames_valid will return FALSE and notmuch_filenames_get will return NULL).

It is acceptable to pass NULL for 'filenames', in which case this function will do nothing.

  void notmuch_filenames_destroy (notmuch_filenames_t * filenames)

Destroy a notmuch_filenames_t object. It's not strictly necessary to call this function. All memory from the notmuch_filenames_t object will be reclaimed when the containing directory object is destroyed.

It is acceptable to pass NULL for 'filenames', in which case this function will do nothing.

  notmuch_status_t notmuch_database_set_config (notmuch_database_t * db, const char * key, const char * value)

set config 'key' to 'value'

Since
    libnotmuch 4.4 (notmuch 0.23)

Return values
    NOTMUCH_STATUS_READ_ONLY_DATABASE Database was opened in read-only mode so message cannot be modified.
    NOTMUCH_STATUS_XAPIAN_EXCEPTION an exception was thrown accessing the database.
    NOTMUCH_STATUS_SUCCESS

  notmuch_status_t notmuch_database_get_config (notmuch_database_t * db, const char * key, char ** value)

retrieve config item 'key', assign to 'value' keys which have not been previously set with n_d_set_config will return an empty string.

return value is allocated by malloc and should be freed by the caller.

Since
    libnotmuch 4.4 (notmuch 0.23)

  notmuch_status_t notmuch_database_get_config_list (notmuch_database_t * db, const char * prefix, notmuch_config_list_t ** out)

Create an iterator for all config items with keys matching a given prefix.

Since
    libnotmuch 4.4 (notmuch 0.23)

  notmuch_bool_t notmuch_config_list_valid (notmuch_config_list_t * config_list)

Is 'config_list' iterator valid (i.e. _key, _value, _move_to_next can be called).

Since
    libnotmuch 4.4 (notmuch 0.23)

  const char * notmuch_config_list_key (notmuch_config_list_t * config_list)

return key for current config pair return value is owned by the iterator, and will be destroyed by the next call to notmuch_config_list_key or notmuch_config_list_destroy.

Since
    libnotmuch 4.4 (notmuch 0.23)

  const char * notmuch_config_list_value (notmuch_config_list_t * config_list)

return 'value' for current config pair return value is owned by the iterator, and will be destroyed by the next call to notmuch_config_list_value or notmuch config_list_destroy

Since
    libnotmuch 4.4 (notmuch 0.23)

Return values
    NULL for errors

  void notmuch_config_list_move_to_next (notmuch_config_list_t * config_list)

move 'config_list' iterator to the next pair

Since
    libnotmuch 4.4 (notmuch 0.23)

  void notmuch_config_list_destroy (notmuch_config_list_t * config_list)

free any resources held by 'config_list'

Since
    libnotmuch 4.4 (notmuch 0.23)

  const char * notmuch_config_get (notmuch_database_t * notmuch, notmuch_config_key_t key)

get a configuration value from an open database. This value reflects all configuration information given at the time the database was opened.

Parameters
    notmuch database
    key configuration key

Since
    libnotmuch 5.4 (notmuch 0.32)

Return values
    NULL if 'key' unknown or if no value is known for 'key'. Otherwise returns a string owned by notmuch which should not be modified nor freed by the caller.

  notmuch_status_t notmuch_config_set (notmuch_database_t * notmuch, notmuch_config_key_t key, const char * val)

set a configuration value from in an open database. This value reflects all configuration information given at the time the database was opened.

Parameters
    notmuch database open read/write
    key configuration key
    val configuration value

Since
    libnotmuch 5.4 (notmuch 0.32)

Return values
    returns any return value for notmuch_database_set_config.

  notmuch_config_values_t * notmuch_config_get_values (notmuch_database_t * notmuch, notmuch_config_key_t key)

Returns an iterator for a ';'-delimited list of configuration values. These values reflect all configuration information given at the time the database was opened.

Parameters
    notmuch database
    key configuration key

Since
    libnotmuch 5.4 (notmuch 0.32)

Return values
    NULL in case of error.

  notmuch_config_values_t * notmuch_config_get_values_string (notmuch_database_t * notmuch, const char * key)

Returns an iterator for a ';'-delimited list of configuration values. These values reflect all configuration information given at the time the database was opened.

Parameters
    notmuch database
    key configuration key

Since
    libnotmuch 5.4 (notmuch 0.32)

Return values
    NULL in case of error.

  notmuch_bool_t notmuch_config_values_valid (notmuch_config_values_t * values)

Is the given 'config_values' iterator pointing at a valid element.

Parameters
    values iterator

Since
    libnotmuch 5.4 (notmuch 0.32)

Return values
    FALSE if passed a NULL pointer, or the iterator is exhausted.

  const char * notmuch_config_values_get (notmuch_config_values_t * values)

Get the current value from the 'values' iterator.

Parameters
    values iterator

Since
    libnotmuch 5.4 (notmuch 0.32)

Return values
    a string with the same lifetime as the iterator

  void notmuch_config_values_move_to_next (notmuch_config_values_t * values)

Move the 'values' iterator to the next element.

Parameters
    values iterator

Since
    libnotmuch 5.4 (notmuch 0.32)

  void notmuch_config_values_start (notmuch_config_values_t * values)

reset the 'values' iterator to the first element

Parameters
    values iterator. A NULL value is ignored.

Since
    libnotmuch 5.4 (notmuch 0.32)

  void notmuch_config_values_destroy (notmuch_config_values_t * values)

Destroy a config values iterator, along with any associated resources.

Parameters
    values iterator

Since
    libnotmuch 5.4 (notmuch 0.32)

  notmuch_config_pairs_t * notmuch_config_get_pairs (notmuch_database_t * notmuch, const char * prefix)

Returns an iterator for a (key, value) configuration pairs.

Parameters
    notmuch database
    prefix prefix for keys. Pass '' for all keys.

Since
    libnotmuch 5.4 (notmuch 0.32)

Return values
    NULL in case of error.

  notmuch_bool_t notmuch_config_pairs_valid (notmuch_config_pairs_t * pairs)

Is the given 'config_pairs' iterator pointing at a valid element.

Parameters
    pairs iterator

Since
    libnotmuch 5.4 (notmuch 0.32)

Return values
    FALSE if passed a NULL pointer, or the iterator is exhausted.

  void notmuch_config_pairs_move_to_next (notmuch_config_pairs_t * pairs)

Move the 'config_pairs' iterator to the next element.

Parameters
    pairs iterator

Since
    libnotmuch 5.4 (notmuch 0.32)

  const char * notmuch_config_pairs_key (notmuch_config_pairs_t * pairs)

Get the current key from the 'config_pairs' iterator.

Parameters
    pairs iterator

Since
    libnotmuch 5.4 (notmuch 0.32)

Return values
    a string with the same lifetime as the iterator

  const char * notmuch_config_pairs_value (notmuch_config_pairs_t * pairs)

Get the current value from the 'config_pairs' iterator.

Parameters
    pairs iterator

Since
    libnotmuch 5.4 (notmuch 0.32)

Return values
    a string with the same lifetime as the iterator

  void notmuch_config_pairs_destroy (notmuch_config_pairs_t * pairs)

Destroy a config_pairs iterator, along with any associated resources.

Parameters
    pairs iterator

Since
    libnotmuch 5.4 (notmuch 0.32)

  notmuch_status_t notmuch_config_get_bool (notmuch_database_t * notmuch, notmuch_config_key_t key, notmuch_bool_t * val)

get a configuration value from an open database as Boolean This value reflects all configuration information given at the time the database was opened.

Parameters
    notmuch database
    key configuration key
    val configuration value, converted to Boolean

Since
    libnotmuch 5.4 (notmuch 0.32)

Return values
    NOTMUCH_STATUS_ILLEGAL_ARGUMENT if either key is unknown or the corresponding value does not convert to Boolean.

  const char * notmuch_config_path (notmuch_database_t * notmuch)

return the path of the config file loaded, if any

Return values
    NULL if no config file was loaded

  notmuch_indexopts_t * notmuch_database_get_default_indexopts (notmuch_database_t * db)

get the current default indexing options for a given database. This object will survive until the database itself is destroyed, but the caller may also release it earlier with notmuch_indexopts_destroy.

This object represents a set of options on how a message can be added to the index. At the moment it is a featureless stub.

Since
    libnotmuch 5.1 (notmuch 0.26)

Return values
    NULL in case of error

  notmuch_status_t notmuch_indexopts_set_decrypt_policy (notmuch_indexopts_t * indexopts, notmuch_decryption_policy_t decrypt_policy)

Specify whether to decrypt encrypted parts while indexing. Be aware that the index is likely sufficient to reconstruct the cleartext of the message itself, so please ensure that the notmuch message index is adequately protected. DO NOT SET THIS FLAG TO TRUE without considering the security of your index.

Since
    libnotmuch 5.1 (notmuch 0.26)

  notmuch_decryption_policy_t notmuch_indexopts_get_decrypt_policy (const notmuch_indexopts_t * indexopts)

Return whether to decrypt encrypted parts while indexing. see notmuch_indexopts_set_decrypt_policy.

Since
    libnotmuch 5.1 (notmuch 0.26)

  void notmuch_indexopts_destroy (notmuch_indexopts_t * options)

Destroy a notmuch_indexopts_t object.

Since
    libnotmuch 5.1 (notmuch 0.26)

  notmuch_bool_t notmuch_built_with (const char * name)

interrogate the library for compile time features

Since
    libnotmuch 4.4 (notmuch 0.23)

Author

Generated automatically by Doxygen for Notmuch 0.39 from the source code.