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 3
59 #define LIBNOTMUCH_MINOR_VERSION 1
60 #define LIBNOTMUCH_MICRO_VERSION 0
62 #endif /* __DOXYGEN__ */
65 * Check the version of the notmuch library being compiled against.
67 * Return true if the library being compiled against is of the
68 * specified version or above. For example:
71 * #if LIBNOTMUCH_CHECK_VERSION(3, 1, 0)
72 * (code requiring libnotmuch 3.1.0 or above)
76 * LIBNOTMUCH_CHECK_VERSION has been defined since version 3.1.0; to
77 * check for versions prior to that, use:
80 * #if !defined(NOTMUCH_CHECK_VERSION)
81 * (code requiring libnotmuch prior to 3.1.0)
85 #define LIBNOTMUCH_CHECK_VERSION (major, minor, micro) \
86 (LIBNOTMUCH_MAJOR_VERSION > (major) || \
87 (LIBNOTMUCH_MAJOR_VERSION == (major) && LIBNOTMUCH_MINOR_VERSION > (minor)) || \
88 (LIBNOTMUCH_MAJOR_VERSION == (major) && LIBNOTMUCH_MINOR_VERSION == (minor) && \
89 LIBNOTMUCH_MICRO_VERSION >= (micro)))
92 * Notmuch boolean type.
94 typedef int notmuch_bool_t;
97 * Status codes used for the return values of most functions.
99 * A zero value (NOTMUCH_STATUS_SUCCESS) indicates that the function
100 * completed without error. Any other value indicates an error.
102 typedef enum _notmuch_status {
106 NOTMUCH_STATUS_SUCCESS = 0,
110 NOTMUCH_STATUS_OUT_OF_MEMORY,
112 * An attempt was made to write to a database opened in read-only
115 NOTMUCH_STATUS_READ_ONLY_DATABASE,
117 * A Xapian exception occurred.
119 NOTMUCH_STATUS_XAPIAN_EXCEPTION,
121 * An error occurred trying to read or write to a file (this could
122 * be file not found, permission denied, etc.)
124 * @todo We don't really want to expose this lame XAPIAN_EXCEPTION
125 * value. Instead we should map to things like DATABASE_LOCKED or
128 NOTMUCH_STATUS_FILE_ERROR,
130 * A file was presented that doesn't appear to be an email
133 NOTMUCH_STATUS_FILE_NOT_EMAIL,
135 * A file contains a message ID that is identical to a message
136 * already in the database.
138 NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID,
140 * The user erroneously passed a NULL pointer to a notmuch
143 NOTMUCH_STATUS_NULL_POINTER,
145 * A tag value is too long (exceeds NOTMUCH_TAG_MAX).
147 NOTMUCH_STATUS_TAG_TOO_LONG,
149 * The notmuch_message_thaw function has been called more times
150 * than notmuch_message_freeze.
152 NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW,
154 * notmuch_database_end_atomic has been called more times than
155 * notmuch_database_begin_atomic.
157 NOTMUCH_STATUS_UNBALANCED_ATOMIC,
159 * The operation is not supported.
161 NOTMUCH_STATUS_UNSUPPORTED_OPERATION,
163 * The operation requires a database upgrade.
165 NOTMUCH_STATUS_UPGRADE_REQUIRED,
167 * Not an actual status value. Just a way to find out how many
168 * valid status values there are.
170 NOTMUCH_STATUS_LAST_STATUS
174 * Get a string representation of a notmuch_status_t value.
176 * The result is read-only.
179 notmuch_status_to_string (notmuch_status_t status);
181 /* Various opaque data types. For each notmuch_<foo>_t see the various
182 * notmuch_<foo> functions below. */
184 typedef struct _notmuch_database notmuch_database_t;
185 typedef struct _notmuch_query notmuch_query_t;
186 typedef struct _notmuch_threads notmuch_threads_t;
187 typedef struct _notmuch_thread notmuch_thread_t;
188 typedef struct _notmuch_messages notmuch_messages_t;
189 typedef struct _notmuch_message notmuch_message_t;
190 typedef struct _notmuch_tags notmuch_tags_t;
191 typedef struct _notmuch_directory notmuch_directory_t;
192 typedef struct _notmuch_filenames notmuch_filenames_t;
193 #endif /* __DOXYGEN__ */
196 * Create a new, empty notmuch database located at 'path'.
198 * The path should be a top-level directory to a collection of
199 * plain-text email messages (one message per file). This call will
200 * create a new ".notmuch" directory within 'path' where notmuch will
203 * After a successful call to notmuch_database_create, the returned
204 * database will be open so the caller should call
205 * notmuch_database_destroy when finished with it.
207 * The database will not yet have any data in it
208 * (notmuch_database_create itself is a very cheap function). Messages
209 * contained within 'path' can be added to the database by calling
210 * notmuch_database_add_message.
212 * In case of any failure, this function returns an error status and
213 * sets *database to NULL (after printing an error message on stderr).
217 * NOTMUCH_STATUS_SUCCESS: Successfully created the database.
219 * NOTMUCH_STATUS_NULL_POINTER: The given 'path' argument is NULL.
221 * NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory.
223 * NOTMUCH_STATUS_FILE_ERROR: An error occurred trying to create the
224 * database file (such as permission denied, or file not found,
225 * etc.), or the database already exists.
227 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred.
230 notmuch_database_create (const char *path, notmuch_database_t **database);
233 * Database open mode for notmuch_database_open.
237 * Open database for reading only.
239 NOTMUCH_DATABASE_MODE_READ_ONLY = 0,
241 * Open database for reading and writing.
243 NOTMUCH_DATABASE_MODE_READ_WRITE
244 } notmuch_database_mode_t;
247 * Open an existing notmuch database located at 'path'.
249 * The database should have been created at some time in the past,
250 * (not necessarily by this process), by calling
251 * notmuch_database_create with 'path'. By default the database should be
252 * opened for reading only. In order to write to the database you need to
253 * pass the NOTMUCH_DATABASE_MODE_READ_WRITE mode.
255 * An existing notmuch database can be identified by the presence of a
256 * directory named ".notmuch" below 'path'.
258 * The caller should call notmuch_database_destroy when finished with
261 * In case of any failure, this function returns an error status and
262 * sets *database to NULL (after printing an error message on stderr).
266 * NOTMUCH_STATUS_SUCCESS: Successfully opened the database.
268 * NOTMUCH_STATUS_NULL_POINTER: The given 'path' argument is NULL.
270 * NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory.
272 * NOTMUCH_STATUS_FILE_ERROR: An error occurred trying to open the
273 * database file (such as permission denied, or file not found,
274 * etc.), or the database version is unknown.
276 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred.
279 notmuch_database_open (const char *path,
280 notmuch_database_mode_t mode,
281 notmuch_database_t **database);
284 * Commit changes and close the given notmuch database.
286 * After notmuch_database_close has been called, calls to other
287 * functions on objects derived from this database may either behave
288 * as if the database had not been closed (e.g., if the required data
289 * has been cached) or may fail with a
290 * NOTMUCH_STATUS_XAPIAN_EXCEPTION.
292 * notmuch_database_close can be called multiple times. Later calls
295 * For writable databases, notmuch_database_close commits all changes
296 * to disk before closing the database. If the caller is currently in
297 * an atomic section (there was a notmuch_database_begin_atomic
298 * without a matching notmuch_database_end_atomic), this will discard
299 * changes made in that atomic section (but still commit changes made
300 * prior to entering the atomic section).
304 * NOTMUCH_STATUS_SUCCESS: Successfully closed the database.
306 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred; the
307 * database has been closed but there are no guarantees the
308 * changes to the database, if any, have been flushed to disk.
311 notmuch_database_close (notmuch_database_t *database);
314 * A callback invoked by notmuch_database_compact to notify the user
315 * of the progress of the compaction process.
317 typedef void (*notmuch_compact_status_cb_t)(const char *message, void *closure);
320 * Compact a notmuch database, backing up the original database to the
323 * The database will be opened with NOTMUCH_DATABASE_MODE_READ_WRITE
324 * during the compaction process to ensure no writes are made.
326 * If the optional callback function 'status_cb' is non-NULL, it will
327 * be called with diagnostic and informational messages. The argument
328 * 'closure' is passed verbatim to any callback invoked.
331 notmuch_database_compact (const char* path,
332 const char* backup_path,
333 notmuch_compact_status_cb_t status_cb,
337 * Destroy the notmuch database, closing it if necessary and freeing
338 * all associated resources.
340 * Return value as in notmuch_database_close if the database was open;
341 * notmuch_database_destroy itself has no failure modes.
344 notmuch_database_destroy (notmuch_database_t *database);
347 * Return the database path of the given database.
349 * The return value is a string owned by notmuch so should not be
350 * modified nor freed by the caller.
353 notmuch_database_get_path (notmuch_database_t *database);
356 * Return the database format version of the given database.
359 notmuch_database_get_version (notmuch_database_t *database);
362 * Can the database be upgraded to a newer database version?
364 * If this function returns TRUE, then the caller may call
365 * notmuch_database_upgrade to upgrade the database. If the caller
366 * does not upgrade an out-of-date database, then some functions may
367 * fail with NOTMUCH_STATUS_UPGRADE_REQUIRED. This always returns
368 * FALSE for a read-only database because there's no way to upgrade a
369 * read-only database.
372 notmuch_database_needs_upgrade (notmuch_database_t *database);
375 * Upgrade the current database to the latest supported version.
377 * This ensures that all current notmuch functionality will be
378 * available on the database. After opening a database in read-write
379 * mode, it is recommended that clients check if an upgrade is needed
380 * (notmuch_database_needs_upgrade) and if so, upgrade with this
381 * function before making any modifications. If
382 * notmuch_database_needs_upgrade returns FALSE, this will be a no-op.
384 * The optional progress_notify callback can be used by the caller to
385 * provide progress indication to the user. If non-NULL it will be
386 * called periodically with 'progress' as a floating-point value in
387 * the range of [0.0 .. 1.0] indicating the progress made so far in
388 * the upgrade process. The argument 'closure' is passed verbatim to
389 * any callback invoked.
392 notmuch_database_upgrade (notmuch_database_t *database,
393 void (*progress_notify) (void *closure,
398 * Begin an atomic database operation.
400 * Any modifications performed between a successful begin and a
401 * notmuch_database_end_atomic will be applied to the database
402 * atomically. Note that, unlike a typical database transaction, this
403 * only ensures atomicity, not durability; neither begin nor end
404 * necessarily flush modifications to disk.
406 * Atomic sections may be nested. begin_atomic and end_atomic must
407 * always be called in pairs.
411 * NOTMUCH_STATUS_SUCCESS: Successfully entered atomic section.
413 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred;
414 * atomic section not entered.
417 notmuch_database_begin_atomic (notmuch_database_t *notmuch);
420 * Indicate the end of an atomic database operation.
424 * NOTMUCH_STATUS_SUCCESS: Successfully completed atomic section.
426 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred;
427 * atomic section not ended.
429 * NOTMUCH_STATUS_UNBALANCED_ATOMIC: The database is not currently in
433 notmuch_database_end_atomic (notmuch_database_t *notmuch);
436 * Retrieve a directory object from the database for 'path'.
438 * Here, 'path' should be a path relative to the path of 'database'
439 * (see notmuch_database_get_path), or else should be an absolute path
440 * with initial components that match the path of 'database'.
442 * If this directory object does not exist in the database, this
443 * returns NOTMUCH_STATUS_SUCCESS and sets *directory to NULL.
445 * Otherwise the returned directory object is owned by the database
446 * and as such, will only be valid until notmuch_database_destroy is
451 * NOTMUCH_STATUS_SUCCESS: Successfully retrieved directory.
453 * NOTMUCH_STATUS_NULL_POINTER: The given 'directory' argument is NULL.
455 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred;
456 * directory not retrieved.
458 * NOTMUCH_STATUS_UPGRADE_REQUIRED: The caller must upgrade the
459 * database to use this function.
462 notmuch_database_get_directory (notmuch_database_t *database,
464 notmuch_directory_t **directory);
467 * Add a new message to the given notmuch database or associate an
468 * additional filename with an existing message.
470 * Here, 'filename' should be a path relative to the path of
471 * 'database' (see notmuch_database_get_path), or else should be an
472 * absolute filename with initial components that match the path of
475 * The file should be a single mail message (not a multi-message mbox)
476 * that is expected to remain at its current location, (since the
477 * notmuch database will reference the filename, and will not copy the
478 * entire contents of the file.
480 * If another message with the same message ID already exists in the
481 * database, rather than creating a new message, this adds 'filename'
482 * to the list of the filenames for the existing message.
484 * If 'message' is not NULL, then, on successful return
485 * (NOTMUCH_STATUS_SUCCESS or NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID) '*message'
486 * will be initialized to a message object that can be used for things
487 * such as adding tags to the just-added message. The user should call
488 * notmuch_message_destroy when done with the message. On any failure
489 * '*message' will be set to NULL.
493 * NOTMUCH_STATUS_SUCCESS: Message successfully added to database.
495 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred,
498 * NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID: Message has the same message
499 * ID as another message already in the database. The new
500 * filename was successfully added to the message in the database
501 * (if not already present) and the existing message is returned.
503 * NOTMUCH_STATUS_FILE_ERROR: an error occurred trying to open the
504 * file, (such as permission denied, or file not found,
505 * etc.). Nothing added to the database.
507 * NOTMUCH_STATUS_FILE_NOT_EMAIL: the contents of filename don't look
508 * like an email message. Nothing added to the database.
510 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
511 * mode so no message can be added.
513 * NOTMUCH_STATUS_UPGRADE_REQUIRED: The caller must upgrade the
514 * database to use this function.
517 notmuch_database_add_message (notmuch_database_t *database,
518 const char *filename,
519 notmuch_message_t **message);
522 * Remove a message filename from the given notmuch database. If the
523 * message has no more filenames, remove the message.
525 * If the same message (as determined by the message ID) is still
526 * available via other filenames, then the message will persist in the
527 * database for those filenames. When the last filename is removed for
528 * a particular message, the database content for that message will be
533 * NOTMUCH_STATUS_SUCCESS: The last filename was removed and the
534 * message was removed from the database.
536 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred,
537 * message not removed.
539 * NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID: This filename was removed but
540 * the message persists in the database with at least one other
543 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
544 * mode so no message can be removed.
546 * NOTMUCH_STATUS_UPGRADE_REQUIRED: The caller must upgrade the
547 * database to use this function.
550 notmuch_database_remove_message (notmuch_database_t *database,
551 const char *filename);
554 * Find a message with the given message_id.
556 * If a message with the given message_id is found then, on successful return
557 * (NOTMUCH_STATUS_SUCCESS) '*message' will be initialized to a message
558 * object. The caller should call notmuch_message_destroy when done with the
561 * On any failure or when the message is not found, this function initializes
562 * '*message' to NULL. This means, when NOTMUCH_STATUS_SUCCESS is returned, the
563 * caller is supposed to check '*message' for NULL to find out whether the
564 * message with the given message_id was found.
568 * NOTMUCH_STATUS_SUCCESS: Successful return, check '*message'.
570 * NOTMUCH_STATUS_NULL_POINTER: The given 'message' argument is NULL
572 * NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory, creating message object
574 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred
577 notmuch_database_find_message (notmuch_database_t *database,
578 const char *message_id,
579 notmuch_message_t **message);
582 * Find a message with the given filename.
584 * If the database contains a message with the given filename then, on
585 * successful return (NOTMUCH_STATUS_SUCCESS) '*message' will be initialized to
586 * a message object. The caller should call notmuch_message_destroy when done
589 * On any failure or when the message is not found, this function initializes
590 * '*message' to NULL. This means, when NOTMUCH_STATUS_SUCCESS is returned, the
591 * caller is supposed to check '*message' for NULL to find out whether the
592 * message with the given filename is found.
596 * NOTMUCH_STATUS_SUCCESS: Successful return, check '*message'
598 * NOTMUCH_STATUS_NULL_POINTER: The given 'message' argument is NULL
600 * NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory, creating the message object
602 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred
604 * NOTMUCH_STATUS_UPGRADE_REQUIRED: The caller must upgrade the
605 * database to use this function.
608 notmuch_database_find_message_by_filename (notmuch_database_t *notmuch,
609 const char *filename,
610 notmuch_message_t **message);
613 * Return a list of all tags found in the database.
615 * This function creates a list of all tags found in the database. The
616 * resulting list contains all tags from all messages found in the database.
618 * On error this function returns NULL.
621 notmuch_database_get_all_tags (notmuch_database_t *db);
624 * Create a new query for 'database'.
626 * Here, 'database' should be an open database, (see
627 * notmuch_database_open and notmuch_database_create).
629 * For the query string, we'll document the syntax here more
630 * completely in the future, but it's likely to be a specialized
631 * version of the general Xapian query syntax:
633 * http://xapian.org/docs/queryparser.html
635 * As a special case, passing either a length-zero string, (that is ""),
636 * or a string consisting of a single asterisk (that is "*"), will
637 * result in a query that returns all messages in the database.
639 * See notmuch_query_set_sort for controlling the order of results.
640 * See notmuch_query_search_messages and notmuch_query_search_threads
641 * to actually execute the query.
643 * User should call notmuch_query_destroy when finished with this
646 * Will return NULL if insufficient memory is available.
649 notmuch_query_create (notmuch_database_t *database,
650 const char *query_string);
653 * Sort values for notmuch_query_set_sort.
659 NOTMUCH_SORT_OLDEST_FIRST,
663 NOTMUCH_SORT_NEWEST_FIRST,
665 * Sort by message-id.
667 NOTMUCH_SORT_MESSAGE_ID,
671 NOTMUCH_SORT_UNSORTED
675 * Return the query_string of this query. See notmuch_query_create.
678 notmuch_query_get_query_string (notmuch_query_t *query);
681 * Exclude values for notmuch_query_set_omit_excluded. The strange
682 * order is to maintain backward compatibility: the old FALSE/TRUE
683 * options correspond to the new
684 * NOTMUCH_EXCLUDE_FLAG/NOTMUCH_EXCLUDE_TRUE options.
687 NOTMUCH_EXCLUDE_FLAG,
688 NOTMUCH_EXCLUDE_TRUE,
689 NOTMUCH_EXCLUDE_FALSE,
694 * Specify whether to omit excluded results or simply flag them. By
695 * default, this is set to TRUE.
697 * If set to TRUE or ALL, notmuch_query_search_messages will omit excluded
698 * messages from the results, and notmuch_query_search_threads will omit
699 * threads that match only in excluded messages. If set to TRUE,
700 * notmuch_query_search_threads will include all messages in threads that
701 * match in at least one non-excluded message. Otherwise, if set to ALL,
702 * notmuch_query_search_threads will omit excluded messages from all threads.
704 * If set to FALSE or FLAG then both notmuch_query_search_messages and
705 * notmuch_query_search_threads will return all matching
706 * messages/threads regardless of exclude status. If set to FLAG then
707 * the exclude flag will be set for any excluded message that is
708 * returned by notmuch_query_search_messages, and the thread counts
709 * for threads returned by notmuch_query_search_threads will be the
710 * number of non-excluded messages/matches. Otherwise, if set to
711 * FALSE, then the exclude status is completely ignored.
713 * The performance difference when calling
714 * notmuch_query_search_messages should be relatively small (and both
715 * should be very fast). However, in some cases,
716 * notmuch_query_search_threads is very much faster when omitting
717 * excluded messages as it does not need to construct the threads that
718 * only match in excluded messages.
721 notmuch_query_set_omit_excluded (notmuch_query_t *query,
722 notmuch_exclude_t omit_excluded);
725 * Specify the sorting desired for this query.
728 notmuch_query_set_sort (notmuch_query_t *query, notmuch_sort_t sort);
731 * Return the sort specified for this query. See
732 * notmuch_query_set_sort.
735 notmuch_query_get_sort (notmuch_query_t *query);
738 * Add a tag that will be excluded from the query results by default.
739 * This exclusion will be overridden if this tag appears explicitly in
743 notmuch_query_add_tag_exclude (notmuch_query_t *query, const char *tag);
746 * Execute a query for threads, returning a notmuch_threads_t object
747 * which can be used to iterate over the results. The returned threads
748 * object is owned by the query and as such, will only be valid until
749 * notmuch_query_destroy.
751 * Typical usage might be:
753 * notmuch_query_t *query;
754 * notmuch_threads_t *threads;
755 * notmuch_thread_t *thread;
757 * query = notmuch_query_create (database, query_string);
759 * for (threads = notmuch_query_search_threads (query);
760 * notmuch_threads_valid (threads);
761 * notmuch_threads_move_to_next (threads))
763 * thread = notmuch_threads_get (threads);
765 * notmuch_thread_destroy (thread);
768 * notmuch_query_destroy (query);
770 * Note: If you are finished with a thread before its containing
771 * query, you can call notmuch_thread_destroy to clean up some memory
772 * sooner (as in the above example). Otherwise, if your thread objects
773 * are long-lived, then you don't need to call notmuch_thread_destroy
774 * and all the memory will still be reclaimed when the query is
777 * Note that there's no explicit destructor needed for the
778 * notmuch_threads_t object. (For consistency, we do provide a
779 * notmuch_threads_destroy function, but there's no good reason
780 * to call it if the query is about to be destroyed).
782 * If a Xapian exception occurs this function will return NULL.
785 notmuch_query_search_threads (notmuch_query_t *query);
788 * Execute a query for messages, returning a notmuch_messages_t object
789 * which can be used to iterate over the results. The returned
790 * messages object is owned by the query and as such, will only be
791 * valid until notmuch_query_destroy.
793 * Typical usage might be:
795 * notmuch_query_t *query;
796 * notmuch_messages_t *messages;
797 * notmuch_message_t *message;
799 * query = notmuch_query_create (database, query_string);
801 * for (messages = notmuch_query_search_messages (query);
802 * notmuch_messages_valid (messages);
803 * notmuch_messages_move_to_next (messages))
805 * message = notmuch_messages_get (messages);
807 * notmuch_message_destroy (message);
810 * notmuch_query_destroy (query);
812 * Note: If you are finished with a message before its containing
813 * query, you can call notmuch_message_destroy to clean up some memory
814 * sooner (as in the above example). Otherwise, if your message
815 * objects are long-lived, then you don't need to call
816 * notmuch_message_destroy and all the memory will still be reclaimed
817 * when the query is destroyed.
819 * Note that there's no explicit destructor needed for the
820 * notmuch_messages_t object. (For consistency, we do provide a
821 * notmuch_messages_destroy function, but there's no good
822 * reason to call it if the query is about to be destroyed).
824 * If a Xapian exception occurs this function will return NULL.
827 notmuch_query_search_messages (notmuch_query_t *query);
830 * Destroy a notmuch_query_t along with any associated resources.
832 * This will in turn destroy any notmuch_threads_t and
833 * notmuch_messages_t objects generated by this query, (and in
834 * turn any notmuch_thread_t and notmuch_message_t objects generated
835 * from those results, etc.), if such objects haven't already been
839 notmuch_query_destroy (notmuch_query_t *query);
842 * Is the given 'threads' iterator pointing at a valid thread.
844 * When this function returns TRUE, notmuch_threads_get will return a
845 * valid object. Whereas when this function returns FALSE,
846 * notmuch_threads_get will return NULL.
848 * If passed a NULL pointer, this function returns FALSE
850 * See the documentation of notmuch_query_search_threads for example
851 * code showing how to iterate over a notmuch_threads_t object.
854 notmuch_threads_valid (notmuch_threads_t *threads);
857 * Get the current thread from 'threads' as a notmuch_thread_t.
859 * Note: The returned thread belongs to 'threads' and has a lifetime
860 * identical to it (and the query to which it belongs).
862 * See the documentation of notmuch_query_search_threads for example
863 * code showing how to iterate over a notmuch_threads_t object.
865 * If an out-of-memory situation occurs, this function will return
869 notmuch_threads_get (notmuch_threads_t *threads);
872 * Move the 'threads' iterator to the next thread.
874 * If 'threads' is already pointing at the last thread then the
875 * iterator will be moved to a point just beyond that last thread,
876 * (where notmuch_threads_valid will return FALSE and
877 * notmuch_threads_get will return NULL).
879 * See the documentation of notmuch_query_search_threads for example
880 * code showing how to iterate over a notmuch_threads_t object.
883 notmuch_threads_move_to_next (notmuch_threads_t *threads);
886 * Destroy a notmuch_threads_t object.
888 * It's not strictly necessary to call this function. All memory from
889 * the notmuch_threads_t object will be reclaimed when the
890 * containing query object is destroyed.
893 notmuch_threads_destroy (notmuch_threads_t *threads);
896 * Return an estimate of the number of messages matching a search.
898 * This function performs a search and returns Xapian's best
899 * guess as to number of matching messages.
901 * If a Xapian exception occurs, this function may return 0 (after
902 * printing a message).
905 notmuch_query_count_messages (notmuch_query_t *query);
908 * Return the number of threads matching a search.
910 * This function performs a search and returns the number of unique thread IDs
911 * in the matching messages. This is the same as number of threads matching a
914 * Note that this is a significantly heavier operation than
915 * notmuch_query_count_messages().
917 * If an error occurs, this function may return 0.
920 notmuch_query_count_threads (notmuch_query_t *query);
923 * Get the thread ID of 'thread'.
925 * The returned string belongs to 'thread' and as such, should not be
926 * modified by the caller and will only be valid for as long as the
927 * thread is valid, (which is until notmuch_thread_destroy or until
928 * the query from which it derived is destroyed).
931 notmuch_thread_get_thread_id (notmuch_thread_t *thread);
934 * Get the total number of messages in 'thread'.
936 * This count consists of all messages in the database belonging to
937 * this thread. Contrast with notmuch_thread_get_matched_messages() .
940 notmuch_thread_get_total_messages (notmuch_thread_t *thread);
943 * Get a notmuch_messages_t iterator for the top-level messages in
944 * 'thread' in oldest-first order.
946 * This iterator will not necessarily iterate over all of the messages
947 * in the thread. It will only iterate over the messages in the thread
948 * which are not replies to other messages in the thread.
950 * The returned list will be destroyed when the thread is destroyed.
953 notmuch_thread_get_toplevel_messages (notmuch_thread_t *thread);
956 * Get a notmuch_thread_t iterator for all messages in 'thread' in
957 * oldest-first order.
959 * The returned list will be destroyed when the thread is destroyed.
962 notmuch_thread_get_messages (notmuch_thread_t *thread);
965 * Get the number of messages in 'thread' that matched the search.
967 * This count includes only the messages in this thread that were
968 * matched by the search from which the thread was created and were
969 * not excluded by any exclude tags passed in with the query (see
970 * notmuch_query_add_tag_exclude). Contrast with
971 * notmuch_thread_get_total_messages() .
974 notmuch_thread_get_matched_messages (notmuch_thread_t *thread);
977 * Get the authors of 'thread' as a UTF-8 string.
979 * The returned string is a comma-separated list of the names of the
980 * authors of mail messages in the query results that belong to this
983 * The string contains authors of messages matching the query first, then
984 * non-matched authors (with the two groups separated by '|'). Within
985 * each group, authors are ordered by date.
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_authors (notmuch_thread_t *thread);
996 * Get the subject of 'thread' as a UTF-8 string.
998 * The subject is taken from the first message (according to the query
999 * order---see notmuch_query_set_sort) in the query results that
1000 * belongs to this thread.
1002 * The returned string belongs to 'thread' and as such, should not be
1003 * modified by the caller and will only be valid for as long as the
1004 * thread is valid, (which is until notmuch_thread_destroy or until
1005 * the query from which it derived is destroyed).
1008 notmuch_thread_get_subject (notmuch_thread_t *thread);
1011 * Get the date of the oldest message in 'thread' as a time_t value.
1014 notmuch_thread_get_oldest_date (notmuch_thread_t *thread);
1017 * Get the date of the newest message in 'thread' as a time_t value.
1020 notmuch_thread_get_newest_date (notmuch_thread_t *thread);
1023 * Get the tags for 'thread', returning a notmuch_tags_t object which
1024 * can be used to iterate over all tags.
1026 * Note: In the Notmuch database, tags are stored on individual
1027 * messages, not on threads. So the tags returned here will be all
1028 * tags of the messages which matched the search and which belong to
1031 * The tags object is owned by the thread and as such, will only be
1032 * valid for as long as the thread is valid, (for example, until
1033 * notmuch_thread_destroy or until the query from which it derived is
1036 * Typical usage might be:
1038 * notmuch_thread_t *thread;
1039 * notmuch_tags_t *tags;
1042 * thread = notmuch_threads_get (threads);
1044 * for (tags = notmuch_thread_get_tags (thread);
1045 * notmuch_tags_valid (tags);
1046 * notmuch_tags_move_to_next (tags))
1048 * tag = notmuch_tags_get (tags);
1052 * notmuch_thread_destroy (thread);
1054 * Note that there's no explicit destructor needed for the
1055 * notmuch_tags_t object. (For consistency, we do provide a
1056 * notmuch_tags_destroy function, but there's no good reason to call
1057 * it if the message is about to be destroyed).
1060 notmuch_thread_get_tags (notmuch_thread_t *thread);
1063 * Destroy a notmuch_thread_t object.
1066 notmuch_thread_destroy (notmuch_thread_t *thread);
1069 * Is the given 'messages' iterator pointing at a valid message.
1071 * When this function returns TRUE, notmuch_messages_get will return a
1072 * valid object. Whereas when this function returns FALSE,
1073 * notmuch_messages_get will return NULL.
1075 * See the documentation of notmuch_query_search_messages for example
1076 * code showing how to iterate over a notmuch_messages_t object.
1079 notmuch_messages_valid (notmuch_messages_t *messages);
1082 * Get the current message from 'messages' as a notmuch_message_t.
1084 * Note: The returned message belongs to 'messages' and has a lifetime
1085 * identical to it (and the query to which it belongs).
1087 * See the documentation of notmuch_query_search_messages for example
1088 * code showing how to iterate over a notmuch_messages_t object.
1090 * If an out-of-memory situation occurs, this function will return
1094 notmuch_messages_get (notmuch_messages_t *messages);
1097 * Move the 'messages' iterator to the next message.
1099 * If 'messages' is already pointing at the last message then the
1100 * iterator will be moved to a point just beyond that last message,
1101 * (where notmuch_messages_valid will return FALSE and
1102 * notmuch_messages_get will return NULL).
1104 * See the documentation of notmuch_query_search_messages for example
1105 * code showing how to iterate over a notmuch_messages_t object.
1108 notmuch_messages_move_to_next (notmuch_messages_t *messages);
1111 * Destroy a notmuch_messages_t object.
1113 * It's not strictly necessary to call this function. All memory from
1114 * the notmuch_messages_t object will be reclaimed when the containing
1115 * query object is destroyed.
1118 notmuch_messages_destroy (notmuch_messages_t *messages);
1121 * Return a list of tags from all messages.
1123 * The resulting list is guaranteed not to contain duplicated tags.
1125 * WARNING: You can no longer iterate over messages after calling this
1126 * function, because the iterator will point at the end of the list.
1127 * We do not have a function to reset the iterator yet and the only
1128 * way how you can iterate over the list again is to recreate the
1131 * The function returns NULL on error.
1134 notmuch_messages_collect_tags (notmuch_messages_t *messages);
1137 * Get the message ID of 'message'.
1139 * The returned string belongs to 'message' and as such, should not be
1140 * modified by the caller and will only be valid for as long as the
1141 * message is valid, (which is until the query from which it derived
1144 * This function will not return NULL since Notmuch ensures that every
1145 * message has a unique message ID, (Notmuch will generate an ID for a
1146 * message if the original file does not contain one).
1149 notmuch_message_get_message_id (notmuch_message_t *message);
1152 * Get the thread ID of 'message'.
1154 * The returned string belongs to 'message' and as such, should not be
1155 * modified by the caller and will only be valid for as long as the
1156 * message is valid, (for example, until the user calls
1157 * notmuch_message_destroy on 'message' or until a query from which it
1158 * derived is destroyed).
1160 * This function will not return NULL since Notmuch ensures that every
1161 * message belongs to a single thread.
1164 notmuch_message_get_thread_id (notmuch_message_t *message);
1167 * Get a notmuch_messages_t iterator for all of the replies to
1170 * Note: This call only makes sense if 'message' was ultimately
1171 * obtained from a notmuch_thread_t object, (such as by coming
1172 * directly from the result of calling notmuch_thread_get_
1173 * toplevel_messages or by any number of subsequent
1174 * calls to notmuch_message_get_replies).
1176 * If 'message' was obtained through some non-thread means, (such as
1177 * by a call to notmuch_query_search_messages), then this function
1180 * If there are no replies to 'message', this function will return
1181 * NULL. (Note that notmuch_messages_valid will accept that NULL
1182 * value as legitimate, and simply return FALSE for it.)
1184 notmuch_messages_t *
1185 notmuch_message_get_replies (notmuch_message_t *message);
1188 * Get a filename for the email corresponding to 'message'.
1190 * The returned filename is an absolute filename, (the initial
1191 * component will match notmuch_database_get_path() ).
1193 * The returned string belongs to the message so should not be
1194 * modified or freed by the caller (nor should it be referenced after
1195 * the message is destroyed).
1197 * Note: If this message corresponds to multiple files in the mail
1198 * store, (that is, multiple files contain identical message IDs),
1199 * this function will arbitrarily return a single one of those
1200 * filenames. See notmuch_message_get_filenames for returning the
1201 * complete list of filenames.
1204 notmuch_message_get_filename (notmuch_message_t *message);
1207 * Get all filenames for the email corresponding to 'message'.
1209 * Returns a notmuch_filenames_t iterator listing all the filenames
1210 * associated with 'message'. These files may not have identical
1211 * content, but each will have the identical Message-ID.
1213 * Each filename in the iterator is an absolute filename, (the initial
1214 * component will match notmuch_database_get_path() ).
1216 notmuch_filenames_t *
1217 notmuch_message_get_filenames (notmuch_message_t *message);
1222 typedef enum _notmuch_message_flag {
1223 NOTMUCH_MESSAGE_FLAG_MATCH,
1224 NOTMUCH_MESSAGE_FLAG_EXCLUDED
1225 } notmuch_message_flag_t;
1228 * Get a value of a flag for the email corresponding to 'message'.
1231 notmuch_message_get_flag (notmuch_message_t *message,
1232 notmuch_message_flag_t flag);
1235 * Set a value of a flag for the email corresponding to 'message'.
1238 notmuch_message_set_flag (notmuch_message_t *message,
1239 notmuch_message_flag_t flag, notmuch_bool_t value);
1242 * Get the date of 'message' as a time_t value.
1244 * For the original textual representation of the Date header from the
1245 * message call notmuch_message_get_header() with a header value of
1249 notmuch_message_get_date (notmuch_message_t *message);
1252 * Get the value of the specified header from 'message' as a UTF-8 string.
1254 * Common headers are stored in the database when the message is
1255 * indexed and will be returned from the database. Other headers will
1256 * be read from the actual message file.
1258 * The header name is case insensitive.
1260 * The returned string belongs to the message so should not be
1261 * modified or freed by the caller (nor should it be referenced after
1262 * the message is destroyed).
1264 * Returns an empty string ("") if the message does not contain a
1265 * header line matching 'header'. Returns NULL if any error occurs.
1268 notmuch_message_get_header (notmuch_message_t *message, const char *header);
1271 * Get the tags for 'message', returning a notmuch_tags_t object which
1272 * can be used to iterate over all tags.
1274 * The tags object is owned by the message and as such, will only be
1275 * valid for as long as the message is valid, (which is until the
1276 * query from which it derived is destroyed).
1278 * Typical usage might be:
1280 * notmuch_message_t *message;
1281 * notmuch_tags_t *tags;
1284 * message = notmuch_database_find_message (database, message_id);
1286 * for (tags = notmuch_message_get_tags (message);
1287 * notmuch_tags_valid (tags);
1288 * notmuch_tags_move_to_next (tags))
1290 * tag = notmuch_tags_get (tags);
1294 * notmuch_message_destroy (message);
1296 * Note that there's no explicit destructor needed for the
1297 * notmuch_tags_t object. (For consistency, we do provide a
1298 * notmuch_tags_destroy function, but there's no good reason to call
1299 * it if the message is about to be destroyed).
1302 notmuch_message_get_tags (notmuch_message_t *message);
1305 * The longest possible tag value.
1307 #define NOTMUCH_TAG_MAX 200
1310 * Add a tag to the given message.
1314 * NOTMUCH_STATUS_SUCCESS: Tag successfully added to message
1316 * NOTMUCH_STATUS_NULL_POINTER: The 'tag' argument is NULL
1318 * NOTMUCH_STATUS_TAG_TOO_LONG: The length of 'tag' is too long
1319 * (exceeds NOTMUCH_TAG_MAX)
1321 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
1322 * mode so message cannot be modified.
1325 notmuch_message_add_tag (notmuch_message_t *message, const char *tag);
1328 * Remove a tag from the given message.
1332 * NOTMUCH_STATUS_SUCCESS: Tag successfully removed from message
1334 * NOTMUCH_STATUS_NULL_POINTER: The 'tag' argument is NULL
1336 * NOTMUCH_STATUS_TAG_TOO_LONG: The length of 'tag' is too long
1337 * (exceeds NOTMUCH_TAG_MAX)
1339 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
1340 * mode so message cannot be modified.
1343 notmuch_message_remove_tag (notmuch_message_t *message, const char *tag);
1346 * Remove all tags from the given message.
1348 * See notmuch_message_freeze for an example showing how to safely
1349 * replace tag values.
1351 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
1352 * mode so message cannot be modified.
1355 notmuch_message_remove_all_tags (notmuch_message_t *message);
1358 * Add/remove tags according to maildir flags in the message filename(s).
1360 * This function examines the filenames of 'message' for maildir
1361 * flags, and adds or removes tags on 'message' as follows when these
1362 * flags are present:
1364 * Flag Action if present
1365 * ---- -----------------
1366 * 'D' Adds the "draft" tag to the message
1367 * 'F' Adds the "flagged" tag to the message
1368 * 'P' Adds the "passed" tag to the message
1369 * 'R' Adds the "replied" tag to the message
1370 * 'S' Removes the "unread" tag from the message
1372 * For each flag that is not present, the opposite action (add/remove)
1373 * is performed for the corresponding tags.
1375 * Flags are identified as trailing components of the filename after a
1376 * sequence of ":2,".
1378 * If there are multiple filenames associated with this message, the
1379 * flag is considered present if it appears in one or more
1380 * filenames. (That is, the flags from the multiple filenames are
1381 * combined with the logical OR operator.)
1383 * A client can ensure that notmuch database tags remain synchronized
1384 * with maildir flags by calling this function after each call to
1385 * notmuch_database_add_message. See also
1386 * notmuch_message_tags_to_maildir_flags for synchronizing tag changes
1387 * back to maildir flags.
1390 notmuch_message_maildir_flags_to_tags (notmuch_message_t *message);
1393 * Rename message filename(s) to encode tags as maildir flags.
1395 * Specifically, for each filename corresponding to this message:
1397 * If the filename is not in a maildir directory, do nothing. (A
1398 * maildir directory is determined as a directory named "new" or
1399 * "cur".) Similarly, if the filename has invalid maildir info,
1400 * (repeated or outof-ASCII-order flag characters after ":2,"), then
1403 * If the filename is in a maildir directory, rename the file so that
1404 * its filename ends with the sequence ":2," followed by zero or more
1405 * of the following single-character flags (in ASCII order):
1407 * 'D' iff the message has the "draft" tag
1408 * 'F' iff the message has the "flagged" tag
1409 * 'P' iff the message has the "passed" tag
1410 * 'R' iff the message has the "replied" tag
1411 * 'S' iff the message does not have the "unread" tag
1413 * Any existing flags unmentioned in the list above will be preserved
1416 * Also, if this filename is in a directory named "new", rename it to
1417 * be within the neighboring directory named "cur".
1419 * A client can ensure that maildir filename flags remain synchronized
1420 * with notmuch database tags by calling this function after changing
1421 * tags, (after calls to notmuch_message_add_tag,
1422 * notmuch_message_remove_tag, or notmuch_message_freeze/
1423 * notmuch_message_thaw). See also notmuch_message_maildir_flags_to_tags
1424 * for synchronizing maildir flag changes back to tags.
1427 notmuch_message_tags_to_maildir_flags (notmuch_message_t *message);
1430 * Freeze the current state of 'message' within the database.
1432 * This means that changes to the message state, (via
1433 * notmuch_message_add_tag, notmuch_message_remove_tag, and
1434 * notmuch_message_remove_all_tags), will not be committed to the
1435 * database until the message is thawed with notmuch_message_thaw.
1437 * Multiple calls to freeze/thaw are valid and these calls will
1438 * "stack". That is there must be as many calls to thaw as to freeze
1439 * before a message is actually thawed.
1441 * The ability to do freeze/thaw allows for safe transactions to
1442 * change tag values. For example, explicitly setting a message to
1443 * have a given set of tags might look like this:
1445 * notmuch_message_freeze (message);
1447 * notmuch_message_remove_all_tags (message);
1449 * for (i = 0; i < NUM_TAGS; i++)
1450 * notmuch_message_add_tag (message, tags[i]);
1452 * notmuch_message_thaw (message);
1454 * With freeze/thaw used like this, the message in the database is
1455 * guaranteed to have either the full set of original tag values, or
1456 * the full set of new tag values, but nothing in between.
1458 * Imagine the example above without freeze/thaw and the operation
1459 * somehow getting interrupted. This could result in the message being
1460 * left with no tags if the interruption happened after
1461 * notmuch_message_remove_all_tags but before notmuch_message_add_tag.
1465 * NOTMUCH_STATUS_SUCCESS: Message successfully frozen.
1467 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
1468 * mode so message cannot be modified.
1471 notmuch_message_freeze (notmuch_message_t *message);
1474 * Thaw the current 'message', synchronizing any changes that may have
1475 * occurred while 'message' was frozen into the notmuch database.
1477 * See notmuch_message_freeze for an example of how to use this
1478 * function to safely provide tag changes.
1480 * Multiple calls to freeze/thaw are valid and these calls with
1481 * "stack". That is there must be as many calls to thaw as to freeze
1482 * before a message is actually thawed.
1486 * NOTMUCH_STATUS_SUCCESS: Message successfully thawed, (or at least
1487 * its frozen count has successfully been reduced by 1).
1489 * NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW: An attempt was made to thaw
1490 * an unfrozen message. That is, there have been an unbalanced
1491 * number of calls to notmuch_message_freeze and
1492 * notmuch_message_thaw.
1495 notmuch_message_thaw (notmuch_message_t *message);
1498 * Destroy a notmuch_message_t object.
1500 * It can be useful to call this function in the case of a single
1501 * query object with many messages in the result, (such as iterating
1502 * over the entire database). Otherwise, it's fine to never call this
1503 * function and there will still be no memory leaks. (The memory from
1504 * the messages get reclaimed when the containing query is destroyed.)
1507 notmuch_message_destroy (notmuch_message_t *message);
1510 * Is the given 'tags' iterator pointing at a valid tag.
1512 * When this function returns TRUE, notmuch_tags_get will return a
1513 * valid string. Whereas when this function returns FALSE,
1514 * notmuch_tags_get will return NULL.
1516 * See the documentation of notmuch_message_get_tags for example code
1517 * showing how to iterate over a notmuch_tags_t object.
1520 notmuch_tags_valid (notmuch_tags_t *tags);
1523 * Get the current tag from 'tags' as a string.
1525 * Note: The returned string belongs to 'tags' and has a lifetime
1526 * identical to it (and the query to which it ultimately belongs).
1528 * See the documentation of notmuch_message_get_tags for example code
1529 * showing how to iterate over a notmuch_tags_t object.
1532 notmuch_tags_get (notmuch_tags_t *tags);
1535 * Move the 'tags' iterator to the next tag.
1537 * If 'tags' is already pointing at the last tag then the iterator
1538 * will be moved to a point just beyond that last tag, (where
1539 * notmuch_tags_valid will return FALSE and notmuch_tags_get will
1542 * See the documentation of notmuch_message_get_tags for example code
1543 * showing how to iterate over a notmuch_tags_t object.
1546 notmuch_tags_move_to_next (notmuch_tags_t *tags);
1549 * Destroy a notmuch_tags_t object.
1551 * It's not strictly necessary to call this function. All memory from
1552 * the notmuch_tags_t object will be reclaimed when the containing
1553 * message or query objects are destroyed.
1556 notmuch_tags_destroy (notmuch_tags_t *tags);
1559 * Store an mtime within the database for 'directory'.
1561 * The 'directory' should be an object retrieved from the database
1562 * with notmuch_database_get_directory for a particular path.
1564 * The intention is for the caller to use the mtime to allow efficient
1565 * identification of new messages to be added to the database. The
1566 * recommended usage is as follows:
1568 * o Read the mtime of a directory from the filesystem
1570 * o Call add_message for all mail files in the directory
1572 * o Call notmuch_directory_set_mtime with the mtime read from the
1575 * Then, when wanting to check for updates to the directory in the
1576 * future, the client can call notmuch_directory_get_mtime and know
1577 * that it only needs to add files if the mtime of the directory and
1578 * files are newer than the stored timestamp.
1580 * Note: The notmuch_directory_get_mtime function does not allow the
1581 * caller to distinguish a timestamp of 0 from a non-existent
1582 * timestamp. So don't store a timestamp of 0 unless you are
1583 * comfortable with that.
1587 * NOTMUCH_STATUS_SUCCESS: mtime successfully stored in database.
1589 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception
1590 * occurred, mtime not stored.
1592 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
1593 * mode so directory mtime cannot be modified.
1596 notmuch_directory_set_mtime (notmuch_directory_t *directory,
1600 * Get the mtime of a directory, (as previously stored with
1601 * notmuch_directory_set_mtime).
1603 * Returns 0 if no mtime has previously been stored for this
1607 notmuch_directory_get_mtime (notmuch_directory_t *directory);
1610 * Get a notmuch_filenames_t iterator listing all the filenames of
1611 * messages in the database within the given directory.
1613 * The returned filenames will be the basename-entries only (not
1616 notmuch_filenames_t *
1617 notmuch_directory_get_child_files (notmuch_directory_t *directory);
1620 * Get a notmuch_filenams_t iterator listing all the filenames of
1621 * sub-directories in the database within the given directory.
1623 * The returned filenames will be the basename-entries only (not
1626 notmuch_filenames_t *
1627 notmuch_directory_get_child_directories (notmuch_directory_t *directory);
1630 * Destroy a notmuch_directory_t object.
1633 notmuch_directory_destroy (notmuch_directory_t *directory);
1636 * Is the given 'filenames' iterator pointing at a valid filename.
1638 * When this function returns TRUE, notmuch_filenames_get will return
1639 * a valid string. Whereas when this function returns FALSE,
1640 * notmuch_filenames_get will return NULL.
1642 * It is acceptable to pass NULL for 'filenames', in which case this
1643 * function will always return FALSE.
1646 notmuch_filenames_valid (notmuch_filenames_t *filenames);
1649 * Get the current filename from 'filenames' as a string.
1651 * Note: The returned string belongs to 'filenames' and has a lifetime
1652 * identical to it (and the directory to which it ultimately belongs).
1654 * It is acceptable to pass NULL for 'filenames', in which case this
1655 * function will always return NULL.
1658 notmuch_filenames_get (notmuch_filenames_t *filenames);
1661 * Move the 'filenames' iterator to the next filename.
1663 * If 'filenames' is already pointing at the last filename then the
1664 * iterator will be moved to a point just beyond that last filename,
1665 * (where notmuch_filenames_valid will return FALSE and
1666 * notmuch_filenames_get will return NULL).
1668 * It is acceptable to pass NULL for 'filenames', in which case this
1669 * function will do nothing.
1672 notmuch_filenames_move_to_next (notmuch_filenames_t *filenames);
1675 * Destroy a notmuch_filenames_t object.
1677 * It's not strictly necessary to call this function. All memory from
1678 * the notmuch_filenames_t object will be reclaimed when the
1679 * containing directory object is destroyed.
1681 * It is acceptable to pass NULL for 'filenames', in which case this
1682 * function will do nothing.
1685 notmuch_filenames_destroy (notmuch_filenames_t *filenames);