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 #endif /* __DOXYGEN__ */
225 * Create a new, empty notmuch database located at 'path'.
227 * The path should be a top-level directory to a collection of
228 * plain-text email messages (one message per file). This call will
229 * create a new ".notmuch" directory within 'path' where notmuch will
232 * After a successful call to notmuch_database_create, the returned
233 * database will be open so the caller should call
234 * notmuch_database_destroy when finished with it.
236 * The database will not yet have any data in it
237 * (notmuch_database_create itself is a very cheap function). Messages
238 * contained within 'path' can be added to the database by calling
239 * notmuch_database_add_message.
241 * In case of any failure, this function returns an error status and
242 * sets *database to NULL (after printing an error message on stderr).
246 * NOTMUCH_STATUS_SUCCESS: Successfully created the database.
248 * NOTMUCH_STATUS_NULL_POINTER: The given 'path' argument is NULL.
250 * NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory.
252 * NOTMUCH_STATUS_FILE_ERROR: An error occurred trying to create the
253 * database file (such as permission denied, or file not found,
254 * etc.), or the database already exists.
256 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred.
259 notmuch_database_create (const char *path, notmuch_database_t **database);
262 * Like notmuch_database_create, except optionally return an error
263 * message. This message is allocated by malloc and should be freed by
267 notmuch_database_create_verbose (const char *path,
268 notmuch_database_t **database,
269 char **error_message);
272 * Database open mode for notmuch_database_open.
276 * Open database for reading only.
278 NOTMUCH_DATABASE_MODE_READ_ONLY = 0,
280 * Open database for reading and writing.
282 NOTMUCH_DATABASE_MODE_READ_WRITE
283 } notmuch_database_mode_t;
286 * Open an existing notmuch database located at 'path'.
288 * The database should have been created at some time in the past,
289 * (not necessarily by this process), by calling
290 * notmuch_database_create with 'path'. By default the database should be
291 * opened for reading only. In order to write to the database you need to
292 * pass the NOTMUCH_DATABASE_MODE_READ_WRITE mode.
294 * An existing notmuch database can be identified by the presence of a
295 * directory named ".notmuch" below 'path'.
297 * The caller should call notmuch_database_destroy when finished with
300 * In case of any failure, this function returns an error status and
301 * sets *database to NULL (after printing an error message on stderr).
305 * NOTMUCH_STATUS_SUCCESS: Successfully opened the database.
307 * NOTMUCH_STATUS_NULL_POINTER: The given 'path' argument is NULL.
309 * NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory.
311 * NOTMUCH_STATUS_FILE_ERROR: An error occurred trying to open the
312 * database file (such as permission denied, or file not found,
313 * etc.), or the database version is unknown.
315 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred.
318 notmuch_database_open (const char *path,
319 notmuch_database_mode_t mode,
320 notmuch_database_t **database);
322 * Like notmuch_database_open, except optionally return an error
323 * message. This message is allocated by malloc and should be freed by
328 notmuch_database_open_verbose (const char *path,
329 notmuch_database_mode_t mode,
330 notmuch_database_t **database,
331 char **error_message);
334 * Retrieve last status string for given database.
338 notmuch_database_status_string (const notmuch_database_t *notmuch);
341 * Commit changes and close the given notmuch database.
343 * After notmuch_database_close has been called, calls to other
344 * functions on objects derived from this database may either behave
345 * as if the database had not been closed (e.g., if the required data
346 * has been cached) or may fail with a
347 * NOTMUCH_STATUS_XAPIAN_EXCEPTION. The only further operation
348 * permitted on the database itself is to call
349 * notmuch_database_destroy.
351 * notmuch_database_close can be called multiple times. Later calls
354 * For writable databases, notmuch_database_close commits all changes
355 * to disk before closing the database. If the caller is currently in
356 * an atomic section (there was a notmuch_database_begin_atomic
357 * without a matching notmuch_database_end_atomic), this will discard
358 * changes made in that atomic section (but still commit changes made
359 * prior to entering the atomic section).
363 * NOTMUCH_STATUS_SUCCESS: Successfully closed the database.
365 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred; the
366 * database has been closed but there are no guarantees the
367 * changes to the database, if any, have been flushed to disk.
370 notmuch_database_close (notmuch_database_t *database);
373 * A callback invoked by notmuch_database_compact to notify the user
374 * of the progress of the compaction process.
376 typedef void (*notmuch_compact_status_cb_t)(const char *message, void *closure);
379 * Compact a notmuch database, backing up the original database to the
382 * The database will be opened with NOTMUCH_DATABASE_MODE_READ_WRITE
383 * during the compaction process to ensure no writes are made.
385 * If the optional callback function 'status_cb' is non-NULL, it will
386 * be called with diagnostic and informational messages. The argument
387 * 'closure' is passed verbatim to any callback invoked.
390 notmuch_database_compact (const char* path,
391 const char* backup_path,
392 notmuch_compact_status_cb_t status_cb,
396 * Destroy the notmuch database, closing it if necessary and freeing
397 * all associated resources.
399 * Return value as in notmuch_database_close if the database was open;
400 * notmuch_database_destroy itself has no failure modes.
403 notmuch_database_destroy (notmuch_database_t *database);
406 * Return the database path of the given database.
408 * The return value is a string owned by notmuch so should not be
409 * modified nor freed by the caller.
412 notmuch_database_get_path (notmuch_database_t *database);
415 * Return the database format version of the given database.
418 notmuch_database_get_version (notmuch_database_t *database);
421 * Can the database be upgraded to a newer database version?
423 * If this function returns TRUE, then the caller may call
424 * notmuch_database_upgrade to upgrade the database. If the caller
425 * does not upgrade an out-of-date database, then some functions may
426 * fail with NOTMUCH_STATUS_UPGRADE_REQUIRED. This always returns
427 * FALSE for a read-only database because there's no way to upgrade a
428 * read-only database.
431 notmuch_database_needs_upgrade (notmuch_database_t *database);
434 * Upgrade the current database to the latest supported version.
436 * This ensures that all current notmuch functionality will be
437 * available on the database. After opening a database in read-write
438 * mode, it is recommended that clients check if an upgrade is needed
439 * (notmuch_database_needs_upgrade) and if so, upgrade with this
440 * function before making any modifications. If
441 * notmuch_database_needs_upgrade returns FALSE, this will be a no-op.
443 * The optional progress_notify callback can be used by the caller to
444 * provide progress indication to the user. If non-NULL it will be
445 * called periodically with 'progress' as a floating-point value in
446 * the range of [0.0 .. 1.0] indicating the progress made so far in
447 * the upgrade process. The argument 'closure' is passed verbatim to
448 * any callback invoked.
451 notmuch_database_upgrade (notmuch_database_t *database,
452 void (*progress_notify) (void *closure,
457 * Begin an atomic database operation.
459 * Any modifications performed between a successful begin and a
460 * notmuch_database_end_atomic will be applied to the database
461 * atomically. Note that, unlike a typical database transaction, this
462 * only ensures atomicity, not durability; neither begin nor end
463 * necessarily flush modifications to disk.
465 * Atomic sections may be nested. begin_atomic and end_atomic must
466 * always be called in pairs.
470 * NOTMUCH_STATUS_SUCCESS: Successfully entered atomic section.
472 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred;
473 * atomic section not entered.
476 notmuch_database_begin_atomic (notmuch_database_t *notmuch);
479 * Indicate the end of an atomic database operation.
483 * NOTMUCH_STATUS_SUCCESS: Successfully completed atomic section.
485 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred;
486 * atomic section not ended.
488 * NOTMUCH_STATUS_UNBALANCED_ATOMIC: The database is not currently in
492 notmuch_database_end_atomic (notmuch_database_t *notmuch);
495 * Return the committed database revision and UUID.
497 * The database revision number increases monotonically with each
498 * commit to the database. Hence, all messages and message changes
499 * committed to the database (that is, visible to readers) have a last
500 * modification revision <= the committed database revision. Any
501 * messages committed in the future will be assigned a modification
502 * revision > the committed database revision.
504 * The UUID is a NUL-terminated opaque string that uniquely identifies
505 * this database. Two revision numbers are only comparable if they
506 * have the same database UUID.
509 notmuch_database_get_revision (notmuch_database_t *notmuch,
513 * Retrieve a directory object from the database for 'path'.
515 * Here, 'path' should be a path relative to the path of 'database'
516 * (see notmuch_database_get_path), or else should be an absolute path
517 * with initial components that match the path of 'database'.
519 * If this directory object does not exist in the database, this
520 * returns NOTMUCH_STATUS_SUCCESS and sets *directory to NULL.
522 * Otherwise the returned directory object is owned by the database
523 * and as such, will only be valid until notmuch_database_destroy is
528 * NOTMUCH_STATUS_SUCCESS: Successfully retrieved directory.
530 * NOTMUCH_STATUS_NULL_POINTER: The given 'directory' argument is NULL.
532 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred;
533 * directory not retrieved.
535 * NOTMUCH_STATUS_UPGRADE_REQUIRED: The caller must upgrade the
536 * database to use this function.
539 notmuch_database_get_directory (notmuch_database_t *database,
541 notmuch_directory_t **directory);
544 * Add a new message to the given notmuch database or associate an
545 * additional filename with an existing message.
547 * Here, 'filename' should be a path relative to the path of
548 * 'database' (see notmuch_database_get_path), or else should be an
549 * absolute filename with initial components that match the path of
552 * The file should be a single mail message (not a multi-message mbox)
553 * that is expected to remain at its current location, (since the
554 * notmuch database will reference the filename, and will not copy the
555 * entire contents of the file.
557 * If another message with the same message ID already exists in the
558 * database, rather than creating a new message, this adds 'filename'
559 * to the list of the filenames for the existing message.
561 * If 'message' is not NULL, then, on successful return
562 * (NOTMUCH_STATUS_SUCCESS or NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID) '*message'
563 * will be initialized to a message object that can be used for things
564 * such as adding tags to the just-added message. The user should call
565 * notmuch_message_destroy when done with the message. On any failure
566 * '*message' will be set to NULL.
570 * NOTMUCH_STATUS_SUCCESS: Message successfully added to database.
572 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred,
575 * NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID: Message has the same message
576 * ID as another message already in the database. The new
577 * filename was successfully added to the message in the database
578 * (if not already present) and the existing message is returned.
580 * NOTMUCH_STATUS_FILE_ERROR: an error occurred trying to open the
581 * file, (such as permission denied, or file not found,
582 * etc.). Nothing added to the database.
584 * NOTMUCH_STATUS_FILE_NOT_EMAIL: the contents of filename don't look
585 * like an email message. Nothing added to the database.
587 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
588 * mode so no message can be added.
590 * NOTMUCH_STATUS_UPGRADE_REQUIRED: The caller must upgrade the
591 * database to use this function.
594 notmuch_database_add_message (notmuch_database_t *database,
595 const char *filename,
596 notmuch_message_t **message);
599 * Remove a message filename from the given notmuch database. If the
600 * message has no more filenames, remove the message.
602 * If the same message (as determined by the message ID) is still
603 * available via other filenames, then the message will persist in the
604 * database for those filenames. When the last filename is removed for
605 * a particular message, the database content for that message will be
610 * NOTMUCH_STATUS_SUCCESS: The last filename was removed and the
611 * message was removed from the database.
613 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred,
614 * message not removed.
616 * NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID: This filename was removed but
617 * the message persists in the database with at least one other
620 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
621 * mode so no message can be removed.
623 * NOTMUCH_STATUS_UPGRADE_REQUIRED: The caller must upgrade the
624 * database to use this function.
627 notmuch_database_remove_message (notmuch_database_t *database,
628 const char *filename);
631 * Find a message with the given message_id.
633 * If a message with the given message_id is found then, on successful return
634 * (NOTMUCH_STATUS_SUCCESS) '*message' will be initialized to a message
635 * object. The caller should call notmuch_message_destroy when done with the
638 * On any failure or when the message is not found, this function initializes
639 * '*message' to NULL. This means, when NOTMUCH_STATUS_SUCCESS is returned, the
640 * caller is supposed to check '*message' for NULL to find out whether the
641 * message with the given message_id was found.
645 * NOTMUCH_STATUS_SUCCESS: Successful return, check '*message'.
647 * NOTMUCH_STATUS_NULL_POINTER: The given 'message' argument is NULL
649 * NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory, creating message object
651 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred
654 notmuch_database_find_message (notmuch_database_t *database,
655 const char *message_id,
656 notmuch_message_t **message);
659 * Find a message with the given filename.
661 * If the database contains a message with the given filename then, on
662 * successful return (NOTMUCH_STATUS_SUCCESS) '*message' will be initialized to
663 * a message object. The caller should call notmuch_message_destroy when done
666 * On any failure or when the message is not found, this function initializes
667 * '*message' to NULL. This means, when NOTMUCH_STATUS_SUCCESS is returned, the
668 * caller is supposed to check '*message' for NULL to find out whether the
669 * message with the given filename is found.
673 * NOTMUCH_STATUS_SUCCESS: Successful return, check '*message'
675 * NOTMUCH_STATUS_NULL_POINTER: The given 'message' argument is NULL
677 * NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory, creating the message object
679 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred
681 * NOTMUCH_STATUS_UPGRADE_REQUIRED: The caller must upgrade the
682 * database to use this function.
685 notmuch_database_find_message_by_filename (notmuch_database_t *notmuch,
686 const char *filename,
687 notmuch_message_t **message);
690 * Return a list of all tags found in the database.
692 * This function creates a list of all tags found in the database. The
693 * resulting list contains all tags from all messages found in the database.
695 * On error this function returns NULL.
698 notmuch_database_get_all_tags (notmuch_database_t *db);
701 * Create a new query for 'database'.
703 * Here, 'database' should be an open database, (see
704 * notmuch_database_open and notmuch_database_create).
706 * For the query string, we'll document the syntax here more
707 * completely in the future, but it's likely to be a specialized
708 * version of the general Xapian query syntax:
710 * https://xapian.org/docs/queryparser.html
712 * As a special case, passing either a length-zero string, (that is ""),
713 * or a string consisting of a single asterisk (that is "*"), will
714 * result in a query that returns all messages in the database.
716 * See notmuch_query_set_sort for controlling the order of results.
717 * See notmuch_query_search_messages and notmuch_query_search_threads
718 * to actually execute the query.
720 * User should call notmuch_query_destroy when finished with this
723 * Will return NULL if insufficient memory is available.
726 notmuch_query_create (notmuch_database_t *database,
727 const char *query_string);
730 * Sort values for notmuch_query_set_sort.
736 NOTMUCH_SORT_OLDEST_FIRST,
740 NOTMUCH_SORT_NEWEST_FIRST,
742 * Sort by message-id.
744 NOTMUCH_SORT_MESSAGE_ID,
748 NOTMUCH_SORT_UNSORTED
752 * Return the query_string of this query. See notmuch_query_create.
755 notmuch_query_get_query_string (const notmuch_query_t *query);
758 * Return the notmuch database of this query. See notmuch_query_create.
761 notmuch_query_get_database (const notmuch_query_t *query);
764 * Exclude values for notmuch_query_set_omit_excluded. The strange
765 * order is to maintain backward compatibility: the old FALSE/TRUE
766 * options correspond to the new
767 * NOTMUCH_EXCLUDE_FLAG/NOTMUCH_EXCLUDE_TRUE options.
770 NOTMUCH_EXCLUDE_FLAG,
771 NOTMUCH_EXCLUDE_TRUE,
772 NOTMUCH_EXCLUDE_FALSE,
777 * Specify whether to omit excluded results or simply flag them. By
778 * default, this is set to TRUE.
780 * If set to TRUE or ALL, notmuch_query_search_messages will omit excluded
781 * messages from the results, and notmuch_query_search_threads will omit
782 * threads that match only in excluded messages. If set to TRUE,
783 * notmuch_query_search_threads will include all messages in threads that
784 * match in at least one non-excluded message. Otherwise, if set to ALL,
785 * notmuch_query_search_threads will omit excluded messages from all threads.
787 * If set to FALSE or FLAG then both notmuch_query_search_messages and
788 * notmuch_query_search_threads will return all matching
789 * messages/threads regardless of exclude status. If set to FLAG then
790 * the exclude flag will be set for any excluded message that is
791 * returned by notmuch_query_search_messages, and the thread counts
792 * for threads returned by notmuch_query_search_threads will be the
793 * number of non-excluded messages/matches. Otherwise, if set to
794 * FALSE, then the exclude status is completely ignored.
796 * The performance difference when calling
797 * notmuch_query_search_messages should be relatively small (and both
798 * should be very fast). However, in some cases,
799 * notmuch_query_search_threads is very much faster when omitting
800 * excluded messages as it does not need to construct the threads that
801 * only match in excluded messages.
804 notmuch_query_set_omit_excluded (notmuch_query_t *query,
805 notmuch_exclude_t omit_excluded);
808 * Specify the sorting desired for this query.
811 notmuch_query_set_sort (notmuch_query_t *query, notmuch_sort_t sort);
814 * Return the sort specified for this query. See
815 * notmuch_query_set_sort.
818 notmuch_query_get_sort (const notmuch_query_t *query);
821 * Add a tag that will be excluded from the query results by default.
822 * This exclusion will be ignored if this tag appears explicitly in
827 * NOTMUCH_STATUS_SUCCESS: excluded was added successfully.
829 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: a Xapian exception occured.
830 * Most likely a problem lazily parsing the query string.
832 * NOTMUCH_STATUS_IGNORED: tag is explicitely present in the query, so
836 notmuch_query_add_tag_exclude (notmuch_query_t *query, const char *tag);
839 * Execute a query for threads, returning a notmuch_threads_t object
840 * which can be used to iterate over the results. The returned threads
841 * object is owned by the query and as such, will only be valid until
842 * notmuch_query_destroy.
844 * Typical usage might be:
846 * notmuch_query_t *query;
847 * notmuch_threads_t *threads;
848 * notmuch_thread_t *thread;
850 * query = notmuch_query_create (database, query_string);
852 * for (threads = notmuch_query_search_threads (query);
853 * notmuch_threads_valid (threads);
854 * notmuch_threads_move_to_next (threads))
856 * thread = notmuch_threads_get (threads);
858 * notmuch_thread_destroy (thread);
861 * notmuch_query_destroy (query);
863 * Note: If you are finished with a thread before its containing
864 * query, you can call notmuch_thread_destroy to clean up some memory
865 * sooner (as in the above example). Otherwise, if your thread objects
866 * are long-lived, then you don't need to call notmuch_thread_destroy
867 * and all the memory will still be reclaimed when the query is
870 * Note that there's no explicit destructor needed for the
871 * notmuch_threads_t object. (For consistency, we do provide a
872 * notmuch_threads_destroy function, but there's no good reason
873 * to call it if the query is about to be destroyed).
875 * @since libnotmuch 5.0 (notmuch 0.25)
878 notmuch_query_search_threads (notmuch_query_t *query,
879 notmuch_threads_t **out);
882 * Deprecated alias for notmuch_query_search_threads.
884 * @deprecated Deprecated as of libnotmuch 5 (notmuch 0.25). Please
885 * use notmuch_query_search_threads instead.
888 NOTMUCH_DEPRECATED(5,0)
890 notmuch_query_search_threads_st (notmuch_query_t *query, notmuch_threads_t **out);
893 * Execute a query for messages, returning a notmuch_messages_t object
894 * which can be used to iterate over the results. The returned
895 * messages object is owned by the query and as such, will only be
896 * valid until notmuch_query_destroy.
898 * Typical usage might be:
900 * notmuch_query_t *query;
901 * notmuch_messages_t *messages;
902 * notmuch_message_t *message;
904 * query = notmuch_query_create (database, query_string);
906 * for (messages = notmuch_query_search_messages (query);
907 * notmuch_messages_valid (messages);
908 * notmuch_messages_move_to_next (messages))
910 * message = notmuch_messages_get (messages);
912 * notmuch_message_destroy (message);
915 * notmuch_query_destroy (query);
917 * Note: If you are finished with a message before its containing
918 * query, you can call notmuch_message_destroy to clean up some memory
919 * sooner (as in the above example). Otherwise, if your message
920 * objects are long-lived, then you don't need to call
921 * notmuch_message_destroy and all the memory will still be reclaimed
922 * when the query is destroyed.
924 * Note that there's no explicit destructor needed for the
925 * notmuch_messages_t object. (For consistency, we do provide a
926 * notmuch_messages_destroy function, but there's no good
927 * reason to call it if the query is about to be destroyed).
929 * If a Xapian exception occurs this function will return NULL.
931 * @since libnotmuch 5 (notmuch 0.25)
934 notmuch_query_search_messages (notmuch_query_t *query,
935 notmuch_messages_t **out);
937 * Deprecated alias for notmuch_query_search_messages
939 * @deprecated Deprecated as of libnotmuch 5 (notmuch 0.25). Please use
940 * notmuch_query_search_messages instead.
944 NOTMUCH_DEPRECATED(5,0)
946 notmuch_query_search_messages_st (notmuch_query_t *query,
947 notmuch_messages_t **out);
950 * Destroy a notmuch_query_t along with any associated resources.
952 * This will in turn destroy any notmuch_threads_t and
953 * notmuch_messages_t objects generated by this query, (and in
954 * turn any notmuch_thread_t and notmuch_message_t objects generated
955 * from those results, etc.), if such objects haven't already been
959 notmuch_query_destroy (notmuch_query_t *query);
962 * Is the given 'threads' iterator pointing at a valid thread.
964 * When this function returns TRUE, notmuch_threads_get will return a
965 * valid object. Whereas when this function returns FALSE,
966 * notmuch_threads_get will return NULL.
968 * If passed a NULL pointer, this function returns FALSE
970 * See the documentation of notmuch_query_search_threads for example
971 * code showing how to iterate over a notmuch_threads_t object.
974 notmuch_threads_valid (notmuch_threads_t *threads);
977 * Get the current thread from 'threads' as a notmuch_thread_t.
979 * Note: The returned thread belongs to 'threads' and has a lifetime
980 * identical to it (and the query to which it belongs).
982 * See the documentation of notmuch_query_search_threads for example
983 * code showing how to iterate over a notmuch_threads_t object.
985 * If an out-of-memory situation occurs, this function will return
989 notmuch_threads_get (notmuch_threads_t *threads);
992 * Move the 'threads' iterator to the next thread.
994 * If 'threads' is already pointing at the last thread then the
995 * iterator will be moved to a point just beyond that last thread,
996 * (where notmuch_threads_valid will return FALSE and
997 * notmuch_threads_get will return NULL).
999 * See the documentation of notmuch_query_search_threads for example
1000 * code showing how to iterate over a notmuch_threads_t object.
1003 notmuch_threads_move_to_next (notmuch_threads_t *threads);
1006 * Destroy a notmuch_threads_t object.
1008 * It's not strictly necessary to call this function. All memory from
1009 * the notmuch_threads_t object will be reclaimed when the
1010 * containing query object is destroyed.
1013 notmuch_threads_destroy (notmuch_threads_t *threads);
1016 * Return the number of messages matching a search.
1018 * This function performs a search and returns the number of matching
1023 * NOTMUCH_STATUS_SUCCESS: query completed successfully.
1025 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: a Xapian exception occured. The
1026 * value of *count is not defined.
1028 * @since libnotmuch 5 (notmuch 0.25)
1031 notmuch_query_count_messages (notmuch_query_t *query, unsigned int *count);
1034 * Deprecated alias for notmuch_query_count_messages
1037 * @deprecated Deprecated since libnotmuch 5.0 (notmuch 0.25). Please
1038 * use notmuch_query_count_messages instead.
1040 NOTMUCH_DEPRECATED(5,0)
1042 notmuch_query_count_messages_st (notmuch_query_t *query, unsigned int *count);
1045 * Return the number of threads matching a search.
1047 * This function performs a search and returns the number of unique thread IDs
1048 * in the matching messages. This is the same as number of threads matching a
1051 * Note that this is a significantly heavier operation than
1052 * notmuch_query_count_messages{_st}().
1056 * NOTMUCH_STATUS_OUT_OF_MEMORY: Memory allocation failed. The value
1057 * of *count is not defined
1059 * NOTMUCH_STATUS_SUCCESS: query completed successfully.
1061 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: a Xapian exception occured. The
1062 * value of *count is not defined.
1064 * @since libnotmuch 5 (notmuch 0.25)
1067 notmuch_query_count_threads (notmuch_query_t *query, unsigned *count);
1070 * Deprecated alias for notmuch_query_count_threads
1072 * @deprecated Deprecated as of libnotmuch 5.0 (notmuch 0.25). Please
1073 * use notmuch_query_count_threads_st instead.
1075 NOTMUCH_DEPRECATED(5,0)
1077 notmuch_query_count_threads_st (notmuch_query_t *query, unsigned *count);
1080 * Get the thread ID of 'thread'.
1082 * The returned string belongs to 'thread' and as such, should not be
1083 * modified by the caller and will only be valid for as long as the
1084 * thread is valid, (which is until notmuch_thread_destroy or until
1085 * the query from which it derived is destroyed).
1088 notmuch_thread_get_thread_id (notmuch_thread_t *thread);
1091 * Get the total number of messages in 'thread'.
1093 * This count consists of all messages in the database belonging to
1094 * this thread. Contrast with notmuch_thread_get_matched_messages() .
1097 notmuch_thread_get_total_messages (notmuch_thread_t *thread);
1100 * Get a notmuch_messages_t iterator for the top-level messages in
1101 * 'thread' in oldest-first order.
1103 * This iterator will not necessarily iterate over all of the messages
1104 * in the thread. It will only iterate over the messages in the thread
1105 * which are not replies to other messages in the thread.
1107 * The returned list will be destroyed when the thread is destroyed.
1109 notmuch_messages_t *
1110 notmuch_thread_get_toplevel_messages (notmuch_thread_t *thread);
1113 * Get a notmuch_thread_t iterator for all messages in 'thread' in
1114 * oldest-first order.
1116 * The returned list will be destroyed when the thread is destroyed.
1118 notmuch_messages_t *
1119 notmuch_thread_get_messages (notmuch_thread_t *thread);
1122 * Get the number of messages in 'thread' that matched the search.
1124 * This count includes only the messages in this thread that were
1125 * matched by the search from which the thread was created and were
1126 * not excluded by any exclude tags passed in with the query (see
1127 * notmuch_query_add_tag_exclude). Contrast with
1128 * notmuch_thread_get_total_messages() .
1131 notmuch_thread_get_matched_messages (notmuch_thread_t *thread);
1134 * Get the authors of 'thread' as a UTF-8 string.
1136 * The returned string is a comma-separated list of the names of the
1137 * authors of mail messages in the query results that belong to this
1140 * The string contains authors of messages matching the query first, then
1141 * non-matched authors (with the two groups separated by '|'). Within
1142 * each group, authors are ordered by date.
1144 * The returned string belongs to 'thread' and as such, should not be
1145 * modified by the caller and will only be valid for as long as the
1146 * thread is valid, (which is until notmuch_thread_destroy or until
1147 * the query from which it derived is destroyed).
1150 notmuch_thread_get_authors (notmuch_thread_t *thread);
1153 * Get the subject of 'thread' as a UTF-8 string.
1155 * The subject is taken from the first message (according to the query
1156 * order---see notmuch_query_set_sort) in the query results that
1157 * belongs to this thread.
1159 * The returned string belongs to 'thread' and as such, should not be
1160 * modified by the caller and will only be valid for as long as the
1161 * thread is valid, (which is until notmuch_thread_destroy or until
1162 * the query from which it derived is destroyed).
1165 notmuch_thread_get_subject (notmuch_thread_t *thread);
1168 * Get the date of the oldest message in 'thread' as a time_t value.
1171 notmuch_thread_get_oldest_date (notmuch_thread_t *thread);
1174 * Get the date of the newest message in 'thread' as a time_t value.
1177 notmuch_thread_get_newest_date (notmuch_thread_t *thread);
1180 * Get the tags for 'thread', returning a notmuch_tags_t object which
1181 * can be used to iterate over all tags.
1183 * Note: In the Notmuch database, tags are stored on individual
1184 * messages, not on threads. So the tags returned here will be all
1185 * tags of the messages which matched the search and which belong to
1188 * The tags object is owned by the thread and as such, will only be
1189 * valid for as long as the thread is valid, (for example, until
1190 * notmuch_thread_destroy or until the query from which it derived is
1193 * Typical usage might be:
1195 * notmuch_thread_t *thread;
1196 * notmuch_tags_t *tags;
1199 * thread = notmuch_threads_get (threads);
1201 * for (tags = notmuch_thread_get_tags (thread);
1202 * notmuch_tags_valid (tags);
1203 * notmuch_tags_move_to_next (tags))
1205 * tag = notmuch_tags_get (tags);
1209 * notmuch_thread_destroy (thread);
1211 * Note that there's no explicit destructor needed for the
1212 * notmuch_tags_t object. (For consistency, we do provide a
1213 * notmuch_tags_destroy function, but there's no good reason to call
1214 * it if the message is about to be destroyed).
1217 notmuch_thread_get_tags (notmuch_thread_t *thread);
1220 * Destroy a notmuch_thread_t object.
1223 notmuch_thread_destroy (notmuch_thread_t *thread);
1226 * Is the given 'messages' iterator pointing at a valid message.
1228 * When this function returns TRUE, notmuch_messages_get will return a
1229 * valid object. Whereas when this function returns FALSE,
1230 * notmuch_messages_get will return NULL.
1232 * See the documentation of notmuch_query_search_messages for example
1233 * code showing how to iterate over a notmuch_messages_t object.
1236 notmuch_messages_valid (notmuch_messages_t *messages);
1239 * Get the current message from 'messages' as a notmuch_message_t.
1241 * Note: The returned message belongs to 'messages' and has a lifetime
1242 * identical to it (and the query to which it belongs).
1244 * See the documentation of notmuch_query_search_messages for example
1245 * code showing how to iterate over a notmuch_messages_t object.
1247 * If an out-of-memory situation occurs, this function will return
1251 notmuch_messages_get (notmuch_messages_t *messages);
1254 * Move the 'messages' iterator to the next message.
1256 * If 'messages' is already pointing at the last message then the
1257 * iterator will be moved to a point just beyond that last message,
1258 * (where notmuch_messages_valid will return FALSE and
1259 * notmuch_messages_get will return NULL).
1261 * See the documentation of notmuch_query_search_messages for example
1262 * code showing how to iterate over a notmuch_messages_t object.
1265 notmuch_messages_move_to_next (notmuch_messages_t *messages);
1268 * Destroy a notmuch_messages_t object.
1270 * It's not strictly necessary to call this function. All memory from
1271 * the notmuch_messages_t object will be reclaimed when the containing
1272 * query object is destroyed.
1275 notmuch_messages_destroy (notmuch_messages_t *messages);
1278 * Return a list of tags from all messages.
1280 * The resulting list is guaranteed not to contain duplicated tags.
1282 * WARNING: You can no longer iterate over messages after calling this
1283 * function, because the iterator will point at the end of the list.
1284 * We do not have a function to reset the iterator yet and the only
1285 * way how you can iterate over the list again is to recreate the
1288 * The function returns NULL on error.
1291 notmuch_messages_collect_tags (notmuch_messages_t *messages);
1294 * Get the message ID of 'message'.
1296 * The returned string belongs to 'message' and as such, should not be
1297 * modified by the caller and will only be valid for as long as the
1298 * message is valid, (which is until the query from which it derived
1301 * This function will not return NULL since Notmuch ensures that every
1302 * message has a unique message ID, (Notmuch will generate an ID for a
1303 * message if the original file does not contain one).
1306 notmuch_message_get_message_id (notmuch_message_t *message);
1309 * Get the thread ID of 'message'.
1311 * The returned string belongs to 'message' and as such, should not be
1312 * modified by the caller and will only be valid for as long as the
1313 * message is valid, (for example, until the user calls
1314 * notmuch_message_destroy on 'message' or until a query from which it
1315 * derived is destroyed).
1317 * This function will not return NULL since Notmuch ensures that every
1318 * message belongs to a single thread.
1321 notmuch_message_get_thread_id (notmuch_message_t *message);
1324 * Get a notmuch_messages_t iterator for all of the replies to
1327 * Note: This call only makes sense if 'message' was ultimately
1328 * obtained from a notmuch_thread_t object, (such as by coming
1329 * directly from the result of calling notmuch_thread_get_
1330 * toplevel_messages or by any number of subsequent
1331 * calls to notmuch_message_get_replies).
1333 * If 'message' was obtained through some non-thread means, (such as
1334 * by a call to notmuch_query_search_messages), then this function
1337 * If there are no replies to 'message', this function will return
1338 * NULL. (Note that notmuch_messages_valid will accept that NULL
1339 * value as legitimate, and simply return FALSE for it.)
1341 notmuch_messages_t *
1342 notmuch_message_get_replies (notmuch_message_t *message);
1345 * Get a filename for the email corresponding to 'message'.
1347 * The returned filename is an absolute filename, (the initial
1348 * component will match notmuch_database_get_path() ).
1350 * The returned string belongs to the message so should not be
1351 * modified or freed by the caller (nor should it be referenced after
1352 * the message is destroyed).
1354 * Note: If this message corresponds to multiple files in the mail
1355 * store, (that is, multiple files contain identical message IDs),
1356 * this function will arbitrarily return a single one of those
1357 * filenames. See notmuch_message_get_filenames for returning the
1358 * complete list of filenames.
1361 notmuch_message_get_filename (notmuch_message_t *message);
1364 * Get all filenames for the email corresponding to 'message'.
1366 * Returns a notmuch_filenames_t iterator listing all the filenames
1367 * associated with 'message'. These files may not have identical
1368 * content, but each will have the identical Message-ID.
1370 * Each filename in the iterator is an absolute filename, (the initial
1371 * component will match notmuch_database_get_path() ).
1373 notmuch_filenames_t *
1374 notmuch_message_get_filenames (notmuch_message_t *message);
1379 typedef enum _notmuch_message_flag {
1380 NOTMUCH_MESSAGE_FLAG_MATCH,
1381 NOTMUCH_MESSAGE_FLAG_EXCLUDED,
1383 /* This message is a "ghost message", meaning it has no filenames
1384 * or content, but we know it exists because it was referenced by
1385 * some other message. A ghost message has only a message ID and
1388 NOTMUCH_MESSAGE_FLAG_GHOST,
1389 } notmuch_message_flag_t;
1392 * Get a value of a flag for the email corresponding to 'message'.
1395 notmuch_message_get_flag (notmuch_message_t *message,
1396 notmuch_message_flag_t flag);
1399 * Set a value of a flag for the email corresponding to 'message'.
1402 notmuch_message_set_flag (notmuch_message_t *message,
1403 notmuch_message_flag_t flag, notmuch_bool_t value);
1406 * Get the date of 'message' as a time_t value.
1408 * For the original textual representation of the Date header from the
1409 * message call notmuch_message_get_header() with a header value of
1413 notmuch_message_get_date (notmuch_message_t *message);
1416 * Get the value of the specified header from 'message' as a UTF-8 string.
1418 * Common headers are stored in the database when the message is
1419 * indexed and will be returned from the database. Other headers will
1420 * be read from the actual message file.
1422 * The header name is case insensitive.
1424 * The returned string belongs to the message so should not be
1425 * modified or freed by the caller (nor should it be referenced after
1426 * the message is destroyed).
1428 * Returns an empty string ("") if the message does not contain a
1429 * header line matching 'header'. Returns NULL if any error occurs.
1432 notmuch_message_get_header (notmuch_message_t *message, const char *header);
1435 * Get the tags for 'message', returning a notmuch_tags_t object which
1436 * can be used to iterate over all tags.
1438 * The tags object is owned by the message and as such, will only be
1439 * valid for as long as the message is valid, (which is until the
1440 * query from which it derived is destroyed).
1442 * Typical usage might be:
1444 * notmuch_message_t *message;
1445 * notmuch_tags_t *tags;
1448 * message = notmuch_database_find_message (database, message_id);
1450 * for (tags = notmuch_message_get_tags (message);
1451 * notmuch_tags_valid (tags);
1452 * notmuch_tags_move_to_next (tags))
1454 * tag = notmuch_tags_get (tags);
1458 * notmuch_message_destroy (message);
1460 * Note that there's no explicit destructor needed for the
1461 * notmuch_tags_t object. (For consistency, we do provide a
1462 * notmuch_tags_destroy function, but there's no good reason to call
1463 * it if the message is about to be destroyed).
1466 notmuch_message_get_tags (notmuch_message_t *message);
1469 * The longest possible tag value.
1471 #define NOTMUCH_TAG_MAX 200
1474 * Add a tag to the given message.
1478 * NOTMUCH_STATUS_SUCCESS: Tag successfully added to message
1480 * NOTMUCH_STATUS_NULL_POINTER: The 'tag' argument is NULL
1482 * NOTMUCH_STATUS_TAG_TOO_LONG: The length of 'tag' is too long
1483 * (exceeds NOTMUCH_TAG_MAX)
1485 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
1486 * mode so message cannot be modified.
1489 notmuch_message_add_tag (notmuch_message_t *message, const char *tag);
1492 * Remove a tag from the given message.
1496 * NOTMUCH_STATUS_SUCCESS: Tag successfully removed from message
1498 * NOTMUCH_STATUS_NULL_POINTER: The 'tag' argument is NULL
1500 * NOTMUCH_STATUS_TAG_TOO_LONG: The length of 'tag' is too long
1501 * (exceeds NOTMUCH_TAG_MAX)
1503 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
1504 * mode so message cannot be modified.
1507 notmuch_message_remove_tag (notmuch_message_t *message, const char *tag);
1510 * Remove all tags from the given message.
1512 * See notmuch_message_freeze for an example showing how to safely
1513 * replace tag values.
1515 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
1516 * mode so message cannot be modified.
1519 notmuch_message_remove_all_tags (notmuch_message_t *message);
1522 * Add/remove tags according to maildir flags in the message filename(s).
1524 * This function examines the filenames of 'message' for maildir
1525 * flags, and adds or removes tags on 'message' as follows when these
1526 * flags are present:
1528 * Flag Action if present
1529 * ---- -----------------
1530 * 'D' Adds the "draft" tag to the message
1531 * 'F' Adds the "flagged" tag to the message
1532 * 'P' Adds the "passed" tag to the message
1533 * 'R' Adds the "replied" tag to the message
1534 * 'S' Removes the "unread" tag from the message
1536 * For each flag that is not present, the opposite action (add/remove)
1537 * is performed for the corresponding tags.
1539 * Flags are identified as trailing components of the filename after a
1540 * sequence of ":2,".
1542 * If there are multiple filenames associated with this message, the
1543 * flag is considered present if it appears in one or more
1544 * filenames. (That is, the flags from the multiple filenames are
1545 * combined with the logical OR operator.)
1547 * A client can ensure that notmuch database tags remain synchronized
1548 * with maildir flags by calling this function after each call to
1549 * notmuch_database_add_message. See also
1550 * notmuch_message_tags_to_maildir_flags for synchronizing tag changes
1551 * back to maildir flags.
1554 notmuch_message_maildir_flags_to_tags (notmuch_message_t *message);
1557 * Rename message filename(s) to encode tags as maildir flags.
1559 * Specifically, for each filename corresponding to this message:
1561 * If the filename is not in a maildir directory, do nothing. (A
1562 * maildir directory is determined as a directory named "new" or
1563 * "cur".) Similarly, if the filename has invalid maildir info,
1564 * (repeated or outof-ASCII-order flag characters after ":2,"), then
1567 * If the filename is in a maildir directory, rename the file so that
1568 * its filename ends with the sequence ":2," followed by zero or more
1569 * of the following single-character flags (in ASCII order):
1571 * 'D' iff the message has the "draft" tag
1572 * 'F' iff the message has the "flagged" tag
1573 * 'P' iff the message has the "passed" tag
1574 * 'R' iff the message has the "replied" tag
1575 * 'S' iff the message does not have the "unread" tag
1577 * Any existing flags unmentioned in the list above will be preserved
1580 * Also, if this filename is in a directory named "new", rename it to
1581 * be within the neighboring directory named "cur".
1583 * A client can ensure that maildir filename flags remain synchronized
1584 * with notmuch database tags by calling this function after changing
1585 * tags, (after calls to notmuch_message_add_tag,
1586 * notmuch_message_remove_tag, or notmuch_message_freeze/
1587 * notmuch_message_thaw). See also notmuch_message_maildir_flags_to_tags
1588 * for synchronizing maildir flag changes back to tags.
1591 notmuch_message_tags_to_maildir_flags (notmuch_message_t *message);
1594 * Freeze the current state of 'message' within the database.
1596 * This means that changes to the message state, (via
1597 * notmuch_message_add_tag, notmuch_message_remove_tag, and
1598 * notmuch_message_remove_all_tags), will not be committed to the
1599 * database until the message is thawed with notmuch_message_thaw.
1601 * Multiple calls to freeze/thaw are valid and these calls will
1602 * "stack". That is there must be as many calls to thaw as to freeze
1603 * before a message is actually thawed.
1605 * The ability to do freeze/thaw allows for safe transactions to
1606 * change tag values. For example, explicitly setting a message to
1607 * have a given set of tags might look like this:
1609 * notmuch_message_freeze (message);
1611 * notmuch_message_remove_all_tags (message);
1613 * for (i = 0; i < NUM_TAGS; i++)
1614 * notmuch_message_add_tag (message, tags[i]);
1616 * notmuch_message_thaw (message);
1618 * With freeze/thaw used like this, the message in the database is
1619 * guaranteed to have either the full set of original tag values, or
1620 * the full set of new tag values, but nothing in between.
1622 * Imagine the example above without freeze/thaw and the operation
1623 * somehow getting interrupted. This could result in the message being
1624 * left with no tags if the interruption happened after
1625 * notmuch_message_remove_all_tags but before notmuch_message_add_tag.
1629 * NOTMUCH_STATUS_SUCCESS: Message successfully frozen.
1631 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
1632 * mode so message cannot be modified.
1635 notmuch_message_freeze (notmuch_message_t *message);
1638 * Thaw the current 'message', synchronizing any changes that may have
1639 * occurred while 'message' was frozen into the notmuch database.
1641 * See notmuch_message_freeze for an example of how to use this
1642 * function to safely provide tag changes.
1644 * Multiple calls to freeze/thaw are valid and these calls with
1645 * "stack". That is there must be as many calls to thaw as to freeze
1646 * before a message is actually thawed.
1650 * NOTMUCH_STATUS_SUCCESS: Message successfully thawed, (or at least
1651 * its frozen count has successfully been reduced by 1).
1653 * NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW: An attempt was made to thaw
1654 * an unfrozen message. That is, there have been an unbalanced
1655 * number of calls to notmuch_message_freeze and
1656 * notmuch_message_thaw.
1659 notmuch_message_thaw (notmuch_message_t *message);
1662 * Destroy a notmuch_message_t object.
1664 * It can be useful to call this function in the case of a single
1665 * query object with many messages in the result, (such as iterating
1666 * over the entire database). Otherwise, it's fine to never call this
1667 * function and there will still be no memory leaks. (The memory from
1668 * the messages get reclaimed when the containing query is destroyed.)
1671 notmuch_message_destroy (notmuch_message_t *message);
1674 * @name Message Properties
1676 * This interface provides the ability to attach arbitrary (key,value)
1677 * string pairs to a message, to remove such pairs, and to iterate
1678 * over them. The caller should take some care as to what keys they
1679 * add or delete values for, as other subsystems or extensions may
1680 * depend on these properties.
1685 * Retrieve the value for a single property key
1687 * *value* is set to a string owned by the message or NULL if there is
1688 * no such key. In the case of multiple values for the given key, the
1689 * first one is retrieved.
1692 * - NOTMUCH_STATUS_NULL_POINTER: *value* may not be NULL.
1693 * - NOTMUCH_STATUS_SUCCESS: No error occured.
1694 * @since libnotmuch 4.4 (notmuch 0.23)
1697 notmuch_message_get_property (notmuch_message_t *message, const char *key, const char **value);
1700 * Add a (key,value) pair to a message
1703 * - NOTMUCH_STATUS_ILLEGAL_ARGUMENT: *key* may not contain an '=' character.
1704 * - NOTMUCH_STATUS_NULL_POINTER: Neither *key* nor *value* may be NULL.
1705 * - NOTMUCH_STATUS_SUCCESS: No error occured.
1706 * @since libnotmuch 4.4 (notmuch 0.23)
1709 notmuch_message_add_property (notmuch_message_t *message, const char *key, const char *value);
1712 * Remove a (key,value) pair from a message.
1714 * It is not an error to remove a non-existant (key,value) pair
1717 * - NOTMUCH_STATUS_ILLEGAL_ARGUMENT: *key* may not contain an '=' character.
1718 * - NOTMUCH_STATUS_NULL_POINTER: Neither *key* nor *value* may be NULL.
1719 * - NOTMUCH_STATUS_SUCCESS: No error occured.
1720 * @since libnotmuch 4.4 (notmuch 0.23)
1723 notmuch_message_remove_property (notmuch_message_t *message, const char *key, const char *value);
1726 * Remove all (key,value) pairs from the given message.
1728 * @param[in,out] message message to operate on.
1729 * @param[in] key key to delete properties for. If NULL, delete
1730 * properties for all keys
1732 * - NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in
1733 * read-only mode so message cannot be modified.
1734 * - NOTMUCH_STATUS_SUCCESS: No error occured.
1736 * @since libnotmuch 4.4 (notmuch 0.23)
1739 notmuch_message_remove_all_properties (notmuch_message_t *message, const char *key);
1742 * Opaque message property iterator
1744 typedef struct _notmuch_string_map_iterator notmuch_message_properties_t;
1747 * Get the properties for *message*, returning a
1748 * notmuch_message_properties_t object which can be used to iterate
1749 * over all properties.
1751 * The notmuch_message_properties_t object is owned by the message and
1752 * as such, will only be valid for as long as the message is valid,
1753 * (which is until the query from which it derived is destroyed).
1755 * @param[in] message The message to examine
1756 * @param[in] key key or key prefix
1757 * @param[in] exact if TRUE, require exact match with key. Otherwise
1760 * Typical usage might be:
1762 * notmuch_message_properties_t *list;
1764 * for (list = notmuch_message_get_properties (message, "testkey1", TRUE);
1765 * notmuch_message_properties_valid (list); notmuch_message_properties_move_to_next (list)) {
1766 * printf("%s\n", notmuch_message_properties_value(list));
1769 * notmuch_message_properties_destroy (list);
1771 * Note that there's no explicit destructor needed for the
1772 * notmuch_message_properties_t object. (For consistency, we do
1773 * provide a notmuch_message_properities_destroy function, but there's
1774 * no good reason to call it if the message is about to be destroyed).
1776 * @since libnotmuch 4.4 (notmuch 0.23)
1778 notmuch_message_properties_t *
1779 notmuch_message_get_properties (notmuch_message_t *message, const char *key, notmuch_bool_t exact);
1782 * Is the given *properties* iterator pointing at a valid (key,value)
1785 * When this function returns TRUE,
1786 * notmuch_message_properties_{key,value} will return a valid string,
1787 * and notmuch_message_properties_move_to_next will do what it
1788 * says. Whereas when this function returns FALSE, calling any of
1789 * these functions results in undefined behaviour.
1791 * See the documentation of notmuch_message_properties_get for example
1792 * code showing how to iterate over a notmuch_message_properties_t
1795 * @since libnotmuch 4.4 (notmuch 0.23)
1798 notmuch_message_properties_valid (notmuch_message_properties_t *properties);
1801 * Move the *properties* iterator to the next (key,value) pair
1803 * If *properties* is already pointing at the last pair then the iterator
1804 * will be moved to a point just beyond that last pair, (where
1805 * notmuch_message_properties_valid will return FALSE).
1807 * See the documentation of notmuch_message_get_properties for example
1808 * code showing how to iterate over a notmuch_message_properties_t object.
1810 * @since libnotmuch 4.4 (notmuch 0.23)
1813 notmuch_message_properties_move_to_next (notmuch_message_properties_t *properties);
1816 * Return the key from the current (key,value) pair.
1818 * this could be useful if iterating for a prefix
1820 * @since libnotmuch 4.4 (notmuch 0.23)
1823 notmuch_message_properties_key (notmuch_message_properties_t *properties);
1826 * Return the value from the current (key,value) pair.
1828 * This could be useful if iterating for a prefix.
1830 * @since libnotmuch 4.4 (notmuch 0.23)
1833 notmuch_message_properties_value (notmuch_message_properties_t *properties);
1837 * Destroy a notmuch_message_properties_t object.
1839 * It's not strictly necessary to call this function. All memory from
1840 * the notmuch_message_properties_t object will be reclaimed when the
1841 * containing message object is destroyed.
1843 * @since libnotmuch 4.4 (notmuch 0.23)
1846 notmuch_message_properties_destroy (notmuch_message_properties_t *properties);
1851 * Is the given 'tags' iterator pointing at a valid tag.
1853 * When this function returns TRUE, notmuch_tags_get will return a
1854 * valid string. Whereas when this function returns FALSE,
1855 * notmuch_tags_get will return NULL.
1857 * See the documentation of notmuch_message_get_tags for example code
1858 * showing how to iterate over a notmuch_tags_t object.
1861 notmuch_tags_valid (notmuch_tags_t *tags);
1864 * Get the current tag from 'tags' as a string.
1866 * Note: The returned string belongs to 'tags' and has a lifetime
1867 * identical to it (and the query to which it ultimately belongs).
1869 * See the documentation of notmuch_message_get_tags for example code
1870 * showing how to iterate over a notmuch_tags_t object.
1873 notmuch_tags_get (notmuch_tags_t *tags);
1876 * Move the 'tags' iterator to the next tag.
1878 * If 'tags' is already pointing at the last tag then the iterator
1879 * will be moved to a point just beyond that last tag, (where
1880 * notmuch_tags_valid will return FALSE and notmuch_tags_get will
1883 * See the documentation of notmuch_message_get_tags for example code
1884 * showing how to iterate over a notmuch_tags_t object.
1887 notmuch_tags_move_to_next (notmuch_tags_t *tags);
1890 * Destroy a notmuch_tags_t object.
1892 * It's not strictly necessary to call this function. All memory from
1893 * the notmuch_tags_t object will be reclaimed when the containing
1894 * message or query objects are destroyed.
1897 notmuch_tags_destroy (notmuch_tags_t *tags);
1900 * Store an mtime within the database for 'directory'.
1902 * The 'directory' should be an object retrieved from the database
1903 * with notmuch_database_get_directory for a particular path.
1905 * The intention is for the caller to use the mtime to allow efficient
1906 * identification of new messages to be added to the database. The
1907 * recommended usage is as follows:
1909 * o Read the mtime of a directory from the filesystem
1911 * o Call add_message for all mail files in the directory
1913 * o Call notmuch_directory_set_mtime with the mtime read from the
1916 * Then, when wanting to check for updates to the directory in the
1917 * future, the client can call notmuch_directory_get_mtime and know
1918 * that it only needs to add files if the mtime of the directory and
1919 * files are newer than the stored timestamp.
1921 * Note: The notmuch_directory_get_mtime function does not allow the
1922 * caller to distinguish a timestamp of 0 from a non-existent
1923 * timestamp. So don't store a timestamp of 0 unless you are
1924 * comfortable with that.
1928 * NOTMUCH_STATUS_SUCCESS: mtime successfully stored in database.
1930 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception
1931 * occurred, mtime not stored.
1933 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
1934 * mode so directory mtime cannot be modified.
1937 notmuch_directory_set_mtime (notmuch_directory_t *directory,
1941 * Get the mtime of a directory, (as previously stored with
1942 * notmuch_directory_set_mtime).
1944 * Returns 0 if no mtime has previously been stored for this
1948 notmuch_directory_get_mtime (notmuch_directory_t *directory);
1951 * Get a notmuch_filenames_t iterator listing all the filenames of
1952 * messages in the database within the given directory.
1954 * The returned filenames will be the basename-entries only (not
1957 notmuch_filenames_t *
1958 notmuch_directory_get_child_files (notmuch_directory_t *directory);
1961 * Get a notmuch_filenames_t iterator listing all the filenames of
1962 * sub-directories in the database within the given directory.
1964 * The returned filenames will be the basename-entries only (not
1967 notmuch_filenames_t *
1968 notmuch_directory_get_child_directories (notmuch_directory_t *directory);
1971 * Delete directory document from the database, and destroy the
1972 * notmuch_directory_t object. Assumes any child directories and files
1973 * have been deleted by the caller.
1975 * @since libnotmuch 4.3 (notmuch 0.21)
1978 notmuch_directory_delete (notmuch_directory_t *directory);
1981 * Destroy a notmuch_directory_t object.
1984 notmuch_directory_destroy (notmuch_directory_t *directory);
1987 * Is the given 'filenames' iterator pointing at a valid filename.
1989 * When this function returns TRUE, notmuch_filenames_get will return
1990 * a valid string. Whereas when this function returns FALSE,
1991 * notmuch_filenames_get will return NULL.
1993 * It is acceptable to pass NULL for 'filenames', in which case this
1994 * function will always return FALSE.
1997 notmuch_filenames_valid (notmuch_filenames_t *filenames);
2000 * Get the current filename from 'filenames' as a string.
2002 * Note: The returned string belongs to 'filenames' and has a lifetime
2003 * identical to it (and the directory to which it ultimately belongs).
2005 * It is acceptable to pass NULL for 'filenames', in which case this
2006 * function will always return NULL.
2009 notmuch_filenames_get (notmuch_filenames_t *filenames);
2012 * Move the 'filenames' iterator to the next filename.
2014 * If 'filenames' is already pointing at the last filename then the
2015 * iterator will be moved to a point just beyond that last filename,
2016 * (where notmuch_filenames_valid will return FALSE and
2017 * notmuch_filenames_get will return NULL).
2019 * It is acceptable to pass NULL for 'filenames', in which case this
2020 * function will do nothing.
2023 notmuch_filenames_move_to_next (notmuch_filenames_t *filenames);
2026 * Destroy a notmuch_filenames_t object.
2028 * It's not strictly necessary to call this function. All memory from
2029 * the notmuch_filenames_t object will be reclaimed when the
2030 * containing directory object is destroyed.
2032 * It is acceptable to pass NULL for 'filenames', in which case this
2033 * function will do nothing.
2036 notmuch_filenames_destroy (notmuch_filenames_t *filenames);
2040 * set config 'key' to 'value'
2042 * @since libnotmuch 4.4 (notmuch 0.23)
2045 notmuch_database_set_config (notmuch_database_t *db, const char *key, const char *value);
2048 * retrieve config item 'key', assign to 'value'
2050 * keys which have not been previously set with n_d_set_config will
2051 * return an empty string.
2053 * return value is allocated by malloc and should be freed by the
2056 * @since libnotmuch 4.4 (notmuch 0.23)
2059 notmuch_database_get_config (notmuch_database_t *db, const char *key, char **value);
2062 * Create an iterator for all config items with keys matching a given prefix
2064 * @since libnotmuch 4.4 (notmuch 0.23)
2067 notmuch_database_get_config_list (notmuch_database_t *db, const char *prefix, notmuch_config_list_t **out);
2070 * Is 'config_list' iterator valid (i.e. _key, _value, _move_to_next can be called).
2072 * @since libnotmuch 4.4 (notmuch 0.23)
2075 notmuch_config_list_valid (notmuch_config_list_t *config_list);
2078 * return key for current config pair
2080 * return value is owned by the iterator, and will be destroyed by the
2081 * next call to notmuch_config_list_key or notmuch_config_list_destroy.
2083 * @since libnotmuch 4.4 (notmuch 0.23)
2086 notmuch_config_list_key (notmuch_config_list_t *config_list);
2089 * return 'value' for current config pair
2091 * return value is owned by the iterator, and will be destroyed by the
2092 * next call to notmuch_config_list_value or notmuch config_list_destroy
2094 * @since libnotmuch 4.4 (notmuch 0.23)
2097 notmuch_config_list_value (notmuch_config_list_t *config_list);
2101 * move 'config_list' iterator to the next pair
2103 * @since libnotmuch 4.4 (notmuch 0.23)
2106 notmuch_config_list_move_to_next (notmuch_config_list_t *config_list);
2109 * free any resources held by 'config_list'
2111 * @since libnotmuch 4.4 (notmuch 0.23)
2114 notmuch_config_list_destroy (notmuch_config_list_t *config_list);
2117 * interrogate the library for compile time features
2119 * @since libnotmuch 4.4 (notmuch 0.23)
2122 notmuch_built_with (const char *name);
2125 #pragma GCC visibility pop