X-Git-Url: https://git.notmuchmail.org/git?p=notmuch;a=blobdiff_plain;f=notmuch.h;h=230c298e2af0384a6d7fb2f6c621fe997554eb56;hp=522bf1b97eeafa833dc316bf7fd6c5a41b7ec89a;hb=c96021a47705bdb2ac189d52825a8edc033d35dd;hpb=1ba3d46fab12d616b2085f5794543444cc4bc750 diff --git a/notmuch.h b/notmuch.h index 522bf1b9..230c298e 100644 --- a/notmuch.h +++ b/notmuch.h @@ -75,6 +75,11 @@ typedef int notmuch_bool_t; * NOTMUCH_STATUS_TAG_TOO_LONG: A tag value is too long (exceeds * NOTMUCH_TAG_MAX) * + * NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW: The notmuch_message_thaw + * function has been called more times than notmuch_message_freeze. + * + * And finally: + * * NOTMUCH_STATUS_LAST_STATUS: Not an actual status value. Just a way * to find out how many valid status values there are. */ @@ -87,6 +92,7 @@ typedef enum _notmuch_status { NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID, NOTMUCH_STATUS_NULL_POINTER, NOTMUCH_STATUS_TAG_TOO_LONG, + NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW, NOTMUCH_STATUS_LAST_STATUS } notmuch_status_t; @@ -102,9 +108,9 @@ notmuch_status_to_string (notmuch_status_t status); * notmuch_ functions below. */ typedef struct _notmuch_database notmuch_database_t; typedef struct _notmuch_query notmuch_query_t; -typedef struct _notmuch_thread_results notmuch_thread_results_t; +typedef struct _notmuch_threads notmuch_threads_t; typedef struct _notmuch_thread notmuch_thread_t; -typedef struct _notmuch_message_results notmuch_message_results_t; +typedef struct _notmuch_messages notmuch_messages_t; typedef struct _notmuch_message notmuch_message_t; typedef struct _notmuch_tags notmuch_tags_t; @@ -240,11 +246,20 @@ notmuch_database_get_timestamp (notmuch_database_t *database, /* Add a new message to the given notmuch database. * * Here,'filename' should be a path relative to the the path of - * 'database' (see notmuch_database_get_path). The file should be a - * single mail message (not a multi-message mbox) that is expected to - * remain at its current location, (since the notmuch database will - * reference the filename, and will not copy the entire contents of - * the file. + * 'database' (see notmuch_database_get_path), or else should be an + * absolute filename with initial components that match the path of + * 'database'. + * + * The file should be a single mail message (not a multi-message mbox) + * that is expected to remain at its current location, (since the + * notmuch database will reference the filename, and will not copy the + * entire contents of the file. + * + * If 'message' is not NULL, then, on successful return '*message' + * will be initialized to a message object that can be used for things + * such as adding tags to the just-added message. The user should call + * notmuch_message_destroy when done with the message. On any failure + * '*message' will be set to NULL. * * Return value: * @@ -263,7 +278,8 @@ notmuch_database_get_timestamp (notmuch_database_t *database, */ notmuch_status_t notmuch_database_add_message (notmuch_database_t *database, - const char *filename); + const char *filename, + notmuch_message_t **message); /* Find a message with the given messsage_id. * @@ -315,24 +331,24 @@ typedef enum { void notmuch_query_set_sort (notmuch_query_t *query, notmuch_sort_t sort); -/* Execute a query for threads, returning a notmuch_thread_results_t - * object which can be used to iterate over the results. The results +/* Execute a query for threads, returning a notmuch_threads_t object + * which can be used to iterate over the results. The returned threads * object is owned by the query and as such, will only be valid until * notmuch_query_destroy. * * Typical usage might be: * * notmuch_query_t *query; - * notmuch_thread_results_t *results; + * notmuch_threads_t *threads; * notmuch_thread_t *thread; * * query = notmuch_query_create (database, query_string); * - * for (results = notmuch_query_search_threads (query); - * notmuch_thread_results_has_more (results); - * notmuch_thread_results_advance (results)) + * for (threads = notmuch_query_search_threads (query); + * notmuch_threads_has_more (threads); + * notmuch_threads_advance (threads)) * { - * thread = notmuch_thread_results_get (results); + * thread = notmuch_threads_get (threads); * .... * notmuch_thread_destroy (thread); * } @@ -347,31 +363,31 @@ notmuch_query_set_sort (notmuch_query_t *query, notmuch_sort_t sort); * destroyed. * * Note that there's no explicit destructor needed for the - * notmuch_thread_results_t object. (For consistency, we do provide a - * notmuch_thread_results_destroy function, but there's no good reason + * notmuch_threads_t object. (For consistency, we do provide a + * notmuch_threads_destroy function, but there's no good reason * to call it if the query is about to be destroyed). */ -notmuch_thread_results_t * +notmuch_threads_t * notmuch_query_search_threads (notmuch_query_t *query); -/* Execute a query for messages, returning a notmuch_message_results_t - * object which can be used to iterate over the results. The results - * object is owned by the query and as such, will only be valid until - * notmuch_query_destroy. +/* Execute a query for messages, returning a notmuch_messages_t object + * which can be used to iterate over the results. The returned + * messages object is owned by the query and as such, will only be + * valid until notmuch_query_destroy. * * Typical usage might be: * * notmuch_query_t *query; - * notmuch_message_results_t *results; + * notmuch_messages_t *messages; * notmuch_message_t *message; * * query = notmuch_query_create (database, query_string); * - * for (results = notmuch_query_search_messages (query); - * notmuch_message_results_has_more (results); - * notmuch_message_results_advance (results)) + * for (messages = notmuch_query_search_messages (query); + * notmuch_messages_has_more (messages); + * notmuch_messages_advance (messages)) * { - * message = notmuch_message_results_get (results); + * message = notmuch_messages_get (messages); * .... * notmuch_message_destroy (message); * } @@ -386,17 +402,17 @@ notmuch_query_search_threads (notmuch_query_t *query); * when the query is destroyed. * * Note that there's no explicit destructor needed for the - * notmuch_message_results_t object. (For consistency, we do provide a - * notmuch_message_results_destroy function, but there's no good + * notmuch_messages_t object. (For consistency, we do provide a + * notmuch_messages_destroy function, but there's no good * reason to call it if the query is about to be destroyed). */ -notmuch_message_results_t * +notmuch_messages_t * notmuch_query_search_messages (notmuch_query_t *query); /* Destroy a notmuch_query_t along with any associated resources. * - * This will in turn destroy any notmuch_thread_results_t and - * notmuch_message_results_t objects generated by this query, (and in + * This will in turn destroy any notmuch_threads_t and + * notmuch_messages_t objects generated by this query, (and in * turn any notmuch_thrad_t and notmuch_message_t objects generated * from those results, etc.), if such objects haven't already been * destroyed. @@ -404,49 +420,49 @@ notmuch_query_search_messages (notmuch_query_t *query); void notmuch_query_destroy (notmuch_query_t *query); -/* Does the given notmuch_thread_results_t object contain any more +/* Does the given notmuch_threads_t object contain any more * results. * - * When this function returns TRUE, notmuch_thread_results_get will + * When this function returns TRUE, notmuch_threads_get will * return a valid object. Whereas when this function returns FALSE, - * notmuch_thread_results_get will return NULL. + * notmuch_threads_get will return NULL. * * See the documentation of notmuch_query_search_threads for example - * code showing how to iterate over a notmuch_thread_results_t object. + * code showing how to iterate over a notmuch_threads_t object. */ notmuch_bool_t -notmuch_thread_results_has_more (notmuch_thread_results_t *results); +notmuch_threads_has_more (notmuch_threads_t *threads); -/* Get the current result from 'results' as a notmuch_thread_t. +/* Get the current thread from 'threads' as a notmuch_thread_t. * - * Note: The returned thread belongs to 'results' and has a lifetime + * Note: The returned thread belongs to 'threads' and has a lifetime * identical to it (and the query to which it belongs). * * See the documentation of notmuch_query_search_threads for example - * code showing how to iterate over a notmuch_thread_results_t object. + * code showing how to iterate over a notmuch_threads_t object. * * If an out-of-memory situation occurs, this function will return * NULL. */ notmuch_thread_t * -notmuch_thread_results_get (notmuch_thread_results_t *results); +notmuch_threads_get (notmuch_threads_t *threads); -/* Advance the 'results' iterator to the next result. +/* Advance the 'threads' iterator to the next thread. * * See the documentation of notmuch_query_search_threads for example - * code showing how to iterate over a notmuch_thread_results_t object. + * code showing how to iterate over a notmuch_threads_t object. */ void -notmuch_thread_results_advance (notmuch_thread_results_t *results); +notmuch_threads_advance (notmuch_threads_t *threads); -/* Destroy a notmuch_thread_results_t object. +/* Destroy a notmuch_threads_t object. * * It's not strictly necessary to call this function. All memory from - * the notmuch_thread_results_t object will be reclaimed when the + * the notmuch_threads_t object will be reclaimed when the * containg query object is destroyed. */ void -notmuch_thread_results_destroy (notmuch_thread_results_t *results); +notmuch_threads_destroy (notmuch_threads_t *threads); /* Get the thread ID of 'thread'. * @@ -458,56 +474,116 @@ notmuch_thread_results_destroy (notmuch_thread_results_t *results); const char * notmuch_thread_get_thread_id (notmuch_thread_t *thread); +/* Get the subject of 'thread' + * + * The subject is taken from the first message (according to the query + * order---see notmuch_query_set_sort) in the query results that + * belongs to this thread. + * + * The returned string belongs to 'thread' and as such, should not be + * modified by the caller and will only be valid for as long as the + * thread is valid, (which is until notmuch_thread_destroy or until + * the query from which it derived is destroyed). + */ +const char * +notmuch_thread_get_subject (notmuch_thread_t *thread); + +/* Get the date of the oldest message in 'thread' as a time_t value. + */ +time_t +notmuch_thread_get_oldest_date (notmuch_thread_t *thread); + +/* Get the date of the oldest message in 'thread' as a time_t value. + */ +time_t +notmuch_thread_get_newest_date (notmuch_thread_t *thread); + +/* Get the tags for 'thread', returning a notmuch_tags_t object which + * can be used to iterate over all tags. + * + * Note: In the Notmuch database, tags are stored on individual + * messages, not on threads. So the tags returned here will be all + * tags of the messages which matched the search and which belong to + * this thread. + * + * The tags object is owned by the thread and as such, will only be + * valid for as long as the thread is valid, (for example, until + * notmuch_thread_destroy or until the query from which it derived is + * destroyed). + * + * Typical usage might be: + * + * notmuch_thread_t *thread; + * notmuch_tags_t *tags; + * const char *tag; + * + * thread = notmuch_threads_get (threads); + * + * for (tags = notmuch_thread_get_tags (thread); + * notmuch_tags_has_more (tags); + * notmuch_result_advance (tags)) + * { + * tag = notmuch_tags_get (tags); + * .... + * } + * + * notmuch_thread_destroy (thread); + * + * Note that there's no explicit destructor needed for the + * notmuch_tags_t object. (For consistency, we do provide a + * notmuch_tags_destroy function, but there's no good reason to call + * it if the message is about to be destroyed). + */ +notmuch_tags_t * +notmuch_thread_get_tags (notmuch_thread_t *thread); + /* Destroy a notmuch_thread_t object. */ void notmuch_thread_destroy (notmuch_thread_t *thread); -/* Does the given notmuch_message_results_t object contain any more - * results. +/* Does the given notmuch_messages_t object contain any more + * messages. * - * When this function returns TRUE, notmuch_message_results_get will - * return a valid object. Whereas when this function returns FALSE, - * notmuch_message_results_get will return NULL. + * When this function returns TRUE, notmuch_messages_get will return a + * valid object. Whereas when this function returns FALSE, + * notmuch_messages_get will return NULL. * * See the documentation of notmuch_query_search_messages for example - * code showing how to iterate over a notmuch_message_results_t - * object. + * code showing how to iterate over a notmuch_messages_t object. */ notmuch_bool_t -notmuch_message_results_has_more (notmuch_message_results_t *results); +notmuch_messages_has_more (notmuch_messages_t *messages); -/* Get the current result from 'results' as a notmuch_message_t. +/* Get the current message from 'messages' as a notmuch_message_t. * - * Note: The returned message belongs to 'results' and has a lifetime + * Note: The returned message belongs to 'messages' and has a lifetime * identical to it (and the query to which it belongs). * * See the documentation of notmuch_query_search_messages for example - * code showing how to iterate over a notmuch_message_results_t - * object. + * code showing how to iterate over a notmuch_messages_t object. * * If an out-of-memory situation occurs, this function will return * NULL. */ notmuch_message_t * -notmuch_message_results_get (notmuch_message_results_t *results); +notmuch_messages_get (notmuch_messages_t *messages); -/* Advance the 'results' iterator to the next result. +/* Advance the 'messages' iterator to the next result. * * See the documentation of notmuch_query_search_messages for example - * code showing how to iterate over a notmuch_message_results_t - * object. + * code showing how to iterate over a notmuch_messages_t object. */ void -notmuch_message_results_advance (notmuch_message_results_t *results); +notmuch_messages_advance (notmuch_messages_t *messages); -/* Destroy a notmuch_message_results_t object. +/* Destroy a notmuch_messages_t object. * * It's not strictly necessary to call this function. All memory from - * the notmuch_message_results_t object will be reclaimed when the - * containg query object is destroyed. + * the notmuch_messages_t object will be reclaimed when the containg + * query object is destroyed. */ void -notmuch_message_results_destroy (notmuch_message_results_t *results); +notmuch_messages_destroy (notmuch_messages_t *messages); /* Get the message ID of 'message'. * @@ -539,14 +615,62 @@ notmuch_message_get_thread_id (notmuch_message_t *message); /* Get the 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() . + * The returned filename is an absolute filename, (the initial + * component will match notmuch_database_get_path() ). + * * The returned string belongs to the message so should not be * modified or freed by the caller (nor should it be referenced after * the message is destroyed). */ const char * notmuch_message_get_filename (notmuch_message_t *message); +/* Get the date of 'message' as a time_t value. + * + * For the original textual representation of the Date header from the + * message call notmuch_message_get_header() with a header value of + * "date". */ +time_t +notmuch_message_get_date (notmuch_message_t *message); + +/* Get the size in bytes of the full header section of 'message'. + * + * This is useful in conjunction with notmuch_message_get_filename + * for separately parsing the message header and content. + * + * Returns 0 in the case of any error. + */ +size_t +notmuch_message_get_header_size (notmuch_message_t *message); + +/* Get the value of the specified header from 'message'. + * + * The value will be read from the actual message file, not from the + * notmuch database. The header name is case insensitive. + * + * The returned string belongs to the message so should not be + * modified or freed by the caller (nor should it be referenced after + * the message is destroyed). + * + * Returns NULL if the message does not contain a header line matching + * 'header' of if any error occurs. + */ +const char * +notmuch_message_get_header (notmuch_message_t *message, const char *header); + +/* Get the entire set of headers from an email message as a string. + * + * The value will be read from the actual message file, not from the + * notmuch database. + * + * The returned value is owned by the notmuch message and is valid + * only until the message is closed. The caller should copy it if + * needing to modify the value or to hold onto it for longer. + * + * Returns NULL in the case of any error. + */ +const char * +notmuch_message_get_all_headers (notmuch_message_t *message); + /* Get the tags for 'message', returning a notmuch_tags_t object which * can be used to iterate over all tags. * @@ -591,8 +715,8 @@ notmuch_message_get_tags (notmuch_message_t *message); * * 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) + * NOTMUCH_STATUS_TAG_TOO_LONG: The length of 'tag' is too long + * (exceeds NOTMUCH_TAG_MAX) */ notmuch_status_t notmuch_message_add_tag (notmuch_message_t *message, const char *tag); @@ -601,16 +725,83 @@ notmuch_message_add_tag (notmuch_message_t *message, const char *tag); * * Return value: * - * NOTMUCH_STATUS_SUCCESS: Tag successfully added to message + * NOTMUCH_STATUS_SUCCESS: Tag successfully removed from message * * 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) + * NOTMUCH_STATUS_TAG_TOO_LONG: The length of 'tag' is too long + * (exceeds NOTMUCH_TAG_MAX) */ notmuch_status_t notmuch_message_remove_tag (notmuch_message_t *message, const char *tag); +/* Remove all tags from the given message. + * + * See notmuch_message_freeze for an example showing how to safely + * replace tag values. + */ +void +notmuch_message_remove_all_tags (notmuch_message_t *message); + +/* Freeze the current state of 'message' within the database. + * + * This means that changes to the message state, (via + * notmuch_message_add_tag, notmuch_message_remove_tag, and + * notmuch_message_remove_all_tags), will not be committed to the + * database until the message is thawed with notmuch_message_thaw. + * + * Multiple calls to freeze/thaw are valid and these calls with + * "stack". That is there must be as many calls to thaw as to freeze + * before a message is actually thawed. + * + * The ability to do freeze/thaw allows for safe transactions to + * change tag values. For example, explicitly setting a message to + * have a given set of tags might look like this: + * + * notmuch_message_freeze (message); + * + * notmuch_message_remove_all_tags (message); + * + * for (i = 0; i < NUM_TAGS; i++) + * notmuch_message_add_tag (message, tags[i]); + * + * notmuch_message_thaw (message); + * + * With freeze/thaw used like this, the message in the database is + * guaranteed to have either the full set of original tag value, or + * the full set of new tag values, but nothing in between. + * + * Imagine the example above without freeze/thaw and the operation + * somehow getting interrupted. This could result in the message being + * left with no tags if the interruption happened after + * notmuch_message_remove_all_tags but before notmuch_message_add_tag. + */ +void +notmuch_message_freeze (notmuch_message_t *message); + +/* Thaw the current 'message', synchronizing any changes that may have + * occurred while 'message' was frozen into the notmuch database. + * + * See notmuch_message_freeze for an example of how to use this + * function to safely provide tag changes. + * + * Multiple calls to freeze/thaw are valid and these calls with + * "stack". That is there must be as many calls to thaw as to freeze + * before a message is actually thawed. + * + * Return value: + * + * NOTMUCH_STATUS_SUCCESS: Message successfully thawed, (or at least + * its frozen count has successfully been reduced by 1). + * + * NOTMUCH_STATUS_UNBALANCE_FREEZE_THAW: An attempt was made to thaw + * an unfrozen message. That is, there have been an unbalanced + * number of calls to notmuch_message_freeze and + * notmuch_message_thaw. + */ +notmuch_status_t +notmuch_message_thaw (notmuch_message_t *message); + /* Destroy a notmuch_message_t object. * * It can be useful to call this function in the case of a single