diff -r 000000000000 -r 6f7a81934006 commands/vcheckquota.html --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/commands/vcheckquota.html Wed Jan 16 22:39:43 2008 +0100 @@ -0,0 +1,100 @@ + + +vcheckquota - vmailmgr quota enforcement program + + + + + + + + + +

+

NAME

+

+vcheckquota - vmailmgr quota enforcement program + +

+


+

SYNOPSIS

+

+vcheckquota +[-a UINT] [--soft-maxsize=UINT] [-m STR] [--soft-message=STR] + +

+


+

DESCRIPTION

+

+vcheckquota ensures that the hard and soft quotas are enforced, that message counts and +sizes are appropriately limited. The limits are set by the vadduser or +vchattr command. + +

+The following rules are applied: + +

    +
  1. +

    +If the message is larger than the message size limit, it is rejected. + +

  2. +

    +If the user has too many messages in their mailbox, further messages are +rejected. + +

  3. +

    +If the user is over their hard quota, all further messages are rejected and +no warning messages are linked in. + +

  4. +

    +If the user is over their soft quota, and the message is small (as defined +by soft-maxsize), the message is accepted, otherwise it is rejected. If soft-message is defined, a warning message is linked into the mailbox in either case. + +

+

+Warning: the soft-message is linked into the users maildir once for each +message that is received while the account is over its soft quota. This may +result in multiple warning messages. + +

+


+

OPTIONS

+
+
-a UINT, --soft-maxsize=UINT
+

+The maximum message size after soft quota is reached. Defaults to 4096. + +

-m STR, --soft-message=STR
+

+The path to the soft quota warning message. Defaults to no message. + +

+

+


+

SEE ALSO

+

+vadduser(1), vchattr(1) + +

+


+

AUTHORS

+

+Bruce Guenter <bruceg@em.ca> + + + +