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 2
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 * A MIME object claimed to have cryptographic protection which
196 * notmuch tried to handle, but the protocol was not specified in
197 * an intelligible way.
199 NOTMUCH_STATUS_MALFORMED_CRYPTO_PROTOCOL,
201 * Notmuch attempted to do crypto processing, but could not
202 * initialize the engine needed to do so.
204 NOTMUCH_STATUS_FAILED_CRYPTO_CONTEXT_CREATION,
206 * A MIME object claimed to have cryptographic protection, and
207 * notmuch attempted to process it, but the specific protocol was
208 * something that notmuch doesn't know how to handle.
210 NOTMUCH_STATUS_UNKNOWN_CRYPTO_PROTOCOL,
212 * Not an actual status value. Just a way to find out how many
213 * valid status values there are.
215 NOTMUCH_STATUS_LAST_STATUS
219 * Get a string representation of a notmuch_status_t value.
221 * The result is read-only.
224 notmuch_status_to_string (notmuch_status_t status);
226 /* Various opaque data types. For each notmuch_<foo>_t see the various
227 * notmuch_<foo> functions below. */
229 typedef struct _notmuch_database notmuch_database_t;
230 typedef struct _notmuch_query notmuch_query_t;
231 typedef struct _notmuch_threads notmuch_threads_t;
232 typedef struct _notmuch_thread notmuch_thread_t;
233 typedef struct _notmuch_messages notmuch_messages_t;
234 typedef struct _notmuch_message notmuch_message_t;
235 typedef struct _notmuch_tags notmuch_tags_t;
236 typedef struct _notmuch_directory notmuch_directory_t;
237 typedef struct _notmuch_filenames notmuch_filenames_t;
238 typedef struct _notmuch_config_list notmuch_config_list_t;
239 typedef struct _notmuch_indexopts notmuch_indexopts_t;
240 #endif /* __DOXYGEN__ */
243 * Create a new, empty notmuch database located at 'path'.
245 * The path should be a top-level directory to a collection of
246 * plain-text email messages (one message per file). This call will
247 * create a new ".notmuch" directory within 'path' where notmuch will
250 * After a successful call to notmuch_database_create, the returned
251 * database will be open so the caller should call
252 * notmuch_database_destroy when finished with it.
254 * The database will not yet have any data in it
255 * (notmuch_database_create itself is a very cheap function). Messages
256 * contained within 'path' can be added to the database by calling
257 * notmuch_database_index_file.
259 * In case of any failure, this function returns an error status and
260 * sets *database to NULL (after printing an error message on stderr).
264 * NOTMUCH_STATUS_SUCCESS: Successfully created the database.
266 * NOTMUCH_STATUS_NULL_POINTER: The given 'path' argument is NULL.
268 * NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory.
270 * NOTMUCH_STATUS_FILE_ERROR: An error occurred trying to create the
271 * database file (such as permission denied, or file not found,
272 * etc.), or the database already exists.
274 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred.
277 notmuch_database_create (const char *path, notmuch_database_t **database);
280 * Like notmuch_database_create, except optionally return an error
281 * message. This message is allocated by malloc and should be freed by
285 notmuch_database_create_verbose (const char *path,
286 notmuch_database_t **database,
287 char **error_message);
290 * Database open mode for notmuch_database_open.
294 * Open database for reading only.
296 NOTMUCH_DATABASE_MODE_READ_ONLY = 0,
298 * Open database for reading and writing.
300 NOTMUCH_DATABASE_MODE_READ_WRITE
301 } notmuch_database_mode_t;
304 * Open an existing notmuch database located at 'path'.
306 * The database should have been created at some time in the past,
307 * (not necessarily by this process), by calling
308 * notmuch_database_create with 'path'. By default the database should be
309 * opened for reading only. In order to write to the database you need to
310 * pass the NOTMUCH_DATABASE_MODE_READ_WRITE mode.
312 * An existing notmuch database can be identified by the presence of a
313 * directory named ".notmuch" below 'path'.
315 * The caller should call notmuch_database_destroy when finished with
318 * In case of any failure, this function returns an error status and
319 * sets *database to NULL (after printing an error message on stderr).
323 * NOTMUCH_STATUS_SUCCESS: Successfully opened the database.
325 * NOTMUCH_STATUS_NULL_POINTER: The given 'path' argument is NULL.
327 * NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory.
329 * NOTMUCH_STATUS_FILE_ERROR: An error occurred trying to open the
330 * database file (such as permission denied, or file not found,
331 * etc.), or the database version is unknown.
333 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred.
336 notmuch_database_open (const char *path,
337 notmuch_database_mode_t mode,
338 notmuch_database_t **database);
340 * Like notmuch_database_open, except optionally return an error
341 * message. This message is allocated by malloc and should be freed by
346 notmuch_database_open_verbose (const char *path,
347 notmuch_database_mode_t mode,
348 notmuch_database_t **database,
349 char **error_message);
352 * Retrieve last status string for given database.
356 notmuch_database_status_string (const notmuch_database_t *notmuch);
359 * Commit changes and close the given notmuch database.
361 * After notmuch_database_close has been called, calls to other
362 * functions on objects derived from this database may either behave
363 * as if the database had not been closed (e.g., if the required data
364 * has been cached) or may fail with a
365 * NOTMUCH_STATUS_XAPIAN_EXCEPTION. The only further operation
366 * permitted on the database itself is to call
367 * notmuch_database_destroy.
369 * notmuch_database_close can be called multiple times. Later calls
372 * For writable databases, notmuch_database_close commits all changes
373 * to disk before closing the database. If the caller is currently in
374 * an atomic section (there was a notmuch_database_begin_atomic
375 * without a matching notmuch_database_end_atomic), this will discard
376 * changes made in that atomic section (but still commit changes made
377 * prior to entering the atomic section).
381 * NOTMUCH_STATUS_SUCCESS: Successfully closed the database.
383 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred; the
384 * database has been closed but there are no guarantees the
385 * changes to the database, if any, have been flushed to disk.
388 notmuch_database_close (notmuch_database_t *database);
391 * A callback invoked by notmuch_database_compact to notify the user
392 * of the progress of the compaction process.
394 typedef void (*notmuch_compact_status_cb_t)(const char *message, void *closure);
397 * Compact a notmuch database, backing up the original database to the
400 * The database will be opened with NOTMUCH_DATABASE_MODE_READ_WRITE
401 * during the compaction process to ensure no writes are made.
403 * If the optional callback function 'status_cb' is non-NULL, it will
404 * be called with diagnostic and informational messages. The argument
405 * 'closure' is passed verbatim to any callback invoked.
408 notmuch_database_compact (const char* path,
409 const char* backup_path,
410 notmuch_compact_status_cb_t status_cb,
414 * Destroy the notmuch database, closing it if necessary and freeing
415 * all associated resources.
417 * Return value as in notmuch_database_close if the database was open;
418 * notmuch_database_destroy itself has no failure modes.
421 notmuch_database_destroy (notmuch_database_t *database);
424 * Return the database path of the given database.
426 * The return value is a string owned by notmuch so should not be
427 * modified nor freed by the caller.
430 notmuch_database_get_path (notmuch_database_t *database);
433 * Return the database format version of the given database.
436 notmuch_database_get_version (notmuch_database_t *database);
439 * Can the database be upgraded to a newer database version?
441 * If this function returns TRUE, then the caller may call
442 * notmuch_database_upgrade to upgrade the database. If the caller
443 * does not upgrade an out-of-date database, then some functions may
444 * fail with NOTMUCH_STATUS_UPGRADE_REQUIRED. This always returns
445 * FALSE for a read-only database because there's no way to upgrade a
446 * read-only database.
449 notmuch_database_needs_upgrade (notmuch_database_t *database);
452 * Upgrade the current database to the latest supported version.
454 * This ensures that all current notmuch functionality will be
455 * available on the database. After opening a database in read-write
456 * mode, it is recommended that clients check if an upgrade is needed
457 * (notmuch_database_needs_upgrade) and if so, upgrade with this
458 * function before making any modifications. If
459 * notmuch_database_needs_upgrade returns FALSE, this will be a no-op.
461 * The optional progress_notify callback can be used by the caller to
462 * provide progress indication to the user. If non-NULL it will be
463 * called periodically with 'progress' as a floating-point value in
464 * the range of [0.0 .. 1.0] indicating the progress made so far in
465 * the upgrade process. The argument 'closure' is passed verbatim to
466 * any callback invoked.
469 notmuch_database_upgrade (notmuch_database_t *database,
470 void (*progress_notify) (void *closure,
475 * Begin an atomic database operation.
477 * Any modifications performed between a successful begin and a
478 * notmuch_database_end_atomic will be applied to the database
479 * atomically. Note that, unlike a typical database transaction, this
480 * only ensures atomicity, not durability; neither begin nor end
481 * necessarily flush modifications to disk.
483 * Atomic sections may be nested. begin_atomic and end_atomic must
484 * always be called in pairs.
488 * NOTMUCH_STATUS_SUCCESS: Successfully entered atomic section.
490 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred;
491 * atomic section not entered.
494 notmuch_database_begin_atomic (notmuch_database_t *notmuch);
497 * Indicate the end of an atomic database operation.
501 * NOTMUCH_STATUS_SUCCESS: Successfully completed atomic section.
503 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred;
504 * atomic section not ended.
506 * NOTMUCH_STATUS_UNBALANCED_ATOMIC: The database is not currently in
510 notmuch_database_end_atomic (notmuch_database_t *notmuch);
513 * Return the committed database revision and UUID.
515 * The database revision number increases monotonically with each
516 * commit to the database. Hence, all messages and message changes
517 * committed to the database (that is, visible to readers) have a last
518 * modification revision <= the committed database revision. Any
519 * messages committed in the future will be assigned a modification
520 * revision > the committed database revision.
522 * The UUID is a NUL-terminated opaque string that uniquely identifies
523 * this database. Two revision numbers are only comparable if they
524 * have the same database UUID.
527 notmuch_database_get_revision (notmuch_database_t *notmuch,
531 * Retrieve a directory object from the database for 'path'.
533 * Here, 'path' should be a path relative to the path of 'database'
534 * (see notmuch_database_get_path), or else should be an absolute path
535 * with initial components that match the path of 'database'.
537 * If this directory object does not exist in the database, this
538 * returns NOTMUCH_STATUS_SUCCESS and sets *directory to NULL.
540 * Otherwise the returned directory object is owned by the database
541 * and as such, will only be valid until notmuch_database_destroy is
546 * NOTMUCH_STATUS_SUCCESS: Successfully retrieved directory.
548 * NOTMUCH_STATUS_NULL_POINTER: The given 'directory' argument is NULL.
550 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred;
551 * directory not retrieved.
553 * NOTMUCH_STATUS_UPGRADE_REQUIRED: The caller must upgrade the
554 * database to use this function.
557 notmuch_database_get_directory (notmuch_database_t *database,
559 notmuch_directory_t **directory);
562 * Add a message file to a database, indexing it for retrieval by
563 * future searches. If a message already exists with the same message
564 * ID as the specified file, their indexes will be merged, and this
565 * new filename will also be associated with the existing message.
567 * Here, 'filename' should be a path relative to the path of
568 * 'database' (see notmuch_database_get_path), or else should be an
569 * absolute filename with initial components that match the path of
572 * The file should be a single mail message (not a multi-message mbox)
573 * that is expected to remain at its current location, (since the
574 * notmuch database will reference the filename, and will not copy the
575 * entire contents of the file.
577 * If another message with the same message ID already exists in the
578 * database, rather than creating a new message, this adds the search
579 * terms from the identified file to the existing message's index, and
580 * adds 'filename' to the list of filenames known for the message.
582 * The 'indexopts' parameter can be NULL (meaning, use the indexing
583 * defaults from the database), or can be an explicit choice of
584 * indexing options that should govern the indexing of this specific
587 * If 'message' is not NULL, then, on successful return
588 * (NOTMUCH_STATUS_SUCCESS or NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID) '*message'
589 * will be initialized to a message object that can be used for things
590 * such as adding tags to the just-added message. The user should call
591 * notmuch_message_destroy when done with the message. On any failure
592 * '*message' will be set to NULL.
596 * NOTMUCH_STATUS_SUCCESS: Message successfully added to database.
598 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred,
601 * NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID: Message has the same message
602 * ID as another message already in the database. The new
603 * filename was successfully added to the message in the database
604 * (if not already present) and the existing message is returned.
606 * NOTMUCH_STATUS_FILE_ERROR: an error occurred trying to open the
607 * file, (such as permission denied, or file not found,
608 * etc.). Nothing added to the database.
610 * NOTMUCH_STATUS_FILE_NOT_EMAIL: the contents of filename don't look
611 * like an email message. Nothing added to the database.
613 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
614 * mode so no message can be added.
616 * NOTMUCH_STATUS_UPGRADE_REQUIRED: The caller must upgrade the
617 * database to use this function.
619 * @since libnotmuch 5.1 (notmuch 0.26)
622 notmuch_database_index_file (notmuch_database_t *database,
623 const char *filename,
624 notmuch_indexopts_t *indexopts,
625 notmuch_message_t **message);
628 * Deprecated alias for notmuch_database_index_file called with
631 * @deprecated Deprecated as of libnotmuch 5.1 (notmuch 0.26). Please
632 * use notmuch_database_index_file instead.
635 NOTMUCH_DEPRECATED(5,1)
637 notmuch_database_add_message (notmuch_database_t *database,
638 const char *filename,
639 notmuch_message_t **message);
642 * Remove a message filename from the given notmuch database. If the
643 * message has no more filenames, remove the message.
645 * If the same message (as determined by the message ID) is still
646 * available via other filenames, then the message will persist in the
647 * database for those filenames. When the last filename is removed for
648 * a particular message, the database content for that message will be
653 * NOTMUCH_STATUS_SUCCESS: The last filename was removed and the
654 * message was removed from the database.
656 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred,
657 * message not removed.
659 * NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID: This filename was removed but
660 * the message persists in the database with at least one other
663 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
664 * mode so no message can be removed.
666 * NOTMUCH_STATUS_UPGRADE_REQUIRED: The caller must upgrade the
667 * database to use this function.
670 notmuch_database_remove_message (notmuch_database_t *database,
671 const char *filename);
674 * Find a message with the given message_id.
676 * If a message with the given message_id is found then, on successful return
677 * (NOTMUCH_STATUS_SUCCESS) '*message' will be initialized to a message
678 * object. The caller should call notmuch_message_destroy when done with the
681 * On any failure or when the message is not found, this function initializes
682 * '*message' to NULL. This means, when NOTMUCH_STATUS_SUCCESS is returned, the
683 * caller is supposed to check '*message' for NULL to find out whether the
684 * message with the given message_id was found.
688 * NOTMUCH_STATUS_SUCCESS: Successful return, check '*message'.
690 * NOTMUCH_STATUS_NULL_POINTER: The given 'message' argument is NULL
692 * NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory, creating message object
694 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred
697 notmuch_database_find_message (notmuch_database_t *database,
698 const char *message_id,
699 notmuch_message_t **message);
702 * Find a message with the given filename.
704 * If the database contains a message with the given filename then, on
705 * successful return (NOTMUCH_STATUS_SUCCESS) '*message' will be initialized to
706 * a message object. The caller should call notmuch_message_destroy when done
709 * On any failure or when the message is not found, this function initializes
710 * '*message' to NULL. This means, when NOTMUCH_STATUS_SUCCESS is returned, the
711 * caller is supposed to check '*message' for NULL to find out whether the
712 * message with the given filename is found.
716 * NOTMUCH_STATUS_SUCCESS: Successful return, check '*message'
718 * NOTMUCH_STATUS_NULL_POINTER: The given 'message' argument is NULL
720 * NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory, creating the message object
722 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred
724 * NOTMUCH_STATUS_UPGRADE_REQUIRED: The caller must upgrade the
725 * database to use this function.
728 notmuch_database_find_message_by_filename (notmuch_database_t *notmuch,
729 const char *filename,
730 notmuch_message_t **message);
733 * Return a list of all tags found in the database.
735 * This function creates a list of all tags found in the database. The
736 * resulting list contains all tags from all messages found in the database.
738 * On error this function returns NULL.
741 notmuch_database_get_all_tags (notmuch_database_t *db);
744 * Create a new query for 'database'.
746 * Here, 'database' should be an open database, (see
747 * notmuch_database_open and notmuch_database_create).
749 * For the query string, we'll document the syntax here more
750 * completely in the future, but it's likely to be a specialized
751 * version of the general Xapian query syntax:
753 * https://xapian.org/docs/queryparser.html
755 * As a special case, passing either a length-zero string, (that is ""),
756 * or a string consisting of a single asterisk (that is "*"), will
757 * result in a query that returns all messages in the database.
759 * See notmuch_query_set_sort for controlling the order of results.
760 * See notmuch_query_search_messages and notmuch_query_search_threads
761 * to actually execute the query.
763 * User should call notmuch_query_destroy when finished with this
766 * Will return NULL if insufficient memory is available.
769 notmuch_query_create (notmuch_database_t *database,
770 const char *query_string);
773 * Sort values for notmuch_query_set_sort.
779 NOTMUCH_SORT_OLDEST_FIRST,
783 NOTMUCH_SORT_NEWEST_FIRST,
785 * Sort by message-id.
787 NOTMUCH_SORT_MESSAGE_ID,
791 NOTMUCH_SORT_UNSORTED
795 * Return the query_string of this query. See notmuch_query_create.
798 notmuch_query_get_query_string (const notmuch_query_t *query);
801 * Return the notmuch database of this query. See notmuch_query_create.
804 notmuch_query_get_database (const notmuch_query_t *query);
807 * Exclude values for notmuch_query_set_omit_excluded. The strange
808 * order is to maintain backward compatibility: the old FALSE/TRUE
809 * options correspond to the new
810 * NOTMUCH_EXCLUDE_FLAG/NOTMUCH_EXCLUDE_TRUE options.
813 NOTMUCH_EXCLUDE_FLAG,
814 NOTMUCH_EXCLUDE_TRUE,
815 NOTMUCH_EXCLUDE_FALSE,
820 * Specify whether to omit excluded results or simply flag them. By
821 * default, this is set to TRUE.
823 * If set to TRUE or ALL, notmuch_query_search_messages will omit excluded
824 * messages from the results, and notmuch_query_search_threads will omit
825 * threads that match only in excluded messages. If set to TRUE,
826 * notmuch_query_search_threads will include all messages in threads that
827 * match in at least one non-excluded message. Otherwise, if set to ALL,
828 * notmuch_query_search_threads will omit excluded messages from all threads.
830 * If set to FALSE or FLAG then both notmuch_query_search_messages and
831 * notmuch_query_search_threads will return all matching
832 * messages/threads regardless of exclude status. If set to FLAG then
833 * the exclude flag will be set for any excluded message that is
834 * returned by notmuch_query_search_messages, and the thread counts
835 * for threads returned by notmuch_query_search_threads will be the
836 * number of non-excluded messages/matches. Otherwise, if set to
837 * FALSE, then the exclude status is completely ignored.
839 * The performance difference when calling
840 * notmuch_query_search_messages should be relatively small (and both
841 * should be very fast). However, in some cases,
842 * notmuch_query_search_threads is very much faster when omitting
843 * excluded messages as it does not need to construct the threads that
844 * only match in excluded messages.
847 notmuch_query_set_omit_excluded (notmuch_query_t *query,
848 notmuch_exclude_t omit_excluded);
851 * Specify the sorting desired for this query.
854 notmuch_query_set_sort (notmuch_query_t *query, notmuch_sort_t sort);
857 * Return the sort specified for this query. See
858 * notmuch_query_set_sort.
861 notmuch_query_get_sort (const notmuch_query_t *query);
864 * Add a tag that will be excluded from the query results by default.
865 * This exclusion will be ignored if this tag appears explicitly in
870 * NOTMUCH_STATUS_SUCCESS: excluded was added successfully.
872 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: a Xapian exception occurred.
873 * Most likely a problem lazily parsing the query string.
875 * NOTMUCH_STATUS_IGNORED: tag is explicitly present in the query, so
879 notmuch_query_add_tag_exclude (notmuch_query_t *query, const char *tag);
882 * Execute a query for threads, returning a notmuch_threads_t object
883 * which can be used to iterate over the results. The returned threads
884 * object is owned by the query and as such, will only be valid until
885 * notmuch_query_destroy.
887 * Typical usage might be:
889 * notmuch_query_t *query;
890 * notmuch_threads_t *threads;
891 * notmuch_thread_t *thread;
893 * query = notmuch_query_create (database, query_string);
895 * for (threads = notmuch_query_search_threads (query);
896 * notmuch_threads_valid (threads);
897 * notmuch_threads_move_to_next (threads))
899 * thread = notmuch_threads_get (threads);
901 * notmuch_thread_destroy (thread);
904 * notmuch_query_destroy (query);
906 * Note: If you are finished with a thread before its containing
907 * query, you can call notmuch_thread_destroy to clean up some memory
908 * sooner (as in the above example). Otherwise, if your thread objects
909 * are long-lived, then you don't need to call notmuch_thread_destroy
910 * and all the memory will still be reclaimed when the query is
913 * Note that there's no explicit destructor needed for the
914 * notmuch_threads_t object. (For consistency, we do provide a
915 * notmuch_threads_destroy function, but there's no good reason
916 * to call it if the query is about to be destroyed).
918 * @since libnotmuch 5.0 (notmuch 0.25)
921 notmuch_query_search_threads (notmuch_query_t *query,
922 notmuch_threads_t **out);
925 * Deprecated alias for notmuch_query_search_threads.
927 * @deprecated Deprecated as of libnotmuch 5 (notmuch 0.25). Please
928 * use notmuch_query_search_threads instead.
931 NOTMUCH_DEPRECATED(5,0)
933 notmuch_query_search_threads_st (notmuch_query_t *query, notmuch_threads_t **out);
936 * Execute a query for messages, returning a notmuch_messages_t object
937 * which can be used to iterate over the results. The returned
938 * messages object is owned by the query and as such, will only be
939 * valid until notmuch_query_destroy.
941 * Typical usage might be:
943 * notmuch_query_t *query;
944 * notmuch_messages_t *messages;
945 * notmuch_message_t *message;
947 * query = notmuch_query_create (database, query_string);
949 * for (messages = notmuch_query_search_messages (query);
950 * notmuch_messages_valid (messages);
951 * notmuch_messages_move_to_next (messages))
953 * message = notmuch_messages_get (messages);
955 * notmuch_message_destroy (message);
958 * notmuch_query_destroy (query);
960 * Note: If you are finished with a message before its containing
961 * query, you can call notmuch_message_destroy to clean up some memory
962 * sooner (as in the above example). Otherwise, if your message
963 * objects are long-lived, then you don't need to call
964 * notmuch_message_destroy and all the memory will still be reclaimed
965 * when the query is destroyed.
967 * Note that there's no explicit destructor needed for the
968 * notmuch_messages_t object. (For consistency, we do provide a
969 * notmuch_messages_destroy function, but there's no good
970 * reason to call it if the query is about to be destroyed).
972 * If a Xapian exception occurs this function will return NULL.
974 * @since libnotmuch 5 (notmuch 0.25)
977 notmuch_query_search_messages (notmuch_query_t *query,
978 notmuch_messages_t **out);
980 * Deprecated alias for notmuch_query_search_messages
982 * @deprecated Deprecated as of libnotmuch 5 (notmuch 0.25). Please use
983 * notmuch_query_search_messages instead.
987 NOTMUCH_DEPRECATED(5,0)
989 notmuch_query_search_messages_st (notmuch_query_t *query,
990 notmuch_messages_t **out);
993 * Destroy a notmuch_query_t along with any associated resources.
995 * This will in turn destroy any notmuch_threads_t and
996 * notmuch_messages_t objects generated by this query, (and in
997 * turn any notmuch_thread_t and notmuch_message_t objects generated
998 * from those results, etc.), if such objects haven't already been
1002 notmuch_query_destroy (notmuch_query_t *query);
1005 * Is the given 'threads' iterator pointing at a valid thread.
1007 * When this function returns TRUE, notmuch_threads_get will return a
1008 * valid object. Whereas when this function returns FALSE,
1009 * notmuch_threads_get will return NULL.
1011 * If passed a NULL pointer, this function returns FALSE
1013 * See the documentation of notmuch_query_search_threads for example
1014 * code showing how to iterate over a notmuch_threads_t object.
1017 notmuch_threads_valid (notmuch_threads_t *threads);
1020 * Get the current thread from 'threads' as a notmuch_thread_t.
1022 * Note: The returned thread belongs to 'threads' and has a lifetime
1023 * identical to it (and the query to which it belongs).
1025 * See the documentation of notmuch_query_search_threads for example
1026 * code showing how to iterate over a notmuch_threads_t object.
1028 * If an out-of-memory situation occurs, this function will return
1032 notmuch_threads_get (notmuch_threads_t *threads);
1035 * Move the 'threads' iterator to the next thread.
1037 * If 'threads' is already pointing at the last thread then the
1038 * iterator will be moved to a point just beyond that last thread,
1039 * (where notmuch_threads_valid will return FALSE and
1040 * notmuch_threads_get will return NULL).
1042 * See the documentation of notmuch_query_search_threads for example
1043 * code showing how to iterate over a notmuch_threads_t object.
1046 notmuch_threads_move_to_next (notmuch_threads_t *threads);
1049 * Destroy a notmuch_threads_t object.
1051 * It's not strictly necessary to call this function. All memory from
1052 * the notmuch_threads_t object will be reclaimed when the
1053 * containing query object is destroyed.
1056 notmuch_threads_destroy (notmuch_threads_t *threads);
1059 * Return the number of messages matching a search.
1061 * This function performs a search and returns the number of matching
1066 * NOTMUCH_STATUS_SUCCESS: query completed successfully.
1068 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: a Xapian exception occurred. The
1069 * value of *count is not defined.
1071 * @since libnotmuch 5 (notmuch 0.25)
1074 notmuch_query_count_messages (notmuch_query_t *query, unsigned int *count);
1077 * Deprecated alias for notmuch_query_count_messages
1080 * @deprecated Deprecated since libnotmuch 5.0 (notmuch 0.25). Please
1081 * use notmuch_query_count_messages instead.
1083 NOTMUCH_DEPRECATED(5,0)
1085 notmuch_query_count_messages_st (notmuch_query_t *query, unsigned int *count);
1088 * Return the number of threads matching a search.
1090 * This function performs a search and returns the number of unique thread IDs
1091 * in the matching messages. This is the same as number of threads matching a
1094 * Note that this is a significantly heavier operation than
1095 * notmuch_query_count_messages{_st}().
1099 * NOTMUCH_STATUS_OUT_OF_MEMORY: Memory allocation failed. The value
1100 * of *count is not defined
1102 * NOTMUCH_STATUS_SUCCESS: query completed successfully.
1104 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: a Xapian exception occurred. The
1105 * value of *count is not defined.
1107 * @since libnotmuch 5 (notmuch 0.25)
1110 notmuch_query_count_threads (notmuch_query_t *query, unsigned *count);
1113 * Deprecated alias for notmuch_query_count_threads
1115 * @deprecated Deprecated as of libnotmuch 5.0 (notmuch 0.25). Please
1116 * use notmuch_query_count_threads_st instead.
1118 NOTMUCH_DEPRECATED(5,0)
1120 notmuch_query_count_threads_st (notmuch_query_t *query, unsigned *count);
1123 * Get the thread ID of 'thread'.
1125 * The returned string belongs to 'thread' and as such, should not be
1126 * modified by the caller and will only be valid for as long as the
1127 * thread is valid, (which is until notmuch_thread_destroy or until
1128 * the query from which it derived is destroyed).
1131 notmuch_thread_get_thread_id (notmuch_thread_t *thread);
1134 * Get the total number of messages in 'thread'.
1136 * This count consists of all messages in the database belonging to
1137 * this thread. Contrast with notmuch_thread_get_matched_messages() .
1140 notmuch_thread_get_total_messages (notmuch_thread_t *thread);
1143 * Get the total number of files in 'thread'.
1145 * This sums notmuch_message_count_files over all messages in the
1147 * @returns Non-negative integer
1148 * @since libnotmuch 5.0 (notmuch 0.25)
1152 notmuch_thread_get_total_files (notmuch_thread_t *thread);
1155 * Get a notmuch_messages_t iterator for the top-level messages in
1156 * 'thread' in oldest-first order.
1158 * This iterator will not necessarily iterate over all of the messages
1159 * in the thread. It will only iterate over the messages in the thread
1160 * which are not replies to other messages in the thread.
1162 * The returned list will be destroyed when the thread is destroyed.
1164 notmuch_messages_t *
1165 notmuch_thread_get_toplevel_messages (notmuch_thread_t *thread);
1168 * Get a notmuch_thread_t iterator for all messages in 'thread' in
1169 * oldest-first order.
1171 * The returned list will be destroyed when the thread is destroyed.
1173 notmuch_messages_t *
1174 notmuch_thread_get_messages (notmuch_thread_t *thread);
1177 * Get the number of messages in 'thread' that matched the search.
1179 * This count includes only the messages in this thread that were
1180 * matched by the search from which the thread was created and were
1181 * not excluded by any exclude tags passed in with the query (see
1182 * notmuch_query_add_tag_exclude). Contrast with
1183 * notmuch_thread_get_total_messages() .
1186 notmuch_thread_get_matched_messages (notmuch_thread_t *thread);
1189 * Get the authors of 'thread' as a UTF-8 string.
1191 * The returned string is a comma-separated list of the names of the
1192 * authors of mail messages in the query results that belong to this
1195 * The string contains authors of messages matching the query first, then
1196 * non-matched authors (with the two groups separated by '|'). Within
1197 * each group, authors are ordered by date.
1199 * The returned string belongs to 'thread' and as such, should not be
1200 * modified by the caller and will only be valid for as long as the
1201 * thread is valid, (which is until notmuch_thread_destroy or until
1202 * the query from which it derived is destroyed).
1205 notmuch_thread_get_authors (notmuch_thread_t *thread);
1208 * Get the subject of 'thread' as a UTF-8 string.
1210 * The subject is taken from the first message (according to the query
1211 * order---see notmuch_query_set_sort) in the query results that
1212 * belongs to this thread.
1214 * The returned string belongs to 'thread' and as such, should not be
1215 * modified by the caller and will only be valid for as long as the
1216 * thread is valid, (which is until notmuch_thread_destroy or until
1217 * the query from which it derived is destroyed).
1220 notmuch_thread_get_subject (notmuch_thread_t *thread);
1223 * Get the date of the oldest message in 'thread' as a time_t value.
1226 notmuch_thread_get_oldest_date (notmuch_thread_t *thread);
1229 * Get the date of the newest message in 'thread' as a time_t value.
1232 notmuch_thread_get_newest_date (notmuch_thread_t *thread);
1235 * Get the tags for 'thread', returning a notmuch_tags_t object which
1236 * can be used to iterate over all tags.
1238 * Note: In the Notmuch database, tags are stored on individual
1239 * messages, not on threads. So the tags returned here will be all
1240 * tags of the messages which matched the search and which belong to
1243 * The tags object is owned by the thread and as such, will only be
1244 * valid for as long as the thread is valid, (for example, until
1245 * notmuch_thread_destroy or until the query from which it derived is
1248 * Typical usage might be:
1250 * notmuch_thread_t *thread;
1251 * notmuch_tags_t *tags;
1254 * thread = notmuch_threads_get (threads);
1256 * for (tags = notmuch_thread_get_tags (thread);
1257 * notmuch_tags_valid (tags);
1258 * notmuch_tags_move_to_next (tags))
1260 * tag = notmuch_tags_get (tags);
1264 * notmuch_thread_destroy (thread);
1266 * Note that there's no explicit destructor needed for the
1267 * notmuch_tags_t object. (For consistency, we do provide a
1268 * notmuch_tags_destroy function, but there's no good reason to call
1269 * it if the message is about to be destroyed).
1272 notmuch_thread_get_tags (notmuch_thread_t *thread);
1275 * Destroy a notmuch_thread_t object.
1278 notmuch_thread_destroy (notmuch_thread_t *thread);
1281 * Is the given 'messages' iterator pointing at a valid message.
1283 * When this function returns TRUE, notmuch_messages_get will return a
1284 * valid object. Whereas when this function returns FALSE,
1285 * notmuch_messages_get will return NULL.
1287 * See the documentation of notmuch_query_search_messages for example
1288 * code showing how to iterate over a notmuch_messages_t object.
1291 notmuch_messages_valid (notmuch_messages_t *messages);
1294 * Get the current message from 'messages' as a notmuch_message_t.
1296 * Note: The returned message belongs to 'messages' and has a lifetime
1297 * identical to it (and the query to which it belongs).
1299 * See the documentation of notmuch_query_search_messages for example
1300 * code showing how to iterate over a notmuch_messages_t object.
1302 * If an out-of-memory situation occurs, this function will return
1306 notmuch_messages_get (notmuch_messages_t *messages);
1309 * Move the 'messages' iterator to the next message.
1311 * If 'messages' is already pointing at the last message then the
1312 * iterator will be moved to a point just beyond that last message,
1313 * (where notmuch_messages_valid will return FALSE and
1314 * notmuch_messages_get will return NULL).
1316 * See the documentation of notmuch_query_search_messages for example
1317 * code showing how to iterate over a notmuch_messages_t object.
1320 notmuch_messages_move_to_next (notmuch_messages_t *messages);
1323 * Destroy a notmuch_messages_t object.
1325 * It's not strictly necessary to call this function. All memory from
1326 * the notmuch_messages_t object will be reclaimed when the containing
1327 * query object is destroyed.
1330 notmuch_messages_destroy (notmuch_messages_t *messages);
1333 * Return a list of tags from all messages.
1335 * The resulting list is guaranteed not to contain duplicated tags.
1337 * WARNING: You can no longer iterate over messages after calling this
1338 * function, because the iterator will point at the end of the list.
1339 * We do not have a function to reset the iterator yet and the only
1340 * way how you can iterate over the list again is to recreate the
1343 * The function returns NULL on error.
1346 notmuch_messages_collect_tags (notmuch_messages_t *messages);
1349 * Get the database associated with this message.
1351 * @since libnotmuch 5.2 (notmuch 0.27)
1353 notmuch_database_t *
1354 notmuch_message_get_database (const notmuch_message_t *message);
1357 * Get the message ID of 'message'.
1359 * The returned string belongs to 'message' and as such, should not be
1360 * modified by the caller and will only be valid for as long as the
1361 * message is valid, (which is until the query from which it derived
1364 * This function will not return NULL since Notmuch ensures that every
1365 * message has a unique message ID, (Notmuch will generate an ID for a
1366 * message if the original file does not contain one).
1369 notmuch_message_get_message_id (notmuch_message_t *message);
1372 * Get the thread ID of 'message'.
1374 * The returned string belongs to 'message' and as such, should not be
1375 * modified by the caller and will only be valid for as long as the
1376 * message is valid, (for example, until the user calls
1377 * notmuch_message_destroy on 'message' or until a query from which it
1378 * derived is destroyed).
1380 * This function will not return NULL since Notmuch ensures that every
1381 * message belongs to a single thread.
1384 notmuch_message_get_thread_id (notmuch_message_t *message);
1387 * Get a notmuch_messages_t iterator for all of the replies to
1390 * Note: This call only makes sense if 'message' was ultimately
1391 * obtained from a notmuch_thread_t object, (such as by coming
1392 * directly from the result of calling notmuch_thread_get_
1393 * toplevel_messages or by any number of subsequent
1394 * calls to notmuch_message_get_replies).
1396 * If 'message' was obtained through some non-thread means, (such as
1397 * by a call to notmuch_query_search_messages), then this function
1400 * If there are no replies to 'message', this function will return
1401 * NULL. (Note that notmuch_messages_valid will accept that NULL
1402 * value as legitimate, and simply return FALSE for it.)
1404 notmuch_messages_t *
1405 notmuch_message_get_replies (notmuch_message_t *message);
1408 * Get the total number of files associated with a message.
1409 * @returns Non-negative integer
1410 * @since libnotmuch 5.0 (notmuch 0.25)
1413 notmuch_message_count_files (notmuch_message_t *message);
1416 * Get a filename for the email corresponding to 'message'.
1418 * The returned filename is an absolute filename, (the initial
1419 * component will match notmuch_database_get_path() ).
1421 * The returned string belongs to the message so should not be
1422 * modified or freed by the caller (nor should it be referenced after
1423 * the message is destroyed).
1425 * Note: If this message corresponds to multiple files in the mail
1426 * store, (that is, multiple files contain identical message IDs),
1427 * this function will arbitrarily return a single one of those
1428 * filenames. See notmuch_message_get_filenames for returning the
1429 * complete list of filenames.
1432 notmuch_message_get_filename (notmuch_message_t *message);
1435 * Get all filenames for the email corresponding to 'message'.
1437 * Returns a notmuch_filenames_t iterator listing all the filenames
1438 * associated with 'message'. These files may not have identical
1439 * content, but each will have the identical Message-ID.
1441 * Each filename in the iterator is an absolute filename, (the initial
1442 * component will match notmuch_database_get_path() ).
1444 notmuch_filenames_t *
1445 notmuch_message_get_filenames (notmuch_message_t *message);
1448 * Re-index the e-mail corresponding to 'message' using the supplied index options
1450 * Returns the status of the re-index operation. (see the return
1451 * codes documented in notmuch_database_index_file)
1453 * After reindexing, the user should discard the message object passed
1454 * in here by calling notmuch_message_destroy, since it refers to the
1455 * original message, not to the reindexed message.
1458 notmuch_message_reindex (notmuch_message_t *message,
1459 notmuch_indexopts_t *indexopts);
1464 typedef enum _notmuch_message_flag {
1465 NOTMUCH_MESSAGE_FLAG_MATCH,
1466 NOTMUCH_MESSAGE_FLAG_EXCLUDED,
1468 /* This message is a "ghost message", meaning it has no filenames
1469 * or content, but we know it exists because it was referenced by
1470 * some other message. A ghost message has only a message ID and
1473 NOTMUCH_MESSAGE_FLAG_GHOST,
1474 } notmuch_message_flag_t;
1477 * Get a value of a flag for the email corresponding to 'message'.
1480 notmuch_message_get_flag (notmuch_message_t *message,
1481 notmuch_message_flag_t flag);
1484 * Set a value of a flag for the email corresponding to 'message'.
1487 notmuch_message_set_flag (notmuch_message_t *message,
1488 notmuch_message_flag_t flag, notmuch_bool_t value);
1491 * Get the date of 'message' as a time_t value.
1493 * For the original textual representation of the Date header from the
1494 * message call notmuch_message_get_header() with a header value of
1498 notmuch_message_get_date (notmuch_message_t *message);
1501 * Get the value of the specified header from 'message' as a UTF-8 string.
1503 * Common headers are stored in the database when the message is
1504 * indexed and will be returned from the database. Other headers will
1505 * be read from the actual message file.
1507 * The header name is case insensitive.
1509 * The returned string belongs to the message so should not be
1510 * modified or freed by the caller (nor should it be referenced after
1511 * the message is destroyed).
1513 * Returns an empty string ("") if the message does not contain a
1514 * header line matching 'header'. Returns NULL if any error occurs.
1517 notmuch_message_get_header (notmuch_message_t *message, const char *header);
1520 * Get the tags for 'message', returning a notmuch_tags_t object which
1521 * can be used to iterate over all tags.
1523 * The tags object is owned by the message and as such, will only be
1524 * valid for as long as the message is valid, (which is until the
1525 * query from which it derived is destroyed).
1527 * Typical usage might be:
1529 * notmuch_message_t *message;
1530 * notmuch_tags_t *tags;
1533 * message = notmuch_database_find_message (database, message_id);
1535 * for (tags = notmuch_message_get_tags (message);
1536 * notmuch_tags_valid (tags);
1537 * notmuch_tags_move_to_next (tags))
1539 * tag = notmuch_tags_get (tags);
1543 * notmuch_message_destroy (message);
1545 * Note that there's no explicit destructor needed for the
1546 * notmuch_tags_t object. (For consistency, we do provide a
1547 * notmuch_tags_destroy function, but there's no good reason to call
1548 * it if the message is about to be destroyed).
1551 notmuch_message_get_tags (notmuch_message_t *message);
1554 * The longest possible tag value.
1556 #define NOTMUCH_TAG_MAX 200
1559 * Add a tag to the given message.
1563 * NOTMUCH_STATUS_SUCCESS: Tag successfully added to message
1565 * NOTMUCH_STATUS_NULL_POINTER: The 'tag' argument is NULL
1567 * NOTMUCH_STATUS_TAG_TOO_LONG: The length of 'tag' is too long
1568 * (exceeds NOTMUCH_TAG_MAX)
1570 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
1571 * mode so message cannot be modified.
1574 notmuch_message_add_tag (notmuch_message_t *message, const char *tag);
1577 * Remove a tag from the given message.
1581 * NOTMUCH_STATUS_SUCCESS: Tag successfully removed from message
1583 * NOTMUCH_STATUS_NULL_POINTER: The 'tag' argument is NULL
1585 * NOTMUCH_STATUS_TAG_TOO_LONG: The length of 'tag' is too long
1586 * (exceeds NOTMUCH_TAG_MAX)
1588 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
1589 * mode so message cannot be modified.
1592 notmuch_message_remove_tag (notmuch_message_t *message, const char *tag);
1595 * Remove all tags from the given message.
1597 * See notmuch_message_freeze for an example showing how to safely
1598 * replace tag values.
1600 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
1601 * mode so message cannot be modified.
1604 notmuch_message_remove_all_tags (notmuch_message_t *message);
1607 * Add/remove tags according to maildir flags in the message filename(s).
1609 * This function examines the filenames of 'message' for maildir
1610 * flags, and adds or removes tags on 'message' as follows when these
1611 * flags are present:
1613 * Flag Action if present
1614 * ---- -----------------
1615 * 'D' Adds the "draft" tag to the message
1616 * 'F' Adds the "flagged" tag to the message
1617 * 'P' Adds the "passed" tag to the message
1618 * 'R' Adds the "replied" tag to the message
1619 * 'S' Removes the "unread" tag from the message
1621 * For each flag that is not present, the opposite action (add/remove)
1622 * is performed for the corresponding tags.
1624 * Flags are identified as trailing components of the filename after a
1625 * sequence of ":2,".
1627 * If there are multiple filenames associated with this message, the
1628 * flag is considered present if it appears in one or more
1629 * filenames. (That is, the flags from the multiple filenames are
1630 * combined with the logical OR operator.)
1632 * A client can ensure that notmuch database tags remain synchronized
1633 * with maildir flags by calling this function after each call to
1634 * notmuch_database_index_file. See also
1635 * notmuch_message_tags_to_maildir_flags for synchronizing tag changes
1636 * back to maildir flags.
1639 notmuch_message_maildir_flags_to_tags (notmuch_message_t *message);
1642 * return TRUE if any filename of 'message' has maildir flag 'flag',
1647 notmuch_message_has_maildir_flag (notmuch_message_t *message, char flag);
1650 * Rename message filename(s) to encode tags as maildir flags.
1652 * Specifically, for each filename corresponding to this message:
1654 * If the filename is not in a maildir directory, do nothing. (A
1655 * maildir directory is determined as a directory named "new" or
1656 * "cur".) Similarly, if the filename has invalid maildir info,
1657 * (repeated or outof-ASCII-order flag characters after ":2,"), then
1660 * If the filename is in a maildir directory, rename the file so that
1661 * its filename ends with the sequence ":2," followed by zero or more
1662 * of the following single-character flags (in ASCII order):
1664 * * flag 'D' iff the message has the "draft" tag
1665 * * flag 'F' iff the message has the "flagged" tag
1666 * * flag 'P' iff the message has the "passed" tag
1667 * * flag 'R' iff the message has the "replied" tag
1668 * * flag 'S' iff the message does not have the "unread" tag
1670 * Any existing flags unmentioned in the list above will be preserved
1673 * Also, if this filename is in a directory named "new", rename it to
1674 * be within the neighboring directory named "cur".
1676 * A client can ensure that maildir filename flags remain synchronized
1677 * with notmuch database tags by calling this function after changing
1678 * tags, (after calls to notmuch_message_add_tag,
1679 * notmuch_message_remove_tag, or notmuch_message_freeze/
1680 * notmuch_message_thaw). See also notmuch_message_maildir_flags_to_tags
1681 * for synchronizing maildir flag changes back to tags.
1684 notmuch_message_tags_to_maildir_flags (notmuch_message_t *message);
1687 * Freeze the current state of 'message' within the database.
1689 * This means that changes to the message state, (via
1690 * notmuch_message_add_tag, notmuch_message_remove_tag, and
1691 * notmuch_message_remove_all_tags), will not be committed to the
1692 * database until the message is thawed with notmuch_message_thaw.
1694 * Multiple calls to freeze/thaw are valid and these calls will
1695 * "stack". That is there must be as many calls to thaw as to freeze
1696 * before a message is actually thawed.
1698 * The ability to do freeze/thaw allows for safe transactions to
1699 * change tag values. For example, explicitly setting a message to
1700 * have a given set of tags might look like this:
1702 * notmuch_message_freeze (message);
1704 * notmuch_message_remove_all_tags (message);
1706 * for (i = 0; i < NUM_TAGS; i++)
1707 * notmuch_message_add_tag (message, tags[i]);
1709 * notmuch_message_thaw (message);
1711 * With freeze/thaw used like this, the message in the database is
1712 * guaranteed to have either the full set of original tag values, or
1713 * the full set of new tag values, but nothing in between.
1715 * Imagine the example above without freeze/thaw and the operation
1716 * somehow getting interrupted. This could result in the message being
1717 * left with no tags if the interruption happened after
1718 * notmuch_message_remove_all_tags but before notmuch_message_add_tag.
1722 * NOTMUCH_STATUS_SUCCESS: Message successfully frozen.
1724 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
1725 * mode so message cannot be modified.
1728 notmuch_message_freeze (notmuch_message_t *message);
1731 * Thaw the current 'message', synchronizing any changes that may have
1732 * occurred while 'message' was frozen into the notmuch database.
1734 * See notmuch_message_freeze for an example of how to use this
1735 * function to safely provide tag changes.
1737 * Multiple calls to freeze/thaw are valid and these calls with
1738 * "stack". That is there must be as many calls to thaw as to freeze
1739 * before a message is actually thawed.
1743 * NOTMUCH_STATUS_SUCCESS: Message successfully thawed, (or at least
1744 * its frozen count has successfully been reduced by 1).
1746 * NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW: An attempt was made to thaw
1747 * an unfrozen message. That is, there have been an unbalanced
1748 * number of calls to notmuch_message_freeze and
1749 * notmuch_message_thaw.
1752 notmuch_message_thaw (notmuch_message_t *message);
1755 * Destroy a notmuch_message_t object.
1757 * It can be useful to call this function in the case of a single
1758 * query object with many messages in the result, (such as iterating
1759 * over the entire database). Otherwise, it's fine to never call this
1760 * function and there will still be no memory leaks. (The memory from
1761 * the messages get reclaimed when the containing query is destroyed.)
1764 notmuch_message_destroy (notmuch_message_t *message);
1767 * @name Message Properties
1769 * This interface provides the ability to attach arbitrary (key,value)
1770 * string pairs to a message, to remove such pairs, and to iterate
1771 * over them. The caller should take some care as to what keys they
1772 * add or delete values for, as other subsystems or extensions may
1773 * depend on these properties.
1775 * Please see notmuch-properties(7) for more details about specific
1776 * properties and conventions around their use.
1781 * Retrieve the value for a single property key
1783 * *value* is set to a string owned by the message or NULL if there is
1784 * no such key. In the case of multiple values for the given key, the
1785 * first one is retrieved.
1788 * - NOTMUCH_STATUS_NULL_POINTER: *value* may not be NULL.
1789 * - NOTMUCH_STATUS_SUCCESS: No error occurred.
1790 * @since libnotmuch 4.4 (notmuch 0.23)
1793 notmuch_message_get_property (notmuch_message_t *message, const char *key, const char **value);
1796 * Add a (key,value) pair to a message
1799 * - NOTMUCH_STATUS_ILLEGAL_ARGUMENT: *key* may not contain an '=' character.
1800 * - NOTMUCH_STATUS_NULL_POINTER: Neither *key* nor *value* may be NULL.
1801 * - NOTMUCH_STATUS_SUCCESS: No error occurred.
1802 * @since libnotmuch 4.4 (notmuch 0.23)
1805 notmuch_message_add_property (notmuch_message_t *message, const char *key, const char *value);
1808 * Remove a (key,value) pair from a message.
1810 * It is not an error to remove a non-existant (key,value) pair
1813 * - NOTMUCH_STATUS_ILLEGAL_ARGUMENT: *key* may not contain an '=' character.
1814 * - NOTMUCH_STATUS_NULL_POINTER: Neither *key* nor *value* may be NULL.
1815 * - NOTMUCH_STATUS_SUCCESS: No error occurred.
1816 * @since libnotmuch 4.4 (notmuch 0.23)
1819 notmuch_message_remove_property (notmuch_message_t *message, const char *key, const char *value);
1822 * Remove all (key,value) pairs from the given message.
1824 * @param[in,out] message message to operate on.
1825 * @param[in] key key to delete properties for. If NULL, delete
1826 * properties for all keys
1828 * - NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in
1829 * read-only mode so message cannot be modified.
1830 * - NOTMUCH_STATUS_SUCCESS: No error occurred.
1832 * @since libnotmuch 4.4 (notmuch 0.23)
1835 notmuch_message_remove_all_properties (notmuch_message_t *message, const char *key);
1838 * Remove all (prefix*,value) pairs from the given message
1840 * @param[in,out] message message to operate on.
1841 * @param[in] prefix delete properties with keys that start with prefix.
1842 * If NULL, delete all properties
1844 * - NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in
1845 * read-only mode so message cannot be modified.
1846 * - NOTMUCH_STATUS_SUCCESS: No error occurred.
1848 * @since libnotmuch 5.1 (notmuch 0.26)
1851 notmuch_message_remove_all_properties_with_prefix (notmuch_message_t *message, const char *prefix);
1854 * Opaque message property iterator
1856 typedef struct _notmuch_string_map_iterator notmuch_message_properties_t;
1859 * Get the properties for *message*, returning a
1860 * notmuch_message_properties_t object which can be used to iterate
1861 * over all properties.
1863 * The notmuch_message_properties_t object is owned by the message and
1864 * as such, will only be valid for as long as the message is valid,
1865 * (which is until the query from which it derived is destroyed).
1867 * @param[in] message The message to examine
1868 * @param[in] key key or key prefix
1869 * @param[in] exact if TRUE, require exact match with key. Otherwise
1872 * Typical usage might be:
1874 * notmuch_message_properties_t *list;
1876 * for (list = notmuch_message_get_properties (message, "testkey1", TRUE);
1877 * notmuch_message_properties_valid (list); notmuch_message_properties_move_to_next (list)) {
1878 * printf("%s\n", notmuch_message_properties_value(list));
1881 * notmuch_message_properties_destroy (list);
1883 * Note that there's no explicit destructor needed for the
1884 * notmuch_message_properties_t object. (For consistency, we do
1885 * provide a notmuch_message_properities_destroy function, but there's
1886 * no good reason to call it if the message is about to be destroyed).
1888 * @since libnotmuch 4.4 (notmuch 0.23)
1890 notmuch_message_properties_t *
1891 notmuch_message_get_properties (notmuch_message_t *message, const char *key, notmuch_bool_t exact);
1894 * Return the number of properties named "key" belonging to the specific message.
1896 * @param[in] message The message to examine
1897 * @param[in] key key to count
1898 * @param[out] count The number of matching properties associated with this message.
1902 * NOTMUCH_STATUS_SUCCESS: successful count, possibly some other error.
1904 * @since libnotmuch 5.2 (notmuch 0.27)
1907 notmuch_message_count_properties (notmuch_message_t *message, const char *key, unsigned int *count);
1910 * Is the given *properties* iterator pointing at a valid (key,value)
1913 * When this function returns TRUE,
1914 * notmuch_message_properties_{key,value} will return a valid string,
1915 * and notmuch_message_properties_move_to_next will do what it
1916 * says. Whereas when this function returns FALSE, calling any of
1917 * these functions results in undefined behaviour.
1919 * See the documentation of notmuch_message_get_properties for example
1920 * code showing how to iterate over a notmuch_message_properties_t
1923 * @since libnotmuch 4.4 (notmuch 0.23)
1926 notmuch_message_properties_valid (notmuch_message_properties_t *properties);
1929 * Move the *properties* iterator to the next (key,value) pair
1931 * If *properties* is already pointing at the last pair then the iterator
1932 * will be moved to a point just beyond that last pair, (where
1933 * notmuch_message_properties_valid will return FALSE).
1935 * See the documentation of notmuch_message_get_properties for example
1936 * code showing how to iterate over a notmuch_message_properties_t object.
1938 * @since libnotmuch 4.4 (notmuch 0.23)
1941 notmuch_message_properties_move_to_next (notmuch_message_properties_t *properties);
1944 * Return the key from the current (key,value) pair.
1946 * this could be useful if iterating for a prefix
1948 * @since libnotmuch 4.4 (notmuch 0.23)
1951 notmuch_message_properties_key (notmuch_message_properties_t *properties);
1954 * Return the value from the current (key,value) pair.
1956 * This could be useful if iterating for a prefix.
1958 * @since libnotmuch 4.4 (notmuch 0.23)
1961 notmuch_message_properties_value (notmuch_message_properties_t *properties);
1965 * Destroy a notmuch_message_properties_t object.
1967 * It's not strictly necessary to call this function. All memory from
1968 * the notmuch_message_properties_t object will be reclaimed when the
1969 * containing message object is destroyed.
1971 * @since libnotmuch 4.4 (notmuch 0.23)
1974 notmuch_message_properties_destroy (notmuch_message_properties_t *properties);
1979 * Is the given 'tags' iterator pointing at a valid tag.
1981 * When this function returns TRUE, notmuch_tags_get will return a
1982 * valid string. Whereas when this function returns FALSE,
1983 * notmuch_tags_get will return NULL.
1985 * See the documentation of notmuch_message_get_tags for example code
1986 * showing how to iterate over a notmuch_tags_t object.
1989 notmuch_tags_valid (notmuch_tags_t *tags);
1992 * Get the current tag from 'tags' as a string.
1994 * Note: The returned string belongs to 'tags' and has a lifetime
1995 * identical to it (and the query to which it ultimately belongs).
1997 * See the documentation of notmuch_message_get_tags for example code
1998 * showing how to iterate over a notmuch_tags_t object.
2001 notmuch_tags_get (notmuch_tags_t *tags);
2004 * Move the 'tags' iterator to the next tag.
2006 * If 'tags' is already pointing at the last tag then the iterator
2007 * will be moved to a point just beyond that last tag, (where
2008 * notmuch_tags_valid will return FALSE and notmuch_tags_get will
2011 * See the documentation of notmuch_message_get_tags for example code
2012 * showing how to iterate over a notmuch_tags_t object.
2015 notmuch_tags_move_to_next (notmuch_tags_t *tags);
2018 * Destroy a notmuch_tags_t object.
2020 * It's not strictly necessary to call this function. All memory from
2021 * the notmuch_tags_t object will be reclaimed when the containing
2022 * message or query objects are destroyed.
2025 notmuch_tags_destroy (notmuch_tags_t *tags);
2028 * Store an mtime within the database for 'directory'.
2030 * The 'directory' should be an object retrieved from the database
2031 * with notmuch_database_get_directory for a particular path.
2033 * The intention is for the caller to use the mtime to allow efficient
2034 * identification of new messages to be added to the database. The
2035 * recommended usage is as follows:
2037 * o Read the mtime of a directory from the filesystem
2039 * o Call index_file for all mail files in the directory
2041 * o Call notmuch_directory_set_mtime with the mtime read from the
2044 * Then, when wanting to check for updates to the directory in the
2045 * future, the client can call notmuch_directory_get_mtime and know
2046 * that it only needs to add files if the mtime of the directory and
2047 * files are newer than the stored timestamp.
2049 * Note: The notmuch_directory_get_mtime function does not allow the
2050 * caller to distinguish a timestamp of 0 from a non-existent
2051 * timestamp. So don't store a timestamp of 0 unless you are
2052 * comfortable with that.
2056 * NOTMUCH_STATUS_SUCCESS: mtime successfully stored in database.
2058 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception
2059 * occurred, mtime not stored.
2061 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
2062 * mode so directory mtime cannot be modified.
2065 notmuch_directory_set_mtime (notmuch_directory_t *directory,
2069 * Get the mtime of a directory, (as previously stored with
2070 * notmuch_directory_set_mtime).
2072 * Returns 0 if no mtime has previously been stored for this
2076 notmuch_directory_get_mtime (notmuch_directory_t *directory);
2079 * Get a notmuch_filenames_t iterator listing all the filenames of
2080 * messages in the database within the given directory.
2082 * The returned filenames will be the basename-entries only (not
2085 notmuch_filenames_t *
2086 notmuch_directory_get_child_files (notmuch_directory_t *directory);
2089 * Get a notmuch_filenames_t iterator listing all the filenames of
2090 * sub-directories in the database within the given directory.
2092 * The returned filenames will be the basename-entries only (not
2095 notmuch_filenames_t *
2096 notmuch_directory_get_child_directories (notmuch_directory_t *directory);
2099 * Delete directory document from the database, and destroy the
2100 * notmuch_directory_t object. Assumes any child directories and files
2101 * have been deleted by the caller.
2103 * @since libnotmuch 4.3 (notmuch 0.21)
2106 notmuch_directory_delete (notmuch_directory_t *directory);
2109 * Destroy a notmuch_directory_t object.
2112 notmuch_directory_destroy (notmuch_directory_t *directory);
2115 * Is the given 'filenames' iterator pointing at a valid filename.
2117 * When this function returns TRUE, notmuch_filenames_get will return
2118 * a valid string. Whereas when this function returns FALSE,
2119 * notmuch_filenames_get will return NULL.
2121 * It is acceptable to pass NULL for 'filenames', in which case this
2122 * function will always return FALSE.
2125 notmuch_filenames_valid (notmuch_filenames_t *filenames);
2128 * Get the current filename from 'filenames' as a string.
2130 * Note: The returned string belongs to 'filenames' and has a lifetime
2131 * identical to it (and the directory to which it ultimately belongs).
2133 * It is acceptable to pass NULL for 'filenames', in which case this
2134 * function will always return NULL.
2137 notmuch_filenames_get (notmuch_filenames_t *filenames);
2140 * Move the 'filenames' iterator to the next filename.
2142 * If 'filenames' is already pointing at the last filename then the
2143 * iterator will be moved to a point just beyond that last filename,
2144 * (where notmuch_filenames_valid will return FALSE and
2145 * notmuch_filenames_get will return NULL).
2147 * It is acceptable to pass NULL for 'filenames', in which case this
2148 * function will do nothing.
2151 notmuch_filenames_move_to_next (notmuch_filenames_t *filenames);
2154 * Destroy a notmuch_filenames_t object.
2156 * It's not strictly necessary to call this function. All memory from
2157 * the notmuch_filenames_t object will be reclaimed when the
2158 * containing directory object is destroyed.
2160 * It is acceptable to pass NULL for 'filenames', in which case this
2161 * function will do nothing.
2164 notmuch_filenames_destroy (notmuch_filenames_t *filenames);
2168 * set config 'key' to 'value'
2170 * @since libnotmuch 4.4 (notmuch 0.23)
2173 notmuch_database_set_config (notmuch_database_t *db, const char *key, const char *value);
2176 * retrieve config item 'key', assign to 'value'
2178 * keys which have not been previously set with n_d_set_config will
2179 * return an empty string.
2181 * return value is allocated by malloc and should be freed by the
2184 * @since libnotmuch 4.4 (notmuch 0.23)
2187 notmuch_database_get_config (notmuch_database_t *db, const char *key, char **value);
2190 * Create an iterator for all config items with keys matching a given prefix
2192 * @since libnotmuch 4.4 (notmuch 0.23)
2195 notmuch_database_get_config_list (notmuch_database_t *db, const char *prefix, notmuch_config_list_t **out);
2198 * Is 'config_list' iterator valid (i.e. _key, _value, _move_to_next can be called).
2200 * @since libnotmuch 4.4 (notmuch 0.23)
2203 notmuch_config_list_valid (notmuch_config_list_t *config_list);
2206 * return key for current config pair
2208 * return value is owned by the iterator, and will be destroyed by the
2209 * next call to notmuch_config_list_key or notmuch_config_list_destroy.
2211 * @since libnotmuch 4.4 (notmuch 0.23)
2214 notmuch_config_list_key (notmuch_config_list_t *config_list);
2217 * return 'value' for current config pair
2219 * return value is owned by the iterator, and will be destroyed by the
2220 * next call to notmuch_config_list_value or notmuch config_list_destroy
2222 * @since libnotmuch 4.4 (notmuch 0.23)
2225 notmuch_config_list_value (notmuch_config_list_t *config_list);
2229 * move 'config_list' iterator to the next pair
2231 * @since libnotmuch 4.4 (notmuch 0.23)
2234 notmuch_config_list_move_to_next (notmuch_config_list_t *config_list);
2237 * free any resources held by 'config_list'
2239 * @since libnotmuch 4.4 (notmuch 0.23)
2242 notmuch_config_list_destroy (notmuch_config_list_t *config_list);
2246 * get the current default indexing options for a given database.
2248 * This object will survive until the database itself is destroyed,
2249 * but the caller may also release it earlier with
2250 * notmuch_indexopts_destroy.
2252 * This object represents a set of options on how a message can be
2253 * added to the index. At the moment it is a featureless stub.
2255 * @since libnotmuch 5.1 (notmuch 0.26)
2257 notmuch_indexopts_t *
2258 notmuch_database_get_default_indexopts (notmuch_database_t *db);
2261 * Stating a policy about how to decrypt messages.
2263 * See index.decrypt in notmuch-config(1) for more details.
2266 NOTMUCH_DECRYPT_FALSE,
2267 NOTMUCH_DECRYPT_TRUE,
2268 NOTMUCH_DECRYPT_AUTO,
2269 NOTMUCH_DECRYPT_NOSTASH,
2270 } notmuch_decryption_policy_t;
2273 * Specify whether to decrypt encrypted parts while indexing.
2275 * Be aware that the index is likely sufficient to reconstruct the
2276 * cleartext of the message itself, so please ensure that the notmuch
2277 * message index is adequately protected. DO NOT SET THIS FLAG TO TRUE
2278 * without considering the security of your index.
2280 * @since libnotmuch 5.1 (notmuch 0.26)
2283 notmuch_indexopts_set_decrypt_policy (notmuch_indexopts_t *indexopts,
2284 notmuch_decryption_policy_t decrypt_policy);
2287 * Return whether to decrypt encrypted parts while indexing.
2288 * see notmuch_indexopts_set_decrypt_policy.
2290 * @since libnotmuch 5.1 (notmuch 0.26)
2292 notmuch_decryption_policy_t
2293 notmuch_indexopts_get_decrypt_policy (const notmuch_indexopts_t *indexopts);
2296 * Destroy a notmuch_indexopts_t object.
2298 * @since libnotmuch 5.1 (notmuch 0.26)
2301 notmuch_indexopts_destroy (notmuch_indexopts_t *options);
2305 * interrogate the library for compile time features
2307 * @since libnotmuch 4.4 (notmuch 0.23)
2310 notmuch_built_with (const char *name);
2313 #pragma GCC visibility pop