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