.TH "DOVEADM-FS" "1" "March 2025" "78ffb79" "Dovecot"
.SH "NAME"
\fBdoveadm-fs\fR - Interact with the abstract mail storage filesystem
.SH "SYNOPSIS"
.P
\fBdoveadm\fR \[lB]\fIGLOBAL OPTIONS\fR\[rB] \fBfs\fR \fIcommand\fR \fIconfig-filter-name\fR \[lB]\fIARGUMENTS\fR\[rB]
.P
\fBdoveadm\fR \[lB]\fIGLOBAL OPTIONS\fR\[rB] \fBmail fs\fR \fIcommand\fR \[lB]\fIOPTIONS\fR\[rB] \fIconfig-filter-name\fR \[lB]\fIARGUMENTS\fR\[rB]
.SH "DESCRIPTION"
.P
The \fBdoveadm fs\fR \fIcommands\fR are used to abstractly interact with the storage driver defined in the Dovecot configuration. It allows access to the mailbox structure without needing to know details of how the storage driver is designed.
.P
\fIconfig-filter-name\fR
.RS 0
.RS 4
.P
Filter name to use when looking up the fs settings. For example \fImail_attachments\fR, \fIobox\fR, \fImetacache\fR, \fIfts/dovecot\fR. It's also possible to use an empty filter name and specify the fs settings using the \fB-o\fR parameter.
.RE 0

.RE 0

.SH "GLOBAL OPTIONS"
.P
Global doveadm(1) 
.P
\fB-D\fR
.RS 0
.RS 4
.P
Enables \fIverbosity\fR and debug messages.
.RE 0

.RE 0

.P
\fB-O\fR
.RS 0
.RS 4
.P
Do not read any config file, just use defaults. The \fBdovecot_storage_version\fR setting defaults to the latest version, but can be overridden with 
.RE 0

.RE 0

.P
\fB-k\fR
.RS 0
.RS 4
.P
Preserve entire environment for doveadm, not just \fBimport_environment\fR setting.
.RE 0

.RE 0

.P
\fB-v\fR
.RS 0
.RS 4
.P
Enables verbosity, including progress counter.
.RE 0

.RE 0

.P
\fB-i\fR \fIinstance-name\fR
.RS 0
.RS 4
.P
If using multiple Dovecot instances, choose the config file based on this instance name.
.P
See \fBinstance_name\fR setting for more information.
.RE 0

.RE 0

.P
\fB-c\fR \fIconfig-file\fR
.RS 0
.RS 4
.P
Read configuration from the given \fIconfig-file\fR. By default it first reads config socket, and then falls back to \fI/etc/dovecot/dovecot.conf\fR. You can also point this to config socket of some instance running compatible version.
.RE 0

.RE 0

.P
\fB-o\fR \fIsetting\fR\fB=\fR\fIvalue\fR
.RS 0
.RS 4
.P
Overrides the configuration \fIsetting\fR from \fI/etc/dovecot/dovecot.conf\fR and from the userdb with the given \fIvalue\fR. In order to override multiple settings, the \fB-o\fR option may be specified multiple times.
.RE 0

.RE 0

.P
\fB-f\fR \fIformatter\fR
.RS 0
.RS 4
.P
Specifies the \fIformatter\fR for formatting the output. Supported formatters are:
.P
\fBflow\fR
.RS 4
.P
prints each line with \fIkey\fR\fB=\fR\fIvalue\fR pairs.
.RE 0

.P
\fBpager\fR
.RS 4
.P
prints each \fIkey\fR: \fIvalue\fR pair on its own line and separates records with form feed character (\fB^L\fR).
.RE 0

.P
\fBtab\fR
.RS 4
.P
prints a table header followed by tab separated value lines.
.RE 0

.P
\fBtable\fR
.RS 4
.P
prints a table header followed by adjusted value lines.
.RE 0

.RE 0

.RE 0

