All Downloads are FREE. Search and download functionalities are using the official Maven repository.

javax.mail.QuotaAwareStore Maven / Gradle / Ivy

There is a newer version: 1.6.7
Show newest version
/*
 * Copyright (c) 1997, 2018 Oracle and/or its affiliates. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v. 2.0, which is available at
 * http://www.eclipse.org/legal/epl-2.0.
 *
 * This Source Code may also be made available under the following Secondary
 * Licenses when the conditions for such availability set forth in the
 * Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
 * version 2 with the GNU Classpath Exception, which is available at
 * https://www.gnu.org/software/classpath/license.html.
 *
 * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
 */

package javax.mail;

/**
 * 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 */ public interface QuotaAwareStore { /** * 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. * * @param folder the name of the folder * @return array of Quota objects * @exception MessagingException if the server doesn't support the * QUOTA extension */ Quota[] getQuota(String folder) 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. * * @param quota the quota to set * @exception MessagingException if the server doesn't support the * QUOTA extension */ void setQuota(Quota quota) throws MessagingException; }





© 2015 - 2024 Weber Informatics LLC | Privacy Policy