var searchIndex = {};
searchIndex["notmuch_sys"] = {"doc":"Not much of an email library, just index and search.","items":[[4,"notmuch_status_t","notmuch_sys","Status codes used for the return values of most functions.",null,null],[13,"SUCCESS","","No error occurred.",0,null],[13,"OUT_OF_MEMORY","","Out of memory.",0,null],[13,"READ_ONLY_DATABASE","","An attempt was made to write to a database opened in read-only\nmode.",0,null],[13,"XAPIAN_EXCEPTION","","A Xapian exception occurred.",0,null],[13,"FILE_ERROR","","An error occurred trying to read or write to a file (this could\nbe file not found, permission denied, etc.)",0,null],[13,"FILE_NOT_EMAIL","","A file was presented that doesn't appear to be an email\nmessage.",0,null],[13,"DUPLICATE_MESSAGE_ID","","A file contains a message ID that is identical to a message\nalready in the database.",0,null],[13,"NULL_POINTER","","The user erroneously passed a NULL pointer to a notmuch\nfunction.",0,null],[13,"TAG_TOO_LONG","","A tag value is too long (exceeds TAG_MAX).",0,null],[13,"UNBALANCED_FREEZE_THAW","","The `notmuch_message_thaw` function has been called more times\nthan `notmuch_message_freeze`.",0,null],[13,"UNBALANCED_ATOMIC","","`notmuch_database_end_atomic` has been called more times than\n`notmuch_database_begin_atomic`.",0,null],[13,"UNSUPPORTED_OPERATION","","The operation is not supported.",0,null],[13,"UPGRADE_REQUIRED","","The operation requires a database upgrade.",0,null],[13,"PATH_ERROR","","There is a problem with the proposed path, e.g. a relative path\npassed to a function expecting an absolute path.",0,null],[4,"notmuch_sort_t","","Sort values for `notmuch_query_set_sort`.",null,null],[13,"OLDEST_FIRST","","Oldest first.",1,null],[13,"NEWEST_FIRST","","Newest first.",1,null],[13,"MESSAGE_ID","","Sort by message-id.",1,null],[13,"UNSORTED","","Do not sort.",1,null],[4,"notmuch_exclude_t","","Exclude values for `notmuch_query_set_omit_excluded`",null,null],[13,"FLAG","","",2,null],[13,"TRUE","","",2,null],[13,"FALSE","","",2,null],[13,"ALL","","",2,null],[4,"notmuch_message_flag_t","","Message flags.",null,null],[13,"MATCH","","",3,null],[13,"EXCLUDED","","",3,null],[13,"GHOST","","This message is a "ghost message", meaning it has no filenames\nor content, but we know it exists because it was referenced by\nsome other message.  A ghost message has only a message ID and\nthread ID.",3,null],[4,"notmuch_database_mode_t","","Database open mode for `notmuch_database_open`.",null,null],[13,"READ_ONLY","","Open database for reading only.",4,null],[13,"READ_WRITE","","Open database for reading and writing.",4,null],[4,"notmuch_database_t","","",null,null],[4,"notmuch_query_t","","",null,null],[4,"notmuch_threads_t","","",null,null],[4,"notmuch_thread_t","","",null,null],[4,"notmuch_messages_t","","",null,null],[4,"notmuch_message_t","","",null,null],[4,"notmuch_tags_t","","",null,null],[4,"notmuch_directory_t","","",null,null],[4,"notmuch_filenames_t","","",null,null],[5,"notmuch_database_open","","Open an existing notmuch database located at 'path'.",null,null],[5,"notmuch_database_open_verbose","","Like notmuch_database_open, except optionally return an error\nmessage. This message is allocated by malloc and should be freed by\nthe caller.",null,null],[5,"notmuch_status_to_string","","Get a string representation of a `notmuch_status_t` value.",null,null],[5,"notmuch_database_create","","Create a new, empty notmuch database located at 'path'.",null,null],[5,"notmuch_database_create_verbose","","Like `notmuch_database_create`, except optionally return an error\nmessage. This message is allocated by malloc and should be freed by\nthe caller.",null,null],[5,"notmuch_database_status_string","","Retrieve last status string for given database.",null,null],[5,"notmuch_database_close","","Commit changes and close the given notmuch database.",null,null],[5,"notmuch_database_compact","","Compact a notmuch database, backing up the original database to the\ngiven path.",null,null],[5,"notmuch_database_destroy","","Destroy the notmuch database, closing it if necessary and freeing\nall associated resources.",null,null],[5,"notmuch_database_get_path","","Return the database path of the given database.",null,null],[5,"notmuch_database_get_version","","Return the database format version of the given database.",null,null],[5,"notmuch_database_needs_upgrade","","Can the database be upgraded to a newer database version?",null,null],[5,"notmuch_database_upgrade","","Upgrade the current database to the latest supported version.",null,null],[5,"notmuch_database_begin_atomic","","Begin an atomic database operation.",null,null],[5,"notmuch_database_end_atomic","","Indicate the end of an atomic database operation.",null,null],[5,"notmuch_database_get_revision","","Return the committed database revision and UUID.",null,null],[5,"notmuch_database_get_directory","","Retrieve a directory object from the database for 'path'.",null,null],[5,"notmuch_database_add_message","","Add a new message to the given notmuch database or associate an\nadditional filename with an existing message.",null,null],[5,"notmuch_database_remove_message","","Remove a message filename from the given notmuch database. If the\nmessage has no more filenames, remove the message.",null,null],[5,"notmuch_database_find_message","","Find a message with the given message_id.",null,null],[5,"notmuch_database_find_message_by_filename","","Find a message with the given filename.",null,null],[5,"notmuch_database_get_all_tags","","Return a list of all tags found in the database.",null,null],[5,"notmuch_query_create","","Create a new query for 'database'.",null,null],[5,"notmuch_query_get_query_string","","Return the query_string of this query. See `notmuch_query_create`.",null,null],[5,"notmuch_query_get_database","","Return the notmuch database of this query. See `notmuch_query_create`.",null,null],[5,"notmuch_query_set_omit_excluded","","Specify whether to omit excluded results or simply flag them.  By\ndefault, this is set to TRUE.",null,null],[5,"notmuch_query_set_sort","","Specify the sorting desired for this query.",null,null],[5,"notmuch_query_get_sort","","Return the sort specified for this query. See\n`notmuch_query_set_sort`.",null,null],[5,"notmuch_query_add_tag_exclude","","Add a tag that will be excluded from the query results by default.\nThis exclusion will be overridden if this tag appears explicitly in\nthe query.",null,null],[5,"notmuch_query_search_threads_st","","Execute a query for threads, returning a `notmuch_threads_t` object\nwhich can be used to iterate over the results. The returned threads\nobject is owned by the query and as such, will only be valid until\n`notmuch_query_destroy`.",null,null],[5,"notmuch_query_search_messages_st","","Execute a query for messages, returning a `notmuch_messages_t` object\nwhich can be used to iterate over the results. The returned\nmessages object is owned by the query and as such, will only be\nvalid until `notmuch_query_destroy`.",null,null],[5,"notmuch_query_destroy","","Destroy a `notmuch_query_t` along with any associated resources.",null,null],[5,"notmuch_threads_valid","","Is the given 'threads' iterator pointing at a valid thread.",null,null],[5,"notmuch_threads_get","","Get the current thread from 'threads' as a `notmuch_thread_t`.",null,null],[5,"notmuch_threads_move_to_next","","Move the 'threads' iterator to the next thread.",null,null],[5,"notmuch_threads_destroy","","Destroy a `notmuch_threads_t` object.",null,null],[5,"notmuch_query_count_messages_st","","Return the number of messages matching a search.",null,null],[5,"notmuch_query_count_threads_st","","Return the number of threads matching a search.",null,null],[5,"notmuch_thread_get_thread_id","","Get the thread ID of 'thread'.",null,null],[5,"notmuch_thread_get_total_messages","","Get the total number of messages in 'thread'.",null,null],[5,"notmuch_thread_get_toplevel_messages","","Get a `notmuch_messages_t` iterator for the top-level messages in\n'thread' in oldest-first order.",null,null],[5,"notmuch_thread_get_messages","","Get a `notmuch_thread_t` iterator for all messages in 'thread' in\noldest-first order.",null,null],[5,"notmuch_thread_get_matched_messages","","Get the number of messages in 'thread' that matched the search.",null,null],[5,"notmuch_thread_get_authors","","Get the authors of 'thread' as a UTF-8 string.",null,null],[5,"notmuch_thread_get_subject","","Get the subject of 'thread' as a UTF-8 string.",null,null],[5,"notmuch_thread_get_oldest_date","","Get the date of the oldest message in 'thread' as a time_t value.",null,null],[5,"notmuch_thread_get_newest_date","","Get the date of the newest message in 'thread' as a time_t value.",null,null],[5,"notmuch_thread_get_tags","","Get the tags for 'thread', returning a `notmuch_tags_t` object which\ncan be used to iterate over all tags.",null,null],[5,"notmuch_thread_destroy","","Destroy a `notmuch_thread_t` object.",null,null],[5,"notmuch_messages_valid","","Is the given 'messages' iterator pointing at a valid message.",null,null],[5,"notmuch_messages_get","","Get the current message from 'messages' as a `notmuch_message_t`.",null,null],[5,"notmuch_messages_move_to_next","","Move the 'messages' iterator to the next message.",null,null],[5,"notmuch_messages_destroy","","Destroy a `notmuch_messages_t` object.",null,null],[5,"notmuch_messages_collect_tags","","Return a list of tags from all messages.",null,null],[5,"notmuch_message_get_message_id","","Get the message ID of 'message'.",null,null],[5,"notmuch_message_get_thread_id","","Get the thread ID of 'message'.",null,null],[5,"notmuch_message_get_replies","","Get a `notmuch_messages_t` iterator for all of the replies to\n'message'.",null,null],[5,"notmuch_message_get_filename","","Get a filename for the email corresponding to 'message'.",null,null],[5,"notmuch_message_get_filenames","","Get all filenames for the email corresponding to 'message'.",null,null],[5,"notmuch_message_get_flag","","Get a value of a flag for the email corresponding to 'message'.",null,null],[5,"notmuch_message_set_flag","","Set a value of a flag for the email corresponding to 'message'.",null,null],[5,"notmuch_message_get_date","","Get the date of 'message' as a time_t value.",null,null],[5,"notmuch_message_get_header","","Get the value of the specified header from 'message' as a UTF-8 string.",null,null],[5,"notmuch_message_get_tags","","Get the tags for 'message', returning a `notmuch_tags_t` object which\ncan be used to iterate over all tags.",null,null],[5,"notmuch_message_add_tag","","Add a tag to the given message.",null,null],[5,"notmuch_message_remove_tag","","Remove a tag from the given message.",null,null],[5,"notmuch_message_remove_all_tags","","Remove all tags from the given message.",null,null],[5,"notmuch_message_maildir_flags_to_tags","","Add/remove tags according to maildir flags in the message filename(s).",null,null],[5,"notmuch_message_tags_to_maildir_flags","","Rename message filename(s) to encode tags as maildir flags.",null,null],[5,"notmuch_message_freeze","","Freeze the current state of 'message' within the database.",null,null],[5,"notmuch_message_thaw","","Thaw the current 'message', synchronizing any changes that may have\noccurred while 'message' was frozen into the notmuch database.",null,null],[5,"notmuch_message_destroy","","Destroy a `notmuch_message_t` object.",null,null],[5,"notmuch_tags_valid","","Is the given 'tags' iterator pointing at a valid tag.",null,null],[5,"notmuch_tags_get","","Get the current tag from 'tags' as a string.",null,null],[5,"notmuch_tags_move_to_next","","Move the 'tags' iterator to the next tag.",null,null],[5,"notmuch_tags_destroy","","Destroy a `notmuch_tags_t` object.",null,null],[5,"notmuch_directory_set_mtime","","Store an mtime within the database for 'directory'.",null,null],[5,"notmuch_directory_get_mtime","","Get the mtime of a directory, (as previously stored with\n`notmuch_directory_set_mtime`).",null,null],[5,"notmuch_directory_get_child_files","","Get a `notmuch_filenames_t` iterator listing all the filenames of\nmessages in the database within the given directory.",null,null],[5,"notmuch_directory_get_child_directories","","Get a `notmuch_filenames_t` iterator listing all the filenames of\nsub-directories in the database within the given directory.",null,null],[5,"notmuch_directory_delete","","Delete directory document from the database, and destroy the\n`notmuch_directory_t` object. Assumes any child directories and files\nhave been deleted by the caller.",null,null],[5,"notmuch_directory_destroy","","Destroy a `notmuch_directory_t` object.",null,null],[5,"notmuch_filenames_valid","","Is the given 'filenames' iterator pointing at a valid filename.",null,null],[5,"notmuch_filenames_get","","Get the current filename from 'filenames' as a string.",null,null],[5,"notmuch_filenames_move_to_next","","Move the 'filenames' iterator to the next filename.",null,null],[5,"notmuch_filenames_destroy","","Destroy a `notmuch_filenames_t` object.",null,null],[6,"notmuch_bool_t","","",null,null],[17,"TAG_MAX","","The longest possible tag value.",null,null],[11,"eq","","",0,null],[11,"fmt","","",0,null],[11,"eq","","",1,null],[11,"fmt","","",1,null],[11,"eq","","",2,null],[11,"fmt","","",2,null],[11,"eq","","",3,null],[11,"fmt","","",3,null],[11,"eq","","",4,null],[11,"fmt","","",4,null]],"paths":[[4,"notmuch_status_t"],[4,"notmuch_sort_t"],[4,"notmuch_exclude_t"],[4,"notmuch_message_flag_t"],[4,"notmuch_database_mode_t"]]};
initSearch(searchIndex);