mailbox-list-private.h revision d3e5a14ea363264dcc7640ca7226249d0c27a793
5c2d695acf9f95ae0dcdda89c4d2391ceda4d672Timo Sirainen#define MAILBOX_LIST_NAME_MAILDIRPLUSPLUS "maildir++"
4fc52b7b25c3d3f42348903e0154840f8761f306Timo Sirainen#define MAILBOX_LOG_FILE_NAME "dovecot.mailbox.log"
4fc52b7b25c3d3f42348903e0154840f8761f306Timo Sirainen#define T_MAILBOX_LIST_ERR_NOT_FOUND(list, name) \
5c2d695acf9f95ae0dcdda89c4d2391ceda4d672Timo Sirainen t_strdup_printf(MAIL_ERRSTR_MAILBOX_NOT_FOUND, \
4fc52b7b25c3d3f42348903e0154840f8761f306Timo Sirainen (((flags) & (MAILBOX_SELECT | MAILBOX_NOSELECT | \
4fc52b7b25c3d3f42348903e0154840f8761f306Timo Sirainen int (*init)(struct mailbox_list *list, const char **error_r);
39224d71e56c50ccfbc0405eb1914281590064d6Timo Sirainen int (*get_storage)(struct mailbox_list **list, const char *vname,
5c2d695acf9f95ae0dcdda89c4d2391ceda4d672Timo Sirainen char (*get_hierarchy_sep)(struct mailbox_list *list);
4fc52b7b25c3d3f42348903e0154840f8761f306Timo Sirainen const char *(*get_vname)(struct mailbox_list *list,
4fc52b7b25c3d3f42348903e0154840f8761f306Timo Sirainen const char *(*get_storage_name)(struct mailbox_list *list,
592270d9a3d666a1b687c146f6e1edf2aacd46e8Timo Sirainen const char *vname);
39224d71e56c50ccfbc0405eb1914281590064d6Timo Sirainen int (*get_path)(struct mailbox_list *list, const char *name,
39224d71e56c50ccfbc0405eb1914281590064d6Timo Sirainen enum mailbox_list_path_type type, const char **path_r);
4fc52b7b25c3d3f42348903e0154840f8761f306Timo Sirainen const char *(*get_temp_prefix)(struct mailbox_list *list, bool global);
4fc52b7b25c3d3f42348903e0154840f8761f306Timo Sirainen const char *(*join_refpattern)(struct mailbox_list *list,
4fc52b7b25c3d3f42348903e0154840f8761f306Timo Sirainen const char *const *patterns,
592270d9a3d666a1b687c146f6e1edf2aacd46e8Timo Sirainen (*iter_next)(struct mailbox_list_iterate_context *ctx);
4fc52b7b25c3d3f42348903e0154840f8761f306Timo Sirainen int (*iter_deinit)(struct mailbox_list_iterate_context *ctx);
39224d71e56c50ccfbc0405eb1914281590064d6Timo Sirainen int (*get_mailbox_flags)(struct mailbox_list *list,
4fc52b7b25c3d3f42348903e0154840f8761f306Timo Sirainen /* Returns TRUE if name is mailbox's internal file/directory.
4fc52b7b25c3d3f42348903e0154840f8761f306Timo Sirainen If it does, mailbox deletion assumes it can safely delete it. */
4fc52b7b25c3d3f42348903e0154840f8761f306Timo Sirainen bool (*is_internal_name)(struct mailbox_list *list, const char *name);
4fc52b7b25c3d3f42348903e0154840f8761f306Timo Sirainen /* Read subscriptions from src_list, but place them into
5c2d695acf9f95ae0dcdda89c4d2391ceda4d672Timo Sirainen dest_list->subscriptions. Set errors to dest_list. */
4fc52b7b25c3d3f42348903e0154840f8761f306Timo Sirainen int (*subscriptions_refresh)(struct mailbox_list *src_list,
4fc52b7b25c3d3f42348903e0154840f8761f306Timo Sirainen int (*set_subscribed)(struct mailbox_list *list,
4fc52b7b25c3d3f42348903e0154840f8761f306Timo Sirainen int (*delete_mailbox)(struct mailbox_list *list, const char *name);
4fc52b7b25c3d3f42348903e0154840f8761f306Timo Sirainen int (*delete_dir)(struct mailbox_list *list, const char *name);
4fc52b7b25c3d3f42348903e0154840f8761f306Timo Sirainen int (*delete_symlink)(struct mailbox_list *list, const char *name);
4fc52b7b25c3d3f42348903e0154840f8761f306Timo Sirainen int (*rename_mailbox)(struct mailbox_list *oldlist, const char *oldname,
4fc52b7b25c3d3f42348903e0154840f8761f306Timo Sirainen struct mailbox_list *newlist, const char *newname);
5e114f59ad9b9632bf7f3403d56bea17bd494e8eTimo Sirainen int (*notify_next)(struct mailbox_list_notify *notify,
5e114f59ad9b9632bf7f3403d56bea17bd494e8eTimo Sirainen const struct mailbox_list_notify_rec **rec_r);
5e114f59ad9b9632bf7f3403d56bea17bd494e8eTimo Sirainen void (*notify_deinit)(struct mailbox_list_notify *notify);
4fc52b7b25c3d3f42348903e0154840f8761f306Timo Sirainen void (*notify_wait)(struct mailbox_list_notify *notify,
5e114f59ad9b9632bf7f3403d56bea17bd494e8eTimo Sirainen void (*callback)(void *context), void *context);
5e114f59ad9b9632bf7f3403d56bea17bd494e8eTimo Sirainen unsigned int id;
4fc52b7b25c3d3f42348903e0154840f8761f306Timo Sirainen/* private: */
4fc52b7b25c3d3f42348903e0154840f8761f306Timo Sirainen /* may not be set yet, use mailbox_list_get_permissions() to access */
4fc52b7b25c3d3f42348903e0154840f8761f306Timo Sirainen time_t subscriptions_mtime, subscriptions_read_time;
4fc52b7b25c3d3f42348903e0154840f8761f306Timo Sirainen HASH_TABLE(uint8_t *, struct mailbox_guid_cache_rec *) guid_cache;
4fc52b7b25c3d3f42348903e0154840f8761f306Timo Sirainen ARRAY(union mailbox_list_module_context *) module_contexts;
51379a5d323a361622f1d8cd7c40e168c9302a0cTimo Sirainen struct mailbox_list_autocreate_iterate_context *autocreate_ctx;
4fc52b7b25c3d3f42348903e0154840f8761f306Timo Sirainen ARRAY(union mailbox_list_iterate_module_context *) module_contexts;
00120655cf38b7981ea65abb73330e338bc78f5bTimo Sirainen struct mailbox_list_iterate_context *iter_ctx;
4fc52b7b25c3d3f42348903e0154840f8761f306Timo Sirainen enum mailbox_info_flags leaf_flags, parent_flags;
4fc52b7b25c3d3f42348903e0154840f8761f306Timo Sirainen/* Modules should use do "my_id = mailbox_list_module_id++" and
4fc52b7b25c3d3f42348903e0154840f8761f306Timo Sirainen use objects' module_contexts[id] for their own purposes. */
4fc52b7b25c3d3f42348903e0154840f8761f306Timo Sirainenextern struct mailbox_list_module_register mailbox_list_module_register;
4fc52b7b25c3d3f42348903e0154840f8761f306Timo Sirainenint mailbox_list_settings_parse(struct mail_user *user, const char *data,
4fc52b7b25c3d3f42348903e0154840f8761f306Timo Sirainen const char **error_r);
4fc52b7b25c3d3f42348903e0154840f8761f306Timo Sirainenmailbox_list_escape_name(struct mailbox_list *list, const char *vname);
4fc52b7b25c3d3f42348903e0154840f8761f306Timo Sirainenmailbox_list_unescape_name(struct mailbox_list *list, const char *src);
4fc52b7b25c3d3f42348903e0154840f8761f306Timo Sirainenconst char *mailbox_list_default_get_storage_name(struct mailbox_list *list,
4fc52b7b25c3d3f42348903e0154840f8761f306Timo Sirainen const char *vname);
4fc52b7b25c3d3f42348903e0154840f8761f306Timo Sirainenconst char *mailbox_list_default_get_vname(struct mailbox_list *list,
00120655cf38b7981ea65abb73330e338bc78f5bTimo Sirainenconst char *mailbox_list_get_unexpanded_path(struct mailbox_list *list,
4fc52b7b25c3d3f42348903e0154840f8761f306Timo Sirainenbool mailbox_list_set_get_root_path(const struct mailbox_list_settings *set,
4fc52b7b25c3d3f42348903e0154840f8761f306Timo Sirainen const char **path_r);
4fc52b7b25c3d3f42348903e0154840f8761f306Timo Sirainenint mailbox_list_delete_index_control(struct mailbox_list *list,
4fc52b7b25c3d3f42348903e0154840f8761f306Timo Sirainen const char *name);
4fc52b7b25c3d3f42348903e0154840f8761f306Timo Sirainenvoid mailbox_list_iter_update(struct mailbox_list_iter_update_context *ctx,
4fc52b7b25c3d3f42348903e0154840f8761f306Timo Sirainen const char *name);
4fc52b7b25c3d3f42348903e0154840f8761f306Timo Sirainenint mailbox_list_iter_subscriptions_refresh(struct mailbox_list *list);
4fc52b7b25c3d3f42348903e0154840f8761f306Timo Sirainenbool mailbox_list_name_is_too_large(const char *name, char sep);
4fc52b7b25c3d3f42348903e0154840f8761f306Timo Sirainenenum mailbox_list_file_type mailbox_list_get_file_type(const struct dirent *d);
4fc52b7b25c3d3f42348903e0154840f8761f306Timo Sirainenint mailbox_list_dirent_is_alias_symlink(struct mailbox_list *list,
4fc52b7b25c3d3f42348903e0154840f8761f306Timo Sirainen const struct dirent *d);
4fc52b7b25c3d3f42348903e0154840f8761f306Timo Sirainenbool mailbox_list_try_get_absolute_path(struct mailbox_list *list,
4fc52b7b25c3d3f42348903e0154840f8761f306Timo Sirainen const char **name);
4fc52b7b25c3d3f42348903e0154840f8761f306Timo Sirainenvoid mailbox_list_add_change(struct mailbox_list *list,
4fc52b7b25c3d3f42348903e0154840f8761f306Timo Sirainenvoid mailbox_name_get_sha128(const char *name, guid_128_t guid_128_r);
4fc52b7b25c3d3f42348903e0154840f8761f306Timo Sirainenvoid mailbox_list_clear_error(struct mailbox_list *list);
4fc52b7b25c3d3f42348903e0154840f8761f306Timo Sirainenvoid mailbox_list_set_error(struct mailbox_list *list,
4fc52b7b25c3d3f42348903e0154840f8761f306Timo Sirainenvoid mailbox_list_set_critical(struct mailbox_list *list, const char *fmt, ...)
4fc52b7b25c3d3f42348903e0154840f8761f306Timo Sirainenvoid mailbox_list_set_internal_error(struct mailbox_list *list);