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 * Not an actual status value. Just a way to find out how many
164 * valid status values there are.
166 NOTMUCH_STATUS_LAST_STATUS
170 * Get a string representation of a notmuch_status_t value.
172 * The result is read-only.
175 notmuch_status_to_string (notmuch_status_t status);
177 /* Various opaque data types. For each notmuch_<foo>_t see the various
178 * notmuch_<foo> functions below. */
180 typedef struct _notmuch_database notmuch_database_t;
181 typedef struct _notmuch_query notmuch_query_t;
182 typedef struct _notmuch_threads notmuch_threads_t;
183 typedef struct _notmuch_thread notmuch_thread_t;
184 typedef struct _notmuch_messages notmuch_messages_t;
185 typedef struct _notmuch_message notmuch_message_t;
186 typedef struct _notmuch_tags notmuch_tags_t;
187 typedef struct _notmuch_directory notmuch_directory_t;
188 typedef struct _notmuch_filenames notmuch_filenames_t;
189 #endif /* __DOXYGEN__ */
192 * Create a new, empty notmuch database located at 'path'.
194 * The path should be a top-level directory to a collection of
195 * plain-text email messages (one message per file). This call will
196 * create a new ".notmuch" directory within 'path' where notmuch will
199 * After a successful call to notmuch_database_create, the returned
200 * database will be open so the caller should call
201 * notmuch_database_destroy when finished with it.
203 * The database will not yet have any data in it
204 * (notmuch_database_create itself is a very cheap function). Messages
205 * contained within 'path' can be added to the database by calling
206 * notmuch_database_add_message.
208 * In case of any failure, this function returns an error status and
209 * sets *database to NULL (after printing an error message on stderr).
213 * NOTMUCH_STATUS_SUCCESS: Successfully created the database.
215 * NOTMUCH_STATUS_NULL_POINTER: The given 'path' argument is NULL.
217 * NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory.
219 * NOTMUCH_STATUS_FILE_ERROR: An error occurred trying to create the
220 * database file (such as permission denied, or file not found,
221 * etc.), or the database already exists.
223 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred.
226 notmuch_database_create (const char *path, notmuch_database_t **database);
229 * Database open mode for notmuch_database_open.
233 * Open database for reading only.
235 NOTMUCH_DATABASE_MODE_READ_ONLY = 0,
237 * Open database for reading and writing.
239 NOTMUCH_DATABASE_MODE_READ_WRITE
240 } notmuch_database_mode_t;
243 * Open an existing notmuch database located at 'path'.
245 * The database should have been created at some time in the past,
246 * (not necessarily by this process), by calling
247 * notmuch_database_create with 'path'. By default the database should be
248 * opened for reading only. In order to write to the database you need to
249 * pass the NOTMUCH_DATABASE_MODE_READ_WRITE mode.
251 * An existing notmuch database can be identified by the presence of a
252 * directory named ".notmuch" below 'path'.
254 * The caller should call notmuch_database_destroy when finished with
257 * In case of any failure, this function returns an error status and
258 * sets *database to NULL (after printing an error message on stderr).
262 * NOTMUCH_STATUS_SUCCESS: Successfully opened the database.
264 * NOTMUCH_STATUS_NULL_POINTER: The given 'path' argument is NULL.
266 * NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory.
268 * NOTMUCH_STATUS_FILE_ERROR: An error occurred trying to open the
269 * database file (such as permission denied, or file not found,
270 * etc.), or the database version is unknown.
272 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred.
275 notmuch_database_open (const char *path,
276 notmuch_database_mode_t mode,
277 notmuch_database_t **database);
280 * Close the given notmuch database.
282 * After notmuch_database_close has been called, calls to other
283 * functions on objects derived from this database may either behave
284 * as if the database had not been closed (e.g., if the required data
285 * has been cached) or may fail with a
286 * NOTMUCH_STATUS_XAPIAN_EXCEPTION.
288 * notmuch_database_close can be called multiple times. Later calls
293 * NOTMUCH_STATUS_SUCCESS: Successfully closed the database.
295 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred; the
296 * database has been closed but there are no guarantees the
297 * changes to the database, if any, have been flushed to disk.
300 notmuch_database_close (notmuch_database_t *database);
303 * A callback invoked by notmuch_database_compact to notify the user
304 * of the progress of the compaction process.
306 typedef void (*notmuch_compact_status_cb_t)(const char *message, void *closure);
309 * Compact a notmuch database, backing up the original database to the
312 * The database will be opened with NOTMUCH_DATABASE_MODE_READ_WRITE
313 * during the compaction process to ensure no writes are made.
315 * If the optional callback function 'status_cb' is non-NULL, it will
316 * be called with diagnostic and informational messages. The argument
317 * 'closure' is passed verbatim to any callback invoked.
320 notmuch_database_compact (const char* path,
321 const char* backup_path,
322 notmuch_compact_status_cb_t status_cb,
326 * Destroy the notmuch database, closing it if necessary and freeing
327 * all associated resources.
329 * Return value as in notmuch_database_close if the database was open;
330 * notmuch_database_destroy itself has no failure modes.
333 notmuch_database_destroy (notmuch_database_t *database);
336 * Return the database path of the given database.
338 * The return value is a string owned by notmuch so should not be
339 * modified nor freed by the caller.
342 notmuch_database_get_path (notmuch_database_t *database);
345 * Return the database format version of the given database.
348 notmuch_database_get_version (notmuch_database_t *database);
351 * Does this database need to be upgraded before writing to it?
353 * If this function returns TRUE then no functions that modify the
354 * database (notmuch_database_add_message, notmuch_message_add_tag,
355 * notmuch_directory_set_mtime, etc.) will work unless the function
356 * notmuch_database_upgrade is called successfully first.
359 notmuch_database_needs_upgrade (notmuch_database_t *database);
362 * Upgrade the current database.
364 * After opening a database in read-write mode, the client should
365 * check if an upgrade is needed (notmuch_database_needs_upgrade) and
366 * if so, upgrade with this function before making any modifications.
368 * The optional progress_notify callback can be used by the caller to
369 * provide progress indication to the user. If non-NULL it will be
370 * called periodically with 'progress' as a floating-point value in
371 * the range of [0.0 .. 1.0] indicating the progress made so far in
372 * the upgrade process. The argument 'closure' is passed verbatim to
373 * any callback invoked.
376 notmuch_database_upgrade (notmuch_database_t *database,
377 void (*progress_notify) (void *closure,
382 * Begin an atomic database operation.
384 * Any modifications performed between a successful begin and a
385 * notmuch_database_end_atomic will be applied to the database
386 * atomically. Note that, unlike a typical database transaction, this
387 * only ensures atomicity, not durability; neither begin nor end
388 * necessarily flush modifications to disk.
390 * Atomic sections may be nested. begin_atomic and end_atomic must
391 * always be called in pairs.
395 * NOTMUCH_STATUS_SUCCESS: Successfully entered atomic section.
397 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred;
398 * atomic section not entered.
401 notmuch_database_begin_atomic (notmuch_database_t *notmuch);
404 * Indicate the end of an atomic database operation.
408 * NOTMUCH_STATUS_SUCCESS: Successfully completed atomic section.
410 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred;
411 * atomic section not ended.
413 * NOTMUCH_STATUS_UNBALANCED_ATOMIC: The database is not currently in
417 notmuch_database_end_atomic (notmuch_database_t *notmuch);
420 * Retrieve a directory object from the database for 'path'.
422 * Here, 'path' should be a path relative to the path of 'database'
423 * (see notmuch_database_get_path), or else should be an absolute path
424 * with initial components that match the path of 'database'.
426 * If this directory object does not exist in the database, this
427 * returns NOTMUCH_STATUS_SUCCESS and sets *directory to NULL.
429 * Otherwise the returned directory object is owned by the database
430 * and as such, will only be valid until notmuch_database_destroy is
435 * NOTMUCH_STATUS_SUCCESS: Successfully retrieved directory.
437 * NOTMUCH_STATUS_NULL_POINTER: The given 'directory' argument is NULL.
439 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred;
440 * directory not retrieved.
443 notmuch_database_get_directory (notmuch_database_t *database,
445 notmuch_directory_t **directory);
448 * Add a new message to the given notmuch database or associate an
449 * additional filename with an existing message.
451 * Here, 'filename' should be a path relative to the path of
452 * 'database' (see notmuch_database_get_path), or else should be an
453 * absolute filename with initial components that match the path of
456 * The file should be a single mail message (not a multi-message mbox)
457 * that is expected to remain at its current location, (since the
458 * notmuch database will reference the filename, and will not copy the
459 * entire contents of the file.
461 * If another message with the same message ID already exists in the
462 * database, rather than creating a new message, this adds 'filename'
463 * to the list of the filenames for the existing message.
465 * If 'message' is not NULL, then, on successful return
466 * (NOTMUCH_STATUS_SUCCESS or NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID) '*message'
467 * will be initialized to a message object that can be used for things
468 * such as adding tags to the just-added message. The user should call
469 * notmuch_message_destroy when done with the message. On any failure
470 * '*message' will be set to NULL.
474 * NOTMUCH_STATUS_SUCCESS: Message successfully added to database.
476 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred,
479 * NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID: Message has the same message
480 * ID as another message already in the database. The new
481 * filename was successfully added to the message in the database
482 * (if not already present) and the existing message is returned.
484 * NOTMUCH_STATUS_FILE_ERROR: an error occurred trying to open the
485 * file, (such as permission denied, or file not found,
486 * etc.). Nothing added to the database.
488 * NOTMUCH_STATUS_FILE_NOT_EMAIL: the contents of filename don't look
489 * like an email message. Nothing added to the database.
491 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
492 * mode so no message can be added.
495 notmuch_database_add_message (notmuch_database_t *database,
496 const char *filename,
497 notmuch_message_t **message);
500 * Remove a message filename from the given notmuch database. If the
501 * message has no more filenames, remove the message.
503 * If the same message (as determined by the message ID) is still
504 * available via other filenames, then the message will persist in the
505 * database for those filenames. When the last filename is removed for
506 * a particular message, the database content for that message will be
511 * NOTMUCH_STATUS_SUCCESS: The last filename was removed and the
512 * message was removed from the database.
514 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred,
515 * message not removed.
517 * NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID: This filename was removed but
518 * the message persists in the database with at least one other
521 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
522 * mode so no message can be removed.
525 notmuch_database_remove_message (notmuch_database_t *database,
526 const char *filename);
529 * Find a message with the given message_id.
531 * If a message with the given message_id is found then, on successful return
532 * (NOTMUCH_STATUS_SUCCESS) '*message' will be initialized to a message
533 * object. The caller should call notmuch_message_destroy when done with the
536 * On any failure or when the message is not found, this function initializes
537 * '*message' to NULL. This means, when NOTMUCH_STATUS_SUCCESS is returned, the
538 * caller is supposed to check '*message' for NULL to find out whether the
539 * message with the given message_id was found.
543 * NOTMUCH_STATUS_SUCCESS: Successful return, check '*message'.
545 * NOTMUCH_STATUS_NULL_POINTER: The given 'message' argument is NULL
547 * NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory, creating message object
549 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred
552 notmuch_database_find_message (notmuch_database_t *database,
553 const char *message_id,
554 notmuch_message_t **message);
557 * Find a message with the given filename.
559 * If the database contains a message with the given filename then, on
560 * successful return (NOTMUCH_STATUS_SUCCESS) '*message' will be initialized to
561 * a message object. The caller should call notmuch_message_destroy when done
564 * On any failure or when the message is not found, this function initializes
565 * '*message' to NULL. This means, when NOTMUCH_STATUS_SUCCESS is returned, the
566 * caller is supposed to check '*message' for NULL to find out whether the
567 * message with the given filename is found.
571 * NOTMUCH_STATUS_SUCCESS: Successful return, check '*message'
573 * NOTMUCH_STATUS_NULL_POINTER: The given 'message' argument is NULL
575 * NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory, creating the message object
577 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred
580 notmuch_database_find_message_by_filename (notmuch_database_t *notmuch,
581 const char *filename,
582 notmuch_message_t **message);
585 * Return a list of all tags found in the database.
587 * This function creates a list of all tags found in the database. The
588 * resulting list contains all tags from all messages found in the database.
590 * On error this function returns NULL.
593 notmuch_database_get_all_tags (notmuch_database_t *db);
596 * Create a new query for 'database'.
598 * Here, 'database' should be an open database, (see
599 * notmuch_database_open and notmuch_database_create).
601 * For the query string, we'll document the syntax here more
602 * completely in the future, but it's likely to be a specialized
603 * version of the general Xapian query syntax:
605 * http://xapian.org/docs/queryparser.html
607 * As a special case, passing either a length-zero string, (that is ""),
608 * or a string consisting of a single asterisk (that is "*"), will
609 * result in a query that returns all messages in the database.
611 * See notmuch_query_set_sort for controlling the order of results.
612 * See notmuch_query_search_messages and notmuch_query_search_threads
613 * to actually execute the query.
615 * User should call notmuch_query_destroy when finished with this
618 * Will return NULL if insufficient memory is available.
621 notmuch_query_create (notmuch_database_t *database,
622 const char *query_string);
625 * Sort values for notmuch_query_set_sort.
631 NOTMUCH_SORT_OLDEST_FIRST,
635 NOTMUCH_SORT_NEWEST_FIRST,
637 * Sort by message-id.
639 NOTMUCH_SORT_MESSAGE_ID,
643 NOTMUCH_SORT_UNSORTED
647 * Return the query_string of this query. See notmuch_query_create.
650 notmuch_query_get_query_string (notmuch_query_t *query);
653 * Exclude values for notmuch_query_set_omit_excluded. The strange
654 * order is to maintain backward compatibility: the old FALSE/TRUE
655 * options correspond to the new
656 * NOTMUCH_EXCLUDE_FLAG/NOTMUCH_EXCLUDE_TRUE options.
659 NOTMUCH_EXCLUDE_FLAG,
660 NOTMUCH_EXCLUDE_TRUE,
661 NOTMUCH_EXCLUDE_FALSE,
666 * Specify whether to omit excluded results or simply flag them. By
667 * default, this is set to TRUE.
669 * If set to TRUE or ALL, notmuch_query_search_messages will omit excluded
670 * messages from the results, and notmuch_query_search_threads will omit
671 * threads that match only in excluded messages. If set to TRUE,
672 * notmuch_query_search_threads will include all messages in threads that
673 * match in at least one non-excluded message. Otherwise, if set to ALL,
674 * notmuch_query_search_threads will omit excluded messages from all threads.
676 * If set to FALSE or FLAG then both notmuch_query_search_messages and
677 * notmuch_query_search_threads will return all matching
678 * messages/threads regardless of exclude status. If set to FLAG then
679 * the exclude flag will be set for any excluded message that is
680 * returned by notmuch_query_search_messages, and the thread counts
681 * for threads returned by notmuch_query_search_threads will be the
682 * number of non-excluded messages/matches. Otherwise, if set to
683 * FALSE, then the exclude status is completely ignored.
685 * The performance difference when calling
686 * notmuch_query_search_messages should be relatively small (and both
687 * should be very fast). However, in some cases,
688 * notmuch_query_search_threads is very much faster when omitting
689 * excluded messages as it does not need to construct the threads that
690 * only match in excluded messages.
693 notmuch_query_set_omit_excluded (notmuch_query_t *query,
694 notmuch_exclude_t omit_excluded);
697 * Specify the sorting desired for this query.
700 notmuch_query_set_sort (notmuch_query_t *query, notmuch_sort_t sort);
703 * Return the sort specified for this query. See
704 * notmuch_query_set_sort.
707 notmuch_query_get_sort (notmuch_query_t *query);
710 * Add a tag that will be excluded from the query results by default.
711 * This exclusion will be overridden if this tag appears explicitly in
715 notmuch_query_add_tag_exclude (notmuch_query_t *query, const char *tag);
718 * Execute a query for threads, returning a notmuch_threads_t object
719 * which can be used to iterate over the results. The returned threads
720 * object is owned by the query and as such, will only be valid until
721 * notmuch_query_destroy.
723 * Typical usage might be:
725 * notmuch_query_t *query;
726 * notmuch_threads_t *threads;
727 * notmuch_thread_t *thread;
729 * query = notmuch_query_create (database, query_string);
731 * for (threads = notmuch_query_search_threads (query);
732 * notmuch_threads_valid (threads);
733 * notmuch_threads_move_to_next (threads))
735 * thread = notmuch_threads_get (threads);
737 * notmuch_thread_destroy (thread);
740 * notmuch_query_destroy (query);
742 * Note: If you are finished with a thread before its containing
743 * query, you can call notmuch_thread_destroy to clean up some memory
744 * sooner (as in the above example). Otherwise, if your thread objects
745 * are long-lived, then you don't need to call notmuch_thread_destroy
746 * and all the memory will still be reclaimed when the query is
749 * Note that there's no explicit destructor needed for the
750 * notmuch_threads_t object. (For consistency, we do provide a
751 * notmuch_threads_destroy function, but there's no good reason
752 * to call it if the query is about to be destroyed).
754 * If a Xapian exception occurs this function will return NULL.
757 notmuch_query_search_threads (notmuch_query_t *query);
760 * Execute a query for messages, returning a notmuch_messages_t object
761 * which can be used to iterate over the results. The returned
762 * messages object is owned by the query and as such, will only be
763 * valid until notmuch_query_destroy.
765 * Typical usage might be:
767 * notmuch_query_t *query;
768 * notmuch_messages_t *messages;
769 * notmuch_message_t *message;
771 * query = notmuch_query_create (database, query_string);
773 * for (messages = notmuch_query_search_messages (query);
774 * notmuch_messages_valid (messages);
775 * notmuch_messages_move_to_next (messages))
777 * message = notmuch_messages_get (messages);
779 * notmuch_message_destroy (message);
782 * notmuch_query_destroy (query);
784 * Note: If you are finished with a message before its containing
785 * query, you can call notmuch_message_destroy to clean up some memory
786 * sooner (as in the above example). Otherwise, if your message
787 * objects are long-lived, then you don't need to call
788 * notmuch_message_destroy and all the memory will still be reclaimed
789 * when the query is destroyed.
791 * Note that there's no explicit destructor needed for the
792 * notmuch_messages_t object. (For consistency, we do provide a
793 * notmuch_messages_destroy function, but there's no good
794 * reason to call it if the query is about to be destroyed).
796 * If a Xapian exception occurs this function will return NULL.
799 notmuch_query_search_messages (notmuch_query_t *query);
802 * Destroy a notmuch_query_t along with any associated resources.
804 * This will in turn destroy any notmuch_threads_t and
805 * notmuch_messages_t objects generated by this query, (and in
806 * turn any notmuch_thread_t and notmuch_message_t objects generated
807 * from those results, etc.), if such objects haven't already been
811 notmuch_query_destroy (notmuch_query_t *query);
814 * Is the given 'threads' iterator pointing at a valid thread.
816 * When this function returns TRUE, notmuch_threads_get will return a
817 * valid object. Whereas when this function returns FALSE,
818 * notmuch_threads_get will return NULL.
820 * If passed a NULL pointer, this function returns FALSE
822 * See the documentation of notmuch_query_search_threads for example
823 * code showing how to iterate over a notmuch_threads_t object.
826 notmuch_threads_valid (notmuch_threads_t *threads);
829 * Get the current thread from 'threads' as a notmuch_thread_t.
831 * Note: The returned thread belongs to 'threads' and has a lifetime
832 * identical to it (and the query to which it belongs).
834 * See the documentation of notmuch_query_search_threads for example
835 * code showing how to iterate over a notmuch_threads_t object.
837 * If an out-of-memory situation occurs, this function will return
841 notmuch_threads_get (notmuch_threads_t *threads);
844 * Move the 'threads' iterator to the next thread.
846 * If 'threads' is already pointing at the last thread then the
847 * iterator will be moved to a point just beyond that last thread,
848 * (where notmuch_threads_valid will return FALSE and
849 * notmuch_threads_get will return NULL).
851 * See the documentation of notmuch_query_search_threads for example
852 * code showing how to iterate over a notmuch_threads_t object.
855 notmuch_threads_move_to_next (notmuch_threads_t *threads);
858 * Destroy a notmuch_threads_t object.
860 * It's not strictly necessary to call this function. All memory from
861 * the notmuch_threads_t object will be reclaimed when the
862 * containing query object is destroyed.
865 notmuch_threads_destroy (notmuch_threads_t *threads);
868 * Return an estimate of the number of messages matching a search.
870 * This function performs a search and returns Xapian's best
871 * guess as to number of matching messages.
873 * If a Xapian exception occurs, this function may return 0 (after
874 * printing a message).
877 notmuch_query_count_messages (notmuch_query_t *query);
880 * Return the number of threads matching a search.
882 * This function performs a search and returns the number of unique thread IDs
883 * in the matching messages. This is the same as number of threads matching a
886 * Note that this is a significantly heavier operation than
887 * notmuch_query_count_messages().
889 * If an error occurs, this function may return 0.
892 notmuch_query_count_threads (notmuch_query_t *query);
895 * Get the thread ID of 'thread'.
897 * The returned string belongs to 'thread' and as such, should not be
898 * modified by the caller and will only be valid for as long as the
899 * thread is valid, (which is until notmuch_thread_destroy or until
900 * the query from which it derived is destroyed).
903 notmuch_thread_get_thread_id (notmuch_thread_t *thread);
906 * Get the total number of messages in 'thread'.
908 * This count consists of all messages in the database belonging to
909 * this thread. Contrast with notmuch_thread_get_matched_messages() .
912 notmuch_thread_get_total_messages (notmuch_thread_t *thread);
915 * Get a notmuch_messages_t iterator for the top-level messages in
916 * 'thread' in oldest-first order.
918 * This iterator will not necessarily iterate over all of the messages
919 * in the thread. It will only iterate over the messages in the thread
920 * which are not replies to other messages in the thread.
922 * The returned list will be destroyed when the thread is destroyed.
925 notmuch_thread_get_toplevel_messages (notmuch_thread_t *thread);
928 * Get a notmuch_thread_t iterator for all messages in 'thread' in
929 * oldest-first order.
931 * The returned list will be destroyed when the thread is destroyed.
934 notmuch_thread_get_messages (notmuch_thread_t *thread);
937 * Get the number of messages in 'thread' that matched the search.
939 * This count includes only the messages in this thread that were
940 * matched by the search from which the thread was created and were
941 * not excluded by any exclude tags passed in with the query (see
942 * notmuch_query_add_tag_exclude). Contrast with
943 * notmuch_thread_get_total_messages() .
946 notmuch_thread_get_matched_messages (notmuch_thread_t *thread);
949 * Get the authors of 'thread' as a UTF-8 string.
951 * The returned string is a comma-separated list of the names of the
952 * authors of mail messages in the query results that belong to this
955 * The returned string belongs to 'thread' and as such, should not be
956 * modified by the caller and will only be valid for as long as the
957 * thread is valid, (which is until notmuch_thread_destroy or until
958 * the query from which it derived is destroyed).
961 notmuch_thread_get_authors (notmuch_thread_t *thread);
964 * Get the subject of 'thread' as a UTF-8 string.
966 * The subject is taken from the first message (according to the query
967 * order---see notmuch_query_set_sort) in the query results that
968 * belongs to this thread.
970 * The returned string belongs to 'thread' and as such, should not be
971 * modified by the caller and will only be valid for as long as the
972 * thread is valid, (which is until notmuch_thread_destroy or until
973 * the query from which it derived is destroyed).
976 notmuch_thread_get_subject (notmuch_thread_t *thread);
979 * Get the date of the oldest message in 'thread' as a time_t value.
982 notmuch_thread_get_oldest_date (notmuch_thread_t *thread);
985 * Get the date of the newest message in 'thread' as a time_t value.
988 notmuch_thread_get_newest_date (notmuch_thread_t *thread);
991 * Get the tags for 'thread', returning a notmuch_tags_t object which
992 * can be used to iterate over all tags.
994 * Note: In the Notmuch database, tags are stored on individual
995 * messages, not on threads. So the tags returned here will be all
996 * tags of the messages which matched the search and which belong to
999 * The tags object is owned by the thread and as such, will only be
1000 * valid for as long as the thread is valid, (for example, until
1001 * notmuch_thread_destroy or until the query from which it derived is
1004 * Typical usage might be:
1006 * notmuch_thread_t *thread;
1007 * notmuch_tags_t *tags;
1010 * thread = notmuch_threads_get (threads);
1012 * for (tags = notmuch_thread_get_tags (thread);
1013 * notmuch_tags_valid (tags);
1014 * notmuch_tags_move_to_next (tags))
1016 * tag = notmuch_tags_get (tags);
1020 * notmuch_thread_destroy (thread);
1022 * Note that there's no explicit destructor needed for the
1023 * notmuch_tags_t object. (For consistency, we do provide a
1024 * notmuch_tags_destroy function, but there's no good reason to call
1025 * it if the message is about to be destroyed).
1028 notmuch_thread_get_tags (notmuch_thread_t *thread);
1031 * Destroy a notmuch_thread_t object.
1034 notmuch_thread_destroy (notmuch_thread_t *thread);
1037 * Is the given 'messages' iterator pointing at a valid message.
1039 * When this function returns TRUE, notmuch_messages_get will return a
1040 * valid object. Whereas when this function returns FALSE,
1041 * notmuch_messages_get will return NULL.
1043 * See the documentation of notmuch_query_search_messages for example
1044 * code showing how to iterate over a notmuch_messages_t object.
1047 notmuch_messages_valid (notmuch_messages_t *messages);
1050 * Get the current message from 'messages' as a notmuch_message_t.
1052 * Note: The returned message belongs to 'messages' and has a lifetime
1053 * identical to it (and the query to which it belongs).
1055 * See the documentation of notmuch_query_search_messages for example
1056 * code showing how to iterate over a notmuch_messages_t object.
1058 * If an out-of-memory situation occurs, this function will return
1062 notmuch_messages_get (notmuch_messages_t *messages);
1065 * Move the 'messages' iterator to the next message.
1067 * If 'messages' is already pointing at the last message then the
1068 * iterator will be moved to a point just beyond that last message,
1069 * (where notmuch_messages_valid will return FALSE and
1070 * notmuch_messages_get will return NULL).
1072 * See the documentation of notmuch_query_search_messages for example
1073 * code showing how to iterate over a notmuch_messages_t object.
1076 notmuch_messages_move_to_next (notmuch_messages_t *messages);
1079 * Destroy a notmuch_messages_t object.
1081 * It's not strictly necessary to call this function. All memory from
1082 * the notmuch_messages_t object will be reclaimed when the containing
1083 * query object is destroyed.
1086 notmuch_messages_destroy (notmuch_messages_t *messages);
1089 * Return a list of tags from all messages.
1091 * The resulting list is guaranteed not to contain duplicated tags.
1093 * WARNING: You can no longer iterate over messages after calling this
1094 * function, because the iterator will point at the end of the list.
1095 * We do not have a function to reset the iterator yet and the only
1096 * way how you can iterate over the list again is to recreate the
1099 * The function returns NULL on error.
1102 notmuch_messages_collect_tags (notmuch_messages_t *messages);
1105 * Get the message ID of 'message'.
1107 * The returned string belongs to 'message' and as such, should not be
1108 * modified by the caller and will only be valid for as long as the
1109 * message is valid, (which is until the query from which it derived
1112 * This function will not return NULL since Notmuch ensures that every
1113 * message has a unique message ID, (Notmuch will generate an ID for a
1114 * message if the original file does not contain one).
1117 notmuch_message_get_message_id (notmuch_message_t *message);
1120 * Get the thread ID of 'message'.
1122 * The returned string belongs to 'message' and as such, should not be
1123 * modified by the caller and will only be valid for as long as the
1124 * message is valid, (for example, until the user calls
1125 * notmuch_message_destroy on 'message' or until a query from which it
1126 * derived is destroyed).
1128 * This function will not return NULL since Notmuch ensures that every
1129 * message belongs to a single thread.
1132 notmuch_message_get_thread_id (notmuch_message_t *message);
1135 * Get a notmuch_messages_t iterator for all of the replies to
1138 * Note: This call only makes sense if 'message' was ultimately
1139 * obtained from a notmuch_thread_t object, (such as by coming
1140 * directly from the result of calling notmuch_thread_get_
1141 * toplevel_messages or by any number of subsequent
1142 * calls to notmuch_message_get_replies).
1144 * If 'message' was obtained through some non-thread means, (such as
1145 * by a call to notmuch_query_search_messages), then this function
1148 * If there are no replies to 'message', this function will return
1149 * NULL. (Note that notmuch_messages_valid will accept that NULL
1150 * value as legitimate, and simply return FALSE for it.)
1152 notmuch_messages_t *
1153 notmuch_message_get_replies (notmuch_message_t *message);
1156 * Get a filename for the email corresponding to 'message'.
1158 * The returned filename is an absolute filename, (the initial
1159 * component will match notmuch_database_get_path() ).
1161 * The returned string belongs to the message so should not be
1162 * modified or freed by the caller (nor should it be referenced after
1163 * the message is destroyed).
1165 * Note: If this message corresponds to multiple files in the mail
1166 * store, (that is, multiple files contain identical message IDs),
1167 * this function will arbitrarily return a single one of those
1168 * filenames. See notmuch_message_get_filenames for returning the
1169 * complete list of filenames.
1172 notmuch_message_get_filename (notmuch_message_t *message);
1175 * Get all filenames for the email corresponding to 'message'.
1177 * Returns a notmuch_filenames_t iterator listing all the filenames
1178 * associated with 'message'. These files may not have identical
1179 * content, but each will have the identical Message-ID.
1181 * Each filename in the iterator is an absolute filename, (the initial
1182 * component will match notmuch_database_get_path() ).
1184 notmuch_filenames_t *
1185 notmuch_message_get_filenames (notmuch_message_t *message);
1190 typedef enum _notmuch_message_flag {
1191 NOTMUCH_MESSAGE_FLAG_MATCH,
1192 NOTMUCH_MESSAGE_FLAG_EXCLUDED
1193 } notmuch_message_flag_t;
1196 * Get a value of a flag for the email corresponding to 'message'.
1199 notmuch_message_get_flag (notmuch_message_t *message,
1200 notmuch_message_flag_t flag);
1203 * Set a value of a flag for the email corresponding to 'message'.
1206 notmuch_message_set_flag (notmuch_message_t *message,
1207 notmuch_message_flag_t flag, notmuch_bool_t value);
1210 * Get the date of 'message' as a time_t value.
1212 * For the original textual representation of the Date header from the
1213 * message call notmuch_message_get_header() with a header value of
1217 notmuch_message_get_date (notmuch_message_t *message);
1220 * Get the value of the specified header from 'message' as a UTF-8 string.
1222 * Common headers are stored in the database when the message is
1223 * indexed and will be returned from the database. Other headers will
1224 * be read from the actual message file.
1226 * The header name is case insensitive.
1228 * The returned string belongs to the message so should not be
1229 * modified or freed by the caller (nor should it be referenced after
1230 * the message is destroyed).
1232 * Returns an empty string ("") if the message does not contain a
1233 * header line matching 'header'. Returns NULL if any error occurs.
1236 notmuch_message_get_header (notmuch_message_t *message, const char *header);
1239 * Get the tags for 'message', returning a notmuch_tags_t object which
1240 * can be used to iterate over all tags.
1242 * The tags object is owned by the message and as such, will only be
1243 * valid for as long as the message is valid, (which is until the
1244 * query from which it derived is destroyed).
1246 * Typical usage might be:
1248 * notmuch_message_t *message;
1249 * notmuch_tags_t *tags;
1252 * message = notmuch_database_find_message (database, message_id);
1254 * for (tags = notmuch_message_get_tags (message);
1255 * notmuch_tags_valid (tags);
1256 * notmuch_tags_move_to_next (tags))
1258 * tag = notmuch_tags_get (tags);
1262 * notmuch_message_destroy (message);
1264 * Note that there's no explicit destructor needed for the
1265 * notmuch_tags_t object. (For consistency, we do provide a
1266 * notmuch_tags_destroy function, but there's no good reason to call
1267 * it if the message is about to be destroyed).
1270 notmuch_message_get_tags (notmuch_message_t *message);
1273 * The longest possible tag value.
1275 #define NOTMUCH_TAG_MAX 200
1278 * Add a tag to the given message.
1282 * NOTMUCH_STATUS_SUCCESS: Tag successfully added to message
1284 * NOTMUCH_STATUS_NULL_POINTER: The 'tag' argument is NULL
1286 * NOTMUCH_STATUS_TAG_TOO_LONG: The length of 'tag' is too long
1287 * (exceeds NOTMUCH_TAG_MAX)
1289 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
1290 * mode so message cannot be modified.
1293 notmuch_message_add_tag (notmuch_message_t *message, const char *tag);
1296 * Remove a tag from the given message.
1300 * NOTMUCH_STATUS_SUCCESS: Tag successfully removed from message
1302 * NOTMUCH_STATUS_NULL_POINTER: The 'tag' argument is NULL
1304 * NOTMUCH_STATUS_TAG_TOO_LONG: The length of 'tag' is too long
1305 * (exceeds NOTMUCH_TAG_MAX)
1307 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
1308 * mode so message cannot be modified.
1311 notmuch_message_remove_tag (notmuch_message_t *message, const char *tag);
1314 * Remove all tags from the given message.
1316 * See notmuch_message_freeze for an example showing how to safely
1317 * replace tag values.
1319 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
1320 * mode so message cannot be modified.
1323 notmuch_message_remove_all_tags (notmuch_message_t *message);
1326 * Add/remove tags according to maildir flags in the message filename(s).
1328 * This function examines the filenames of 'message' for maildir
1329 * flags, and adds or removes tags on 'message' as follows when these
1330 * flags are present:
1332 * Flag Action if present
1333 * ---- -----------------
1334 * 'D' Adds the "draft" tag to the message
1335 * 'F' Adds the "flagged" tag to the message
1336 * 'P' Adds the "passed" tag to the message
1337 * 'R' Adds the "replied" tag to the message
1338 * 'S' Removes the "unread" tag from the message
1340 * For each flag that is not present, the opposite action (add/remove)
1341 * is performed for the corresponding tags.
1343 * Flags are identified as trailing components of the filename after a
1344 * sequence of ":2,".
1346 * If there are multiple filenames associated with this message, the
1347 * flag is considered present if it appears in one or more
1348 * filenames. (That is, the flags from the multiple filenames are
1349 * combined with the logical OR operator.)
1351 * A client can ensure that notmuch database tags remain synchronized
1352 * with maildir flags by calling this function after each call to
1353 * notmuch_database_add_message. See also
1354 * notmuch_message_tags_to_maildir_flags for synchronizing tag changes
1355 * back to maildir flags.
1358 notmuch_message_maildir_flags_to_tags (notmuch_message_t *message);
1361 * Rename message filename(s) to encode tags as maildir flags.
1363 * Specifically, for each filename corresponding to this message:
1365 * If the filename is not in a maildir directory, do nothing. (A
1366 * maildir directory is determined as a directory named "new" or
1367 * "cur".) Similarly, if the filename has invalid maildir info,
1368 * (repeated or outof-ASCII-order flag characters after ":2,"), then
1371 * If the filename is in a maildir directory, rename the file so that
1372 * its filename ends with the sequence ":2," followed by zero or more
1373 * of the following single-character flags (in ASCII order):
1375 * 'D' iff the message has the "draft" tag
1376 * 'F' iff the message has the "flagged" tag
1377 * 'P' iff the message has the "passed" tag
1378 * 'R' iff the message has the "replied" tag
1379 * 'S' iff the message does not have the "unread" tag
1381 * Any existing flags unmentioned in the list above will be preserved
1384 * Also, if this filename is in a directory named "new", rename it to
1385 * be within the neighboring directory named "cur".
1387 * A client can ensure that maildir filename flags remain synchronized
1388 * with notmuch database tags by calling this function after changing
1389 * tags, (after calls to notmuch_message_add_tag,
1390 * notmuch_message_remove_tag, or notmuch_message_freeze/
1391 * notmuch_message_thaw). See also notmuch_message_maildir_flags_to_tags
1392 * for synchronizing maildir flag changes back to tags.
1395 notmuch_message_tags_to_maildir_flags (notmuch_message_t *message);
1398 * Freeze the current state of 'message' within the database.
1400 * This means that changes to the message state, (via
1401 * notmuch_message_add_tag, notmuch_message_remove_tag, and
1402 * notmuch_message_remove_all_tags), will not be committed to the
1403 * database until the message is thawed with notmuch_message_thaw.
1405 * Multiple calls to freeze/thaw are valid and these calls will
1406 * "stack". That is there must be as many calls to thaw as to freeze
1407 * before a message is actually thawed.
1409 * The ability to do freeze/thaw allows for safe transactions to
1410 * change tag values. For example, explicitly setting a message to
1411 * have a given set of tags might look like this:
1413 * notmuch_message_freeze (message);
1415 * notmuch_message_remove_all_tags (message);
1417 * for (i = 0; i < NUM_TAGS; i++)
1418 * notmuch_message_add_tag (message, tags[i]);
1420 * notmuch_message_thaw (message);
1422 * With freeze/thaw used like this, the message in the database is
1423 * guaranteed to have either the full set of original tag values, or
1424 * the full set of new tag values, but nothing in between.
1426 * Imagine the example above without freeze/thaw and the operation
1427 * somehow getting interrupted. This could result in the message being
1428 * left with no tags if the interruption happened after
1429 * notmuch_message_remove_all_tags but before notmuch_message_add_tag.
1433 * NOTMUCH_STATUS_SUCCESS: Message successfully frozen.
1435 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
1436 * mode so message cannot be modified.
1439 notmuch_message_freeze (notmuch_message_t *message);
1442 * Thaw the current 'message', synchronizing any changes that may have
1443 * occurred while 'message' was frozen into the notmuch database.
1445 * See notmuch_message_freeze for an example of how to use this
1446 * function to safely provide tag changes.
1448 * Multiple calls to freeze/thaw are valid and these calls with
1449 * "stack". That is there must be as many calls to thaw as to freeze
1450 * before a message is actually thawed.
1454 * NOTMUCH_STATUS_SUCCESS: Message successfully thawed, (or at least
1455 * its frozen count has successfully been reduced by 1).
1457 * NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW: An attempt was made to thaw
1458 * an unfrozen message. That is, there have been an unbalanced
1459 * number of calls to notmuch_message_freeze and
1460 * notmuch_message_thaw.
1463 notmuch_message_thaw (notmuch_message_t *message);
1466 * Destroy a notmuch_message_t object.
1468 * It can be useful to call this function in the case of a single
1469 * query object with many messages in the result, (such as iterating
1470 * over the entire database). Otherwise, it's fine to never call this
1471 * function and there will still be no memory leaks. (The memory from
1472 * the messages get reclaimed when the containing query is destroyed.)
1475 notmuch_message_destroy (notmuch_message_t *message);
1478 * Is the given 'tags' iterator pointing at a valid tag.
1480 * When this function returns TRUE, notmuch_tags_get will return a
1481 * valid string. Whereas when this function returns FALSE,
1482 * notmuch_tags_get will return NULL.
1484 * See the documentation of notmuch_message_get_tags for example code
1485 * showing how to iterate over a notmuch_tags_t object.
1488 notmuch_tags_valid (notmuch_tags_t *tags);
1491 * Get the current tag from 'tags' as a string.
1493 * Note: The returned string belongs to 'tags' and has a lifetime
1494 * identical to it (and the query to which it ultimately belongs).
1496 * See the documentation of notmuch_message_get_tags for example code
1497 * showing how to iterate over a notmuch_tags_t object.
1500 notmuch_tags_get (notmuch_tags_t *tags);
1503 * Move the 'tags' iterator to the next tag.
1505 * If 'tags' is already pointing at the last tag then the iterator
1506 * will be moved to a point just beyond that last tag, (where
1507 * notmuch_tags_valid will return FALSE and notmuch_tags_get will
1510 * See the documentation of notmuch_message_get_tags for example code
1511 * showing how to iterate over a notmuch_tags_t object.
1514 notmuch_tags_move_to_next (notmuch_tags_t *tags);
1517 * Destroy a notmuch_tags_t object.
1519 * It's not strictly necessary to call this function. All memory from
1520 * the notmuch_tags_t object will be reclaimed when the containing
1521 * message or query objects are destroyed.
1524 notmuch_tags_destroy (notmuch_tags_t *tags);
1527 * Store an mtime within the database for 'directory'.
1529 * The 'directory' should be an object retrieved from the database
1530 * with notmuch_database_get_directory for a particular path.
1532 * The intention is for the caller to use the mtime to allow efficient
1533 * identification of new messages to be added to the database. The
1534 * recommended usage is as follows:
1536 * o Read the mtime of a directory from the filesystem
1538 * o Call add_message for all mail files in the directory
1540 * o Call notmuch_directory_set_mtime with the mtime read from the
1543 * Then, when wanting to check for updates to the directory in the
1544 * future, the client can call notmuch_directory_get_mtime and know
1545 * that it only needs to add files if the mtime of the directory and
1546 * files are newer than the stored timestamp.
1548 * Note: The notmuch_directory_get_mtime function does not allow the
1549 * caller to distinguish a timestamp of 0 from a non-existent
1550 * timestamp. So don't store a timestamp of 0 unless you are
1551 * comfortable with that.
1555 * NOTMUCH_STATUS_SUCCESS: mtime successfully stored in database.
1557 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception
1558 * occurred, mtime not stored.
1560 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
1561 * mode so directory mtime cannot be modified.
1564 notmuch_directory_set_mtime (notmuch_directory_t *directory,
1568 * Get the mtime of a directory, (as previously stored with
1569 * notmuch_directory_set_mtime).
1571 * Returns 0 if no mtime has previously been stored for this
1575 notmuch_directory_get_mtime (notmuch_directory_t *directory);
1578 * Get a notmuch_filenames_t iterator listing all the filenames of
1579 * messages in the database within the given directory.
1581 * The returned filenames will be the basename-entries only (not
1584 notmuch_filenames_t *
1585 notmuch_directory_get_child_files (notmuch_directory_t *directory);
1588 * Get a notmuch_filenams_t iterator listing all the filenames of
1589 * sub-directories in the database within the given directory.
1591 * The returned filenames will be the basename-entries only (not
1594 notmuch_filenames_t *
1595 notmuch_directory_get_child_directories (notmuch_directory_t *directory);
1598 * Destroy a notmuch_directory_t object.
1601 notmuch_directory_destroy (notmuch_directory_t *directory);
1604 * Is the given 'filenames' iterator pointing at a valid filename.
1606 * When this function returns TRUE, notmuch_filenames_get will return
1607 * a valid string. Whereas when this function returns FALSE,
1608 * notmuch_filenames_get will return NULL.
1610 * It is acceptable to pass NULL for 'filenames', in which case this
1611 * function will always return FALSE.
1614 notmuch_filenames_valid (notmuch_filenames_t *filenames);
1617 * Get the current filename from 'filenames' as a string.
1619 * Note: The returned string belongs to 'filenames' and has a lifetime
1620 * identical to it (and the directory to which it ultimately belongs).
1622 * It is acceptable to pass NULL for 'filenames', in which case this
1623 * function will always return NULL.
1626 notmuch_filenames_get (notmuch_filenames_t *filenames);
1629 * Move the 'filenames' iterator to the next filename.
1631 * If 'filenames' is already pointing at the last filename then the
1632 * iterator will be moved to a point just beyond that last filename,
1633 * (where notmuch_filenames_valid will return FALSE and
1634 * notmuch_filenames_get will return NULL).
1636 * It is acceptable to pass NULL for 'filenames', in which case this
1637 * function will do nothing.
1640 notmuch_filenames_move_to_next (notmuch_filenames_t *filenames);
1643 * Destroy a notmuch_filenames_t object.
1645 * It's not strictly necessary to call this function. All memory from
1646 * the notmuch_filenames_t object will be reclaimed when the
1647 * containing directory object is destroyed.
1649 * It is acceptable to pass NULL for 'filenames', in which case this
1650 * function will do nothing.
1653 notmuch_filenames_destroy (notmuch_filenames_t *filenames);