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