mailbox-list-private.h revision a8fe899601735459641edae975c0fa08be8482e2
c4267cf4c40fb1f866b5958ff122ef836b8c5dfbTimo Sirainen#define MAILBOX_LIST_NAME_MAILDIRPLUSPLUS "maildir++"
c4267cf4c40fb1f866b5958ff122ef836b8c5dfbTimo Sirainen#define MAILBOX_LOG_FILE_NAME "dovecot.mailbox.log"
c4267cf4c40fb1f866b5958ff122ef836b8c5dfbTimo Sirainen (((flags) & (MAILBOX_SELECT | MAILBOX_NOSELECT | \
c4267cf4c40fb1f866b5958ff122ef836b8c5dfbTimo Sirainen /* Creating a mailbox */
c4267cf4c40fb1f866b5958ff122ef836b8c5dfbTimo Sirainen /* Create a \Noselect or a mailbox */
c4267cf4c40fb1f866b5958ff122ef836b8c5dfbTimo Sirainen /* Create a \Noselect or fail */
c4267cf4c40fb1f866b5958ff122ef836b8c5dfbTimo Sirainen int (*get_storage)(struct mailbox_list **list, const char *vname,
c4267cf4c40fb1f866b5958ff122ef836b8c5dfbTimo Sirainen bool (*is_valid_pattern)(struct mailbox_list *list,
39e6fcc3e8b1ccb13087c232cb6bdea04d1a20a4Timo Sirainen const char *pattern);
c4267cf4c40fb1f866b5958ff122ef836b8c5dfbTimo Sirainen bool (*is_valid_existing_name)(struct mailbox_list *list,
c4267cf4c40fb1f866b5958ff122ef836b8c5dfbTimo Sirainen const char *name);
fdc557286bc9f92c5f3bb49096ff6e2bcec0ea79Timo Sirainen bool (*is_valid_create_name)(struct mailbox_list *list,
fdc557286bc9f92c5f3bb49096ff6e2bcec0ea79Timo Sirainen const char *name);
bc3698b8892df8003b410daea6f5bbcd20433808Timo Sirainen char (*get_hierarchy_sep)(struct mailbox_list *list);
bc3698b8892df8003b410daea6f5bbcd20433808Timo Sirainen const char *(*get_vname)(struct mailbox_list *list,
bc3698b8892df8003b410daea6f5bbcd20433808Timo Sirainen const char *(*get_storage_name)(struct mailbox_list *list,
bc3698b8892df8003b410daea6f5bbcd20433808Timo Sirainen const char *vname);
bc3698b8892df8003b410daea6f5bbcd20433808Timo Sirainen const char *(*get_path)(struct mailbox_list *list, const char *name,
c4267cf4c40fb1f866b5958ff122ef836b8c5dfbTimo Sirainen const char *(*get_temp_prefix)(struct mailbox_list *list, bool global);
c4267cf4c40fb1f866b5958ff122ef836b8c5dfbTimo Sirainen const char *(*join_refpattern)(struct mailbox_list *list,
fdc557286bc9f92c5f3bb49096ff6e2bcec0ea79Timo Sirainen const char *const *patterns,
c4267cf4c40fb1f866b5958ff122ef836b8c5dfbTimo Sirainen (*iter_next)(struct mailbox_list_iterate_context *ctx);
c4267cf4c40fb1f866b5958ff122ef836b8c5dfbTimo Sirainen int (*iter_deinit)(struct mailbox_list_iterate_context *ctx);
c4267cf4c40fb1f866b5958ff122ef836b8c5dfbTimo Sirainen int (*get_mailbox_flags)(struct mailbox_list *list,
c4267cf4c40fb1f866b5958ff122ef836b8c5dfbTimo Sirainen /* Returns TRUE if name is mailbox's internal file/directory.
c4267cf4c40fb1f866b5958ff122ef836b8c5dfbTimo Sirainen If it does, mailbox deletion assumes it can safely delete it. */
c4267cf4c40fb1f866b5958ff122ef836b8c5dfbTimo 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 (*create_mailbox_dir)(struct mailbox_list *list, const char *name,
c4267cf4c40fb1f866b5958ff122ef836b8c5dfbTimo Sirainen int (*delete_mailbox)(struct mailbox_list *list, const char *name);
c4267cf4c40fb1f866b5958ff122ef836b8c5dfbTimo Sirainen int (*delete_dir)(struct mailbox_list *list, const char *name);
c4267cf4c40fb1f866b5958ff122ef836b8c5dfbTimo Sirainen int (*delete_symlink)(struct mailbox_list *list, const char *name);
c4267cf4c40fb1f866b5958ff122ef836b8c5dfbTimo Sirainen int (*rename_mailbox)(struct mailbox_list *oldlist, const char *oldname,
c4267cf4c40fb1f866b5958ff122ef836b8c5dfbTimo Sirainen struct mailbox_list *newlist, const char *newname);
16c89b1260c9d07c01c83a9219424d3727069b2eTimo Sirainen int (*notify_next)(struct mailbox_list_notify *notify,
d756ebcfa96bd7cff02097c8f26df9df368b81b1Timo Sirainen const struct mailbox_list_notify_rec **rec_r);
68efcccb384f2d6871164b072457e87473502c51Timo Sirainen void (*notify_deinit)(struct mailbox_list_notify *notify);
d756ebcfa96bd7cff02097c8f26df9df368b81b1Timo Sirainen void (*notify_wait)(struct mailbox_list_notify *notify,
d756ebcfa96bd7cff02097c8f26df9df368b81b1Timo Sirainen void (*callback)(void *context), void *context);
c4267cf4c40fb1f866b5958ff122ef836b8c5dfbTimo Sirainen unsigned int id;
16c89b1260c9d07c01c83a9219424d3727069b2eTimo Sirainen/* private: */
88286b0527bcc0711e312e9db65ca121a45213e3Timo Sirainen /* -1 if not set yet. use mailbox_list_get_permissions() to set them */
fdc557286bc9f92c5f3bb49096ff6e2bcec0ea79Timo Sirainen /* origin (e.g. path) where the file_create_gid was got from */
fdc557286bc9f92c5f3bb49096ff6e2bcec0ea79Timo Sirainen time_t subscriptions_mtime, subscriptions_read_time;
39e6fcc3e8b1ccb13087c232cb6bdea04d1a20a4Timo Sirainen HASH_TABLE(uint8_t *, struct mailbox_guid_cache_rec *) guid_cache;
68efcccb384f2d6871164b072457e87473502c51Timo Sirainen ARRAY(union mailbox_list_module_context *) module_contexts;
c4267cf4c40fb1f866b5958ff122ef836b8c5dfbTimo Sirainen struct mailbox_list_autocreate_iterate_context *autocreate_ctx;
d756ebcfa96bd7cff02097c8f26df9df368b81b1Timo Sirainen ARRAY(union mailbox_list_iterate_module_context *) module_contexts;
88286b0527bcc0711e312e9db65ca121a45213e3Timo Sirainen struct mailbox_list_iterate_context *iter_ctx;
d756ebcfa96bd7cff02097c8f26df9df368b81b1Timo Sirainen enum mailbox_info_flags leaf_flags, parent_flags;
c4267cf4c40fb1f866b5958ff122ef836b8c5dfbTimo Sirainen/* Modules should use do "my_id = mailbox_list_module_id++" and
c4267cf4c40fb1f866b5958ff122ef836b8c5dfbTimo Sirainen use objects' module_contexts[id] for their own purposes. */
c4267cf4c40fb1f866b5958ff122ef836b8c5dfbTimo Sirainenextern struct mailbox_list_module_register mailbox_list_module_register;
c4267cf4c40fb1f866b5958ff122ef836b8c5dfbTimo Sirainenint mailbox_list_settings_parse(struct mail_user *user, const char *data,
c4267cf4c40fb1f866b5958ff122ef836b8c5dfbTimo Sirainen const char **error_r);
d756ebcfa96bd7cff02097c8f26df9df368b81b1Timo Sirainenconst char *mailbox_list_default_get_storage_name(struct mailbox_list *list,
e60a349c641bb2f4723e4a395a25f55531682d2bTimo Sirainen const char *vname);
c4267cf4c40fb1f866b5958ff122ef836b8c5dfbTimo Sirainenconst char *mailbox_list_default_get_vname(struct mailbox_list *list,
88286b0527bcc0711e312e9db65ca121a45213e3Timo Sirainenconst char *mailbox_list_get_unexpanded_path(struct mailbox_list *list,
c4267cf4c40fb1f866b5958ff122ef836b8c5dfbTimo Sirainenmailbox_list_set_get_root_path(const struct mailbox_list_settings *set,
88286b0527bcc0711e312e9db65ca121a45213e3Timo Sirainenint mailbox_list_delete_index_control(struct mailbox_list *list,
88286b0527bcc0711e312e9db65ca121a45213e3Timo Sirainen const char *name);
e60a349c641bb2f4723e4a395a25f55531682d2bTimo Sirainenvoid mailbox_list_iter_update(struct mailbox_list_iter_update_context *ctx,
e60a349c641bb2f4723e4a395a25f55531682d2bTimo Sirainen const char *name);
d756ebcfa96bd7cff02097c8f26df9df368b81b1Timo Sirainenint mailbox_list_iter_subscriptions_refresh(struct mailbox_list *list);
e60a349c641bb2f4723e4a395a25f55531682d2bTimo Sirainenbool mailbox_list_name_is_too_large(const char *name, char sep);
c4267cf4c40fb1f866b5958ff122ef836b8c5dfbTimo Sirainenenum mailbox_list_file_type mailbox_list_get_file_type(const struct dirent *d);
c4267cf4c40fb1f866b5958ff122ef836b8c5dfbTimo Sirainenbool mailbox_list_try_get_absolute_path(struct mailbox_list *list,
c4267cf4c40fb1f866b5958ff122ef836b8c5dfbTimo Sirainen const char **name);
e60a349c641bb2f4723e4a395a25f55531682d2bTimo Sirainenint mailbox_list_create_missing_index_dir(struct mailbox_list *list,
c4267cf4c40fb1f866b5958ff122ef836b8c5dfbTimo Sirainenint mailbox_list_create_missing_index_pvt_dir(struct mailbox_list *list,
c4267cf4c40fb1f866b5958ff122ef836b8c5dfbTimo Sirainen const char *name);
e60a349c641bb2f4723e4a395a25f55531682d2bTimo Sirainenvoid mailbox_list_add_change(struct mailbox_list *list,
d756ebcfa96bd7cff02097c8f26df9df368b81b1Timo Sirainenint mailbox_list_get_guid_path(struct mailbox_list *list, const char *path,
294f1a51763015cda0e2d874c5027d6fe7a2cd54Timo Sirainenvoid mailbox_name_get_sha128(const char *name, guid_128_t guid_128_r);
18634dae6e304bac982bb1e0ff1b6b88fc448dbcTimo Sirainenvoid mailbox_list_clear_error(struct mailbox_list *list);
18634dae6e304bac982bb1e0ff1b6b88fc448dbcTimo Sirainenvoid mailbox_list_set_error(struct mailbox_list *list,
18634dae6e304bac982bb1e0ff1b6b88fc448dbcTimo Sirainenvoid mailbox_list_set_critical(struct mailbox_list *list, const char *fmt, ...)
18634dae6e304bac982bb1e0ff1b6b88fc448dbcTimo Sirainenvoid mailbox_list_set_internal_error(struct mailbox_list *list);