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