mailbox-list-private.h revision c040ee67d0ac0fb7375bb543965bf67dcae6affa
2454dfa32c93c20a8522c6ed42fe057baaac9f9aStephan Bosch#ifndef MAILBOX_LIST_PRIVATE_H
1279090ba03f9c176976a69ab7718f0ed77b19afTimo Sirainen#define MAILBOX_LIST_PRIVATE_H
1279090ba03f9c176976a69ab7718f0ed77b19afTimo Sirainen
1279090ba03f9c176976a69ab7718f0ed77b19afTimo Sirainen#include "mail-namespace.h"
d97f939b1c09e9f90b01b6f81bfb1c05da990148Timo Sirainen#include "mailbox-list.h"
1279090ba03f9c176976a69ab7718f0ed77b19afTimo Sirainen
1279090ba03f9c176976a69ab7718f0ed77b19afTimo Sirainenstruct dirent;
1279090ba03f9c176976a69ab7718f0ed77b19afTimo Sirainenstruct imap_match_glob;
1279090ba03f9c176976a69ab7718f0ed77b19afTimo Sirainenstruct mailbox_tree_context;
0c909e3461607eadcd66f4eac69b7f34e37fccf1Timo Sirainen
0c909e3461607eadcd66f4eac69b7f34e37fccf1Timo Sirainenstruct mailbox_list_vfuncs {
0c909e3461607eadcd66f4eac69b7f34e37fccf1Timo Sirainen struct mailbox_list *(*alloc)(void);
0c909e3461607eadcd66f4eac69b7f34e37fccf1Timo Sirainen void (*deinit)(struct mailbox_list *list);
0c909e3461607eadcd66f4eac69b7f34e37fccf1Timo Sirainen
0c909e3461607eadcd66f4eac69b7f34e37fccf1Timo Sirainen bool (*is_valid_pattern)(struct mailbox_list *list,
0c909e3461607eadcd66f4eac69b7f34e37fccf1Timo Sirainen const char *pattern);
0c909e3461607eadcd66f4eac69b7f34e37fccf1Timo Sirainen bool (*is_valid_existing_name)(struct mailbox_list *list,
0c909e3461607eadcd66f4eac69b7f34e37fccf1Timo Sirainen const char *name);
0c909e3461607eadcd66f4eac69b7f34e37fccf1Timo Sirainen bool (*is_valid_create_name)(struct mailbox_list *list,
0c909e3461607eadcd66f4eac69b7f34e37fccf1Timo Sirainen const char *name);
0c909e3461607eadcd66f4eac69b7f34e37fccf1Timo Sirainen
0c909e3461607eadcd66f4eac69b7f34e37fccf1Timo Sirainen const char *(*get_path)(struct mailbox_list *list, const char *name,
0c909e3461607eadcd66f4eac69b7f34e37fccf1Timo Sirainen enum mailbox_list_path_type type);
0c909e3461607eadcd66f4eac69b7f34e37fccf1Timo Sirainen int (*get_mailbox_name_status)(struct mailbox_list *list,
0c909e3461607eadcd66f4eac69b7f34e37fccf1Timo Sirainen const char *name,
0c909e3461607eadcd66f4eac69b7f34e37fccf1Timo Sirainen enum mailbox_name_status *status);
0c909e3461607eadcd66f4eac69b7f34e37fccf1Timo Sirainen
0c909e3461607eadcd66f4eac69b7f34e37fccf1Timo Sirainen const char *(*get_temp_prefix)(struct mailbox_list *list, bool global);
0c909e3461607eadcd66f4eac69b7f34e37fccf1Timo Sirainen const char *(*join_refpattern)(struct mailbox_list *list,
1279090ba03f9c176976a69ab7718f0ed77b19afTimo Sirainen const char *ref, const char *pattern);
1279090ba03f9c176976a69ab7718f0ed77b19afTimo Sirainen
1279090ba03f9c176976a69ab7718f0ed77b19afTimo Sirainen struct mailbox_list_iterate_context *
1279090ba03f9c176976a69ab7718f0ed77b19afTimo Sirainen (*iter_init)(struct mailbox_list *list,
1279090ba03f9c176976a69ab7718f0ed77b19afTimo Sirainen const char *const *patterns,
1279090ba03f9c176976a69ab7718f0ed77b19afTimo Sirainen enum mailbox_list_iter_flags flags);
1279090ba03f9c176976a69ab7718f0ed77b19afTimo Sirainen const struct mailbox_info *
1279090ba03f9c176976a69ab7718f0ed77b19afTimo Sirainen (*iter_next)(struct mailbox_list_iterate_context *ctx);
1279090ba03f9c176976a69ab7718f0ed77b19afTimo Sirainen int (*iter_deinit)(struct mailbox_list_iterate_context *ctx);
1279090ba03f9c176976a69ab7718f0ed77b19afTimo Sirainen
1279090ba03f9c176976a69ab7718f0ed77b19afTimo Sirainen /* Returns -1 if error, 0 if it's not a valid mailbox, 1 if it is.
1279090ba03f9c176976a69ab7718f0ed77b19afTimo Sirainen flags may be updated (especially the children flags). */
1279090ba03f9c176976a69ab7718f0ed77b19afTimo Sirainen int (*iter_is_mailbox)(struct mailbox_list_iterate_context *ctx,
1279090ba03f9c176976a69ab7718f0ed77b19afTimo Sirainen const char *dir, const char *fname,
1279090ba03f9c176976a69ab7718f0ed77b19afTimo Sirainen enum mailbox_list_file_type type,
1279090ba03f9c176976a69ab7718f0ed77b19afTimo Sirainen enum mailbox_info_flags *flags_r);
1279090ba03f9c176976a69ab7718f0ed77b19afTimo Sirainen
1279090ba03f9c176976a69ab7718f0ed77b19afTimo Sirainen int (*set_subscribed)(struct mailbox_list *list,
1279090ba03f9c176976a69ab7718f0ed77b19afTimo Sirainen const char *name, bool set);
1279090ba03f9c176976a69ab7718f0ed77b19afTimo Sirainen int (*delete_mailbox)(struct mailbox_list *list, const char *name);
1279090ba03f9c176976a69ab7718f0ed77b19afTimo Sirainen int (*rename_mailbox)(struct mailbox_list *list, const char *oldname,
1279090ba03f9c176976a69ab7718f0ed77b19afTimo Sirainen const char *newname);
1279090ba03f9c176976a69ab7718f0ed77b19afTimo Sirainen};
1279090ba03f9c176976a69ab7718f0ed77b19afTimo Sirainen
1279090ba03f9c176976a69ab7718f0ed77b19afTimo Sirainenstruct mailbox_list_module_register {
1279090ba03f9c176976a69ab7718f0ed77b19afTimo Sirainen unsigned int id;
1279090ba03f9c176976a69ab7718f0ed77b19afTimo Sirainen};
1279090ba03f9c176976a69ab7718f0ed77b19afTimo Sirainen
1279090ba03f9c176976a69ab7718f0ed77b19afTimo Sirainenunion mailbox_list_module_context {
1279090ba03f9c176976a69ab7718f0ed77b19afTimo Sirainen struct mailbox_list_vfuncs super;
1279090ba03f9c176976a69ab7718f0ed77b19afTimo Sirainen struct mailbox_list_module_register *reg;
1279090ba03f9c176976a69ab7718f0ed77b19afTimo Sirainen};
1279090ba03f9c176976a69ab7718f0ed77b19afTimo Sirainen
1279090ba03f9c176976a69ab7718f0ed77b19afTimo Sirainenstruct mailbox_list {
1279090ba03f9c176976a69ab7718f0ed77b19afTimo Sirainen const char *name;
1279090ba03f9c176976a69ab7718f0ed77b19afTimo Sirainen char hierarchy_sep;
1279090ba03f9c176976a69ab7718f0ed77b19afTimo Sirainen size_t mailbox_name_max_length;
1279090ba03f9c176976a69ab7718f0ed77b19afTimo Sirainen
1279090ba03f9c176976a69ab7718f0ed77b19afTimo Sirainen struct mailbox_list_vfuncs v;
1279090ba03f9c176976a69ab7718f0ed77b19afTimo Sirainen
1279090ba03f9c176976a69ab7718f0ed77b19afTimo Sirainen/* private: */
1279090ba03f9c176976a69ab7718f0ed77b19afTimo Sirainen pool_t pool;
1279090ba03f9c176976a69ab7718f0ed77b19afTimo Sirainen struct mail_namespace *ns;
1279090ba03f9c176976a69ab7718f0ed77b19afTimo Sirainen struct mailbox_list_settings set;
1279090ba03f9c176976a69ab7718f0ed77b19afTimo Sirainen enum mailbox_list_flags flags;
1279090ba03f9c176976a69ab7718f0ed77b19afTimo Sirainen
1279090ba03f9c176976a69ab7718f0ed77b19afTimo Sirainen /* -1 if not set yet. use mailbox_list_get_permissions() to set them */
1279090ba03f9c176976a69ab7718f0ed77b19afTimo Sirainen mode_t file_create_mode;
1279090ba03f9c176976a69ab7718f0ed77b19afTimo Sirainen gid_t file_create_gid;
1279090ba03f9c176976a69ab7718f0ed77b19afTimo Sirainen
1279090ba03f9c176976a69ab7718f0ed77b19afTimo Sirainen char *error_string;
1279090ba03f9c176976a69ab7718f0ed77b19afTimo Sirainen enum mail_error error;
54b51a9c2705a19dfb1639647bc7e9378e37f881Timo Sirainen bool temporary_error;
54b51a9c2705a19dfb1639647bc7e9378e37f881Timo Sirainen
5da1aa5197a43d83f0fb3eeb83125c7cd73d1b62Timo Sirainen ARRAY_DEFINE(module_contexts, union mailbox_list_module_context *);
54b51a9c2705a19dfb1639647bc7e9378e37f881Timo Sirainen};
54b51a9c2705a19dfb1639647bc7e9378e37f881Timo Sirainen
54b51a9c2705a19dfb1639647bc7e9378e37f881Timo Sirainenstruct mailbox_list_iterate_context {
54b51a9c2705a19dfb1639647bc7e9378e37f881Timo Sirainen struct mailbox_list *list;
54b51a9c2705a19dfb1639647bc7e9378e37f881Timo Sirainen enum mailbox_list_iter_flags flags;
54b51a9c2705a19dfb1639647bc7e9378e37f881Timo Sirainen bool failed;
54b51a9c2705a19dfb1639647bc7e9378e37f881Timo Sirainen};
54b51a9c2705a19dfb1639647bc7e9378e37f881Timo Sirainen
54b51a9c2705a19dfb1639647bc7e9378e37f881Timo Sirainen/* Modules should use do "my_id = mailbox_list_module_id++" and
54b51a9c2705a19dfb1639647bc7e9378e37f881Timo Sirainen use objects' module_contexts[id] for their own purposes. */
19557f192d37cd54a1a090a8a26d9d47265e4413Aki Tuomiextern struct mailbox_list_module_register mailbox_list_module_register;
54b51a9c2705a19dfb1639647bc7e9378e37f881Timo Sirainen
54b51a9c2705a19dfb1639647bc7e9378e37f881Timo Sirainenextern void (*hook_mailbox_list_created)(struct mailbox_list *list);
54b51a9c2705a19dfb1639647bc7e9378e37f881Timo Sirainen
54b51a9c2705a19dfb1639647bc7e9378e37f881Timo Sirainenint mailbox_list_settings_parse(const char *data,
54b51a9c2705a19dfb1639647bc7e9378e37f881Timo Sirainen struct mailbox_list_settings *set,
54b51a9c2705a19dfb1639647bc7e9378e37f881Timo Sirainen const char **layout, const char **alt_dir_r,
54b51a9c2705a19dfb1639647bc7e9378e37f881Timo Sirainen const char **error_r);
54b51a9c2705a19dfb1639647bc7e9378e37f881Timo Sirainen
54b51a9c2705a19dfb1639647bc7e9378e37f881Timo Sirainenint mailbox_list_delete_index_control(struct mailbox_list *list,
54b51a9c2705a19dfb1639647bc7e9378e37f881Timo Sirainen const char *name);
54b51a9c2705a19dfb1639647bc7e9378e37f881Timo Sirainen
54b51a9c2705a19dfb1639647bc7e9378e37f881Timo Sirainenvoid mailbox_list_iter_update(struct mailbox_list_iterate_context *ctx,
54b51a9c2705a19dfb1639647bc7e9378e37f881Timo Sirainen struct mailbox_tree_context *tree_ctx,
54b51a9c2705a19dfb1639647bc7e9378e37f881Timo Sirainen struct imap_match_glob *glob, bool update_only,
54b51a9c2705a19dfb1639647bc7e9378e37f881Timo Sirainen bool match_parents, const char *name);
54b51a9c2705a19dfb1639647bc7e9378e37f881Timo Sirainen
54b51a9c2705a19dfb1639647bc7e9378e37f881Timo Sirainenbool mailbox_list_name_is_too_large(const char *name, char sep);
5da1aa5197a43d83f0fb3eeb83125c7cd73d1b62Timo Sirainenenum mailbox_list_file_type mailbox_list_get_file_type(const struct dirent *d);
54b51a9c2705a19dfb1639647bc7e9378e37f881Timo Sirainen
54b51a9c2705a19dfb1639647bc7e9378e37f881Timo Sirainenvoid mailbox_list_clear_error(struct mailbox_list *list);
54b51a9c2705a19dfb1639647bc7e9378e37f881Timo Sirainenvoid mailbox_list_set_error(struct mailbox_list *list,
54b51a9c2705a19dfb1639647bc7e9378e37f881Timo Sirainen enum mail_error error, const char *string);
54b51a9c2705a19dfb1639647bc7e9378e37f881Timo Sirainenvoid mailbox_list_set_critical(struct mailbox_list *list, const char *fmt, ...)
eab880d75fd73a80c7803289796d13e08e4b52cbTimo Sirainen ATTR_FORMAT(2, 3);
54b51a9c2705a19dfb1639647bc7e9378e37f881Timo Sirainenvoid mailbox_list_set_internal_error(struct mailbox_list *list);
54b51a9c2705a19dfb1639647bc7e9378e37f881Timo Sirainenbool mailbox_list_set_error_from_errno(struct mailbox_list *list);
54b51a9c2705a19dfb1639647bc7e9378e37f881Timo Sirainen
54b51a9c2705a19dfb1639647bc7e9378e37f881Timo Sirainen#endif
54b51a9c2705a19dfb1639647bc7e9378e37f881Timo Sirainen