.SH "OPTIONS"
.P
\fB-A\fR
.RS 0
.RS 4
.P
If the \fB-A\fR option is present, the \fIcommand\fR will be performed for all users. Using this option in combination with system users from \fBuserdb { driver = passwd }\fR is not recommended, because it contains also users with a lower UID than the one configured with the \fBfirst_valid_uid\fR setting.
.P
When the SQL userdb module is used, make sure that the \fBuserdb_sql_iterate_query\fR setting setting matches your database layout.
.P
When using the LDAP userdb module, make sure that the \fBuserdb_fields\fR setting and \fBuserdb_ldap_iterate_fields\fR setting settings match your LDAP schema. Otherwise doveadm(1) will be unable to iterate over all users.
.RE 0

.RE 0

.P
\fB-u\fR \fIuser/mask\fR
.RS 0
.RS 4
.P
Run the \fIcommand\fR only for the given \fIuser\fR. It's also possible to use '\fB*\fR' and '\fB?\fR' wildcards (e.g. -u *@example.org).
.RE 0

.RE 0

.P
\fB-F\fR \fIfile\fR
.RS 0
.RS 4
.P
Execute the \fIcommand\fR for all the users in the \fIfile\fR. This is similar to the \fB-A\fR option, but instead of getting the list of users from the userdb, they are read from the given \fIfile\fR. The \fIfile\fR contains one username per line.
.RE 0

.RE 0

.P
\fB-S\fR \fIsocket_path\fR
.RS 0
.RS 4
.P
The option's argument is either an absolute path to a local UNIX domain socket, or a hostname and port (\fIhostname\fR:\fIport\fR), in order to connect a remote host via a TCP socket.
.P
This allows an administrator to execute doveadm(1) mail commands through the given socket.
.RE 0

.RE 0

.SH "COMMANDS"
.SS "copy"
.P
\fBdoveadm\fR \[lB]\fIGLOBAL OPTIONS\fR\[rB] fs copy \fIconfig-filter-name\fR \fIsource-path\fR \fIdest-path\fR
.P
\fBdoveadm\fR \[lB]\fIGLOBAL OPTIONS\fR\[rB] mail fs copy \[lB]\fB-A\fR | \fB-u\fR \fIuser\fR | \fB-F\fR \fIfile\fR\[rB] \[lB]\fB-S\fR \fIsocket_path\fR\[rB] \fIconfig-filter-name\fR \fIsource-path\fR \fIdest-path\fR
.P
Copy source path to the destination path.
.SS "delete"
.P
\fBdoveadm\fR \[lB]\fIGLOBAL OPTIONS\fR\[rB] fs delete \[lB]\fB-R\fR\[rB] \[lB]\fB-n\fR \fIcount\fR\[rB] \fIconfig-filter-name\fR \fIpath\fR \[lB]\fIpath\fR ...\[rB]
.P
\fBdoveadm\fR \[lB]\fIGLOBAL OPTIONS\fR\[rB] mail fs delete \[lB]\fB-A\fR | \fB-u\fR \fIuser\fR | \fB-F\fR \fIfile\fR\[rB] \[lB]\fB-S\fR \fIsocket_path\fR\[rB] \[lB]\fB-R\fR\[rB] \[lB]\fB-n\fR \fIcount\fR\[rB] \fIconfig-filter-name\fR \fIpath\fR \[lB]\fIpath\fR ...\[rB]
.P
Delete all data associated with the path provided.
.P
\fB-R\fR
.RS 0
.RS 4
.P
Recursively delete files.
.RE 0

.RE 0

.P
\fB-n\fR \fIcount\fR
.RS 0
.RS 4
.P
Maximum number of parallel operations to perform.
.RE 0

.RE 0

