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 typedef int notmuch_bool_t;
46 /* Status codes used for the return values of most functions.
48 * A zero value (NOTMUCH_STATUS_SUCCESS) indicates that the function
49 * completed without error. Any other value indicates an error as
52 * NOTMUCH_STATUS_SUCCESS: No error occurred.
54 * NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory
56 * XXX: We don't really want to expose this lame XAPIAN_EXCEPTION
57 * value. Instead we should map to things like DATABASE_LOCKED or
60 * NOTMUCH_STATUS_READ_ONLY_DATABASE: An attempt was made to write to
61 * a database opened in read-only mode.
63 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred
65 * NOTMUCH_STATUS_FILE_ERROR: An error occurred trying to read or
66 * write to a file (this could be file not found, permission
69 * NOTMUCH_STATUS_FILE_NOT_EMAIL: A file was presented that doesn't
70 * appear to be an email message.
72 * NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID: A file contains a message ID
73 * that is identical to a message already in the database.
75 * NOTMUCH_STATUS_NULL_POINTER: The user erroneously passed a NULL
76 * pointer to a notmuch function.
78 * NOTMUCH_STATUS_TAG_TOO_LONG: A tag value is too long (exceeds
81 * NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW: The notmuch_message_thaw
82 * function has been called more times than notmuch_message_freeze.
84 * NOTMUCH_STATUS_UNBALANCED_ATOMIC: notmuch_database_end_atomic has
85 * been called more times than notmuch_database_begin_atomic.
89 * NOTMUCH_STATUS_LAST_STATUS: Not an actual status value. Just a way
90 * to find out how many valid status values there are.
92 typedef enum _notmuch_status {
93 NOTMUCH_STATUS_SUCCESS = 0,
94 NOTMUCH_STATUS_OUT_OF_MEMORY,
95 NOTMUCH_STATUS_READ_ONLY_DATABASE,
96 NOTMUCH_STATUS_XAPIAN_EXCEPTION,
97 NOTMUCH_STATUS_FILE_ERROR,
98 NOTMUCH_STATUS_FILE_NOT_EMAIL,
99 NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID,
100 NOTMUCH_STATUS_NULL_POINTER,
101 NOTMUCH_STATUS_TAG_TOO_LONG,
102 NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW,
103 NOTMUCH_STATUS_UNBALANCED_ATOMIC,
104 NOTMUCH_STATUS_UNSUPPORTED_OPERATION,
106 NOTMUCH_STATUS_LAST_STATUS
109 /* Get a string representation of a notmuch_status_t value.
111 * The result is read-only.
114 notmuch_status_to_string (notmuch_status_t status);
116 /* Various opaque data types. For each notmuch_<foo>_t see the various
117 * notmuch_<foo> functions below. */
118 typedef struct _notmuch_database notmuch_database_t;
119 typedef struct _notmuch_query notmuch_query_t;
120 typedef struct _notmuch_threads notmuch_threads_t;
121 typedef struct _notmuch_thread notmuch_thread_t;
122 typedef struct _notmuch_messages notmuch_messages_t;
123 typedef struct _notmuch_message notmuch_message_t;
124 typedef struct _notmuch_tags notmuch_tags_t;
125 typedef struct _notmuch_directory notmuch_directory_t;
126 typedef struct _notmuch_filenames notmuch_filenames_t;
128 /* Create a new, empty notmuch database located at 'path'.
130 * The path should be a top-level directory to a collection of
131 * plain-text email messages (one message per file). This call will
132 * create a new ".notmuch" directory within 'path' where notmuch will
135 * After a successful call to notmuch_database_create, the returned
136 * database will be open so the caller should call
137 * notmuch_database_destroy when finished with it.
139 * The database will not yet have any data in it
140 * (notmuch_database_create itself is a very cheap function). Messages
141 * contained within 'path' can be added to the database by calling
142 * notmuch_database_add_message.
144 * In case of any failure, this function returns an error status and
145 * sets *database to NULL (after printing an error message on stderr).
149 * NOTMUCH_STATUS_SUCCESS: Successfully created the database.
151 * NOTMUCH_STATUS_NULL_POINTER: The given 'path' argument is NULL.
153 * NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory.
155 * NOTMUCH_STATUS_FILE_ERROR: An error occurred trying to create the
156 * database file (such as permission denied, or file not found,
157 * etc.), or the database already exists.
159 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred.
162 notmuch_database_create (const char *path, notmuch_database_t **database);
165 NOTMUCH_DATABASE_MODE_READ_ONLY = 0,
166 NOTMUCH_DATABASE_MODE_READ_WRITE
167 } notmuch_database_mode_t;
169 /* Open an existing notmuch database located at 'path'.
171 * The database should have been created at some time in the past,
172 * (not necessarily by this process), by calling
173 * notmuch_database_create with 'path'. By default the database should be
174 * opened for reading only. In order to write to the database you need to
175 * pass the NOTMUCH_DATABASE_MODE_READ_WRITE mode.
177 * An existing notmuch database can be identified by the presence of a
178 * directory named ".notmuch" below 'path'.
180 * The caller should call notmuch_database_destroy when finished with
183 * In case of any failure, this function returns an error status and
184 * sets *database to NULL (after printing an error message on stderr).
188 * NOTMUCH_STATUS_SUCCESS: Successfully opened the database.
190 * NOTMUCH_STATUS_NULL_POINTER: The given 'path' argument is NULL.
192 * NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory.
194 * NOTMUCH_STATUS_FILE_ERROR: An error occurred trying to open the
195 * database file (such as permission denied, or file not found,
196 * etc.), or the database version is unknown.
198 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred.
201 notmuch_database_open (const char *path,
202 notmuch_database_mode_t mode,
203 notmuch_database_t **database);
205 /* Close the given notmuch database.
207 * After notmuch_database_close has been called, calls to other
208 * functions on objects derived from this database may either behave
209 * as if the database had not been closed (e.g., if the required data
210 * has been cached) or may fail with a
211 * NOTMUCH_STATUS_XAPIAN_EXCEPTION.
213 * notmuch_database_close can be called multiple times. Later calls
217 notmuch_database_close (notmuch_database_t *database);
219 /* A callback invoked by notmuch_database_compact to notify the user
220 * of the progress of the compaction process.
222 typedef void (*notmuch_compact_status_cb_t)(const char*);
224 /* Compact a notmuch database, backing up the original database to the
227 * The database will be opened with NOTMUCH_DATABASE_MODE_READ_WRITE
228 * during the compaction process to ensure no writes are made.
232 notmuch_database_compact (const char* path,
233 const char* backup_path,
234 notmuch_compact_status_cb_t status_cb);
236 /* Destroy the notmuch database, closing it if necessary and freeing
237 * all associated resources.
240 notmuch_database_destroy (notmuch_database_t *database);
242 /* Return the database path of the given database.
244 * The return value is a string owned by notmuch so should not be
245 * modified nor freed by the caller. */
247 notmuch_database_get_path (notmuch_database_t *database);
249 /* Return the database format version of the given database. */
251 notmuch_database_get_version (notmuch_database_t *database);
253 /* Does this database need to be upgraded before writing to it?
255 * If this function returns TRUE then no functions that modify the
256 * database (notmuch_database_add_message, notmuch_message_add_tag,
257 * notmuch_directory_set_mtime, etc.) will work unless the function
258 * notmuch_database_upgrade is called successfully first. */
260 notmuch_database_needs_upgrade (notmuch_database_t *database);
262 /* Upgrade the current database.
264 * After opening a database in read-write mode, the client should
265 * check if an upgrade is needed (notmuch_database_needs_upgrade) and
266 * if so, upgrade with this function before making any modifications.
268 * The optional progress_notify callback can be used by the caller to
269 * provide progress indication to the user. If non-NULL it will be
270 * called periodically with 'progress' as a floating-point value in
271 * the range of [0.0 .. 1.0] indicating the progress made so far in
272 * the upgrade process.
275 notmuch_database_upgrade (notmuch_database_t *database,
276 void (*progress_notify) (void *closure,
280 /* Begin an atomic database operation.
282 * Any modifications performed between a successful begin and a
283 * notmuch_database_end_atomic will be applied to the database
284 * atomically. Note that, unlike a typical database transaction, this
285 * only ensures atomicity, not durability; neither begin nor end
286 * necessarily flush modifications to disk.
288 * Atomic sections may be nested. begin_atomic and end_atomic must
289 * always be called in pairs.
293 * NOTMUCH_STATUS_SUCCESS: Successfully entered atomic section.
295 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred;
296 * atomic section not entered.
299 notmuch_database_begin_atomic (notmuch_database_t *notmuch);
301 /* Indicate the end of an atomic database operation.
305 * NOTMUCH_STATUS_SUCCESS: Successfully completed atomic section.
307 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred;
308 * atomic section not ended.
310 * NOTMUCH_STATUS_UNBALANCED_ATOMIC: The database is not currently in
314 notmuch_database_end_atomic (notmuch_database_t *notmuch);
316 /* Retrieve a directory object from the database for 'path'.
318 * Here, 'path' should be a path relative to the path of 'database'
319 * (see notmuch_database_get_path), or else should be an absolute path
320 * with initial components that match the path of 'database'.
322 * If this directory object does not exist in the database, this
323 * returns NOTMUCH_STATUS_SUCCESS and sets *directory to NULL.
327 * NOTMUCH_STATUS_SUCCESS: Successfully retrieved directory.
329 * NOTMUCH_STATUS_NULL_POINTER: The given 'directory' argument is NULL.
331 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred;
332 * directory not retrieved.
335 notmuch_database_get_directory (notmuch_database_t *database,
337 notmuch_directory_t **directory);
339 /* Add a new message to the given notmuch database or associate an
340 * additional filename with an existing message.
342 * Here, 'filename' should be a path relative to the path of
343 * 'database' (see notmuch_database_get_path), or else should be an
344 * absolute filename with initial components that match the path of
347 * The file should be a single mail message (not a multi-message mbox)
348 * that is expected to remain at its current location, (since the
349 * notmuch database will reference the filename, and will not copy the
350 * entire contents of the file.
352 * If another message with the same message ID already exists in the
353 * database, rather than creating a new message, this adds 'filename'
354 * to the list of the filenames for the existing message.
356 * If 'message' is not NULL, then, on successful return
357 * (NOTMUCH_STATUS_SUCCESS or NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID) '*message'
358 * will be initialized to a message object that can be used for things
359 * such as adding tags to the just-added message. The user should call
360 * notmuch_message_destroy when done with the message. On any failure
361 * '*message' will be set to NULL.
365 * NOTMUCH_STATUS_SUCCESS: Message successfully added to database.
367 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred,
370 * NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID: Message has the same message
371 * ID as another message already in the database. The new
372 * filename was successfully added to the message in the database
373 * (if not already present) and the existing message is returned.
375 * NOTMUCH_STATUS_FILE_ERROR: an error occurred trying to open the
376 * file, (such as permission denied, or file not found,
377 * etc.). Nothing added to the database.
379 * NOTMUCH_STATUS_FILE_NOT_EMAIL: the contents of filename don't look
380 * like an email message. Nothing added to the database.
382 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
383 * mode so no message can be added.
386 notmuch_database_add_message (notmuch_database_t *database,
387 const char *filename,
388 notmuch_message_t **message);
390 /* Remove a message filename from the given notmuch database. If the
391 * message has no more filenames, remove the message.
393 * If the same message (as determined by the message ID) is still
394 * available via other filenames, then the message will persist in the
395 * database for those filenames. When the last filename is removed for
396 * a particular message, the database content for that message will be
401 * NOTMUCH_STATUS_SUCCESS: The last filename was removed and the
402 * message was removed from the database.
404 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred,
405 * message not removed.
407 * NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID: This filename was removed but
408 * the message persists in the database with at least one other
411 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
412 * mode so no message can be removed.
415 notmuch_database_remove_message (notmuch_database_t *database,
416 const char *filename);
418 /* Find a message with the given message_id.
420 * If a message with the given message_id is found then, on successful return
421 * (NOTMUCH_STATUS_SUCCESS) '*message' will be initialized to a message
422 * object. The caller should call notmuch_message_destroy when done with the
425 * On any failure or when the message is not found, this function initializes
426 * '*message' to NULL. This means, when NOTMUCH_STATUS_SUCCESS is returned, the
427 * caller is supposed to check '*message' for NULL to find out whether the
428 * message with the given message_id was found.
432 * NOTMUCH_STATUS_SUCCESS: Successful return, check '*message'.
434 * NOTMUCH_STATUS_NULL_POINTER: The given 'message' argument is NULL
436 * NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory, creating message object
438 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred
441 notmuch_database_find_message (notmuch_database_t *database,
442 const char *message_id,
443 notmuch_message_t **message);
445 /* Find a message with the given filename.
447 * If the database contains a message with the given filename then, on
448 * successful return (NOTMUCH_STATUS_SUCCESS) '*message' will be initialized to
449 * a message object. The caller should call notmuch_message_destroy when done
452 * On any failure or when the message is not found, this function initializes
453 * '*message' to NULL. This means, when NOTMUCH_STATUS_SUCCESS is returned, the
454 * caller is supposed to check '*message' for NULL to find out whether the
455 * message with the given filename is found.
459 * NOTMUCH_STATUS_SUCCESS: Successful return, check '*message'
461 * NOTMUCH_STATUS_NULL_POINTER: The given 'message' argument is NULL
463 * NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory, creating the message object
465 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred
468 notmuch_database_find_message_by_filename (notmuch_database_t *notmuch,
469 const char *filename,
470 notmuch_message_t **message);
472 /* Return a list of all tags found in the database.
474 * This function creates a list of all tags found in the database. The
475 * resulting list contains all tags from all messages found in the database.
477 * On error this function returns NULL.
480 notmuch_database_get_all_tags (notmuch_database_t *db);
482 /* Create a new query for 'database'.
484 * Here, 'database' should be an open database, (see
485 * notmuch_database_open and notmuch_database_create).
487 * For the query string, we'll document the syntax here more
488 * completely in the future, but it's likely to be a specialized
489 * version of the general Xapian query syntax:
491 * http://xapian.org/docs/queryparser.html
493 * As a special case, passing either a length-zero string, (that is ""),
494 * or a string consisting of a single asterisk (that is "*"), will
495 * result in a query that returns all messages in the database.
497 * See notmuch_query_set_sort for controlling the order of results.
498 * See notmuch_query_search_messages and notmuch_query_search_threads
499 * to actually execute the query.
501 * User should call notmuch_query_destroy when finished with this
504 * Will return NULL if insufficient memory is available.
507 notmuch_query_create (notmuch_database_t *database,
508 const char *query_string);
510 /* Sort values for notmuch_query_set_sort */
512 NOTMUCH_SORT_OLDEST_FIRST,
513 NOTMUCH_SORT_NEWEST_FIRST,
514 NOTMUCH_SORT_MESSAGE_ID,
515 NOTMUCH_SORT_UNSORTED
518 /* Return the query_string of this query. See notmuch_query_create. */
520 notmuch_query_get_query_string (notmuch_query_t *query);
522 /* Exclude values for notmuch_query_set_omit_excluded. The strange
523 * order is to maintain backward compatibility: the old FALSE/TRUE
524 * options correspond to the new
525 * NOTMUCH_EXCLUDE_FLAG/NOTMUCH_EXCLUDE_TRUE options.
528 NOTMUCH_EXCLUDE_FLAG,
529 NOTMUCH_EXCLUDE_TRUE,
530 NOTMUCH_EXCLUDE_FALSE,
534 /* Specify whether to omit excluded results or simply flag them. By
535 * default, this is set to TRUE.
537 * If set to TRUE or ALL, notmuch_query_search_messages will omit excluded
538 * messages from the results, and notmuch_query_search_threads will omit
539 * threads that match only in excluded messages. If set to TRUE,
540 * notmuch_query_search_threads will include all messages in threads that
541 * match in at least one non-excluded message. Otherwise, if set to ALL,
542 * notmuch_query_search_threads will omit excluded messages from all threads.
544 * If set to FALSE or FLAG then both notmuch_query_search_messages and
545 * notmuch_query_search_threads will return all matching
546 * messages/threads regardless of exclude status. If set to FLAG then
547 * the exclude flag will be set for any excluded message that is
548 * returned by notmuch_query_search_messages, and the thread counts
549 * for threads returned by notmuch_query_search_threads will be the
550 * number of non-excluded messages/matches. Otherwise, if set to
551 * FALSE, then the exclude status is completely ignored.
553 * The performance difference when calling
554 * notmuch_query_search_messages should be relatively small (and both
555 * should be very fast). However, in some cases,
556 * notmuch_query_search_threads is very much faster when omitting
557 * excluded messages as it does not need to construct the threads that
558 * only match in excluded messages.
561 notmuch_query_set_omit_excluded (notmuch_query_t *query,
562 notmuch_exclude_t omit_excluded);
564 /* Specify the sorting desired for this query. */
566 notmuch_query_set_sort (notmuch_query_t *query, notmuch_sort_t sort);
568 /* Return the sort specified for this query. See notmuch_query_set_sort. */
570 notmuch_query_get_sort (notmuch_query_t *query);
572 /* Add a tag that will be excluded from the query results by default.
573 * This exclusion will be overridden if this tag appears explicitly in
576 notmuch_query_add_tag_exclude (notmuch_query_t *query, const char *tag);
578 /* Execute a query for threads, returning a notmuch_threads_t object
579 * which can be used to iterate over the results. The returned threads
580 * object is owned by the query and as such, will only be valid until
581 * notmuch_query_destroy.
583 * Typical usage might be:
585 * notmuch_query_t *query;
586 * notmuch_threads_t *threads;
587 * notmuch_thread_t *thread;
589 * query = notmuch_query_create (database, query_string);
591 * for (threads = notmuch_query_search_threads (query);
592 * notmuch_threads_valid (threads);
593 * notmuch_threads_move_to_next (threads))
595 * thread = notmuch_threads_get (threads);
597 * notmuch_thread_destroy (thread);
600 * notmuch_query_destroy (query);
602 * Note: If you are finished with a thread before its containing
603 * query, you can call notmuch_thread_destroy to clean up some memory
604 * sooner (as in the above example). Otherwise, if your thread objects
605 * are long-lived, then you don't need to call notmuch_thread_destroy
606 * and all the memory will still be reclaimed when the query is
609 * Note that there's no explicit destructor needed for the
610 * notmuch_threads_t object. (For consistency, we do provide a
611 * notmuch_threads_destroy function, but there's no good reason
612 * to call it if the query is about to be destroyed).
614 * If a Xapian exception occurs this function will return NULL.
617 notmuch_query_search_threads (notmuch_query_t *query);
619 /* Execute a query for messages, returning a notmuch_messages_t object
620 * which can be used to iterate over the results. The returned
621 * messages object is owned by the query and as such, will only be
622 * valid until notmuch_query_destroy.
624 * Typical usage might be:
626 * notmuch_query_t *query;
627 * notmuch_messages_t *messages;
628 * notmuch_message_t *message;
630 * query = notmuch_query_create (database, query_string);
632 * for (messages = notmuch_query_search_messages (query);
633 * notmuch_messages_valid (messages);
634 * notmuch_messages_move_to_next (messages))
636 * message = notmuch_messages_get (messages);
638 * notmuch_message_destroy (message);
641 * notmuch_query_destroy (query);
643 * Note: If you are finished with a message before its containing
644 * query, you can call notmuch_message_destroy to clean up some memory
645 * sooner (as in the above example). Otherwise, if your message
646 * objects are long-lived, then you don't need to call
647 * notmuch_message_destroy and all the memory will still be reclaimed
648 * when the query is destroyed.
650 * Note that there's no explicit destructor needed for the
651 * notmuch_messages_t object. (For consistency, we do provide a
652 * notmuch_messages_destroy function, but there's no good
653 * reason to call it if the query is about to be destroyed).
655 * If a Xapian exception occurs this function will return NULL.
658 notmuch_query_search_messages (notmuch_query_t *query);
660 /* Destroy a notmuch_query_t along with any associated resources.
662 * This will in turn destroy any notmuch_threads_t and
663 * notmuch_messages_t objects generated by this query, (and in
664 * turn any notmuch_thread_t and notmuch_message_t objects generated
665 * from those results, etc.), if such objects haven't already been
669 notmuch_query_destroy (notmuch_query_t *query);
671 /* Is the given 'threads' iterator pointing at a valid thread.
673 * When this function returns TRUE, notmuch_threads_get will return a
674 * valid object. Whereas when this function returns FALSE,
675 * notmuch_threads_get will return NULL.
677 * See the documentation of notmuch_query_search_threads for example
678 * code showing how to iterate over a notmuch_threads_t object.
681 notmuch_threads_valid (notmuch_threads_t *threads);
683 /* Get the current thread from 'threads' as a notmuch_thread_t.
685 * Note: The returned thread belongs to 'threads' and has a lifetime
686 * identical to it (and the query to which it belongs).
688 * See the documentation of notmuch_query_search_threads for example
689 * code showing how to iterate over a notmuch_threads_t object.
691 * If an out-of-memory situation occurs, this function will return
695 notmuch_threads_get (notmuch_threads_t *threads);
697 /* Move the 'threads' iterator to the next thread.
699 * If 'threads' is already pointing at the last thread then the
700 * iterator will be moved to a point just beyond that last thread,
701 * (where notmuch_threads_valid will return FALSE and
702 * notmuch_threads_get will return NULL).
704 * See the documentation of notmuch_query_search_threads for example
705 * code showing how to iterate over a notmuch_threads_t object.
708 notmuch_threads_move_to_next (notmuch_threads_t *threads);
710 /* Destroy a notmuch_threads_t object.
712 * It's not strictly necessary to call this function. All memory from
713 * the notmuch_threads_t object will be reclaimed when the
714 * containing query object is destroyed.
717 notmuch_threads_destroy (notmuch_threads_t *threads);
719 /* Return an estimate of the number of messages matching a search
721 * This function performs a search and returns Xapian's best
722 * guess as to number of matching messages.
724 * If a Xapian exception occurs, this function may return 0 (after
725 * printing a message).
728 notmuch_query_count_messages (notmuch_query_t *query);
730 /* Return the number of threads matching a search.
732 * This function performs a search and returns the number of unique thread IDs
733 * in the matching messages. This is the same as number of threads matching a
736 * Note that this is a significantly heavier operation than
737 * notmuch_query_count_messages().
739 * If an error occurs, this function may return 0.
742 notmuch_query_count_threads (notmuch_query_t *query);
744 /* Get the thread ID of 'thread'.
746 * The returned string belongs to 'thread' and as such, should not be
747 * modified by the caller and will only be valid for as long as the
748 * thread is valid, (which is until notmuch_thread_destroy or until
749 * the query from which it derived is destroyed).
752 notmuch_thread_get_thread_id (notmuch_thread_t *thread);
754 /* Get the total number of messages in 'thread'.
756 * This count consists of all messages in the database belonging to
757 * this thread. Contrast with notmuch_thread_get_matched_messages() .
760 notmuch_thread_get_total_messages (notmuch_thread_t *thread);
762 /* Get a notmuch_messages_t iterator for the top-level messages in
763 * 'thread' in oldest-first order.
765 * This iterator will not necessarily iterate over all of the messages
766 * in the thread. It will only iterate over the messages in the thread
767 * which are not replies to other messages in the thread.
770 notmuch_thread_get_toplevel_messages (notmuch_thread_t *thread);
772 /* Get a notmuch_thread_t iterator for all messages in 'thread' in
773 * oldest-first order.
776 notmuch_thread_get_messages (notmuch_thread_t *thread);
778 /* Get the number of messages in 'thread' that matched the search.
780 * This count includes only the messages in this thread that were
781 * matched by the search from which the thread was created and were
782 * not excluded by any exclude tags passed in with the query (see
783 * notmuch_query_add_tag_exclude). Contrast with
784 * notmuch_thread_get_total_messages() .
787 notmuch_thread_get_matched_messages (notmuch_thread_t *thread);
789 /* Get the authors of 'thread' as a UTF-8 string.
791 * The returned string is a comma-separated list of the names of the
792 * authors of mail messages in the query results that belong to this
795 * The returned string belongs to 'thread' and as such, should not be
796 * modified by the caller and will only be valid for as long as the
797 * thread is valid, (which is until notmuch_thread_destroy or until
798 * the query from which it derived is destroyed).
801 notmuch_thread_get_authors (notmuch_thread_t *thread);
803 /* Get the subject of 'thread' as a UTF-8 string.
805 * The subject is taken from the first message (according to the query
806 * order---see notmuch_query_set_sort) in the query results that
807 * belongs to this thread.
809 * The returned string belongs to 'thread' and as such, should not be
810 * modified by the caller and will only be valid for as long as the
811 * thread is valid, (which is until notmuch_thread_destroy or until
812 * the query from which it derived is destroyed).
815 notmuch_thread_get_subject (notmuch_thread_t *thread);
817 /* Get the date of the oldest message in 'thread' as a time_t value.
820 notmuch_thread_get_oldest_date (notmuch_thread_t *thread);
822 /* Get the date of the newest message in 'thread' as a time_t value.
825 notmuch_thread_get_newest_date (notmuch_thread_t *thread);
827 /* Get the tags for 'thread', returning a notmuch_tags_t object which
828 * can be used to iterate over all tags.
830 * Note: In the Notmuch database, tags are stored on individual
831 * messages, not on threads. So the tags returned here will be all
832 * tags of the messages which matched the search and which belong to
835 * The tags object is owned by the thread and as such, will only be
836 * valid for as long as the thread is valid, (for example, until
837 * notmuch_thread_destroy or until the query from which it derived is
840 * Typical usage might be:
842 * notmuch_thread_t *thread;
843 * notmuch_tags_t *tags;
846 * thread = notmuch_threads_get (threads);
848 * for (tags = notmuch_thread_get_tags (thread);
849 * notmuch_tags_valid (tags);
850 * notmuch_result_move_to_next (tags))
852 * tag = notmuch_tags_get (tags);
856 * notmuch_thread_destroy (thread);
858 * Note that there's no explicit destructor needed for the
859 * notmuch_tags_t object. (For consistency, we do provide a
860 * notmuch_tags_destroy function, but there's no good reason to call
861 * it if the message is about to be destroyed).
864 notmuch_thread_get_tags (notmuch_thread_t *thread);
866 /* Destroy a notmuch_thread_t object. */
868 notmuch_thread_destroy (notmuch_thread_t *thread);
870 /* Is the given 'messages' iterator pointing at a valid message.
872 * When this function returns TRUE, notmuch_messages_get will return a
873 * valid object. Whereas when this function returns FALSE,
874 * notmuch_messages_get will return NULL.
876 * See the documentation of notmuch_query_search_messages for example
877 * code showing how to iterate over a notmuch_messages_t object.
880 notmuch_messages_valid (notmuch_messages_t *messages);
882 /* Get the current message from 'messages' as a notmuch_message_t.
884 * Note: The returned message belongs to 'messages' and has a lifetime
885 * identical to it (and the query to which it belongs).
887 * See the documentation of notmuch_query_search_messages for example
888 * code showing how to iterate over a notmuch_messages_t object.
890 * If an out-of-memory situation occurs, this function will return
894 notmuch_messages_get (notmuch_messages_t *messages);
896 /* Move the 'messages' iterator to the next message.
898 * If 'messages' is already pointing at the last message then the
899 * iterator will be moved to a point just beyond that last message,
900 * (where notmuch_messages_valid will return FALSE and
901 * notmuch_messages_get will return NULL).
903 * See the documentation of notmuch_query_search_messages for example
904 * code showing how to iterate over a notmuch_messages_t object.
907 notmuch_messages_move_to_next (notmuch_messages_t *messages);
909 /* Destroy a notmuch_messages_t object.
911 * It's not strictly necessary to call this function. All memory from
912 * the notmuch_messages_t object will be reclaimed when the containing
913 * query object is destroyed.
916 notmuch_messages_destroy (notmuch_messages_t *messages);
918 /* Return a list of tags from all messages.
920 * The resulting list is guaranteed not to contain duplicated tags.
922 * WARNING: You can no longer iterate over messages after calling this
923 * function, because the iterator will point at the end of the list.
924 * We do not have a function to reset the iterator yet and the only
925 * way how you can iterate over the list again is to recreate the
928 * The function returns NULL on error.
931 notmuch_messages_collect_tags (notmuch_messages_t *messages);
933 /* Get the message ID of 'message'.
935 * The returned string belongs to 'message' and as such, should not be
936 * modified by the caller and will only be valid for as long as the
937 * message is valid, (which is until the query from which it derived
940 * This function will not return NULL since Notmuch ensures that every
941 * message has a unique message ID, (Notmuch will generate an ID for a
942 * message if the original file does not contain one).
945 notmuch_message_get_message_id (notmuch_message_t *message);
947 /* Get the thread ID of 'message'.
949 * The returned string belongs to 'message' and as such, should not be
950 * modified by the caller and will only be valid for as long as the
951 * message is valid, (for example, until the user calls
952 * notmuch_message_destroy on 'message' or until a query from which it
953 * derived is destroyed).
955 * This function will not return NULL since Notmuch ensures that every
956 * message belongs to a single thread.
959 notmuch_message_get_thread_id (notmuch_message_t *message);
961 /* Get a notmuch_messages_t iterator for all of the replies to
964 * Note: This call only makes sense if 'message' was ultimately
965 * obtained from a notmuch_thread_t object, (such as by coming
966 * directly from the result of calling notmuch_thread_get_
967 * toplevel_messages or by any number of subsequent
968 * calls to notmuch_message_get_replies).
970 * If 'message' was obtained through some non-thread means, (such as
971 * by a call to notmuch_query_search_messages), then this function
974 * If there are no replies to 'message', this function will return
975 * NULL. (Note that notmuch_messages_valid will accept that NULL
976 * value as legitimate, and simply return FALSE for it.)
979 notmuch_message_get_replies (notmuch_message_t *message);
981 /* Get a filename for the email corresponding to 'message'.
983 * The returned filename is an absolute filename, (the initial
984 * component will match notmuch_database_get_path() ).
986 * The returned string belongs to the message so should not be
987 * modified or freed by the caller (nor should it be referenced after
988 * the message is destroyed).
990 * Note: If this message corresponds to multiple files in the mail
991 * store, (that is, multiple files contain identical message IDs),
992 * this function will arbitrarily return a single one of those
993 * filenames. See notmuch_message_get_filenames for returning the
994 * complete list of filenames.
997 notmuch_message_get_filename (notmuch_message_t *message);
999 /* Get all filenames for the email corresponding to 'message'.
1001 * Returns a notmuch_filenames_t iterator listing all the filenames
1002 * associated with 'message'. These files may not have identical
1003 * content, but each will have the identical Message-ID.
1005 * Each filename in the iterator is an absolute filename, (the initial
1006 * component will match notmuch_database_get_path() ).
1008 notmuch_filenames_t *
1009 notmuch_message_get_filenames (notmuch_message_t *message);
1012 typedef enum _notmuch_message_flag {
1013 NOTMUCH_MESSAGE_FLAG_MATCH,
1014 NOTMUCH_MESSAGE_FLAG_EXCLUDED
1015 } notmuch_message_flag_t;
1017 /* Get a value of a flag for the email corresponding to 'message'. */
1019 notmuch_message_get_flag (notmuch_message_t *message,
1020 notmuch_message_flag_t flag);
1022 /* Set a value of a flag for the email corresponding to 'message'. */
1024 notmuch_message_set_flag (notmuch_message_t *message,
1025 notmuch_message_flag_t flag, notmuch_bool_t value);
1027 /* Get the date of 'message' as a time_t value.
1029 * For the original textual representation of the Date header from the
1030 * message call notmuch_message_get_header() with a header value of
1033 notmuch_message_get_date (notmuch_message_t *message);
1035 /* Get the value of the specified header from 'message' as a UTF-8 string.
1037 * Common headers are stored in the database when the message is
1038 * indexed and will be returned from the database. Other headers will
1039 * be read from the actual message file.
1041 * The header name is case insensitive.
1043 * The returned string belongs to the message so should not be
1044 * modified or freed by the caller (nor should it be referenced after
1045 * the message is destroyed).
1047 * Returns an empty string ("") if the message does not contain a
1048 * header line matching 'header'. Returns NULL if any error occurs.
1051 notmuch_message_get_header (notmuch_message_t *message, const char *header);
1053 /* Get the tags for 'message', returning a notmuch_tags_t object which
1054 * can be used to iterate over all tags.
1056 * The tags object is owned by the message and as such, will only be
1057 * valid for as long as the message is valid, (which is until the
1058 * query from which it derived is destroyed).
1060 * Typical usage might be:
1062 * notmuch_message_t *message;
1063 * notmuch_tags_t *tags;
1066 * message = notmuch_database_find_message (database, message_id);
1068 * for (tags = notmuch_message_get_tags (message);
1069 * notmuch_tags_valid (tags);
1070 * notmuch_result_move_to_next (tags))
1072 * tag = notmuch_tags_get (tags);
1076 * notmuch_message_destroy (message);
1078 * Note that there's no explicit destructor needed for the
1079 * notmuch_tags_t object. (For consistency, we do provide a
1080 * notmuch_tags_destroy function, but there's no good reason to call
1081 * it if the message is about to be destroyed).
1084 notmuch_message_get_tags (notmuch_message_t *message);
1086 /* The longest possible tag value. */
1087 #define NOTMUCH_TAG_MAX 200
1089 /* Add a tag to the given message.
1093 * NOTMUCH_STATUS_SUCCESS: Tag successfully added to message
1095 * NOTMUCH_STATUS_NULL_POINTER: The 'tag' argument is NULL
1097 * NOTMUCH_STATUS_TAG_TOO_LONG: The length of 'tag' is too long
1098 * (exceeds NOTMUCH_TAG_MAX)
1100 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
1101 * mode so message cannot be modified.
1104 notmuch_message_add_tag (notmuch_message_t *message, const char *tag);
1106 /* Remove a tag from the given message.
1110 * NOTMUCH_STATUS_SUCCESS: Tag successfully removed from message
1112 * NOTMUCH_STATUS_NULL_POINTER: The 'tag' argument is NULL
1114 * NOTMUCH_STATUS_TAG_TOO_LONG: The length of 'tag' is too long
1115 * (exceeds NOTMUCH_TAG_MAX)
1117 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
1118 * mode so message cannot be modified.
1121 notmuch_message_remove_tag (notmuch_message_t *message, const char *tag);
1123 /* Remove all tags from the given message.
1125 * See notmuch_message_freeze for an example showing how to safely
1126 * replace tag values.
1128 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
1129 * mode so message cannot be modified.
1132 notmuch_message_remove_all_tags (notmuch_message_t *message);
1134 /* Add/remove tags according to maildir flags in the message filename(s)
1136 * This function examines the filenames of 'message' for maildir
1137 * flags, and adds or removes tags on 'message' as follows when these
1138 * flags are present:
1140 * Flag Action if present
1141 * ---- -----------------
1142 * 'D' Adds the "draft" tag to the message
1143 * 'F' Adds the "flagged" tag to the message
1144 * 'P' Adds the "passed" tag to the message
1145 * 'R' Adds the "replied" tag to the message
1146 * 'S' Removes the "unread" tag from the message
1148 * For each flag that is not present, the opposite action (add/remove)
1149 * is performed for the corresponding tags.
1151 * Flags are identified as trailing components of the filename after a
1152 * sequence of ":2,".
1154 * If there are multiple filenames associated with this message, the
1155 * flag is considered present if it appears in one or more
1156 * filenames. (That is, the flags from the multiple filenames are
1157 * combined with the logical OR operator.)
1159 * A client can ensure that notmuch database tags remain synchronized
1160 * with maildir flags by calling this function after each call to
1161 * notmuch_database_add_message. See also
1162 * notmuch_message_tags_to_maildir_flags for synchronizing tag changes
1163 * back to maildir flags.
1166 notmuch_message_maildir_flags_to_tags (notmuch_message_t *message);
1168 /* Rename message filename(s) to encode tags as maildir flags
1170 * Specifically, for each filename corresponding to this message:
1172 * If the filename is not in a maildir directory, do nothing. (A
1173 * maildir directory is determined as a directory named "new" or
1174 * "cur".) Similarly, if the filename has invalid maildir info,
1175 * (repeated or outof-ASCII-order flag characters after ":2,"), then
1178 * If the filename is in a maildir directory, rename the file so that
1179 * its filename ends with the sequence ":2," followed by zero or more
1180 * of the following single-character flags (in ASCII order):
1182 * 'D' iff the message has the "draft" tag
1183 * 'F' iff the message has the "flagged" tag
1184 * 'P' iff the message has the "passed" tag
1185 * 'R' iff the message has the "replied" tag
1186 * 'S' iff the message does not have the "unread" tag
1188 * Any existing flags unmentioned in the list above will be preserved
1191 * Also, if this filename is in a directory named "new", rename it to
1192 * be within the neighboring directory named "cur".
1194 * A client can ensure that maildir filename flags remain synchronized
1195 * with notmuch database tags by calling this function after changing
1196 * tags, (after calls to notmuch_message_add_tag,
1197 * notmuch_message_remove_tag, or notmuch_message_freeze/
1198 * notmuch_message_thaw). See also notmuch_message_maildir_flags_to_tags
1199 * for synchronizing maildir flag changes back to tags.
1202 notmuch_message_tags_to_maildir_flags (notmuch_message_t *message);
1204 /* Freeze the current state of 'message' within the database.
1206 * This means that changes to the message state, (via
1207 * notmuch_message_add_tag, notmuch_message_remove_tag, and
1208 * notmuch_message_remove_all_tags), will not be committed to the
1209 * database until the message is thawed with notmuch_message_thaw.
1211 * Multiple calls to freeze/thaw are valid and these calls will
1212 * "stack". That is there must be as many calls to thaw as to freeze
1213 * before a message is actually thawed.
1215 * The ability to do freeze/thaw allows for safe transactions to
1216 * change tag values. For example, explicitly setting a message to
1217 * have a given set of tags might look like this:
1219 * notmuch_message_freeze (message);
1221 * notmuch_message_remove_all_tags (message);
1223 * for (i = 0; i < NUM_TAGS; i++)
1224 * notmuch_message_add_tag (message, tags[i]);
1226 * notmuch_message_thaw (message);
1228 * With freeze/thaw used like this, the message in the database is
1229 * guaranteed to have either the full set of original tag values, or
1230 * the full set of new tag values, but nothing in between.
1232 * Imagine the example above without freeze/thaw and the operation
1233 * somehow getting interrupted. This could result in the message being
1234 * left with no tags if the interruption happened after
1235 * notmuch_message_remove_all_tags but before notmuch_message_add_tag.
1239 * NOTMUCH_STATUS_SUCCESS: Message successfully frozen.
1241 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
1242 * mode so message cannot be modified.
1245 notmuch_message_freeze (notmuch_message_t *message);
1247 /* Thaw the current 'message', synchronizing any changes that may have
1248 * occurred while 'message' was frozen into the notmuch database.
1250 * See notmuch_message_freeze for an example of how to use this
1251 * function to safely provide tag changes.
1253 * Multiple calls to freeze/thaw are valid and these calls with
1254 * "stack". That is there must be as many calls to thaw as to freeze
1255 * before a message is actually thawed.
1259 * NOTMUCH_STATUS_SUCCESS: Message successfully thawed, (or at least
1260 * its frozen count has successfully been reduced by 1).
1262 * NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW: An attempt was made to thaw
1263 * an unfrozen message. That is, there have been an unbalanced
1264 * number of calls to notmuch_message_freeze and
1265 * notmuch_message_thaw.
1268 notmuch_message_thaw (notmuch_message_t *message);
1270 /* Destroy a notmuch_message_t object.
1272 * It can be useful to call this function in the case of a single
1273 * query object with many messages in the result, (such as iterating
1274 * over the entire database). Otherwise, it's fine to never call this
1275 * function and there will still be no memory leaks. (The memory from
1276 * the messages get reclaimed when the containing query is destroyed.)
1279 notmuch_message_destroy (notmuch_message_t *message);
1281 /* Is the given 'tags' iterator pointing at a valid tag.
1283 * When this function returns TRUE, notmuch_tags_get will return a
1284 * valid string. Whereas when this function returns FALSE,
1285 * notmuch_tags_get will return NULL.
1287 * See the documentation of notmuch_message_get_tags for example code
1288 * showing how to iterate over a notmuch_tags_t object.
1291 notmuch_tags_valid (notmuch_tags_t *tags);
1293 /* Get the current tag from 'tags' as a string.
1295 * Note: The returned string belongs to 'tags' and has a lifetime
1296 * identical to it (and the query to which it ultimately belongs).
1298 * See the documentation of notmuch_message_get_tags for example code
1299 * showing how to iterate over a notmuch_tags_t object.
1302 notmuch_tags_get (notmuch_tags_t *tags);
1304 /* Move the 'tags' iterator to the next tag.
1306 * If 'tags' is already pointing at the last tag then the iterator
1307 * will be moved to a point just beyond that last tag, (where
1308 * notmuch_tags_valid will return FALSE and notmuch_tags_get will
1311 * See the documentation of notmuch_message_get_tags for example code
1312 * showing how to iterate over a notmuch_tags_t object.
1315 notmuch_tags_move_to_next (notmuch_tags_t *tags);
1317 /* Destroy a notmuch_tags_t object.
1319 * It's not strictly necessary to call this function. All memory from
1320 * the notmuch_tags_t object will be reclaimed when the containing
1321 * message or query objects are destroyed.
1324 notmuch_tags_destroy (notmuch_tags_t *tags);
1326 /* Store an mtime within the database for 'directory'.
1328 * The 'directory' should be an object retrieved from the database
1329 * with notmuch_database_get_directory for a particular path.
1331 * The intention is for the caller to use the mtime to allow efficient
1332 * identification of new messages to be added to the database. The
1333 * recommended usage is as follows:
1335 * o Read the mtime of a directory from the filesystem
1337 * o Call add_message for all mail files in the directory
1339 * o Call notmuch_directory_set_mtime with the mtime read from the
1342 * Then, when wanting to check for updates to the directory in the
1343 * future, the client can call notmuch_directory_get_mtime and know
1344 * that it only needs to add files if the mtime of the directory and
1345 * files are newer than the stored timestamp.
1347 * Note: The notmuch_directory_get_mtime function does not allow the
1348 * caller to distinguish a timestamp of 0 from a non-existent
1349 * timestamp. So don't store a timestamp of 0 unless you are
1350 * comfortable with that.
1354 * NOTMUCH_STATUS_SUCCESS: mtime successfully stored in database.
1356 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception
1357 * occurred, mtime not stored.
1359 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
1360 * mode so directory mtime cannot be modified.
1363 notmuch_directory_set_mtime (notmuch_directory_t *directory,
1366 /* Get the mtime of a directory, (as previously stored with
1367 * notmuch_directory_set_mtime).
1369 * Returns 0 if no mtime has previously been stored for this
1372 notmuch_directory_get_mtime (notmuch_directory_t *directory);
1374 /* Get a notmuch_filenames_t iterator listing all the filenames of
1375 * messages in the database within the given directory.
1377 * The returned filenames will be the basename-entries only (not
1378 * complete paths). */
1379 notmuch_filenames_t *
1380 notmuch_directory_get_child_files (notmuch_directory_t *directory);
1382 /* Get a notmuch_filenams_t iterator listing all the filenames of
1383 * sub-directories in the database within the given directory.
1385 * The returned filenames will be the basename-entries only (not
1386 * complete paths). */
1387 notmuch_filenames_t *
1388 notmuch_directory_get_child_directories (notmuch_directory_t *directory);
1390 /* Destroy a notmuch_directory_t object. */
1392 notmuch_directory_destroy (notmuch_directory_t *directory);
1394 /* Is the given 'filenames' iterator pointing at a valid filename.
1396 * When this function returns TRUE, notmuch_filenames_get will return
1397 * a valid string. Whereas when this function returns FALSE,
1398 * notmuch_filenames_get will return NULL.
1400 * It is acceptable to pass NULL for 'filenames', in which case this
1401 * function will always return FALSE.
1404 notmuch_filenames_valid (notmuch_filenames_t *filenames);
1406 /* Get the current filename from 'filenames' as a string.
1408 * Note: The returned string belongs to 'filenames' and has a lifetime
1409 * identical to it (and the directory to which it ultimately belongs).
1411 * It is acceptable to pass NULL for 'filenames', in which case this
1412 * function will always return NULL.
1415 notmuch_filenames_get (notmuch_filenames_t *filenames);
1417 /* Move the 'filenames' iterator to the next filename.
1419 * If 'filenames' is already pointing at the last filename then the
1420 * iterator will be moved to a point just beyond that last filename,
1421 * (where notmuch_filenames_valid will return FALSE and
1422 * notmuch_filenames_get will return NULL).
1424 * It is acceptable to pass NULL for 'filenames', in which case this
1425 * function will do nothing.
1428 notmuch_filenames_move_to_next (notmuch_filenames_t *filenames);
1430 /* Destroy a notmuch_filenames_t object.
1432 * It's not strictly necessary to call this function. All memory from
1433 * the notmuch_filenames_t object will be reclaimed when the
1434 * containing directory object is destroyed.
1436 * It is acceptable to pass NULL for 'filenames', in which case this
1437 * function will do nothing.
1440 notmuch_filenames_destroy (notmuch_filenames_t *filenames);