fe01e7321494ad936ad254544d125eb2ce6f99bb
[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_READ_WRITE 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 /* Return the database format version of the given database. */
187 unsigned int
188 notmuch_database_get_version (notmuch_database_t *database);
189
190 /* Does this database need to be upgraded before writing to it?
191  *
192  * If this function returns TRUE then no functions that modify the
193  * database (notmuch_database_add_message, notmuch_message_add_tag,
194  * notmuch_directory_set_mtime, etc.) will work unless the function
195  * notmuch_database_upgrade is called successfully first. */
196 notmuch_bool_t
197 notmuch_database_needs_upgrade (notmuch_database_t *database);
198
199 /* Upgrade the current database.
200  *
201  * After opening a database in read-write mode, the client should
202  * check if an upgrade is needed (notmuch_database_needs_upgrade) and
203  * if so, upgrade with this function before making any modifications.
204  *
205  * The optional progress_notify callback can be used by the caller to
206  * provide progress indication to the user. If non-NULL it will be
207  * called periodically with 'progress' as a floating-point value in
208  * the range of [0.0 .. 1.0] indicating the progress made so far in
209  * the upgrade process.
210  */
211 notmuch_status_t
212 notmuch_database_upgrade (notmuch_database_t *database,
213                           void (*progress_notify) (void *closure,
214                                                    double progress),
215                           void *closure);
216
217 /* Retrieve a directory object from the database for 'path'.
218  *
219  * Here, 'path' should be a path relative to the path of 'database'
220  * (see notmuch_database_get_path), or else should be an absolute path
221  * with initial components that match the path of 'database'.
222  *
223  * Can return NULL if a Xapian exception occurs.
224  */
225 notmuch_directory_t *
226 notmuch_database_get_directory (notmuch_database_t *database,
227                                 const char *path);
228
229 /* Add a new message to the given notmuch database.
230  *
231  * Here,'filename' should be a path relative to the path of
232  * 'database' (see notmuch_database_get_path), or else should be an
233  * absolute filename with initial components that match the path of
234  * 'database'.
235  *
236  * The file should be a single mail message (not a multi-message mbox)
237  * that is expected to remain at its current location, (since the
238  * notmuch database will reference the filename, and will not copy the
239  * entire contents of the file.
240  *
241  * If 'message' is not NULL, then, on successful return
242  * (NOTMUCH_STATUS_SUCCESS or NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID) '*message'
243  * will be initialized to a message object that can be used for things
244  * such as adding tags to the just-added message. The user should call
245  * notmuch_message_destroy when done with the message. On any failure
246  * '*message' will be set to NULL.
247  *
248  * Return value:
249  *
250  * NOTMUCH_STATUS_SUCCESS: Message successfully added to database.
251  *
252  * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred,
253  *      message not added.
254  *
255  * NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID: Message has the same message
256  *      ID as another message already in the database. The new
257  *      filename was successfully added to the message in the database
258  *      (if not already present).
259  *
260  * NOTMUCH_STATUS_FILE_ERROR: an error occurred trying to open the
261  *      file, (such as permission denied, or file not found,
262  *      etc.). Nothing added to the database.
263  *
264  * NOTMUCH_STATUS_FILE_NOT_EMAIL: the contents of filename don't look
265  *      like an email message. Nothing added to the database.
266  *
267  * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
268  *      mode so no message can be added.
269  */
270 notmuch_status_t
271 notmuch_database_add_message (notmuch_database_t *database,
272                               const char *filename,
273                               notmuch_message_t **message);
274
275 /* Remove a message from the given notmuch database.
276  *
277  * Note that only this particular filename association is removed from
278  * the database. If the same message (as determined by the message ID)
279  * is still available via other filenames, then the message will
280  * persist in the database for those filenames. When the last filename
281  * is removed for a particular message, the database content for that
282  * message will be entirely removed.
283  *
284  * Return value:
285  *
286  * NOTMUCH_STATUS_SUCCESS: The last filename was removed and the
287  *      message was removed from the database.
288  *
289  * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred,
290  *      message not removed.
291  *
292  * NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID: This filename was removed but
293  *      the message persists in the database with at least one other
294  *      filename.
295  *
296  * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
297  *      mode so no message can be removed.
298  */
299 notmuch_status_t
300 notmuch_database_remove_message (notmuch_database_t *database,
301                                  const char *filename);
302
303 /* Find a message with the given message_id.
304  *
305  * If the database contains a message with the given message_id, then
306  * a new notmuch_message_t object is returned. The caller should call
307  * notmuch_message_destroy when done with the message.
308  *
309  * This function returns NULL in the following situations:
310  *
311  *      * No message is found with the given message_id
312  *      * An out-of-memory situation occurs
313  *      * A Xapian exception occurs
314  */
315 notmuch_message_t *
316 notmuch_database_find_message (notmuch_database_t *database,
317                                const char *message_id);
318
319 /* Return a list of all tags found in the database.
320  *
321  * This function creates a list of all tags found in the database. The
322  * resulting list contains all tags from all messages found in the database.
323  *
324  * On error this function returns NULL.
325  */
326 notmuch_tags_t *
327 notmuch_database_get_all_tags (notmuch_database_t *db);
328
329 /* Create a new query for 'database'.
330  *
331  * Here, 'database' should be an open database, (see
332  * notmuch_database_open and notmuch_database_create).
333  *
334  * For the query string, we'll document the syntax here more
335  * completely in the future, but it's likely to be a specialized
336  * version of the general Xapian query syntax:
337  *
338  * http://xapian.org/docs/queryparser.html
339  *
340  * As a special case, passing either a length-zero string, (that is ""),
341  * or a string consisting of a single asterisk (that is "*"), will
342  * result in a query that returns all messages in the database.
343  *
344  * See notmuch_query_set_sort for controlling the order of results.
345  * See notmuch_query_search_messages and notmuch_query_search_threads
346  * to actually execute the query.
347  *
348  * User should call notmuch_query_destroy when finished with this
349  * query.
350  *
351  * Will return NULL if insufficient memory is available.
352  */
353 notmuch_query_t *
354 notmuch_query_create (notmuch_database_t *database,
355                       const char *query_string);
356
357 /* Sort values for notmuch_query_set_sort */
358 typedef enum {
359     NOTMUCH_SORT_OLDEST_FIRST,
360     NOTMUCH_SORT_NEWEST_FIRST,
361     NOTMUCH_SORT_MESSAGE_ID,
362     NOTMUCH_SORT_UNSORTED
363 } notmuch_sort_t;
364
365 /* Return the query_string of this query. See notmuch_query_create. */
366 const char *
367 notmuch_query_get_query_string (notmuch_query_t *query);
368
369 /* Specify the sorting desired for this query. */
370 void
371 notmuch_query_set_sort (notmuch_query_t *query, notmuch_sort_t sort);
372
373 /* Return the sort specified for this query. See notmuch_query_set_sort. */
374 notmuch_sort_t
375 notmuch_query_get_sort (notmuch_query_t *query);
376
377 /* Execute a query for threads, returning a notmuch_threads_t object
378  * which can be used to iterate over the results. The returned threads
379  * object is owned by the query and as such, will only be valid until
380  * notmuch_query_destroy.
381  *
382  * Typical usage might be:
383  *
384  *     notmuch_query_t *query;
385  *     notmuch_threads_t *threads;
386  *     notmuch_thread_t *thread;
387  *
388  *     query = notmuch_query_create (database, query_string);
389  *
390  *     for (threads = notmuch_query_search_threads (query);
391  *          notmuch_threads_valid (threads);
392  *          notmuch_threads_move_to_next (threads))
393  *     {
394  *         thread = notmuch_threads_get (threads);
395  *         ....
396  *         notmuch_thread_destroy (thread);
397  *     }
398  *
399  *     notmuch_query_destroy (query);
400  *
401  * Note: If you are finished with a thread before its containing
402  * query, you can call notmuch_thread_destroy to clean up some memory
403  * sooner (as in the above example). Otherwise, if your thread objects
404  * are long-lived, then you don't need to call notmuch_thread_destroy
405  * and all the memory will still be reclaimed when the query is
406  * destroyed.
407  *
408  * Note that there's no explicit destructor needed for the
409  * notmuch_threads_t object. (For consistency, we do provide a
410  * notmuch_threads_destroy function, but there's no good reason
411  * to call it if the query is about to be destroyed).
412  *
413  * If a Xapian exception occurs this function will return NULL.
414  */
415 notmuch_threads_t *
416 notmuch_query_search_threads (notmuch_query_t *query);
417
418 /* Execute a query for messages, returning a notmuch_messages_t object
419  * which can be used to iterate over the results. The returned
420  * messages object is owned by the query and as such, will only be
421  * valid until notmuch_query_destroy.
422  *
423  * Typical usage might be:
424  *
425  *     notmuch_query_t *query;
426  *     notmuch_messages_t *messages;
427  *     notmuch_message_t *message;
428  *
429  *     query = notmuch_query_create (database, query_string);
430  *
431  *     for (messages = notmuch_query_search_messages (query);
432  *          notmuch_messages_valid (messages);
433  *          notmuch_messages_move_to_next (messages))
434  *     {
435  *         message = notmuch_messages_get (messages);
436  *         ....
437  *         notmuch_message_destroy (message);
438  *     }
439  *
440  *     notmuch_query_destroy (query);
441  *
442  * Note: If you are finished with a message before its containing
443  * query, you can call notmuch_message_destroy to clean up some memory
444  * sooner (as in the above example). Otherwise, if your message
445  * objects are long-lived, then you don't need to call
446  * notmuch_message_destroy and all the memory will still be reclaimed
447  * when the query is destroyed.
448  *
449  * Note that there's no explicit destructor needed for the
450  * notmuch_messages_t object. (For consistency, we do provide a
451  * notmuch_messages_destroy function, but there's no good
452  * reason to call it if the query is about to be destroyed).
453  *
454  * If a Xapian exception occurs this function will return NULL.
455  */
456 notmuch_messages_t *
457 notmuch_query_search_messages (notmuch_query_t *query);
458
459 /* Destroy a notmuch_query_t along with any associated resources.
460  *
461  * This will in turn destroy any notmuch_threads_t and
462  * notmuch_messages_t objects generated by this query, (and in
463  * turn any notmuch_thread_t and notmuch_message_t objects generated
464  * from those results, etc.), if such objects haven't already been
465  * destroyed.
466  */
467 void
468 notmuch_query_destroy (notmuch_query_t *query);
469
470 /* Is the given 'threads' iterator pointing at a valid thread.
471  *
472  * When this function returns TRUE, notmuch_threads_get will return a
473  * valid object. Whereas when this function returns FALSE,
474  * notmuch_threads_get will return NULL.
475  *
476  * See the documentation of notmuch_query_search_threads for example
477  * code showing how to iterate over a notmuch_threads_t object.
478  */
479 notmuch_bool_t
480 notmuch_threads_valid (notmuch_threads_t *threads);
481
482 /* Get the current thread from 'threads' as a notmuch_thread_t.
483  *
484  * Note: The returned thread belongs to 'threads' and has a lifetime
485  * identical to it (and the query to which it belongs).
486  *
487  * See the documentation of notmuch_query_search_threads for example
488  * code showing how to iterate over a notmuch_threads_t object.
489  *
490  * If an out-of-memory situation occurs, this function will return
491  * NULL.
492  */
493 notmuch_thread_t *
494 notmuch_threads_get (notmuch_threads_t *threads);
495
496 /* Move the 'threads' iterator to the next thread.
497  *
498  * If 'threads' is already pointing at the last thread then the
499  * iterator will be moved to a point just beyond that last thread,
500  * (where notmuch_threads_valid will return FALSE and
501  * notmuch_threads_get will return NULL).
502  *
503  * See the documentation of notmuch_query_search_threads for example
504  * code showing how to iterate over a notmuch_threads_t object.
505  */
506 void
507 notmuch_threads_move_to_next (notmuch_threads_t *threads);
508
509 /* Destroy a notmuch_threads_t object.
510  *
511  * It's not strictly necessary to call this function. All memory from
512  * the notmuch_threads_t object will be reclaimed when the
513  * containg query object is destroyed.
514  */
515 void
516 notmuch_threads_destroy (notmuch_threads_t *threads);
517
518 /* Return an estimate of the number of messages matching a search
519  *
520  * This function performs a search and returns Xapian's best
521  * guess as to number of matching messages.
522  *
523  * If a Xapian exception occurs, this function may return 0 (after
524  * printing a message).
525  */
526 unsigned
527 notmuch_query_count_messages (notmuch_query_t *query);
528  
529 /* Get the thread ID of 'thread'.
530  *
531  * The returned string belongs to 'thread' and as such, should not be
532  * modified by the caller and will only be valid for as long as the
533  * thread is valid, (which is until notmuch_thread_destroy or until
534  * the query from which it derived is destroyed).
535  */
536 const char *
537 notmuch_thread_get_thread_id (notmuch_thread_t *thread);
538
539 /* Get the total number of messages in 'thread'.
540  *
541  * This count consists of all messages in the database belonging to
542  * this thread. Contrast with notmuch_thread_get_matched_messages() .
543  */
544 int
545 notmuch_thread_get_total_messages (notmuch_thread_t *thread);
546
547 /* Get a notmuch_messages_t iterator for the top-level messages in
548  * 'thread'.
549  *
550  * This iterator will not necessarily iterate over all of the messages
551  * in the thread. It will only iterate over the messages in the thread
552  * which are not replies to other messages in the thread.
553  *
554  * To iterate over all messages in the thread, the caller will need to
555  * iterate over the result of notmuch_message_get_replies for each
556  * top-level message (and do that recursively for the resulting
557  * messages, etc.).
558  */
559 notmuch_messages_t *
560 notmuch_thread_get_toplevel_messages (notmuch_thread_t *thread);
561
562 /* Get the number of messages in 'thread' that matched the search.
563  *
564  * This count includes only the messages in this thread that were
565  * matched by the search from which the thread was created. Contrast
566  * with notmuch_thread_get_total_messages() .
567  */
568 int
569 notmuch_thread_get_matched_messages (notmuch_thread_t *thread);
570
571 /* Get the authors of 'thread'
572  *
573  * The returned string is a comma-separated list of the names of the
574  * authors of mail messages in the query results that belong to this
575  * thread.
576  *
577  * The returned string belongs to 'thread' and as such, should not be
578  * modified by the caller and will only be valid for as long as the
579  * thread is valid, (which is until notmuch_thread_destroy or until
580  * the query from which it derived is destroyed).
581  */
582 const char *
583 notmuch_thread_get_authors (notmuch_thread_t *thread);
584
585 /* Get the subject of 'thread'
586  *
587  * The subject is taken from the first message (according to the query
588  * order---see notmuch_query_set_sort) in the query results that
589  * belongs to this thread.
590  *
591  * The returned string belongs to 'thread' and as such, should not be
592  * modified by the caller and will only be valid for as long as the
593  * thread is valid, (which is until notmuch_thread_destroy or until
594  * the query from which it derived is destroyed).
595  */
596 const char *
597 notmuch_thread_get_subject (notmuch_thread_t *thread);
598
599 /* Get the date of the oldest message in 'thread' as a time_t value.
600  */
601 time_t
602 notmuch_thread_get_oldest_date (notmuch_thread_t *thread);
603
604 /* Get the date of the newest message in 'thread' as a time_t value.
605  */
606 time_t
607 notmuch_thread_get_newest_date (notmuch_thread_t *thread);
608
609 /* Get the tags for 'thread', returning a notmuch_tags_t object which
610  * can be used to iterate over all tags.
611  *
612  * Note: In the Notmuch database, tags are stored on individual
613  * messages, not on threads. So the tags returned here will be all
614  * tags of the messages which matched the search and which belong to
615  * this thread.
616  *
617  * The tags object is owned by the thread and as such, will only be
618  * valid for as long as the thread is valid, (for example, until
619  * notmuch_thread_destroy or until the query from which it derived is
620  * destroyed).
621  *
622  * Typical usage might be:
623  *
624  *     notmuch_thread_t *thread;
625  *     notmuch_tags_t *tags;
626  *     const char *tag;
627  *
628  *     thread = notmuch_threads_get (threads);
629  *
630  *     for (tags = notmuch_thread_get_tags (thread);
631  *          notmuch_tags_valid (tags);
632  *          notmuch_result_move_to_next (tags))
633  *     {
634  *         tag = notmuch_tags_get (tags);
635  *         ....
636  *     }
637  *
638  *     notmuch_thread_destroy (thread);
639  *
640  * Note that there's no explicit destructor needed for the
641  * notmuch_tags_t object. (For consistency, we do provide a
642  * notmuch_tags_destroy function, but there's no good reason to call
643  * it if the message is about to be destroyed).
644  */
645 notmuch_tags_t *
646 notmuch_thread_get_tags (notmuch_thread_t *thread);
647
648 /* Destroy a notmuch_thread_t object. */
649 void
650 notmuch_thread_destroy (notmuch_thread_t *thread);
651
652 /* Is the given 'messages' iterator pointing at a valid message.
653  *
654  * When this function returns TRUE, notmuch_messages_get will return a
655  * valid object. Whereas when this function returns FALSE,
656  * notmuch_messages_get will return NULL.
657  *
658  * See the documentation of notmuch_query_search_messages for example
659  * code showing how to iterate over a notmuch_messages_t object.
660  */
661 notmuch_bool_t
662 notmuch_messages_valid (notmuch_messages_t *messages);
663
664 /* Get the current message from 'messages' as a notmuch_message_t.
665  *
666  * Note: The returned message belongs to 'messages' and has a lifetime
667  * identical to it (and the query to which it belongs).
668  *
669  * See the documentation of notmuch_query_search_messages for example
670  * code showing how to iterate over a notmuch_messages_t object.
671  *
672  * If an out-of-memory situation occurs, this function will return
673  * NULL.
674  */
675 notmuch_message_t *
676 notmuch_messages_get (notmuch_messages_t *messages);
677
678 /* Move the 'messages' iterator to the next message.
679  *
680  * If 'messages' is already pointing at the last message then the
681  * iterator will be moved to a point just beyond that last message,
682  * (where notmuch_messages_valid will return FALSE and
683  * notmuch_messages_get will return NULL).
684  *
685  * See the documentation of notmuch_query_search_messages for example
686  * code showing how to iterate over a notmuch_messages_t object.
687  */
688 void
689 notmuch_messages_move_to_next (notmuch_messages_t *messages);
690
691 /* Destroy a notmuch_messages_t object.
692  *
693  * It's not strictly necessary to call this function. All memory from
694  * the notmuch_messages_t object will be reclaimed when the containing
695  * query object is destroyed.
696  */
697 void
698 notmuch_messages_destroy (notmuch_messages_t *messages);
699
700 /* Return a list of tags from all messages.
701  *
702  * The resulting list is guaranteed not to contain duplicated tags.
703  *
704  * WARNING: You can no longer iterate over messages after calling this
705  * function, because the iterator will point at the end of the list.
706  * We do not have a function to reset the iterator yet and the only
707  * way how you can iterate over the list again is to recreate the
708  * message list.
709  *
710  * The function returns NULL on error.
711  */
712 notmuch_tags_t *
713 notmuch_messages_collect_tags (notmuch_messages_t *messages);
714
715 /* Get the message ID of 'message'.
716  *
717  * The returned string belongs to 'message' and as such, should not be
718  * modified by the caller and will only be valid for as long as the
719  * message is valid, (which is until the query from which it derived
720  * is destroyed).
721  *
722  * This function will not return NULL since Notmuch ensures that every
723  * message has a unique message ID, (Notmuch will generate an ID for a
724  * message if the original file does not contain one).
725  */
726 const char *
727 notmuch_message_get_message_id (notmuch_message_t *message);
728
729 /* Get the thread ID of 'message'.
730  *
731  * The returned string belongs to 'message' and as such, should not be
732  * modified by the caller and will only be valid for as long as the
733  * message is valid, (for example, until the user calls
734  * notmuch_message_destroy on 'message' or until a query from which it
735  * derived is destroyed).
736  *
737  * This function will not return NULL since Notmuch ensures that every
738  * message belongs to a single thread.
739  */
740 const char *
741 notmuch_message_get_thread_id (notmuch_message_t *message);
742
743 /* Get a notmuch_messages_t iterator for all of the replies to
744  * 'message'.
745  *
746  * Note: This call only makes sense if 'message' was ultimately
747  * obtained from a notmuch_thread_t object, (such as by coming
748  * directly from the result of calling notmuch_thread_get_
749  * toplevel_messages or by any number of subsequent
750  * calls to notmuch_message_get_replies).
751  *
752  * If 'message' was obtained through some non-thread means, (such as
753  * by a call to notmuch_query_search_messages), then this function
754  * will return NULL.
755  *
756  * If there are no replies to 'message', this function will return
757  * NULL. (Note that notmuch_messages_valid will accept that NULL
758  * value as legitimate, and simply return FALSE for it.)
759  */
760 notmuch_messages_t *
761 notmuch_message_get_replies (notmuch_message_t *message);
762
763 /* Get a filename for the email corresponding to 'message'.
764  *
765  * The returned filename is an absolute filename, (the initial
766  * component will match notmuch_database_get_path() ).
767  *
768  * The returned string belongs to the message so should not be
769  * modified or freed by the caller (nor should it be referenced after
770  * the message is destroyed).
771  *
772  * Note: If this message corresponds to multiple files in the mail
773  * store, (that is, multiple files contain identical message IDs),
774  * this function will arbitrarily return a single one of those
775  * filenames.
776  */
777 const char *
778 notmuch_message_get_filename (notmuch_message_t *message);
779
780 /* Message flags */
781 typedef enum _notmuch_message_flag {
782     NOTMUCH_MESSAGE_FLAG_MATCH,
783     NOTMUCH_MESSAGE_FLAG_TAGS_INVALID,
784 } notmuch_message_flag_t;
785
786 /* Get a value of a flag for the email corresponding to 'message'. */
787 notmuch_bool_t
788 notmuch_message_get_flag (notmuch_message_t *message,
789                           notmuch_message_flag_t flag);
790
791 /* Set a value of a flag for the email corresponding to 'message'. */
792 void
793 notmuch_message_set_flag (notmuch_message_t *message,
794                           notmuch_message_flag_t flag, notmuch_bool_t value);
795
796 /* Get the date of 'message' as a time_t value.
797  *
798  * For the original textual representation of the Date header from the
799  * message call notmuch_message_get_header() with a header value of
800  * "date". */
801 time_t
802 notmuch_message_get_date  (notmuch_message_t *message);
803
804 /* Get the value of the specified header from 'message'.
805  *
806  * The value will be read from the actual message file, not from the
807  * notmuch database. The header name is case insensitive.
808  *
809  * The returned string belongs to the message so should not be
810  * modified or freed by the caller (nor should it be referenced after
811  * the message is destroyed).
812  *
813  * Returns an empty string ("") if the message does not contain a
814  * header line matching 'header'. Returns NULL if any error occurs.
815  */
816 const char *
817 notmuch_message_get_header (notmuch_message_t *message, const char *header);
818
819 /* Get the tags for 'message', returning a notmuch_tags_t object which
820  * can be used to iterate over all tags.
821  *
822  * The tags object is owned by the message and as such, will only be
823  * valid for as long as the message is valid, (which is until the
824  * query from which it derived is destroyed).
825  *
826  * Typical usage might be:
827  *
828  *     notmuch_message_t *message;
829  *     notmuch_tags_t *tags;
830  *     const char *tag;
831  *
832  *     message = notmuch_database_find_message (database, message_id);
833  *
834  *     for (tags = notmuch_message_get_tags (message);
835  *          notmuch_tags_valid (tags);
836  *          notmuch_result_move_to_next (tags))
837  *     {
838  *         tag = notmuch_tags_get (tags);
839  *         ....
840  *     }
841  *
842  *     notmuch_message_destroy (message);
843  *
844  * Note that there's no explicit destructor needed for the
845  * notmuch_tags_t object. (For consistency, we do provide a
846  * notmuch_tags_destroy function, but there's no good reason to call
847  * it if the message is about to be destroyed).
848  */
849 notmuch_tags_t *
850 notmuch_message_get_tags (notmuch_message_t *message);
851
852 /* The longest possible tag value. */
853 #define NOTMUCH_TAG_MAX 200
854
855 /* Add a tag to the given message.
856  *
857  * Return value:
858  *
859  * NOTMUCH_STATUS_SUCCESS: Tag successfully added to message
860  *
861  * NOTMUCH_STATUS_NULL_POINTER: The 'tag' argument is NULL
862  *
863  * NOTMUCH_STATUS_TAG_TOO_LONG: The length of 'tag' is too long
864  *      (exceeds NOTMUCH_TAG_MAX)
865  *
866  * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
867  *      mode so message cannot be modified.
868  */
869 notmuch_status_t
870 notmuch_message_add_tag (notmuch_message_t *message, const char *tag);
871
872 /* Remove a tag from the given message.
873  *
874  * Return value:
875  *
876  * NOTMUCH_STATUS_SUCCESS: Tag successfully removed from message
877  *
878  * NOTMUCH_STATUS_NULL_POINTER: The 'tag' argument is NULL
879  *
880  * NOTMUCH_STATUS_TAG_TOO_LONG: The length of 'tag' is too long
881  *      (exceeds NOTMUCH_TAG_MAX)
882  *
883  * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
884  *      mode so message cannot be modified.
885  */
886 notmuch_status_t
887 notmuch_message_remove_tag (notmuch_message_t *message, const char *tag);
888
889 /* Remove all tags from the given message.
890  *
891  * See notmuch_message_freeze for an example showing how to safely
892  * replace tag values.
893  *
894  * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
895  *      mode so message cannot be modified.
896  */
897 notmuch_status_t
898 notmuch_message_remove_all_tags (notmuch_message_t *message);
899
900 /* Add or remove tags based on the maildir flags in the file name.
901  */
902 notmuch_status_t
903 notmuch_message_maildir_to_tags (notmuch_message_t *message,
904                                  const char *filename);
905
906 /* Freeze the current state of 'message' within the database.
907  *
908  * This means that changes to the message state, (via
909  * notmuch_message_add_tag, notmuch_message_remove_tag, and
910  * notmuch_message_remove_all_tags), will not be committed to the
911  * database until the message is thawed with notmuch_message_thaw.
912  *
913  * Multiple calls to freeze/thaw are valid and these calls will
914  * "stack". That is there must be as many calls to thaw as to freeze
915  * before a message is actually thawed.
916  *
917  * The ability to do freeze/thaw allows for safe transactions to
918  * change tag values. For example, explicitly setting a message to
919  * have a given set of tags might look like this:
920  *
921  *    notmuch_message_freeze (message);
922  *
923  *    notmuch_message_remove_all_tags (message);
924  *
925  *    for (i = 0; i < NUM_TAGS; i++)
926  *        notmuch_message_add_tag (message, tags[i]);
927  *
928  *    notmuch_message_thaw (message);
929  *
930  * With freeze/thaw used like this, the message in the database is
931  * guaranteed to have either the full set of original tag values, or
932  * the full set of new tag values, but nothing in between.
933  *
934  * Imagine the example above without freeze/thaw and the operation
935  * somehow getting interrupted. This could result in the message being
936  * left with no tags if the interruption happened after
937  * notmuch_message_remove_all_tags but before notmuch_message_add_tag.
938  *
939  * Return value:
940  *
941  * NOTMUCH_STATUS_SUCCESS: Message successfully frozen.
942  *
943  * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
944  *      mode so message cannot be modified.
945  */
946 notmuch_status_t
947 notmuch_message_freeze (notmuch_message_t *message);
948
949 /* Thaw the current 'message', synchronizing any changes that may have
950  * occurred while 'message' was frozen into the notmuch database.
951  *
952  * See notmuch_message_freeze for an example of how to use this
953  * function to safely provide tag changes.
954  *
955  * Multiple calls to freeze/thaw are valid and these calls with
956  * "stack". That is there must be as many calls to thaw as to freeze
957  * before a message is actually thawed.
958  *
959  * Return value:
960  *
961  * NOTMUCH_STATUS_SUCCESS: Message successfully thawed, (or at least
962  *      its frozen count has successfully been reduced by 1).
963  *
964  * NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW: An attempt was made to thaw
965  *      an unfrozen message. That is, there have been an unbalanced
966  *      number of calls to notmuch_message_freeze and
967  *      notmuch_message_thaw.
968  */
969 notmuch_status_t
970 notmuch_message_thaw (notmuch_message_t *message);
971
972 /* Destroy a notmuch_message_t object.
973  *
974  * It can be useful to call this function in the case of a single
975  * query object with many messages in the result, (such as iterating
976  * over the entire database). Otherwise, it's fine to never call this
977  * function and there will still be no memory leaks. (The memory from
978  * the messages get reclaimed when the containing query is destroyed.)
979  */
980 void
981 notmuch_message_destroy (notmuch_message_t *message);
982
983 /* Is the given 'tags' iterator pointing at a valid tag.
984  *
985  * When this function returns TRUE, notmuch_tags_get will return a
986  * valid string. Whereas when this function returns FALSE,
987  * notmuch_tags_get will return NULL.
988  *
989  * See the documentation of notmuch_message_get_tags for example code
990  * showing how to iterate over a notmuch_tags_t object.
991  */
992 notmuch_bool_t
993 notmuch_tags_valid (notmuch_tags_t *tags);
994
995 /* Get the current tag from 'tags' as a string.
996  *
997  * Note: The returned string belongs to 'tags' and has a lifetime
998  * identical to it (and the query to which it ultimately belongs).
999  *
1000  * See the documentation of notmuch_message_get_tags for example code
1001  * showing how to iterate over a notmuch_tags_t object.
1002  */
1003 const char *
1004 notmuch_tags_get (notmuch_tags_t *tags);
1005
1006 /* Move the 'tags' iterator to the next tag.
1007  *
1008  * If 'tags' is already pointing at the last tag then the iterator
1009  * will be moved to a point just beyond that last tag, (where
1010  * notmuch_tags_valid will return FALSE and notmuch_tags_get will
1011  * return NULL).
1012  *
1013  * See the documentation of notmuch_message_get_tags for example code
1014  * showing how to iterate over a notmuch_tags_t object.
1015  */
1016 void
1017 notmuch_tags_move_to_next (notmuch_tags_t *tags);
1018
1019 /* Destroy a notmuch_tags_t object.
1020  *
1021  * It's not strictly necessary to call this function. All memory from
1022  * the notmuch_tags_t object will be reclaimed when the containing
1023  * message or query objects are destroyed.
1024  */
1025 void
1026 notmuch_tags_destroy (notmuch_tags_t *tags);
1027
1028 /* Store an mtime within the database for 'directory'.
1029  *
1030  * The 'directory' should be an object retrieved from the database
1031  * with notmuch_database_get_directory for a particular path.
1032  *
1033  * The intention is for the caller to use the mtime to allow efficient
1034  * identification of new messages to be added to the database. The
1035  * recommended usage is as follows:
1036  *
1037  *   o Read the mtime of a directory from the filesystem
1038  *
1039  *   o Call add_message for all mail files in the directory
1040  *
1041  *   o Call notmuch_directory_set_mtime with the mtime read from the
1042  *     filesystem.
1043  *
1044  * Then, when wanting to check for updates to the directory in the
1045  * future, the client can call notmuch_directory_get_mtime and know
1046  * that it only needs to add files if the mtime of the directory and
1047  * files are newer than the stored timestamp.
1048  *
1049  * Note: The notmuch_directory_get_mtime function does not allow the
1050  * caller to distinguish a timestamp of 0 from a non-existent
1051  * timestamp. So don't store a timestamp of 0 unless you are
1052  * comfortable with that.
1053  *
1054  * Return value:
1055  *
1056  * NOTMUCH_STATUS_SUCCESS: mtime successfully stored in database.
1057  *
1058  * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception
1059  *      occurred, mtime not stored.
1060  *
1061  * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
1062  *      mode so directory mtime cannot be modified.
1063  */
1064 notmuch_status_t
1065 notmuch_directory_set_mtime (notmuch_directory_t *directory,
1066                              time_t mtime);
1067
1068 /* Get the mtime of a directory, (as previously stored with
1069  * notmuch_directory_set_mtime).
1070  *
1071  * Returns 0 if no mtime has previously been stored for this
1072  * directory.*/
1073 time_t
1074 notmuch_directory_get_mtime (notmuch_directory_t *directory);
1075
1076 /* Get a notmuch_filenames_t iterator listing all the filenames of
1077  * messages in the database within the given directory.
1078  *
1079  * The returned filenames will be the basename-entries only (not
1080  * complete paths). */
1081 notmuch_filenames_t *
1082 notmuch_directory_get_child_files (notmuch_directory_t *directory);
1083
1084 /* Get a notmuch_filenams_t iterator listing all the filenames of
1085  * sub-directories in the database within the given directory.
1086  *
1087  * The returned filenames will be the basename-entries only (not
1088  * complete paths). */
1089 notmuch_filenames_t *
1090 notmuch_directory_get_child_directories (notmuch_directory_t *directory);
1091
1092 /* Destroy a notmuch_directory_t object. */
1093 void
1094 notmuch_directory_destroy (notmuch_directory_t *directory);
1095
1096 /* Is the given 'filenames' iterator pointing at a valid filename.
1097  *
1098  * When this function returns TRUE, notmuch_filenames_get will return
1099  * a valid string. Whereas when this function returns FALSE,
1100  * notmuch_filenames_get will return NULL.
1101  *
1102  * It is acceptable to pass NULL for 'filenames', in which case this
1103  * function will always return FALSE.
1104  */
1105 notmuch_bool_t
1106 notmuch_filenames_valid (notmuch_filenames_t *filenames);
1107
1108 /* Get the current filename from 'filenames' as a string.
1109  *
1110  * Note: The returned string belongs to 'filenames' and has a lifetime
1111  * identical to it (and the directory to which it ultimately belongs).
1112  *
1113  * It is acceptable to pass NULL for 'filenames', in which case this
1114  * function will always return NULL.
1115  */
1116 const char *
1117 notmuch_filenames_get (notmuch_filenames_t *filenames);
1118
1119 /* Move the 'filenames' iterator to the next filename.
1120  *
1121  * If 'filenames' is already pointing at the last filename then the
1122  * iterator will be moved to a point just beyond that last filename,
1123  * (where notmuch_filenames_valid will return FALSE and
1124  * notmuch_filenames_get will return NULL).
1125  *
1126  * It is acceptable to pass NULL for 'filenames', in which case this
1127  * function will do nothing.
1128  */
1129 void
1130 notmuch_filenames_move_to_next (notmuch_filenames_t *filenames);
1131
1132 /* Destroy a notmuch_filenames_t object.
1133  *
1134  * It's not strictly necessary to call this function. All memory from
1135  * the notmuch_filenames_t object will be reclaimed when the
1136  * containing directory object is destroyed.
1137  *
1138  * It is acceptable to pass NULL for 'filenames', in which case this
1139  * function will do nothing.
1140  */
1141 void
1142 notmuch_filenames_destroy (notmuch_filenames_t *filenames);
1143
1144 NOTMUCH_END_DECLS
1145
1146 #endif