DOVEADM-FS(1)                       Dovecot                      DOVEADM-FS(1)

<?><?><?> (NAME)
       doveadm-fs - <?><?><?><?><?> <?><?> <?><?><?><?><?><?><?><?><?><?>
       <?><?><?><?><?><?><?> <?><?><?><?><?><?><?><?><?><?> <?><?><?><?><?>

<?><?><?><?><?> <?><?><?><?><?> (SYNOPSIS)
       doveadm [GLOBAL OPTIONS] fs command config-filter-name [ARGUMENTS]

       doveadm [GLOBAL OPTIONS] mail fs command [OPTIONS] config-filter-name
       [ARGUMENTS]

<?><?><?><?><?><?><?> (DESCRIPTION)
       <?><?><?><?><?><?><?><?> doveadm fs <?><?><?><?> <?><?><?><?><?>
       <?><?><?><?><?><?><?> <?><?> <?><?><?><?><?><?>
       <?><?><?><?><?><?><?><?><?><?><?> <?><?><?><?><?><?><?><?><?> <?><?>
       <?><?><?><?><?><?><?><?> Dovecot <?><?><?><?><?><?><?>
       <?><?><?><?><?><?><?>. <?><?><?> <?><?><?><?><?><?><?> <?><?><?><?><?>
       <?><?><?><?><?><?> <?><?> <?><?><?><?><?><?> <?><?><?><?><?>
       <?><?><?><?> <?><?> <?><?><?><?> <?><?><?><?> <?><?> <?><?><?><?><?><?>
       <?><?><?><?><?><?> <?><?><?><?> <?><?><?><?><?> <?><?><?><?><?><?>
       <?><?><?><?><?><?><?><?><?><?> <?><?><?><?><?> <?><?><?><?><?><?><?>.

       config-filter-name

           <?><?><?> <?><?><?><?><?><?> <?><?> <?><?><?><?><?>
           <?><?><?><?><?><?> <?><?><?><?><?><?><?> fs <?><?><?><?><?><?><?>
           <?><?><?><?><?><?>. <?><?><?><?> <?><?><?><?><?>
           mail_attachments<?> obox<?> metacache<?> fts/dovecot.
           <?><?><?><?><?><?> <?><?><?><?><?> <?><?><?><?><?><?><?> <?><?>
           <?><?> <?><?><?> <?><?><?><?><?> <?><?><?><?> <?> <?><?><?><?><?>
           <?><?><?><?><?><?><?> fs <?><?> <?><?><?><?><?><?><?> <?><?>
           <?><?><?><?><?><?><?> -o <?><?><?><?> <?><?><?><?>.