.SS "get"
.P
\fBdoveadm\fR \[lB]\fIGLOBAL OPTIONS\fR\[rB] fs get \fIconfig-filter-name\fR \fIpath\fR
.P
\fBdoveadm\fR \[lB]\fIGLOBAL OPTIONS\fR\[rB] mail fs get \[lB]\fB-A\fR | \fB-u\fR \fIuser\fR | \fB-F\fR \fIfile\fR\[rB] \[lB]\fB-S\fR \fIsocket_path\fR\[rB] \fIconfig-filter-name\fR \fIpath\fR
.P
Retrieve data associated with the path provided.
.SS "iter"
.P
\fBdoveadm\fR \[lB]\fIGLOBAL OPTIONS\fR\[rB] fs iter \fIconfig-filter-name\fR \fIpath\fR
.P
\fBdoveadm\fR \[lB]\fIGLOBAL OPTIONS\fR\[rB] mail fs iter \[lB]\fB-A\fR | \fB-u\fR \fIuser\fR | \fB-F\fR \fIfile\fR\[rB] \[lB]\fB-S\fR \fIsocket_path\fR\[rB] \fIconfig-filter-name\fR \fIpath\fR
.P
Iterate through all data files in the path provided.
.SS "iter-dirs"
.P
\fBdoveadm\fR \[lB]\fIGLOBAL OPTIONS\fR\[rB] fs iter-dirs \fIconfig-filter-name\fR \fIpath\fR
.P
\fBdoveadm\fR \[lB]\fIGLOBAL OPTIONS\fR\[rB] mail fs iter-dirs \[lB]\fB-A\fR | \fB-u\fR \fIuser\fR | \fB-F\fR \fIfile\fR\[rB] \[lB]\fB-S\fR \fIsocket_path\fR\[rB] \fIconfig-filter-name\fR \fIpath\fR
.P
Iterate through all directories in the path provided.
.SS "put"
.P
\fBdoveadm\fR \[lB]\fIGLOBAL OPTIONS\fR\[rB] fs put \[lB]\fB-h\fR \fIhash\fR\[rB] \[lB]\fB-m\fR \fIkey\fR=\fIvalue\fR\[rB] \fIconfig-filter-name\fR \fIinput_path\fR \fIpath\fR
.P
\fBdoveadm\fR \[lB]\fIGLOBAL OPTIONS\fR\[rB] mail fs put \[lB]\fB-A\fR | \fB-u\fR \fIuser\fR | \fB-F\fR \fIfile\fR\[rB] \[lB]\fB-S\fR \fIsocket_path\fR\[rB] \[lB]\fB-h\fR \fIhash\fR\[rB] \[lB]\fB-m\fR \fIkey\fR=\fIvalue\fR\[rB] \fIconfig-filter-name\fR \fIpath\fR
.P
Store data at the path provided.
.P
\fB-h\fR \fIhash\fR
.RS 0
.RS 4
.P
Save provided hash as content hash. Must be either MD5 or SHA256 in hexdigits.
.RE 0

.RE 0

.P
\fB-m\fR \fIkey=value\fR
.RS 0
.RS 4
.P
Assign a value to a metadata. Can be provided as many times as needed. Requires either metawrap as driver or metadata capable FS-driver.
.RE 0

.RE 0

.SS "stat"
.P
\fBdoveadm\fR \[lB]\fIGLOBAL OPTIONS\fR\[rB] fs stat \fIconfig-filter-name\fR \fIpath\fR
.P
\fBdoveadm\fR \[lB]\fIGLOBAL OPTIONS\fR\[rB] mail fs stat \[lB]\fB-A\fR | \fB-u\fR \fIuser\fR | \fB-F\fR \fIfile\fR\[rB] \[lB]\fB-S\fR \fIsocket_path\fR\[rB] \fIconfig-filter-name\fR \fIpath\fR
.P
Retrieve files status for the path provided. Currently, only the total size (in bytes) of the item is returned.
.SH "REPORTING BUGS"
.P
Report bugs, including \fIdoveconf -n\fR output, to the Dovecot Mailing List \fI\(ladovecot@dovecot.org\(ra\fR. Information about reporting bugs is available at: https://dovecot.org/bugreport.html
.P
SEE ALSO
.P
doveadm(1)