JMAP for Sieve Scripts
draft-ietf-jmap-sieve-14
| Document | Type | Active Internet-Draft (jmap WG) | |
|---|---|---|---|
| Author | Kenneth Murchison | ||
| Last updated | 2023-03-30 | ||
| RFC stream | Internet Engineering Task Force (IETF) | ||
| Intended RFC status | Proposed Standard | ||
| Formats | |||
| Additional resources | Mailing list discussion | ||
| Stream | WG state | In WG Last Call | |
| Document shepherd | Bron Gondwana | ||
| Shepherd write-up | Show Last changed 2022-10-24 | ||
| IESG | IESG state | I-D Exists | |
| Consensus boilerplate | Yes | ||
| Telechat date | (None) | ||
| Responsible AD | (None) | ||
| Send notices to | brong@fastmailteam.com |
draft-ietf-jmap-sieve-14
JMAP K. Murchison
Internet-Draft Fastmail
Intended status: Standards Track 30 March 2023
Expires: 1 October 2023
JMAP for Sieve Scripts
draft-ietf-jmap-sieve-14
Abstract
This document specifies a data model for managing Sieve scripts on a
server using the JSON Meta Application Protocol (JMAP).
Open Issues
* Should ALL Sieve capabilites be in the JMAP Session capabilities
property rather than in the accountCapabilities property? Would
the capabilities actually differ between users?
Status of This Memo
This Internet-Draft is submitted in full conformance with the
provisions of BCP 78 and BCP 79.
Internet-Drafts are working documents of the Internet Engineering
Task Force (IETF). Note that other groups may also distribute
working documents as Internet-Drafts. The list of current Internet-
Drafts is at https://datatracker.ietf.org/drafts/current/.
Internet-Drafts are draft documents valid for a maximum of six months
and may be updated, replaced, or obsoleted by other documents at any
time. It is inappropriate to use Internet-Drafts as reference
material or to cite them other than as "work in progress."
This Internet-Draft will expire on 1 October 2023.
Copyright Notice
Copyright (c) 2023 IETF Trust and the persons identified as the
document authors. All rights reserved.
Murchison Expires 1 October 2023 [Page 1]
Internet-Draft JMAP Sieve March 2023
This document is subject to BCP 78 and the IETF Trust's Legal
Provisions Relating to IETF Documents (https://trustee.ietf.org/
license-info) in effect on the date of publication of this document.
Please review these documents carefully, as they describe your rights
and restrictions with respect to this document. Code Components
extracted from this document must include Revised BSD License text as
described in Section 4.e of the Trust Legal Provisions and are
provided without warranty as described in the Revised BSD License.
Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2
1.1. Notational Conventions . . . . . . . . . . . . . . . . . 3
1.2. Terminology . . . . . . . . . . . . . . . . . . . . . . . 3
1.3. Addition to the Capabilities Object . . . . . . . . . . . 3
1.3.1. urn:ietf:params:jmap:sieve . . . . . . . . . . . . . 4
2. Sieve Scripts . . . . . . . . . . . . . . . . . . . . . . . . 5
2.1. SieveScript/get . . . . . . . . . . . . . . . . . . . . . 6
2.1.1. Examples . . . . . . . . . . . . . . . . . . . . . . 6
2.2. SieveScript/set . . . . . . . . . . . . . . . . . . . . . 9
2.2.1. Examples . . . . . . . . . . . . . . . . . . . . . . 11
2.3. SieveScript/query . . . . . . . . . . . . . . . . . . . . 19
2.4. SieveScript/validate . . . . . . . . . . . . . . . . . . 19
3. Compatibility with JMAP Vacation Response . . . . . . . . . . 20
4. Security Considerations . . . . . . . . . . . . . . . . . . . 20
5. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 20
5.1. JMAP Capability Registration for "sieve" . . . . . . . . 20
5.2. JMAP Error Codes Registry . . . . . . . . . . . . . . . . 21
5.2.1. invalidScript . . . . . . . . . . . . . . . . . . . . 21
5.2.2. scriptIsActive . . . . . . . . . . . . . . . . . . . 21
6. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 21
7. References . . . . . . . . . . . . . . . . . . . . . . . . . 21
7.1. Normative References . . . . . . . . . . . . . . . . . . 21
7.2. Informative References . . . . . . . . . . . . . . . . . 22
Appendix A. Change History (To be removed by RFC Editor before
publication) . . . . . . . . . . . . . . . . . . . . . . 23
Author's Address . . . . . . . . . . . . . . . . . . . . . . . . 26
1. Introduction
JMAP [RFC8620] (JSON Meta Application Protocol) is a generic protocol
for synchronizing data, such as mail, calendars or contacts, between
a client and a server. It is optimized for mobile and web
environments, and aims to provide a consistent interface to different
data types.
Murchison Expires 1 October 2023 [Page 2]
Internet-Draft JMAP Sieve March 2023
This specification defines a data model for managing Sieve [RFC5228]
scripts on a server using JMAP. The data model is designed to allow
a server to provide consistent access to the same scripts via
ManageSieve [RFC5804] as well as JMAP, however the functionality
offered over the two protocols may differ.
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.
Servers MUST support all properties specified for the new data type
defined in this document.
For compatibility with publishing requirements, line breaks have been
inserted inside long JSON strings, with the following continuation
lines indented. To form the valid JSON example, any line breaks
inside a string must be replaced with a space and any other white
space after the line break removed.
1.2. Terminology
The same terminology is used in this document as in the core JMAP
specification, see [RFC8620], Section 1.6.
The term SieveScript (with this specific capitalization) is used to
refer to the data type defined in this document and instances of
those data types.
1.3. Addition to the Capabilities Object
The capabilities object is returned as part of the JMAP Session
object; see [RFC8620], Section 2. This document defines one
additional capability URI.
Murchison Expires 1 October 2023 [Page 3]
Internet-Draft JMAP Sieve March 2023
1.3.1. urn:ietf:params:jmap:sieve
This represents support for the SieveScript data type and associated
API methods. The value of this property in the JMAP Session
capabilities property is an object that MUST contain the following
information on server capabilities:
* *implementation*: String
The name and version of the Sieve implementation.
The value of this property in an account's accountCapabilities
property is an object that MUST contain the following information on
server capabilities:
* *maxSizeScriptName*: UnsignedInt
The maximum length, in (UTF-8) octets, allowed for the name of a
SieveScript. For compatibility with ManageSieve, this MUST be at
least 512 (up to 128 Unicode characters).
* *maxSizeScript*: UnsignedInt|null
The maximum size (in octets) of a Sieve script the server is
willing to store for the user, or null for no limit.
* *maxNumberScripts*: UnsignedInt|null
The maximum number of Sieve scripts the server is willing to store
for the user, or null for no limit.
* *maxNumberRedirects*: UnsignedInt|null
The maximum number of Sieve "redirect" actions a script can
perform during a single evaluation or null for no limit. Note
that this is different from the total number of "redirect" actions
a script can contain.
* *sieveExtensions*: String[]
A list of case-sensitive Sieve capability strings (as listed in
Sieve "require" action; see [RFC5228], Section 3.2) indicating the
extensions supported by the Sieve engine.
* *notificationMethods*: String[]|null
Murchison Expires 1 October 2023 [Page 4]
Internet-Draft JMAP Sieve March 2023
A list of URI schema parts [RFC3986] for notification methods
supported by the Sieve "enotify" [RFC5435] extension, or null if
the extension is not supported by the Sieve engine.
* *externalLists*: String[]|null
A list of URI schema parts [RFC3986] for externally stored list
types supported by the Sieve "extlists" [RFC6134] extension, or
null if the extension is not supported by the Sieve engine.
2. Sieve Scripts
A *SieveScript* object represents a single Sieve [RFC5228] script for
filtering email messages at time of final delivery.
A *SieveScript* object has the following properties:
* *id*: Id (immutable; server-set)
The id of the script.
* *name*: String|null (optional; default is server-dependent)
User-visible name for the SieveScript. If non-null, this MUST be
a Net-Unicode [RFC5198] string of at least 1 character in length,
subject to the maximum size given in the capability object. For
compatibility with ManageSieve, servers MUST reject names that
contain control characters. Servers MAY reject names that violate
server policy (e.g., names containing slash (/)). The name MUST
be unique among all SieveScripts within an account.
* *blobId*: Id
The id of the blob containing the raw octets of the script.
The script MUST be UTF-8 [RFC3629] content of at least 1 character
in length, subject to the syntax of Sieve [RFC5228]. The script
MUST NOT contain any "require" statement(s) mentioning Sieve
capability strings not present in the capability (Section 1.3.1)
object. Note that if the Sieve "ihave" [RFC5463] capability
string is present in the capability object, the script MAY mention
unrecognized/unsupported extensions in the "ihave" test.
* *isActive*: Boolean (server-set; default: false)
Murchison Expires 1 October 2023 [Page 5]
Internet-Draft JMAP Sieve March 2023
A user may have multiple SieveScripts on the server, yet only one
script may be used for filtering of incoming messages. This is
the active script. Users may have zero or one active script. The
SieveScript/set (Section 2.2) method is used for changing the
active script or disabling Sieve processing.
2.1. SieveScript/get
This is a standard "/get" method as described in [RFC8620],
Section 5.1. The _ids_ argument may be null to fetch all at once.
This method provides similar functionality to the GETSCRIPT and
LISTSCRIPTS commands in [RFC5804].
2.1.1. Examples
Request (and response) to list all scripts:
Murchison Expires 1 October 2023 [Page 6]
Internet-Draft JMAP Sieve March 2023
{
"using": [ "urn:ietf:params:jmap:core",
"urn:ietf:params:jmap:sieve" ],
"methodCalls": [
["SieveScript/get", {
"accountId": "ken"
}, "0"]
]
}
{
"methodResponses": [
[
"SieveScript/get",
{
"state": "1634915373.240633104-120",
"list": [
{
"id": "2d647053-dded-418d-917a-63eda3ac8f7b",
"name": "test1",
"isActive": true,
"blobId": "S123"
}
],
"notFound": [],
"accountId": "ken"
},
"0"
]
]
}
Request (and response) to download the script (assuming that the JMAP
Download URL has been advertised in the JMAP Session object as having
a path of "/jmap/
download/{accountId}/{blobId}/{name}?accept={type}"). Note that the
request-line has been wrapped for presentation purposes only.
Murchison Expires 1 October 2023 [Page 7]
Internet-Draft JMAP Sieve March 2023
GET
/jmap/download/ken/S123/test1.siv?accept=application/sieve
HTTP/1.1
Host: jmap.example.com
Authorization: Basic a2VuOnBhc3N3b3Jk
HTTP/1.1 200 OK
Date: Fri, 22 Oct 2021 15:27:38 GMT
Content-Type: application/sieve; charset=utf-8
Content-Disposition: attachment; filename="test1.siv"
Content-Length: 49
require ["fileinto"];
fileinto "INBOX.target";
Request (and response) to fetch the content of a single script:
{
"using": [ "urn:ietf:params:jmap:core",
"urn:ietf:params:jmap:blob",
"urn:ietf:params:jmap:sieve" ],
"methodCalls": [
["SieveScript/get", {
"accountId": "ken",
"ids": [ "2d647053-dded-418d-917a-63eda3ac8f7b" ]
}, "0"],
["Blob/get", {
"accountId": "ken",
"#ids": {
"resultOf": "0",
"name": "SieveScript/get",
"path": "/list/*/blobId"
}
}, "1"]
]
}
{
"methodResponses": [
[
"SieveScript/get",
{
"state": "1634915373.240633104-120",
"list": [
{
"id": "2d647053-dded-418d-917a-63eda3ac8f7b",
"name": "test1",
"isActive": true,
Murchison Expires 1 October 2023 [Page 8]
Internet-Draft JMAP Sieve March 2023
"blobId": "S123"
}
],
"notFound": [],
"accountId": "ken"
},
"0"
],
[
"Blob/get",
{
"list": [
{
"id": "S123",
"data:asText":
"require [\"fileinto\"];\\r\\nfileinto \"INBOX.target\";\\r\\n",
"size": 49
}
],
"notFound": [],
"accountId": "ken"
},
"1"
]
]
}
2.2. SieveScript/set
This is a standard "/set" method as described in [RFC8620],
Section 5.3 but with the following additional request arguments,
either or both of which may be omitted:
* *onSuccessActivateScript*: Id (optional)
The id of the SieveScript to activate if and only if all of the
creations, modifications, and destructions (if any) succeed. (For
references to SieveScript creations, this is equivalent to a
creation-reference, so the id will be the creation id prefixed
with a "#".) The currently active SieveScript (if any) will be
deactivated before activating the specified SieveScript.
If the id is either illegal or nonexistent, it MUST be ignored and
the currently active SieveScript (if any) will remain as such.
The id of any activated SieveScript MUST be reported in either the
"created" or "updated" argument in the response as appropriate,
including a value of "true" for the "isActive" property. The id
Murchison Expires 1 October 2023 [Page 9]
Internet-Draft JMAP Sieve March 2023
of any deactivated SieveScript MUST be reported in the "updated"
argument in the response, including a value of "false" for the
"isActive" property.
* *onSuccessDeactivateScript*: Boolean (optional)
If true, the currently active SieveScript (if any) will be
deactivated if and only if all of the creations, modifications,
and destructions (if any) succeed. If false, the currently active
SieveScript (if any) will remain as such.
The id of any deactivated SieveScript MUST be reported in the
"updated" argument in the response, including a value of "false"
for the "isActive" property.
If both the *onSuccessActivateScript* and *onSuccessDeactivateScript*
arguments are present in the request, then
*onSuccessDeactivateScript* MUST be processed first. If neither
argument is present in the request, the currently active SieveScript
(if any) will remain as such.
This method provides similar functionality to the PUTSCRIPT,
DELETESCRIPT, RENAMESCRIPT, and SETACTIVE commands in [RFC5804].
Script content must first be uploaded as a blob using either the
standard upload mechanism (see [RFC8620] Section 6.1) or the JMAP
Blob management extension (see [I-D.ietf-jmap-blob] Section 3.1).
If the SieveScript can not be created or updated because it would
result in two SieveScripts with the same name, the server MUST reject
the request with an "alreadyExists" SetError. An "existingId"
property of type "Id" MUST be included on the SetError object with
the id of the existing SieveScript.
If the SieveScript can not be created or updated because its size
exceeds the "maxSizeScript" limit, the server MUST reject the request
with a "tooLarge" SetError.
If the Sieve Script can not be created because it would exceed the
"maxNumberScripts" limit, the server MUST reject the request with an
"overQuota" SetError.
The active SieveScript MUST NOT be destroyed unless it is first
deactivated in a separate SieveScript/set method call.
The following extra SetError types are defined:
For "create" and "update":
Murchison Expires 1 October 2023 [Page 10]
Internet-Draft JMAP Sieve March 2023
* *invalidScript*:
The SieveScript content violates the Sieve [RFC5228] grammar and/
or one or more extensions mentioned in the script's "require"
statement(s) are not supported by the Sieve interpreter. The
_description_ property on the SetError object SHOULD contain a
specific error message giving at least the line number of the
first error.
For "destroy":
* *scriptIsActive*:
The SieveScript is active.
2.2.1. Examples
Request (and response) to upload a script requiring the Imap4Flags
[RFC5232] Extension (assuming that the JMAP Upload URL has been
advertised in the JMAP Session object as having a path of "/jmap/
upload/{accountId}/"):
POST /jmap/upload/ken/ HTTP/1.1
Host: jmap.example.com
Authorization: Basic a2VuOnBhc3N3b3Jk
Content-Type: application/sieve
Content-Length: 98
require "imapflags";
if address :is ["To", "Cc"] "jmap@ietf.org" {
setflag "\\Flagged";
}
HTTP/1.1 201 Created
Date: Thu, 10 Dec 2020 17:14:31 GMT
Content-Type: application/json; charset=utf-8
Content-Length: 171
{
"accountId": "ken",
"blobId": "Gabcc83e44a6e19991c4568d0b94e1767c83dd123",
"type": "application/sieve"
"size": 98
}
Murchison Expires 1 October 2023 [Page 11]
Internet-Draft JMAP Sieve March 2023
Request (and response) to create and activate a script using the
uploaded blob. Note that the response shows that an existing active
script has been deactivated in lieu of the newly created script being
activated.
Murchison Expires 1 October 2023 [Page 12]
Internet-Draft JMAP Sieve March 2023
{
"using": [ "urn:ietf:params:jmap:core",
"urn:ietf:params:jmap:sieve" ],
"methodCalls": [
["SieveScript/set", {
"accountId": "ken",
"create": {
"A": {
"name": null,
"blobId": "Gabcc83e44a6e19991c4568d0b94e1767c83dd123"
}
},
"onSuccessActivateScript": "#A"
}, "0"]
]
}
{
"methodResponses": [
[
"SieveScript/set",
{
"oldState": "1603741717.50737918-4096",
"newState": "1603741751.227268529-4096",
"created": {
"A": {
"id": "dd1b164f-8cdc-448c-9f54",
"name": "ken-20201210T171432-0",
"blobId": "Sdd1b164f-8cdc-448c-9f54",
"isActive": true
}
},
"updated": {
"8abd6f4a-bcb4d-87650-3fcd": {
"isActive": false
}
},
"destroyed": null,
"notCreated": null,
"notUpdated": null,
"notDestroyed": null,
"accountId": "ken"
},
"0"
]
]
}
Murchison Expires 1 October 2023 [Page 13]
Internet-Draft JMAP Sieve March 2023
Request (and response) to update script content using the JMAP Blob
management extension [I-D.ietf-jmap-blob]:
{
"using": [ "urn:ietf:params:jmap:core",
"urn:ietf:params:jmap:blob",
"urn:ietf:params:jmap:sieve" ],
"methodCalls": [
["Blob/upload", {
"accountId": "ken",
"create": {
"B": {
"data": [ {
"data:asText":
"redirect \"ken@example.com\"\r\n;"
} ],
"type": "application/sieve"
}
}
}, "1"],
["SieveScript/set", {
"accountId": "ken",
"update": { "dd1b164f-8cdc-448c-9f54": {
"blobId": "#B"
}
}
}, "2"]
]
}
{
"methodResponses": [
[
"Blob/upload",
{
"oldState": null,
"newState": "1603741700.309607123-0128",
"created": {
"B": {
"id": "G969c83e44a6e10871c4568d0b94e1767c83ddeae",
"blobId": "G969c83e44a6e10871c4568d0b94e1767c83ddeae",
"type": "application/sieve",
"size": 29
}
},
"notCreated": null,
"accountId": "ken"
},
Murchison Expires 1 October 2023 [Page 14]
Internet-Draft JMAP Sieve March 2023
"1"
],
[
"SieveScript/set",
{
"oldState": "1603741751.227268529-4096",
"newState": "1603742603.309607868-4096",
"created": null,
"updated": {
"dd1b164f-8cdc-448c-9f54": null
},
"destroyed": null,
"notCreated": null,
"notUpdated": null,
"notDestroyed": null,
"accountId": "ken"
},
"2"
]
]
}
Request (and response) to update script name and deactivate:
Murchison Expires 1 October 2023 [Page 15]
Internet-Draft JMAP Sieve March 2023
{
"using": [ "urn:ietf:params:jmap:core",
"urn:ietf:params:jmap:sieve" ],
"methodCalls": [
["SieveScript/set", {
"accountId": "ken",
"update": { "dd1b164f-8cdc-448c-9f54": {
"name": "myscript"
}
},
"onSuccessDeactivateScript": true
}, "3"]
]
}
{
"methodResponses": [
[
"SieveScript/set",
{
"oldState": "1603742603.309607868-4096",
"newState": "1603742967.852315428-4096",
"created": null,
"updated": {
"dd1b164f-8cdc-448c-9f54": {
"isActive": false
}
},
"destroyed": null,
"notCreated": null,
"notUpdated": null,
"notDestroyed": null,
"accountId": "ken"
},
"3"
]
]
}
Request (and response) to activate a script:
Murchison Expires 1 October 2023 [Page 16]
Internet-Draft JMAP Sieve March 2023
{
"using": [ "urn:ietf:params:jmap:core",
"urn:ietf:params:jmap:sieve" ],
"methodCalls": [
["SieveScript/set", {
"accountId": "ken",
"onSuccessActivateScript": "dd1b164f-8cdc-448c-9f54"
}, "4"]
]
}
{
"methodResponses": [
[
"SieveScript/set",
{
"oldState": "1603742967.852315428-4096",
"newState": "1603744460.316617118-4096",
"created": null,
"updated": {
"dd1b164f-8cdc-448c-9f54": {
"isActive": true
}
},
"destroyed": null,
"notCreated": null,
"notUpdated": null,
"notDestroyed": null,
"accountId": "ken"
},
"4"
]
]
}
Requests (and responses) to deactivate and destroy the active script:
{
"using": [ "urn:ietf:params:jmap:core",
"urn:ietf:params:jmap:sieve" ],
"methodCalls": [
["SieveScript/set", {
"accountId": "ken",
"onSuccessDeactivateScript": true
}, "5"],
["SieveScript/set", {
"accountId": "ken",
"destroy": [ "dd1b164f-8cdc-448c-9f54" ]
Murchison Expires 1 October 2023 [Page 17]
Internet-Draft JMAP Sieve March 2023
}, "6"]
]
}
{
"methodResponses": [
[
"SieveScript/set",
{
"oldState": "1603744460.316617118-4096",
"newState": "1603744637.575375572-4096",
"created": null,
"updated": {
"dd1b164f-8cdc-448c-9f54": {
"isActive": false
}
},
"destroyed": null,
"notCreated": null,
"notUpdated": null,
"notDestroyed": null,
"accountId": "ken"
},
"5"
],
[
"SieveScript/set",
{
"oldState": "1603744637.575375572-4096",
"newState": "1603744637.854390875-4096",
"created": null,
"updated": null,
"destroyed": [
"dd1b164f-8cdc-448c-9f54"
],
"notCreated": null,
"notUpdated": null,
"notDestroyed": null,
"accountId": "ken"
},
"6"
]
]
}
Murchison Expires 1 October 2023 [Page 18]
Internet-Draft JMAP Sieve March 2023
2.3. SieveScript/query
This is a standard "/query" method as described in [RFC8620],
Section 5.5. A _FilterCondition_ object has the following
properties, either of which may be omitted:
* *name*: String
The SieveScript "name" property contains the given string.
* *isActive*: Boolean
The "isActive" property of the SieveScript must be identical to
the value given to match the condition.
The following SieveScript properties MUST be supported for sorting:
* *name*
* *isActive*
2.4. SieveScript/validate
This method is used by the client to verify Sieve script validity
without storing the script on the server, providing similar
functionality to the CHECKSCRIPT command in [RFC5804].
The method takes the following arguments:
* *accountId*: Id
The id of the account to use.
* *blobId*: Id
The id of the blob containing the raw octets of the script to
validate, subject to the same requirements in Section 2.
The response has the following arguments:
* *accountId*: Id
The id of the account used for this call.
* *error*: SetError|null
A "invalidScript" SetError object if the script content is invalid
(see Section 2.2), or null if the script content is valid.
Murchison Expires 1 October 2023 [Page 19]
Internet-Draft JMAP Sieve March 2023
As with the SieveScript/set (Section 2.2) method, script content must
first be uploaded as a blob using either the standard upload
mechanism (see [RFC8620] Section 6.1) or the JMAP Blob management
extension (see [I-D.ietf-jmap-blob] Section 3.1).
3. Compatibility with JMAP Vacation Response
Section 8 of [RFC8621] defines a VacationResponse object to represent
an autoresponder to incoming email messages. Servers that implement
the VacationResponse as a Sieve script that resides amongst other
user scripts are subject to the following requirements:
* MUST allow the VacationResponse Sieve script to be fetched by the
SieveScript/get (Section 2.1) method.
* MUST allow the VacationResponse Sieve script to be [de]activated
via the "onSuccessActivateScript" argument to the SieveScript/set
(Section 2.2) method.
* MUST NOT allow the VacationResponse Sieve script to be destroyed
or have its content updated by the SieveScript/set (Section 2.2)
method. Any such request MUST be rejected with a "forbidden"
SetError. A "description" property MAY be present with an
explanation that the script can only be modified by a
VacationResponse/set method.
4. Security Considerations
All security considerations of JMAP [RFC8620] and Sieve [RFC5228]
apply to this specification.
5. IANA Considerations
5.1. JMAP Capability Registration for "sieve"
IANA will register the "sieve" JMAP Capability as follows:
Capability Name: urn:ietf:params:jmap:sieve
Specification document: this document
Intended use: common
Change Controller: IETF
Security and privacy considerations: this document, Section 4
Murchison Expires 1 October 2023 [Page 20]
Internet-Draft JMAP Sieve March 2023
5.2. JMAP Error Codes Registry
The following sub-sections register two new error codes in the JMAP
Error Codes registry, as defined in [RFC8620].
5.2.1. invalidScript
JMAP Error Code: invalidScript
Intended use: common
Change controller: IETF
Reference: This document, Section 2.2
Description: The SieveScript violates the Sieve grammar [RFC5228]
and/or one or more extensions mentioned in the script's "require"
statement(s) are not supported by the Sieve interpreter.
5.2.2. scriptIsActive
JMAP Error Code: scriptIsActive
Intended use: common
Change controller: IETF
Reference: This document, Section 2.2
Description: The client tried to destroy the active SieveScript.
6. Acknowledgments
The concepts in this document are based largely on those in
[RFC5804]. The author would like to thank the authors of that
document for providing both inspiration and some borrowed text for
this document.
The author would also like to thank the following individuals for
contributing their ideas and support for writing this specification:
Bron Gondwana, Neil Jenkins, Alexey Melnikov, and Ricardo Signes.
7. References
7.1. Normative References
Murchison Expires 1 October 2023 [Page 21]
Internet-Draft JMAP Sieve March 2023
[RFC2119] Bradner, S., "Key words for use in RFCs to Indicate
Requirement Levels", BCP 14, RFC 2119,
DOI 10.17487/RFC2119, March 1997,
<https://www.rfc-editor.org/info/rfc2119>.
[RFC3629] Yergeau, F., "UTF-8, a transformation format of ISO
10646", STD 63, RFC 3629, DOI 10.17487/RFC3629, November
2003, <https://www.rfc-editor.org/info/rfc3629>.
[RFC3986] Berners-Lee, T., Fielding, R., and L. Masinter, "Uniform
Resource Identifier (URI): Generic Syntax", STD 66,
RFC 3986, DOI 10.17487/RFC3986, January 2005,
<https://www.rfc-editor.org/info/rfc3986>.
[RFC5198] Klensin, J. and M. Padlipsky, "Unicode Format for Network
Interchange", RFC 5198, DOI 10.17487/RFC5198, March 2008,
<https://www.rfc-editor.org/info/rfc5198>.
[RFC5228] Guenther, P., Ed. and T. Showalter, Ed., "Sieve: An Email
Filtering Language", RFC 5228, DOI 10.17487/RFC5228,
January 2008, <https://www.rfc-editor.org/info/rfc5228>.
[RFC5435] Melnikov, A., Ed., Leiba, B., Ed., Segmuller, W., and T.
Martin, "Sieve Email Filtering: Extension for
Notifications", RFC 5435, DOI 10.17487/RFC5435, January
2009, <https://www.rfc-editor.org/info/rfc5435>.
[RFC6134] Melnikov, A. and B. Leiba, "Sieve Extension: Externally
Stored Lists", RFC 6134, DOI 10.17487/RFC6134, July 2011,
<https://www.rfc-editor.org/info/rfc6134>.
[RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC
2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174,
May 2017, <https://www.rfc-editor.org/info/rfc8174>.
[RFC8620] Jenkins, N. and C. Newman, "The JSON Meta Application
Protocol (JMAP)", RFC 8620, DOI 10.17487/RFC8620, July
2019, <https://www.rfc-editor.org/info/rfc8620>.
[RFC8621] Jenkins, N. and C. Newman, "The JSON Meta Application
Protocol (JMAP) for Mail", RFC 8621, DOI 10.17487/RFC8621,
August 2019, <https://www.rfc-editor.org/info/rfc8621>.
7.2. Informative References
Murchison Expires 1 October 2023 [Page 22]
Internet-Draft JMAP Sieve March 2023
[I-D.ietf-jmap-blob]
Gondwana, B., "JMAP Blob management extension", Work in
Progress, Internet-Draft, draft-ietf-jmap-blob-18, 3
January 2023, <https://datatracker.ietf.org/doc/html/
draft-ietf-jmap-blob-18>.
[RFC5232] Melnikov, A., "Sieve Email Filtering: Imap4flags
Extension", RFC 5232, DOI 10.17487/RFC5232, January 2008,
<https://www.rfc-editor.org/info/rfc5232>.
[RFC5463] Freed, N., "Sieve Email Filtering: Ihave Extension",
RFC 5463, DOI 10.17487/RFC5463, March 2009,
<https://www.rfc-editor.org/info/rfc5463>.
[RFC5804] Melnikov, A., Ed. and T. Martin, "A Protocol for Remotely
Managing Sieve Scripts", RFC 5804, DOI 10.17487/RFC5804,
July 2010, <https://www.rfc-editor.org/info/rfc5804>.
Appendix A. Change History (To be removed by RFC Editor before
publication)
Changes since ietf-13:
* Added implementation argument to capabilities.
* Miscellaneous editorial changes.
Changes since ietf-12:
* Added onSuccessDeactivateScipt argument to /set method.
* Clarified that the "isActive" property must be included in the
created/uodated/destroyed arguments in a response of the active
script is changed and/or deactivated.
* Miscellaneous editorial changes.
Changes since ietf-11:
* Fixed examples to be proper JSON and JMAP.
Changes since ietf-10:
* Fixed SieveScript/set response deactivating script example.
* Fixed line line nit in Blob/get request.
* Removed unused references.
Murchison Expires 1 October 2023 [Page 23]
Internet-Draft JMAP Sieve March 2023
Changes since ietf-09:
* Fixed Blob/upload request in example.
Changes since ietf-08:
* Fixed Blob/upload response in example.
* Removed SieveScript/test method (to be written as an extension
document).
Changes since ietf-07:
* Updated example to use Blob/upload rather than Blob/set.
Changes since ietf-06:
* None (refreshed to avoid expiration).
Changes since ietf-05:
* Converted source from xml2rfc v2 to v3.
* Added examples for SieveScript/get.
* Miscellaneous editorial changes.
Changes since ietf-04:
* SieveScript/test: Switched from using a JSON array for each
completed action and its args to a JSON object.
* Switched to referencing draft-ietf-jmap-blob.
* Miscellaneous editorial changes.
Changes since ietf-03:
* SieveScript/test: Moved positional arguments into their own array
(because the specfications don't use a consistent method for
defining the action syntax or naming of positional arguments).
Changes since ietf-02:
* Removed open issues.
* Reverted back to using only blob ids for script content.
Murchison Expires 1 October 2023 [Page 24]
Internet-Draft JMAP Sieve March 2023
* Added "rateLimit" and "requestTooLarge" to the list of possible
error codes for /set method.
* Added Compatibility with JMAP Vacation Response section.
* Added RFC5228 to Security Considerations.
* Miscellaneous editorial changes.
Changes since ietf-01:
* Removed normative references to ManageSieve (RFC 5804).
* Added the 'maxSizeScriptName' capability.
* Made the 'name' property in the SieveScript object optional.
* Added requirements for the 'name' property in the SieveScript
object.
* Removed the 'blobId' property from the SieveScript object.
* Removed the 'replaceOnCreate' argument from the /set method.
* Removed the 'blobId' argument from the /validate method.
* Removed the 'scriptBlobId' argument from, and added the
'scriptContent' argument to, the /test method.
* Editorial fixes from Neil Jenkins and Ricardo Signes.
* Other miscellaneous text reorganization and editorial fixes.
Changes since ietf-00:
* Specified that changes made by onSuccessActivateScript MUST be
reported in the /set response as created and/or updated as
appropriate.
* Reworked and specified more of the /test response based on
implementation experience.
Changes since murchison-01:
* Explicitly stated that Sieve capability strings are case-
sensitive.
* errorDescription is now String|null.
Murchison Expires 1 October 2023 [Page 25]
Internet-Draft JMAP Sieve March 2023
* Added /query method.
* Added /test method.
Changes since murchison-00:
* Added IANA registration for "scriptIsActive" JMAP error code.
* Added open issue about /set{create} with an existing script name.
Author's Address
Kenneth Murchison
Fastmail US LLC
1429 Walnut Street - Suite 1201
Philadelphia, PA 19102
United States of America
Email: murch@fastmailteam.com
Murchison Expires 1 October 2023 [Page 26]