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>
25 # define NOTMUCH_BEGIN_DECLS extern "C" {
26 # define NOTMUCH_END_DECLS }
28 # define NOTMUCH_BEGIN_DECLS
29 # define NOTMUCH_END_DECLS
44 #define NOTMUCH_MAJOR_VERSION 0
45 #define NOTMUCH_MINOR_VERSION 17
46 #define NOTMUCH_MICRO_VERSION 0
49 * Check the version of the notmuch library being compiled against.
51 * Return true if the library being compiled against is of the
52 * specified version or above. For example:
54 * #if NOTMUCH_CHECK_VERSION(0, 18, 0)
55 * (code requiring notmuch 0.18 or above)
58 * NOTMUCH_CHECK_VERSION has been defined since version 0.17.0; you
59 * can use #if !defined(NOTMUCH_CHECK_VERSION) to check for versions
62 #define NOTMUCH_CHECK_VERSION (major, minor, micro) \
63 (NOTMUCH_MAJOR_VERSION > (major) || \
64 (NOTMUCH_MAJOR_VERSION == (major) && NOTMUCH_MINOR_VERSION > (minor)) || \
65 (NOTMUCH_MAJOR_VERSION == (major) && NOTMUCH_MINOR_VERSION == (minor) && \
66 NOTMUCH_MICRO_VERSION >= (micro)))
68 typedef int notmuch_bool_t;
70 /* Status codes used for the return values of most functions.
72 * A zero value (NOTMUCH_STATUS_SUCCESS) indicates that the function
73 * completed without error. Any other value indicates an error as
76 * NOTMUCH_STATUS_SUCCESS: No error occurred.
78 * NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory
80 * XXX: We don't really want to expose this lame XAPIAN_EXCEPTION
81 * value. Instead we should map to things like DATABASE_LOCKED or
84 * NOTMUCH_STATUS_READ_ONLY_DATABASE: An attempt was made to write to
85 * a database opened in read-only mode.
87 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred
89 * NOTMUCH_STATUS_FILE_ERROR: An error occurred trying to read or
90 * write to a file (this could be file not found, permission
93 * NOTMUCH_STATUS_FILE_NOT_EMAIL: A file was presented that doesn't
94 * appear to be an email message.
96 * NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID: A file contains a message ID
97 * that is identical to a message already in the database.
99 * NOTMUCH_STATUS_NULL_POINTER: The user erroneously passed a NULL
100 * pointer to a notmuch function.
102 * NOTMUCH_STATUS_TAG_TOO_LONG: A tag value is too long (exceeds
105 * NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW: The notmuch_message_thaw
106 * function has been called more times than notmuch_message_freeze.
108 * NOTMUCH_STATUS_UNBALANCED_ATOMIC: notmuch_database_end_atomic has
109 * been called more times than notmuch_database_begin_atomic.
113 * NOTMUCH_STATUS_LAST_STATUS: Not an actual status value. Just a way
114 * to find out how many valid status values there are.
116 typedef enum _notmuch_status {
117 NOTMUCH_STATUS_SUCCESS = 0,
118 NOTMUCH_STATUS_OUT_OF_MEMORY,
119 NOTMUCH_STATUS_READ_ONLY_DATABASE,
120 NOTMUCH_STATUS_XAPIAN_EXCEPTION,
121 NOTMUCH_STATUS_FILE_ERROR,
122 NOTMUCH_STATUS_FILE_NOT_EMAIL,
123 NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID,
124 NOTMUCH_STATUS_NULL_POINTER,
125 NOTMUCH_STATUS_TAG_TOO_LONG,
126 NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW,
127 NOTMUCH_STATUS_UNBALANCED_ATOMIC,
128 NOTMUCH_STATUS_UNSUPPORTED_OPERATION,
130 NOTMUCH_STATUS_LAST_STATUS
133 /* Get a string representation of a notmuch_status_t value.
135 * The result is read-only.
138 notmuch_status_to_string (notmuch_status_t status);
140 /* Various opaque data types. For each notmuch_<foo>_t see the various
141 * notmuch_<foo> functions below. */
142 typedef struct _notmuch_database notmuch_database_t;
143 typedef struct _notmuch_query notmuch_query_t;
144 typedef struct _notmuch_threads notmuch_threads_t;
145 typedef struct _notmuch_thread notmuch_thread_t;
146 typedef struct _notmuch_messages notmuch_messages_t;
147 typedef struct _notmuch_message notmuch_message_t;
148 typedef struct _notmuch_tags notmuch_tags_t;
149 typedef struct _notmuch_directory notmuch_directory_t;
150 typedef struct _notmuch_filenames notmuch_filenames_t;
152 /* Create a new, empty notmuch database located at 'path'.
154 * The path should be a top-level directory to a collection of
155 * plain-text email messages (one message per file). This call will
156 * create a new ".notmuch" directory within 'path' where notmuch will
159 * After a successful call to notmuch_database_create, the returned
160 * database will be open so the caller should call
161 * notmuch_database_destroy when finished with it.
163 * The database will not yet have any data in it
164 * (notmuch_database_create itself is a very cheap function). Messages
165 * contained within 'path' can be added to the database by calling
166 * notmuch_database_add_message.
168 * In case of any failure, this function returns an error status and
169 * sets *database to NULL (after printing an error message on stderr).
173 * NOTMUCH_STATUS_SUCCESS: Successfully created the database.
175 * NOTMUCH_STATUS_NULL_POINTER: The given 'path' argument is NULL.
177 * NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory.
179 * NOTMUCH_STATUS_FILE_ERROR: An error occurred trying to create the
180 * database file (such as permission denied, or file not found,
181 * etc.), or the database already exists.
183 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred.
186 notmuch_database_create (const char *path, notmuch_database_t **database);
189 NOTMUCH_DATABASE_MODE_READ_ONLY = 0,
190 NOTMUCH_DATABASE_MODE_READ_WRITE
191 } notmuch_database_mode_t;
193 /* Open an existing notmuch database located at 'path'.
195 * The database should have been created at some time in the past,
196 * (not necessarily by this process), by calling
197 * notmuch_database_create with 'path'. By default the database should be
198 * opened for reading only. In order to write to the database you need to
199 * pass the NOTMUCH_DATABASE_MODE_READ_WRITE mode.
201 * An existing notmuch database can be identified by the presence of a
202 * directory named ".notmuch" below 'path'.
204 * The caller should call notmuch_database_destroy when finished with
207 * In case of any failure, this function returns an error status and
208 * sets *database to NULL (after printing an error message on stderr).
212 * NOTMUCH_STATUS_SUCCESS: Successfully opened the database.
214 * NOTMUCH_STATUS_NULL_POINTER: The given 'path' argument is NULL.
216 * NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory.
218 * NOTMUCH_STATUS_FILE_ERROR: An error occurred trying to open the
219 * database file (such as permission denied, or file not found,
220 * etc.), or the database version is unknown.
222 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred.
225 notmuch_database_open (const char *path,
226 notmuch_database_mode_t mode,
227 notmuch_database_t **database);
229 /* Close the given notmuch database.
231 * After notmuch_database_close has been called, calls to other
232 * functions on objects derived from this database may either behave
233 * as if the database had not been closed (e.g., if the required data
234 * has been cached) or may fail with a
235 * NOTMUCH_STATUS_XAPIAN_EXCEPTION.
237 * notmuch_database_close can be called multiple times. Later calls
241 notmuch_database_close (notmuch_database_t *database);
243 /* A callback invoked by notmuch_database_compact to notify the user
244 * of the progress of the compaction process.
246 typedef void (*notmuch_compact_status_cb_t)(const char *message, void *closure);
248 /* Compact a notmuch database, backing up the original database to the
251 * The database will be opened with NOTMUCH_DATABASE_MODE_READ_WRITE
252 * during the compaction process to ensure no writes are made.
254 * If the optional callback function 'status_cb' is non-NULL, it will
255 * be called with diagnostic and informational messages. The argument
256 * 'closure' is passed verbatim to any callback invoked.
259 notmuch_database_compact (const char* path,
260 const char* backup_path,
261 notmuch_compact_status_cb_t status_cb,
264 /* Destroy the notmuch database, closing it if necessary and freeing
265 * all associated resources.
268 notmuch_database_destroy (notmuch_database_t *database);
270 /* Return the database path of the given database.
272 * The return value is a string owned by notmuch so should not be
273 * modified nor freed by the caller. */
275 notmuch_database_get_path (notmuch_database_t *database);
277 /* Return the database format version of the given database. */
279 notmuch_database_get_version (notmuch_database_t *database);
281 /* Does this database need to be upgraded before writing to it?
283 * If this function returns TRUE then no functions that modify the
284 * database (notmuch_database_add_message, notmuch_message_add_tag,
285 * notmuch_directory_set_mtime, etc.) will work unless the function
286 * notmuch_database_upgrade is called successfully first. */
288 notmuch_database_needs_upgrade (notmuch_database_t *database);
290 /* Upgrade the current database.
292 * After opening a database in read-write mode, the client should
293 * check if an upgrade is needed (notmuch_database_needs_upgrade) and
294 * if so, upgrade with this function before making any modifications.
296 * The optional progress_notify callback can be used by the caller to
297 * provide progress indication to the user. If non-NULL it will be
298 * called periodically with 'progress' as a floating-point value in
299 * the range of [0.0 .. 1.0] indicating the progress made so far in
300 * the upgrade process. The argument 'closure' is passed verbatim to
301 * any callback invoked.
304 notmuch_database_upgrade (notmuch_database_t *database,
305 void (*progress_notify) (void *closure,
309 /* Begin an atomic database operation.
311 * Any modifications performed between a successful begin and a
312 * notmuch_database_end_atomic will be applied to the database
313 * atomically. Note that, unlike a typical database transaction, this
314 * only ensures atomicity, not durability; neither begin nor end
315 * necessarily flush modifications to disk.
317 * Atomic sections may be nested. begin_atomic and end_atomic must
318 * always be called in pairs.
322 * NOTMUCH_STATUS_SUCCESS: Successfully entered atomic section.
324 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred;
325 * atomic section not entered.
328 notmuch_database_begin_atomic (notmuch_database_t *notmuch);
330 /* Indicate the end of an atomic database operation.
334 * NOTMUCH_STATUS_SUCCESS: Successfully completed atomic section.
336 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred;
337 * atomic section not ended.
339 * NOTMUCH_STATUS_UNBALANCED_ATOMIC: The database is not currently in
343 notmuch_database_end_atomic (notmuch_database_t *notmuch);
345 /* Retrieve a directory object from the database for 'path'.
347 * Here, 'path' should be a path relative to the path of 'database'
348 * (see notmuch_database_get_path), or else should be an absolute path
349 * with initial components that match the path of 'database'.
351 * If this directory object does not exist in the database, this
352 * returns NOTMUCH_STATUS_SUCCESS and sets *directory to NULL.
356 * NOTMUCH_STATUS_SUCCESS: Successfully retrieved directory.
358 * NOTMUCH_STATUS_NULL_POINTER: The given 'directory' argument is NULL.
360 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred;
361 * directory not retrieved.
364 notmuch_database_get_directory (notmuch_database_t *database,
366 notmuch_directory_t **directory);
368 /* Add a new message to the given notmuch database or associate an
369 * additional filename with an existing message.
371 * Here, 'filename' should be a path relative to the path of
372 * 'database' (see notmuch_database_get_path), or else should be an
373 * absolute filename with initial components that match the path of
376 * The file should be a single mail message (not a multi-message mbox)
377 * that is expected to remain at its current location, (since the
378 * notmuch database will reference the filename, and will not copy the
379 * entire contents of the file.
381 * If another message with the same message ID already exists in the
382 * database, rather than creating a new message, this adds 'filename'
383 * to the list of the filenames for the existing message.
385 * If 'message' is not NULL, then, on successful return
386 * (NOTMUCH_STATUS_SUCCESS or NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID) '*message'
387 * will be initialized to a message object that can be used for things
388 * such as adding tags to the just-added message. The user should call
389 * notmuch_message_destroy when done with the message. On any failure
390 * '*message' will be set to NULL.
394 * NOTMUCH_STATUS_SUCCESS: Message successfully added to database.
396 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred,
399 * NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID: Message has the same message
400 * ID as another message already in the database. The new
401 * filename was successfully added to the message in the database
402 * (if not already present) and the existing message is returned.
404 * NOTMUCH_STATUS_FILE_ERROR: an error occurred trying to open the
405 * file, (such as permission denied, or file not found,
406 * etc.). Nothing added to the database.
408 * NOTMUCH_STATUS_FILE_NOT_EMAIL: the contents of filename don't look
409 * like an email message. Nothing added to the database.
411 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
412 * mode so no message can be added.
415 notmuch_database_add_message (notmuch_database_t *database,
416 const char *filename,
417 notmuch_message_t **message);
419 /* Remove a message filename from the given notmuch database. If the
420 * message has no more filenames, remove the message.
422 * If the same message (as determined by the message ID) is still
423 * available via other filenames, then the message will persist in the
424 * database for those filenames. When the last filename is removed for
425 * a particular message, the database content for that message will be
430 * NOTMUCH_STATUS_SUCCESS: The last filename was removed and the
431 * message was removed from the database.
433 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred,
434 * message not removed.
436 * NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID: This filename was removed but
437 * the message persists in the database with at least one other
440 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
441 * mode so no message can be removed.
444 notmuch_database_remove_message (notmuch_database_t *database,
445 const char *filename);
447 /* Find a message with the given message_id.
449 * If a message with the given message_id is found then, on successful return
450 * (NOTMUCH_STATUS_SUCCESS) '*message' will be initialized to a message
451 * object. The caller should call notmuch_message_destroy when done with the
454 * On any failure or when the message is not found, this function initializes
455 * '*message' to NULL. This means, when NOTMUCH_STATUS_SUCCESS is returned, the
456 * caller is supposed to check '*message' for NULL to find out whether the
457 * message with the given message_id was found.
461 * NOTMUCH_STATUS_SUCCESS: Successful return, check '*message'.
463 * NOTMUCH_STATUS_NULL_POINTER: The given 'message' argument is NULL
465 * NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory, creating message object
467 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred
470 notmuch_database_find_message (notmuch_database_t *database,
471 const char *message_id,
472 notmuch_message_t **message);
474 /* Find a message with the given filename.
476 * If the database contains a message with the given filename then, on
477 * successful return (NOTMUCH_STATUS_SUCCESS) '*message' will be initialized to
478 * a message object. The caller should call notmuch_message_destroy when done
481 * On any failure or when the message is not found, this function initializes
482 * '*message' to NULL. This means, when NOTMUCH_STATUS_SUCCESS is returned, the
483 * caller is supposed to check '*message' for NULL to find out whether the
484 * message with the given filename is found.
488 * NOTMUCH_STATUS_SUCCESS: Successful return, check '*message'
490 * NOTMUCH_STATUS_NULL_POINTER: The given 'message' argument is NULL
492 * NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory, creating the message object
494 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred
497 notmuch_database_find_message_by_filename (notmuch_database_t *notmuch,
498 const char *filename,
499 notmuch_message_t **message);
501 /* Return a list of all tags found in the database.
503 * This function creates a list of all tags found in the database. The
504 * resulting list contains all tags from all messages found in the database.
506 * On error this function returns NULL.
509 notmuch_database_get_all_tags (notmuch_database_t *db);
511 /* Create a new query for 'database'.
513 * Here, 'database' should be an open database, (see
514 * notmuch_database_open and notmuch_database_create).
516 * For the query string, we'll document the syntax here more
517 * completely in the future, but it's likely to be a specialized
518 * version of the general Xapian query syntax:
520 * http://xapian.org/docs/queryparser.html
522 * As a special case, passing either a length-zero string, (that is ""),
523 * or a string consisting of a single asterisk (that is "*"), will
524 * result in a query that returns all messages in the database.
526 * See notmuch_query_set_sort for controlling the order of results.
527 * See notmuch_query_search_messages and notmuch_query_search_threads
528 * to actually execute the query.
530 * User should call notmuch_query_destroy when finished with this
533 * Will return NULL if insufficient memory is available.
536 notmuch_query_create (notmuch_database_t *database,
537 const char *query_string);
539 /* Sort values for notmuch_query_set_sort */
541 NOTMUCH_SORT_OLDEST_FIRST,
542 NOTMUCH_SORT_NEWEST_FIRST,
543 NOTMUCH_SORT_MESSAGE_ID,
544 NOTMUCH_SORT_UNSORTED
547 /* Return the query_string of this query. See notmuch_query_create. */
549 notmuch_query_get_query_string (notmuch_query_t *query);
551 /* Exclude values for notmuch_query_set_omit_excluded. The strange
552 * order is to maintain backward compatibility: the old FALSE/TRUE
553 * options correspond to the new
554 * NOTMUCH_EXCLUDE_FLAG/NOTMUCH_EXCLUDE_TRUE options.
557 NOTMUCH_EXCLUDE_FLAG,
558 NOTMUCH_EXCLUDE_TRUE,
559 NOTMUCH_EXCLUDE_FALSE,
563 /* Specify whether to omit excluded results or simply flag them. By
564 * default, this is set to TRUE.
566 * If set to TRUE or ALL, notmuch_query_search_messages will omit excluded
567 * messages from the results, and notmuch_query_search_threads will omit
568 * threads that match only in excluded messages. If set to TRUE,
569 * notmuch_query_search_threads will include all messages in threads that
570 * match in at least one non-excluded message. Otherwise, if set to ALL,
571 * notmuch_query_search_threads will omit excluded messages from all threads.
573 * If set to FALSE or FLAG then both notmuch_query_search_messages and
574 * notmuch_query_search_threads will return all matching
575 * messages/threads regardless of exclude status. If set to FLAG then
576 * the exclude flag will be set for any excluded message that is
577 * returned by notmuch_query_search_messages, and the thread counts
578 * for threads returned by notmuch_query_search_threads will be the
579 * number of non-excluded messages/matches. Otherwise, if set to
580 * FALSE, then the exclude status is completely ignored.
582 * The performance difference when calling
583 * notmuch_query_search_messages should be relatively small (and both
584 * should be very fast). However, in some cases,
585 * notmuch_query_search_threads is very much faster when omitting
586 * excluded messages as it does not need to construct the threads that
587 * only match in excluded messages.
590 notmuch_query_set_omit_excluded (notmuch_query_t *query,
591 notmuch_exclude_t omit_excluded);
593 /* Specify the sorting desired for this query. */
595 notmuch_query_set_sort (notmuch_query_t *query, notmuch_sort_t sort);
597 /* Return the sort specified for this query. See notmuch_query_set_sort. */
599 notmuch_query_get_sort (notmuch_query_t *query);
601 /* Add a tag that will be excluded from the query results by default.
602 * This exclusion will be overridden if this tag appears explicitly in
605 notmuch_query_add_tag_exclude (notmuch_query_t *query, const char *tag);
607 /* Execute a query for threads, returning a notmuch_threads_t object
608 * which can be used to iterate over the results. The returned threads
609 * object is owned by the query and as such, will only be valid until
610 * notmuch_query_destroy.
612 * Typical usage might be:
614 * notmuch_query_t *query;
615 * notmuch_threads_t *threads;
616 * notmuch_thread_t *thread;
618 * query = notmuch_query_create (database, query_string);
620 * for (threads = notmuch_query_search_threads (query);
621 * notmuch_threads_valid (threads);
622 * notmuch_threads_move_to_next (threads))
624 * thread = notmuch_threads_get (threads);
626 * notmuch_thread_destroy (thread);
629 * notmuch_query_destroy (query);
631 * Note: If you are finished with a thread before its containing
632 * query, you can call notmuch_thread_destroy to clean up some memory
633 * sooner (as in the above example). Otherwise, if your thread objects
634 * are long-lived, then you don't need to call notmuch_thread_destroy
635 * and all the memory will still be reclaimed when the query is
638 * Note that there's no explicit destructor needed for the
639 * notmuch_threads_t object. (For consistency, we do provide a
640 * notmuch_threads_destroy function, but there's no good reason
641 * to call it if the query is about to be destroyed).
643 * If a Xapian exception occurs this function will return NULL.
646 notmuch_query_search_threads (notmuch_query_t *query);
648 /* Execute a query for messages, returning a notmuch_messages_t object
649 * which can be used to iterate over the results. The returned
650 * messages object is owned by the query and as such, will only be
651 * valid until notmuch_query_destroy.
653 * Typical usage might be:
655 * notmuch_query_t *query;
656 * notmuch_messages_t *messages;
657 * notmuch_message_t *message;
659 * query = notmuch_query_create (database, query_string);
661 * for (messages = notmuch_query_search_messages (query);
662 * notmuch_messages_valid (messages);
663 * notmuch_messages_move_to_next (messages))
665 * message = notmuch_messages_get (messages);
667 * notmuch_message_destroy (message);
670 * notmuch_query_destroy (query);
672 * Note: If you are finished with a message before its containing
673 * query, you can call notmuch_message_destroy to clean up some memory
674 * sooner (as in the above example). Otherwise, if your message
675 * objects are long-lived, then you don't need to call
676 * notmuch_message_destroy and all the memory will still be reclaimed
677 * when the query is destroyed.
679 * Note that there's no explicit destructor needed for the
680 * notmuch_messages_t object. (For consistency, we do provide a
681 * notmuch_messages_destroy function, but there's no good
682 * reason to call it if the query is about to be destroyed).
684 * If a Xapian exception occurs this function will return NULL.
687 notmuch_query_search_messages (notmuch_query_t *query);
689 /* Destroy a notmuch_query_t along with any associated resources.
691 * This will in turn destroy any notmuch_threads_t and
692 * notmuch_messages_t objects generated by this query, (and in
693 * turn any notmuch_thread_t and notmuch_message_t objects generated
694 * from those results, etc.), if such objects haven't already been
698 notmuch_query_destroy (notmuch_query_t *query);
700 /* Is the given 'threads' iterator pointing at a valid thread.
702 * When this function returns TRUE, notmuch_threads_get will return a
703 * valid object. Whereas when this function returns FALSE,
704 * notmuch_threads_get will return NULL.
706 * See the documentation of notmuch_query_search_threads for example
707 * code showing how to iterate over a notmuch_threads_t object.
710 notmuch_threads_valid (notmuch_threads_t *threads);
712 /* Get the current thread from 'threads' as a notmuch_thread_t.
714 * Note: The returned thread belongs to 'threads' and has a lifetime
715 * identical to it (and the query to which it belongs).
717 * See the documentation of notmuch_query_search_threads for example
718 * code showing how to iterate over a notmuch_threads_t object.
720 * If an out-of-memory situation occurs, this function will return
724 notmuch_threads_get (notmuch_threads_t *threads);
726 /* Move the 'threads' iterator to the next thread.
728 * If 'threads' is already pointing at the last thread then the
729 * iterator will be moved to a point just beyond that last thread,
730 * (where notmuch_threads_valid will return FALSE and
731 * notmuch_threads_get will return NULL).
733 * See the documentation of notmuch_query_search_threads for example
734 * code showing how to iterate over a notmuch_threads_t object.
737 notmuch_threads_move_to_next (notmuch_threads_t *threads);
739 /* Destroy a notmuch_threads_t object.
741 * It's not strictly necessary to call this function. All memory from
742 * the notmuch_threads_t object will be reclaimed when the
743 * containing query object is destroyed.
746 notmuch_threads_destroy (notmuch_threads_t *threads);
748 /* Return an estimate of the number of messages matching a search
750 * This function performs a search and returns Xapian's best
751 * guess as to number of matching messages.
753 * If a Xapian exception occurs, this function may return 0 (after
754 * printing a message).
757 notmuch_query_count_messages (notmuch_query_t *query);
759 /* Return the number of threads matching a search.
761 * This function performs a search and returns the number of unique thread IDs
762 * in the matching messages. This is the same as number of threads matching a
765 * Note that this is a significantly heavier operation than
766 * notmuch_query_count_messages().
768 * If an error occurs, this function may return 0.
771 notmuch_query_count_threads (notmuch_query_t *query);
773 /* Get the thread ID of 'thread'.
775 * The returned string belongs to 'thread' and as such, should not be
776 * modified by the caller and will only be valid for as long as the
777 * thread is valid, (which is until notmuch_thread_destroy or until
778 * the query from which it derived is destroyed).
781 notmuch_thread_get_thread_id (notmuch_thread_t *thread);
783 /* Get the total number of messages in 'thread'.
785 * This count consists of all messages in the database belonging to
786 * this thread. Contrast with notmuch_thread_get_matched_messages() .
789 notmuch_thread_get_total_messages (notmuch_thread_t *thread);
791 /* Get a notmuch_messages_t iterator for the top-level messages in
792 * 'thread' in oldest-first order.
794 * This iterator will not necessarily iterate over all of the messages
795 * in the thread. It will only iterate over the messages in the thread
796 * which are not replies to other messages in the thread.
798 * The returned list will be destroyed when the thread is destroyed.
801 notmuch_thread_get_toplevel_messages (notmuch_thread_t *thread);
803 /* Get a notmuch_thread_t iterator for all messages in 'thread' in
804 * oldest-first order.
806 * The returned list will be destroyed when the thread is destroyed.
809 notmuch_thread_get_messages (notmuch_thread_t *thread);
811 /* Get the number of messages in 'thread' that matched the search.
813 * This count includes only the messages in this thread that were
814 * matched by the search from which the thread was created and were
815 * not excluded by any exclude tags passed in with the query (see
816 * notmuch_query_add_tag_exclude). Contrast with
817 * notmuch_thread_get_total_messages() .
820 notmuch_thread_get_matched_messages (notmuch_thread_t *thread);
822 /* Get the authors of 'thread' as a UTF-8 string.
824 * The returned string is a comma-separated list of the names of the
825 * authors of mail messages in the query results that belong to this
828 * The returned string belongs to 'thread' and as such, should not be
829 * modified by the caller and will only be valid for as long as the
830 * thread is valid, (which is until notmuch_thread_destroy or until
831 * the query from which it derived is destroyed).
834 notmuch_thread_get_authors (notmuch_thread_t *thread);
836 /* Get the subject of 'thread' as a UTF-8 string.
838 * The subject is taken from the first message (according to the query
839 * order---see notmuch_query_set_sort) in the query results that
840 * belongs to this thread.
842 * The returned string belongs to 'thread' and as such, should not be
843 * modified by the caller and will only be valid for as long as the
844 * thread is valid, (which is until notmuch_thread_destroy or until
845 * the query from which it derived is destroyed).
848 notmuch_thread_get_subject (notmuch_thread_t *thread);
850 /* Get the date of the oldest message in 'thread' as a time_t value.
853 notmuch_thread_get_oldest_date (notmuch_thread_t *thread);
855 /* Get the date of the newest message in 'thread' as a time_t value.
858 notmuch_thread_get_newest_date (notmuch_thread_t *thread);
860 /* Get the tags for 'thread', returning a notmuch_tags_t object which
861 * can be used to iterate over all tags.
863 * Note: In the Notmuch database, tags are stored on individual
864 * messages, not on threads. So the tags returned here will be all
865 * tags of the messages which matched the search and which belong to
868 * The tags object is owned by the thread and as such, will only be
869 * valid for as long as the thread is valid, (for example, until
870 * notmuch_thread_destroy or until the query from which it derived is
873 * Typical usage might be:
875 * notmuch_thread_t *thread;
876 * notmuch_tags_t *tags;
879 * thread = notmuch_threads_get (threads);
881 * for (tags = notmuch_thread_get_tags (thread);
882 * notmuch_tags_valid (tags);
883 * notmuch_result_move_to_next (tags))
885 * tag = notmuch_tags_get (tags);
889 * notmuch_thread_destroy (thread);
891 * Note that there's no explicit destructor needed for the
892 * notmuch_tags_t object. (For consistency, we do provide a
893 * notmuch_tags_destroy function, but there's no good reason to call
894 * it if the message is about to be destroyed).
897 notmuch_thread_get_tags (notmuch_thread_t *thread);
899 /* Destroy a notmuch_thread_t object. */
901 notmuch_thread_destroy (notmuch_thread_t *thread);
903 /* Is the given 'messages' iterator pointing at a valid message.
905 * When this function returns TRUE, notmuch_messages_get will return a
906 * valid object. Whereas when this function returns FALSE,
907 * notmuch_messages_get will return NULL.
909 * See the documentation of notmuch_query_search_messages for example
910 * code showing how to iterate over a notmuch_messages_t object.
913 notmuch_messages_valid (notmuch_messages_t *messages);
915 /* Get the current message from 'messages' as a notmuch_message_t.
917 * Note: The returned message belongs to 'messages' and has a lifetime
918 * identical to it (and the query to which it belongs).
920 * See the documentation of notmuch_query_search_messages for example
921 * code showing how to iterate over a notmuch_messages_t object.
923 * If an out-of-memory situation occurs, this function will return
927 notmuch_messages_get (notmuch_messages_t *messages);
929 /* Move the 'messages' iterator to the next message.
931 * If 'messages' is already pointing at the last message then the
932 * iterator will be moved to a point just beyond that last message,
933 * (where notmuch_messages_valid will return FALSE and
934 * notmuch_messages_get will return NULL).
936 * See the documentation of notmuch_query_search_messages for example
937 * code showing how to iterate over a notmuch_messages_t object.
940 notmuch_messages_move_to_next (notmuch_messages_t *messages);
942 /* Destroy a notmuch_messages_t object.
944 * It's not strictly necessary to call this function. All memory from
945 * the notmuch_messages_t object will be reclaimed when the containing
946 * query object is destroyed.
949 notmuch_messages_destroy (notmuch_messages_t *messages);
951 /* Return a list of tags from all messages.
953 * The resulting list is guaranteed not to contain duplicated tags.
955 * WARNING: You can no longer iterate over messages after calling this
956 * function, because the iterator will point at the end of the list.
957 * We do not have a function to reset the iterator yet and the only
958 * way how you can iterate over the list again is to recreate the
961 * The function returns NULL on error.
964 notmuch_messages_collect_tags (notmuch_messages_t *messages);
966 /* Get the message ID of 'message'.
968 * The returned string belongs to 'message' and as such, should not be
969 * modified by the caller and will only be valid for as long as the
970 * message is valid, (which is until the query from which it derived
973 * This function will not return NULL since Notmuch ensures that every
974 * message has a unique message ID, (Notmuch will generate an ID for a
975 * message if the original file does not contain one).
978 notmuch_message_get_message_id (notmuch_message_t *message);
980 /* Get the thread ID of 'message'.
982 * The returned string belongs to 'message' and as such, should not be
983 * modified by the caller and will only be valid for as long as the
984 * message is valid, (for example, until the user calls
985 * notmuch_message_destroy on 'message' or until a query from which it
986 * derived is destroyed).
988 * This function will not return NULL since Notmuch ensures that every
989 * message belongs to a single thread.
992 notmuch_message_get_thread_id (notmuch_message_t *message);
994 /* Get a notmuch_messages_t iterator for all of the replies to
997 * Note: This call only makes sense if 'message' was ultimately
998 * obtained from a notmuch_thread_t object, (such as by coming
999 * directly from the result of calling notmuch_thread_get_
1000 * toplevel_messages or by any number of subsequent
1001 * calls to notmuch_message_get_replies).
1003 * If 'message' was obtained through some non-thread means, (such as
1004 * by a call to notmuch_query_search_messages), then this function
1007 * If there are no replies to 'message', this function will return
1008 * NULL. (Note that notmuch_messages_valid will accept that NULL
1009 * value as legitimate, and simply return FALSE for it.)
1011 notmuch_messages_t *
1012 notmuch_message_get_replies (notmuch_message_t *message);
1014 /* Get a filename for the email corresponding to 'message'.
1016 * The returned filename is an absolute filename, (the initial
1017 * component will match notmuch_database_get_path() ).
1019 * The returned string belongs to the message so should not be
1020 * modified or freed by the caller (nor should it be referenced after
1021 * the message is destroyed).
1023 * Note: If this message corresponds to multiple files in the mail
1024 * store, (that is, multiple files contain identical message IDs),
1025 * this function will arbitrarily return a single one of those
1026 * filenames. See notmuch_message_get_filenames for returning the
1027 * complete list of filenames.
1030 notmuch_message_get_filename (notmuch_message_t *message);
1032 /* Get all filenames for the email corresponding to 'message'.
1034 * Returns a notmuch_filenames_t iterator listing all the filenames
1035 * associated with 'message'. These files may not have identical
1036 * content, but each will have the identical Message-ID.
1038 * Each filename in the iterator is an absolute filename, (the initial
1039 * component will match notmuch_database_get_path() ).
1041 notmuch_filenames_t *
1042 notmuch_message_get_filenames (notmuch_message_t *message);
1045 typedef enum _notmuch_message_flag {
1046 NOTMUCH_MESSAGE_FLAG_MATCH,
1047 NOTMUCH_MESSAGE_FLAG_EXCLUDED
1048 } notmuch_message_flag_t;
1050 /* Get a value of a flag for the email corresponding to 'message'. */
1052 notmuch_message_get_flag (notmuch_message_t *message,
1053 notmuch_message_flag_t flag);
1055 /* Set a value of a flag for the email corresponding to 'message'. */
1057 notmuch_message_set_flag (notmuch_message_t *message,
1058 notmuch_message_flag_t flag, notmuch_bool_t value);
1060 /* Get the date of 'message' as a time_t value.
1062 * For the original textual representation of the Date header from the
1063 * message call notmuch_message_get_header() with a header value of
1066 notmuch_message_get_date (notmuch_message_t *message);
1068 /* Get the value of the specified header from 'message' as a UTF-8 string.
1070 * Common headers are stored in the database when the message is
1071 * indexed and will be returned from the database. Other headers will
1072 * be read from the actual message file.
1074 * The header name is case insensitive.
1076 * The returned string belongs to the message so should not be
1077 * modified or freed by the caller (nor should it be referenced after
1078 * the message is destroyed).
1080 * Returns an empty string ("") if the message does not contain a
1081 * header line matching 'header'. Returns NULL if any error occurs.
1084 notmuch_message_get_header (notmuch_message_t *message, const char *header);
1086 /* Get the tags for 'message', returning a notmuch_tags_t object which
1087 * can be used to iterate over all tags.
1089 * The tags object is owned by the message and as such, will only be
1090 * valid for as long as the message is valid, (which is until the
1091 * query from which it derived is destroyed).
1093 * Typical usage might be:
1095 * notmuch_message_t *message;
1096 * notmuch_tags_t *tags;
1099 * message = notmuch_database_find_message (database, message_id);
1101 * for (tags = notmuch_message_get_tags (message);
1102 * notmuch_tags_valid (tags);
1103 * notmuch_result_move_to_next (tags))
1105 * tag = notmuch_tags_get (tags);
1109 * notmuch_message_destroy (message);
1111 * Note that there's no explicit destructor needed for the
1112 * notmuch_tags_t object. (For consistency, we do provide a
1113 * notmuch_tags_destroy function, but there's no good reason to call
1114 * it if the message is about to be destroyed).
1117 notmuch_message_get_tags (notmuch_message_t *message);
1119 /* The longest possible tag value. */
1120 #define NOTMUCH_TAG_MAX 200
1122 /* Add a tag to the given message.
1126 * NOTMUCH_STATUS_SUCCESS: Tag successfully added to message
1128 * NOTMUCH_STATUS_NULL_POINTER: The 'tag' argument is NULL
1130 * NOTMUCH_STATUS_TAG_TOO_LONG: The length of 'tag' is too long
1131 * (exceeds NOTMUCH_TAG_MAX)
1133 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
1134 * mode so message cannot be modified.
1137 notmuch_message_add_tag (notmuch_message_t *message, const char *tag);
1139 /* Remove a tag from the given message.
1143 * NOTMUCH_STATUS_SUCCESS: Tag successfully removed from message
1145 * NOTMUCH_STATUS_NULL_POINTER: The 'tag' argument is NULL
1147 * NOTMUCH_STATUS_TAG_TOO_LONG: The length of 'tag' is too long
1148 * (exceeds NOTMUCH_TAG_MAX)
1150 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
1151 * mode so message cannot be modified.
1154 notmuch_message_remove_tag (notmuch_message_t *message, const char *tag);
1156 /* Remove all tags from the given message.
1158 * See notmuch_message_freeze for an example showing how to safely
1159 * replace tag values.
1161 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
1162 * mode so message cannot be modified.
1165 notmuch_message_remove_all_tags (notmuch_message_t *message);
1167 /* Add/remove tags according to maildir flags in the message filename(s)
1169 * This function examines the filenames of 'message' for maildir
1170 * flags, and adds or removes tags on 'message' as follows when these
1171 * flags are present:
1173 * Flag Action if present
1174 * ---- -----------------
1175 * 'D' Adds the "draft" tag to the message
1176 * 'F' Adds the "flagged" tag to the message
1177 * 'P' Adds the "passed" tag to the message
1178 * 'R' Adds the "replied" tag to the message
1179 * 'S' Removes the "unread" tag from the message
1181 * For each flag that is not present, the opposite action (add/remove)
1182 * is performed for the corresponding tags.
1184 * Flags are identified as trailing components of the filename after a
1185 * sequence of ":2,".
1187 * If there are multiple filenames associated with this message, the
1188 * flag is considered present if it appears in one or more
1189 * filenames. (That is, the flags from the multiple filenames are
1190 * combined with the logical OR operator.)
1192 * A client can ensure that notmuch database tags remain synchronized
1193 * with maildir flags by calling this function after each call to
1194 * notmuch_database_add_message. See also
1195 * notmuch_message_tags_to_maildir_flags for synchronizing tag changes
1196 * back to maildir flags.
1199 notmuch_message_maildir_flags_to_tags (notmuch_message_t *message);
1201 /* Rename message filename(s) to encode tags as maildir flags
1203 * Specifically, for each filename corresponding to this message:
1205 * If the filename is not in a maildir directory, do nothing. (A
1206 * maildir directory is determined as a directory named "new" or
1207 * "cur".) Similarly, if the filename has invalid maildir info,
1208 * (repeated or outof-ASCII-order flag characters after ":2,"), then
1211 * If the filename is in a maildir directory, rename the file so that
1212 * its filename ends with the sequence ":2," followed by zero or more
1213 * of the following single-character flags (in ASCII order):
1215 * 'D' iff the message has the "draft" tag
1216 * 'F' iff the message has the "flagged" tag
1217 * 'P' iff the message has the "passed" tag
1218 * 'R' iff the message has the "replied" tag
1219 * 'S' iff the message does not have the "unread" tag
1221 * Any existing flags unmentioned in the list above will be preserved
1224 * Also, if this filename is in a directory named "new", rename it to
1225 * be within the neighboring directory named "cur".
1227 * A client can ensure that maildir filename flags remain synchronized
1228 * with notmuch database tags by calling this function after changing
1229 * tags, (after calls to notmuch_message_add_tag,
1230 * notmuch_message_remove_tag, or notmuch_message_freeze/
1231 * notmuch_message_thaw). See also notmuch_message_maildir_flags_to_tags
1232 * for synchronizing maildir flag changes back to tags.
1235 notmuch_message_tags_to_maildir_flags (notmuch_message_t *message);
1237 /* Freeze the current state of 'message' within the database.
1239 * This means that changes to the message state, (via
1240 * notmuch_message_add_tag, notmuch_message_remove_tag, and
1241 * notmuch_message_remove_all_tags), will not be committed to the
1242 * database until the message is thawed with notmuch_message_thaw.
1244 * Multiple calls to freeze/thaw are valid and these calls will
1245 * "stack". That is there must be as many calls to thaw as to freeze
1246 * before a message is actually thawed.
1248 * The ability to do freeze/thaw allows for safe transactions to
1249 * change tag values. For example, explicitly setting a message to
1250 * have a given set of tags might look like this:
1252 * notmuch_message_freeze (message);
1254 * notmuch_message_remove_all_tags (message);
1256 * for (i = 0; i < NUM_TAGS; i++)
1257 * notmuch_message_add_tag (message, tags[i]);
1259 * notmuch_message_thaw (message);
1261 * With freeze/thaw used like this, the message in the database is
1262 * guaranteed to have either the full set of original tag values, or
1263 * the full set of new tag values, but nothing in between.
1265 * Imagine the example above without freeze/thaw and the operation
1266 * somehow getting interrupted. This could result in the message being
1267 * left with no tags if the interruption happened after
1268 * notmuch_message_remove_all_tags but before notmuch_message_add_tag.
1272 * NOTMUCH_STATUS_SUCCESS: Message successfully frozen.
1274 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
1275 * mode so message cannot be modified.
1278 notmuch_message_freeze (notmuch_message_t *message);
1280 /* Thaw the current 'message', synchronizing any changes that may have
1281 * occurred while 'message' was frozen into the notmuch database.
1283 * See notmuch_message_freeze for an example of how to use this
1284 * function to safely provide tag changes.
1286 * Multiple calls to freeze/thaw are valid and these calls with
1287 * "stack". That is there must be as many calls to thaw as to freeze
1288 * before a message is actually thawed.
1292 * NOTMUCH_STATUS_SUCCESS: Message successfully thawed, (or at least
1293 * its frozen count has successfully been reduced by 1).
1295 * NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW: An attempt was made to thaw
1296 * an unfrozen message. That is, there have been an unbalanced
1297 * number of calls to notmuch_message_freeze and
1298 * notmuch_message_thaw.
1301 notmuch_message_thaw (notmuch_message_t *message);
1303 /* Destroy a notmuch_message_t object.
1305 * It can be useful to call this function in the case of a single
1306 * query object with many messages in the result, (such as iterating
1307 * over the entire database). Otherwise, it's fine to never call this
1308 * function and there will still be no memory leaks. (The memory from
1309 * the messages get reclaimed when the containing query is destroyed.)
1312 notmuch_message_destroy (notmuch_message_t *message);
1314 /* Is the given 'tags' iterator pointing at a valid tag.
1316 * When this function returns TRUE, notmuch_tags_get will return a
1317 * valid string. Whereas when this function returns FALSE,
1318 * notmuch_tags_get will return NULL.
1320 * See the documentation of notmuch_message_get_tags for example code
1321 * showing how to iterate over a notmuch_tags_t object.
1324 notmuch_tags_valid (notmuch_tags_t *tags);
1326 /* Get the current tag from 'tags' as a string.
1328 * Note: The returned string belongs to 'tags' and has a lifetime
1329 * identical to it (and the query to which it ultimately belongs).
1331 * See the documentation of notmuch_message_get_tags for example code
1332 * showing how to iterate over a notmuch_tags_t object.
1335 notmuch_tags_get (notmuch_tags_t *tags);
1337 /* Move the 'tags' iterator to the next tag.
1339 * If 'tags' is already pointing at the last tag then the iterator
1340 * will be moved to a point just beyond that last tag, (where
1341 * notmuch_tags_valid will return FALSE and notmuch_tags_get will
1344 * See the documentation of notmuch_message_get_tags for example code
1345 * showing how to iterate over a notmuch_tags_t object.
1348 notmuch_tags_move_to_next (notmuch_tags_t *tags);
1350 /* Destroy a notmuch_tags_t object.
1352 * It's not strictly necessary to call this function. All memory from
1353 * the notmuch_tags_t object will be reclaimed when the containing
1354 * message or query objects are destroyed.
1357 notmuch_tags_destroy (notmuch_tags_t *tags);
1359 /* Store an mtime within the database for 'directory'.
1361 * The 'directory' should be an object retrieved from the database
1362 * with notmuch_database_get_directory for a particular path.
1364 * The intention is for the caller to use the mtime to allow efficient
1365 * identification of new messages to be added to the database. The
1366 * recommended usage is as follows:
1368 * o Read the mtime of a directory from the filesystem
1370 * o Call add_message for all mail files in the directory
1372 * o Call notmuch_directory_set_mtime with the mtime read from the
1375 * Then, when wanting to check for updates to the directory in the
1376 * future, the client can call notmuch_directory_get_mtime and know
1377 * that it only needs to add files if the mtime of the directory and
1378 * files are newer than the stored timestamp.
1380 * Note: The notmuch_directory_get_mtime function does not allow the
1381 * caller to distinguish a timestamp of 0 from a non-existent
1382 * timestamp. So don't store a timestamp of 0 unless you are
1383 * comfortable with that.
1387 * NOTMUCH_STATUS_SUCCESS: mtime successfully stored in database.
1389 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception
1390 * occurred, mtime not stored.
1392 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
1393 * mode so directory mtime cannot be modified.
1396 notmuch_directory_set_mtime (notmuch_directory_t *directory,
1399 /* Get the mtime of a directory, (as previously stored with
1400 * notmuch_directory_set_mtime).
1402 * Returns 0 if no mtime has previously been stored for this
1405 notmuch_directory_get_mtime (notmuch_directory_t *directory);
1407 /* Get a notmuch_filenames_t iterator listing all the filenames of
1408 * messages in the database within the given directory.
1410 * The returned filenames will be the basename-entries only (not
1411 * complete paths). */
1412 notmuch_filenames_t *
1413 notmuch_directory_get_child_files (notmuch_directory_t *directory);
1415 /* Get a notmuch_filenams_t iterator listing all the filenames of
1416 * sub-directories in the database within the given directory.
1418 * The returned filenames will be the basename-entries only (not
1419 * complete paths). */
1420 notmuch_filenames_t *
1421 notmuch_directory_get_child_directories (notmuch_directory_t *directory);
1423 /* Destroy a notmuch_directory_t object. */
1425 notmuch_directory_destroy (notmuch_directory_t *directory);
1427 /* Is the given 'filenames' iterator pointing at a valid filename.
1429 * When this function returns TRUE, notmuch_filenames_get will return
1430 * a valid string. Whereas when this function returns FALSE,
1431 * notmuch_filenames_get will return NULL.
1433 * It is acceptable to pass NULL for 'filenames', in which case this
1434 * function will always return FALSE.
1437 notmuch_filenames_valid (notmuch_filenames_t *filenames);
1439 /* Get the current filename from 'filenames' as a string.
1441 * Note: The returned string belongs to 'filenames' and has a lifetime
1442 * identical to it (and the directory to which it ultimately belongs).
1444 * It is acceptable to pass NULL for 'filenames', in which case this
1445 * function will always return NULL.
1448 notmuch_filenames_get (notmuch_filenames_t *filenames);
1450 /* Move the 'filenames' iterator to the next filename.
1452 * If 'filenames' is already pointing at the last filename then the
1453 * iterator will be moved to a point just beyond that last filename,
1454 * (where notmuch_filenames_valid will return FALSE and
1455 * notmuch_filenames_get will return NULL).
1457 * It is acceptable to pass NULL for 'filenames', in which case this
1458 * function will do nothing.
1461 notmuch_filenames_move_to_next (notmuch_filenames_t *filenames);
1463 /* Destroy a notmuch_filenames_t object.
1465 * It's not strictly necessary to call this function. All memory from
1466 * the notmuch_filenames_t object will be reclaimed when the
1467 * containing directory object is destroyed.
1469 * It is acceptable to pass NULL for 'filenames', in which case this
1470 * function will do nothing.
1473 notmuch_filenames_destroy (notmuch_filenames_t *filenames);