doveadm-mail.h revision 2a15ce3abe14099b94535f6dfc2d4ee023a7c455
02c335c23bf5fa225a467c19f2c063fb0dc7b8c3Timo Sirainen#ifndef DOVEADM_MAIL_H
48acc31adebfdd4e4945ee76e1f5259e4b1b6fffTimo Sirainen#define DOVEADM_MAIL_H
48acc31adebfdd4e4945ee76e1f5259e4b1b6fffTimo Sirainen
48acc31adebfdd4e4945ee76e1f5259e4b1b6fffTimo Sirainen#include <stdio.h>
48acc31adebfdd4e4945ee76e1f5259e4b1b6fffTimo Sirainen#include "doveadm.h"
48acc31adebfdd4e4945ee76e1f5259e4b1b6fffTimo Sirainen#include "doveadm-util.h"
48acc31adebfdd4e4945ee76e1f5259e4b1b6fffTimo Sirainen#include "module-context.h"
4082d5b171d1c3a00ba705093d62b8afc9cf17aeTimo Sirainen#include "mail-error.h"
4082d5b171d1c3a00ba705093d62b8afc9cf17aeTimo Sirainen#include "mail-storage-service.h"
4082d5b171d1c3a00ba705093d62b8afc9cf17aeTimo Sirainen
4082d5b171d1c3a00ba705093d62b8afc9cf17aeTimo Sirainenstruct mailbox;
4082d5b171d1c3a00ba705093d62b8afc9cf17aeTimo Sirainenstruct mail_storage;
4082d5b171d1c3a00ba705093d62b8afc9cf17aeTimo Sirainenstruct mail_user;
4082d5b171d1c3a00ba705093d62b8afc9cf17aeTimo Sirainenstruct doveadm_mail_cmd_context;
4082d5b171d1c3a00ba705093d62b8afc9cf17aeTimo Sirainen
4082d5b171d1c3a00ba705093d62b8afc9cf17aeTimo Sirainenstruct doveadm_mail_cmd_vfuncs {
4082d5b171d1c3a00ba705093d62b8afc9cf17aeTimo Sirainen bool (*parse_arg)(struct doveadm_mail_cmd_context *ctx,int c);
4082d5b171d1c3a00ba705093d62b8afc9cf17aeTimo Sirainen void (*preinit)(struct doveadm_mail_cmd_context *ctx);
4082d5b171d1c3a00ba705093d62b8afc9cf17aeTimo Sirainen void (*init)(struct doveadm_mail_cmd_context *ctx,
4082d5b171d1c3a00ba705093d62b8afc9cf17aeTimo Sirainen const char *const args[]);
4082d5b171d1c3a00ba705093d62b8afc9cf17aeTimo Sirainen int (*get_next_user)(struct doveadm_mail_cmd_context *ctx,
4082d5b171d1c3a00ba705093d62b8afc9cf17aeTimo Sirainen const char **username_r);
4082d5b171d1c3a00ba705093d62b8afc9cf17aeTimo Sirainen int (*prerun)(struct doveadm_mail_cmd_context *ctx,
4082d5b171d1c3a00ba705093d62b8afc9cf17aeTimo Sirainen struct mail_storage_service_user *service_user,
4082d5b171d1c3a00ba705093d62b8afc9cf17aeTimo Sirainen const char **error_r);
4082d5b171d1c3a00ba705093d62b8afc9cf17aeTimo Sirainen int (*run)(struct doveadm_mail_cmd_context *ctx,
4082d5b171d1c3a00ba705093d62b8afc9cf17aeTimo Sirainen struct mail_user *mail_user);
4082d5b171d1c3a00ba705093d62b8afc9cf17aeTimo Sirainen void (*deinit)(struct doveadm_mail_cmd_context *ctx);
4082d5b171d1c3a00ba705093d62b8afc9cf17aeTimo Sirainen};
4082d5b171d1c3a00ba705093d62b8afc9cf17aeTimo Sirainen
4082d5b171d1c3a00ba705093d62b8afc9cf17aeTimo Sirainenstruct doveadm_mail_cmd_module_register {
4082d5b171d1c3a00ba705093d62b8afc9cf17aeTimo Sirainen unsigned int id;
4082d5b171d1c3a00ba705093d62b8afc9cf17aeTimo Sirainen};
4082d5b171d1c3a00ba705093d62b8afc9cf17aeTimo Sirainen
4082d5b171d1c3a00ba705093d62b8afc9cf17aeTimo Sirainenunion doveadm_mail_cmd_module_context {
4082d5b171d1c3a00ba705093d62b8afc9cf17aeTimo Sirainen struct doveadm_mail_cmd_vfuncs super;
4082d5b171d1c3a00ba705093d62b8afc9cf17aeTimo Sirainen struct doveadm_mail_cmd_module_register *reg;
4082d5b171d1c3a00ba705093d62b8afc9cf17aeTimo Sirainen};
4082d5b171d1c3a00ba705093d62b8afc9cf17aeTimo Sirainen
4082d5b171d1c3a00ba705093d62b8afc9cf17aeTimo Sirainenstruct doveadm_mail_cmd_context {
4082d5b171d1c3a00ba705093d62b8afc9cf17aeTimo Sirainen pool_t pool;
4082d5b171d1c3a00ba705093d62b8afc9cf17aeTimo Sirainen const struct doveadm_mail_cmd *cmd;
d06d6667bac64aabe1efb216af56ca45108d63b0Timo Sirainen const char *const *args;
d06d6667bac64aabe1efb216af56ca45108d63b0Timo Sirainen /* args including -options */
d06d6667bac64aabe1efb216af56ca45108d63b0Timo Sirainen const char *const *full_args;
d06d6667bac64aabe1efb216af56ca45108d63b0Timo Sirainen
d06d6667bac64aabe1efb216af56ca45108d63b0Timo Sirainen const char *getopt_args;
d06d6667bac64aabe1efb216af56ca45108d63b0Timo Sirainen const struct doveadm_settings *set;
86bde2c1838d1ce967fa2b394bb952004a4adcb7Timo Sirainen enum mail_storage_service_flags service_flags;
86bde2c1838d1ce967fa2b394bb952004a4adcb7Timo Sirainen struct mail_storage_service_ctx *storage_service;
86bde2c1838d1ce967fa2b394bb952004a4adcb7Timo Sirainen struct mail_storage_service_input storage_service_input;
d06d6667bac64aabe1efb216af56ca45108d63b0Timo Sirainen /* search args aren't set for all mail commands */
c8bac7666cdc780a3390110e420350fffb62b909Timo Sirainen struct mail_search_args *search_args;
c8bac7666cdc780a3390110e420350fffb62b909Timo Sirainen
c8bac7666cdc780a3390110e420350fffb62b909Timo Sirainen const char *cur_username;
c8bac7666cdc780a3390110e420350fffb62b909Timo Sirainen struct mail_storage_service_user *cur_service_user;
c8bac7666cdc780a3390110e420350fffb62b909Timo Sirainen struct mail_user *cur_mail_user;
d06d6667bac64aabe1efb216af56ca45108d63b0Timo Sirainen struct doveadm_mail_cmd_vfuncs v;
d06d6667bac64aabe1efb216af56ca45108d63b0Timo Sirainen
d06d6667bac64aabe1efb216af56ca45108d63b0Timo Sirainen ARRAY(union doveadm_mail_cmd_module_context *) module_contexts;
199566f5a171b2c43b9a5254634f6bf47b8baca8Timo Sirainen
199566f5a171b2c43b9a5254634f6bf47b8baca8Timo Sirainen /* if non-zero, exit with this code */
199566f5a171b2c43b9a5254634f6bf47b8baca8Timo Sirainen int exit_code;
199566f5a171b2c43b9a5254634f6bf47b8baca8Timo Sirainen
199566f5a171b2c43b9a5254634f6bf47b8baca8Timo Sirainen /* This command is being called by a remote doveadm client. */
199566f5a171b2c43b9a5254634f6bf47b8baca8Timo Sirainen unsigned int proxying:1;
199566f5a171b2c43b9a5254634f6bf47b8baca8Timo Sirainen /* We're handling only a single user */
199566f5a171b2c43b9a5254634f6bf47b8baca8Timo Sirainen unsigned int iterate_single_user:1;
199566f5a171b2c43b9a5254634f6bf47b8baca8Timo Sirainen /* We're going through all users (not set for wildcard usernames) */
199566f5a171b2c43b9a5254634f6bf47b8baca8Timo Sirainen unsigned int iterate_all_users:1;
199566f5a171b2c43b9a5254634f6bf47b8baca8Timo Sirainen};
199566f5a171b2c43b9a5254634f6bf47b8baca8Timo Sirainen
199566f5a171b2c43b9a5254634f6bf47b8baca8Timo Sirainenstruct doveadm_mail_cmd {
199566f5a171b2c43b9a5254634f6bf47b8baca8Timo Sirainen struct doveadm_mail_cmd_context *(*alloc)(void);
199566f5a171b2c43b9a5254634f6bf47b8baca8Timo Sirainen const char *name;
199566f5a171b2c43b9a5254634f6bf47b8baca8Timo Sirainen const char *usage_args;
199566f5a171b2c43b9a5254634f6bf47b8baca8Timo Sirainen};
199566f5a171b2c43b9a5254634f6bf47b8baca8Timo SirainenARRAY_DEFINE_TYPE(doveadm_mail_cmd, struct doveadm_mail_cmd);
199566f5a171b2c43b9a5254634f6bf47b8baca8Timo Sirainen
199566f5a171b2c43b9a5254634f6bf47b8baca8Timo Sirainenextern ARRAY_TYPE(doveadm_mail_cmd) doveadm_mail_cmds;
199566f5a171b2c43b9a5254634f6bf47b8baca8Timo Sirainenextern void (*hook_doveadm_mail_init)(struct doveadm_mail_cmd_context *ctx);
199566f5a171b2c43b9a5254634f6bf47b8baca8Timo Sirainenextern struct doveadm_mail_cmd_module_register doveadm_mail_cmd_module_register;
199566f5a171b2c43b9a5254634f6bf47b8baca8Timo Sirainenextern char doveadm_mail_cmd_hide;
199566f5a171b2c43b9a5254634f6bf47b8baca8Timo Sirainen
199566f5a171b2c43b9a5254634f6bf47b8baca8Timo Sirainenbool doveadm_mail_try_run(const char *cmd_name, int argc, char *argv[]);
199566f5a171b2c43b9a5254634f6bf47b8baca8Timo Sirainenvoid doveadm_mail_register_cmd(const struct doveadm_mail_cmd *cmd);
48acc31adebfdd4e4945ee76e1f5259e4b1b6fffTimo Sirainenconst struct doveadm_mail_cmd *doveadm_mail_cmd_find(const char *cmd_name);
48acc31adebfdd4e4945ee76e1f5259e4b1b6fffTimo Sirainen
ba66ac5557ca97d8a6fe5d524056264a9f92243cPhil Carmodyvoid doveadm_mail_usage(string_t *out);
ba66ac5557ca97d8a6fe5d524056264a9f92243cPhil Carmodyvoid doveadm_mail_help(const struct doveadm_mail_cmd *cmd) ATTR_NORETURN;
48acc31adebfdd4e4945ee76e1f5259e4b1b6fffTimo Sirainenvoid doveadm_mail_help_name(const char *cmd_name) ATTR_NORETURN;
48acc31adebfdd4e4945ee76e1f5259e4b1b6fffTimo Sirainenvoid doveadm_mail_try_help_name(const char *cmd_name);
48acc31adebfdd4e4945ee76e1f5259e4b1b6fffTimo Sirainenbool doveadm_mail_has_subcommands(const char *cmd_name);
48acc31adebfdd4e4945ee76e1f5259e4b1b6fffTimo Sirainen
48acc31adebfdd4e4945ee76e1f5259e4b1b6fffTimo Sirainenvoid doveadm_mail_init(void);
48acc31adebfdd4e4945ee76e1f5259e4b1b6fffTimo Sirainenvoid doveadm_mail_deinit(void);
48acc31adebfdd4e4945ee76e1f5259e4b1b6fffTimo Sirainen
48acc31adebfdd4e4945ee76e1f5259e4b1b6fffTimo Sirainenstruct doveadm_mail_cmd_context *
48acc31adebfdd4e4945ee76e1f5259e4b1b6fffTimo Sirainendoveadm_mail_cmd_init(const struct doveadm_mail_cmd *cmd,
48acc31adebfdd4e4945ee76e1f5259e4b1b6fffTimo Sirainen const struct doveadm_settings *set);
48acc31adebfdd4e4945ee76e1f5259e4b1b6fffTimo Sirainenint doveadm_mail_single_user(struct doveadm_mail_cmd_context *ctx,
48acc31adebfdd4e4945ee76e1f5259e4b1b6fffTimo Sirainen const struct mail_storage_service_input *input,
48acc31adebfdd4e4945ee76e1f5259e4b1b6fffTimo Sirainen const char **error_r);
48acc31adebfdd4e4945ee76e1f5259e4b1b6fffTimo Sirainenint doveadm_mail_server_user(struct doveadm_mail_cmd_context *ctx,
48acc31adebfdd4e4945ee76e1f5259e4b1b6fffTimo Sirainen const struct mail_storage_service_input *input,
48acc31adebfdd4e4945ee76e1f5259e4b1b6fffTimo Sirainen const char **error_r);
ba66ac5557ca97d8a6fe5d524056264a9f92243cPhil Carmodyvoid doveadm_mail_server_flush(void);
ba66ac5557ca97d8a6fe5d524056264a9f92243cPhil Carmody
48acc31adebfdd4e4945ee76e1f5259e4b1b6fffTimo Sirainenstruct mailbox *
48acc31adebfdd4e4945ee76e1f5259e4b1b6fffTimo Sirainendoveadm_mailbox_find(struct mail_user *user, const char *mailbox);
48acc31adebfdd4e4945ee76e1f5259e4b1b6fffTimo Sirainenint doveadm_mailbox_find_and_sync(struct mail_user *user, const char *mailbox,
ba66ac5557ca97d8a6fe5d524056264a9f92243cPhil Carmody struct mailbox **box_r);
ba66ac5557ca97d8a6fe5d524056264a9f92243cPhil Carmodystruct mail_search_args *
ba66ac5557ca97d8a6fe5d524056264a9f92243cPhil Carmodydoveadm_mail_build_search_args(const char *const args[]);
ba66ac5557ca97d8a6fe5d524056264a9f92243cPhil Carmodyvoid doveadm_mailbox_args_check(const char *const args[]);
ba66ac5557ca97d8a6fe5d524056264a9f92243cPhil Carmodystruct mail_search_args *
ba66ac5557ca97d8a6fe5d524056264a9f92243cPhil Carmodydoveadm_mail_mailbox_search_args_build(const char *const args[]);
ba66ac5557ca97d8a6fe5d524056264a9f92243cPhil Carmody
48acc31adebfdd4e4945ee76e1f5259e4b1b6fffTimo Sirainenvoid expunge_search_args_check(struct mail_search_args *args, const char *cmd);
48acc31adebfdd4e4945ee76e1f5259e4b1b6fffTimo Sirainen
461ffead9720d1e516b959d5e41f049c73d38c7cTimo Sirainenstruct doveadm_mail_cmd_context *
48acc31adebfdd4e4945ee76e1f5259e4b1b6fffTimo Sirainendoveadm_mail_cmd_alloc_size(size_t size);
48acc31adebfdd4e4945ee76e1f5259e4b1b6fffTimo Sirainen#define doveadm_mail_cmd_alloc(type) \
48acc31adebfdd4e4945ee76e1f5259e4b1b6fffTimo Sirainen (type *)doveadm_mail_cmd_alloc_size(sizeof(type))
48acc31adebfdd4e4945ee76e1f5259e4b1b6fffTimo Sirainen
461ffead9720d1e516b959d5e41f049c73d38c7cTimo Sirainenvoid doveadm_mail_failed_error(struct doveadm_mail_cmd_context *ctx,
48acc31adebfdd4e4945ee76e1f5259e4b1b6fffTimo Sirainen enum mail_error error);
48acc31adebfdd4e4945ee76e1f5259e4b1b6fffTimo Sirainenvoid doveadm_mail_failed_storage(struct doveadm_mail_cmd_context *ctx,
48acc31adebfdd4e4945ee76e1f5259e4b1b6fffTimo Sirainen struct mail_storage *storage);
48acc31adebfdd4e4945ee76e1f5259e4b1b6fffTimo Sirainenvoid doveadm_mail_failed_mailbox(struct doveadm_mail_cmd_context *ctx,
48acc31adebfdd4e4945ee76e1f5259e4b1b6fffTimo Sirainen struct mailbox *box);
48acc31adebfdd4e4945ee76e1f5259e4b1b6fffTimo Sirainen
48acc31adebfdd4e4945ee76e1f5259e4b1b6fffTimo Sirainenextern struct doveadm_mail_cmd cmd_expunge;
48acc31adebfdd4e4945ee76e1f5259e4b1b6fffTimo Sirainenextern struct doveadm_mail_cmd cmd_search;
48acc31adebfdd4e4945ee76e1f5259e4b1b6fffTimo Sirainenextern struct doveadm_mail_cmd cmd_fetch;
48acc31adebfdd4e4945ee76e1f5259e4b1b6fffTimo Sirainenextern struct doveadm_mail_cmd cmd_import;
48acc31adebfdd4e4945ee76e1f5259e4b1b6fffTimo Sirainenextern struct doveadm_mail_cmd cmd_index;
48acc31adebfdd4e4945ee76e1f5259e4b1b6fffTimo Sirainenextern struct doveadm_mail_cmd cmd_altmove;
48acc31adebfdd4e4945ee76e1f5259e4b1b6fffTimo Sirainenextern struct doveadm_mail_cmd cmd_copy;
d06d6667bac64aabe1efb216af56ca45108d63b0Timo Sirainenextern struct doveadm_mail_cmd cmd_move;
48acc31adebfdd4e4945ee76e1f5259e4b1b6fffTimo Sirainenextern struct doveadm_mail_cmd cmd_mailbox_list;
48acc31adebfdd4e4945ee76e1f5259e4b1b6fffTimo Sirainenextern struct doveadm_mail_cmd cmd_mailbox_create;
48acc31adebfdd4e4945ee76e1f5259e4b1b6fffTimo Sirainenextern struct doveadm_mail_cmd cmd_mailbox_delete;
48acc31adebfdd4e4945ee76e1f5259e4b1b6fffTimo Sirainenextern struct doveadm_mail_cmd cmd_mailbox_rename;
48acc31adebfdd4e4945ee76e1f5259e4b1b6fffTimo Sirainenextern struct doveadm_mail_cmd cmd_mailbox_subscribe;
48acc31adebfdd4e4945ee76e1f5259e4b1b6fffTimo Sirainenextern struct doveadm_mail_cmd cmd_mailbox_unsubscribe;
48acc31adebfdd4e4945ee76e1f5259e4b1b6fffTimo Sirainenextern struct doveadm_mail_cmd cmd_mailbox_status;
48acc31adebfdd4e4945ee76e1f5259e4b1b6fffTimo Sirainen
48acc31adebfdd4e4945ee76e1f5259e4b1b6fffTimo Sirainen#endif
48acc31adebfdd4e4945ee76e1f5259e4b1b6fffTimo Sirainen