<?><?><?><?><?><?><?><?><?> <?><?><?><?><?> (GLOBAL OPTIONS)
       <?><?><?><?><?><?><?><?><?> <?><?><?><?><?> doveadm(1):

       -D

           <?><?><?><?> <?><?><?><?><?><?> (verbosity) <?>
           <?><?><?><?><?><?><?><?> <?><?><?><?><?><?><?><?><?><?><?> <?><?>
           <?><?><?><?> <?><?><?><?><?><?>.



       -O

           <?><?><?> <?><?><?><?> <?><?><?><?><?><?><?><?><?><?><?> <?><?>
           <?><?><?><?><?><?><?><?><?><?> <?><?><?><?> <?><?>
           <?><?><?><?><?><?> <?><?><?><?><?><?><?> <?><?><?><?><?><?><?>
           <?><?><?><?><?><?>. <?><?><?><?><?> dovecot_storage_version
           <?><?><?><?><?><?> <?><?><?><?><?><?><?> <?><?> <?><?><?><?><?>
           <?><?><?><?> <?><?><?><?><?> <?><?><?><?><?><?><?> <?><?><?>
           <?><?><?><?><?><?><?> <?><?> <?><?> <?><?> -o
           <?><?><?><?><?><?><?><?> <?><?><?>.



       -k

           <?><?><?><?> <?><?><?><?><?><?><?><?> <?><?><?><?><?> <?><?>
           <?><?><?><?> doveadm <?><?><?> <?><?><?><?><?><?><?> <?><?>
           <?><?><?> <?><?><?><?><?> <?><?><?><?><?><?><?><?><?> <?><?>
           <?><?><?><?><?> import_environment <?><?>.



       -v

           <?><?><?><?><?><?> <?><?> <?><?><?><?> <?><?><?><?><?><?><?> <?><?>
           <?><?><?><?> <?><?><?><?><?> <?><?><?><?><?><?><?>
           <?><?><?><?><?><?>.



       -i instance-name

           <?><?> <?><?><?><?> <?><?><?><?><?><?><?> <?><?> <?><?><?>
           <?><?><?><?><?><?><?> Dovecot<?> <?><?><?><?>
           <?><?><?><?><?><?><?><?> <?><?> <?><?> <?><?><?><?> <?><?><?>
           <?><?><?> <?><?><?><?><?> <?><?><?><?><?><?> <?><?><?><?><?><?>.

           <?><?><?><?> <?><?><?><?><?><?><?> <?><?><?><?><?><?>
           <?><?><?><?><?> instance_name <?><?> <?><?><?><?><?><?>.



       -c config-file

           <?><?><?><?><?><?><?><?> <?><?> <?><?> config-file
           <?><?><?><?><?><?><?><?> <?><?><?><?><?><?><?><?>.
           <?><?><?><?><?><?> <?><?><?><?><?><?><?> <?><?><?><?><?>
           <?><?><?><?> <?><?><?><?><?><?><?><?> <?><?>
           <?><?><?><?><?><?><?><?> <?> <?><?> <?><?><?><?> <?><?><?>
           <?><?><?><?><?><?> <?><?> /etc/dovecot/dovecot.conf
           <?><?><?><?><?><?><?><?><?><?>. <?><?><?><?><?><?>
           <?><?><?><?><?><?><?><?><?> <?><?> <?><?> <?><?> <?><?><?><?>
           <?><?><?><?><?><?><?><?> <?><?><?><?><?><?><?><?> <?><?>
           <?><?><?><?><?><?><?> <?><?><?><?><?><?> <?><?> <?><?><?><?>
           <?><?><?><?><?><?> <?><?><?><?><?> <?><?><?><?>.



       -o setting=value

           <?><?><?><?><?> <?><?><?><?><?><?><?><?> (setting) <?><?> <?><?>
           /etc/dovecot/dovecot.conf <?> <?><?> userdb <?><?> <?><?><?><?><?>
           (value) <?><?><?><?><?><?><?><?> <?><?><?><?><?><?><?><?>
           <?><?><?><?><?><?>. <?><?><?><?> <?><?><?><?><?><?><?><?>
           <?><?><?><?><?> <?><?><?><?><?><?> <?><?><?><?><?><?><?>
           <?><?><?><?><?> -o <?><?> <?><?><?><?><?> <?><?><?> <?><?><?><?>
           <?><?><?>.



       -f formatter

           <?><?><?><?><?><?><?><?> (formatter) <?><?> <?><?><?><?>
           <?><?><?><?><?><?><?><?><?> <?><?><?><?><?> <?><?><?><?>
           <?><?><?><?><?><?>. <?><?><?><?><?><?><?><?><?><?><?>
           <?><?><?><?><?><?><?><?><?><?><?><?> <?><?><?><?><?><?><?> <?><?>:

           flow

               <?><?> <?><?> <?><?> <?><?> <?><?><?><?><?><?><?> key=value
               <?><?><?> <?><?><?><?><?><?>.


       json

           <?><?> <?><?><?><?><?> JSON <?><?> <?><?><?><?><?> JSON <?><?>
           <?><?><?> <?><?><?><?><?><?>.


       pager

           <?><?> <?><?><?> key: value <?><?> <?><?> <?><?>
           <?><?><?><?><?><?><?><?><?><?> <?><?><?> <?><?><?><?><?><?> <?>
           <?><?><?><?><?><?><?> <?><?> <?><?> <?><?><?><?><?> <?><?><?><?><?>
           <?><?><?><?> (^L) <?><?> <?><?> <?><?><?> <?><?><?><?><?><?><?>.


       tab

           <?><?> <?><?><?><?><?> <?><?><?><?> <?><?><?> <?><?><?><?><?><?>
           <?><?> <?><?><?><?> <?><?><?><?><?><?> <?><?><?><?><?><?> <?><?>
           <?><?> (tab-separated) <?><?> <?><?><?><?><?> <?><?>
           <?><?><?><?><?><?><?>.


       table

           <?><?> <?><?><?><?><?> <?><?><?><?> <?><?><?> <?><?><?><?><?><?>
           <?><?> <?><?><?><?> <?><?><?><?><?><?> <?><?><?><?> <?><?><?>
           <?><?> <?><?><?><?><?> <?><?> <?><?><?><?><?><?><?>.




