View Javadoc

1   /**
2    *
3    * Copyright 2006 The Apache Software Foundation
4    *
5    *  Licensed under the Apache License, Version 2.0 (the "License");
6    *  you may not use this file except in compliance with the License.
7    *  You may obtain a copy of the License at
8    *
9    *     http://www.apache.org/licenses/LICENSE-2.0
10   *
11   *  Unless required by applicable law or agreed to in writing, software
12   *  distributed under the License is distributed on an "AS IS" BASIS,
13   *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   *  See the License for the specific language governing permissions and
15   *  limitations under the License.
16   */
17  
18  package javax.mail;
19  
20  
21  /**
22   * An interface for Store implementations to support the IMAP RFC 2087 Quota extension.
23   *
24   * @version $Rev: 421852 $ $Date: 2006-07-14 03:02:19 -0700 (Fri, 14 Jul 2006) $
25   */
26  
27  public interface QuotaAwareStore {
28      /**
29       * Get the quotas for the specified root element.
30       *
31       * @param root   The root name for the quota information.
32       *
33       * @return An array of Quota objects defined for the root.
34       */
35      public Quota[] getQuota(String root);
36  
37      /**
38       * Set a quota item.  The root contained in the Quota item identies
39       * the quota target.
40       *
41       * @param quota  The source quota item.
42       */
43      public void setQuota(Quota quota);
44  }
45  
46