1 /* The Ruby interface to the notmuch mail library
3 * Copyright © 2010, 2011 Ali Polatel
5 * This program is free software: you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation, either version 3 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program. If not, see https://www.gnu.org/licenses/ .
18 * Author: Ali Polatel <alip@exherbo.org>
24 * call-seq: THREAD.destroy! => nil
26 * Destroys the thread, freeing all resources allocated for it.
29 notmuch_rb_thread_destroy (VALUE self)
31 notmuch_rb_object_destroy (self, ¬much_rb_thread_type);
37 * call-seq: THREAD.thread_id => String
39 * Returns the thread id
42 notmuch_rb_thread_get_thread_id (VALUE self)
45 notmuch_thread_t *thread;
47 Data_Get_Notmuch_Thread (self, thread);
49 tid = notmuch_thread_get_thread_id (thread);
51 return rb_str_new2 (tid);
55 * call-seq: THREAD.total_messages => fixnum
57 * Returns the number of total messages
60 notmuch_rb_thread_get_total_messages (VALUE self)
62 notmuch_thread_t *thread;
64 Data_Get_Notmuch_Thread (self, thread);
66 return INT2FIX (notmuch_thread_get_total_messages (thread));
70 * call-seq: THREAD.toplevel_messages => MESSAGES
72 * Get a Notmuch::Messages iterator for the top level messages in thread.
75 notmuch_rb_thread_get_toplevel_messages (VALUE self)
77 notmuch_messages_t *messages;
78 notmuch_thread_t *thread;
80 Data_Get_Notmuch_Thread (self, thread);
82 messages = notmuch_thread_get_toplevel_messages (thread);
84 rb_raise (notmuch_rb_eMemoryError, "Out of memory");
86 return Data_Wrap_Notmuch_Object (notmuch_rb_cMessages, ¬much_rb_messages_type, messages);
90 * call-seq: THREAD.messages => MESSAGES
92 * Get a Notmuch::Messages iterator for the all messages in thread.
95 notmuch_rb_thread_get_messages (VALUE self)
97 notmuch_messages_t *messages;
98 notmuch_thread_t *thread;
100 Data_Get_Notmuch_Thread (self, thread);
102 messages = notmuch_thread_get_messages (thread);
104 rb_raise (notmuch_rb_eMemoryError, "Out of memory");
106 return Data_Wrap_Notmuch_Object (notmuch_rb_cMessages, ¬much_rb_messages_type, messages);
110 * call-seq: THREAD.matched_messages => fixnum
112 * Get the number of messages in thread that matched the search
115 notmuch_rb_thread_get_matched_messages (VALUE self)
117 notmuch_thread_t *thread;
119 Data_Get_Notmuch_Thread (self, thread);
121 return INT2FIX (notmuch_thread_get_matched_messages (thread));
125 * call-seq: THREAD.authors => String
127 * Get a comma-separated list of the names of the authors.
130 notmuch_rb_thread_get_authors (VALUE self)
133 notmuch_thread_t *thread;
135 Data_Get_Notmuch_Thread (self, thread);
137 authors = notmuch_thread_get_authors (thread);
139 return rb_str_new2 (authors);
143 * call-seq: THREAD.subject => String
145 * Returns the subject of the thread
148 notmuch_rb_thread_get_subject (VALUE self)
151 notmuch_thread_t *thread;
153 Data_Get_Notmuch_Thread (self, thread);
155 subject = notmuch_thread_get_subject (thread);
157 return rb_str_new2 (subject);
161 * call-seq: THREAD.oldest_date => Fixnum
163 * Get the date of the oldest message in thread.
166 notmuch_rb_thread_get_oldest_date (VALUE self)
168 notmuch_thread_t *thread;
170 Data_Get_Notmuch_Thread (self, thread);
172 return UINT2NUM (notmuch_thread_get_oldest_date (thread));
176 * call-seq: THREAD.newest_date => fixnum
178 * Get the date of the newest message in thread.
181 notmuch_rb_thread_get_newest_date (VALUE self)
183 notmuch_thread_t *thread;
185 Data_Get_Notmuch_Thread (self, thread);
187 return UINT2NUM (notmuch_thread_get_newest_date (thread));
191 * call-seq: THREAD.tags => TAGS
193 * Get a Notmuch::Tags iterator for the tags of the thread
196 notmuch_rb_thread_get_tags (VALUE self)
198 notmuch_thread_t *thread;
199 notmuch_tags_t *tags;
201 Data_Get_Notmuch_Thread (self, thread);
203 tags = notmuch_thread_get_tags (thread);
205 rb_raise (notmuch_rb_eMemoryError, "Out of memory");
207 return Data_Wrap_Notmuch_Object (notmuch_rb_cTags, ¬much_rb_tags_type, tags);