<?><?><?><?><?><?><?><?> (OPTIONS)
       -A

           <?><?><?> <?><?><?><?><?> -A <?><?><?><?> <?><?><?><?>
           <?><?><?><?><?> (command) <?><?><?><?> <?><?><?>
           <?><?><?><?><?><?><?> <?><?><?><?> <?><?><?><?><?> <?><?>.
           <?><?><?><?><?><?><?> <?><?> <?><?><?> <?><?><?><?><?>
           <?><?><?><?><?> <?><?> <?><?><?><?><?><?><?> <?><?><?><?><?><?>
           <?><?> userdb { driver = passwd } <?><?><?><?><?>
           <?><?><?><?><?><?><?><?> <?><?><?><?> <?><?> <?><?> <?><?><?><?>
           <?><?><?><?><?><?><?><?> <?><?> UID <?><?><?><?> <?><?>
           <?><?><?><?><?> <?><?><?><?><?><?><?><?><?><?><?><?> <?><?>
           <?><?><?><?><?> first_valid_uid <?><?><?>.

           <?><?><?><?><?> <?><?><?><?><?><?><?> <?><?> <?><?><?><?><?> userdb
           <?><?><?><?><?> <?><?> SQL<?> <?><?><?><?><?><?><?> <?><?><?><?>
           <?><?><?><?> <?><?> <?><?><?><?><?> userdb_sql_iterate_query <?><?>
           <?><?><?><?><?><?> <?><?><?><?><?><?> <?><?><?><?> <?><?><?>
           <?><?><?><?><?><?> <?><?><?><?><?> <?><?><?><?>.

           <?><?><?><?><?> <?><?><?><?><?><?><?> <?><?> <?><?><?><?><?> userdb
           <?><?><?><?><?> <?><?> LDAP<?> <?><?><?><?><?><?><?> <?><?><?><?>
           <?><?><?><?> <?><?> <?><?><?><?><?><?><?> userdb_fields <?>
           userdb_ldap_iterate_fields <?><?> <?><?><?><?><?><?><?> (schema)
           LDAP <?><?><?> <?><?><?><?><?><?><?> <?><?><?><?><?>
           <?><?><?><?><?>. <?><?> <?><?><?> <?><?><?> <?><?><?><?> doveadm(1)
           <?><?><?><?> <?><?> <?><?><?><?><?><?> <?><?><?> <?><?><?>
           <?><?><?><?><?><?><?> <?><?><?><?><?><?> <?><?><?>.



       -u user/mask

           <?><?><?><?><?> <?><?><?><?><?> (command) <?><?><?><?> <?><?><?><?>
           <?><?><?><?><?> (user) <?><?><?><?><?><?><?><?>. <?><?><?><?><?><?>
           <?><?><?><?><?> <?><?><?><?><?><?><?> <?><?>
           <?><?><?><?><?><?><?><?><?> <?><?><?><?><?> '*' <?> '?'
           <?><?><?><?> <?><?><?><?> (<?><?><?><?><?> <?>-u *@example.org).



       -F file

           <?><?><?><?><?> <?><?><?><?><?> (command) <?><?><?><?> <?><?><?><?>
           <?><?><?><?><?><?><?> <?><?><?><?><?> <?><?> file. <?><?><?>
           <?><?><?><?><?> <?><?><?><?><?> <?><?><?><?><?> -A <?><?><?><?>
           <?><?><?> <?><?> <?><?><?> <?><?><?><?><?><?> <?><?><?><?><?>
           <?><?><?><?><?><?><?> <?><?> userdb<?> <?><?><?><?> <?><?> file
           <?><?><?><?><?><?><?><?> <?><?><?><?><?><?> <?><?><?><?><?><?><?>.
           <?><?><?> file <?><?> <?><?> <?><?> <?><?><?><?> <?><?> <?><?><?>
           <?><?><?><?><?><?> <?><?><?>.



       -S socket_path

           <?><?><?><?><?><?><?> <?><?><?> <?><?><?><?><?> <?><?> <?><?>
           <?><?><?><?> <?><?><?><?> <?><?> <?><?> <?><?><?><?> <?><?><?><?>
           <?><?><?><?><?> <?><?><?><?><?><?> (UNIX domain socket)
           <?><?><?><?> <?><?> <?><?> <?><?><?> <?><?><?><?><?><?> <?>
           <?><?><?><?><?> (hostname:port) <?><?><?><?> <?><?><?><?><?> <?><?>
           <?><?> <?><?><?><?><?><?> <?><?><?> <?><?><?> <?><?> <?><?><?><?>
           <?><?><?><?> TCP.

           <?><?><?> <?><?><?><?><?> <?><?> <?><?><?><?> <?><?><?><?><?>
           <?><?><?><?><?> <?><?><?><?><?><?> <?><?><?><?><?><?><?><?>
           <?><?><?><?><?> doveadm(1) <?><?> <?><?> <?><?><?><?> <?><?><?><?>
           <?><?><?><?><?><?><?><?> <?><?><?><?> <?><?><?>.



