Merge remote branch 'origin/master' into vim
[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_XAPIAN_EXCEPTION: A Xapian exception occurred
61  *
62  * NOTMUCH_STATUS_FILE_ERROR: An error occurred trying to read or
63  *      write to a file (this could be file not found, permission
64  *      denied, etc.)
65  *
66  * NOTMUCH_STATUS_FILE_NOT_EMAIL: A file was presented that doesn't
67  *      appear to be an email message.
68  *
69  * NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID: A file contains a message ID
70  *      that is identical to a message already in the database.
71  *
72  * NOTMUCH_STATUS_NULL_POINTER: The user erroneously passed a NULL
73  *      pointer to a notmuch function.
74  *
75  * NOTMUCH_STATUS_TAG_TOO_LONG: A tag value is too long (exceeds
76  *      NOTMUCH_TAG_MAX)
77  *
78  * NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW: The notmuch_message_thaw
79  *      function has been called more times than notmuch_message_freeze.
80  *
81  * And finally:
82  *
83  * NOTMUCH_STATUS_LAST_STATUS: Not an actual status value. Just a way
84  *      to find out how many valid status values there are.
85  */
86 typedef enum _notmuch_status {
87     NOTMUCH_STATUS_SUCCESS = 0,
88     NOTMUCH_STATUS_OUT_OF_MEMORY,
89     NOTMUCH_STATUS_READONLY_DATABASE,
90     NOTMUCH_STATUS_XAPIAN_EXCEPTION,
91     NOTMUCH_STATUS_FILE_ERROR,
92     NOTMUCH_STATUS_FILE_NOT_EMAIL,
93     NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID,
94     NOTMUCH_STATUS_NULL_POINTER,
95     NOTMUCH_STATUS_TAG_TOO_LONG,
96     NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW,
97
98     NOTMUCH_STATUS_LAST_STATUS
99 } notmuch_status_t;
100
101 /* Get a string representation of a notmuch_status_t value.
102  *
103  * The result is readonly.
104  */
105 const char *
106 notmuch_status_to_string (notmuch_status_t status);
107
108 /* Various opaque data types. For each notmuch_<foo>_t see the various
109  * notmuch_<foo> functions below. */
110 typedef struct _notmuch_database notmuch_database_t;
111 typedef struct _notmuch_query notmuch_query_t;
112 typedef struct _notmuch_threads notmuch_threads_t;
113 typedef struct _notmuch_thread notmuch_thread_t;
114 typedef struct _notmuch_messages notmuch_messages_t;
115 typedef struct _notmuch_message notmuch_message_t;
116 typedef struct _notmuch_tags notmuch_tags_t;
117
118 /* Create a new, empty notmuch database located at 'path'.
119  *
120  * The path should be a top-level directory to a collection of
121  * plain-text email messages (one message per file). This call will
122  * create a new ".notmuch" directory within 'path' where notmuch will
123  * store its data.
124  *
125  * After a successful call to notmuch_database_create, the returned
126  * database will be open so the caller should call
127  * notmuch_database_close when finished with it.
128  *
129  * The database will not yet have any data in it
130  * (notmuch_database_create itself is a very cheap function). Messages
131  * contained within 'path' can be added to the database by calling
132  * notmuch_database_add_message.
133  *
134  * In case of any failure, this function returns NULL, (after printing
135  * an error message on stderr).
136  */
137 notmuch_database_t *
138 notmuch_database_create (const char *path);
139
140 typedef enum {
141     NOTMUCH_DATABASE_MODE_READ_ONLY = 0,
142     NOTMUCH_DATABASE_MODE_READ_WRITE
143 } notmuch_database_mode_t;
144
145 /* XXX: I think I'd like this to take an extra argument of
146  * notmuch_status_t* for returning a status value on failure. */
147
148 /* Open an existing notmuch database located at 'path'.
149  *
150  * The database should have been created at some time in the past,
151  * (not necessarily by this process), by calling
152  * notmuch_database_create with 'path'. By default the database should be
153  * opened for reading only. In order to write to the database you need to
154  * pass the NOTMUCH_DATABASE_MODE_WRITABLE mode.
155  *
156  * An existing notmuch database can be identified by the presence of a
157  * directory named ".notmuch" below 'path'.
158  *
159  * The caller should call notmuch_database_close when finished with
160  * this database.
161  *
162  * In case of any failure, this function returns NULL, (after printing
163  * an error message on stderr).
164  */
165 notmuch_database_t *
166 notmuch_database_open (const char *path,
167                        notmuch_database_mode_t mode);
168
169 /* Close the given notmuch database, freeing all associated
170  * resources. See notmuch_database_open. */
171 void
172 notmuch_database_close (notmuch_database_t *database);
173
174 /* Return the database path of the given database.
175  *
176  * The return value is a string owned by notmuch so should not be
177  * modified nor freed by the caller. */
178 const char *
179 notmuch_database_get_path (notmuch_database_t *database);
180
181 /* Store a timestamp within the database.
182  *
183  * The Notmuch database will not interpret this key nor the timestamp
184  * values at all. It will merely store them together and return the
185  * timestamp when notmuch_database_get_timestamp is called with the
186  * same value for 'key'.
187  *
188  * The intention is for the caller to use the timestamp to allow
189  * efficient identification of new messages to be added to the
190  * database. The recommended usage is as follows:
191  *
192  *   o Read the mtime of a directory from the filesystem
193  *
194  *   o Call add_message for all mail files in the directory
195  *
196  *   o Call notmuch_database_set_timestamp with the path of the
197  *     directory as 'key' and the originally read mtime as 'value'.
198  *
199  * Then, when wanting to check for updates to the directory in the
200  * future, the client can call notmuch_database_get_timestamp and know
201  * that it only needs to add files if the mtime of the directory and
202  * files are newer than the stored timestamp.
203  *
204  * Note: The notmuch_database_get_timestamp function does not allow
205  * the caller to distinguish a timestamp of 0 from a non-existent
206  * timestamp. So don't store a timestamp of 0 unless you are
207  * comfortable with that.
208  *
209  * Return value:
210  *
211  * NOTMUCH_STATUS_SUCCESS: Timestamp successfully stored in database.
212  *
213  * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception
214  *      occurred. Timestamp not stored.
215  */
216 notmuch_status_t
217 notmuch_database_set_timestamp (notmuch_database_t *database,
218                                 const char *key, time_t timestamp);
219
220 /* Retrieve a timestamp from the database.
221  *
222  * Returns the timestamp value previously stored by calling
223  * notmuch_database_set_timestamp with the same value for 'key'.
224  *
225  * Returns 0 if no timestamp is stored for 'key' or if any error
226  * occurred querying the database.
227  */
228 time_t
229 notmuch_database_get_timestamp (notmuch_database_t *database,
230                                 const char *key);
231
232 /* Add a new message to the given notmuch database.
233  *
234  * Here,'filename' should be a path relative to the path of
235  * 'database' (see notmuch_database_get_path), or else should be an
236  * absolute filename with initial components that match the path of
237  * 'database'.
238  *
239  * The file should be a single mail message (not a multi-message mbox)
240  * that is expected to remain at its current location, (since the
241  * notmuch database will reference the filename, and will not copy the
242  * entire contents of the file.
243  *
244  * If 'message' is not NULL, then, on successful return '*message'
245  * will be initialized to a message object that can be used for things
246  * such as adding tags to the just-added message. The user should call
247  * notmuch_message_destroy when done with the message. On any failure
248  * '*message' will be set to NULL.
249  *
250  * Return value:
251  *
252  * NOTMUCH_STATUS_SUCCESS: Message successfully added to database.
253  *
254  * NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID: Message has the same message
255  *      ID as another message already in the database. Nothing added
256  *      to the database.
257  *
258  * NOTMUCH_STATUS_FILE_ERROR: an error occurred trying to open the
259  *      file, (such as permission denied, or file not found,
260  *      etc.). Nothing added to the database.
261  *
262  * NOTMUCH_STATUS_FILE_NOT_EMAIL: the contents of filename don't look
263  *      like an email message. Nothing added to the database.
264  */
265 notmuch_status_t
266 notmuch_database_add_message (notmuch_database_t *database,
267                               const char *filename,
268                               notmuch_message_t **message);
269
270 /* Find a message with the given message_id.
271  *
272  * If the database contains a message with the given message_id, then
273  * a new notmuch_message_t object is returned. The caller should call
274  * notmuch_message_destroy when done with the message.
275  *
276  * If no message is found with the given message_id or if an
277  * out-of-memory situation occurs, this function returns NULL.
278  */
279 notmuch_message_t *
280 notmuch_database_find_message (notmuch_database_t *database,
281                                const char *message_id);
282
283 /* Return a list of all tags found in the database.
284  *
285  * This function creates a list of all tags found in the database. The
286  * resulting list contains all tags from all messages found in the database.
287  *
288  * On error this function returns NULL.
289  */
290 notmuch_tags_t *
291 notmuch_database_get_all_tags (notmuch_database_t *db);
292
293 /* Create a new query for 'database'.
294  *
295  * Here, 'database' should be an open database, (see
296  * notmuch_database_open and notmuch_database_create).
297  *
298  * For the query string, we'll document the syntax here more
299  * completely in the future, but it's likely to be a specialized
300  * version of the general Xapian query syntax:
301  *
302  * http://xapian.org/docs/queryparser.html
303  *
304  * As a special case, passing a length-zero string, (that is ""), will
305  * result in a query that returns all messages in the database.
306  *
307  * See notmuch_query_set_sort for controlling the order of results and
308  * notmuch_query_search to actually execute the query.
309  *
310  * User should call notmuch_query_destroy when finished with this
311  * query.
312  *
313  * Will return NULL if insufficient memory is available.
314  */
315 notmuch_query_t *
316 notmuch_query_create (notmuch_database_t *database,
317                       const char *query_string);
318
319 /* Sort values for notmuch_query_set_sort */
320 typedef enum {
321     NOTMUCH_SORT_OLDEST_FIRST,
322     NOTMUCH_SORT_NEWEST_FIRST,
323     NOTMUCH_SORT_MESSAGE_ID
324 } notmuch_sort_t;
325
326 /* Specify the sorting desired for this query. */
327 void
328 notmuch_query_set_sort (notmuch_query_t *query, notmuch_sort_t sort);
329
330 /* Execute a query for threads, returning a notmuch_threads_t object
331  * which can be used to iterate over the results. The returned threads
332  * object is owned by the query and as such, will only be valid until
333  * notmuch_query_destroy.
334  *
335  * Typical usage might be:
336  *
337  *     notmuch_query_t *query;
338  *     notmuch_threads_t *threads;
339  *     notmuch_thread_t *thread;
340  *
341  *     query = notmuch_query_create (database, query_string);
342  *
343  *     for (threads = notmuch_query_search_threads (query);
344  *          notmuch_threads_has_more (threads);
345  *          notmuch_threads_advance (threads))
346  *     {
347  *         thread = notmuch_threads_get (threads);
348  *         ....
349  *         notmuch_thread_destroy (thread);
350  *     }
351  *
352  *     notmuch_query_destroy (query);
353  *
354  * Note: If you are finished with a thread before its containing
355  * query, you can call notmuch_thread_destroy to clean up some memory
356  * sooner (as in the above example). Otherwise, if your thread objects
357  * are long-lived, then you don't need to call notmuch_thread_destroy
358  * and all the memory will still be reclaimed when the query is
359  * destroyed.
360  *
361  * Note that there's no explicit destructor needed for the
362  * notmuch_threads_t object. (For consistency, we do provide a
363  * notmuch_threads_destroy function, but there's no good reason
364  * to call it if the query is about to be destroyed).
365  */
366 notmuch_threads_t *
367 notmuch_query_search_threads (notmuch_query_t *query);
368
369 /* Execute a query for messages, returning a notmuch_messages_t object
370  * which can be used to iterate over the results. The returned
371  * messages object is owned by the query and as such, will only be
372  * valid until notmuch_query_destroy.
373  *
374  * Typical usage might be:
375  *
376  *     notmuch_query_t *query;
377  *     notmuch_messages_t *messages;
378  *     notmuch_message_t *message;
379  *
380  *     query = notmuch_query_create (database, query_string);
381  *
382  *     for (messages = notmuch_query_search_messages (query);
383  *          notmuch_messages_has_more (messages);
384  *          notmuch_messages_advance (messages))
385  *     {
386  *         message = notmuch_messages_get (messages);
387  *         ....
388  *         notmuch_message_destroy (message);
389  *     }
390  *
391  *     notmuch_query_destroy (query);
392  *
393  * Note: If you are finished with a message before its containing
394  * query, you can call notmuch_message_destroy to clean up some memory
395  * sooner (as in the above example). Otherwise, if your message
396  * objects are long-lived, then you don't need to call
397  * notmuch_message_destroy and all the memory will still be reclaimed
398  * when the query is destroyed.
399  *
400  * Note that there's no explicit destructor needed for the
401  * notmuch_messages_t object. (For consistency, we do provide a
402  * notmuch_messages_destroy function, but there's no good
403  * reason to call it if the query is about to be destroyed).
404  */
405 notmuch_messages_t *
406 notmuch_query_search_messages (notmuch_query_t *query);
407
408 /* Destroy a notmuch_query_t along with any associated resources.
409  *
410  * This will in turn destroy any notmuch_threads_t and
411  * notmuch_messages_t objects generated by this query, (and in
412  * turn any notmuch_thrad_t and notmuch_message_t objects generated
413  * from those results, etc.), if such objects haven't already been
414  * destroyed.
415  */
416 void
417 notmuch_query_destroy (notmuch_query_t *query);
418
419 /* Does the given notmuch_threads_t object contain any more
420  * results.
421  *
422  * When this function returns TRUE, notmuch_threads_get will
423  * return a valid object. Whereas when this function returns FALSE,
424  * notmuch_threads_get will return NULL.
425  *
426  * See the documentation of notmuch_query_search_threads for example
427  * code showing how to iterate over a notmuch_threads_t object.
428  */
429 notmuch_bool_t
430 notmuch_threads_has_more (notmuch_threads_t *threads);
431
432 /* Get the current thread from 'threads' as a notmuch_thread_t.
433  *
434  * Note: The returned thread belongs to 'threads' and has a lifetime
435  * identical to it (and the query to which it belongs).
436  *
437  * See the documentation of notmuch_query_search_threads for example
438  * code showing how to iterate over a notmuch_threads_t object.
439  *
440  * If an out-of-memory situation occurs, this function will return
441  * NULL.
442  */
443 notmuch_thread_t *
444 notmuch_threads_get (notmuch_threads_t *threads);
445
446 /* Advance the 'threads' iterator to the next thread.
447  *
448  * See the documentation of notmuch_query_search_threads for example
449  * code showing how to iterate over a notmuch_threads_t object.
450  */
451 void
452 notmuch_threads_advance (notmuch_threads_t *threads);
453
454 /* Destroy a notmuch_threads_t object.
455  *
456  * It's not strictly necessary to call this function. All memory from
457  * the notmuch_threads_t object will be reclaimed when the
458  * containg query object is destroyed.
459  */
460 void
461 notmuch_threads_destroy (notmuch_threads_t *threads);
462
463 /* Return an estimate of the number of messages matching a search
464  *
465  * This function performs a search and returns Xapian's best
466  * guess as to number of matching messages.
467  */
468 unsigned
469 notmuch_query_count_messages (notmuch_query_t *query);
470  
471 /* Get the thread ID of 'thread'.
472  *
473  * The returned string belongs to 'thread' and as such, should not be
474  * modified by the caller and will only be valid for as long as the
475  * thread is valid, (which is until notmuch_thread_destroy or until
476  * the query from which it derived is destroyed).
477  */
478 const char *
479 notmuch_thread_get_thread_id (notmuch_thread_t *thread);
480
481 /* Get the total number of messages in 'thread'.
482  *
483  * This count consists of all messages in the database belonging to
484  * this thread. Contrast with notmuch_thread_get_matched_messages() .
485  */
486 int
487 notmuch_thread_get_total_messages (notmuch_thread_t *thread);
488
489 /* Get a notmuch_messages_t iterator for the top-level messages in
490  * 'thread'.
491  *
492  * This iterator will not necessarily iterate over all of the messages
493  * in the thread. It will only iterate over the messages in the thread
494  * which are not replies to other messages in the thread.
495  *
496  * To iterate over all messages in the thread, the caller will need to
497  * iterate over the result of notmuch_message_get_replies for each
498  * top-level message (and do that recursively for the resulting
499  * messages, etc.).
500  */
501 notmuch_messages_t *
502 notmuch_thread_get_toplevel_messages (notmuch_thread_t *thread);
503
504 /* Get the number of messages in 'thread' that matched the search.
505  *
506  * This count includes only the messages in this thread that were
507  * matched by the search from which the thread was created. Contrast
508  * with notmuch_thread_get_total_messages() .
509  */
510 int
511 notmuch_thread_get_matched_messages (notmuch_thread_t *thread);
512
513 /* Get the authors of 'thread'
514  *
515  * The returned string is a comma-separated list of the names of the
516  * authors of mail messages in the query results that belong to this
517  * thread.
518  *
519  * The returned string belongs to 'thread' and as such, should not be
520  * modified by the caller and will only be valid for as long as the
521  * thread is valid, (which is until notmuch_thread_destroy or until
522  * the query from which it derived is destroyed).
523  */
524 const char *
525 notmuch_thread_get_authors (notmuch_thread_t *thread);
526
527 /* Get the subject of 'thread'
528  *
529  * The subject is taken from the first message (according to the query
530  * order---see notmuch_query_set_sort) in the query results that
531  * belongs to this thread.
532  *
533  * The returned string belongs to 'thread' and as such, should not be
534  * modified by the caller and will only be valid for as long as the
535  * thread is valid, (which is until notmuch_thread_destroy or until
536  * the query from which it derived is destroyed).
537  */
538 const char *
539 notmuch_thread_get_subject (notmuch_thread_t *thread);
540
541 /* Get the date of the oldest message in 'thread' as a time_t value.
542  */
543 time_t
544 notmuch_thread_get_oldest_date (notmuch_thread_t *thread);
545
546 /* Get the date of the oldest message in 'thread' as a time_t value.
547  */
548 time_t
549 notmuch_thread_get_newest_date (notmuch_thread_t *thread);
550
551 /* Get the tags for 'thread', returning a notmuch_tags_t object which
552  * can be used to iterate over all tags.
553  *
554  * Note: In the Notmuch database, tags are stored on individual
555  * messages, not on threads. So the tags returned here will be all
556  * tags of the messages which matched the search and which belong to
557  * this thread.
558  *
559  * The tags object is owned by the thread and as such, will only be
560  * valid for as long as the thread is valid, (for example, until
561  * notmuch_thread_destroy or until the query from which it derived is
562  * destroyed).
563  *
564  * Typical usage might be:
565  *
566  *     notmuch_thread_t *thread;
567  *     notmuch_tags_t *tags;
568  *     const char *tag;
569  *
570  *     thread = notmuch_threads_get (threads);
571  *
572  *     for (tags = notmuch_thread_get_tags (thread);
573  *          notmuch_tags_has_more (tags);
574  *          notmuch_result_advance (tags))
575  *     {
576  *         tag = notmuch_tags_get (tags);
577  *         ....
578  *     }
579  *
580  *     notmuch_thread_destroy (thread);
581  *
582  * Note that there's no explicit destructor needed for the
583  * notmuch_tags_t object. (For consistency, we do provide a
584  * notmuch_tags_destroy function, but there's no good reason to call
585  * it if the message is about to be destroyed).
586  */
587 notmuch_tags_t *
588 notmuch_thread_get_tags (notmuch_thread_t *thread);
589
590 /* Destroy a notmuch_thread_t object. */
591 void
592 notmuch_thread_destroy (notmuch_thread_t *thread);
593
594 /* Does the given notmuch_messages_t object contain any more
595  * messages.
596  *
597  * When this function returns TRUE, notmuch_messages_get will return a
598  * valid object. Whereas when this function returns FALSE,
599  * notmuch_messages_get will return NULL.
600  *
601  * See the documentation of notmuch_query_search_messages for example
602  * code showing how to iterate over a notmuch_messages_t object.
603  */
604 notmuch_bool_t
605 notmuch_messages_has_more (notmuch_messages_t *messages);
606
607 /* Get the current message from 'messages' as a notmuch_message_t.
608  *
609  * Note: The returned message belongs to 'messages' and has a lifetime
610  * identical to it (and the query to which it belongs).
611  *
612  * See the documentation of notmuch_query_search_messages for example
613  * code showing how to iterate over a notmuch_messages_t object.
614  *
615  * If an out-of-memory situation occurs, this function will return
616  * NULL.
617  */
618 notmuch_message_t *
619 notmuch_messages_get (notmuch_messages_t *messages);
620
621 /* Advance the 'messages' iterator to the next result.
622  *
623  * See the documentation of notmuch_query_search_messages for example
624  * code showing how to iterate over a notmuch_messages_t object.
625  */
626 void
627 notmuch_messages_advance (notmuch_messages_t *messages);
628
629 /* Destroy a notmuch_messages_t object.
630  *
631  * It's not strictly necessary to call this function. All memory from
632  * the notmuch_messages_t object will be reclaimed when the containing
633  * query object is destroyed.
634  */
635 void
636 notmuch_messages_destroy (notmuch_messages_t *messages);
637
638 /* Return a list of tags from all messages.
639  *
640  * The resulting list is guaranteed not to contain duplicated tags.
641  *
642  * WARNING: You can no longer iterate over messages after calling this
643  * function, because the iterator will point at the end of the list.
644  * We do not have a function to reset the iterator yet and the only
645  * way how you can iterate over the list again is to recreate the
646  * message list.
647  *
648  * The function returns NULL on error.
649  */
650 notmuch_tags_t *
651 notmuch_messages_collect_tags (notmuch_messages_t *messages);
652
653 /* Get the message ID of 'message'.
654  *
655  * The returned string belongs to 'message' and as such, should not be
656  * modified by the caller and will only be valid for as long as the
657  * message is valid, (which is until the query from which it derived
658  * is destroyed).
659  *
660  * This function will not return NULL since Notmuch ensures that every
661  * message has a unique message ID, (Notmuch will generate an ID for a
662  * message if the original file does not contain one).
663  */
664 const char *
665 notmuch_message_get_message_id (notmuch_message_t *message);
666
667 /* Get the thread ID of 'message'.
668  *
669  * The returned string belongs to 'message' and as such, should not be
670  * modified by the caller and will only be valid for as long as the
671  * message is valid, (for example, until the user calls
672  * notmuch_message_destroy on 'message' or until a query from which it
673  * derived is destroyed).
674  *
675  * This function will not return NULL since Notmuch ensures that every
676  * message belongs to a single thread.
677  */
678 const char *
679 notmuch_message_get_thread_id (notmuch_message_t *message);
680
681 /* Get a notmuch_messages_t iterator for all of the replies to
682  * 'message'.
683  *
684  * Note: This call only makes sense if 'message' was ultimately
685  * obtained from a notmuch_thread_t object, (such as by coming
686  * directly from the result of calling notmuch_thread_get_
687  * toplevel_messages or by any number of subsequent
688  * calls to notmuch_message_get_replies).
689  *
690  * If 'message' was obtained through some non-thread means, (such as
691  * by a call to notmuch_query_search_messages), then this function
692  * will return NULL.
693  *
694  * If there are no replies to 'message', this function will return
695  * NULL. (Note that notmuch_messages_has_more will accept that NULL
696  * value as legitimate, and simply return FALSE for it.)
697  */
698 notmuch_messages_t *
699 notmuch_message_get_replies (notmuch_message_t *message);
700
701 /* Get the filename for the email corresponding to 'message'.
702  *
703  * The returned filename is an absolute filename, (the initial
704  * component will match notmuch_database_get_path() ).
705  *
706  * The returned string belongs to the message so should not be
707  * modified or freed by the caller (nor should it be referenced after
708  * the message is destroyed). */
709 const char *
710 notmuch_message_get_filename (notmuch_message_t *message);
711
712 /* Message flags */
713 typedef enum _notmuch_message_flag {
714     NOTMUCH_MSG_FLAG_MATCHING_SEARCH,
715 } notmuch_message_flag_t;
716
717 /* Get a value of a flag for the email corresponding to 'message'. */
718 notmuch_bool_t
719 notmuch_message_get_flag (notmuch_message_t *message,
720                           notmuch_message_flag_t flag);
721
722 /* Set a value of a flag for the email corresponding to 'message'. */
723 void
724 notmuch_message_set_flag (notmuch_message_t *message,
725                           notmuch_message_flag_t flag, notmuch_bool_t value);
726
727 /* Get the date of 'message' as a time_t value.
728  *
729  * For the original textual representation of the Date header from the
730  * message call notmuch_message_get_header() with a header value of
731  * "date". */
732 time_t
733 notmuch_message_get_date  (notmuch_message_t *message);
734
735 /* Get the value of the specified header from 'message'.
736  *
737  * The value will be read from the actual message file, not from the
738  * notmuch database. The header name is case insensitive.
739  *
740  * The returned string belongs to the message so should not be
741  * modified or freed by the caller (nor should it be referenced after
742  * the message is destroyed).
743  *
744  * Returns an empty string ("") if the message does not contain a
745  * header line matching 'header'. Returns NULL if any error occurs.
746  */
747 const char *
748 notmuch_message_get_header (notmuch_message_t *message, const char *header);
749
750 /* Get the tags for 'message', returning a notmuch_tags_t object which
751  * can be used to iterate over all tags.
752  *
753  * The tags object is owned by the message and as such, will only be
754  * valid for as long as the message is valid, (which is until the
755  * query from which it derived is destroyed).
756  *
757  * Typical usage might be:
758  *
759  *     notmuch_message_t *message;
760  *     notmuch_tags_t *tags;
761  *     const char *tag;
762  *
763  *     message = notmuch_database_find_message (database, message_id);
764  *
765  *     for (tags = notmuch_message_get_tags (message);
766  *          notmuch_tags_has_more (tags);
767  *          notmuch_result_advance (tags))
768  *     {
769  *         tag = notmuch_tags_get (tags);
770  *         ....
771  *     }
772  *
773  *     notmuch_message_destroy (message);
774  *
775  * Note that there's no explicit destructor needed for the
776  * notmuch_tags_t object. (For consistency, we do provide a
777  * notmuch_tags_destroy function, but there's no good reason to call
778  * it if the message is about to be destroyed).
779  */
780 notmuch_tags_t *
781 notmuch_message_get_tags (notmuch_message_t *message);
782
783 /* The longest possible tag value. */
784 #define NOTMUCH_TAG_MAX 200
785
786 /* Add a tag to the given message.
787  *
788  * Return value:
789  *
790  * NOTMUCH_STATUS_SUCCESS: Tag successfully added to message
791  *
792  * NOTMUCH_STATUS_NULL_POINTER: The 'tag' argument is NULL
793  *
794  * NOTMUCH_STATUS_TAG_TOO_LONG: The length of 'tag' is too long
795  *      (exceeds NOTMUCH_TAG_MAX)
796  */
797 notmuch_status_t
798 notmuch_message_add_tag (notmuch_message_t *message, const char *tag);
799
800 /* Remove a tag from the given message.
801  *
802  * Return value:
803  *
804  * NOTMUCH_STATUS_SUCCESS: Tag successfully removed from message
805  *
806  * NOTMUCH_STATUS_NULL_POINTER: The 'tag' argument is NULL
807  *
808  * NOTMUCH_STATUS_TAG_TOO_LONG: The length of 'tag' is too long
809  *      (exceeds NOTMUCH_TAG_MAX)
810  */
811 notmuch_status_t
812 notmuch_message_remove_tag (notmuch_message_t *message, const char *tag);
813
814 /* Remove all tags from the given message.
815  *
816  * See notmuch_message_freeze for an example showing how to safely
817  * replace tag values.
818  */
819 void
820 notmuch_message_remove_all_tags (notmuch_message_t *message);
821
822 /* Freeze the current state of 'message' within the database.
823  *
824  * This means that changes to the message state, (via
825  * notmuch_message_add_tag, notmuch_message_remove_tag, and
826  * notmuch_message_remove_all_tags), will not be committed to the
827  * database until the message is thawed with notmuch_message_thaw.
828  *
829  * Multiple calls to freeze/thaw are valid and these calls with
830  * "stack". That is there must be as many calls to thaw as to freeze
831  * before a message is actually thawed.
832  *
833  * The ability to do freeze/thaw allows for safe transactions to
834  * change tag values. For example, explicitly setting a message to
835  * have a given set of tags might look like this:
836  *
837  *    notmuch_message_freeze (message);
838  *
839  *    notmuch_message_remove_all_tags (message);
840  *
841  *    for (i = 0; i < NUM_TAGS; i++)
842  *        notmuch_message_add_tag (message, tags[i]);
843  *
844  *    notmuch_message_thaw (message);
845  *
846  * With freeze/thaw used like this, the message in the database is
847  * guaranteed to have either the full set of original tag value, or
848  * the full set of new tag values, but nothing in between.
849  *
850  * Imagine the example above without freeze/thaw and the operation
851  * somehow getting interrupted. This could result in the message being
852  * left with no tags if the interruption happened after
853  * notmuch_message_remove_all_tags but before notmuch_message_add_tag.
854  */
855 void
856 notmuch_message_freeze (notmuch_message_t *message);
857
858 /* Thaw the current 'message', synchronizing any changes that may have
859  * occurred while 'message' was frozen into the notmuch database.
860  *
861  * See notmuch_message_freeze for an example of how to use this
862  * function to safely provide tag changes.
863  *
864  * Multiple calls to freeze/thaw are valid and these calls with
865  * "stack". That is there must be as many calls to thaw as to freeze
866  * before a message is actually thawed.
867  *
868  * Return value:
869  *
870  * NOTMUCH_STATUS_SUCCESS: Message successfully thawed, (or at least
871  *      its frozen count has successfully been reduced by 1).
872  *
873  * NOTMUCH_STATUS_UNBALANCE_FREEZE_THAW: An attempt was made to thaw
874  *      an unfrozen message. That is, there have been an unbalanced
875  *      number of calls to notmuch_message_freeze and
876  *      notmuch_message_thaw.
877  */
878 notmuch_status_t
879 notmuch_message_thaw (notmuch_message_t *message);
880
881 /* Destroy a notmuch_message_t object.
882  *
883  * It can be useful to call this function in the case of a single
884  * query object with many messages in the result, (such as iterating
885  * over the entire database). Otherwise, it's fine to never call this
886  * function and there will still be no memory leaks. (The memory from
887  * the messages get reclaimed when the containing query is destroyed.)
888  */
889 void
890 notmuch_message_destroy (notmuch_message_t *message);
891
892 /* Does the given notmuch_tags_t object contain any more tags.
893  *
894  * When this function returns TRUE, notmuch_tags_get will return a
895  * valid string. Whereas when this function returns FALSE,
896  * notmuch_tags_get will return NULL.
897  *
898  * See the documentation of notmuch_message_get_tags for example code
899  * showing how to iterate over a notmuch_tags_t object.
900  */
901 notmuch_bool_t
902 notmuch_tags_has_more (notmuch_tags_t *tags);
903
904 /* Get the current tag from 'tags' as a string.
905  *
906  * Note: The returned string belongs to 'tags' and has a lifetime
907  * identical to it (and the query to which it ultimately belongs).
908  *
909  * See the documentation of notmuch_message_get_tags for example code
910  * showing how to iterate over a notmuch_tags_t object.
911  */
912 const char *
913 notmuch_tags_get (notmuch_tags_t *tags);
914
915 /* Advance the 'tags' iterator to the next tag.
916  *
917  * See the documentation of notmuch_message_get_tags for example code
918  * showing how to iterate over a notmuch_tags_t object.
919  */
920 void
921 notmuch_tags_advance (notmuch_tags_t *tags);
922
923 /* Destroy a notmuch_tags_t object.
924  *
925  * It's not strictly necessary to call this function. All memory from
926  * the notmuch_tags_t object will be reclaimed when the containing
927  * message or query objects are destroyed.
928  */
929 void
930 notmuch_tags_destroy (notmuch_tags_t *tags);
931
932 NOTMUCH_END_DECLS
933
934 #endif