mailbox-list-private.h revision 43d32cbe60fdaef2699d99f1ca259053e9350411
bcb4e51a409d94ae670de96afb8483a4f7855294Stephan Bosch#ifndef MAILBOX_LIST_PRIVATE_H
48acc31adebfdd4e4945ee76e1f5259e4b1b6fffTimo Sirainen#define MAILBOX_LIST_PRIVATE_H
48acc31adebfdd4e4945ee76e1f5259e4b1b6fffTimo Sirainen
48acc31adebfdd4e4945ee76e1f5259e4b1b6fffTimo Sirainen#include "mail-namespace.h"
48acc31adebfdd4e4945ee76e1f5259e4b1b6fffTimo Sirainen#include "mailbox-list.h"
27a44fcfd8d19bffe0f267f20a2b5d3fe7600fddTimo Sirainen
48acc31adebfdd4e4945ee76e1f5259e4b1b6fffTimo Sirainenstruct dirent;
1384fac439fea3026b16a9d8d24954200e413bccTimo Sirainen
48acc31adebfdd4e4945ee76e1f5259e4b1b6fffTimo Sirainenstruct mailbox_list_vfuncs {
48acc31adebfdd4e4945ee76e1f5259e4b1b6fffTimo Sirainen struct mailbox_list *(*alloc)(void);
48acc31adebfdd4e4945ee76e1f5259e4b1b6fffTimo Sirainen void (*deinit)(struct mailbox_list *list);
48acc31adebfdd4e4945ee76e1f5259e4b1b6fffTimo Sirainen
48acc31adebfdd4e4945ee76e1f5259e4b1b6fffTimo Sirainen bool (*is_valid_pattern)(struct mailbox_list *list,
8ae72ad7d0c69e972cfa65d1e2ce4e3e9a8b765cTimo Sirainen const char *pattern);
8ae72ad7d0c69e972cfa65d1e2ce4e3e9a8b765cTimo Sirainen bool (*is_valid_existing_name)(struct mailbox_list *list,
8ae72ad7d0c69e972cfa65d1e2ce4e3e9a8b765cTimo Sirainen const char *name);
48acc31adebfdd4e4945ee76e1f5259e4b1b6fffTimo Sirainen bool (*is_valid_create_name)(struct mailbox_list *list,
48acc31adebfdd4e4945ee76e1f5259e4b1b6fffTimo Sirainen const char *name);
48acc31adebfdd4e4945ee76e1f5259e4b1b6fffTimo Sirainen
48acc31adebfdd4e4945ee76e1f5259e4b1b6fffTimo Sirainen const char *(*get_path)(struct mailbox_list *list, const char *name,
48acc31adebfdd4e4945ee76e1f5259e4b1b6fffTimo Sirainen enum mailbox_list_path_type type);
48acc31adebfdd4e4945ee76e1f5259e4b1b6fffTimo Sirainen int (*get_mailbox_name_status)(struct mailbox_list *list,
48acc31adebfdd4e4945ee76e1f5259e4b1b6fffTimo Sirainen const char *name,
8ae72ad7d0c69e972cfa65d1e2ce4e3e9a8b765cTimo Sirainen enum mailbox_name_status *status);
8ae72ad7d0c69e972cfa65d1e2ce4e3e9a8b765cTimo Sirainen
48acc31adebfdd4e4945ee76e1f5259e4b1b6fffTimo Sirainen const char *(*get_temp_prefix)(struct mailbox_list *list);
48acc31adebfdd4e4945ee76e1f5259e4b1b6fffTimo Sirainen const char *(*join_refpattern)(struct mailbox_list *list,
48acc31adebfdd4e4945ee76e1f5259e4b1b6fffTimo Sirainen const char *ref, const char *pattern);
48acc31adebfdd4e4945ee76e1f5259e4b1b6fffTimo Sirainen
48acc31adebfdd4e4945ee76e1f5259e4b1b6fffTimo Sirainen struct mailbox_list_iterate_context *
48acc31adebfdd4e4945ee76e1f5259e4b1b6fffTimo Sirainen (*iter_init)(struct mailbox_list *list,
48acc31adebfdd4e4945ee76e1f5259e4b1b6fffTimo Sirainen const char *const *patterns,
48acc31adebfdd4e4945ee76e1f5259e4b1b6fffTimo Sirainen enum mailbox_list_iter_flags flags);
48acc31adebfdd4e4945ee76e1f5259e4b1b6fffTimo Sirainen const struct mailbox_info *
48acc31adebfdd4e4945ee76e1f5259e4b1b6fffTimo Sirainen (*iter_next)(struct mailbox_list_iterate_context *ctx);
48acc31adebfdd4e4945ee76e1f5259e4b1b6fffTimo Sirainen int (*iter_deinit)(struct mailbox_list_iterate_context *ctx);
48acc31adebfdd4e4945ee76e1f5259e4b1b6fffTimo Sirainen
48acc31adebfdd4e4945ee76e1f5259e4b1b6fffTimo Sirainen /* Returns -1 if error, 0 if it's not a valid mailbox, 1 if it is.
48acc31adebfdd4e4945ee76e1f5259e4b1b6fffTimo Sirainen flags may be updated (especially the children flags). */
48acc31adebfdd4e4945ee76e1f5259e4b1b6fffTimo Sirainen int (*iter_is_mailbox)(struct mailbox_list_iterate_context *ctx,
48acc31adebfdd4e4945ee76e1f5259e4b1b6fffTimo Sirainen const char *dir, const char *fname,
48acc31adebfdd4e4945ee76e1f5259e4b1b6fffTimo Sirainen enum mailbox_list_file_type type,
48acc31adebfdd4e4945ee76e1f5259e4b1b6fffTimo Sirainen enum mailbox_info_flags *flags_r);
48acc31adebfdd4e4945ee76e1f5259e4b1b6fffTimo Sirainen
48acc31adebfdd4e4945ee76e1f5259e4b1b6fffTimo Sirainen int (*set_subscribed)(struct mailbox_list *list,
48acc31adebfdd4e4945ee76e1f5259e4b1b6fffTimo Sirainen const char *name, bool set);
int (*delete_mailbox)(struct mailbox_list *list, const char *name);
int (*rename_mailbox)(struct mailbox_list *list, const char *oldname,
const char *newname);
};
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;
size_t mailbox_name_max_length;
struct mailbox_list_vfuncs v;
/* private: */
pool_t pool;
struct mail_namespace *ns;
struct mailbox_list_settings set;
enum mailbox_list_flags flags;
/* -1 if unset: */
uid_t cached_uid;
gid_t cached_gid;
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;
};
/* 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);
int mailbox_list_delete_index_control(struct mailbox_list *list,
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);
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