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 * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred
54 * NOTMUCH_STATUS_FILE_NOT_EMAIL: A file was presented that doesn't
55 * appear to be an email message.
57 typedef enum _notmuch_status {
58 NOTMUCH_STATUS_SUCCESS = 0,
59 NOTMUCH_STATUS_XAPIAN_EXCEPTION,
60 NOTMUCH_STATUS_FILE_NOT_EMAIL
63 /* Various opaque data types. For each notmuch_<foo>_t see the various
64 * notmuch_<foo> functions below. */
65 typedef struct _notmuch_database notmuch_database_t;
66 typedef struct _notmuch_query notmuch_query_t;
67 typedef struct _notmuch_results notmuch_results_t;
68 typedef struct _notmuch_message notmuch_message_t;
69 typedef struct _notmuch_tags notmuch_tags_t;
71 /* Create a new, empty notmuch database located at 'path'.
73 * The path should be a top-level directory to a collection of
74 * plain-text email messages (one message per file). This call will
75 * create a new ".notmuch" directory within 'path' where notmuch will
78 * Passing a value of NULL for 'path' will cause notmuch to open the
79 * default database. The default database path can be specified by the
80 * NOTMUCH_BASE environment variable, and is equivalent to
81 * ${HOME}/mail if NOTMUCH_BASE is not set.
83 * After a successful call to notmuch_database_create, the returned
84 * database will be open so the caller should call
85 * notmuch_database_close when finished with it.
87 * The database will not yet have any data in it
88 * (notmuch_database_create itself is a very cheap function). Messages
89 * contained within 'path' can be added to the database by calling
90 * notmuch_database_add_message.
92 * In case of any failure, this function returns NULL, (after printing
93 * an error message on stderr).
96 notmuch_database_create (const char *path);
98 /* Open a an existing notmuch database located at 'path'.
100 * The database should have been created at some time in the past,
101 * (not necessarily by this process), by calling
102 * notmuch_database_create with 'path'.
104 * An existing notmuch database can be identified by the presence of a
105 * directory named ".notmuch" below 'path'.
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 * The caller should call notmuch_database_close when finished with
115 * In case of any failure, this function returns NULL, (after printing
116 * an error message on stderr).
119 notmuch_database_open (const char *path);
121 /* Close the given notmuch database, freeing all associated
122 * resources. See notmuch_database_open. */
124 notmuch_database_close (notmuch_database_t *database);
126 /* Lookup the default database path.
128 * This is the path that will be used by notmuch_database_create and
129 * notmuch_database_open if given a NULL path. Specifically it will be
130 * the value of the NOTMUCH_BASE environment variable if set,
131 * otherwise ${HOME}/mail
133 * Returns a newly allocated string which the caller should free()
134 * when finished with it.
137 notmuch_database_default_path (void);
139 /* Return the database path of the given database.
141 * The return value is a string owned by notmuch so should not be
142 * modified nor freed by the caller. */
144 notmuch_database_get_path (notmuch_database_t *database);
146 /* Add a new message to the given notmuch database.
148 * Here,'filename' should be a path relative to the the path of
149 * 'database' (see notmuch_database_get_path). The file should be a
150 * single mail message (not a multi-message mbox) that is expected to
151 * remain at its current location, (since the notmuch database will
152 * reference the filename, and will not copy the entire contents of
157 * NOTMUCH_STATUS_SUCCESS: Message successfully added to database.
159 * NOTMUCH_STATUS_FILE_NOT_EMAIL: the contents of filename don't look
160 * like an email message. Nothing added to the database.
163 notmuch_database_add_message (notmuch_database_t *database,
164 const char *filename);
166 /* Create a new query for 'database'.
168 * Here, 'database' should be an open database, (see
169 * notmuch_database_open and notmuch_database_create).
171 * For the query string, we'll document the syntax here more
172 * completely in the future, but it's likely to be a specialized
173 * version of the general Xapian query syntax:
175 * http://xapian.org/docs/queryparser.html
177 * As a special case, passing a length-zero string, (that is ""), will
178 * result in a query that returns all messages in the database.
180 * See notmuch_query_set_sort for controlling the order of results and
181 * notmuch_query_search to actually execute the query.
183 * User should call notmuch_query_destroy when finished with this
186 * Will return NULL if insufficient memory is available.
189 notmuch_query_create (notmuch_database_t *database,
190 const char *query_string);
192 /* Sort values for notmuch_query_set_sort */
194 NOTMUCH_SORT_DATE_OLDEST_FIRST,
195 NOTMUCH_SORT_DATE_NEWEST_FIRST,
196 NOTMUCH_SORT_MESSAGE_ID
199 /* Specify the sorting desired for this query. */
201 notmuch_query_set_sort (notmuch_query_t *query, notmuch_sort_t sort);
203 /* Execute a query, returning a notmuch_results_t object which can be
204 * used to iterate over the results. The results object is owned by
205 * the query and as such, will only be valid until notmuch_query_destroy.
207 * Typical usage might be:
209 * notmuch_query_t *query;
210 * notmuch_results_t *results;
212 * query = notmuch_query_create (database, query_string);
214 * for (results = notmuch_query_search (query);
215 * notmuch_results_has_more (results);
216 * notmuch_result_advance (results))
218 * message = notmuch_results_get (results);
222 * notmuch_query_destroy (query);
224 * Note that there's no explicit destructor needed for the
225 * notmuch_results_t object.
227 * (For consistency, we do provide a notmuch_results_destroy function,
228 * but there's no point in calling it if you're about to destroy the
229 * query object as well too---either call will free all the memory of
233 notmuch_query_search (notmuch_query_t *query);
235 /* Destroy a notmuch_query_t along with any associated resources.
237 * This will in turn destroy any notmuch_results_t objects generated
238 * by this query, (and in turn any notmuch_message_t objects generated
239 * from those results, etc.).
242 notmuch_query_destroy (notmuch_query_t *query);
244 /* Does the given notmuch_results_t object contain any more results.
246 * When this function returns TRUE, notmuch_results_get will return a
247 * valid object. Whereas when this function returns FALSE,
248 * notmuch_results_get will return NULL.
250 * See the documentation of notmuch_query_search for example code
251 * showing how to iterate over a notmuch_results_t object.
254 notmuch_results_has_more (notmuch_results_t *results);
256 /* Get the current result from 'results' as a notmuch_message_t.
258 * Note: The returned message belongs to 'results' and has a lifetime
259 * identical to it (and the query to which it belongs).
261 * See the documentation of notmuch_query_search for example code
262 * showing how to iterate over a notmuch_results_t object.
265 notmuch_results_get (notmuch_results_t *results);
267 /* Advance the 'results' iterator to the next result.
269 * See the documentation of notmuch_query_search for example code
270 * showing how to iterate over a notmuch_results_t object.
273 notmuch_results_advance (notmuch_results_t *results);
275 /* Destroy a notmuch_results_t object.
277 * It's not strictly necessary to call this function. All memory from
278 * the notmuch_results_t object will be reclaimed when the containg
279 * query object is destroyed.
282 notmuch_results_destroy (notmuch_results_t *results);
284 /* Get the message ID of 'message'.
286 * The returned string belongs to 'message' and as such, should not be
287 * modified by the caller and will only be valid for as long as the
288 * message is valid, (which is until the query from which it derived
292 notmuch_message_get_message_id (notmuch_message_t *message);
294 /* Get the tags for 'message', returning a notmuch_tags_t object which
295 * can be used to iterate over all tags.
297 * The tags object is owned by the message and as such, will only be
298 * valid for as long as the message is valid, (which is until the
299 * query from which it derived is destroyed).
301 * Typical usage might be:
303 * notmuch_message_t *message;
304 * notmuch_tags_t *tags;
307 * message = notmuch_results_get (results);
309 * for (tags = notmuch_message_get_tags (message);
310 * notmuch_tags_has_more (tags);
311 * notmuch_result_advance (tags))
313 * tag = notmuch_tags_get_string (tags);
317 * Note: If you are finished with a message before its containing
318 * query, you can call notmuch_message_destroy to clean up some memory
319 * sooner. If you don't call it, all the memory will still be
320 * reclaimed when the query is destroyed.
323 notmuch_message_get_tags (notmuch_message_t *message);
325 /* Destroy a notmuch_message_t object.
327 * It can be useful to call this function in the case of a single
328 * query object with many messages in the result, (such as iterating
329 * over the entire database). Otherwise, it's fine to never call this
330 * function and there will still be no memory leaks. (The memory from
331 * the messages get reclaimed when the containing query is destroyed.)
334 notmuch_message_destroy (notmuch_message_t *message);
336 /* Does the given notmuch_tags_t object contain any more results.
338 * When this function returns TRUE, notmuch_tags_get will return a
339 * valid string. Whereas when this function returns FALSE,
340 * notmuch_tags_get will return NULL.
342 * See the documentation of notmuch_message_get_tags for example code
343 * showing how to iterate over a notmuch_tags_t object.
346 notmuch_tags_has_more (notmuch_tags_t *tags);
348 /* Get the current result from 'tags' as a string.
350 * Note: The returned string belongs to 'tags' and has a lifetime
351 * identical to it (and the query to which it utlimately belongs).
353 * See the documentation of notmuch_message_get_tags for example code
354 * showing how to iterate over a notmuch_tags_t object.
357 notmuch_tags_get (notmuch_tags_t *tags);
359 /* Advance the 'tags' iterator to the next tag.
361 * See the documentation of notmuch_message_get_tags for example code
362 * showing how to iterate over a notmuch_tags_t object.
365 notmuch_tags_advance (notmuch_tags_t *results);
367 /* Destroy a notmuch_tags_t object.
369 * It's not strictly necessary to call this function. All memory from
370 * the notmuch_tags_t object will be reclaimed when the containg
371 * message or query objects are destroyed.
374 notmuch_tags_destroy (notmuch_tags_t *tags);