doveadm-user(1)

1DOVEADM-USER(1)                     Dovecot                    DOVEADM-USER(1)
2
3
4

NAME

6       doveadm-user - Perform a user lookup in Dovecot's userdbs
7

SYNOPSIS

9       doveadm [-Dv] user [-a userdb_socket_path] [-x auth_info] user ...
10

DESCRIPTION

12       The user command is used to perform a user lookup - to show what infor‐
13       mation Dovecot sees about the user(s), or if it exists at  all  in  the
14       configured userdb(s).
15
16       The  auth_info may be useful when the userdb is for example a SQL data‐
17       base and you are using %variables, like %s or  %l,  in  the  user_query
18       setting.  Or when you have configured the userdb in a way like this:
19
20       userdb {
21         driver = passwd-file
22         args = /etc/%s.passwd
23       }
24

OPTIONS

26       Global doveadm(1) options:
27
28       -D     Enables verbosity and debug messages.
29
30       -v     Enables verbosity, including progress counter.
31
32       Command specific options:
33
34       -a userdb_socket_path
35              This  option  is used to specify an absolute path to an alterna‐
36              tive UNIX domain socket.
37
38              By  default  doveadm(1)  will  use  the  socket   /var/run/dove‐
39              cot/auth-userdb.   The  socket  may be located in another direc‐
40              tory, when  the  default  base_dir  setting  was  overridden  in
41              /etc/dovecot/dovecot.conf.
42
43       -x auth_info
44              auth_info  specifies additional conditions for the user command.
45              The auth_info option string has to be given as name=value  pair.
46              For multiple conditions the -x option could be supplied multiple
47              times.
48              Possible names for the auth_info are:
49
50              service
51                     The service for which the userdb lookup should be tested.
52                     The  value  may  be  the name of a service, commonly used
53                     with Dovecot.  For example: imap, pop3 or smtp.
54
55              lip    The local IP address (server) for the test.
56
57              rip    The remote IP address (client) for the test.
58
59              lport  The local port, e.g. 143
60
61              rport  The remote port, e.g. 24567
62

ARGUMENTS

64       user   Is a user's login name.  Depending on the configuration, a login
65              name  may  be  for  example jane or john@example.com.  It's also
66              possible to use '*' and '?' wildcards (e.g. -u *@example.org).
67

EXAMPLE

69       Perform a user lookup for the users jane and john@example.com.
70
71       doveadm user jane john@example.com
72       userdb: jane
73         uid       : 8001
74         gid       : 8001
75         home      : /home/jane
76         mail      : sdbox:~/sdbox
77         plugins   : sieve
78         quota_rule: *:storage=150M
79
80       userdb: john@example.com
81         home      : /srv/mail/8/70312/79832
82         uid       : 79832
83         gid       : 70312
84         mail      : mdbox:~/mdbox
85
86       The next example shows a user lookup, using wildcards.
87
88       doveadm user *.?oe@example.net
89       jane.doe@example.net
90       judy.roe@example.net
91       john.doe@example.net
92

REPORTING BUGS

94       Report bugs, including doveconf -n output, to the Dovecot Mailing  List
95       <dovecot@dovecot.org>.   Information  about reporting bugs is available
96       at: http://dovecot.org/bugreport.html
97