//
// FolderQuota.cs
//
// Author: Jeffrey Stedfast <jestedfa@microsoft.com>
//
// Copyright (c) 2013-2020 .NET Foundation and Contributors
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
//

using System;

namespace MailKit {
	/// <summary>
	/// A folder quota.
	/// </summary>
	/// <remarks>
	/// A <see cref="FolderQuota"/> is returned by <see cref="IMailFolder.GetQuota(System.Threading.CancellationToken)"/>.
	/// </remarks>
	/// <example>
	/// <code language="c#" source="Examples\ImapExamples.cs" region="Capabilities"/>
	/// </example>
	public class FolderQuota
	{
		/// <summary>
		/// Initializes a new instance of the <see cref="MailKit.FolderQuota"/> class.
		/// </summary>
		/// <remarks>
		/// Creates a new <see cref="FolderQuota"/> with the specified root.
		/// </remarks>
		/// <param name="quotaRoot">The quota root.</param>
		public FolderQuota (IMailFolder quotaRoot)
		{
			QuotaRoot = quotaRoot;
		}

		/// <summary>
		/// Get the quota root.
		/// </summary>
		/// <remarks>
		/// Gets the quota root. If the quota root is <c>null</c>, then
		/// it suggests that the folder does not have a quota.
		/// </remarks>
		/// <example>
		/// <code language="c#" source="Examples\ImapExamples.cs" region="Capabilities"/>
		/// </example>
		/// <value>The quota root.</value>
		public IMailFolder QuotaRoot {
			get; private set;
		}

		/// <summary>
		/// Get or set the message limit.
		/// </summary>
		/// <remarks>
		/// Gets or sets the message limit.
		/// </remarks>
		/// <example>
		/// <code language="c#" source="Examples\ImapExamples.cs" region="Capabilities"/>
		/// </example>
		/// <value>The message limit.</value>
		public uint? MessageLimit {
			get; set;
		}

		/// <summary>
		/// Get or set the storage limit, in kilobytes.
		/// </summary>
		/// <remarks>
		/// Gets or sets the storage limit, in kilobytes.
		/// </remarks>
		/// <example>
		/// <code language="c#" source="Examples\ImapExamples.cs" region="Capabilities"/>
		/// </example>
		/// <value>The storage limit, in kilobytes.</value>
		public uint? StorageLimit {
			get; set;
		}

		/// <summary>
		/// Get or set the current message count.
		/// </summary>
		/// <remarks>
		/// Gets or sets the current message count.
		/// </remarks>
		/// <example>
		/// <code language="c#" source="Examples\ImapExamples.cs" region="Capabilities"/>
		/// </example>
		/// <value>The current message count.</value>
		public uint? CurrentMessageCount {
			get; set;
		}

		/// <summary>
		/// Gets or sets the size of the current storage, in kilobytes.
		/// </summary>
		/// <remarks>
		/// Gets or sets the size of the current storage, in kilobytes.
		/// </remarks>
		/// <example>
		/// <code language="c#" source="Examples\ImapExamples.cs" region="Capabilities"/>
		/// </example>
		/// <value>The size of the current storage, in kilobytes.</value>
		public uint? CurrentStorageSize {
			get; set;
		}
	}
}