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_XAPIAN_EXCEPTION: A Xapian exception occurred
62 * NOTMUCH_STATUS_FILE_ERROR: An error occurred trying to read or
63 * write to a file (this could be file not found, permission
66 * NOTMUCH_STATUS_FILE_NOT_EMAIL: A file was presented that doesn't
67 * appear to be an email message.
69 * NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID: A file contains a message ID
70 * that is identical to a message already in the database.
72 * NOTMUCH_STATUS_NULL_POINTER: The user erroneously passed a NULL
73 * pointer to a notmuch function.
75 * NOTMUCH_STATUS_TAG_TOO_LONG: A tag value is too long (exceeds
78 * NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW: The notmuch_message_thaw
79 * function has been called more times than notmuch_message_freeze.
83 * NOTMUCH_STATUS_LAST_STATUS: Not an actual status value. Just a way
84 * to find out how many valid status values there are.
86 typedef enum _notmuch_status {
87 NOTMUCH_STATUS_SUCCESS = 0,
88 NOTMUCH_STATUS_OUT_OF_MEMORY,
89 NOTMUCH_STATUS_READONLY_DATABASE,
90 NOTMUCH_STATUS_XAPIAN_EXCEPTION,
91 NOTMUCH_STATUS_FILE_ERROR,
92 NOTMUCH_STATUS_FILE_NOT_EMAIL,
93 NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID,
94 NOTMUCH_STATUS_NULL_POINTER,
95 NOTMUCH_STATUS_TAG_TOO_LONG,
96 NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW,
98 NOTMUCH_STATUS_LAST_STATUS
101 /* Get a string representation of a notmuch_status_t value.
103 * The result is readonly.
106 notmuch_status_to_string (notmuch_status_t status);
108 /* Various opaque data types. For each notmuch_<foo>_t see the various
109 * notmuch_<foo> functions below. */
110 typedef struct _notmuch_database notmuch_database_t;
111 typedef struct _notmuch_query notmuch_query_t;
112 typedef struct _notmuch_threads notmuch_threads_t;
113 typedef struct _notmuch_thread notmuch_thread_t;
114 typedef struct _notmuch_messages notmuch_messages_t;
115 typedef struct _notmuch_message notmuch_message_t;
116 typedef struct _notmuch_tags notmuch_tags_t;
117 typedef struct _notmuch_directory notmuch_directory_t;
118 typedef struct _notmuch_filenames notmuch_filenames_t;
120 /* Create a new, empty notmuch database located at 'path'.
122 * The path should be a top-level directory to a collection of
123 * plain-text email messages (one message per file). This call will
124 * create a new ".notmuch" directory within 'path' where notmuch will
127 * After a successful call to notmuch_database_create, the returned
128 * database will be open so the caller should call
129 * notmuch_database_close when finished with it.
131 * The database will not yet have any data in it
132 * (notmuch_database_create itself is a very cheap function). Messages
133 * contained within 'path' can be added to the database by calling
134 * notmuch_database_add_message.
136 * In case of any failure, this function returns NULL, (after printing
137 * an error message on stderr).
140 notmuch_database_create (const char *path);
143 NOTMUCH_DATABASE_MODE_READ_ONLY = 0,
144 NOTMUCH_DATABASE_MODE_READ_WRITE
145 } notmuch_database_mode_t;
147 /* XXX: I think I'd like this to take an extra argument of
148 * notmuch_status_t* for returning a status value on failure. */
150 /* Open an existing notmuch database located at 'path'.
152 * The database should have been created at some time in the past,
153 * (not necessarily by this process), by calling
154 * notmuch_database_create with 'path'. By default the database should be
155 * opened for reading only. In order to write to the database you need to
156 * pass the NOTMUCH_DATABASE_MODE_WRITABLE mode.
158 * An existing notmuch database can be identified by the presence of a
159 * directory named ".notmuch" below 'path'.
161 * The caller should call notmuch_database_close when finished with
164 * In case of any failure, this function returns NULL, (after printing
165 * an error message on stderr).
168 notmuch_database_open (const char *path,
169 notmuch_database_mode_t mode);
171 /* Close the given notmuch database, freeing all associated
172 * resources. See notmuch_database_open. */
174 notmuch_database_close (notmuch_database_t *database);
176 /* Return the database path of the given database.
178 * The return value is a string owned by notmuch so should not be
179 * modified nor freed by the caller. */
181 notmuch_database_get_path (notmuch_database_t *database);
183 /* Retrieve a directory object from the database for 'path'.
185 * Here, 'path' should be a path relative to the path of 'database'
186 * (see notmuch_database_get_path), or else should be an absolute path
187 * with initial components that match the path of 'database'.
189 * Note: The resulting notmuch_directory_t object will represent the
190 * state as it currently exists in the database, (and will not reflect
191 * subsequent changes).
193 notmuch_directory_t *
194 notmuch_database_get_directory (notmuch_database_t *database,
197 /* Add a new message to the given notmuch database.
199 * Here,'filename' should be a path relative to the path of
200 * 'database' (see notmuch_database_get_path), or else should be an
201 * absolute filename with initial components that match the path of
204 * The file should be a single mail message (not a multi-message mbox)
205 * that is expected to remain at its current location, (since the
206 * notmuch database will reference the filename, and will not copy the
207 * entire contents of the file.
209 * If 'message' is not NULL, then, on successful return '*message'
210 * will be initialized to a message object that can be used for things
211 * such as adding tags to the just-added message. The user should call
212 * notmuch_message_destroy when done with the message. On any failure
213 * '*message' will be set to NULL.
217 * NOTMUCH_STATUS_SUCCESS: Message successfully added to database.
219 * NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID: Message has the same message
220 * ID as another message already in the database. Nothing added
223 * NOTMUCH_STATUS_FILE_ERROR: an error occurred trying to open the
224 * file, (such as permission denied, or file not found,
225 * etc.). Nothing added to the database.
227 * NOTMUCH_STATUS_FILE_NOT_EMAIL: the contents of filename don't look
228 * like an email message. Nothing added to the database.
231 notmuch_database_add_message (notmuch_database_t *database,
232 const char *filename,
233 notmuch_message_t **message);
235 /* Remove a message from the given notmuch database.
237 * Note that the only this particular filename association is removed
238 * from the database. If the same message (as determined by the
239 * message ID) is still available via other filenames, then the
240 * message will persist in the database for those filenames. When the
241 * last filename is removed for a particular message, the database
242 * content for that message will be entirely removed.
245 notmuch_database_remove_message (notmuch_database_t *database,
246 const char *filename);
248 /* Find a message with the given message_id.
250 * If the database contains a message with the given message_id, then
251 * a new notmuch_message_t object is returned. The caller should call
252 * notmuch_message_destroy when done with the message.
254 * If no message is found with the given message_id or if an
255 * out-of-memory situation occurs, this function returns NULL.
258 notmuch_database_find_message (notmuch_database_t *database,
259 const char *message_id);
261 /* Return a list of all tags found in the database.
263 * This function creates a list of all tags found in the database. The
264 * resulting list contains all tags from all messages found in the database.
266 * On error this function returns NULL.
269 notmuch_database_get_all_tags (notmuch_database_t *db);
271 /* Create a new query for 'database'.
273 * Here, 'database' should be an open database, (see
274 * notmuch_database_open and notmuch_database_create).
276 * For the query string, we'll document the syntax here more
277 * completely in the future, but it's likely to be a specialized
278 * version of the general Xapian query syntax:
280 * http://xapian.org/docs/queryparser.html
282 * As a special case, passing a length-zero string, (that is ""), will
283 * result in a query that returns all messages in the database.
285 * See notmuch_query_set_sort for controlling the order of results and
286 * notmuch_query_search to actually execute the query.
288 * User should call notmuch_query_destroy when finished with this
291 * Will return NULL if insufficient memory is available.
294 notmuch_query_create (notmuch_database_t *database,
295 const char *query_string);
297 /* Sort values for notmuch_query_set_sort */
299 NOTMUCH_SORT_OLDEST_FIRST,
300 NOTMUCH_SORT_NEWEST_FIRST,
301 NOTMUCH_SORT_MESSAGE_ID
304 /* Specify the sorting desired for this query. */
306 notmuch_query_set_sort (notmuch_query_t *query, notmuch_sort_t sort);
308 /* Execute a query for threads, returning a notmuch_threads_t object
309 * which can be used to iterate over the results. The returned threads
310 * object is owned by the query and as such, will only be valid until
311 * notmuch_query_destroy.
313 * Typical usage might be:
315 * notmuch_query_t *query;
316 * notmuch_threads_t *threads;
317 * notmuch_thread_t *thread;
319 * query = notmuch_query_create (database, query_string);
321 * for (threads = notmuch_query_search_threads (query);
322 * notmuch_threads_has_more (threads);
323 * notmuch_threads_advance (threads))
325 * thread = notmuch_threads_get (threads);
327 * notmuch_thread_destroy (thread);
330 * notmuch_query_destroy (query);
332 * Note: If you are finished with a thread before its containing
333 * query, you can call notmuch_thread_destroy to clean up some memory
334 * sooner (as in the above example). Otherwise, if your thread objects
335 * are long-lived, then you don't need to call notmuch_thread_destroy
336 * and all the memory will still be reclaimed when the query is
339 * Note that there's no explicit destructor needed for the
340 * notmuch_threads_t object. (For consistency, we do provide a
341 * notmuch_threads_destroy function, but there's no good reason
342 * to call it if the query is about to be destroyed).
345 notmuch_query_search_threads (notmuch_query_t *query);
347 /* Execute a query for messages, returning a notmuch_messages_t object
348 * which can be used to iterate over the results. The returned
349 * messages object is owned by the query and as such, will only be
350 * valid until notmuch_query_destroy.
352 * Typical usage might be:
354 * notmuch_query_t *query;
355 * notmuch_messages_t *messages;
356 * notmuch_message_t *message;
358 * query = notmuch_query_create (database, query_string);
360 * for (messages = notmuch_query_search_messages (query);
361 * notmuch_messages_has_more (messages);
362 * notmuch_messages_advance (messages))
364 * message = notmuch_messages_get (messages);
366 * notmuch_message_destroy (message);
369 * notmuch_query_destroy (query);
371 * Note: If you are finished with a message before its containing
372 * query, you can call notmuch_message_destroy to clean up some memory
373 * sooner (as in the above example). Otherwise, if your message
374 * objects are long-lived, then you don't need to call
375 * notmuch_message_destroy and all the memory will still be reclaimed
376 * when the query is destroyed.
378 * Note that there's no explicit destructor needed for the
379 * notmuch_messages_t object. (For consistency, we do provide a
380 * notmuch_messages_destroy function, but there's no good
381 * reason to call it if the query is about to be destroyed).
384 notmuch_query_search_messages (notmuch_query_t *query);
386 /* Destroy a notmuch_query_t along with any associated resources.
388 * This will in turn destroy any notmuch_threads_t and
389 * notmuch_messages_t objects generated by this query, (and in
390 * turn any notmuch_thrad_t and notmuch_message_t objects generated
391 * from those results, etc.), if such objects haven't already been
395 notmuch_query_destroy (notmuch_query_t *query);
397 /* Does the given notmuch_threads_t object contain any more
400 * When this function returns TRUE, notmuch_threads_get will
401 * return a valid object. Whereas when this function returns FALSE,
402 * notmuch_threads_get will return NULL.
404 * See the documentation of notmuch_query_search_threads for example
405 * code showing how to iterate over a notmuch_threads_t object.
408 notmuch_threads_has_more (notmuch_threads_t *threads);
410 /* Get the current thread from 'threads' as a notmuch_thread_t.
412 * Note: The returned thread belongs to 'threads' and has a lifetime
413 * identical to it (and the query to which it belongs).
415 * See the documentation of notmuch_query_search_threads for example
416 * code showing how to iterate over a notmuch_threads_t object.
418 * If an out-of-memory situation occurs, this function will return
422 notmuch_threads_get (notmuch_threads_t *threads);
424 /* Advance the 'threads' iterator to the next thread.
426 * See the documentation of notmuch_query_search_threads for example
427 * code showing how to iterate over a notmuch_threads_t object.
430 notmuch_threads_advance (notmuch_threads_t *threads);
432 /* Destroy a notmuch_threads_t object.
434 * It's not strictly necessary to call this function. All memory from
435 * the notmuch_threads_t object will be reclaimed when the
436 * containg query object is destroyed.
439 notmuch_threads_destroy (notmuch_threads_t *threads);
441 /* Return an estimate of the number of messages matching a search
443 * This function performs a search and returns Xapian's best
444 * guess as to number of matching messages.
447 notmuch_query_count_messages (notmuch_query_t *query);
449 /* Get the thread ID of 'thread'.
451 * The returned string belongs to 'thread' and as such, should not be
452 * modified by the caller and will only be valid for as long as the
453 * thread is valid, (which is until notmuch_thread_destroy or until
454 * the query from which it derived is destroyed).
457 notmuch_thread_get_thread_id (notmuch_thread_t *thread);
459 /* Get the total number of messages in 'thread'.
461 * This count consists of all messages in the database belonging to
462 * this thread. Contrast with notmuch_thread_get_matched_messages() .
465 notmuch_thread_get_total_messages (notmuch_thread_t *thread);
467 /* Get a notmuch_messages_t iterator for the top-level messages in
470 * This iterator will not necessarily iterate over all of the messages
471 * in the thread. It will only iterate over the messages in the thread
472 * which are not replies to other messages in the thread.
474 * To iterate over all messages in the thread, the caller will need to
475 * iterate over the result of notmuch_message_get_replies for each
476 * top-level message (and do that recursively for the resulting
480 notmuch_thread_get_toplevel_messages (notmuch_thread_t *thread);
482 /* Get the number of messages in 'thread' that matched the search.
484 * This count includes only the messages in this thread that were
485 * matched by the search from which the thread was created. Contrast
486 * with notmuch_thread_get_total_messages() .
489 notmuch_thread_get_matched_messages (notmuch_thread_t *thread);
491 /* Get the authors of 'thread'
493 * The returned string is a comma-separated list of the names of the
494 * authors of mail messages in the query results that belong to this
497 * The returned string belongs to 'thread' and as such, should not be
498 * modified by the caller and will only be valid for as long as the
499 * thread is valid, (which is until notmuch_thread_destroy or until
500 * the query from which it derived is destroyed).
503 notmuch_thread_get_authors (notmuch_thread_t *thread);
505 /* Get the subject of 'thread'
507 * The subject is taken from the first message (according to the query
508 * order---see notmuch_query_set_sort) in the query results that
509 * belongs to this thread.
511 * The returned string belongs to 'thread' and as such, should not be
512 * modified by the caller and will only be valid for as long as the
513 * thread is valid, (which is until notmuch_thread_destroy or until
514 * the query from which it derived is destroyed).
517 notmuch_thread_get_subject (notmuch_thread_t *thread);
519 /* Get the date of the oldest message in 'thread' as a time_t value.
522 notmuch_thread_get_oldest_date (notmuch_thread_t *thread);
524 /* Get the date of the oldest message in 'thread' as a time_t value.
527 notmuch_thread_get_newest_date (notmuch_thread_t *thread);
529 /* Get the tags for 'thread', returning a notmuch_tags_t object which
530 * can be used to iterate over all tags.
532 * Note: In the Notmuch database, tags are stored on individual
533 * messages, not on threads. So the tags returned here will be all
534 * tags of the messages which matched the search and which belong to
537 * The tags object is owned by the thread and as such, will only be
538 * valid for as long as the thread is valid, (for example, until
539 * notmuch_thread_destroy or until the query from which it derived is
542 * Typical usage might be:
544 * notmuch_thread_t *thread;
545 * notmuch_tags_t *tags;
548 * thread = notmuch_threads_get (threads);
550 * for (tags = notmuch_thread_get_tags (thread);
551 * notmuch_tags_has_more (tags);
552 * notmuch_result_advance (tags))
554 * tag = notmuch_tags_get (tags);
558 * notmuch_thread_destroy (thread);
560 * Note that there's no explicit destructor needed for the
561 * notmuch_tags_t object. (For consistency, we do provide a
562 * notmuch_tags_destroy function, but there's no good reason to call
563 * it if the message is about to be destroyed).
566 notmuch_thread_get_tags (notmuch_thread_t *thread);
568 /* Destroy a notmuch_thread_t object. */
570 notmuch_thread_destroy (notmuch_thread_t *thread);
572 /* Does the given notmuch_messages_t object contain any more
575 * When this function returns TRUE, notmuch_messages_get will return a
576 * valid object. Whereas when this function returns FALSE,
577 * notmuch_messages_get will return NULL.
579 * See the documentation of notmuch_query_search_messages for example
580 * code showing how to iterate over a notmuch_messages_t object.
583 notmuch_messages_has_more (notmuch_messages_t *messages);
585 /* Get the current message from 'messages' as a notmuch_message_t.
587 * Note: The returned message belongs to 'messages' and has a lifetime
588 * identical to it (and the query to which it belongs).
590 * See the documentation of notmuch_query_search_messages for example
591 * code showing how to iterate over a notmuch_messages_t object.
593 * If an out-of-memory situation occurs, this function will return
597 notmuch_messages_get (notmuch_messages_t *messages);
599 /* Advance the 'messages' iterator to the next result.
601 * See the documentation of notmuch_query_search_messages for example
602 * code showing how to iterate over a notmuch_messages_t object.
605 notmuch_messages_advance (notmuch_messages_t *messages);
607 /* Destroy a notmuch_messages_t object.
609 * It's not strictly necessary to call this function. All memory from
610 * the notmuch_messages_t object will be reclaimed when the containing
611 * query object is destroyed.
614 notmuch_messages_destroy (notmuch_messages_t *messages);
616 /* Return a list of tags from all messages.
618 * The resulting list is guaranteed not to contain duplicated tags.
620 * WARNING: You can no longer iterate over messages after calling this
621 * function, because the iterator will point at the end of the list.
622 * We do not have a function to reset the iterator yet and the only
623 * way how you can iterate over the list again is to recreate the
626 * The function returns NULL on error.
629 notmuch_messages_collect_tags (notmuch_messages_t *messages);
631 /* Get the message ID of 'message'.
633 * The returned string belongs to 'message' and as such, should not be
634 * modified by the caller and will only be valid for as long as the
635 * message is valid, (which is until the query from which it derived
638 * This function will not return NULL since Notmuch ensures that every
639 * message has a unique message ID, (Notmuch will generate an ID for a
640 * message if the original file does not contain one).
643 notmuch_message_get_message_id (notmuch_message_t *message);
645 /* Get the thread ID of 'message'.
647 * The returned string belongs to 'message' and as such, should not be
648 * modified by the caller and will only be valid for as long as the
649 * message is valid, (for example, until the user calls
650 * notmuch_message_destroy on 'message' or until a query from which it
651 * derived is destroyed).
653 * This function will not return NULL since Notmuch ensures that every
654 * message belongs to a single thread.
657 notmuch_message_get_thread_id (notmuch_message_t *message);
659 /* Get a notmuch_messages_t iterator for all of the replies to
662 * Note: This call only makes sense if 'message' was ultimately
663 * obtained from a notmuch_thread_t object, (such as by coming
664 * directly from the result of calling notmuch_thread_get_
665 * toplevel_messages or by any number of subsequent
666 * calls to notmuch_message_get_replies).
668 * If 'message' was obtained through some non-thread means, (such as
669 * by a call to notmuch_query_search_messages), then this function
672 * If there are no replies to 'message', this function will return
673 * NULL. (Note that notmuch_messages_has_more will accept that NULL
674 * value as legitimate, and simply return FALSE for it.)
677 notmuch_message_get_replies (notmuch_message_t *message);
679 /* Get a filename for the email corresponding to 'message'.
681 * The returned filename is an absolute filename, (the initial
682 * component will match notmuch_database_get_path() ).
684 * The returned string belongs to the message so should not be
685 * modified or freed by the caller (nor should it be referenced after
686 * the message is destroyed).
688 * Note: If this message corresponds to multiple files in the mail
689 * store, (that is, multiple files contain identical message IDs),
690 * this function will arbitrarily return a single one of those
694 notmuch_message_get_filename (notmuch_message_t *message);
697 typedef enum _notmuch_message_flag {
698 NOTMUCH_MESSAGE_FLAG_MATCH,
699 } notmuch_message_flag_t;
701 /* Get a value of a flag for the email corresponding to 'message'. */
703 notmuch_message_get_flag (notmuch_message_t *message,
704 notmuch_message_flag_t flag);
706 /* Set a value of a flag for the email corresponding to 'message'. */
708 notmuch_message_set_flag (notmuch_message_t *message,
709 notmuch_message_flag_t flag, notmuch_bool_t value);
711 /* Get the date of 'message' as a time_t value.
713 * For the original textual representation of the Date header from the
714 * message call notmuch_message_get_header() with a header value of
717 notmuch_message_get_date (notmuch_message_t *message);
719 /* Get the value of the specified header from 'message'.
721 * The value will be read from the actual message file, not from the
722 * notmuch database. The header name is case insensitive.
724 * The returned string belongs to the message so should not be
725 * modified or freed by the caller (nor should it be referenced after
726 * the message is destroyed).
728 * Returns an empty string ("") if the message does not contain a
729 * header line matching 'header'. Returns NULL if any error occurs.
732 notmuch_message_get_header (notmuch_message_t *message, const char *header);
734 /* Get the tags for 'message', returning a notmuch_tags_t object which
735 * can be used to iterate over all tags.
737 * The tags object is owned by the message and as such, will only be
738 * valid for as long as the message is valid, (which is until the
739 * query from which it derived is destroyed).
741 * Typical usage might be:
743 * notmuch_message_t *message;
744 * notmuch_tags_t *tags;
747 * message = notmuch_database_find_message (database, message_id);
749 * for (tags = notmuch_message_get_tags (message);
750 * notmuch_tags_has_more (tags);
751 * notmuch_result_advance (tags))
753 * tag = notmuch_tags_get (tags);
757 * notmuch_message_destroy (message);
759 * Note that there's no explicit destructor needed for the
760 * notmuch_tags_t object. (For consistency, we do provide a
761 * notmuch_tags_destroy function, but there's no good reason to call
762 * it if the message is about to be destroyed).
765 notmuch_message_get_tags (notmuch_message_t *message);
767 /* The longest possible tag value. */
768 #define NOTMUCH_TAG_MAX 200
770 /* Add a tag to the given message.
774 * NOTMUCH_STATUS_SUCCESS: Tag successfully added to message
776 * NOTMUCH_STATUS_NULL_POINTER: The 'tag' argument is NULL
778 * NOTMUCH_STATUS_TAG_TOO_LONG: The length of 'tag' is too long
779 * (exceeds NOTMUCH_TAG_MAX)
782 notmuch_message_add_tag (notmuch_message_t *message, const char *tag);
784 /* Remove a tag from the given message.
788 * NOTMUCH_STATUS_SUCCESS: Tag successfully removed from message
790 * NOTMUCH_STATUS_NULL_POINTER: The 'tag' argument is NULL
792 * NOTMUCH_STATUS_TAG_TOO_LONG: The length of 'tag' is too long
793 * (exceeds NOTMUCH_TAG_MAX)
796 notmuch_message_remove_tag (notmuch_message_t *message, const char *tag);
798 /* Remove all tags from the given message.
800 * See notmuch_message_freeze for an example showing how to safely
801 * replace tag values.
804 notmuch_message_remove_all_tags (notmuch_message_t *message);
806 /* Freeze the current state of 'message' within the database.
808 * This means that changes to the message state, (via
809 * notmuch_message_add_tag, notmuch_message_remove_tag, and
810 * notmuch_message_remove_all_tags), will not be committed to the
811 * database until the message is thawed with notmuch_message_thaw.
813 * Multiple calls to freeze/thaw are valid and these calls with
814 * "stack". That is there must be as many calls to thaw as to freeze
815 * before a message is actually thawed.
817 * The ability to do freeze/thaw allows for safe transactions to
818 * change tag values. For example, explicitly setting a message to
819 * have a given set of tags might look like this:
821 * notmuch_message_freeze (message);
823 * notmuch_message_remove_all_tags (message);
825 * for (i = 0; i < NUM_TAGS; i++)
826 * notmuch_message_add_tag (message, tags[i]);
828 * notmuch_message_thaw (message);
830 * With freeze/thaw used like this, the message in the database is
831 * guaranteed to have either the full set of original tag value, or
832 * the full set of new tag values, but nothing in between.
834 * Imagine the example above without freeze/thaw and the operation
835 * somehow getting interrupted. This could result in the message being
836 * left with no tags if the interruption happened after
837 * notmuch_message_remove_all_tags but before notmuch_message_add_tag.
840 notmuch_message_freeze (notmuch_message_t *message);
842 /* Thaw the current 'message', synchronizing any changes that may have
843 * occurred while 'message' was frozen into the notmuch database.
845 * See notmuch_message_freeze for an example of how to use this
846 * function to safely provide tag changes.
848 * Multiple calls to freeze/thaw are valid and these calls with
849 * "stack". That is there must be as many calls to thaw as to freeze
850 * before a message is actually thawed.
854 * NOTMUCH_STATUS_SUCCESS: Message successfully thawed, (or at least
855 * its frozen count has successfully been reduced by 1).
857 * NOTMUCH_STATUS_UNBALANCE_FREEZE_THAW: An attempt was made to thaw
858 * an unfrozen message. That is, there have been an unbalanced
859 * number of calls to notmuch_message_freeze and
860 * notmuch_message_thaw.
863 notmuch_message_thaw (notmuch_message_t *message);
865 /* Destroy a notmuch_message_t object.
867 * It can be useful to call this function in the case of a single
868 * query object with many messages in the result, (such as iterating
869 * over the entire database). Otherwise, it's fine to never call this
870 * function and there will still be no memory leaks. (The memory from
871 * the messages get reclaimed when the containing query is destroyed.)
874 notmuch_message_destroy (notmuch_message_t *message);
876 /* Does the given notmuch_tags_t object contain any more tags.
878 * When this function returns TRUE, notmuch_tags_get will return a
879 * valid string. Whereas when this function returns FALSE,
880 * notmuch_tags_get will return NULL.
882 * See the documentation of notmuch_message_get_tags for example code
883 * showing how to iterate over a notmuch_tags_t object.
886 notmuch_tags_has_more (notmuch_tags_t *tags);
888 /* Get the current tag from 'tags' as a string.
890 * Note: The returned string belongs to 'tags' and has a lifetime
891 * identical to it (and the query to which it ultimately belongs).
893 * See the documentation of notmuch_message_get_tags for example code
894 * showing how to iterate over a notmuch_tags_t object.
897 notmuch_tags_get (notmuch_tags_t *tags);
899 /* Advance the 'tags' iterator to the next tag.
901 * See the documentation of notmuch_message_get_tags for example code
902 * showing how to iterate over a notmuch_tags_t object.
905 notmuch_tags_advance (notmuch_tags_t *tags);
907 /* Destroy a notmuch_tags_t object.
909 * It's not strictly necessary to call this function. All memory from
910 * the notmuch_tags_t object will be reclaimed when the containing
911 * message or query objects are destroyed.
914 notmuch_tags_destroy (notmuch_tags_t *tags);
916 /* Store an mtime within the database for 'directory'.
918 * The 'directory' should be an object retrieved from the database
919 * with notmuch_database_get_directory for a particular path.
921 * The intention is for the caller to use the mtime to allow efficient
922 * identification of new messages to be added to the database. The
923 * recommended usage is as follows:
925 * o Read the mtime of a directory from the filesystem
927 * o Call add_message for all mail files in the directory
929 * o Call notmuch_directory_set_mtime with the mtime read from the
932 * Then, when wanting to check for updates to the directory in the
933 * future, the client can call notmuch_directory_get_mtime and know
934 * that it only needs to add files if the mtime of the directory and
935 * files are newer than the stored timestamp.
937 * Note: The notmuch_directory_get_mtime function does not allow the
938 * caller to distinguish a timestamp of 0 from a non-existent
939 * timestamp. So don't store a timestamp of 0 unless you are
940 * comfortable with that.
944 * NOTMUCH_STATUS_SUCCESS: mtime successfully stored in database.
946 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception
947 * occurred, mtime not stored.
950 notmuch_directory_set_mtime (notmuch_directory_t *directory,
953 /* Get the mtime of a directory, (as previously stored with
954 * notmuch_directory_set_mtime).
956 * Returns 0 if not mtime has previously been stored for this
959 notmuch_directory_get_mtime (notmuch_directory_t *directory);
961 /* Get a notmuch_filenames_t iterator listing all the filenames of
962 * messages in the database within the given directory.
964 * The returned filenames will be the basename-entries only (not
965 * complete paths). */
966 notmuch_filenames_t *
967 notmuch_directory_get_child_files (notmuch_directory_t *directory);
969 /* Get a notmuch_filenams_t iterator listing all the filenames of
970 * sub-directories in the database within the given directory.
972 * The returned filenames will be the basename-entries only (not
973 * complete paths). */
974 notmuch_filenames_t *
975 notmuch_directory_get_child_directories (notmuch_directory_t *directory);
977 /* Destroy a notmuch_directory_t object. */
979 notmuch_directory_destroy (notmuch_directory_t *directory);
981 /* Does the given notmuch_filenames_t object contain any more
984 * When this function returns TRUE, notmuch_filenames_get will return
985 * a valid string. Whereas when this function returns FALSE,
986 * notmuch_filenames_get will return NULL.
989 notmuch_filenames_has_more (notmuch_filenames_t *filenames);
991 /* Get the current filename from 'filenames' as a string.
993 * Note: The returned string belongs to 'filenames' and has a lifetime
994 * identical to it (and the directory to which it ultimately belongs).
997 notmuch_filenames_get (notmuch_filenames_t *filenames);
999 /* Advance the 'filenames' iterator to the next filename.
1002 notmuch_filenames_advance (notmuch_filenames_t *filenames);
1004 /* Destroy a notmuch_filenames_t object.
1006 * It's not strictly necessary to call this function. All memory from
1007 * the notmuch_filenames_t object will be reclaimed when the
1008 * containing directory object is destroyed.
1011 notmuch_filenames_destroy (notmuch_filenames_t *filenames);