gtpo1m8vOperations

ZMAIL SETQUOTA-Set the Storage Limit for a Mailbox

Use this command to set the quota (storage limit) for one or more mailboxes in a TPF Internet mail server database. The quota is the maximum amount of storage allowed for one or more mailboxes. A quota is applied to a quota root, which is the point in a mailbox naming hierarchy where the quota (storage limit) is set. A quota root does not have to be a mailbox.

Quotas on a quota root apply to the total amount of storage used by any mailbox at that level and any submailboxes of that level that are not under a quota root in a lower-level hierarchy. For example, assume you have the following mailboxes in your mail database:

   tpfuser.inbox
   tpfuser.inbox.work.project1
   tpfuser.inbox.work.project2
   tpfuser.inbox.play
   tpfuser.inbox.todo

Also assume that a quota is set at the following points in the naming hierarchy:

   tpfuser.inbox
   tpfuser.inbox.work
   tpfuser.inbox.play

These points are referred to as quota roots. In this example, the storage limit set for quota root tpfuser.inbox applies to the mailboxes named tpfuser.inbox and tpfuser.inbox.todo; the storage limit set for quota root tpfuser.inbox.work applies to the mailboxes named tpfuser.inbox.work.project1 and tpfuser.inbox.work.project2; and the storage limit set for quota root tpfuser.inbox.play applies to the mailbox named tpfuser.inbox.play.

Requirements and Restrictions

Format




Note:
You can use ZMAIL SQ as a short form of the ZMAIL SETQUOTA command.

mailbox
is the point in the mailbox naming hierarchy for which you want to set the storage limit, or quota.

You can specify as many as 30 characters for an account name. The total length of a mailbox string (including all submailboxes) can be as many as 256 characters. The name of an account or mailbox can consist of any alphanumeric character, underscore (_), hyphen (-), comma (,), semicolon (;), left parenthesis ( ( ), or right parenthesis ( ) ).

quota
is the storage limit for this resource. Specify the maximum number of 4-KB pool records that the mailbox (or mailboxes in the hierarchy) can use. A quota value of 0 indicates that there is no storage limit.

If you specify a value that is below the amount of storage currently being used, the next mail item will be rejected. Subsequent mail will be rejected until the amount of storage being used falls below the new quota.

The first mail item that causes the quota to be exceeded will be accepted and any mail following that will be rejected.

Additional Information

Examples

In the following example, the storage limits are set for various points in the mailbox naming hierarchy. See ZMAIL LISTQUOTA-Display Storage for a Mailbox and ZMAIL LISTQUOTAROOT-Display the Quota Root for a Mailbox for examples of displaying these storage limits and the amount of storage being used to hold mail items in the mailboxes.

+--------------------------------------------------------------------------------+
|User:   zmail lm tpfuser                                                        |
|                                                                                |
|System: MAIL0001I 10:05:30 START OF RESPONSE FROM ZMAIL lm                      |
|        tpfuser.inbox                                                           |
|        tpfuser.inbox.work.project1                                             |
|        tpfuser.inbox.work.project2                                             |
|        tpfuser.inbox.play                                                      |
|        tpfuser.inbox.todo                                                      |
|        END OF DISPLAY                                                          |
|                                                                                |
|User:   zmail setquota tpfuser 1000                                             |
|                                                                                |
|System: MAIL0001I 10:05:49 START OF RESPONSE FROM ZMAIL setquota                |
|        STORAGE 0/1000                                                          |
|        END OF DISPLAY                                                          |
|                                                                                |
|User:  zmail sq tpfuser.inbox.work 5000                                         |
|                                                                                |
|System: MAIL0001I 10:06:20 START OF RESPONSE FROM ZMAIL sq                      |
|        STORAGE 0/5000                                                          |
|        END OF DISPLAY                                                          |
|                                                                                |
|User:  zmail sq tpfuser.inbox.play 3000                                         |
|                                                                                |
|System: MAIL0001I 10:06:20 START OF RESPONSE FROM ZMAIL sq                      |
|        STORAGE 0/3000                                                          |
|        END OF DISPLAY                                                          |
|                                                                                |
+--------------------------------------------------------------------------------+

Related Information