| 1 |
.. cyrusman:: quota(8) |
| 2 |
|
| 3 |
.. author: Jeroen van Meeuwen (Kolab Systems) |
| 4 |
.. author: Nic Bernstein (Onlight) |
| 5 |
|
| 6 |
.. _imap-reference-manpages-systemcommands-quota: |
| 7 |
|
| 8 |
========= |
| 9 |
**quota** |
| 10 |
========= |
| 11 |
|
| 12 |
Report and optionally fix storage and message quota usage. |
| 13 |
|
| 14 |
Synopsis |
| 15 |
======== |
| 16 |
|
| 17 |
.. parsed-literal:: |
| 18 |
|
| 19 |
**quota** [ **-C** *config-file* ] [ **-d** *domain* ] [ **-f** ] [ **-u** ] [ *mailbox-spec*... ] |
| 20 |
|
| 21 |
Description |
| 22 |
=========== |
| 23 |
|
| 24 |
**quota** generates a report listing quota roots, giving their limits and |
| 25 |
usage. |
| 26 |
|
| 27 |
If the **-f** option is specified, **quota** first fixes any |
| 28 |
inconsistencies in the quota subsystem, such as mailboxes with the wrong |
| 29 |
quota root or quota roots with the wrong quota usage reported. |
| 30 |
|
| 31 |
If an optional *domain* is specified with the **-d** option, the quota |
| 32 |
listing (and any inconsistency fixing) is performed only in that domain |
| 33 |
rather than all mailboxes. |
| 34 |
|
| 35 |
If one or more *mailbox-spec* arguments are specified, these are interpreted |
| 36 |
as mailbox prefixes, and the quota listing (and inconsistency fixing) is |
| 37 |
limited to quota roots with names that start with one of the given prefixes. |
| 38 |
If the **-u** is provided, *mailbox-spec* arguments are instead interpreted |
| 39 |
as userids, and the quota listing (and inconsistency fixing) is limited to |
| 40 |
quota roots for only the specified users. |
| 41 |
|
| 42 |
.. WARNING:: |
| 43 |
|
| 44 |
Running **quota** with both the **-f** option and *mailbox-spec* |
| 45 |
arguments is not recommended. |
| 46 |
|
| 47 |
**quota** |default-conf-text| |
| 48 |
|
| 49 |
Options |
| 50 |
======= |
| 51 |
|
| 52 |
.. program:: quota |
| 53 |
|
| 54 |
.. option:: -C config-file |
| 55 |
|
| 56 |
|cli-dash-c-text| |
| 57 |
|
| 58 |
.. option:: -d domain, --domain domain |
| 59 |
|
| 60 |
List and/or fix quota only in *domain*. |
| 61 |
|
| 62 |
.. option:: -f, --fix |
| 63 |
|
| 64 |
Detect and fix any inconsistencies in the quota subsystem before generating |
| 65 |
a report. |
| 66 |
|
| 67 |
.. option:: -n, --report-only |
| 68 |
|
| 69 |
Check for any inconsistencies in the quota subsystem but don't actually |
| 70 |
fix them. Use with **-f** and **-q** to only see what's incorrect. |
| 71 |
|
| 72 |
.. option:: -q, --quiet |
| 73 |
|
| 74 |
Operate quietly. If **-f** is specified, then don't print the quota |
| 75 |
values, only print messages when things are changed. |
| 76 |
|
| 77 |
.. option:: -J, --json |
| 78 |
|
| 79 |
Output the quota values as JSON for automated tooling support |
| 80 |
|
| 81 |
.. option:: -u, --userids |
| 82 |
|
| 83 |
Interpret *mailbox-spec* arguments as userids. The default is to |
| 84 |
interpret them as mailbox prefixes |
| 85 |
|
| 86 |
.. option:: mailbox-spec |
| 87 |
|
| 88 |
Only report and/or fix quota in mailboxes matching the specified |
| 89 |
*mailbox-spec* arguments. See also **-u**. |
| 90 |
|
| 91 |
Examples |
| 92 |
======== |
| 93 |
|
| 94 |
.. parsed-literal:: |
| 95 |
|
| 96 |
**quota** |
| 97 |
|
| 98 |
.. |
| 99 |
|
| 100 |
List quotas for all users and mailboxes. |
| 101 |
|
| 102 |
.. only:: html |
| 103 |
|
| 104 |
:: |
| 105 |
|
| 106 |
Quota % Used Used Resource Root |
| 107 |
1048576 21 228429 STORAGE example.org!user.jane |
| 108 |
9459 MESSAGE example.org!user.jane |
| 109 |
1 X-ANNOTATION-STORAGE example.org!user.jane |
| 110 |
26 X-NUM-FOLDERS example.org!user.jane |
| 111 |
169791 STORAGE example.org!user.jane.Archive |
| 112 |
4137 MESSAGE example.org!user.jane.Archive |
| 113 |
0 X-ANNOTATION-STORAGE example.org!user.jane.Archive |
| 114 |
1 X-NUM-FOLDERS example.org!user.jane.Archive |
| 115 |
1048576 42 448944 STORAGE example.org!user.john |
| 116 |
9088 MESSAGE example.org!user.john |
| 117 |
2 X-ANNOTATION-STORAGE example.org!user.john |
| 118 |
35 X-NUM-FOLDERS example.org!user.john |
| 119 |
|
| 120 |
Files |
| 121 |
===== |
| 122 |
|
| 123 |
/etc/imapd.conf |
| 124 |
|
| 125 |
See Also |
| 126 |
======== |
| 127 |
|
| 128 |
:cyrusman:`imapd.conf(5)` |