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
42 typedef int notmuch_bool_t;
44 /* Status codes used for the return values of most functions.
46 * A zero value (NOTMUCH_STATUS_SUCCESS) indicates that the function
47 * completed without error. Any other value indicates an error as
50 * NOTMUCH_STATUS_SUCCESS: No error occurred.
52 * XXX: We don't really want to expose this lame XAPIAN_EXCEPTION
53 * value. Instead we should map to things like DATABASE_LOCKED or
56 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred
58 * NOTMUCH_STATUS_FILE_ERROR: An error occurred trying to read or
59 * write to a file (this could be file not found, permission
62 * NOTMUCH_STATUS_FILE_NOT_EMAIL: A file was presented that doesn't
63 * appear to be an email message.
65 * NOTMUCH_STATUS_NULL_POINTER: The user erroneously passed a NULL
66 * pointer to a notmuch function.
68 * NOTMUCH_STATUS_TAG_TOO_LONG: A tag value is too long.
70 * NOTMUCH_STATUS_LAST_STATUS: Not an actual status value. Just a way
71 * to find out how many valid status values there are.
73 typedef enum _notmuch_status {
74 NOTMUCH_STATUS_SUCCESS = 0,
75 NOTMUCH_STATUS_XAPIAN_EXCEPTION,
76 NOTMUCH_STATUS_FILE_ERROR,
77 NOTMUCH_STATUS_FILE_NOT_EMAIL,
78 NOTMUCH_STATUS_NULL_POINTER,
79 NOTMUCH_STATUS_TAG_TOO_LONG,
81 NOTMUCH_STATUS_LAST_STATUS
84 /* Get a string representation of a notmuch_status_t value.
86 * The result is readonly.
89 notmuch_status_to_string (notmuch_status_t status);
91 /* Various opaque data types. For each notmuch_<foo>_t see the various
92 * notmuch_<foo> functions below. */
93 typedef struct _notmuch_database notmuch_database_t;
94 typedef struct _notmuch_query notmuch_query_t;
95 typedef struct _notmuch_results notmuch_results_t;
96 typedef struct _notmuch_message notmuch_message_t;
97 typedef struct _notmuch_tags notmuch_tags_t;
98 typedef struct _notmuch_thread_ids notmuch_thread_ids_t;
100 /* Create a new, empty notmuch database located at 'path'.
102 * The path should be a top-level directory to a collection of
103 * plain-text email messages (one message per file). This call will
104 * create a new ".notmuch" directory within 'path' where notmuch will
107 * Passing a value of NULL for 'path' will cause notmuch to open the
108 * default database. The default database path can be specified by the
109 * NOTMUCH_BASE environment variable, and is equivalent to
110 * ${HOME}/mail if NOTMUCH_BASE is not set.
112 * After a successful call to notmuch_database_create, the returned
113 * database will be open so the caller should call
114 * notmuch_database_close when finished with it.
116 * The database will not yet have any data in it
117 * (notmuch_database_create itself is a very cheap function). Messages
118 * contained within 'path' can be added to the database by calling
119 * notmuch_database_add_message.
121 * In case of any failure, this function returns NULL, (after printing
122 * an error message on stderr).
125 notmuch_database_create (const char *path);
127 /* Open a an existing notmuch database located at 'path'.
129 * The database should have been created at some time in the past,
130 * (not necessarily by this process), by calling
131 * notmuch_database_create with 'path'.
133 * An existing notmuch database can be identified by the presence of a
134 * directory named ".notmuch" below 'path'.
136 * Passing a value of NULL for 'path' will cause notmuch to open the
137 * default database. The default database path can be specified by the
138 * NOTMUCH_BASE environment variable, and is equivalent to
139 * ${HOME}/mail if NOTMUCH_BASE is not set.
141 * The caller should call notmuch_database_close when finished with
144 * In case of any failure, this function returns NULL, (after printing
145 * an error message on stderr).
148 notmuch_database_open (const char *path);
150 /* Close the given notmuch database, freeing all associated
151 * resources. See notmuch_database_open. */
153 notmuch_database_close (notmuch_database_t *database);
155 /* Lookup the default database path.
157 * This is the path that will be used by notmuch_database_create and
158 * notmuch_database_open if given a NULL path. Specifically it will be
159 * the value of the NOTMUCH_BASE environment variable if set,
160 * otherwise ${HOME}/mail
162 * Returns a newly allocated string which the caller should free()
163 * when finished with it.
166 notmuch_database_default_path (void);
168 /* Return the database path of the given database.
170 * The return value is a string owned by notmuch so should not be
171 * modified nor freed by the caller. */
173 notmuch_database_get_path (notmuch_database_t *database);
175 /* Add a new message to the given notmuch database.
177 * Here,'filename' should be a path relative to the the path of
178 * 'database' (see notmuch_database_get_path). The file should be a
179 * single mail message (not a multi-message mbox) that is expected to
180 * remain at its current location, (since the notmuch database will
181 * reference the filename, and will not copy the entire contents of
186 * NOTMUCH_STATUS_SUCCESS: Message successfully added to database.
188 * NOTMUCH_STATUS_FILE_ERROR: an error occurred trying to open the
189 * file, (such as permission denied, or file not found,
190 * etc.). Nothing added to the database.
192 * NOTMUCH_STATUS_FILE_NOT_EMAIL: the contents of filename don't look
193 * like an email message. Nothing added to the database.
196 notmuch_database_add_message (notmuch_database_t *database,
197 const char *filename);
199 /* Find a message with the given messsage_id.
201 * If the database contains a message with the given message_id, then
202 * a new notmuch_message_t object is returned. The caller should call
203 * notmuch_message_destroy when done with the message.
205 * If no message is found with the given message_id, this function
209 notmuch_database_find_message (notmuch_database_t *database,
210 const char *message_id);
212 /* Create a new query for 'database'.
214 * Here, 'database' should be an open database, (see
215 * notmuch_database_open and notmuch_database_create).
217 * For the query string, we'll document the syntax here more
218 * completely in the future, but it's likely to be a specialized
219 * version of the general Xapian query syntax:
221 * http://xapian.org/docs/queryparser.html
223 * As a special case, passing a length-zero string, (that is ""), will
224 * result in a query that returns all messages in the database.
226 * See notmuch_query_set_sort for controlling the order of results and
227 * notmuch_query_search to actually execute the query.
229 * User should call notmuch_query_destroy when finished with this
232 * Will return NULL if insufficient memory is available.
235 notmuch_query_create (notmuch_database_t *database,
236 const char *query_string);
238 /* Sort values for notmuch_query_set_sort */
240 NOTMUCH_SORT_DATE_OLDEST_FIRST,
241 NOTMUCH_SORT_DATE_NEWEST_FIRST,
242 NOTMUCH_SORT_MESSAGE_ID
245 /* Specify the sorting desired for this query. */
247 notmuch_query_set_sort (notmuch_query_t *query, notmuch_sort_t sort);
249 /* Execute a query, returning a notmuch_results_t object which can be
250 * used to iterate over the results. The results object is owned by
251 * the query and as such, will only be valid until notmuch_query_destroy.
253 * Typical usage might be:
255 * notmuch_query_t *query;
256 * notmuch_results_t *results;
258 * query = notmuch_query_create (database, query_string);
260 * for (results = notmuch_query_search (query);
261 * notmuch_results_has_more (results);
262 * notmuch_result_advance (results))
264 * message = notmuch_results_get (results);
266 * notmuch_message_destroy (message);
269 * notmuch_query_destroy (query);
271 * Note: If you are finished with a message before its containing
272 * query, you can call notmuch_message_destroy to clean up some memory
273 * sooner (as in the above example). Otherwise, if your message
274 * objects are long-lived, then you don't need to call
275 * notmuch_message_destroy and all the memory will still be reclaimed
276 * when the query is destroyed.
278 * Note that there's no explicit destructor needed for the
279 * notmuch_results_t object. (For consistency, we do provide a
280 * notmuch_results_destroy function, but there's no good reason to
281 * call it if the query is about to be destroyed).
284 notmuch_query_search (notmuch_query_t *query);
286 /* Destroy a notmuch_query_t along with any associated resources.
288 * This will in turn destroy any notmuch_results_t objects generated
289 * by this query, (and in turn any notmuch_message_t objects generated
290 * from those results, etc.).
293 notmuch_query_destroy (notmuch_query_t *query);
295 /* Does the given notmuch_results_t object contain any more results.
297 * When this function returns TRUE, notmuch_results_get will return a
298 * valid object. Whereas when this function returns FALSE,
299 * notmuch_results_get will return NULL.
301 * See the documentation of notmuch_query_search for example code
302 * showing how to iterate over a notmuch_results_t object.
305 notmuch_results_has_more (notmuch_results_t *results);
307 /* Get the current result from 'results' as a notmuch_message_t.
309 * Note: The returned message belongs to 'results' and has a lifetime
310 * identical to it (and the query to which it belongs).
312 * See the documentation of notmuch_query_search for example code
313 * showing how to iterate over a notmuch_results_t object.
316 notmuch_results_get (notmuch_results_t *results);
318 /* Advance the 'results' iterator to the next result.
320 * See the documentation of notmuch_query_search for example code
321 * showing how to iterate over a notmuch_results_t object.
324 notmuch_results_advance (notmuch_results_t *results);
326 /* Destroy a notmuch_results_t object.
328 * It's not strictly necessary to call this function. All memory from
329 * the notmuch_results_t object will be reclaimed when the containg
330 * query object is destroyed.
333 notmuch_results_destroy (notmuch_results_t *results);
335 /* Get the message ID of 'message'.
337 * The returned string belongs to 'message' and as such, should not be
338 * modified by the caller and will only be valid for as long as the
339 * message is valid, (which is until the query from which it derived
343 notmuch_message_get_message_id (notmuch_message_t *message);
345 /* Get the tags for 'message', returning a notmuch_tags_t object which
346 * can be used to iterate over all tags.
348 * The tags object is owned by the message and as such, will only be
349 * valid for as long as the message is valid, (which is until the
350 * query from which it derived is destroyed).
352 * Typical usage might be:
354 * notmuch_message_t *message;
355 * notmuch_tags_t *tags;
358 * message = notmuch_database_find_message (database, message_id);
360 * for (tags = notmuch_message_get_tags (message);
361 * notmuch_tags_has_more (tags);
362 * notmuch_result_advance (tags))
364 * tag = notmuch_tags_get (tags);
368 * notmuch_message_destroy (message);
370 * Note that there's no explicit destructor needed for the
371 * notmuch_tags_t object. (For consistency, we do provide a
372 * notmuch_tags_destroy function, but there's no good reason to call
373 * it if the message is about to be destroyed).
376 notmuch_message_get_tags (notmuch_message_t *message);
378 /* Get the thread IDs for 'message', returning a notmuch_thread_ids_t
379 * object which can be used to iterate over all thread IDs.
381 * The thread_ids object is owned by the message and as such, will
382 * only be valid for as long as the message is valid, (which is until
383 * the query from which it derived is destroyed).
385 * Typical usage might be:
387 * notmuch_message_t *message;
388 * notmuch_thread_ids_t *thread_ids;
389 * const char *thread_id;
391 * message = notmuch_database_find_message (database, message_id);
393 * for (thread_ids = notmuch_message_get_thread_ids (message);
394 * notmuch_thread_ids_has_more (thread_ids);
395 * notmuch_thread_ids_advance (thread_ids))
397 * thread_id = notmuch_thread_ids_get (thread_ids);
401 * notmuch_message_destroy (message);
403 * Note that there's no explicit destructor needed for the
404 * notmuch_thread_ids_t object. (For consistency, we do provide a
405 * notmuch_thread_ids_destroy function, but there's no good reason to
406 * call it if the message is about to be destroyed).
408 notmuch_thread_ids_t *
409 notmuch_message_get_thread_ids (notmuch_message_t *message);
411 /* The longest possible tag value. */
412 #define NOTMUCH_TAG_MAX 200
414 /* Add a tag to the given message.
418 * NOTMUCH_STATUS_SUCCESS: Tag successfully added to message
420 * NOTMUCH_STATUS_NULL_POINTER: The 'tag' argument is NULL
422 * NOTMUCH_STATUS_TAG_TOO_LONG: The length of 'tag' is longer than
423 * too long (exceeds NOTMUCH_TAG_MAX)
426 notmuch_message_add_tag (notmuch_message_t *message, const char *tag);
428 /* Remove a tag from the given message.
432 * NOTMUCH_STATUS_SUCCESS: Tag successfully added to message
434 * NOTMUCH_STATUS_NULL_POINTER: The 'tag' argument is NULL
436 * NOTMUCH_STATUS_TAG_TOO_LONG: The length of 'tag' is longer than
437 * too long (exceeds NOTMUCH_TAG_MAX)
440 notmuch_message_remove_tag (notmuch_message_t *message, const char *tag);
442 /* Destroy a notmuch_message_t object.
444 * It can be useful to call this function in the case of a single
445 * query object with many messages in the result, (such as iterating
446 * over the entire database). Otherwise, it's fine to never call this
447 * function and there will still be no memory leaks. (The memory from
448 * the messages get reclaimed when the containing query is destroyed.)
451 notmuch_message_destroy (notmuch_message_t *message);
453 /* Does the given notmuch_tags_t object contain any more tags.
455 * When this function returns TRUE, notmuch_tags_get will return a
456 * valid string. Whereas when this function returns FALSE,
457 * notmuch_tags_get will return NULL.
459 * See the documentation of notmuch_message_get_tags for example code
460 * showing how to iterate over a notmuch_tags_t object.
463 notmuch_tags_has_more (notmuch_tags_t *tags);
465 /* Get the current tag from 'tags' as a string.
467 * Note: The returned string belongs to 'tags' and has a lifetime
468 * identical to it (and the query to which it utlimately belongs).
470 * See the documentation of notmuch_message_get_tags for example code
471 * showing how to iterate over a notmuch_tags_t object.
474 notmuch_tags_get (notmuch_tags_t *tags);
476 /* Advance the 'tags' iterator to the next tag.
478 * See the documentation of notmuch_message_get_tags for example code
479 * showing how to iterate over a notmuch_tags_t object.
482 notmuch_tags_advance (notmuch_tags_t *tags);
484 /* Destroy a notmuch_tags_t object.
486 * It's not strictly necessary to call this function. All memory from
487 * the notmuch_tags_t object will be reclaimed when the containg
488 * message or query objects are destroyed.
491 notmuch_tags_destroy (notmuch_tags_t *tags);
493 /* Does the given notmuch_thread_ids_t object contain any more thread IDs.
495 * When this function returns TRUE, notmuch_thread_ids_get will return a
496 * valid string. Whereas when this function returns FALSE,
497 * notmuch_thread_ids_get will return NULL.
499 * See the documentation of notmuch_message_get_thread_ids for example code
500 * showing how to iterate over a notmuch_thread_ids_t object.
503 notmuch_thread_ids_has_more (notmuch_thread_ids_t *thread_ids);
505 /* Get the current thread ID from 'thread_ids' as a string.
507 * Note: The returned string belongs to 'thread_ids' and has a lifetime
508 * identical to it (and the query to which it utlimately belongs).
510 * See the documentation of notmuch_message_get_thread_ids for example code
511 * showing how to iterate over a notmuch_thread_ids_t object.
514 notmuch_thread_ids_get (notmuch_thread_ids_t *thread_ids);
516 /* Advance the 'thread_ids' iterator to the next tag.
518 * See the documentation of notmuch_message_get_thread_ids for example code
519 * showing how to iterate over a notmuch_thread_ids_t object.
522 notmuch_thread_ids_advance (notmuch_thread_ids_t *thread_ids);
524 /* Destroy a notmuch_thread_ids_t object.
526 * It's not strictly necessary to call this function. All memory from
527 * the notmuch_thread_ids_t object will be reclaimed when the containg
528 * message or query objects are destroyed.
531 notmuch_thread_ids_destroy (notmuch_thread_ids_t *thread_ids);