1 /* notmuch - Not much of an email library, (just index and search)
3 * Copyright © 2009 Carl Worth
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.
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.
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/ .
18 * Author: Carl Worth <cworth@cworth.org>
25 # define NOTMUCH_BEGIN_DECLS extern "C" {
26 # define NOTMUCH_END_DECLS }
28 # define NOTMUCH_BEGIN_DECLS
29 # define NOTMUCH_END_DECLS
44 typedef int notmuch_bool_t;
46 /* Status codes used for the return values of most functions.
48 * A zero value (NOTMUCH_STATUS_SUCCESS) indicates that the function
49 * completed without error. Any other value indicates an error as
52 * NOTMUCH_STATUS_SUCCESS: No error occurred.
54 * XXX: We don't really want to expose this lame XAPIAN_EXCEPTION
55 * value. Instead we should map to things like DATABASE_LOCKED or
58 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred
60 * NOTMUCH_STATUS_FILE_ERROR: An error occurred trying to read or
61 * write to a file (this could be file not found, permission
64 * NOTMUCH_STATUS_FILE_NOT_EMAIL: A file was presented that doesn't
65 * appear to be an email message.
67 * NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID: A file contains a message ID
68 * that is identical to a message already in the database.
70 * NOTMUCH_STATUS_NULL_POINTER: The user erroneously passed a NULL
71 * pointer to a notmuch function.
73 * NOTMUCH_STATUS_TAG_TOO_LONG: A tag value is too long (exceeds
76 * NOTMUCH_STATUS_LAST_STATUS: Not an actual status value. Just a way
77 * to find out how many valid status values there are.
79 typedef enum _notmuch_status {
80 NOTMUCH_STATUS_SUCCESS = 0,
81 NOTMUCH_STATUS_XAPIAN_EXCEPTION,
82 NOTMUCH_STATUS_FILE_ERROR,
83 NOTMUCH_STATUS_FILE_NOT_EMAIL,
84 NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID,
85 NOTMUCH_STATUS_NULL_POINTER,
86 NOTMUCH_STATUS_TAG_TOO_LONG,
88 NOTMUCH_STATUS_LAST_STATUS
91 /* Get a string representation of a notmuch_status_t value.
93 * The result is readonly.
96 notmuch_status_to_string (notmuch_status_t status);
98 /* Various opaque data types. For each notmuch_<foo>_t see the various
99 * notmuch_<foo> functions below. */
100 typedef struct _notmuch_database notmuch_database_t;
101 typedef struct _notmuch_query notmuch_query_t;
102 typedef struct _notmuch_results notmuch_results_t;
103 typedef struct _notmuch_message notmuch_message_t;
104 typedef struct _notmuch_tags notmuch_tags_t;
105 typedef struct _notmuch_thread_ids notmuch_thread_ids_t;
107 /* Lookup the default database path.
109 * This is the path that will be used by notmuch_database_create and
110 * notmuch_database_open if given a NULL path. Specifically it will be
111 * the value of the NOTMUCH_BASE environment variable if set,
112 * otherwise ${HOME}/mail
114 * Returns a newly allocated string which the caller should free()
115 * when finished with it.
118 notmuch_database_default_path (void);
120 /* Create a new, empty notmuch database located at 'path'.
122 * The path should be a top-level directory to a collection of
123 * plain-text email messages (one message per file). This call will
124 * create a new ".notmuch" directory within 'path' where notmuch will
127 * Passing a value of NULL for 'path' will cause notmuch to open the
128 * default database. The default database path can be specified by the
129 * NOTMUCH_BASE environment variable, and is equivalent to
130 * ${HOME}/mail if NOTMUCH_BASE is not set.
132 * After a successful call to notmuch_database_create, the returned
133 * database will be open so the caller should call
134 * notmuch_database_close when finished with it.
136 * The database will not yet have any data in it
137 * (notmuch_database_create itself is a very cheap function). Messages
138 * contained within 'path' can be added to the database by calling
139 * notmuch_database_add_message.
141 * In case of any failure, this function returns NULL, (after printing
142 * an error message on stderr).
145 notmuch_database_create (const char *path);
147 /* XXX: I think I'd like this to take an extra argument of
148 * notmuch_status_t* for returning a status value on failure. */
150 /* Open a an existing notmuch database located at 'path'.
152 * The database should have been created at some time in the past,
153 * (not necessarily by this process), by calling
154 * notmuch_database_create with 'path'.
156 * An existing notmuch database can be identified by the presence of a
157 * directory named ".notmuch" below 'path'.
159 * Passing a value of NULL for 'path' will cause notmuch to open the
160 * default database. The default database path can be specified by the
161 * NOTMUCH_BASE environment variable, and is equivalent to
162 * ${HOME}/mail if NOTMUCH_BASE is not set.
164 * The caller should call notmuch_database_close when finished with
167 * In case of any failure, this function returns NULL, (after printing
168 * an error message on stderr).
171 notmuch_database_open (const char *path);
173 /* Close the given notmuch database, freeing all associated
174 * resources. See notmuch_database_open. */
176 notmuch_database_close (notmuch_database_t *database);
178 /* Return the database path of the given database.
180 * The return value is a string owned by notmuch so should not be
181 * modified nor freed by the caller. */
183 notmuch_database_get_path (notmuch_database_t *database);
185 /* Store a timestamp within the database.
187 * The Notmuch database will not interpret this key nor the timestamp
188 * values at all. It will merely store them together and return the
189 * timestamp when notmuch_database_get_timestamp is called with the
190 * same value for 'key'.
192 * The intention is for the caller to use the timestamp to allow
193 * efficient identification of new messages to be added to the
194 * database. The recommended usage is as follows:
196 * o Read the mtime of a directory from the filesystem
198 * o Call add_message for all mail files in the directory
200 * o Call notmuch_database_set_timestamp with the path of the
201 * directory as 'key' and the originally read mtime as 'value'.
203 * Then, when wanting to check for updates to the directory in the
204 * future, the client can call notmuch_database_get_timestamp and know
205 * that it only needs to add files if the mtime of the directory and
206 * files are newer than the stored timestamp.
208 * Note: The notmuch_database_get_timestamp function does not allow
209 * the caller to distinguish a timestamp of 0 from a non-existent
210 * timestamp. So don't store a timestamp of 0 unless you are
211 * comfortable with that.
215 * NOTMUCH_STATUS_SUCCESS: Timestamp successfully stored in database.
217 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception
218 * occurred. Timestamp not stored.
221 notmuch_database_set_timestamp (notmuch_database_t *database,
222 const char *key, time_t timestamp);
224 /* Retrieve a timestamp from the database.
226 * Returns the timestamp value previously stored by calling
227 * notmuch_database_set_timestamp with the same value for 'key'.
229 * Returns 0 if no timestamp is stored for 'key' or if any error
230 * occurred querying the database.
233 notmuch_database_get_timestamp (notmuch_database_t *database,
236 /* Add a new message to the given notmuch database.
238 * Here,'filename' should be a path relative to the the path of
239 * 'database' (see notmuch_database_get_path). The file should be a
240 * single mail message (not a multi-message mbox) that is expected to
241 * remain at its current location, (since the notmuch database will
242 * reference the filename, and will not copy the entire contents of
247 * NOTMUCH_STATUS_SUCCESS: Message successfully added to database.
249 * NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID: Message has the same message
250 * ID as another message already in the database. Nothing added
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.
257 * NOTMUCH_STATUS_FILE_NOT_EMAIL: the contents of filename don't look
258 * like an email message. Nothing added to the database.
261 notmuch_database_add_message (notmuch_database_t *database,
262 const char *filename);
264 /* Find a message with the given messsage_id.
266 * If the database contains a message with the given message_id, then
267 * a new notmuch_message_t object is returned. The caller should call
268 * notmuch_message_destroy when done with the message.
270 * If no message is found with the given message_id, this function
274 notmuch_database_find_message (notmuch_database_t *database,
275 const char *message_id);
277 /* Create a new query for 'database'.
279 * Here, 'database' should be an open database, (see
280 * notmuch_database_open and notmuch_database_create).
282 * For the query string, we'll document the syntax here more
283 * completely in the future, but it's likely to be a specialized
284 * version of the general Xapian query syntax:
286 * http://xapian.org/docs/queryparser.html
288 * As a special case, passing a length-zero string, (that is ""), will
289 * result in a query that returns all messages in the database.
291 * See notmuch_query_set_sort for controlling the order of results and
292 * notmuch_query_search to actually execute the query.
294 * User should call notmuch_query_destroy when finished with this
297 * Will return NULL if insufficient memory is available.
300 notmuch_query_create (notmuch_database_t *database,
301 const char *query_string);
303 /* Sort values for notmuch_query_set_sort */
305 NOTMUCH_SORT_DATE_OLDEST_FIRST,
306 NOTMUCH_SORT_DATE_NEWEST_FIRST,
307 NOTMUCH_SORT_MESSAGE_ID
310 /* Specify the sorting desired for this query. */
312 notmuch_query_set_sort (notmuch_query_t *query, notmuch_sort_t sort);
314 /* Execute a query, returning a notmuch_results_t object which can be
315 * used to iterate over the results. The results object is owned by
316 * the query and as such, will only be valid until notmuch_query_destroy.
318 * Typical usage might be:
320 * notmuch_query_t *query;
321 * notmuch_results_t *results;
323 * query = notmuch_query_create (database, query_string);
325 * for (results = notmuch_query_search (query);
326 * notmuch_results_has_more (results);
327 * notmuch_result_advance (results))
329 * message = notmuch_results_get (results);
331 * notmuch_message_destroy (message);
334 * notmuch_query_destroy (query);
336 * Note: If you are finished with a message before its containing
337 * query, you can call notmuch_message_destroy to clean up some memory
338 * sooner (as in the above example). Otherwise, if your message
339 * objects are long-lived, then you don't need to call
340 * notmuch_message_destroy and all the memory will still be reclaimed
341 * when the query is destroyed.
343 * Note that there's no explicit destructor needed for the
344 * notmuch_results_t object. (For consistency, we do provide a
345 * notmuch_results_destroy function, but there's no good reason to
346 * call it if the query is about to be destroyed).
349 notmuch_query_search (notmuch_query_t *query);
351 /* Destroy a notmuch_query_t along with any associated resources.
353 * This will in turn destroy any notmuch_results_t objects generated
354 * by this query, (and in turn any notmuch_message_t objects generated
355 * from those results, etc.).
358 notmuch_query_destroy (notmuch_query_t *query);
360 /* Does the given notmuch_results_t object contain any more results.
362 * When this function returns TRUE, notmuch_results_get will return a
363 * valid object. Whereas when this function returns FALSE,
364 * notmuch_results_get will return NULL.
366 * See the documentation of notmuch_query_search for example code
367 * showing how to iterate over a notmuch_results_t object.
370 notmuch_results_has_more (notmuch_results_t *results);
372 /* Get the current result from 'results' as a notmuch_message_t.
374 * Note: The returned message belongs to 'results' and has a lifetime
375 * identical to it (and the query to which it belongs).
377 * See the documentation of notmuch_query_search for example code
378 * showing how to iterate over a notmuch_results_t object.
381 notmuch_results_get (notmuch_results_t *results);
383 /* Advance the 'results' iterator to the next result.
385 * See the documentation of notmuch_query_search for example code
386 * showing how to iterate over a notmuch_results_t object.
389 notmuch_results_advance (notmuch_results_t *results);
391 /* Destroy a notmuch_results_t object.
393 * It's not strictly necessary to call this function. All memory from
394 * the notmuch_results_t object will be reclaimed when the containg
395 * query object is destroyed.
398 notmuch_results_destroy (notmuch_results_t *results);
400 /* Get the message ID of 'message'.
402 * The returned string belongs to 'message' and as such, should not be
403 * modified by the caller and will only be valid for as long as the
404 * message is valid, (which is until the query from which it derived
407 * This function will not return NULL since Notmuch ensures that every
408 * message has a unique message ID, (Notmuch will generate an ID for a
409 * message if the original file does not contain one).
412 notmuch_message_get_message_id (notmuch_message_t *message);
414 /* Get the filename for the email corresponding to 'message'.
416 * The returned filename is relative to the base of the database from
417 * which 'message' was obtained. See notmuch_database_get_path() .
418 * The returned string belongs to the message so should not be
419 * modified or freed by the caller (nor should it be referenced after
420 * the message is destroyed). */
422 notmuch_message_get_filename (notmuch_message_t *message);
424 /* Get the tags for 'message', returning a notmuch_tags_t object which
425 * can be used to iterate over all tags.
427 * The tags object is owned by the message and as such, will only be
428 * valid for as long as the message is valid, (which is until the
429 * query from which it derived is destroyed).
431 * Typical usage might be:
433 * notmuch_message_t *message;
434 * notmuch_tags_t *tags;
437 * message = notmuch_database_find_message (database, message_id);
439 * for (tags = notmuch_message_get_tags (message);
440 * notmuch_tags_has_more (tags);
441 * notmuch_result_advance (tags))
443 * tag = notmuch_tags_get (tags);
447 * notmuch_message_destroy (message);
449 * Note that there's no explicit destructor needed for the
450 * notmuch_tags_t object. (For consistency, we do provide a
451 * notmuch_tags_destroy function, but there's no good reason to call
452 * it if the message is about to be destroyed).
455 notmuch_message_get_tags (notmuch_message_t *message);
457 /* Get the thread IDs for 'message', returning a notmuch_thread_ids_t
458 * object which can be used to iterate over all thread IDs.
460 * The thread_ids object is owned by the message and as such, will
461 * only be valid for as long as the message is valid, (which is until
462 * the query from which it derived is destroyed).
464 * Typical usage might be:
466 * notmuch_message_t *message;
467 * notmuch_thread_ids_t *thread_ids;
468 * const char *thread_id;
470 * message = notmuch_database_find_message (database, message_id);
472 * for (thread_ids = notmuch_message_get_thread_ids (message);
473 * notmuch_thread_ids_has_more (thread_ids);
474 * notmuch_thread_ids_advance (thread_ids))
476 * thread_id = notmuch_thread_ids_get (thread_ids);
480 * notmuch_message_destroy (message);
482 * Note that there's no explicit destructor needed for the
483 * notmuch_thread_ids_t object. (For consistency, we do provide a
484 * notmuch_thread_ids_destroy function, but there's no good reason to
485 * call it if the message is about to be destroyed).
487 notmuch_thread_ids_t *
488 notmuch_message_get_thread_ids (notmuch_message_t *message);
490 /* The longest possible tag value. */
491 #define NOTMUCH_TAG_MAX 200
493 /* Add a tag to the given message.
497 * NOTMUCH_STATUS_SUCCESS: Tag successfully added to message
499 * NOTMUCH_STATUS_NULL_POINTER: The 'tag' argument is NULL
501 * NOTMUCH_STATUS_TAG_TOO_LONG: The length of 'tag' is longer than
502 * too long (exceeds NOTMUCH_TAG_MAX)
505 notmuch_message_add_tag (notmuch_message_t *message, const char *tag);
507 /* Remove a tag from the given message.
511 * NOTMUCH_STATUS_SUCCESS: Tag successfully added to message
513 * NOTMUCH_STATUS_NULL_POINTER: The 'tag' argument is NULL
515 * NOTMUCH_STATUS_TAG_TOO_LONG: The length of 'tag' is longer than
516 * too long (exceeds NOTMUCH_TAG_MAX)
519 notmuch_message_remove_tag (notmuch_message_t *message, const char *tag);
521 /* Destroy a notmuch_message_t object.
523 * It can be useful to call this function in the case of a single
524 * query object with many messages in the result, (such as iterating
525 * over the entire database). Otherwise, it's fine to never call this
526 * function and there will still be no memory leaks. (The memory from
527 * the messages get reclaimed when the containing query is destroyed.)
530 notmuch_message_destroy (notmuch_message_t *message);
532 /* Does the given notmuch_tags_t object contain any more tags.
534 * When this function returns TRUE, notmuch_tags_get will return a
535 * valid string. Whereas when this function returns FALSE,
536 * notmuch_tags_get will return NULL.
538 * See the documentation of notmuch_message_get_tags for example code
539 * showing how to iterate over a notmuch_tags_t object.
542 notmuch_tags_has_more (notmuch_tags_t *tags);
544 /* Get the current tag from 'tags' as a string.
546 * Note: The returned string belongs to 'tags' and has a lifetime
547 * identical to it (and the query to which it utlimately belongs).
549 * See the documentation of notmuch_message_get_tags for example code
550 * showing how to iterate over a notmuch_tags_t object.
553 notmuch_tags_get (notmuch_tags_t *tags);
555 /* Advance the 'tags' iterator to the next tag.
557 * See the documentation of notmuch_message_get_tags for example code
558 * showing how to iterate over a notmuch_tags_t object.
561 notmuch_tags_advance (notmuch_tags_t *tags);
563 /* Destroy a notmuch_tags_t object.
565 * It's not strictly necessary to call this function. All memory from
566 * the notmuch_tags_t object will be reclaimed when the containg
567 * message or query objects are destroyed.
570 notmuch_tags_destroy (notmuch_tags_t *tags);
572 /* Does the given notmuch_thread_ids_t object contain any more thread IDs.
574 * When this function returns TRUE, notmuch_thread_ids_get will return a
575 * valid string. Whereas when this function returns FALSE,
576 * notmuch_thread_ids_get will return NULL.
578 * See the documentation of notmuch_message_get_thread_ids for example code
579 * showing how to iterate over a notmuch_thread_ids_t object.
582 notmuch_thread_ids_has_more (notmuch_thread_ids_t *thread_ids);
584 /* Get the current thread ID from 'thread_ids' as a string.
586 * Note: The returned string belongs to 'thread_ids' and has a lifetime
587 * identical to it (and the query to which it utlimately belongs).
589 * See the documentation of notmuch_message_get_thread_ids for example code
590 * showing how to iterate over a notmuch_thread_ids_t object.
593 notmuch_thread_ids_get (notmuch_thread_ids_t *thread_ids);
595 /* Advance the 'thread_ids' iterator to the next tag.
597 * See the documentation of notmuch_message_get_thread_ids for example code
598 * showing how to iterate over a notmuch_thread_ids_t object.
601 notmuch_thread_ids_advance (notmuch_thread_ids_t *thread_ids);
603 /* Destroy a notmuch_thread_ids_t object.
605 * It's not strictly necessary to call this function. All memory from
606 * the notmuch_thread_ids_t object will be reclaimed when the containg
607 * message or query objects are destroyed.
610 notmuch_thread_ids_destroy (notmuch_thread_ids_t *thread_ids);