lib: Add notmuch_database_{begin,end}_atomic.
[notmuch] / lib / notmuch.h
1 /* notmuch - Not much of an email library, (just index and search)
2  *
3  * Copyright © 2009 Carl Worth
4  *
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.
9  *
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.
14  *
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/ .
17  *
18  * Author: Carl Worth <cworth@cworth.org>
19  */
20
21 #ifndef NOTMUCH_H
22 #define NOTMUCH_H
23
24 #ifdef  __cplusplus
25 # define NOTMUCH_BEGIN_DECLS  extern "C" {
26 # define NOTMUCH_END_DECLS    }
27 #else
28 # define NOTMUCH_BEGIN_DECLS
29 # define NOTMUCH_END_DECLS
30 #endif
31
32 NOTMUCH_BEGIN_DECLS
33
34 #include <time.h>
35
36 #ifndef FALSE
37 #define FALSE 0
38 #endif
39
40 #ifndef TRUE
41 #define TRUE 1
42 #endif
43
44 typedef int notmuch_bool_t;
45
46 /* Status codes used for the return values of most functions.
47  *
48  * A zero value (NOTMUCH_STATUS_SUCCESS) indicates that the function
49  * completed without error. Any other value indicates an error as
50  * follows:
51  *
52  * NOTMUCH_STATUS_SUCCESS: No error occurred.
53  *
54  * NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory
55  *
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
58  * whatever.
59  *
60  * NOTMUCH_STATUS_READ_ONLY_DATABASE: An attempt was made to write to
61  *      a database opened in read-only mode.
62  *
63  * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred
64  *
65  * NOTMUCH_STATUS_FILE_ERROR: An error occurred trying to read or
66  *      write to a file (this could be file not found, permission
67  *      denied, etc.)
68  *
69  * NOTMUCH_STATUS_FILE_NOT_EMAIL: A file was presented that doesn't
70  *      appear to be an email message.
71  *
72  * NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID: A file contains a message ID
73  *      that is identical to a message already in the database.
74  *
75  * NOTMUCH_STATUS_NULL_POINTER: The user erroneously passed a NULL
76  *      pointer to a notmuch function.
77  *
78  * NOTMUCH_STATUS_TAG_TOO_LONG: A tag value is too long (exceeds
79  *      NOTMUCH_TAG_MAX)
80  *
81  * NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW: The notmuch_message_thaw
82  *      function has been called more times than notmuch_message_freeze.
83  *
84  * And finally:
85  *
86  * NOTMUCH_STATUS_LAST_STATUS: Not an actual status value. Just a way
87  *      to find out how many valid status values there are.
88  */
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,
100
101     NOTMUCH_STATUS_LAST_STATUS
102 } notmuch_status_t;
103
104 /* Get a string representation of a notmuch_status_t value.
105  *
106  * The result is read-only.
107  */
108 const char *
109 notmuch_status_to_string (notmuch_status_t status);
110
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;
122
123 /* Create a new, empty notmuch database located at 'path'.
124  *
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
128  * store its data.
129  *
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.
133  *
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.
138  *
139  * In case of any failure, this function returns NULL, (after printing
140  * an error message on stderr).
141  */
142 notmuch_database_t *
143 notmuch_database_create (const char *path);
144
145 typedef enum {
146     NOTMUCH_DATABASE_MODE_READ_ONLY = 0,
147     NOTMUCH_DATABASE_MODE_READ_WRITE
148 } notmuch_database_mode_t;
149
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. */
152
153 /* Open an existing notmuch database located at 'path'.
154  *
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.
160  *
161  * An existing notmuch database can be identified by the presence of a
162  * directory named ".notmuch" below 'path'.
163  *
164  * The caller should call notmuch_database_close when finished with
165  * this database.
166  *
167  * In case of any failure, this function returns NULL, (after printing
168  * an error message on stderr).
169  */
170 notmuch_database_t *
171 notmuch_database_open (const char *path,
172                        notmuch_database_mode_t mode);
173
174 /* Close the given notmuch database, freeing all associated
175  * resources. See notmuch_database_open. */
176 void
177 notmuch_database_close (notmuch_database_t *database);
178
179 /* Return the database path of the given database.
180  *
181  * The return value is a string owned by notmuch so should not be
182  * modified nor freed by the caller. */
183 const char *
184 notmuch_database_get_path (notmuch_database_t *database);
185
186 /* Return the database format version of the given database. */
187 unsigned int
188 notmuch_database_get_version (notmuch_database_t *database);
189
190 /* Does this database need to be upgraded before writing to it?
191  *
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. */
196 notmuch_bool_t
197 notmuch_database_needs_upgrade (notmuch_database_t *database);
198
199 /* Upgrade the current database.
200  *
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.
204  *
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.
210  */
211 notmuch_status_t
212 notmuch_database_upgrade (notmuch_database_t *database,
213                           void (*progress_notify) (void *closure,
214                                                    double progress),
215                           void *closure);
216
217 /* Begin an atomic database operation.
218  *
219  * Any modifications performed between a successful begin and a
220  * notmuch_database_end_atomic will be applied to the database
221  * atomically.  Note that, unlike a typical database transaction, this
222  * only ensures atomicity, not durability; neither begin nor end
223  * necessarily flush modifications to disk.
224  *
225  * Return value:
226  *
227  * NOTMUCH_STATUS_SUCCESS: Successfully entered atomic section.
228  *
229  * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred;
230  *      atomic section not entered.
231  */
232 notmuch_status_t
233 notmuch_database_begin_atomic (notmuch_database_t *notmuch);
234
235 /* Indicate the end of an atomic database operation.
236  *
237  * Return value:
238  *
239  * NOTMUCH_STATUS_SUCCESS: Successfully completed atomic section.
240  *
241  * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred;
242  *      atomic section not ended.
243  */
244 notmuch_status_t
245 notmuch_database_end_atomic (notmuch_database_t *notmuch);
246
247 /* Retrieve a directory object from the database for 'path'.
248  *
249  * Here, 'path' should be a path relative to the path of 'database'
250  * (see notmuch_database_get_path), or else should be an absolute path
251  * with initial components that match the path of 'database'.
252  *
253  * Can return NULL if a Xapian exception occurs.
254  */
255 notmuch_directory_t *
256 notmuch_database_get_directory (notmuch_database_t *database,
257                                 const char *path);
258
259 /* Add a new message to the given notmuch database.
260  *
261  * Here,'filename' should be a path relative to the path of
262  * 'database' (see notmuch_database_get_path), or else should be an
263  * absolute filename with initial components that match the path of
264  * 'database'.
265  *
266  * The file should be a single mail message (not a multi-message mbox)
267  * that is expected to remain at its current location, (since the
268  * notmuch database will reference the filename, and will not copy the
269  * entire contents of the file.
270  *
271  * If 'message' is not NULL, then, on successful return
272  * (NOTMUCH_STATUS_SUCCESS or NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID) '*message'
273  * will be initialized to a message object that can be used for things
274  * such as adding tags to the just-added message. The user should call
275  * notmuch_message_destroy when done with the message. On any failure
276  * '*message' will be set to NULL.
277  *
278  * Return value:
279  *
280  * NOTMUCH_STATUS_SUCCESS: Message successfully added to database.
281  *
282  * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred,
283  *      message not added.
284  *
285  * NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID: Message has the same message
286  *      ID as another message already in the database. The new
287  *      filename was successfully added to the message in the database
288  *      (if not already present).
289  *
290  * NOTMUCH_STATUS_FILE_ERROR: an error occurred trying to open the
291  *      file, (such as permission denied, or file not found,
292  *      etc.). Nothing added to the database.
293  *
294  * NOTMUCH_STATUS_FILE_NOT_EMAIL: the contents of filename don't look
295  *      like an email message. Nothing added to the database.
296  *
297  * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
298  *      mode so no message can be added.
299  */
300 notmuch_status_t
301 notmuch_database_add_message (notmuch_database_t *database,
302                               const char *filename,
303                               notmuch_message_t **message);
304
305 /* Remove a message from the given notmuch database.
306  *
307  * Note that only this particular filename association is removed from
308  * the database. If the same message (as determined by the message ID)
309  * is still available via other filenames, then the message will
310  * persist in the database for those filenames. When the last filename
311  * is removed for a particular message, the database content for that
312  * message will be entirely removed.
313  *
314  * Return value:
315  *
316  * NOTMUCH_STATUS_SUCCESS: The last filename was removed and the
317  *      message was removed from the database.
318  *
319  * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred,
320  *      message not removed.
321  *
322  * NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID: This filename was removed but
323  *      the message persists in the database with at least one other
324  *      filename.
325  *
326  * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
327  *      mode so no message can be removed.
328  */
329 notmuch_status_t
330 notmuch_database_remove_message (notmuch_database_t *database,
331                                  const char *filename);
332
333 /* Find a message with the given message_id.
334  *
335  * If the database contains a message with the given message_id, then
336  * a new notmuch_message_t object is returned. The caller should call
337  * notmuch_message_destroy when done with the message.
338  *
339  * This function returns NULL in the following situations:
340  *
341  *      * No message is found with the given message_id
342  *      * An out-of-memory situation occurs
343  *      * A Xapian exception occurs
344  */
345 notmuch_message_t *
346 notmuch_database_find_message (notmuch_database_t *database,
347                                const char *message_id);
348
349 /* Return a list of all tags found in the database.
350  *
351  * This function creates a list of all tags found in the database. The
352  * resulting list contains all tags from all messages found in the database.
353  *
354  * On error this function returns NULL.
355  */
356 notmuch_tags_t *
357 notmuch_database_get_all_tags (notmuch_database_t *db);
358
359 /* Create a new query for 'database'.
360  *
361  * Here, 'database' should be an open database, (see
362  * notmuch_database_open and notmuch_database_create).
363  *
364  * For the query string, we'll document the syntax here more
365  * completely in the future, but it's likely to be a specialized
366  * version of the general Xapian query syntax:
367  *
368  * http://xapian.org/docs/queryparser.html
369  *
370  * As a special case, passing either a length-zero string, (that is ""),
371  * or a string consisting of a single asterisk (that is "*"), will
372  * result in a query that returns all messages in the database.
373  *
374  * See notmuch_query_set_sort for controlling the order of results.
375  * See notmuch_query_search_messages and notmuch_query_search_threads
376  * to actually execute the query.
377  *
378  * User should call notmuch_query_destroy when finished with this
379  * query.
380  *
381  * Will return NULL if insufficient memory is available.
382  */
383 notmuch_query_t *
384 notmuch_query_create (notmuch_database_t *database,
385                       const char *query_string);
386
387 /* Sort values for notmuch_query_set_sort */
388 typedef enum {
389     NOTMUCH_SORT_OLDEST_FIRST,
390     NOTMUCH_SORT_NEWEST_FIRST,
391     NOTMUCH_SORT_MESSAGE_ID,
392     NOTMUCH_SORT_UNSORTED
393 } notmuch_sort_t;
394
395 /* Return the query_string of this query. See notmuch_query_create. */
396 const char *
397 notmuch_query_get_query_string (notmuch_query_t *query);
398
399 /* Specify the sorting desired for this query. */
400 void
401 notmuch_query_set_sort (notmuch_query_t *query, notmuch_sort_t sort);
402
403 /* Return the sort specified for this query. See notmuch_query_set_sort. */
404 notmuch_sort_t
405 notmuch_query_get_sort (notmuch_query_t *query);
406
407 /* Execute a query for threads, returning a notmuch_threads_t object
408  * which can be used to iterate over the results. The returned threads
409  * object is owned by the query and as such, will only be valid until
410  * notmuch_query_destroy.
411  *
412  * Typical usage might be:
413  *
414  *     notmuch_query_t *query;
415  *     notmuch_threads_t *threads;
416  *     notmuch_thread_t *thread;
417  *
418  *     query = notmuch_query_create (database, query_string);
419  *
420  *     for (threads = notmuch_query_search_threads (query);
421  *          notmuch_threads_valid (threads);
422  *          notmuch_threads_move_to_next (threads))
423  *     {
424  *         thread = notmuch_threads_get (threads);
425  *         ....
426  *         notmuch_thread_destroy (thread);
427  *     }
428  *
429  *     notmuch_query_destroy (query);
430  *
431  * Note: If you are finished with a thread before its containing
432  * query, you can call notmuch_thread_destroy to clean up some memory
433  * sooner (as in the above example). Otherwise, if your thread objects
434  * are long-lived, then you don't need to call notmuch_thread_destroy
435  * and all the memory will still be reclaimed when the query is
436  * destroyed.
437  *
438  * Note that there's no explicit destructor needed for the
439  * notmuch_threads_t object. (For consistency, we do provide a
440  * notmuch_threads_destroy function, but there's no good reason
441  * to call it if the query is about to be destroyed).
442  *
443  * If a Xapian exception occurs this function will return NULL.
444  */
445 notmuch_threads_t *
446 notmuch_query_search_threads (notmuch_query_t *query);
447
448 /* Execute a query for messages, returning a notmuch_messages_t object
449  * which can be used to iterate over the results. The returned
450  * messages object is owned by the query and as such, will only be
451  * valid until notmuch_query_destroy.
452  *
453  * Typical usage might be:
454  *
455  *     notmuch_query_t *query;
456  *     notmuch_messages_t *messages;
457  *     notmuch_message_t *message;
458  *
459  *     query = notmuch_query_create (database, query_string);
460  *
461  *     for (messages = notmuch_query_search_messages (query);
462  *          notmuch_messages_valid (messages);
463  *          notmuch_messages_move_to_next (messages))
464  *     {
465  *         message = notmuch_messages_get (messages);
466  *         ....
467  *         notmuch_message_destroy (message);
468  *     }
469  *
470  *     notmuch_query_destroy (query);
471  *
472  * Note: If you are finished with a message before its containing
473  * query, you can call notmuch_message_destroy to clean up some memory
474  * sooner (as in the above example). Otherwise, if your message
475  * objects are long-lived, then you don't need to call
476  * notmuch_message_destroy and all the memory will still be reclaimed
477  * when the query is destroyed.
478  *
479  * Note that there's no explicit destructor needed for the
480  * notmuch_messages_t object. (For consistency, we do provide a
481  * notmuch_messages_destroy function, but there's no good
482  * reason to call it if the query is about to be destroyed).
483  *
484  * If a Xapian exception occurs this function will return NULL.
485  */
486 notmuch_messages_t *
487 notmuch_query_search_messages (notmuch_query_t *query);
488
489 /* Destroy a notmuch_query_t along with any associated resources.
490  *
491  * This will in turn destroy any notmuch_threads_t and
492  * notmuch_messages_t objects generated by this query, (and in
493  * turn any notmuch_thread_t and notmuch_message_t objects generated
494  * from those results, etc.), if such objects haven't already been
495  * destroyed.
496  */
497 void
498 notmuch_query_destroy (notmuch_query_t *query);
499
500 /* Is the given 'threads' iterator pointing at a valid thread.
501  *
502  * When this function returns TRUE, notmuch_threads_get will return a
503  * valid object. Whereas when this function returns FALSE,
504  * notmuch_threads_get will return NULL.
505  *
506  * See the documentation of notmuch_query_search_threads for example
507  * code showing how to iterate over a notmuch_threads_t object.
508  */
509 notmuch_bool_t
510 notmuch_threads_valid (notmuch_threads_t *threads);
511
512 /* Get the current thread from 'threads' as a notmuch_thread_t.
513  *
514  * Note: The returned thread belongs to 'threads' and has a lifetime
515  * identical to it (and the query to which it belongs).
516  *
517  * See the documentation of notmuch_query_search_threads for example
518  * code showing how to iterate over a notmuch_threads_t object.
519  *
520  * If an out-of-memory situation occurs, this function will return
521  * NULL.
522  */
523 notmuch_thread_t *
524 notmuch_threads_get (notmuch_threads_t *threads);
525
526 /* Move the 'threads' iterator to the next thread.
527  *
528  * If 'threads' is already pointing at the last thread then the
529  * iterator will be moved to a point just beyond that last thread,
530  * (where notmuch_threads_valid will return FALSE and
531  * notmuch_threads_get will return NULL).
532  *
533  * See the documentation of notmuch_query_search_threads for example
534  * code showing how to iterate over a notmuch_threads_t object.
535  */
536 void
537 notmuch_threads_move_to_next (notmuch_threads_t *threads);
538
539 /* Destroy a notmuch_threads_t object.
540  *
541  * It's not strictly necessary to call this function. All memory from
542  * the notmuch_threads_t object will be reclaimed when the
543  * containing query object is destroyed.
544  */
545 void
546 notmuch_threads_destroy (notmuch_threads_t *threads);
547
548 /* Return an estimate of the number of messages matching a search
549  *
550  * This function performs a search and returns Xapian's best
551  * guess as to number of matching messages.
552  *
553  * If a Xapian exception occurs, this function may return 0 (after
554  * printing a message).
555  */
556 unsigned
557 notmuch_query_count_messages (notmuch_query_t *query);
558  
559 /* Get the thread ID of 'thread'.
560  *
561  * The returned string belongs to 'thread' and as such, should not be
562  * modified by the caller and will only be valid for as long as the
563  * thread is valid, (which is until notmuch_thread_destroy or until
564  * the query from which it derived is destroyed).
565  */
566 const char *
567 notmuch_thread_get_thread_id (notmuch_thread_t *thread);
568
569 /* Get the total number of messages in 'thread'.
570  *
571  * This count consists of all messages in the database belonging to
572  * this thread. Contrast with notmuch_thread_get_matched_messages() .
573  */
574 int
575 notmuch_thread_get_total_messages (notmuch_thread_t *thread);
576
577 /* Get a notmuch_messages_t iterator for the top-level messages in
578  * 'thread'.
579  *
580  * This iterator will not necessarily iterate over all of the messages
581  * in the thread. It will only iterate over the messages in the thread
582  * which are not replies to other messages in the thread.
583  *
584  * To iterate over all messages in the thread, the caller will need to
585  * iterate over the result of notmuch_message_get_replies for each
586  * top-level message (and do that recursively for the resulting
587  * messages, etc.).
588  */
589 notmuch_messages_t *
590 notmuch_thread_get_toplevel_messages (notmuch_thread_t *thread);
591
592 /* Get the number of messages in 'thread' that matched the search.
593  *
594  * This count includes only the messages in this thread that were
595  * matched by the search from which the thread was created. Contrast
596  * with notmuch_thread_get_total_messages() .
597  */
598 int
599 notmuch_thread_get_matched_messages (notmuch_thread_t *thread);
600
601 /* Get the authors of 'thread'
602  *
603  * The returned string is a comma-separated list of the names of the
604  * authors of mail messages in the query results that belong to this
605  * thread.
606  *
607  * The returned string belongs to 'thread' and as such, should not be
608  * modified by the caller and will only be valid for as long as the
609  * thread is valid, (which is until notmuch_thread_destroy or until
610  * the query from which it derived is destroyed).
611  */
612 const char *
613 notmuch_thread_get_authors (notmuch_thread_t *thread);
614
615 /* Get the subject of 'thread'
616  *
617  * The subject is taken from the first message (according to the query
618  * order---see notmuch_query_set_sort) in the query results that
619  * belongs to this thread.
620  *
621  * The returned string belongs to 'thread' and as such, should not be
622  * modified by the caller and will only be valid for as long as the
623  * thread is valid, (which is until notmuch_thread_destroy or until
624  * the query from which it derived is destroyed).
625  */
626 const char *
627 notmuch_thread_get_subject (notmuch_thread_t *thread);
628
629 /* Get the date of the oldest message in 'thread' as a time_t value.
630  */
631 time_t
632 notmuch_thread_get_oldest_date (notmuch_thread_t *thread);
633
634 /* Get the date of the newest message in 'thread' as a time_t value.
635  */
636 time_t
637 notmuch_thread_get_newest_date (notmuch_thread_t *thread);
638
639 /* Get the tags for 'thread', returning a notmuch_tags_t object which
640  * can be used to iterate over all tags.
641  *
642  * Note: In the Notmuch database, tags are stored on individual
643  * messages, not on threads. So the tags returned here will be all
644  * tags of the messages which matched the search and which belong to
645  * this thread.
646  *
647  * The tags object is owned by the thread and as such, will only be
648  * valid for as long as the thread is valid, (for example, until
649  * notmuch_thread_destroy or until the query from which it derived is
650  * destroyed).
651  *
652  * Typical usage might be:
653  *
654  *     notmuch_thread_t *thread;
655  *     notmuch_tags_t *tags;
656  *     const char *tag;
657  *
658  *     thread = notmuch_threads_get (threads);
659  *
660  *     for (tags = notmuch_thread_get_tags (thread);
661  *          notmuch_tags_valid (tags);
662  *          notmuch_result_move_to_next (tags))
663  *     {
664  *         tag = notmuch_tags_get (tags);
665  *         ....
666  *     }
667  *
668  *     notmuch_thread_destroy (thread);
669  *
670  * Note that there's no explicit destructor needed for the
671  * notmuch_tags_t object. (For consistency, we do provide a
672  * notmuch_tags_destroy function, but there's no good reason to call
673  * it if the message is about to be destroyed).
674  */
675 notmuch_tags_t *
676 notmuch_thread_get_tags (notmuch_thread_t *thread);
677
678 /* Destroy a notmuch_thread_t object. */
679 void
680 notmuch_thread_destroy (notmuch_thread_t *thread);
681
682 /* Is the given 'messages' iterator pointing at a valid message.
683  *
684  * When this function returns TRUE, notmuch_messages_get will return a
685  * valid object. Whereas when this function returns FALSE,
686  * notmuch_messages_get will return NULL.
687  *
688  * See the documentation of notmuch_query_search_messages for example
689  * code showing how to iterate over a notmuch_messages_t object.
690  */
691 notmuch_bool_t
692 notmuch_messages_valid (notmuch_messages_t *messages);
693
694 /* Get the current message from 'messages' as a notmuch_message_t.
695  *
696  * Note: The returned message belongs to 'messages' and has a lifetime
697  * identical to it (and the query to which it belongs).
698  *
699  * See the documentation of notmuch_query_search_messages for example
700  * code showing how to iterate over a notmuch_messages_t object.
701  *
702  * If an out-of-memory situation occurs, this function will return
703  * NULL.
704  */
705 notmuch_message_t *
706 notmuch_messages_get (notmuch_messages_t *messages);
707
708 /* Move the 'messages' iterator to the next message.
709  *
710  * If 'messages' is already pointing at the last message then the
711  * iterator will be moved to a point just beyond that last message,
712  * (where notmuch_messages_valid will return FALSE and
713  * notmuch_messages_get will return NULL).
714  *
715  * See the documentation of notmuch_query_search_messages for example
716  * code showing how to iterate over a notmuch_messages_t object.
717  */
718 void
719 notmuch_messages_move_to_next (notmuch_messages_t *messages);
720
721 /* Destroy a notmuch_messages_t object.
722  *
723  * It's not strictly necessary to call this function. All memory from
724  * the notmuch_messages_t object will be reclaimed when the containing
725  * query object is destroyed.
726  */
727 void
728 notmuch_messages_destroy (notmuch_messages_t *messages);
729
730 /* Return a list of tags from all messages.
731  *
732  * The resulting list is guaranteed not to contain duplicated tags.
733  *
734  * WARNING: You can no longer iterate over messages after calling this
735  * function, because the iterator will point at the end of the list.
736  * We do not have a function to reset the iterator yet and the only
737  * way how you can iterate over the list again is to recreate the
738  * message list.
739  *
740  * The function returns NULL on error.
741  */
742 notmuch_tags_t *
743 notmuch_messages_collect_tags (notmuch_messages_t *messages);
744
745 /* Get the message ID of 'message'.
746  *
747  * The returned string belongs to 'message' and as such, should not be
748  * modified by the caller and will only be valid for as long as the
749  * message is valid, (which is until the query from which it derived
750  * is destroyed).
751  *
752  * This function will not return NULL since Notmuch ensures that every
753  * message has a unique message ID, (Notmuch will generate an ID for a
754  * message if the original file does not contain one).
755  */
756 const char *
757 notmuch_message_get_message_id (notmuch_message_t *message);
758
759 /* Get the thread ID of 'message'.
760  *
761  * The returned string belongs to 'message' and as such, should not be
762  * modified by the caller and will only be valid for as long as the
763  * message is valid, (for example, until the user calls
764  * notmuch_message_destroy on 'message' or until a query from which it
765  * derived is destroyed).
766  *
767  * This function will not return NULL since Notmuch ensures that every
768  * message belongs to a single thread.
769  */
770 const char *
771 notmuch_message_get_thread_id (notmuch_message_t *message);
772
773 /* Get a notmuch_messages_t iterator for all of the replies to
774  * 'message'.
775  *
776  * Note: This call only makes sense if 'message' was ultimately
777  * obtained from a notmuch_thread_t object, (such as by coming
778  * directly from the result of calling notmuch_thread_get_
779  * toplevel_messages or by any number of subsequent
780  * calls to notmuch_message_get_replies).
781  *
782  * If 'message' was obtained through some non-thread means, (such as
783  * by a call to notmuch_query_search_messages), then this function
784  * will return NULL.
785  *
786  * If there are no replies to 'message', this function will return
787  * NULL. (Note that notmuch_messages_valid will accept that NULL
788  * value as legitimate, and simply return FALSE for it.)
789  */
790 notmuch_messages_t *
791 notmuch_message_get_replies (notmuch_message_t *message);
792
793 /* Get a filename for the email corresponding to 'message'.
794  *
795  * The returned filename is an absolute filename, (the initial
796  * component will match notmuch_database_get_path() ).
797  *
798  * The returned string belongs to the message so should not be
799  * modified or freed by the caller (nor should it be referenced after
800  * the message is destroyed).
801  *
802  * Note: If this message corresponds to multiple files in the mail
803  * store, (that is, multiple files contain identical message IDs),
804  * this function will arbitrarily return a single one of those
805  * filenames. See notmuch_message_get_filenames for returning the
806  * complete list of filenames.
807  */
808 const char *
809 notmuch_message_get_filename (notmuch_message_t *message);
810
811 /* Get all filenames for the email corresponding to 'message'.
812  *
813  * Returns a notmuch_filenames_t iterator listing all the filenames
814  * associated with 'message'. These files may not have identical
815  * content, but each will have the identical Message-ID.
816  *
817  * Each filename in the iterator is an absolute filename, (the initial
818  * component will match notmuch_database_get_path() ).
819  */
820 notmuch_filenames_t *
821 notmuch_message_get_filenames (notmuch_message_t *message);
822
823 /* Message flags */
824 typedef enum _notmuch_message_flag {
825     NOTMUCH_MESSAGE_FLAG_MATCH
826 } notmuch_message_flag_t;
827
828 /* Get a value of a flag for the email corresponding to 'message'. */
829 notmuch_bool_t
830 notmuch_message_get_flag (notmuch_message_t *message,
831                           notmuch_message_flag_t flag);
832
833 /* Set a value of a flag for the email corresponding to 'message'. */
834 void
835 notmuch_message_set_flag (notmuch_message_t *message,
836                           notmuch_message_flag_t flag, notmuch_bool_t value);
837
838 /* Get the date of 'message' as a time_t value.
839  *
840  * For the original textual representation of the Date header from the
841  * message call notmuch_message_get_header() with a header value of
842  * "date". */
843 time_t
844 notmuch_message_get_date  (notmuch_message_t *message);
845
846 /* Get the value of the specified header from 'message'.
847  *
848  * The value will be read from the actual message file, not from the
849  * notmuch database. The header name is case insensitive.
850  *
851  * The returned string belongs to the message so should not be
852  * modified or freed by the caller (nor should it be referenced after
853  * the message is destroyed).
854  *
855  * Returns an empty string ("") if the message does not contain a
856  * header line matching 'header'. Returns NULL if any error occurs.
857  */
858 const char *
859 notmuch_message_get_header (notmuch_message_t *message, const char *header);
860
861 /* Get the tags for 'message', returning a notmuch_tags_t object which
862  * can be used to iterate over all tags.
863  *
864  * The tags object is owned by the message and as such, will only be
865  * valid for as long as the message is valid, (which is until the
866  * query from which it derived is destroyed).
867  *
868  * Typical usage might be:
869  *
870  *     notmuch_message_t *message;
871  *     notmuch_tags_t *tags;
872  *     const char *tag;
873  *
874  *     message = notmuch_database_find_message (database, message_id);
875  *
876  *     for (tags = notmuch_message_get_tags (message);
877  *          notmuch_tags_valid (tags);
878  *          notmuch_result_move_to_next (tags))
879  *     {
880  *         tag = notmuch_tags_get (tags);
881  *         ....
882  *     }
883  *
884  *     notmuch_message_destroy (message);
885  *
886  * Note that there's no explicit destructor needed for the
887  * notmuch_tags_t object. (For consistency, we do provide a
888  * notmuch_tags_destroy function, but there's no good reason to call
889  * it if the message is about to be destroyed).
890  */
891 notmuch_tags_t *
892 notmuch_message_get_tags (notmuch_message_t *message);
893
894 /* The longest possible tag value. */
895 #define NOTMUCH_TAG_MAX 200
896
897 /* Add a tag to the given message.
898  *
899  * Return value:
900  *
901  * NOTMUCH_STATUS_SUCCESS: Tag successfully added to message
902  *
903  * NOTMUCH_STATUS_NULL_POINTER: The 'tag' argument is NULL
904  *
905  * NOTMUCH_STATUS_TAG_TOO_LONG: The length of 'tag' is too long
906  *      (exceeds NOTMUCH_TAG_MAX)
907  *
908  * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
909  *      mode so message cannot be modified.
910  */
911 notmuch_status_t
912 notmuch_message_add_tag (notmuch_message_t *message, const char *tag);
913
914 /* Remove a tag from the given message.
915  *
916  * Return value:
917  *
918  * NOTMUCH_STATUS_SUCCESS: Tag successfully removed from message
919  *
920  * NOTMUCH_STATUS_NULL_POINTER: The 'tag' argument is NULL
921  *
922  * NOTMUCH_STATUS_TAG_TOO_LONG: The length of 'tag' is too long
923  *      (exceeds NOTMUCH_TAG_MAX)
924  *
925  * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
926  *      mode so message cannot be modified.
927  */
928 notmuch_status_t
929 notmuch_message_remove_tag (notmuch_message_t *message, const char *tag);
930
931 /* Remove all tags from the given message.
932  *
933  * See notmuch_message_freeze for an example showing how to safely
934  * replace tag values.
935  *
936  * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
937  *      mode so message cannot be modified.
938  */
939 notmuch_status_t
940 notmuch_message_remove_all_tags (notmuch_message_t *message);
941
942 /* Add/remove tags according to maildir flags in the message filename(s)
943  *
944  * This function examines the filenames of 'message' for maildir
945  * flags, and adds or removes tags on 'message' as follows when these
946  * flags are present:
947  *
948  *      Flag    Action if present
949  *      ----    -----------------
950  *      'D'     Adds the "draft" tag to the message
951  *      'F'     Adds the "flagged" tag to the message
952  *      'P'     Adds the "passed" tag to the message
953  *      'R'     Adds the "replied" tag to the message
954  *      'S'     Removes the "unread" tag from the message
955  *
956  * For each flag that is not present, the opposite action (add/remove)
957  * is performed for the corresponding tags.
958  *
959  * Flags are identified as trailing components of the filename after a
960  * sequence of ":2,".
961  *
962  * If there are multiple filenames associated with this message, the
963  * flag is considered present if it appears in one or more
964  * filenames. (That is, the flags from the multiple filenames are
965  * combined with the logical OR operator.)
966  *
967  * A client can ensure that notmuch database tags remain synchronized
968  * with maildir flags by calling this function after each call to
969  * notmuch_database_add_message. See also
970  * notmuch_message_tags_to_maildir_flags for synchronizing tag changes
971  * back to maildir flags.
972  */
973 notmuch_status_t
974 notmuch_message_maildir_flags_to_tags (notmuch_message_t *message);
975
976 /* Rename message filename(s) to encode tags as maildir flags
977  *
978  * Specifically, for each filename corresponding to this message:
979  *
980  * If the filename is not in a maildir directory, do nothing.  (A
981  * maildir directory is determined as a directory named "new" or
982  * "cur".) Similarly, if the filename has invalid maildir info,
983  * (repeated or outof-ASCII-order flag characters after ":2,"), then
984  * do nothing.
985  *
986  * If the filename is in a maildir directory, rename the file so that
987  * its filename ends with the sequence ":2," followed by zero or more
988  * of the following single-character flags (in ASCII order):
989  *
990  *   'D' iff the message has the "draft" tag
991  *   'F' iff the message has the "flagged" tag
992  *   'P' iff the message has the "passed" tag
993  *   'R' iff the message has the "replied" tag
994  *   'S' iff the message does not have the "unread" tag
995  *
996  * Any existing flags unmentioned in the list above will be preserved
997  * in the renaming.
998  *
999  * Also, if this filename is in a directory named "new", rename it to
1000  * be within the neighboring directory named "cur".
1001  *
1002  * A client can ensure that maildir filename flags remain synchronized
1003  * with notmuch database tags by calling this function after changing
1004  * tags, (after calls to notmuch_message_add_tag,
1005  * notmuch_message_remove_tag, or notmuch_message_freeze/
1006  * notmuch_message_thaw). See also notmuch_message_maildir_flags_to_tags
1007  * for synchronizing maildir flag changes back to tags.
1008  */
1009 notmuch_status_t
1010 notmuch_message_tags_to_maildir_flags (notmuch_message_t *message);
1011
1012 /* Freeze the current state of 'message' within the database.
1013  *
1014  * This means that changes to the message state, (via
1015  * notmuch_message_add_tag, notmuch_message_remove_tag, and
1016  * notmuch_message_remove_all_tags), will not be committed to the
1017  * database until the message is thawed with notmuch_message_thaw.
1018  *
1019  * Multiple calls to freeze/thaw are valid and these calls will
1020  * "stack". That is there must be as many calls to thaw as to freeze
1021  * before a message is actually thawed.
1022  *
1023  * The ability to do freeze/thaw allows for safe transactions to
1024  * change tag values. For example, explicitly setting a message to
1025  * have a given set of tags might look like this:
1026  *
1027  *    notmuch_message_freeze (message);
1028  *
1029  *    notmuch_message_remove_all_tags (message);
1030  *
1031  *    for (i = 0; i < NUM_TAGS; i++)
1032  *        notmuch_message_add_tag (message, tags[i]);
1033  *
1034  *    notmuch_message_thaw (message);
1035  *
1036  * With freeze/thaw used like this, the message in the database is
1037  * guaranteed to have either the full set of original tag values, or
1038  * the full set of new tag values, but nothing in between.
1039  *
1040  * Imagine the example above without freeze/thaw and the operation
1041  * somehow getting interrupted. This could result in the message being
1042  * left with no tags if the interruption happened after
1043  * notmuch_message_remove_all_tags but before notmuch_message_add_tag.
1044  *
1045  * Return value:
1046  *
1047  * NOTMUCH_STATUS_SUCCESS: Message successfully frozen.
1048  *
1049  * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
1050  *      mode so message cannot be modified.
1051  */
1052 notmuch_status_t
1053 notmuch_message_freeze (notmuch_message_t *message);
1054
1055 /* Thaw the current 'message', synchronizing any changes that may have
1056  * occurred while 'message' was frozen into the notmuch database.
1057  *
1058  * See notmuch_message_freeze for an example of how to use this
1059  * function to safely provide tag changes.
1060  *
1061  * Multiple calls to freeze/thaw are valid and these calls with
1062  * "stack". That is there must be as many calls to thaw as to freeze
1063  * before a message is actually thawed.
1064  *
1065  * Return value:
1066  *
1067  * NOTMUCH_STATUS_SUCCESS: Message successfully thawed, (or at least
1068  *      its frozen count has successfully been reduced by 1).
1069  *
1070  * NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW: An attempt was made to thaw
1071  *      an unfrozen message. That is, there have been an unbalanced
1072  *      number of calls to notmuch_message_freeze and
1073  *      notmuch_message_thaw.
1074  */
1075 notmuch_status_t
1076 notmuch_message_thaw (notmuch_message_t *message);
1077
1078 /* Destroy a notmuch_message_t object.
1079  *
1080  * It can be useful to call this function in the case of a single
1081  * query object with many messages in the result, (such as iterating
1082  * over the entire database). Otherwise, it's fine to never call this
1083  * function and there will still be no memory leaks. (The memory from
1084  * the messages get reclaimed when the containing query is destroyed.)
1085  */
1086 void
1087 notmuch_message_destroy (notmuch_message_t *message);
1088
1089 /* Is the given 'tags' iterator pointing at a valid tag.
1090  *
1091  * When this function returns TRUE, notmuch_tags_get will return a
1092  * valid string. Whereas when this function returns FALSE,
1093  * notmuch_tags_get will return NULL.
1094  *
1095  * See the documentation of notmuch_message_get_tags for example code
1096  * showing how to iterate over a notmuch_tags_t object.
1097  */
1098 notmuch_bool_t
1099 notmuch_tags_valid (notmuch_tags_t *tags);
1100
1101 /* Get the current tag from 'tags' as a string.
1102  *
1103  * Note: The returned string belongs to 'tags' and has a lifetime
1104  * identical to it (and the query to which it ultimately belongs).
1105  *
1106  * See the documentation of notmuch_message_get_tags for example code
1107  * showing how to iterate over a notmuch_tags_t object.
1108  */
1109 const char *
1110 notmuch_tags_get (notmuch_tags_t *tags);
1111
1112 /* Move the 'tags' iterator to the next tag.
1113  *
1114  * If 'tags' is already pointing at the last tag then the iterator
1115  * will be moved to a point just beyond that last tag, (where
1116  * notmuch_tags_valid will return FALSE and notmuch_tags_get will
1117  * return NULL).
1118  *
1119  * See the documentation of notmuch_message_get_tags for example code
1120  * showing how to iterate over a notmuch_tags_t object.
1121  */
1122 void
1123 notmuch_tags_move_to_next (notmuch_tags_t *tags);
1124
1125 /* Destroy a notmuch_tags_t object.
1126  *
1127  * It's not strictly necessary to call this function. All memory from
1128  * the notmuch_tags_t object will be reclaimed when the containing
1129  * message or query objects are destroyed.
1130  */
1131 void
1132 notmuch_tags_destroy (notmuch_tags_t *tags);
1133
1134 /* Store an mtime within the database for 'directory'.
1135  *
1136  * The 'directory' should be an object retrieved from the database
1137  * with notmuch_database_get_directory for a particular path.
1138  *
1139  * The intention is for the caller to use the mtime to allow efficient
1140  * identification of new messages to be added to the database. The
1141  * recommended usage is as follows:
1142  *
1143  *   o Read the mtime of a directory from the filesystem
1144  *
1145  *   o Call add_message for all mail files in the directory
1146  *
1147  *   o Call notmuch_directory_set_mtime with the mtime read from the
1148  *     filesystem.
1149  *
1150  * Then, when wanting to check for updates to the directory in the
1151  * future, the client can call notmuch_directory_get_mtime and know
1152  * that it only needs to add files if the mtime of the directory and
1153  * files are newer than the stored timestamp.
1154  *
1155  * Note: The notmuch_directory_get_mtime function does not allow the
1156  * caller to distinguish a timestamp of 0 from a non-existent
1157  * timestamp. So don't store a timestamp of 0 unless you are
1158  * comfortable with that.
1159  *
1160  * Return value:
1161  *
1162  * NOTMUCH_STATUS_SUCCESS: mtime successfully stored in database.
1163  *
1164  * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception
1165  *      occurred, mtime not stored.
1166  *
1167  * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
1168  *      mode so directory mtime cannot be modified.
1169  */
1170 notmuch_status_t
1171 notmuch_directory_set_mtime (notmuch_directory_t *directory,
1172                              time_t mtime);
1173
1174 /* Get the mtime of a directory, (as previously stored with
1175  * notmuch_directory_set_mtime).
1176  *
1177  * Returns 0 if no mtime has previously been stored for this
1178  * directory.*/
1179 time_t
1180 notmuch_directory_get_mtime (notmuch_directory_t *directory);
1181
1182 /* Get a notmuch_filenames_t iterator listing all the filenames of
1183  * messages in the database within the given directory.
1184  *
1185  * The returned filenames will be the basename-entries only (not
1186  * complete paths). */
1187 notmuch_filenames_t *
1188 notmuch_directory_get_child_files (notmuch_directory_t *directory);
1189
1190 /* Get a notmuch_filenams_t iterator listing all the filenames of
1191  * sub-directories in the database within the given directory.
1192  *
1193  * The returned filenames will be the basename-entries only (not
1194  * complete paths). */
1195 notmuch_filenames_t *
1196 notmuch_directory_get_child_directories (notmuch_directory_t *directory);
1197
1198 /* Destroy a notmuch_directory_t object. */
1199 void
1200 notmuch_directory_destroy (notmuch_directory_t *directory);
1201
1202 /* Is the given 'filenames' iterator pointing at a valid filename.
1203  *
1204  * When this function returns TRUE, notmuch_filenames_get will return
1205  * a valid string. Whereas when this function returns FALSE,
1206  * notmuch_filenames_get will return NULL.
1207  *
1208  * It is acceptable to pass NULL for 'filenames', in which case this
1209  * function will always return FALSE.
1210  */
1211 notmuch_bool_t
1212 notmuch_filenames_valid (notmuch_filenames_t *filenames);
1213
1214 /* Get the current filename from 'filenames' as a string.
1215  *
1216  * Note: The returned string belongs to 'filenames' and has a lifetime
1217  * identical to it (and the directory to which it ultimately belongs).
1218  *
1219  * It is acceptable to pass NULL for 'filenames', in which case this
1220  * function will always return NULL.
1221  */
1222 const char *
1223 notmuch_filenames_get (notmuch_filenames_t *filenames);
1224
1225 /* Move the 'filenames' iterator to the next filename.
1226  *
1227  * If 'filenames' is already pointing at the last filename then the
1228  * iterator will be moved to a point just beyond that last filename,
1229  * (where notmuch_filenames_valid will return FALSE and
1230  * notmuch_filenames_get will return NULL).
1231  *
1232  * It is acceptable to pass NULL for 'filenames', in which case this
1233  * function will do nothing.
1234  */
1235 void
1236 notmuch_filenames_move_to_next (notmuch_filenames_t *filenames);
1237
1238 /* Destroy a notmuch_filenames_t object.
1239  *
1240  * It's not strictly necessary to call this function. All memory from
1241  * the notmuch_filenames_t object will be reclaimed when the
1242  * containing directory object is destroyed.
1243  *
1244  * It is acceptable to pass NULL for 'filenames', in which case this
1245  * function will do nothing.
1246  */
1247 void
1248 notmuch_filenames_destroy (notmuch_filenames_t *filenames);
1249
1250 NOTMUCH_END_DECLS
1251
1252 #endif