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