doveadm-mail.h revision 26c41874cf6019c3e39f0ed630b2a07a92b2635f
be6ad6e46ecb8c7126b421819046e7f4857a2babTimo Sirainen /* Parse one getopt() parameter. This is called for each parameter. */
be6ad6e46ecb8c7126b421819046e7f4857a2babTimo Sirainen bool (*parse_arg)(struct doveadm_mail_cmd_context *ctx, int c);
e2ce8d4a6ac5d82a906178148453e7613fab9ba0Timo Sirainen /* Usually not needed. The preinit() is called just after parsing all
e2ce8d4a6ac5d82a906178148453e7613fab9ba0Timo Sirainen parameters, but before any userdb lookups are done. This allows the
be6ad6e46ecb8c7126b421819046e7f4857a2babTimo Sirainen preinit() to alter the userdb lookup behavior (especially
be6ad6e46ecb8c7126b421819046e7f4857a2babTimo Sirainen service_flags). */
be6ad6e46ecb8c7126b421819046e7f4857a2babTimo Sirainen void (*preinit)(struct doveadm_mail_cmd_context *ctx);
be6ad6e46ecb8c7126b421819046e7f4857a2babTimo Sirainen /* Initialize the command. Most importantly if the function prints
be6ad6e46ecb8c7126b421819046e7f4857a2babTimo Sirainen anything, this should initialize the headers. It shouldn't however
be6ad6e46ecb8c7126b421819046e7f4857a2babTimo Sirainen do any actual work. The init() is called also when doveadm is
be6ad6e46ecb8c7126b421819046e7f4857a2babTimo Sirainen performing the work via doveadm-server, which could be running
be6ad6e46ecb8c7126b421819046e7f4857a2babTimo Sirainen remotely with completely different Dovecot configuration. */
be6ad6e46ecb8c7126b421819046e7f4857a2babTimo Sirainen void (*init)(struct doveadm_mail_cmd_context *ctx,
be6ad6e46ecb8c7126b421819046e7f4857a2babTimo Sirainen const char *const args[]);
be6ad6e46ecb8c7126b421819046e7f4857a2babTimo Sirainen /* Usually not needed. When iterating through multiple users, use this
be6ad6e46ecb8c7126b421819046e7f4857a2babTimo Sirainen function to get the next username. Overriding this is usually done
be6ad6e46ecb8c7126b421819046e7f4857a2babTimo Sirainen only when there's a known username filter, such as the expire
be6ad6e46ecb8c7126b421819046e7f4857a2babTimo Sirainen int (*get_next_user)(struct doveadm_mail_cmd_context *ctx,
be6ad6e46ecb8c7126b421819046e7f4857a2babTimo Sirainen const char **username_r);
be6ad6e46ecb8c7126b421819046e7f4857a2babTimo Sirainen /* Usually not needed. This is called between
be6ad6e46ecb8c7126b421819046e7f4857a2babTimo Sirainen mail_storage_service_lookup() and mail_storage_service_next() for
be6ad6e46ecb8c7126b421819046e7f4857a2babTimo Sirainen each user. */
be6ad6e46ecb8c7126b421819046e7f4857a2babTimo Sirainen int (*prerun)(struct doveadm_mail_cmd_context *ctx,
be6ad6e46ecb8c7126b421819046e7f4857a2babTimo Sirainen struct mail_storage_service_user *service_user,
be6ad6e46ecb8c7126b421819046e7f4857a2babTimo Sirainen const char **error_r);
be6ad6e46ecb8c7126b421819046e7f4857a2babTimo Sirainen /* This is the main function which performs all the work for the
be6ad6e46ecb8c7126b421819046e7f4857a2babTimo Sirainen command. This is called once per each user. */
be6ad6e46ecb8c7126b421819046e7f4857a2babTimo Sirainen int (*run)(struct doveadm_mail_cmd_context *ctx,
be6ad6e46ecb8c7126b421819046e7f4857a2babTimo Sirainen /* Deinitialize the command. Called once at the end - even if
be6ad6e46ecb8c7126b421819046e7f4857a2babTimo Sirainen preinit() or init() was never called. */
be6ad6e46ecb8c7126b421819046e7f4857a2babTimo Sirainen void (*deinit)(struct doveadm_mail_cmd_context *ctx);
bcd286622779a93f809b11993db0550f8c7cc9b5Timo Sirainen unsigned int id;
be6ad6e46ecb8c7126b421819046e7f4857a2babTimo Sirainen const char *const *args;
be6ad6e46ecb8c7126b421819046e7f4857a2babTimo Sirainen /* args including -options */
be6ad6e46ecb8c7126b421819046e7f4857a2babTimo Sirainen const char *const *full_args;
be6ad6e46ecb8c7126b421819046e7f4857a2babTimo Sirainen /* connection via doveadm-server */
be6ad6e46ecb8c7126b421819046e7f4857a2babTimo Sirainen enum mail_storage_service_flags service_flags;
be6ad6e46ecb8c7126b421819046e7f4857a2babTimo Sirainen struct mail_storage_service_ctx *storage_service;
be6ad6e46ecb8c7126b421819046e7f4857a2babTimo Sirainen struct mail_storage_service_input storage_service_input;
be6ad6e46ecb8c7126b421819046e7f4857a2babTimo Sirainen /* search args aren't set for all mail commands */
be6ad6e46ecb8c7126b421819046e7f4857a2babTimo Sirainen struct mail_storage_service_user *cur_service_user;
76d4ff1c1b31a1a09f6cbfe613a8d0efe62cbfd2Timo Sirainen ARRAY(union doveadm_mail_cmd_module_context *) module_contexts;
76d4ff1c1b31a1a09f6cbfe613a8d0efe62cbfd2Timo Sirainen /* if non-zero, exit with this code */
76d4ff1c1b31a1a09f6cbfe613a8d0efe62cbfd2Timo Sirainen /* This command is being called by a remote doveadm client. */
76d4ff1c1b31a1a09f6cbfe613a8d0efe62cbfd2Timo Sirainen /* We're handling only a single user */
76d4ff1c1b31a1a09f6cbfe613a8d0efe62cbfd2Timo Sirainen /* We're going through all users (not set for wildcard usernames) */
be6ad6e46ecb8c7126b421819046e7f4857a2babTimo Sirainen /* Add username header to all replies */
5df8396a7cbad0b38b83a86667fb3d4c223f6f7cTimo Sirainen /* Running from CLI doveadm (not doveadm-server) */
f1ed4fa248aaf6841ba638b9d66b2738d9f7aa18Timo Sirainen /* Allow empty mailbox name - to allow access to server attributes */
be6ad6e46ecb8c7126b421819046e7f4857a2babTimo Sirainen struct doveadm_mail_cmd_context *(*alloc)(void);
be6ad6e46ecb8c7126b421819046e7f4857a2babTimo SirainenARRAY_DEFINE_TYPE(doveadm_mail_cmd, struct doveadm_mail_cmd);
be6ad6e46ecb8c7126b421819046e7f4857a2babTimo Sirainenextern ARRAY_TYPE(doveadm_mail_cmd) doveadm_mail_cmds;
extern char doveadm_mail_cmd_hide;
bool doveadm_is_killed(void);
int doveadm_killed_signo(void);
void doveadm_mail_init(void);
void doveadm_mail_deinit(void);
const struct doveadm_mail_cmd *
const char *const **argv);
struct doveadm_mail_cmd_context *
const char **error_r);
const char **error_r);
void doveadm_mail_server_flush(void);
struct mailbox *
struct mail_search_args *
struct mail_search_args *
struct doveadm_mail_cmd_context *
#define DOVEADM_CMD_MAIL_COMMON \
#define DOVEADM_CMD_MAIL_USAGE_PREFIX \