JMAP for QuotasLinagora100 Terrasse Boieldieu – Tour FranklinParis - La Défense CEDEX92042Francercordier@linagora.comhttps://www.linagora.comLinagora100 Terrasse Boieldieu – Tour FranklinParis - La Défense CEDEX92042Francembailly@linagora.comhttps://www.linagora.com
Applications
JMAPJMAPJSONemailquotasThis document specifies a data model for handling quotas on mailboxes with a server using JMAP.
JMAP ( – JSON Meta Application Protocol) is a generic protocol for synchronising data, such as mail, calendars or contacts, between a client and a server. It is optimised for mobile and web environments, and aims to provide a consistent interface to different data types.
This specification defines a data model for handling mail quotas over JMAP, allowing you to read and explain quota information.
This specification does not address quota administration, which should be handled by other means.
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
"SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and
"OPTIONAL" in this document are to be interpreted as described in BCP
14 when, and only when, they appear in all
capitals, as shown here.
Type signatures, examples and property descriptions in this document follow the conventions established in section 1.1 of . Data types defined in the core specification are also used in this document.
Servers MUST support all properties specified for the new data types defined in this document.
A quota is a numeric upper limit that the server is enforcing. Quotas are applied to JMAP Mailbox objects.
The capabilities object is returned as part of the JMAP Session object; see , section 2.
This document defines one additional capability URI.
This represents support for the Quota data type and associated API methods. Servers supporting this specification MUST add this property to the capabilities object.
The quota is an object that displays the limit set to a mailbox usage as well as the current usage in regard to that limit.
The Scope is a String from an enumeration defined list of values, handled by the server.
It explains the entities this value applies to. Some custom specifications might provide some additional values. If the client does not specify custom scope specifications in the "using" parameter of the request, the server should respond the JSON value null, instead of answering a scope value that the client does not support. Standard values are:
* account: Applies for this account
* domain: All users of this domain share this part of the quota
* global: All users of this mail server share this part of the quota
The quota object MUST contain the following fields:
id: Id The unique identifier for this object. It should respect the JMAP ID datatype defined in section 1.2 of type: String The type of quota. It should either be "messageCount" or "messageStorageSize". There is two ways we can define a quota: either on a number of emails, or in the amount of bytes.used: UnsignedInt The current usage of the mailbox. Computation of this value is handled by the server.usedScope: Scope The Scope of the current mailbox usage.limit: UnsignedInt The limit set by this quota object to the current mailbox.limitScope: Scope The Scope of the mailbox limit.The quota object MAY contain the following field:
description: String|null Arbitrary free, human readable, description of this quota. Might be used to explain where the limit comes from and explain the entities this quota applies to.Standard “/get” method as described in section 5.1. The ids argument may be null to fetch all at once.
Request fetching all quotas related to an account :
With response :
Standard “/changes” method as described in section 5.2.
Request:
Response:
The following extra property is defined:
quotaIds:Id[] (default: []) A list of quota ids bound to that mailbox, or [] if that mailbox has no quota restrictions. This value is server-set.All security considerations of JMAP () apply to this specification.
IANA will register the "quota" JMAP Capability as follows:
Capability Name: urn:ietf:params:jmap:quotaSpecification document: this document
Intended use: common
Change Controller: IETF
Security and privacy considerations: this document, section 4.