DOVEADM-USER(1)                     Dovecot                    DOVEADM-USER(1)

<?><?><?> (NAME)
       doveadm-user - <?><?><?><?><?><?> <?><?><?><?><?> <?><?>
       <?><?><?><?><?><?><?><?><?><?> <?><?><?><?> <?><?><?><?><?> (userdb)
       <?><?><?><?><?>

<?><?><?><?><?> <?><?><?><?><?> (SYNOPSIS)
       doveadm [<?><?><?><?><?><?><?><?><?> <?><?><?><?><?><?>] user [-a
       userdb_socket_path] [-e <?><?><?><?>] [-f <?><?><?><?>] [-u] [-x
       <?><?><?><?><?><?><?>_<?><?><?><?><?>_<?><?><?><?>] <?><?><?><?><?>...

<?><?><?><?><?><?><?> (DESCRIPTION)
       <?><?><?><?><?> user <?><?><?><?> <?><?><?><?><?> <?><?><?><?><?><?>
       <?><?><?><?><?> <?><?> <?><?><?> <?><?><?><?><?><?><?> <?><?>
       <?><?><?><?> <?><?><?> <?><?><?><?><?> <?><?> <?><?><?><?><?><?><?><?>
       <?><?><?><?><?><?><?> <?><?><?><?><?>(<?><?>) <?><?><?><?><?><?><?><?>
       <?><?> <?><?><?><?><?> <?><?><?><?><?> <?><?> userdb(<?><?><?>)
       <?><?><?><?><?><?><?><?><?><?><?><?> <?><?><?><?> <?><?><?><?> <?><?>
       <?><?><?>.

       <?><?><?><?><?> auth_info <?><?><?><?> <?><?><?> <?><?><?><?><?>
       <?><?><?><?> <?><?><?><?> <?><?> userdb <?><?> <?><?><?><?><?>
       <?><?><?><?> <?><?> <?><?><?><?><?><?> <?><?><?><?> SQL <?><?><?> <?>
       <?><?><?> <?><?> <?><?><?><?><?><?><?><?> %<?><?><?><?><?> %{protocol}
       <?><?> %{local_ip} <?><?> <?><?><?><?><?> userdb_sql_query
       <?><?><?><?><?><?><?> <?><?><?><?><?><?><?>. <?><?> <?><?><?><?><?>
       <?><?> userdb <?><?> <?><?> <?><?><?><?> <?><?><?><?><?> <?><?><?>
       <?><?><?><?><?><?><?><?> <?><?><?><?><?><?><?><?>:

         userdb passwd-file {
           passwd_file_path = /etc/%{protocol}.passwd
         }

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

       -D

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



       -O

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



       -k

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



       -v

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



       -i instance-name

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

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



       -c config-file

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



       -o setting=value

           <?><?><?><?><?> <?><?><?><?><?><?><?><?> <?><?> <?><?>
           /etc/dovecot/dovecot.conf <?> <?><?> userdb <?><?> <?><?><?><?><?>
           <?><?><?><?><?><?><?><?> <?><?><?><?><?><?><?><?>
           <?><?><?><?><?><?>. <?><?><?><?> <?><?><?><?><?><?><?><?>
           <?><?><?><?><?> <?><?><?><?><?><?> <?><?><?><?><?><?> -o
           <?><?><?><?><?><?><?><?> <?><?><?><?><?> <?><?><?> <?><?><?><?>
           <?><?><?>.



