4 ffibuilder = cffi.FFI()
12 #if LIBNOTMUCH_MAJOR_VERSION < 5
13 #error libnotmuch version not supported by notmuch2 python bindings
15 #if LIBNOTMUCH_MINOR_VERSION < 1
16 #ERROR libnotmuch version < 5.1 not supported
19 include_dirs=['../../lib'],
20 library_dirs=['../../lib'],
21 libraries=['notmuch'],
26 typedef int... time_t;
28 #define LIBNOTMUCH_MAJOR_VERSION ...
29 #define LIBNOTMUCH_MINOR_VERSION ...
30 #define LIBNOTMUCH_MICRO_VERSION ...
32 #define NOTMUCH_TAG_MAX ...
34 typedef enum _notmuch_status {
35 NOTMUCH_STATUS_SUCCESS = 0,
36 NOTMUCH_STATUS_OUT_OF_MEMORY,
37 NOTMUCH_STATUS_READ_ONLY_DATABASE,
38 NOTMUCH_STATUS_XAPIAN_EXCEPTION,
39 NOTMUCH_STATUS_FILE_ERROR,
40 NOTMUCH_STATUS_FILE_NOT_EMAIL,
41 NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID,
42 NOTMUCH_STATUS_NULL_POINTER,
43 NOTMUCH_STATUS_TAG_TOO_LONG,
44 NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW,
45 NOTMUCH_STATUS_UNBALANCED_ATOMIC,
46 NOTMUCH_STATUS_UNSUPPORTED_OPERATION,
47 NOTMUCH_STATUS_UPGRADE_REQUIRED,
48 NOTMUCH_STATUS_PATH_ERROR,
49 NOTMUCH_STATUS_ILLEGAL_ARGUMENT,
50 NOTMUCH_STATUS_MALFORMED_CRYPTO_PROTOCOL,
51 NOTMUCH_STATUS_FAILED_CRYPTO_CONTEXT_CREATION,
52 NOTMUCH_STATUS_UNKNOWN_CRYPTO_PROTOCOL,
53 NOTMUCH_STATUS_NO_CONFIG,
54 NOTMUCH_STATUS_NO_DATABASE,
55 NOTMUCH_STATUS_DATABASE_EXISTS,
56 NOTMUCH_STATUS_LAST_STATUS
59 NOTMUCH_DATABASE_MODE_READ_ONLY = 0,
60 NOTMUCH_DATABASE_MODE_READ_WRITE
61 } notmuch_database_mode_t;
62 typedef int notmuch_bool_t;
63 typedef enum _notmuch_message_flag {
64 NOTMUCH_MESSAGE_FLAG_MATCH,
65 NOTMUCH_MESSAGE_FLAG_EXCLUDED,
66 NOTMUCH_MESSAGE_FLAG_GHOST,
67 } notmuch_message_flag_t;
69 NOTMUCH_SORT_OLDEST_FIRST,
70 NOTMUCH_SORT_NEWEST_FIRST,
71 NOTMUCH_SORT_MESSAGE_ID,
77 NOTMUCH_EXCLUDE_FALSE,
81 NOTMUCH_DECRYPT_FALSE,
84 NOTMUCH_DECRYPT_NOSTASH,
85 } notmuch_decryption_policy_t;
87 // These are fully opaque types for us, we only ever use pointers.
88 typedef struct _notmuch_database notmuch_database_t;
89 typedef struct _notmuch_query notmuch_query_t;
90 typedef struct _notmuch_threads notmuch_threads_t;
91 typedef struct _notmuch_thread notmuch_thread_t;
92 typedef struct _notmuch_messages notmuch_messages_t;
93 typedef struct _notmuch_message notmuch_message_t;
94 typedef struct _notmuch_tags notmuch_tags_t;
95 typedef struct _notmuch_string_map_iterator notmuch_message_properties_t;
96 typedef struct _notmuch_directory notmuch_directory_t;
97 typedef struct _notmuch_filenames notmuch_filenames_t;
98 typedef struct _notmuch_config_list notmuch_config_list_t;
99 typedef struct _notmuch_indexopts notmuch_indexopts_t;
102 notmuch_status_to_string (notmuch_status_t status);
105 notmuch_database_create_verbose (const char *path,
106 notmuch_database_t **database,
107 char **error_message);
109 notmuch_database_create (const char *path, notmuch_database_t **database);
111 notmuch_database_open_verbose (const char *path,
112 notmuch_database_mode_t mode,
113 notmuch_database_t **database,
114 char **error_message);
116 notmuch_database_open (const char *path,
117 notmuch_database_mode_t mode,
118 notmuch_database_t **database);
120 notmuch_database_close (notmuch_database_t *database);
122 notmuch_database_destroy (notmuch_database_t *database);
124 notmuch_database_get_path (notmuch_database_t *database);
126 notmuch_database_get_version (notmuch_database_t *database);
128 notmuch_database_needs_upgrade (notmuch_database_t *database);
130 notmuch_database_begin_atomic (notmuch_database_t *notmuch);
132 notmuch_database_end_atomic (notmuch_database_t *notmuch);
134 notmuch_database_get_revision (notmuch_database_t *notmuch,
137 notmuch_database_index_file (notmuch_database_t *database,
138 const char *filename,
139 notmuch_indexopts_t *indexopts,
140 notmuch_message_t **message);
142 notmuch_database_remove_message (notmuch_database_t *database,
143 const char *filename);
145 notmuch_database_find_message (notmuch_database_t *database,
146 const char *message_id,
147 notmuch_message_t **message);
149 notmuch_database_find_message_by_filename (notmuch_database_t *notmuch,
150 const char *filename,
151 notmuch_message_t **message);
153 notmuch_database_get_all_tags (notmuch_database_t *db);
156 notmuch_query_create (notmuch_database_t *database,
157 const char *query_string);
159 notmuch_query_get_query_string (const notmuch_query_t *query);
161 notmuch_query_get_database (const notmuch_query_t *query);
163 notmuch_query_set_omit_excluded (notmuch_query_t *query,
164 notmuch_exclude_t omit_excluded);
166 notmuch_query_set_sort (notmuch_query_t *query, notmuch_sort_t sort);
168 notmuch_query_get_sort (const notmuch_query_t *query);
170 notmuch_query_add_tag_exclude (notmuch_query_t *query, const char *tag);
172 notmuch_query_search_threads (notmuch_query_t *query,
173 notmuch_threads_t **out);
175 notmuch_query_search_messages (notmuch_query_t *query,
176 notmuch_messages_t **out);
178 notmuch_query_count_messages (notmuch_query_t *query, unsigned int *count);
180 notmuch_query_count_threads (notmuch_query_t *query, unsigned *count);
182 notmuch_query_destroy (notmuch_query_t *query);
185 notmuch_threads_valid (notmuch_threads_t *threads);
187 notmuch_threads_get (notmuch_threads_t *threads);
189 notmuch_threads_move_to_next (notmuch_threads_t *threads);
191 notmuch_threads_destroy (notmuch_threads_t *threads);
194 notmuch_thread_get_thread_id (notmuch_thread_t *thread);
196 notmuch_message_get_replies (notmuch_message_t *message);
198 notmuch_thread_get_total_messages (notmuch_thread_t *thread);
200 notmuch_thread_get_toplevel_messages (notmuch_thread_t *thread);
202 notmuch_thread_get_messages (notmuch_thread_t *thread);
204 notmuch_thread_get_matched_messages (notmuch_thread_t *thread);
206 notmuch_thread_get_authors (notmuch_thread_t *thread);
208 notmuch_thread_get_subject (notmuch_thread_t *thread);
210 notmuch_thread_get_oldest_date (notmuch_thread_t *thread);
212 notmuch_thread_get_newest_date (notmuch_thread_t *thread);
214 notmuch_thread_get_tags (notmuch_thread_t *thread);
216 notmuch_thread_destroy (notmuch_thread_t *thread);
219 notmuch_messages_valid (notmuch_messages_t *messages);
221 notmuch_messages_get (notmuch_messages_t *messages);
223 notmuch_messages_move_to_next (notmuch_messages_t *messages);
225 notmuch_messages_destroy (notmuch_messages_t *messages);
227 notmuch_messages_collect_tags (notmuch_messages_t *messages);
230 notmuch_message_get_message_id (notmuch_message_t *message);
232 notmuch_message_get_thread_id (notmuch_message_t *message);
234 notmuch_message_get_filename (notmuch_message_t *message);
235 notmuch_filenames_t *
236 notmuch_message_get_filenames (notmuch_message_t *message);
238 notmuch_message_get_flag (notmuch_message_t *message,
239 notmuch_message_flag_t flag);
241 notmuch_message_set_flag (notmuch_message_t *message,
242 notmuch_message_flag_t flag,
243 notmuch_bool_t value);
245 notmuch_message_get_date (notmuch_message_t *message);
247 notmuch_message_get_header (notmuch_message_t *message,
250 notmuch_message_get_tags (notmuch_message_t *message);
252 notmuch_message_add_tag (notmuch_message_t *message, const char *tag);
254 notmuch_message_remove_tag (notmuch_message_t *message, const char *tag);
256 notmuch_message_remove_all_tags (notmuch_message_t *message);
258 notmuch_message_maildir_flags_to_tags (notmuch_message_t *message);
260 notmuch_message_tags_to_maildir_flags (notmuch_message_t *message);
262 notmuch_message_freeze (notmuch_message_t *message);
264 notmuch_message_thaw (notmuch_message_t *message);
266 notmuch_message_get_property (notmuch_message_t *message,
267 const char *key, const char **value);
269 notmuch_message_add_property (notmuch_message_t *message,
270 const char *key, const char *value);
272 notmuch_message_remove_property (notmuch_message_t *message,
273 const char *key, const char *value);
275 notmuch_message_remove_all_properties (notmuch_message_t *message,
277 notmuch_message_properties_t *
278 notmuch_message_get_properties (notmuch_message_t *message,
279 const char *key, notmuch_bool_t exact);
281 notmuch_message_properties_valid (notmuch_message_properties_t
284 notmuch_message_properties_move_to_next (notmuch_message_properties_t
287 notmuch_message_properties_key (notmuch_message_properties_t *properties);
289 notmuch_message_properties_value (notmuch_message_properties_t
292 notmuch_message_properties_destroy (notmuch_message_properties_t
295 notmuch_message_destroy (notmuch_message_t *message);
298 notmuch_tags_valid (notmuch_tags_t *tags);
300 notmuch_tags_get (notmuch_tags_t *tags);
302 notmuch_tags_move_to_next (notmuch_tags_t *tags);
304 notmuch_tags_destroy (notmuch_tags_t *tags);
307 notmuch_filenames_valid (notmuch_filenames_t *filenames);
309 notmuch_filenames_get (notmuch_filenames_t *filenames);
311 notmuch_filenames_move_to_next (notmuch_filenames_t *filenames);
313 notmuch_filenames_destroy (notmuch_filenames_t *filenames);
314 notmuch_indexopts_t *
315 notmuch_database_get_default_indexopts (notmuch_database_t *db);
317 notmuch_indexopts_set_decrypt_policy (notmuch_indexopts_t *indexopts,
318 notmuch_decryption_policy_t decrypt_policy);
319 notmuch_decryption_policy_t
320 notmuch_indexopts_get_decrypt_policy (const notmuch_indexopts_t *indexopts);
322 notmuch_indexopts_destroy (notmuch_indexopts_t *options);
325 notmuch_database_set_config (notmuch_database_t *db, const char *key, const char *value);
327 notmuch_database_get_config (notmuch_database_t *db, const char *key, char **value);
329 notmuch_database_get_config_list (notmuch_database_t *db, const char *prefix, notmuch_config_list_t **out);
331 notmuch_config_list_valid (notmuch_config_list_t *config_list);
333 notmuch_config_list_key (notmuch_config_list_t *config_list);
335 notmuch_config_list_value (notmuch_config_list_t *config_list);
337 notmuch_config_list_move_to_next (notmuch_config_list_t *config_list);
339 notmuch_config_list_destroy (notmuch_config_list_t *config_list);
344 if __name__ == '__main__':
345 ffibuilder.compile(verbose=True)