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