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 * NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory
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
60 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred
62 * NOTMUCH_STATUS_FILE_ERROR: An error occurred trying to read or
63 * write to a file (this could be file not found, permission
66 * NOTMUCH_STATUS_FILE_NOT_EMAIL: A file was presented that doesn't
67 * appear to be an email message.
69 * NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID: A file contains a message ID
70 * that is identical to a message already in the database.
72 * NOTMUCH_STATUS_NULL_POINTER: The user erroneously passed a NULL
73 * pointer to a notmuch function.
75 * NOTMUCH_STATUS_TAG_TOO_LONG: A tag value is too long (exceeds
78 * NOTMUCH_STATUS_LAST_STATUS: Not an actual status value. Just a way
79 * to find out how many valid status values there are.
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,
91 NOTMUCH_STATUS_LAST_STATUS
94 /* Get a string representation of a notmuch_status_t value.
96 * The result is readonly.
99 notmuch_status_to_string (notmuch_status_t status);
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_results notmuch_results_t;
106 typedef struct _notmuch_message notmuch_message_t;
107 typedef struct _notmuch_tags notmuch_tags_t;
108 typedef struct _notmuch_thread_ids notmuch_thread_ids_t;
110 /* Lookup the default database path.
112 * This is the path that will be used by notmuch_database_create and
113 * notmuch_database_open if given a NULL path. Specifically it will be
114 * the value of the NOTMUCH_BASE environment variable if set,
115 * otherwise ${HOME}/mail
117 * Returns a newly allocated string which the caller should free()
118 * when finished with it.
121 notmuch_database_default_path (void);
123 /* Create a new, empty notmuch database located at 'path'.
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
130 * Passing a value of NULL for 'path' will cause notmuch to open the
131 * default database. The default database path can be specified by the
132 * NOTMUCH_BASE environment variable, and is equivalent to
133 * ${HOME}/mail if NOTMUCH_BASE is not set.
135 * After a successful call to notmuch_database_create, the returned
136 * database will be open so the caller should call
137 * notmuch_database_close when finished with it.
139 * The database will not yet have any data in it
140 * (notmuch_database_create itself is a very cheap function). Messages
141 * contained within 'path' can be added to the database by calling
142 * notmuch_database_add_message.
144 * In case of any failure, this function returns NULL, (after printing
145 * an error message on stderr).
148 notmuch_database_create (const char *path);
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. */
153 /* Open a an existing notmuch database located at 'path'.
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'.
159 * An existing notmuch database can be identified by the presence of a
160 * directory named ".notmuch" below 'path'.
162 * Passing a value of NULL for 'path' will cause notmuch to open the
163 * default database. The default database path can be specified by the
164 * NOTMUCH_BASE environment variable, and is equivalent to
165 * ${HOME}/mail if NOTMUCH_BASE is not set.
167 * The caller should call notmuch_database_close when finished with
170 * In case of any failure, this function returns NULL, (after printing
171 * an error message on stderr).
174 notmuch_database_open (const char *path);
176 /* Close the given notmuch database, freeing all associated
177 * resources. See notmuch_database_open. */
179 notmuch_database_close (notmuch_database_t *database);
181 /* Return the database path of the given database.
183 * The return value is a string owned by notmuch so should not be
184 * modified nor freed by the caller. */
186 notmuch_database_get_path (notmuch_database_t *database);
188 /* Store a timestamp within the database.
190 * The Notmuch database will not interpret this key nor the timestamp
191 * values at all. It will merely store them together and return the
192 * timestamp when notmuch_database_get_timestamp is called with the
193 * same value for 'key'.
195 * The intention is for the caller to use the timestamp to allow
196 * efficient identification of new messages to be added to the
197 * database. The recommended usage is as follows:
199 * o Read the mtime of a directory from the filesystem
201 * o Call add_message for all mail files in the directory
203 * o Call notmuch_database_set_timestamp with the path of the
204 * directory as 'key' and the originally read mtime as 'value'.
206 * Then, when wanting to check for updates to the directory in the
207 * future, the client can call notmuch_database_get_timestamp and know
208 * that it only needs to add files if the mtime of the directory and
209 * files are newer than the stored timestamp.
211 * Note: The notmuch_database_get_timestamp function does not allow
212 * the caller to distinguish a timestamp of 0 from a non-existent
213 * timestamp. So don't store a timestamp of 0 unless you are
214 * comfortable with that.
218 * NOTMUCH_STATUS_SUCCESS: Timestamp successfully stored in database.
220 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception
221 * occurred. Timestamp not stored.
224 notmuch_database_set_timestamp (notmuch_database_t *database,
225 const char *key, time_t timestamp);
227 /* Retrieve a timestamp from the database.
229 * Returns the timestamp value previously stored by calling
230 * notmuch_database_set_timestamp with the same value for 'key'.
232 * Returns 0 if no timestamp is stored for 'key' or if any error
233 * occurred querying the database.
236 notmuch_database_get_timestamp (notmuch_database_t *database,
239 /* Add a new message to the given notmuch database.
241 * Here,'filename' should be a path relative to the the path of
242 * 'database' (see notmuch_database_get_path). The file should be a
243 * single mail message (not a multi-message mbox) that is expected to
244 * remain at its current location, (since the notmuch database will
245 * reference the filename, and will not copy the entire contents of
250 * NOTMUCH_STATUS_SUCCESS: Message successfully added to database.
252 * NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID: Message has the same message
253 * ID as another message already in the database. Nothing added
256 * NOTMUCH_STATUS_FILE_ERROR: an error occurred trying to open the
257 * file, (such as permission denied, or file not found,
258 * etc.). Nothing added to the database.
260 * NOTMUCH_STATUS_FILE_NOT_EMAIL: the contents of filename don't look
261 * like an email message. Nothing added to the database.
264 notmuch_database_add_message (notmuch_database_t *database,
265 const char *filename);
267 /* Find a message with the given messsage_id.
269 * If the database contains a message with the given message_id, then
270 * a new notmuch_message_t object is returned. The caller should call
271 * notmuch_message_destroy when done with the message.
273 * If no message is found with the given message_id or if an
274 * out-of-memory situation occurs, this function returns NULL.
277 notmuch_database_find_message (notmuch_database_t *database,
278 const char *message_id);
280 /* Create a new query for 'database'.
282 * Here, 'database' should be an open database, (see
283 * notmuch_database_open and notmuch_database_create).
285 * For the query string, we'll document the syntax here more
286 * completely in the future, but it's likely to be a specialized
287 * version of the general Xapian query syntax:
289 * http://xapian.org/docs/queryparser.html
291 * As a special case, passing a length-zero string, (that is ""), will
292 * result in a query that returns all messages in the database.
294 * See notmuch_query_set_sort for controlling the order of results and
295 * notmuch_query_search to actually execute the query.
297 * User should call notmuch_query_destroy when finished with this
300 * Will return NULL if insufficient memory is available.
303 notmuch_query_create (notmuch_database_t *database,
304 const char *query_string);
306 /* Sort values for notmuch_query_set_sort */
308 NOTMUCH_SORT_DATE_OLDEST_FIRST,
309 NOTMUCH_SORT_DATE_NEWEST_FIRST,
310 NOTMUCH_SORT_MESSAGE_ID
313 /* Specify the sorting desired for this query. */
315 notmuch_query_set_sort (notmuch_query_t *query, notmuch_sort_t sort);
317 /* Execute a query, returning a notmuch_results_t object which can be
318 * used to iterate over the results. The results object is owned by
319 * the query and as such, will only be valid until notmuch_query_destroy.
321 * Typical usage might be:
323 * notmuch_query_t *query;
324 * notmuch_results_t *results;
326 * query = notmuch_query_create (database, query_string);
328 * for (results = notmuch_query_search (query);
329 * notmuch_results_has_more (results);
330 * notmuch_result_advance (results))
332 * message = notmuch_results_get (results);
334 * notmuch_message_destroy (message);
337 * notmuch_query_destroy (query);
339 * Note: If you are finished with a message before its containing
340 * query, you can call notmuch_message_destroy to clean up some memory
341 * sooner (as in the above example). Otherwise, if your message
342 * objects are long-lived, then you don't need to call
343 * notmuch_message_destroy and all the memory will still be reclaimed
344 * when the query is destroyed.
346 * Note that there's no explicit destructor needed for the
347 * notmuch_results_t object. (For consistency, we do provide a
348 * notmuch_results_destroy function, but there's no good reason to
349 * call it if the query is about to be destroyed).
352 notmuch_query_search (notmuch_query_t *query);
354 /* Destroy a notmuch_query_t along with any associated resources.
356 * This will in turn destroy any notmuch_results_t objects generated
357 * by this query, (and in turn any notmuch_message_t objects generated
358 * from those results, etc.).
361 notmuch_query_destroy (notmuch_query_t *query);
363 /* Does the given notmuch_results_t object contain any more results.
365 * When this function returns TRUE, notmuch_results_get will return a
366 * valid object. Whereas when this function returns FALSE,
367 * notmuch_results_get will return NULL.
369 * See the documentation of notmuch_query_search for example code
370 * showing how to iterate over a notmuch_results_t object.
373 notmuch_results_has_more (notmuch_results_t *results);
375 /* Get the current result from 'results' as a notmuch_message_t.
377 * Note: The returned message belongs to 'results' and has a lifetime
378 * identical to it (and the query to which it belongs).
380 * See the documentation of notmuch_query_search for example code
381 * showing how to iterate over a notmuch_results_t object.
383 * If an out-of-memory situation occurs, this function will return
387 notmuch_results_get (notmuch_results_t *results);
389 /* Advance the 'results' iterator to the next result.
391 * See the documentation of notmuch_query_search for example code
392 * showing how to iterate over a notmuch_results_t object.
395 notmuch_results_advance (notmuch_results_t *results);
397 /* Destroy a notmuch_results_t object.
399 * It's not strictly necessary to call this function. All memory from
400 * the notmuch_results_t object will be reclaimed when the containg
401 * query object is destroyed.
404 notmuch_results_destroy (notmuch_results_t *results);
406 /* Get the message ID of 'message'.
408 * The returned string belongs to 'message' and as such, should not be
409 * modified by the caller and will only be valid for as long as the
410 * message is valid, (which is until the query from which it derived
413 * This function will not return NULL since Notmuch ensures that every
414 * message has a unique message ID, (Notmuch will generate an ID for a
415 * message if the original file does not contain one).
418 notmuch_message_get_message_id (notmuch_message_t *message);
420 /* Get the filename for the email corresponding to 'message'.
422 * The returned filename is relative to the base of the database from
423 * which 'message' was obtained. See notmuch_database_get_path() .
424 * The returned string belongs to the message so should not be
425 * modified or freed by the caller (nor should it be referenced after
426 * the message is destroyed). */
428 notmuch_message_get_filename (notmuch_message_t *message);
430 /* Get the tags for 'message', returning a notmuch_tags_t object which
431 * can be used to iterate over all tags.
433 * The tags object is owned by the message and as such, will only be
434 * valid for as long as the message is valid, (which is until the
435 * query from which it derived is destroyed).
437 * Typical usage might be:
439 * notmuch_message_t *message;
440 * notmuch_tags_t *tags;
443 * message = notmuch_database_find_message (database, message_id);
445 * for (tags = notmuch_message_get_tags (message);
446 * notmuch_tags_has_more (tags);
447 * notmuch_result_advance (tags))
449 * tag = notmuch_tags_get (tags);
453 * notmuch_message_destroy (message);
455 * Note that there's no explicit destructor needed for the
456 * notmuch_tags_t object. (For consistency, we do provide a
457 * notmuch_tags_destroy function, but there's no good reason to call
458 * it if the message is about to be destroyed).
461 notmuch_message_get_tags (notmuch_message_t *message);
463 /* Get the thread IDs for 'message', returning a notmuch_thread_ids_t
464 * object which can be used to iterate over all thread IDs.
466 * The thread_ids object is owned by the message and as such, will
467 * only be valid for as long as the message is valid, (which is until
468 * the query from which it derived is destroyed).
470 * Typical usage might be:
472 * notmuch_message_t *message;
473 * notmuch_thread_ids_t *thread_ids;
474 * const char *thread_id;
476 * message = notmuch_database_find_message (database, message_id);
478 * for (thread_ids = notmuch_message_get_thread_ids (message);
479 * notmuch_thread_ids_has_more (thread_ids);
480 * notmuch_thread_ids_advance (thread_ids))
482 * thread_id = notmuch_thread_ids_get (thread_ids);
486 * notmuch_message_destroy (message);
488 * Note that there's no explicit destructor needed for the
489 * notmuch_thread_ids_t object. (For consistency, we do provide a
490 * notmuch_thread_ids_destroy function, but there's no good reason to
491 * call it if the message is about to be destroyed).
493 notmuch_thread_ids_t *
494 notmuch_message_get_thread_ids (notmuch_message_t *message);
496 /* The longest possible tag value. */
497 #define NOTMUCH_TAG_MAX 200
499 /* Add a tag to the given message.
503 * NOTMUCH_STATUS_SUCCESS: Tag successfully added to message
505 * NOTMUCH_STATUS_NULL_POINTER: The 'tag' argument is NULL
507 * NOTMUCH_STATUS_TAG_TOO_LONG: The length of 'tag' is longer than
508 * too long (exceeds NOTMUCH_TAG_MAX)
511 notmuch_message_add_tag (notmuch_message_t *message, const char *tag);
513 /* Remove a tag from the given message.
517 * NOTMUCH_STATUS_SUCCESS: Tag successfully added to message
519 * NOTMUCH_STATUS_NULL_POINTER: The 'tag' argument is NULL
521 * NOTMUCH_STATUS_TAG_TOO_LONG: The length of 'tag' is longer than
522 * too long (exceeds NOTMUCH_TAG_MAX)
525 notmuch_message_remove_tag (notmuch_message_t *message, const char *tag);
527 /* Destroy a notmuch_message_t object.
529 * It can be useful to call this function in the case of a single
530 * query object with many messages in the result, (such as iterating
531 * over the entire database). Otherwise, it's fine to never call this
532 * function and there will still be no memory leaks. (The memory from
533 * the messages get reclaimed when the containing query is destroyed.)
536 notmuch_message_destroy (notmuch_message_t *message);
538 /* Does the given notmuch_tags_t object contain any more tags.
540 * When this function returns TRUE, notmuch_tags_get will return a
541 * valid string. Whereas when this function returns FALSE,
542 * notmuch_tags_get will return NULL.
544 * See the documentation of notmuch_message_get_tags for example code
545 * showing how to iterate over a notmuch_tags_t object.
548 notmuch_tags_has_more (notmuch_tags_t *tags);
550 /* Get the current tag from 'tags' as a string.
552 * Note: The returned string belongs to 'tags' and has a lifetime
553 * identical to it (and the query to which it utlimately belongs).
555 * See the documentation of notmuch_message_get_tags for example code
556 * showing how to iterate over a notmuch_tags_t object.
559 notmuch_tags_get (notmuch_tags_t *tags);
561 /* Advance the 'tags' iterator to the next tag.
563 * See the documentation of notmuch_message_get_tags for example code
564 * showing how to iterate over a notmuch_tags_t object.
567 notmuch_tags_advance (notmuch_tags_t *tags);
569 /* Destroy a notmuch_tags_t object.
571 * It's not strictly necessary to call this function. All memory from
572 * the notmuch_tags_t object will be reclaimed when the containg
573 * message or query objects are destroyed.
576 notmuch_tags_destroy (notmuch_tags_t *tags);
578 /* Does the given notmuch_thread_ids_t object contain any more thread IDs.
580 * When this function returns TRUE, notmuch_thread_ids_get will return a
581 * valid string. Whereas when this function returns FALSE,
582 * notmuch_thread_ids_get will return NULL.
584 * See the documentation of notmuch_message_get_thread_ids for example code
585 * showing how to iterate over a notmuch_thread_ids_t object.
588 notmuch_thread_ids_has_more (notmuch_thread_ids_t *thread_ids);
590 /* Get the current thread ID from 'thread_ids' as a string.
592 * Note: The returned string belongs to 'thread_ids' and has a lifetime
593 * identical to it (and the query to which it utlimately belongs).
595 * See the documentation of notmuch_message_get_thread_ids for example code
596 * showing how to iterate over a notmuch_thread_ids_t object.
599 notmuch_thread_ids_get (notmuch_thread_ids_t *thread_ids);
601 /* Advance the 'thread_ids' iterator to the next tag.
603 * See the documentation of notmuch_message_get_thread_ids for example code
604 * showing how to iterate over a notmuch_thread_ids_t object.
607 notmuch_thread_ids_advance (notmuch_thread_ids_t *thread_ids);
609 /* Destroy a notmuch_thread_ids_t object.
611 * It's not strictly necessary to call this function. All memory from
612 * the notmuch_thread_ids_t object will be reclaimed when the containg
613 * message or query objects are destroyed.
616 notmuch_thread_ids_destroy (notmuch_thread_ids_t *thread_ids);