Add 'notmuch count' command to show the count of matching messages
[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 /* Create a new query for 'database'.
284  *
285  * Here, 'database' should be an open database, (see
286  * notmuch_database_open and notmuch_database_create).
287  *
288  * For the query string, we'll document the syntax here more
289  * completely in the future, but it's likely to be a specialized
290  * version of the general Xapian query syntax:
291  *
292  * http://xapian.org/docs/queryparser.html
293  *
294  * As a special case, passing a length-zero string, (that is ""), will
295  * result in a query that returns all messages in the database.
296  *
297  * See notmuch_query_set_sort for controlling the order of results and
298  * notmuch_query_search to actually execute the query.
299  *
300  * User should call notmuch_query_destroy when finished with this
301  * query.
302  *
303  * Will return NULL if insufficient memory is available.
304  */
305 notmuch_query_t *
306 notmuch_query_create (notmuch_database_t *database,
307                       const char *query_string);
308
309 /* Sort values for notmuch_query_set_sort */
310 typedef enum {
311     NOTMUCH_SORT_OLDEST_FIRST,
312     NOTMUCH_SORT_NEWEST_FIRST,
313     NOTMUCH_SORT_MESSAGE_ID
314 } notmuch_sort_t;
315
316 /* Specify the sorting desired for this query. */
317 void
318 notmuch_query_set_sort (notmuch_query_t *query, notmuch_sort_t sort);
319
320 /* Execute a query for threads, returning a notmuch_threads_t object
321  * which can be used to iterate over the results. The returned threads
322  * object is owned by the query and as such, will only be valid until
323  * notmuch_query_destroy.
324  *
325  * The 'first' and 'max_threads' arguments can be used to obtain
326  * partial results from the search. For example, to get results 10 at
327  * a time, pass 'max_threads' as 10 and for 'first' pass the values 0,
328  * 10, 20, etc. As a special case, a value of -1 for 'max_threads'
329  * indicates that no limiting is to be performed. So a search with
330  * 'first' == 0 and 'max_threads' == -1 will return the complete
331  * results of the search.
332  *
333  * Typical usage might be:
334  *
335  *     notmuch_query_t *query;
336  *     notmuch_threads_t *threads;
337  *     notmuch_thread_t *thread;
338  *
339  *     query = notmuch_query_create (database, query_string);
340  *
341  *     for (threads = notmuch_query_search_threads (query);
342  *          notmuch_threads_has_more (threads);
343  *          notmuch_threads_advance (threads))
344  *     {
345  *         thread = notmuch_threads_get (threads);
346  *         ....
347  *         notmuch_thread_destroy (thread);
348  *     }
349  *
350  *     notmuch_query_destroy (query);
351  *
352  * Note: If you are finished with a thread before its containing
353  * query, you can call notmuch_thread_destroy to clean up some memory
354  * sooner (as in the above example). Otherwise, if your thread objects
355  * are long-lived, then you don't need to call notmuch_thread_destroy
356  * and all the memory will still be reclaimed when the query is
357  * destroyed.
358  *
359  * Note that there's no explicit destructor needed for the
360  * notmuch_threads_t object. (For consistency, we do provide a
361  * notmuch_threads_destroy function, but there's no good reason
362  * to call it if the query is about to be destroyed).
363  */
364 notmuch_threads_t *
365 notmuch_query_search_threads (notmuch_query_t *query,
366                               int first, int max_threads);
367
368 /* Execute a query for messages, returning a notmuch_messages_t object
369  * which can be used to iterate over the results. The returned
370  * messages object is owned by the query and as such, will only be
371  * valid until notmuch_query_destroy.
372  *
373  * The 'first' and 'max_messages' arguments can be used to obtain
374  * partial results from the search. For example, to get results 10 at
375  * a time, pass 'max_messages' as 10 and for 'first' pass the values
376  * 0, 10, 20, etc. As a special case, a value of -1 for 'max_messages'
377  * indicates that no limiting is to be performed. So a search with
378  * 'first' == 0 and 'max_messages' == -1 will return the complete
379  * results of the search.
380  *
381  * Typical usage might be:
382  *
383  *     notmuch_query_t *query;
384  *     notmuch_messages_t *messages;
385  *     notmuch_message_t *message;
386  *
387  *     query = notmuch_query_create (database, query_string);
388  *
389  *     for (messages = notmuch_query_search_messages (query);
390  *          notmuch_messages_has_more (messages);
391  *          notmuch_messages_advance (messages))
392  *     {
393  *         message = notmuch_messages_get (messages);
394  *         ....
395  *         notmuch_message_destroy (message);
396  *     }
397  *
398  *     notmuch_query_destroy (query);
399  *
400  * Note: If you are finished with a message before its containing
401  * query, you can call notmuch_message_destroy to clean up some memory
402  * sooner (as in the above example). Otherwise, if your message
403  * objects are long-lived, then you don't need to call
404  * notmuch_message_destroy and all the memory will still be reclaimed
405  * when the query is destroyed.
406  *
407  * Note that there's no explicit destructor needed for the
408  * notmuch_messages_t object. (For consistency, we do provide a
409  * notmuch_messages_destroy function, but there's no good
410  * reason to call it if the query is about to be destroyed).
411  */
412 notmuch_messages_t *
413 notmuch_query_search_messages (notmuch_query_t *query,
414                                int first, int max_messages);
415
416 /* Destroy a notmuch_query_t along with any associated resources.
417  *
418  * This will in turn destroy any notmuch_threads_t and
419  * notmuch_messages_t objects generated by this query, (and in
420  * turn any notmuch_thrad_t and notmuch_message_t objects generated
421  * from those results, etc.), if such objects haven't already been
422  * destroyed.
423  */
424 void
425 notmuch_query_destroy (notmuch_query_t *query);
426
427 /* Does the given notmuch_threads_t object contain any more
428  * results.
429  *
430  * When this function returns TRUE, notmuch_threads_get will
431  * return a valid object. Whereas when this function returns FALSE,
432  * notmuch_threads_get will return NULL.
433  *
434  * See the documentation of notmuch_query_search_threads for example
435  * code showing how to iterate over a notmuch_threads_t object.
436  */
437 notmuch_bool_t
438 notmuch_threads_has_more (notmuch_threads_t *threads);
439
440 /* Get the current thread from 'threads' as a notmuch_thread_t.
441  *
442  * Note: The returned thread belongs to 'threads' and has a lifetime
443  * identical to it (and the query to which it belongs).
444  *
445  * See the documentation of notmuch_query_search_threads for example
446  * code showing how to iterate over a notmuch_threads_t object.
447  *
448  * If an out-of-memory situation occurs, this function will return
449  * NULL.
450  */
451 notmuch_thread_t *
452 notmuch_threads_get (notmuch_threads_t *threads);
453
454 /* Advance the 'threads' iterator to the next thread.
455  *
456  * See the documentation of notmuch_query_search_threads for example
457  * code showing how to iterate over a notmuch_threads_t object.
458  */
459 void
460 notmuch_threads_advance (notmuch_threads_t *threads);
461
462 /* Destroy a notmuch_threads_t object.
463  *
464  * It's not strictly necessary to call this function. All memory from
465  * the notmuch_threads_t object will be reclaimed when the
466  * containg query object is destroyed.
467  */
468 void
469 notmuch_threads_destroy (notmuch_threads_t *threads);
470
471 /* Return an estimate of the number of messages matching a search
472  *
473  * This function performs a search and returns Xapian's best
474  * guess as to number of matching messages.
475  */
476 unsigned
477 notmuch_query_count_messages (notmuch_query_t *query);
478  
479 /* Get the thread ID of 'thread'.
480  *
481  * The returned string belongs to 'thread' and as such, should not be
482  * modified by the caller and will only be valid for as long as the
483  * thread is valid, (which is until notmuch_thread_destroy or until
484  * the query from which it derived is destroyed).
485  */
486 const char *
487 notmuch_thread_get_thread_id (notmuch_thread_t *thread);
488
489 /* Get the total number of messages in 'thread'.
490  *
491  * This count consists of all messages in the database belonging to
492  * this thread. Contrast with notmuch_thread_get_matched_messages() .
493  */
494 int
495 notmuch_thread_get_total_messages (notmuch_thread_t *thread);
496
497 /* Get a notmuch_messages_t iterator for the top-level messages in
498  * 'thread'.
499  *
500  * This iterator will not necessarily iterate over all of the messages
501  * in the thread. It will only iterate over the messages in the thread
502  * which are not replies to other messages in the thread.
503  *
504  * To iterate over all messages in the thread, the caller will need to
505  * iterate over the result of notmuch_message_get_replies for each
506  * top-level message (and do that recursively for the resulting
507  * messages, etc.).
508  */
509 notmuch_messages_t *
510 notmuch_thread_get_toplevel_messages (notmuch_thread_t *thread);
511
512 /* Get the number of messages in 'thread' that matched the search.
513  *
514  * This count includes only the messages in this thread that were
515  * matched by the search from which the thread was created. Contrast
516  * with notmuch_thread_get_total_messages() .
517  */
518 int
519 notmuch_thread_get_matched_messages (notmuch_thread_t *thread);
520
521 /* Get the authors of 'thread'
522  *
523  * The returned string is a comma-separated list of the names of the
524  * authors of mail messages in the query results that belong to this
525  * thread.
526  *
527  * The returned string belongs to 'thread' and as such, should not be
528  * modified by the caller and will only be valid for as long as the
529  * thread is valid, (which is until notmuch_thread_destroy or until
530  * the query from which it derived is destroyed).
531  */
532 const char *
533 notmuch_thread_get_authors (notmuch_thread_t *thread);
534
535 /* Get the subject of 'thread'
536  *
537  * The subject is taken from the first message (according to the query
538  * order---see notmuch_query_set_sort) in the query results that
539  * belongs to this thread.
540  *
541  * The returned string belongs to 'thread' and as such, should not be
542  * modified by the caller and will only be valid for as long as the
543  * thread is valid, (which is until notmuch_thread_destroy or until
544  * the query from which it derived is destroyed).
545  */
546 const char *
547 notmuch_thread_get_subject (notmuch_thread_t *thread);
548
549 /* Get the date of the oldest message in 'thread' as a time_t value.
550  */
551 time_t
552 notmuch_thread_get_oldest_date (notmuch_thread_t *thread);
553
554 /* Get the date of the oldest message in 'thread' as a time_t value.
555  */
556 time_t
557 notmuch_thread_get_newest_date (notmuch_thread_t *thread);
558
559 /* Get the tags for 'thread', returning a notmuch_tags_t object which
560  * can be used to iterate over all tags.
561  *
562  * Note: In the Notmuch database, tags are stored on individual
563  * messages, not on threads. So the tags returned here will be all
564  * tags of the messages which matched the search and which belong to
565  * this thread.
566  *
567  * The tags object is owned by the thread and as such, will only be
568  * valid for as long as the thread is valid, (for example, until
569  * notmuch_thread_destroy or until the query from which it derived is
570  * destroyed).
571  *
572  * Typical usage might be:
573  *
574  *     notmuch_thread_t *thread;
575  *     notmuch_tags_t *tags;
576  *     const char *tag;
577  *
578  *     thread = notmuch_threads_get (threads);
579  *
580  *     for (tags = notmuch_thread_get_tags (thread);
581  *          notmuch_tags_has_more (tags);
582  *          notmuch_result_advance (tags))
583  *     {
584  *         tag = notmuch_tags_get (tags);
585  *         ....
586  *     }
587  *
588  *     notmuch_thread_destroy (thread);
589  *
590  * Note that there's no explicit destructor needed for the
591  * notmuch_tags_t object. (For consistency, we do provide a
592  * notmuch_tags_destroy function, but there's no good reason to call
593  * it if the message is about to be destroyed).
594  */
595 notmuch_tags_t *
596 notmuch_thread_get_tags (notmuch_thread_t *thread);
597
598 /* Destroy a notmuch_thread_t object. */
599 void
600 notmuch_thread_destroy (notmuch_thread_t *thread);
601
602 /* Does the given notmuch_messages_t object contain any more
603  * messages.
604  *
605  * When this function returns TRUE, notmuch_messages_get will return a
606  * valid object. Whereas when this function returns FALSE,
607  * notmuch_messages_get will return NULL.
608  *
609  * See the documentation of notmuch_query_search_messages for example
610  * code showing how to iterate over a notmuch_messages_t object.
611  */
612 notmuch_bool_t
613 notmuch_messages_has_more (notmuch_messages_t *messages);
614
615 /* Get the current message from 'messages' as a notmuch_message_t.
616  *
617  * Note: The returned message belongs to 'messages' and has a lifetime
618  * identical to it (and the query to which it belongs).
619  *
620  * See the documentation of notmuch_query_search_messages for example
621  * code showing how to iterate over a notmuch_messages_t object.
622  *
623  * If an out-of-memory situation occurs, this function will return
624  * NULL.
625  */
626 notmuch_message_t *
627 notmuch_messages_get (notmuch_messages_t *messages);
628
629 /* Advance the 'messages' iterator to the next result.
630  *
631  * See the documentation of notmuch_query_search_messages for example
632  * code showing how to iterate over a notmuch_messages_t object.
633  */
634 void
635 notmuch_messages_advance (notmuch_messages_t *messages);
636
637 /* Destroy a notmuch_messages_t object.
638  *
639  * It's not strictly necessary to call this function. All memory from
640  * the notmuch_messages_t object will be reclaimed when the containing
641  * query object is destroyed.
642  */
643 void
644 notmuch_messages_destroy (notmuch_messages_t *messages);
645
646 /* Get the message ID of 'message'.
647  *
648  * The returned string belongs to 'message' and as such, should not be
649  * modified by the caller and will only be valid for as long as the
650  * message is valid, (which is until the query from which it derived
651  * is destroyed).
652  *
653  * This function will not return NULL since Notmuch ensures that every
654  * message has a unique message ID, (Notmuch will generate an ID for a
655  * message if the original file does not contain one).
656  */
657 const char *
658 notmuch_message_get_message_id (notmuch_message_t *message);
659
660 /* Get the thread ID of 'message'.
661  *
662  * The returned string belongs to 'message' and as such, should not be
663  * modified by the caller and will only be valid for as long as the
664  * message is valid, (for example, until the user calls
665  * notmuch_message_destroy on 'message' or until a query from which it
666  * derived is destroyed).
667  *
668  * This function will not return NULL since Notmuch ensures that every
669  * message belongs to a single thread.
670  */
671 const char *
672 notmuch_message_get_thread_id (notmuch_message_t *message);
673
674 /* Get a notmuch_messages_t iterator for all of the replies to
675  * 'message'.
676  *
677  * Note: This call only makes sense if 'message' was ultimately
678  * obtained from a notmuch_thread_t object, (such as by coming
679  * directly from the result of calling notmuch_thread_get_
680  * toplevel_messages or by any number of subsequent
681  * calls to notmuch_message_get_replies).
682  *
683  * If 'message' was obtained through some non-thread means, (such as
684  * by a call to notmuch_query_search_messages), then this function
685  * will return NULL.
686  *
687  * If there are no replies to 'message', this function will return
688  * NULL. (Note that notmuch_messages_has_more will accept that NULL
689  * value as legitimate, and simply return FALSE for it.)
690  */
691 notmuch_messages_t *
692 notmuch_message_get_replies (notmuch_message_t *message);
693
694 /* Get the filename for the email corresponding to 'message'.
695  *
696  * The returned filename is an absolute filename, (the initial
697  * component will match notmuch_database_get_path() ).
698  *
699  * The returned string belongs to the message so should not be
700  * modified or freed by the caller (nor should it be referenced after
701  * the message is destroyed). */
702 const char *
703 notmuch_message_get_filename (notmuch_message_t *message);
704
705 /* Get the date of 'message' as a time_t value.
706  *
707  * For the original textual representation of the Date header from the
708  * message call notmuch_message_get_header() with a header value of
709  * "date". */
710 time_t
711 notmuch_message_get_date  (notmuch_message_t *message);
712
713 /* Get the value of the specified header from 'message'.
714  *
715  * The value will be read from the actual message file, not from the
716  * notmuch database. The header name is case insensitive.
717  *
718  * The returned string belongs to the message so should not be
719  * modified or freed by the caller (nor should it be referenced after
720  * the message is destroyed).
721  *
722  * Returns an empty string ("") if the message does not contain a
723  * header line matching 'header'. Returns NULL if any error occurs.
724  */
725 const char *
726 notmuch_message_get_header (notmuch_message_t *message, const char *header);
727
728 /* Get the tags for 'message', returning a notmuch_tags_t object which
729  * can be used to iterate over all tags.
730  *
731  * The tags object is owned by the message and as such, will only be
732  * valid for as long as the message is valid, (which is until the
733  * query from which it derived is destroyed).
734  *
735  * Typical usage might be:
736  *
737  *     notmuch_message_t *message;
738  *     notmuch_tags_t *tags;
739  *     const char *tag;
740  *
741  *     message = notmuch_database_find_message (database, message_id);
742  *
743  *     for (tags = notmuch_message_get_tags (message);
744  *          notmuch_tags_has_more (tags);
745  *          notmuch_result_advance (tags))
746  *     {
747  *         tag = notmuch_tags_get (tags);
748  *         ....
749  *     }
750  *
751  *     notmuch_message_destroy (message);
752  *
753  * Note that there's no explicit destructor needed for the
754  * notmuch_tags_t object. (For consistency, we do provide a
755  * notmuch_tags_destroy function, but there's no good reason to call
756  * it if the message is about to be destroyed).
757  */
758 notmuch_tags_t *
759 notmuch_message_get_tags (notmuch_message_t *message);
760
761 /* The longest possible tag value. */
762 #define NOTMUCH_TAG_MAX 200
763
764 /* Add a tag to the given message.
765  *
766  * Return value:
767  *
768  * NOTMUCH_STATUS_SUCCESS: Tag successfully added to message
769  *
770  * NOTMUCH_STATUS_NULL_POINTER: The 'tag' argument is NULL
771  *
772  * NOTMUCH_STATUS_TAG_TOO_LONG: The length of 'tag' is too long
773  *      (exceeds NOTMUCH_TAG_MAX)
774  */
775 notmuch_status_t
776 notmuch_message_add_tag (notmuch_message_t *message, const char *tag);
777
778 /* Remove a tag from the given message.
779  *
780  * Return value:
781  *
782  * NOTMUCH_STATUS_SUCCESS: Tag successfully removed from message
783  *
784  * NOTMUCH_STATUS_NULL_POINTER: The 'tag' argument is NULL
785  *
786  * NOTMUCH_STATUS_TAG_TOO_LONG: The length of 'tag' is too long
787  *      (exceeds NOTMUCH_TAG_MAX)
788  */
789 notmuch_status_t
790 notmuch_message_remove_tag (notmuch_message_t *message, const char *tag);
791
792 /* Remove all tags from the given message.
793  *
794  * See notmuch_message_freeze for an example showing how to safely
795  * replace tag values.
796  */
797 void
798 notmuch_message_remove_all_tags (notmuch_message_t *message);
799
800 /* Freeze the current state of 'message' within the database.
801  *
802  * This means that changes to the message state, (via
803  * notmuch_message_add_tag, notmuch_message_remove_tag, and
804  * notmuch_message_remove_all_tags), will not be committed to the
805  * database until the message is thawed with notmuch_message_thaw.
806  *
807  * Multiple calls to freeze/thaw are valid and these calls with
808  * "stack". That is there must be as many calls to thaw as to freeze
809  * before a message is actually thawed.
810  *
811  * The ability to do freeze/thaw allows for safe transactions to
812  * change tag values. For example, explicitly setting a message to
813  * have a given set of tags might look like this:
814  *
815  *    notmuch_message_freeze (message);
816  *
817  *    notmuch_message_remove_all_tags (message);
818  *
819  *    for (i = 0; i < NUM_TAGS; i++)
820  *        notmuch_message_add_tag (message, tags[i]);
821  *
822  *    notmuch_message_thaw (message);
823  *
824  * With freeze/thaw used like this, the message in the database is
825  * guaranteed to have either the full set of original tag value, or
826  * the full set of new tag values, but nothing in between.
827  *
828  * Imagine the example above without freeze/thaw and the operation
829  * somehow getting interrupted. This could result in the message being
830  * left with no tags if the interruption happened after
831  * notmuch_message_remove_all_tags but before notmuch_message_add_tag.
832  */
833 void
834 notmuch_message_freeze (notmuch_message_t *message);
835
836 /* Thaw the current 'message', synchronizing any changes that may have
837  * occurred while 'message' was frozen into the notmuch database.
838  *
839  * See notmuch_message_freeze for an example of how to use this
840  * function to safely provide tag changes.
841  *
842  * Multiple calls to freeze/thaw are valid and these calls with
843  * "stack". That is there must be as many calls to thaw as to freeze
844  * before a message is actually thawed.
845  *
846  * Return value:
847  *
848  * NOTMUCH_STATUS_SUCCESS: Message successfully thawed, (or at least
849  *      its frozen count has successfully been reduced by 1).
850  *
851  * NOTMUCH_STATUS_UNBALANCE_FREEZE_THAW: An attempt was made to thaw
852  *      an unfrozen message. That is, there have been an unbalanced
853  *      number of calls to notmuch_message_freeze and
854  *      notmuch_message_thaw.
855  */
856 notmuch_status_t
857 notmuch_message_thaw (notmuch_message_t *message);
858
859 /* Destroy a notmuch_message_t object.
860  *
861  * It can be useful to call this function in the case of a single
862  * query object with many messages in the result, (such as iterating
863  * over the entire database). Otherwise, it's fine to never call this
864  * function and there will still be no memory leaks. (The memory from
865  * the messages get reclaimed when the containing query is destroyed.)
866  */
867 void
868 notmuch_message_destroy (notmuch_message_t *message);
869
870 /* Does the given notmuch_tags_t object contain any more tags.
871  *
872  * When this function returns TRUE, notmuch_tags_get will return a
873  * valid string. Whereas when this function returns FALSE,
874  * notmuch_tags_get will return NULL.
875  *
876  * See the documentation of notmuch_message_get_tags for example code
877  * showing how to iterate over a notmuch_tags_t object.
878  */
879 notmuch_bool_t
880 notmuch_tags_has_more (notmuch_tags_t *tags);
881
882 /* Get the current tag from 'tags' as a string.
883  *
884  * Note: The returned string belongs to 'tags' and has a lifetime
885  * identical to it (and the query to which it ultimately belongs).
886  *
887  * See the documentation of notmuch_message_get_tags for example code
888  * showing how to iterate over a notmuch_tags_t object.
889  */
890 const char *
891 notmuch_tags_get (notmuch_tags_t *tags);
892
893 /* Advance the 'tags' iterator to the next tag.
894  *
895  * See the documentation of notmuch_message_get_tags for example code
896  * showing how to iterate over a notmuch_tags_t object.
897  */
898 void
899 notmuch_tags_advance (notmuch_tags_t *tags);
900
901 /* Destroy a notmuch_tags_t object.
902  *
903  * It's not strictly necessary to call this function. All memory from
904  * the notmuch_tags_t object will be reclaimed when the containing
905  * message or query objects are destroyed.
906  */
907 void
908 notmuch_tags_destroy (notmuch_tags_t *tags);
909
910 NOTMUCH_END_DECLS
911
912 #endif