1 /* notmuch - Not much of an email library, (just index and search)
3 * Copyright © 2009 Carl Worth
5 * This program is free software: you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation, either version 3 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program. If not, see https://www.gnu.org/licenses/ .
18 * Author: Carl Worth <cworth@cworth.org>
22 * @defgroup notmuch The notmuch API
24 * Not much of an email library, (just index and search)
35 # define NOTMUCH_BEGIN_DECLS extern "C" {
36 # define NOTMUCH_END_DECLS }
38 # define NOTMUCH_BEGIN_DECLS
39 # define NOTMUCH_END_DECLS
46 #pragma GCC visibility push(default)
57 * The library version number. This must agree with the soname
58 * version in Makefile.local.
60 #define LIBNOTMUCH_MAJOR_VERSION 5
61 #define LIBNOTMUCH_MINOR_VERSION 0
62 #define LIBNOTMUCH_MICRO_VERSION 0
65 #if defined (__clang_major__) && __clang_major__ >= 3 \
66 || defined (__GNUC__) && __GNUC__ >= 5 \
67 || defined (__GNUC__) && __GNUC__ == 4 && __GNUC_MINOR__ >= 5
68 #define NOTMUCH_DEPRECATED(major,minor) \
69 __attribute__ ((deprecated ("function deprecated as of libnotmuch " #major "." #minor)))
71 #define NOTMUCH_DEPRECATED(major,minor) __attribute__ ((deprecated))
75 #endif /* __DOXYGEN__ */
78 * Check the version of the notmuch library being compiled against.
80 * Return true if the library being compiled against is of the
81 * specified version or above. For example:
84 * #if LIBNOTMUCH_CHECK_VERSION(3, 1, 0)
85 * (code requiring libnotmuch 3.1.0 or above)
89 * LIBNOTMUCH_CHECK_VERSION has been defined since version 3.1.0; to
90 * check for versions prior to that, use:
93 * #if !defined(NOTMUCH_CHECK_VERSION)
94 * (code requiring libnotmuch prior to 3.1.0)
98 #define LIBNOTMUCH_CHECK_VERSION(major, minor, micro) \
99 (LIBNOTMUCH_MAJOR_VERSION > (major) || \
100 (LIBNOTMUCH_MAJOR_VERSION == (major) && LIBNOTMUCH_MINOR_VERSION > (minor)) || \
101 (LIBNOTMUCH_MAJOR_VERSION == (major) && LIBNOTMUCH_MINOR_VERSION == (minor) && \
102 LIBNOTMUCH_MICRO_VERSION >= (micro)))
105 * Notmuch boolean type.
107 typedef int notmuch_bool_t;
110 * Status codes used for the return values of most functions.
112 * A zero value (NOTMUCH_STATUS_SUCCESS) indicates that the function
113 * completed without error. Any other value indicates an error.
115 typedef enum _notmuch_status {
119 NOTMUCH_STATUS_SUCCESS = 0,
123 NOTMUCH_STATUS_OUT_OF_MEMORY,
125 * An attempt was made to write to a database opened in read-only
128 NOTMUCH_STATUS_READ_ONLY_DATABASE,
130 * A Xapian exception occurred.
132 * @todo We don't really want to expose this lame XAPIAN_EXCEPTION
133 * value. Instead we should map to things like DATABASE_LOCKED or
136 NOTMUCH_STATUS_XAPIAN_EXCEPTION,
138 * An error occurred trying to read or write to a file (this could
139 * be file not found, permission denied, etc.)
141 NOTMUCH_STATUS_FILE_ERROR,
143 * A file was presented that doesn't appear to be an email
146 NOTMUCH_STATUS_FILE_NOT_EMAIL,
148 * A file contains a message ID that is identical to a message
149 * already in the database.
151 NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID,
153 * The user erroneously passed a NULL pointer to a notmuch
156 NOTMUCH_STATUS_NULL_POINTER,
158 * A tag value is too long (exceeds NOTMUCH_TAG_MAX).
160 NOTMUCH_STATUS_TAG_TOO_LONG,
162 * The notmuch_message_thaw function has been called more times
163 * than notmuch_message_freeze.
165 NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW,
167 * notmuch_database_end_atomic has been called more times than
168 * notmuch_database_begin_atomic.
170 NOTMUCH_STATUS_UNBALANCED_ATOMIC,
172 * The operation is not supported.
174 NOTMUCH_STATUS_UNSUPPORTED_OPERATION,
176 * The operation requires a database upgrade.
178 NOTMUCH_STATUS_UPGRADE_REQUIRED,
180 * There is a problem with the proposed path, e.g. a relative path
181 * passed to a function expecting an absolute path.
183 NOTMUCH_STATUS_PATH_ERROR,
185 * The requested operation was ignored. Depending on the function,
186 * this may not be an actual error.
188 NOTMUCH_STATUS_IGNORED,
190 * One of the arguments violates the preconditions for the
191 * function, in a way not covered by a more specific argument.
193 NOTMUCH_STATUS_ILLEGAL_ARGUMENT,
195 * Not an actual status value. Just a way to find out how many
196 * valid status values there are.
198 NOTMUCH_STATUS_LAST_STATUS
202 * Get a string representation of a notmuch_status_t value.
204 * The result is read-only.
207 notmuch_status_to_string (notmuch_status_t status);
209 /* Various opaque data types. For each notmuch_<foo>_t see the various
210 * notmuch_<foo> functions below. */
212 typedef struct _notmuch_database notmuch_database_t;
213 typedef struct _notmuch_query notmuch_query_t;
214 typedef struct _notmuch_threads notmuch_threads_t;
215 typedef struct _notmuch_thread notmuch_thread_t;
216 typedef struct _notmuch_messages notmuch_messages_t;
217 typedef struct _notmuch_message notmuch_message_t;
218 typedef struct _notmuch_tags notmuch_tags_t;
219 typedef struct _notmuch_directory notmuch_directory_t;
220 typedef struct _notmuch_filenames notmuch_filenames_t;
221 typedef struct _notmuch_config_list notmuch_config_list_t;
222 typedef struct _notmuch_param notmuch_param_t;
223 #endif /* __DOXYGEN__ */
226 * Create a new, empty notmuch database located at 'path'.
228 * The path should be a top-level directory to a collection of
229 * plain-text email messages (one message per file). This call will
230 * create a new ".notmuch" directory within 'path' where notmuch will
233 * After a successful call to notmuch_database_create, the returned
234 * database will be open so the caller should call
235 * notmuch_database_destroy when finished with it.
237 * The database will not yet have any data in it
238 * (notmuch_database_create itself is a very cheap function). Messages
239 * contained within 'path' can be added to the database by calling
240 * notmuch_database_add_message.
242 * In case of any failure, this function returns an error status and
243 * sets *database to NULL (after printing an error message on stderr).
247 * NOTMUCH_STATUS_SUCCESS: Successfully created the database.
249 * NOTMUCH_STATUS_NULL_POINTER: The given 'path' argument is NULL.
251 * NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory.
253 * NOTMUCH_STATUS_FILE_ERROR: An error occurred trying to create the
254 * database file (such as permission denied, or file not found,
255 * etc.), or the database already exists.
257 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred.
260 notmuch_database_create (const char *path, notmuch_database_t **database);
263 * Like notmuch_database_create, except optionally return an error
264 * message. This message is allocated by malloc and should be freed by
268 notmuch_database_create_verbose (const char *path,
269 notmuch_database_t **database,
270 char **error_message);
273 * Database open mode for notmuch_database_open.
277 * Open database for reading only.
279 NOTMUCH_DATABASE_MODE_READ_ONLY = 0,
281 * Open database for reading and writing.
283 NOTMUCH_DATABASE_MODE_READ_WRITE
284 } notmuch_database_mode_t;
287 * Open an existing notmuch database located at 'path'.
289 * The database should have been created at some time in the past,
290 * (not necessarily by this process), by calling
291 * notmuch_database_create with 'path'. By default the database should be
292 * opened for reading only. In order to write to the database you need to
293 * pass the NOTMUCH_DATABASE_MODE_READ_WRITE mode.
295 * An existing notmuch database can be identified by the presence of a
296 * directory named ".notmuch" below 'path'.
298 * The caller should call notmuch_database_destroy when finished with
301 * In case of any failure, this function returns an error status and
302 * sets *database to NULL (after printing an error message on stderr).
306 * NOTMUCH_STATUS_SUCCESS: Successfully opened the database.
308 * NOTMUCH_STATUS_NULL_POINTER: The given 'path' argument is NULL.
310 * NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory.
312 * NOTMUCH_STATUS_FILE_ERROR: An error occurred trying to open the
313 * database file (such as permission denied, or file not found,
314 * etc.), or the database version is unknown.
316 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred.
319 notmuch_database_open (const char *path,
320 notmuch_database_mode_t mode,
321 notmuch_database_t **database);
323 * Like notmuch_database_open, except optionally return an error
324 * message. This message is allocated by malloc and should be freed by
329 notmuch_database_open_verbose (const char *path,
330 notmuch_database_mode_t mode,
331 notmuch_database_t **database,
332 char **error_message);
335 * Retrieve last status string for given database.
339 notmuch_database_status_string (const notmuch_database_t *notmuch);
342 * Commit changes and close the given notmuch database.
344 * After notmuch_database_close has been called, calls to other
345 * functions on objects derived from this database may either behave
346 * as if the database had not been closed (e.g., if the required data
347 * has been cached) or may fail with a
348 * NOTMUCH_STATUS_XAPIAN_EXCEPTION. The only further operation
349 * permitted on the database itself is to call
350 * notmuch_database_destroy.
352 * notmuch_database_close can be called multiple times. Later calls
355 * For writable databases, notmuch_database_close commits all changes
356 * to disk before closing the database. If the caller is currently in
357 * an atomic section (there was a notmuch_database_begin_atomic
358 * without a matching notmuch_database_end_atomic), this will discard
359 * changes made in that atomic section (but still commit changes made
360 * prior to entering the atomic section).
364 * NOTMUCH_STATUS_SUCCESS: Successfully closed the database.
366 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred; the
367 * database has been closed but there are no guarantees the
368 * changes to the database, if any, have been flushed to disk.
371 notmuch_database_close (notmuch_database_t *database);
374 * A callback invoked by notmuch_database_compact to notify the user
375 * of the progress of the compaction process.
377 typedef void (*notmuch_compact_status_cb_t)(const char *message, void *closure);
380 * Compact a notmuch database, backing up the original database to the
383 * The database will be opened with NOTMUCH_DATABASE_MODE_READ_WRITE
384 * during the compaction process to ensure no writes are made.
386 * If the optional callback function 'status_cb' is non-NULL, it will
387 * be called with diagnostic and informational messages. The argument
388 * 'closure' is passed verbatim to any callback invoked.
391 notmuch_database_compact (const char* path,
392 const char* backup_path,
393 notmuch_compact_status_cb_t status_cb,
397 * Destroy the notmuch database, closing it if necessary and freeing
398 * all associated resources.
400 * Return value as in notmuch_database_close if the database was open;
401 * notmuch_database_destroy itself has no failure modes.
404 notmuch_database_destroy (notmuch_database_t *database);
407 * Return the database path of the given database.
409 * The return value is a string owned by notmuch so should not be
410 * modified nor freed by the caller.
413 notmuch_database_get_path (notmuch_database_t *database);
416 * Return the database format version of the given database.
419 notmuch_database_get_version (notmuch_database_t *database);
422 * Can the database be upgraded to a newer database version?
424 * If this function returns TRUE, then the caller may call
425 * notmuch_database_upgrade to upgrade the database. If the caller
426 * does not upgrade an out-of-date database, then some functions may
427 * fail with NOTMUCH_STATUS_UPGRADE_REQUIRED. This always returns
428 * FALSE for a read-only database because there's no way to upgrade a
429 * read-only database.
432 notmuch_database_needs_upgrade (notmuch_database_t *database);
435 * Upgrade the current database to the latest supported version.
437 * This ensures that all current notmuch functionality will be
438 * available on the database. After opening a database in read-write
439 * mode, it is recommended that clients check if an upgrade is needed
440 * (notmuch_database_needs_upgrade) and if so, upgrade with this
441 * function before making any modifications. If
442 * notmuch_database_needs_upgrade returns FALSE, this will be a no-op.
444 * The optional progress_notify callback can be used by the caller to
445 * provide progress indication to the user. If non-NULL it will be
446 * called periodically with 'progress' as a floating-point value in
447 * the range of [0.0 .. 1.0] indicating the progress made so far in
448 * the upgrade process. The argument 'closure' is passed verbatim to
449 * any callback invoked.
452 notmuch_database_upgrade (notmuch_database_t *database,
453 void (*progress_notify) (void *closure,
458 * Begin an atomic database operation.
460 * Any modifications performed between a successful begin and a
461 * notmuch_database_end_atomic will be applied to the database
462 * atomically. Note that, unlike a typical database transaction, this
463 * only ensures atomicity, not durability; neither begin nor end
464 * necessarily flush modifications to disk.
466 * Atomic sections may be nested. begin_atomic and end_atomic must
467 * always be called in pairs.
471 * NOTMUCH_STATUS_SUCCESS: Successfully entered atomic section.
473 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred;
474 * atomic section not entered.
477 notmuch_database_begin_atomic (notmuch_database_t *notmuch);
480 * Indicate the end of an atomic database operation.
484 * NOTMUCH_STATUS_SUCCESS: Successfully completed atomic section.
486 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred;
487 * atomic section not ended.
489 * NOTMUCH_STATUS_UNBALANCED_ATOMIC: The database is not currently in
493 notmuch_database_end_atomic (notmuch_database_t *notmuch);
496 * Return the committed database revision and UUID.
498 * The database revision number increases monotonically with each
499 * commit to the database. Hence, all messages and message changes
500 * committed to the database (that is, visible to readers) have a last
501 * modification revision <= the committed database revision. Any
502 * messages committed in the future will be assigned a modification
503 * revision > the committed database revision.
505 * The UUID is a NUL-terminated opaque string that uniquely identifies
506 * this database. Two revision numbers are only comparable if they
507 * have the same database UUID.
510 notmuch_database_get_revision (notmuch_database_t *notmuch,
514 * Retrieve a directory object from the database for 'path'.
516 * Here, 'path' should be a path relative to the path of 'database'
517 * (see notmuch_database_get_path), or else should be an absolute path
518 * with initial components that match the path of 'database'.
520 * If this directory object does not exist in the database, this
521 * returns NOTMUCH_STATUS_SUCCESS and sets *directory to NULL.
523 * Otherwise the returned directory object is owned by the database
524 * and as such, will only be valid until notmuch_database_destroy is
529 * NOTMUCH_STATUS_SUCCESS: Successfully retrieved directory.
531 * NOTMUCH_STATUS_NULL_POINTER: The given 'directory' argument is NULL.
533 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred;
534 * directory not retrieved.
536 * NOTMUCH_STATUS_UPGRADE_REQUIRED: The caller must upgrade the
537 * database to use this function.
540 notmuch_database_get_directory (notmuch_database_t *database,
542 notmuch_directory_t **directory);
545 * Add a new message to the given notmuch database or associate an
546 * additional filename with an existing message.
548 * Here, 'filename' should be a path relative to the path of
549 * 'database' (see notmuch_database_get_path), or else should be an
550 * absolute filename with initial components that match the path of
553 * The file should be a single mail message (not a multi-message mbox)
554 * that is expected to remain at its current location, (since the
555 * notmuch database will reference the filename, and will not copy the
556 * entire contents of the file.
558 * If another message with the same message ID already exists in the
559 * database, rather than creating a new message, this adds 'filename'
560 * to the list of the filenames for the existing message.
562 * If 'message' is not NULL, then, on successful return
563 * (NOTMUCH_STATUS_SUCCESS or NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID) '*message'
564 * will be initialized to a message object that can be used for things
565 * such as adding tags to the just-added message. The user should call
566 * notmuch_message_destroy when done with the message. On any failure
567 * '*message' will be set to NULL.
571 * NOTMUCH_STATUS_SUCCESS: Message successfully added to database.
573 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred,
576 * NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID: Message has the same message
577 * ID as another message already in the database. The new
578 * filename was successfully added to the message in the database
579 * (if not already present) and the existing message is returned.
581 * NOTMUCH_STATUS_FILE_ERROR: an error occurred trying to open the
582 * file, (such as permission denied, or file not found,
583 * etc.). Nothing added to the database.
585 * NOTMUCH_STATUS_FILE_NOT_EMAIL: the contents of filename don't look
586 * like an email message. Nothing added to the database.
588 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
589 * mode so no message can be added.
591 * NOTMUCH_STATUS_UPGRADE_REQUIRED: The caller must upgrade the
592 * database to use this function.
595 notmuch_database_add_message (notmuch_database_t *database,
596 const char *filename,
597 notmuch_message_t **message);
600 * Remove a message filename from the given notmuch database. If the
601 * message has no more filenames, remove the message.
603 * If the same message (as determined by the message ID) is still
604 * available via other filenames, then the message will persist in the
605 * database for those filenames. When the last filename is removed for
606 * a particular message, the database content for that message will be
611 * NOTMUCH_STATUS_SUCCESS: The last filename was removed and the
612 * message was removed from the database.
614 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred,
615 * message not removed.
617 * NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID: This filename was removed but
618 * the message persists in the database with at least one other
621 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
622 * mode so no message can be removed.
624 * NOTMUCH_STATUS_UPGRADE_REQUIRED: The caller must upgrade the
625 * database to use this function.
628 notmuch_database_remove_message (notmuch_database_t *database,
629 const char *filename);
632 * Find a message with the given message_id.
634 * If a message with the given message_id is found then, on successful return
635 * (NOTMUCH_STATUS_SUCCESS) '*message' will be initialized to a message
636 * object. The caller should call notmuch_message_destroy when done with the
639 * On any failure or when the message is not found, this function initializes
640 * '*message' to NULL. This means, when NOTMUCH_STATUS_SUCCESS is returned, the
641 * caller is supposed to check '*message' for NULL to find out whether the
642 * message with the given message_id was found.
646 * NOTMUCH_STATUS_SUCCESS: Successful return, check '*message'.
648 * NOTMUCH_STATUS_NULL_POINTER: The given 'message' argument is NULL
650 * NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory, creating message object
652 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred
655 notmuch_database_find_message (notmuch_database_t *database,
656 const char *message_id,
657 notmuch_message_t **message);
660 * Find a message with the given filename.
662 * If the database contains a message with the given filename then, on
663 * successful return (NOTMUCH_STATUS_SUCCESS) '*message' will be initialized to
664 * a message object. The caller should call notmuch_message_destroy when done
667 * On any failure or when the message is not found, this function initializes
668 * '*message' to NULL. This means, when NOTMUCH_STATUS_SUCCESS is returned, the
669 * caller is supposed to check '*message' for NULL to find out whether the
670 * message with the given filename is found.
674 * NOTMUCH_STATUS_SUCCESS: Successful return, check '*message'
676 * NOTMUCH_STATUS_NULL_POINTER: The given 'message' argument is NULL
678 * NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory, creating the message object
680 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred
682 * NOTMUCH_STATUS_UPGRADE_REQUIRED: The caller must upgrade the
683 * database to use this function.
686 notmuch_database_find_message_by_filename (notmuch_database_t *notmuch,
687 const char *filename,
688 notmuch_message_t **message);
691 * Return a list of all tags found in the database.
693 * This function creates a list of all tags found in the database. The
694 * resulting list contains all tags from all messages found in the database.
696 * On error this function returns NULL.
699 notmuch_database_get_all_tags (notmuch_database_t *db);
702 * Create a new query for 'database'.
704 * Here, 'database' should be an open database, (see
705 * notmuch_database_open and notmuch_database_create).
707 * For the query string, we'll document the syntax here more
708 * completely in the future, but it's likely to be a specialized
709 * version of the general Xapian query syntax:
711 * https://xapian.org/docs/queryparser.html
713 * As a special case, passing either a length-zero string, (that is ""),
714 * or a string consisting of a single asterisk (that is "*"), will
715 * result in a query that returns all messages in the database.
717 * See notmuch_query_set_sort for controlling the order of results.
718 * See notmuch_query_search_messages and notmuch_query_search_threads
719 * to actually execute the query.
721 * User should call notmuch_query_destroy when finished with this
724 * Will return NULL if insufficient memory is available.
727 notmuch_query_create (notmuch_database_t *database,
728 const char *query_string);
731 * Sort values for notmuch_query_set_sort.
737 NOTMUCH_SORT_OLDEST_FIRST,
741 NOTMUCH_SORT_NEWEST_FIRST,
743 * Sort by message-id.
745 NOTMUCH_SORT_MESSAGE_ID,
749 NOTMUCH_SORT_UNSORTED
753 * Return the query_string of this query. See notmuch_query_create.
756 notmuch_query_get_query_string (const notmuch_query_t *query);
759 * Return the notmuch database of this query. See notmuch_query_create.
762 notmuch_query_get_database (const notmuch_query_t *query);
765 * Exclude values for notmuch_query_set_omit_excluded. The strange
766 * order is to maintain backward compatibility: the old FALSE/TRUE
767 * options correspond to the new
768 * NOTMUCH_EXCLUDE_FLAG/NOTMUCH_EXCLUDE_TRUE options.
771 NOTMUCH_EXCLUDE_FLAG,
772 NOTMUCH_EXCLUDE_TRUE,
773 NOTMUCH_EXCLUDE_FALSE,
778 * Specify whether to omit excluded results or simply flag them. By
779 * default, this is set to TRUE.
781 * If set to TRUE or ALL, notmuch_query_search_messages will omit excluded
782 * messages from the results, and notmuch_query_search_threads will omit
783 * threads that match only in excluded messages. If set to TRUE,
784 * notmuch_query_search_threads will include all messages in threads that
785 * match in at least one non-excluded message. Otherwise, if set to ALL,
786 * notmuch_query_search_threads will omit excluded messages from all threads.
788 * If set to FALSE or FLAG then both notmuch_query_search_messages and
789 * notmuch_query_search_threads will return all matching
790 * messages/threads regardless of exclude status. If set to FLAG then
791 * the exclude flag will be set for any excluded message that is
792 * returned by notmuch_query_search_messages, and the thread counts
793 * for threads returned by notmuch_query_search_threads will be the
794 * number of non-excluded messages/matches. Otherwise, if set to
795 * FALSE, then the exclude status is completely ignored.
797 * The performance difference when calling
798 * notmuch_query_search_messages should be relatively small (and both
799 * should be very fast). However, in some cases,
800 * notmuch_query_search_threads is very much faster when omitting
801 * excluded messages as it does not need to construct the threads that
802 * only match in excluded messages.
805 notmuch_query_set_omit_excluded (notmuch_query_t *query,
806 notmuch_exclude_t omit_excluded);
809 * Specify the sorting desired for this query.
812 notmuch_query_set_sort (notmuch_query_t *query, notmuch_sort_t sort);
815 * Return the sort specified for this query. See
816 * notmuch_query_set_sort.
819 notmuch_query_get_sort (const notmuch_query_t *query);
822 * Add a tag that will be excluded from the query results by default.
823 * This exclusion will be ignored if this tag appears explicitly in
828 * NOTMUCH_STATUS_SUCCESS: excluded was added successfully.
830 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: a Xapian exception occured.
831 * Most likely a problem lazily parsing the query string.
833 * NOTMUCH_STATUS_IGNORED: tag is explicitly present in the query, so
837 notmuch_query_add_tag_exclude (notmuch_query_t *query, const char *tag);
840 * Execute a query for threads, returning a notmuch_threads_t object
841 * which can be used to iterate over the results. The returned threads
842 * object is owned by the query and as such, will only be valid until
843 * notmuch_query_destroy.
845 * Typical usage might be:
847 * notmuch_query_t *query;
848 * notmuch_threads_t *threads;
849 * notmuch_thread_t *thread;
851 * query = notmuch_query_create (database, query_string);
853 * for (threads = notmuch_query_search_threads (query);
854 * notmuch_threads_valid (threads);
855 * notmuch_threads_move_to_next (threads))
857 * thread = notmuch_threads_get (threads);
859 * notmuch_thread_destroy (thread);
862 * notmuch_query_destroy (query);
864 * Note: If you are finished with a thread before its containing
865 * query, you can call notmuch_thread_destroy to clean up some memory
866 * sooner (as in the above example). Otherwise, if your thread objects
867 * are long-lived, then you don't need to call notmuch_thread_destroy
868 * and all the memory will still be reclaimed when the query is
871 * Note that there's no explicit destructor needed for the
872 * notmuch_threads_t object. (For consistency, we do provide a
873 * notmuch_threads_destroy function, but there's no good reason
874 * to call it if the query is about to be destroyed).
876 * @since libnotmuch 5.0 (notmuch 0.25)
879 notmuch_query_search_threads (notmuch_query_t *query,
880 notmuch_threads_t **out);
883 * Deprecated alias for notmuch_query_search_threads.
885 * @deprecated Deprecated as of libnotmuch 5 (notmuch 0.25). Please
886 * use notmuch_query_search_threads instead.
889 NOTMUCH_DEPRECATED(5,0)
891 notmuch_query_search_threads_st (notmuch_query_t *query, notmuch_threads_t **out);
894 * Execute a query for messages, returning a notmuch_messages_t object
895 * which can be used to iterate over the results. The returned
896 * messages object is owned by the query and as such, will only be
897 * valid until notmuch_query_destroy.
899 * Typical usage might be:
901 * notmuch_query_t *query;
902 * notmuch_messages_t *messages;
903 * notmuch_message_t *message;
905 * query = notmuch_query_create (database, query_string);
907 * for (messages = notmuch_query_search_messages (query);
908 * notmuch_messages_valid (messages);
909 * notmuch_messages_move_to_next (messages))
911 * message = notmuch_messages_get (messages);
913 * notmuch_message_destroy (message);
916 * notmuch_query_destroy (query);
918 * Note: If you are finished with a message before its containing
919 * query, you can call notmuch_message_destroy to clean up some memory
920 * sooner (as in the above example). Otherwise, if your message
921 * objects are long-lived, then you don't need to call
922 * notmuch_message_destroy and all the memory will still be reclaimed
923 * when the query is destroyed.
925 * Note that there's no explicit destructor needed for the
926 * notmuch_messages_t object. (For consistency, we do provide a
927 * notmuch_messages_destroy function, but there's no good
928 * reason to call it if the query is about to be destroyed).
930 * If a Xapian exception occurs this function will return NULL.
932 * @since libnotmuch 5 (notmuch 0.25)
935 notmuch_query_search_messages (notmuch_query_t *query,
936 notmuch_messages_t **out);
938 * Deprecated alias for notmuch_query_search_messages
940 * @deprecated Deprecated as of libnotmuch 5 (notmuch 0.25). Please use
941 * notmuch_query_search_messages instead.
945 NOTMUCH_DEPRECATED(5,0)
947 notmuch_query_search_messages_st (notmuch_query_t *query,
948 notmuch_messages_t **out);
951 * Destroy a notmuch_query_t along with any associated resources.
953 * This will in turn destroy any notmuch_threads_t and
954 * notmuch_messages_t objects generated by this query, (and in
955 * turn any notmuch_thread_t and notmuch_message_t objects generated
956 * from those results, etc.), if such objects haven't already been
960 notmuch_query_destroy (notmuch_query_t *query);
963 * Is the given 'threads' iterator pointing at a valid thread.
965 * When this function returns TRUE, notmuch_threads_get will return a
966 * valid object. Whereas when this function returns FALSE,
967 * notmuch_threads_get will return NULL.
969 * If passed a NULL pointer, this function returns FALSE
971 * See the documentation of notmuch_query_search_threads for example
972 * code showing how to iterate over a notmuch_threads_t object.
975 notmuch_threads_valid (notmuch_threads_t *threads);
978 * Get the current thread from 'threads' as a notmuch_thread_t.
980 * Note: The returned thread belongs to 'threads' and has a lifetime
981 * identical to it (and the query to which it belongs).
983 * See the documentation of notmuch_query_search_threads for example
984 * code showing how to iterate over a notmuch_threads_t object.
986 * If an out-of-memory situation occurs, this function will return
990 notmuch_threads_get (notmuch_threads_t *threads);
993 * Move the 'threads' iterator to the next thread.
995 * If 'threads' is already pointing at the last thread then the
996 * iterator will be moved to a point just beyond that last thread,
997 * (where notmuch_threads_valid will return FALSE and
998 * notmuch_threads_get will return NULL).
1000 * See the documentation of notmuch_query_search_threads for example
1001 * code showing how to iterate over a notmuch_threads_t object.
1004 notmuch_threads_move_to_next (notmuch_threads_t *threads);
1007 * Destroy a notmuch_threads_t object.
1009 * It's not strictly necessary to call this function. All memory from
1010 * the notmuch_threads_t object will be reclaimed when the
1011 * containing query object is destroyed.
1014 notmuch_threads_destroy (notmuch_threads_t *threads);
1017 * Return the number of messages matching a search.
1019 * This function performs a search and returns the number of matching
1024 * NOTMUCH_STATUS_SUCCESS: query completed successfully.
1026 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: a Xapian exception occured. The
1027 * value of *count is not defined.
1029 * @since libnotmuch 5 (notmuch 0.25)
1032 notmuch_query_count_messages (notmuch_query_t *query, unsigned int *count);
1035 * Deprecated alias for notmuch_query_count_messages
1038 * @deprecated Deprecated since libnotmuch 5.0 (notmuch 0.25). Please
1039 * use notmuch_query_count_messages instead.
1041 NOTMUCH_DEPRECATED(5,0)
1043 notmuch_query_count_messages_st (notmuch_query_t *query, unsigned int *count);
1046 * Return the number of threads matching a search.
1048 * This function performs a search and returns the number of unique thread IDs
1049 * in the matching messages. This is the same as number of threads matching a
1052 * Note that this is a significantly heavier operation than
1053 * notmuch_query_count_messages{_st}().
1057 * NOTMUCH_STATUS_OUT_OF_MEMORY: Memory allocation failed. The value
1058 * of *count is not defined
1060 * NOTMUCH_STATUS_SUCCESS: query completed successfully.
1062 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: a Xapian exception occured. The
1063 * value of *count is not defined.
1065 * @since libnotmuch 5 (notmuch 0.25)
1068 notmuch_query_count_threads (notmuch_query_t *query, unsigned *count);
1071 * Deprecated alias for notmuch_query_count_threads
1073 * @deprecated Deprecated as of libnotmuch 5.0 (notmuch 0.25). Please
1074 * use notmuch_query_count_threads_st instead.
1076 NOTMUCH_DEPRECATED(5,0)
1078 notmuch_query_count_threads_st (notmuch_query_t *query, unsigned *count);
1081 * Get the thread ID of 'thread'.
1083 * The returned string belongs to 'thread' and as such, should not be
1084 * modified by the caller and will only be valid for as long as the
1085 * thread is valid, (which is until notmuch_thread_destroy or until
1086 * the query from which it derived is destroyed).
1089 notmuch_thread_get_thread_id (notmuch_thread_t *thread);
1092 * Get the total number of messages in 'thread'.
1094 * This count consists of all messages in the database belonging to
1095 * this thread. Contrast with notmuch_thread_get_matched_messages() .
1098 notmuch_thread_get_total_messages (notmuch_thread_t *thread);
1101 * Get the total number of files in 'thread'.
1103 * This sums notmuch_message_count_files over all messages in the
1105 * @returns Non-negative integer
1106 * @since libnotmuch 5.0 (notmuch 0.25)
1110 notmuch_thread_get_total_files (notmuch_thread_t *thread);
1113 * Get a notmuch_messages_t iterator for the top-level messages in
1114 * 'thread' in oldest-first order.
1116 * This iterator will not necessarily iterate over all of the messages
1117 * in the thread. It will only iterate over the messages in the thread
1118 * which are not replies to other messages in the thread.
1120 * The returned list will be destroyed when the thread is destroyed.
1122 notmuch_messages_t *
1123 notmuch_thread_get_toplevel_messages (notmuch_thread_t *thread);
1126 * Get a notmuch_thread_t iterator for all messages in 'thread' in
1127 * oldest-first order.
1129 * The returned list will be destroyed when the thread is destroyed.
1131 notmuch_messages_t *
1132 notmuch_thread_get_messages (notmuch_thread_t *thread);
1135 * Get the number of messages in 'thread' that matched the search.
1137 * This count includes only the messages in this thread that were
1138 * matched by the search from which the thread was created and were
1139 * not excluded by any exclude tags passed in with the query (see
1140 * notmuch_query_add_tag_exclude). Contrast with
1141 * notmuch_thread_get_total_messages() .
1144 notmuch_thread_get_matched_messages (notmuch_thread_t *thread);
1147 * Get the authors of 'thread' as a UTF-8 string.
1149 * The returned string is a comma-separated list of the names of the
1150 * authors of mail messages in the query results that belong to this
1153 * The string contains authors of messages matching the query first, then
1154 * non-matched authors (with the two groups separated by '|'). Within
1155 * each group, authors are ordered by date.
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_authors (notmuch_thread_t *thread);
1166 * Get the subject of 'thread' as a UTF-8 string.
1168 * The subject is taken from the first message (according to the query
1169 * order---see notmuch_query_set_sort) in the query results that
1170 * belongs to this thread.
1172 * The returned string belongs to 'thread' and as such, should not be
1173 * modified by the caller and will only be valid for as long as the
1174 * thread is valid, (which is until notmuch_thread_destroy or until
1175 * the query from which it derived is destroyed).
1178 notmuch_thread_get_subject (notmuch_thread_t *thread);
1181 * Get the date of the oldest message in 'thread' as a time_t value.
1184 notmuch_thread_get_oldest_date (notmuch_thread_t *thread);
1187 * Get the date of the newest message in 'thread' as a time_t value.
1190 notmuch_thread_get_newest_date (notmuch_thread_t *thread);
1193 * Get the tags for 'thread', returning a notmuch_tags_t object which
1194 * can be used to iterate over all tags.
1196 * Note: In the Notmuch database, tags are stored on individual
1197 * messages, not on threads. So the tags returned here will be all
1198 * tags of the messages which matched the search and which belong to
1201 * The tags object is owned by the thread and as such, will only be
1202 * valid for as long as the thread is valid, (for example, until
1203 * notmuch_thread_destroy or until the query from which it derived is
1206 * Typical usage might be:
1208 * notmuch_thread_t *thread;
1209 * notmuch_tags_t *tags;
1212 * thread = notmuch_threads_get (threads);
1214 * for (tags = notmuch_thread_get_tags (thread);
1215 * notmuch_tags_valid (tags);
1216 * notmuch_tags_move_to_next (tags))
1218 * tag = notmuch_tags_get (tags);
1222 * notmuch_thread_destroy (thread);
1224 * Note that there's no explicit destructor needed for the
1225 * notmuch_tags_t object. (For consistency, we do provide a
1226 * notmuch_tags_destroy function, but there's no good reason to call
1227 * it if the message is about to be destroyed).
1230 notmuch_thread_get_tags (notmuch_thread_t *thread);
1233 * Destroy a notmuch_thread_t object.
1236 notmuch_thread_destroy (notmuch_thread_t *thread);
1239 * Is the given 'messages' iterator pointing at a valid message.
1241 * When this function returns TRUE, notmuch_messages_get will return a
1242 * valid object. Whereas when this function returns FALSE,
1243 * notmuch_messages_get will return NULL.
1245 * See the documentation of notmuch_query_search_messages for example
1246 * code showing how to iterate over a notmuch_messages_t object.
1249 notmuch_messages_valid (notmuch_messages_t *messages);
1252 * Get the current message from 'messages' as a notmuch_message_t.
1254 * Note: The returned message belongs to 'messages' and has a lifetime
1255 * identical to it (and the query to which it belongs).
1257 * See the documentation of notmuch_query_search_messages for example
1258 * code showing how to iterate over a notmuch_messages_t object.
1260 * If an out-of-memory situation occurs, this function will return
1264 notmuch_messages_get (notmuch_messages_t *messages);
1267 * Move the 'messages' iterator to the next message.
1269 * If 'messages' is already pointing at the last message then the
1270 * iterator will be moved to a point just beyond that last message,
1271 * (where notmuch_messages_valid will return FALSE and
1272 * notmuch_messages_get will return NULL).
1274 * See the documentation of notmuch_query_search_messages for example
1275 * code showing how to iterate over a notmuch_messages_t object.
1278 notmuch_messages_move_to_next (notmuch_messages_t *messages);
1281 * Destroy a notmuch_messages_t object.
1283 * It's not strictly necessary to call this function. All memory from
1284 * the notmuch_messages_t object will be reclaimed when the containing
1285 * query object is destroyed.
1288 notmuch_messages_destroy (notmuch_messages_t *messages);
1291 * Return a list of tags from all messages.
1293 * The resulting list is guaranteed not to contain duplicated tags.
1295 * WARNING: You can no longer iterate over messages after calling this
1296 * function, because the iterator will point at the end of the list.
1297 * We do not have a function to reset the iterator yet and the only
1298 * way how you can iterate over the list again is to recreate the
1301 * The function returns NULL on error.
1304 notmuch_messages_collect_tags (notmuch_messages_t *messages);
1307 * Get the message 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, (which is until the query from which it derived
1314 * This function will not return NULL since Notmuch ensures that every
1315 * message has a unique message ID, (Notmuch will generate an ID for a
1316 * message if the original file does not contain one).
1319 notmuch_message_get_message_id (notmuch_message_t *message);
1322 * Get the thread ID of 'message'.
1324 * The returned string belongs to 'message' and as such, should not be
1325 * modified by the caller and will only be valid for as long as the
1326 * message is valid, (for example, until the user calls
1327 * notmuch_message_destroy on 'message' or until a query from which it
1328 * derived is destroyed).
1330 * This function will not return NULL since Notmuch ensures that every
1331 * message belongs to a single thread.
1334 notmuch_message_get_thread_id (notmuch_message_t *message);
1337 * Get a notmuch_messages_t iterator for all of the replies to
1340 * Note: This call only makes sense if 'message' was ultimately
1341 * obtained from a notmuch_thread_t object, (such as by coming
1342 * directly from the result of calling notmuch_thread_get_
1343 * toplevel_messages or by any number of subsequent
1344 * calls to notmuch_message_get_replies).
1346 * If 'message' was obtained through some non-thread means, (such as
1347 * by a call to notmuch_query_search_messages), then this function
1350 * If there are no replies to 'message', this function will return
1351 * NULL. (Note that notmuch_messages_valid will accept that NULL
1352 * value as legitimate, and simply return FALSE for it.)
1354 notmuch_messages_t *
1355 notmuch_message_get_replies (notmuch_message_t *message);
1358 * Get the total number of files associated with a message.
1359 * @returns Non-negative integer
1360 * @since libnotmuch 5.0 (notmuch 0.25)
1363 notmuch_message_count_files (notmuch_message_t *message);
1366 * Get a filename for the email corresponding to 'message'.
1368 * The returned filename is an absolute filename, (the initial
1369 * component will match notmuch_database_get_path() ).
1371 * The returned string belongs to the message so should not be
1372 * modified or freed by the caller (nor should it be referenced after
1373 * the message is destroyed).
1375 * Note: If this message corresponds to multiple files in the mail
1376 * store, (that is, multiple files contain identical message IDs),
1377 * this function will arbitrarily return a single one of those
1378 * filenames. See notmuch_message_get_filenames for returning the
1379 * complete list of filenames.
1382 notmuch_message_get_filename (notmuch_message_t *message);
1385 * Get all filenames for the email corresponding to 'message'.
1387 * Returns a notmuch_filenames_t iterator listing all the filenames
1388 * associated with 'message'. These files may not have identical
1389 * content, but each will have the identical Message-ID.
1391 * Each filename in the iterator is an absolute filename, (the initial
1392 * component will match notmuch_database_get_path() ).
1394 notmuch_filenames_t *
1395 notmuch_message_get_filenames (notmuch_message_t *message);
1398 * Re-index the e-mail corresponding to 'message' using the supplied index options
1400 * Returns the status of the re-index operation. (see the return
1401 * codes documented in notmuch_database_add_message)
1403 * After reindexing, the user should discard the message object passed
1404 * in here by calling notmuch_message_destroy, since it refers to the
1405 * original message, not to the reindexed message.
1408 notmuch_message_reindex (notmuch_message_t *message,
1409 notmuch_param_t *indexopts);
1414 typedef enum _notmuch_message_flag {
1415 NOTMUCH_MESSAGE_FLAG_MATCH,
1416 NOTMUCH_MESSAGE_FLAG_EXCLUDED,
1418 /* This message is a "ghost message", meaning it has no filenames
1419 * or content, but we know it exists because it was referenced by
1420 * some other message. A ghost message has only a message ID and
1423 NOTMUCH_MESSAGE_FLAG_GHOST,
1424 } notmuch_message_flag_t;
1427 * Get a value of a flag for the email corresponding to 'message'.
1430 notmuch_message_get_flag (notmuch_message_t *message,
1431 notmuch_message_flag_t flag);
1434 * Set a value of a flag for the email corresponding to 'message'.
1437 notmuch_message_set_flag (notmuch_message_t *message,
1438 notmuch_message_flag_t flag, notmuch_bool_t value);
1441 * Get the date of 'message' as a time_t value.
1443 * For the original textual representation of the Date header from the
1444 * message call notmuch_message_get_header() with a header value of
1448 notmuch_message_get_date (notmuch_message_t *message);
1451 * Get the value of the specified header from 'message' as a UTF-8 string.
1453 * Common headers are stored in the database when the message is
1454 * indexed and will be returned from the database. Other headers will
1455 * be read from the actual message file.
1457 * The header name is case insensitive.
1459 * The returned string belongs to the message so should not be
1460 * modified or freed by the caller (nor should it be referenced after
1461 * the message is destroyed).
1463 * Returns an empty string ("") if the message does not contain a
1464 * header line matching 'header'. Returns NULL if any error occurs.
1467 notmuch_message_get_header (notmuch_message_t *message, const char *header);
1470 * Get the tags for 'message', returning a notmuch_tags_t object which
1471 * can be used to iterate over all tags.
1473 * The tags object is owned by the message and as such, will only be
1474 * valid for as long as the message is valid, (which is until the
1475 * query from which it derived is destroyed).
1477 * Typical usage might be:
1479 * notmuch_message_t *message;
1480 * notmuch_tags_t *tags;
1483 * message = notmuch_database_find_message (database, message_id);
1485 * for (tags = notmuch_message_get_tags (message);
1486 * notmuch_tags_valid (tags);
1487 * notmuch_tags_move_to_next (tags))
1489 * tag = notmuch_tags_get (tags);
1493 * notmuch_message_destroy (message);
1495 * Note that there's no explicit destructor needed for the
1496 * notmuch_tags_t object. (For consistency, we do provide a
1497 * notmuch_tags_destroy function, but there's no good reason to call
1498 * it if the message is about to be destroyed).
1501 notmuch_message_get_tags (notmuch_message_t *message);
1504 * The longest possible tag value.
1506 #define NOTMUCH_TAG_MAX 200
1509 * Add a tag to the given message.
1513 * NOTMUCH_STATUS_SUCCESS: Tag successfully added to message
1515 * NOTMUCH_STATUS_NULL_POINTER: The 'tag' argument is NULL
1517 * NOTMUCH_STATUS_TAG_TOO_LONG: The length of 'tag' is too long
1518 * (exceeds NOTMUCH_TAG_MAX)
1520 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
1521 * mode so message cannot be modified.
1524 notmuch_message_add_tag (notmuch_message_t *message, const char *tag);
1527 * Remove a tag from the given message.
1531 * NOTMUCH_STATUS_SUCCESS: Tag successfully removed from message
1533 * NOTMUCH_STATUS_NULL_POINTER: The 'tag' argument is NULL
1535 * NOTMUCH_STATUS_TAG_TOO_LONG: The length of 'tag' is too long
1536 * (exceeds NOTMUCH_TAG_MAX)
1538 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
1539 * mode so message cannot be modified.
1542 notmuch_message_remove_tag (notmuch_message_t *message, const char *tag);
1545 * Remove all tags from the given message.
1547 * See notmuch_message_freeze for an example showing how to safely
1548 * replace tag values.
1550 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
1551 * mode so message cannot be modified.
1554 notmuch_message_remove_all_tags (notmuch_message_t *message);
1557 * Add/remove tags according to maildir flags in the message filename(s).
1559 * This function examines the filenames of 'message' for maildir
1560 * flags, and adds or removes tags on 'message' as follows when these
1561 * flags are present:
1563 * Flag Action if present
1564 * ---- -----------------
1565 * 'D' Adds the "draft" tag to the message
1566 * 'F' Adds the "flagged" tag to the message
1567 * 'P' Adds the "passed" tag to the message
1568 * 'R' Adds the "replied" tag to the message
1569 * 'S' Removes the "unread" tag from the message
1571 * For each flag that is not present, the opposite action (add/remove)
1572 * is performed for the corresponding tags.
1574 * Flags are identified as trailing components of the filename after a
1575 * sequence of ":2,".
1577 * If there are multiple filenames associated with this message, the
1578 * flag is considered present if it appears in one or more
1579 * filenames. (That is, the flags from the multiple filenames are
1580 * combined with the logical OR operator.)
1582 * A client can ensure that notmuch database tags remain synchronized
1583 * with maildir flags by calling this function after each call to
1584 * notmuch_database_add_message. See also
1585 * notmuch_message_tags_to_maildir_flags for synchronizing tag changes
1586 * back to maildir flags.
1589 notmuch_message_maildir_flags_to_tags (notmuch_message_t *message);
1592 * Rename message filename(s) to encode tags as maildir flags.
1594 * Specifically, for each filename corresponding to this message:
1596 * If the filename is not in a maildir directory, do nothing. (A
1597 * maildir directory is determined as a directory named "new" or
1598 * "cur".) Similarly, if the filename has invalid maildir info,
1599 * (repeated or outof-ASCII-order flag characters after ":2,"), then
1602 * If the filename is in a maildir directory, rename the file so that
1603 * its filename ends with the sequence ":2," followed by zero or more
1604 * of the following single-character flags (in ASCII order):
1606 * * flag 'D' iff the message has the "draft" tag
1607 * * flag 'F' iff the message has the "flagged" tag
1608 * * flag 'P' iff the message has the "passed" tag
1609 * * flag 'R' iff the message has the "replied" tag
1610 * * flag 'S' iff the message does not have the "unread" tag
1612 * Any existing flags unmentioned in the list above will be preserved
1615 * Also, if this filename is in a directory named "new", rename it to
1616 * be within the neighboring directory named "cur".
1618 * A client can ensure that maildir filename flags remain synchronized
1619 * with notmuch database tags by calling this function after changing
1620 * tags, (after calls to notmuch_message_add_tag,
1621 * notmuch_message_remove_tag, or notmuch_message_freeze/
1622 * notmuch_message_thaw). See also notmuch_message_maildir_flags_to_tags
1623 * for synchronizing maildir flag changes back to tags.
1626 notmuch_message_tags_to_maildir_flags (notmuch_message_t *message);
1629 * Freeze the current state of 'message' within the database.
1631 * This means that changes to the message state, (via
1632 * notmuch_message_add_tag, notmuch_message_remove_tag, and
1633 * notmuch_message_remove_all_tags), will not be committed to the
1634 * database until the message is thawed with notmuch_message_thaw.
1636 * Multiple calls to freeze/thaw are valid and these calls will
1637 * "stack". That is there must be as many calls to thaw as to freeze
1638 * before a message is actually thawed.
1640 * The ability to do freeze/thaw allows for safe transactions to
1641 * change tag values. For example, explicitly setting a message to
1642 * have a given set of tags might look like this:
1644 * notmuch_message_freeze (message);
1646 * notmuch_message_remove_all_tags (message);
1648 * for (i = 0; i < NUM_TAGS; i++)
1649 * notmuch_message_add_tag (message, tags[i]);
1651 * notmuch_message_thaw (message);
1653 * With freeze/thaw used like this, the message in the database is
1654 * guaranteed to have either the full set of original tag values, or
1655 * the full set of new tag values, but nothing in between.
1657 * Imagine the example above without freeze/thaw and the operation
1658 * somehow getting interrupted. This could result in the message being
1659 * left with no tags if the interruption happened after
1660 * notmuch_message_remove_all_tags but before notmuch_message_add_tag.
1664 * NOTMUCH_STATUS_SUCCESS: Message successfully frozen.
1666 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
1667 * mode so message cannot be modified.
1670 notmuch_message_freeze (notmuch_message_t *message);
1673 * Thaw the current 'message', synchronizing any changes that may have
1674 * occurred while 'message' was frozen into the notmuch database.
1676 * See notmuch_message_freeze for an example of how to use this
1677 * function to safely provide tag changes.
1679 * Multiple calls to freeze/thaw are valid and these calls with
1680 * "stack". That is there must be as many calls to thaw as to freeze
1681 * before a message is actually thawed.
1685 * NOTMUCH_STATUS_SUCCESS: Message successfully thawed, (or at least
1686 * its frozen count has successfully been reduced by 1).
1688 * NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW: An attempt was made to thaw
1689 * an unfrozen message. That is, there have been an unbalanced
1690 * number of calls to notmuch_message_freeze and
1691 * notmuch_message_thaw.
1694 notmuch_message_thaw (notmuch_message_t *message);
1697 * Destroy a notmuch_message_t object.
1699 * It can be useful to call this function in the case of a single
1700 * query object with many messages in the result, (such as iterating
1701 * over the entire database). Otherwise, it's fine to never call this
1702 * function and there will still be no memory leaks. (The memory from
1703 * the messages get reclaimed when the containing query is destroyed.)
1706 notmuch_message_destroy (notmuch_message_t *message);
1709 * @name Message Properties
1711 * This interface provides the ability to attach arbitrary (key,value)
1712 * string pairs to a message, to remove such pairs, and to iterate
1713 * over them. The caller should take some care as to what keys they
1714 * add or delete values for, as other subsystems or extensions may
1715 * depend on these properties.
1720 * Retrieve the value for a single property key
1722 * *value* is set to a string owned by the message or NULL if there is
1723 * no such key. In the case of multiple values for the given key, the
1724 * first one is retrieved.
1727 * - NOTMUCH_STATUS_NULL_POINTER: *value* may not be NULL.
1728 * - NOTMUCH_STATUS_SUCCESS: No error occured.
1729 * @since libnotmuch 4.4 (notmuch 0.23)
1732 notmuch_message_get_property (notmuch_message_t *message, const char *key, const char **value);
1735 * Add a (key,value) pair to a message
1738 * - NOTMUCH_STATUS_ILLEGAL_ARGUMENT: *key* may not contain an '=' character.
1739 * - NOTMUCH_STATUS_NULL_POINTER: Neither *key* nor *value* may be NULL.
1740 * - NOTMUCH_STATUS_SUCCESS: No error occured.
1741 * @since libnotmuch 4.4 (notmuch 0.23)
1744 notmuch_message_add_property (notmuch_message_t *message, const char *key, const char *value);
1747 * Remove a (key,value) pair from a message.
1749 * It is not an error to remove a non-existant (key,value) pair
1752 * - NOTMUCH_STATUS_ILLEGAL_ARGUMENT: *key* may not contain an '=' character.
1753 * - NOTMUCH_STATUS_NULL_POINTER: Neither *key* nor *value* may be NULL.
1754 * - NOTMUCH_STATUS_SUCCESS: No error occured.
1755 * @since libnotmuch 4.4 (notmuch 0.23)
1758 notmuch_message_remove_property (notmuch_message_t *message, const char *key, const char *value);
1761 * Remove all (key,value) pairs from the given message.
1763 * @param[in,out] message message to operate on.
1764 * @param[in] key key to delete properties for. If NULL, delete
1765 * properties for all keys
1767 * - NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in
1768 * read-only mode so message cannot be modified.
1769 * - NOTMUCH_STATUS_SUCCESS: No error occured.
1771 * @since libnotmuch 4.4 (notmuch 0.23)
1774 notmuch_message_remove_all_properties (notmuch_message_t *message, const char *key);
1777 * Opaque message property iterator
1779 typedef struct _notmuch_string_map_iterator notmuch_message_properties_t;
1782 * Get the properties for *message*, returning a
1783 * notmuch_message_properties_t object which can be used to iterate
1784 * over all properties.
1786 * The notmuch_message_properties_t object is owned by the message and
1787 * as such, will only be valid for as long as the message is valid,
1788 * (which is until the query from which it derived is destroyed).
1790 * @param[in] message The message to examine
1791 * @param[in] key key or key prefix
1792 * @param[in] exact if TRUE, require exact match with key. Otherwise
1795 * Typical usage might be:
1797 * notmuch_message_properties_t *list;
1799 * for (list = notmuch_message_get_properties (message, "testkey1", TRUE);
1800 * notmuch_message_properties_valid (list); notmuch_message_properties_move_to_next (list)) {
1801 * printf("%s\n", notmuch_message_properties_value(list));
1804 * notmuch_message_properties_destroy (list);
1806 * Note that there's no explicit destructor needed for the
1807 * notmuch_message_properties_t object. (For consistency, we do
1808 * provide a notmuch_message_properities_destroy function, but there's
1809 * no good reason to call it if the message is about to be destroyed).
1811 * @since libnotmuch 4.4 (notmuch 0.23)
1813 notmuch_message_properties_t *
1814 notmuch_message_get_properties (notmuch_message_t *message, const char *key, notmuch_bool_t exact);
1817 * Is the given *properties* iterator pointing at a valid (key,value)
1820 * When this function returns TRUE,
1821 * notmuch_message_properties_{key,value} will return a valid string,
1822 * and notmuch_message_properties_move_to_next will do what it
1823 * says. Whereas when this function returns FALSE, calling any of
1824 * these functions results in undefined behaviour.
1826 * See the documentation of notmuch_message_properties_get for example
1827 * code showing how to iterate over a notmuch_message_properties_t
1830 * @since libnotmuch 4.4 (notmuch 0.23)
1833 notmuch_message_properties_valid (notmuch_message_properties_t *properties);
1836 * Move the *properties* iterator to the next (key,value) pair
1838 * If *properties* is already pointing at the last pair then the iterator
1839 * will be moved to a point just beyond that last pair, (where
1840 * notmuch_message_properties_valid will return FALSE).
1842 * See the documentation of notmuch_message_get_properties for example
1843 * code showing how to iterate over a notmuch_message_properties_t object.
1845 * @since libnotmuch 4.4 (notmuch 0.23)
1848 notmuch_message_properties_move_to_next (notmuch_message_properties_t *properties);
1851 * Return the key from the current (key,value) pair.
1853 * this could be useful if iterating for a prefix
1855 * @since libnotmuch 4.4 (notmuch 0.23)
1858 notmuch_message_properties_key (notmuch_message_properties_t *properties);
1861 * Return the value from the current (key,value) pair.
1863 * This could be useful if iterating for a prefix.
1865 * @since libnotmuch 4.4 (notmuch 0.23)
1868 notmuch_message_properties_value (notmuch_message_properties_t *properties);
1872 * Destroy a notmuch_message_properties_t object.
1874 * It's not strictly necessary to call this function. All memory from
1875 * the notmuch_message_properties_t object will be reclaimed when the
1876 * containing message object is destroyed.
1878 * @since libnotmuch 4.4 (notmuch 0.23)
1881 notmuch_message_properties_destroy (notmuch_message_properties_t *properties);
1886 * Is the given 'tags' iterator pointing at a valid tag.
1888 * When this function returns TRUE, notmuch_tags_get will return a
1889 * valid string. Whereas when this function returns FALSE,
1890 * notmuch_tags_get will return NULL.
1892 * See the documentation of notmuch_message_get_tags for example code
1893 * showing how to iterate over a notmuch_tags_t object.
1896 notmuch_tags_valid (notmuch_tags_t *tags);
1899 * Get the current tag from 'tags' as a string.
1901 * Note: The returned string belongs to 'tags' and has a lifetime
1902 * identical to it (and the query to which it ultimately belongs).
1904 * See the documentation of notmuch_message_get_tags for example code
1905 * showing how to iterate over a notmuch_tags_t object.
1908 notmuch_tags_get (notmuch_tags_t *tags);
1911 * Move the 'tags' iterator to the next tag.
1913 * If 'tags' is already pointing at the last tag then the iterator
1914 * will be moved to a point just beyond that last tag, (where
1915 * notmuch_tags_valid will return FALSE and notmuch_tags_get will
1918 * See the documentation of notmuch_message_get_tags for example code
1919 * showing how to iterate over a notmuch_tags_t object.
1922 notmuch_tags_move_to_next (notmuch_tags_t *tags);
1925 * Destroy a notmuch_tags_t object.
1927 * It's not strictly necessary to call this function. All memory from
1928 * the notmuch_tags_t object will be reclaimed when the containing
1929 * message or query objects are destroyed.
1932 notmuch_tags_destroy (notmuch_tags_t *tags);
1935 * Store an mtime within the database for 'directory'.
1937 * The 'directory' should be an object retrieved from the database
1938 * with notmuch_database_get_directory for a particular path.
1940 * The intention is for the caller to use the mtime to allow efficient
1941 * identification of new messages to be added to the database. The
1942 * recommended usage is as follows:
1944 * o Read the mtime of a directory from the filesystem
1946 * o Call add_message for all mail files in the directory
1948 * o Call notmuch_directory_set_mtime with the mtime read from the
1951 * Then, when wanting to check for updates to the directory in the
1952 * future, the client can call notmuch_directory_get_mtime and know
1953 * that it only needs to add files if the mtime of the directory and
1954 * files are newer than the stored timestamp.
1956 * Note: The notmuch_directory_get_mtime function does not allow the
1957 * caller to distinguish a timestamp of 0 from a non-existent
1958 * timestamp. So don't store a timestamp of 0 unless you are
1959 * comfortable with that.
1963 * NOTMUCH_STATUS_SUCCESS: mtime successfully stored in database.
1965 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception
1966 * occurred, mtime not stored.
1968 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
1969 * mode so directory mtime cannot be modified.
1972 notmuch_directory_set_mtime (notmuch_directory_t *directory,
1976 * Get the mtime of a directory, (as previously stored with
1977 * notmuch_directory_set_mtime).
1979 * Returns 0 if no mtime has previously been stored for this
1983 notmuch_directory_get_mtime (notmuch_directory_t *directory);
1986 * Get a notmuch_filenames_t iterator listing all the filenames of
1987 * messages in the database within the given directory.
1989 * The returned filenames will be the basename-entries only (not
1992 notmuch_filenames_t *
1993 notmuch_directory_get_child_files (notmuch_directory_t *directory);
1996 * Get a notmuch_filenames_t iterator listing all the filenames of
1997 * sub-directories in the database within the given directory.
1999 * The returned filenames will be the basename-entries only (not
2002 notmuch_filenames_t *
2003 notmuch_directory_get_child_directories (notmuch_directory_t *directory);
2006 * Delete directory document from the database, and destroy the
2007 * notmuch_directory_t object. Assumes any child directories and files
2008 * have been deleted by the caller.
2010 * @since libnotmuch 4.3 (notmuch 0.21)
2013 notmuch_directory_delete (notmuch_directory_t *directory);
2016 * Destroy a notmuch_directory_t object.
2019 notmuch_directory_destroy (notmuch_directory_t *directory);
2022 * Is the given 'filenames' iterator pointing at a valid filename.
2024 * When this function returns TRUE, notmuch_filenames_get will return
2025 * a valid string. Whereas when this function returns FALSE,
2026 * notmuch_filenames_get will return NULL.
2028 * It is acceptable to pass NULL for 'filenames', in which case this
2029 * function will always return FALSE.
2032 notmuch_filenames_valid (notmuch_filenames_t *filenames);
2035 * Get the current filename from 'filenames' as a string.
2037 * Note: The returned string belongs to 'filenames' and has a lifetime
2038 * identical to it (and the directory to which it ultimately belongs).
2040 * It is acceptable to pass NULL for 'filenames', in which case this
2041 * function will always return NULL.
2044 notmuch_filenames_get (notmuch_filenames_t *filenames);
2047 * Move the 'filenames' iterator to the next filename.
2049 * If 'filenames' is already pointing at the last filename then the
2050 * iterator will be moved to a point just beyond that last filename,
2051 * (where notmuch_filenames_valid will return FALSE and
2052 * notmuch_filenames_get will return NULL).
2054 * It is acceptable to pass NULL for 'filenames', in which case this
2055 * function will do nothing.
2058 notmuch_filenames_move_to_next (notmuch_filenames_t *filenames);
2061 * Destroy a notmuch_filenames_t object.
2063 * It's not strictly necessary to call this function. All memory from
2064 * the notmuch_filenames_t object will be reclaimed when the
2065 * containing directory object is destroyed.
2067 * It is acceptable to pass NULL for 'filenames', in which case this
2068 * function will do nothing.
2071 notmuch_filenames_destroy (notmuch_filenames_t *filenames);
2075 * set config 'key' to 'value'
2077 * @since libnotmuch 4.4 (notmuch 0.23)
2080 notmuch_database_set_config (notmuch_database_t *db, const char *key, const char *value);
2083 * retrieve config item 'key', assign to 'value'
2085 * keys which have not been previously set with n_d_set_config will
2086 * return an empty string.
2088 * return value is allocated by malloc and should be freed by the
2091 * @since libnotmuch 4.4 (notmuch 0.23)
2094 notmuch_database_get_config (notmuch_database_t *db, const char *key, char **value);
2097 * Create an iterator for all config items with keys matching a given prefix
2099 * @since libnotmuch 4.4 (notmuch 0.23)
2102 notmuch_database_get_config_list (notmuch_database_t *db, const char *prefix, notmuch_config_list_t **out);
2105 * Is 'config_list' iterator valid (i.e. _key, _value, _move_to_next can be called).
2107 * @since libnotmuch 4.4 (notmuch 0.23)
2110 notmuch_config_list_valid (notmuch_config_list_t *config_list);
2113 * return key for current config pair
2115 * return value is owned by the iterator, and will be destroyed by the
2116 * next call to notmuch_config_list_key or notmuch_config_list_destroy.
2118 * @since libnotmuch 4.4 (notmuch 0.23)
2121 notmuch_config_list_key (notmuch_config_list_t *config_list);
2124 * return 'value' for current config pair
2126 * return value is owned by the iterator, and will be destroyed by the
2127 * next call to notmuch_config_list_value or notmuch config_list_destroy
2129 * @since libnotmuch 4.4 (notmuch 0.23)
2132 notmuch_config_list_value (notmuch_config_list_t *config_list);
2136 * move 'config_list' iterator to the next pair
2138 * @since libnotmuch 4.4 (notmuch 0.23)
2141 notmuch_config_list_move_to_next (notmuch_config_list_t *config_list);
2144 * free any resources held by 'config_list'
2146 * @since libnotmuch 4.4 (notmuch 0.23)
2149 notmuch_config_list_destroy (notmuch_config_list_t *config_list);
2152 * interrogate the library for compile time features
2154 * @since libnotmuch 4.4 (notmuch 0.23)
2157 notmuch_built_with (const char *name);
2160 #pragma GCC visibility pop