Usually this is only ever to be used during migration, or restoring mailbox after disaster.
Settings these values is highly discouraged, and is not supported for all mail backends.
.\"------------------------------------------------------------------------
-.SS mailbox cache compress
-.B doveadm mailbox cache compress
+.SS mailbox cache purge
+.B doveadm mailbox cache purge
[\fB\-A\fP|\fB\-u\fP \fIuser\fP|\fB\-F\fP \fIfile\fP]
[\fB\-S\fP \fIsocket_path\fP]
.IR mailbox\ ...
.PP
-Perform "compression" to the dovecot.index.cache file. Most importantly this
-frees up disk space from mails that were already deleted. Normally there is
-no need to run this command manually, because the compression is also run
-automatically.
+Purge the dovecot.index.cache file. Most importantly this frees up disk space
+from mails that were already deleted. Normally there i no need to run this
+command manually, because the compression is also run automatically.
.\"------------------------------------------------------------------------
.SS mailbox cache decision
.B doveadm mailbox cache decision
ctx->ctx.search_args = doveadm_mail_build_search_args(args);
}
-static int cmd_mailbox_cache_compress_run_box(struct mailbox_cache_cmd_context *ctx,
- struct mailbox *box)
+static int cmd_mailbox_cache_purge_run_box(struct mailbox_cache_cmd_context *ctx,
+ struct mailbox *box)
{
struct mailbox_transaction_context *t =
mailbox_transaction_begin(box,
MAILBOX_TRANSACTION_FLAG_EXTERNAL,
- "mailbox cache compress");
+ "mailbox cache purge");
struct mail_cache *cache = t->box->cache;
struct mail_cache_compress_lock *lock;
int ret = 0;
return ret;
}
-static int cmd_mailbox_cache_compress_run(struct doveadm_mail_cmd_context *_ctx,
- struct mail_user *user)
+static int cmd_mailbox_cache_purge_run(struct doveadm_mail_cmd_context *_ctx,
+ struct mail_user *user)
{
struct mailbox_cache_cmd_context *ctx =
container_of(_ctx, struct mailbox_cache_cmd_context, ctx);
struct mailbox *box;
if ((ret = cmd_mailbox_cache_open_box(_ctx, user, *boxname, &box)) < 0)
break;
- ret = cmd_mailbox_cache_compress_run_box(ctx, box);
+ ret = cmd_mailbox_cache_purge_run_box(ctx, box);
mailbox_free(&box);
}
return ret;
}
-static void cmd_mailbox_cache_compress_init(struct doveadm_mail_cmd_context *_ctx,
- const char *const args[])
+static void cmd_mailbox_cache_purge_init(struct doveadm_mail_cmd_context *_ctx,
+ const char *const args[])
{
struct mailbox_cache_cmd_context *ctx =
container_of(_ctx, struct mailbox_cache_cmd_context, ctx);
return &ctx->ctx;
}
-static struct doveadm_mail_cmd_context *cmd_mailbox_cache_compress_alloc(void)
+static struct doveadm_mail_cmd_context *cmd_mailbox_cache_purge_alloc(void)
{
struct mailbox_cache_cmd_context *ctx =
doveadm_mail_cmd_alloc(struct mailbox_cache_cmd_context);
- ctx->ctx.v.init = cmd_mailbox_cache_compress_init;
- ctx->ctx.v.run = cmd_mailbox_cache_compress_run;
+ ctx->ctx.v.init = cmd_mailbox_cache_purge_init;
+ ctx->ctx.v.run = cmd_mailbox_cache_purge_run;
ctx->ctx.getopt_args = "";
doveadm_print_init(DOVEADM_PRINT_TYPE_TABLE);
return &ctx->ctx;
DOVEADM_CMD_PARAMS_END
};
-struct doveadm_cmd_ver2 doveadm_cmd_mailbox_cache_compress = {
- .name = "mailbox cache compress",
- .mail_cmd = cmd_mailbox_cache_compress_alloc,
+struct doveadm_cmd_ver2 doveadm_cmd_mailbox_cache_purge = {
+ .name = "mailbox cache purge",
+ .mail_cmd = cmd_mailbox_cache_purge_alloc,
.usage = DOVEADM_CMD_MAIL_USAGE_PREFIX"<mailbox> [...]",
DOVEADM_CMD_PARAMS_START
DOVEADM_CMD_MAIL_COMMON