mail-storage-settings.h revision 57b819d3aa978b88ef478e4f2397c32db231ebb7
a64adf62fa33f2463a86f990217b0c9078531a40Timo Sirainen#ifndef MAIL_STORAGE_SETTINGS_H
a64adf62fa33f2463a86f990217b0c9078531a40Timo Sirainen#define MAIL_STORAGE_SETTINGS_H
a64adf62fa33f2463a86f990217b0c9078531a40Timo Sirainen
2615df45a8027948a474abe5e817b34b0499c171Timo Sirainen#include "file-lock.h"
b780aa272b742a43579cdb523cc79cc8d4521306Timo Sirainen#include "fsync-mode.h"
2615df45a8027948a474abe5e817b34b0499c171Timo Sirainen
2fb9ae42f9e36388ec6db24188b9108434043fd0Timo Sirainen#define MAIL_STORAGE_SET_DRIVER_NAME "MAIL"
2fb9ae42f9e36388ec6db24188b9108434043fd0Timo Sirainen
a64adf62fa33f2463a86f990217b0c9078531a40Timo Sirainenstruct mail_user;
a64adf62fa33f2463a86f990217b0c9078531a40Timo Sirainenstruct mail_storage;
a64adf62fa33f2463a86f990217b0c9078531a40Timo Sirainen
a64adf62fa33f2463a86f990217b0c9078531a40Timo Sirainenstruct mail_storage_settings {
a64adf62fa33f2463a86f990217b0c9078531a40Timo Sirainen const char *mail_location;
b9f564d00b7a115f465ffd6840341c7b8f9bfc8aTimo Sirainen const char *mail_attachment_fs;
b9f564d00b7a115f465ffd6840341c7b8f9bfc8aTimo Sirainen const char *mail_attachment_dir;
b9f564d00b7a115f465ffd6840341c7b8f9bfc8aTimo Sirainen const char *mail_attachment_hash;
b9f564d00b7a115f465ffd6840341c7b8f9bfc8aTimo Sirainen uoff_t mail_attachment_min_size;
e15b305e90c9834734ccf35ed78f0ad29d570ee9Timo Sirainen unsigned int mail_prefetch_count;
a64adf62fa33f2463a86f990217b0c9078531a40Timo Sirainen const char *mail_cache_fields;
a64adf62fa33f2463a86f990217b0c9078531a40Timo Sirainen const char *mail_never_cache_fields;
a64adf62fa33f2463a86f990217b0c9078531a40Timo Sirainen unsigned int mail_cache_min_mail_count;
a64adf62fa33f2463a86f990217b0c9078531a40Timo Sirainen unsigned int mailbox_idle_check_interval;
a64adf62fa33f2463a86f990217b0c9078531a40Timo Sirainen unsigned int mail_max_keyword_length;
036626b19f14bef582f96e556913ae91b1d67881Timo Sirainen unsigned int mail_max_lock_timeout;
68b5e132f1f8bb2528482310daffcc06c2f019d3Timo Sirainen unsigned int mail_temp_scan_interval;
a64adf62fa33f2463a86f990217b0c9078531a40Timo Sirainen bool mail_save_crlf;
b780aa272b742a43579cdb523cc79cc8d4521306Timo Sirainen const char *mail_fsync;
a64adf62fa33f2463a86f990217b0c9078531a40Timo Sirainen bool mmap_disable;
a64adf62fa33f2463a86f990217b0c9078531a40Timo Sirainen bool dotlock_use_excl;
a64adf62fa33f2463a86f990217b0c9078531a40Timo Sirainen bool mail_nfs_storage;
a64adf62fa33f2463a86f990217b0c9078531a40Timo Sirainen bool mail_nfs_index;
dc53fff3700362b544dcba166ff81420db227a60Timo Sirainen bool mailbox_list_index;
a64adf62fa33f2463a86f990217b0c9078531a40Timo Sirainen bool mail_debug;
a64adf62fa33f2463a86f990217b0c9078531a40Timo Sirainen bool mail_full_filesystem_access;
dca6d617a23e3f93af3b8df59acb46478179fe55Timo Sirainen bool maildir_stat_dirs;
0bd259973f98837cf0e41fdee3e2a578e51ad09eTimo Sirainen bool mail_shared_explicit_inbox;
a64adf62fa33f2463a86f990217b0c9078531a40Timo Sirainen const char *lock_method;
a64adf62fa33f2463a86f990217b0c9078531a40Timo Sirainen const char *pop3_uidl_format;
2615df45a8027948a474abe5e817b34b0499c171Timo Sirainen
2615df45a8027948a474abe5e817b34b0499c171Timo Sirainen enum file_lock_method parsed_lock_method;
b780aa272b742a43579cdb523cc79cc8d4521306Timo Sirainen enum fsync_mode parsed_fsync_mode;
a64adf62fa33f2463a86f990217b0c9078531a40Timo Sirainen};
a64adf62fa33f2463a86f990217b0c9078531a40Timo Sirainen
a64adf62fa33f2463a86f990217b0c9078531a40Timo Sirainenstruct mail_namespace_settings {
f330867f937b7a8505807a02edd21524600822eeTimo Sirainen const char *name;
a64adf62fa33f2463a86f990217b0c9078531a40Timo Sirainen const char *type;
a64adf62fa33f2463a86f990217b0c9078531a40Timo Sirainen const char *separator;
a64adf62fa33f2463a86f990217b0c9078531a40Timo Sirainen const char *prefix;
a64adf62fa33f2463a86f990217b0c9078531a40Timo Sirainen const char *location;
a64adf62fa33f2463a86f990217b0c9078531a40Timo Sirainen const char *alias_for;
a64adf62fa33f2463a86f990217b0c9078531a40Timo Sirainen
a64adf62fa33f2463a86f990217b0c9078531a40Timo Sirainen bool inbox;
a64adf62fa33f2463a86f990217b0c9078531a40Timo Sirainen bool hidden;
a64adf62fa33f2463a86f990217b0c9078531a40Timo Sirainen const char *list;
a64adf62fa33f2463a86f990217b0c9078531a40Timo Sirainen bool subscriptions;
de83c1e095ba081ef80f630bcd933e5e28aff94bTimo Sirainen bool ignore_on_failure;
57b819d3aa978b88ef478e4f2397c32db231ebb7Timo Sirainen bool disabled;
b215a8a123623782554a83f3025ef4e771bd8f01Timo Sirainen
4ee00532a265bdfb38539d811fcd12d51210ac35Timo Sirainen ARRAY(struct mailbox_settings *) mailboxes;
b215a8a123623782554a83f3025ef4e771bd8f01Timo Sirainen struct mail_user_settings *user_set;
a64adf62fa33f2463a86f990217b0c9078531a40Timo Sirainen};
a64adf62fa33f2463a86f990217b0c9078531a40Timo Sirainen
eb1572d7c44ebc7b0b039d085c3dbab2ef7043ddTimo Sirainen/* <settings checks> */
eb1572d7c44ebc7b0b039d085c3dbab2ef7043ddTimo Sirainen#define MAILBOX_SET_AUTO_NO "no"
eb1572d7c44ebc7b0b039d085c3dbab2ef7043ddTimo Sirainen#define MAILBOX_SET_AUTO_CREATE "create"
eb1572d7c44ebc7b0b039d085c3dbab2ef7043ddTimo Sirainen#define MAILBOX_SET_AUTO_SUBSCRIBE "subscribe"
eb1572d7c44ebc7b0b039d085c3dbab2ef7043ddTimo Sirainen/* </settings checks> */
eb1572d7c44ebc7b0b039d085c3dbab2ef7043ddTimo Sirainenstruct mailbox_settings {
eb1572d7c44ebc7b0b039d085c3dbab2ef7043ddTimo Sirainen const char *name;
eb1572d7c44ebc7b0b039d085c3dbab2ef7043ddTimo Sirainen const char *autocreate;
ed354926406e28254b581f821bb052f38d9c14e8Timo Sirainen const char *special_use;
eb1572d7c44ebc7b0b039d085c3dbab2ef7043ddTimo Sirainen};
eb1572d7c44ebc7b0b039d085c3dbab2ef7043ddTimo Sirainen
a64adf62fa33f2463a86f990217b0c9078531a40Timo Sirainenstruct mail_user_settings {
8d3278a82b964217d95c340ec6f82037cdc59d19Timo Sirainen const char *base_dir;
8d3278a82b964217d95c340ec6f82037cdc59d19Timo Sirainen const char *auth_socket_path;
55a14bce15b9f44441b5f56616d73651a294d770Timo Sirainen const char *mail_temp_dir;
8d3278a82b964217d95c340ec6f82037cdc59d19Timo Sirainen
8d3278a82b964217d95c340ec6f82037cdc59d19Timo Sirainen const char *mail_uid;
8d3278a82b964217d95c340ec6f82037cdc59d19Timo Sirainen const char *mail_gid;
8d3278a82b964217d95c340ec6f82037cdc59d19Timo Sirainen const char *mail_home;
8d3278a82b964217d95c340ec6f82037cdc59d19Timo Sirainen const char *mail_chroot;
8d3278a82b964217d95c340ec6f82037cdc59d19Timo Sirainen const char *mail_access_groups;
8d3278a82b964217d95c340ec6f82037cdc59d19Timo Sirainen const char *mail_privileged_group;
8d3278a82b964217d95c340ec6f82037cdc59d19Timo Sirainen const char *valid_chroot_dirs;
8d3278a82b964217d95c340ec6f82037cdc59d19Timo Sirainen
8d3278a82b964217d95c340ec6f82037cdc59d19Timo Sirainen unsigned int first_valid_uid, last_valid_uid;
8d3278a82b964217d95c340ec6f82037cdc59d19Timo Sirainen unsigned int first_valid_gid, last_valid_gid;
8d3278a82b964217d95c340ec6f82037cdc59d19Timo Sirainen
8d3278a82b964217d95c340ec6f82037cdc59d19Timo Sirainen const char *mail_plugins;
8d3278a82b964217d95c340ec6f82037cdc59d19Timo Sirainen const char *mail_plugin_dir;
8d3278a82b964217d95c340ec6f82037cdc59d19Timo Sirainen
d1fff80640050631b06bfab904a34b2ad24601e8Timo Sirainen const char *mail_log_prefix;
d1fff80640050631b06bfab904a34b2ad24601e8Timo Sirainen
4ee00532a265bdfb38539d811fcd12d51210ac35Timo Sirainen ARRAY(struct mail_namespace_settings *) namespaces;
4ee00532a265bdfb38539d811fcd12d51210ac35Timo Sirainen ARRAY(const char *) plugin_envs;
a64adf62fa33f2463a86f990217b0c9078531a40Timo Sirainen};
a64adf62fa33f2463a86f990217b0c9078531a40Timo Sirainen
7744586e3e0fd60158abfbb03a233d3bd8d6c48bTimo Sirainenextern const struct setting_parser_info mail_user_setting_parser_info;
7744586e3e0fd60158abfbb03a233d3bd8d6c48bTimo Sirainenextern const struct setting_parser_info mail_namespace_setting_parser_info;
7744586e3e0fd60158abfbb03a233d3bd8d6c48bTimo Sirainenextern const struct setting_parser_info mail_storage_setting_parser_info;
7744586e3e0fd60158abfbb03a233d3bd8d6c48bTimo Sirainenextern const struct mail_namespace_settings mail_namespace_default_settings;
eb1572d7c44ebc7b0b039d085c3dbab2ef7043ddTimo Sirainenextern const struct mailbox_settings mailbox_default_settings;
a64adf62fa33f2463a86f990217b0c9078531a40Timo Sirainen
a64adf62fa33f2463a86f990217b0c9078531a40Timo Sirainenconst void *
2fb9ae42f9e36388ec6db24188b9108434043fd0Timo Sirainenmail_user_set_get_driver_settings(const struct setting_parser_info *info,
2fb9ae42f9e36388ec6db24188b9108434043fd0Timo Sirainen const struct mail_user_settings *set,
a64adf62fa33f2463a86f990217b0c9078531a40Timo Sirainen const char *driver);
8d3278a82b964217d95c340ec6f82037cdc59d19Timo Sirainenconst struct mail_storage_settings *
2fb9ae42f9e36388ec6db24188b9108434043fd0Timo Sirainenmail_user_set_get_storage_set(struct mail_user *user);
a64adf62fa33f2463a86f990217b0c9078531a40Timo Sirainenconst void *mail_storage_get_driver_settings(struct mail_storage *storage);
a64adf62fa33f2463a86f990217b0c9078531a40Timo Sirainen
a64adf62fa33f2463a86f990217b0c9078531a40Timo Sirainenenum mail_index_open_flags
a64adf62fa33f2463a86f990217b0c9078531a40Timo Sirainenmail_storage_settings_to_index_flags(const struct mail_storage_settings *set);
a64adf62fa33f2463a86f990217b0c9078531a40Timo Sirainen
5d03d9f439e41c90215a3c938ffebe4c2a8ae257Timo Sirainenconst struct dynamic_settings_parser *
5d03d9f439e41c90215a3c938ffebe4c2a8ae257Timo Sirainenmail_storage_get_dynamic_parsers(pool_t pool);
a64adf62fa33f2463a86f990217b0c9078531a40Timo Sirainen
a64adf62fa33f2463a86f990217b0c9078531a40Timo Sirainen#endif