commands/vcheckquota.pod
changeset 2 b3afb9f1e801
parent 1 30113bfbe723
child 3 3d1d327cfa68
equal deleted inserted replaced
1:30113bfbe723 2:b3afb9f1e801
     1 =head1 NAME
       
     2 
       
     3 vcheckquota - vmailmgr quota enforcement program
       
     4 
       
     5 =head1 SYNOPSIS
       
     6 
       
     7 B<vcheckquota>
       
     8 [B<-a UINT>]
       
     9 [B<--soft-maxsize=UINT>]
       
    10 [B<-m STR>]
       
    11 [B<--soft-message=STR>]
       
    12 
       
    13 
       
    14 =head1 DESCRIPTION
       
    15 
       
    16 F<vcheckquota> ensures that the hard and soft quotas are enforced,
       
    17 that message counts and sizes are appropriately limited.
       
    18 The limits are set by the vadduser or vchattr command.
       
    19 
       
    20 The following rules are applied:
       
    21 
       
    22 =over 8
       
    23 
       
    24 =item 1
       
    25 
       
    26 If the message is larger than the message size limit, it is rejected.
       
    27 
       
    28 =item 2
       
    29 
       
    30 If the user has too many messages in their mailbox,
       
    31 further messages are rejected.
       
    32 
       
    33 =item 3
       
    34 
       
    35 If the user is over their hard quota, all further messages are rejected
       
    36 and no warning messages are linked in.
       
    37 
       
    38 =item 4
       
    39 
       
    40 If the user is over their soft quota, and the message is small
       
    41 (as defined by I<soft-maxsize>), the message is accepted, otherwise
       
    42 it is rejected.  If I<soft-message> is defined, a warning message
       
    43 is linked into the mailbox in either case.
       
    44 
       
    45 =back
       
    46 
       
    47 
       
    48 
       
    49 Warning: the soft-message is linked into the users maildir once for each
       
    50 message that is received while the account is over its soft quota.  This may
       
    51 result in multiple warning messages.
       
    52 
       
    53 
       
    54 =head1 OPTIONS
       
    55 
       
    56 =over 8
       
    57 
       
    58 =item B<-a UINT>, B<--soft-maxsize=UINT>
       
    59 
       
    60 The maximum message size after soft quota is reached. Defaults to 4096.
       
    61 
       
    62 =item B<-m STR>, B<--soft-message=STR>
       
    63 
       
    64 The path to the soft quota warning message. Defaults to no message.
       
    65 
       
    66 =back
       
    67 
       
    68 =head1 SEE ALSO
       
    69 
       
    70 
       
    71 vadduser(1), vchattr(1)
       
    72 
       
    73 
       
    74 
       
    75 =head1 AUTHORS
       
    76 
       
    77 Bruce Guenter <bruceg@em.ca>
       
    78