1 /* notmuch - Not much of an email library, (just index and search)
3 * Copyright © 2009 Carl Worth
5 * This program is free software: you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation, either version 3 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program. If not, see https://www.gnu.org/licenses/ .
18 * Author: Carl Worth <cworth@cworth.org>
22 * @defgroup notmuch The notmuch API
24 * Not much of an email library, (just index and search)
35 # define NOTMUCH_BEGIN_DECLS extern "C" {
36 # define NOTMUCH_END_DECLS }
38 # define NOTMUCH_BEGIN_DECLS
39 # define NOTMUCH_END_DECLS
46 #pragma GCC visibility push(default)
57 * The library version number. This must agree with the soname
58 * version in Makefile.local.
60 #define LIBNOTMUCH_MAJOR_VERSION 5
61 #define LIBNOTMUCH_MINOR_VERSION 0
62 #define LIBNOTMUCH_MICRO_VERSION 0
65 #if defined (__clang_major__) && __clang_major__ >= 3 \
66 || defined (__GNUC__) && __GNUC__ >= 5 \
67 || defined (__GNUC__) && __GNUC__ == 4 && __GNUC_MINOR__ >= 5
68 #define NOTMUCH_DEPRECATED(major,minor) \
69 __attribute__ ((deprecated ("function deprecated as of libnotmuch " #major "." #minor)))
71 #define NOTMUCH_DEPRECATED(major,minor) __attribute__ ((deprecated))
75 #endif /* __DOXYGEN__ */
78 * Check the version of the notmuch library being compiled against.
80 * Return true if the library being compiled against is of the
81 * specified version or above. For example:
84 * #if LIBNOTMUCH_CHECK_VERSION(3, 1, 0)
85 * (code requiring libnotmuch 3.1.0 or above)
89 * LIBNOTMUCH_CHECK_VERSION has been defined since version 3.1.0; to
90 * check for versions prior to that, use:
93 * #if !defined(NOTMUCH_CHECK_VERSION)
94 * (code requiring libnotmuch prior to 3.1.0)
98 #define LIBNOTMUCH_CHECK_VERSION(major, minor, micro) \
99 (LIBNOTMUCH_MAJOR_VERSION > (major) || \
100 (LIBNOTMUCH_MAJOR_VERSION == (major) && LIBNOTMUCH_MINOR_VERSION > (minor)) || \
101 (LIBNOTMUCH_MAJOR_VERSION == (major) && LIBNOTMUCH_MINOR_VERSION == (minor) && \
102 LIBNOTMUCH_MICRO_VERSION >= (micro)))
105 * Notmuch boolean type.
107 typedef int notmuch_bool_t;
110 * Status codes used for the return values of most functions.
112 * A zero value (NOTMUCH_STATUS_SUCCESS) indicates that the function
113 * completed without error. Any other value indicates an error.
115 typedef enum _notmuch_status {
119 NOTMUCH_STATUS_SUCCESS = 0,
123 NOTMUCH_STATUS_OUT_OF_MEMORY,
125 * An attempt was made to write to a database opened in read-only
128 NOTMUCH_STATUS_READ_ONLY_DATABASE,
130 * A Xapian exception occurred.
132 * @todo We don't really want to expose this lame XAPIAN_EXCEPTION
133 * value. Instead we should map to things like DATABASE_LOCKED or
136 NOTMUCH_STATUS_XAPIAN_EXCEPTION,
138 * An error occurred trying to read or write to a file (this could
139 * be file not found, permission denied, etc.)
141 NOTMUCH_STATUS_FILE_ERROR,
143 * A file was presented that doesn't appear to be an email
146 NOTMUCH_STATUS_FILE_NOT_EMAIL,
148 * A file contains a message ID that is identical to a message
149 * already in the database.
151 NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID,
153 * The user erroneously passed a NULL pointer to a notmuch
156 NOTMUCH_STATUS_NULL_POINTER,
158 * A tag value is too long (exceeds NOTMUCH_TAG_MAX).
160 NOTMUCH_STATUS_TAG_TOO_LONG,
162 * The notmuch_message_thaw function has been called more times
163 * than notmuch_message_freeze.
165 NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW,
167 * notmuch_database_end_atomic has been called more times than
168 * notmuch_database_begin_atomic.
170 NOTMUCH_STATUS_UNBALANCED_ATOMIC,
172 * The operation is not supported.
174 NOTMUCH_STATUS_UNSUPPORTED_OPERATION,
176 * The operation requires a database upgrade.
178 NOTMUCH_STATUS_UPGRADE_REQUIRED,
180 * There is a problem with the proposed path, e.g. a relative path
181 * passed to a function expecting an absolute path.
183 NOTMUCH_STATUS_PATH_ERROR,
185 * The requested operation was ignored. Depending on the function,
186 * this may not be an actual error.
188 NOTMUCH_STATUS_IGNORED,
190 * One of the arguments violates the preconditions for the
191 * function, in a way not covered by a more specific argument.
193 NOTMUCH_STATUS_ILLEGAL_ARGUMENT,
195 * Not an actual status value. Just a way to find out how many
196 * valid status values there are.
198 NOTMUCH_STATUS_LAST_STATUS
202 * Get a string representation of a notmuch_status_t value.
204 * The result is read-only.
207 notmuch_status_to_string (notmuch_status_t status);
209 /* Various opaque data types. For each notmuch_<foo>_t see the various
210 * notmuch_<foo> functions below. */
212 typedef struct _notmuch_database notmuch_database_t;
213 typedef struct _notmuch_query notmuch_query_t;
214 typedef struct _notmuch_threads notmuch_threads_t;
215 typedef struct _notmuch_thread notmuch_thread_t;
216 typedef struct _notmuch_messages notmuch_messages_t;
217 typedef struct _notmuch_message notmuch_message_t;
218 typedef struct _notmuch_tags notmuch_tags_t;
219 typedef struct _notmuch_directory notmuch_directory_t;
220 typedef struct _notmuch_filenames notmuch_filenames_t;
221 typedef struct _notmuch_config_list notmuch_config_list_t;
222 typedef struct _notmuch_indexopts notmuch_indexopts_t;
223 #endif /* __DOXYGEN__ */
226 * Create a new, empty notmuch database located at 'path'.
228 * The path should be a top-level directory to a collection of
229 * plain-text email messages (one message per file). This call will
230 * create a new ".notmuch" directory within 'path' where notmuch will
233 * After a successful call to notmuch_database_create, the returned
234 * database will be open so the caller should call
235 * notmuch_database_destroy when finished with it.
237 * The database will not yet have any data in it
238 * (notmuch_database_create itself is a very cheap function). Messages
239 * contained within 'path' can be added to the database by calling
240 * notmuch_database_index_file.
242 * In case of any failure, this function returns an error status and
243 * sets *database to NULL (after printing an error message on stderr).
247 * NOTMUCH_STATUS_SUCCESS: Successfully created the database.
249 * NOTMUCH_STATUS_NULL_POINTER: The given 'path' argument is NULL.
251 * NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory.
253 * NOTMUCH_STATUS_FILE_ERROR: An error occurred trying to create the
254 * database file (such as permission denied, or file not found,
255 * etc.), or the database already exists.
257 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred.
260 notmuch_database_create (const char *path, notmuch_database_t **database);
263 * Like notmuch_database_create, except optionally return an error
264 * message. This message is allocated by malloc and should be freed by
268 notmuch_database_create_verbose (const char *path,
269 notmuch_database_t **database,
270 char **error_message);
273 * Database open mode for notmuch_database_open.
277 * Open database for reading only.
279 NOTMUCH_DATABASE_MODE_READ_ONLY = 0,
281 * Open database for reading and writing.
283 NOTMUCH_DATABASE_MODE_READ_WRITE
284 } notmuch_database_mode_t;
287 * Open an existing notmuch database located at 'path'.
289 * The database should have been created at some time in the past,
290 * (not necessarily by this process), by calling
291 * notmuch_database_create with 'path'. By default the database should be
292 * opened for reading only. In order to write to the database you need to
293 * pass the NOTMUCH_DATABASE_MODE_READ_WRITE mode.
295 * An existing notmuch database can be identified by the presence of a
296 * directory named ".notmuch" below 'path'.
298 * The caller should call notmuch_database_destroy when finished with
301 * In case of any failure, this function returns an error status and
302 * sets *database to NULL (after printing an error message on stderr).
306 * NOTMUCH_STATUS_SUCCESS: Successfully opened the database.
308 * NOTMUCH_STATUS_NULL_POINTER: The given 'path' argument is NULL.
310 * NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory.
312 * NOTMUCH_STATUS_FILE_ERROR: An error occurred trying to open the
313 * database file (such as permission denied, or file not found,
314 * etc.), or the database version is unknown.
316 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred.
319 notmuch_database_open (const char *path,
320 notmuch_database_mode_t mode,
321 notmuch_database_t **database);
323 * Like notmuch_database_open, except optionally return an error
324 * message. This message is allocated by malloc and should be freed by
329 notmuch_database_open_verbose (const char *path,
330 notmuch_database_mode_t mode,
331 notmuch_database_t **database,
332 char **error_message);
335 * Retrieve last status string for given database.
339 notmuch_database_status_string (const notmuch_database_t *notmuch);
342 * Commit changes and close the given notmuch database.
344 * After notmuch_database_close has been called, calls to other
345 * functions on objects derived from this database may either behave
346 * as if the database had not been closed (e.g., if the required data
347 * has been cached) or may fail with a
348 * NOTMUCH_STATUS_XAPIAN_EXCEPTION. The only further operation
349 * permitted on the database itself is to call
350 * notmuch_database_destroy.
352 * notmuch_database_close can be called multiple times. Later calls
355 * For writable databases, notmuch_database_close commits all changes
356 * to disk before closing the database. If the caller is currently in
357 * an atomic section (there was a notmuch_database_begin_atomic
358 * without a matching notmuch_database_end_atomic), this will discard
359 * changes made in that atomic section (but still commit changes made
360 * prior to entering the atomic section).
364 * NOTMUCH_STATUS_SUCCESS: Successfully closed the database.
366 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred; the
367 * database has been closed but there are no guarantees the
368 * changes to the database, if any, have been flushed to disk.
371 notmuch_database_close (notmuch_database_t *database);
374 * A callback invoked by notmuch_database_compact to notify the user
375 * of the progress of the compaction process.
377 typedef void (*notmuch_compact_status_cb_t)(const char *message, void *closure);
380 * Compact a notmuch database, backing up the original database to the
383 * The database will be opened with NOTMUCH_DATABASE_MODE_READ_WRITE
384 * during the compaction process to ensure no writes are made.
386 * If the optional callback function 'status_cb' is non-NULL, it will
387 * be called with diagnostic and informational messages. The argument
388 * 'closure' is passed verbatim to any callback invoked.
391 notmuch_database_compact (const char* path,
392 const char* backup_path,
393 notmuch_compact_status_cb_t status_cb,
397 * Destroy the notmuch database, closing it if necessary and freeing
398 * all associated resources.
400 * Return value as in notmuch_database_close if the database was open;
401 * notmuch_database_destroy itself has no failure modes.
404 notmuch_database_destroy (notmuch_database_t *database);
407 * Return the database path of the given database.
409 * The return value is a string owned by notmuch so should not be
410 * modified nor freed by the caller.
413 notmuch_database_get_path (notmuch_database_t *database);
416 * Return the database format version of the given database.
419 notmuch_database_get_version (notmuch_database_t *database);
422 * Can the database be upgraded to a newer database version?
424 * If this function returns TRUE, then the caller may call
425 * notmuch_database_upgrade to upgrade the database. If the caller
426 * does not upgrade an out-of-date database, then some functions may
427 * fail with NOTMUCH_STATUS_UPGRADE_REQUIRED. This always returns
428 * FALSE for a read-only database because there's no way to upgrade a
429 * read-only database.
432 notmuch_database_needs_upgrade (notmuch_database_t *database);
435 * Upgrade the current database to the latest supported version.
437 * This ensures that all current notmuch functionality will be
438 * available on the database. After opening a database in read-write
439 * mode, it is recommended that clients check if an upgrade is needed
440 * (notmuch_database_needs_upgrade) and if so, upgrade with this
441 * function before making any modifications. If
442 * notmuch_database_needs_upgrade returns FALSE, this will be a no-op.
444 * The optional progress_notify callback can be used by the caller to
445 * provide progress indication to the user. If non-NULL it will be
446 * called periodically with 'progress' as a floating-point value in
447 * the range of [0.0 .. 1.0] indicating the progress made so far in
448 * the upgrade process. The argument 'closure' is passed verbatim to
449 * any callback invoked.
452 notmuch_database_upgrade (notmuch_database_t *database,
453 void (*progress_notify) (void *closure,
458 * Begin an atomic database operation.
460 * Any modifications performed between a successful begin and a
461 * notmuch_database_end_atomic will be applied to the database
462 * atomically. Note that, unlike a typical database transaction, this
463 * only ensures atomicity, not durability; neither begin nor end
464 * necessarily flush modifications to disk.
466 * Atomic sections may be nested. begin_atomic and end_atomic must
467 * always be called in pairs.
471 * NOTMUCH_STATUS_SUCCESS: Successfully entered atomic section.
473 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred;
474 * atomic section not entered.
477 notmuch_database_begin_atomic (notmuch_database_t *notmuch);
480 * Indicate the end of an atomic database operation.
484 * NOTMUCH_STATUS_SUCCESS: Successfully completed atomic section.
486 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred;
487 * atomic section not ended.
489 * NOTMUCH_STATUS_UNBALANCED_ATOMIC: The database is not currently in
493 notmuch_database_end_atomic (notmuch_database_t *notmuch);
496 * Return the committed database revision and UUID.
498 * The database revision number increases monotonically with each
499 * commit to the database. Hence, all messages and message changes
500 * committed to the database (that is, visible to readers) have a last
501 * modification revision <= the committed database revision. Any
502 * messages committed in the future will be assigned a modification
503 * revision > the committed database revision.
505 * The UUID is a NUL-terminated opaque string that uniquely identifies
506 * this database. Two revision numbers are only comparable if they
507 * have the same database UUID.
510 notmuch_database_get_revision (notmuch_database_t *notmuch,
514 * Retrieve a directory object from the database for 'path'.
516 * Here, 'path' should be a path relative to the path of 'database'
517 * (see notmuch_database_get_path), or else should be an absolute path
518 * with initial components that match the path of 'database'.
520 * If this directory object does not exist in the database, this
521 * returns NOTMUCH_STATUS_SUCCESS and sets *directory to NULL.
523 * Otherwise the returned directory object is owned by the database
524 * and as such, will only be valid until notmuch_database_destroy is
529 * NOTMUCH_STATUS_SUCCESS: Successfully retrieved directory.
531 * NOTMUCH_STATUS_NULL_POINTER: The given 'directory' argument is NULL.
533 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred;
534 * directory not retrieved.
536 * NOTMUCH_STATUS_UPGRADE_REQUIRED: The caller must upgrade the
537 * database to use this function.
540 notmuch_database_get_directory (notmuch_database_t *database,
542 notmuch_directory_t **directory);
545 * Add a message file to a database, indexing it for retrieval by
546 * future searches. If a message already exists with the same message
547 * ID as the specified file, their indexes will be merged, and this
548 * new filename will also be associated with the existing message.
550 * Here, 'filename' should be a path relative to the path of
551 * 'database' (see notmuch_database_get_path), or else should be an
552 * absolute filename with initial components that match the path of
555 * The file should be a single mail message (not a multi-message mbox)
556 * that is expected to remain at its current location, (since the
557 * notmuch database will reference the filename, and will not copy the
558 * entire contents of the file.
560 * If another message with the same message ID already exists in the
561 * database, rather than creating a new message, this adds the search
562 * terms from the identified file to the existing message's index, and
563 * adds 'filename' to the list of filenames known for the message.
565 * 'indexopts' can be NULL (meaning, use the indexing defaults from
566 * the database), or can be an explicit choice of indexing options
567 * that should govern the indexing of this specific 'filename'.
569 * If 'message' is not NULL, then, on successful return
570 * (NOTMUCH_STATUS_SUCCESS or NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID) '*message'
571 * will be initialized to a message object that can be used for things
572 * such as adding tags to the just-added message. The user should call
573 * notmuch_message_destroy when done with the message. On any failure
574 * '*message' will be set to NULL.
578 * NOTMUCH_STATUS_SUCCESS: Message successfully added to database.
580 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred,
583 * NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID: Message has the same message
584 * ID as another message already in the database. The new
585 * filename was successfully added to the message in the database
586 * (if not already present) and the existing message is returned.
588 * NOTMUCH_STATUS_FILE_ERROR: an error occurred trying to open the
589 * file, (such as permission denied, or file not found,
590 * etc.). Nothing added to the database.
592 * NOTMUCH_STATUS_FILE_NOT_EMAIL: the contents of filename don't look
593 * like an email message. Nothing added to the database.
595 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
596 * mode so no message can be added.
598 * NOTMUCH_STATUS_UPGRADE_REQUIRED: The caller must upgrade the
599 * database to use this function.
601 * @since libnotmuch 5.1 (notmuch 0.26)
604 notmuch_database_index_file (notmuch_database_t *database,
605 const char *filename,
606 notmuch_indexopts_t *indexopts,
607 notmuch_message_t **message);
610 * Deprecated alias for notmuch_database_index_file called with
613 * @deprecated Deprecated as of libnotmuch 5.1 (notmuch 0.26). Please
614 * use notmuch_database_index_file instead.
617 NOTMUCH_DEPRECATED(5,1)
619 notmuch_database_add_message (notmuch_database_t *database,
620 const char *filename,
621 notmuch_message_t **message);
624 * Remove a message filename from the given notmuch database. If the
625 * message has no more filenames, remove the message.
627 * If the same message (as determined by the message ID) is still
628 * available via other filenames, then the message will persist in the
629 * database for those filenames. When the last filename is removed for
630 * a particular message, the database content for that message will be
635 * NOTMUCH_STATUS_SUCCESS: The last filename was removed and the
636 * message was removed from the database.
638 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred,
639 * message not removed.
641 * NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID: This filename was removed but
642 * the message persists in the database with at least one other
645 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
646 * mode so no message can be removed.
648 * NOTMUCH_STATUS_UPGRADE_REQUIRED: The caller must upgrade the
649 * database to use this function.
652 notmuch_database_remove_message (notmuch_database_t *database,
653 const char *filename);
656 * Find a message with the given message_id.
658 * If a message with the given message_id is found then, on successful return
659 * (NOTMUCH_STATUS_SUCCESS) '*message' will be initialized to a message
660 * object. The caller should call notmuch_message_destroy when done with the
663 * On any failure or when the message is not found, this function initializes
664 * '*message' to NULL. This means, when NOTMUCH_STATUS_SUCCESS is returned, the
665 * caller is supposed to check '*message' for NULL to find out whether the
666 * message with the given message_id was found.
670 * NOTMUCH_STATUS_SUCCESS: Successful return, check '*message'.
672 * NOTMUCH_STATUS_NULL_POINTER: The given 'message' argument is NULL
674 * NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory, creating message object
676 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred
679 notmuch_database_find_message (notmuch_database_t *database,
680 const char *message_id,
681 notmuch_message_t **message);
684 * Find a message with the given filename.
686 * If the database contains a message with the given filename then, on
687 * successful return (NOTMUCH_STATUS_SUCCESS) '*message' will be initialized to
688 * a message object. The caller should call notmuch_message_destroy when done
691 * On any failure or when the message is not found, this function initializes
692 * '*message' to NULL. This means, when NOTMUCH_STATUS_SUCCESS is returned, the
693 * caller is supposed to check '*message' for NULL to find out whether the
694 * message with the given filename is found.
698 * NOTMUCH_STATUS_SUCCESS: Successful return, check '*message'
700 * NOTMUCH_STATUS_NULL_POINTER: The given 'message' argument is NULL
702 * NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory, creating the message object
704 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred
706 * NOTMUCH_STATUS_UPGRADE_REQUIRED: The caller must upgrade the
707 * database to use this function.
710 notmuch_database_find_message_by_filename (notmuch_database_t *notmuch,
711 const char *filename,
712 notmuch_message_t **message);
715 * Return a list of all tags found in the database.
717 * This function creates a list of all tags found in the database. The
718 * resulting list contains all tags from all messages found in the database.
720 * On error this function returns NULL.
723 notmuch_database_get_all_tags (notmuch_database_t *db);
726 * Create a new query for 'database'.
728 * Here, 'database' should be an open database, (see
729 * notmuch_database_open and notmuch_database_create).
731 * For the query string, we'll document the syntax here more
732 * completely in the future, but it's likely to be a specialized
733 * version of the general Xapian query syntax:
735 * https://xapian.org/docs/queryparser.html
737 * As a special case, passing either a length-zero string, (that is ""),
738 * or a string consisting of a single asterisk (that is "*"), will
739 * result in a query that returns all messages in the database.
741 * See notmuch_query_set_sort for controlling the order of results.
742 * See notmuch_query_search_messages and notmuch_query_search_threads
743 * to actually execute the query.
745 * User should call notmuch_query_destroy when finished with this
748 * Will return NULL if insufficient memory is available.
751 notmuch_query_create (notmuch_database_t *database,
752 const char *query_string);
755 * Sort values for notmuch_query_set_sort.
761 NOTMUCH_SORT_OLDEST_FIRST,
765 NOTMUCH_SORT_NEWEST_FIRST,
767 * Sort by message-id.
769 NOTMUCH_SORT_MESSAGE_ID,
773 NOTMUCH_SORT_UNSORTED
777 * Return the query_string of this query. See notmuch_query_create.
780 notmuch_query_get_query_string (const notmuch_query_t *query);
783 * Return the notmuch database of this query. See notmuch_query_create.
786 notmuch_query_get_database (const notmuch_query_t *query);
789 * Exclude values for notmuch_query_set_omit_excluded. The strange
790 * order is to maintain backward compatibility: the old FALSE/TRUE
791 * options correspond to the new
792 * NOTMUCH_EXCLUDE_FLAG/NOTMUCH_EXCLUDE_TRUE options.
795 NOTMUCH_EXCLUDE_FLAG,
796 NOTMUCH_EXCLUDE_TRUE,
797 NOTMUCH_EXCLUDE_FALSE,
802 * Specify whether to omit excluded results or simply flag them. By
803 * default, this is set to TRUE.
805 * If set to TRUE or ALL, notmuch_query_search_messages will omit excluded
806 * messages from the results, and notmuch_query_search_threads will omit
807 * threads that match only in excluded messages. If set to TRUE,
808 * notmuch_query_search_threads will include all messages in threads that
809 * match in at least one non-excluded message. Otherwise, if set to ALL,
810 * notmuch_query_search_threads will omit excluded messages from all threads.
812 * If set to FALSE or FLAG then both notmuch_query_search_messages and
813 * notmuch_query_search_threads will return all matching
814 * messages/threads regardless of exclude status. If set to FLAG then
815 * the exclude flag will be set for any excluded message that is
816 * returned by notmuch_query_search_messages, and the thread counts
817 * for threads returned by notmuch_query_search_threads will be the
818 * number of non-excluded messages/matches. Otherwise, if set to
819 * FALSE, then the exclude status is completely ignored.
821 * The performance difference when calling
822 * notmuch_query_search_messages should be relatively small (and both
823 * should be very fast). However, in some cases,
824 * notmuch_query_search_threads is very much faster when omitting
825 * excluded messages as it does not need to construct the threads that
826 * only match in excluded messages.
829 notmuch_query_set_omit_excluded (notmuch_query_t *query,
830 notmuch_exclude_t omit_excluded);
833 * Specify the sorting desired for this query.
836 notmuch_query_set_sort (notmuch_query_t *query, notmuch_sort_t sort);
839 * Return the sort specified for this query. See
840 * notmuch_query_set_sort.
843 notmuch_query_get_sort (const notmuch_query_t *query);
846 * Add a tag that will be excluded from the query results by default.
847 * This exclusion will be ignored if this tag appears explicitly in
852 * NOTMUCH_STATUS_SUCCESS: excluded was added successfully.
854 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: a Xapian exception occured.
855 * Most likely a problem lazily parsing the query string.
857 * NOTMUCH_STATUS_IGNORED: tag is explicitly present in the query, so
861 notmuch_query_add_tag_exclude (notmuch_query_t *query, const char *tag);
864 * Execute a query for threads, returning a notmuch_threads_t object
865 * which can be used to iterate over the results. The returned threads
866 * object is owned by the query and as such, will only be valid until
867 * notmuch_query_destroy.
869 * Typical usage might be:
871 * notmuch_query_t *query;
872 * notmuch_threads_t *threads;
873 * notmuch_thread_t *thread;
875 * query = notmuch_query_create (database, query_string);
877 * for (threads = notmuch_query_search_threads (query);
878 * notmuch_threads_valid (threads);
879 * notmuch_threads_move_to_next (threads))
881 * thread = notmuch_threads_get (threads);
883 * notmuch_thread_destroy (thread);
886 * notmuch_query_destroy (query);
888 * Note: If you are finished with a thread before its containing
889 * query, you can call notmuch_thread_destroy to clean up some memory
890 * sooner (as in the above example). Otherwise, if your thread objects
891 * are long-lived, then you don't need to call notmuch_thread_destroy
892 * and all the memory will still be reclaimed when the query is
895 * Note that there's no explicit destructor needed for the
896 * notmuch_threads_t object. (For consistency, we do provide a
897 * notmuch_threads_destroy function, but there's no good reason
898 * to call it if the query is about to be destroyed).
900 * @since libnotmuch 5.0 (notmuch 0.25)
903 notmuch_query_search_threads (notmuch_query_t *query,
904 notmuch_threads_t **out);
907 * Deprecated alias for notmuch_query_search_threads.
909 * @deprecated Deprecated as of libnotmuch 5 (notmuch 0.25). Please
910 * use notmuch_query_search_threads instead.
913 NOTMUCH_DEPRECATED(5,0)
915 notmuch_query_search_threads_st (notmuch_query_t *query, notmuch_threads_t **out);
918 * Execute a query for messages, returning a notmuch_messages_t object
919 * which can be used to iterate over the results. The returned
920 * messages object is owned by the query and as such, will only be
921 * valid until notmuch_query_destroy.
923 * Typical usage might be:
925 * notmuch_query_t *query;
926 * notmuch_messages_t *messages;
927 * notmuch_message_t *message;
929 * query = notmuch_query_create (database, query_string);
931 * for (messages = notmuch_query_search_messages (query);
932 * notmuch_messages_valid (messages);
933 * notmuch_messages_move_to_next (messages))
935 * message = notmuch_messages_get (messages);
937 * notmuch_message_destroy (message);
940 * notmuch_query_destroy (query);
942 * Note: If you are finished with a message before its containing
943 * query, you can call notmuch_message_destroy to clean up some memory
944 * sooner (as in the above example). Otherwise, if your message
945 * objects are long-lived, then you don't need to call
946 * notmuch_message_destroy and all the memory will still be reclaimed
947 * when the query is destroyed.
949 * Note that there's no explicit destructor needed for the
950 * notmuch_messages_t object. (For consistency, we do provide a
951 * notmuch_messages_destroy function, but there's no good
952 * reason to call it if the query is about to be destroyed).
954 * If a Xapian exception occurs this function will return NULL.
956 * @since libnotmuch 5 (notmuch 0.25)
959 notmuch_query_search_messages (notmuch_query_t *query,
960 notmuch_messages_t **out);
962 * Deprecated alias for notmuch_query_search_messages
964 * @deprecated Deprecated as of libnotmuch 5 (notmuch 0.25). Please use
965 * notmuch_query_search_messages instead.
969 NOTMUCH_DEPRECATED(5,0)
971 notmuch_query_search_messages_st (notmuch_query_t *query,
972 notmuch_messages_t **out);
975 * Destroy a notmuch_query_t along with any associated resources.
977 * This will in turn destroy any notmuch_threads_t and
978 * notmuch_messages_t objects generated by this query, (and in
979 * turn any notmuch_thread_t and notmuch_message_t objects generated
980 * from those results, etc.), if such objects haven't already been
984 notmuch_query_destroy (notmuch_query_t *query);
987 * Is the given 'threads' iterator pointing at a valid thread.
989 * When this function returns TRUE, notmuch_threads_get will return a
990 * valid object. Whereas when this function returns FALSE,
991 * notmuch_threads_get will return NULL.
993 * If passed a NULL pointer, this function returns FALSE
995 * See the documentation of notmuch_query_search_threads for example
996 * code showing how to iterate over a notmuch_threads_t object.
999 notmuch_threads_valid (notmuch_threads_t *threads);
1002 * Get the current thread from 'threads' as a notmuch_thread_t.
1004 * Note: The returned thread belongs to 'threads' and has a lifetime
1005 * identical to it (and the query to which it belongs).
1007 * See the documentation of notmuch_query_search_threads for example
1008 * code showing how to iterate over a notmuch_threads_t object.
1010 * If an out-of-memory situation occurs, this function will return
1014 notmuch_threads_get (notmuch_threads_t *threads);
1017 * Move the 'threads' iterator to the next thread.
1019 * If 'threads' is already pointing at the last thread then the
1020 * iterator will be moved to a point just beyond that last thread,
1021 * (where notmuch_threads_valid will return FALSE and
1022 * notmuch_threads_get will return NULL).
1024 * See the documentation of notmuch_query_search_threads for example
1025 * code showing how to iterate over a notmuch_threads_t object.
1028 notmuch_threads_move_to_next (notmuch_threads_t *threads);
1031 * Destroy a notmuch_threads_t object.
1033 * It's not strictly necessary to call this function. All memory from
1034 * the notmuch_threads_t object will be reclaimed when the
1035 * containing query object is destroyed.
1038 notmuch_threads_destroy (notmuch_threads_t *threads);
1041 * Return the number of messages matching a search.
1043 * This function performs a search and returns the number of matching
1048 * NOTMUCH_STATUS_SUCCESS: query completed successfully.
1050 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: a Xapian exception occured. The
1051 * value of *count is not defined.
1053 * @since libnotmuch 5 (notmuch 0.25)
1056 notmuch_query_count_messages (notmuch_query_t *query, unsigned int *count);
1059 * Deprecated alias for notmuch_query_count_messages
1062 * @deprecated Deprecated since libnotmuch 5.0 (notmuch 0.25). Please
1063 * use notmuch_query_count_messages instead.
1065 NOTMUCH_DEPRECATED(5,0)
1067 notmuch_query_count_messages_st (notmuch_query_t *query, unsigned int *count);
1070 * Return the number of threads matching a search.
1072 * This function performs a search and returns the number of unique thread IDs
1073 * in the matching messages. This is the same as number of threads matching a
1076 * Note that this is a significantly heavier operation than
1077 * notmuch_query_count_messages{_st}().
1081 * NOTMUCH_STATUS_OUT_OF_MEMORY: Memory allocation failed. The value
1082 * of *count is not defined
1084 * NOTMUCH_STATUS_SUCCESS: query completed successfully.
1086 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: a Xapian exception occured. The
1087 * value of *count is not defined.
1089 * @since libnotmuch 5 (notmuch 0.25)
1092 notmuch_query_count_threads (notmuch_query_t *query, unsigned *count);
1095 * Deprecated alias for notmuch_query_count_threads
1097 * @deprecated Deprecated as of libnotmuch 5.0 (notmuch 0.25). Please
1098 * use notmuch_query_count_threads_st instead.
1100 NOTMUCH_DEPRECATED(5,0)
1102 notmuch_query_count_threads_st (notmuch_query_t *query, unsigned *count);
1105 * Get the thread ID of 'thread'.
1107 * The returned string belongs to 'thread' and as such, should not be
1108 * modified by the caller and will only be valid for as long as the
1109 * thread is valid, (which is until notmuch_thread_destroy or until
1110 * the query from which it derived is destroyed).
1113 notmuch_thread_get_thread_id (notmuch_thread_t *thread);
1116 * Get the total number of messages in 'thread'.
1118 * This count consists of all messages in the database belonging to
1119 * this thread. Contrast with notmuch_thread_get_matched_messages() .
1122 notmuch_thread_get_total_messages (notmuch_thread_t *thread);
1125 * Get the total number of files in 'thread'.
1127 * This sums notmuch_message_count_files over all messages in the
1129 * @returns Non-negative integer
1130 * @since libnotmuch 5.0 (notmuch 0.25)
1134 notmuch_thread_get_total_files (notmuch_thread_t *thread);
1137 * Get a notmuch_messages_t iterator for the top-level messages in
1138 * 'thread' in oldest-first order.
1140 * This iterator will not necessarily iterate over all of the messages
1141 * in the thread. It will only iterate over the messages in the thread
1142 * which are not replies to other messages in the thread.
1144 * The returned list will be destroyed when the thread is destroyed.
1146 notmuch_messages_t *
1147 notmuch_thread_get_toplevel_messages (notmuch_thread_t *thread);
1150 * Get a notmuch_thread_t iterator for all messages in 'thread' in
1151 * oldest-first order.
1153 * The returned list will be destroyed when the thread is destroyed.
1155 notmuch_messages_t *
1156 notmuch_thread_get_messages (notmuch_thread_t *thread);
1159 * Get the number of messages in 'thread' that matched the search.
1161 * This count includes only the messages in this thread that were
1162 * matched by the search from which the thread was created and were
1163 * not excluded by any exclude tags passed in with the query (see
1164 * notmuch_query_add_tag_exclude). Contrast with
1165 * notmuch_thread_get_total_messages() .
1168 notmuch_thread_get_matched_messages (notmuch_thread_t *thread);
1171 * Get the authors of 'thread' as a UTF-8 string.
1173 * The returned string is a comma-separated list of the names of the
1174 * authors of mail messages in the query results that belong to this
1177 * The string contains authors of messages matching the query first, then
1178 * non-matched authors (with the two groups separated by '|'). Within
1179 * each group, authors are ordered by date.
1181 * The returned string belongs to 'thread' and as such, should not be
1182 * modified by the caller and will only be valid for as long as the
1183 * thread is valid, (which is until notmuch_thread_destroy or until
1184 * the query from which it derived is destroyed).
1187 notmuch_thread_get_authors (notmuch_thread_t *thread);
1190 * Get the subject of 'thread' as a UTF-8 string.
1192 * The subject is taken from the first message (according to the query
1193 * order---see notmuch_query_set_sort) in the query results that
1194 * belongs to this thread.
1196 * The returned string belongs to 'thread' and as such, should not be
1197 * modified by the caller and will only be valid for as long as the
1198 * thread is valid, (which is until notmuch_thread_destroy or until
1199 * the query from which it derived is destroyed).
1202 notmuch_thread_get_subject (notmuch_thread_t *thread);
1205 * Get the date of the oldest message in 'thread' as a time_t value.
1208 notmuch_thread_get_oldest_date (notmuch_thread_t *thread);
1211 * Get the date of the newest message in 'thread' as a time_t value.
1214 notmuch_thread_get_newest_date (notmuch_thread_t *thread);
1217 * Get the tags for 'thread', returning a notmuch_tags_t object which
1218 * can be used to iterate over all tags.
1220 * Note: In the Notmuch database, tags are stored on individual
1221 * messages, not on threads. So the tags returned here will be all
1222 * tags of the messages which matched the search and which belong to
1225 * The tags object is owned by the thread and as such, will only be
1226 * valid for as long as the thread is valid, (for example, until
1227 * notmuch_thread_destroy or until the query from which it derived is
1230 * Typical usage might be:
1232 * notmuch_thread_t *thread;
1233 * notmuch_tags_t *tags;
1236 * thread = notmuch_threads_get (threads);
1238 * for (tags = notmuch_thread_get_tags (thread);
1239 * notmuch_tags_valid (tags);
1240 * notmuch_tags_move_to_next (tags))
1242 * tag = notmuch_tags_get (tags);
1246 * notmuch_thread_destroy (thread);
1248 * Note that there's no explicit destructor needed for the
1249 * notmuch_tags_t object. (For consistency, we do provide a
1250 * notmuch_tags_destroy function, but there's no good reason to call
1251 * it if the message is about to be destroyed).
1254 notmuch_thread_get_tags (notmuch_thread_t *thread);
1257 * Destroy a notmuch_thread_t object.
1260 notmuch_thread_destroy (notmuch_thread_t *thread);
1263 * Is the given 'messages' iterator pointing at a valid message.
1265 * When this function returns TRUE, notmuch_messages_get will return a
1266 * valid object. Whereas when this function returns FALSE,
1267 * notmuch_messages_get will return NULL.
1269 * See the documentation of notmuch_query_search_messages for example
1270 * code showing how to iterate over a notmuch_messages_t object.
1273 notmuch_messages_valid (notmuch_messages_t *messages);
1276 * Get the current message from 'messages' as a notmuch_message_t.
1278 * Note: The returned message belongs to 'messages' and has a lifetime
1279 * identical to it (and the query to which it belongs).
1281 * See the documentation of notmuch_query_search_messages for example
1282 * code showing how to iterate over a notmuch_messages_t object.
1284 * If an out-of-memory situation occurs, this function will return
1288 notmuch_messages_get (notmuch_messages_t *messages);
1291 * Move the 'messages' iterator to the next message.
1293 * If 'messages' is already pointing at the last message then the
1294 * iterator will be moved to a point just beyond that last message,
1295 * (where notmuch_messages_valid will return FALSE and
1296 * notmuch_messages_get will return NULL).
1298 * See the documentation of notmuch_query_search_messages for example
1299 * code showing how to iterate over a notmuch_messages_t object.
1302 notmuch_messages_move_to_next (notmuch_messages_t *messages);
1305 * Destroy a notmuch_messages_t object.
1307 * It's not strictly necessary to call this function. All memory from
1308 * the notmuch_messages_t object will be reclaimed when the containing
1309 * query object is destroyed.
1312 notmuch_messages_destroy (notmuch_messages_t *messages);
1315 * Return a list of tags from all messages.
1317 * The resulting list is guaranteed not to contain duplicated tags.
1319 * WARNING: You can no longer iterate over messages after calling this
1320 * function, because the iterator will point at the end of the list.
1321 * We do not have a function to reset the iterator yet and the only
1322 * way how you can iterate over the list again is to recreate the
1325 * The function returns NULL on error.
1328 notmuch_messages_collect_tags (notmuch_messages_t *messages);
1331 * Get the message ID of 'message'.
1333 * The returned string belongs to 'message' and as such, should not be
1334 * modified by the caller and will only be valid for as long as the
1335 * message is valid, (which is until the query from which it derived
1338 * This function will not return NULL since Notmuch ensures that every
1339 * message has a unique message ID, (Notmuch will generate an ID for a
1340 * message if the original file does not contain one).
1343 notmuch_message_get_message_id (notmuch_message_t *message);
1346 * Get the thread ID of 'message'.
1348 * The returned string belongs to 'message' and as such, should not be
1349 * modified by the caller and will only be valid for as long as the
1350 * message is valid, (for example, until the user calls
1351 * notmuch_message_destroy on 'message' or until a query from which it
1352 * derived is destroyed).
1354 * This function will not return NULL since Notmuch ensures that every
1355 * message belongs to a single thread.
1358 notmuch_message_get_thread_id (notmuch_message_t *message);
1361 * Get a notmuch_messages_t iterator for all of the replies to
1364 * Note: This call only makes sense if 'message' was ultimately
1365 * obtained from a notmuch_thread_t object, (such as by coming
1366 * directly from the result of calling notmuch_thread_get_
1367 * toplevel_messages or by any number of subsequent
1368 * calls to notmuch_message_get_replies).
1370 * If 'message' was obtained through some non-thread means, (such as
1371 * by a call to notmuch_query_search_messages), then this function
1374 * If there are no replies to 'message', this function will return
1375 * NULL. (Note that notmuch_messages_valid will accept that NULL
1376 * value as legitimate, and simply return FALSE for it.)
1378 notmuch_messages_t *
1379 notmuch_message_get_replies (notmuch_message_t *message);
1382 * Get the total number of files associated with a message.
1383 * @returns Non-negative integer
1384 * @since libnotmuch 5.0 (notmuch 0.25)
1387 notmuch_message_count_files (notmuch_message_t *message);
1390 * Get a filename for the email corresponding to 'message'.
1392 * The returned filename is an absolute filename, (the initial
1393 * component will match notmuch_database_get_path() ).
1395 * The returned string belongs to the message so should not be
1396 * modified or freed by the caller (nor should it be referenced after
1397 * the message is destroyed).
1399 * Note: If this message corresponds to multiple files in the mail
1400 * store, (that is, multiple files contain identical message IDs),
1401 * this function will arbitrarily return a single one of those
1402 * filenames. See notmuch_message_get_filenames for returning the
1403 * complete list of filenames.
1406 notmuch_message_get_filename (notmuch_message_t *message);
1409 * Get all filenames for the email corresponding to 'message'.
1411 * Returns a notmuch_filenames_t iterator listing all the filenames
1412 * associated with 'message'. These files may not have identical
1413 * content, but each will have the identical Message-ID.
1415 * Each filename in the iterator is an absolute filename, (the initial
1416 * component will match notmuch_database_get_path() ).
1418 notmuch_filenames_t *
1419 notmuch_message_get_filenames (notmuch_message_t *message);
1422 * Re-index the e-mail corresponding to 'message' using the supplied index options
1424 * Returns the status of the re-index operation. (see the return
1425 * codes documented in notmuch_database_index_file)
1427 * After reindexing, the user should discard the message object passed
1428 * in here by calling notmuch_message_destroy, since it refers to the
1429 * original message, not to the reindexed message.
1432 notmuch_message_reindex (notmuch_message_t *message,
1433 notmuch_indexopts_t *indexopts);
1438 typedef enum _notmuch_message_flag {
1439 NOTMUCH_MESSAGE_FLAG_MATCH,
1440 NOTMUCH_MESSAGE_FLAG_EXCLUDED,
1442 /* This message is a "ghost message", meaning it has no filenames
1443 * or content, but we know it exists because it was referenced by
1444 * some other message. A ghost message has only a message ID and
1447 NOTMUCH_MESSAGE_FLAG_GHOST,
1448 } notmuch_message_flag_t;
1451 * Get a value of a flag for the email corresponding to 'message'.
1454 notmuch_message_get_flag (notmuch_message_t *message,
1455 notmuch_message_flag_t flag);
1458 * Set a value of a flag for the email corresponding to 'message'.
1461 notmuch_message_set_flag (notmuch_message_t *message,
1462 notmuch_message_flag_t flag, notmuch_bool_t value);
1465 * Get the date of 'message' as a time_t value.
1467 * For the original textual representation of the Date header from the
1468 * message call notmuch_message_get_header() with a header value of
1472 notmuch_message_get_date (notmuch_message_t *message);
1475 * Get the value of the specified header from 'message' as a UTF-8 string.
1477 * Common headers are stored in the database when the message is
1478 * indexed and will be returned from the database. Other headers will
1479 * be read from the actual message file.
1481 * The header name is case insensitive.
1483 * The returned string belongs to the message so should not be
1484 * modified or freed by the caller (nor should it be referenced after
1485 * the message is destroyed).
1487 * Returns an empty string ("") if the message does not contain a
1488 * header line matching 'header'. Returns NULL if any error occurs.
1491 notmuch_message_get_header (notmuch_message_t *message, const char *header);
1494 * Get the tags for 'message', returning a notmuch_tags_t object which
1495 * can be used to iterate over all tags.
1497 * The tags object is owned by the message and as such, will only be
1498 * valid for as long as the message is valid, (which is until the
1499 * query from which it derived is destroyed).
1501 * Typical usage might be:
1503 * notmuch_message_t *message;
1504 * notmuch_tags_t *tags;
1507 * message = notmuch_database_find_message (database, message_id);
1509 * for (tags = notmuch_message_get_tags (message);
1510 * notmuch_tags_valid (tags);
1511 * notmuch_tags_move_to_next (tags))
1513 * tag = notmuch_tags_get (tags);
1517 * notmuch_message_destroy (message);
1519 * Note that there's no explicit destructor needed for the
1520 * notmuch_tags_t object. (For consistency, we do provide a
1521 * notmuch_tags_destroy function, but there's no good reason to call
1522 * it if the message is about to be destroyed).
1525 notmuch_message_get_tags (notmuch_message_t *message);
1528 * The longest possible tag value.
1530 #define NOTMUCH_TAG_MAX 200
1533 * Add a tag to the given message.
1537 * NOTMUCH_STATUS_SUCCESS: Tag successfully added to message
1539 * NOTMUCH_STATUS_NULL_POINTER: The 'tag' argument is NULL
1541 * NOTMUCH_STATUS_TAG_TOO_LONG: The length of 'tag' is too long
1542 * (exceeds NOTMUCH_TAG_MAX)
1544 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
1545 * mode so message cannot be modified.
1548 notmuch_message_add_tag (notmuch_message_t *message, const char *tag);
1551 * Remove a tag from the given message.
1555 * NOTMUCH_STATUS_SUCCESS: Tag successfully removed from message
1557 * NOTMUCH_STATUS_NULL_POINTER: The 'tag' argument is NULL
1559 * NOTMUCH_STATUS_TAG_TOO_LONG: The length of 'tag' is too long
1560 * (exceeds NOTMUCH_TAG_MAX)
1562 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
1563 * mode so message cannot be modified.
1566 notmuch_message_remove_tag (notmuch_message_t *message, const char *tag);
1569 * Remove all tags from the given message.
1571 * See notmuch_message_freeze for an example showing how to safely
1572 * replace tag values.
1574 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
1575 * mode so message cannot be modified.
1578 notmuch_message_remove_all_tags (notmuch_message_t *message);
1581 * Add/remove tags according to maildir flags in the message filename(s).
1583 * This function examines the filenames of 'message' for maildir
1584 * flags, and adds or removes tags on 'message' as follows when these
1585 * flags are present:
1587 * Flag Action if present
1588 * ---- -----------------
1589 * 'D' Adds the "draft" tag to the message
1590 * 'F' Adds the "flagged" tag to the message
1591 * 'P' Adds the "passed" tag to the message
1592 * 'R' Adds the "replied" tag to the message
1593 * 'S' Removes the "unread" tag from the message
1595 * For each flag that is not present, the opposite action (add/remove)
1596 * is performed for the corresponding tags.
1598 * Flags are identified as trailing components of the filename after a
1599 * sequence of ":2,".
1601 * If there are multiple filenames associated with this message, the
1602 * flag is considered present if it appears in one or more
1603 * filenames. (That is, the flags from the multiple filenames are
1604 * combined with the logical OR operator.)
1606 * A client can ensure that notmuch database tags remain synchronized
1607 * with maildir flags by calling this function after each call to
1608 * notmuch_database_index_file. See also
1609 * notmuch_message_tags_to_maildir_flags for synchronizing tag changes
1610 * back to maildir flags.
1613 notmuch_message_maildir_flags_to_tags (notmuch_message_t *message);
1616 * Rename message filename(s) to encode tags as maildir flags.
1618 * Specifically, for each filename corresponding to this message:
1620 * If the filename is not in a maildir directory, do nothing. (A
1621 * maildir directory is determined as a directory named "new" or
1622 * "cur".) Similarly, if the filename has invalid maildir info,
1623 * (repeated or outof-ASCII-order flag characters after ":2,"), then
1626 * If the filename is in a maildir directory, rename the file so that
1627 * its filename ends with the sequence ":2," followed by zero or more
1628 * of the following single-character flags (in ASCII order):
1630 * * flag 'D' iff the message has the "draft" tag
1631 * * flag 'F' iff the message has the "flagged" tag
1632 * * flag 'P' iff the message has the "passed" tag
1633 * * flag 'R' iff the message has the "replied" tag
1634 * * flag 'S' iff the message does not have the "unread" tag
1636 * Any existing flags unmentioned in the list above will be preserved
1639 * Also, if this filename is in a directory named "new", rename it to
1640 * be within the neighboring directory named "cur".
1642 * A client can ensure that maildir filename flags remain synchronized
1643 * with notmuch database tags by calling this function after changing
1644 * tags, (after calls to notmuch_message_add_tag,
1645 * notmuch_message_remove_tag, or notmuch_message_freeze/
1646 * notmuch_message_thaw). See also notmuch_message_maildir_flags_to_tags
1647 * for synchronizing maildir flag changes back to tags.
1650 notmuch_message_tags_to_maildir_flags (notmuch_message_t *message);
1653 * Freeze the current state of 'message' within the database.
1655 * This means that changes to the message state, (via
1656 * notmuch_message_add_tag, notmuch_message_remove_tag, and
1657 * notmuch_message_remove_all_tags), will not be committed to the
1658 * database until the message is thawed with notmuch_message_thaw.
1660 * Multiple calls to freeze/thaw are valid and these calls will
1661 * "stack". That is there must be as many calls to thaw as to freeze
1662 * before a message is actually thawed.
1664 * The ability to do freeze/thaw allows for safe transactions to
1665 * change tag values. For example, explicitly setting a message to
1666 * have a given set of tags might look like this:
1668 * notmuch_message_freeze (message);
1670 * notmuch_message_remove_all_tags (message);
1672 * for (i = 0; i < NUM_TAGS; i++)
1673 * notmuch_message_add_tag (message, tags[i]);
1675 * notmuch_message_thaw (message);
1677 * With freeze/thaw used like this, the message in the database is
1678 * guaranteed to have either the full set of original tag values, or
1679 * the full set of new tag values, but nothing in between.
1681 * Imagine the example above without freeze/thaw and the operation
1682 * somehow getting interrupted. This could result in the message being
1683 * left with no tags if the interruption happened after
1684 * notmuch_message_remove_all_tags but before notmuch_message_add_tag.
1688 * NOTMUCH_STATUS_SUCCESS: Message successfully frozen.
1690 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
1691 * mode so message cannot be modified.
1694 notmuch_message_freeze (notmuch_message_t *message);
1697 * Thaw the current 'message', synchronizing any changes that may have
1698 * occurred while 'message' was frozen into the notmuch database.
1700 * See notmuch_message_freeze for an example of how to use this
1701 * function to safely provide tag changes.
1703 * Multiple calls to freeze/thaw are valid and these calls with
1704 * "stack". That is there must be as many calls to thaw as to freeze
1705 * before a message is actually thawed.
1709 * NOTMUCH_STATUS_SUCCESS: Message successfully thawed, (or at least
1710 * its frozen count has successfully been reduced by 1).
1712 * NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW: An attempt was made to thaw
1713 * an unfrozen message. That is, there have been an unbalanced
1714 * number of calls to notmuch_message_freeze and
1715 * notmuch_message_thaw.
1718 notmuch_message_thaw (notmuch_message_t *message);
1721 * Destroy a notmuch_message_t object.
1723 * It can be useful to call this function in the case of a single
1724 * query object with many messages in the result, (such as iterating
1725 * over the entire database). Otherwise, it's fine to never call this
1726 * function and there will still be no memory leaks. (The memory from
1727 * the messages get reclaimed when the containing query is destroyed.)
1730 notmuch_message_destroy (notmuch_message_t *message);
1733 * @name Message Properties
1735 * This interface provides the ability to attach arbitrary (key,value)
1736 * string pairs to a message, to remove such pairs, and to iterate
1737 * over them. The caller should take some care as to what keys they
1738 * add or delete values for, as other subsystems or extensions may
1739 * depend on these properties.
1744 * Retrieve the value for a single property key
1746 * *value* is set to a string owned by the message or NULL if there is
1747 * no such key. In the case of multiple values for the given key, the
1748 * first one is retrieved.
1751 * - NOTMUCH_STATUS_NULL_POINTER: *value* may not be NULL.
1752 * - NOTMUCH_STATUS_SUCCESS: No error occured.
1753 * @since libnotmuch 4.4 (notmuch 0.23)
1756 notmuch_message_get_property (notmuch_message_t *message, const char *key, const char **value);
1759 * Add a (key,value) pair to a message
1762 * - NOTMUCH_STATUS_ILLEGAL_ARGUMENT: *key* may not contain an '=' character.
1763 * - NOTMUCH_STATUS_NULL_POINTER: Neither *key* nor *value* may be NULL.
1764 * - NOTMUCH_STATUS_SUCCESS: No error occured.
1765 * @since libnotmuch 4.4 (notmuch 0.23)
1768 notmuch_message_add_property (notmuch_message_t *message, const char *key, const char *value);
1771 * Remove a (key,value) pair from a message.
1773 * It is not an error to remove a non-existant (key,value) pair
1776 * - NOTMUCH_STATUS_ILLEGAL_ARGUMENT: *key* may not contain an '=' character.
1777 * - NOTMUCH_STATUS_NULL_POINTER: Neither *key* nor *value* may be NULL.
1778 * - NOTMUCH_STATUS_SUCCESS: No error occured.
1779 * @since libnotmuch 4.4 (notmuch 0.23)
1782 notmuch_message_remove_property (notmuch_message_t *message, const char *key, const char *value);
1785 * Remove all (key,value) pairs from the given message.
1787 * @param[in,out] message message to operate on.
1788 * @param[in] key key to delete properties for. If NULL, delete
1789 * properties for all keys
1791 * - NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in
1792 * read-only mode so message cannot be modified.
1793 * - NOTMUCH_STATUS_SUCCESS: No error occured.
1795 * @since libnotmuch 4.4 (notmuch 0.23)
1798 notmuch_message_remove_all_properties (notmuch_message_t *message, const char *key);
1801 * Opaque message property iterator
1803 typedef struct _notmuch_string_map_iterator notmuch_message_properties_t;
1806 * Get the properties for *message*, returning a
1807 * notmuch_message_properties_t object which can be used to iterate
1808 * over all properties.
1810 * The notmuch_message_properties_t object is owned by the message and
1811 * as such, will only be valid for as long as the message is valid,
1812 * (which is until the query from which it derived is destroyed).
1814 * @param[in] message The message to examine
1815 * @param[in] key key or key prefix
1816 * @param[in] exact if TRUE, require exact match with key. Otherwise
1819 * Typical usage might be:
1821 * notmuch_message_properties_t *list;
1823 * for (list = notmuch_message_get_properties (message, "testkey1", TRUE);
1824 * notmuch_message_properties_valid (list); notmuch_message_properties_move_to_next (list)) {
1825 * printf("%s\n", notmuch_message_properties_value(list));
1828 * notmuch_message_properties_destroy (list);
1830 * Note that there's no explicit destructor needed for the
1831 * notmuch_message_properties_t object. (For consistency, we do
1832 * provide a notmuch_message_properities_destroy function, but there's
1833 * no good reason to call it if the message is about to be destroyed).
1835 * @since libnotmuch 4.4 (notmuch 0.23)
1837 notmuch_message_properties_t *
1838 notmuch_message_get_properties (notmuch_message_t *message, const char *key, notmuch_bool_t exact);
1841 * Is the given *properties* iterator pointing at a valid (key,value)
1844 * When this function returns TRUE,
1845 * notmuch_message_properties_{key,value} will return a valid string,
1846 * and notmuch_message_properties_move_to_next will do what it
1847 * says. Whereas when this function returns FALSE, calling any of
1848 * these functions results in undefined behaviour.
1850 * See the documentation of notmuch_message_properties_get for example
1851 * code showing how to iterate over a notmuch_message_properties_t
1854 * @since libnotmuch 4.4 (notmuch 0.23)
1857 notmuch_message_properties_valid (notmuch_message_properties_t *properties);
1860 * Move the *properties* iterator to the next (key,value) pair
1862 * If *properties* is already pointing at the last pair then the iterator
1863 * will be moved to a point just beyond that last pair, (where
1864 * notmuch_message_properties_valid will return FALSE).
1866 * See the documentation of notmuch_message_get_properties for example
1867 * code showing how to iterate over a notmuch_message_properties_t object.
1869 * @since libnotmuch 4.4 (notmuch 0.23)
1872 notmuch_message_properties_move_to_next (notmuch_message_properties_t *properties);
1875 * Return the key from the current (key,value) pair.
1877 * this could be useful if iterating for a prefix
1879 * @since libnotmuch 4.4 (notmuch 0.23)
1882 notmuch_message_properties_key (notmuch_message_properties_t *properties);
1885 * Return the value from the current (key,value) pair.
1887 * This could be useful if iterating for a prefix.
1889 * @since libnotmuch 4.4 (notmuch 0.23)
1892 notmuch_message_properties_value (notmuch_message_properties_t *properties);
1896 * Destroy a notmuch_message_properties_t object.
1898 * It's not strictly necessary to call this function. All memory from
1899 * the notmuch_message_properties_t object will be reclaimed when the
1900 * containing message object is destroyed.
1902 * @since libnotmuch 4.4 (notmuch 0.23)
1905 notmuch_message_properties_destroy (notmuch_message_properties_t *properties);
1910 * Is the given 'tags' iterator pointing at a valid tag.
1912 * When this function returns TRUE, notmuch_tags_get will return a
1913 * valid string. Whereas when this function returns FALSE,
1914 * notmuch_tags_get will return NULL.
1916 * See the documentation of notmuch_message_get_tags for example code
1917 * showing how to iterate over a notmuch_tags_t object.
1920 notmuch_tags_valid (notmuch_tags_t *tags);
1923 * Get the current tag from 'tags' as a string.
1925 * Note: The returned string belongs to 'tags' and has a lifetime
1926 * identical to it (and the query to which it ultimately belongs).
1928 * See the documentation of notmuch_message_get_tags for example code
1929 * showing how to iterate over a notmuch_tags_t object.
1932 notmuch_tags_get (notmuch_tags_t *tags);
1935 * Move the 'tags' iterator to the next tag.
1937 * If 'tags' is already pointing at the last tag then the iterator
1938 * will be moved to a point just beyond that last tag, (where
1939 * notmuch_tags_valid will return FALSE and notmuch_tags_get will
1942 * See the documentation of notmuch_message_get_tags for example code
1943 * showing how to iterate over a notmuch_tags_t object.
1946 notmuch_tags_move_to_next (notmuch_tags_t *tags);
1949 * Destroy a notmuch_tags_t object.
1951 * It's not strictly necessary to call this function. All memory from
1952 * the notmuch_tags_t object will be reclaimed when the containing
1953 * message or query objects are destroyed.
1956 notmuch_tags_destroy (notmuch_tags_t *tags);
1959 * Store an mtime within the database for 'directory'.
1961 * The 'directory' should be an object retrieved from the database
1962 * with notmuch_database_get_directory for a particular path.
1964 * The intention is for the caller to use the mtime to allow efficient
1965 * identification of new messages to be added to the database. The
1966 * recommended usage is as follows:
1968 * o Read the mtime of a directory from the filesystem
1970 * o Call index_file for all mail files in the directory
1972 * o Call notmuch_directory_set_mtime with the mtime read from the
1975 * Then, when wanting to check for updates to the directory in the
1976 * future, the client can call notmuch_directory_get_mtime and know
1977 * that it only needs to add files if the mtime of the directory and
1978 * files are newer than the stored timestamp.
1980 * Note: The notmuch_directory_get_mtime function does not allow the
1981 * caller to distinguish a timestamp of 0 from a non-existent
1982 * timestamp. So don't store a timestamp of 0 unless you are
1983 * comfortable with that.
1987 * NOTMUCH_STATUS_SUCCESS: mtime successfully stored in database.
1989 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception
1990 * occurred, mtime not stored.
1992 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
1993 * mode so directory mtime cannot be modified.
1996 notmuch_directory_set_mtime (notmuch_directory_t *directory,
2000 * Get the mtime of a directory, (as previously stored with
2001 * notmuch_directory_set_mtime).
2003 * Returns 0 if no mtime has previously been stored for this
2007 notmuch_directory_get_mtime (notmuch_directory_t *directory);
2010 * Get a notmuch_filenames_t iterator listing all the filenames of
2011 * messages in the database within the given directory.
2013 * The returned filenames will be the basename-entries only (not
2016 notmuch_filenames_t *
2017 notmuch_directory_get_child_files (notmuch_directory_t *directory);
2020 * Get a notmuch_filenames_t iterator listing all the filenames of
2021 * sub-directories in the database within the given directory.
2023 * The returned filenames will be the basename-entries only (not
2026 notmuch_filenames_t *
2027 notmuch_directory_get_child_directories (notmuch_directory_t *directory);
2030 * Delete directory document from the database, and destroy the
2031 * notmuch_directory_t object. Assumes any child directories and files
2032 * have been deleted by the caller.
2034 * @since libnotmuch 4.3 (notmuch 0.21)
2037 notmuch_directory_delete (notmuch_directory_t *directory);
2040 * Destroy a notmuch_directory_t object.
2043 notmuch_directory_destroy (notmuch_directory_t *directory);
2046 * Is the given 'filenames' iterator pointing at a valid filename.
2048 * When this function returns TRUE, notmuch_filenames_get will return
2049 * a valid string. Whereas when this function returns FALSE,
2050 * notmuch_filenames_get will return NULL.
2052 * It is acceptable to pass NULL for 'filenames', in which case this
2053 * function will always return FALSE.
2056 notmuch_filenames_valid (notmuch_filenames_t *filenames);
2059 * Get the current filename from 'filenames' as a string.
2061 * Note: The returned string belongs to 'filenames' and has a lifetime
2062 * identical to it (and the directory to which it ultimately belongs).
2064 * It is acceptable to pass NULL for 'filenames', in which case this
2065 * function will always return NULL.
2068 notmuch_filenames_get (notmuch_filenames_t *filenames);
2071 * Move the 'filenames' iterator to the next filename.
2073 * If 'filenames' is already pointing at the last filename then the
2074 * iterator will be moved to a point just beyond that last filename,
2075 * (where notmuch_filenames_valid will return FALSE and
2076 * notmuch_filenames_get will return NULL).
2078 * It is acceptable to pass NULL for 'filenames', in which case this
2079 * function will do nothing.
2082 notmuch_filenames_move_to_next (notmuch_filenames_t *filenames);
2085 * Destroy a notmuch_filenames_t object.
2087 * It's not strictly necessary to call this function. All memory from
2088 * the notmuch_filenames_t object will be reclaimed when the
2089 * containing directory object is destroyed.
2091 * It is acceptable to pass NULL for 'filenames', in which case this
2092 * function will do nothing.
2095 notmuch_filenames_destroy (notmuch_filenames_t *filenames);
2099 * set config 'key' to 'value'
2101 * @since libnotmuch 4.4 (notmuch 0.23)
2104 notmuch_database_set_config (notmuch_database_t *db, const char *key, const char *value);
2107 * retrieve config item 'key', assign to 'value'
2109 * keys which have not been previously set with n_d_set_config will
2110 * return an empty string.
2112 * return value is allocated by malloc and should be freed by the
2115 * @since libnotmuch 4.4 (notmuch 0.23)
2118 notmuch_database_get_config (notmuch_database_t *db, const char *key, char **value);
2121 * Create an iterator for all config items with keys matching a given prefix
2123 * @since libnotmuch 4.4 (notmuch 0.23)
2126 notmuch_database_get_config_list (notmuch_database_t *db, const char *prefix, notmuch_config_list_t **out);
2129 * Is 'config_list' iterator valid (i.e. _key, _value, _move_to_next can be called).
2131 * @since libnotmuch 4.4 (notmuch 0.23)
2134 notmuch_config_list_valid (notmuch_config_list_t *config_list);
2137 * return key for current config pair
2139 * return value is owned by the iterator, and will be destroyed by the
2140 * next call to notmuch_config_list_key or notmuch_config_list_destroy.
2142 * @since libnotmuch 4.4 (notmuch 0.23)
2145 notmuch_config_list_key (notmuch_config_list_t *config_list);
2148 * return 'value' for current config pair
2150 * return value is owned by the iterator, and will be destroyed by the
2151 * next call to notmuch_config_list_value or notmuch config_list_destroy
2153 * @since libnotmuch 4.4 (notmuch 0.23)
2156 notmuch_config_list_value (notmuch_config_list_t *config_list);
2160 * move 'config_list' iterator to the next pair
2162 * @since libnotmuch 4.4 (notmuch 0.23)
2165 notmuch_config_list_move_to_next (notmuch_config_list_t *config_list);
2168 * free any resources held by 'config_list'
2170 * @since libnotmuch 4.4 (notmuch 0.23)
2173 notmuch_config_list_destroy (notmuch_config_list_t *config_list);
2177 * get the current default indexing options for a given database.
2179 * This object will survive until the database itself is destroyed,
2180 * but the caller may also release it earlier with
2181 * notmuch_indexopts_destroy.
2183 * This object represents a set of options on how a message can be
2184 * added to the index. At the moment it is a featureless stub.
2186 * @since libnotmuch 5.1 (notmuch 0.26)
2188 notmuch_indexopts_t *
2189 notmuch_database_get_default_indexopts (notmuch_database_t *db);
2192 * Destroy a notmuch_indexopts_t object.
2194 * @since libnotmuch 5.1 (notmuch 0.26)
2197 notmuch_indexopts_destroy (notmuch_indexopts_t *options);
2201 * interrogate the library for compile time features
2203 * @since libnotmuch 4.4 (notmuch 0.23)
2206 notmuch_built_with (const char *name);
2209 #pragma GCC visibility pop