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.
86 * NOTMUCH_STATUS_LAST_STATUS: Not an actual status value. Just a way
87 * to find out how many valid status values there are.
89 typedef enum _notmuch_status {
90 NOTMUCH_STATUS_SUCCESS = 0,
91 NOTMUCH_STATUS_OUT_OF_MEMORY,
92 NOTMUCH_STATUS_READ_ONLY_DATABASE,
93 NOTMUCH_STATUS_XAPIAN_EXCEPTION,
94 NOTMUCH_STATUS_FILE_ERROR,
95 NOTMUCH_STATUS_FILE_NOT_EMAIL,
96 NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID,
97 NOTMUCH_STATUS_NULL_POINTER,
98 NOTMUCH_STATUS_TAG_TOO_LONG,
99 NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW,
101 NOTMUCH_STATUS_LAST_STATUS
104 /* Get a string representation of a notmuch_status_t value.
106 * The result is readonly.
109 notmuch_status_to_string (notmuch_status_t status);
111 /* Various opaque data types. For each notmuch_<foo>_t see the various
112 * notmuch_<foo> functions below. */
113 typedef struct _notmuch_database notmuch_database_t;
114 typedef struct _notmuch_query notmuch_query_t;
115 typedef struct _notmuch_threads notmuch_threads_t;
116 typedef struct _notmuch_thread notmuch_thread_t;
117 typedef struct _notmuch_messages notmuch_messages_t;
118 typedef struct _notmuch_message notmuch_message_t;
119 typedef struct _notmuch_tags notmuch_tags_t;
120 typedef struct _notmuch_directory notmuch_directory_t;
121 typedef struct _notmuch_filenames notmuch_filenames_t;
123 /* Create a new, empty notmuch database located at 'path'.
125 * The path should be a top-level directory to a collection of
126 * plain-text email messages (one message per file). This call will
127 * create a new ".notmuch" directory within 'path' where notmuch will
130 * After a successful call to notmuch_database_create, the returned
131 * database will be open so the caller should call
132 * notmuch_database_close when finished with it.
134 * The database will not yet have any data in it
135 * (notmuch_database_create itself is a very cheap function). Messages
136 * contained within 'path' can be added to the database by calling
137 * notmuch_database_add_message.
139 * In case of any failure, this function returns NULL, (after printing
140 * an error message on stderr).
143 notmuch_database_create (const char *path);
146 NOTMUCH_DATABASE_MODE_READ_ONLY = 0,
147 NOTMUCH_DATABASE_MODE_READ_WRITE
148 } notmuch_database_mode_t;
150 /* XXX: I think I'd like this to take an extra argument of
151 * notmuch_status_t* for returning a status value on failure. */
153 /* Open an existing notmuch database located at 'path'.
155 * The database should have been created at some time in the past,
156 * (not necessarily by this process), by calling
157 * notmuch_database_create with 'path'. By default the database should be
158 * opened for reading only. In order to write to the database you need to
159 * pass the NOTMUCH_DATABASE_MODE_READ_WRITE mode.
161 * An existing notmuch database can be identified by the presence of a
162 * directory named ".notmuch" below 'path'.
164 * The caller should call notmuch_database_close when finished with
167 * In case of any failure, this function returns NULL, (after printing
168 * an error message on stderr).
171 notmuch_database_open (const char *path,
172 notmuch_database_mode_t mode);
174 /* Close the given notmuch database, freeing all associated
175 * resources. See notmuch_database_open. */
177 notmuch_database_close (notmuch_database_t *database);
179 /* Return the database path of the given database.
181 * The return value is a string owned by notmuch so should not be
182 * modified nor freed by the caller. */
184 notmuch_database_get_path (notmuch_database_t *database);
186 /* Return the database format version of the given database. */
188 notmuch_database_get_version (notmuch_database_t *database);
190 /* Does this database need to be upgraded before writing to it?
192 * If this function returns TRUE then no functions that modify the
193 * database (notmuch_database_add_message, notmuch_message_add_tag,
194 * notmuch_directory_set_mtime, etc.) will work unless the function
195 * notmuch_database_upgrade is called successfully first. */
197 notmuch_database_needs_upgrade (notmuch_database_t *database);
199 /* Upgrade the current database.
201 * After opening a database in read-write mode, the client should
202 * check if an upgrade is needed (notmuch_database_needs_upgrade) and
203 * if so, upgrade with this function before making any modifications.
205 * The optional progress_notify callback can be used by the caller to
206 * provide progress indication to the user. If non-NULL it will be
207 * called periodically with 'progress' as a floating-point value in
208 * the range of [0.0 .. 1.0] indicating the progress made so far in
209 * the upgrade process.
212 notmuch_database_upgrade (notmuch_database_t *database,
213 void (*progress_notify) (void *closure,
217 /* Retrieve a directory object from the database for 'path'.
219 * Here, 'path' should be a path relative to the path of 'database'
220 * (see notmuch_database_get_path), or else should be an absolute path
221 * with initial components that match the path of 'database'.
223 * Can return NULL if a Xapian exception occurs.
225 notmuch_directory_t *
226 notmuch_database_get_directory (notmuch_database_t *database,
229 /* Add a new message to the given notmuch database.
231 * Here,'filename' should be a path relative to the path of
232 * 'database' (see notmuch_database_get_path), or else should be an
233 * absolute filename with initial components that match the path of
236 * The file should be a single mail message (not a multi-message mbox)
237 * that is expected to remain at its current location, (since the
238 * notmuch database will reference the filename, and will not copy the
239 * entire contents of the file.
241 * If 'message' is not NULL, then, on successful return '*message'
242 * will be initialized to a message object that can be used for things
243 * such as adding tags to the just-added message. The user should call
244 * notmuch_message_destroy when done with the message. On any failure
245 * '*message' will be set to NULL.
249 * NOTMUCH_STATUS_SUCCESS: Message successfully added to database.
251 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred,
254 * NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID: Message has the same message
255 * ID as another message already in the database. The new
256 * filename was successfully added to the message in the database
257 * (if not already present).
259 * NOTMUCH_STATUS_FILE_ERROR: an error occurred trying to open the
260 * file, (such as permission denied, or file not found,
261 * etc.). Nothing added to the database.
263 * NOTMUCH_STATUS_FILE_NOT_EMAIL: the contents of filename don't look
264 * like an email message. Nothing added to the database.
266 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
267 * mode so no message can be added.
270 notmuch_database_add_message (notmuch_database_t *database,
271 const char *filename,
272 notmuch_message_t **message);
274 /* Remove a message from the given notmuch database.
276 * Note that only this particular filename association is removed from
277 * the database. If the same message (as determined by the message ID)
278 * is still available via other filenames, then the message will
279 * persist in the database for those filenames. When the last filename
280 * is removed for a particular message, the database content for that
281 * message will be entirely removed.
285 * NOTMUCH_STATUS_SUCCESS: The last filename was removed and the
286 * message was removed from the database.
288 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred,
289 * message not removed.
291 * NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID: This filename was removed but
292 * the message persists in the database with at least one other
295 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
296 * mode so no message can be removed.
299 notmuch_database_remove_message (notmuch_database_t *database,
300 const char *filename);
302 /* Find a message with the given message_id.
304 * If the database contains a message with the given message_id, then
305 * a new notmuch_message_t object is returned. The caller should call
306 * notmuch_message_destroy when done with the message.
308 * This function returns NULL in the following situations:
310 * * No message is found with the given message_id
311 * * An out-of-memory situation occurs
312 * * A Xapian exception occurs
315 notmuch_database_find_message (notmuch_database_t *database,
316 const char *message_id);
318 /* Return a list of all tags found in the database.
320 * This function creates a list of all tags found in the database. The
321 * resulting list contains all tags from all messages found in the database.
323 * On error this function returns NULL.
326 notmuch_database_get_all_tags (notmuch_database_t *db);
328 /* Create a new query for 'database'.
330 * Here, 'database' should be an open database, (see
331 * notmuch_database_open and notmuch_database_create).
333 * For the query string, we'll document the syntax here more
334 * completely in the future, but it's likely to be a specialized
335 * version of the general Xapian query syntax:
337 * http://xapian.org/docs/queryparser.html
339 * As a special case, passing either a length-zero string, (that is ""),
340 * or a string consisting of a single asterisk (that is "*"), will
341 * result in a query that returns all messages in the database.
343 * See notmuch_query_set_sort for controlling the order of results.
344 * See notmuch_query_search_messages and notmuch_query_search_threads
345 * to actually execute the query.
347 * User should call notmuch_query_destroy when finished with this
350 * Will return NULL if insufficient memory is available.
353 notmuch_query_create (notmuch_database_t *database,
354 const char *query_string);
356 /* Sort values for notmuch_query_set_sort */
358 NOTMUCH_SORT_OLDEST_FIRST,
359 NOTMUCH_SORT_NEWEST_FIRST,
360 NOTMUCH_SORT_MESSAGE_ID,
361 NOTMUCH_SORT_UNSORTED
364 /* Return the query_string of this query. See notmuch_query_create. */
366 notmuch_query_get_query_string (notmuch_query_t *query);
368 /* Specify the sorting desired for this query. */
370 notmuch_query_set_sort (notmuch_query_t *query, notmuch_sort_t sort);
372 /* Return the sort specified for this query. See notmuch_query_set_sort. */
374 notmuch_query_get_sort (notmuch_query_t *query);
376 /* Execute a query for threads, returning a notmuch_threads_t object
377 * which can be used to iterate over the results. The returned threads
378 * object is owned by the query and as such, will only be valid until
379 * notmuch_query_destroy.
381 * Typical usage might be:
383 * notmuch_query_t *query;
384 * notmuch_threads_t *threads;
385 * notmuch_thread_t *thread;
387 * query = notmuch_query_create (database, query_string);
389 * for (threads = notmuch_query_search_threads (query);
390 * notmuch_threads_valid (threads);
391 * notmuch_threads_move_to_next (threads))
393 * thread = notmuch_threads_get (threads);
395 * notmuch_thread_destroy (thread);
398 * notmuch_query_destroy (query);
400 * Note: If you are finished with a thread before its containing
401 * query, you can call notmuch_thread_destroy to clean up some memory
402 * sooner (as in the above example). Otherwise, if your thread objects
403 * are long-lived, then you don't need to call notmuch_thread_destroy
404 * and all the memory will still be reclaimed when the query is
407 * Note that there's no explicit destructor needed for the
408 * notmuch_threads_t object. (For consistency, we do provide a
409 * notmuch_threads_destroy function, but there's no good reason
410 * to call it if the query is about to be destroyed).
412 * If a Xapian exception occurs this function will return NULL.
415 notmuch_query_search_threads (notmuch_query_t *query);
417 /* Execute a query for messages, returning a notmuch_messages_t object
418 * which can be used to iterate over the results. The returned
419 * messages object is owned by the query and as such, will only be
420 * valid until notmuch_query_destroy.
422 * Typical usage might be:
424 * notmuch_query_t *query;
425 * notmuch_messages_t *messages;
426 * notmuch_message_t *message;
428 * query = notmuch_query_create (database, query_string);
430 * for (messages = notmuch_query_search_messages (query);
431 * notmuch_messages_valid (messages);
432 * notmuch_messages_move_to_next (messages))
434 * message = notmuch_messages_get (messages);
436 * notmuch_message_destroy (message);
439 * notmuch_query_destroy (query);
441 * Note: If you are finished with a message before its containing
442 * query, you can call notmuch_message_destroy to clean up some memory
443 * sooner (as in the above example). Otherwise, if your message
444 * objects are long-lived, then you don't need to call
445 * notmuch_message_destroy and all the memory will still be reclaimed
446 * when the query is destroyed.
448 * Note that there's no explicit destructor needed for the
449 * notmuch_messages_t object. (For consistency, we do provide a
450 * notmuch_messages_destroy function, but there's no good
451 * reason to call it if the query is about to be destroyed).
453 * If a Xapian exception occurs this function will return NULL.
456 notmuch_query_search_messages (notmuch_query_t *query);
458 /* Destroy a notmuch_query_t along with any associated resources.
460 * This will in turn destroy any notmuch_threads_t and
461 * notmuch_messages_t objects generated by this query, (and in
462 * turn any notmuch_thread_t and notmuch_message_t objects generated
463 * from those results, etc.), if such objects haven't already been
467 notmuch_query_destroy (notmuch_query_t *query);
469 /* Is the given 'threads' iterator pointing at a valid thread.
471 * When this function returns TRUE, notmuch_threads_get will return a
472 * valid object. Whereas when this function returns FALSE,
473 * notmuch_threads_get will return NULL.
475 * See the documentation of notmuch_query_search_threads for example
476 * code showing how to iterate over a notmuch_threads_t object.
479 notmuch_threads_valid (notmuch_threads_t *threads);
481 /* Get the current thread from 'threads' as a notmuch_thread_t.
483 * Note: The returned thread belongs to 'threads' and has a lifetime
484 * identical to it (and the query to which it belongs).
486 * See the documentation of notmuch_query_search_threads for example
487 * code showing how to iterate over a notmuch_threads_t object.
489 * If an out-of-memory situation occurs, this function will return
493 notmuch_threads_get (notmuch_threads_t *threads);
495 /* Move the 'threads' iterator to the next thread.
497 * If 'threads' is already pointing at the last thread then the
498 * iterator will be moved to a point just beyond that last thread,
499 * (where notmuch_threads_valid will return FALSE and
500 * notmuch_threads_get will return NULL).
502 * See the documentation of notmuch_query_search_threads for example
503 * code showing how to iterate over a notmuch_threads_t object.
506 notmuch_threads_move_to_next (notmuch_threads_t *threads);
508 /* Destroy a notmuch_threads_t object.
510 * It's not strictly necessary to call this function. All memory from
511 * the notmuch_threads_t object will be reclaimed when the
512 * containg query object is destroyed.
515 notmuch_threads_destroy (notmuch_threads_t *threads);
517 /* Return an estimate of the number of messages matching a search
519 * This function performs a search and returns Xapian's best
520 * guess as to number of matching messages.
522 * If a Xapian exception occurs, this function may return 0 (after
523 * printing a message).
526 notmuch_query_count_messages (notmuch_query_t *query);
528 /* Get the thread ID of 'thread'.
530 * The returned string belongs to 'thread' and as such, should not be
531 * modified by the caller and will only be valid for as long as the
532 * thread is valid, (which is until notmuch_thread_destroy or until
533 * the query from which it derived is destroyed).
536 notmuch_thread_get_thread_id (notmuch_thread_t *thread);
538 /* Get the total number of messages in 'thread'.
540 * This count consists of all messages in the database belonging to
541 * this thread. Contrast with notmuch_thread_get_matched_messages() .
544 notmuch_thread_get_total_messages (notmuch_thread_t *thread);
546 /* Get a notmuch_messages_t iterator for the top-level messages in
549 * This iterator will not necessarily iterate over all of the messages
550 * in the thread. It will only iterate over the messages in the thread
551 * which are not replies to other messages in the thread.
553 * To iterate over all messages in the thread, the caller will need to
554 * iterate over the result of notmuch_message_get_replies for each
555 * top-level message (and do that recursively for the resulting
559 notmuch_thread_get_toplevel_messages (notmuch_thread_t *thread);
561 /* Get the number of messages in 'thread' that matched the search.
563 * This count includes only the messages in this thread that were
564 * matched by the search from which the thread was created. Contrast
565 * with notmuch_thread_get_total_messages() .
568 notmuch_thread_get_matched_messages (notmuch_thread_t *thread);
570 /* Get the authors of 'thread'
572 * The returned string is a comma-separated list of the names of the
573 * authors of mail messages in the query results that belong to this
576 * The returned string belongs to 'thread' and as such, should not be
577 * modified by the caller and will only be valid for as long as the
578 * thread is valid, (which is until notmuch_thread_destroy or until
579 * the query from which it derived is destroyed).
582 notmuch_thread_get_authors (notmuch_thread_t *thread);
584 /* Get the subject of 'thread'
586 * The subject is taken from the first message (according to the query
587 * order---see notmuch_query_set_sort) in the query results that
588 * belongs to this thread.
590 * The returned string belongs to 'thread' and as such, should not be
591 * modified by the caller and will only be valid for as long as the
592 * thread is valid, (which is until notmuch_thread_destroy or until
593 * the query from which it derived is destroyed).
596 notmuch_thread_get_subject (notmuch_thread_t *thread);
598 /* Get the date of the oldest message in 'thread' as a time_t value.
601 notmuch_thread_get_oldest_date (notmuch_thread_t *thread);
603 /* Get the date of the newest message in 'thread' as a time_t value.
606 notmuch_thread_get_newest_date (notmuch_thread_t *thread);
608 /* Get the tags for 'thread', returning a notmuch_tags_t object which
609 * can be used to iterate over all tags.
611 * Note: In the Notmuch database, tags are stored on individual
612 * messages, not on threads. So the tags returned here will be all
613 * tags of the messages which matched the search and which belong to
616 * The tags object is owned by the thread and as such, will only be
617 * valid for as long as the thread is valid, (for example, until
618 * notmuch_thread_destroy or until the query from which it derived is
621 * Typical usage might be:
623 * notmuch_thread_t *thread;
624 * notmuch_tags_t *tags;
627 * thread = notmuch_threads_get (threads);
629 * for (tags = notmuch_thread_get_tags (thread);
630 * notmuch_tags_valid (tags);
631 * notmuch_result_move_to_next (tags))
633 * tag = notmuch_tags_get (tags);
637 * notmuch_thread_destroy (thread);
639 * Note that there's no explicit destructor needed for the
640 * notmuch_tags_t object. (For consistency, we do provide a
641 * notmuch_tags_destroy function, but there's no good reason to call
642 * it if the message is about to be destroyed).
645 notmuch_thread_get_tags (notmuch_thread_t *thread);
647 /* Destroy a notmuch_thread_t object. */
649 notmuch_thread_destroy (notmuch_thread_t *thread);
651 /* Is the given 'messages' iterator pointing at a valid message.
653 * When this function returns TRUE, notmuch_messages_get will return a
654 * valid object. Whereas when this function returns FALSE,
655 * notmuch_messages_get will return NULL.
657 * See the documentation of notmuch_query_search_messages for example
658 * code showing how to iterate over a notmuch_messages_t object.
661 notmuch_messages_valid (notmuch_messages_t *messages);
663 /* Get the current message from 'messages' as a notmuch_message_t.
665 * Note: The returned message belongs to 'messages' and has a lifetime
666 * identical to it (and the query to which it belongs).
668 * See the documentation of notmuch_query_search_messages for example
669 * code showing how to iterate over a notmuch_messages_t object.
671 * If an out-of-memory situation occurs, this function will return
675 notmuch_messages_get (notmuch_messages_t *messages);
677 /* Move the 'messages' iterator to the next message.
679 * If 'messages' is already pointing at the last message then the
680 * iterator will be moved to a point just beyond that last message,
681 * (where notmuch_messages_valid will return FALSE and
682 * notmuch_messages_get will return NULL).
684 * See the documentation of notmuch_query_search_messages for example
685 * code showing how to iterate over a notmuch_messages_t object.
688 notmuch_messages_move_to_next (notmuch_messages_t *messages);
690 /* Destroy a notmuch_messages_t object.
692 * It's not strictly necessary to call this function. All memory from
693 * the notmuch_messages_t object will be reclaimed when the containing
694 * query object is destroyed.
697 notmuch_messages_destroy (notmuch_messages_t *messages);
699 /* Return a list of tags from all messages.
701 * The resulting list is guaranteed not to contain duplicated tags.
703 * WARNING: You can no longer iterate over messages after calling this
704 * function, because the iterator will point at the end of the list.
705 * We do not have a function to reset the iterator yet and the only
706 * way how you can iterate over the list again is to recreate the
709 * The function returns NULL on error.
712 notmuch_messages_collect_tags (notmuch_messages_t *messages);
714 /* Get the message ID of 'message'.
716 * The returned string belongs to 'message' and as such, should not be
717 * modified by the caller and will only be valid for as long as the
718 * message is valid, (which is until the query from which it derived
721 * This function will not return NULL since Notmuch ensures that every
722 * message has a unique message ID, (Notmuch will generate an ID for a
723 * message if the original file does not contain one).
726 notmuch_message_get_message_id (notmuch_message_t *message);
728 /* Get the thread ID of 'message'.
730 * The returned string belongs to 'message' and as such, should not be
731 * modified by the caller and will only be valid for as long as the
732 * message is valid, (for example, until the user calls
733 * notmuch_message_destroy on 'message' or until a query from which it
734 * derived is destroyed).
736 * This function will not return NULL since Notmuch ensures that every
737 * message belongs to a single thread.
740 notmuch_message_get_thread_id (notmuch_message_t *message);
742 /* Get a notmuch_messages_t iterator for all of the replies to
745 * Note: This call only makes sense if 'message' was ultimately
746 * obtained from a notmuch_thread_t object, (such as by coming
747 * directly from the result of calling notmuch_thread_get_
748 * toplevel_messages or by any number of subsequent
749 * calls to notmuch_message_get_replies).
751 * If 'message' was obtained through some non-thread means, (such as
752 * by a call to notmuch_query_search_messages), then this function
755 * If there are no replies to 'message', this function will return
756 * NULL. (Note that notmuch_messages_valid will accept that NULL
757 * value as legitimate, and simply return FALSE for it.)
760 notmuch_message_get_replies (notmuch_message_t *message);
762 /* Get a filename for the email corresponding to 'message'.
764 * The returned filename is an absolute filename, (the initial
765 * component will match notmuch_database_get_path() ).
767 * The returned string belongs to the message so should not be
768 * modified or freed by the caller (nor should it be referenced after
769 * the message is destroyed).
771 * Note: If this message corresponds to multiple files in the mail
772 * store, (that is, multiple files contain identical message IDs),
773 * this function will arbitrarily return a single one of those
777 notmuch_message_get_filename (notmuch_message_t *message);
780 typedef enum _notmuch_message_flag {
781 NOTMUCH_MESSAGE_FLAG_MATCH,
782 } notmuch_message_flag_t;
784 /* Get a value of a flag for the email corresponding to 'message'. */
786 notmuch_message_get_flag (notmuch_message_t *message,
787 notmuch_message_flag_t flag);
789 /* Set a value of a flag for the email corresponding to 'message'. */
791 notmuch_message_set_flag (notmuch_message_t *message,
792 notmuch_message_flag_t flag, notmuch_bool_t value);
794 /* Get the date of 'message' as a time_t value.
796 * For the original textual representation of the Date header from the
797 * message call notmuch_message_get_header() with a header value of
800 notmuch_message_get_date (notmuch_message_t *message);
802 /* Get the value of the specified header from 'message'.
804 * The value will be read from the actual message file, not from the
805 * notmuch database. The header name is case insensitive.
807 * The returned string belongs to the message so should not be
808 * modified or freed by the caller (nor should it be referenced after
809 * the message is destroyed).
811 * Returns an empty string ("") if the message does not contain a
812 * header line matching 'header'. Returns NULL if any error occurs.
815 notmuch_message_get_header (notmuch_message_t *message, const char *header);
817 /* Get the tags for 'message', returning a notmuch_tags_t object which
818 * can be used to iterate over all tags.
820 * The tags object is owned by the message and as such, will only be
821 * valid for as long as the message is valid, (which is until the
822 * query from which it derived is destroyed).
824 * Typical usage might be:
826 * notmuch_message_t *message;
827 * notmuch_tags_t *tags;
830 * message = notmuch_database_find_message (database, message_id);
832 * for (tags = notmuch_message_get_tags (message);
833 * notmuch_tags_valid (tags);
834 * notmuch_result_move_to_next (tags))
836 * tag = notmuch_tags_get (tags);
840 * notmuch_message_destroy (message);
842 * Note that there's no explicit destructor needed for the
843 * notmuch_tags_t object. (For consistency, we do provide a
844 * notmuch_tags_destroy function, but there's no good reason to call
845 * it if the message is about to be destroyed).
848 notmuch_message_get_tags (notmuch_message_t *message);
850 /* The longest possible tag value. */
851 #define NOTMUCH_TAG_MAX 200
853 /* Add a tag to the given message.
857 * NOTMUCH_STATUS_SUCCESS: Tag successfully added to message
859 * NOTMUCH_STATUS_NULL_POINTER: The 'tag' argument is NULL
861 * NOTMUCH_STATUS_TAG_TOO_LONG: The length of 'tag' is too long
862 * (exceeds NOTMUCH_TAG_MAX)
864 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
865 * mode so message cannot be modified.
868 notmuch_message_add_tag (notmuch_message_t *message, const char *tag);
870 /* Remove a tag from the given message.
874 * NOTMUCH_STATUS_SUCCESS: Tag successfully removed from message
876 * NOTMUCH_STATUS_NULL_POINTER: The 'tag' argument is NULL
878 * NOTMUCH_STATUS_TAG_TOO_LONG: The length of 'tag' is too long
879 * (exceeds NOTMUCH_TAG_MAX)
881 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
882 * mode so message cannot be modified.
885 notmuch_message_remove_tag (notmuch_message_t *message, const char *tag);
887 /* Remove all tags from the given message.
889 * See notmuch_message_freeze for an example showing how to safely
890 * replace tag values.
892 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
893 * mode so message cannot be modified.
896 notmuch_message_remove_all_tags (notmuch_message_t *message);
898 /* Freeze the current state of 'message' within the database.
900 * This means that changes to the message state, (via
901 * notmuch_message_add_tag, notmuch_message_remove_tag, and
902 * notmuch_message_remove_all_tags), will not be committed to the
903 * database until the message is thawed with notmuch_message_thaw.
905 * Multiple calls to freeze/thaw are valid and these calls will
906 * "stack". That is there must be as many calls to thaw as to freeze
907 * before a message is actually thawed.
909 * The ability to do freeze/thaw allows for safe transactions to
910 * change tag values. For example, explicitly setting a message to
911 * have a given set of tags might look like this:
913 * notmuch_message_freeze (message);
915 * notmuch_message_remove_all_tags (message);
917 * for (i = 0; i < NUM_TAGS; i++)
918 * notmuch_message_add_tag (message, tags[i]);
920 * notmuch_message_thaw (message);
922 * With freeze/thaw used like this, the message in the database is
923 * guaranteed to have either the full set of original tag values, or
924 * the full set of new tag values, but nothing in between.
926 * Imagine the example above without freeze/thaw and the operation
927 * somehow getting interrupted. This could result in the message being
928 * left with no tags if the interruption happened after
929 * notmuch_message_remove_all_tags but before notmuch_message_add_tag.
933 * NOTMUCH_STATUS_SUCCESS: Message successfully frozen.
935 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
936 * mode so message cannot be modified.
939 notmuch_message_freeze (notmuch_message_t *message);
941 /* Thaw the current 'message', synchronizing any changes that may have
942 * occurred while 'message' was frozen into the notmuch database.
944 * See notmuch_message_freeze for an example of how to use this
945 * function to safely provide tag changes.
947 * Multiple calls to freeze/thaw are valid and these calls with
948 * "stack". That is there must be as many calls to thaw as to freeze
949 * before a message is actually thawed.
953 * NOTMUCH_STATUS_SUCCESS: Message successfully thawed, (or at least
954 * its frozen count has successfully been reduced by 1).
956 * NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW: An attempt was made to thaw
957 * an unfrozen message. That is, there have been an unbalanced
958 * number of calls to notmuch_message_freeze and
959 * notmuch_message_thaw.
962 notmuch_message_thaw (notmuch_message_t *message);
964 /* Destroy a notmuch_message_t object.
966 * It can be useful to call this function in the case of a single
967 * query object with many messages in the result, (such as iterating
968 * over the entire database). Otherwise, it's fine to never call this
969 * function and there will still be no memory leaks. (The memory from
970 * the messages get reclaimed when the containing query is destroyed.)
973 notmuch_message_destroy (notmuch_message_t *message);
975 /* Is the given 'tags' iterator pointing at a valid tag.
977 * When this function returns TRUE, notmuch_tags_get will return a
978 * valid string. Whereas when this function returns FALSE,
979 * notmuch_tags_get will return NULL.
981 * See the documentation of notmuch_message_get_tags for example code
982 * showing how to iterate over a notmuch_tags_t object.
985 notmuch_tags_valid (notmuch_tags_t *tags);
987 /* Get the current tag from 'tags' as a string.
989 * Note: The returned string belongs to 'tags' and has a lifetime
990 * identical to it (and the query to which it ultimately belongs).
992 * See the documentation of notmuch_message_get_tags for example code
993 * showing how to iterate over a notmuch_tags_t object.
996 notmuch_tags_get (notmuch_tags_t *tags);
998 /* Move the 'tags' iterator to the next tag.
1000 * If 'tags' is already pointing at the last tag then the iterator
1001 * will be moved to a point just beyond that last tag, (where
1002 * notmuch_tags_valid will return FALSE and notmuch_tags_get will
1005 * See the documentation of notmuch_message_get_tags for example code
1006 * showing how to iterate over a notmuch_tags_t object.
1009 notmuch_tags_move_to_next (notmuch_tags_t *tags);
1011 /* Destroy a notmuch_tags_t object.
1013 * It's not strictly necessary to call this function. All memory from
1014 * the notmuch_tags_t object will be reclaimed when the containing
1015 * message or query objects are destroyed.
1018 notmuch_tags_destroy (notmuch_tags_t *tags);
1020 /* Store an mtime within the database for 'directory'.
1022 * The 'directory' should be an object retrieved from the database
1023 * with notmuch_database_get_directory for a particular path.
1025 * The intention is for the caller to use the mtime to allow efficient
1026 * identification of new messages to be added to the database. The
1027 * recommended usage is as follows:
1029 * o Read the mtime of a directory from the filesystem
1031 * o Call add_message for all mail files in the directory
1033 * o Call notmuch_directory_set_mtime with the mtime read from the
1036 * Then, when wanting to check for updates to the directory in the
1037 * future, the client can call notmuch_directory_get_mtime and know
1038 * that it only needs to add files if the mtime of the directory and
1039 * files are newer than the stored timestamp.
1041 * Note: The notmuch_directory_get_mtime function does not allow the
1042 * caller to distinguish a timestamp of 0 from a non-existent
1043 * timestamp. So don't store a timestamp of 0 unless you are
1044 * comfortable with that.
1048 * NOTMUCH_STATUS_SUCCESS: mtime successfully stored in database.
1050 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception
1051 * occurred, mtime not stored.
1053 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
1054 * mode so directory mtime cannot be modified.
1057 notmuch_directory_set_mtime (notmuch_directory_t *directory,
1060 /* Get the mtime of a directory, (as previously stored with
1061 * notmuch_directory_set_mtime).
1063 * Returns 0 if no mtime has previously been stored for this
1066 notmuch_directory_get_mtime (notmuch_directory_t *directory);
1068 /* Get a notmuch_filenames_t iterator listing all the filenames of
1069 * messages in the database within the given directory.
1071 * The returned filenames will be the basename-entries only (not
1072 * complete paths). */
1073 notmuch_filenames_t *
1074 notmuch_directory_get_child_files (notmuch_directory_t *directory);
1076 /* Get a notmuch_filenams_t iterator listing all the filenames of
1077 * sub-directories in the database within the given directory.
1079 * The returned filenames will be the basename-entries only (not
1080 * complete paths). */
1081 notmuch_filenames_t *
1082 notmuch_directory_get_child_directories (notmuch_directory_t *directory);
1084 /* Destroy a notmuch_directory_t object. */
1086 notmuch_directory_destroy (notmuch_directory_t *directory);
1088 /* Is the given 'filenames' iterator pointing at a valid filename.
1090 * When this function returns TRUE, notmuch_filenames_get will return
1091 * a valid string. Whereas when this function returns FALSE,
1092 * notmuch_filenames_get will return NULL.
1094 * It is acceptable to pass NULL for 'filenames', in which case this
1095 * function will always return FALSE.
1098 notmuch_filenames_valid (notmuch_filenames_t *filenames);
1100 /* Get the current filename from 'filenames' as a string.
1102 * Note: The returned string belongs to 'filenames' and has a lifetime
1103 * identical to it (and the directory to which it ultimately belongs).
1105 * It is acceptable to pass NULL for 'filenames', in which case this
1106 * function will always return NULL.
1109 notmuch_filenames_get (notmuch_filenames_t *filenames);
1111 /* Move the 'filenames' iterator to the next filename.
1113 * If 'filenames' is already pointing at the last filename then the
1114 * iterator will be moved to a point just beyond that last filename,
1115 * (where notmuch_filenames_valid will return FALSE and
1116 * notmuch_filenames_get will return NULL).
1118 * It is acceptable to pass NULL for 'filenames', in which case this
1119 * function will do nothing.
1122 notmuch_filenames_move_to_next (notmuch_filenames_t *filenames);
1124 /* Destroy a notmuch_filenames_t object.
1126 * It's not strictly necessary to call this function. All memory from
1127 * the notmuch_filenames_t object will be reclaimed when the
1128 * containing directory object is destroyed.
1130 * It is acceptable to pass NULL for 'filenames', in which case this
1131 * function will do nothing.
1134 notmuch_filenames_destroy (notmuch_filenames_t *filenames);