mailbox-list-private.h revision 0185427dd52fddec6fc76d6e99c7659620d4366e
239N/A#ifndef MAILBOX_LIST_PRIVATE_H
239N/A#define MAILBOX_LIST_PRIVATE_H
239N/A
239N/A#include "mail-namespace.h"
239N/A#include "mailbox-list.h"
239N/A#include "mail-storage-settings.h"
239N/A
239N/A#define MAILBOX_LIST_NAME_MAILDIRPLUSPLUS "maildir++"
239N/A#define MAILBOX_LIST_NAME_IMAPDIR "imapdir"
239N/A#define MAILBOX_LIST_NAME_FS "fs"
239N/A
239N/A#define MAILBOX_LOG_FILE_NAME "dovecot.mailbox.log"
239N/A
239N/Aenum mailbox_log_record_type;
239N/Astruct dirent;
239N/Astruct imap_match_glob;
239N/Astruct mailbox_tree_context;
239N/A
239N/Astruct mailbox_list_vfuncs {
239N/A struct mailbox_list *(*alloc)(void);
239N/A void (*deinit)(struct mailbox_list *list);
239N/A
239N/A int (*get_storage)(struct mailbox_list **list, const char **name,
239N/A struct mail_storage **storage_r);
239N/A bool (*is_valid_pattern)(struct mailbox_list *list,
239N/A const char *pattern);
239N/A bool (*is_valid_existing_name)(struct mailbox_list *list,
239N/A const char *name);
239N/A bool (*is_valid_create_name)(struct mailbox_list *list,
618N/A const char *name);
239N/A
239N/A const char *(*get_path)(struct mailbox_list *list, const char *name,
239N/A enum mailbox_list_path_type type);
239N/A int (*get_mailbox_name_status)(struct mailbox_list *list,
239N/A const char *name,
239N/A enum mailbox_name_status *status);
239N/A
239N/A const char *(*get_temp_prefix)(struct mailbox_list *list, bool global);
239N/A const char *(*join_refpattern)(struct mailbox_list *list,
239N/A const char *ref, const char *pattern);
239N/A
239N/A struct mailbox_list_iterate_context *
239N/A (*iter_init)(struct mailbox_list *list,
239N/A const char *const *patterns,
239N/A enum mailbox_list_iter_flags flags);
239N/A const struct mailbox_info *
239N/A (*iter_next)(struct mailbox_list_iterate_context *ctx);
239N/A int (*iter_deinit)(struct mailbox_list_iterate_context *ctx);
239N/A
239N/A /* Returns -1 if error, 0 if it's not a valid mailbox, 1 if it is.
239N/A flags may be updated (especially the children flags). */
239N/A int (*iter_is_mailbox)(struct mailbox_list_iterate_context *ctx,
239N/A const char *dir, const char *fname,
const char *mailbox_name,
enum mailbox_list_file_type type,
enum mailbox_info_flags *flags_r);
int (*set_subscribed)(struct mailbox_list *list,
const char *name, bool set);
int (*delete_mailbox)(struct mailbox_list *list, const char *name);
int (*rename_mailbox)(struct mailbox_list *oldlist, const char *oldname,
struct mailbox_list *newlist, const char *newname,
bool rename_children);
/* called by rename_mailbox() just before running the actual rename() */
int (*rename_mailbox_pre)(struct mailbox_list *oldlist,
const char *oldname,
struct mailbox_list *newlist,
const char *newname);
int (*get_guid)(struct mailbox_list *list, const char *name,
uint8_t mailbox_guid[MAIL_GUID_128_SIZE]);
};
struct mailbox_list_module_register {
unsigned int id;
};
union mailbox_list_module_context {
struct mailbox_list_vfuncs super;
struct mailbox_list_module_register *reg;
};
struct mailbox_list {
const char *name;
char hierarchy_sep;
enum mailbox_list_properties props;
size_t mailbox_name_max_length;
struct mailbox_list_vfuncs v;
/* private: */
pool_t pool;
struct mail_namespace *ns;
struct mailbox_list_settings set;
const struct mail_storage_settings *mail_set;
enum mailbox_list_flags flags;
/* -1 if not set yet. use mailbox_list_get_permissions() to set them */
mode_t file_create_mode, dir_create_mode;
gid_t file_create_gid;
/* origin (e.g. path) where the file_create_gid was got from */
const char *file_create_gid_origin;
struct mailbox_log *changelog;
char *error_string;
enum mail_error error;
bool temporary_error;
ARRAY_DEFINE(module_contexts, union mailbox_list_module_context *);
};
struct mailbox_list_iterate_context {
struct mailbox_list *list;
enum mailbox_list_iter_flags flags;
bool failed;
};
struct mailbox_list_iter_update_context {
struct mailbox_list_iterate_context *iter_ctx;
struct mailbox_tree_context *tree_ctx;
struct imap_match_glob *glob;
enum mailbox_info_flags leaf_flags, parent_flags;
unsigned int update_only:1;
unsigned int match_parents:1;
};
/* Modules should use do "my_id = mailbox_list_module_id++" and
use objects' module_contexts[id] for their own purposes. */
extern struct mailbox_list_module_register mailbox_list_module_register;
extern void (*hook_mailbox_list_created)(struct mailbox_list *list);
void mailbox_lists_init(void);
void mailbox_lists_deinit(void);
int mailbox_list_settings_parse(const char *data,
struct mailbox_list_settings *set,
struct mail_namespace *ns,
const char **error_r);
int mailbox_list_delete_index_control(struct mailbox_list *list,
const char *name);
void mailbox_list_iter_update(struct mailbox_list_iter_update_context *ctx,
const char *name);
bool mailbox_list_name_is_too_large(const char *name, char sep);
enum mailbox_list_file_type mailbox_list_get_file_type(const struct dirent *d);
bool mailbox_list_try_get_absolute_path(struct mailbox_list *list,
const char **name);
void mailbox_list_add_change(struct mailbox_list *list,
enum mailbox_log_record_type type,
const uint8_t mailbox_guid[MAIL_GUID_128_SIZE]);
int mailbox_list_get_guid_path(struct mailbox_list *list, const char *path,
uint8_t mailbox_guid[MAIL_GUID_128_SIZE]);
void mailbox_list_clear_error(struct mailbox_list *list);
void mailbox_list_set_error(struct mailbox_list *list,
enum mail_error error, const char *string);
void mailbox_list_set_critical(struct mailbox_list *list, const char *fmt, ...)
ATTR_FORMAT(2, 3);
void mailbox_list_set_internal_error(struct mailbox_list *list);
bool mailbox_list_set_error_from_errno(struct mailbox_list *list);
#endif