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
242 * (NOTMUCH_STATUS_SUCCESS or NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID) '*message'
243 * will be initialized to a message object that can be used for things
244 * such as adding tags to the just-added message. The user should call
245 * notmuch_message_destroy when done with the message. On any failure
246 * '*message' will be set to NULL.
250 * NOTMUCH_STATUS_SUCCESS: Message successfully added to database.
252 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred,
255 * NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID: Message has the same message
256 * ID as another message already in the database. The new
257 * filename was successfully added to the message in the database
258 * (if not already present).
260 * NOTMUCH_STATUS_FILE_ERROR: an error occurred trying to open the
261 * file, (such as permission denied, or file not found,
262 * etc.). Nothing added to the database.
264 * NOTMUCH_STATUS_FILE_NOT_EMAIL: the contents of filename don't look
265 * like an email message. Nothing added to the database.
267 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
268 * mode so no message can be added.
271 notmuch_database_add_message (notmuch_database_t *database,
272 const char *filename,
273 notmuch_message_t **message);
275 /* Remove a message from the given notmuch database.
277 * Note that only this particular filename association is removed from
278 * the database. If the same message (as determined by the message ID)
279 * is still available via other filenames, then the message will
280 * persist in the database for those filenames. When the last filename
281 * is removed for a particular message, the database content for that
282 * message will be entirely removed.
286 * NOTMUCH_STATUS_SUCCESS: The last filename was removed and the
287 * message was removed from the database.
289 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred,
290 * message not removed.
292 * NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID: This filename was removed but
293 * the message persists in the database with at least one other
296 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
297 * mode so no message can be removed.
300 notmuch_database_remove_message (notmuch_database_t *database,
301 const char *filename);
303 /* Find a message with the given message_id.
305 * If the database contains a message with the given message_id, then
306 * a new notmuch_message_t object is returned. The caller should call
307 * notmuch_message_destroy when done with the message.
309 * This function returns NULL in the following situations:
311 * * No message is found with the given message_id
312 * * An out-of-memory situation occurs
313 * * A Xapian exception occurs
316 notmuch_database_find_message (notmuch_database_t *database,
317 const char *message_id);
319 /* Return a list of all tags found in the database.
321 * This function creates a list of all tags found in the database. The
322 * resulting list contains all tags from all messages found in the database.
324 * On error this function returns NULL.
327 notmuch_database_get_all_tags (notmuch_database_t *db);
329 /* Create a new query for 'database'.
331 * Here, 'database' should be an open database, (see
332 * notmuch_database_open and notmuch_database_create).
334 * For the query string, we'll document the syntax here more
335 * completely in the future, but it's likely to be a specialized
336 * version of the general Xapian query syntax:
338 * http://xapian.org/docs/queryparser.html
340 * As a special case, passing either a length-zero string, (that is ""),
341 * or a string consisting of a single asterisk (that is "*"), will
342 * result in a query that returns all messages in the database.
344 * See notmuch_query_set_sort for controlling the order of results.
345 * See notmuch_query_search_messages and notmuch_query_search_threads
346 * to actually execute the query.
348 * User should call notmuch_query_destroy when finished with this
351 * Will return NULL if insufficient memory is available.
354 notmuch_query_create (notmuch_database_t *database,
355 const char *query_string);
357 /* Sort values for notmuch_query_set_sort */
359 NOTMUCH_SORT_OLDEST_FIRST,
360 NOTMUCH_SORT_NEWEST_FIRST,
361 NOTMUCH_SORT_MESSAGE_ID,
362 NOTMUCH_SORT_UNSORTED
365 /* Return the query_string of this query. See notmuch_query_create. */
367 notmuch_query_get_query_string (notmuch_query_t *query);
369 /* Specify the sorting desired for this query. */
371 notmuch_query_set_sort (notmuch_query_t *query, notmuch_sort_t sort);
373 /* Return the sort specified for this query. See notmuch_query_set_sort. */
375 notmuch_query_get_sort (notmuch_query_t *query);
377 /* Execute a query for threads, returning a notmuch_threads_t object
378 * which can be used to iterate over the results. The returned threads
379 * object is owned by the query and as such, will only be valid until
380 * notmuch_query_destroy.
382 * Typical usage might be:
384 * notmuch_query_t *query;
385 * notmuch_threads_t *threads;
386 * notmuch_thread_t *thread;
388 * query = notmuch_query_create (database, query_string);
390 * for (threads = notmuch_query_search_threads (query);
391 * notmuch_threads_valid (threads);
392 * notmuch_threads_move_to_next (threads))
394 * thread = notmuch_threads_get (threads);
396 * notmuch_thread_destroy (thread);
399 * notmuch_query_destroy (query);
401 * Note: If you are finished with a thread before its containing
402 * query, you can call notmuch_thread_destroy to clean up some memory
403 * sooner (as in the above example). Otherwise, if your thread objects
404 * are long-lived, then you don't need to call notmuch_thread_destroy
405 * and all the memory will still be reclaimed when the query is
408 * Note that there's no explicit destructor needed for the
409 * notmuch_threads_t object. (For consistency, we do provide a
410 * notmuch_threads_destroy function, but there's no good reason
411 * to call it if the query is about to be destroyed).
413 * If a Xapian exception occurs this function will return NULL.
416 notmuch_query_search_threads (notmuch_query_t *query);
418 /* Execute a query for messages, returning a notmuch_messages_t object
419 * which can be used to iterate over the results. The returned
420 * messages object is owned by the query and as such, will only be
421 * valid until notmuch_query_destroy.
423 * Typical usage might be:
425 * notmuch_query_t *query;
426 * notmuch_messages_t *messages;
427 * notmuch_message_t *message;
429 * query = notmuch_query_create (database, query_string);
431 * for (messages = notmuch_query_search_messages (query);
432 * notmuch_messages_valid (messages);
433 * notmuch_messages_move_to_next (messages))
435 * message = notmuch_messages_get (messages);
437 * notmuch_message_destroy (message);
440 * notmuch_query_destroy (query);
442 * Note: If you are finished with a message before its containing
443 * query, you can call notmuch_message_destroy to clean up some memory
444 * sooner (as in the above example). Otherwise, if your message
445 * objects are long-lived, then you don't need to call
446 * notmuch_message_destroy and all the memory will still be reclaimed
447 * when the query is destroyed.
449 * Note that there's no explicit destructor needed for the
450 * notmuch_messages_t object. (For consistency, we do provide a
451 * notmuch_messages_destroy function, but there's no good
452 * reason to call it if the query is about to be destroyed).
454 * If a Xapian exception occurs this function will return NULL.
457 notmuch_query_search_messages (notmuch_query_t *query);
459 /* Destroy a notmuch_query_t along with any associated resources.
461 * This will in turn destroy any notmuch_threads_t and
462 * notmuch_messages_t objects generated by this query, (and in
463 * turn any notmuch_thread_t and notmuch_message_t objects generated
464 * from those results, etc.), if such objects haven't already been
468 notmuch_query_destroy (notmuch_query_t *query);
470 /* Is the given 'threads' iterator pointing at a valid thread.
472 * When this function returns TRUE, notmuch_threads_get will return a
473 * valid object. Whereas when this function returns FALSE,
474 * notmuch_threads_get will return NULL.
476 * See the documentation of notmuch_query_search_threads for example
477 * code showing how to iterate over a notmuch_threads_t object.
480 notmuch_threads_valid (notmuch_threads_t *threads);
482 /* Get the current thread from 'threads' as a notmuch_thread_t.
484 * Note: The returned thread belongs to 'threads' and has a lifetime
485 * identical to it (and the query to which it belongs).
487 * See the documentation of notmuch_query_search_threads for example
488 * code showing how to iterate over a notmuch_threads_t object.
490 * If an out-of-memory situation occurs, this function will return
494 notmuch_threads_get (notmuch_threads_t *threads);
496 /* Move the 'threads' iterator to the next thread.
498 * If 'threads' is already pointing at the last thread then the
499 * iterator will be moved to a point just beyond that last thread,
500 * (where notmuch_threads_valid will return FALSE and
501 * notmuch_threads_get will return NULL).
503 * See the documentation of notmuch_query_search_threads for example
504 * code showing how to iterate over a notmuch_threads_t object.
507 notmuch_threads_move_to_next (notmuch_threads_t *threads);
509 /* Destroy a notmuch_threads_t object.
511 * It's not strictly necessary to call this function. All memory from
512 * the notmuch_threads_t object will be reclaimed when the
513 * containg query object is destroyed.
516 notmuch_threads_destroy (notmuch_threads_t *threads);
518 /* Return an estimate of the number of messages matching a search
520 * This function performs a search and returns Xapian's best
521 * guess as to number of matching messages.
523 * If a Xapian exception occurs, this function may return 0 (after
524 * printing a message).
527 notmuch_query_count_messages (notmuch_query_t *query);
529 /* Get the thread ID of 'thread'.
531 * The returned string belongs to 'thread' and as such, should not be
532 * modified by the caller and will only be valid for as long as the
533 * thread is valid, (which is until notmuch_thread_destroy or until
534 * the query from which it derived is destroyed).
537 notmuch_thread_get_thread_id (notmuch_thread_t *thread);
539 /* Get the total number of messages in 'thread'.
541 * This count consists of all messages in the database belonging to
542 * this thread. Contrast with notmuch_thread_get_matched_messages() .
545 notmuch_thread_get_total_messages (notmuch_thread_t *thread);
547 /* Get a notmuch_messages_t iterator for the top-level messages in
550 * This iterator will not necessarily iterate over all of the messages
551 * in the thread. It will only iterate over the messages in the thread
552 * which are not replies to other messages in the thread.
554 * To iterate over all messages in the thread, the caller will need to
555 * iterate over the result of notmuch_message_get_replies for each
556 * top-level message (and do that recursively for the resulting
560 notmuch_thread_get_toplevel_messages (notmuch_thread_t *thread);
562 /* Get the number of messages in 'thread' that matched the search.
564 * This count includes only the messages in this thread that were
565 * matched by the search from which the thread was created. Contrast
566 * with notmuch_thread_get_total_messages() .
569 notmuch_thread_get_matched_messages (notmuch_thread_t *thread);
571 /* Get the authors of 'thread'
573 * The returned string is a comma-separated list of the names of the
574 * authors of mail messages in the query results that belong to this
577 * The returned string belongs to 'thread' and as such, should not be
578 * modified by the caller and will only be valid for as long as the
579 * thread is valid, (which is until notmuch_thread_destroy or until
580 * the query from which it derived is destroyed).
583 notmuch_thread_get_authors (notmuch_thread_t *thread);
585 /* Get the subject of 'thread'
587 * The subject is taken from the first message (according to the query
588 * order---see notmuch_query_set_sort) in the query results that
589 * belongs to this thread.
591 * The returned string belongs to 'thread' and as such, should not be
592 * modified by the caller and will only be valid for as long as the
593 * thread is valid, (which is until notmuch_thread_destroy or until
594 * the query from which it derived is destroyed).
597 notmuch_thread_get_subject (notmuch_thread_t *thread);
599 /* Get the date of the oldest message in 'thread' as a time_t value.
602 notmuch_thread_get_oldest_date (notmuch_thread_t *thread);
604 /* Get the date of the newest message in 'thread' as a time_t value.
607 notmuch_thread_get_newest_date (notmuch_thread_t *thread);
609 /* Get the tags for 'thread', returning a notmuch_tags_t object which
610 * can be used to iterate over all tags.
612 * Note: In the Notmuch database, tags are stored on individual
613 * messages, not on threads. So the tags returned here will be all
614 * tags of the messages which matched the search and which belong to
617 * The tags object is owned by the thread and as such, will only be
618 * valid for as long as the thread is valid, (for example, until
619 * notmuch_thread_destroy or until the query from which it derived is
622 * Typical usage might be:
624 * notmuch_thread_t *thread;
625 * notmuch_tags_t *tags;
628 * thread = notmuch_threads_get (threads);
630 * for (tags = notmuch_thread_get_tags (thread);
631 * notmuch_tags_valid (tags);
632 * notmuch_result_move_to_next (tags))
634 * tag = notmuch_tags_get (tags);
638 * notmuch_thread_destroy (thread);
640 * Note that there's no explicit destructor needed for the
641 * notmuch_tags_t object. (For consistency, we do provide a
642 * notmuch_tags_destroy function, but there's no good reason to call
643 * it if the message is about to be destroyed).
646 notmuch_thread_get_tags (notmuch_thread_t *thread);
648 /* Destroy a notmuch_thread_t object. */
650 notmuch_thread_destroy (notmuch_thread_t *thread);
652 /* Is the given 'messages' iterator pointing at a valid message.
654 * When this function returns TRUE, notmuch_messages_get will return a
655 * valid object. Whereas when this function returns FALSE,
656 * notmuch_messages_get will return NULL.
658 * See the documentation of notmuch_query_search_messages for example
659 * code showing how to iterate over a notmuch_messages_t object.
662 notmuch_messages_valid (notmuch_messages_t *messages);
664 /* Get the current message from 'messages' as a notmuch_message_t.
666 * Note: The returned message belongs to 'messages' and has a lifetime
667 * identical to it (and the query to which it belongs).
669 * See the documentation of notmuch_query_search_messages for example
670 * code showing how to iterate over a notmuch_messages_t object.
672 * If an out-of-memory situation occurs, this function will return
676 notmuch_messages_get (notmuch_messages_t *messages);
678 /* Move the 'messages' iterator to the next message.
680 * If 'messages' is already pointing at the last message then the
681 * iterator will be moved to a point just beyond that last message,
682 * (where notmuch_messages_valid will return FALSE and
683 * notmuch_messages_get will return NULL).
685 * See the documentation of notmuch_query_search_messages for example
686 * code showing how to iterate over a notmuch_messages_t object.
689 notmuch_messages_move_to_next (notmuch_messages_t *messages);
691 /* Destroy a notmuch_messages_t object.
693 * It's not strictly necessary to call this function. All memory from
694 * the notmuch_messages_t object will be reclaimed when the containing
695 * query object is destroyed.
698 notmuch_messages_destroy (notmuch_messages_t *messages);
700 /* Return a list of tags from all messages.
702 * The resulting list is guaranteed not to contain duplicated tags.
704 * WARNING: You can no longer iterate over messages after calling this
705 * function, because the iterator will point at the end of the list.
706 * We do not have a function to reset the iterator yet and the only
707 * way how you can iterate over the list again is to recreate the
710 * The function returns NULL on error.
713 notmuch_messages_collect_tags (notmuch_messages_t *messages);
715 /* Get the message ID of 'message'.
717 * The returned string belongs to 'message' and as such, should not be
718 * modified by the caller and will only be valid for as long as the
719 * message is valid, (which is until the query from which it derived
722 * This function will not return NULL since Notmuch ensures that every
723 * message has a unique message ID, (Notmuch will generate an ID for a
724 * message if the original file does not contain one).
727 notmuch_message_get_message_id (notmuch_message_t *message);
729 /* Get the thread ID of 'message'.
731 * The returned string belongs to 'message' and as such, should not be
732 * modified by the caller and will only be valid for as long as the
733 * message is valid, (for example, until the user calls
734 * notmuch_message_destroy on 'message' or until a query from which it
735 * derived is destroyed).
737 * This function will not return NULL since Notmuch ensures that every
738 * message belongs to a single thread.
741 notmuch_message_get_thread_id (notmuch_message_t *message);
743 /* Get a notmuch_messages_t iterator for all of the replies to
746 * Note: This call only makes sense if 'message' was ultimately
747 * obtained from a notmuch_thread_t object, (such as by coming
748 * directly from the result of calling notmuch_thread_get_
749 * toplevel_messages or by any number of subsequent
750 * calls to notmuch_message_get_replies).
752 * If 'message' was obtained through some non-thread means, (such as
753 * by a call to notmuch_query_search_messages), then this function
756 * If there are no replies to 'message', this function will return
757 * NULL. (Note that notmuch_messages_valid will accept that NULL
758 * value as legitimate, and simply return FALSE for it.)
761 notmuch_message_get_replies (notmuch_message_t *message);
763 /* Get a filename for the email corresponding to 'message'.
765 * The returned filename is an absolute filename, (the initial
766 * component will match notmuch_database_get_path() ).
768 * The returned string belongs to the message so should not be
769 * modified or freed by the caller (nor should it be referenced after
770 * the message is destroyed).
772 * Note: If this message corresponds to multiple files in the mail
773 * store, (that is, multiple files contain identical message IDs),
774 * this function will arbitrarily return a single one of those
775 * filenames. See notmuch_message_get_filenames for returning the
776 * complete list of filenames.
779 notmuch_message_get_filename (notmuch_message_t *message);
781 /* Get all filenames for the email corresponding to 'message'.
783 * Returns a notmuch_filenames_t iterator listing all the filenames
784 * associated with 'message'. These files may not have identical
785 * content, but each will have the identical Message-ID.
787 * Each filename in the iterator is an absolute filename, (the initial
788 * component will match notmuch_database_get_path() ).
790 notmuch_filenames_t *
791 notmuch_message_get_filenames (notmuch_message_t *message);
794 typedef enum _notmuch_message_flag {
795 NOTMUCH_MESSAGE_FLAG_MATCH
796 } notmuch_message_flag_t;
798 /* Get a value of a flag for the email corresponding to 'message'. */
800 notmuch_message_get_flag (notmuch_message_t *message,
801 notmuch_message_flag_t flag);
803 /* Set a value of a flag for the email corresponding to 'message'. */
805 notmuch_message_set_flag (notmuch_message_t *message,
806 notmuch_message_flag_t flag, notmuch_bool_t value);
808 /* Get the date of 'message' as a time_t value.
810 * For the original textual representation of the Date header from the
811 * message call notmuch_message_get_header() with a header value of
814 notmuch_message_get_date (notmuch_message_t *message);
816 /* Get the value of the specified header from 'message'.
818 * The value will be read from the actual message file, not from the
819 * notmuch database. The header name is case insensitive.
821 * The returned string belongs to the message so should not be
822 * modified or freed by the caller (nor should it be referenced after
823 * the message is destroyed).
825 * Returns an empty string ("") if the message does not contain a
826 * header line matching 'header'. Returns NULL if any error occurs.
829 notmuch_message_get_header (notmuch_message_t *message, const char *header);
831 /* Get the tags for 'message', returning a notmuch_tags_t object which
832 * can be used to iterate over all tags.
834 * The tags object is owned by the message and as such, will only be
835 * valid for as long as the message is valid, (which is until the
836 * query from which it derived is destroyed).
838 * Typical usage might be:
840 * notmuch_message_t *message;
841 * notmuch_tags_t *tags;
844 * message = notmuch_database_find_message (database, message_id);
846 * for (tags = notmuch_message_get_tags (message);
847 * notmuch_tags_valid (tags);
848 * notmuch_result_move_to_next (tags))
850 * tag = notmuch_tags_get (tags);
854 * notmuch_message_destroy (message);
856 * Note that there's no explicit destructor needed for the
857 * notmuch_tags_t object. (For consistency, we do provide a
858 * notmuch_tags_destroy function, but there's no good reason to call
859 * it if the message is about to be destroyed).
862 notmuch_message_get_tags (notmuch_message_t *message);
864 /* The longest possible tag value. */
865 #define NOTMUCH_TAG_MAX 200
867 /* Add a tag to the given message.
871 * NOTMUCH_STATUS_SUCCESS: Tag successfully added to message
873 * NOTMUCH_STATUS_NULL_POINTER: The 'tag' argument is NULL
875 * NOTMUCH_STATUS_TAG_TOO_LONG: The length of 'tag' is too long
876 * (exceeds NOTMUCH_TAG_MAX)
878 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
879 * mode so message cannot be modified.
882 notmuch_message_add_tag (notmuch_message_t *message, const char *tag);
884 /* Remove a tag from the given message.
888 * NOTMUCH_STATUS_SUCCESS: Tag successfully removed from message
890 * NOTMUCH_STATUS_NULL_POINTER: The 'tag' argument is NULL
892 * NOTMUCH_STATUS_TAG_TOO_LONG: The length of 'tag' is too long
893 * (exceeds NOTMUCH_TAG_MAX)
895 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
896 * mode so message cannot be modified.
899 notmuch_message_remove_tag (notmuch_message_t *message, const char *tag);
901 /* Remove all tags from the given message.
903 * See notmuch_message_freeze for an example showing how to safely
904 * replace tag values.
906 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
907 * mode so message cannot be modified.
910 notmuch_message_remove_all_tags (notmuch_message_t *message);
912 /* Add/remove tags according to maildir flags in the message filename(s)
914 * This function examines the filenames of 'message' for maildir
915 * flags, and adds or removes tags on 'message' as follows when these
920 * 'D' Adds the "draft" tag to the message
921 * 'F' Adds the "flagged" tag to the message
922 * 'P' Adds the "passed" tag to the message
923 * 'R' Adds the "replied" tag to the message
924 * 'S' Removes the "unread" tag from the message
926 * The only filenames examined for flags are filenames which appear to
927 * be within a maildir directory, (the file must be in a directory
928 * named "new" or "cur" and there must be a neighboring directory
929 * named respectively "cur" or "new"). The flags are identified as
930 * trailing components of the filename after a sequence of ":2,".
932 * If there are multiple filenames associated with this message, the
933 * flag is considered present if it appears in one or more
934 * filenames. (That is, the flags from the multiple filenames are
935 * combined with the logical OR operator.)
937 * A client can ensure that notmuch database tags remain synchronized
938 * with maildir flags by calling this function after each call to
939 * notmuch_database_add_message. See also
940 * notmuch_message_tags_to_maildir_flags for synchronizing tag changes
941 * back to maildir flags.
944 notmuch_message_maildir_flags_to_tags (notmuch_message_t *message);
946 /* Rename message filename(s) to encode tags as maildir flags
948 * Specifically, for each filename corresponding to this message:
950 * If the filename is not in a maildir directory, do nothing.
951 * (A maildir directory is determined as a directory named "new" or
952 * "cur" with a neighboring directory named respectively "cur" or
955 * If the filename is in a maildir directory, rename the file so that
956 * its filename ends with the sequence ":2," followed by zero or more
957 * of the following single-character flags (in ASCII order):
959 * 'D' if the message has the "draft" tag
960 * 'F' if the message has the "flagged" tag
961 * 'P' if the message has the "passed" tag
962 * 'R' if the message has the "replied" tag
963 * 'S' if the message does not have the "unread" tag
965 * Any existing flags unmentioned in the list above are left
966 * unaffected by the rename.
968 * Also, if this filename is in a directory named "new", rename it to
969 * be within the neighboring directory named "cur".
971 * A client can ensure that maildir filename flags remain synchronized
972 * with notmuch database tags by calling this function after changing
973 * tags, (after calls to notmuch_message_add_tag,
974 * notmuch_message_remove_tag, or notmuch_message_freeze/
975 * notmuch_message_thaw). See also notmuch_message_maildir_flags_to_tags
976 * for synchronizing maildir flag changes back to tags.
979 notmuch_message_tags_to_maildir_flags (notmuch_message_t *message);
981 /* Freeze the current state of 'message' within the database.
983 * This means that changes to the message state, (via
984 * notmuch_message_add_tag, notmuch_message_remove_tag, and
985 * notmuch_message_remove_all_tags), will not be committed to the
986 * database until the message is thawed with notmuch_message_thaw.
988 * Multiple calls to freeze/thaw are valid and these calls will
989 * "stack". That is there must be as many calls to thaw as to freeze
990 * before a message is actually thawed.
992 * The ability to do freeze/thaw allows for safe transactions to
993 * change tag values. For example, explicitly setting a message to
994 * have a given set of tags might look like this:
996 * notmuch_message_freeze (message);
998 * notmuch_message_remove_all_tags (message);
1000 * for (i = 0; i < NUM_TAGS; i++)
1001 * notmuch_message_add_tag (message, tags[i]);
1003 * notmuch_message_thaw (message);
1005 * With freeze/thaw used like this, the message in the database is
1006 * guaranteed to have either the full set of original tag values, or
1007 * the full set of new tag values, but nothing in between.
1009 * Imagine the example above without freeze/thaw and the operation
1010 * somehow getting interrupted. This could result in the message being
1011 * left with no tags if the interruption happened after
1012 * notmuch_message_remove_all_tags but before notmuch_message_add_tag.
1016 * NOTMUCH_STATUS_SUCCESS: Message successfully frozen.
1018 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
1019 * mode so message cannot be modified.
1022 notmuch_message_freeze (notmuch_message_t *message);
1024 /* Thaw the current 'message', synchronizing any changes that may have
1025 * occurred while 'message' was frozen into the notmuch database.
1027 * See notmuch_message_freeze for an example of how to use this
1028 * function to safely provide tag changes.
1030 * Multiple calls to freeze/thaw are valid and these calls with
1031 * "stack". That is there must be as many calls to thaw as to freeze
1032 * before a message is actually thawed.
1036 * NOTMUCH_STATUS_SUCCESS: Message successfully thawed, (or at least
1037 * its frozen count has successfully been reduced by 1).
1039 * NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW: An attempt was made to thaw
1040 * an unfrozen message. That is, there have been an unbalanced
1041 * number of calls to notmuch_message_freeze and
1042 * notmuch_message_thaw.
1045 notmuch_message_thaw (notmuch_message_t *message);
1047 /* Destroy a notmuch_message_t object.
1049 * It can be useful to call this function in the case of a single
1050 * query object with many messages in the result, (such as iterating
1051 * over the entire database). Otherwise, it's fine to never call this
1052 * function and there will still be no memory leaks. (The memory from
1053 * the messages get reclaimed when the containing query is destroyed.)
1056 notmuch_message_destroy (notmuch_message_t *message);
1058 /* Is the given 'tags' iterator pointing at a valid tag.
1060 * When this function returns TRUE, notmuch_tags_get will return a
1061 * valid string. Whereas when this function returns FALSE,
1062 * notmuch_tags_get will return NULL.
1064 * See the documentation of notmuch_message_get_tags for example code
1065 * showing how to iterate over a notmuch_tags_t object.
1068 notmuch_tags_valid (notmuch_tags_t *tags);
1070 /* Get the current tag from 'tags' as a string.
1072 * Note: The returned string belongs to 'tags' and has a lifetime
1073 * identical to it (and the query to which it ultimately belongs).
1075 * See the documentation of notmuch_message_get_tags for example code
1076 * showing how to iterate over a notmuch_tags_t object.
1079 notmuch_tags_get (notmuch_tags_t *tags);
1081 /* Move the 'tags' iterator to the next tag.
1083 * If 'tags' is already pointing at the last tag then the iterator
1084 * will be moved to a point just beyond that last tag, (where
1085 * notmuch_tags_valid will return FALSE and notmuch_tags_get will
1088 * See the documentation of notmuch_message_get_tags for example code
1089 * showing how to iterate over a notmuch_tags_t object.
1092 notmuch_tags_move_to_next (notmuch_tags_t *tags);
1094 /* Destroy a notmuch_tags_t object.
1096 * It's not strictly necessary to call this function. All memory from
1097 * the notmuch_tags_t object will be reclaimed when the containing
1098 * message or query objects are destroyed.
1101 notmuch_tags_destroy (notmuch_tags_t *tags);
1103 /* Store an mtime within the database for 'directory'.
1105 * The 'directory' should be an object retrieved from the database
1106 * with notmuch_database_get_directory for a particular path.
1108 * The intention is for the caller to use the mtime to allow efficient
1109 * identification of new messages to be added to the database. The
1110 * recommended usage is as follows:
1112 * o Read the mtime of a directory from the filesystem
1114 * o Call add_message for all mail files in the directory
1116 * o Call notmuch_directory_set_mtime with the mtime read from the
1119 * Then, when wanting to check for updates to the directory in the
1120 * future, the client can call notmuch_directory_get_mtime and know
1121 * that it only needs to add files if the mtime of the directory and
1122 * files are newer than the stored timestamp.
1124 * Note: The notmuch_directory_get_mtime function does not allow the
1125 * caller to distinguish a timestamp of 0 from a non-existent
1126 * timestamp. So don't store a timestamp of 0 unless you are
1127 * comfortable with that.
1131 * NOTMUCH_STATUS_SUCCESS: mtime successfully stored in database.
1133 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception
1134 * occurred, mtime not stored.
1136 * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
1137 * mode so directory mtime cannot be modified.
1140 notmuch_directory_set_mtime (notmuch_directory_t *directory,
1143 /* Get the mtime of a directory, (as previously stored with
1144 * notmuch_directory_set_mtime).
1146 * Returns 0 if no mtime has previously been stored for this
1149 notmuch_directory_get_mtime (notmuch_directory_t *directory);
1151 /* Get a notmuch_filenames_t iterator listing all the filenames of
1152 * messages in the database within the given directory.
1154 * The returned filenames will be the basename-entries only (not
1155 * complete paths). */
1156 notmuch_filenames_t *
1157 notmuch_directory_get_child_files (notmuch_directory_t *directory);
1159 /* Get a notmuch_filenams_t iterator listing all the filenames of
1160 * sub-directories in the database within the given directory.
1162 * The returned filenames will be the basename-entries only (not
1163 * complete paths). */
1164 notmuch_filenames_t *
1165 notmuch_directory_get_child_directories (notmuch_directory_t *directory);
1167 /* Destroy a notmuch_directory_t object. */
1169 notmuch_directory_destroy (notmuch_directory_t *directory);
1171 /* Is the given 'filenames' iterator pointing at a valid filename.
1173 * When this function returns TRUE, notmuch_filenames_get will return
1174 * a valid string. Whereas when this function returns FALSE,
1175 * notmuch_filenames_get will return NULL.
1177 * It is acceptable to pass NULL for 'filenames', in which case this
1178 * function will always return FALSE.
1181 notmuch_filenames_valid (notmuch_filenames_t *filenames);
1183 /* Get the current filename from 'filenames' as a string.
1185 * Note: The returned string belongs to 'filenames' and has a lifetime
1186 * identical to it (and the directory to which it ultimately belongs).
1188 * It is acceptable to pass NULL for 'filenames', in which case this
1189 * function will always return NULL.
1192 notmuch_filenames_get (notmuch_filenames_t *filenames);
1194 /* Move the 'filenames' iterator to the next filename.
1196 * If 'filenames' is already pointing at the last filename then the
1197 * iterator will be moved to a point just beyond that last filename,
1198 * (where notmuch_filenames_valid will return FALSE and
1199 * notmuch_filenames_get will return NULL).
1201 * It is acceptable to pass NULL for 'filenames', in which case this
1202 * function will do nothing.
1205 notmuch_filenames_move_to_next (notmuch_filenames_t *filenames);
1207 /* Destroy a notmuch_filenames_t object.
1209 * It's not strictly necessary to call this function. All memory from
1210 * the notmuch_filenames_t object will be reclaimed when the
1211 * containing directory object is destroyed.
1213 * It is acceptable to pass NULL for 'filenames', in which case this
1214 * function will do nothing.
1217 notmuch_filenames_destroy (notmuch_filenames_t *filenames);