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.
271 * Here,'filename' should be a path relative to the path of
272 * 'database' (see notmuch_database_get_path), or else should be an
273 * absolute filename with initial components that match the path of
276 * The file should be a single mail message (not a multi-message mbox)
277 * that is expected to remain at its current location, (since the
278 * notmuch database will reference the filename, and will not copy the
279 * entire contents of the file.
281 * If 'message' is not NULL, then, on successful return
282 * (NOTMUCH_STATUS_SUCCESS or NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID) '*message'
283 * will be initialized to a message object that can be used for things
284 * such as adding tags to the just-added message. The user should call
285 * notmuch_message_destroy when done with the message. On any failure
286 * '*message' will be set to NULL.
290 * NOTMUCH_STATUS_SUCCESS: Message successfully added to database.
292 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred,
295 * NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID: Message has the same message
296 * ID as another message already in the database. The new
297 * filename was successfully added to the message in the database
298 * (if not already present).
300 * NOTMUCH_STATUS_FILE_ERROR: an error occurred trying to open the
301 * file, (such as permission denied, or file not found,
302 * etc.). Nothing added to the database.
304 * NOTMUCH_STATUS_FILE_NOT_EMAIL: the contents of filename don't look
305 * like an email message. Nothing added to the database.
307 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
308 * mode so no message can be added.
311 notmuch_database_add_message (notmuch_database_t *database,
312 const char *filename,
313 notmuch_message_t **message);
315 /* Remove a message from the given notmuch database.
317 * Note that only this particular filename association is removed from
318 * the database. If the same message (as determined by the message ID)
319 * is still available via other filenames, then the message will
320 * persist in the database for those filenames. When the last filename
321 * is removed for a particular message, the database content for that
322 * message will be entirely removed.
326 * NOTMUCH_STATUS_SUCCESS: The last filename was removed and the
327 * message was removed from the database.
329 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred,
330 * message not removed.
332 * NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID: This filename was removed but
333 * the message persists in the database with at least one other
336 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
337 * mode so no message can be removed.
340 notmuch_database_remove_message (notmuch_database_t *database,
341 const char *filename);
343 /* Find a message with the given message_id.
345 * If the database contains a message with the given message_id, then
346 * a new notmuch_message_t object is returned. The caller should call
347 * notmuch_message_destroy when done with the message.
349 * This function returns NULL in the following situations:
351 * * No message is found with the given message_id
352 * * An out-of-memory situation occurs
353 * * A Xapian exception occurs
356 notmuch_database_find_message (notmuch_database_t *database,
357 const char *message_id);
359 /* Find a message with the given filename.
361 * If the database contains a message with the given filename, then a
362 * new notmuch_message_t object is returned. The caller should call
363 * notmuch_message_destroy when done with the message.
365 * This function returns NULL in the following situations:
367 * * No message is found with the given filename
368 * * An out-of-memory situation occurs
369 * * A Xapian exception occurs
372 notmuch_database_find_message_by_filename (notmuch_database_t *notmuch,
373 const char *filename);
375 /* Return a list of all tags found in the database.
377 * This function creates a list of all tags found in the database. The
378 * resulting list contains all tags from all messages found in the database.
380 * On error this function returns NULL.
383 notmuch_database_get_all_tags (notmuch_database_t *db);
385 /* Create a new query for 'database'.
387 * Here, 'database' should be an open database, (see
388 * notmuch_database_open and notmuch_database_create).
390 * For the query string, we'll document the syntax here more
391 * completely in the future, but it's likely to be a specialized
392 * version of the general Xapian query syntax:
394 * http://xapian.org/docs/queryparser.html
396 * As a special case, passing either a length-zero string, (that is ""),
397 * or a string consisting of a single asterisk (that is "*"), will
398 * result in a query that returns all messages in the database.
400 * See notmuch_query_set_sort for controlling the order of results.
401 * See notmuch_query_search_messages and notmuch_query_search_threads
402 * to actually execute the query.
404 * User should call notmuch_query_destroy when finished with this
407 * Will return NULL if insufficient memory is available.
410 notmuch_query_create (notmuch_database_t *database,
411 const char *query_string);
413 /* Sort values for notmuch_query_set_sort */
415 NOTMUCH_SORT_OLDEST_FIRST,
416 NOTMUCH_SORT_NEWEST_FIRST,
417 NOTMUCH_SORT_MESSAGE_ID,
418 NOTMUCH_SORT_UNSORTED
421 /* Return the query_string of this query. See notmuch_query_create. */
423 notmuch_query_get_query_string (notmuch_query_t *query);
425 /* Specify the sorting desired for this query. */
427 notmuch_query_set_sort (notmuch_query_t *query, notmuch_sort_t sort);
429 /* Return the sort specified for this query. See notmuch_query_set_sort. */
431 notmuch_query_get_sort (notmuch_query_t *query);
433 /* Execute a query for threads, returning a notmuch_threads_t object
434 * which can be used to iterate over the results. The returned threads
435 * object is owned by the query and as such, will only be valid until
436 * notmuch_query_destroy.
438 * Typical usage might be:
440 * notmuch_query_t *query;
441 * notmuch_threads_t *threads;
442 * notmuch_thread_t *thread;
444 * query = notmuch_query_create (database, query_string);
446 * for (threads = notmuch_query_search_threads (query);
447 * notmuch_threads_valid (threads);
448 * notmuch_threads_move_to_next (threads))
450 * thread = notmuch_threads_get (threads);
452 * notmuch_thread_destroy (thread);
455 * notmuch_query_destroy (query);
457 * Note: If you are finished with a thread before its containing
458 * query, you can call notmuch_thread_destroy to clean up some memory
459 * sooner (as in the above example). Otherwise, if your thread objects
460 * are long-lived, then you don't need to call notmuch_thread_destroy
461 * and all the memory will still be reclaimed when the query is
464 * Note that there's no explicit destructor needed for the
465 * notmuch_threads_t object. (For consistency, we do provide a
466 * notmuch_threads_destroy function, but there's no good reason
467 * to call it if the query is about to be destroyed).
469 * If a Xapian exception occurs this function will return NULL.
472 notmuch_query_search_threads (notmuch_query_t *query);
474 /* Execute a query for messages, returning a notmuch_messages_t object
475 * which can be used to iterate over the results. The returned
476 * messages object is owned by the query and as such, will only be
477 * valid until notmuch_query_destroy.
479 * Typical usage might be:
481 * notmuch_query_t *query;
482 * notmuch_messages_t *messages;
483 * notmuch_message_t *message;
485 * query = notmuch_query_create (database, query_string);
487 * for (messages = notmuch_query_search_messages (query);
488 * notmuch_messages_valid (messages);
489 * notmuch_messages_move_to_next (messages))
491 * message = notmuch_messages_get (messages);
493 * notmuch_message_destroy (message);
496 * notmuch_query_destroy (query);
498 * Note: If you are finished with a message before its containing
499 * query, you can call notmuch_message_destroy to clean up some memory
500 * sooner (as in the above example). Otherwise, if your message
501 * objects are long-lived, then you don't need to call
502 * notmuch_message_destroy and all the memory will still be reclaimed
503 * when the query is destroyed.
505 * Note that there's no explicit destructor needed for the
506 * notmuch_messages_t object. (For consistency, we do provide a
507 * notmuch_messages_destroy function, but there's no good
508 * reason to call it if the query is about to be destroyed).
510 * If a Xapian exception occurs this function will return NULL.
513 notmuch_query_search_messages (notmuch_query_t *query);
515 /* Destroy a notmuch_query_t along with any associated resources.
517 * This will in turn destroy any notmuch_threads_t and
518 * notmuch_messages_t objects generated by this query, (and in
519 * turn any notmuch_thread_t and notmuch_message_t objects generated
520 * from those results, etc.), if such objects haven't already been
524 notmuch_query_destroy (notmuch_query_t *query);
526 /* Is the given 'threads' iterator pointing at a valid thread.
528 * When this function returns TRUE, notmuch_threads_get will return a
529 * valid object. Whereas when this function returns FALSE,
530 * notmuch_threads_get will return NULL.
532 * See the documentation of notmuch_query_search_threads for example
533 * code showing how to iterate over a notmuch_threads_t object.
536 notmuch_threads_valid (notmuch_threads_t *threads);
538 /* Get the current thread from 'threads' as a notmuch_thread_t.
540 * Note: The returned thread belongs to 'threads' and has a lifetime
541 * identical to it (and the query to which it belongs).
543 * See the documentation of notmuch_query_search_threads for example
544 * code showing how to iterate over a notmuch_threads_t object.
546 * If an out-of-memory situation occurs, this function will return
550 notmuch_threads_get (notmuch_threads_t *threads);
552 /* Move the 'threads' iterator to the next thread.
554 * If 'threads' is already pointing at the last thread then the
555 * iterator will be moved to a point just beyond that last thread,
556 * (where notmuch_threads_valid will return FALSE and
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_move_to_next (notmuch_threads_t *threads);
565 /* Destroy a notmuch_threads_t object.
567 * It's not strictly necessary to call this function. All memory from
568 * the notmuch_threads_t object will be reclaimed when the
569 * containing query object is destroyed.
572 notmuch_threads_destroy (notmuch_threads_t *threads);
574 /* Return an estimate of the number of messages matching a search
576 * This function performs a search and returns Xapian's best
577 * guess as to number of matching messages.
579 * If a Xapian exception occurs, this function may return 0 (after
580 * printing a message).
583 notmuch_query_count_messages (notmuch_query_t *query);
585 /* Get the thread ID of 'thread'.
587 * The returned string belongs to 'thread' and as such, should not be
588 * modified by the caller and will only be valid for as long as the
589 * thread is valid, (which is until notmuch_thread_destroy or until
590 * the query from which it derived is destroyed).
593 notmuch_thread_get_thread_id (notmuch_thread_t *thread);
595 /* Get the total number of messages in 'thread'.
597 * This count consists of all messages in the database belonging to
598 * this thread. Contrast with notmuch_thread_get_matched_messages() .
601 notmuch_thread_get_total_messages (notmuch_thread_t *thread);
603 /* Get a notmuch_messages_t iterator for the top-level messages in
606 * This iterator will not necessarily iterate over all of the messages
607 * in the thread. It will only iterate over the messages in the thread
608 * which are not replies to other messages in the thread.
610 * To iterate over all messages in the thread, the caller will need to
611 * iterate over the result of notmuch_message_get_replies for each
612 * top-level message (and do that recursively for the resulting
616 notmuch_thread_get_toplevel_messages (notmuch_thread_t *thread);
618 /* Get the number of messages in 'thread' that matched the search.
620 * This count includes only the messages in this thread that were
621 * matched by the search from which the thread was created. Contrast
622 * with notmuch_thread_get_total_messages() .
625 notmuch_thread_get_matched_messages (notmuch_thread_t *thread);
627 /* Get the authors of 'thread'
629 * The returned string is a comma-separated list of the names of the
630 * authors of mail messages in the query results that belong to this
633 * The returned string belongs to 'thread' and as such, should not be
634 * modified by the caller and will only be valid for as long as the
635 * thread is valid, (which is until notmuch_thread_destroy or until
636 * the query from which it derived is destroyed).
639 notmuch_thread_get_authors (notmuch_thread_t *thread);
641 /* Get the subject of 'thread'
643 * The subject is taken from the first message (according to the query
644 * order---see notmuch_query_set_sort) in the query results that
645 * belongs to this thread.
647 * The returned string belongs to 'thread' and as such, should not be
648 * modified by the caller and will only be valid for as long as the
649 * thread is valid, (which is until notmuch_thread_destroy or until
650 * the query from which it derived is destroyed).
653 notmuch_thread_get_subject (notmuch_thread_t *thread);
655 /* Get the date of the oldest message in 'thread' as a time_t value.
658 notmuch_thread_get_oldest_date (notmuch_thread_t *thread);
660 /* Get the date of the newest message in 'thread' as a time_t value.
663 notmuch_thread_get_newest_date (notmuch_thread_t *thread);
665 /* Get the tags for 'thread', returning a notmuch_tags_t object which
666 * can be used to iterate over all tags.
668 * Note: In the Notmuch database, tags are stored on individual
669 * messages, not on threads. So the tags returned here will be all
670 * tags of the messages which matched the search and which belong to
673 * The tags object is owned by the thread and as such, will only be
674 * valid for as long as the thread is valid, (for example, until
675 * notmuch_thread_destroy or until the query from which it derived is
678 * Typical usage might be:
680 * notmuch_thread_t *thread;
681 * notmuch_tags_t *tags;
684 * thread = notmuch_threads_get (threads);
686 * for (tags = notmuch_thread_get_tags (thread);
687 * notmuch_tags_valid (tags);
688 * notmuch_result_move_to_next (tags))
690 * tag = notmuch_tags_get (tags);
694 * notmuch_thread_destroy (thread);
696 * Note that there's no explicit destructor needed for the
697 * notmuch_tags_t object. (For consistency, we do provide a
698 * notmuch_tags_destroy function, but there's no good reason to call
699 * it if the message is about to be destroyed).
702 notmuch_thread_get_tags (notmuch_thread_t *thread);
704 /* Destroy a notmuch_thread_t object. */
706 notmuch_thread_destroy (notmuch_thread_t *thread);
708 /* Is the given 'messages' iterator pointing at a valid message.
710 * When this function returns TRUE, notmuch_messages_get will return a
711 * valid object. Whereas when this function returns FALSE,
712 * notmuch_messages_get will return NULL.
714 * See the documentation of notmuch_query_search_messages for example
715 * code showing how to iterate over a notmuch_messages_t object.
718 notmuch_messages_valid (notmuch_messages_t *messages);
720 /* Get the current message from 'messages' as a notmuch_message_t.
722 * Note: The returned message belongs to 'messages' and has a lifetime
723 * identical to it (and the query to which it belongs).
725 * See the documentation of notmuch_query_search_messages for example
726 * code showing how to iterate over a notmuch_messages_t object.
728 * If an out-of-memory situation occurs, this function will return
732 notmuch_messages_get (notmuch_messages_t *messages);
734 /* Move the 'messages' iterator to the next message.
736 * If 'messages' is already pointing at the last message then the
737 * iterator will be moved to a point just beyond that last message,
738 * (where notmuch_messages_valid will return FALSE and
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_move_to_next (notmuch_messages_t *messages);
747 /* Destroy a notmuch_messages_t object.
749 * It's not strictly necessary to call this function. All memory from
750 * the notmuch_messages_t object will be reclaimed when the containing
751 * query object is destroyed.
754 notmuch_messages_destroy (notmuch_messages_t *messages);
756 /* Return a list of tags from all messages.
758 * The resulting list is guaranteed not to contain duplicated tags.
760 * WARNING: You can no longer iterate over messages after calling this
761 * function, because the iterator will point at the end of the list.
762 * We do not have a function to reset the iterator yet and the only
763 * way how you can iterate over the list again is to recreate the
766 * The function returns NULL on error.
769 notmuch_messages_collect_tags (notmuch_messages_t *messages);
771 /* Get the message ID of 'message'.
773 * The returned string belongs to 'message' and as such, should not be
774 * modified by the caller and will only be valid for as long as the
775 * message is valid, (which is until the query from which it derived
778 * This function will not return NULL since Notmuch ensures that every
779 * message has a unique message ID, (Notmuch will generate an ID for a
780 * message if the original file does not contain one).
783 notmuch_message_get_message_id (notmuch_message_t *message);
785 /* Get the thread ID of 'message'.
787 * The returned string belongs to 'message' and as such, should not be
788 * modified by the caller and will only be valid for as long as the
789 * message is valid, (for example, until the user calls
790 * notmuch_message_destroy on 'message' or until a query from which it
791 * derived is destroyed).
793 * This function will not return NULL since Notmuch ensures that every
794 * message belongs to a single thread.
797 notmuch_message_get_thread_id (notmuch_message_t *message);
799 /* Get a notmuch_messages_t iterator for all of the replies to
802 * Note: This call only makes sense if 'message' was ultimately
803 * obtained from a notmuch_thread_t object, (such as by coming
804 * directly from the result of calling notmuch_thread_get_
805 * toplevel_messages or by any number of subsequent
806 * calls to notmuch_message_get_replies).
808 * If 'message' was obtained through some non-thread means, (such as
809 * by a call to notmuch_query_search_messages), then this function
812 * If there are no replies to 'message', this function will return
813 * NULL. (Note that notmuch_messages_valid will accept that NULL
814 * value as legitimate, and simply return FALSE for it.)
817 notmuch_message_get_replies (notmuch_message_t *message);
819 /* Get a filename for the email corresponding to 'message'.
821 * The returned filename is an absolute filename, (the initial
822 * component will match notmuch_database_get_path() ).
824 * The returned string belongs to the message so should not be
825 * modified or freed by the caller (nor should it be referenced after
826 * the message is destroyed).
828 * Note: If this message corresponds to multiple files in the mail
829 * store, (that is, multiple files contain identical message IDs),
830 * this function will arbitrarily return a single one of those
831 * filenames. See notmuch_message_get_filenames for returning the
832 * complete list of filenames.
835 notmuch_message_get_filename (notmuch_message_t *message);
837 /* Get all filenames for the email corresponding to 'message'.
839 * Returns a notmuch_filenames_t iterator listing all the filenames
840 * associated with 'message'. These files may not have identical
841 * content, but each will have the identical Message-ID.
843 * Each filename in the iterator is an absolute filename, (the initial
844 * component will match notmuch_database_get_path() ).
846 notmuch_filenames_t *
847 notmuch_message_get_filenames (notmuch_message_t *message);
850 typedef enum _notmuch_message_flag {
851 NOTMUCH_MESSAGE_FLAG_MATCH
852 } notmuch_message_flag_t;
854 /* Get a value of a flag for the email corresponding to 'message'. */
856 notmuch_message_get_flag (notmuch_message_t *message,
857 notmuch_message_flag_t flag);
859 /* Set a value of a flag for the email corresponding to 'message'. */
861 notmuch_message_set_flag (notmuch_message_t *message,
862 notmuch_message_flag_t flag, notmuch_bool_t value);
864 /* Get the date of 'message' as a time_t value.
866 * For the original textual representation of the Date header from the
867 * message call notmuch_message_get_header() with a header value of
870 notmuch_message_get_date (notmuch_message_t *message);
872 /* Get the value of the specified header from 'message'.
874 * The value will be read from the actual message file, not from the
875 * notmuch database. The header name is case insensitive.
877 * The returned string belongs to the message so should not be
878 * modified or freed by the caller (nor should it be referenced after
879 * the message is destroyed).
881 * Returns an empty string ("") if the message does not contain a
882 * header line matching 'header'. Returns NULL if any error occurs.
885 notmuch_message_get_header (notmuch_message_t *message, const char *header);
887 /* Get the tags for 'message', returning a notmuch_tags_t object which
888 * can be used to iterate over all tags.
890 * The tags object is owned by the message and as such, will only be
891 * valid for as long as the message is valid, (which is until the
892 * query from which it derived is destroyed).
894 * Typical usage might be:
896 * notmuch_message_t *message;
897 * notmuch_tags_t *tags;
900 * message = notmuch_database_find_message (database, message_id);
902 * for (tags = notmuch_message_get_tags (message);
903 * notmuch_tags_valid (tags);
904 * notmuch_result_move_to_next (tags))
906 * tag = notmuch_tags_get (tags);
910 * notmuch_message_destroy (message);
912 * Note that there's no explicit destructor needed for the
913 * notmuch_tags_t object. (For consistency, we do provide a
914 * notmuch_tags_destroy function, but there's no good reason to call
915 * it if the message is about to be destroyed).
918 notmuch_message_get_tags (notmuch_message_t *message);
920 /* The longest possible tag value. */
921 #define NOTMUCH_TAG_MAX 200
923 /* Add a tag to the given message.
927 * NOTMUCH_STATUS_SUCCESS: Tag successfully added to message
929 * NOTMUCH_STATUS_NULL_POINTER: The 'tag' argument is NULL
931 * NOTMUCH_STATUS_TAG_TOO_LONG: The length of 'tag' is too long
932 * (exceeds NOTMUCH_TAG_MAX)
934 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
935 * mode so message cannot be modified.
938 notmuch_message_add_tag (notmuch_message_t *message, const char *tag);
940 /* Remove a tag from the given message.
944 * NOTMUCH_STATUS_SUCCESS: Tag successfully removed from message
946 * NOTMUCH_STATUS_NULL_POINTER: The 'tag' argument is NULL
948 * NOTMUCH_STATUS_TAG_TOO_LONG: The length of 'tag' is too long
949 * (exceeds NOTMUCH_TAG_MAX)
951 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
952 * mode so message cannot be modified.
955 notmuch_message_remove_tag (notmuch_message_t *message, const char *tag);
957 /* Remove all tags from the given message.
959 * See notmuch_message_freeze for an example showing how to safely
960 * replace tag values.
962 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
963 * mode so message cannot be modified.
966 notmuch_message_remove_all_tags (notmuch_message_t *message);
968 /* Add/remove tags according to maildir flags in the message filename(s)
970 * This function examines the filenames of 'message' for maildir
971 * flags, and adds or removes tags on 'message' as follows when these
974 * Flag Action if present
975 * ---- -----------------
976 * 'D' Adds the "draft" tag to the message
977 * 'F' Adds the "flagged" tag to the message
978 * 'P' Adds the "passed" tag to the message
979 * 'R' Adds the "replied" tag to the message
980 * 'S' Removes the "unread" tag from the message
982 * For each flag that is not present, the opposite action (add/remove)
983 * is performed for the corresponding tags.
985 * Flags are identified as trailing components of the filename after a
988 * If there are multiple filenames associated with this message, the
989 * flag is considered present if it appears in one or more
990 * filenames. (That is, the flags from the multiple filenames are
991 * combined with the logical OR operator.)
993 * A client can ensure that notmuch database tags remain synchronized
994 * with maildir flags by calling this function after each call to
995 * notmuch_database_add_message. See also
996 * notmuch_message_tags_to_maildir_flags for synchronizing tag changes
997 * back to maildir flags.
1000 notmuch_message_maildir_flags_to_tags (notmuch_message_t *message);
1002 /* Rename message filename(s) to encode tags as maildir flags
1004 * Specifically, for each filename corresponding to this message:
1006 * If the filename is not in a maildir directory, do nothing. (A
1007 * maildir directory is determined as a directory named "new" or
1008 * "cur".) Similarly, if the filename has invalid maildir info,
1009 * (repeated or outof-ASCII-order flag characters after ":2,"), then
1012 * If the filename is in a maildir directory, rename the file so that
1013 * its filename ends with the sequence ":2," followed by zero or more
1014 * of the following single-character flags (in ASCII order):
1016 * 'D' iff the message has the "draft" tag
1017 * 'F' iff the message has the "flagged" tag
1018 * 'P' iff the message has the "passed" tag
1019 * 'R' iff the message has the "replied" tag
1020 * 'S' iff the message does not have the "unread" tag
1022 * Any existing flags unmentioned in the list above will be preserved
1025 * Also, if this filename is in a directory named "new", rename it to
1026 * be within the neighboring directory named "cur".
1028 * A client can ensure that maildir filename flags remain synchronized
1029 * with notmuch database tags by calling this function after changing
1030 * tags, (after calls to notmuch_message_add_tag,
1031 * notmuch_message_remove_tag, or notmuch_message_freeze/
1032 * notmuch_message_thaw). See also notmuch_message_maildir_flags_to_tags
1033 * for synchronizing maildir flag changes back to tags.
1036 notmuch_message_tags_to_maildir_flags (notmuch_message_t *message);
1038 /* Freeze the current state of 'message' within the database.
1040 * This means that changes to the message state, (via
1041 * notmuch_message_add_tag, notmuch_message_remove_tag, and
1042 * notmuch_message_remove_all_tags), will not be committed to the
1043 * database until the message is thawed with notmuch_message_thaw.
1045 * Multiple calls to freeze/thaw are valid and these calls will
1046 * "stack". That is there must be as many calls to thaw as to freeze
1047 * before a message is actually thawed.
1049 * The ability to do freeze/thaw allows for safe transactions to
1050 * change tag values. For example, explicitly setting a message to
1051 * have a given set of tags might look like this:
1053 * notmuch_message_freeze (message);
1055 * notmuch_message_remove_all_tags (message);
1057 * for (i = 0; i < NUM_TAGS; i++)
1058 * notmuch_message_add_tag (message, tags[i]);
1060 * notmuch_message_thaw (message);
1062 * With freeze/thaw used like this, the message in the database is
1063 * guaranteed to have either the full set of original tag values, or
1064 * the full set of new tag values, but nothing in between.
1066 * Imagine the example above without freeze/thaw and the operation
1067 * somehow getting interrupted. This could result in the message being
1068 * left with no tags if the interruption happened after
1069 * notmuch_message_remove_all_tags but before notmuch_message_add_tag.
1073 * NOTMUCH_STATUS_SUCCESS: Message successfully frozen.
1075 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
1076 * mode so message cannot be modified.
1079 notmuch_message_freeze (notmuch_message_t *message);
1081 /* Thaw the current 'message', synchronizing any changes that may have
1082 * occurred while 'message' was frozen into the notmuch database.
1084 * See notmuch_message_freeze for an example of how to use this
1085 * function to safely provide tag changes.
1087 * Multiple calls to freeze/thaw are valid and these calls with
1088 * "stack". That is there must be as many calls to thaw as to freeze
1089 * before a message is actually thawed.
1093 * NOTMUCH_STATUS_SUCCESS: Message successfully thawed, (or at least
1094 * its frozen count has successfully been reduced by 1).
1096 * NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW: An attempt was made to thaw
1097 * an unfrozen message. That is, there have been an unbalanced
1098 * number of calls to notmuch_message_freeze and
1099 * notmuch_message_thaw.
1102 notmuch_message_thaw (notmuch_message_t *message);
1104 /* Destroy a notmuch_message_t object.
1106 * It can be useful to call this function in the case of a single
1107 * query object with many messages in the result, (such as iterating
1108 * over the entire database). Otherwise, it's fine to never call this
1109 * function and there will still be no memory leaks. (The memory from
1110 * the messages get reclaimed when the containing query is destroyed.)
1113 notmuch_message_destroy (notmuch_message_t *message);
1115 /* Is the given 'tags' iterator pointing at a valid tag.
1117 * When this function returns TRUE, notmuch_tags_get will return a
1118 * valid string. Whereas when this function returns FALSE,
1119 * notmuch_tags_get will return NULL.
1121 * See the documentation of notmuch_message_get_tags for example code
1122 * showing how to iterate over a notmuch_tags_t object.
1125 notmuch_tags_valid (notmuch_tags_t *tags);
1127 /* Get the current tag from 'tags' as a string.
1129 * Note: The returned string belongs to 'tags' and has a lifetime
1130 * identical to it (and the query to which it ultimately belongs).
1132 * See the documentation of notmuch_message_get_tags for example code
1133 * showing how to iterate over a notmuch_tags_t object.
1136 notmuch_tags_get (notmuch_tags_t *tags);
1138 /* Move the 'tags' iterator to the next tag.
1140 * If 'tags' is already pointing at the last tag then the iterator
1141 * will be moved to a point just beyond that last tag, (where
1142 * notmuch_tags_valid will return FALSE and notmuch_tags_get will
1145 * See the documentation of notmuch_message_get_tags for example code
1146 * showing how to iterate over a notmuch_tags_t object.
1149 notmuch_tags_move_to_next (notmuch_tags_t *tags);
1151 /* Destroy a notmuch_tags_t object.
1153 * It's not strictly necessary to call this function. All memory from
1154 * the notmuch_tags_t object will be reclaimed when the containing
1155 * message or query objects are destroyed.
1158 notmuch_tags_destroy (notmuch_tags_t *tags);
1160 /* Store an mtime within the database for 'directory'.
1162 * The 'directory' should be an object retrieved from the database
1163 * with notmuch_database_get_directory for a particular path.
1165 * The intention is for the caller to use the mtime to allow efficient
1166 * identification of new messages to be added to the database. The
1167 * recommended usage is as follows:
1169 * o Read the mtime of a directory from the filesystem
1171 * o Call add_message for all mail files in the directory
1173 * o Call notmuch_directory_set_mtime with the mtime read from the
1176 * Then, when wanting to check for updates to the directory in the
1177 * future, the client can call notmuch_directory_get_mtime and know
1178 * that it only needs to add files if the mtime of the directory and
1179 * files are newer than the stored timestamp.
1181 * Note: The notmuch_directory_get_mtime function does not allow the
1182 * caller to distinguish a timestamp of 0 from a non-existent
1183 * timestamp. So don't store a timestamp of 0 unless you are
1184 * comfortable with that.
1188 * NOTMUCH_STATUS_SUCCESS: mtime successfully stored in database.
1190 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception
1191 * occurred, mtime not stored.
1193 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
1194 * mode so directory mtime cannot be modified.
1197 notmuch_directory_set_mtime (notmuch_directory_t *directory,
1200 /* Get the mtime of a directory, (as previously stored with
1201 * notmuch_directory_set_mtime).
1203 * Returns 0 if no mtime has previously been stored for this
1206 notmuch_directory_get_mtime (notmuch_directory_t *directory);
1208 /* Get a notmuch_filenames_t iterator listing all the filenames of
1209 * messages in the database within the given directory.
1211 * The returned filenames will be the basename-entries only (not
1212 * complete paths). */
1213 notmuch_filenames_t *
1214 notmuch_directory_get_child_files (notmuch_directory_t *directory);
1216 /* Get a notmuch_filenams_t iterator listing all the filenames of
1217 * sub-directories in the database within the given directory.
1219 * The returned filenames will be the basename-entries only (not
1220 * complete paths). */
1221 notmuch_filenames_t *
1222 notmuch_directory_get_child_directories (notmuch_directory_t *directory);
1224 /* Destroy a notmuch_directory_t object. */
1226 notmuch_directory_destroy (notmuch_directory_t *directory);
1228 /* Is the given 'filenames' iterator pointing at a valid filename.
1230 * When this function returns TRUE, notmuch_filenames_get will return
1231 * a valid string. Whereas when this function returns FALSE,
1232 * notmuch_filenames_get will return NULL.
1234 * It is acceptable to pass NULL for 'filenames', in which case this
1235 * function will always return FALSE.
1238 notmuch_filenames_valid (notmuch_filenames_t *filenames);
1240 /* Get the current filename from 'filenames' as a string.
1242 * Note: The returned string belongs to 'filenames' and has a lifetime
1243 * identical to it (and the directory to which it ultimately belongs).
1245 * It is acceptable to pass NULL for 'filenames', in which case this
1246 * function will always return NULL.
1249 notmuch_filenames_get (notmuch_filenames_t *filenames);
1251 /* Move the 'filenames' iterator to the next filename.
1253 * If 'filenames' is already pointing at the last filename then the
1254 * iterator will be moved to a point just beyond that last filename,
1255 * (where notmuch_filenames_valid will return FALSE and
1256 * notmuch_filenames_get will return NULL).
1258 * It is acceptable to pass NULL for 'filenames', in which case this
1259 * function will do nothing.
1262 notmuch_filenames_move_to_next (notmuch_filenames_t *filenames);
1264 /* Destroy a notmuch_filenames_t object.
1266 * It's not strictly necessary to call this function. All memory from
1267 * the notmuch_filenames_t object will be reclaimed when the
1268 * containing directory object is destroyed.
1270 * It is acceptable to pass NULL for 'filenames', in which case this
1271 * function will do nothing.
1274 notmuch_filenames_destroy (notmuch_filenames_t *filenames);