diff options
author | Carl Worth <cworth@cworth.org> | 2009-10-26 14:46:14 -0700 |
---|---|---|
committer | Carl Worth <cworth@cworth.org> | 2009-10-26 14:46:14 -0700 |
commit | 94f01d9de914b609e1f02385092b82fd61ca73b5 (patch) | |
tree | fcc611cb8fddbb520504a32ee0dd103a1ef0c075 /notmuch.h | |
parent | ef3ab5781a3730e019f92517366029540a960cd0 (diff) |
Add notmuch_thread_get_tags
And augment "notmuch search" to print tag values as well as thread ID
values. This tool is almost usable now.
Diffstat (limited to 'notmuch.h')
-rw-r--r-- | notmuch.h | 39 |
1 files changed, 39 insertions, 0 deletions
@@ -458,6 +458,45 @@ notmuch_thread_results_destroy (notmuch_thread_results_t *results); const char * notmuch_thread_get_thread_id (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_thread_results_get (thread_results); + * + * 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); |