mailQuota

Origin

Messaging Server 5.0

Syntax

integer, single-valued

Object Classes

inetMailUser, mailDomain

Definition

Specifies, in bytes, the amount of disk space allowed for the user’s mailbox.

This attribute also can specify the amount of disk space allowed for a particular folder or message type.

Although mailQuota is a single-valued attribute, you can use it to specify multiple quota values. You can set individual quota values for specific folders and message types. For details, see Specifying Quotas for Folders and Message Types.

For a description of the numeric values for specifying quotas, see quota Values.

If the mailQuota attribute is not specified, the system default quota is used. The system default is specified in the server configuration parameter store.defaultmailboxquota. Setting the configuration parameter store.quotaenforcement to ”on’ causes the message store to enforce the quota.

LDAP_DISK_QUOTA is the MTA option used to specify a different attribute name for this function.

To specify a mailQuota value for the user's entire mailbox tree, use the following format:

mailQuota: quota

where

quota is the number of bytes.

quota Values

Valid numeric values for quota are

pos_num[G|M|K] or -1 or -2.

where pos_num is a positive number up to a maximum of 4294966272

and G (gigabytes), M (megabytes), and K (kilobytes) are the valid units of measurement.

You can specify the full quota value as a positive number by itself (for example, 20000000) or use a unit of measurement (for example, 20M).

The maximum quota value of the user mailbox is 4096G.

Specifying a quota value of 0 will mean that no mail will be delivered.

You can also use the values shown in the following table.

Specifying Quotas for Folders and Message Types

To enable the quotas for individual folders or specific message types, you must run the configutil command with the parameters store.quotafolder.enable and store.typequota.enable.

To enable and configure message types, you also must enable the configutil parameter store.messagetype.enable and configure other configutil parameters.

Guidelines for Specifying Multiple Quota Values

You can specify the following mailQuota values for a user's mailbox tree:

• Quota values for specific folders in the user's mailbox

• Quota values for specific message types such as voice mail or text messages. A message type quota applies to messages of that type in all folders in the user's mailbox.

• A default quota value that applies to all folders and message types in the user's mailbox that are not explicitly assigned quotas.

The following guidelines apply when you assign multiple quota values for a user:

• Quotas do not overlap. For example, when there is a quota for a particular message type or folder, messages of that type or messages in that folder are not counted toward the default quota. Each message counts toward one and only one quota.

• The total quota for the whole user mailbox equals the sum of the values of all the quotas specified by default, type, and folder.

• Message type quotas take precedence over folder quotas. For example, suppose one quota is specified for a user's memos folder and another quota is specified for voice messages. Now suppose the user stores eight voice messages in the memos folder. The eight messages are counted toward the voice-mail quota and excluded from the memos folder quota.

Formatting Quota Values for Folders and Message Types

To specify mailQuota values for folders or message types, use the following format:

mailQuota: {quota}[;{name}%{quota}]...

where

{quota} is the number of bytes. For a description of the allowed numeric values, see quota Values.

{name} is the name of the folder or message type.

The semicolon (“;” ) is a separator that separates multiple quota values.

The percent sign (“%”) associates a folder or message-type name with the quota value that follows it.

Additional Formatting Guidelines for Quota Values

• The first {quota} in the syntax shown above–that is, the first quota value entered after the mailQuota attribute—does not have a name. This value represents the default quota for all folders in the user's mailbox that are not explicitly assigned quotas. The default value applies to all the unnamed folders combined, not individual folders.

• A message-type name starts with a pound sign (“#”).

• A folder name does not start with a pound sign (“#”).

• The “%” and “#” signs are not allowed in folder names or message-type names.

Example

To specify a quota of 4 gigabytes for the user mailbox:

mailQuota: 4G

To specify the system default quota, do not add mailQuota to the LDAP entry. Or you can use the following value:

mailQuota: -2

To specify a 20 MB default quota for all user folders not explicitly assigned a quota; a 10 MB voice-message quota; and a 100 MB quota for the Archive folder:

mailQuota: 20M;#voice%10M;Archive%100M

In the preceding example, the 20 MB default quota includes messages in all user folders except the Archive folder; it also excludes voice messages. The 10 MB voice-message quota includes voices messages in all user folders, including the Archive folder. The 100 MB Archive folder quota includes messages in the Archive folder and its subfolders; it includes messages of all types except voice messages.

OID

2.16.840.1.113730.3.1.21