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