This documentation differs from the official API.
Jadeite adds
extra features to the API including:
variable font sizes,
constructions examples,
placeholders for classes and methods, and auto-generated “See Also” links.
Additionally it
is missing some items found in standard Javadoc documentation, including:
generics type information,
“Deprecated” tags and comments,
“See Also” links,
along with other minor differences.
Please send any questions or feedback to
bam@cs.cmu.edu.
javax.mail
interface QuotaAwareStore
- All Known Implementing Classes:
- IMAPStore, IMAPSSLStore
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.
Method Summary |
Quota[] |
Get the quotas for the named quota root.
|
void |
Set the quotas for the quota root specified in the quota argument.
|
getQuota
public Quota[] getQuota(String root)
throws MessagingException
-
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.
- Parameters:
root
- the name of the quota root
- Returns:
- array of Quota objects
- Throws:
MessagingException
- if the server doesn't support the
QUOTA extension
setQuota
public void setQuota(Quota quota)
throws MessagingException
-
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
This documentation differs from the official API.
Jadeite adds
extra features to the API including:
variable font sizes,
constructions examples,
placeholders for classes and methods, and auto-generated “See Also” links.
Additionally it
is missing some items found in standard Javadoc documentation, including:
generics type information,
“Deprecated” tags and comments,
“See Also” links,
along with other minor differences.
Please send any questions or feedback to
bam@cs.cmu.edu.