mailbox-list-private.h revision 9fc97c8aa8190df87624d214bcc5d0b5362bec93
2615df45a8027948a474abe5e817b34b0499c171Timo Sirainen#define MAILBOX_LIST_NAME_MAILDIRPLUSPLUS "maildir++"
37847ec8eaec9ad55c9df10ae109efe7b37ac573Timo Sirainen#define MAILBOX_LOG_FILE_NAME "dovecot.mailbox.log"
dca6d617a23e3f93af3b8df59acb46478179fe55Timo Sirainen (((flags) & (MAILBOX_SELECT | MAILBOX_NOSELECT | \
c0a87e5f3316a57e6f915882fa1951d0fbb74a61Timo Sirainen int (*get_storage)(struct mailbox_list **list, const char *vname,
c0a87e5f3316a57e6f915882fa1951d0fbb74a61Timo Sirainen char (*get_hierarchy_sep)(struct mailbox_list *list);
c0a87e5f3316a57e6f915882fa1951d0fbb74a61Timo Sirainen const char *(*get_vname)(struct mailbox_list *list,
c0a87e5f3316a57e6f915882fa1951d0fbb74a61Timo Sirainen const char *(*get_storage_name)(struct mailbox_list *list,
c0a87e5f3316a57e6f915882fa1951d0fbb74a61Timo Sirainen const char *vname);
9fc97c8aa8190df87624d214bcc5d0b5362bec93Timo Sirainen int (*get_path)(struct mailbox_list *list, const char *name,
9fc97c8aa8190df87624d214bcc5d0b5362bec93Timo Sirainen enum mailbox_list_path_type type, const char **path_r);
c040ee67d0ac0fb7375bb543965bf67dcae6affaTimo Sirainen const char *(*get_temp_prefix)(struct mailbox_list *list, bool global);
533bfba437e4120aa29dd45bca2aa87e30ee28a2Timo Sirainen const char *(*join_refpattern)(struct mailbox_list *list,
d92f33f13830ba23d814342bf3ea8db721a15bb1Timo Sirainen const char *const *patterns,
a27e065f1a1f91c7fbdf7c2ea1c387441af0cbb3Timo Sirainen (*iter_next)(struct mailbox_list_iterate_context *ctx);
a27e065f1a1f91c7fbdf7c2ea1c387441af0cbb3Timo Sirainen int (*iter_deinit)(struct mailbox_list_iterate_context *ctx);
dca6d617a23e3f93af3b8df59acb46478179fe55Timo Sirainen int (*get_mailbox_flags)(struct mailbox_list *list,
dca6d617a23e3f93af3b8df59acb46478179fe55Timo Sirainen /* Returns TRUE if name is mailbox's internal file/directory.
61b0637759146621cbb7edcbd0b03a71cfd66dfeTimo Sirainen If it does, mailbox deletion assumes it can safely delete it. */
dca6d617a23e3f93af3b8df59acb46478179fe55Timo Sirainen bool (*is_internal_name)(struct mailbox_list *list, const char *name);
4ba962c3e78f140facdcfb1e093c4c46de75ae24Timo Sirainen /* Read subscriptions from src_list, but place them into
4ba962c3e78f140facdcfb1e093c4c46de75ae24Timo Sirainen dest_list->subscriptions. Set errors to dest_list. */
4ba962c3e78f140facdcfb1e093c4c46de75ae24Timo Sirainen int (*subscriptions_refresh)(struct mailbox_list *src_list,
a27e065f1a1f91c7fbdf7c2ea1c387441af0cbb3Timo Sirainen int (*set_subscribed)(struct mailbox_list *list,
b039dabf4c53f72454e795930e7643b6e0e625f9Timo Sirainen int (*delete_mailbox)(struct mailbox_list *list, const char *name);
2f30b72d49fbff0c4096125c139e4bdfef45669cTimo Sirainen int (*delete_dir)(struct mailbox_list *list, const char *name);
0b25846ba794ce19536a24d4065beaf2a0bd9464Timo Sirainen int (*delete_symlink)(struct mailbox_list *list, const char *name);
91b203fd2132510a47a4b34252c0ae0efd688a19Timo Sirainen int (*rename_mailbox)(struct mailbox_list *oldlist, const char *oldname,
71e88fae3be360e9a93b3398e743f99a6f05d2edTimo Sirainen struct mailbox_list *newlist, const char *newname);
8854395cdd21ca521b37ce669f3acb8445792b20Timo Sirainen int (*notify_next)(struct mailbox_list_notify *notify,
8854395cdd21ca521b37ce669f3acb8445792b20Timo Sirainen const struct mailbox_list_notify_rec **rec_r);
8854395cdd21ca521b37ce669f3acb8445792b20Timo Sirainen void (*notify_deinit)(struct mailbox_list_notify *notify);
8854395cdd21ca521b37ce669f3acb8445792b20Timo Sirainen void (*notify_wait)(struct mailbox_list_notify *notify,
8854395cdd21ca521b37ce669f3acb8445792b20Timo Sirainen void (*callback)(void *context), void *context);
8e371a3ce32bd64288786855b8ce0cb63f19f7d1Timo Sirainen unsigned int id;
a27e065f1a1f91c7fbdf7c2ea1c387441af0cbb3Timo Sirainen/* private: */
76b91bac787101e6b0075122ab6478dd98c8a884Timo Sirainen /* may not be set yet, use mailbox_list_get_permissions() to access */
b13f738e8eb3f24dc2abf2c804f954b4d864ac6fTimo Sirainen time_t subscriptions_mtime, subscriptions_read_time;
678d0463849ba777106eb7875f27db07a5d8e3dfTimo Sirainen HASH_TABLE(uint8_t *, struct mailbox_guid_cache_rec *) guid_cache;
4ee00532a265bdfb38539d811fcd12d51210ac35Timo Sirainen ARRAY(union mailbox_list_module_context *) module_contexts;
eb1572d7c44ebc7b0b039d085c3dbab2ef7043ddTimo Sirainen struct mailbox_list_autocreate_iterate_context *autocreate_ctx;
4ee00532a265bdfb38539d811fcd12d51210ac35Timo Sirainen ARRAY(union mailbox_list_iterate_module_context *) module_contexts;
4366a21968093172d9b757fe6894b1ee8916434eTimo Sirainen struct mailbox_list_iterate_context *iter_ctx;
4366a21968093172d9b757fe6894b1ee8916434eTimo Sirainen enum mailbox_info_flags leaf_flags, parent_flags;
a27e065f1a1f91c7fbdf7c2ea1c387441af0cbb3Timo Sirainen/* Modules should use do "my_id = mailbox_list_module_id++" and
a27e065f1a1f91c7fbdf7c2ea1c387441af0cbb3Timo Sirainen use objects' module_contexts[id] for their own purposes. */
8e371a3ce32bd64288786855b8ce0cb63f19f7d1Timo Sirainenextern struct mailbox_list_module_register mailbox_list_module_register;
b365bd121cdc87f63e1dd47c5085a27091118e00Timo Sirainenint mailbox_list_settings_parse(struct mail_user *user, const char *data,
4645cc6c911a95991d7af43b40f88e99506ea5e9Timo Sirainen const char **error_r);
c0a87e5f3316a57e6f915882fa1951d0fbb74a61Timo Sirainenconst char *mailbox_list_default_get_storage_name(struct mailbox_list *list,
c0a87e5f3316a57e6f915882fa1951d0fbb74a61Timo Sirainen const char *vname);
c0a87e5f3316a57e6f915882fa1951d0fbb74a61Timo Sirainenconst char *mailbox_list_default_get_vname(struct mailbox_list *list,
0b4e1043e596bfb36d999dacbf1d4d63ee96d75fTimo Sirainenconst char *mailbox_list_get_unexpanded_path(struct mailbox_list *list,
9fc97c8aa8190df87624d214bcc5d0b5362bec93Timo Sirainenbool mailbox_list_set_get_root_path(const struct mailbox_list_settings *set,
9fc97c8aa8190df87624d214bcc5d0b5362bec93Timo Sirainen const char **path_r);
b039dabf4c53f72454e795930e7643b6e0e625f9Timo Sirainenint mailbox_list_delete_index_control(struct mailbox_list *list,
b039dabf4c53f72454e795930e7643b6e0e625f9Timo Sirainen const char *name);
4366a21968093172d9b757fe6894b1ee8916434eTimo Sirainenvoid mailbox_list_iter_update(struct mailbox_list_iter_update_context *ctx,
4366a21968093172d9b757fe6894b1ee8916434eTimo Sirainen const char *name);
24acd68c82dc137b88bb3ba3258b9d1f7ebcb44dTimo Sirainenint mailbox_list_iter_subscriptions_refresh(struct mailbox_list *list);
a27e065f1a1f91c7fbdf7c2ea1c387441af0cbb3Timo Sirainenbool mailbox_list_name_is_too_large(const char *name, char sep);
a27e065f1a1f91c7fbdf7c2ea1c387441af0cbb3Timo Sirainenenum mailbox_list_file_type mailbox_list_get_file_type(const struct dirent *d);
77b5fd56e5a06d624f3ab92198272287333114f4Timo Sirainenint mailbox_list_dirent_is_alias_symlink(struct mailbox_list *list,
77b5fd56e5a06d624f3ab92198272287333114f4Timo Sirainen const struct dirent *d);
96f2533c48ce5def0004931606a2fdf275578880Timo Sirainenbool mailbox_list_try_get_absolute_path(struct mailbox_list *list,
96f2533c48ce5def0004931606a2fdf275578880Timo Sirainen const char **name);
37847ec8eaec9ad55c9df10ae109efe7b37ac573Timo Sirainenvoid mailbox_list_add_change(struct mailbox_list *list,
de62ce819d59a529530da4b57be1b8d6dad13d6bTimo Sirainenvoid mailbox_name_get_sha128(const char *name, guid_128_t guid_128_r);
a27e065f1a1f91c7fbdf7c2ea1c387441af0cbb3Timo Sirainenvoid mailbox_list_clear_error(struct mailbox_list *list);
ff7056842f14fd3b30a2d327dfab165b9d15dd30Timo Sirainenvoid mailbox_list_set_error(struct mailbox_list *list,
a27e065f1a1f91c7fbdf7c2ea1c387441af0cbb3Timo Sirainenvoid mailbox_list_set_critical(struct mailbox_list *list, const char *fmt, ...)
5fb3bff645380804c9db2510940c41db6b8fdb01Timo Sirainenvoid mailbox_list_set_internal_error(struct mailbox_list *list);