JMAP for Quotas

1.1. Notational conventions

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 [RFC2119] [RFC8174] 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 [RFC8620]. Data types defined in the core specification are also used in this document.¶

1.2. Terminology

This document reuses the terminology from the core JMAP specification established in section 1.6 of [RFC8620].¶

The term Quota (when capitalized) is used to refer to the data type defined in this document in Section 4 and instance of that data type.¶

2.1. urn:ietf:params:jmap:quota

This represents support for the Quota data type and associated API methods. Servers supporting this specification MUST add a property called urn:ietf:params:jmap:quota to the capabilities object.¶

The value of this property is an empty object in both the JMAP session capabilities property and an account's accountCapabilities property.¶

3.1. Scope

The Scope data type is used to represent the entities the Quota applies to. It is defined as a "String" with values from the following set:¶

• account: The Quota information applies to just the client's account¶
• domain: The Quota information applies to all accounts sharing this domain¶
• global: The Quota information applies to all accounts belonging to the server¶

3.2. ResourceType

The ResourceType data type is used to act as a unit of measure for the quota usage. It is defined as a "String" with values from the following set:¶

• count: The quota is measured in number of data type objects. For example, a quota can have a limit of 50 "Mail" objects.¶
• octets: The quota is measured in size (in "octets"). For example, a quota can have a limit of 25000 "octets".¶

4.1. Properties of the quota object

The quota object MUST contain the following fields:¶

• id: "Id"¶

• The unique identifier for this object.¶

• resourceType: "String"¶

• The resource type of the quota as defined in Section 3.2.¶

• used: "UnsignedInt"¶

• The current usage of the defined quota, using the "resourceType" defined as unit of measure. Computation of this value is handled by the server.¶

• hardLimit: "UnsignedInt"¶

• The hard limit set by this quota, using the "resourceType" defined as unit of measure. Objects in scope may not be created or updated if this limit is reached.¶

• scope: "String"¶

• The "Scope" of this quota as defined in Section 3.1.¶

• name: "String"¶

• The name of the quota object. Useful for managing quotas and using queries for searching.¶

• types: "String[]"¶

• A list of all the type names as defined in the "JMAP Types Names" registry (e.g., Email, Calendar, etc.) to which this quota applies. This allows to assign quotas to distinct or shared data types.¶

• The server MUST filter out any types for which the client did not request the associated capability in the "using" section of the request. Further, the server MUST NOT return Quota objects for which there are no types recognised by the client.¶

The quota object MAY contain the following fields:¶

• warnLimit: "UnsignedInt|null"¶

• The warn limit set by this quota object, using the "resourceType" defined as unit of measure. It can be used to send a warning to an entity about to reach the hard limit soon, but with no action taken yet. If set, it SHOULD be lower than the "softLimit" (if present and different from null) and the "hardLimit".¶

• softLimit: "UnsignedInt|null"¶

• The soft limit set by this quota object, using the "resourceType" defined as unit of measure. It can be used to still allow some operations, but refuse some others. What is allowed or not is up to the server. For example, it could be used for blocking outgoing events of an entity (sending emails, creating calendar events, ...) while still receiving incoming events (receiving emails, receiving calendars events, ...). If set, it SHOULD be higher than the "warnLimit" (if present and different from null) but lower than the "hardLimit".¶

• description: "String|null"¶

• Arbitrary free, human-readable, description of this quota. It might be used to explain where the different limits come from and explain the entities and data types this quota applies to. The description MUST be encoded in UTF-8 [RFC3629] as described in [RFC8620] section 1.5, selected based on an Accept-Language header in the request (as defined in [RFC9110], Section 12.5.4) or out-of-band information about the user's language/locale.¶

The following JMAP methods are supported.¶

4.2. Quota/get

Standard "/get" method as described in [RFC8620] section 5.1. The ids argument may be "null" to fetch all Quotas of the account at once, as demonstrated in this document in Section 5.1.¶

4.3. Quota/changes

Standard "/changes" method as described in [RFC8620] section 5.2 but with one extra argument in the response:¶

• updatedProperties: "String[]|null"¶