<?><?><?><?><?><?><?> (COMMANDS)
   copy
       doveadm [GLOBAL OPTIONS] fs copy config-filter-name source-path dest-
       path

       doveadm [GLOBAL OPTIONS] mail fs copy [-A | -u user | -F file] [-S
       socket_path] config-filter-name source-path dest-path

       <?><?><?> <?><?><?><?> <?><?><?><?> <?><?><?><?> <?><?> <?><?><?><?>
       <?><?><?><?>.

   delete
       doveadm [GLOBAL OPTIONS] fs delete [-R] [-n count] config-filter-name
       path [path ...]

       doveadm [GLOBAL OPTIONS] mail fs delete [-A | -u user | -F file] [-S
       socket_path] [-R] [-n count] config-filter-name path [path ...]

       <?><?><?> <?><?><?><?> <?><?><?><?><?><?><?><?> <?><?><?><?><?> <?><?>
       <?><?><?><?> <?><?><?><?><?><?><?><?><?>.

       -R

           <?><?><?> <?><?><?><?><?><?><?> <?><?><?><?><?><?><?>.



       -n count

           <?><?><?><?><?><?> <?><?><?><?><?> <?><?><?><?><?><?>
           <?><?><?><?><?> <?><?><?><?> <?><?><?><?>.



   get
       doveadm [GLOBAL OPTIONS] fs get config-filter-name path

       doveadm [GLOBAL OPTIONS] mail fs get [-A | -u user | -F file] [-S
       socket_path] config-filter-name path

       <?><?><?><?><?><?><?> <?><?><?><?><?><?><?><?> <?><?><?><?><?> <?><?>
       <?><?><?><?> <?><?><?><?><?><?><?><?><?>.

   iter
       doveadm [GLOBAL OPTIONS] fs iter config-filter-name path

       doveadm [GLOBAL OPTIONS] mail fs iter [-A | -u user | -F file] [-S
       socket_path] config-filter-name path

       <?><?><?><?><?><?> <?><?><?><?> <?><?><?><?><?><?><?><?> <?><?><?><?>
       <?><?> <?><?><?><?> <?><?><?><?><?><?><?><?><?>.

   iter-dirs
       doveadm [GLOBAL OPTIONS] fs iter-dirs config-filter-name path

       doveadm [GLOBAL OPTIONS] mail fs iter-dirs [-A | -u user | -F file] [-S
       socket_path] config-filter-name path

       <?><?><?><?><?><?> <?><?><?><?> <?><?><?><?><?><?><?><?><?><?><?><?>
       <?><?> <?><?><?><?> <?><?><?><?><?><?><?><?><?>.

   put
       doveadm [GLOBAL OPTIONS] fs put [-h hash] [-m key=value] config-filter-
       name input_path path

       doveadm [GLOBAL OPTIONS] mail fs put [-A | -u user | -F file] [-S
       socket_path] [-h hash] [-m key=value] config-filter-name path

       <?><?><?><?><?> <?><?><?><?><?><?><?> <?><?> <?><?><?><?>
       <?><?><?><?><?><?><?><?><?>.

       -h hash

           <?><?> <?><?><?><?><?><?><?><?><?> <?><?> <?><?> <?><?><?><?><?>
           <?><?> <?><?><?><?><?> <?><?><?><?><?> <?><?><?><?><?><?>.
           <?><?><?><?> <?><?><?><?><?><?><?> <?><?><?><?><?>
           <?><?><?><?><?><?><?><?><?><?> MD5 <?><?> SHA256 <?><?><?><?>.



       -m key=value

           <?><?><?><?><?><?> <?><?><?><?> <?><?> <?><?><?><?><?> <?><?>
           <?><?> <?><?><?><?><?><?><?>. <?><?><?><?><?><?><?><?> <?><?>
           <?><?> <?><?><?><?><?> <?><?><?> <?><?> <?><?><?><?> <?><?><?>
           <?><?><?><?> <?><?><?>. <?><?><?><?><?><?><?> <?><?><?><?><?><?>
           metawrap <?><?> <?><?> <?><?><?><?><?><?> FS <?><?>
           <?><?><?><?><?><?> <?><?><?><?><?><?><?><?> <?><?>
           <?><?><?><?><?><?><?> <?><?><?>.



   stat
       doveadm [GLOBAL OPTIONS] fs stat config-filter-name path

       doveadm [GLOBAL OPTIONS] mail fs stat [-A | -u user | -F file] [-S
       socket_path] config-filter-name path

       <?><?><?><?><?><?> <?><?><?><?><?> <?><?><?><?><?><?><?> <?><?><?><?>
       <?><?><?><?> <?><?><?><?><?><?><?><?><?>. <?><?> <?><?><?>
       <?><?><?><?><?> <?><?><?><?> <?><?><?><?><?><?> <?><?> (<?><?>
       <?><?><?><?>) <?><?><?><?> <?><?><?><?><?><?><?><?><?><?>
       <?><?><?><?><?><?>.

