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 http://www.gnu.org/licenses/ .
18 * Author: Ali Polatel <alip@exherbo.org>
24 * Document-module: Notmuch
28 * Ruby extension to the <tt>notmuch</tt> mail library.
32 * Following are the classes that are most likely to be of interest to
36 * - Notmuch::FileNames
50 ID_call = rb_intern("call");
51 ID_db_create = rb_intern("create");
52 ID_db_mode = rb_intern("mode");
54 mod = rb_define_module("Notmuch");
57 * Document-const: Notmuch::MODE_READ_ONLY
59 * Open the database in read only mode
61 rb_define_const(mod, "MODE_READ_ONLY", INT2FIX(NOTMUCH_DATABASE_MODE_READ_ONLY));
63 * Document-const: Notmuch::MODE_READ_WRITE
65 * Open the database in read write mode
67 rb_define_const(mod, "MODE_READ_WRITE", INT2FIX(NOTMUCH_DATABASE_MODE_READ_WRITE));
69 * Document-const: Notmuch::SORT_OLDEST_FIRST
71 * Sort query results by oldest first
73 rb_define_const(mod, "SORT_OLDEST_FIRST", INT2FIX(NOTMUCH_SORT_OLDEST_FIRST));
75 * Document-const: Notmuch::SORT_NEWEST_FIRST
77 * Sort query results by newest first
79 rb_define_const(mod, "SORT_NEWEST_FIRST", INT2FIX(NOTMUCH_SORT_NEWEST_FIRST));
81 * Document-const: Notmuch::SORT_MESSAGE_ID
83 * Sort query results by message id
85 rb_define_const(mod, "SORT_MESSAGE_ID", INT2FIX(NOTMUCH_SORT_MESSAGE_ID));
87 * Document-const: Notmuch::SORT_UNSORTED
89 * Do not sort query results
91 rb_define_const(mod, "SORT_UNSORTED", INT2FIX(NOTMUCH_SORT_UNSORTED));
93 * Document-const: Notmuch::MESSAGE_FLAG_MATCH
95 * Message flag "match"
97 rb_define_const(mod, "MESSAGE_FLAG_MATCH", INT2FIX(NOTMUCH_MESSAGE_FLAG_MATCH));
99 * Document-const: Notmuch::TAG_MAX
101 * Maximum allowed length of a tag
103 rb_define_const(mod, "TAG_MAX", INT2FIX(NOTMUCH_TAG_MAX));
106 * Document-class: Notmuch::BaseError
108 * Base class for all notmuch exceptions
110 notmuch_rb_eBaseError = rb_define_class_under(mod, "BaseError", rb_eStandardError);
112 * Document-class: Notmuch::DatabaseError
114 * Raised when the database can't be created or opened.
116 notmuch_rb_eDatabaseError = rb_define_class_under(mod, "DatabaseError", notmuch_rb_eBaseError);
118 * Document-class: Notmuch::MemoryError
120 * Raised when notmuch is out of memory
122 notmuch_rb_eMemoryError = rb_define_class_under(mod, "MemoryError", notmuch_rb_eBaseError);
124 * Document-class: Notmuch::ReadOnlyError
126 * Raised when an attempt was made to write to a database opened in read-only
129 notmuch_rb_eReadOnlyError = rb_define_class_under(mod, "ReadOnlyError", notmuch_rb_eBaseError);
131 * Document-class: Notmuch::XapianError
133 * Raised when a Xapian exception occurs
135 notmuch_rb_eXapianError = rb_define_class_under(mod, "XapianError", notmuch_rb_eBaseError);
137 * Document-class: Notmuch::FileError
139 * Raised when an error occurs trying to read or write to a file.
141 notmuch_rb_eFileError = rb_define_class_under(mod, "FileError", notmuch_rb_eBaseError);
143 * Document-class: Notmuch::FileNotEmailError
145 * Raised when a file is presented that doesn't appear to be an email message.
147 notmuch_rb_eFileNotEmailError = rb_define_class_under(mod, "FileNotEmailError", notmuch_rb_eBaseError);
149 * Document-class: Notmuch::NullPointerError
151 * Raised when the user erroneously passes a +NULL+ pointer to a notmuch
154 notmuch_rb_eNullPointerError = rb_define_class_under(mod, "NullPointerError", notmuch_rb_eBaseError);
156 * Document-class: Notmuch::TagTooLongError
158 * Raised when a tag value is too long (exceeds Notmuch::TAG_MAX)
160 notmuch_rb_eTagTooLongError = rb_define_class_under(mod, "TagTooLongError", notmuch_rb_eBaseError);
162 * Document-class: Notmuch::UnbalancedFreezeThawError
164 * Raised when the notmuch_message_thaw function has been called more times
165 * than notmuch_message_freeze.
167 notmuch_rb_eUnbalancedFreezeThawError = rb_define_class_under(mod, "UnbalancedFreezeThawError",
168 notmuch_rb_eBaseError);
170 * Document-class: Notmuch::UnbalancedAtomicError
172 * Raised when notmuch_database_end_atomic has been called more times than
173 * notmuch_database_begin_atomic
175 notmuch_rb_eUnbalancedAtomicError = rb_define_class_under(mod, "UnbalancedAtomicError",
176 notmuch_rb_eBaseError);
178 * Document-class: Notmuch::Database
180 * Notmuch database interaction
182 notmuch_rb_cDatabase = rb_define_class_under(mod, "Database", rb_cData);
183 rb_define_alloc_func(notmuch_rb_cDatabase, notmuch_rb_database_alloc);
184 rb_define_singleton_method(notmuch_rb_cDatabase, "open", notmuch_rb_database_open, -1); /* in database.c */
185 rb_define_method(notmuch_rb_cDatabase, "initialize", notmuch_rb_database_initialize, -1); /* in database.c */
186 rb_define_method(notmuch_rb_cDatabase, "close", notmuch_rb_database_close, 0); /* in database.c */
187 rb_define_method(notmuch_rb_cDatabase, "path", notmuch_rb_database_path, 0); /* in database.c */
188 rb_define_method(notmuch_rb_cDatabase, "version", notmuch_rb_database_version, 0); /* in database.c */
189 rb_define_method(notmuch_rb_cDatabase, "needs_upgrade?", notmuch_rb_database_needs_upgrade, 0); /* in database.c */
190 rb_define_method(notmuch_rb_cDatabase, "upgrade!", notmuch_rb_database_upgrade, 0); /* in database.c */
191 rb_define_method(notmuch_rb_cDatabase, "begin_atomic", notmuch_rb_database_begin_atomic, 0); /* in database.c */
192 rb_define_method(notmuch_rb_cDatabase, "end_atomic", notmuch_rb_database_end_atomic, 0); /* in database.c */
193 rb_define_method(notmuch_rb_cDatabase, "get_directory", notmuch_rb_database_get_directory, 1); /* in database.c */
194 rb_define_method(notmuch_rb_cDatabase, "add_message", notmuch_rb_database_add_message, 1); /* in database.c */
195 rb_define_method(notmuch_rb_cDatabase, "remove_message", notmuch_rb_database_remove_message, 1); /* in database.c */
196 rb_define_method(notmuch_rb_cDatabase, "query", notmuch_rb_database_query_create, 1); /* in database.c */
199 * Document-class: Notmuch::Directory
203 notmuch_rb_cDirectory = rb_define_class_under(mod, "Directory", rb_cData);
204 rb_undef_method(notmuch_rb_cDirectory, "initialize");
205 rb_define_method(notmuch_rb_cDirectory, "destroy!", notmuch_rb_directory_destroy, 0); /* in directory.c */
206 rb_define_method(notmuch_rb_cDirectory, "mtime", notmuch_rb_directory_get_mtime, 0); /* in directory.c */
207 rb_define_method(notmuch_rb_cDirectory, "mtime=", notmuch_rb_directory_set_mtime, 1); /* in directory.c */
208 rb_define_method(notmuch_rb_cDirectory, "child_files", notmuch_rb_directory_get_child_files, 0); /* in directory.c */
209 rb_define_method(notmuch_rb_cDirectory, "child_directories", notmuch_rb_directory_get_child_directories, 0); /* in directory.c */
212 * Document-class: Notmuch::FileNames
216 notmuch_rb_cFileNames = rb_define_class_under(mod, "FileNames", rb_cData);
217 rb_undef_method(notmuch_rb_cFileNames, "initialize");
218 rb_define_method(notmuch_rb_cFileNames, "destroy!", notmuch_rb_filenames_destroy, 0); /* in filenames.c */
219 rb_define_method(notmuch_rb_cFileNames, "each", notmuch_rb_filenames_each, 0); /* in filenames.c */
220 rb_include_module(notmuch_rb_cFileNames, rb_mEnumerable);
223 * Document-class: Notmuch::Query
227 notmuch_rb_cQuery = rb_define_class_under(mod, "Query", rb_cData);
228 rb_undef_method(notmuch_rb_cQuery, "initialize");
229 rb_define_method(notmuch_rb_cQuery, "destroy!", notmuch_rb_query_destroy, 0); /* in query.c */
230 rb_define_method(notmuch_rb_cQuery, "sort", notmuch_rb_query_get_sort, 0); /* in query.c */
231 rb_define_method(notmuch_rb_cQuery, "sort=", notmuch_rb_query_set_sort, 1); /* in query.c */
232 rb_define_method(notmuch_rb_cQuery, "to_s", notmuch_rb_query_get_string, 0); /* in query.c */
233 rb_define_method(notmuch_rb_cQuery, "search_threads", notmuch_rb_query_search_threads, 0); /* in query.c */
234 rb_define_method(notmuch_rb_cQuery, "search_messages", notmuch_rb_query_search_messages, 0); /* in query.c */
237 * Document-class: Notmuch::Threads
241 notmuch_rb_cThreads = rb_define_class_under(mod, "Threads", rb_cData);
242 rb_undef_method(notmuch_rb_cThreads, "initialize");
243 rb_define_method(notmuch_rb_cThreads, "destroy!", notmuch_rb_threads_destroy, 0); /* in threads.c */
244 rb_define_method(notmuch_rb_cThreads, "each", notmuch_rb_threads_each, 0); /* in threads.c */
245 rb_include_module(notmuch_rb_cThreads, rb_mEnumerable);
248 * Document-class: Notmuch::Messages
252 notmuch_rb_cMessages = rb_define_class_under(mod, "Messages", rb_cData);
253 rb_undef_method(notmuch_rb_cMessages, "initialize");
254 rb_define_method(notmuch_rb_cMessages, "destroy!", notmuch_rb_messages_destroy, 0); /* in messages.c */
255 rb_define_method(notmuch_rb_cMessages, "each", notmuch_rb_messages_each, 0); /* in messages.c */
256 rb_define_method(notmuch_rb_cMessages, "tags", notmuch_rb_messages_collect_tags, 0); /* in messages.c */
257 rb_include_module(notmuch_rb_cMessages, rb_mEnumerable);
260 * Document-class: Notmuch::Thread
264 notmuch_rb_cThread = rb_define_class_under(mod, "Thread", rb_cData);
265 rb_undef_method(notmuch_rb_cThread, "initialize");
266 rb_define_method(notmuch_rb_cThread, "destroy!", notmuch_rb_thread_destroy, 0); /* in thread.c */
267 rb_define_method(notmuch_rb_cThread, "thread_id", notmuch_rb_thread_get_thread_id, 0); /* in thread.c */
268 rb_define_method(notmuch_rb_cThread, "total_messages", notmuch_rb_thread_get_total_messages, 0); /* in thread.c */
269 rb_define_method(notmuch_rb_cThread, "toplevel_messages", notmuch_rb_thread_get_toplevel_messages, 0); /* in thread.c */
270 rb_define_method(notmuch_rb_cThread, "matched_messages", notmuch_rb_thread_get_matched_messages, 0); /* in thread.c */
271 rb_define_method(notmuch_rb_cThread, "authors", notmuch_rb_thread_get_authors, 0); /* in thread.c */
272 rb_define_method(notmuch_rb_cThread, "subject", notmuch_rb_thread_get_subject, 0); /* in thread.c */
273 rb_define_method(notmuch_rb_cThread, "oldest_date", notmuch_rb_thread_get_oldest_date, 0); /* in thread.c */
274 rb_define_method(notmuch_rb_cThread, "newest_date", notmuch_rb_thread_get_newest_date, 0); /* in thread.c */
275 rb_define_method(notmuch_rb_cThread, "tags", notmuch_rb_thread_get_tags, 0); /* in thread.c */
278 * Document-class: Notmuch::Message
282 notmuch_rb_cMessage = rb_define_class_under(mod, "Message", rb_cData);
283 rb_undef_method(notmuch_rb_cMessage, "initialize");
284 rb_define_method(notmuch_rb_cMessage, "destroy!", notmuch_rb_message_destroy, 0); /* in message.c */
285 rb_define_method(notmuch_rb_cMessage, "message_id", notmuch_rb_message_get_message_id, 0); /* in message.c */
286 rb_define_method(notmuch_rb_cMessage, "thread_id", notmuch_rb_message_get_thread_id, 0); /* in message.c */
287 rb_define_method(notmuch_rb_cMessage, "replies", notmuch_rb_message_get_replies, 0); /* in message.c */
288 rb_define_method(notmuch_rb_cMessage, "filename", notmuch_rb_message_get_filename, 0); /* in message.c */
289 rb_define_method(notmuch_rb_cMessage, "filenames", notmuch_rb_message_get_filenames, 0); /* in message.c */
290 rb_define_method(notmuch_rb_cMessage, "get_flag", notmuch_rb_message_get_flag, 1); /* in message.c */
291 rb_define_method(notmuch_rb_cMessage, "set_flag", notmuch_rb_message_set_flag, 2); /* in message.c */
292 rb_define_method(notmuch_rb_cMessage, "date", notmuch_rb_message_get_date, 0); /* in message.c */
293 rb_define_method(notmuch_rb_cMessage, "header", notmuch_rb_message_get_header, 1); /* in message.c */
294 rb_define_alias(notmuch_rb_cMessage, "[]", "header");
295 rb_define_method(notmuch_rb_cMessage, "tags", notmuch_rb_message_get_tags, 0); /* in message.c */
296 rb_define_method(notmuch_rb_cMessage, "add_tag", notmuch_rb_message_add_tag, 1); /* in message.c */
297 rb_define_alias(notmuch_rb_cMessage, "<<", "add_tag");
298 rb_define_method(notmuch_rb_cMessage, "remove_tag", notmuch_rb_message_remove_tag, 1); /* in message.c */
299 rb_define_method(notmuch_rb_cMessage, "remove_all_tags", notmuch_rb_message_remove_all_tags, 0); /* in message.c */
300 rb_define_method(notmuch_rb_cMessage, "maildir_flags_to_tags", notmuch_rb_message_maildir_flags_to_tags, 0); /* in message.c */
301 rb_define_method(notmuch_rb_cMessage, "tags_to_maildir_flags", notmuch_rb_message_tags_to_maildir_flags, 0); /* in message.c */
302 rb_define_method(notmuch_rb_cMessage, "freeze", notmuch_rb_message_freeze, 0); /* in message.c */
303 rb_define_method(notmuch_rb_cMessage, "thaw", notmuch_rb_message_thaw, 0); /* in message.c */
306 * Document-class: Notmuch::Tags
310 notmuch_rb_cTags = rb_define_class_under(mod, "Tags", rb_cData);
311 rb_undef_method(notmuch_rb_cTags, "initialize");
312 rb_define_method(notmuch_rb_cTags, "destroy!", notmuch_rb_tags_destroy, 0); /* in tags.c */
313 rb_define_method(notmuch_rb_cTags, "each", notmuch_rb_tags_each, 0); /* in tags.c */
314 rb_include_module(notmuch_rb_cTags, rb_mEnumerable);