lib: constify arguments to notmuch_query_get_*
[notmuch] / lib / notmuch.h
1 /* notmuch - Not much of an email library, (just index and search)
2  *
3  * Copyright © 2009 Carl Worth
4  *
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.
9  *
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.
14  *
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/ .
17  *
18  * Author: Carl Worth <cworth@cworth.org>
19  */
20
21 /**
22  * @defgroup notmuch The notmuch API
23  *
24  * Not much of an email library, (just index and search)
25  *
26  * @{
27  */
28
29 #ifndef NOTMUCH_H
30 #define NOTMUCH_H
31
32 #ifndef __DOXYGEN__
33
34 #ifdef  __cplusplus
35 # define NOTMUCH_BEGIN_DECLS  extern "C" {
36 # define NOTMUCH_END_DECLS    }
37 #else
38 # define NOTMUCH_BEGIN_DECLS
39 # define NOTMUCH_END_DECLS
40 #endif
41
42 NOTMUCH_BEGIN_DECLS
43
44 #include <time.h>
45
46 #ifndef FALSE
47 #define FALSE 0
48 #endif
49
50 #ifndef TRUE
51 #define TRUE 1
52 #endif
53
54 /*
55  * The library version number.  This must agree with the soname
56  * version in Makefile.local.
57  */
58 #define LIBNOTMUCH_MAJOR_VERSION        4
59 #define LIBNOTMUCH_MINOR_VERSION        3
60 #define LIBNOTMUCH_MICRO_VERSION        0
61
62 #define NOTMUCH_DEPRECATED(major,minor) \
63     __attribute__ ((deprecated ("function deprecated as of libnotmuch " #major "." #minor)))
64 #endif /* __DOXYGEN__ */
65
66 /**
67  * Check the version of the notmuch library being compiled against.
68  *
69  * Return true if the library being compiled against is of the
70  * specified version or above. For example:
71  *
72  * @code
73  * #if LIBNOTMUCH_CHECK_VERSION(3, 1, 0)
74  *     (code requiring libnotmuch 3.1.0 or above)
75  * #endif
76  * @endcode
77  *
78  * LIBNOTMUCH_CHECK_VERSION has been defined since version 3.1.0; to
79  * check for versions prior to that, use:
80  *
81  * @code
82  * #if !defined(NOTMUCH_CHECK_VERSION)
83  *     (code requiring libnotmuch prior to 3.1.0)
84  * #endif
85  * @endcode
86  */
87 #define LIBNOTMUCH_CHECK_VERSION (major, minor, micro)                  \
88     (LIBNOTMUCH_MAJOR_VERSION > (major) ||                                      \
89      (LIBNOTMUCH_MAJOR_VERSION == (major) && LIBNOTMUCH_MINOR_VERSION > (minor)) || \
90      (LIBNOTMUCH_MAJOR_VERSION == (major) && LIBNOTMUCH_MINOR_VERSION == (minor) && \
91       LIBNOTMUCH_MICRO_VERSION >= (micro)))
92
93 /**
94  * Notmuch boolean type.
95  */
96 typedef int notmuch_bool_t;
97
98 /**
99  * Status codes used for the return values of most functions.
100  *
101  * A zero value (NOTMUCH_STATUS_SUCCESS) indicates that the function
102  * completed without error. Any other value indicates an error.
103  */
104 typedef enum _notmuch_status {
105     /**
106      * No error occurred.
107      */
108     NOTMUCH_STATUS_SUCCESS = 0,
109     /**
110      * Out of memory.
111      */
112     NOTMUCH_STATUS_OUT_OF_MEMORY,
113     /**
114      * An attempt was made to write to a database opened in read-only
115      * mode.
116      */
117     NOTMUCH_STATUS_READ_ONLY_DATABASE,
118     /**
119      * A Xapian exception occurred.
120      */
121     NOTMUCH_STATUS_XAPIAN_EXCEPTION,
122     /**
123      * An error occurred trying to read or write to a file (this could
124      * be file not found, permission denied, etc.)
125      *
126      * @todo We don't really want to expose this lame XAPIAN_EXCEPTION
127      * value. Instead we should map to things like DATABASE_LOCKED or
128      * whatever.
129      */
130     NOTMUCH_STATUS_FILE_ERROR,
131     /**
132      * A file was presented that doesn't appear to be an email
133      * message.
134      */
135     NOTMUCH_STATUS_FILE_NOT_EMAIL,
136     /**
137      * A file contains a message ID that is identical to a message
138      * already in the database.
139      */
140     NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID,
141     /**
142      * The user erroneously passed a NULL pointer to a notmuch
143      * function.
144      */
145     NOTMUCH_STATUS_NULL_POINTER,
146     /**
147      * A tag value is too long (exceeds NOTMUCH_TAG_MAX).
148      */
149     NOTMUCH_STATUS_TAG_TOO_LONG,
150     /**
151      * The notmuch_message_thaw function has been called more times
152      * than notmuch_message_freeze.
153      */
154     NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW,
155     /**
156      * notmuch_database_end_atomic has been called more times than
157      * notmuch_database_begin_atomic.
158      */
159     NOTMUCH_STATUS_UNBALANCED_ATOMIC,
160     /**
161      * The operation is not supported.
162      */
163     NOTMUCH_STATUS_UNSUPPORTED_OPERATION,
164     /**
165      * The operation requires a database upgrade.
166      */
167     NOTMUCH_STATUS_UPGRADE_REQUIRED,
168     /**
169      * There is a problem with the proposed path, e.g. a relative path
170      * passed to a function expecting an absolute path.
171      */
172     NOTMUCH_STATUS_PATH_ERROR,
173     /**
174      * Not an actual status value. Just a way to find out how many
175      * valid status values there are.
176      */
177     NOTMUCH_STATUS_LAST_STATUS
178 } notmuch_status_t;
179
180 /**
181  * Get a string representation of a notmuch_status_t value.
182  *
183  * The result is read-only.
184  */
185 const char *
186 notmuch_status_to_string (notmuch_status_t status);
187
188 /* Various opaque data types. For each notmuch_<foo>_t see the various
189  * notmuch_<foo> functions below. */
190 #ifndef __DOXYGEN__
191 typedef struct _notmuch_database notmuch_database_t;
192 typedef struct _notmuch_query notmuch_query_t;
193 typedef struct _notmuch_threads notmuch_threads_t;
194 typedef struct _notmuch_thread notmuch_thread_t;
195 typedef struct _notmuch_messages notmuch_messages_t;
196 typedef struct _notmuch_message notmuch_message_t;
197 typedef struct _notmuch_tags notmuch_tags_t;
198 typedef struct _notmuch_directory notmuch_directory_t;
199 typedef struct _notmuch_filenames notmuch_filenames_t;
200 #endif /* __DOXYGEN__ */
201
202 /**
203  * Create a new, empty notmuch database located at 'path'.
204  *
205  * The path should be a top-level directory to a collection of
206  * plain-text email messages (one message per file). This call will
207  * create a new ".notmuch" directory within 'path' where notmuch will
208  * store its data.
209  *
210  * After a successful call to notmuch_database_create, the returned
211  * database will be open so the caller should call
212  * notmuch_database_destroy when finished with it.
213  *
214  * The database will not yet have any data in it
215  * (notmuch_database_create itself is a very cheap function). Messages
216  * contained within 'path' can be added to the database by calling
217  * notmuch_database_add_message.
218  *
219  * In case of any failure, this function returns an error status and
220  * sets *database to NULL (after printing an error message on stderr).
221  *
222  * Return value:
223  *
224  * NOTMUCH_STATUS_SUCCESS: Successfully created the database.
225  *
226  * NOTMUCH_STATUS_NULL_POINTER: The given 'path' argument is NULL.
227  *
228  * NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory.
229  *
230  * NOTMUCH_STATUS_FILE_ERROR: An error occurred trying to create the
231  *      database file (such as permission denied, or file not found,
232  *      etc.), or the database already exists.
233  *
234  * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred.
235  */
236 notmuch_status_t
237 notmuch_database_create (const char *path, notmuch_database_t **database);
238
239 /**
240  * Like notmuch_database_create, except optionally return an error
241  * message. This message is allocated by malloc and should be freed by
242  * the caller.
243  */
244 notmuch_status_t
245 notmuch_database_create_verbose (const char *path,
246                                  notmuch_database_t **database,
247                                  char **error_message);
248
249 /**
250  * Database open mode for notmuch_database_open.
251  */
252 typedef enum {
253     /**
254      * Open database for reading only.
255      */
256     NOTMUCH_DATABASE_MODE_READ_ONLY = 0,
257     /**
258      * Open database for reading and writing.
259      */
260     NOTMUCH_DATABASE_MODE_READ_WRITE
261 } notmuch_database_mode_t;
262
263 /**
264  * Open an existing notmuch database located at 'path'.
265  *
266  * The database should have been created at some time in the past,
267  * (not necessarily by this process), by calling
268  * notmuch_database_create with 'path'. By default the database should be
269  * opened for reading only. In order to write to the database you need to
270  * pass the NOTMUCH_DATABASE_MODE_READ_WRITE mode.
271  *
272  * An existing notmuch database can be identified by the presence of a
273  * directory named ".notmuch" below 'path'.
274  *
275  * The caller should call notmuch_database_destroy when finished with
276  * this database.
277  *
278  * In case of any failure, this function returns an error status and
279  * sets *database to NULL (after printing an error message on stderr).
280  *
281  * Return value:
282  *
283  * NOTMUCH_STATUS_SUCCESS: Successfully opened the database.
284  *
285  * NOTMUCH_STATUS_NULL_POINTER: The given 'path' argument is NULL.
286  *
287  * NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory.
288  *
289  * NOTMUCH_STATUS_FILE_ERROR: An error occurred trying to open the
290  *      database file (such as permission denied, or file not found,
291  *      etc.), or the database version is unknown.
292  *
293  * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred.
294  */
295 notmuch_status_t
296 notmuch_database_open (const char *path,
297                        notmuch_database_mode_t mode,
298                        notmuch_database_t **database);
299 /**
300  * Like notmuch_database_open, except optionally return an error
301  * message. This message is allocated by malloc and should be freed by
302  * the caller.
303  */
304
305 notmuch_status_t
306 notmuch_database_open_verbose (const char *path,
307                                notmuch_database_mode_t mode,
308                                notmuch_database_t **database,
309                                char **error_message);
310
311 /**
312  * Retrieve last status string for given database.
313  *
314  */
315 const char *
316 notmuch_database_status_string (const notmuch_database_t *notmuch);
317
318 /**
319  * Commit changes and close the given notmuch database.
320  *
321  * After notmuch_database_close has been called, calls to other
322  * functions on objects derived from this database may either behave
323  * as if the database had not been closed (e.g., if the required data
324  * has been cached) or may fail with a
325  * NOTMUCH_STATUS_XAPIAN_EXCEPTION.
326  *
327  * notmuch_database_close can be called multiple times.  Later calls
328  * have no effect.
329  *
330  * For writable databases, notmuch_database_close commits all changes
331  * to disk before closing the database.  If the caller is currently in
332  * an atomic section (there was a notmuch_database_begin_atomic
333  * without a matching notmuch_database_end_atomic), this will discard
334  * changes made in that atomic section (but still commit changes made
335  * prior to entering the atomic section).
336  *
337  * Return value:
338  *
339  * NOTMUCH_STATUS_SUCCESS: Successfully closed the database.
340  *
341  * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred; the
342  *      database has been closed but there are no guarantees the
343  *      changes to the database, if any, have been flushed to disk.
344  */
345 notmuch_status_t
346 notmuch_database_close (notmuch_database_t *database);
347
348 /**
349  * A callback invoked by notmuch_database_compact to notify the user
350  * of the progress of the compaction process.
351  */
352 typedef void (*notmuch_compact_status_cb_t)(const char *message, void *closure);
353
354 /**
355  * Compact a notmuch database, backing up the original database to the
356  * given path.
357  *
358  * The database will be opened with NOTMUCH_DATABASE_MODE_READ_WRITE
359  * during the compaction process to ensure no writes are made.
360  *
361  * If the optional callback function 'status_cb' is non-NULL, it will
362  * be called with diagnostic and informational messages. The argument
363  * 'closure' is passed verbatim to any callback invoked.
364  */
365 notmuch_status_t
366 notmuch_database_compact (const char* path,
367                           const char* backup_path,
368                           notmuch_compact_status_cb_t status_cb,
369                           void *closure);
370
371 /**
372  * Destroy the notmuch database, closing it if necessary and freeing
373  * all associated resources.
374  *
375  * Return value as in notmuch_database_close if the database was open;
376  * notmuch_database_destroy itself has no failure modes.
377  */
378 notmuch_status_t
379 notmuch_database_destroy (notmuch_database_t *database);
380
381 /**
382  * Return the database path of the given database.
383  *
384  * The return value is a string owned by notmuch so should not be
385  * modified nor freed by the caller.
386  */
387 const char *
388 notmuch_database_get_path (notmuch_database_t *database);
389
390 /**
391  * Return the database format version of the given database.
392  */
393 unsigned int
394 notmuch_database_get_version (notmuch_database_t *database);
395
396 /**
397  * Can the database be upgraded to a newer database version?
398  *
399  * If this function returns TRUE, then the caller may call
400  * notmuch_database_upgrade to upgrade the database.  If the caller
401  * does not upgrade an out-of-date database, then some functions may
402  * fail with NOTMUCH_STATUS_UPGRADE_REQUIRED.  This always returns
403  * FALSE for a read-only database because there's no way to upgrade a
404  * read-only database.
405  */
406 notmuch_bool_t
407 notmuch_database_needs_upgrade (notmuch_database_t *database);
408
409 /**
410  * Upgrade the current database to the latest supported version.
411  *
412  * This ensures that all current notmuch functionality will be
413  * available on the database.  After opening a database in read-write
414  * mode, it is recommended that clients check if an upgrade is needed
415  * (notmuch_database_needs_upgrade) and if so, upgrade with this
416  * function before making any modifications.  If
417  * notmuch_database_needs_upgrade returns FALSE, this will be a no-op.
418  *
419  * The optional progress_notify callback can be used by the caller to
420  * provide progress indication to the user. If non-NULL it will be
421  * called periodically with 'progress' as a floating-point value in
422  * the range of [0.0 .. 1.0] indicating the progress made so far in
423  * the upgrade process.  The argument 'closure' is passed verbatim to
424  * any callback invoked.
425  */
426 notmuch_status_t
427 notmuch_database_upgrade (notmuch_database_t *database,
428                           void (*progress_notify) (void *closure,
429                                                    double progress),
430                           void *closure);
431
432 /**
433  * Begin an atomic database operation.
434  *
435  * Any modifications performed between a successful begin and a
436  * notmuch_database_end_atomic will be applied to the database
437  * atomically.  Note that, unlike a typical database transaction, this
438  * only ensures atomicity, not durability; neither begin nor end
439  * necessarily flush modifications to disk.
440  *
441  * Atomic sections may be nested.  begin_atomic and end_atomic must
442  * always be called in pairs.
443  *
444  * Return value:
445  *
446  * NOTMUCH_STATUS_SUCCESS: Successfully entered atomic section.
447  *
448  * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred;
449  *      atomic section not entered.
450  */
451 notmuch_status_t
452 notmuch_database_begin_atomic (notmuch_database_t *notmuch);
453
454 /**
455  * Indicate the end of an atomic database operation.
456  *
457  * Return value:
458  *
459  * NOTMUCH_STATUS_SUCCESS: Successfully completed atomic section.
460  *
461  * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred;
462  *      atomic section not ended.
463  *
464  * NOTMUCH_STATUS_UNBALANCED_ATOMIC: The database is not currently in
465  *      an atomic section.
466  */
467 notmuch_status_t
468 notmuch_database_end_atomic (notmuch_database_t *notmuch);
469
470 /**
471  * Return the committed database revision and UUID.
472  *
473  * The database revision number increases monotonically with each
474  * commit to the database.  Hence, all messages and message changes
475  * committed to the database (that is, visible to readers) have a last
476  * modification revision <= the committed database revision.  Any
477  * messages committed in the future will be assigned a modification
478  * revision > the committed database revision.
479  *
480  * The UUID is a NUL-terminated opaque string that uniquely identifies
481  * this database.  Two revision numbers are only comparable if they
482  * have the same database UUID.
483  */
484 unsigned long
485 notmuch_database_get_revision (notmuch_database_t *notmuch,
486                                 const char **uuid);
487
488 /**
489  * Retrieve a directory object from the database for 'path'.
490  *
491  * Here, 'path' should be a path relative to the path of 'database'
492  * (see notmuch_database_get_path), or else should be an absolute path
493  * with initial components that match the path of 'database'.
494  *
495  * If this directory object does not exist in the database, this
496  * returns NOTMUCH_STATUS_SUCCESS and sets *directory to NULL.
497  *
498  * Otherwise the returned directory object is owned by the database
499  * and as such, will only be valid until notmuch_database_destroy is
500  * called.
501  *
502  * Return value:
503  *
504  * NOTMUCH_STATUS_SUCCESS: Successfully retrieved directory.
505  *
506  * NOTMUCH_STATUS_NULL_POINTER: The given 'directory' argument is NULL.
507  *
508  * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred;
509  *      directory not retrieved.
510  *
511  * NOTMUCH_STATUS_UPGRADE_REQUIRED: The caller must upgrade the
512  *      database to use this function.
513  */
514 notmuch_status_t
515 notmuch_database_get_directory (notmuch_database_t *database,
516                                 const char *path,
517                                 notmuch_directory_t **directory);
518
519 /**
520  * Add a new message to the given notmuch database or associate an
521  * additional filename with an existing message.
522  *
523  * Here, 'filename' should be a path relative to the path of
524  * 'database' (see notmuch_database_get_path), or else should be an
525  * absolute filename with initial components that match the path of
526  * 'database'.
527  *
528  * The file should be a single mail message (not a multi-message mbox)
529  * that is expected to remain at its current location, (since the
530  * notmuch database will reference the filename, and will not copy the
531  * entire contents of the file.
532  *
533  * If another message with the same message ID already exists in the
534  * database, rather than creating a new message, this adds 'filename'
535  * to the list of the filenames for the existing message.
536  *
537  * If 'message' is not NULL, then, on successful return
538  * (NOTMUCH_STATUS_SUCCESS or NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID) '*message'
539  * will be initialized to a message object that can be used for things
540  * such as adding tags to the just-added message. The user should call
541  * notmuch_message_destroy when done with the message. On any failure
542  * '*message' will be set to NULL.
543  *
544  * Return value:
545  *
546  * NOTMUCH_STATUS_SUCCESS: Message successfully added to database.
547  *
548  * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred,
549  *      message not added.
550  *
551  * NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID: Message has the same message
552  *      ID as another message already in the database. The new
553  *      filename was successfully added to the message in the database
554  *      (if not already present) and the existing message is returned.
555  *
556  * NOTMUCH_STATUS_FILE_ERROR: an error occurred trying to open the
557  *      file, (such as permission denied, or file not found,
558  *      etc.). Nothing added to the database.
559  *
560  * NOTMUCH_STATUS_FILE_NOT_EMAIL: the contents of filename don't look
561  *      like an email message. Nothing added to the database.
562  *
563  * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
564  *      mode so no message can be added.
565  *
566  * NOTMUCH_STATUS_UPGRADE_REQUIRED: The caller must upgrade the
567  *      database to use this function.
568  */
569 notmuch_status_t
570 notmuch_database_add_message (notmuch_database_t *database,
571                               const char *filename,
572                               notmuch_message_t **message);
573
574 /**
575  * Remove a message filename from the given notmuch database. If the
576  * message has no more filenames, remove the message.
577  *
578  * If the same message (as determined by the message ID) is still
579  * available via other filenames, then the message will persist in the
580  * database for those filenames. When the last filename is removed for
581  * a particular message, the database content for that message will be
582  * entirely removed.
583  *
584  * Return value:
585  *
586  * NOTMUCH_STATUS_SUCCESS: The last filename was removed and the
587  *      message was removed from the database.
588  *
589  * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred,
590  *      message not removed.
591  *
592  * NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID: This filename was removed but
593  *      the message persists in the database with at least one other
594  *      filename.
595  *
596  * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
597  *      mode so no message can be removed.
598  *
599  * NOTMUCH_STATUS_UPGRADE_REQUIRED: The caller must upgrade the
600  *      database to use this function.
601  */
602 notmuch_status_t
603 notmuch_database_remove_message (notmuch_database_t *database,
604                                  const char *filename);
605
606 /**
607  * Find a message with the given message_id.
608  *
609  * If a message with the given message_id is found then, on successful return
610  * (NOTMUCH_STATUS_SUCCESS) '*message' will be initialized to a message
611  * object.  The caller should call notmuch_message_destroy when done with the
612  * message.
613  *
614  * On any failure or when the message is not found, this function initializes
615  * '*message' to NULL. This means, when NOTMUCH_STATUS_SUCCESS is returned, the
616  * caller is supposed to check '*message' for NULL to find out whether the
617  * message with the given message_id was found.
618  *
619  * Return value:
620  *
621  * NOTMUCH_STATUS_SUCCESS: Successful return, check '*message'.
622  *
623  * NOTMUCH_STATUS_NULL_POINTER: The given 'message' argument is NULL
624  *
625  * NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory, creating message object
626  *
627  * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred
628  */
629 notmuch_status_t
630 notmuch_database_find_message (notmuch_database_t *database,
631                                const char *message_id,
632                                notmuch_message_t **message);
633
634 /**
635  * Find a message with the given filename.
636  *
637  * If the database contains a message with the given filename then, on
638  * successful return (NOTMUCH_STATUS_SUCCESS) '*message' will be initialized to
639  * a message object. The caller should call notmuch_message_destroy when done
640  * with the message.
641  *
642  * On any failure or when the message is not found, this function initializes
643  * '*message' to NULL. This means, when NOTMUCH_STATUS_SUCCESS is returned, the
644  * caller is supposed to check '*message' for NULL to find out whether the
645  * message with the given filename is found.
646  *
647  * Return value:
648  *
649  * NOTMUCH_STATUS_SUCCESS: Successful return, check '*message'
650  *
651  * NOTMUCH_STATUS_NULL_POINTER: The given 'message' argument is NULL
652  *
653  * NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory, creating the message object
654  *
655  * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred
656  *
657  * NOTMUCH_STATUS_UPGRADE_REQUIRED: The caller must upgrade the
658  *      database to use this function.
659  */
660 notmuch_status_t
661 notmuch_database_find_message_by_filename (notmuch_database_t *notmuch,
662                                            const char *filename,
663                                            notmuch_message_t **message);
664
665 /**
666  * Return a list of all tags found in the database.
667  *
668  * This function creates a list of all tags found in the database. The
669  * resulting list contains all tags from all messages found in the database.
670  *
671  * On error this function returns NULL.
672  */
673 notmuch_tags_t *
674 notmuch_database_get_all_tags (notmuch_database_t *db);
675
676 /**
677  * Create a new query for 'database'.
678  *
679  * Here, 'database' should be an open database, (see
680  * notmuch_database_open and notmuch_database_create).
681  *
682  * For the query string, we'll document the syntax here more
683  * completely in the future, but it's likely to be a specialized
684  * version of the general Xapian query syntax:
685  *
686  * http://xapian.org/docs/queryparser.html
687  *
688  * As a special case, passing either a length-zero string, (that is ""),
689  * or a string consisting of a single asterisk (that is "*"), will
690  * result in a query that returns all messages in the database.
691  *
692  * See notmuch_query_set_sort for controlling the order of results.
693  * See notmuch_query_search_messages and notmuch_query_search_threads
694  * to actually execute the query.
695  *
696  * User should call notmuch_query_destroy when finished with this
697  * query.
698  *
699  * Will return NULL if insufficient memory is available.
700  */
701 notmuch_query_t *
702 notmuch_query_create (notmuch_database_t *database,
703                       const char *query_string);
704
705 /**
706  * Sort values for notmuch_query_set_sort.
707  */
708 typedef enum {
709     /**
710      * Oldest first.
711      */
712     NOTMUCH_SORT_OLDEST_FIRST,
713     /**
714      * Newest first.
715      */
716     NOTMUCH_SORT_NEWEST_FIRST,
717     /**
718      * Sort by message-id.
719      */
720     NOTMUCH_SORT_MESSAGE_ID,
721     /**
722      * Do not sort.
723      */
724     NOTMUCH_SORT_UNSORTED
725 } notmuch_sort_t;
726
727 /**
728  * Return the query_string of this query. See notmuch_query_create.
729  */
730 const char *
731 notmuch_query_get_query_string (const notmuch_query_t *query);
732
733 /**
734  * Return the notmuch database of this query. See notmuch_query_create.
735  */
736 notmuch_database_t *
737 notmuch_query_get_database (const notmuch_query_t *query);
738
739 /**
740  * Exclude values for notmuch_query_set_omit_excluded. The strange
741  * order is to maintain backward compatibility: the old FALSE/TRUE
742  * options correspond to the new
743  * NOTMUCH_EXCLUDE_FLAG/NOTMUCH_EXCLUDE_TRUE options.
744  */
745 typedef enum {
746     NOTMUCH_EXCLUDE_FLAG,
747     NOTMUCH_EXCLUDE_TRUE,
748     NOTMUCH_EXCLUDE_FALSE,
749     NOTMUCH_EXCLUDE_ALL
750 } notmuch_exclude_t;
751
752 /**
753  * Specify whether to omit excluded results or simply flag them.  By
754  * default, this is set to TRUE.
755  *
756  * If set to TRUE or ALL, notmuch_query_search_messages will omit excluded
757  * messages from the results, and notmuch_query_search_threads will omit
758  * threads that match only in excluded messages.  If set to TRUE,
759  * notmuch_query_search_threads will include all messages in threads that
760  * match in at least one non-excluded message.  Otherwise, if set to ALL,
761  * notmuch_query_search_threads will omit excluded messages from all threads.
762  *
763  * If set to FALSE or FLAG then both notmuch_query_search_messages and
764  * notmuch_query_search_threads will return all matching
765  * messages/threads regardless of exclude status. If set to FLAG then
766  * the exclude flag will be set for any excluded message that is
767  * returned by notmuch_query_search_messages, and the thread counts
768  * for threads returned by notmuch_query_search_threads will be the
769  * number of non-excluded messages/matches. Otherwise, if set to
770  * FALSE, then the exclude status is completely ignored.
771  *
772  * The performance difference when calling
773  * notmuch_query_search_messages should be relatively small (and both
774  * should be very fast).  However, in some cases,
775  * notmuch_query_search_threads is very much faster when omitting
776  * excluded messages as it does not need to construct the threads that
777  * only match in excluded messages.
778  */
779 void
780 notmuch_query_set_omit_excluded (notmuch_query_t *query,
781                                  notmuch_exclude_t omit_excluded);
782
783 /**
784  * Specify the sorting desired for this query.
785  */
786 void
787 notmuch_query_set_sort (notmuch_query_t *query, notmuch_sort_t sort);
788
789 /**
790  * Return the sort specified for this query. See
791  * notmuch_query_set_sort.
792  */
793 notmuch_sort_t
794 notmuch_query_get_sort (const notmuch_query_t *query);
795
796 /**
797  * Add a tag that will be excluded from the query results by default.
798  * This exclusion will be overridden if this tag appears explicitly in
799  * the query.
800  */
801 void
802 notmuch_query_add_tag_exclude (notmuch_query_t *query, const char *tag);
803
804 /**
805  * Execute a query for threads, returning a notmuch_threads_t object
806  * which can be used to iterate over the results. The returned threads
807  * object is owned by the query and as such, will only be valid until
808  * notmuch_query_destroy.
809  *
810  * Typical usage might be:
811  *
812  *     notmuch_query_t *query;
813  *     notmuch_threads_t *threads;
814  *     notmuch_thread_t *thread;
815  *
816  *     query = notmuch_query_create (database, query_string);
817  *
818  *     for (threads = notmuch_query_search_threads (query);
819  *          notmuch_threads_valid (threads);
820  *          notmuch_threads_move_to_next (threads))
821  *     {
822  *         thread = notmuch_threads_get (threads);
823  *         ....
824  *         notmuch_thread_destroy (thread);
825  *     }
826  *
827  *     notmuch_query_destroy (query);
828  *
829  * Note: If you are finished with a thread before its containing
830  * query, you can call notmuch_thread_destroy to clean up some memory
831  * sooner (as in the above example). Otherwise, if your thread objects
832  * are long-lived, then you don't need to call notmuch_thread_destroy
833  * and all the memory will still be reclaimed when the query is
834  * destroyed.
835  *
836  * Note that there's no explicit destructor needed for the
837  * notmuch_threads_t object. (For consistency, we do provide a
838  * notmuch_threads_destroy function, but there's no good reason
839  * to call it if the query is about to be destroyed).
840  *
841  */
842 notmuch_status_t
843 notmuch_query_search_threads_st (notmuch_query_t *query,
844                                  notmuch_threads_t **out);
845
846 /**
847  * Like notmuch_query_search_threads_st, but without a status return.
848  *
849  * If a Xapian exception occurs this function will return NULL.
850  *
851  * @deprecated Deprecated as of libnotmuch 4.3 (notmuch 0.21). Please
852  * use notmuch_query_search_threads_st instead.
853  *
854  */
855 NOTMUCH_DEPRECATED(4,3)
856 notmuch_threads_t *
857 notmuch_query_search_threads (notmuch_query_t *query);
858
859 /**
860  * Execute a query for messages, returning a notmuch_messages_t object
861  * which can be used to iterate over the results. The returned
862  * messages object is owned by the query and as such, will only be
863  * valid until notmuch_query_destroy.
864  *
865  * Typical usage might be:
866  *
867  *     notmuch_query_t *query;
868  *     notmuch_messages_t *messages;
869  *     notmuch_message_t *message;
870  *
871  *     query = notmuch_query_create (database, query_string);
872  *
873  *     for (messages = notmuch_query_search_messages (query);
874  *          notmuch_messages_valid (messages);
875  *          notmuch_messages_move_to_next (messages))
876  *     {
877  *         message = notmuch_messages_get (messages);
878  *         ....
879  *         notmuch_message_destroy (message);
880  *     }
881  *
882  *     notmuch_query_destroy (query);
883  *
884  * Note: If you are finished with a message before its containing
885  * query, you can call notmuch_message_destroy to clean up some memory
886  * sooner (as in the above example). Otherwise, if your message
887  * objects are long-lived, then you don't need to call
888  * notmuch_message_destroy and all the memory will still be reclaimed
889  * when the query is destroyed.
890  *
891  * Note that there's no explicit destructor needed for the
892  * notmuch_messages_t object. (For consistency, we do provide a
893  * notmuch_messages_destroy function, but there's no good
894  * reason to call it if the query is about to be destroyed).
895  *
896  * If a Xapian exception occurs this function will return NULL.
897  *
898  */
899 notmuch_status_t
900 notmuch_query_search_messages_st (notmuch_query_t *query,
901                                   notmuch_messages_t **out);
902 /**
903  * Like notmuch_query_search_messages, but without a status return.
904  *
905  * If a Xapian exception occurs this function will return NULL.
906  *
907  * @deprecated Deprecated as of libnotmuch 4.3 (notmuch 0.21). Please use
908  * notmuch_query_search_messages_st instead.
909  *
910  */
911 NOTMUCH_DEPRECATED(4,3)
912 notmuch_messages_t *
913 notmuch_query_search_messages (notmuch_query_t *query);
914
915 /**
916  * Destroy a notmuch_query_t along with any associated resources.
917  *
918  * This will in turn destroy any notmuch_threads_t and
919  * notmuch_messages_t objects generated by this query, (and in
920  * turn any notmuch_thread_t and notmuch_message_t objects generated
921  * from those results, etc.), if such objects haven't already been
922  * destroyed.
923  */
924 void
925 notmuch_query_destroy (notmuch_query_t *query);
926
927 /**
928  * Is the given 'threads' iterator pointing at a valid thread.
929  *
930  * When this function returns TRUE, notmuch_threads_get will return a
931  * valid object. Whereas when this function returns FALSE,
932  * notmuch_threads_get will return NULL.
933  *
934  * If passed a NULL pointer, this function returns FALSE
935  *
936  * See the documentation of notmuch_query_search_threads for example
937  * code showing how to iterate over a notmuch_threads_t object.
938  */
939 notmuch_bool_t
940 notmuch_threads_valid (notmuch_threads_t *threads);
941
942 /**
943  * Get the current thread from 'threads' as a notmuch_thread_t.
944  *
945  * Note: The returned thread belongs to 'threads' and has a lifetime
946  * identical to it (and the query to which it belongs).
947  *
948  * See the documentation of notmuch_query_search_threads for example
949  * code showing how to iterate over a notmuch_threads_t object.
950  *
951  * If an out-of-memory situation occurs, this function will return
952  * NULL.
953  */
954 notmuch_thread_t *
955 notmuch_threads_get (notmuch_threads_t *threads);
956
957 /**
958  * Move the 'threads' iterator to the next thread.
959  *
960  * If 'threads' is already pointing at the last thread then the
961  * iterator will be moved to a point just beyond that last thread,
962  * (where notmuch_threads_valid will return FALSE and
963  * notmuch_threads_get will return NULL).
964  *
965  * See the documentation of notmuch_query_search_threads for example
966  * code showing how to iterate over a notmuch_threads_t object.
967  */
968 void
969 notmuch_threads_move_to_next (notmuch_threads_t *threads);
970
971 /**
972  * Destroy a notmuch_threads_t object.
973  *
974  * It's not strictly necessary to call this function. All memory from
975  * the notmuch_threads_t object will be reclaimed when the
976  * containing query object is destroyed.
977  */
978 void
979 notmuch_threads_destroy (notmuch_threads_t *threads);
980
981 /**
982  * Return the number of messages matching a search.
983  *
984  * This function performs a search and returns the number of matching
985  * messages.
986  *
987  * If a Xapian exception occurs, this function may return 0 (after
988  * printing a message).
989  */
990 unsigned
991 notmuch_query_count_messages (notmuch_query_t *query);
992
993 /**
994  * Return the number of threads matching a search.
995  *
996  * This function performs a search and returns the number of unique thread IDs
997  * in the matching messages. This is the same as number of threads matching a
998  * search.
999  *
1000  * Note that this is a significantly heavier operation than
1001  * notmuch_query_count_messages().
1002  *
1003  * If an error occurs, this function may return 0.
1004  */
1005 unsigned
1006 notmuch_query_count_threads (notmuch_query_t *query);
1007
1008 /**
1009  * Get the thread ID of 'thread'.
1010  *
1011  * The returned string belongs to 'thread' and as such, should not be
1012  * modified by the caller and will only be valid for as long as the
1013  * thread is valid, (which is until notmuch_thread_destroy or until
1014  * the query from which it derived is destroyed).
1015  */
1016 const char *
1017 notmuch_thread_get_thread_id (notmuch_thread_t *thread);
1018
1019 /**
1020  * Get the total number of messages in 'thread'.
1021  *
1022  * This count consists of all messages in the database belonging to
1023  * this thread. Contrast with notmuch_thread_get_matched_messages() .
1024  */
1025 int
1026 notmuch_thread_get_total_messages (notmuch_thread_t *thread);
1027
1028 /**
1029  * Get a notmuch_messages_t iterator for the top-level messages in
1030  * 'thread' in oldest-first order.
1031  *
1032  * This iterator will not necessarily iterate over all of the messages
1033  * in the thread. It will only iterate over the messages in the thread
1034  * which are not replies to other messages in the thread.
1035  *
1036  * The returned list will be destroyed when the thread is destroyed.
1037  */
1038 notmuch_messages_t *
1039 notmuch_thread_get_toplevel_messages (notmuch_thread_t *thread);
1040
1041 /**
1042  * Get a notmuch_thread_t iterator for all messages in 'thread' in
1043  * oldest-first order.
1044  *
1045  * The returned list will be destroyed when the thread is destroyed.
1046  */
1047 notmuch_messages_t *
1048 notmuch_thread_get_messages (notmuch_thread_t *thread);
1049
1050 /**
1051  * Get the number of messages in 'thread' that matched the search.
1052  *
1053  * This count includes only the messages in this thread that were
1054  * matched by the search from which the thread was created and were
1055  * not excluded by any exclude tags passed in with the query (see
1056  * notmuch_query_add_tag_exclude). Contrast with
1057  * notmuch_thread_get_total_messages() .
1058  */
1059 int
1060 notmuch_thread_get_matched_messages (notmuch_thread_t *thread);
1061
1062 /**
1063  * Get the authors of 'thread' as a UTF-8 string.
1064  *
1065  * The returned string is a comma-separated list of the names of the
1066  * authors of mail messages in the query results that belong to this
1067  * thread.
1068  *
1069  * The string contains authors of messages matching the query first, then
1070  * non-matched authors (with the two groups separated by '|'). Within
1071  * each group, authors are ordered by date.
1072  *
1073  * The returned string belongs to 'thread' and as such, should not be
1074  * modified by the caller and will only be valid for as long as the
1075  * thread is valid, (which is until notmuch_thread_destroy or until
1076  * the query from which it derived is destroyed).
1077  */
1078 const char *
1079 notmuch_thread_get_authors (notmuch_thread_t *thread);
1080
1081 /**
1082  * Get the subject of 'thread' as a UTF-8 string.
1083  *
1084  * The subject is taken from the first message (according to the query
1085  * order---see notmuch_query_set_sort) in the query results that
1086  * belongs to this thread.
1087  *
1088  * The returned string belongs to 'thread' and as such, should not be
1089  * modified by the caller and will only be valid for as long as the
1090  * thread is valid, (which is until notmuch_thread_destroy or until
1091  * the query from which it derived is destroyed).
1092  */
1093 const char *
1094 notmuch_thread_get_subject (notmuch_thread_t *thread);
1095
1096 /**
1097  * Get the date of the oldest message in 'thread' as a time_t value.
1098  */
1099 time_t
1100 notmuch_thread_get_oldest_date (notmuch_thread_t *thread);
1101
1102 /**
1103  * Get the date of the newest message in 'thread' as a time_t value.
1104  */
1105 time_t
1106 notmuch_thread_get_newest_date (notmuch_thread_t *thread);
1107
1108 /**
1109  * Get the tags for 'thread', returning a notmuch_tags_t object which
1110  * can be used to iterate over all tags.
1111  *
1112  * Note: In the Notmuch database, tags are stored on individual
1113  * messages, not on threads. So the tags returned here will be all
1114  * tags of the messages which matched the search and which belong to
1115  * this thread.
1116  *
1117  * The tags object is owned by the thread and as such, will only be
1118  * valid for as long as the thread is valid, (for example, until
1119  * notmuch_thread_destroy or until the query from which it derived is
1120  * destroyed).
1121  *
1122  * Typical usage might be:
1123  *
1124  *     notmuch_thread_t *thread;
1125  *     notmuch_tags_t *tags;
1126  *     const char *tag;
1127  *
1128  *     thread = notmuch_threads_get (threads);
1129  *
1130  *     for (tags = notmuch_thread_get_tags (thread);
1131  *          notmuch_tags_valid (tags);
1132  *          notmuch_tags_move_to_next (tags))
1133  *     {
1134  *         tag = notmuch_tags_get (tags);
1135  *         ....
1136  *     }
1137  *
1138  *     notmuch_thread_destroy (thread);
1139  *
1140  * Note that there's no explicit destructor needed for the
1141  * notmuch_tags_t object. (For consistency, we do provide a
1142  * notmuch_tags_destroy function, but there's no good reason to call
1143  * it if the message is about to be destroyed).
1144  */
1145 notmuch_tags_t *
1146 notmuch_thread_get_tags (notmuch_thread_t *thread);
1147
1148 /**
1149  * Destroy a notmuch_thread_t object.
1150  */
1151 void
1152 notmuch_thread_destroy (notmuch_thread_t *thread);
1153
1154 /**
1155  * Is the given 'messages' iterator pointing at a valid message.
1156  *
1157  * When this function returns TRUE, notmuch_messages_get will return a
1158  * valid object. Whereas when this function returns FALSE,
1159  * notmuch_messages_get will return NULL.
1160  *
1161  * See the documentation of notmuch_query_search_messages for example
1162  * code showing how to iterate over a notmuch_messages_t object.
1163  */
1164 notmuch_bool_t
1165 notmuch_messages_valid (notmuch_messages_t *messages);
1166
1167 /**
1168  * Get the current message from 'messages' as a notmuch_message_t.
1169  *
1170  * Note: The returned message belongs to 'messages' and has a lifetime
1171  * identical to it (and the query to which it belongs).
1172  *
1173  * See the documentation of notmuch_query_search_messages for example
1174  * code showing how to iterate over a notmuch_messages_t object.
1175  *
1176  * If an out-of-memory situation occurs, this function will return
1177  * NULL.
1178  */
1179 notmuch_message_t *
1180 notmuch_messages_get (notmuch_messages_t *messages);
1181
1182 /**
1183  * Move the 'messages' iterator to the next message.
1184  *
1185  * If 'messages' is already pointing at the last message then the
1186  * iterator will be moved to a point just beyond that last message,
1187  * (where notmuch_messages_valid will return FALSE and
1188  * notmuch_messages_get will return NULL).
1189  *
1190  * See the documentation of notmuch_query_search_messages for example
1191  * code showing how to iterate over a notmuch_messages_t object.
1192  */
1193 void
1194 notmuch_messages_move_to_next (notmuch_messages_t *messages);
1195
1196 /**
1197  * Destroy a notmuch_messages_t object.
1198  *
1199  * It's not strictly necessary to call this function. All memory from
1200  * the notmuch_messages_t object will be reclaimed when the containing
1201  * query object is destroyed.
1202  */
1203 void
1204 notmuch_messages_destroy (notmuch_messages_t *messages);
1205
1206 /**
1207  * Return a list of tags from all messages.
1208  *
1209  * The resulting list is guaranteed not to contain duplicated tags.
1210  *
1211  * WARNING: You can no longer iterate over messages after calling this
1212  * function, because the iterator will point at the end of the list.
1213  * We do not have a function to reset the iterator yet and the only
1214  * way how you can iterate over the list again is to recreate the
1215  * message list.
1216  *
1217  * The function returns NULL on error.
1218  */
1219 notmuch_tags_t *
1220 notmuch_messages_collect_tags (notmuch_messages_t *messages);
1221
1222 /**
1223  * Get the message ID of 'message'.
1224  *
1225  * The returned string belongs to 'message' and as such, should not be
1226  * modified by the caller and will only be valid for as long as the
1227  * message is valid, (which is until the query from which it derived
1228  * is destroyed).
1229  *
1230  * This function will not return NULL since Notmuch ensures that every
1231  * message has a unique message ID, (Notmuch will generate an ID for a
1232  * message if the original file does not contain one).
1233  */
1234 const char *
1235 notmuch_message_get_message_id (notmuch_message_t *message);
1236
1237 /**
1238  * Get the thread ID of 'message'.
1239  *
1240  * The returned string belongs to 'message' and as such, should not be
1241  * modified by the caller and will only be valid for as long as the
1242  * message is valid, (for example, until the user calls
1243  * notmuch_message_destroy on 'message' or until a query from which it
1244  * derived is destroyed).
1245  *
1246  * This function will not return NULL since Notmuch ensures that every
1247  * message belongs to a single thread.
1248  */
1249 const char *
1250 notmuch_message_get_thread_id (notmuch_message_t *message);
1251
1252 /**
1253  * Get a notmuch_messages_t iterator for all of the replies to
1254  * 'message'.
1255  *
1256  * Note: This call only makes sense if 'message' was ultimately
1257  * obtained from a notmuch_thread_t object, (such as by coming
1258  * directly from the result of calling notmuch_thread_get_
1259  * toplevel_messages or by any number of subsequent
1260  * calls to notmuch_message_get_replies).
1261  *
1262  * If 'message' was obtained through some non-thread means, (such as
1263  * by a call to notmuch_query_search_messages), then this function
1264  * will return NULL.
1265  *
1266  * If there are no replies to 'message', this function will return
1267  * NULL. (Note that notmuch_messages_valid will accept that NULL
1268  * value as legitimate, and simply return FALSE for it.)
1269  */
1270 notmuch_messages_t *
1271 notmuch_message_get_replies (notmuch_message_t *message);
1272
1273 /**
1274  * Get a filename for the email corresponding to 'message'.
1275  *
1276  * The returned filename is an absolute filename, (the initial
1277  * component will match notmuch_database_get_path() ).
1278  *
1279  * The returned string belongs to the message so should not be
1280  * modified or freed by the caller (nor should it be referenced after
1281  * the message is destroyed).
1282  *
1283  * Note: If this message corresponds to multiple files in the mail
1284  * store, (that is, multiple files contain identical message IDs),
1285  * this function will arbitrarily return a single one of those
1286  * filenames. See notmuch_message_get_filenames for returning the
1287  * complete list of filenames.
1288  */
1289 const char *
1290 notmuch_message_get_filename (notmuch_message_t *message);
1291
1292 /**
1293  * Get all filenames for the email corresponding to 'message'.
1294  *
1295  * Returns a notmuch_filenames_t iterator listing all the filenames
1296  * associated with 'message'. These files may not have identical
1297  * content, but each will have the identical Message-ID.
1298  *
1299  * Each filename in the iterator is an absolute filename, (the initial
1300  * component will match notmuch_database_get_path() ).
1301  */
1302 notmuch_filenames_t *
1303 notmuch_message_get_filenames (notmuch_message_t *message);
1304
1305 /**
1306  * Message flags.
1307  */
1308 typedef enum _notmuch_message_flag {
1309     NOTMUCH_MESSAGE_FLAG_MATCH,
1310     NOTMUCH_MESSAGE_FLAG_EXCLUDED,
1311
1312     /* This message is a "ghost message", meaning it has no filenames
1313      * or content, but we know it exists because it was referenced by
1314      * some other message.  A ghost message has only a message ID and
1315      * thread ID.
1316      */
1317     NOTMUCH_MESSAGE_FLAG_GHOST,
1318 } notmuch_message_flag_t;
1319
1320 /**
1321  * Get a value of a flag for the email corresponding to 'message'.
1322  */
1323 notmuch_bool_t
1324 notmuch_message_get_flag (notmuch_message_t *message,
1325                           notmuch_message_flag_t flag);
1326
1327 /**
1328  * Set a value of a flag for the email corresponding to 'message'.
1329  */
1330 void
1331 notmuch_message_set_flag (notmuch_message_t *message,
1332                           notmuch_message_flag_t flag, notmuch_bool_t value);
1333
1334 /**
1335  * Get the date of 'message' as a time_t value.
1336  *
1337  * For the original textual representation of the Date header from the
1338  * message call notmuch_message_get_header() with a header value of
1339  * "date".
1340  */
1341 time_t
1342 notmuch_message_get_date  (notmuch_message_t *message);
1343
1344 /**
1345  * Get the value of the specified header from 'message' as a UTF-8 string.
1346  *
1347  * Common headers are stored in the database when the message is
1348  * indexed and will be returned from the database.  Other headers will
1349  * be read from the actual message file.
1350  *
1351  * The header name is case insensitive.
1352  *
1353  * The returned string belongs to the message so should not be
1354  * modified or freed by the caller (nor should it be referenced after
1355  * the message is destroyed).
1356  *
1357  * Returns an empty string ("") if the message does not contain a
1358  * header line matching 'header'. Returns NULL if any error occurs.
1359  */
1360 const char *
1361 notmuch_message_get_header (notmuch_message_t *message, const char *header);
1362
1363 /**
1364  * Get the tags for 'message', returning a notmuch_tags_t object which
1365  * can be used to iterate over all tags.
1366  *
1367  * The tags object is owned by the message and as such, will only be
1368  * valid for as long as the message is valid, (which is until the
1369  * query from which it derived is destroyed).
1370  *
1371  * Typical usage might be:
1372  *
1373  *     notmuch_message_t *message;
1374  *     notmuch_tags_t *tags;
1375  *     const char *tag;
1376  *
1377  *     message = notmuch_database_find_message (database, message_id);
1378  *
1379  *     for (tags = notmuch_message_get_tags (message);
1380  *          notmuch_tags_valid (tags);
1381  *          notmuch_tags_move_to_next (tags))
1382  *     {
1383  *         tag = notmuch_tags_get (tags);
1384  *         ....
1385  *     }
1386  *
1387  *     notmuch_message_destroy (message);
1388  *
1389  * Note that there's no explicit destructor needed for the
1390  * notmuch_tags_t object. (For consistency, we do provide a
1391  * notmuch_tags_destroy function, but there's no good reason to call
1392  * it if the message is about to be destroyed).
1393  */
1394 notmuch_tags_t *
1395 notmuch_message_get_tags (notmuch_message_t *message);
1396
1397 /**
1398  * The longest possible tag value.
1399  */
1400 #define NOTMUCH_TAG_MAX 200
1401
1402 /**
1403  * Add a tag to the given message.
1404  *
1405  * Return value:
1406  *
1407  * NOTMUCH_STATUS_SUCCESS: Tag successfully added to message
1408  *
1409  * NOTMUCH_STATUS_NULL_POINTER: The 'tag' argument is NULL
1410  *
1411  * NOTMUCH_STATUS_TAG_TOO_LONG: The length of 'tag' is too long
1412  *      (exceeds NOTMUCH_TAG_MAX)
1413  *
1414  * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
1415  *      mode so message cannot be modified.
1416  */
1417 notmuch_status_t
1418 notmuch_message_add_tag (notmuch_message_t *message, const char *tag);
1419
1420 /**
1421  * Remove a tag from the given message.
1422  *
1423  * Return value:
1424  *
1425  * NOTMUCH_STATUS_SUCCESS: Tag successfully removed from message
1426  *
1427  * NOTMUCH_STATUS_NULL_POINTER: The 'tag' argument is NULL
1428  *
1429  * NOTMUCH_STATUS_TAG_TOO_LONG: The length of 'tag' is too long
1430  *      (exceeds NOTMUCH_TAG_MAX)
1431  *
1432  * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
1433  *      mode so message cannot be modified.
1434  */
1435 notmuch_status_t
1436 notmuch_message_remove_tag (notmuch_message_t *message, const char *tag);
1437
1438 /**
1439  * Remove all tags from the given message.
1440  *
1441  * See notmuch_message_freeze for an example showing how to safely
1442  * replace tag values.
1443  *
1444  * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
1445  *      mode so message cannot be modified.
1446  */
1447 notmuch_status_t
1448 notmuch_message_remove_all_tags (notmuch_message_t *message);
1449
1450 /**
1451  * Add/remove tags according to maildir flags in the message filename(s).
1452  *
1453  * This function examines the filenames of 'message' for maildir
1454  * flags, and adds or removes tags on 'message' as follows when these
1455  * flags are present:
1456  *
1457  *      Flag    Action if present
1458  *      ----    -----------------
1459  *      'D'     Adds the "draft" tag to the message
1460  *      'F'     Adds the "flagged" tag to the message
1461  *      'P'     Adds the "passed" tag to the message
1462  *      'R'     Adds the "replied" tag to the message
1463  *      'S'     Removes the "unread" tag from the message
1464  *
1465  * For each flag that is not present, the opposite action (add/remove)
1466  * is performed for the corresponding tags.
1467  *
1468  * Flags are identified as trailing components of the filename after a
1469  * sequence of ":2,".
1470  *
1471  * If there are multiple filenames associated with this message, the
1472  * flag is considered present if it appears in one or more
1473  * filenames. (That is, the flags from the multiple filenames are
1474  * combined with the logical OR operator.)
1475  *
1476  * A client can ensure that notmuch database tags remain synchronized
1477  * with maildir flags by calling this function after each call to
1478  * notmuch_database_add_message. See also
1479  * notmuch_message_tags_to_maildir_flags for synchronizing tag changes
1480  * back to maildir flags.
1481  */
1482 notmuch_status_t
1483 notmuch_message_maildir_flags_to_tags (notmuch_message_t *message);
1484
1485 /**
1486  * Rename message filename(s) to encode tags as maildir flags.
1487  *
1488  * Specifically, for each filename corresponding to this message:
1489  *
1490  * If the filename is not in a maildir directory, do nothing.  (A
1491  * maildir directory is determined as a directory named "new" or
1492  * "cur".) Similarly, if the filename has invalid maildir info,
1493  * (repeated or outof-ASCII-order flag characters after ":2,"), then
1494  * do nothing.
1495  *
1496  * If the filename is in a maildir directory, rename the file so that
1497  * its filename ends with the sequence ":2," followed by zero or more
1498  * of the following single-character flags (in ASCII order):
1499  *
1500  *   'D' iff the message has the "draft" tag
1501  *   'F' iff the message has the "flagged" tag
1502  *   'P' iff the message has the "passed" tag
1503  *   'R' iff the message has the "replied" tag
1504  *   'S' iff the message does not have the "unread" tag
1505  *
1506  * Any existing flags unmentioned in the list above will be preserved
1507  * in the renaming.
1508  *
1509  * Also, if this filename is in a directory named "new", rename it to
1510  * be within the neighboring directory named "cur".
1511  *
1512  * A client can ensure that maildir filename flags remain synchronized
1513  * with notmuch database tags by calling this function after changing
1514  * tags, (after calls to notmuch_message_add_tag,
1515  * notmuch_message_remove_tag, or notmuch_message_freeze/
1516  * notmuch_message_thaw). See also notmuch_message_maildir_flags_to_tags
1517  * for synchronizing maildir flag changes back to tags.
1518  */
1519 notmuch_status_t
1520 notmuch_message_tags_to_maildir_flags (notmuch_message_t *message);
1521
1522 /**
1523  * Freeze the current state of 'message' within the database.
1524  *
1525  * This means that changes to the message state, (via
1526  * notmuch_message_add_tag, notmuch_message_remove_tag, and
1527  * notmuch_message_remove_all_tags), will not be committed to the
1528  * database until the message is thawed with notmuch_message_thaw.
1529  *
1530  * Multiple calls to freeze/thaw are valid and these calls will
1531  * "stack". That is there must be as many calls to thaw as to freeze
1532  * before a message is actually thawed.
1533  *
1534  * The ability to do freeze/thaw allows for safe transactions to
1535  * change tag values. For example, explicitly setting a message to
1536  * have a given set of tags might look like this:
1537  *
1538  *    notmuch_message_freeze (message);
1539  *
1540  *    notmuch_message_remove_all_tags (message);
1541  *
1542  *    for (i = 0; i < NUM_TAGS; i++)
1543  *        notmuch_message_add_tag (message, tags[i]);
1544  *
1545  *    notmuch_message_thaw (message);
1546  *
1547  * With freeze/thaw used like this, the message in the database is
1548  * guaranteed to have either the full set of original tag values, or
1549  * the full set of new tag values, but nothing in between.
1550  *
1551  * Imagine the example above without freeze/thaw and the operation
1552  * somehow getting interrupted. This could result in the message being
1553  * left with no tags if the interruption happened after
1554  * notmuch_message_remove_all_tags but before notmuch_message_add_tag.
1555  *
1556  * Return value:
1557  *
1558  * NOTMUCH_STATUS_SUCCESS: Message successfully frozen.
1559  *
1560  * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
1561  *      mode so message cannot be modified.
1562  */
1563 notmuch_status_t
1564 notmuch_message_freeze (notmuch_message_t *message);
1565
1566 /**
1567  * Thaw the current 'message', synchronizing any changes that may have
1568  * occurred while 'message' was frozen into the notmuch database.
1569  *
1570  * See notmuch_message_freeze for an example of how to use this
1571  * function to safely provide tag changes.
1572  *
1573  * Multiple calls to freeze/thaw are valid and these calls with
1574  * "stack". That is there must be as many calls to thaw as to freeze
1575  * before a message is actually thawed.
1576  *
1577  * Return value:
1578  *
1579  * NOTMUCH_STATUS_SUCCESS: Message successfully thawed, (or at least
1580  *      its frozen count has successfully been reduced by 1).
1581  *
1582  * NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW: An attempt was made to thaw
1583  *      an unfrozen message. That is, there have been an unbalanced
1584  *      number of calls to notmuch_message_freeze and
1585  *      notmuch_message_thaw.
1586  */
1587 notmuch_status_t
1588 notmuch_message_thaw (notmuch_message_t *message);
1589
1590 /**
1591  * Destroy a notmuch_message_t object.
1592  *
1593  * It can be useful to call this function in the case of a single
1594  * query object with many messages in the result, (such as iterating
1595  * over the entire database). Otherwise, it's fine to never call this
1596  * function and there will still be no memory leaks. (The memory from
1597  * the messages get reclaimed when the containing query is destroyed.)
1598  */
1599 void
1600 notmuch_message_destroy (notmuch_message_t *message);
1601
1602 /**
1603  * Is the given 'tags' iterator pointing at a valid tag.
1604  *
1605  * When this function returns TRUE, notmuch_tags_get will return a
1606  * valid string. Whereas when this function returns FALSE,
1607  * notmuch_tags_get will return NULL.
1608  *
1609  * See the documentation of notmuch_message_get_tags for example code
1610  * showing how to iterate over a notmuch_tags_t object.
1611  */
1612 notmuch_bool_t
1613 notmuch_tags_valid (notmuch_tags_t *tags);
1614
1615 /**
1616  * Get the current tag from 'tags' as a string.
1617  *
1618  * Note: The returned string belongs to 'tags' and has a lifetime
1619  * identical to it (and the query to which it ultimately belongs).
1620  *
1621  * See the documentation of notmuch_message_get_tags for example code
1622  * showing how to iterate over a notmuch_tags_t object.
1623  */
1624 const char *
1625 notmuch_tags_get (notmuch_tags_t *tags);
1626
1627 /**
1628  * Move the 'tags' iterator to the next tag.
1629  *
1630  * If 'tags' is already pointing at the last tag then the iterator
1631  * will be moved to a point just beyond that last tag, (where
1632  * notmuch_tags_valid will return FALSE and notmuch_tags_get will
1633  * return NULL).
1634  *
1635  * See the documentation of notmuch_message_get_tags for example code
1636  * showing how to iterate over a notmuch_tags_t object.
1637  */
1638 void
1639 notmuch_tags_move_to_next (notmuch_tags_t *tags);
1640
1641 /**
1642  * Destroy a notmuch_tags_t object.
1643  *
1644  * It's not strictly necessary to call this function. All memory from
1645  * the notmuch_tags_t object will be reclaimed when the containing
1646  * message or query objects are destroyed.
1647  */
1648 void
1649 notmuch_tags_destroy (notmuch_tags_t *tags);
1650
1651 /**
1652  * Store an mtime within the database for 'directory'.
1653  *
1654  * The 'directory' should be an object retrieved from the database
1655  * with notmuch_database_get_directory for a particular path.
1656  *
1657  * The intention is for the caller to use the mtime to allow efficient
1658  * identification of new messages to be added to the database. The
1659  * recommended usage is as follows:
1660  *
1661  *   o Read the mtime of a directory from the filesystem
1662  *
1663  *   o Call add_message for all mail files in the directory
1664  *
1665  *   o Call notmuch_directory_set_mtime with the mtime read from the
1666  *     filesystem.
1667  *
1668  * Then, when wanting to check for updates to the directory in the
1669  * future, the client can call notmuch_directory_get_mtime and know
1670  * that it only needs to add files if the mtime of the directory and
1671  * files are newer than the stored timestamp.
1672  *
1673  * Note: The notmuch_directory_get_mtime function does not allow the
1674  * caller to distinguish a timestamp of 0 from a non-existent
1675  * timestamp. So don't store a timestamp of 0 unless you are
1676  * comfortable with that.
1677  *
1678  * Return value:
1679  *
1680  * NOTMUCH_STATUS_SUCCESS: mtime successfully stored in database.
1681  *
1682  * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception
1683  *      occurred, mtime not stored.
1684  *
1685  * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only
1686  *      mode so directory mtime cannot be modified.
1687  */
1688 notmuch_status_t
1689 notmuch_directory_set_mtime (notmuch_directory_t *directory,
1690                              time_t mtime);
1691
1692 /**
1693  * Get the mtime of a directory, (as previously stored with
1694  * notmuch_directory_set_mtime).
1695  *
1696  * Returns 0 if no mtime has previously been stored for this
1697  * directory.
1698  */
1699 time_t
1700 notmuch_directory_get_mtime (notmuch_directory_t *directory);
1701
1702 /**
1703  * Get a notmuch_filenames_t iterator listing all the filenames of
1704  * messages in the database within the given directory.
1705  *
1706  * The returned filenames will be the basename-entries only (not
1707  * complete paths).
1708  */
1709 notmuch_filenames_t *
1710 notmuch_directory_get_child_files (notmuch_directory_t *directory);
1711
1712 /**
1713  * Get a notmuch_filenams_t iterator listing all the filenames of
1714  * sub-directories in the database within the given directory.
1715  *
1716  * The returned filenames will be the basename-entries only (not
1717  * complete paths).
1718  */
1719 notmuch_filenames_t *
1720 notmuch_directory_get_child_directories (notmuch_directory_t *directory);
1721
1722 /**
1723  * Destroy a notmuch_directory_t object.
1724  */
1725 void
1726 notmuch_directory_destroy (notmuch_directory_t *directory);
1727
1728 /**
1729  * Is the given 'filenames' iterator pointing at a valid filename.
1730  *
1731  * When this function returns TRUE, notmuch_filenames_get will return
1732  * a valid string. Whereas when this function returns FALSE,
1733  * notmuch_filenames_get will return NULL.
1734  *
1735  * It is acceptable to pass NULL for 'filenames', in which case this
1736  * function will always return FALSE.
1737  */
1738 notmuch_bool_t
1739 notmuch_filenames_valid (notmuch_filenames_t *filenames);
1740
1741 /**
1742  * Get the current filename from 'filenames' as a string.
1743  *
1744  * Note: The returned string belongs to 'filenames' and has a lifetime
1745  * identical to it (and the directory to which it ultimately belongs).
1746  *
1747  * It is acceptable to pass NULL for 'filenames', in which case this
1748  * function will always return NULL.
1749  */
1750 const char *
1751 notmuch_filenames_get (notmuch_filenames_t *filenames);
1752
1753 /**
1754  * Move the 'filenames' iterator to the next filename.
1755  *
1756  * If 'filenames' is already pointing at the last filename then the
1757  * iterator will be moved to a point just beyond that last filename,
1758  * (where notmuch_filenames_valid will return FALSE and
1759  * notmuch_filenames_get will return NULL).
1760  *
1761  * It is acceptable to pass NULL for 'filenames', in which case this
1762  * function will do nothing.
1763  */
1764 void
1765 notmuch_filenames_move_to_next (notmuch_filenames_t *filenames);
1766
1767 /**
1768  * Destroy a notmuch_filenames_t object.
1769  *
1770  * It's not strictly necessary to call this function. All memory from
1771  * the notmuch_filenames_t object will be reclaimed when the
1772  * containing directory object is destroyed.
1773  *
1774  * It is acceptable to pass NULL for 'filenames', in which case this
1775  * function will do nothing.
1776  */
1777 void
1778 notmuch_filenames_destroy (notmuch_filenames_t *filenames);
1779
1780 /* @} */
1781
1782 NOTMUCH_END_DECLS
1783
1784 #endif