Sun Java System Messaging Server 6.3 Administration Reference

Options

The options for this command are:

Option  

Description  

-a

Lists users in the LDAP directory. If the -a option is not used, imquotacheck lists users in the message store (the local mboxlist database).

-d domain

Searches for users only in the specified domain. 

When used with the -f option, the -d domain option enforces quotas for the specified domain.

When used with the -n option, the -d domain option delivers over-quota notifications for users in the specified domain.

-f

Enforces domain quotas. If the domain is over quota and the mailDomainStatus attribute is currently set to active, the value will be reset to overquota, which will prevent mail from being accepted by the message store. If the domain is not over quota and the mailDomainStatus attribute is set to overquota, then the value will be changed to active, and mail will be accepted.

-h

Displays help for this command. 

-n

Sends notification messages based on the rules defined in the rulefile. If you do not define any rules with the -r option when you use the -n option, the default rulefile is used. If you have not set up a default rulefile and you do not define any rules when you use the -n option, you will receive an error.

The delivery agent’s quota warning mechanism needs to be turned off in order for the imquotacheck -n command to work, because the imquotacheck and the delivery agent use the same element in the quota database to record last-warn time. To turn off the delivery agent’s quota warning, set store.quotanotification to off.

-r rulefile

Specifies the set of rules to be used when you want to calculate quota usage. This option is used with the -n option.

If -r is not specified, a default rulefile can be used. To set up a default rulefile, copy the Sample Rulefile to msg-svr-base/config/imq.rulefile. See Rulefile Format.

-t message template

Notifies users when their mailbox quota is exceeded. This option is used with the -n option.

The message template format is the following: 

  • %U% - user’s mailbox id

  • %Q% - percentage of the used mailbox quota

  • %R% - quota usage details: assigned quota, total mailbox size, and percentage used. If the -e is specified, mailbox usage of the individual folders are also reported.

  • %M% - current mailbox size

  • %C% - quota attribute value

If -t is not specified, a default message file will be mailed. To setup a default message file, copy the Notification File to msg-svr-base/config.

-u user

Obtains the quota status of the specified user id. Cannot be used to specify multiple users. 

-D

Debug mode; displays the execution steps to stdout.