mailbox-list-private.h revision 533bfba437e4120aa29dd45bca2aa87e30ee28a2
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher#ifndef __MAILBOX_LIST_PRIVATE_H
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher#define __MAILBOX_LIST_PRIVATE_H
ee359fe1384507fed6c2274e7bfe81d288de4542Stephen Gallagher
33396dc46ea52c18f47db1b5d590880806521005Sumit Bose#include "mail-namespace.h"
ee359fe1384507fed6c2274e7bfe81d288de4542Stephen Gallagher#include "mailbox-list.h"
33396dc46ea52c18f47db1b5d590880806521005Sumit Bose
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagherstruct dirent;
324fb26ba803a999bedc29e93c46c84f27abf5b7Sumit Bose
324fb26ba803a999bedc29e93c46c84f27abf5b7Sumit Bosestruct mailbox_list_vfuncs {
324fb26ba803a999bedc29e93c46c84f27abf5b7Sumit Bose struct mailbox_list *(*alloc)(void);
324fb26ba803a999bedc29e93c46c84f27abf5b7Sumit Bose void (*deinit)(struct mailbox_list *list);
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher bool (*is_valid_pattern)(struct mailbox_list *list,
84ae5edab16ad6be5e3be956cb6fa031c1428eb5Stephen Gallagher const char *pattern);
84ae5edab16ad6be5e3be956cb6fa031c1428eb5Stephen Gallagher bool (*is_valid_existing_name)(struct mailbox_list *list,
84ae5edab16ad6be5e3be956cb6fa031c1428eb5Stephen Gallagher const char *name);
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher bool (*is_valid_create_name)(struct mailbox_list *list,
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher const char *name);
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher const char *(*get_path)(struct mailbox_list *list, const char *name,
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher enum mailbox_list_path_type type);
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher int (*get_mailbox_name_status)(struct mailbox_list *list,
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher const char *name,
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher enum mailbox_name_status *status);
84ae5edab16ad6be5e3be956cb6fa031c1428eb5Stephen Gallagher
cc98edd9479d4622634a1275c98058916c14059aStephen Gallagher const char *(*get_temp_prefix)(struct mailbox_list *list);
ee359fe1384507fed6c2274e7bfe81d288de4542Stephen Gallagher const char *(*join_refpattern)(struct mailbox_list *list,
cc98edd9479d4622634a1275c98058916c14059aStephen Gallagher const char *ref, const char *pattern);
1183d29d87c5c7439cf2364b7d7324d4a13b6e35Stephen Gallagher
1183d29d87c5c7439cf2364b7d7324d4a13b6e35Stephen Gallagher struct mailbox_list_iterate_context *
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher (*iter_init)(struct mailbox_list *list, const char *pattern,
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher enum mailbox_list_iter_flags flags);
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher const struct mailbox_info *
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher (*iter_next)(struct mailbox_list_iterate_context *ctx);
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher int (*iter_deinit)(struct mailbox_list_iterate_context *ctx);
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher /* Returns -1 if error, 0 if it's not a valid mailbox, 1 if it is.
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher flags may be updated (especially the children flags). */
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher int (*iter_is_mailbox)(struct mailbox_list_iterate_context *ctx,
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher const char *dir, const char *fname,
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher enum mailbox_list_file_type type,
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher enum mailbox_info_flags *flags_r);
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher
c89589fa349f38214c9cb8d9389c0fd557e5dca2Simo Sorce int (*set_subscribed)(struct mailbox_list *list,
c89589fa349f38214c9cb8d9389c0fd557e5dca2Simo Sorce const char *name, bool set);
c89589fa349f38214c9cb8d9389c0fd557e5dca2Simo Sorce int (*delete_mailbox)(struct mailbox_list *list, const char *name);
c89589fa349f38214c9cb8d9389c0fd557e5dca2Simo Sorce int (*rename_mailbox)(struct mailbox_list *list, const char *oldname,
c89589fa349f38214c9cb8d9389c0fd557e5dca2Simo Sorce const char *newname);
c89589fa349f38214c9cb8d9389c0fd557e5dca2Simo Sorce};
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagherstruct mailbox_list_module_register {
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher unsigned int id;
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher};
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagherunion mailbox_list_module_context {
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher struct mailbox_list_vfuncs super;
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher struct mailbox_list_module_register *reg;
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher};
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagherstruct mailbox_list {
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher const char *name;
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher char hierarchy_sep;
d921c1eba437662437847279f251a0a5d8f70127Maxim size_t mailbox_name_max_length;
d921c1eba437662437847279f251a0a5d8f70127Maxim
d921c1eba437662437847279f251a0a5d8f70127Maxim struct mailbox_list_vfuncs v;
d921c1eba437662437847279f251a0a5d8f70127Maxim
d921c1eba437662437847279f251a0a5d8f70127Maxim/* private: */
d921c1eba437662437847279f251a0a5d8f70127Maxim pool_t pool;
d921c1eba437662437847279f251a0a5d8f70127Maxim struct mail_namespace *ns;
327127bb7fcc07f882209f029e14026de1b23c94Maxim struct mailbox_list_settings set;
327127bb7fcc07f882209f029e14026de1b23c94Maxim enum mailbox_list_flags flags;
327127bb7fcc07f882209f029e14026de1b23c94Maxim
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher /* -1 if unset: */
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher uid_t cached_uid;
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher gid_t cached_gid;
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher char *error_string;
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher enum mail_error error;
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher bool temporary_error;
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher ARRAY_DEFINE(module_contexts, union mailbox_list_module_context *);
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher};
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagherstruct mailbox_list_iterate_context {
4b6a0d0b3d42e5fdb457f47d9adfa5e66b160256Stephen Gallagher struct mailbox_list *list;
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher enum mailbox_list_iter_flags flags;
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher bool failed;
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher};
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher/* Modules should use do "my_id = mailbox_list_module_id++" and
068dbee9ca7bf5b37330eff91c94ae10f288d09fJakub Hrozek use objects' module_contexts[id] for their own purposes. */
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagherextern struct mailbox_list_module_register mailbox_list_module_register;
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagherextern void (*hook_mailbox_list_created)(struct mailbox_list *list);
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagherint mailbox_list_delete_index_control(struct mailbox_list *list,
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher const char *name);
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagherbool mailbox_list_name_is_too_large(const char *name, char sep);
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagherenum mailbox_list_file_type mailbox_list_get_file_type(const struct dirent *d);
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallaghervoid mailbox_list_clear_error(struct mailbox_list *list);
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallaghervoid mailbox_list_set_error(struct mailbox_list *list,
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher enum mail_error error, const char *string);
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallaghervoid mailbox_list_set_critical(struct mailbox_list *list, const char *fmt, ...)
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher __attr_format__(2, 3);
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallaghervoid mailbox_list_set_internal_error(struct mailbox_list *list);
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagherbool mailbox_list_set_error_from_errno(struct mailbox_list *list);
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher#endif
551aa6c36797ed720487f5974dcadabf19e6ff9fStephen Gallagher