doveadm-quota(1)

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

NAME

6       doveadm-quota - Initialize/recalculate or show current quota usage
7

SYNOPSIS

9       doveadm [-Dv] [-f formatter] quota [-S socket_path] command
10       doveadm [-Dv] [-f formatter] quota [-S socket_path] command -A
11       doveadm [-Dv] [-f formatter] quota [-S socket_path] command -u user
12

DESCRIPTION

14       In  the  first  form,  doveadm(1) will execute the command for the cur‐
15       rently logged in user.
16
17       In the second form, the command will be performed for all users.
18
19       In the third form, the command will affect only the matching user(s).
20
21       Note:  The quota get and quota recalc commands are only available  when
22              the global mail_plugins setting contains the quota plugin.
23

OPTIONS

25       Global doveadm(1) options:
26
27       -D     Enables verbosity and debug messages.
28
29       -f formatter
30              Specifies  the  formatter  for formatting the output.  Supported
31              formatters are:
32
33              flow   prints each line with key=value pairs.
34
35              pager  prints each key: value pair on its own line and separates
36                     records with form feed character (^L).
37
38              tab    prints  a  table  header  followed by tab separated value
39                     lines.
40
41              table  prints a table header followed by adjusted value lines.
42
43       -v     Enables verbosity, including progress counter.
44
45       Command specific options:
46
47       -A     If the -A option is present, the command will be  performed  for
48              all  users.   Using this option in combination with system users
49              from userdb { driver = passwd } is not recommended,  because  it
50              contains  also  users  with  a lower UID than the one configured
51              with the first_valid_uid setting.
52
53              When the SQL userdb module is used  make  sure  that  the  iter‐
54              ate_query  setting  in /etc/dovecot/dovecot-sql.conf.ext matches
55              your database layout.  When using the LDAP userdb  module,  make
56              sure  that  the  iterate_attrs  and  iterate_filter  settings in
57              /etc/dovecot/dovecot-ldap.conf.ext match your LDAP schema.  Oth‐
58              erwise doveadm(1) will be unable to iterate over all users.
59
60       -S socket_path
61              The option's argument is either an absolute path to a local UNIX
62              domain socket, or a hostname and port (hostname:port), in  order
63              to connect a remote host via a TCP socket.
64
65              This allows an administrator to execute doveadm(1) mail commands
66              through the given socket.
67
68       -u user/mask
69              Run the command only for the given user.  It's also possible  to
70              use '*' and '?' wildcards (e.g. -u *@example.org).
71              When  neither  the -A option nor -u user was specified, the com‐
72              mand will be executed with  the  environment  of  the  currently
73              logged in user.
74

COMMANDS

76   quota get
77       doveadm [-f formatter] quota get [-A|-u user]
78
79       The quota get command is used to display the current quota usage.
80
81       This command uses by default the output formatter table.
82
83   quota recalc
84       doveadm quota recalc [-A|-u user]
85
86       The  quota  recalc  command  is  used  to recalculate the current quota
87       usage.
88

FILES

90       /etc/dovecot/dovecot.conf
91              Dovecot's main configuration file, including the dict section.
92
93       /etc/dovecot/dovecot-dict-sql.conf.ext
94              SQL dictionary proxy settings.
95
96       /etc/dovecot/conf.d/10-mail.conf
97              Mailbox locations and namespaces, including global mail_location
98
99       /etc/dovecot/conf.d/90-quota.conf
100              Quota configuration.
101

EXAMPLE

103       Get the current quota usage of user jane.
104
105       doveadm quota get -u jane
106       Quota name                        Type    Value  Limit  %
107       user                              STORAGE 90099 102400 87
108       user                              MESSAGE 20548  30000 68
109

REPORTING BUGS

111       Report bugs, including doveconf -n output, to the Dovecot Mailing  List
112       <dovecot@dovecot.org>.   Information  about reporting bugs is available
113       at: http://dovecot.org/bugreport.html
114