Summary: Methods | [Expand All]
public interface

QuotaAwareStore

com.google.code.javax.mail.QuotaAwareStore
Known Indirect Subclasses

Class Overview

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

Summary

Public Methods
abstract Quota[] getQuota(String folder)
Get the quotas for the named folder.
abstract void setQuota(Quota quota)
Set the quotas for the quota root specified in the quota argument.

Public Methods

public abstract Quota[] getQuota (String folder)

Get the quotas for the named folder. 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.

Parameters
folder The name of the folder
Returns
  • array of Quota objects
Throws
MessagingException if the server doesn't support the QUOTA extension

public abstract void setQuota (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.

Parameters
quota The quota to set
Throws
MessagingException if the server doesn't support the QUOTA extension