• If only the "used" Quota property has changed since the old state, this will be a list containing only that property. If the server is unable to tell if only "used" has changed, it MUST be null.¶

Since "used" frequently changes but other properties are generally only changed rarely, the server can help the client optimise data transfer by keeping track of changes to Quota usage separate from other state changes. The updatedProperties array may be used directly via a back-reference in a subsequent Quota/get call in the same request, so only these properties are returned if nothing else has changed.¶

Servers MAY decide to add other properties to the list that they judge to be changing frequently.¶

This method's usage is demonstrated in this document at Section 5.2.¶

4.4. Quota/query

This is a standard "/query" method as described in [RFC8620], Section 5.5.¶

A FilterCondition object has the following properties, any of which may be included or omitted:¶

• name: "String"¶

• The Quota name property contains the given string.¶

• scope: "String"¶

• The Quota scope property must match the given value exactly.¶

• resourceType: "String"¶

• The Quota resourceType property must match the given value exactly.¶

• type: "String"¶

• The Quota types property contains the given value.¶

A Quota object matches the FilterCondition if and only if all the given conditions match. If zero properties are specified, it is automatically true for all objects.¶

The following Quota properties MUST be supported for sorting:¶

• name¶
• used¶

4.5. Quota/queryChanges

This is a standard "/queryChanges" method as described in [RFC8620], Section 5.6.¶

5.1. Fetching quotas

Request fetching all quotas related to an account :¶

[[ "Quota/get", {
  "accountId": "u33084183",
  "ids": null
}, "0" ]]

With response :¶

[[ "Quota/get", {
  "accountId": "u33084183",
  "state": "78540",
  "list": [{
    "id": "2a06df0d-9865-4e74-a92f-74dcc814270e",
    "resourceType": "count",
    "used": 1056,
    "warnLimit": 1600,
    "softLimit": 1800,
    "hardLimit": 2000,
    "scope": "account",
    "name": "bob@example.com",
    "description": "Personal account usage. When the soft limit is reached, the user is not allowed to send mails or create contacts and calendar events anymore.",
    "types" : [ "Mail", "Calendar", "Contact" ]
  }, {
    "id": "3b06df0e-3761-4s74-a92f-74dcc963501x",
    "resourceType": "octets",
    ...
  }, ...],
  "notFound": []
}, "0" ]]

5.2. Requesting latest quota changes

Request fetching the changes for a specific quota:¶

[[ "Quota/changes", {
  "accountId": "u33084183",
  "sinceState": "78540",
  "maxChanges": 20
}, "0" ],
[ "Quota/get", {
  "accountId": "u33084183",
  "#ids": {
    "resultOf": "0",
    "name": "Quota/changes",
    "path": "/updated"
  },
  "#properties": {
    "resultOf": "0",
    "name": "Quota/changes",
    "path": "/updatedProperties"
  }
}, "1" ]]

With response:¶

[[ "Quota/changes", {
  "accountId": "u33084183",
  "oldState": "78540",
  "newState": "78542",
  "hasMoreChanges": false,
  "updatedProperties": ["used"],
  "created": [],
  "updated": ["2a06df0d-9865-4e74-a92f-74dcc814270e"],
  "destroyed": []
}, "0" ],
[ "Quota/get", {
  "accountId": "u33084183",
  "state": "10826",
  "list": [{
    "id": "2a06df0d-9865-4e74-a92f-74dcc814270e",
    "used": 1246
  }],
  "notFound": []
}, "1" ]]

8.1. JMAP Capability Registration for "quota"

IANA will register the "quota" JMAP Capability as follows:¶

Capability Name: "urn:ietf:params:jmap:quota"¶

Specification document: this document¶

Intended use: common¶

Change Controller: IETF¶

Security and privacy considerations: this document, Section 7.¶

8.2. JMAP Datatype Registration for "Quota"

IANA will register the "Quota" Data Type as folows:¶

Type Name: "Quota"¶

Can reference blobs: No¶

Can use for state change: Yes¶

Capability: "urn:ietf:params:jmap:quota"¶

Reference: this document¶