FileDocCategorySizeDatePackage
QuotaAwareStore.javaAPI DocGlassfish v2 API3575Mon May 14 15:28:48 BST 2007javax.mail

QuotaAwareStore

public interface QuotaAwareStore
An interface implemented by Stores that support quotas. The {@link #getQuota getQuota} and {@link #setQuota setQuota} methods support the quota model defined by the IMAP QUOTA extension. Refer to RFC 2087 for more information.

since
JavaMail 1.4

Fields Summary
Constructors Summary
Methods Summary
public javax.mail.Quota[]getQuota(java.lang.String root)
Get the quotas for the named quota root. Quotas are controlled on the basis of a quota root, not (necessarily) a folder. The relationship between folders and quota roots depends on the server. Some servers might implement a single quota root for all folders owned by a user. Other servers might implement a separate quota root for each folder. A single folder can even have multiple quota roots, perhaps controlling quotas for different resources.

param
root the name of the quota root
return
array of Quota objects
exception
MessagingException if the server doesn't support the QUOTA extension

public voidsetQuota(javax.mail.Quota quota)
Set the quotas for the quota root specified in the quota argument. Typically this will be one of the quota roots obtained from the getQuota method, but it need not be.

param
quota the quota to set
exception
MessagingException if the server doesn't support the QUOTA extension