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