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