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 *message, void *closure);
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.
230 * If the optional callback function 'status_cb' is non-NULL, it will
231 * be called with diagnostic and informational messages. The argument
232 * 'closure' is passed verbatim to any callback invoked.
235 notmuch_database_compact (const char* path,
236 const char* backup_path,
237 notmuch_compact_status_cb_t status_cb,
240 /* Destroy the notmuch database, closing it if necessary and freeing
241 * all associated resources.
244 notmuch_database_destroy (notmuch_database_t *database);
246 /* Return the database path of the given database.
248 * The return value is a string owned by notmuch so should not be
249 * modified nor freed by the caller. */
251 notmuch_database_get_path (notmuch_database_t *database);
253 /* Return the database format version of the given database. */
255 notmuch_database_get_version (notmuch_database_t *database);
257 /* Does this database need to be upgraded before writing to it?
259 * If this function returns TRUE then no functions that modify the
260 * database (notmuch_database_add_message, notmuch_message_add_tag,
261 * notmuch_directory_set_mtime, etc.) will work unless the function
262 * notmuch_database_upgrade is called successfully first. */
264 notmuch_database_needs_upgrade (notmuch_database_t *database);
266 /* Upgrade the current database.
268 * After opening a database in read-write mode, the client should
269 * check if an upgrade is needed (notmuch_database_needs_upgrade) and
270 * if so, upgrade with this function before making any modifications.
272 * The optional progress_notify callback can be used by the caller to
273 * provide progress indication to the user. If non-NULL it will be
274 * called periodically with 'progress' as a floating-point value in
275 * the range of [0.0 .. 1.0] indicating the progress made so far in
276 * the upgrade process. The argument 'closure' is passed verbatim to
277 * any callback invoked.
280 notmuch_database_upgrade (notmuch_database_t *database,
281 void (*progress_notify) (void *closure,
285 /* Begin an atomic database operation.
287 * Any modifications performed between a successful begin and a
288 * notmuch_database_end_atomic will be applied to the database
289 * atomically. Note that, unlike a typical database transaction, this
290 * only ensures atomicity, not durability; neither begin nor end
291 * necessarily flush modifications to disk.
293 * Atomic sections may be nested. begin_atomic and end_atomic must
294 * always be called in pairs.
298 * NOTMUCH_STATUS_SUCCESS: Successfully entered atomic section.
300 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred;
301 * atomic section not entered.
304 notmuch_database_begin_atomic (notmuch_database_t *notmuch);
306 /* Indicate the end of an atomic database operation.
310 * NOTMUCH_STATUS_SUCCESS: Successfully completed atomic section.
312 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred;
313 * atomic section not ended.
315 * NOTMUCH_STATUS_UNBALANCED_ATOMIC: The database is not currently in
319 notmuch_database_end_atomic (notmuch_database_t *notmuch);
321 /* Retrieve a directory object from the database for 'path'.
323 * Here, 'path' should be a path relative to the path of 'database'
324 * (see notmuch_database_get_path), or else should be an absolute path
325 * with initial components that match the path of 'database'.
327 * If this directory object does not exist in the database, this
328 * returns NOTMUCH_STATUS_SUCCESS and sets *directory to NULL.
332 * NOTMUCH_STATUS_SUCCESS: Successfully retrieved directory.
334 * NOTMUCH_STATUS_NULL_POINTER: The given 'directory' argument is NULL.
336 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred;
337 * directory not retrieved.
340 notmuch_database_get_directory (notmuch_database_t *database,
342 notmuch_directory_t **directory);
344 /* Add a new message to the given notmuch database or associate an
345 * additional filename with an existing message.
347 * Here, 'filename' should be a path relative to the path of
348 * 'database' (see notmuch_database_get_path), or else should be an
349 * absolute filename with initial components that match the path of
352 * The file should be a single mail message (not a multi-message mbox)
353 * that is expected to remain at its current location, (since the
354 * notmuch database will reference the filename, and will not copy the
355 * entire contents of the file.
357 * If another message with the same message ID already exists in the
358 * database, rather than creating a new message, this adds 'filename'
359 * to the list of the filenames for the existing message.
361 * If 'message' is not NULL, then, on successful return
362 * (NOTMUCH_STATUS_SUCCESS or NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID) '*message'
363 * will be initialized to a message object that can be used for things
364 * such as adding tags to the just-added message. The user should call
365 * notmuch_message_destroy when done with the message. On any failure
366 * '*message' will be set to NULL.
370 * NOTMUCH_STATUS_SUCCESS: Message successfully added to database.
372 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred,
375 * NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID: Message has the same message
376 * ID as another message already in the database. The new
377 * filename was successfully added to the message in the database
378 * (if not already present) and the existing message is returned.
380 * NOTMUCH_STATUS_FILE_ERROR: an error occurred trying to open the
381 * file, (such as permission denied, or file not found,
382 * etc.). Nothing added to the database.
384 * NOTMUCH_STATUS_FILE_NOT_EMAIL: the contents of filename don't look
385 * like an email message. Nothing added to the database.
387 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
388 * mode so no message can be added.
391 notmuch_database_add_message (notmuch_database_t *database,
392 const char *filename,
393 notmuch_message_t **message);
395 /* Remove a message filename from the given notmuch database. If the
396 * message has no more filenames, remove the message.
398 * If the same message (as determined by the message ID) is still
399 * available via other filenames, then the message will persist in the
400 * database for those filenames. When the last filename is removed for
401 * a particular message, the database content for that message will be
406 * NOTMUCH_STATUS_SUCCESS: The last filename was removed and the
407 * message was removed from the database.
409 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred,
410 * message not removed.
412 * NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID: This filename was removed but
413 * the message persists in the database with at least one other
416 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
417 * mode so no message can be removed.
420 notmuch_database_remove_message (notmuch_database_t *database,
421 const char *filename);
423 /* Find a message with the given message_id.
425 * If a message with the given message_id is found then, on successful return
426 * (NOTMUCH_STATUS_SUCCESS) '*message' will be initialized to a message
427 * object. The caller should call notmuch_message_destroy when done with the
430 * On any failure or when the message is not found, this function initializes
431 * '*message' to NULL. This means, when NOTMUCH_STATUS_SUCCESS is returned, the
432 * caller is supposed to check '*message' for NULL to find out whether the
433 * message with the given message_id was found.
437 * NOTMUCH_STATUS_SUCCESS: Successful return, check '*message'.
439 * NOTMUCH_STATUS_NULL_POINTER: The given 'message' argument is NULL
441 * NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory, creating message object
443 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred
446 notmuch_database_find_message (notmuch_database_t *database,
447 const char *message_id,
448 notmuch_message_t **message);
450 /* Find a message with the given filename.
452 * If the database contains a message with the given filename then, on
453 * successful return (NOTMUCH_STATUS_SUCCESS) '*message' will be initialized to
454 * a message object. The caller should call notmuch_message_destroy when done
457 * On any failure or when the message is not found, this function initializes
458 * '*message' to NULL. This means, when NOTMUCH_STATUS_SUCCESS is returned, the
459 * caller is supposed to check '*message' for NULL to find out whether the
460 * message with the given filename is found.
464 * NOTMUCH_STATUS_SUCCESS: Successful return, check '*message'
466 * NOTMUCH_STATUS_NULL_POINTER: The given 'message' argument is NULL
468 * NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory, creating the message object
470 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred
473 notmuch_database_find_message_by_filename (notmuch_database_t *notmuch,
474 const char *filename,
475 notmuch_message_t **message);
477 /* Return a list of all tags found in the database.
479 * This function creates a list of all tags found in the database. The
480 * resulting list contains all tags from all messages found in the database.
482 * On error this function returns NULL.
485 notmuch_database_get_all_tags (notmuch_database_t *db);
487 /* Create a new query for 'database'.
489 * Here, 'database' should be an open database, (see
490 * notmuch_database_open and notmuch_database_create).
492 * For the query string, we'll document the syntax here more
493 * completely in the future, but it's likely to be a specialized
494 * version of the general Xapian query syntax:
496 * http://xapian.org/docs/queryparser.html
498 * As a special case, passing either a length-zero string, (that is ""),
499 * or a string consisting of a single asterisk (that is "*"), will
500 * result in a query that returns all messages in the database.
502 * See notmuch_query_set_sort for controlling the order of results.
503 * See notmuch_query_search_messages and notmuch_query_search_threads
504 * to actually execute the query.
506 * User should call notmuch_query_destroy when finished with this
509 * Will return NULL if insufficient memory is available.
512 notmuch_query_create (notmuch_database_t *database,
513 const char *query_string);
515 /* Sort values for notmuch_query_set_sort */
517 NOTMUCH_SORT_OLDEST_FIRST,
518 NOTMUCH_SORT_NEWEST_FIRST,
519 NOTMUCH_SORT_MESSAGE_ID,
520 NOTMUCH_SORT_UNSORTED
523 /* Return the query_string of this query. See notmuch_query_create. */
525 notmuch_query_get_query_string (notmuch_query_t *query);
527 /* Exclude values for notmuch_query_set_omit_excluded. The strange
528 * order is to maintain backward compatibility: the old FALSE/TRUE
529 * options correspond to the new
530 * NOTMUCH_EXCLUDE_FLAG/NOTMUCH_EXCLUDE_TRUE options.
533 NOTMUCH_EXCLUDE_FLAG,
534 NOTMUCH_EXCLUDE_TRUE,
535 NOTMUCH_EXCLUDE_FALSE,
539 /* Specify whether to omit excluded results or simply flag them. By
540 * default, this is set to TRUE.
542 * If set to TRUE or ALL, notmuch_query_search_messages will omit excluded
543 * messages from the results, and notmuch_query_search_threads will omit
544 * threads that match only in excluded messages. If set to TRUE,
545 * notmuch_query_search_threads will include all messages in threads that
546 * match in at least one non-excluded message. Otherwise, if set to ALL,
547 * notmuch_query_search_threads will omit excluded messages from all threads.
549 * If set to FALSE or FLAG then both notmuch_query_search_messages and
550 * notmuch_query_search_threads will return all matching
551 * messages/threads regardless of exclude status. If set to FLAG then
552 * the exclude flag will be set for any excluded message that is
553 * returned by notmuch_query_search_messages, and the thread counts
554 * for threads returned by notmuch_query_search_threads will be the
555 * number of non-excluded messages/matches. Otherwise, if set to
556 * FALSE, then the exclude status is completely ignored.
558 * The performance difference when calling
559 * notmuch_query_search_messages should be relatively small (and both
560 * should be very fast). However, in some cases,
561 * notmuch_query_search_threads is very much faster when omitting
562 * excluded messages as it does not need to construct the threads that
563 * only match in excluded messages.
566 notmuch_query_set_omit_excluded (notmuch_query_t *query,
567 notmuch_exclude_t omit_excluded);
569 /* Specify the sorting desired for this query. */
571 notmuch_query_set_sort (notmuch_query_t *query, notmuch_sort_t sort);
573 /* Return the sort specified for this query. See notmuch_query_set_sort. */
575 notmuch_query_get_sort (notmuch_query_t *query);
577 /* Add a tag that will be excluded from the query results by default.
578 * This exclusion will be overridden if this tag appears explicitly in
581 notmuch_query_add_tag_exclude (notmuch_query_t *query, const char *tag);
583 /* Execute a query for threads, returning a notmuch_threads_t object
584 * which can be used to iterate over the results. The returned threads
585 * object is owned by the query and as such, will only be valid until
586 * notmuch_query_destroy.
588 * Typical usage might be:
590 * notmuch_query_t *query;
591 * notmuch_threads_t *threads;
592 * notmuch_thread_t *thread;
594 * query = notmuch_query_create (database, query_string);
596 * for (threads = notmuch_query_search_threads (query);
597 * notmuch_threads_valid (threads);
598 * notmuch_threads_move_to_next (threads))
600 * thread = notmuch_threads_get (threads);
602 * notmuch_thread_destroy (thread);
605 * notmuch_query_destroy (query);
607 * Note: If you are finished with a thread before its containing
608 * query, you can call notmuch_thread_destroy to clean up some memory
609 * sooner (as in the above example). Otherwise, if your thread objects
610 * are long-lived, then you don't need to call notmuch_thread_destroy
611 * and all the memory will still be reclaimed when the query is
614 * Note that there's no explicit destructor needed for the
615 * notmuch_threads_t object. (For consistency, we do provide a
616 * notmuch_threads_destroy function, but there's no good reason
617 * to call it if the query is about to be destroyed).
619 * If a Xapian exception occurs this function will return NULL.
622 notmuch_query_search_threads (notmuch_query_t *query);
624 /* Execute a query for messages, returning a notmuch_messages_t object
625 * which can be used to iterate over the results. The returned
626 * messages object is owned by the query and as such, will only be
627 * valid until notmuch_query_destroy.
629 * Typical usage might be:
631 * notmuch_query_t *query;
632 * notmuch_messages_t *messages;
633 * notmuch_message_t *message;
635 * query = notmuch_query_create (database, query_string);
637 * for (messages = notmuch_query_search_messages (query);
638 * notmuch_messages_valid (messages);
639 * notmuch_messages_move_to_next (messages))
641 * message = notmuch_messages_get (messages);
643 * notmuch_message_destroy (message);
646 * notmuch_query_destroy (query);
648 * Note: If you are finished with a message before its containing
649 * query, you can call notmuch_message_destroy to clean up some memory
650 * sooner (as in the above example). Otherwise, if your message
651 * objects are long-lived, then you don't need to call
652 * notmuch_message_destroy and all the memory will still be reclaimed
653 * when the query is destroyed.
655 * Note that there's no explicit destructor needed for the
656 * notmuch_messages_t object. (For consistency, we do provide a
657 * notmuch_messages_destroy function, but there's no good
658 * reason to call it if the query is about to be destroyed).
660 * If a Xapian exception occurs this function will return NULL.
663 notmuch_query_search_messages (notmuch_query_t *query);
665 /* Destroy a notmuch_query_t along with any associated resources.
667 * This will in turn destroy any notmuch_threads_t and
668 * notmuch_messages_t objects generated by this query, (and in
669 * turn any notmuch_thread_t and notmuch_message_t objects generated
670 * from those results, etc.), if such objects haven't already been
674 notmuch_query_destroy (notmuch_query_t *query);
676 /* Is the given 'threads' iterator pointing at a valid thread.
678 * When this function returns TRUE, notmuch_threads_get will return a
679 * valid object. Whereas when this function returns FALSE,
680 * notmuch_threads_get will return NULL.
682 * See the documentation of notmuch_query_search_threads for example
683 * code showing how to iterate over a notmuch_threads_t object.
686 notmuch_threads_valid (notmuch_threads_t *threads);
688 /* Get the current thread from 'threads' as a notmuch_thread_t.
690 * Note: The returned thread belongs to 'threads' and has a lifetime
691 * identical to it (and the query to which it belongs).
693 * See the documentation of notmuch_query_search_threads for example
694 * code showing how to iterate over a notmuch_threads_t object.
696 * If an out-of-memory situation occurs, this function will return
700 notmuch_threads_get (notmuch_threads_t *threads);
702 /* Move the 'threads' iterator to the next thread.
704 * If 'threads' is already pointing at the last thread then the
705 * iterator will be moved to a point just beyond that last thread,
706 * (where notmuch_threads_valid will return FALSE and
707 * notmuch_threads_get will return NULL).
709 * See the documentation of notmuch_query_search_threads for example
710 * code showing how to iterate over a notmuch_threads_t object.
713 notmuch_threads_move_to_next (notmuch_threads_t *threads);
715 /* Destroy a notmuch_threads_t object.
717 * It's not strictly necessary to call this function. All memory from
718 * the notmuch_threads_t object will be reclaimed when the
719 * containing query object is destroyed.
722 notmuch_threads_destroy (notmuch_threads_t *threads);
724 /* Return an estimate of the number of messages matching a search
726 * This function performs a search and returns Xapian's best
727 * guess as to number of matching messages.
729 * If a Xapian exception occurs, this function may return 0 (after
730 * printing a message).
733 notmuch_query_count_messages (notmuch_query_t *query);
735 /* Return the number of threads matching a search.
737 * This function performs a search and returns the number of unique thread IDs
738 * in the matching messages. This is the same as number of threads matching a
741 * Note that this is a significantly heavier operation than
742 * notmuch_query_count_messages().
744 * If an error occurs, this function may return 0.
747 notmuch_query_count_threads (notmuch_query_t *query);
749 /* Get the thread ID of 'thread'.
751 * The returned string belongs to 'thread' and as such, should not be
752 * modified by the caller and will only be valid for as long as the
753 * thread is valid, (which is until notmuch_thread_destroy or until
754 * the query from which it derived is destroyed).
757 notmuch_thread_get_thread_id (notmuch_thread_t *thread);
759 /* Get the total number of messages in 'thread'.
761 * This count consists of all messages in the database belonging to
762 * this thread. Contrast with notmuch_thread_get_matched_messages() .
765 notmuch_thread_get_total_messages (notmuch_thread_t *thread);
767 /* Get a notmuch_messages_t iterator for the top-level messages in
768 * 'thread' in oldest-first order.
770 * This iterator will not necessarily iterate over all of the messages
771 * in the thread. It will only iterate over the messages in the thread
772 * which are not replies to other messages in the thread.
775 notmuch_thread_get_toplevel_messages (notmuch_thread_t *thread);
777 /* Get a notmuch_thread_t iterator for all messages in 'thread' in
778 * oldest-first order.
781 notmuch_thread_get_messages (notmuch_thread_t *thread);
783 /* Get the number of messages in 'thread' that matched the search.
785 * This count includes only the messages in this thread that were
786 * matched by the search from which the thread was created and were
787 * not excluded by any exclude tags passed in with the query (see
788 * notmuch_query_add_tag_exclude). Contrast with
789 * notmuch_thread_get_total_messages() .
792 notmuch_thread_get_matched_messages (notmuch_thread_t *thread);
794 /* Get the authors of 'thread' as a UTF-8 string.
796 * The returned string is a comma-separated list of the names of the
797 * authors of mail messages in the query results that belong to this
800 * The returned string belongs to 'thread' and as such, should not be
801 * modified by the caller and will only be valid for as long as the
802 * thread is valid, (which is until notmuch_thread_destroy or until
803 * the query from which it derived is destroyed).
806 notmuch_thread_get_authors (notmuch_thread_t *thread);
808 /* Get the subject of 'thread' as a UTF-8 string.
810 * The subject is taken from the first message (according to the query
811 * order---see notmuch_query_set_sort) in the query results that
812 * belongs to this thread.
814 * The returned string belongs to 'thread' and as such, should not be
815 * modified by the caller and will only be valid for as long as the
816 * thread is valid, (which is until notmuch_thread_destroy or until
817 * the query from which it derived is destroyed).
820 notmuch_thread_get_subject (notmuch_thread_t *thread);
822 /* Get the date of the oldest message in 'thread' as a time_t value.
825 notmuch_thread_get_oldest_date (notmuch_thread_t *thread);
827 /* Get the date of the newest message in 'thread' as a time_t value.
830 notmuch_thread_get_newest_date (notmuch_thread_t *thread);
832 /* Get the tags for 'thread', returning a notmuch_tags_t object which
833 * can be used to iterate over all tags.
835 * Note: In the Notmuch database, tags are stored on individual
836 * messages, not on threads. So the tags returned here will be all
837 * tags of the messages which matched the search and which belong to
840 * The tags object is owned by the thread and as such, will only be
841 * valid for as long as the thread is valid, (for example, until
842 * notmuch_thread_destroy or until the query from which it derived is
845 * Typical usage might be:
847 * notmuch_thread_t *thread;
848 * notmuch_tags_t *tags;
851 * thread = notmuch_threads_get (threads);
853 * for (tags = notmuch_thread_get_tags (thread);
854 * notmuch_tags_valid (tags);
855 * notmuch_result_move_to_next (tags))
857 * tag = notmuch_tags_get (tags);
861 * notmuch_thread_destroy (thread);
863 * Note that there's no explicit destructor needed for the
864 * notmuch_tags_t object. (For consistency, we do provide a
865 * notmuch_tags_destroy function, but there's no good reason to call
866 * it if the message is about to be destroyed).
869 notmuch_thread_get_tags (notmuch_thread_t *thread);
871 /* Destroy a notmuch_thread_t object. */
873 notmuch_thread_destroy (notmuch_thread_t *thread);
875 /* Is the given 'messages' iterator pointing at a valid message.
877 * When this function returns TRUE, notmuch_messages_get will return a
878 * valid object. Whereas when this function returns FALSE,
879 * notmuch_messages_get will return NULL.
881 * See the documentation of notmuch_query_search_messages for example
882 * code showing how to iterate over a notmuch_messages_t object.
885 notmuch_messages_valid (notmuch_messages_t *messages);
887 /* Get the current message from 'messages' as a notmuch_message_t.
889 * Note: The returned message belongs to 'messages' and has a lifetime
890 * identical to it (and the query to which it belongs).
892 * See the documentation of notmuch_query_search_messages for example
893 * code showing how to iterate over a notmuch_messages_t object.
895 * If an out-of-memory situation occurs, this function will return
899 notmuch_messages_get (notmuch_messages_t *messages);
901 /* Move the 'messages' iterator to the next message.
903 * If 'messages' is already pointing at the last message then the
904 * iterator will be moved to a point just beyond that last message,
905 * (where notmuch_messages_valid will return FALSE and
906 * notmuch_messages_get will return NULL).
908 * See the documentation of notmuch_query_search_messages for example
909 * code showing how to iterate over a notmuch_messages_t object.
912 notmuch_messages_move_to_next (notmuch_messages_t *messages);
914 /* Destroy a notmuch_messages_t object.
916 * It's not strictly necessary to call this function. All memory from
917 * the notmuch_messages_t object will be reclaimed when the containing
918 * query object is destroyed.
921 notmuch_messages_destroy (notmuch_messages_t *messages);
923 /* Return a list of tags from all messages.
925 * The resulting list is guaranteed not to contain duplicated tags.
927 * WARNING: You can no longer iterate over messages after calling this
928 * function, because the iterator will point at the end of the list.
929 * We do not have a function to reset the iterator yet and the only
930 * way how you can iterate over the list again is to recreate the
933 * The function returns NULL on error.
936 notmuch_messages_collect_tags (notmuch_messages_t *messages);
938 /* Get the message ID of 'message'.
940 * The returned string belongs to 'message' and as such, should not be
941 * modified by the caller and will only be valid for as long as the
942 * message is valid, (which is until the query from which it derived
945 * This function will not return NULL since Notmuch ensures that every
946 * message has a unique message ID, (Notmuch will generate an ID for a
947 * message if the original file does not contain one).
950 notmuch_message_get_message_id (notmuch_message_t *message);
952 /* Get the thread ID of 'message'.
954 * The returned string belongs to 'message' and as such, should not be
955 * modified by the caller and will only be valid for as long as the
956 * message is valid, (for example, until the user calls
957 * notmuch_message_destroy on 'message' or until a query from which it
958 * derived is destroyed).
960 * This function will not return NULL since Notmuch ensures that every
961 * message belongs to a single thread.
964 notmuch_message_get_thread_id (notmuch_message_t *message);
966 /* Get a notmuch_messages_t iterator for all of the replies to
969 * Note: This call only makes sense if 'message' was ultimately
970 * obtained from a notmuch_thread_t object, (such as by coming
971 * directly from the result of calling notmuch_thread_get_
972 * toplevel_messages or by any number of subsequent
973 * calls to notmuch_message_get_replies).
975 * If 'message' was obtained through some non-thread means, (such as
976 * by a call to notmuch_query_search_messages), then this function
979 * If there are no replies to 'message', this function will return
980 * NULL. (Note that notmuch_messages_valid will accept that NULL
981 * value as legitimate, and simply return FALSE for it.)
984 notmuch_message_get_replies (notmuch_message_t *message);
986 /* Get a filename for the email corresponding to 'message'.
988 * The returned filename is an absolute filename, (the initial
989 * component will match notmuch_database_get_path() ).
991 * The returned string belongs to the message so should not be
992 * modified or freed by the caller (nor should it be referenced after
993 * the message is destroyed).
995 * Note: If this message corresponds to multiple files in the mail
996 * store, (that is, multiple files contain identical message IDs),
997 * this function will arbitrarily return a single one of those
998 * filenames. See notmuch_message_get_filenames for returning the
999 * complete list of filenames.
1002 notmuch_message_get_filename (notmuch_message_t *message);
1004 /* Get all filenames for the email corresponding to 'message'.
1006 * Returns a notmuch_filenames_t iterator listing all the filenames
1007 * associated with 'message'. These files may not have identical
1008 * content, but each will have the identical Message-ID.
1010 * Each filename in the iterator is an absolute filename, (the initial
1011 * component will match notmuch_database_get_path() ).
1013 notmuch_filenames_t *
1014 notmuch_message_get_filenames (notmuch_message_t *message);
1017 typedef enum _notmuch_message_flag {
1018 NOTMUCH_MESSAGE_FLAG_MATCH,
1019 NOTMUCH_MESSAGE_FLAG_EXCLUDED
1020 } notmuch_message_flag_t;
1022 /* Get a value of a flag for the email corresponding to 'message'. */
1024 notmuch_message_get_flag (notmuch_message_t *message,
1025 notmuch_message_flag_t flag);
1027 /* Set a value of a flag for the email corresponding to 'message'. */
1029 notmuch_message_set_flag (notmuch_message_t *message,
1030 notmuch_message_flag_t flag, notmuch_bool_t value);
1032 /* Get the date of 'message' as a time_t value.
1034 * For the original textual representation of the Date header from the
1035 * message call notmuch_message_get_header() with a header value of
1038 notmuch_message_get_date (notmuch_message_t *message);
1040 /* Get the value of the specified header from 'message' as a UTF-8 string.
1042 * Common headers are stored in the database when the message is
1043 * indexed and will be returned from the database. Other headers will
1044 * be read from the actual message file.
1046 * The header name is case insensitive.
1048 * The returned string belongs to the message so should not be
1049 * modified or freed by the caller (nor should it be referenced after
1050 * the message is destroyed).
1052 * Returns an empty string ("") if the message does not contain a
1053 * header line matching 'header'. Returns NULL if any error occurs.
1056 notmuch_message_get_header (notmuch_message_t *message, const char *header);
1058 /* Get the tags for 'message', returning a notmuch_tags_t object which
1059 * can be used to iterate over all tags.
1061 * The tags object is owned by the message and as such, will only be
1062 * valid for as long as the message is valid, (which is until the
1063 * query from which it derived is destroyed).
1065 * Typical usage might be:
1067 * notmuch_message_t *message;
1068 * notmuch_tags_t *tags;
1071 * message = notmuch_database_find_message (database, message_id);
1073 * for (tags = notmuch_message_get_tags (message);
1074 * notmuch_tags_valid (tags);
1075 * notmuch_result_move_to_next (tags))
1077 * tag = notmuch_tags_get (tags);
1081 * notmuch_message_destroy (message);
1083 * Note that there's no explicit destructor needed for the
1084 * notmuch_tags_t object. (For consistency, we do provide a
1085 * notmuch_tags_destroy function, but there's no good reason to call
1086 * it if the message is about to be destroyed).
1089 notmuch_message_get_tags (notmuch_message_t *message);
1091 /* The longest possible tag value. */
1092 #define NOTMUCH_TAG_MAX 200
1094 /* Add a tag to the given message.
1098 * NOTMUCH_STATUS_SUCCESS: Tag successfully added to message
1100 * NOTMUCH_STATUS_NULL_POINTER: The 'tag' argument is NULL
1102 * NOTMUCH_STATUS_TAG_TOO_LONG: The length of 'tag' is too long
1103 * (exceeds NOTMUCH_TAG_MAX)
1105 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
1106 * mode so message cannot be modified.
1109 notmuch_message_add_tag (notmuch_message_t *message, const char *tag);
1111 /* Remove a tag from the given message.
1115 * NOTMUCH_STATUS_SUCCESS: Tag successfully removed from message
1117 * NOTMUCH_STATUS_NULL_POINTER: The 'tag' argument is NULL
1119 * NOTMUCH_STATUS_TAG_TOO_LONG: The length of 'tag' is too long
1120 * (exceeds NOTMUCH_TAG_MAX)
1122 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
1123 * mode so message cannot be modified.
1126 notmuch_message_remove_tag (notmuch_message_t *message, const char *tag);
1128 /* Remove all tags from the given message.
1130 * See notmuch_message_freeze for an example showing how to safely
1131 * replace tag values.
1133 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
1134 * mode so message cannot be modified.
1137 notmuch_message_remove_all_tags (notmuch_message_t *message);
1139 /* Add/remove tags according to maildir flags in the message filename(s)
1141 * This function examines the filenames of 'message' for maildir
1142 * flags, and adds or removes tags on 'message' as follows when these
1143 * flags are present:
1145 * Flag Action if present
1146 * ---- -----------------
1147 * 'D' Adds the "draft" tag to the message
1148 * 'F' Adds the "flagged" tag to the message
1149 * 'P' Adds the "passed" tag to the message
1150 * 'R' Adds the "replied" tag to the message
1151 * 'S' Removes the "unread" tag from the message
1153 * For each flag that is not present, the opposite action (add/remove)
1154 * is performed for the corresponding tags.
1156 * Flags are identified as trailing components of the filename after a
1157 * sequence of ":2,".
1159 * If there are multiple filenames associated with this message, the
1160 * flag is considered present if it appears in one or more
1161 * filenames. (That is, the flags from the multiple filenames are
1162 * combined with the logical OR operator.)
1164 * A client can ensure that notmuch database tags remain synchronized
1165 * with maildir flags by calling this function after each call to
1166 * notmuch_database_add_message. See also
1167 * notmuch_message_tags_to_maildir_flags for synchronizing tag changes
1168 * back to maildir flags.
1171 notmuch_message_maildir_flags_to_tags (notmuch_message_t *message);
1173 /* Rename message filename(s) to encode tags as maildir flags
1175 * Specifically, for each filename corresponding to this message:
1177 * If the filename is not in a maildir directory, do nothing. (A
1178 * maildir directory is determined as a directory named "new" or
1179 * "cur".) Similarly, if the filename has invalid maildir info,
1180 * (repeated or outof-ASCII-order flag characters after ":2,"), then
1183 * If the filename is in a maildir directory, rename the file so that
1184 * its filename ends with the sequence ":2," followed by zero or more
1185 * of the following single-character flags (in ASCII order):
1187 * 'D' iff the message has the "draft" tag
1188 * 'F' iff the message has the "flagged" tag
1189 * 'P' iff the message has the "passed" tag
1190 * 'R' iff the message has the "replied" tag
1191 * 'S' iff the message does not have the "unread" tag
1193 * Any existing flags unmentioned in the list above will be preserved
1196 * Also, if this filename is in a directory named "new", rename it to
1197 * be within the neighboring directory named "cur".
1199 * A client can ensure that maildir filename flags remain synchronized
1200 * with notmuch database tags by calling this function after changing
1201 * tags, (after calls to notmuch_message_add_tag,
1202 * notmuch_message_remove_tag, or notmuch_message_freeze/
1203 * notmuch_message_thaw). See also notmuch_message_maildir_flags_to_tags
1204 * for synchronizing maildir flag changes back to tags.
1207 notmuch_message_tags_to_maildir_flags (notmuch_message_t *message);
1209 /* Freeze the current state of 'message' within the database.
1211 * This means that changes to the message state, (via
1212 * notmuch_message_add_tag, notmuch_message_remove_tag, and
1213 * notmuch_message_remove_all_tags), will not be committed to the
1214 * database until the message is thawed with notmuch_message_thaw.
1216 * Multiple calls to freeze/thaw are valid and these calls will
1217 * "stack". That is there must be as many calls to thaw as to freeze
1218 * before a message is actually thawed.
1220 * The ability to do freeze/thaw allows for safe transactions to
1221 * change tag values. For example, explicitly setting a message to
1222 * have a given set of tags might look like this:
1224 * notmuch_message_freeze (message);
1226 * notmuch_message_remove_all_tags (message);
1228 * for (i = 0; i < NUM_TAGS; i++)
1229 * notmuch_message_add_tag (message, tags[i]);
1231 * notmuch_message_thaw (message);
1233 * With freeze/thaw used like this, the message in the database is
1234 * guaranteed to have either the full set of original tag values, or
1235 * the full set of new tag values, but nothing in between.
1237 * Imagine the example above without freeze/thaw and the operation
1238 * somehow getting interrupted. This could result in the message being
1239 * left with no tags if the interruption happened after
1240 * notmuch_message_remove_all_tags but before notmuch_message_add_tag.
1244 * NOTMUCH_STATUS_SUCCESS: Message successfully frozen.
1246 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
1247 * mode so message cannot be modified.
1250 notmuch_message_freeze (notmuch_message_t *message);
1252 /* Thaw the current 'message', synchronizing any changes that may have
1253 * occurred while 'message' was frozen into the notmuch database.
1255 * See notmuch_message_freeze for an example of how to use this
1256 * function to safely provide tag changes.
1258 * Multiple calls to freeze/thaw are valid and these calls with
1259 * "stack". That is there must be as many calls to thaw as to freeze
1260 * before a message is actually thawed.
1264 * NOTMUCH_STATUS_SUCCESS: Message successfully thawed, (or at least
1265 * its frozen count has successfully been reduced by 1).
1267 * NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW: An attempt was made to thaw
1268 * an unfrozen message. That is, there have been an unbalanced
1269 * number of calls to notmuch_message_freeze and
1270 * notmuch_message_thaw.
1273 notmuch_message_thaw (notmuch_message_t *message);
1275 /* Destroy a notmuch_message_t object.
1277 * It can be useful to call this function in the case of a single
1278 * query object with many messages in the result, (such as iterating
1279 * over the entire database). Otherwise, it's fine to never call this
1280 * function and there will still be no memory leaks. (The memory from
1281 * the messages get reclaimed when the containing query is destroyed.)
1284 notmuch_message_destroy (notmuch_message_t *message);
1286 /* Is the given 'tags' iterator pointing at a valid tag.
1288 * When this function returns TRUE, notmuch_tags_get will return a
1289 * valid string. Whereas when this function returns FALSE,
1290 * notmuch_tags_get will return NULL.
1292 * See the documentation of notmuch_message_get_tags for example code
1293 * showing how to iterate over a notmuch_tags_t object.
1296 notmuch_tags_valid (notmuch_tags_t *tags);
1298 /* Get the current tag from 'tags' as a string.
1300 * Note: The returned string belongs to 'tags' and has a lifetime
1301 * identical to it (and the query to which it ultimately belongs).
1303 * See the documentation of notmuch_message_get_tags for example code
1304 * showing how to iterate over a notmuch_tags_t object.
1307 notmuch_tags_get (notmuch_tags_t *tags);
1309 /* Move the 'tags' iterator to the next tag.
1311 * If 'tags' is already pointing at the last tag then the iterator
1312 * will be moved to a point just beyond that last tag, (where
1313 * notmuch_tags_valid will return FALSE and notmuch_tags_get will
1316 * See the documentation of notmuch_message_get_tags for example code
1317 * showing how to iterate over a notmuch_tags_t object.
1320 notmuch_tags_move_to_next (notmuch_tags_t *tags);
1322 /* Destroy a notmuch_tags_t object.
1324 * It's not strictly necessary to call this function. All memory from
1325 * the notmuch_tags_t object will be reclaimed when the containing
1326 * message or query objects are destroyed.
1329 notmuch_tags_destroy (notmuch_tags_t *tags);
1331 /* Store an mtime within the database for 'directory'.
1333 * The 'directory' should be an object retrieved from the database
1334 * with notmuch_database_get_directory for a particular path.
1336 * The intention is for the caller to use the mtime to allow efficient
1337 * identification of new messages to be added to the database. The
1338 * recommended usage is as follows:
1340 * o Read the mtime of a directory from the filesystem
1342 * o Call add_message for all mail files in the directory
1344 * o Call notmuch_directory_set_mtime with the mtime read from the
1347 * Then, when wanting to check for updates to the directory in the
1348 * future, the client can call notmuch_directory_get_mtime and know
1349 * that it only needs to add files if the mtime of the directory and
1350 * files are newer than the stored timestamp.
1352 * Note: The notmuch_directory_get_mtime function does not allow the
1353 * caller to distinguish a timestamp of 0 from a non-existent
1354 * timestamp. So don't store a timestamp of 0 unless you are
1355 * comfortable with that.
1359 * NOTMUCH_STATUS_SUCCESS: mtime successfully stored in database.
1361 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception
1362 * occurred, mtime not stored.
1364 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
1365 * mode so directory mtime cannot be modified.
1368 notmuch_directory_set_mtime (notmuch_directory_t *directory,
1371 /* Get the mtime of a directory, (as previously stored with
1372 * notmuch_directory_set_mtime).
1374 * Returns 0 if no mtime has previously been stored for this
1377 notmuch_directory_get_mtime (notmuch_directory_t *directory);
1379 /* Get a notmuch_filenames_t iterator listing all the filenames of
1380 * messages in the database within the given directory.
1382 * The returned filenames will be the basename-entries only (not
1383 * complete paths). */
1384 notmuch_filenames_t *
1385 notmuch_directory_get_child_files (notmuch_directory_t *directory);
1387 /* Get a notmuch_filenams_t iterator listing all the filenames of
1388 * sub-directories in the database within the given directory.
1390 * The returned filenames will be the basename-entries only (not
1391 * complete paths). */
1392 notmuch_filenames_t *
1393 notmuch_directory_get_child_directories (notmuch_directory_t *directory);
1395 /* Destroy a notmuch_directory_t object. */
1397 notmuch_directory_destroy (notmuch_directory_t *directory);
1399 /* Is the given 'filenames' iterator pointing at a valid filename.
1401 * When this function returns TRUE, notmuch_filenames_get will return
1402 * a valid string. Whereas when this function returns FALSE,
1403 * notmuch_filenames_get will return NULL.
1405 * It is acceptable to pass NULL for 'filenames', in which case this
1406 * function will always return FALSE.
1409 notmuch_filenames_valid (notmuch_filenames_t *filenames);
1411 /* Get the current filename from 'filenames' as a string.
1413 * Note: The returned string belongs to 'filenames' and has a lifetime
1414 * identical to it (and the directory to which it ultimately belongs).
1416 * It is acceptable to pass NULL for 'filenames', in which case this
1417 * function will always return NULL.
1420 notmuch_filenames_get (notmuch_filenames_t *filenames);
1422 /* Move the 'filenames' iterator to the next filename.
1424 * If 'filenames' is already pointing at the last filename then the
1425 * iterator will be moved to a point just beyond that last filename,
1426 * (where notmuch_filenames_valid will return FALSE and
1427 * notmuch_filenames_get will return NULL).
1429 * It is acceptable to pass NULL for 'filenames', in which case this
1430 * function will do nothing.
1433 notmuch_filenames_move_to_next (notmuch_filenames_t *filenames);
1435 /* Destroy a notmuch_filenames_t object.
1437 * It's not strictly necessary to call this function. All memory from
1438 * the notmuch_filenames_t object will be reclaimed when the
1439 * containing directory object is destroyed.
1441 * It is acceptable to pass NULL for 'filenames', in which case this
1442 * function will do nothing.
1445 notmuch_filenames_destroy (notmuch_filenames_t *filenames);