Add an initial implementation of a notmuch_thread_t object.
[notmuch] / 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_XAPIAN_EXCEPTION: A Xapian exception occurred
61  *
62  * NOTMUCH_STATUS_FILE_ERROR: An error occurred trying to read or
63  *      write to a file (this could be file not found, permission
64  *      denied, etc.)
65  *
66  * NOTMUCH_STATUS_FILE_NOT_EMAIL: A file was presented that doesn't
67  *      appear to be an email message.
68  *
69  * NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID: A file contains a message ID
70  *      that is identical to a message already in the database.
71  *
72  * NOTMUCH_STATUS_NULL_POINTER: The user erroneously passed a NULL
73  *      pointer to a notmuch function.
74  *
75  * NOTMUCH_STATUS_TAG_TOO_LONG: A tag value is too long (exceeds
76  *      NOTMUCH_TAG_MAX)
77  *
78  * NOTMUCH_STATUS_LAST_STATUS: Not an actual status value. Just a way
79  *      to find out how many valid status values there are.
80  */
81 typedef enum _notmuch_status {
82     NOTMUCH_STATUS_SUCCESS = 0,
83     NOTMUCH_STATUS_OUT_OF_MEMORY,
84     NOTMUCH_STATUS_XAPIAN_EXCEPTION,
85     NOTMUCH_STATUS_FILE_ERROR,
86     NOTMUCH_STATUS_FILE_NOT_EMAIL,
87     NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID,
88     NOTMUCH_STATUS_NULL_POINTER,
89     NOTMUCH_STATUS_TAG_TOO_LONG,
90
91     NOTMUCH_STATUS_LAST_STATUS
92 } notmuch_status_t;
93
94 /* Get a string representation of a notmuch_status_t value.
95  *
96  * The result is readonly.
97  */
98 const char *
99 notmuch_status_to_string (notmuch_status_t status);
100
101 /* Various opaque data types. For each notmuch_<foo>_t see the various
102  * notmuch_<foo> functions below. */
103 typedef struct _notmuch_database notmuch_database_t;
104 typedef struct _notmuch_query notmuch_query_t;
105 typedef struct _notmuch_thread_results notmuch_thread_results_t;
106 typedef struct _notmuch_thread notmuch_thread_t;
107 typedef struct _notmuch_message_results notmuch_message_results_t;
108 typedef struct _notmuch_message notmuch_message_t;
109 typedef struct _notmuch_tags notmuch_tags_t;
110
111 /* Lookup the default database path.
112  *
113  * This is the path that will be used by notmuch_database_create and
114  * notmuch_database_open if given a NULL path. Specifically it will be
115  * the value of the NOTMUCH_BASE environment variable if set,
116  * otherwise ${HOME}/mail
117  *
118  * Returns a newly allocated string which the caller should free()
119  * when finished with it.
120  */
121 char *
122 notmuch_database_default_path (void);
123
124 /* Create a new, empty notmuch database located at 'path'.
125  *
126  * The path should be a top-level directory to a collection of
127  * plain-text email messages (one message per file). This call will
128  * create a new ".notmuch" directory within 'path' where notmuch will
129  * store its data.
130  *
131  * Passing a value of NULL for 'path' will cause notmuch to open the
132  * default database. The default database path can be specified by the
133  * NOTMUCH_BASE environment variable, and is equivalent to
134  * ${HOME}/mail if NOTMUCH_BASE is not set.
135  *
136  * After a successful call to notmuch_database_create, the returned
137  * database will be open so the caller should call
138  * notmuch_database_close when finished with it.
139  *
140  * The database will not yet have any data in it
141  * (notmuch_database_create itself is a very cheap function). Messages
142  * contained within 'path' can be added to the database by calling
143  * notmuch_database_add_message.
144  *
145  * In case of any failure, this function returns NULL, (after printing
146  * an error message on stderr).
147  */
148 notmuch_database_t *
149 notmuch_database_create (const char *path);
150
151 /* XXX: I think I'd like this to take an extra argument of
152  * notmuch_status_t* for returning a status value on failure. */
153
154 /* Open a an existing notmuch database located at 'path'.
155  *
156  * The database should have been created at some time in the past,
157  * (not necessarily by this process), by calling
158  * notmuch_database_create with 'path'.
159  *
160  * An existing notmuch database can be identified by the presence of a
161  * directory named ".notmuch" below 'path'.
162  *
163  * Passing a value of NULL for 'path' will cause notmuch to open the
164  * default database. The default database path can be specified by the
165  * NOTMUCH_BASE environment variable, and is equivalent to
166  * ${HOME}/mail if NOTMUCH_BASE is not set.
167  *
168  * The caller should call notmuch_database_close when finished with
169  * this database.
170  *
171  * In case of any failure, this function returns NULL, (after printing
172  * an error message on stderr).
173  */
174 notmuch_database_t *
175 notmuch_database_open (const char *path);
176
177 /* Close the given notmuch database, freeing all associated
178  * resources. See notmuch_database_open. */
179 void
180 notmuch_database_close (notmuch_database_t *database);
181
182 /* Return the database path of the given database.
183  *
184  * The return value is a string owned by notmuch so should not be
185  * modified nor freed by the caller. */
186 const char *
187 notmuch_database_get_path (notmuch_database_t *database);
188
189 /* Store a timestamp within the database.
190  *
191  * The Notmuch database will not interpret this key nor the timestamp
192  * values at all. It will merely store them together and return the
193  * timestamp when notmuch_database_get_timestamp is called with the
194  * same value for 'key'.
195  *
196  * The intention is for the caller to use the timestamp to allow
197  * efficient identification of new messages to be added to the
198  * database. The recommended usage is as follows:
199  *
200  *   o Read the mtime of a directory from the filesystem
201  *
202  *   o Call add_message for all mail files in the directory
203  *
204  *   o Call notmuch_database_set_timestamp with the path of the
205  *     directory as 'key' and the originally read mtime as 'value'.
206  *
207  * Then, when wanting to check for updates to the directory in the
208  * future, the client can call notmuch_database_get_timestamp and know
209  * that it only needs to add files if the mtime of the directory and
210  * files are newer than the stored timestamp.
211  *
212  * Note: The notmuch_database_get_timestamp function does not allow
213  * the caller to distinguish a timestamp of 0 from a non-existent
214  * timestamp. So don't store a timestamp of 0 unless you are
215  * comfortable with that.
216  *
217  * Return value:
218  *
219  * NOTMUCH_STATUS_SUCCESS: Timestamp successfully stored in database.
220  *
221  * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception
222  *      occurred. Timestamp not stored.
223  */
224 notmuch_status_t
225 notmuch_database_set_timestamp (notmuch_database_t *database,
226                                 const char *key, time_t timestamp);
227
228 /* Retrieve a timestamp from the database.
229  *
230  * Returns the timestamp value previously stored by calling
231  * notmuch_database_set_timestamp with the same value for 'key'.
232  *
233  * Returns 0 if no timestamp is stored for 'key' or if any error
234  * occurred querying the database.
235  */
236 time_t
237 notmuch_database_get_timestamp (notmuch_database_t *database,
238                                 const char *key);
239
240 /* Add a new message to the given notmuch database.
241  *
242  * Here,'filename' should be a path relative to the the path of
243  * 'database' (see notmuch_database_get_path). The file should be a
244  * single mail message (not a multi-message mbox) that is expected to
245  * remain at its current location, (since the notmuch database will
246  * reference the filename, and will not copy the entire contents of
247  * the file.
248  *
249  * Return value:
250  *
251  * NOTMUCH_STATUS_SUCCESS: Message successfully added to database.
252  *
253  * NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID: Message has the same message
254  *      ID as another message already in the database. Nothing added
255  *      to the database.
256  *
257  * NOTMUCH_STATUS_FILE_ERROR: an error occurred trying to open the
258  *      file, (such as permission denied, or file not found,
259  *      etc.). Nothing added to the database.
260  *
261  * NOTMUCH_STATUS_FILE_NOT_EMAIL: the contents of filename don't look
262  *      like an email message. Nothing added to the database.
263  */
264 notmuch_status_t
265 notmuch_database_add_message (notmuch_database_t *database,
266                               const char *filename);
267
268 /* Find a message with the given messsage_id.
269  *
270  * If the database contains a message with the given message_id, then
271  * a new notmuch_message_t object is returned. The caller should call
272  * notmuch_message_destroy when done with the message.
273  *
274  * If no message is found with the given message_id or if an
275  * out-of-memory situation occurs, this function returns NULL.
276  */
277 notmuch_message_t *
278 notmuch_database_find_message (notmuch_database_t *database,
279                                const char *message_id);
280
281 /* Create a new query for 'database'.
282  *
283  * Here, 'database' should be an open database, (see
284  * notmuch_database_open and notmuch_database_create).
285  *
286  * For the query string, we'll document the syntax here more
287  * completely in the future, but it's likely to be a specialized
288  * version of the general Xapian query syntax:
289  *
290  * http://xapian.org/docs/queryparser.html
291  *
292  * As a special case, passing a length-zero string, (that is ""), will
293  * result in a query that returns all messages in the database.
294  *
295  * See notmuch_query_set_sort for controlling the order of results and
296  * notmuch_query_search to actually execute the query.
297  *
298  * User should call notmuch_query_destroy when finished with this
299  * query.
300  *
301  * Will return NULL if insufficient memory is available.
302  */
303 notmuch_query_t *
304 notmuch_query_create (notmuch_database_t *database,
305                       const char *query_string);
306
307 /* Sort values for notmuch_query_set_sort */
308 typedef enum {
309     NOTMUCH_SORT_DATE_OLDEST_FIRST,
310     NOTMUCH_SORT_DATE_NEWEST_FIRST,
311     NOTMUCH_SORT_MESSAGE_ID
312 } notmuch_sort_t;
313
314 /* Specify the sorting desired for this query. */
315 void
316 notmuch_query_set_sort (notmuch_query_t *query, notmuch_sort_t sort);
317
318 /* Execute a query for threads, returning a notmuch_thread_results_t
319  * object which can be used to iterate over the results. The results
320  * object is owned by the query and as such, will only be valid until
321  * notmuch_query_destroy.
322  *
323  * Typical usage might be:
324  *
325  *     notmuch_query_t *query;
326  *     notmuch_thread_results_t *results;
327  *     notmuch_thread_t *thread;
328  *
329  *     query = notmuch_query_create (database, query_string);
330  *
331  *     for (results = notmuch_query_search_threads (query);
332  *          notmuch_thread_results_has_more (results);
333  *          notmuch_thread_results_advance (results))
334  *     {
335  *         thread = notmuch_thread_results_get (results);
336  *         ....
337  *         notmuch_thread_destroy (thread);
338  *     }
339  *
340  *     notmuch_query_destroy (query);
341  *
342  * Note: If you are finished with a thread before its containing
343  * query, you can call notmuch_thread_destroy to clean up some memory
344  * sooner (as in the above example). Otherwise, if your thread objects
345  * are long-lived, then you don't need to call notmuch_thread_destroy
346  * and all the memory will still be reclaimed when the query is
347  * destroyed.
348  *
349  * Note that there's no explicit destructor needed for the
350  * notmuch_thread_results_t object. (For consistency, we do provide a
351  * notmuch_thread_results_destroy function, but there's no good reason
352  * to call it if the query is about to be destroyed).
353  */
354 notmuch_thread_results_t *
355 notmuch_query_search_threads (notmuch_query_t *query);
356
357 /* Execute a query for messages, returning a notmuch_message_results_t
358  * object which can be used to iterate over the results. The results
359  * object is owned by the query and as such, will only be valid until
360  * notmuch_query_destroy.
361  *
362  * Typical usage might be:
363  *
364  *     notmuch_query_t *query;
365  *     notmuch_message_results_t *results;
366  *     notmuch_message_t *message;
367  *
368  *     query = notmuch_query_create (database, query_string);
369  *
370  *     for (results = notmuch_query_search_messages (query);
371  *          notmuch_message_results_has_more (results);
372  *          notmuch_message_results_advance (results))
373  *     {
374  *         message = notmuch_message_results_get (results);
375  *         ....
376  *         notmuch_message_destroy (message);
377  *     }
378  *
379  *     notmuch_query_destroy (query);
380  *
381  * Note: If you are finished with a message before its containing
382  * query, you can call notmuch_message_destroy to clean up some memory
383  * sooner (as in the above example). Otherwise, if your message
384  * objects are long-lived, then you don't need to call
385  * notmuch_message_destroy and all the memory will still be reclaimed
386  * when the query is destroyed.
387  *
388  * Note that there's no explicit destructor needed for the
389  * notmuch_message_results_t object. (For consistency, we do provide a
390  * notmuch_message_results_destroy function, but there's no good
391  * reason to call it if the query is about to be destroyed).
392  */
393 notmuch_message_results_t *
394 notmuch_query_search_messages (notmuch_query_t *query);
395
396 /* Destroy a notmuch_query_t along with any associated resources.
397  *
398  * This will in turn destroy any notmuch_thread_results_t and
399  * notmuch_message_results_t objects generated by this query, (and in
400  * turn any notmuch_thrad_t and notmuch_message_t objects generated
401  * from those results, etc.), if such objects haven't already been
402  * destroyed.
403  */
404 void
405 notmuch_query_destroy (notmuch_query_t *query);
406
407 /* Does the given notmuch_thread_results_t object contain any more
408  * results.
409  *
410  * When this function returns TRUE, notmuch_thread_results_get will
411  * return a valid object. Whereas when this function returns FALSE,
412  * notmuch_thread_results_get will return NULL.
413  *
414  * See the documentation of notmuch_query_search_threads for example
415  * code showing how to iterate over a notmuch_thread_results_t object.
416  */
417 notmuch_bool_t
418 notmuch_thread_results_has_more (notmuch_thread_results_t *results);
419
420 /* Get the current result from 'results' as a notmuch_thread_t.
421  *
422  * Note: The returned thread belongs to 'results' and has a lifetime
423  * identical to it (and the query to which it belongs).
424  *
425  * See the documentation of notmuch_query_search_threads for example
426  * code showing how to iterate over a notmuch_thread_results_t object.
427  *
428  * If an out-of-memory situation occurs, this function will return
429  * NULL.
430  */
431 notmuch_thread_t *
432 notmuch_thread_results_get (notmuch_thread_results_t *results);
433
434 /* Advance the 'results' iterator to the next result.
435  *
436  * See the documentation of notmuch_query_search_threads for example
437  * code showing how to iterate over a notmuch_thread_results_t object.
438  */
439 void
440 notmuch_thread_results_advance (notmuch_thread_results_t *results);
441
442 /* Destroy a notmuch_thread_results_t object.
443  *
444  * It's not strictly necessary to call this function. All memory from
445  * the notmuch_thread_results_t object will be reclaimed when the
446  * containg query object is destroyed.
447  */
448 void
449 notmuch_thread_results_destroy (notmuch_thread_results_t *results);
450
451 /* Get the thread ID of 'thread'.
452  *
453  * The returned string belongs to 'thread' and as such, should not be
454  * modified by the caller and will only be valid for as long as the
455  * thread is valid, (which is until notmuch_thread_destroy or until
456  * the query from which it derived is destroyed).
457  */
458 const char *
459 notmuch_thread_get_thread_id (notmuch_thread_t *thread);
460
461 /* Destroy a notmuch_thread_t object. */
462 void
463 notmuch_thread_destroy (notmuch_thread_t *thread);
464
465 /* Does the given notmuch_message_results_t object contain any more
466  * results.
467  *
468  * When this function returns TRUE, notmuch_message_results_get will
469  * return a valid object. Whereas when this function returns FALSE,
470  * notmuch_message_results_get will return NULL.
471  *
472  * See the documentation of notmuch_query_search_messages for example
473  * code showing how to iterate over a notmuch_message_results_t
474  * object.
475  */
476 notmuch_bool_t
477 notmuch_message_results_has_more (notmuch_message_results_t *results);
478
479 /* Get the current result from 'results' as a notmuch_message_t.
480  *
481  * Note: The returned message belongs to 'results' and has a lifetime
482  * identical to it (and the query to which it belongs).
483  *
484  * See the documentation of notmuch_query_search_messages for example
485  * code showing how to iterate over a notmuch_message_results_t
486  * object.
487  *
488  * If an out-of-memory situation occurs, this function will return
489  * NULL.
490  */
491 notmuch_message_t *
492 notmuch_message_results_get (notmuch_message_results_t *results);
493
494 /* Advance the 'results' iterator to the next result.
495  *
496  * See the documentation of notmuch_query_search_messages for example
497  * code showing how to iterate over a notmuch_message_results_t
498  * object.
499  */
500 void
501 notmuch_message_results_advance (notmuch_message_results_t *results);
502
503 /* Destroy a notmuch_message_results_t object.
504  *
505  * It's not strictly necessary to call this function. All memory from
506  * the notmuch_message_results_t object will be reclaimed when the
507  * containg query object is destroyed.
508  */
509 void
510 notmuch_message_results_destroy (notmuch_message_results_t *results);
511
512 /* Get the message ID of 'message'.
513  *
514  * The returned string belongs to 'message' and as such, should not be
515  * modified by the caller and will only be valid for as long as the
516  * message is valid, (which is until the query from which it derived
517  * is destroyed).
518  *
519  * This function will not return NULL since Notmuch ensures that every
520  * message has a unique message ID, (Notmuch will generate an ID for a
521  * message if the original file does not contain one).
522  */
523 const char *
524 notmuch_message_get_message_id (notmuch_message_t *message);
525
526 /* Get the thread ID of 'message'.
527  *
528  * The returned string belongs to 'message' and as such, should not be
529  * modified by the caller and will only be valid for as long as the
530  * message is valid, (for example, until the user calls
531  * notmuch_message_destroy on 'message' or until a query from which it
532  * derived is destroyed).
533  *
534  * This function will not return NULL since Notmuch ensures that every
535  * message belongs to a single thread.
536  */
537 const char *
538 notmuch_message_get_thread_id (notmuch_message_t *message);
539
540 /* Get the filename for the email corresponding to 'message'.
541  *
542  * The returned filename is relative to the base of the database from
543  * which 'message' was obtained. See notmuch_database_get_path() .
544  * The returned string belongs to the message so should not be
545  * modified or freed by the caller (nor should it be referenced after
546  * the message is destroyed). */
547 const char *
548 notmuch_message_get_filename (notmuch_message_t *message);
549
550 /* Get the tags for 'message', returning a notmuch_tags_t object which
551  * can be used to iterate over all tags.
552  *
553  * The tags object is owned by the message and as such, will only be
554  * valid for as long as the message is valid, (which is until the
555  * query from which it derived is destroyed).
556  *
557  * Typical usage might be:
558  *
559  *     notmuch_message_t *message;
560  *     notmuch_tags_t *tags;
561  *     const char *tag;
562  *
563  *     message = notmuch_database_find_message (database, message_id);
564  *
565  *     for (tags = notmuch_message_get_tags (message);
566  *          notmuch_tags_has_more (tags);
567  *          notmuch_result_advance (tags))
568  *     {
569  *         tag = notmuch_tags_get (tags);
570  *         ....
571  *     }
572  *
573  *     notmuch_message_destroy (message);
574  *
575  * Note that there's no explicit destructor needed for the
576  * notmuch_tags_t object. (For consistency, we do provide a
577  * notmuch_tags_destroy function, but there's no good reason to call
578  * it if the message is about to be destroyed).
579  */
580 notmuch_tags_t *
581 notmuch_message_get_tags (notmuch_message_t *message);
582
583 /* The longest possible tag value. */
584 #define NOTMUCH_TAG_MAX 200
585
586 /* Add a tag to the given message.
587  *
588  * Return value:
589  *
590  * NOTMUCH_STATUS_SUCCESS: Tag successfully added to message
591  *
592  * NOTMUCH_STATUS_NULL_POINTER: The 'tag' argument is NULL
593  *
594  * NOTMUCH_STATUS_TAG_TOO_LONG: The length of 'tag' is longer than
595  *      too long (exceeds NOTMUCH_TAG_MAX)
596  */
597 notmuch_status_t
598 notmuch_message_add_tag (notmuch_message_t *message, const char *tag);
599
600 /* Remove a tag from the given message.
601  *
602  * Return value:
603  *
604  * NOTMUCH_STATUS_SUCCESS: Tag successfully added to message
605  *
606  * NOTMUCH_STATUS_NULL_POINTER: The 'tag' argument is NULL
607  *
608  * NOTMUCH_STATUS_TAG_TOO_LONG: The length of 'tag' is longer than
609  *      too long (exceeds NOTMUCH_TAG_MAX)
610  */
611 notmuch_status_t
612 notmuch_message_remove_tag (notmuch_message_t *message, const char *tag);
613
614 /* Destroy a notmuch_message_t object.
615  *
616  * It can be useful to call this function in the case of a single
617  * query object with many messages in the result, (such as iterating
618  * over the entire database). Otherwise, it's fine to never call this
619  * function and there will still be no memory leaks. (The memory from
620  * the messages get reclaimed when the containing query is destroyed.)
621  */
622 void
623 notmuch_message_destroy (notmuch_message_t *message);
624
625 /* Does the given notmuch_tags_t object contain any more tags.
626  *
627  * When this function returns TRUE, notmuch_tags_get will return a
628  * valid string. Whereas when this function returns FALSE,
629  * notmuch_tags_get will return NULL.
630  *
631  * See the documentation of notmuch_message_get_tags for example code
632  * showing how to iterate over a notmuch_tags_t object.
633  */
634 notmuch_bool_t
635 notmuch_tags_has_more (notmuch_tags_t *tags);
636
637 /* Get the current tag from 'tags' as a string.
638  *
639  * Note: The returned string belongs to 'tags' and has a lifetime
640  * identical to it (and the query to which it utlimately belongs).
641  *
642  * See the documentation of notmuch_message_get_tags for example code
643  * showing how to iterate over a notmuch_tags_t object.
644  */
645 const char *
646 notmuch_tags_get (notmuch_tags_t *tags);
647
648 /* Advance the 'tags' iterator to the next tag.
649  *
650  * See the documentation of notmuch_message_get_tags for example code
651  * showing how to iterate over a notmuch_tags_t object.
652  */
653 void
654 notmuch_tags_advance (notmuch_tags_t *tags);
655
656 /* Destroy a notmuch_tags_t object.
657  *
658  * It's not strictly necessary to call this function. All memory from
659  * the notmuch_tags_t object will be reclaimed when the containg
660  * message or query objects are destroyed.
661  */
662 void
663 notmuch_tags_destroy (notmuch_tags_t *tags);
664
665 NOTMUCH_END_DECLS
666
667 #endif