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
55 * The library version number. This must agree with the soname
56 * version in Makefile.local.
58 #define LIBNOTMUCH_MAJOR_VERSION 5
59 #define LIBNOTMUCH_MINOR_VERSION 0
60 #define LIBNOTMUCH_MICRO_VERSION 0
63 #if defined (__clang_major__) && __clang_major__ >= 3 \
64 || defined (__GNUC__) && __GNUC__ >= 5 \
65 || defined (__GNUC__) && __GNUC__ == 4 && __GNUC_MINOR__ >= 5
66 #define NOTMUCH_DEPRECATED(major,minor) \
67 __attribute__ ((deprecated ("function deprecated as of libnotmuch " #major "." #minor)))
69 #define NOTMUCH_DEPRECATED(major,minor) __attribute__ ((deprecated))
73 #endif /* __DOXYGEN__ */
76 * Check the version of the notmuch library being compiled against.
78 * Return true if the library being compiled against is of the
79 * specified version or above. For example:
82 * #if LIBNOTMUCH_CHECK_VERSION(3, 1, 0)
83 * (code requiring libnotmuch 3.1.0 or above)
87 * LIBNOTMUCH_CHECK_VERSION has been defined since version 3.1.0; to
88 * check for versions prior to that, use:
91 * #if !defined(NOTMUCH_CHECK_VERSION)
92 * (code requiring libnotmuch prior to 3.1.0)
96 #define LIBNOTMUCH_CHECK_VERSION(major, minor, micro) \
97 (LIBNOTMUCH_MAJOR_VERSION > (major) || \
98 (LIBNOTMUCH_MAJOR_VERSION == (major) && LIBNOTMUCH_MINOR_VERSION > (minor)) || \
99 (LIBNOTMUCH_MAJOR_VERSION == (major) && LIBNOTMUCH_MINOR_VERSION == (minor) && \
100 LIBNOTMUCH_MICRO_VERSION >= (micro)))
103 * Notmuch boolean type.
105 typedef int notmuch_bool_t;
108 * Status codes used for the return values of most functions.
110 * A zero value (NOTMUCH_STATUS_SUCCESS) indicates that the function
111 * completed without error. Any other value indicates an error.
113 typedef enum _notmuch_status {
117 NOTMUCH_STATUS_SUCCESS = 0,
121 NOTMUCH_STATUS_OUT_OF_MEMORY,
123 * An attempt was made to write to a database opened in read-only
126 NOTMUCH_STATUS_READ_ONLY_DATABASE,
128 * A Xapian exception occurred.
130 * @todo We don't really want to expose this lame XAPIAN_EXCEPTION
131 * value. Instead we should map to things like DATABASE_LOCKED or
134 NOTMUCH_STATUS_XAPIAN_EXCEPTION,
136 * An error occurred trying to read or write to a file (this could
137 * be file not found, permission denied, etc.)
139 NOTMUCH_STATUS_FILE_ERROR,
141 * A file was presented that doesn't appear to be an email
144 NOTMUCH_STATUS_FILE_NOT_EMAIL,
146 * A file contains a message ID that is identical to a message
147 * already in the database.
149 NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID,
151 * The user erroneously passed a NULL pointer to a notmuch
154 NOTMUCH_STATUS_NULL_POINTER,
156 * A tag value is too long (exceeds NOTMUCH_TAG_MAX).
158 NOTMUCH_STATUS_TAG_TOO_LONG,
160 * The notmuch_message_thaw function has been called more times
161 * than notmuch_message_freeze.
163 NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW,
165 * notmuch_database_end_atomic has been called more times than
166 * notmuch_database_begin_atomic.
168 NOTMUCH_STATUS_UNBALANCED_ATOMIC,
170 * The operation is not supported.
172 NOTMUCH_STATUS_UNSUPPORTED_OPERATION,
174 * The operation requires a database upgrade.
176 NOTMUCH_STATUS_UPGRADE_REQUIRED,
178 * There is a problem with the proposed path, e.g. a relative path
179 * passed to a function expecting an absolute path.
181 NOTMUCH_STATUS_PATH_ERROR,
183 * The requested operation was ignored. Depending on the function,
184 * this may not be an actual error.
186 NOTMUCH_STATUS_IGNORED,
188 * One of the arguments violates the preconditions for the
189 * function, in a way not covered by a more specific argument.
191 NOTMUCH_STATUS_ILLEGAL_ARGUMENT,
193 * Not an actual status value. Just a way to find out how many
194 * valid status values there are.
196 NOTMUCH_STATUS_LAST_STATUS
200 * Get a string representation of a notmuch_status_t value.
202 * The result is read-only.
205 notmuch_status_to_string (notmuch_status_t status);
207 /* Various opaque data types. For each notmuch_<foo>_t see the various
208 * notmuch_<foo> functions below. */
210 typedef struct _notmuch_database notmuch_database_t;
211 typedef struct _notmuch_query notmuch_query_t;
212 typedef struct _notmuch_threads notmuch_threads_t;
213 typedef struct _notmuch_thread notmuch_thread_t;
214 typedef struct _notmuch_messages notmuch_messages_t;
215 typedef struct _notmuch_message notmuch_message_t;
216 typedef struct _notmuch_tags notmuch_tags_t;
217 typedef struct _notmuch_directory notmuch_directory_t;
218 typedef struct _notmuch_filenames notmuch_filenames_t;
219 typedef struct _notmuch_config_list notmuch_config_list_t;
220 #endif /* __DOXYGEN__ */
223 * Create a new, empty notmuch database located at 'path'.
225 * The path should be a top-level directory to a collection of
226 * plain-text email messages (one message per file). This call will
227 * create a new ".notmuch" directory within 'path' where notmuch will
230 * After a successful call to notmuch_database_create, the returned
231 * database will be open so the caller should call
232 * notmuch_database_destroy when finished with it.
234 * The database will not yet have any data in it
235 * (notmuch_database_create itself is a very cheap function). Messages
236 * contained within 'path' can be added to the database by calling
237 * notmuch_database_add_message.
239 * In case of any failure, this function returns an error status and
240 * sets *database to NULL (after printing an error message on stderr).
244 * NOTMUCH_STATUS_SUCCESS: Successfully created the database.
246 * NOTMUCH_STATUS_NULL_POINTER: The given 'path' argument is NULL.
248 * NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory.
250 * NOTMUCH_STATUS_FILE_ERROR: An error occurred trying to create the
251 * database file (such as permission denied, or file not found,
252 * etc.), or the database already exists.
254 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred.
257 notmuch_database_create (const char *path, notmuch_database_t **database);
260 * Like notmuch_database_create, except optionally return an error
261 * message. This message is allocated by malloc and should be freed by
265 notmuch_database_create_verbose (const char *path,
266 notmuch_database_t **database,
267 char **error_message);
270 * Database open mode for notmuch_database_open.
274 * Open database for reading only.
276 NOTMUCH_DATABASE_MODE_READ_ONLY = 0,
278 * Open database for reading and writing.
280 NOTMUCH_DATABASE_MODE_READ_WRITE
281 } notmuch_database_mode_t;
284 * Open an existing notmuch database located at 'path'.
286 * The database should have been created at some time in the past,
287 * (not necessarily by this process), by calling
288 * notmuch_database_create with 'path'. By default the database should be
289 * opened for reading only. In order to write to the database you need to
290 * pass the NOTMUCH_DATABASE_MODE_READ_WRITE mode.
292 * An existing notmuch database can be identified by the presence of a
293 * directory named ".notmuch" below 'path'.
295 * The caller should call notmuch_database_destroy when finished with
298 * In case of any failure, this function returns an error status and
299 * sets *database to NULL (after printing an error message on stderr).
303 * NOTMUCH_STATUS_SUCCESS: Successfully opened the database.
305 * NOTMUCH_STATUS_NULL_POINTER: The given 'path' argument is NULL.
307 * NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory.
309 * NOTMUCH_STATUS_FILE_ERROR: An error occurred trying to open the
310 * database file (such as permission denied, or file not found,
311 * etc.), or the database version is unknown.
313 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred.
316 notmuch_database_open (const char *path,
317 notmuch_database_mode_t mode,
318 notmuch_database_t **database);
320 * Like notmuch_database_open, except optionally return an error
321 * message. This message is allocated by malloc and should be freed by
326 notmuch_database_open_verbose (const char *path,
327 notmuch_database_mode_t mode,
328 notmuch_database_t **database,
329 char **error_message);
332 * Retrieve last status string for given database.
336 notmuch_database_status_string (const notmuch_database_t *notmuch);
339 * Commit changes and close the given notmuch database.
341 * After notmuch_database_close has been called, calls to other
342 * functions on objects derived from this database may either behave
343 * as if the database had not been closed (e.g., if the required data
344 * has been cached) or may fail with a
345 * NOTMUCH_STATUS_XAPIAN_EXCEPTION. The only further operation
346 * permitted on the database itself is to call
347 * notmuch_database_destroy.
349 * notmuch_database_close can be called multiple times. Later calls
352 * For writable databases, notmuch_database_close commits all changes
353 * to disk before closing the database. If the caller is currently in
354 * an atomic section (there was a notmuch_database_begin_atomic
355 * without a matching notmuch_database_end_atomic), this will discard
356 * changes made in that atomic section (but still commit changes made
357 * prior to entering the atomic section).
361 * NOTMUCH_STATUS_SUCCESS: Successfully closed the database.
363 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred; the
364 * database has been closed but there are no guarantees the
365 * changes to the database, if any, have been flushed to disk.
368 notmuch_database_close (notmuch_database_t *database);
371 * A callback invoked by notmuch_database_compact to notify the user
372 * of the progress of the compaction process.
374 typedef void (*notmuch_compact_status_cb_t)(const char *message, void *closure);
377 * Compact a notmuch database, backing up the original database to the
380 * The database will be opened with NOTMUCH_DATABASE_MODE_READ_WRITE
381 * during the compaction process to ensure no writes are made.
383 * If the optional callback function 'status_cb' is non-NULL, it will
384 * be called with diagnostic and informational messages. The argument
385 * 'closure' is passed verbatim to any callback invoked.
388 notmuch_database_compact (const char* path,
389 const char* backup_path,
390 notmuch_compact_status_cb_t status_cb,
394 * Destroy the notmuch database, closing it if necessary and freeing
395 * all associated resources.
397 * Return value as in notmuch_database_close if the database was open;
398 * notmuch_database_destroy itself has no failure modes.
401 notmuch_database_destroy (notmuch_database_t *database);
404 * Return the database path of the given database.
406 * The return value is a string owned by notmuch so should not be
407 * modified nor freed by the caller.
410 notmuch_database_get_path (notmuch_database_t *database);
413 * Return the database format version of the given database.
416 notmuch_database_get_version (notmuch_database_t *database);
419 * Can the database be upgraded to a newer database version?
421 * If this function returns TRUE, then the caller may call
422 * notmuch_database_upgrade to upgrade the database. If the caller
423 * does not upgrade an out-of-date database, then some functions may
424 * fail with NOTMUCH_STATUS_UPGRADE_REQUIRED. This always returns
425 * FALSE for a read-only database because there's no way to upgrade a
426 * read-only database.
429 notmuch_database_needs_upgrade (notmuch_database_t *database);
432 * Upgrade the current database to the latest supported version.
434 * This ensures that all current notmuch functionality will be
435 * available on the database. After opening a database in read-write
436 * mode, it is recommended that clients check if an upgrade is needed
437 * (notmuch_database_needs_upgrade) and if so, upgrade with this
438 * function before making any modifications. If
439 * notmuch_database_needs_upgrade returns FALSE, this will be a no-op.
441 * The optional progress_notify callback can be used by the caller to
442 * provide progress indication to the user. If non-NULL it will be
443 * called periodically with 'progress' as a floating-point value in
444 * the range of [0.0 .. 1.0] indicating the progress made so far in
445 * the upgrade process. The argument 'closure' is passed verbatim to
446 * any callback invoked.
449 notmuch_database_upgrade (notmuch_database_t *database,
450 void (*progress_notify) (void *closure,
455 * Begin an atomic database operation.
457 * Any modifications performed between a successful begin and a
458 * notmuch_database_end_atomic will be applied to the database
459 * atomically. Note that, unlike a typical database transaction, this
460 * only ensures atomicity, not durability; neither begin nor end
461 * necessarily flush modifications to disk.
463 * Atomic sections may be nested. begin_atomic and end_atomic must
464 * always be called in pairs.
468 * NOTMUCH_STATUS_SUCCESS: Successfully entered atomic section.
470 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred;
471 * atomic section not entered.
474 notmuch_database_begin_atomic (notmuch_database_t *notmuch);
477 * Indicate the end of an atomic database operation.
481 * NOTMUCH_STATUS_SUCCESS: Successfully completed atomic section.
483 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred;
484 * atomic section not ended.
486 * NOTMUCH_STATUS_UNBALANCED_ATOMIC: The database is not currently in
490 notmuch_database_end_atomic (notmuch_database_t *notmuch);
493 * Return the committed database revision and UUID.
495 * The database revision number increases monotonically with each
496 * commit to the database. Hence, all messages and message changes
497 * committed to the database (that is, visible to readers) have a last
498 * modification revision <= the committed database revision. Any
499 * messages committed in the future will be assigned a modification
500 * revision > the committed database revision.
502 * The UUID is a NUL-terminated opaque string that uniquely identifies
503 * this database. Two revision numbers are only comparable if they
504 * have the same database UUID.
507 notmuch_database_get_revision (notmuch_database_t *notmuch,
511 * Retrieve a directory object from the database for 'path'.
513 * Here, 'path' should be a path relative to the path of 'database'
514 * (see notmuch_database_get_path), or else should be an absolute path
515 * with initial components that match the path of 'database'.
517 * If this directory object does not exist in the database, this
518 * returns NOTMUCH_STATUS_SUCCESS and sets *directory to NULL.
520 * Otherwise the returned directory object is owned by the database
521 * and as such, will only be valid until notmuch_database_destroy is
526 * NOTMUCH_STATUS_SUCCESS: Successfully retrieved directory.
528 * NOTMUCH_STATUS_NULL_POINTER: The given 'directory' argument is NULL.
530 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred;
531 * directory not retrieved.
533 * NOTMUCH_STATUS_UPGRADE_REQUIRED: The caller must upgrade the
534 * database to use this function.
537 notmuch_database_get_directory (notmuch_database_t *database,
539 notmuch_directory_t **directory);
542 * Add a new message to the given notmuch database or associate an
543 * additional filename with an existing message.
545 * Here, 'filename' should be a path relative to the path of
546 * 'database' (see notmuch_database_get_path), or else should be an
547 * absolute filename with initial components that match the path of
550 * The file should be a single mail message (not a multi-message mbox)
551 * that is expected to remain at its current location, (since the
552 * notmuch database will reference the filename, and will not copy the
553 * entire contents of the file.
555 * If another message with the same message ID already exists in the
556 * database, rather than creating a new message, this adds 'filename'
557 * to the list of the filenames for the existing message.
559 * If 'message' is not NULL, then, on successful return
560 * (NOTMUCH_STATUS_SUCCESS or NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID) '*message'
561 * will be initialized to a message object that can be used for things
562 * such as adding tags to the just-added message. The user should call
563 * notmuch_message_destroy when done with the message. On any failure
564 * '*message' will be set to NULL.
568 * NOTMUCH_STATUS_SUCCESS: Message successfully added to database.
570 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred,
573 * NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID: Message has the same message
574 * ID as another message already in the database. The new
575 * filename was successfully added to the message in the database
576 * (if not already present) and the existing message is returned.
578 * NOTMUCH_STATUS_FILE_ERROR: an error occurred trying to open the
579 * file, (such as permission denied, or file not found,
580 * etc.). Nothing added to the database.
582 * NOTMUCH_STATUS_FILE_NOT_EMAIL: the contents of filename don't look
583 * like an email message. Nothing added to the database.
585 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
586 * mode so no message can be added.
588 * NOTMUCH_STATUS_UPGRADE_REQUIRED: The caller must upgrade the
589 * database to use this function.
592 notmuch_database_add_message (notmuch_database_t *database,
593 const char *filename,
594 notmuch_message_t **message);
597 * Remove a message filename from the given notmuch database. If the
598 * message has no more filenames, remove the message.
600 * If the same message (as determined by the message ID) is still
601 * available via other filenames, then the message will persist in the
602 * database for those filenames. When the last filename is removed for
603 * a particular message, the database content for that message will be
608 * NOTMUCH_STATUS_SUCCESS: The last filename was removed and the
609 * message was removed from the database.
611 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred,
612 * message not removed.
614 * NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID: This filename was removed but
615 * the message persists in the database with at least one other
618 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
619 * mode so no message can be removed.
621 * NOTMUCH_STATUS_UPGRADE_REQUIRED: The caller must upgrade the
622 * database to use this function.
625 notmuch_database_remove_message (notmuch_database_t *database,
626 const char *filename);
629 * Find a message with the given message_id.
631 * If a message with the given message_id is found then, on successful return
632 * (NOTMUCH_STATUS_SUCCESS) '*message' will be initialized to a message
633 * object. The caller should call notmuch_message_destroy when done with the
636 * On any failure or when the message is not found, this function initializes
637 * '*message' to NULL. This means, when NOTMUCH_STATUS_SUCCESS is returned, the
638 * caller is supposed to check '*message' for NULL to find out whether the
639 * message with the given message_id was found.
643 * NOTMUCH_STATUS_SUCCESS: Successful return, check '*message'.
645 * NOTMUCH_STATUS_NULL_POINTER: The given 'message' argument is NULL
647 * NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory, creating message object
649 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred
652 notmuch_database_find_message (notmuch_database_t *database,
653 const char *message_id,
654 notmuch_message_t **message);
657 * Find a message with the given filename.
659 * If the database contains a message with the given filename then, on
660 * successful return (NOTMUCH_STATUS_SUCCESS) '*message' will be initialized to
661 * a message object. The caller should call notmuch_message_destroy when done
664 * On any failure or when the message is not found, this function initializes
665 * '*message' to NULL. This means, when NOTMUCH_STATUS_SUCCESS is returned, the
666 * caller is supposed to check '*message' for NULL to find out whether the
667 * message with the given filename is found.
671 * NOTMUCH_STATUS_SUCCESS: Successful return, check '*message'
673 * NOTMUCH_STATUS_NULL_POINTER: The given 'message' argument is NULL
675 * NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory, creating the message object
677 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred
679 * NOTMUCH_STATUS_UPGRADE_REQUIRED: The caller must upgrade the
680 * database to use this function.
683 notmuch_database_find_message_by_filename (notmuch_database_t *notmuch,
684 const char *filename,
685 notmuch_message_t **message);
688 * Return a list of all tags found in the database.
690 * This function creates a list of all tags found in the database. The
691 * resulting list contains all tags from all messages found in the database.
693 * On error this function returns NULL.
696 notmuch_database_get_all_tags (notmuch_database_t *db);
699 * Create a new query for 'database'.
701 * Here, 'database' should be an open database, (see
702 * notmuch_database_open and notmuch_database_create).
704 * For the query string, we'll document the syntax here more
705 * completely in the future, but it's likely to be a specialized
706 * version of the general Xapian query syntax:
708 * https://xapian.org/docs/queryparser.html
710 * As a special case, passing either a length-zero string, (that is ""),
711 * or a string consisting of a single asterisk (that is "*"), will
712 * result in a query that returns all messages in the database.
714 * See notmuch_query_set_sort for controlling the order of results.
715 * See notmuch_query_search_messages and notmuch_query_search_threads
716 * to actually execute the query.
718 * User should call notmuch_query_destroy when finished with this
721 * Will return NULL if insufficient memory is available.
724 notmuch_query_create (notmuch_database_t *database,
725 const char *query_string);
728 * Sort values for notmuch_query_set_sort.
734 NOTMUCH_SORT_OLDEST_FIRST,
738 NOTMUCH_SORT_NEWEST_FIRST,
740 * Sort by message-id.
742 NOTMUCH_SORT_MESSAGE_ID,
746 NOTMUCH_SORT_UNSORTED
750 * Return the query_string of this query. See notmuch_query_create.
753 notmuch_query_get_query_string (const notmuch_query_t *query);
756 * Return the notmuch database of this query. See notmuch_query_create.
759 notmuch_query_get_database (const notmuch_query_t *query);
762 * Exclude values for notmuch_query_set_omit_excluded. The strange
763 * order is to maintain backward compatibility: the old FALSE/TRUE
764 * options correspond to the new
765 * NOTMUCH_EXCLUDE_FLAG/NOTMUCH_EXCLUDE_TRUE options.
768 NOTMUCH_EXCLUDE_FLAG,
769 NOTMUCH_EXCLUDE_TRUE,
770 NOTMUCH_EXCLUDE_FALSE,
775 * Specify whether to omit excluded results or simply flag them. By
776 * default, this is set to TRUE.
778 * If set to TRUE or ALL, notmuch_query_search_messages will omit excluded
779 * messages from the results, and notmuch_query_search_threads will omit
780 * threads that match only in excluded messages. If set to TRUE,
781 * notmuch_query_search_threads will include all messages in threads that
782 * match in at least one non-excluded message. Otherwise, if set to ALL,
783 * notmuch_query_search_threads will omit excluded messages from all threads.
785 * If set to FALSE or FLAG then both notmuch_query_search_messages and
786 * notmuch_query_search_threads will return all matching
787 * messages/threads regardless of exclude status. If set to FLAG then
788 * the exclude flag will be set for any excluded message that is
789 * returned by notmuch_query_search_messages, and the thread counts
790 * for threads returned by notmuch_query_search_threads will be the
791 * number of non-excluded messages/matches. Otherwise, if set to
792 * FALSE, then the exclude status is completely ignored.
794 * The performance difference when calling
795 * notmuch_query_search_messages should be relatively small (and both
796 * should be very fast). However, in some cases,
797 * notmuch_query_search_threads is very much faster when omitting
798 * excluded messages as it does not need to construct the threads that
799 * only match in excluded messages.
802 notmuch_query_set_omit_excluded (notmuch_query_t *query,
803 notmuch_exclude_t omit_excluded);
806 * Specify the sorting desired for this query.
809 notmuch_query_set_sort (notmuch_query_t *query, notmuch_sort_t sort);
812 * Return the sort specified for this query. See
813 * notmuch_query_set_sort.
816 notmuch_query_get_sort (const notmuch_query_t *query);
819 * Add a tag that will be excluded from the query results by default.
820 * This exclusion will be ignored if this tag appears explicitly in
825 * NOTMUCH_STATUS_SUCCESS: excluded was added successfully.
827 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: a Xapian exception occured.
828 * Most likely a problem lazily parsing the query string.
830 * NOTMUCH_STATUS_IGNORED: tag is explicitely present in the query, so
834 notmuch_query_add_tag_exclude (notmuch_query_t *query, const char *tag);
837 * Execute a query for threads, returning a notmuch_threads_t object
838 * which can be used to iterate over the results. The returned threads
839 * object is owned by the query and as such, will only be valid until
840 * notmuch_query_destroy.
842 * Typical usage might be:
844 * notmuch_query_t *query;
845 * notmuch_threads_t *threads;
846 * notmuch_thread_t *thread;
848 * query = notmuch_query_create (database, query_string);
850 * for (threads = notmuch_query_search_threads (query);
851 * notmuch_threads_valid (threads);
852 * notmuch_threads_move_to_next (threads))
854 * thread = notmuch_threads_get (threads);
856 * notmuch_thread_destroy (thread);
859 * notmuch_query_destroy (query);
861 * Note: If you are finished with a thread before its containing
862 * query, you can call notmuch_thread_destroy to clean up some memory
863 * sooner (as in the above example). Otherwise, if your thread objects
864 * are long-lived, then you don't need to call notmuch_thread_destroy
865 * and all the memory will still be reclaimed when the query is
868 * Note that there's no explicit destructor needed for the
869 * notmuch_threads_t object. (For consistency, we do provide a
870 * notmuch_threads_destroy function, but there's no good reason
871 * to call it if the query is about to be destroyed).
873 * @since libnotmuch 5.0 (notmuch 0.25)
876 notmuch_query_search_threads (notmuch_query_t *query,
877 notmuch_threads_t **out);
880 * Deprecated alias for notmuch_query_search_threads.
882 * @deprecated Deprecated as of libnotmuch 5 (notmuch 0.25). Please
883 * use notmuch_query_search_threads instead.
886 NOTMUCH_DEPRECATED(5,0)
888 notmuch_query_search_threads_st (notmuch_query_t *query, notmuch_threads_t **out);
891 * Execute a query for messages, returning a notmuch_messages_t object
892 * which can be used to iterate over the results. The returned
893 * messages object is owned by the query and as such, will only be
894 * valid until notmuch_query_destroy.
896 * Typical usage might be:
898 * notmuch_query_t *query;
899 * notmuch_messages_t *messages;
900 * notmuch_message_t *message;
902 * query = notmuch_query_create (database, query_string);
904 * for (messages = notmuch_query_search_messages (query);
905 * notmuch_messages_valid (messages);
906 * notmuch_messages_move_to_next (messages))
908 * message = notmuch_messages_get (messages);
910 * notmuch_message_destroy (message);
913 * notmuch_query_destroy (query);
915 * Note: If you are finished with a message before its containing
916 * query, you can call notmuch_message_destroy to clean up some memory
917 * sooner (as in the above example). Otherwise, if your message
918 * objects are long-lived, then you don't need to call
919 * notmuch_message_destroy and all the memory will still be reclaimed
920 * when the query is destroyed.
922 * Note that there's no explicit destructor needed for the
923 * notmuch_messages_t object. (For consistency, we do provide a
924 * notmuch_messages_destroy function, but there's no good
925 * reason to call it if the query is about to be destroyed).
927 * If a Xapian exception occurs this function will return NULL.
929 * @since libnotmuch 5 (notmuch 0.25)
932 notmuch_query_search_messages (notmuch_query_t *query,
933 notmuch_messages_t **out);
935 * Deprecated alias for notmuch_query_search_messages
937 * @deprecated Deprecated as of libnotmuch 5 (notmuch 0.25). Please use
938 * notmuch_query_search_messages instead.
942 NOTMUCH_DEPRECATED(5,0)
944 notmuch_query_search_messages_st (notmuch_query_t *query,
945 notmuch_messages_t **out);
948 * Destroy a notmuch_query_t along with any associated resources.
950 * This will in turn destroy any notmuch_threads_t and
951 * notmuch_messages_t objects generated by this query, (and in
952 * turn any notmuch_thread_t and notmuch_message_t objects generated
953 * from those results, etc.), if such objects haven't already been
957 notmuch_query_destroy (notmuch_query_t *query);
960 * Is the given 'threads' iterator pointing at a valid thread.
962 * When this function returns TRUE, notmuch_threads_get will return a
963 * valid object. Whereas when this function returns FALSE,
964 * notmuch_threads_get will return NULL.
966 * If passed a NULL pointer, this function returns FALSE
968 * See the documentation of notmuch_query_search_threads for example
969 * code showing how to iterate over a notmuch_threads_t object.
972 notmuch_threads_valid (notmuch_threads_t *threads);
975 * Get the current thread from 'threads' as a notmuch_thread_t.
977 * Note: The returned thread belongs to 'threads' and has a lifetime
978 * identical to it (and the query to which it belongs).
980 * See the documentation of notmuch_query_search_threads for example
981 * code showing how to iterate over a notmuch_threads_t object.
983 * If an out-of-memory situation occurs, this function will return
987 notmuch_threads_get (notmuch_threads_t *threads);
990 * Move the 'threads' iterator to the next thread.
992 * If 'threads' is already pointing at the last thread then the
993 * iterator will be moved to a point just beyond that last thread,
994 * (where notmuch_threads_valid will return FALSE and
995 * notmuch_threads_get will return NULL).
997 * See the documentation of notmuch_query_search_threads for example
998 * code showing how to iterate over a notmuch_threads_t object.
1001 notmuch_threads_move_to_next (notmuch_threads_t *threads);
1004 * Destroy a notmuch_threads_t object.
1006 * It's not strictly necessary to call this function. All memory from
1007 * the notmuch_threads_t object will be reclaimed when the
1008 * containing query object is destroyed.
1011 notmuch_threads_destroy (notmuch_threads_t *threads);
1014 * Return the number of messages matching a search.
1016 * This function performs a search and returns the number of matching
1021 * NOTMUCH_STATUS_SUCCESS: query completed successfully.
1023 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: a Xapian exception occured. The
1024 * value of *count is not defined.
1026 * @since libnotmuch 5 (notmuch 0.25)
1029 notmuch_query_count_messages (notmuch_query_t *query, unsigned int *count);
1032 * Deprecated alias for notmuch_query_count_messages
1035 * @deprecated Deprecated since libnotmuch 5.0 (notmuch 0.25). Please
1036 * use notmuch_query_count_messages instead.
1038 NOTMUCH_DEPRECATED(5,0)
1040 notmuch_query_count_messages_st (notmuch_query_t *query, unsigned int *count);
1043 * Return the number of threads matching a search.
1045 * This function performs a search and returns the number of unique thread IDs
1046 * in the matching messages. This is the same as number of threads matching a
1049 * Note that this is a significantly heavier operation than
1050 * notmuch_query_count_messages{_st}().
1054 * NOTMUCH_STATUS_OUT_OF_MEMORY: Memory allocation failed. The value
1055 * of *count is not defined
1057 * NOTMUCH_STATUS_SUCCESS: query completed successfully.
1059 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: a Xapian exception occured. The
1060 * value of *count is not defined.
1062 * @since libnotmuch 5 (notmuch 0.25)
1065 notmuch_query_count_threads (notmuch_query_t *query, unsigned *count);
1068 * Deprecated alias for notmuch_query_count_threads
1070 * @deprecated Deprecated as of libnotmuch 5.0 (notmuch 0.25). Please
1071 * use notmuch_query_count_threads_st instead.
1073 NOTMUCH_DEPRECATED(5,0)
1075 notmuch_query_count_threads_st (notmuch_query_t *query, unsigned *count);
1078 * Get the thread ID of 'thread'.
1080 * The returned string belongs to 'thread' and as such, should not be
1081 * modified by the caller and will only be valid for as long as the
1082 * thread is valid, (which is until notmuch_thread_destroy or until
1083 * the query from which it derived is destroyed).
1086 notmuch_thread_get_thread_id (notmuch_thread_t *thread);
1089 * Get the total number of messages in 'thread'.
1091 * This count consists of all messages in the database belonging to
1092 * this thread. Contrast with notmuch_thread_get_matched_messages() .
1095 notmuch_thread_get_total_messages (notmuch_thread_t *thread);
1098 * Get a notmuch_messages_t iterator for the top-level messages in
1099 * 'thread' in oldest-first order.
1101 * This iterator will not necessarily iterate over all of the messages
1102 * in the thread. It will only iterate over the messages in the thread
1103 * which are not replies to other messages in the thread.
1105 * The returned list will be destroyed when the thread is destroyed.
1107 notmuch_messages_t *
1108 notmuch_thread_get_toplevel_messages (notmuch_thread_t *thread);
1111 * Get a notmuch_thread_t iterator for all messages in 'thread' in
1112 * oldest-first order.
1114 * The returned list will be destroyed when the thread is destroyed.
1116 notmuch_messages_t *
1117 notmuch_thread_get_messages (notmuch_thread_t *thread);
1120 * Get the number of messages in 'thread' that matched the search.
1122 * This count includes only the messages in this thread that were
1123 * matched by the search from which the thread was created and were
1124 * not excluded by any exclude tags passed in with the query (see
1125 * notmuch_query_add_tag_exclude). Contrast with
1126 * notmuch_thread_get_total_messages() .
1129 notmuch_thread_get_matched_messages (notmuch_thread_t *thread);
1132 * Get the authors of 'thread' as a UTF-8 string.
1134 * The returned string is a comma-separated list of the names of the
1135 * authors of mail messages in the query results that belong to this
1138 * The string contains authors of messages matching the query first, then
1139 * non-matched authors (with the two groups separated by '|'). Within
1140 * each group, authors are ordered by date.
1142 * The returned string belongs to 'thread' and as such, should not be
1143 * modified by the caller and will only be valid for as long as the
1144 * thread is valid, (which is until notmuch_thread_destroy or until
1145 * the query from which it derived is destroyed).
1148 notmuch_thread_get_authors (notmuch_thread_t *thread);
1151 * Get the subject of 'thread' as a UTF-8 string.
1153 * The subject is taken from the first message (according to the query
1154 * order---see notmuch_query_set_sort) in the query results that
1155 * belongs to this thread.
1157 * The returned string belongs to 'thread' and as such, should not be
1158 * modified by the caller and will only be valid for as long as the
1159 * thread is valid, (which is until notmuch_thread_destroy or until
1160 * the query from which it derived is destroyed).
1163 notmuch_thread_get_subject (notmuch_thread_t *thread);
1166 * Get the date of the oldest message in 'thread' as a time_t value.
1169 notmuch_thread_get_oldest_date (notmuch_thread_t *thread);
1172 * Get the date of the newest message in 'thread' as a time_t value.
1175 notmuch_thread_get_newest_date (notmuch_thread_t *thread);
1178 * Get the tags for 'thread', returning a notmuch_tags_t object which
1179 * can be used to iterate over all tags.
1181 * Note: In the Notmuch database, tags are stored on individual
1182 * messages, not on threads. So the tags returned here will be all
1183 * tags of the messages which matched the search and which belong to
1186 * The tags object is owned by the thread and as such, will only be
1187 * valid for as long as the thread is valid, (for example, until
1188 * notmuch_thread_destroy or until the query from which it derived is
1191 * Typical usage might be:
1193 * notmuch_thread_t *thread;
1194 * notmuch_tags_t *tags;
1197 * thread = notmuch_threads_get (threads);
1199 * for (tags = notmuch_thread_get_tags (thread);
1200 * notmuch_tags_valid (tags);
1201 * notmuch_tags_move_to_next (tags))
1203 * tag = notmuch_tags_get (tags);
1207 * notmuch_thread_destroy (thread);
1209 * Note that there's no explicit destructor needed for the
1210 * notmuch_tags_t object. (For consistency, we do provide a
1211 * notmuch_tags_destroy function, but there's no good reason to call
1212 * it if the message is about to be destroyed).
1215 notmuch_thread_get_tags (notmuch_thread_t *thread);
1218 * Destroy a notmuch_thread_t object.
1221 notmuch_thread_destroy (notmuch_thread_t *thread);
1224 * Is the given 'messages' iterator pointing at a valid message.
1226 * When this function returns TRUE, notmuch_messages_get will return a
1227 * valid object. Whereas when this function returns FALSE,
1228 * notmuch_messages_get will return NULL.
1230 * See the documentation of notmuch_query_search_messages for example
1231 * code showing how to iterate over a notmuch_messages_t object.
1234 notmuch_messages_valid (notmuch_messages_t *messages);
1237 * Get the current message from 'messages' as a notmuch_message_t.
1239 * Note: The returned message belongs to 'messages' and has a lifetime
1240 * identical to it (and the query to which it belongs).
1242 * See the documentation of notmuch_query_search_messages for example
1243 * code showing how to iterate over a notmuch_messages_t object.
1245 * If an out-of-memory situation occurs, this function will return
1249 notmuch_messages_get (notmuch_messages_t *messages);
1252 * Move the 'messages' iterator to the next message.
1254 * If 'messages' is already pointing at the last message then the
1255 * iterator will be moved to a point just beyond that last message,
1256 * (where notmuch_messages_valid will return FALSE and
1257 * notmuch_messages_get will return NULL).
1259 * See the documentation of notmuch_query_search_messages for example
1260 * code showing how to iterate over a notmuch_messages_t object.
1263 notmuch_messages_move_to_next (notmuch_messages_t *messages);
1266 * Destroy a notmuch_messages_t object.
1268 * It's not strictly necessary to call this function. All memory from
1269 * the notmuch_messages_t object will be reclaimed when the containing
1270 * query object is destroyed.
1273 notmuch_messages_destroy (notmuch_messages_t *messages);
1276 * Return a list of tags from all messages.
1278 * The resulting list is guaranteed not to contain duplicated tags.
1280 * WARNING: You can no longer iterate over messages after calling this
1281 * function, because the iterator will point at the end of the list.
1282 * We do not have a function to reset the iterator yet and the only
1283 * way how you can iterate over the list again is to recreate the
1286 * The function returns NULL on error.
1289 notmuch_messages_collect_tags (notmuch_messages_t *messages);
1292 * Get the message ID of 'message'.
1294 * The returned string belongs to 'message' and as such, should not be
1295 * modified by the caller and will only be valid for as long as the
1296 * message is valid, (which is until the query from which it derived
1299 * This function will not return NULL since Notmuch ensures that every
1300 * message has a unique message ID, (Notmuch will generate an ID for a
1301 * message if the original file does not contain one).
1304 notmuch_message_get_message_id (notmuch_message_t *message);
1307 * Get the thread ID of 'message'.
1309 * The returned string belongs to 'message' and as such, should not be
1310 * modified by the caller and will only be valid for as long as the
1311 * message is valid, (for example, until the user calls
1312 * notmuch_message_destroy on 'message' or until a query from which it
1313 * derived is destroyed).
1315 * This function will not return NULL since Notmuch ensures that every
1316 * message belongs to a single thread.
1319 notmuch_message_get_thread_id (notmuch_message_t *message);
1322 * Get a notmuch_messages_t iterator for all of the replies to
1325 * Note: This call only makes sense if 'message' was ultimately
1326 * obtained from a notmuch_thread_t object, (such as by coming
1327 * directly from the result of calling notmuch_thread_get_
1328 * toplevel_messages or by any number of subsequent
1329 * calls to notmuch_message_get_replies).
1331 * If 'message' was obtained through some non-thread means, (such as
1332 * by a call to notmuch_query_search_messages), then this function
1335 * If there are no replies to 'message', this function will return
1336 * NULL. (Note that notmuch_messages_valid will accept that NULL
1337 * value as legitimate, and simply return FALSE for it.)
1339 notmuch_messages_t *
1340 notmuch_message_get_replies (notmuch_message_t *message);
1343 * Get a filename for the email corresponding to 'message'.
1345 * The returned filename is an absolute filename, (the initial
1346 * component will match notmuch_database_get_path() ).
1348 * The returned string belongs to the message so should not be
1349 * modified or freed by the caller (nor should it be referenced after
1350 * the message is destroyed).
1352 * Note: If this message corresponds to multiple files in the mail
1353 * store, (that is, multiple files contain identical message IDs),
1354 * this function will arbitrarily return a single one of those
1355 * filenames. See notmuch_message_get_filenames for returning the
1356 * complete list of filenames.
1359 notmuch_message_get_filename (notmuch_message_t *message);
1362 * Get all filenames for the email corresponding to 'message'.
1364 * Returns a notmuch_filenames_t iterator listing all the filenames
1365 * associated with 'message'. These files may not have identical
1366 * content, but each will have the identical Message-ID.
1368 * Each filename in the iterator is an absolute filename, (the initial
1369 * component will match notmuch_database_get_path() ).
1371 notmuch_filenames_t *
1372 notmuch_message_get_filenames (notmuch_message_t *message);
1377 typedef enum _notmuch_message_flag {
1378 NOTMUCH_MESSAGE_FLAG_MATCH,
1379 NOTMUCH_MESSAGE_FLAG_EXCLUDED,
1381 /* This message is a "ghost message", meaning it has no filenames
1382 * or content, but we know it exists because it was referenced by
1383 * some other message. A ghost message has only a message ID and
1386 NOTMUCH_MESSAGE_FLAG_GHOST,
1387 } notmuch_message_flag_t;
1390 * Get a value of a flag for the email corresponding to 'message'.
1393 notmuch_message_get_flag (notmuch_message_t *message,
1394 notmuch_message_flag_t flag);
1397 * Set a value of a flag for the email corresponding to 'message'.
1400 notmuch_message_set_flag (notmuch_message_t *message,
1401 notmuch_message_flag_t flag, notmuch_bool_t value);
1404 * Get the date of 'message' as a time_t value.
1406 * For the original textual representation of the Date header from the
1407 * message call notmuch_message_get_header() with a header value of
1411 notmuch_message_get_date (notmuch_message_t *message);
1414 * Get the value of the specified header from 'message' as a UTF-8 string.
1416 * Common headers are stored in the database when the message is
1417 * indexed and will be returned from the database. Other headers will
1418 * be read from the actual message file.
1420 * The header name is case insensitive.
1422 * The returned string belongs to the message so should not be
1423 * modified or freed by the caller (nor should it be referenced after
1424 * the message is destroyed).
1426 * Returns an empty string ("") if the message does not contain a
1427 * header line matching 'header'. Returns NULL if any error occurs.
1430 notmuch_message_get_header (notmuch_message_t *message, const char *header);
1433 * Get the tags for 'message', returning a notmuch_tags_t object which
1434 * can be used to iterate over all tags.
1436 * The tags object is owned by the message and as such, will only be
1437 * valid for as long as the message is valid, (which is until the
1438 * query from which it derived is destroyed).
1440 * Typical usage might be:
1442 * notmuch_message_t *message;
1443 * notmuch_tags_t *tags;
1446 * message = notmuch_database_find_message (database, message_id);
1448 * for (tags = notmuch_message_get_tags (message);
1449 * notmuch_tags_valid (tags);
1450 * notmuch_tags_move_to_next (tags))
1452 * tag = notmuch_tags_get (tags);
1456 * notmuch_message_destroy (message);
1458 * Note that there's no explicit destructor needed for the
1459 * notmuch_tags_t object. (For consistency, we do provide a
1460 * notmuch_tags_destroy function, but there's no good reason to call
1461 * it if the message is about to be destroyed).
1464 notmuch_message_get_tags (notmuch_message_t *message);
1467 * The longest possible tag value.
1469 #define NOTMUCH_TAG_MAX 200
1472 * Add a tag to the given message.
1476 * NOTMUCH_STATUS_SUCCESS: Tag successfully added to message
1478 * NOTMUCH_STATUS_NULL_POINTER: The 'tag' argument is NULL
1480 * NOTMUCH_STATUS_TAG_TOO_LONG: The length of 'tag' is too long
1481 * (exceeds NOTMUCH_TAG_MAX)
1483 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
1484 * mode so message cannot be modified.
1487 notmuch_message_add_tag (notmuch_message_t *message, const char *tag);
1490 * Remove a tag from the given message.
1494 * NOTMUCH_STATUS_SUCCESS: Tag successfully removed from message
1496 * NOTMUCH_STATUS_NULL_POINTER: The 'tag' argument is NULL
1498 * NOTMUCH_STATUS_TAG_TOO_LONG: The length of 'tag' is too long
1499 * (exceeds NOTMUCH_TAG_MAX)
1501 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
1502 * mode so message cannot be modified.
1505 notmuch_message_remove_tag (notmuch_message_t *message, const char *tag);
1508 * Remove all tags from the given message.
1510 * See notmuch_message_freeze for an example showing how to safely
1511 * replace tag values.
1513 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
1514 * mode so message cannot be modified.
1517 notmuch_message_remove_all_tags (notmuch_message_t *message);
1520 * Add/remove tags according to maildir flags in the message filename(s).
1522 * This function examines the filenames of 'message' for maildir
1523 * flags, and adds or removes tags on 'message' as follows when these
1524 * flags are present:
1526 * Flag Action if present
1527 * ---- -----------------
1528 * 'D' Adds the "draft" tag to the message
1529 * 'F' Adds the "flagged" tag to the message
1530 * 'P' Adds the "passed" tag to the message
1531 * 'R' Adds the "replied" tag to the message
1532 * 'S' Removes the "unread" tag from the message
1534 * For each flag that is not present, the opposite action (add/remove)
1535 * is performed for the corresponding tags.
1537 * Flags are identified as trailing components of the filename after a
1538 * sequence of ":2,".
1540 * If there are multiple filenames associated with this message, the
1541 * flag is considered present if it appears in one or more
1542 * filenames. (That is, the flags from the multiple filenames are
1543 * combined with the logical OR operator.)
1545 * A client can ensure that notmuch database tags remain synchronized
1546 * with maildir flags by calling this function after each call to
1547 * notmuch_database_add_message. See also
1548 * notmuch_message_tags_to_maildir_flags for synchronizing tag changes
1549 * back to maildir flags.
1552 notmuch_message_maildir_flags_to_tags (notmuch_message_t *message);
1555 * Rename message filename(s) to encode tags as maildir flags.
1557 * Specifically, for each filename corresponding to this message:
1559 * If the filename is not in a maildir directory, do nothing. (A
1560 * maildir directory is determined as a directory named "new" or
1561 * "cur".) Similarly, if the filename has invalid maildir info,
1562 * (repeated or outof-ASCII-order flag characters after ":2,"), then
1565 * If the filename is in a maildir directory, rename the file so that
1566 * its filename ends with the sequence ":2," followed by zero or more
1567 * of the following single-character flags (in ASCII order):
1569 * 'D' iff the message has the "draft" tag
1570 * 'F' iff the message has the "flagged" tag
1571 * 'P' iff the message has the "passed" tag
1572 * 'R' iff the message has the "replied" tag
1573 * 'S' iff the message does not have the "unread" tag
1575 * Any existing flags unmentioned in the list above will be preserved
1578 * Also, if this filename is in a directory named "new", rename it to
1579 * be within the neighboring directory named "cur".
1581 * A client can ensure that maildir filename flags remain synchronized
1582 * with notmuch database tags by calling this function after changing
1583 * tags, (after calls to notmuch_message_add_tag,
1584 * notmuch_message_remove_tag, or notmuch_message_freeze/
1585 * notmuch_message_thaw). See also notmuch_message_maildir_flags_to_tags
1586 * for synchronizing maildir flag changes back to tags.
1589 notmuch_message_tags_to_maildir_flags (notmuch_message_t *message);
1592 * Freeze the current state of 'message' within the database.
1594 * This means that changes to the message state, (via
1595 * notmuch_message_add_tag, notmuch_message_remove_tag, and
1596 * notmuch_message_remove_all_tags), will not be committed to the
1597 * database until the message is thawed with notmuch_message_thaw.
1599 * Multiple calls to freeze/thaw are valid and these calls will
1600 * "stack". That is there must be as many calls to thaw as to freeze
1601 * before a message is actually thawed.
1603 * The ability to do freeze/thaw allows for safe transactions to
1604 * change tag values. For example, explicitly setting a message to
1605 * have a given set of tags might look like this:
1607 * notmuch_message_freeze (message);
1609 * notmuch_message_remove_all_tags (message);
1611 * for (i = 0; i < NUM_TAGS; i++)
1612 * notmuch_message_add_tag (message, tags[i]);
1614 * notmuch_message_thaw (message);
1616 * With freeze/thaw used like this, the message in the database is
1617 * guaranteed to have either the full set of original tag values, or
1618 * the full set of new tag values, but nothing in between.
1620 * Imagine the example above without freeze/thaw and the operation
1621 * somehow getting interrupted. This could result in the message being
1622 * left with no tags if the interruption happened after
1623 * notmuch_message_remove_all_tags but before notmuch_message_add_tag.
1627 * NOTMUCH_STATUS_SUCCESS: Message successfully frozen.
1629 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
1630 * mode so message cannot be modified.
1633 notmuch_message_freeze (notmuch_message_t *message);
1636 * Thaw the current 'message', synchronizing any changes that may have
1637 * occurred while 'message' was frozen into the notmuch database.
1639 * See notmuch_message_freeze for an example of how to use this
1640 * function to safely provide tag changes.
1642 * Multiple calls to freeze/thaw are valid and these calls with
1643 * "stack". That is there must be as many calls to thaw as to freeze
1644 * before a message is actually thawed.
1648 * NOTMUCH_STATUS_SUCCESS: Message successfully thawed, (or at least
1649 * its frozen count has successfully been reduced by 1).
1651 * NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW: An attempt was made to thaw
1652 * an unfrozen message. That is, there have been an unbalanced
1653 * number of calls to notmuch_message_freeze and
1654 * notmuch_message_thaw.
1657 notmuch_message_thaw (notmuch_message_t *message);
1660 * Destroy a notmuch_message_t object.
1662 * It can be useful to call this function in the case of a single
1663 * query object with many messages in the result, (such as iterating
1664 * over the entire database). Otherwise, it's fine to never call this
1665 * function and there will still be no memory leaks. (The memory from
1666 * the messages get reclaimed when the containing query is destroyed.)
1669 notmuch_message_destroy (notmuch_message_t *message);
1672 * @name Message Properties
1674 * This interface provides the ability to attach arbitrary (key,value)
1675 * string pairs to a message, to remove such pairs, and to iterate
1676 * over them. The caller should take some care as to what keys they
1677 * add or delete values for, as other subsystems or extensions may
1678 * depend on these properties.
1683 * Retrieve the value for a single property key
1685 * *value* is set to a string owned by the message or NULL if there is
1686 * no such key. In the case of multiple values for the given key, the
1687 * first one is retrieved.
1690 * - NOTMUCH_STATUS_NULL_POINTER: *value* may not be NULL.
1691 * - NOTMUCH_STATUS_SUCCESS: No error occured.
1692 * @since libnotmuch 4.4 (notmuch 0.23)
1695 notmuch_message_get_property (notmuch_message_t *message, const char *key, const char **value);
1698 * Add a (key,value) pair to a message
1701 * - NOTMUCH_STATUS_ILLEGAL_ARGUMENT: *key* may not contain an '=' character.
1702 * - NOTMUCH_STATUS_NULL_POINTER: Neither *key* nor *value* may be NULL.
1703 * - NOTMUCH_STATUS_SUCCESS: No error occured.
1704 * @since libnotmuch 4.4 (notmuch 0.23)
1707 notmuch_message_add_property (notmuch_message_t *message, const char *key, const char *value);
1710 * Remove a (key,value) pair from a message.
1712 * It is not an error to remove a non-existant (key,value) pair
1715 * - NOTMUCH_STATUS_ILLEGAL_ARGUMENT: *key* may not contain an '=' character.
1716 * - NOTMUCH_STATUS_NULL_POINTER: Neither *key* nor *value* may be NULL.
1717 * - NOTMUCH_STATUS_SUCCESS: No error occured.
1718 * @since libnotmuch 4.4 (notmuch 0.23)
1721 notmuch_message_remove_property (notmuch_message_t *message, const char *key, const char *value);
1724 * Remove all (key,value) pairs from the given message.
1726 * @param[in,out] message message to operate on.
1727 * @param[in] key key to delete properties for. If NULL, delete
1728 * properties for all keys
1730 * - NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in
1731 * read-only mode so message cannot be modified.
1732 * - NOTMUCH_STATUS_SUCCESS: No error occured.
1734 * @since libnotmuch 4.4 (notmuch 0.23)
1737 notmuch_message_remove_all_properties (notmuch_message_t *message, const char *key);
1740 * Opaque message property iterator
1742 typedef struct _notmuch_string_map_iterator notmuch_message_properties_t;
1745 * Get the properties for *message*, returning a
1746 * notmuch_message_properties_t object which can be used to iterate
1747 * over all properties.
1749 * The notmuch_message_properties_t object is owned by the message and
1750 * as such, will only be valid for as long as the message is valid,
1751 * (which is until the query from which it derived is destroyed).
1753 * @param[in] message The message to examine
1754 * @param[in] key key or key prefix
1755 * @param[in] exact if TRUE, require exact match with key. Otherwise
1758 * Typical usage might be:
1760 * notmuch_message_properties_t *list;
1762 * for (list = notmuch_message_get_properties (message, "testkey1", TRUE);
1763 * notmuch_message_properties_valid (list); notmuch_message_properties_move_to_next (list)) {
1764 * printf("%s\n", notmuch_message_properties_value(list));
1767 * notmuch_message_properties_destroy (list);
1769 * Note that there's no explicit destructor needed for the
1770 * notmuch_message_properties_t object. (For consistency, we do
1771 * provide a notmuch_message_properities_destroy function, but there's
1772 * no good reason to call it if the message is about to be destroyed).
1774 * @since libnotmuch 4.4 (notmuch 0.23)
1776 notmuch_message_properties_t *
1777 notmuch_message_get_properties (notmuch_message_t *message, const char *key, notmuch_bool_t exact);
1780 * Is the given *properties* iterator pointing at a valid (key,value)
1783 * When this function returns TRUE,
1784 * notmuch_message_properties_{key,value} will return a valid string,
1785 * and notmuch_message_properties_move_to_next will do what it
1786 * says. Whereas when this function returns FALSE, calling any of
1787 * these functions results in undefined behaviour.
1789 * See the documentation of notmuch_message_properties_get for example
1790 * code showing how to iterate over a notmuch_message_properties_t
1793 * @since libnotmuch 4.4 (notmuch 0.23)
1796 notmuch_message_properties_valid (notmuch_message_properties_t *properties);
1799 * Move the *properties* iterator to the next (key,value) pair
1801 * If *properties* is already pointing at the last pair then the iterator
1802 * will be moved to a point just beyond that last pair, (where
1803 * notmuch_message_properties_valid will return FALSE).
1805 * See the documentation of notmuch_message_get_properties for example
1806 * code showing how to iterate over a notmuch_message_properties_t object.
1808 * @since libnotmuch 4.4 (notmuch 0.23)
1811 notmuch_message_properties_move_to_next (notmuch_message_properties_t *properties);
1814 * Return the key from the current (key,value) pair.
1816 * this could be useful if iterating for a prefix
1818 * @since libnotmuch 4.4 (notmuch 0.23)
1821 notmuch_message_properties_key (notmuch_message_properties_t *properties);
1824 * Return the value from the current (key,value) pair.
1826 * This could be useful if iterating for a prefix.
1828 * @since libnotmuch 4.4 (notmuch 0.23)
1831 notmuch_message_properties_value (notmuch_message_properties_t *properties);
1835 * Destroy a notmuch_message_properties_t object.
1837 * It's not strictly necessary to call this function. All memory from
1838 * the notmuch_message_properties_t object will be reclaimed when the
1839 * containing message object is destroyed.
1841 * @since libnotmuch 4.4 (notmuch 0.23)
1844 notmuch_message_properties_destroy (notmuch_message_properties_t *properties);
1849 * Is the given 'tags' iterator pointing at a valid tag.
1851 * When this function returns TRUE, notmuch_tags_get will return a
1852 * valid string. Whereas when this function returns FALSE,
1853 * notmuch_tags_get will return NULL.
1855 * See the documentation of notmuch_message_get_tags for example code
1856 * showing how to iterate over a notmuch_tags_t object.
1859 notmuch_tags_valid (notmuch_tags_t *tags);
1862 * Get the current tag from 'tags' as a string.
1864 * Note: The returned string belongs to 'tags' and has a lifetime
1865 * identical to it (and the query to which it ultimately belongs).
1867 * See the documentation of notmuch_message_get_tags for example code
1868 * showing how to iterate over a notmuch_tags_t object.
1871 notmuch_tags_get (notmuch_tags_t *tags);
1874 * Move the 'tags' iterator to the next tag.
1876 * If 'tags' is already pointing at the last tag then the iterator
1877 * will be moved to a point just beyond that last tag, (where
1878 * notmuch_tags_valid will return FALSE and notmuch_tags_get will
1881 * See the documentation of notmuch_message_get_tags for example code
1882 * showing how to iterate over a notmuch_tags_t object.
1885 notmuch_tags_move_to_next (notmuch_tags_t *tags);
1888 * Destroy a notmuch_tags_t object.
1890 * It's not strictly necessary to call this function. All memory from
1891 * the notmuch_tags_t object will be reclaimed when the containing
1892 * message or query objects are destroyed.
1895 notmuch_tags_destroy (notmuch_tags_t *tags);
1898 * Store an mtime within the database for 'directory'.
1900 * The 'directory' should be an object retrieved from the database
1901 * with notmuch_database_get_directory for a particular path.
1903 * The intention is for the caller to use the mtime to allow efficient
1904 * identification of new messages to be added to the database. The
1905 * recommended usage is as follows:
1907 * o Read the mtime of a directory from the filesystem
1909 * o Call add_message for all mail files in the directory
1911 * o Call notmuch_directory_set_mtime with the mtime read from the
1914 * Then, when wanting to check for updates to the directory in the
1915 * future, the client can call notmuch_directory_get_mtime and know
1916 * that it only needs to add files if the mtime of the directory and
1917 * files are newer than the stored timestamp.
1919 * Note: The notmuch_directory_get_mtime function does not allow the
1920 * caller to distinguish a timestamp of 0 from a non-existent
1921 * timestamp. So don't store a timestamp of 0 unless you are
1922 * comfortable with that.
1926 * NOTMUCH_STATUS_SUCCESS: mtime successfully stored in database.
1928 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception
1929 * occurred, mtime not stored.
1931 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
1932 * mode so directory mtime cannot be modified.
1935 notmuch_directory_set_mtime (notmuch_directory_t *directory,
1939 * Get the mtime of a directory, (as previously stored with
1940 * notmuch_directory_set_mtime).
1942 * Returns 0 if no mtime has previously been stored for this
1946 notmuch_directory_get_mtime (notmuch_directory_t *directory);
1949 * Get a notmuch_filenames_t iterator listing all the filenames of
1950 * messages in the database within the given directory.
1952 * The returned filenames will be the basename-entries only (not
1955 notmuch_filenames_t *
1956 notmuch_directory_get_child_files (notmuch_directory_t *directory);
1959 * Get a notmuch_filenames_t iterator listing all the filenames of
1960 * sub-directories in the database within the given directory.
1962 * The returned filenames will be the basename-entries only (not
1965 notmuch_filenames_t *
1966 notmuch_directory_get_child_directories (notmuch_directory_t *directory);
1969 * Delete directory document from the database, and destroy the
1970 * notmuch_directory_t object. Assumes any child directories and files
1971 * have been deleted by the caller.
1973 * @since libnotmuch 4.3 (notmuch 0.21)
1976 notmuch_directory_delete (notmuch_directory_t *directory);
1979 * Destroy a notmuch_directory_t object.
1982 notmuch_directory_destroy (notmuch_directory_t *directory);
1985 * Is the given 'filenames' iterator pointing at a valid filename.
1987 * When this function returns TRUE, notmuch_filenames_get will return
1988 * a valid string. Whereas when this function returns FALSE,
1989 * notmuch_filenames_get will return NULL.
1991 * It is acceptable to pass NULL for 'filenames', in which case this
1992 * function will always return FALSE.
1995 notmuch_filenames_valid (notmuch_filenames_t *filenames);
1998 * Get the current filename from 'filenames' as a string.
2000 * Note: The returned string belongs to 'filenames' and has a lifetime
2001 * identical to it (and the directory to which it ultimately belongs).
2003 * It is acceptable to pass NULL for 'filenames', in which case this
2004 * function will always return NULL.
2007 notmuch_filenames_get (notmuch_filenames_t *filenames);
2010 * Move the 'filenames' iterator to the next filename.
2012 * If 'filenames' is already pointing at the last filename then the
2013 * iterator will be moved to a point just beyond that last filename,
2014 * (where notmuch_filenames_valid will return FALSE and
2015 * notmuch_filenames_get will return NULL).
2017 * It is acceptable to pass NULL for 'filenames', in which case this
2018 * function will do nothing.
2021 notmuch_filenames_move_to_next (notmuch_filenames_t *filenames);
2024 * Destroy a notmuch_filenames_t object.
2026 * It's not strictly necessary to call this function. All memory from
2027 * the notmuch_filenames_t object will be reclaimed when the
2028 * containing directory object is destroyed.
2030 * It is acceptable to pass NULL for 'filenames', in which case this
2031 * function will do nothing.
2034 notmuch_filenames_destroy (notmuch_filenames_t *filenames);
2038 * set config 'key' to 'value'
2040 * @since libnotmuch 4.4 (notmuch 0.23)
2043 notmuch_database_set_config (notmuch_database_t *db, const char *key, const char *value);
2046 * retrieve config item 'key', assign to 'value'
2048 * keys which have not been previously set with n_d_set_config will
2049 * return an empty string.
2051 * return value is allocated by malloc and should be freed by the
2054 * @since libnotmuch 4.4 (notmuch 0.23)
2057 notmuch_database_get_config (notmuch_database_t *db, const char *key, char **value);
2060 * Create an iterator for all config items with keys matching a given prefix
2062 * @since libnotmuch 4.4 (notmuch 0.23)
2065 notmuch_database_get_config_list (notmuch_database_t *db, const char *prefix, notmuch_config_list_t **out);
2068 * Is 'config_list' iterator valid (i.e. _key, _value, _move_to_next can be called).
2070 * @since libnotmuch 4.4 (notmuch 0.23)
2073 notmuch_config_list_valid (notmuch_config_list_t *config_list);
2076 * return key for current config pair
2078 * return value is owned by the iterator, and will be destroyed by the
2079 * next call to notmuch_config_list_key or notmuch_config_list_destroy.
2081 * @since libnotmuch 4.4 (notmuch 0.23)
2084 notmuch_config_list_key (notmuch_config_list_t *config_list);
2087 * return 'value' for current config pair
2089 * return value is owned by the iterator, and will be destroyed by the
2090 * next call to notmuch_config_list_value or notmuch config_list_destroy
2092 * @since libnotmuch 4.4 (notmuch 0.23)
2095 notmuch_config_list_value (notmuch_config_list_t *config_list);
2099 * move 'config_list' iterator to the next pair
2101 * @since libnotmuch 4.4 (notmuch 0.23)
2104 notmuch_config_list_move_to_next (notmuch_config_list_t *config_list);
2107 * free any resources held by 'config_list'
2109 * @since libnotmuch 4.4 (notmuch 0.23)
2112 notmuch_config_list_destroy (notmuch_config_list_t *config_list);
2115 * interrogate the library for compile time features
2117 * @since libnotmuch 4.4 (notmuch 0.23)
2120 notmuch_built_with (const char *name);