lib: Improve notmuch_database_{add,remove}_message documentation.
[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  * NOTMUCH_STATUS_UNBALANCED_ATOMIC: notmuch_database_end_atomic has
85  *      been called more times than notmuch_database_begin_atomic.
86  *
87  * And finally:
88  *
89  * NOTMUCH_STATUS_LAST_STATUS: Not an actual status value. Just a way
90  *      to find out how many valid status values there are.
91  */
92 typedef enum _notmuch_status {
93     NOTMUCH_STATUS_SUCCESS = 0,
94     NOTMUCH_STATUS_OUT_OF_MEMORY,
95     NOTMUCH_STATUS_READ_ONLY_DATABASE,
96     NOTMUCH_STATUS_XAPIAN_EXCEPTION,
97     NOTMUCH_STATUS_FILE_ERROR,
98     NOTMUCH_STATUS_FILE_NOT_EMAIL,
99     NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID,
100     NOTMUCH_STATUS_NULL_POINTER,
101     NOTMUCH_STATUS_TAG_TOO_LONG,
102     NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW,
103     NOTMUCH_STATUS_UNBALANCED_ATOMIC,
104
105     NOTMUCH_STATUS_LAST_STATUS
106 } notmuch_status_t;
107
108 /* Get a string representation of a notmuch_status_t value.
109  *
110  * The result is read-only.
111  */
112 const char *
113 notmuch_status_to_string (notmuch_status_t status);
114
115 /* Various opaque data types. For each notmuch_<foo>_t see the various
116  * notmuch_<foo> functions below. */
117 typedef struct _notmuch_database notmuch_database_t;
118 typedef struct _notmuch_query notmuch_query_t;
119 typedef struct _notmuch_threads notmuch_threads_t;
120 typedef struct _notmuch_thread notmuch_thread_t;
121 typedef struct _notmuch_messages notmuch_messages_t;
122 typedef struct _notmuch_message notmuch_message_t;
123 typedef struct _notmuch_tags notmuch_tags_t;
124 typedef struct _notmuch_directory notmuch_directory_t;
125 typedef struct _notmuch_filenames notmuch_filenames_t;
126
127 /* Create a new, empty notmuch database located at 'path'.
128  *
129  * The path should be a top-level directory to a collection of
130  * plain-text email messages (one message per file). This call will
131  * create a new ".notmuch" directory within 'path' where notmuch will
132  * store its data.
133  *
134  * After a successful call to notmuch_database_create, the returned
135  * database will be open so the caller should call
136  * notmuch_database_close when finished with it.
137  *
138  * The database will not yet have any data in it
139  * (notmuch_database_create itself is a very cheap function). Messages
140  * contained within 'path' can be added to the database by calling
141  * notmuch_database_add_message.
142  *
143  * In case of any failure, this function returns NULL, (after printing
144  * an error message on stderr).
145  */
146 notmuch_database_t *
147 notmuch_database_create (const char *path);
148
149 typedef enum {
150     NOTMUCH_DATABASE_MODE_READ_ONLY = 0,
151     NOTMUCH_DATABASE_MODE_READ_WRITE
152 } notmuch_database_mode_t;
153
154 /* XXX: I think I'd like this to take an extra argument of
155  * notmuch_status_t* for returning a status value on failure. */
156
157 /* Open an existing notmuch database located at 'path'.
158  *
159  * The database should have been created at some time in the past,
160  * (not necessarily by this process), by calling
161  * notmuch_database_create with 'path'. By default the database should be
162  * opened for reading only. In order to write to the database you need to
163  * pass the NOTMUCH_DATABASE_MODE_READ_WRITE mode.
164  *
165  * An existing notmuch database can be identified by the presence of a
166  * directory named ".notmuch" below 'path'.
167  *
168  * The caller should call notmuch_database_close when finished with
169  * this database.
170  *
171  * In case of any failure, this function returns NULL, (after printing
172  * an error message on stderr).
173  */
174 notmuch_database_t *
175 notmuch_database_open (const char *path,
176                        notmuch_database_mode_t mode);
177
178 /* Close the given notmuch database, freeing all associated
179  * resources. See notmuch_database_open. */
180 void
181 notmuch_database_close (notmuch_database_t *database);
182
183 /* Return the database path of the given database.
184  *
185  * The return value is a string owned by notmuch so should not be
186  * modified nor freed by the caller. */
187 const char *
188 notmuch_database_get_path (notmuch_database_t *database);
189
190 /* Return the database format version of the given database. */
191 unsigned int
192 notmuch_database_get_version (notmuch_database_t *database);
193
194 /* Does this database need to be upgraded before writing to it?
195  *
196  * If this function returns TRUE then no functions that modify the
197  * database (notmuch_database_add_message, notmuch_message_add_tag,
198  * notmuch_directory_set_mtime, etc.) will work unless the function
199  * notmuch_database_upgrade is called successfully first. */
200 notmuch_bool_t
201 notmuch_database_needs_upgrade (notmuch_database_t *database);
202
203 /* Upgrade the current database.
204  *
205  * After opening a database in read-write mode, the client should
206  * check if an upgrade is needed (notmuch_database_needs_upgrade) and
207  * if so, upgrade with this function before making any modifications.
208  *
209  * The optional progress_notify callback can be used by the caller to
210  * provide progress indication to the user. If non-NULL it will be
211  * called periodically with 'progress' as a floating-point value in
212  * the range of [0.0 .. 1.0] indicating the progress made so far in
213  * the upgrade process.
214  */
215 notmuch_status_t
216 notmuch_database_upgrade (notmuch_database_t *database,
217                           void (*progress_notify) (void *closure,
218                                                    double progress),
219                           void *closure);
220
221 /* Begin an atomic database operation.
222  *
223  * Any modifications performed between a successful begin and a
224  * notmuch_database_end_atomic will be applied to the database
225  * atomically.  Note that, unlike a typical database transaction, this
226  * only ensures atomicity, not durability; neither begin nor end
227  * necessarily flush modifications to disk.
228  *
229  * Atomic sections may be nested.  begin_atomic and end_atomic must
230  * always be called in pairs.
231  *
232  * Return value:
233  *
234  * NOTMUCH_STATUS_SUCCESS: Successfully entered atomic section.
235  *
236  * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred;
237  *      atomic section not entered.
238  */
239 notmuch_status_t
240 notmuch_database_begin_atomic (notmuch_database_t *notmuch);
241
242 /* Indicate the end of an atomic database operation.
243  *
244  * Return value:
245  *
246  * NOTMUCH_STATUS_SUCCESS: Successfully completed atomic section.
247  *
248  * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred;
249  *      atomic section not ended.
250  *
251  * NOTMUCH_STATUS_UNBALANCED_ATOMIC: The database is not currently in
252  *      an atomic section.
253  */
254 notmuch_status_t
255 notmuch_database_end_atomic (notmuch_database_t *notmuch);
256
257 /* Retrieve a directory object from the database for 'path'.
258  *
259  * Here, 'path' should be a path relative to the path of 'database'
260  * (see notmuch_database_get_path), or else should be an absolute path
261  * with initial components that match the path of 'database'.
262  *
263  * Can return NULL if a Xapian exception occurs.
264  */
265 notmuch_directory_t *
266 notmuch_database_get_directory (notmuch_database_t *database,
267                                 const char *path);
268
269 /* Add a new message to the given notmuch database or associate an
270  * additional filename with an existing message.
271  *
272  * Here, 'filename' should be a path relative to the path of
273  * 'database' (see notmuch_database_get_path), or else should be an
274  * absolute filename with initial components that match the path of
275  * 'database'.
276  *
277  * The file should be a single mail message (not a multi-message mbox)
278  * that is expected to remain at its current location, (since the
279  * notmuch database will reference the filename, and will not copy the
280  * entire contents of the file.
281  *
282  * If another message with the same message ID already exists in the
283  * database, rather than creating a new message, this adds 'filename'
284  * to the list of the filenames for the existing message.
285  *
286  * If 'message' is not NULL, then, on successful return
287  * (NOTMUCH_STATUS_SUCCESS or NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID) '*message'
288  * will be initialized to a message object that can be used for things
289  * such as adding tags to the just-added message. The user should call
290  * notmuch_message_destroy when done with the message. On any failure
291  * '*message' will be set to NULL.
292  *
293  * Return value:
294  *
295  * NOTMUCH_STATUS_SUCCESS: Message successfully added to database.
296  *
297  * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred,
298  *      message not added.
299  *
300  * NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID: Message has the same message
301  *      ID as another message already in the database. The new
302  *      filename was successfully added to the message in the database
303  *      (if not already present) and the existing message is returned.
304  *
305  * NOTMUCH_STATUS_FILE_ERROR: an error occurred trying to open the
306  *      file, (such as permission denied, or file not found,
307  *      etc.). Nothing added to the database.
308  *
309  * NOTMUCH_STATUS_FILE_NOT_EMAIL: the contents of filename don't look
310  *      like an email message. Nothing added to the database.
311  *
312  * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
313  *      mode so no message can be added.
314  */
315 notmuch_status_t
316 notmuch_database_add_message (notmuch_database_t *database,
317                               const char *filename,
318                               notmuch_message_t **message);
319
320 /* Remove a message filename from the given notmuch database. If the
321  * message has no more filenames, remove the message.
322  *
323  * If the same message (as determined by the message ID) is still
324  * available via other filenames, then the message will persist in the
325  * database for those filenames. When the last filename is removed for
326  * a particular message, the database content for that message will be
327  * entirely removed.
328  *
329  * Return value:
330  *
331  * NOTMUCH_STATUS_SUCCESS: The last filename was removed and the
332  *      message was removed from the database.
333  *
334  * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred,
335  *      message not removed.
336  *
337  * NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID: This filename was removed but
338  *      the message persists in the database with at least one other
339  *      filename.
340  *
341  * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
342  *      mode so no message can be removed.
343  */
344 notmuch_status_t
345 notmuch_database_remove_message (notmuch_database_t *database,
346                                  const char *filename);
347
348 /* Find a message with the given message_id.
349  *
350  * If the database contains a message with the given message_id, then
351  * a new notmuch_message_t object is returned. The caller should call
352  * notmuch_message_destroy when done with the message.
353  *
354  * This function returns NULL in the following situations:
355  *
356  *      * No message is found with the given message_id
357  *      * An out-of-memory situation occurs
358  *      * A Xapian exception occurs
359  */
360 notmuch_message_t *
361 notmuch_database_find_message (notmuch_database_t *database,
362                                const char *message_id);
363
364 /* Find a message with the given filename.
365  *
366  * If the database contains a message with the given filename, then a
367  * new notmuch_message_t object is returned.  The caller should call 
368  * notmuch_message_destroy when done with the message.
369  *
370  * This function returns NULL in the following situations:
371  *
372  *      * No message is found with the given filename
373  *      * An out-of-memory situation occurs
374  *      * A Xapian exception occurs
375  */
376 notmuch_message_t *
377 notmuch_database_find_message_by_filename (notmuch_database_t *notmuch,
378                                            const char *filename);
379
380 /* Return a list of all tags found in the database.
381  *
382  * This function creates a list of all tags found in the database. The
383  * resulting list contains all tags from all messages found in the database.
384  *
385  * On error this function returns NULL.
386  */
387 notmuch_tags_t *
388 notmuch_database_get_all_tags (notmuch_database_t *db);
389
390 /* Create a new query for 'database'.
391  *
392  * Here, 'database' should be an open database, (see
393  * notmuch_database_open and notmuch_database_create).
394  *
395  * For the query string, we'll document the syntax here more
396  * completely in the future, but it's likely to be a specialized
397  * version of the general Xapian query syntax:
398  *
399  * http://xapian.org/docs/queryparser.html
400  *
401  * As a special case, passing either a length-zero string, (that is ""),
402  * or a string consisting of a single asterisk (that is "*"), will
403  * result in a query that returns all messages in the database.
404  *
405  * See notmuch_query_set_sort for controlling the order of results.
406  * See notmuch_query_search_messages and notmuch_query_search_threads
407  * to actually execute the query.
408  *
409  * User should call notmuch_query_destroy when finished with this
410  * query.
411  *
412  * Will return NULL if insufficient memory is available.
413  */
414 notmuch_query_t *
415 notmuch_query_create (notmuch_database_t *database,
416                       const char *query_string);
417
418 /* Sort values for notmuch_query_set_sort */
419 typedef enum {
420     NOTMUCH_SORT_OLDEST_FIRST,
421     NOTMUCH_SORT_NEWEST_FIRST,
422     NOTMUCH_SORT_MESSAGE_ID,
423     NOTMUCH_SORT_UNSORTED
424 } notmuch_sort_t;
425
426 /* Return the query_string of this query. See notmuch_query_create. */
427 const char *
428 notmuch_query_get_query_string (notmuch_query_t *query);
429
430 /* Specify the sorting desired for this query. */
431 void
432 notmuch_query_set_sort (notmuch_query_t *query, notmuch_sort_t sort);
433
434 /* Return the sort specified for this query. See notmuch_query_set_sort. */
435 notmuch_sort_t
436 notmuch_query_get_sort (notmuch_query_t *query);
437
438 /* Execute a query for threads, returning a notmuch_threads_t object
439  * which can be used to iterate over the results. The returned threads
440  * object is owned by the query and as such, will only be valid until
441  * notmuch_query_destroy.
442  *
443  * Typical usage might be:
444  *
445  *     notmuch_query_t *query;
446  *     notmuch_threads_t *threads;
447  *     notmuch_thread_t *thread;
448  *
449  *     query = notmuch_query_create (database, query_string);
450  *
451  *     for (threads = notmuch_query_search_threads (query);
452  *          notmuch_threads_valid (threads);
453  *          notmuch_threads_move_to_next (threads))
454  *     {
455  *         thread = notmuch_threads_get (threads);
456  *         ....
457  *         notmuch_thread_destroy (thread);
458  *     }
459  *
460  *     notmuch_query_destroy (query);
461  *
462  * Note: If you are finished with a thread before its containing
463  * query, you can call notmuch_thread_destroy to clean up some memory
464  * sooner (as in the above example). Otherwise, if your thread objects
465  * are long-lived, then you don't need to call notmuch_thread_destroy
466  * and all the memory will still be reclaimed when the query is
467  * destroyed.
468  *
469  * Note that there's no explicit destructor needed for the
470  * notmuch_threads_t object. (For consistency, we do provide a
471  * notmuch_threads_destroy function, but there's no good reason
472  * to call it if the query is about to be destroyed).
473  *
474  * If a Xapian exception occurs this function will return NULL.
475  */
476 notmuch_threads_t *
477 notmuch_query_search_threads (notmuch_query_t *query);
478
479 /* Execute a query for messages, returning a notmuch_messages_t object
480  * which can be used to iterate over the results. The returned
481  * messages object is owned by the query and as such, will only be
482  * valid until notmuch_query_destroy.
483  *
484  * Typical usage might be:
485  *
486  *     notmuch_query_t *query;
487  *     notmuch_messages_t *messages;
488  *     notmuch_message_t *message;
489  *
490  *     query = notmuch_query_create (database, query_string);
491  *
492  *     for (messages = notmuch_query_search_messages (query);
493  *          notmuch_messages_valid (messages);
494  *          notmuch_messages_move_to_next (messages))
495  *     {
496  *         message = notmuch_messages_get (messages);
497  *         ....
498  *         notmuch_message_destroy (message);
499  *     }
500  *
501  *     notmuch_query_destroy (query);
502  *
503  * Note: If you are finished with a message before its containing
504  * query, you can call notmuch_message_destroy to clean up some memory
505  * sooner (as in the above example). Otherwise, if your message
506  * objects are long-lived, then you don't need to call
507  * notmuch_message_destroy and all the memory will still be reclaimed
508  * when the query is destroyed.
509  *
510  * Note that there's no explicit destructor needed for the
511  * notmuch_messages_t object. (For consistency, we do provide a
512  * notmuch_messages_destroy function, but there's no good
513  * reason to call it if the query is about to be destroyed).
514  *
515  * If a Xapian exception occurs this function will return NULL.
516  */
517 notmuch_messages_t *
518 notmuch_query_search_messages (notmuch_query_t *query);
519
520 /* Destroy a notmuch_query_t along with any associated resources.
521  *
522  * This will in turn destroy any notmuch_threads_t and
523  * notmuch_messages_t objects generated by this query, (and in
524  * turn any notmuch_thread_t and notmuch_message_t objects generated
525  * from those results, etc.), if such objects haven't already been
526  * destroyed.
527  */
528 void
529 notmuch_query_destroy (notmuch_query_t *query);
530
531 /* Is the given 'threads' iterator pointing at a valid thread.
532  *
533  * When this function returns TRUE, notmuch_threads_get will return a
534  * valid object. Whereas when this function returns FALSE,
535  * notmuch_threads_get will return NULL.
536  *
537  * See the documentation of notmuch_query_search_threads for example
538  * code showing how to iterate over a notmuch_threads_t object.
539  */
540 notmuch_bool_t
541 notmuch_threads_valid (notmuch_threads_t *threads);
542
543 /* Get the current thread from 'threads' as a notmuch_thread_t.
544  *
545  * Note: The returned thread belongs to 'threads' and has a lifetime
546  * identical to it (and the query to which it belongs).
547  *
548  * See the documentation of notmuch_query_search_threads for example
549  * code showing how to iterate over a notmuch_threads_t object.
550  *
551  * If an out-of-memory situation occurs, this function will return
552  * NULL.
553  */
554 notmuch_thread_t *
555 notmuch_threads_get (notmuch_threads_t *threads);
556
557 /* Move the 'threads' iterator to the next thread.
558  *
559  * If 'threads' is already pointing at the last thread then the
560  * iterator will be moved to a point just beyond that last thread,
561  * (where notmuch_threads_valid will return FALSE and
562  * notmuch_threads_get will return NULL).
563  *
564  * See the documentation of notmuch_query_search_threads for example
565  * code showing how to iterate over a notmuch_threads_t object.
566  */
567 void
568 notmuch_threads_move_to_next (notmuch_threads_t *threads);
569
570 /* Destroy a notmuch_threads_t object.
571  *
572  * It's not strictly necessary to call this function. All memory from
573  * the notmuch_threads_t object will be reclaimed when the
574  * containing query object is destroyed.
575  */
576 void
577 notmuch_threads_destroy (notmuch_threads_t *threads);
578
579 /* Return an estimate of the number of messages matching a search
580  *
581  * This function performs a search and returns Xapian's best
582  * guess as to number of matching messages.
583  *
584  * If a Xapian exception occurs, this function may return 0 (after
585  * printing a message).
586  */
587 unsigned
588 notmuch_query_count_messages (notmuch_query_t *query);
589  
590 /* Get the thread ID of 'thread'.
591  *
592  * The returned string belongs to 'thread' and as such, should not be
593  * modified by the caller and will only be valid for as long as the
594  * thread is valid, (which is until notmuch_thread_destroy or until
595  * the query from which it derived is destroyed).
596  */
597 const char *
598 notmuch_thread_get_thread_id (notmuch_thread_t *thread);
599
600 /* Get the total number of messages in 'thread'.
601  *
602  * This count consists of all messages in the database belonging to
603  * this thread. Contrast with notmuch_thread_get_matched_messages() .
604  */
605 int
606 notmuch_thread_get_total_messages (notmuch_thread_t *thread);
607
608 /* Get a notmuch_messages_t iterator for the top-level messages in
609  * 'thread'.
610  *
611  * This iterator will not necessarily iterate over all of the messages
612  * in the thread. It will only iterate over the messages in the thread
613  * which are not replies to other messages in the thread.
614  *
615  * To iterate over all messages in the thread, the caller will need to
616  * iterate over the result of notmuch_message_get_replies for each
617  * top-level message (and do that recursively for the resulting
618  * messages, etc.).
619  */
620 notmuch_messages_t *
621 notmuch_thread_get_toplevel_messages (notmuch_thread_t *thread);
622
623 /* Get the number of messages in 'thread' that matched the search.
624  *
625  * This count includes only the messages in this thread that were
626  * matched by the search from which the thread was created. Contrast
627  * with notmuch_thread_get_total_messages() .
628  */
629 int
630 notmuch_thread_get_matched_messages (notmuch_thread_t *thread);
631
632 /* Get the authors of 'thread'
633  *
634  * The returned string is a comma-separated list of the names of the
635  * authors of mail messages in the query results that belong to this
636  * thread.
637  *
638  * The returned string belongs to 'thread' and as such, should not be
639  * modified by the caller and will only be valid for as long as the
640  * thread is valid, (which is until notmuch_thread_destroy or until
641  * the query from which it derived is destroyed).
642  */
643 const char *
644 notmuch_thread_get_authors (notmuch_thread_t *thread);
645
646 /* Get the subject of 'thread'
647  *
648  * The subject is taken from the first message (according to the query
649  * order---see notmuch_query_set_sort) in the query results that
650  * belongs to this thread.
651  *
652  * The returned string belongs to 'thread' and as such, should not be
653  * modified by the caller and will only be valid for as long as the
654  * thread is valid, (which is until notmuch_thread_destroy or until
655  * the query from which it derived is destroyed).
656  */
657 const char *
658 notmuch_thread_get_subject (notmuch_thread_t *thread);
659
660 /* Get the date of the oldest message in 'thread' as a time_t value.
661  */
662 time_t
663 notmuch_thread_get_oldest_date (notmuch_thread_t *thread);
664
665 /* Get the date of the newest message in 'thread' as a time_t value.
666  */
667 time_t
668 notmuch_thread_get_newest_date (notmuch_thread_t *thread);
669
670 /* Get the tags for 'thread', returning a notmuch_tags_t object which
671  * can be used to iterate over all tags.
672  *
673  * Note: In the Notmuch database, tags are stored on individual
674  * messages, not on threads. So the tags returned here will be all
675  * tags of the messages which matched the search and which belong to
676  * this thread.
677  *
678  * The tags object is owned by the thread and as such, will only be
679  * valid for as long as the thread is valid, (for example, until
680  * notmuch_thread_destroy or until the query from which it derived is
681  * destroyed).
682  *
683  * Typical usage might be:
684  *
685  *     notmuch_thread_t *thread;
686  *     notmuch_tags_t *tags;
687  *     const char *tag;
688  *
689  *     thread = notmuch_threads_get (threads);
690  *
691  *     for (tags = notmuch_thread_get_tags (thread);
692  *          notmuch_tags_valid (tags);
693  *          notmuch_result_move_to_next (tags))
694  *     {
695  *         tag = notmuch_tags_get (tags);
696  *         ....
697  *     }
698  *
699  *     notmuch_thread_destroy (thread);
700  *
701  * Note that there's no explicit destructor needed for the
702  * notmuch_tags_t object. (For consistency, we do provide a
703  * notmuch_tags_destroy function, but there's no good reason to call
704  * it if the message is about to be destroyed).
705  */
706 notmuch_tags_t *
707 notmuch_thread_get_tags (notmuch_thread_t *thread);
708
709 /* Destroy a notmuch_thread_t object. */
710 void
711 notmuch_thread_destroy (notmuch_thread_t *thread);
712
713 /* Is the given 'messages' iterator pointing at a valid message.
714  *
715  * When this function returns TRUE, notmuch_messages_get will return a
716  * valid object. Whereas when this function returns FALSE,
717  * notmuch_messages_get will return NULL.
718  *
719  * See the documentation of notmuch_query_search_messages for example
720  * code showing how to iterate over a notmuch_messages_t object.
721  */
722 notmuch_bool_t
723 notmuch_messages_valid (notmuch_messages_t *messages);
724
725 /* Get the current message from 'messages' as a notmuch_message_t.
726  *
727  * Note: The returned message belongs to 'messages' and has a lifetime
728  * identical to it (and the query to which it belongs).
729  *
730  * See the documentation of notmuch_query_search_messages for example
731  * code showing how to iterate over a notmuch_messages_t object.
732  *
733  * If an out-of-memory situation occurs, this function will return
734  * NULL.
735  */
736 notmuch_message_t *
737 notmuch_messages_get (notmuch_messages_t *messages);
738
739 /* Move the 'messages' iterator to the next message.
740  *
741  * If 'messages' is already pointing at the last message then the
742  * iterator will be moved to a point just beyond that last message,
743  * (where notmuch_messages_valid will return FALSE and
744  * notmuch_messages_get will return NULL).
745  *
746  * See the documentation of notmuch_query_search_messages for example
747  * code showing how to iterate over a notmuch_messages_t object.
748  */
749 void
750 notmuch_messages_move_to_next (notmuch_messages_t *messages);
751
752 /* Destroy a notmuch_messages_t object.
753  *
754  * It's not strictly necessary to call this function. All memory from
755  * the notmuch_messages_t object will be reclaimed when the containing
756  * query object is destroyed.
757  */
758 void
759 notmuch_messages_destroy (notmuch_messages_t *messages);
760
761 /* Return a list of tags from all messages.
762  *
763  * The resulting list is guaranteed not to contain duplicated tags.
764  *
765  * WARNING: You can no longer iterate over messages after calling this
766  * function, because the iterator will point at the end of the list.
767  * We do not have a function to reset the iterator yet and the only
768  * way how you can iterate over the list again is to recreate the
769  * message list.
770  *
771  * The function returns NULL on error.
772  */
773 notmuch_tags_t *
774 notmuch_messages_collect_tags (notmuch_messages_t *messages);
775
776 /* Get the message ID of 'message'.
777  *
778  * The returned string belongs to 'message' and as such, should not be
779  * modified by the caller and will only be valid for as long as the
780  * message is valid, (which is until the query from which it derived
781  * is destroyed).
782  *
783  * This function will not return NULL since Notmuch ensures that every
784  * message has a unique message ID, (Notmuch will generate an ID for a
785  * message if the original file does not contain one).
786  */
787 const char *
788 notmuch_message_get_message_id (notmuch_message_t *message);
789
790 /* Get the thread ID of 'message'.
791  *
792  * The returned string belongs to 'message' and as such, should not be
793  * modified by the caller and will only be valid for as long as the
794  * message is valid, (for example, until the user calls
795  * notmuch_message_destroy on 'message' or until a query from which it
796  * derived is destroyed).
797  *
798  * This function will not return NULL since Notmuch ensures that every
799  * message belongs to a single thread.
800  */
801 const char *
802 notmuch_message_get_thread_id (notmuch_message_t *message);
803
804 /* Get a notmuch_messages_t iterator for all of the replies to
805  * 'message'.
806  *
807  * Note: This call only makes sense if 'message' was ultimately
808  * obtained from a notmuch_thread_t object, (such as by coming
809  * directly from the result of calling notmuch_thread_get_
810  * toplevel_messages or by any number of subsequent
811  * calls to notmuch_message_get_replies).
812  *
813  * If 'message' was obtained through some non-thread means, (such as
814  * by a call to notmuch_query_search_messages), then this function
815  * will return NULL.
816  *
817  * If there are no replies to 'message', this function will return
818  * NULL. (Note that notmuch_messages_valid will accept that NULL
819  * value as legitimate, and simply return FALSE for it.)
820  */
821 notmuch_messages_t *
822 notmuch_message_get_replies (notmuch_message_t *message);
823
824 /* Get a filename for the email corresponding to 'message'.
825  *
826  * The returned filename is an absolute filename, (the initial
827  * component will match notmuch_database_get_path() ).
828  *
829  * The returned string belongs to the message so should not be
830  * modified or freed by the caller (nor should it be referenced after
831  * the message is destroyed).
832  *
833  * Note: If this message corresponds to multiple files in the mail
834  * store, (that is, multiple files contain identical message IDs),
835  * this function will arbitrarily return a single one of those
836  * filenames. See notmuch_message_get_filenames for returning the
837  * complete list of filenames.
838  */
839 const char *
840 notmuch_message_get_filename (notmuch_message_t *message);
841
842 /* Get all filenames for the email corresponding to 'message'.
843  *
844  * Returns a notmuch_filenames_t iterator listing all the filenames
845  * associated with 'message'. These files may not have identical
846  * content, but each will have the identical Message-ID.
847  *
848  * Each filename in the iterator is an absolute filename, (the initial
849  * component will match notmuch_database_get_path() ).
850  */
851 notmuch_filenames_t *
852 notmuch_message_get_filenames (notmuch_message_t *message);
853
854 /* Message flags */
855 typedef enum _notmuch_message_flag {
856     NOTMUCH_MESSAGE_FLAG_MATCH
857 } notmuch_message_flag_t;
858
859 /* Get a value of a flag for the email corresponding to 'message'. */
860 notmuch_bool_t
861 notmuch_message_get_flag (notmuch_message_t *message,
862                           notmuch_message_flag_t flag);
863
864 /* Set a value of a flag for the email corresponding to 'message'. */
865 void
866 notmuch_message_set_flag (notmuch_message_t *message,
867                           notmuch_message_flag_t flag, notmuch_bool_t value);
868
869 /* Get the date of 'message' as a time_t value.
870  *
871  * For the original textual representation of the Date header from the
872  * message call notmuch_message_get_header() with a header value of
873  * "date". */
874 time_t
875 notmuch_message_get_date  (notmuch_message_t *message);
876
877 /* Get the value of the specified header from 'message'.
878  *
879  * The value will be read from the actual message file, not from the
880  * notmuch database. The header name is case insensitive.
881  *
882  * The returned string belongs to the message so should not be
883  * modified or freed by the caller (nor should it be referenced after
884  * the message is destroyed).
885  *
886  * Returns an empty string ("") if the message does not contain a
887  * header line matching 'header'. Returns NULL if any error occurs.
888  */
889 const char *
890 notmuch_message_get_header (notmuch_message_t *message, const char *header);
891
892 /* Get the tags for 'message', returning a notmuch_tags_t object which
893  * can be used to iterate over all tags.
894  *
895  * The tags object is owned by the message and as such, will only be
896  * valid for as long as the message is valid, (which is until the
897  * query from which it derived is destroyed).
898  *
899  * Typical usage might be:
900  *
901  *     notmuch_message_t *message;
902  *     notmuch_tags_t *tags;
903  *     const char *tag;
904  *
905  *     message = notmuch_database_find_message (database, message_id);
906  *
907  *     for (tags = notmuch_message_get_tags (message);
908  *          notmuch_tags_valid (tags);
909  *          notmuch_result_move_to_next (tags))
910  *     {
911  *         tag = notmuch_tags_get (tags);
912  *         ....
913  *     }
914  *
915  *     notmuch_message_destroy (message);
916  *
917  * Note that there's no explicit destructor needed for the
918  * notmuch_tags_t object. (For consistency, we do provide a
919  * notmuch_tags_destroy function, but there's no good reason to call
920  * it if the message is about to be destroyed).
921  */
922 notmuch_tags_t *
923 notmuch_message_get_tags (notmuch_message_t *message);
924
925 /* The longest possible tag value. */
926 #define NOTMUCH_TAG_MAX 200
927
928 /* Add a tag to the given message.
929  *
930  * Return value:
931  *
932  * NOTMUCH_STATUS_SUCCESS: Tag successfully added to message
933  *
934  * NOTMUCH_STATUS_NULL_POINTER: The 'tag' argument is NULL
935  *
936  * NOTMUCH_STATUS_TAG_TOO_LONG: The length of 'tag' is too long
937  *      (exceeds NOTMUCH_TAG_MAX)
938  *
939  * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
940  *      mode so message cannot be modified.
941  */
942 notmuch_status_t
943 notmuch_message_add_tag (notmuch_message_t *message, const char *tag);
944
945 /* Remove a tag from the given message.
946  *
947  * Return value:
948  *
949  * NOTMUCH_STATUS_SUCCESS: Tag successfully removed from message
950  *
951  * NOTMUCH_STATUS_NULL_POINTER: The 'tag' argument is NULL
952  *
953  * NOTMUCH_STATUS_TAG_TOO_LONG: The length of 'tag' is too long
954  *      (exceeds NOTMUCH_TAG_MAX)
955  *
956  * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
957  *      mode so message cannot be modified.
958  */
959 notmuch_status_t
960 notmuch_message_remove_tag (notmuch_message_t *message, const char *tag);
961
962 /* Remove all tags from the given message.
963  *
964  * See notmuch_message_freeze for an example showing how to safely
965  * replace tag values.
966  *
967  * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
968  *      mode so message cannot be modified.
969  */
970 notmuch_status_t
971 notmuch_message_remove_all_tags (notmuch_message_t *message);
972
973 /* Add/remove tags according to maildir flags in the message filename(s)
974  *
975  * This function examines the filenames of 'message' for maildir
976  * flags, and adds or removes tags on 'message' as follows when these
977  * flags are present:
978  *
979  *      Flag    Action if present
980  *      ----    -----------------
981  *      'D'     Adds the "draft" tag to the message
982  *      'F'     Adds the "flagged" tag to the message
983  *      'P'     Adds the "passed" tag to the message
984  *      'R'     Adds the "replied" tag to the message
985  *      'S'     Removes the "unread" tag from the message
986  *
987  * For each flag that is not present, the opposite action (add/remove)
988  * is performed for the corresponding tags.
989  *
990  * Flags are identified as trailing components of the filename after a
991  * sequence of ":2,".
992  *
993  * If there are multiple filenames associated with this message, the
994  * flag is considered present if it appears in one or more
995  * filenames. (That is, the flags from the multiple filenames are
996  * combined with the logical OR operator.)
997  *
998  * A client can ensure that notmuch database tags remain synchronized
999  * with maildir flags by calling this function after each call to
1000  * notmuch_database_add_message. See also
1001  * notmuch_message_tags_to_maildir_flags for synchronizing tag changes
1002  * back to maildir flags.
1003  */
1004 notmuch_status_t
1005 notmuch_message_maildir_flags_to_tags (notmuch_message_t *message);
1006
1007 /* Rename message filename(s) to encode tags as maildir flags
1008  *
1009  * Specifically, for each filename corresponding to this message:
1010  *
1011  * If the filename is not in a maildir directory, do nothing.  (A
1012  * maildir directory is determined as a directory named "new" or
1013  * "cur".) Similarly, if the filename has invalid maildir info,
1014  * (repeated or outof-ASCII-order flag characters after ":2,"), then
1015  * do nothing.
1016  *
1017  * If the filename is in a maildir directory, rename the file so that
1018  * its filename ends with the sequence ":2," followed by zero or more
1019  * of the following single-character flags (in ASCII order):
1020  *
1021  *   'D' iff the message has the "draft" tag
1022  *   'F' iff the message has the "flagged" tag
1023  *   'P' iff the message has the "passed" tag
1024  *   'R' iff the message has the "replied" tag
1025  *   'S' iff the message does not have the "unread" tag
1026  *
1027  * Any existing flags unmentioned in the list above will be preserved
1028  * in the renaming.
1029  *
1030  * Also, if this filename is in a directory named "new", rename it to
1031  * be within the neighboring directory named "cur".
1032  *
1033  * A client can ensure that maildir filename flags remain synchronized
1034  * with notmuch database tags by calling this function after changing
1035  * tags, (after calls to notmuch_message_add_tag,
1036  * notmuch_message_remove_tag, or notmuch_message_freeze/
1037  * notmuch_message_thaw). See also notmuch_message_maildir_flags_to_tags
1038  * for synchronizing maildir flag changes back to tags.
1039  */
1040 notmuch_status_t
1041 notmuch_message_tags_to_maildir_flags (notmuch_message_t *message);
1042
1043 /* Freeze the current state of 'message' within the database.
1044  *
1045  * This means that changes to the message state, (via
1046  * notmuch_message_add_tag, notmuch_message_remove_tag, and
1047  * notmuch_message_remove_all_tags), will not be committed to the
1048  * database until the message is thawed with notmuch_message_thaw.
1049  *
1050  * Multiple calls to freeze/thaw are valid and these calls will
1051  * "stack". That is there must be as many calls to thaw as to freeze
1052  * before a message is actually thawed.
1053  *
1054  * The ability to do freeze/thaw allows for safe transactions to
1055  * change tag values. For example, explicitly setting a message to
1056  * have a given set of tags might look like this:
1057  *
1058  *    notmuch_message_freeze (message);
1059  *
1060  *    notmuch_message_remove_all_tags (message);
1061  *
1062  *    for (i = 0; i < NUM_TAGS; i++)
1063  *        notmuch_message_add_tag (message, tags[i]);
1064  *
1065  *    notmuch_message_thaw (message);
1066  *
1067  * With freeze/thaw used like this, the message in the database is
1068  * guaranteed to have either the full set of original tag values, or
1069  * the full set of new tag values, but nothing in between.
1070  *
1071  * Imagine the example above without freeze/thaw and the operation
1072  * somehow getting interrupted. This could result in the message being
1073  * left with no tags if the interruption happened after
1074  * notmuch_message_remove_all_tags but before notmuch_message_add_tag.
1075  *
1076  * Return value:
1077  *
1078  * NOTMUCH_STATUS_SUCCESS: Message successfully frozen.
1079  *
1080  * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
1081  *      mode so message cannot be modified.
1082  */
1083 notmuch_status_t
1084 notmuch_message_freeze (notmuch_message_t *message);
1085
1086 /* Thaw the current 'message', synchronizing any changes that may have
1087  * occurred while 'message' was frozen into the notmuch database.
1088  *
1089  * See notmuch_message_freeze for an example of how to use this
1090  * function to safely provide tag changes.
1091  *
1092  * Multiple calls to freeze/thaw are valid and these calls with
1093  * "stack". That is there must be as many calls to thaw as to freeze
1094  * before a message is actually thawed.
1095  *
1096  * Return value:
1097  *
1098  * NOTMUCH_STATUS_SUCCESS: Message successfully thawed, (or at least
1099  *      its frozen count has successfully been reduced by 1).
1100  *
1101  * NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW: An attempt was made to thaw
1102  *      an unfrozen message. That is, there have been an unbalanced
1103  *      number of calls to notmuch_message_freeze and
1104  *      notmuch_message_thaw.
1105  */
1106 notmuch_status_t
1107 notmuch_message_thaw (notmuch_message_t *message);
1108
1109 /* Destroy a notmuch_message_t object.
1110  *
1111  * It can be useful to call this function in the case of a single
1112  * query object with many messages in the result, (such as iterating
1113  * over the entire database). Otherwise, it's fine to never call this
1114  * function and there will still be no memory leaks. (The memory from
1115  * the messages get reclaimed when the containing query is destroyed.)
1116  */
1117 void
1118 notmuch_message_destroy (notmuch_message_t *message);
1119
1120 /* Is the given 'tags' iterator pointing at a valid tag.
1121  *
1122  * When this function returns TRUE, notmuch_tags_get will return a
1123  * valid string. Whereas when this function returns FALSE,
1124  * notmuch_tags_get will return NULL.
1125  *
1126  * See the documentation of notmuch_message_get_tags for example code
1127  * showing how to iterate over a notmuch_tags_t object.
1128  */
1129 notmuch_bool_t
1130 notmuch_tags_valid (notmuch_tags_t *tags);
1131
1132 /* Get the current tag from 'tags' as a string.
1133  *
1134  * Note: The returned string belongs to 'tags' and has a lifetime
1135  * identical to it (and the query to which it ultimately belongs).
1136  *
1137  * See the documentation of notmuch_message_get_tags for example code
1138  * showing how to iterate over a notmuch_tags_t object.
1139  */
1140 const char *
1141 notmuch_tags_get (notmuch_tags_t *tags);
1142
1143 /* Move the 'tags' iterator to the next tag.
1144  *
1145  * If 'tags' is already pointing at the last tag then the iterator
1146  * will be moved to a point just beyond that last tag, (where
1147  * notmuch_tags_valid will return FALSE and notmuch_tags_get will
1148  * return NULL).
1149  *
1150  * See the documentation of notmuch_message_get_tags for example code
1151  * showing how to iterate over a notmuch_tags_t object.
1152  */
1153 void
1154 notmuch_tags_move_to_next (notmuch_tags_t *tags);
1155
1156 /* Destroy a notmuch_tags_t object.
1157  *
1158  * It's not strictly necessary to call this function. All memory from
1159  * the notmuch_tags_t object will be reclaimed when the containing
1160  * message or query objects are destroyed.
1161  */
1162 void
1163 notmuch_tags_destroy (notmuch_tags_t *tags);
1164
1165 /* Store an mtime within the database for 'directory'.
1166  *
1167  * The 'directory' should be an object retrieved from the database
1168  * with notmuch_database_get_directory for a particular path.
1169  *
1170  * The intention is for the caller to use the mtime to allow efficient
1171  * identification of new messages to be added to the database. The
1172  * recommended usage is as follows:
1173  *
1174  *   o Read the mtime of a directory from the filesystem
1175  *
1176  *   o Call add_message for all mail files in the directory
1177  *
1178  *   o Call notmuch_directory_set_mtime with the mtime read from the
1179  *     filesystem.
1180  *
1181  * Then, when wanting to check for updates to the directory in the
1182  * future, the client can call notmuch_directory_get_mtime and know
1183  * that it only needs to add files if the mtime of the directory and
1184  * files are newer than the stored timestamp.
1185  *
1186  * Note: The notmuch_directory_get_mtime function does not allow the
1187  * caller to distinguish a timestamp of 0 from a non-existent
1188  * timestamp. So don't store a timestamp of 0 unless you are
1189  * comfortable with that.
1190  *
1191  * Return value:
1192  *
1193  * NOTMUCH_STATUS_SUCCESS: mtime successfully stored in database.
1194  *
1195  * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception
1196  *      occurred, mtime not stored.
1197  *
1198  * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
1199  *      mode so directory mtime cannot be modified.
1200  */
1201 notmuch_status_t
1202 notmuch_directory_set_mtime (notmuch_directory_t *directory,
1203                              time_t mtime);
1204
1205 /* Get the mtime of a directory, (as previously stored with
1206  * notmuch_directory_set_mtime).
1207  *
1208  * Returns 0 if no mtime has previously been stored for this
1209  * directory.*/
1210 time_t
1211 notmuch_directory_get_mtime (notmuch_directory_t *directory);
1212
1213 /* Get a notmuch_filenames_t iterator listing all the filenames of
1214  * messages in the database within the given directory.
1215  *
1216  * The returned filenames will be the basename-entries only (not
1217  * complete paths). */
1218 notmuch_filenames_t *
1219 notmuch_directory_get_child_files (notmuch_directory_t *directory);
1220
1221 /* Get a notmuch_filenams_t iterator listing all the filenames of
1222  * sub-directories in the database within the given directory.
1223  *
1224  * The returned filenames will be the basename-entries only (not
1225  * complete paths). */
1226 notmuch_filenames_t *
1227 notmuch_directory_get_child_directories (notmuch_directory_t *directory);
1228
1229 /* Destroy a notmuch_directory_t object. */
1230 void
1231 notmuch_directory_destroy (notmuch_directory_t *directory);
1232
1233 /* Is the given 'filenames' iterator pointing at a valid filename.
1234  *
1235  * When this function returns TRUE, notmuch_filenames_get will return
1236  * a valid string. Whereas when this function returns FALSE,
1237  * notmuch_filenames_get will return NULL.
1238  *
1239  * It is acceptable to pass NULL for 'filenames', in which case this
1240  * function will always return FALSE.
1241  */
1242 notmuch_bool_t
1243 notmuch_filenames_valid (notmuch_filenames_t *filenames);
1244
1245 /* Get the current filename from 'filenames' as a string.
1246  *
1247  * Note: The returned string belongs to 'filenames' and has a lifetime
1248  * identical to it (and the directory to which it ultimately belongs).
1249  *
1250  * It is acceptable to pass NULL for 'filenames', in which case this
1251  * function will always return NULL.
1252  */
1253 const char *
1254 notmuch_filenames_get (notmuch_filenames_t *filenames);
1255
1256 /* Move the 'filenames' iterator to the next filename.
1257  *
1258  * If 'filenames' is already pointing at the last filename then the
1259  * iterator will be moved to a point just beyond that last filename,
1260  * (where notmuch_filenames_valid will return FALSE and
1261  * notmuch_filenames_get will return NULL).
1262  *
1263  * It is acceptable to pass NULL for 'filenames', in which case this
1264  * function will do nothing.
1265  */
1266 void
1267 notmuch_filenames_move_to_next (notmuch_filenames_t *filenames);
1268
1269 /* Destroy a notmuch_filenames_t object.
1270  *
1271  * It's not strictly necessary to call this function. All memory from
1272  * the notmuch_filenames_t object will be reclaimed when the
1273  * containing directory object is destroyed.
1274  *
1275  * It is acceptable to pass NULL for 'filenames', in which case this
1276  * function will do nothing.
1277  */
1278 void
1279 notmuch_filenames_destroy (notmuch_filenames_t *filenames);
1280
1281 NOTMUCH_END_DECLS
1282
1283 #endif