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,
105 NOTMUCH_STATUS_LAST_STATUS
108 /* Get a string representation of a notmuch_status_t value.
110 * The result is read-only.
113 notmuch_status_to_string (notmuch_status_t status);
115 /* Various opaque data types. For each notmuch_<foo>_t see the various
116 * notmuch_<foo> functions below. */
117 typedef struct _notmuch_database notmuch_database_t;
118 typedef struct _notmuch_query notmuch_query_t;
119 typedef struct _notmuch_threads notmuch_threads_t;
120 typedef struct _notmuch_thread notmuch_thread_t;
121 typedef struct _notmuch_messages notmuch_messages_t;
122 typedef struct _notmuch_message notmuch_message_t;
123 typedef struct _notmuch_tags notmuch_tags_t;
124 typedef struct _notmuch_directory notmuch_directory_t;
125 typedef struct _notmuch_filenames notmuch_filenames_t;
127 /* Create a new, empty notmuch database located at 'path'.
129 * The path should be a top-level directory to a collection of
130 * plain-text email messages (one message per file). This call will
131 * create a new ".notmuch" directory within 'path' where notmuch will
134 * After a successful call to notmuch_database_create, the returned
135 * database will be open so the caller should call
136 * notmuch_database_close when finished with it.
138 * The database will not yet have any data in it
139 * (notmuch_database_create itself is a very cheap function). Messages
140 * contained within 'path' can be added to the database by calling
141 * notmuch_database_add_message.
143 * In case of any failure, this function returns NULL, (after printing
144 * an error message on stderr).
147 notmuch_database_create (const char *path);
150 NOTMUCH_DATABASE_MODE_READ_ONLY = 0,
151 NOTMUCH_DATABASE_MODE_READ_WRITE
152 } notmuch_database_mode_t;
154 /* XXX: I think I'd like this to take an extra argument of
155 * notmuch_status_t* for returning a status value on failure. */
157 /* Open an existing notmuch database located at 'path'.
159 * The database should have been created at some time in the past,
160 * (not necessarily by this process), by calling
161 * notmuch_database_create with 'path'. By default the database should be
162 * opened for reading only. In order to write to the database you need to
163 * pass the NOTMUCH_DATABASE_MODE_READ_WRITE mode.
165 * An existing notmuch database can be identified by the presence of a
166 * directory named ".notmuch" below 'path'.
168 * The caller should call notmuch_database_close when finished with
171 * In case of any failure, this function returns NULL, (after printing
172 * an error message on stderr).
175 notmuch_database_open (const char *path,
176 notmuch_database_mode_t mode);
178 /* Close the given notmuch database, freeing all associated
179 * resources. See notmuch_database_open. */
181 notmuch_database_close (notmuch_database_t *database);
183 /* Return the database path of the given database.
185 * The return value is a string owned by notmuch so should not be
186 * modified nor freed by the caller. */
188 notmuch_database_get_path (notmuch_database_t *database);
190 /* Return the database format version of the given database. */
192 notmuch_database_get_version (notmuch_database_t *database);
194 /* Does this database need to be upgraded before writing to it?
196 * If this function returns TRUE then no functions that modify the
197 * database (notmuch_database_add_message, notmuch_message_add_tag,
198 * notmuch_directory_set_mtime, etc.) will work unless the function
199 * notmuch_database_upgrade is called successfully first. */
201 notmuch_database_needs_upgrade (notmuch_database_t *database);
203 /* Upgrade the current database.
205 * After opening a database in read-write mode, the client should
206 * check if an upgrade is needed (notmuch_database_needs_upgrade) and
207 * if so, upgrade with this function before making any modifications.
209 * The optional progress_notify callback can be used by the caller to
210 * provide progress indication to the user. If non-NULL it will be
211 * called periodically with 'progress' as a floating-point value in
212 * the range of [0.0 .. 1.0] indicating the progress made so far in
213 * the upgrade process.
216 notmuch_database_upgrade (notmuch_database_t *database,
217 void (*progress_notify) (void *closure,
221 /* Begin an atomic database operation.
223 * Any modifications performed between a successful begin and a
224 * notmuch_database_end_atomic will be applied to the database
225 * atomically. Note that, unlike a typical database transaction, this
226 * only ensures atomicity, not durability; neither begin nor end
227 * necessarily flush modifications to disk.
229 * Atomic sections may be nested. begin_atomic and end_atomic must
230 * always be called in pairs.
234 * NOTMUCH_STATUS_SUCCESS: Successfully entered atomic section.
236 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred;
237 * atomic section not entered.
240 notmuch_database_begin_atomic (notmuch_database_t *notmuch);
242 /* Indicate the end of an atomic database operation.
246 * NOTMUCH_STATUS_SUCCESS: Successfully completed atomic section.
248 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred;
249 * atomic section not ended.
251 * NOTMUCH_STATUS_UNBALANCED_ATOMIC: The database is not currently in
255 notmuch_database_end_atomic (notmuch_database_t *notmuch);
257 /* Retrieve a directory object from the database for 'path'.
259 * Here, 'path' should be a path relative to the path of 'database'
260 * (see notmuch_database_get_path), or else should be an absolute path
261 * with initial components that match the path of 'database'.
263 * Can return NULL if a Xapian exception occurs.
265 notmuch_directory_t *
266 notmuch_database_get_directory (notmuch_database_t *database,
269 /* Add a new message to the given notmuch database or associate an
270 * additional filename with an existing message.
272 * Here, 'filename' should be a path relative to the path of
273 * 'database' (see notmuch_database_get_path), or else should be an
274 * absolute filename with initial components that match the path of
277 * The file should be a single mail message (not a multi-message mbox)
278 * that is expected to remain at its current location, (since the
279 * notmuch database will reference the filename, and will not copy the
280 * entire contents of the file.
282 * If another message with the same message ID already exists in the
283 * database, rather than creating a new message, this adds 'filename'
284 * to the list of the filenames for the existing message.
286 * If 'message' is not NULL, then, on successful return
287 * (NOTMUCH_STATUS_SUCCESS or NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID) '*message'
288 * will be initialized to a message object that can be used for things
289 * such as adding tags to the just-added message. The user should call
290 * notmuch_message_destroy when done with the message. On any failure
291 * '*message' will be set to NULL.
295 * NOTMUCH_STATUS_SUCCESS: Message successfully added to database.
297 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred,
300 * NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID: Message has the same message
301 * ID as another message already in the database. The new
302 * filename was successfully added to the message in the database
303 * (if not already present) and the existing message is returned.
305 * NOTMUCH_STATUS_FILE_ERROR: an error occurred trying to open the
306 * file, (such as permission denied, or file not found,
307 * etc.). Nothing added to the database.
309 * NOTMUCH_STATUS_FILE_NOT_EMAIL: the contents of filename don't look
310 * like an email message. Nothing added to the database.
312 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
313 * mode so no message can be added.
316 notmuch_database_add_message (notmuch_database_t *database,
317 const char *filename,
318 notmuch_message_t **message);
320 /* Remove a message filename from the given notmuch database. If the
321 * message has no more filenames, remove the message.
323 * If the same message (as determined by the message ID) is still
324 * available via other filenames, then the message will persist in the
325 * database for those filenames. When the last filename is removed for
326 * a particular message, the database content for that message will be
331 * NOTMUCH_STATUS_SUCCESS: The last filename was removed and the
332 * message was removed from the database.
334 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred,
335 * message not removed.
337 * NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID: This filename was removed but
338 * the message persists in the database with at least one other
341 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
342 * mode so no message can be removed.
345 notmuch_database_remove_message (notmuch_database_t *database,
346 const char *filename);
348 /* Find a message with the given message_id.
350 * If a message with the given message_id is found then, on successful return
351 * (NOTMUCH_STATUS_SUCCESS) '*message' will be initialized to a message
352 * object. The caller should call notmuch_message_destroy when done with the
355 * On any failure or when the message is not found, this function initializes
356 * '*message' to NULL. This means, when NOTMUCH_STATUS_SUCCESS is returned, the
357 * caller is supposed to check '*message' for NULL to find out whether the
358 * message with the given message_id was found.
362 * NOTMUCH_STATUS_SUCCESS: Successful return, check '*message'.
364 * NOTMUCH_STATUS_NULL_POINTER: The given 'message' argument is NULL
366 * NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory, creating message object
368 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred
371 notmuch_database_find_message (notmuch_database_t *database,
372 const char *message_id,
373 notmuch_message_t **message);
375 /* Find a message with the given filename.
377 * If the database contains a message with the given filename then, on
378 * successful return (NOTMUCH_STATUS_SUCCESS) '*message' will be initialized to
379 * a message object. The caller should call notmuch_message_destroy when done
382 * On any failure or when the message is not found, this function initializes
383 * '*message' to NULL. This means, when NOTMUCH_STATUS_SUCCESS is returned, the
384 * caller is supposed to check '*message' for NULL to find out whether the
385 * message with the given filename is found.
389 * NOTMUCH_STATUS_SUCCESS: Successful return, check '*message'
391 * NOTMUCH_STATUS_NULL_POINTER: The given 'message' argument is NULL
393 * NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory, creating the message object
395 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred
398 notmuch_database_find_message_by_filename (notmuch_database_t *notmuch,
399 const char *filename,
400 notmuch_message_t **message);
402 /* Return a list of all tags found in the database.
404 * This function creates a list of all tags found in the database. The
405 * resulting list contains all tags from all messages found in the database.
407 * On error this function returns NULL.
410 notmuch_database_get_all_tags (notmuch_database_t *db);
412 /* Create a new query for 'database'.
414 * Here, 'database' should be an open database, (see
415 * notmuch_database_open and notmuch_database_create).
417 * For the query string, we'll document the syntax here more
418 * completely in the future, but it's likely to be a specialized
419 * version of the general Xapian query syntax:
421 * http://xapian.org/docs/queryparser.html
423 * As a special case, passing either a length-zero string, (that is ""),
424 * or a string consisting of a single asterisk (that is "*"), will
425 * result in a query that returns all messages in the database.
427 * See notmuch_query_set_sort for controlling the order of results.
428 * See notmuch_query_search_messages and notmuch_query_search_threads
429 * to actually execute the query.
431 * User should call notmuch_query_destroy when finished with this
434 * Will return NULL if insufficient memory is available.
437 notmuch_query_create (notmuch_database_t *database,
438 const char *query_string);
440 /* Sort values for notmuch_query_set_sort */
442 NOTMUCH_SORT_OLDEST_FIRST,
443 NOTMUCH_SORT_NEWEST_FIRST,
444 NOTMUCH_SORT_MESSAGE_ID,
445 NOTMUCH_SORT_UNSORTED
448 /* Return the query_string of this query. See notmuch_query_create. */
450 notmuch_query_get_query_string (notmuch_query_t *query);
452 /* Specify the sorting desired for this query. */
454 notmuch_query_set_sort (notmuch_query_t *query, notmuch_sort_t sort);
456 /* Return the sort specified for this query. See notmuch_query_set_sort. */
458 notmuch_query_get_sort (notmuch_query_t *query);
460 /* Execute a query for threads, returning a notmuch_threads_t object
461 * which can be used to iterate over the results. The returned threads
462 * object is owned by the query and as such, will only be valid until
463 * notmuch_query_destroy.
465 * Typical usage might be:
467 * notmuch_query_t *query;
468 * notmuch_threads_t *threads;
469 * notmuch_thread_t *thread;
471 * query = notmuch_query_create (database, query_string);
473 * for (threads = notmuch_query_search_threads (query);
474 * notmuch_threads_valid (threads);
475 * notmuch_threads_move_to_next (threads))
477 * thread = notmuch_threads_get (threads);
479 * notmuch_thread_destroy (thread);
482 * notmuch_query_destroy (query);
484 * Note: If you are finished with a thread before its containing
485 * query, you can call notmuch_thread_destroy to clean up some memory
486 * sooner (as in the above example). Otherwise, if your thread objects
487 * are long-lived, then you don't need to call notmuch_thread_destroy
488 * and all the memory will still be reclaimed when the query is
491 * Note that there's no explicit destructor needed for the
492 * notmuch_threads_t object. (For consistency, we do provide a
493 * notmuch_threads_destroy function, but there's no good reason
494 * to call it if the query is about to be destroyed).
496 * If a Xapian exception occurs this function will return NULL.
499 notmuch_query_search_threads (notmuch_query_t *query);
501 /* Execute a query for messages, returning a notmuch_messages_t object
502 * which can be used to iterate over the results. The returned
503 * messages object is owned by the query and as such, will only be
504 * valid until notmuch_query_destroy.
506 * Typical usage might be:
508 * notmuch_query_t *query;
509 * notmuch_messages_t *messages;
510 * notmuch_message_t *message;
512 * query = notmuch_query_create (database, query_string);
514 * for (messages = notmuch_query_search_messages (query);
515 * notmuch_messages_valid (messages);
516 * notmuch_messages_move_to_next (messages))
518 * message = notmuch_messages_get (messages);
520 * notmuch_message_destroy (message);
523 * notmuch_query_destroy (query);
525 * Note: If you are finished with a message before its containing
526 * query, you can call notmuch_message_destroy to clean up some memory
527 * sooner (as in the above example). Otherwise, if your message
528 * objects are long-lived, then you don't need to call
529 * notmuch_message_destroy and all the memory will still be reclaimed
530 * when the query is destroyed.
532 * Note that there's no explicit destructor needed for the
533 * notmuch_messages_t object. (For consistency, we do provide a
534 * notmuch_messages_destroy function, but there's no good
535 * reason to call it if the query is about to be destroyed).
537 * If a Xapian exception occurs this function will return NULL.
540 notmuch_query_search_messages (notmuch_query_t *query);
542 /* Destroy a notmuch_query_t along with any associated resources.
544 * This will in turn destroy any notmuch_threads_t and
545 * notmuch_messages_t objects generated by this query, (and in
546 * turn any notmuch_thread_t and notmuch_message_t objects generated
547 * from those results, etc.), if such objects haven't already been
551 notmuch_query_destroy (notmuch_query_t *query);
553 /* Is the given 'threads' iterator pointing at a valid thread.
555 * When this function returns TRUE, notmuch_threads_get will return a
556 * valid object. Whereas when this function returns FALSE,
557 * notmuch_threads_get will return NULL.
559 * See the documentation of notmuch_query_search_threads for example
560 * code showing how to iterate over a notmuch_threads_t object.
563 notmuch_threads_valid (notmuch_threads_t *threads);
565 /* Get the current thread from 'threads' as a notmuch_thread_t.
567 * Note: The returned thread belongs to 'threads' and has a lifetime
568 * identical to it (and the query to which it belongs).
570 * See the documentation of notmuch_query_search_threads for example
571 * code showing how to iterate over a notmuch_threads_t object.
573 * If an out-of-memory situation occurs, this function will return
577 notmuch_threads_get (notmuch_threads_t *threads);
579 /* Move the 'threads' iterator to the next thread.
581 * If 'threads' is already pointing at the last thread then the
582 * iterator will be moved to a point just beyond that last thread,
583 * (where notmuch_threads_valid will return FALSE and
584 * notmuch_threads_get will return NULL).
586 * See the documentation of notmuch_query_search_threads for example
587 * code showing how to iterate over a notmuch_threads_t object.
590 notmuch_threads_move_to_next (notmuch_threads_t *threads);
592 /* Destroy a notmuch_threads_t object.
594 * It's not strictly necessary to call this function. All memory from
595 * the notmuch_threads_t object will be reclaimed when the
596 * containing query object is destroyed.
599 notmuch_threads_destroy (notmuch_threads_t *threads);
601 /* Return an estimate of the number of messages matching a search
603 * This function performs a search and returns Xapian's best
604 * guess as to number of matching messages.
606 * If a Xapian exception occurs, this function may return 0 (after
607 * printing a message).
610 notmuch_query_count_messages (notmuch_query_t *query);
612 /* Get the thread ID of 'thread'.
614 * The returned string belongs to 'thread' and as such, should not be
615 * modified by the caller and will only be valid for as long as the
616 * thread is valid, (which is until notmuch_thread_destroy or until
617 * the query from which it derived is destroyed).
620 notmuch_thread_get_thread_id (notmuch_thread_t *thread);
622 /* Get the total number of messages in 'thread'.
624 * This count consists of all messages in the database belonging to
625 * this thread. Contrast with notmuch_thread_get_matched_messages() .
628 notmuch_thread_get_total_messages (notmuch_thread_t *thread);
630 /* Get a notmuch_messages_t iterator for the top-level messages in
633 * This iterator will not necessarily iterate over all of the messages
634 * in the thread. It will only iterate over the messages in the thread
635 * which are not replies to other messages in the thread.
637 * To iterate over all messages in the thread, the caller will need to
638 * iterate over the result of notmuch_message_get_replies for each
639 * top-level message (and do that recursively for the resulting
643 notmuch_thread_get_toplevel_messages (notmuch_thread_t *thread);
645 /* Get the number of messages in 'thread' that matched the search.
647 * This count includes only the messages in this thread that were
648 * matched by the search from which the thread was created. Contrast
649 * with notmuch_thread_get_total_messages() .
652 notmuch_thread_get_matched_messages (notmuch_thread_t *thread);
654 /* Get the authors of 'thread'
656 * The returned string is a comma-separated list of the names of the
657 * authors of mail messages in the query results that belong to this
660 * The returned string belongs to 'thread' and as such, should not be
661 * modified by the caller and will only be valid for as long as the
662 * thread is valid, (which is until notmuch_thread_destroy or until
663 * the query from which it derived is destroyed).
666 notmuch_thread_get_authors (notmuch_thread_t *thread);
668 /* Get the subject of 'thread'
670 * The subject is taken from the first message (according to the query
671 * order---see notmuch_query_set_sort) in the query results that
672 * belongs to this thread.
674 * The returned string belongs to 'thread' and as such, should not be
675 * modified by the caller and will only be valid for as long as the
676 * thread is valid, (which is until notmuch_thread_destroy or until
677 * the query from which it derived is destroyed).
680 notmuch_thread_get_subject (notmuch_thread_t *thread);
682 /* Get the date of the oldest message in 'thread' as a time_t value.
685 notmuch_thread_get_oldest_date (notmuch_thread_t *thread);
687 /* Get the date of the newest message in 'thread' as a time_t value.
690 notmuch_thread_get_newest_date (notmuch_thread_t *thread);
692 /* Get the tags for 'thread', returning a notmuch_tags_t object which
693 * can be used to iterate over all tags.
695 * Note: In the Notmuch database, tags are stored on individual
696 * messages, not on threads. So the tags returned here will be all
697 * tags of the messages which matched the search and which belong to
700 * The tags object is owned by the thread and as such, will only be
701 * valid for as long as the thread is valid, (for example, until
702 * notmuch_thread_destroy or until the query from which it derived is
705 * Typical usage might be:
707 * notmuch_thread_t *thread;
708 * notmuch_tags_t *tags;
711 * thread = notmuch_threads_get (threads);
713 * for (tags = notmuch_thread_get_tags (thread);
714 * notmuch_tags_valid (tags);
715 * notmuch_result_move_to_next (tags))
717 * tag = notmuch_tags_get (tags);
721 * notmuch_thread_destroy (thread);
723 * Note that there's no explicit destructor needed for the
724 * notmuch_tags_t object. (For consistency, we do provide a
725 * notmuch_tags_destroy function, but there's no good reason to call
726 * it if the message is about to be destroyed).
729 notmuch_thread_get_tags (notmuch_thread_t *thread);
731 /* Destroy a notmuch_thread_t object. */
733 notmuch_thread_destroy (notmuch_thread_t *thread);
735 /* Is the given 'messages' iterator pointing at a valid message.
737 * When this function returns TRUE, notmuch_messages_get will return a
738 * valid object. Whereas when this function returns FALSE,
739 * notmuch_messages_get will return NULL.
741 * See the documentation of notmuch_query_search_messages for example
742 * code showing how to iterate over a notmuch_messages_t object.
745 notmuch_messages_valid (notmuch_messages_t *messages);
747 /* Get the current message from 'messages' as a notmuch_message_t.
749 * Note: The returned message belongs to 'messages' and has a lifetime
750 * identical to it (and the query to which it belongs).
752 * See the documentation of notmuch_query_search_messages for example
753 * code showing how to iterate over a notmuch_messages_t object.
755 * If an out-of-memory situation occurs, this function will return
759 notmuch_messages_get (notmuch_messages_t *messages);
761 /* Move the 'messages' iterator to the next message.
763 * If 'messages' is already pointing at the last message then the
764 * iterator will be moved to a point just beyond that last message,
765 * (where notmuch_messages_valid will return FALSE and
766 * notmuch_messages_get will return NULL).
768 * See the documentation of notmuch_query_search_messages for example
769 * code showing how to iterate over a notmuch_messages_t object.
772 notmuch_messages_move_to_next (notmuch_messages_t *messages);
774 /* Destroy a notmuch_messages_t object.
776 * It's not strictly necessary to call this function. All memory from
777 * the notmuch_messages_t object will be reclaimed when the containing
778 * query object is destroyed.
781 notmuch_messages_destroy (notmuch_messages_t *messages);
783 /* Return a list of tags from all messages.
785 * The resulting list is guaranteed not to contain duplicated tags.
787 * WARNING: You can no longer iterate over messages after calling this
788 * function, because the iterator will point at the end of the list.
789 * We do not have a function to reset the iterator yet and the only
790 * way how you can iterate over the list again is to recreate the
793 * The function returns NULL on error.
796 notmuch_messages_collect_tags (notmuch_messages_t *messages);
798 /* Get the message ID of 'message'.
800 * The returned string belongs to 'message' and as such, should not be
801 * modified by the caller and will only be valid for as long as the
802 * message is valid, (which is until the query from which it derived
805 * This function will not return NULL since Notmuch ensures that every
806 * message has a unique message ID, (Notmuch will generate an ID for a
807 * message if the original file does not contain one).
810 notmuch_message_get_message_id (notmuch_message_t *message);
812 /* Get the thread ID of 'message'.
814 * The returned string belongs to 'message' and as such, should not be
815 * modified by the caller and will only be valid for as long as the
816 * message is valid, (for example, until the user calls
817 * notmuch_message_destroy on 'message' or until a query from which it
818 * derived is destroyed).
820 * This function will not return NULL since Notmuch ensures that every
821 * message belongs to a single thread.
824 notmuch_message_get_thread_id (notmuch_message_t *message);
826 /* Get a notmuch_messages_t iterator for all of the replies to
829 * Note: This call only makes sense if 'message' was ultimately
830 * obtained from a notmuch_thread_t object, (such as by coming
831 * directly from the result of calling notmuch_thread_get_
832 * toplevel_messages or by any number of subsequent
833 * calls to notmuch_message_get_replies).
835 * If 'message' was obtained through some non-thread means, (such as
836 * by a call to notmuch_query_search_messages), then this function
839 * If there are no replies to 'message', this function will return
840 * NULL. (Note that notmuch_messages_valid will accept that NULL
841 * value as legitimate, and simply return FALSE for it.)
844 notmuch_message_get_replies (notmuch_message_t *message);
846 /* Get a filename for the email corresponding to 'message'.
848 * The returned filename is an absolute filename, (the initial
849 * component will match notmuch_database_get_path() ).
851 * The returned string belongs to the message so should not be
852 * modified or freed by the caller (nor should it be referenced after
853 * the message is destroyed).
855 * Note: If this message corresponds to multiple files in the mail
856 * store, (that is, multiple files contain identical message IDs),
857 * this function will arbitrarily return a single one of those
858 * filenames. See notmuch_message_get_filenames for returning the
859 * complete list of filenames.
862 notmuch_message_get_filename (notmuch_message_t *message);
864 /* Get all filenames for the email corresponding to 'message'.
866 * Returns a notmuch_filenames_t iterator listing all the filenames
867 * associated with 'message'. These files may not have identical
868 * content, but each will have the identical Message-ID.
870 * Each filename in the iterator is an absolute filename, (the initial
871 * component will match notmuch_database_get_path() ).
873 notmuch_filenames_t *
874 notmuch_message_get_filenames (notmuch_message_t *message);
877 typedef enum _notmuch_message_flag {
878 NOTMUCH_MESSAGE_FLAG_MATCH
879 } notmuch_message_flag_t;
881 /* Get a value of a flag for the email corresponding to 'message'. */
883 notmuch_message_get_flag (notmuch_message_t *message,
884 notmuch_message_flag_t flag);
886 /* Set a value of a flag for the email corresponding to 'message'. */
888 notmuch_message_set_flag (notmuch_message_t *message,
889 notmuch_message_flag_t flag, notmuch_bool_t value);
891 /* Get the date of 'message' as a time_t value.
893 * For the original textual representation of the Date header from the
894 * message call notmuch_message_get_header() with a header value of
897 notmuch_message_get_date (notmuch_message_t *message);
899 /* Get the value of the specified header from 'message'.
901 * The value will be read from the actual message file, not from the
902 * notmuch database. The header name is case insensitive.
904 * The returned string belongs to the message so should not be
905 * modified or freed by the caller (nor should it be referenced after
906 * the message is destroyed).
908 * Returns an empty string ("") if the message does not contain a
909 * header line matching 'header'. Returns NULL if any error occurs.
912 notmuch_message_get_header (notmuch_message_t *message, const char *header);
914 /* Get the tags for 'message', returning a notmuch_tags_t object which
915 * can be used to iterate over all tags.
917 * The tags object is owned by the message and as such, will only be
918 * valid for as long as the message is valid, (which is until the
919 * query from which it derived is destroyed).
921 * Typical usage might be:
923 * notmuch_message_t *message;
924 * notmuch_tags_t *tags;
927 * message = notmuch_database_find_message (database, message_id);
929 * for (tags = notmuch_message_get_tags (message);
930 * notmuch_tags_valid (tags);
931 * notmuch_result_move_to_next (tags))
933 * tag = notmuch_tags_get (tags);
937 * notmuch_message_destroy (message);
939 * Note that there's no explicit destructor needed for the
940 * notmuch_tags_t object. (For consistency, we do provide a
941 * notmuch_tags_destroy function, but there's no good reason to call
942 * it if the message is about to be destroyed).
945 notmuch_message_get_tags (notmuch_message_t *message);
947 /* The longest possible tag value. */
948 #define NOTMUCH_TAG_MAX 200
950 /* Add a tag to the given message.
954 * NOTMUCH_STATUS_SUCCESS: Tag successfully added to message
956 * NOTMUCH_STATUS_NULL_POINTER: The 'tag' argument is NULL
958 * NOTMUCH_STATUS_TAG_TOO_LONG: The length of 'tag' is too long
959 * (exceeds NOTMUCH_TAG_MAX)
961 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
962 * mode so message cannot be modified.
965 notmuch_message_add_tag (notmuch_message_t *message, const char *tag);
967 /* Remove a tag from the given message.
971 * NOTMUCH_STATUS_SUCCESS: Tag successfully removed from message
973 * NOTMUCH_STATUS_NULL_POINTER: The 'tag' argument is NULL
975 * NOTMUCH_STATUS_TAG_TOO_LONG: The length of 'tag' is too long
976 * (exceeds NOTMUCH_TAG_MAX)
978 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
979 * mode so message cannot be modified.
982 notmuch_message_remove_tag (notmuch_message_t *message, const char *tag);
984 /* Remove all tags from the given message.
986 * See notmuch_message_freeze for an example showing how to safely
987 * replace tag values.
989 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
990 * mode so message cannot be modified.
993 notmuch_message_remove_all_tags (notmuch_message_t *message);
995 /* Add/remove tags according to maildir flags in the message filename(s)
997 * This function examines the filenames of 'message' for maildir
998 * flags, and adds or removes tags on 'message' as follows when these
1001 * Flag Action if present
1002 * ---- -----------------
1003 * 'D' Adds the "draft" tag to the message
1004 * 'F' Adds the "flagged" tag to the message
1005 * 'P' Adds the "passed" tag to the message
1006 * 'R' Adds the "replied" tag to the message
1007 * 'S' Removes the "unread" tag from the message
1009 * For each flag that is not present, the opposite action (add/remove)
1010 * is performed for the corresponding tags.
1012 * Flags are identified as trailing components of the filename after a
1013 * sequence of ":2,".
1015 * If there are multiple filenames associated with this message, the
1016 * flag is considered present if it appears in one or more
1017 * filenames. (That is, the flags from the multiple filenames are
1018 * combined with the logical OR operator.)
1020 * A client can ensure that notmuch database tags remain synchronized
1021 * with maildir flags by calling this function after each call to
1022 * notmuch_database_add_message. See also
1023 * notmuch_message_tags_to_maildir_flags for synchronizing tag changes
1024 * back to maildir flags.
1027 notmuch_message_maildir_flags_to_tags (notmuch_message_t *message);
1029 /* Rename message filename(s) to encode tags as maildir flags
1031 * Specifically, for each filename corresponding to this message:
1033 * If the filename is not in a maildir directory, do nothing. (A
1034 * maildir directory is determined as a directory named "new" or
1035 * "cur".) Similarly, if the filename has invalid maildir info,
1036 * (repeated or outof-ASCII-order flag characters after ":2,"), then
1039 * If the filename is in a maildir directory, rename the file so that
1040 * its filename ends with the sequence ":2," followed by zero or more
1041 * of the following single-character flags (in ASCII order):
1043 * 'D' iff the message has the "draft" tag
1044 * 'F' iff the message has the "flagged" tag
1045 * 'P' iff the message has the "passed" tag
1046 * 'R' iff the message has the "replied" tag
1047 * 'S' iff the message does not have the "unread" tag
1049 * Any existing flags unmentioned in the list above will be preserved
1052 * Also, if this filename is in a directory named "new", rename it to
1053 * be within the neighboring directory named "cur".
1055 * A client can ensure that maildir filename flags remain synchronized
1056 * with notmuch database tags by calling this function after changing
1057 * tags, (after calls to notmuch_message_add_tag,
1058 * notmuch_message_remove_tag, or notmuch_message_freeze/
1059 * notmuch_message_thaw). See also notmuch_message_maildir_flags_to_tags
1060 * for synchronizing maildir flag changes back to tags.
1063 notmuch_message_tags_to_maildir_flags (notmuch_message_t *message);
1065 /* Freeze the current state of 'message' within the database.
1067 * This means that changes to the message state, (via
1068 * notmuch_message_add_tag, notmuch_message_remove_tag, and
1069 * notmuch_message_remove_all_tags), will not be committed to the
1070 * database until the message is thawed with notmuch_message_thaw.
1072 * Multiple calls to freeze/thaw are valid and these calls will
1073 * "stack". That is there must be as many calls to thaw as to freeze
1074 * before a message is actually thawed.
1076 * The ability to do freeze/thaw allows for safe transactions to
1077 * change tag values. For example, explicitly setting a message to
1078 * have a given set of tags might look like this:
1080 * notmuch_message_freeze (message);
1082 * notmuch_message_remove_all_tags (message);
1084 * for (i = 0; i < NUM_TAGS; i++)
1085 * notmuch_message_add_tag (message, tags[i]);
1087 * notmuch_message_thaw (message);
1089 * With freeze/thaw used like this, the message in the database is
1090 * guaranteed to have either the full set of original tag values, or
1091 * the full set of new tag values, but nothing in between.
1093 * Imagine the example above without freeze/thaw and the operation
1094 * somehow getting interrupted. This could result in the message being
1095 * left with no tags if the interruption happened after
1096 * notmuch_message_remove_all_tags but before notmuch_message_add_tag.
1100 * NOTMUCH_STATUS_SUCCESS: Message successfully frozen.
1102 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
1103 * mode so message cannot be modified.
1106 notmuch_message_freeze (notmuch_message_t *message);
1108 /* Thaw the current 'message', synchronizing any changes that may have
1109 * occurred while 'message' was frozen into the notmuch database.
1111 * See notmuch_message_freeze for an example of how to use this
1112 * function to safely provide tag changes.
1114 * Multiple calls to freeze/thaw are valid and these calls with
1115 * "stack". That is there must be as many calls to thaw as to freeze
1116 * before a message is actually thawed.
1120 * NOTMUCH_STATUS_SUCCESS: Message successfully thawed, (or at least
1121 * its frozen count has successfully been reduced by 1).
1123 * NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW: An attempt was made to thaw
1124 * an unfrozen message. That is, there have been an unbalanced
1125 * number of calls to notmuch_message_freeze and
1126 * notmuch_message_thaw.
1129 notmuch_message_thaw (notmuch_message_t *message);
1131 /* Destroy a notmuch_message_t object.
1133 * It can be useful to call this function in the case of a single
1134 * query object with many messages in the result, (such as iterating
1135 * over the entire database). Otherwise, it's fine to never call this
1136 * function and there will still be no memory leaks. (The memory from
1137 * the messages get reclaimed when the containing query is destroyed.)
1140 notmuch_message_destroy (notmuch_message_t *message);
1142 /* Is the given 'tags' iterator pointing at a valid tag.
1144 * When this function returns TRUE, notmuch_tags_get will return a
1145 * valid string. Whereas when this function returns FALSE,
1146 * notmuch_tags_get will return NULL.
1148 * See the documentation of notmuch_message_get_tags for example code
1149 * showing how to iterate over a notmuch_tags_t object.
1152 notmuch_tags_valid (notmuch_tags_t *tags);
1154 /* Get the current tag from 'tags' as a string.
1156 * Note: The returned string belongs to 'tags' and has a lifetime
1157 * identical to it (and the query to which it ultimately belongs).
1159 * See the documentation of notmuch_message_get_tags for example code
1160 * showing how to iterate over a notmuch_tags_t object.
1163 notmuch_tags_get (notmuch_tags_t *tags);
1165 /* Move the 'tags' iterator to the next tag.
1167 * If 'tags' is already pointing at the last tag then the iterator
1168 * will be moved to a point just beyond that last tag, (where
1169 * notmuch_tags_valid will return FALSE and notmuch_tags_get will
1172 * See the documentation of notmuch_message_get_tags for example code
1173 * showing how to iterate over a notmuch_tags_t object.
1176 notmuch_tags_move_to_next (notmuch_tags_t *tags);
1178 /* Destroy a notmuch_tags_t object.
1180 * It's not strictly necessary to call this function. All memory from
1181 * the notmuch_tags_t object will be reclaimed when the containing
1182 * message or query objects are destroyed.
1185 notmuch_tags_destroy (notmuch_tags_t *tags);
1187 /* Store an mtime within the database for 'directory'.
1189 * The 'directory' should be an object retrieved from the database
1190 * with notmuch_database_get_directory for a particular path.
1192 * The intention is for the caller to use the mtime to allow efficient
1193 * identification of new messages to be added to the database. The
1194 * recommended usage is as follows:
1196 * o Read the mtime of a directory from the filesystem
1198 * o Call add_message for all mail files in the directory
1200 * o Call notmuch_directory_set_mtime with the mtime read from the
1203 * Then, when wanting to check for updates to the directory in the
1204 * future, the client can call notmuch_directory_get_mtime and know
1205 * that it only needs to add files if the mtime of the directory and
1206 * files are newer than the stored timestamp.
1208 * Note: The notmuch_directory_get_mtime function does not allow the
1209 * caller to distinguish a timestamp of 0 from a non-existent
1210 * timestamp. So don't store a timestamp of 0 unless you are
1211 * comfortable with that.
1215 * NOTMUCH_STATUS_SUCCESS: mtime successfully stored in database.
1217 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception
1218 * occurred, mtime not stored.
1220 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
1221 * mode so directory mtime cannot be modified.
1224 notmuch_directory_set_mtime (notmuch_directory_t *directory,
1227 /* Get the mtime of a directory, (as previously stored with
1228 * notmuch_directory_set_mtime).
1230 * Returns 0 if no mtime has previously been stored for this
1233 notmuch_directory_get_mtime (notmuch_directory_t *directory);
1235 /* Get a notmuch_filenames_t iterator listing all the filenames of
1236 * messages in the database within the given directory.
1238 * The returned filenames will be the basename-entries only (not
1239 * complete paths). */
1240 notmuch_filenames_t *
1241 notmuch_directory_get_child_files (notmuch_directory_t *directory);
1243 /* Get a notmuch_filenams_t iterator listing all the filenames of
1244 * sub-directories in the database within the given directory.
1246 * The returned filenames will be the basename-entries only (not
1247 * complete paths). */
1248 notmuch_filenames_t *
1249 notmuch_directory_get_child_directories (notmuch_directory_t *directory);
1251 /* Destroy a notmuch_directory_t object. */
1253 notmuch_directory_destroy (notmuch_directory_t *directory);
1255 /* Is the given 'filenames' iterator pointing at a valid filename.
1257 * When this function returns TRUE, notmuch_filenames_get will return
1258 * a valid string. Whereas when this function returns FALSE,
1259 * notmuch_filenames_get will return NULL.
1261 * It is acceptable to pass NULL for 'filenames', in which case this
1262 * function will always return FALSE.
1265 notmuch_filenames_valid (notmuch_filenames_t *filenames);
1267 /* Get the current filename from 'filenames' as a string.
1269 * Note: The returned string belongs to 'filenames' and has a lifetime
1270 * identical to it (and the directory to which it ultimately belongs).
1272 * It is acceptable to pass NULL for 'filenames', in which case this
1273 * function will always return NULL.
1276 notmuch_filenames_get (notmuch_filenames_t *filenames);
1278 /* Move the 'filenames' iterator to the next filename.
1280 * If 'filenames' is already pointing at the last filename then the
1281 * iterator will be moved to a point just beyond that last filename,
1282 * (where notmuch_filenames_valid will return FALSE and
1283 * notmuch_filenames_get will return NULL).
1285 * It is acceptable to pass NULL for 'filenames', in which case this
1286 * function will do nothing.
1289 notmuch_filenames_move_to_next (notmuch_filenames_t *filenames);
1291 /* Destroy a notmuch_filenames_t object.
1293 * It's not strictly necessary to call this function. All memory from
1294 * the notmuch_filenames_t object will be reclaimed when the
1295 * containing directory object is destroyed.
1297 * It is acceptable to pass NULL for 'filenames', in which case this
1298 * function will do nothing.
1301 notmuch_filenames_destroy (notmuch_filenames_t *filenames);