doveadm-fs(1) - Interact with the abstract mail storage filesystem

SYNOPSIS

doveadm [GLOBAL OPTIONS] fs command [ARGUMENTS]

DESCRIPTION

The doveadm fs commands are used to abstractly interact with the storage backend defined in the Dovecot configuration. It allows access to the mailbox structure without needing to know details of how the storage backend is designed.

GLOBAL OPTIONS

Global doveadm(1) options:

-D

Enables verbosity and debug messages.

-O

Do not read any config file, just use defaults. The dovecot_storage_version defaults to the latest version, but can be overridden with -o.

-k

Preserve entire environment for doveadm, not just import_environment.

-v

Enables verbosity, including progress counter.

-i instance-name

If using multiple Dovecot instances, choose the config file based on this instance name.

See instance_name for more information.

-c config-file

Read configuration from the given config-file. By default it first reads config socket, and then falls back to /etc/dovecot/dovecot.conf. You can also point this to config socket of some instance running compatible version.

-o setting= value

Overrides the configuration setting from /etc/dovecot/dovecot.conf and from the userdb with the given value. In order to override multiple settings, the -o option may be specified multiple times.

-f formatter

Specifies the formatter for formatting the output. Supported formatters are:

flow

prints each line with key=value pairs.

pager

prints each key: value pair on its own line and separates records with form feed character (^L).

tab

prints a table header followed by tab separated value lines.

table

prints a table header followed by adjusted value lines.

This command uses by default the table output formatter.

If you have multiple fs drivers, you start by having the first driver in fs-driver and the rest of the pipeline as-is in fs-args.

COMMANDS

fs copy

doveadm [GLOBAL OPTIONS] fs copy fs-driver fs-args source-path dest-path

Copy source path to the destination path.

fs delete

doveadm [GLOBAL OPTIONS] fs delete [-R] [-n count] fs-driver fs-args path [path ...]

Delete all data associated with the path provided.

-R

Recursively delete files.

-n count

Maximum number of parallel operations to perform.

fs get

doveadm [GLOBAL OPTIONS] fs get fs-driver fs-args path

Retrieve data associated with the path provided.

fs iter

doveadm [GLOBAL OPTIONS] fs iter fs-driver fs-args path

Iterate through all data files in the path provided.

fs iter-dirs

doveadm [GLOBAL OPTIONS] fs iter-dirs fs-driver fs-args path

Iterate through all directories in the path provided.

fs put

doveadm [GLOBAL OPTIONS] fs put [-h hash] fs-driver fs-args input_path path

Store data at the path provided.

-h hash

Save provided hash as content hash. Must be either MD5 or SHA256 in hexdigits.

-m key=value

Assign a value to a metadata. Can be provided as many times as needed. Requires either metawrap as driver or metadata capable FS-driver.

fs stat

doveadm [GLOBAL OPTIONS] fs stat fs-driver fs-args path

Retrieve files status for the path provided. Currently, only the total size (in bytes) of the item is returned.

REPORTING BUGS

Report bugs, including doveconf -n output, to the Dovecot Mailing List dovecot@dovecot.org. Information about reporting bugs is available at: https://dovecot.org/bugreport.html

SEE ALSO

doveadm(1)