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