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 -F file
12       doveadm [-Dv] [-f formatter] quota [-S socket_path] command -u user
13

DESCRIPTION

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

OPTIONS

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

COMMANDS

92   quota get
93       doveadm [-f formatter] quota get [-A|-u user|-F file]
94
95       The quota get command is used to display the current quota usage.   The
96       storage values are reported in kilobytes.
97
98       This command uses by default the output formatter table.
99
100   quota recalc
101       doveadm quota recalc [-A|-u user|-F file]
102
103       The  quota  recalc  command  is  used  to recalculate the current quota
104       usage.
105

FILES

107       /etc/dovecot/dovecot.conf
108              Dovecot's main configuration file, including the dict section.
109
110       /etc/dovecot/dovecot-dict-sql.conf.ext
111              SQL dictionary proxy settings.
112
113       /etc/dovecot/conf.d/10-mail.conf
114              Mailbox locations and namespaces, including global mail_location
115
116       /etc/dovecot/conf.d/90-quota.conf
117              Quota configuration.
118

EXAMPLE

120       Get the current quota usage of user jane.
121
122       doveadm quota get -u jane
123       Quota name                        Type    Value  Limit  %
124       user                              STORAGE 90099 102400 87
125       user                              MESSAGE 20548  30000 68
126

REPORTING BUGS

128       Report bugs, including doveconf -n output, to the Dovecot Mailing  List
129       <dovecot@dovecot.org>.   Information  about reporting bugs is available
130       at: http://dovecot.org/bugreport.html
131