diff --git a/data/doveadm.js b/data/doveadm.js index d3c65a33f..0f7650e82 100644 --- a/data/doveadm.js +++ b/data/doveadm.js @@ -763,15 +763,10 @@ Applicable to [[link,mdbox]] and [[link,sdbox]] mailbox formats only. 'fs copy': { args: { - 'fs-driver': { + 'filter-name': { positional: true, type: doveadm_arg_types.STRING, - text: `Filesystem driver to use.` - }, - 'fs-args': { - positional: true, - type: doveadm_arg_types.STRING, - text: `Filesystem driver arguments to use.` + text: `Configuration filter name to use.` }, 'source-path': { type: doveadm_arg_types.STRING, @@ -793,20 +788,15 @@ Applicable to [[link,mdbox]] and [[link,sdbox]] mailbox formats only. type: doveadm_arg_types.BOOL, text: `Do recursive delete of path.` }, - maxParallel: { + 'max-parallel': { cli: 'n', type: doveadm_arg_types.INTEGER, text: `Max number of parallel workers.`, }, - 'fs-driver': { - positional: true, - type: doveadm_arg_types.STRING, - text: `Filesystem driver to use.` - }, - 'fs-args': { + 'filter-name': { positional: true, type: doveadm_arg_types.STRING, - text: `Filesystem driver arguments to use.` + text: `Configuration filter name to use.` }, path: { positional: true, @@ -820,15 +810,10 @@ Applicable to [[link,mdbox]] and [[link,sdbox]] mailbox formats only. 'fs get': { args: { - 'fs-driver': { + 'filter-name': { positional: true, type: doveadm_arg_types.STRING, - text: `Filesystem driver to use.` - }, - 'fs-args': { - positional: true, - type: doveadm_arg_types.STRING, - text: `Filesystem driver arguments to use.` + text: `Configuration filter name to use.` }, path: { positional: true, @@ -842,23 +827,18 @@ Applicable to [[link,mdbox]] and [[link,sdbox]] mailbox formats only. 'fs iter': { args: { - noCache: { + 'no-cache': { cli: 'C', type: doveadm_arg_types.BOOL }, - objectIds: { + 'object-ids': { cli: 'O', type: doveadm_arg_types.BOOL }, - 'fs-driver': { + 'filter-name': { positional: true, type: doveadm_arg_types.STRING, - text: `Filesystem driver to use.` - }, - 'fs-args': { - positional: true, - type: doveadm_arg_types.STRING, - text: `Filesystem driver arguments to use.` + text: `Configuration filter name to use.` }, path: { positional: true, @@ -872,15 +852,10 @@ Applicable to [[link,mdbox]] and [[link,sdbox]] mailbox formats only. 'fs iter-dirs': { args: { - 'fs-driver': { + 'filter-name': { positional: true, type: doveadm_arg_types.STRING, - text: `Filesystem driver to use.` - }, - 'fs-args': { - positional: true, - type: doveadm_arg_types.STRING, - text: `Filesystem driver arguments to use.` + text: `Configuration filter name to use.` }, path: { positional: true, @@ -894,15 +869,10 @@ Applicable to [[link,mdbox]] and [[link,sdbox]] mailbox formats only. 'fs metadata': { args: { - 'fs-driver': { - positional: true, - type: doveadm_arg_types.STRING, - text: `Filesystem driver to use.` - }, - 'fs-args': { + 'filter-name': { positional: true, type: doveadm_arg_types.STRING, - text: `Filesystem driver arguments to use.` + text: `Configuration filter name to use.` }, path: { positional: true, @@ -923,15 +893,10 @@ Applicable to [[link,mdbox]] and [[link,sdbox]] mailbox formats only. cli: 'm', type: doveadm_arg_types.ARRAY }, - 'fs-driver': { - positional: true, - type: doveadm_arg_types.STRING, - text: `Filesystem driver to use.` - }, - 'fs-args': { + 'filter-name': { positional: true, type: doveadm_arg_types.STRING, - text: `Filesystem driver arguments to use.` + text: `Configuration filter name to use.` }, 'input-path': { positional: true, @@ -950,15 +915,10 @@ Applicable to [[link,mdbox]] and [[link,sdbox]] mailbox formats only. 'fs stat': { args: { - 'fs-driver': { + 'filter-name': { positional: true, type: doveadm_arg_types.STRING, - text: `Filesystem driver to use.` - }, - 'fs-args': { - positional: true, - type: doveadm_arg_types.STRING, - text: `Filesystem driver arguments to use.` + text: `Configuration filter name to use.` }, path: { positional: true, @@ -1226,6 +1186,183 @@ Applicable to [[link,mdbox]] and [[link,sdbox]] mailbox formats only. text: `Write a test message to the log files.`, }, + 'mail fs copy': { + args: { + 'filter-name': { + positional: true, + type: doveadm_arg_types.STRING, + text: `Configuration filter name to use.` + }, + 'source-path': { + type: doveadm_arg_types.STRING, + text: `Source object path.`, + }, + 'destination-path': { + type: doveadm_arg_types.STRING, + text: `Destination object path.`, + }, + }, + flags: doveadm_flag_types.USER | doveadm_flag_types.USERFILE, + man: 'doveadm-mail-fs', + text: `Copy object in storage.`, + }, + + 'mail fs delete': { + args: { + recursive: { + cli: 'R', + type: doveadm_arg_types.BOOL, + text: `Do recursive delete of path.` + }, + 'max-parallel': { + cli: 'n', + type: doveadm_arg_types.INTEGER, + text: `Max number of parallel workers.`, + }, + 'filter-name': { + positional: true, + type: doveadm_arg_types.STRING, + text: `Configuration filter name to use.` + }, + path: { + positional: true, + type: doveadm_arg_types.STRING, + text: `Object path.`, + }, + }, + flags: doveadm_flag_types.USER | doveadm_flag_types.USERFILE, + man: 'doveadm-mail-fs', + text: `Delete object from storage.`, + }, + + 'mail fs get': { + args: { + 'filter-name': { + positional: true, + type: doveadm_arg_types.STRING, + text: `Configuration filter name to use.` + }, + path: { + positional: true, + type: doveadm_arg_types.STRING, + text: `Object path.`, + }, + }, + flags: doveadm_flag_types.USER | doveadm_flag_types.USERFILE, + man: 'doveadm-mail-fs', + text: `Get object from storage.`, + }, + + 'mail fs iter': { + args: { + 'no-cache': { + cli: 'C', + type: doveadm_arg_types.BOOL + }, + 'object-ids': { + cli: 'O', + type: doveadm_arg_types.BOOL + }, + 'filter-name': { + positional: true, + type: doveadm_arg_types.STRING, + text: `Configuration filter name to use.` + }, + path: { + positional: true, + type: doveadm_arg_types.STRING, + text: `Object path.`, + }, + }, + flags: doveadm_flag_types.USER | doveadm_flag_types.USERFILE, + man: 'doveadm-mail-fs', + text: `List objects in fs path.`, + }, + + 'mail fs iter-dirs': { + args: { + 'filter-name': { + positional: true, + type: doveadm_arg_types.STRING, + text: `Configuration filter name to use.` + }, + path: { + positional: true, + type: doveadm_arg_types.STRING, + text: `Object path.`, + }, + }, + flags: doveadm_flag_types.USER | doveadm_flag_types.USERFILE, + man: 'doveadm-mail-fs', + text: `List folders in fs path.`, + }, + + 'mail fs metadata': { + args: { + 'filter-name': { + positional: true, + type: doveadm_arg_types.STRING, + text: `Configuration filter name to use.` + }, + path: { + positional: true, + type: doveadm_arg_types.STRING, + text: `Object path.`, + }, + }, + flags: doveadm_flag_types.USER | doveadm_flag_types.USERFILE, + man: 'doveadm-mail-fs', + }, + + 'mail fs put': { + args: { + hash: { + cli: 'h', + type: doveadm_arg_types.STRING + }, + metadata: { + cli: 'm', + type: doveadm_arg_types.ARRAY + }, + 'filter-name': { + positional: true, + type: doveadm_arg_types.STRING, + text: `Configuration filter name to use.` + }, + 'input-path': { + positional: true, + type: doveadm_arg_types.STRING, + text: `Object input path.`, + }, + path: { + positional: true, + type: doveadm_arg_types.STRING, + text: `Object path.`, + }, + }, + flags: doveadm_flag_types.USER | doveadm_flag_types.USERFILE, + man: 'doveadm-mail-fs', + text: `Store object in storage.`, + }, + + 'mail fs stat': { + args: { + 'filter-name': { + positional: true, + type: doveadm_arg_types.STRING, + text: `Configuration filter name to use.` + }, + path: { + positional: true, + type: doveadm_arg_types.STRING, + text: `Object path.`, + }, + }, + flags: doveadm_flag_types.USER | doveadm_flag_types.USERFILE, + man: 'doveadm-mail-fs', + text: `Retrieve files status for the path provided. Currently, only the total size (in bytes) of the item is returned.`, + }, + 'mailbox cache decision': { args: { all: { diff --git a/docs/core/man/doveadm.1.md b/docs/core/man/doveadm.1.md index def476250..f89802337 100644 --- a/docs/core/man/doveadm.1.md +++ b/docs/core/man/doveadm.1.md @@ -153,6 +153,11 @@ Dovecot doesn't automatically do that. [[man,doveadm-index]], Index messages in a given mailbox. +### doveadm mail fs + +[[man,doveadm-mail-fs]], Interact with the abstract mail storage filesystem +in a user context. + ### doveadm mailbox [[man,doveadm-mailbox]], Various commands related to handling mailboxes.