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 http://www.gnu.org/licenses/ .
18 * Author: Carl Worth <cworth@cworth.org>
22 * @defgroup notmuch The notmuch API
24 * Not much of an email library, (just index and search)
35 # define NOTMUCH_BEGIN_DECLS extern "C" {
36 # define NOTMUCH_END_DECLS }
38 # define NOTMUCH_BEGIN_DECLS
39 # define NOTMUCH_END_DECLS
55 * The library version number. This must agree with the soname
56 * version in Makefile.local.
58 #define LIBNOTMUCH_MAJOR_VERSION 4
59 #define LIBNOTMUCH_MINOR_VERSION 2
60 #define LIBNOTMUCH_MICRO_VERSION 0
62 #define NOTMUCH_DEPRECATED(major,minor) \
63 __attribute__ ((deprecated ("function deprecated as of libnotmuch " #major "." #minor)))
64 #endif /* __DOXYGEN__ */
67 * Check the version of the notmuch library being compiled against.
69 * Return true if the library being compiled against is of the
70 * specified version or above. For example:
73 * #if LIBNOTMUCH_CHECK_VERSION(3, 1, 0)
74 * (code requiring libnotmuch 3.1.0 or above)
78 * LIBNOTMUCH_CHECK_VERSION has been defined since version 3.1.0; to
79 * check for versions prior to that, use:
82 * #if !defined(NOTMUCH_CHECK_VERSION)
83 * (code requiring libnotmuch prior to 3.1.0)
87 #define LIBNOTMUCH_CHECK_VERSION (major, minor, micro) \
88 (LIBNOTMUCH_MAJOR_VERSION > (major) || \
89 (LIBNOTMUCH_MAJOR_VERSION == (major) && LIBNOTMUCH_MINOR_VERSION > (minor)) || \
90 (LIBNOTMUCH_MAJOR_VERSION == (major) && LIBNOTMUCH_MINOR_VERSION == (minor) && \
91 LIBNOTMUCH_MICRO_VERSION >= (micro)))
94 * Notmuch boolean type.
96 typedef int notmuch_bool_t;
99 * Status codes used for the return values of most functions.
101 * A zero value (NOTMUCH_STATUS_SUCCESS) indicates that the function
102 * completed without error. Any other value indicates an error.
104 typedef enum _notmuch_status {
108 NOTMUCH_STATUS_SUCCESS = 0,
112 NOTMUCH_STATUS_OUT_OF_MEMORY,
114 * An attempt was made to write to a database opened in read-only
117 NOTMUCH_STATUS_READ_ONLY_DATABASE,
119 * A Xapian exception occurred.
121 NOTMUCH_STATUS_XAPIAN_EXCEPTION,
123 * An error occurred trying to read or write to a file (this could
124 * be file not found, permission denied, etc.)
126 * @todo We don't really want to expose this lame XAPIAN_EXCEPTION
127 * value. Instead we should map to things like DATABASE_LOCKED or
130 NOTMUCH_STATUS_FILE_ERROR,
132 * A file was presented that doesn't appear to be an email
135 NOTMUCH_STATUS_FILE_NOT_EMAIL,
137 * A file contains a message ID that is identical to a message
138 * already in the database.
140 NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID,
142 * The user erroneously passed a NULL pointer to a notmuch
145 NOTMUCH_STATUS_NULL_POINTER,
147 * A tag value is too long (exceeds NOTMUCH_TAG_MAX).
149 NOTMUCH_STATUS_TAG_TOO_LONG,
151 * The notmuch_message_thaw function has been called more times
152 * than notmuch_message_freeze.
154 NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW,
156 * notmuch_database_end_atomic has been called more times than
157 * notmuch_database_begin_atomic.
159 NOTMUCH_STATUS_UNBALANCED_ATOMIC,
161 * The operation is not supported.
163 NOTMUCH_STATUS_UNSUPPORTED_OPERATION,
165 * The operation requires a database upgrade.
167 NOTMUCH_STATUS_UPGRADE_REQUIRED,
169 * There is a problem with the proposed path, e.g. a relative path
170 * passed to a function expecting an absolute path.
172 NOTMUCH_STATUS_PATH_ERROR,
174 * Not an actual status value. Just a way to find out how many
175 * valid status values there are.
177 NOTMUCH_STATUS_LAST_STATUS
181 * Get a string representation of a notmuch_status_t value.
183 * The result is read-only.
186 notmuch_status_to_string (notmuch_status_t status);
188 /* Various opaque data types. For each notmuch_<foo>_t see the various
189 * notmuch_<foo> functions below. */
191 typedef struct _notmuch_database notmuch_database_t;
192 typedef struct _notmuch_query notmuch_query_t;
193 typedef struct _notmuch_threads notmuch_threads_t;
194 typedef struct _notmuch_thread notmuch_thread_t;
195 typedef struct _notmuch_messages notmuch_messages_t;
196 typedef struct _notmuch_message notmuch_message_t;
197 typedef struct _notmuch_tags notmuch_tags_t;
198 typedef struct _notmuch_directory notmuch_directory_t;
199 typedef struct _notmuch_filenames notmuch_filenames_t;
200 #endif /* __DOXYGEN__ */
203 * Create a new, empty notmuch database located at 'path'.
205 * The path should be a top-level directory to a collection of
206 * plain-text email messages (one message per file). This call will
207 * create a new ".notmuch" directory within 'path' where notmuch will
210 * After a successful call to notmuch_database_create, the returned
211 * database will be open so the caller should call
212 * notmuch_database_destroy when finished with it.
214 * The database will not yet have any data in it
215 * (notmuch_database_create itself is a very cheap function). Messages
216 * contained within 'path' can be added to the database by calling
217 * notmuch_database_add_message.
219 * In case of any failure, this function returns an error status and
220 * sets *database to NULL (after printing an error message on stderr).
224 * NOTMUCH_STATUS_SUCCESS: Successfully created the database.
226 * NOTMUCH_STATUS_NULL_POINTER: The given 'path' argument is NULL.
228 * NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory.
230 * NOTMUCH_STATUS_FILE_ERROR: An error occurred trying to create the
231 * database file (such as permission denied, or file not found,
232 * etc.), or the database already exists.
234 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred.
237 notmuch_database_create (const char *path, notmuch_database_t **database);
240 * Like notmuch_database_create, except optionally return an error
241 * message. This message is allocated by malloc and should be freed by
245 notmuch_database_create_verbose (const char *path,
246 notmuch_database_t **database,
247 char **error_message);
250 * Database open mode for notmuch_database_open.
254 * Open database for reading only.
256 NOTMUCH_DATABASE_MODE_READ_ONLY = 0,
258 * Open database for reading and writing.
260 NOTMUCH_DATABASE_MODE_READ_WRITE
261 } notmuch_database_mode_t;
264 * Open an existing notmuch database located at 'path'.
266 * The database should have been created at some time in the past,
267 * (not necessarily by this process), by calling
268 * notmuch_database_create with 'path'. By default the database should be
269 * opened for reading only. In order to write to the database you need to
270 * pass the NOTMUCH_DATABASE_MODE_READ_WRITE mode.
272 * An existing notmuch database can be identified by the presence of a
273 * directory named ".notmuch" below 'path'.
275 * The caller should call notmuch_database_destroy when finished with
278 * In case of any failure, this function returns an error status and
279 * sets *database to NULL (after printing an error message on stderr).
283 * NOTMUCH_STATUS_SUCCESS: Successfully opened the database.
285 * NOTMUCH_STATUS_NULL_POINTER: The given 'path' argument is NULL.
287 * NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory.
289 * NOTMUCH_STATUS_FILE_ERROR: An error occurred trying to open the
290 * database file (such as permission denied, or file not found,
291 * etc.), or the database version is unknown.
293 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred.
296 notmuch_database_open (const char *path,
297 notmuch_database_mode_t mode,
298 notmuch_database_t **database);
300 * Like notmuch_database_open, except optionally return an error
301 * message. This message is allocated by malloc and should be freed by
306 notmuch_database_open_verbose (const char *path,
307 notmuch_database_mode_t mode,
308 notmuch_database_t **database,
309 char **error_message);
312 * Retrieve last status string for given database.
316 notmuch_database_status_string (notmuch_database_t *notmuch);
319 * Commit changes and close the given notmuch database.
321 * After notmuch_database_close has been called, calls to other
322 * functions on objects derived from this database may either behave
323 * as if the database had not been closed (e.g., if the required data
324 * has been cached) or may fail with a
325 * NOTMUCH_STATUS_XAPIAN_EXCEPTION.
327 * notmuch_database_close can be called multiple times. Later calls
330 * For writable databases, notmuch_database_close commits all changes
331 * to disk before closing the database. If the caller is currently in
332 * an atomic section (there was a notmuch_database_begin_atomic
333 * without a matching notmuch_database_end_atomic), this will discard
334 * changes made in that atomic section (but still commit changes made
335 * prior to entering the atomic section).
339 * NOTMUCH_STATUS_SUCCESS: Successfully closed the database.
341 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred; the
342 * database has been closed but there are no guarantees the
343 * changes to the database, if any, have been flushed to disk.
346 notmuch_database_close (notmuch_database_t *database);
349 * A callback invoked by notmuch_database_compact to notify the user
350 * of the progress of the compaction process.
352 typedef void (*notmuch_compact_status_cb_t)(const char *message, void *closure);
355 * Compact a notmuch database, backing up the original database to the
358 * The database will be opened with NOTMUCH_DATABASE_MODE_READ_WRITE
359 * during the compaction process to ensure no writes are made.
361 * If the optional callback function 'status_cb' is non-NULL, it will
362 * be called with diagnostic and informational messages. The argument
363 * 'closure' is passed verbatim to any callback invoked.
366 notmuch_database_compact (const char* path,
367 const char* backup_path,
368 notmuch_compact_status_cb_t status_cb,
372 * Destroy the notmuch database, closing it if necessary and freeing
373 * all associated resources.
375 * Return value as in notmuch_database_close if the database was open;
376 * notmuch_database_destroy itself has no failure modes.
379 notmuch_database_destroy (notmuch_database_t *database);
382 * Return the database path of the given database.
384 * The return value is a string owned by notmuch so should not be
385 * modified nor freed by the caller.
388 notmuch_database_get_path (notmuch_database_t *database);
391 * Return the database format version of the given database.
394 notmuch_database_get_version (notmuch_database_t *database);
397 * Can the database be upgraded to a newer database version?
399 * If this function returns TRUE, then the caller may call
400 * notmuch_database_upgrade to upgrade the database. If the caller
401 * does not upgrade an out-of-date database, then some functions may
402 * fail with NOTMUCH_STATUS_UPGRADE_REQUIRED. This always returns
403 * FALSE for a read-only database because there's no way to upgrade a
404 * read-only database.
407 notmuch_database_needs_upgrade (notmuch_database_t *database);
410 * Upgrade the current database to the latest supported version.
412 * This ensures that all current notmuch functionality will be
413 * available on the database. After opening a database in read-write
414 * mode, it is recommended that clients check if an upgrade is needed
415 * (notmuch_database_needs_upgrade) and if so, upgrade with this
416 * function before making any modifications. If
417 * notmuch_database_needs_upgrade returns FALSE, this will be a no-op.
419 * The optional progress_notify callback can be used by the caller to
420 * provide progress indication to the user. If non-NULL it will be
421 * called periodically with 'progress' as a floating-point value in
422 * the range of [0.0 .. 1.0] indicating the progress made so far in
423 * the upgrade process. The argument 'closure' is passed verbatim to
424 * any callback invoked.
427 notmuch_database_upgrade (notmuch_database_t *database,
428 void (*progress_notify) (void *closure,
433 * Begin an atomic database operation.
435 * Any modifications performed between a successful begin and a
436 * notmuch_database_end_atomic will be applied to the database
437 * atomically. Note that, unlike a typical database transaction, this
438 * only ensures atomicity, not durability; neither begin nor end
439 * necessarily flush modifications to disk.
441 * Atomic sections may be nested. begin_atomic and end_atomic must
442 * always be called in pairs.
446 * NOTMUCH_STATUS_SUCCESS: Successfully entered atomic section.
448 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred;
449 * atomic section not entered.
452 notmuch_database_begin_atomic (notmuch_database_t *notmuch);
455 * Indicate the end of an atomic database operation.
459 * NOTMUCH_STATUS_SUCCESS: Successfully completed atomic section.
461 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred;
462 * atomic section not ended.
464 * NOTMUCH_STATUS_UNBALANCED_ATOMIC: The database is not currently in
468 notmuch_database_end_atomic (notmuch_database_t *notmuch);
471 * Retrieve a directory object from the database for 'path'.
473 * Here, 'path' should be a path relative to the path of 'database'
474 * (see notmuch_database_get_path), or else should be an absolute path
475 * with initial components that match the path of 'database'.
477 * If this directory object does not exist in the database, this
478 * returns NOTMUCH_STATUS_SUCCESS and sets *directory to NULL.
480 * Otherwise the returned directory object is owned by the database
481 * and as such, will only be valid until notmuch_database_destroy is
486 * NOTMUCH_STATUS_SUCCESS: Successfully retrieved directory.
488 * NOTMUCH_STATUS_NULL_POINTER: The given 'directory' argument is NULL.
490 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred;
491 * directory not retrieved.
493 * NOTMUCH_STATUS_UPGRADE_REQUIRED: The caller must upgrade the
494 * database to use this function.
497 notmuch_database_get_directory (notmuch_database_t *database,
499 notmuch_directory_t **directory);
502 * Add a new message to the given notmuch database or associate an
503 * additional filename with an existing message.
505 * Here, 'filename' should be a path relative to the path of
506 * 'database' (see notmuch_database_get_path), or else should be an
507 * absolute filename with initial components that match the path of
510 * The file should be a single mail message (not a multi-message mbox)
511 * that is expected to remain at its current location, (since the
512 * notmuch database will reference the filename, and will not copy the
513 * entire contents of the file.
515 * If another message with the same message ID already exists in the
516 * database, rather than creating a new message, this adds 'filename'
517 * to the list of the filenames for the existing message.
519 * If 'message' is not NULL, then, on successful return
520 * (NOTMUCH_STATUS_SUCCESS or NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID) '*message'
521 * will be initialized to a message object that can be used for things
522 * such as adding tags to the just-added message. The user should call
523 * notmuch_message_destroy when done with the message. On any failure
524 * '*message' will be set to NULL.
528 * NOTMUCH_STATUS_SUCCESS: Message successfully added to database.
530 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred,
533 * NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID: Message has the same message
534 * ID as another message already in the database. The new
535 * filename was successfully added to the message in the database
536 * (if not already present) and the existing message is returned.
538 * NOTMUCH_STATUS_FILE_ERROR: an error occurred trying to open the
539 * file, (such as permission denied, or file not found,
540 * etc.). Nothing added to the database.
542 * NOTMUCH_STATUS_FILE_NOT_EMAIL: the contents of filename don't look
543 * like an email message. Nothing added to the database.
545 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
546 * mode so no message can be added.
548 * NOTMUCH_STATUS_UPGRADE_REQUIRED: The caller must upgrade the
549 * database to use this function.
552 notmuch_database_add_message (notmuch_database_t *database,
553 const char *filename,
554 notmuch_message_t **message);
557 * Remove a message filename from the given notmuch database. If the
558 * message has no more filenames, remove the message.
560 * If the same message (as determined by the message ID) is still
561 * available via other filenames, then the message will persist in the
562 * database for those filenames. When the last filename is removed for
563 * a particular message, the database content for that message will be
568 * NOTMUCH_STATUS_SUCCESS: The last filename was removed and the
569 * message was removed from the database.
571 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred,
572 * message not removed.
574 * NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID: This filename was removed but
575 * the message persists in the database with at least one other
578 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
579 * mode so no message can be removed.
581 * NOTMUCH_STATUS_UPGRADE_REQUIRED: The caller must upgrade the
582 * database to use this function.
585 notmuch_database_remove_message (notmuch_database_t *database,
586 const char *filename);
589 * Find a message with the given message_id.
591 * If a message with the given message_id is found then, on successful return
592 * (NOTMUCH_STATUS_SUCCESS) '*message' will be initialized to a message
593 * object. The caller should call notmuch_message_destroy when done with the
596 * On any failure or when the message is not found, this function initializes
597 * '*message' to NULL. This means, when NOTMUCH_STATUS_SUCCESS is returned, the
598 * caller is supposed to check '*message' for NULL to find out whether the
599 * message with the given message_id was found.
603 * NOTMUCH_STATUS_SUCCESS: Successful return, check '*message'.
605 * NOTMUCH_STATUS_NULL_POINTER: The given 'message' argument is NULL
607 * NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory, creating message object
609 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred
612 notmuch_database_find_message (notmuch_database_t *database,
613 const char *message_id,
614 notmuch_message_t **message);
617 * Find a message with the given filename.
619 * If the database contains a message with the given filename then, on
620 * successful return (NOTMUCH_STATUS_SUCCESS) '*message' will be initialized to
621 * a message object. The caller should call notmuch_message_destroy when done
624 * On any failure or when the message is not found, this function initializes
625 * '*message' to NULL. This means, when NOTMUCH_STATUS_SUCCESS is returned, the
626 * caller is supposed to check '*message' for NULL to find out whether the
627 * message with the given filename is found.
631 * NOTMUCH_STATUS_SUCCESS: Successful return, check '*message'
633 * NOTMUCH_STATUS_NULL_POINTER: The given 'message' argument is NULL
635 * NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory, creating the message object
637 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred
639 * NOTMUCH_STATUS_UPGRADE_REQUIRED: The caller must upgrade the
640 * database to use this function.
643 notmuch_database_find_message_by_filename (notmuch_database_t *notmuch,
644 const char *filename,
645 notmuch_message_t **message);
648 * Return a list of all tags found in the database.
650 * This function creates a list of all tags found in the database. The
651 * resulting list contains all tags from all messages found in the database.
653 * On error this function returns NULL.
656 notmuch_database_get_all_tags (notmuch_database_t *db);
659 * Create a new query for 'database'.
661 * Here, 'database' should be an open database, (see
662 * notmuch_database_open and notmuch_database_create).
664 * For the query string, we'll document the syntax here more
665 * completely in the future, but it's likely to be a specialized
666 * version of the general Xapian query syntax:
668 * http://xapian.org/docs/queryparser.html
670 * As a special case, passing either a length-zero string, (that is ""),
671 * or a string consisting of a single asterisk (that is "*"), will
672 * result in a query that returns all messages in the database.
674 * See notmuch_query_set_sort for controlling the order of results.
675 * See notmuch_query_search_messages and notmuch_query_search_threads
676 * to actually execute the query.
678 * User should call notmuch_query_destroy when finished with this
681 * Will return NULL if insufficient memory is available.
684 notmuch_query_create (notmuch_database_t *database,
685 const char *query_string);
688 * Sort values for notmuch_query_set_sort.
694 NOTMUCH_SORT_OLDEST_FIRST,
698 NOTMUCH_SORT_NEWEST_FIRST,
700 * Sort by message-id.
702 NOTMUCH_SORT_MESSAGE_ID,
706 NOTMUCH_SORT_UNSORTED
710 * Return the query_string of this query. See notmuch_query_create.
713 notmuch_query_get_query_string (notmuch_query_t *query);
716 * Exclude values for notmuch_query_set_omit_excluded. The strange
717 * order is to maintain backward compatibility: the old FALSE/TRUE
718 * options correspond to the new
719 * NOTMUCH_EXCLUDE_FLAG/NOTMUCH_EXCLUDE_TRUE options.
722 NOTMUCH_EXCLUDE_FLAG,
723 NOTMUCH_EXCLUDE_TRUE,
724 NOTMUCH_EXCLUDE_FALSE,
729 * Specify whether to omit excluded results or simply flag them. By
730 * default, this is set to TRUE.
732 * If set to TRUE or ALL, notmuch_query_search_messages will omit excluded
733 * messages from the results, and notmuch_query_search_threads will omit
734 * threads that match only in excluded messages. If set to TRUE,
735 * notmuch_query_search_threads will include all messages in threads that
736 * match in at least one non-excluded message. Otherwise, if set to ALL,
737 * notmuch_query_search_threads will omit excluded messages from all threads.
739 * If set to FALSE or FLAG then both notmuch_query_search_messages and
740 * notmuch_query_search_threads will return all matching
741 * messages/threads regardless of exclude status. If set to FLAG then
742 * the exclude flag will be set for any excluded message that is
743 * returned by notmuch_query_search_messages, and the thread counts
744 * for threads returned by notmuch_query_search_threads will be the
745 * number of non-excluded messages/matches. Otherwise, if set to
746 * FALSE, then the exclude status is completely ignored.
748 * The performance difference when calling
749 * notmuch_query_search_messages should be relatively small (and both
750 * should be very fast). However, in some cases,
751 * notmuch_query_search_threads is very much faster when omitting
752 * excluded messages as it does not need to construct the threads that
753 * only match in excluded messages.
756 notmuch_query_set_omit_excluded (notmuch_query_t *query,
757 notmuch_exclude_t omit_excluded);
760 * Specify the sorting desired for this query.
763 notmuch_query_set_sort (notmuch_query_t *query, notmuch_sort_t sort);
766 * Return the sort specified for this query. See
767 * notmuch_query_set_sort.
770 notmuch_query_get_sort (notmuch_query_t *query);
773 * Add a tag that will be excluded from the query results by default.
774 * This exclusion will be overridden if this tag appears explicitly in
778 notmuch_query_add_tag_exclude (notmuch_query_t *query, const char *tag);
781 * Execute a query for threads, returning a notmuch_threads_t object
782 * which can be used to iterate over the results. The returned threads
783 * object is owned by the query and as such, will only be valid until
784 * notmuch_query_destroy.
786 * Typical usage might be:
788 * notmuch_query_t *query;
789 * notmuch_threads_t *threads;
790 * notmuch_thread_t *thread;
792 * query = notmuch_query_create (database, query_string);
794 * for (threads = notmuch_query_search_threads (query);
795 * notmuch_threads_valid (threads);
796 * notmuch_threads_move_to_next (threads))
798 * thread = notmuch_threads_get (threads);
800 * notmuch_thread_destroy (thread);
803 * notmuch_query_destroy (query);
805 * Note: If you are finished with a thread before its containing
806 * query, you can call notmuch_thread_destroy to clean up some memory
807 * sooner (as in the above example). Otherwise, if your thread objects
808 * are long-lived, then you don't need to call notmuch_thread_destroy
809 * and all the memory will still be reclaimed when the query is
812 * Note that there's no explicit destructor needed for the
813 * notmuch_threads_t object. (For consistency, we do provide a
814 * notmuch_threads_destroy function, but there's no good reason
815 * to call it if the query is about to be destroyed).
819 notmuch_query_search_threads_st (notmuch_query_t *query,
820 notmuch_threads_t **out);
823 * Like notmuch_query_search_threads_st, but without a status return.
825 * If a Xapian exception occurs this function will return NULL.
827 * @deprecated Deprecated as of libnotmuch 4.3 (notmuch 0.21). Please
828 * use notmuch_query_search_threads_st instead.
831 NOTMUCH_DEPRECATED(4,3)
833 notmuch_query_search_threads (notmuch_query_t *query);
836 * Execute a query for messages, returning a notmuch_messages_t object
837 * which can be used to iterate over the results. The returned
838 * messages object is owned by the query and as such, will only be
839 * valid until notmuch_query_destroy.
841 * Typical usage might be:
843 * notmuch_query_t *query;
844 * notmuch_messages_t *messages;
845 * notmuch_message_t *message;
847 * query = notmuch_query_create (database, query_string);
849 * for (messages = notmuch_query_search_messages (query);
850 * notmuch_messages_valid (messages);
851 * notmuch_messages_move_to_next (messages))
853 * message = notmuch_messages_get (messages);
855 * notmuch_message_destroy (message);
858 * notmuch_query_destroy (query);
860 * Note: If you are finished with a message before its containing
861 * query, you can call notmuch_message_destroy to clean up some memory
862 * sooner (as in the above example). Otherwise, if your message
863 * objects are long-lived, then you don't need to call
864 * notmuch_message_destroy and all the memory will still be reclaimed
865 * when the query is destroyed.
867 * Note that there's no explicit destructor needed for the
868 * notmuch_messages_t object. (For consistency, we do provide a
869 * notmuch_messages_destroy function, but there's no good
870 * reason to call it if the query is about to be destroyed).
872 * If a Xapian exception occurs this function will return NULL.
876 notmuch_query_search_messages_st (notmuch_query_t *query,
877 notmuch_messages_t **out);
879 * Like notmuch_query_search_messages, but without a status return.
881 * If a Xapian exception occurs this function will return NULL.
883 * @deprecated Deprecated as of libnotmuch 4.3 (notmuch 0.21). Please use
884 * notmuch_query_search_messages_st instead.
887 NOTMUCH_DEPRECATED(4,3)
889 notmuch_query_search_messages (notmuch_query_t *query);
892 * Destroy a notmuch_query_t along with any associated resources.
894 * This will in turn destroy any notmuch_threads_t and
895 * notmuch_messages_t objects generated by this query, (and in
896 * turn any notmuch_thread_t and notmuch_message_t objects generated
897 * from those results, etc.), if such objects haven't already been
901 notmuch_query_destroy (notmuch_query_t *query);
904 * Is the given 'threads' iterator pointing at a valid thread.
906 * When this function returns TRUE, notmuch_threads_get will return a
907 * valid object. Whereas when this function returns FALSE,
908 * notmuch_threads_get will return NULL.
910 * If passed a NULL pointer, this function returns FALSE
912 * See the documentation of notmuch_query_search_threads for example
913 * code showing how to iterate over a notmuch_threads_t object.
916 notmuch_threads_valid (notmuch_threads_t *threads);
919 * Get the current thread from 'threads' as a notmuch_thread_t.
921 * Note: The returned thread belongs to 'threads' and has a lifetime
922 * identical to it (and the query to which it belongs).
924 * See the documentation of notmuch_query_search_threads for example
925 * code showing how to iterate over a notmuch_threads_t object.
927 * If an out-of-memory situation occurs, this function will return
931 notmuch_threads_get (notmuch_threads_t *threads);
934 * Move the 'threads' iterator to the next thread.
936 * If 'threads' is already pointing at the last thread then the
937 * iterator will be moved to a point just beyond that last thread,
938 * (where notmuch_threads_valid will return FALSE and
939 * notmuch_threads_get will return NULL).
941 * See the documentation of notmuch_query_search_threads for example
942 * code showing how to iterate over a notmuch_threads_t object.
945 notmuch_threads_move_to_next (notmuch_threads_t *threads);
948 * Destroy a notmuch_threads_t object.
950 * It's not strictly necessary to call this function. All memory from
951 * the notmuch_threads_t object will be reclaimed when the
952 * containing query object is destroyed.
955 notmuch_threads_destroy (notmuch_threads_t *threads);
958 * Return the number of messages matching a search.
960 * This function performs a search and returns the number of matching
963 * If a Xapian exception occurs, this function may return 0 (after
964 * printing a message).
967 notmuch_query_count_messages (notmuch_query_t *query);
970 * Return the number of threads matching a search.
972 * This function performs a search and returns the number of unique thread IDs
973 * in the matching messages. This is the same as number of threads matching a
976 * Note that this is a significantly heavier operation than
977 * notmuch_query_count_messages().
979 * If an error occurs, this function may return 0.
982 notmuch_query_count_threads (notmuch_query_t *query);
985 * Get the thread ID of 'thread'.
987 * The returned string belongs to 'thread' and as such, should not be
988 * modified by the caller and will only be valid for as long as the
989 * thread is valid, (which is until notmuch_thread_destroy or until
990 * the query from which it derived is destroyed).
993 notmuch_thread_get_thread_id (notmuch_thread_t *thread);
996 * Get the total number of messages in 'thread'.
998 * This count consists of all messages in the database belonging to
999 * this thread. Contrast with notmuch_thread_get_matched_messages() .
1002 notmuch_thread_get_total_messages (notmuch_thread_t *thread);
1005 * Get a notmuch_messages_t iterator for the top-level messages in
1006 * 'thread' in oldest-first order.
1008 * This iterator will not necessarily iterate over all of the messages
1009 * in the thread. It will only iterate over the messages in the thread
1010 * which are not replies to other messages in the thread.
1012 * The returned list will be destroyed when the thread is destroyed.
1014 notmuch_messages_t *
1015 notmuch_thread_get_toplevel_messages (notmuch_thread_t *thread);
1018 * Get a notmuch_thread_t iterator for all messages in 'thread' in
1019 * oldest-first order.
1021 * The returned list will be destroyed when the thread is destroyed.
1023 notmuch_messages_t *
1024 notmuch_thread_get_messages (notmuch_thread_t *thread);
1027 * Get the number of messages in 'thread' that matched the search.
1029 * This count includes only the messages in this thread that were
1030 * matched by the search from which the thread was created and were
1031 * not excluded by any exclude tags passed in with the query (see
1032 * notmuch_query_add_tag_exclude). Contrast with
1033 * notmuch_thread_get_total_messages() .
1036 notmuch_thread_get_matched_messages (notmuch_thread_t *thread);
1039 * Get the authors of 'thread' as a UTF-8 string.
1041 * The returned string is a comma-separated list of the names of the
1042 * authors of mail messages in the query results that belong to this
1045 * The string contains authors of messages matching the query first, then
1046 * non-matched authors (with the two groups separated by '|'). Within
1047 * each group, authors are ordered by date.
1049 * The returned string belongs to 'thread' and as such, should not be
1050 * modified by the caller and will only be valid for as long as the
1051 * thread is valid, (which is until notmuch_thread_destroy or until
1052 * the query from which it derived is destroyed).
1055 notmuch_thread_get_authors (notmuch_thread_t *thread);
1058 * Get the subject of 'thread' as a UTF-8 string.
1060 * The subject is taken from the first message (according to the query
1061 * order---see notmuch_query_set_sort) in the query results that
1062 * belongs to this thread.
1064 * The returned string belongs to 'thread' and as such, should not be
1065 * modified by the caller and will only be valid for as long as the
1066 * thread is valid, (which is until notmuch_thread_destroy or until
1067 * the query from which it derived is destroyed).
1070 notmuch_thread_get_subject (notmuch_thread_t *thread);
1073 * Get the date of the oldest message in 'thread' as a time_t value.
1076 notmuch_thread_get_oldest_date (notmuch_thread_t *thread);
1079 * Get the date of the newest message in 'thread' as a time_t value.
1082 notmuch_thread_get_newest_date (notmuch_thread_t *thread);
1085 * Get the tags for 'thread', returning a notmuch_tags_t object which
1086 * can be used to iterate over all tags.
1088 * Note: In the Notmuch database, tags are stored on individual
1089 * messages, not on threads. So the tags returned here will be all
1090 * tags of the messages which matched the search and which belong to
1093 * The tags object is owned by the thread and as such, will only be
1094 * valid for as long as the thread is valid, (for example, until
1095 * notmuch_thread_destroy or until the query from which it derived is
1098 * Typical usage might be:
1100 * notmuch_thread_t *thread;
1101 * notmuch_tags_t *tags;
1104 * thread = notmuch_threads_get (threads);
1106 * for (tags = notmuch_thread_get_tags (thread);
1107 * notmuch_tags_valid (tags);
1108 * notmuch_tags_move_to_next (tags))
1110 * tag = notmuch_tags_get (tags);
1114 * notmuch_thread_destroy (thread);
1116 * Note that there's no explicit destructor needed for the
1117 * notmuch_tags_t object. (For consistency, we do provide a
1118 * notmuch_tags_destroy function, but there's no good reason to call
1119 * it if the message is about to be destroyed).
1122 notmuch_thread_get_tags (notmuch_thread_t *thread);
1125 * Destroy a notmuch_thread_t object.
1128 notmuch_thread_destroy (notmuch_thread_t *thread);
1131 * Is the given 'messages' iterator pointing at a valid message.
1133 * When this function returns TRUE, notmuch_messages_get will return a
1134 * valid object. Whereas when this function returns FALSE,
1135 * notmuch_messages_get will return NULL.
1137 * See the documentation of notmuch_query_search_messages for example
1138 * code showing how to iterate over a notmuch_messages_t object.
1141 notmuch_messages_valid (notmuch_messages_t *messages);
1144 * Get the current message from 'messages' as a notmuch_message_t.
1146 * Note: The returned message belongs to 'messages' and has a lifetime
1147 * identical to it (and the query to which it belongs).
1149 * See the documentation of notmuch_query_search_messages for example
1150 * code showing how to iterate over a notmuch_messages_t object.
1152 * If an out-of-memory situation occurs, this function will return
1156 notmuch_messages_get (notmuch_messages_t *messages);
1159 * Move the 'messages' iterator to the next message.
1161 * If 'messages' is already pointing at the last message then the
1162 * iterator will be moved to a point just beyond that last message,
1163 * (where notmuch_messages_valid will return FALSE and
1164 * notmuch_messages_get will return NULL).
1166 * See the documentation of notmuch_query_search_messages for example
1167 * code showing how to iterate over a notmuch_messages_t object.
1170 notmuch_messages_move_to_next (notmuch_messages_t *messages);
1173 * Destroy a notmuch_messages_t object.
1175 * It's not strictly necessary to call this function. All memory from
1176 * the notmuch_messages_t object will be reclaimed when the containing
1177 * query object is destroyed.
1180 notmuch_messages_destroy (notmuch_messages_t *messages);
1183 * Return a list of tags from all messages.
1185 * The resulting list is guaranteed not to contain duplicated tags.
1187 * WARNING: You can no longer iterate over messages after calling this
1188 * function, because the iterator will point at the end of the list.
1189 * We do not have a function to reset the iterator yet and the only
1190 * way how you can iterate over the list again is to recreate the
1193 * The function returns NULL on error.
1196 notmuch_messages_collect_tags (notmuch_messages_t *messages);
1199 * Get the message ID of 'message'.
1201 * The returned string belongs to 'message' and as such, should not be
1202 * modified by the caller and will only be valid for as long as the
1203 * message is valid, (which is until the query from which it derived
1206 * This function will not return NULL since Notmuch ensures that every
1207 * message has a unique message ID, (Notmuch will generate an ID for a
1208 * message if the original file does not contain one).
1211 notmuch_message_get_message_id (notmuch_message_t *message);
1214 * Get the thread ID of 'message'.
1216 * The returned string belongs to 'message' and as such, should not be
1217 * modified by the caller and will only be valid for as long as the
1218 * message is valid, (for example, until the user calls
1219 * notmuch_message_destroy on 'message' or until a query from which it
1220 * derived is destroyed).
1222 * This function will not return NULL since Notmuch ensures that every
1223 * message belongs to a single thread.
1226 notmuch_message_get_thread_id (notmuch_message_t *message);
1229 * Get a notmuch_messages_t iterator for all of the replies to
1232 * Note: This call only makes sense if 'message' was ultimately
1233 * obtained from a notmuch_thread_t object, (such as by coming
1234 * directly from the result of calling notmuch_thread_get_
1235 * toplevel_messages or by any number of subsequent
1236 * calls to notmuch_message_get_replies).
1238 * If 'message' was obtained through some non-thread means, (such as
1239 * by a call to notmuch_query_search_messages), then this function
1242 * If there are no replies to 'message', this function will return
1243 * NULL. (Note that notmuch_messages_valid will accept that NULL
1244 * value as legitimate, and simply return FALSE for it.)
1246 notmuch_messages_t *
1247 notmuch_message_get_replies (notmuch_message_t *message);
1250 * Get a filename for the email corresponding to 'message'.
1252 * The returned filename is an absolute filename, (the initial
1253 * component will match notmuch_database_get_path() ).
1255 * The returned string belongs to the message so should not be
1256 * modified or freed by the caller (nor should it be referenced after
1257 * the message is destroyed).
1259 * Note: If this message corresponds to multiple files in the mail
1260 * store, (that is, multiple files contain identical message IDs),
1261 * this function will arbitrarily return a single one of those
1262 * filenames. See notmuch_message_get_filenames for returning the
1263 * complete list of filenames.
1266 notmuch_message_get_filename (notmuch_message_t *message);
1269 * Get all filenames for the email corresponding to 'message'.
1271 * Returns a notmuch_filenames_t iterator listing all the filenames
1272 * associated with 'message'. These files may not have identical
1273 * content, but each will have the identical Message-ID.
1275 * Each filename in the iterator is an absolute filename, (the initial
1276 * component will match notmuch_database_get_path() ).
1278 notmuch_filenames_t *
1279 notmuch_message_get_filenames (notmuch_message_t *message);
1284 typedef enum _notmuch_message_flag {
1285 NOTMUCH_MESSAGE_FLAG_MATCH,
1286 NOTMUCH_MESSAGE_FLAG_EXCLUDED,
1288 /* This message is a "ghost message", meaning it has no filenames
1289 * or content, but we know it exists because it was referenced by
1290 * some other message. A ghost message has only a message ID and
1293 NOTMUCH_MESSAGE_FLAG_GHOST,
1294 } notmuch_message_flag_t;
1297 * Get a value of a flag for the email corresponding to 'message'.
1300 notmuch_message_get_flag (notmuch_message_t *message,
1301 notmuch_message_flag_t flag);
1304 * Set a value of a flag for the email corresponding to 'message'.
1307 notmuch_message_set_flag (notmuch_message_t *message,
1308 notmuch_message_flag_t flag, notmuch_bool_t value);
1311 * Get the date of 'message' as a time_t value.
1313 * For the original textual representation of the Date header from the
1314 * message call notmuch_message_get_header() with a header value of
1318 notmuch_message_get_date (notmuch_message_t *message);
1321 * Get the value of the specified header from 'message' as a UTF-8 string.
1323 * Common headers are stored in the database when the message is
1324 * indexed and will be returned from the database. Other headers will
1325 * be read from the actual message file.
1327 * The header name is case insensitive.
1329 * The returned string belongs to the message so should not be
1330 * modified or freed by the caller (nor should it be referenced after
1331 * the message is destroyed).
1333 * Returns an empty string ("") if the message does not contain a
1334 * header line matching 'header'. Returns NULL if any error occurs.
1337 notmuch_message_get_header (notmuch_message_t *message, const char *header);
1340 * Get the tags for 'message', returning a notmuch_tags_t object which
1341 * can be used to iterate over all tags.
1343 * The tags object is owned by the message and as such, will only be
1344 * valid for as long as the message is valid, (which is until the
1345 * query from which it derived is destroyed).
1347 * Typical usage might be:
1349 * notmuch_message_t *message;
1350 * notmuch_tags_t *tags;
1353 * message = notmuch_database_find_message (database, message_id);
1355 * for (tags = notmuch_message_get_tags (message);
1356 * notmuch_tags_valid (tags);
1357 * notmuch_tags_move_to_next (tags))
1359 * tag = notmuch_tags_get (tags);
1363 * notmuch_message_destroy (message);
1365 * Note that there's no explicit destructor needed for the
1366 * notmuch_tags_t object. (For consistency, we do provide a
1367 * notmuch_tags_destroy function, but there's no good reason to call
1368 * it if the message is about to be destroyed).
1371 notmuch_message_get_tags (notmuch_message_t *message);
1374 * The longest possible tag value.
1376 #define NOTMUCH_TAG_MAX 200
1379 * Add a tag to the given message.
1383 * NOTMUCH_STATUS_SUCCESS: Tag successfully added to message
1385 * NOTMUCH_STATUS_NULL_POINTER: The 'tag' argument is NULL
1387 * NOTMUCH_STATUS_TAG_TOO_LONG: The length of 'tag' is too long
1388 * (exceeds NOTMUCH_TAG_MAX)
1390 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
1391 * mode so message cannot be modified.
1394 notmuch_message_add_tag (notmuch_message_t *message, const char *tag);
1397 * Remove a tag from the given message.
1401 * NOTMUCH_STATUS_SUCCESS: Tag successfully removed from message
1403 * NOTMUCH_STATUS_NULL_POINTER: The 'tag' argument is NULL
1405 * NOTMUCH_STATUS_TAG_TOO_LONG: The length of 'tag' is too long
1406 * (exceeds NOTMUCH_TAG_MAX)
1408 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
1409 * mode so message cannot be modified.
1412 notmuch_message_remove_tag (notmuch_message_t *message, const char *tag);
1415 * Remove all tags from the given message.
1417 * See notmuch_message_freeze for an example showing how to safely
1418 * replace tag values.
1420 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
1421 * mode so message cannot be modified.
1424 notmuch_message_remove_all_tags (notmuch_message_t *message);
1427 * Add/remove tags according to maildir flags in the message filename(s).
1429 * This function examines the filenames of 'message' for maildir
1430 * flags, and adds or removes tags on 'message' as follows when these
1431 * flags are present:
1433 * Flag Action if present
1434 * ---- -----------------
1435 * 'D' Adds the "draft" tag to the message
1436 * 'F' Adds the "flagged" tag to the message
1437 * 'P' Adds the "passed" tag to the message
1438 * 'R' Adds the "replied" tag to the message
1439 * 'S' Removes the "unread" tag from the message
1441 * For each flag that is not present, the opposite action (add/remove)
1442 * is performed for the corresponding tags.
1444 * Flags are identified as trailing components of the filename after a
1445 * sequence of ":2,".
1447 * If there are multiple filenames associated with this message, the
1448 * flag is considered present if it appears in one or more
1449 * filenames. (That is, the flags from the multiple filenames are
1450 * combined with the logical OR operator.)
1452 * A client can ensure that notmuch database tags remain synchronized
1453 * with maildir flags by calling this function after each call to
1454 * notmuch_database_add_message. See also
1455 * notmuch_message_tags_to_maildir_flags for synchronizing tag changes
1456 * back to maildir flags.
1459 notmuch_message_maildir_flags_to_tags (notmuch_message_t *message);
1462 * Rename message filename(s) to encode tags as maildir flags.
1464 * Specifically, for each filename corresponding to this message:
1466 * If the filename is not in a maildir directory, do nothing. (A
1467 * maildir directory is determined as a directory named "new" or
1468 * "cur".) Similarly, if the filename has invalid maildir info,
1469 * (repeated or outof-ASCII-order flag characters after ":2,"), then
1472 * If the filename is in a maildir directory, rename the file so that
1473 * its filename ends with the sequence ":2," followed by zero or more
1474 * of the following single-character flags (in ASCII order):
1476 * 'D' iff the message has the "draft" tag
1477 * 'F' iff the message has the "flagged" tag
1478 * 'P' iff the message has the "passed" tag
1479 * 'R' iff the message has the "replied" tag
1480 * 'S' iff the message does not have the "unread" tag
1482 * Any existing flags unmentioned in the list above will be preserved
1485 * Also, if this filename is in a directory named "new", rename it to
1486 * be within the neighboring directory named "cur".
1488 * A client can ensure that maildir filename flags remain synchronized
1489 * with notmuch database tags by calling this function after changing
1490 * tags, (after calls to notmuch_message_add_tag,
1491 * notmuch_message_remove_tag, or notmuch_message_freeze/
1492 * notmuch_message_thaw). See also notmuch_message_maildir_flags_to_tags
1493 * for synchronizing maildir flag changes back to tags.
1496 notmuch_message_tags_to_maildir_flags (notmuch_message_t *message);
1499 * Freeze the current state of 'message' within the database.
1501 * This means that changes to the message state, (via
1502 * notmuch_message_add_tag, notmuch_message_remove_tag, and
1503 * notmuch_message_remove_all_tags), will not be committed to the
1504 * database until the message is thawed with notmuch_message_thaw.
1506 * Multiple calls to freeze/thaw are valid and these calls will
1507 * "stack". That is there must be as many calls to thaw as to freeze
1508 * before a message is actually thawed.
1510 * The ability to do freeze/thaw allows for safe transactions to
1511 * change tag values. For example, explicitly setting a message to
1512 * have a given set of tags might look like this:
1514 * notmuch_message_freeze (message);
1516 * notmuch_message_remove_all_tags (message);
1518 * for (i = 0; i < NUM_TAGS; i++)
1519 * notmuch_message_add_tag (message, tags[i]);
1521 * notmuch_message_thaw (message);
1523 * With freeze/thaw used like this, the message in the database is
1524 * guaranteed to have either the full set of original tag values, or
1525 * the full set of new tag values, but nothing in between.
1527 * Imagine the example above without freeze/thaw and the operation
1528 * somehow getting interrupted. This could result in the message being
1529 * left with no tags if the interruption happened after
1530 * notmuch_message_remove_all_tags but before notmuch_message_add_tag.
1534 * NOTMUCH_STATUS_SUCCESS: Message successfully frozen.
1536 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
1537 * mode so message cannot be modified.
1540 notmuch_message_freeze (notmuch_message_t *message);
1543 * Thaw the current 'message', synchronizing any changes that may have
1544 * occurred while 'message' was frozen into the notmuch database.
1546 * See notmuch_message_freeze for an example of how to use this
1547 * function to safely provide tag changes.
1549 * Multiple calls to freeze/thaw are valid and these calls with
1550 * "stack". That is there must be as many calls to thaw as to freeze
1551 * before a message is actually thawed.
1555 * NOTMUCH_STATUS_SUCCESS: Message successfully thawed, (or at least
1556 * its frozen count has successfully been reduced by 1).
1558 * NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW: An attempt was made to thaw
1559 * an unfrozen message. That is, there have been an unbalanced
1560 * number of calls to notmuch_message_freeze and
1561 * notmuch_message_thaw.
1564 notmuch_message_thaw (notmuch_message_t *message);
1567 * Destroy a notmuch_message_t object.
1569 * It can be useful to call this function in the case of a single
1570 * query object with many messages in the result, (such as iterating
1571 * over the entire database). Otherwise, it's fine to never call this
1572 * function and there will still be no memory leaks. (The memory from
1573 * the messages get reclaimed when the containing query is destroyed.)
1576 notmuch_message_destroy (notmuch_message_t *message);
1579 * Is the given 'tags' iterator pointing at a valid tag.
1581 * When this function returns TRUE, notmuch_tags_get will return a
1582 * valid string. Whereas when this function returns FALSE,
1583 * notmuch_tags_get will return NULL.
1585 * See the documentation of notmuch_message_get_tags for example code
1586 * showing how to iterate over a notmuch_tags_t object.
1589 notmuch_tags_valid (notmuch_tags_t *tags);
1592 * Get the current tag from 'tags' as a string.
1594 * Note: The returned string belongs to 'tags' and has a lifetime
1595 * identical to it (and the query to which it ultimately belongs).
1597 * See the documentation of notmuch_message_get_tags for example code
1598 * showing how to iterate over a notmuch_tags_t object.
1601 notmuch_tags_get (notmuch_tags_t *tags);
1604 * Move the 'tags' iterator to the next tag.
1606 * If 'tags' is already pointing at the last tag then the iterator
1607 * will be moved to a point just beyond that last tag, (where
1608 * notmuch_tags_valid will return FALSE and notmuch_tags_get will
1611 * See the documentation of notmuch_message_get_tags for example code
1612 * showing how to iterate over a notmuch_tags_t object.
1615 notmuch_tags_move_to_next (notmuch_tags_t *tags);
1618 * Destroy a notmuch_tags_t object.
1620 * It's not strictly necessary to call this function. All memory from
1621 * the notmuch_tags_t object will be reclaimed when the containing
1622 * message or query objects are destroyed.
1625 notmuch_tags_destroy (notmuch_tags_t *tags);
1628 * Store an mtime within the database for 'directory'.
1630 * The 'directory' should be an object retrieved from the database
1631 * with notmuch_database_get_directory for a particular path.
1633 * The intention is for the caller to use the mtime to allow efficient
1634 * identification of new messages to be added to the database. The
1635 * recommended usage is as follows:
1637 * o Read the mtime of a directory from the filesystem
1639 * o Call add_message for all mail files in the directory
1641 * o Call notmuch_directory_set_mtime with the mtime read from the
1644 * Then, when wanting to check for updates to the directory in the
1645 * future, the client can call notmuch_directory_get_mtime and know
1646 * that it only needs to add files if the mtime of the directory and
1647 * files are newer than the stored timestamp.
1649 * Note: The notmuch_directory_get_mtime function does not allow the
1650 * caller to distinguish a timestamp of 0 from a non-existent
1651 * timestamp. So don't store a timestamp of 0 unless you are
1652 * comfortable with that.
1656 * NOTMUCH_STATUS_SUCCESS: mtime successfully stored in database.
1658 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception
1659 * occurred, mtime not stored.
1661 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
1662 * mode so directory mtime cannot be modified.
1665 notmuch_directory_set_mtime (notmuch_directory_t *directory,
1669 * Get the mtime of a directory, (as previously stored with
1670 * notmuch_directory_set_mtime).
1672 * Returns 0 if no mtime has previously been stored for this
1676 notmuch_directory_get_mtime (notmuch_directory_t *directory);
1679 * Get a notmuch_filenames_t iterator listing all the filenames of
1680 * messages in the database within the given directory.
1682 * The returned filenames will be the basename-entries only (not
1685 notmuch_filenames_t *
1686 notmuch_directory_get_child_files (notmuch_directory_t *directory);
1689 * Get a notmuch_filenams_t iterator listing all the filenames of
1690 * sub-directories in the database within the given directory.
1692 * The returned filenames will be the basename-entries only (not
1695 notmuch_filenames_t *
1696 notmuch_directory_get_child_directories (notmuch_directory_t *directory);
1699 * Destroy a notmuch_directory_t object.
1702 notmuch_directory_destroy (notmuch_directory_t *directory);
1705 * Is the given 'filenames' iterator pointing at a valid filename.
1707 * When this function returns TRUE, notmuch_filenames_get will return
1708 * a valid string. Whereas when this function returns FALSE,
1709 * notmuch_filenames_get will return NULL.
1711 * It is acceptable to pass NULL for 'filenames', in which case this
1712 * function will always return FALSE.
1715 notmuch_filenames_valid (notmuch_filenames_t *filenames);
1718 * Get the current filename from 'filenames' as a string.
1720 * Note: The returned string belongs to 'filenames' and has a lifetime
1721 * identical to it (and the directory to which it ultimately belongs).
1723 * It is acceptable to pass NULL for 'filenames', in which case this
1724 * function will always return NULL.
1727 notmuch_filenames_get (notmuch_filenames_t *filenames);
1730 * Move the 'filenames' iterator to the next filename.
1732 * If 'filenames' is already pointing at the last filename then the
1733 * iterator will be moved to a point just beyond that last filename,
1734 * (where notmuch_filenames_valid will return FALSE and
1735 * notmuch_filenames_get will return NULL).
1737 * It is acceptable to pass NULL for 'filenames', in which case this
1738 * function will do nothing.
1741 notmuch_filenames_move_to_next (notmuch_filenames_t *filenames);
1744 * Destroy a notmuch_filenames_t object.
1746 * It's not strictly necessary to call this function. All memory from
1747 * the notmuch_filenames_t object will be reclaimed when the
1748 * containing directory object is destroyed.
1750 * It is acceptable to pass NULL for 'filenames', in which case this
1751 * function will do nothing.
1754 notmuch_filenames_destroy (notmuch_filenames_t *filenames);