<?><?><?><?><?> <?><?><?><?><?><?> (REPORTING BUGS)
       <?><?><?><?><?> <?><?><?><?><?><?><?> <?><?><?><?> <?><?><?><?><?>
       doveconf -n <?><?> <?><?> <?><?><?><?><?> <?><?><?><?> Dovecot <?><?>
       <?><?><?><?><?> <dovecot@dovecot.org> <?><?><?><?><?> <?><?><?><?>.
       <?><?><?><?><?><?><?> <?><?><?><?><?><?> <?><?><?><?><?>
       <?><?><?><?><?><?> <?><?> <?><?><?> <?><?><?><?><?> <?><?>
       <?><?><?><?><?> <?><?><?>: <https://dovecot.org/bugreport.html>

<?><?><?><?><?><?><?> (EXAMPLES)
       <?><?><?><?> <?><?><?><?> <?><?><?><?> <?><?> <?><?><?><?> <?><?>
       <?><?><?><?> <?><?><?><?><?>.

         doveadm -o fs=compress,posix -o fs/compress/fs_driver=compress -o fs/posix/fs_driver=posix -o fs_posix_prefix=/tmp/ fs get "" test.gz

       <?><?><?><?><?><?><?> <?><?> <?><?> <?><?><?><?><?>
       <?><?><?><?><?><?><?><?><?><?><?><?><?>.

         doveadm mail fs -u testuser get obox path/to/file

<?><?><?><?><?><?> <?><?><?><?><?><?> (SEE ALSO)
       doveadm(1)

e5ac02a                            May 2026                      DOVEADM-FS(1)