<?><?><?><?><?><?><?><?> (OPTIONS)
       -a userdb_socket_path

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

           <?><?><?><?><?><?> <?><?><?><?><?><?><?> doveadm(1) <?><?>
           <?><?><?><?> /rundir/auth-userdb <?><?><?><?><?><?><?>
           <?><?><?><?><?> <?><?><?>. <?><?><?> <?><?><?><?><?>
           <?><?><?><?><?><?><?> base_dir <?><?> /etc/dovecot/dovecot.conf
           <?><?><?><?><?><?><?><?> <?><?><?> <?><?><?><?><?> <?><?><?><?>
           <?><?><?> <?><?><?><?> <?><?> <?><?><?><?><?><?><?><?><?>
           <?><?><?><?><?> <?><?><?><?> <?><?><?><?><?> <?><?><?><?>.



       -e template

           <?><?><?><?><?><?> <?><?> <?><?><?> <?><?><?><?><?> <?> <?><?>
           <?><?><?><?> <?><?> <?><?><?><?><?><?><?><?> %<?><?><?><?>
           <?><?><?><?> doveadm(1) <?><?><?><?><?> <?><?><?><?><?><?><?><?><?>
           <?><?> <?><?><?><?> <?><?><?><?><?> <?><?><?><?>
           <?><?><?><?><?><?>. <?><?><?> <?><?><?><?><?> <?><?>
           <?><?><?><?><?><?><?><?> <?><?><?><?><?> <?><?>
           <?><?><?><?><?><?><?><?><?> -f <?><?> -u <?><?><?><?><?><?><?>
           <?><?><?>.



       -f field

           <?><?><?><?><?><?> <?><?> <?><?><?> <?><?><?><?><?> <?> <?><?><?>
           <?><?> <?><?><?><?> userdb <?><?><?><?> <?><?><?><?> doveadm(1)
           <?><?><?><?> <?><?><?><?><?> <?><?><?><?> <?><?><?><?><?><?><?><?>
           <?><?> <?><?><?><?> <?><?><?><?><?><?>. <?><?><?> <?><?><?><?><?>
           <?><?> <?><?><?><?><?><?><?><?> <?><?><?><?><?> <?><?>
           <?><?><?><?><?><?><?><?><?> -e <?><?> -u <?><?><?><?><?><?><?>
           <?><?><?>.



       -u

           <?><?><?><?><?><?> <?><?> <?><?><?> <?><?><?><?><?> <?><?><?><?>
           <?><?><?><?> doveadm(1) <?><?><?> <?><?><?><?><?><?>
           <?><?><?><?><?> <?><?> userdb <?><?> <?><?><?><?> <?><?><?><?><?>
           <?><?><?>. <?><?><?><?> <?><?><?><?><?><?><?> -u<?> <?><?><?>
           <?><?> <?><?> <?><?> <?><?><?><?><?><?><?> uid<?> gid<?> home
           <?><?> mail_path <?><?><?><?><?> <?><?><?><?><?><?><?>
           <?><?><?><?><?><?> <?><?><?><?><?><?><?> <?><?><?><?><?> <?><?>
           <?><?><?><?> <?><?><?><?><?><?><?><?> <?><?><?><?><?>
           <?><?><?><?><?><?>. <?><?><?> <?><?><?><?><?> <?><?>
           <?><?><?><?><?><?><?><?> <?><?><?><?><?> <?><?>
           <?><?><?><?><?><?><?><?><?> -e <?><?> -f <?><?><?><?><?><?><?>
           <?><?><?>.



       -x auth_info

           <?><?><?><?><?> auth_info <?><?><?><?><?> <?><?><?><?><?> <?><?>
           <?><?><?><?> <?><?><?><?><?> user <?><?><?><?> <?><?><?><?><?><?>.
           <?><?><?><?> <?><?><?><?><?><?> auth_info <?><?><?><?> <?><?>
           <?><?><?><?> <?><?><?> name = value <?><?><?><?> <?><?><?>.
           <?><?><?><?> <?><?><?><?><?> <?><?><?><?> <?><?><?><?><?><?> -x
           <?><?><?><?><?><?><?><?> <?><?><?><?><?> <?><?><?> <?><?><?><?><?>
           <?><?><?>.

           <?><?><?><?><?><?><?> <?><?><?><?> <?><?><?><?> auth_info
           <?><?><?><?><?><?><?> <?><?>:

           service

               <?><?><?><?><?><?> <?><?> <?><?><?><?><?><?> userdb
               <?><?><?><?> <?><?><?><?> <?><?> <?><?><?><?><?><?> <?><?><?>.
               <?><?><?><?><?> <?><?><?><?><?><?><?><?> <?><?><?>
               <?><?><?><?><?><?> <?><?><?><?> <?><?> <?><?><?><?><?><?><?>
               <?><?> <?><?><?><?><?> <?><?><?><?><?><?><?>
               <?><?><?><?><?><?><?> <?><?> <?><?><?><?><?> <?><?><?><?>:
               imap<?> pop3 <?><?> smtp.


       session

           <?><?><?><?><?><?> <?><?><?><?> (Session identifier).


       lip

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


       rip

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


       lport

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


       rport

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


       real_lip

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


       real_rip

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


       real_lport

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


       real_rport

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


       forward_<field>

           <?><?><?><?><?> <?><?> <?><?><?><?> <?><?> <?><?><?><?>
           %{forward:field} <?><?> <?><?><?><?><?><?> <?><?><?><?><?>
           <?><?><?><?> <?><?><?><?><?><?><?> <?><?><?>.




<?><?><?><?><?><?><?><?><?><?> (ARGUMENTS)
       user

           <?><?><?> <?><?><?><?> <?><?> <?><?><?><?><?> <?><?>
           <?><?><?><?><?> <?><?><?>. <?><?><?><?> <?><?>
           <?><?><?><?><?><?><?><?><?> <?><?><?> <?><?><?><?> <?><?><?><?>
           <?><?><?> <?><?><?><?><?> jane <?><?> <john@example.com>
           <?><?><?><?>. <?><?><?><?><?><?> <?><?><?><?><?>
           <?><?><?><?><?><?><?> <?><?> <?><?><?><?><?><?><?><?><?><?>
           <?><?><?><?><?> <<*>> <?> <<?>> <?><?><?><?> <?><?><?><?>
           (<?><?><?><?><?> -u \*@example.org).



<?><?><?><?><?><?><?> (EXAMPLES)
       <?><?><?><?><?> <?><?><?><?><?><?> <?><?><?><?><?> <?><?><?><?>
       <?><?><?><?><?><?><?> jane <?> <john@example.com>:

         doveadm user jane john@example.com

         userdb: jane
           uid       : 8001
           gid       : 8001
           home      : /home/jane
           mail_path : ~/sdbox
           plugins   : sieve
           quota_storage_size: 150M

         userdb: john@example.com
           home      : /srv/mail/8/70312/79832
           uid       : 79832
           gid       : 70312
           mail_path : ~/mdbox

       <?><?><?><?><?><?> <?><?><?><?><?> <?><?> <?><?><?><?><?><?><?> <?><?>
       <?><?><?><?><?><?><?><?><?><?> <?><?><?><?><?> (Wildcards):

         doveadm user \*.?oe@example.net

         jane.doe@example.net
         judy.roe@example.net
         john.doe@example.net

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

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

e5ac02a                            May 2026                    DOVEADM-USER(1)