c1c7980aa06fe898e4a9697f9c8542b59b0d715d
[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  * Typical usage might be:
317  *
318  *     notmuch_query_t *query;
319  *     notmuch_threads_t *threads;
320  *     notmuch_thread_t *thread;
321  *
322  *     query = notmuch_query_create (database, query_string);
323  *
324  *     for (threads = notmuch_query_search_threads (query);
325  *          notmuch_threads_has_more (threads);
326  *          notmuch_threads_advance (threads))
327  *     {
328  *         thread = notmuch_threads_get (threads);
329  *         ....
330  *         notmuch_thread_destroy (thread);
331  *     }
332  *
333  *     notmuch_query_destroy (query);
334  *
335  * Note: If you are finished with a thread before its containing
336  * query, you can call notmuch_thread_destroy to clean up some memory
337  * sooner (as in the above example). Otherwise, if your thread objects
338  * are long-lived, then you don't need to call notmuch_thread_destroy
339  * and all the memory will still be reclaimed when the query is
340  * destroyed.
341  *
342  * Note that there's no explicit destructor needed for the
343  * notmuch_threads_t object. (For consistency, we do provide a
344  * notmuch_threads_destroy function, but there's no good reason
345  * to call it if the query is about to be destroyed).
346  */
347 notmuch_threads_t *
348 notmuch_query_search_threads (notmuch_query_t *query);
349
350 /* Execute a query for messages, returning a notmuch_messages_t object
351  * which can be used to iterate over the results. The returned
352  * messages object is owned by the query and as such, will only be
353  * valid until notmuch_query_destroy.
354  *
355  * Typical usage might be:
356  *
357  *     notmuch_query_t *query;
358  *     notmuch_messages_t *messages;
359  *     notmuch_message_t *message;
360  *
361  *     query = notmuch_query_create (database, query_string);
362  *
363  *     for (messages = notmuch_query_search_messages (query);
364  *          notmuch_messages_has_more (messages);
365  *          notmuch_messages_advance (messages))
366  *     {
367  *         message = notmuch_messages_get (messages);
368  *         ....
369  *         notmuch_message_destroy (message);
370  *     }
371  *
372  *     notmuch_query_destroy (query);
373  *
374  * Note: If you are finished with a message before its containing
375  * query, you can call notmuch_message_destroy to clean up some memory
376  * sooner (as in the above example). Otherwise, if your message
377  * objects are long-lived, then you don't need to call
378  * notmuch_message_destroy and all the memory will still be reclaimed
379  * when the query is destroyed.
380  *
381  * Note that there's no explicit destructor needed for the
382  * notmuch_messages_t object. (For consistency, we do provide a
383  * notmuch_messages_destroy function, but there's no good
384  * reason to call it if the query is about to be destroyed).
385  */
386 notmuch_messages_t *
387 notmuch_query_search_messages (notmuch_query_t *query);
388
389 /* Destroy a notmuch_query_t along with any associated resources.
390  *
391  * This will in turn destroy any notmuch_threads_t and
392  * notmuch_messages_t objects generated by this query, (and in
393  * turn any notmuch_thrad_t and notmuch_message_t objects generated
394  * from those results, etc.), if such objects haven't already been
395  * destroyed.
396  */
397 void
398 notmuch_query_destroy (notmuch_query_t *query);
399
400 /* Does the given notmuch_threads_t object contain any more
401  * results.
402  *
403  * When this function returns TRUE, notmuch_threads_get will
404  * return a valid object. Whereas when this function returns FALSE,
405  * notmuch_threads_get will return NULL.
406  *
407  * See the documentation of notmuch_query_search_threads for example
408  * code showing how to iterate over a notmuch_threads_t object.
409  */
410 notmuch_bool_t
411 notmuch_threads_has_more (notmuch_threads_t *threads);
412
413 /* Get the current thread from 'threads' as a notmuch_thread_t.
414  *
415  * Note: The returned thread belongs to 'threads' and has a lifetime
416  * identical to it (and the query to which it belongs).
417  *
418  * See the documentation of notmuch_query_search_threads for example
419  * code showing how to iterate over a notmuch_threads_t object.
420  *
421  * If an out-of-memory situation occurs, this function will return
422  * NULL.
423  */
424 notmuch_thread_t *
425 notmuch_threads_get (notmuch_threads_t *threads);
426
427 /* Advance the 'threads' iterator to the next thread.
428  *
429  * See the documentation of notmuch_query_search_threads for example
430  * code showing how to iterate over a notmuch_threads_t object.
431  */
432 void
433 notmuch_threads_advance (notmuch_threads_t *threads);
434
435 /* Destroy a notmuch_threads_t object.
436  *
437  * It's not strictly necessary to call this function. All memory from
438  * the notmuch_threads_t object will be reclaimed when the
439  * containg query object is destroyed.
440  */
441 void
442 notmuch_threads_destroy (notmuch_threads_t *threads);
443
444 /* Get the thread ID of 'thread'.
445  *
446  * The returned string belongs to 'thread' and as such, should not be
447  * modified by the caller and will only be valid for as long as the
448  * thread is valid, (which is until notmuch_thread_destroy or until
449  * the query from which it derived is destroyed).
450  */
451 const char *
452 notmuch_thread_get_thread_id (notmuch_thread_t *thread);
453
454 /* Get the subject of 'thread'
455  *
456  * The subject is taken from the first message (according to the query
457  * order---see notmuch_query_set_sort) in the query results that
458  * belongs to this thread.
459  *
460  * The returned string belongs to 'thread' and as such, should not be
461  * modified by the caller and will only be valid for as long as the
462  * thread is valid, (which is until notmuch_thread_destroy or until
463  * the query from which it derived is destroyed).
464  */
465 const char *
466 notmuch_thread_get_subject (notmuch_thread_t *thread);
467
468 /* Get the date of the oldest message in 'thread' as a time_t value.
469  */
470 time_t
471 notmuch_thread_get_oldest_date (notmuch_thread_t *thread);
472
473 /* Get the date of the oldest message in 'thread' as a time_t value.
474  */
475 time_t
476 notmuch_thread_get_newest_date (notmuch_thread_t *thread);
477
478 /* Get the tags for 'thread', returning a notmuch_tags_t object which
479  * can be used to iterate over all tags.
480  *
481  * Note: In the Notmuch database, tags are stored on individual
482  * messages, not on threads. So the tags returned here will be all
483  * tags of the messages which matched the search and which belong to
484  * this thread.
485  *
486  * The tags object is owned by the thread and as such, will only be
487  * valid for as long as the thread is valid, (for example, until
488  * notmuch_thread_destroy or until the query from which it derived is
489  * destroyed).
490  *
491  * Typical usage might be:
492  *
493  *     notmuch_thread_t *thread;
494  *     notmuch_tags_t *tags;
495  *     const char *tag;
496  *
497  *     thread = notmuch_threads_get (threads);
498  *
499  *     for (tags = notmuch_thread_get_tags (thread);
500  *          notmuch_tags_has_more (tags);
501  *          notmuch_result_advance (tags))
502  *     {
503  *         tag = notmuch_tags_get (tags);
504  *         ....
505  *     }
506  *
507  *     notmuch_thread_destroy (thread);
508  *
509  * Note that there's no explicit destructor needed for the
510  * notmuch_tags_t object. (For consistency, we do provide a
511  * notmuch_tags_destroy function, but there's no good reason to call
512  * it if the message is about to be destroyed).
513  */
514 notmuch_tags_t *
515 notmuch_thread_get_tags (notmuch_thread_t *thread);
516
517 /* Destroy a notmuch_thread_t object. */
518 void
519 notmuch_thread_destroy (notmuch_thread_t *thread);
520
521 /* Does the given notmuch_messages_t object contain any more
522  * messages.
523  *
524  * When this function returns TRUE, notmuch_messages_get will return a
525  * valid object. Whereas when this function returns FALSE,
526  * notmuch_messages_get will return NULL.
527  *
528  * See the documentation of notmuch_query_search_messages for example
529  * code showing how to iterate over a notmuch_messages_t object.
530  */
531 notmuch_bool_t
532 notmuch_messages_has_more (notmuch_messages_t *messages);
533
534 /* Get the current message from 'messages' as a notmuch_message_t.
535  *
536  * Note: The returned message belongs to 'messages' and has a lifetime
537  * identical to it (and the query to which it belongs).
538  *
539  * See the documentation of notmuch_query_search_messages for example
540  * code showing how to iterate over a notmuch_messages_t object.
541  *
542  * If an out-of-memory situation occurs, this function will return
543  * NULL.
544  */
545 notmuch_message_t *
546 notmuch_messages_get (notmuch_messages_t *messages);
547
548 /* Advance the 'messages' iterator to the next result.
549  *
550  * See the documentation of notmuch_query_search_messages for example
551  * code showing how to iterate over a notmuch_messages_t object.
552  */
553 void
554 notmuch_messages_advance (notmuch_messages_t *messages);
555
556 /* Destroy a notmuch_messages_t object.
557  *
558  * It's not strictly necessary to call this function. All memory from
559  * the notmuch_messages_t object will be reclaimed when the containg
560  * query object is destroyed.
561  */
562 void
563 notmuch_messages_destroy (notmuch_messages_t *messages);
564
565 /* Get the message ID of 'message'.
566  *
567  * The returned string belongs to 'message' and as such, should not be
568  * modified by the caller and will only be valid for as long as the
569  * message is valid, (which is until the query from which it derived
570  * is destroyed).
571  *
572  * This function will not return NULL since Notmuch ensures that every
573  * message has a unique message ID, (Notmuch will generate an ID for a
574  * message if the original file does not contain one).
575  */
576 const char *
577 notmuch_message_get_message_id (notmuch_message_t *message);
578
579 /* Get the thread ID of 'message'.
580  *
581  * The returned string belongs to 'message' and as such, should not be
582  * modified by the caller and will only be valid for as long as the
583  * message is valid, (for example, until the user calls
584  * notmuch_message_destroy on 'message' or until a query from which it
585  * derived is destroyed).
586  *
587  * This function will not return NULL since Notmuch ensures that every
588  * message belongs to a single thread.
589  */
590 const char *
591 notmuch_message_get_thread_id (notmuch_message_t *message);
592
593 /* Get the filename for the email corresponding to 'message'.
594  *
595  * The returned filename is an absolute filename, (the initial
596  * component will match notmuch_database_get_path() ).
597  *
598  * The returned string belongs to the message so should not be
599  * modified or freed by the caller (nor should it be referenced after
600  * the message is destroyed). */
601 const char *
602 notmuch_message_get_filename (notmuch_message_t *message);
603
604 /* Get the date of 'message' as a time_t value.
605  *
606  * For the original textual representation of the Date header from the
607  * message call notmuch_message_get_header() with a header value of
608  * "date". */
609 time_t
610 notmuch_message_get_date  (notmuch_message_t *message);
611
612 /* Get the value of the specified header from 'message'.
613  *
614  * The value will be read from the actual message file, not from the
615  * notmuch database. The header name is case insensitive.
616  *
617  * The returned string belongs to the message so should not be
618  * modified or freed by the caller (nor should it be referenced after
619  * the message is destroyed).
620  *
621  * Returns NULL if the message does not contain a header line matching
622  * 'header' of if any error occurs.
623  */
624 const char *
625 notmuch_message_get_header (notmuch_message_t *message, const char *header);
626
627 /* Get the tags for 'message', returning a notmuch_tags_t object which
628  * can be used to iterate over all tags.
629  *
630  * The tags object is owned by the message and as such, will only be
631  * valid for as long as the message is valid, (which is until the
632  * query from which it derived is destroyed).
633  *
634  * Typical usage might be:
635  *
636  *     notmuch_message_t *message;
637  *     notmuch_tags_t *tags;
638  *     const char *tag;
639  *
640  *     message = notmuch_database_find_message (database, message_id);
641  *
642  *     for (tags = notmuch_message_get_tags (message);
643  *          notmuch_tags_has_more (tags);
644  *          notmuch_result_advance (tags))
645  *     {
646  *         tag = notmuch_tags_get (tags);
647  *         ....
648  *     }
649  *
650  *     notmuch_message_destroy (message);
651  *
652  * Note that there's no explicit destructor needed for the
653  * notmuch_tags_t object. (For consistency, we do provide a
654  * notmuch_tags_destroy function, but there's no good reason to call
655  * it if the message is about to be destroyed).
656  */
657 notmuch_tags_t *
658 notmuch_message_get_tags (notmuch_message_t *message);
659
660 /* The longest possible tag value. */
661 #define NOTMUCH_TAG_MAX 200
662
663 /* Add a tag to the given message.
664  *
665  * Return value:
666  *
667  * NOTMUCH_STATUS_SUCCESS: Tag successfully added to message
668  *
669  * NOTMUCH_STATUS_NULL_POINTER: The 'tag' argument is NULL
670  *
671  * NOTMUCH_STATUS_TAG_TOO_LONG: The length of 'tag' is too long
672  *      (exceeds NOTMUCH_TAG_MAX)
673  */
674 notmuch_status_t
675 notmuch_message_add_tag (notmuch_message_t *message, const char *tag);
676
677 /* Remove a tag from the given message.
678  *
679  * Return value:
680  *
681  * NOTMUCH_STATUS_SUCCESS: Tag successfully removed from message
682  *
683  * NOTMUCH_STATUS_NULL_POINTER: The 'tag' argument is NULL
684  *
685  * NOTMUCH_STATUS_TAG_TOO_LONG: The length of 'tag' is too long
686  *      (exceeds NOTMUCH_TAG_MAX)
687  */
688 notmuch_status_t
689 notmuch_message_remove_tag (notmuch_message_t *message, const char *tag);
690
691 /* Remove all tags from the given message.
692  *
693  * See notmuch_message_freeze for an example showing how to safely
694  * replace tag values.
695  */
696 void
697 notmuch_message_remove_all_tags (notmuch_message_t *message);
698
699 /* Freeze the current state of 'message' within the database.
700  *
701  * This means that changes to the message state, (via
702  * notmuch_message_add_tag, notmuch_message_remove_tag, and
703  * notmuch_message_remove_all_tags), will not be committed to the
704  * database until the message is thawed with notmuch_message_thaw.
705  *
706  * Multiple calls to freeze/thaw are valid and these calls with
707  * "stack". That is there must be as many calls to thaw as to freeze
708  * before a message is actually thawed.
709  *
710  * The ability to do freeze/thaw allows for safe transactions to
711  * change tag values. For example, explicitly setting a message to
712  * have a given set of tags might look like this:
713  *
714  *    notmuch_message_freeze (message);
715  *
716  *    notmuch_message_remove_all_tags (message);
717  *
718  *    for (i = 0; i < NUM_TAGS; i++)
719  *        notmuch_message_add_tag (message, tags[i]);
720  *
721  *    notmuch_message_thaw (message);
722  *
723  * With freeze/thaw used like this, the message in the database is
724  * guaranteed to have either the full set of original tag value, or
725  * the full set of new tag values, but nothing in between.
726  *
727  * Imagine the example above without freeze/thaw and the operation
728  * somehow getting interrupted. This could result in the message being
729  * left with no tags if the interruption happened after
730  * notmuch_message_remove_all_tags but before notmuch_message_add_tag.
731  */
732 void
733 notmuch_message_freeze (notmuch_message_t *message);
734
735 /* Thaw the current 'message', synchronizing any changes that may have
736  * occurred while 'message' was frozen into the notmuch database.
737  *
738  * See notmuch_message_freeze for an example of how to use this
739  * function to safely provide tag changes.
740  *
741  * Multiple calls to freeze/thaw are valid and these calls with
742  * "stack". That is there must be as many calls to thaw as to freeze
743  * before a message is actually thawed.
744  *
745  * Return value:
746  *
747  * NOTMUCH_STATUS_SUCCESS: Message successfully thawed, (or at least
748  *      its frozen count has successfully been reduced by 1).
749  *
750  * NOTMUCH_STATUS_UNBALANCE_FREEZE_THAW: An attempt was made to thaw
751  *      an unfrozen message. That is, there have been an unbalanced
752  *      number of calls to notmuch_message_freeze and
753  *      notmuch_message_thaw.
754  */
755 notmuch_status_t
756 notmuch_message_thaw (notmuch_message_t *message);
757
758 /* Destroy a notmuch_message_t object.
759  *
760  * It can be useful to call this function in the case of a single
761  * query object with many messages in the result, (such as iterating
762  * over the entire database). Otherwise, it's fine to never call this
763  * function and there will still be no memory leaks. (The memory from
764  * the messages get reclaimed when the containing query is destroyed.)
765  */
766 void
767 notmuch_message_destroy (notmuch_message_t *message);
768
769 /* Does the given notmuch_tags_t object contain any more tags.
770  *
771  * When this function returns TRUE, notmuch_tags_get will return a
772  * valid string. Whereas when this function returns FALSE,
773  * notmuch_tags_get will return NULL.
774  *
775  * See the documentation of notmuch_message_get_tags for example code
776  * showing how to iterate over a notmuch_tags_t object.
777  */
778 notmuch_bool_t
779 notmuch_tags_has_more (notmuch_tags_t *tags);
780
781 /* Get the current tag from 'tags' as a string.
782  *
783  * Note: The returned string belongs to 'tags' and has a lifetime
784  * identical to it (and the query to which it utlimately belongs).
785  *
786  * See the documentation of notmuch_message_get_tags for example code
787  * showing how to iterate over a notmuch_tags_t object.
788  */
789 const char *
790 notmuch_tags_get (notmuch_tags_t *tags);
791
792 /* Advance the 'tags' iterator to the next tag.
793  *
794  * See the documentation of notmuch_message_get_tags for example code
795  * showing how to iterate over a notmuch_tags_t object.
796  */
797 void
798 notmuch_tags_advance (notmuch_tags_t *tags);
799
800 /* Destroy a notmuch_tags_t object.
801  *
802  * It's not strictly necessary to call this function. All memory from
803  * the notmuch_tags_t object will be reclaimed when the containg
804  * message or query objects are destroyed.
805  */
806 void
807 notmuch_tags_destroy (notmuch_tags_t *tags);
808
809 NOTMUCH_END_DECLS
810
811 #endif