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_NULL_POINTER: The user erroneously passed a NULL
68 * pointer to a notmuch function.
70 * NOTMUCH_STATUS_TAG_TOO_LONG: A tag value is too long (exceeds
73 * NOTMUCH_STATUS_LAST_STATUS: Not an actual status value. Just a way
74 * to find out how many valid status values there are.
76 typedef enum _notmuch_status {
77 NOTMUCH_STATUS_SUCCESS = 0,
78 NOTMUCH_STATUS_XAPIAN_EXCEPTION,
79 NOTMUCH_STATUS_FILE_ERROR,
80 NOTMUCH_STATUS_FILE_NOT_EMAIL,
81 NOTMUCH_STATUS_NULL_POINTER,
82 NOTMUCH_STATUS_TAG_TOO_LONG,
84 NOTMUCH_STATUS_LAST_STATUS
87 /* Get a string representation of a notmuch_status_t value.
89 * The result is readonly.
92 notmuch_status_to_string (notmuch_status_t status);
94 /* Various opaque data types. For each notmuch_<foo>_t see the various
95 * notmuch_<foo> functions below. */
96 typedef struct _notmuch_database notmuch_database_t;
97 typedef struct _notmuch_query notmuch_query_t;
98 typedef struct _notmuch_results notmuch_results_t;
99 typedef struct _notmuch_message notmuch_message_t;
100 typedef struct _notmuch_tags notmuch_tags_t;
101 typedef struct _notmuch_thread_ids notmuch_thread_ids_t;
103 /* Create a new, empty notmuch database located at 'path'.
105 * The path should be a top-level directory to a collection of
106 * plain-text email messages (one message per file). This call will
107 * create a new ".notmuch" directory within 'path' where notmuch will
110 * Passing a value of NULL for 'path' will cause notmuch to open the
111 * default database. The default database path can be specified by the
112 * NOTMUCH_BASE environment variable, and is equivalent to
113 * ${HOME}/mail if NOTMUCH_BASE is not set.
115 * After a successful call to notmuch_database_create, the returned
116 * database will be open so the caller should call
117 * notmuch_database_close when finished with it.
119 * The database will not yet have any data in it
120 * (notmuch_database_create itself is a very cheap function). Messages
121 * contained within 'path' can be added to the database by calling
122 * notmuch_database_add_message.
124 * In case of any failure, this function returns NULL, (after printing
125 * an error message on stderr).
128 notmuch_database_create (const char *path);
130 /* Open a an existing notmuch database located at 'path'.
132 * The database should have been created at some time in the past,
133 * (not necessarily by this process), by calling
134 * notmuch_database_create with 'path'.
136 * An existing notmuch database can be identified by the presence of a
137 * directory named ".notmuch" below 'path'.
139 * Passing a value of NULL for 'path' will cause notmuch to open the
140 * default database. The default database path can be specified by the
141 * NOTMUCH_BASE environment variable, and is equivalent to
142 * ${HOME}/mail if NOTMUCH_BASE is not set.
144 * The caller should call notmuch_database_close when finished with
147 * In case of any failure, this function returns NULL, (after printing
148 * an error message on stderr).
151 notmuch_database_open (const char *path);
153 /* Close the given notmuch database, freeing all associated
154 * resources. See notmuch_database_open. */
156 notmuch_database_close (notmuch_database_t *database);
158 /* Lookup the default database path.
160 * This is the path that will be used by notmuch_database_create and
161 * notmuch_database_open if given a NULL path. Specifically it will be
162 * the value of the NOTMUCH_BASE environment variable if set,
163 * otherwise ${HOME}/mail
165 * Returns a newly allocated string which the caller should free()
166 * when finished with it.
169 notmuch_database_default_path (void);
171 /* Return the database path of the given database.
173 * The return value is a string owned by notmuch so should not be
174 * modified nor freed by the caller. */
176 notmuch_database_get_path (notmuch_database_t *database);
178 /* Store a timestamp within the database.
180 * The Notmuch database will not interpret this key nor the timestamp
181 * values at all. It will merely store them together and return the
182 * timestamp when notmuch_database_get_timestamp is called with the
183 * same value for 'key'.
185 * The intention is for the caller to use the timestamp to allow
186 * efficient identification of new messages to be added to the
187 * database. The recommended usage is as follows:
189 * o Read the mtime of a directory from the filesystem
191 * o Call add_message for all mail files in the directory
193 * o Call notmuch_database_set_timestamp with the path of the
194 * directory as 'key' and the originally read mtime as 'value'.
196 * Then, when wanting to check for updates to the directory in the
197 * future, the client can call notmuch_database_get_timestamp and know
198 * that it only needs to add files if the mtime of the directory and
199 * files are newer than the stored timestamp.
201 * Note: The notmuch_database_get_timestamp function does not allow
202 * the caller to distinguish a timestamp of 0 from a non-existent
203 * timestamp. So don't store a timestamp of 0 unless you are
204 * comfortable with that.
208 * NOTMUCH_STATUS_SUCCESS: Timestamp successfully stored in database.
210 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception
211 * occurred. Timestamp not stored.
214 notmuch_database_set_timestamp (notmuch_database_t *database,
215 const char *key, time_t timestamp);
217 /* Retrieve a timestamp from the database.
219 * Returns the timestamp value previously stored by calling
220 * notmuch_database_set_timestamp with the same value for 'key'.
222 * Returns 0 if no timestamp is stored for 'key' or if any error
223 * occurred querying the database.
226 notmuch_database_get_timestamp (notmuch_database_t *database,
229 /* Add a new message to the given notmuch database.
231 * Here,'filename' should be a path relative to the the path of
232 * 'database' (see notmuch_database_get_path). The file should be a
233 * single mail message (not a multi-message mbox) that is expected to
234 * remain at its current location, (since the notmuch database will
235 * reference the filename, and will not copy the entire contents of
240 * NOTMUCH_STATUS_SUCCESS: Message successfully added to database.
242 * NOTMUCH_STATUS_FILE_ERROR: an error occurred trying to open the
243 * file, (such as permission denied, or file not found,
244 * etc.). Nothing added to the database.
246 * NOTMUCH_STATUS_FILE_NOT_EMAIL: the contents of filename don't look
247 * like an email message. Nothing added to the database.
250 notmuch_database_add_message (notmuch_database_t *database,
251 const char *filename);
253 /* Find a message with the given messsage_id.
255 * If the database contains a message with the given message_id, then
256 * a new notmuch_message_t object is returned. The caller should call
257 * notmuch_message_destroy when done with the message.
259 * If no message is found with the given message_id, this function
263 notmuch_database_find_message (notmuch_database_t *database,
264 const char *message_id);
266 /* Create a new query for 'database'.
268 * Here, 'database' should be an open database, (see
269 * notmuch_database_open and notmuch_database_create).
271 * For the query string, we'll document the syntax here more
272 * completely in the future, but it's likely to be a specialized
273 * version of the general Xapian query syntax:
275 * http://xapian.org/docs/queryparser.html
277 * As a special case, passing a length-zero string, (that is ""), will
278 * result in a query that returns all messages in the database.
280 * See notmuch_query_set_sort for controlling the order of results and
281 * notmuch_query_search to actually execute the query.
283 * User should call notmuch_query_destroy when finished with this
286 * Will return NULL if insufficient memory is available.
289 notmuch_query_create (notmuch_database_t *database,
290 const char *query_string);
292 /* Sort values for notmuch_query_set_sort */
294 NOTMUCH_SORT_DATE_OLDEST_FIRST,
295 NOTMUCH_SORT_DATE_NEWEST_FIRST,
296 NOTMUCH_SORT_MESSAGE_ID
299 /* Specify the sorting desired for this query. */
301 notmuch_query_set_sort (notmuch_query_t *query, notmuch_sort_t sort);
303 /* Execute a query, returning a notmuch_results_t object which can be
304 * used to iterate over the results. The results object is owned by
305 * the query and as such, will only be valid until notmuch_query_destroy.
307 * Typical usage might be:
309 * notmuch_query_t *query;
310 * notmuch_results_t *results;
312 * query = notmuch_query_create (database, query_string);
314 * for (results = notmuch_query_search (query);
315 * notmuch_results_has_more (results);
316 * notmuch_result_advance (results))
318 * message = notmuch_results_get (results);
320 * notmuch_message_destroy (message);
323 * notmuch_query_destroy (query);
325 * Note: If you are finished with a message before its containing
326 * query, you can call notmuch_message_destroy to clean up some memory
327 * sooner (as in the above example). Otherwise, if your message
328 * objects are long-lived, then you don't need to call
329 * notmuch_message_destroy and all the memory will still be reclaimed
330 * when the query is destroyed.
332 * Note that there's no explicit destructor needed for the
333 * notmuch_results_t object. (For consistency, we do provide a
334 * notmuch_results_destroy function, but there's no good reason to
335 * call it if the query is about to be destroyed).
338 notmuch_query_search (notmuch_query_t *query);
340 /* Destroy a notmuch_query_t along with any associated resources.
342 * This will in turn destroy any notmuch_results_t objects generated
343 * by this query, (and in turn any notmuch_message_t objects generated
344 * from those results, etc.).
347 notmuch_query_destroy (notmuch_query_t *query);
349 /* Does the given notmuch_results_t object contain any more results.
351 * When this function returns TRUE, notmuch_results_get will return a
352 * valid object. Whereas when this function returns FALSE,
353 * notmuch_results_get will return NULL.
355 * See the documentation of notmuch_query_search for example code
356 * showing how to iterate over a notmuch_results_t object.
359 notmuch_results_has_more (notmuch_results_t *results);
361 /* Get the current result from 'results' as a notmuch_message_t.
363 * Note: The returned message belongs to 'results' and has a lifetime
364 * identical to it (and the query to which it belongs).
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_get (notmuch_results_t *results);
372 /* Advance the 'results' iterator to the next result.
374 * See the documentation of notmuch_query_search for example code
375 * showing how to iterate over a notmuch_results_t object.
378 notmuch_results_advance (notmuch_results_t *results);
380 /* Destroy a notmuch_results_t object.
382 * It's not strictly necessary to call this function. All memory from
383 * the notmuch_results_t object will be reclaimed when the containg
384 * query object is destroyed.
387 notmuch_results_destroy (notmuch_results_t *results);
389 /* Get the message ID of 'message'.
391 * The returned string belongs to 'message' and as such, should not be
392 * modified by the caller and will only be valid for as long as the
393 * message is valid, (which is until the query from which it derived
396 * This function will not return NULL since Notmuch ensures that every
397 * message has a unique message ID, (Notmuch will generate an ID for a
398 * message if the original file does not contain one).
401 notmuch_message_get_message_id (notmuch_message_t *message);
403 /* Get this filename for the email corresponding to 'message'.
405 * The returned filename is relative to the base of the database from
406 * which 'message' was obtained. See notmuch_database_get_path() .*/
408 notmuch_message_get_filename (notmuch_message_t *message);
410 /* Get the tags for 'message', returning a notmuch_tags_t object which
411 * can be used to iterate over all tags.
413 * The tags object is owned by the message and as such, will only be
414 * valid for as long as the message is valid, (which is until the
415 * query from which it derived is destroyed).
417 * Typical usage might be:
419 * notmuch_message_t *message;
420 * notmuch_tags_t *tags;
423 * message = notmuch_database_find_message (database, message_id);
425 * for (tags = notmuch_message_get_tags (message);
426 * notmuch_tags_has_more (tags);
427 * notmuch_result_advance (tags))
429 * tag = notmuch_tags_get (tags);
433 * notmuch_message_destroy (message);
435 * Note that there's no explicit destructor needed for the
436 * notmuch_tags_t object. (For consistency, we do provide a
437 * notmuch_tags_destroy function, but there's no good reason to call
438 * it if the message is about to be destroyed).
441 notmuch_message_get_tags (notmuch_message_t *message);
443 /* Get the thread IDs for 'message', returning a notmuch_thread_ids_t
444 * object which can be used to iterate over all thread IDs.
446 * The thread_ids object is owned by the message and as such, will
447 * only be valid for as long as the message is valid, (which is until
448 * the query from which it derived is destroyed).
450 * Typical usage might be:
452 * notmuch_message_t *message;
453 * notmuch_thread_ids_t *thread_ids;
454 * const char *thread_id;
456 * message = notmuch_database_find_message (database, message_id);
458 * for (thread_ids = notmuch_message_get_thread_ids (message);
459 * notmuch_thread_ids_has_more (thread_ids);
460 * notmuch_thread_ids_advance (thread_ids))
462 * thread_id = notmuch_thread_ids_get (thread_ids);
466 * notmuch_message_destroy (message);
468 * Note that there's no explicit destructor needed for the
469 * notmuch_thread_ids_t object. (For consistency, we do provide a
470 * notmuch_thread_ids_destroy function, but there's no good reason to
471 * call it if the message is about to be destroyed).
473 notmuch_thread_ids_t *
474 notmuch_message_get_thread_ids (notmuch_message_t *message);
476 /* The longest possible tag value. */
477 #define NOTMUCH_TAG_MAX 200
479 /* Add a tag to the given message.
483 * NOTMUCH_STATUS_SUCCESS: Tag successfully added to message
485 * NOTMUCH_STATUS_NULL_POINTER: The 'tag' argument is NULL
487 * NOTMUCH_STATUS_TAG_TOO_LONG: The length of 'tag' is longer than
488 * too long (exceeds NOTMUCH_TAG_MAX)
491 notmuch_message_add_tag (notmuch_message_t *message, const char *tag);
493 /* Remove a tag from 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_remove_tag (notmuch_message_t *message, const char *tag);
507 /* Destroy a notmuch_message_t object.
509 * It can be useful to call this function in the case of a single
510 * query object with many messages in the result, (such as iterating
511 * over the entire database). Otherwise, it's fine to never call this
512 * function and there will still be no memory leaks. (The memory from
513 * the messages get reclaimed when the containing query is destroyed.)
516 notmuch_message_destroy (notmuch_message_t *message);
518 /* Does the given notmuch_tags_t object contain any more tags.
520 * When this function returns TRUE, notmuch_tags_get will return a
521 * valid string. Whereas when this function returns FALSE,
522 * notmuch_tags_get will return NULL.
524 * See the documentation of notmuch_message_get_tags for example code
525 * showing how to iterate over a notmuch_tags_t object.
528 notmuch_tags_has_more (notmuch_tags_t *tags);
530 /* Get the current tag from 'tags' as a string.
532 * Note: The returned string belongs to 'tags' and has a lifetime
533 * identical to it (and the query to which it utlimately belongs).
535 * See the documentation of notmuch_message_get_tags for example code
536 * showing how to iterate over a notmuch_tags_t object.
539 notmuch_tags_get (notmuch_tags_t *tags);
541 /* Advance the 'tags' iterator to the next tag.
543 * See the documentation of notmuch_message_get_tags for example code
544 * showing how to iterate over a notmuch_tags_t object.
547 notmuch_tags_advance (notmuch_tags_t *tags);
549 /* Destroy a notmuch_tags_t object.
551 * It's not strictly necessary to call this function. All memory from
552 * the notmuch_tags_t object will be reclaimed when the containg
553 * message or query objects are destroyed.
556 notmuch_tags_destroy (notmuch_tags_t *tags);
558 /* Does the given notmuch_thread_ids_t object contain any more thread IDs.
560 * When this function returns TRUE, notmuch_thread_ids_get will return a
561 * valid string. Whereas when this function returns FALSE,
562 * notmuch_thread_ids_get will return NULL.
564 * See the documentation of notmuch_message_get_thread_ids for example code
565 * showing how to iterate over a notmuch_thread_ids_t object.
568 notmuch_thread_ids_has_more (notmuch_thread_ids_t *thread_ids);
570 /* Get the current thread ID from 'thread_ids' as a string.
572 * Note: The returned string belongs to 'thread_ids' and has a lifetime
573 * identical to it (and the query to which it utlimately belongs).
575 * See the documentation of notmuch_message_get_thread_ids for example code
576 * showing how to iterate over a notmuch_thread_ids_t object.
579 notmuch_thread_ids_get (notmuch_thread_ids_t *thread_ids);
581 /* Advance the 'thread_ids' iterator to the next tag.
583 * See the documentation of notmuch_message_get_thread_ids for example code
584 * showing how to iterate over a notmuch_thread_ids_t object.
587 notmuch_thread_ids_advance (notmuch_thread_ids_t *thread_ids);
589 /* Destroy a notmuch_thread_ids_t object.
591 * It's not strictly necessary to call this function. All memory from
592 * the notmuch_thread_ids_t object will be reclaimed when the containg
593 * message or query objects are destroyed.
596 notmuch_thread_ids_destroy (notmuch_thread_ids_t *thread_ids);