NOTMUCH_BEGIN_DECLS
+#include <time.h>
+
#ifndef FALSE
#define FALSE 0
#endif
*
* NOTMUCH_STATUS_SUCCESS: No error occurred.
*
+ * XXX: We don't really want to expose this lame XAPIAN_EXCEPTION
+ * value. Instead we should map to things like DATABASE_LOCKED or
+ * whatever.
+ *
* NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred
*
+ * NOTMUCH_STATUS_FILE_ERROR: An error occurred trying to read or
+ * write to a file (this could be file not found, permission
+ * denied, etc.)
+ *
* NOTMUCH_STATUS_FILE_NOT_EMAIL: A file was presented that doesn't
- * appear to be an email message.
+ * appear to be an email message.
*
* NOTMUCH_STATUS_NULL_POINTER: The user erroneously passed a NULL
- * pointer to a notmuch function.
+ * pointer to a notmuch function.
*
- * NOTMUCH_STATUS_TAG_TOO_LONG: A tag value is too long.
+ * NOTMUCH_STATUS_TAG_TOO_LONG: A tag value is too long (exceeds
+ * NOTMUCH_TAG_MAX)
*
* NOTMUCH_STATUS_LAST_STATUS: Not an actual status value. Just a way
- * to find out how many valid status values there are.
+ * to find out how many valid status values there are.
*/
typedef enum _notmuch_status {
NOTMUCH_STATUS_SUCCESS = 0,
NOTMUCH_STATUS_XAPIAN_EXCEPTION,
+ NOTMUCH_STATUS_FILE_ERROR,
NOTMUCH_STATUS_FILE_NOT_EMAIL,
NOTMUCH_STATUS_NULL_POINTER,
NOTMUCH_STATUS_TAG_TOO_LONG,
NOTMUCH_STATUS_LAST_STATUS
} notmuch_status_t;
+/* Get a string representation of a notmuch_status_t value.
+ *
+ * The result is readonly.
+ */
+const char *
+notmuch_status_to_string (notmuch_status_t status);
+
/* Various opaque data types. For each notmuch_<foo>_t see the various
* notmuch_<foo> functions below. */
typedef struct _notmuch_database notmuch_database_t;
const char *
notmuch_database_get_path (notmuch_database_t *database);
+/* Store a timestamp within the database.
+ *
+ * The Notmuch database will not interpret this key nor the timestamp
+ * values at all. It will merely store them together and return the
+ * timestamp when notmuch_database_get_timestamp is called with the
+ * same value for 'key'.
+ *
+ * The intention is for the caller to use the timestamp to allow
+ * efficient identification of new messages to be added to the
+ * database. The recommended usage is as follows:
+ *
+ * o Read the mtime of a directory from the filesystem
+ *
+ * o Call add_message for all mail files in the directory
+ *
+ * o Call notmuch_database_set_timestamp with the path of the
+ * directory as 'key' and the originally read mtime as 'value'.
+ *
+ * Then, when wanting to check for updates to the directory in the
+ * future, the client can call notmuch_database_get_timestamp and know
+ * that it only needs to add files if the mtime of the directory and
+ * files are newer than the stored timestamp.
+ *
+ * Note: The notmuch_database_get_timestamp function does not allow
+ * the caller to distinguish a timestamp of 0 from a non-existent
+ * timestamp. So don't store a timestamp of 0 unless you are
+ * comfortable with that.
+ *
+ * Return value:
+ *
+ * NOTMUCH_STATUS_SUCCESS: Timestamp successfully stored in database.
+ *
+ * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception
+ * occurred. Timestamp not stored.
+ */
+notmuch_status_t
+notmuch_database_set_timestamp (notmuch_database_t *database,
+ const char *key, time_t timestamp);
+
+/* Retrieve a timestamp from the database.
+ *
+ * Returns the timestamp value previously stored by calling
+ * notmuch_database_set_timestamp with the same value for 'key'.
+ *
+ * Returns 0 if no timestamp is stored for 'key' or if any error
+ * occurred querying the database.
+ */
+time_t
+notmuch_database_get_timestamp (notmuch_database_t *database,
+ const char *key);
+
/* Add a new message to the given notmuch database.
*
* Here,'filename' should be a path relative to the the path of
*
* NOTMUCH_STATUS_SUCCESS: Message successfully added to database.
*
+ * NOTMUCH_STATUS_FILE_ERROR: an error occurred trying to open the
+ * file, (such as permission denied, or file not found,
+ * etc.). Nothing added to the database.
+ *
* NOTMUCH_STATUS_FILE_NOT_EMAIL: the contents of filename don't look
- * like an email message. Nothing added to the database.
+ * like an email message. Nothing added to the database.
*/
notmuch_status_t
notmuch_database_add_message (notmuch_database_t *database,
* modified by the caller and will only be valid for as long as the
* message is valid, (which is until the query from which it derived
* is destroyed).
+ *
+ * This function will not return NULL since Notmuch ensures that every
+ * message has a unique message ID, (Notmuch will generate an ID for a
+ * message if the original file does not contain one).
*/
const char *
notmuch_message_get_message_id (notmuch_message_t *message);
+/* Get this filename for the email corresponding to 'message'.
+ *
+ * The returned filename is relative to the base of the database from
+ * which 'message' was obtained. See notmuch_database_get_path() .*/
+const char *
+notmuch_message_get_filename (notmuch_message_t *message);
+
/* Get the tags for 'message', returning a notmuch_tags_t object which
* can be used to iterate over all tags.
*
* NOTMUCH_STATUS_NULL_POINTER: The 'tag' argument is NULL
*
* NOTMUCH_STATUS_TAG_TOO_LONG: The length of 'tag' is longer than
- * too long (exceeds NOTMUCH_TAG_MAX)
+ * too long (exceeds NOTMUCH_TAG_MAX)
*/
notmuch_status_t
notmuch_message_add_tag (notmuch_message_t *message, const char *tag);
* NOTMUCH_STATUS_NULL_POINTER: The 'tag' argument is NULL
*
* NOTMUCH_STATUS_TAG_TOO_LONG: The length of 'tag' is longer than
- * too long (exceeds NOTMUCH_TAG_MAX)
+ * too long (exceeds NOTMUCH_TAG_MAX)
*/
notmuch_status_t
notmuch_message_remove_tag (notmuch_message_t *message, const char *tag);
projects / notmuch / blobdiff