The JSON Meta Application Protocol (JMAP) for Sieve ScriptsFastmail US LLC1429 Walnut Street, Suite 1201PhiladelphiaPA19102United States of Americamurch@fastmailteam.com
ART
jmapJMAPJSONSieveThis document specifies a data model for managing Sieve
scripts on a server using the JSON Meta Application Protocol
(JMAP).
Clients can use this protocol to efficiently search, access,
organize, and validate Sieve scripts.
Status of This Memo
This is an Internet Standards Track document.
This document is a product of the Internet Engineering Task Force
(IETF). It represents the consensus of the IETF community. It has
received public review and has been approved for publication by
the Internet Engineering Steering Group (IESG). Further
information on Internet Standards is available in Section 2 of
RFC 7841.
Information about the current status of this document, any
errata, and how to provide feedback on it may be obtained at
.
Copyright Notice
Copyright (c) 2024 IETF Trust and the persons identified as the
document authors. All rights reserved.
This document is subject to BCP 78 and the IETF Trust's Legal
Provisions Relating to IETF Documents
() 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
. Introduction
. Notational Conventions
. Addition to the Capabilities Object
. urn:ietf:params:jmap:sieve
. Example
. Sieve Scripts
. Sieve Script Properties
. Sieve Script Content
. SieveScript/get
. Examples
. SieveScript/set
. Examples
. SieveScript/query
. SieveScript/validate
. Quotas
. Compatibility with JMAP Vacation Response
. Security Considerations
. IANA Considerations
. JMAP Capability Registration for "sieve"
. JMAP Data Type Registration for "SieveScript"
. JMAP Error Codes Registry
. invalidSieve
. sieveIsActive
. References
. Normative References
. Informative References
Acknowledgments
Author's Address
IntroductionThe JSON Meta Application Protocol (JMAP)
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 it aims to
provide a consistent interface to different data types.
This specification defines a data model for managing
Sieve 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 as well as JMAP.
Notational ConventionsThe 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
.
This document also uses data types and terminology established
in Sections through of
.The term "SieveScript" (with this specific capitalization) is
used to refer to the data type defined in
and instances of this data type used throughout this document.
Servers MUST support all properties specified for the
data type defined in this document.For brevity, JMAP API examples
(see )
only show the "methodCalls" property of the "Request"
object and the "methodResponses" property of the "Response"
object.
All other examples are shown using the
HTTP/1.1 protocol.Addition to the Capabilities ObjectThe "capabilities" object is returned as part of the JMAP
Session object;
see .
This document defines one additional capability URI.
urn:ietf:params:jmap:sieveThe urn:ietf:params:jmap:sieve URI 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 per-account server capabilities:
maxSizeScriptName:
UnsignedInt
The maximum length, in 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 the Sieve "require" action; see
)
indicating the extensions supported by the Sieve engine.
notificationMethods:
String[]|null
A list of
URI scheme parts
for notification methods supported by the Sieve
"enotify" extension,
or null if the extension
is not supported by the Sieve engine.
externalLists:
String[]|null
A list of
URI scheme parts
for externally stored list types supported by the
Sieve "extlists" extension,
or null if the extension
is not supported by the Sieve engine.
Example
This example JMAP Session object shows a user that has access to their
own Sieve scripts with support for a few Sieve extensions:
{
"capabilities": {
"urn:ietf:params:jmap:core": {
...
},
"urn:ietf:params:jmap:mail": {},
"urn:ietf:params:jmap:quota": {},
"urn:ietf:params:jmap:blob": {},
"urn:ietf:params:jmap:sieve": {
"implementation": "ACME Email Filtering"
},
"urn:ietf:params:jmap:vacationresponse": {},
...
},
"accounts": {
"ken": {
"name": "ken@example.com",
"isPersonal": true,
"isReadOnly": false,
"accountCapabilities": {
"urn:ietf:params:jmap:core": {},
"urn:ietf:params:jmap:quota": {},
"urn:ietf:params:jmap:mail": {
...
},
"urn:ietf:params:jmap:blob": {
"supportedTypeNames": [
"Email"
"SieveScript",
...
],
...
},
"urn:ietf:params:jmap:sieve": {
"maxSizeScriptName": 512,
"maxSizeScript": 65536,
"maxNumberScripts": 5,
"maxNumberRedirects": null,
"sieveExtensions": [
"fileinto",
"imap4flags",
"enotify",
...
],
"notificationMethods": [
"mailto"
],
"externalLists": null,
},
"urn:ietf:params:jmap:vacationresponse": {},
...
},
...
}
},
"primaryAccounts": {
"urn:ietf:params:jmap:mail": "ken",
"urn:ietf:params:jmap:sieve": "ken",
"urn:ietf:params:jmap:vacationresponse": "ken",
...
},
"username": "ken@example.com",
"apiUrl": "/jmap/",
"downloadUrl":
"/jmap/download/{accountId}/{blobId}/{name}?accept={type}",
"uploadUrl": "/jmap/upload/{accountId}/",
...
}
Sieve ScriptsA "SieveScript" object represents
a single Sieve script for
filtering email messages at the time of final delivery.
Sieve Script PropertiesA "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 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 any of the following Unicode characters:
U+0000-U+001F, U+007F-U+009F, U+2028, or U+2029.
Servers MAY reject names that violate server policy
(e.g., names containing a 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.
isActive:
Boolean
(server-set; default: false)
Indicator that the SieveScript is actively filtering
incoming messages.
A user may have at most one active script.
The SieveScript/set method is
used for changing the active script or disabling Sieve
processing.
Sieve Script ContentA script MUST be UTF-8 content
of at least 1 character in length, subject to the
syntax of Sieve.
A script MUST NOT contain any "require" statement(s)
mentioning Sieve capability strings not present in the
"capability" object.
Note that if the Sieve "ihave" capability string
is present in the "capability" object,
the script MAY mention unrecognized/unsupported extensions
in the "ihave" test.
Script content is treated as a binary blob and
uploaded/downloaded via the mechanisms provided in
Sections and of ,
respectively, and/or via the JMAP Blob management methods provided in
Sections and of ,
respectively.
Downloading script content via the JMAP downloadUrl or the
Blob/get method provides functionality equivalent to that of the
GETSCRIPT command defined in .
SieveScript/getThis is a standard "/get" method as described in
.
The "ids" argument may be
null to fetch all scripts at once.
This method provides functionality equivalent to that of the
LISTSCRIPTS command defined in .
Examples
List all scripts:
[
["SieveScript/get", {
"accountId": "ken"
}, "0"]
]
[
[
"SieveScript/get",
{
"state": "1634915373.240633104-120",
"list": [
{
"id": "2d647053-dded-418d-917a-63eda3ac8f7b",
"name": "test1",
"isActive": true,
"blobId": "S7"
}
],
"notFound": [],
"accountId": "ken"
},
"0"
]
]
Download the script content via
the JMAP downloadUrl as advertised in the example in :
GET /jmap/download/ken/S7/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";
Fetch script properties
and content in a single JMAP API request using the
JMAP Blob management extension:
[
["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"]
]
[
[
"SieveScript/get",
{
"state": "1634915373.240633104-120",
"list": [
{
"id": "2d647053-dded-418d-917a-63eda3ac8f7b",
"name": "test1",
"isActive": true,
"blobId": "S7"
}
],
"notFound": [],
"accountId": "ken"
},
"0"
],
[
"Blob/get",
{
"list": [
{
"id": "S7",
"data:asText":
"require [\"fileinto\"];\\r\\nfileinto \"INBOX.target\";\\r\\n",
"size": 49
}
],
"notFound": [],
"accountId": "ken"
},
"1"
]
]
SieveScript/setThis is a standard "/set" method as described in
,
but with the following additional optional request arguments:
onSuccessActivateScript:
Id
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 omitted, or if the id is either invalid 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 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
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" or omitted, 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 functionality equivalent to that of the
PUTSCRIPT, DELETESCRIPT, RENAMESCRIPT, and SETACTIVE commands defined
in .
Script content must first be uploaded as per
prior to referencing it in a
SieveScript/set call.If the SieveScript cannot 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 cannot be created or updated because
its size exceeds the "maxSizeScript" limit, the server MUST
reject the request with a "tooLarge" SetError.If the SieveScript cannot be created because it would
exceed the "maxNumberScripts" limit or would exceed a
server-imposed storage 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":
invalidSieve:
The SieveScript content violates the
Sieve 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":
sieveIsActive:
The SieveScript is active.
Examples
Upload a script
requiring the Imap4Flags Extension
using the JMAP uploadUrl as advertised in the example in
:
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
}
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.
[
["SieveScript/set", {
"accountId": "ken",
"create": {
"A": {
"name": null,
"blobId": "Gabcc83e44a6e19991c4568d0b94e1767c83dd123"
}
},
"onSuccessActivateScript": "#A"
}, "0"]
]
[
[
"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"
]
]
Update the script content using
the JMAP Blob management extension:
{
[
["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"]
]
[
[
"Blob/upload",
{
"oldState": null,
"newState": "1603741700.309607123-0128",
"created": {
"B": {
"id": "G969c83e44a6e10871c4568d0b94e1767c83ddeae",
"blobId": "G969c83e44a6e10871c4568d0b94e1767c83ddeae",
"type": "application/sieve",
"size": 29
}
},
"notCreated": null,
"accountId": "ken"
},
"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"
]
]
Update the script name, and deactivate it:
[
["SieveScript/set", {
"accountId": "ken",
"update": { "dd1b164f-8cdc-448c-9f54": {
"name": "myscript"
}
},
"onSuccessDeactivateScript": true
}, "3"]
]
[
[
"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"
]
]
Reactivate the script:
[
["SieveScript/set", {
"accountId": "ken",
"onSuccessActivateScript": "dd1b164f-8cdc-448c-9f54"
}, "4"]
]
[
[
"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"
]
]
Deactivate and destroy the active script:
[
["SieveScript/set", {
"accountId": "ken",
"onSuccessDeactivateScript": true
}, "5"],
["SieveScript/set", {
"accountId": "ken",
"destroy": [ "dd1b164f-8cdc-448c-9f54" ]
}, "6"]
]
[
[
"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"
]
]
SieveScript/queryThis is a standard "/query" method as described in
.
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
SieveScript/validateThis method is used by the client to verify Sieve script
validity without storing the script on the server.
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
.
The response has the following arguments:
accountId:
Id
The id of the account used for this call.
error:
SetError|null
An "invalidSieve" SetError object if the script content
is invalid (see ),
or null if the
script content is valid.
This method provides functionality equivalent to that of the
CHECKSCRIPT command defined in .Script content must first be uploaded as per
prior to referencing it in a
SieveScript/validate call.QuotasServers SHOULD impose quotas on Sieve scripts to prevent
malicious users from exceeding available storage.
Administration of such quotas is outside of the scope of this
specification; however, defines a data
model for users to obtain quota details over JMAP.The mechanism for handling SieveScript requests that would place
a user over a quota setting is discussed in .
Compatibility with JMAP Vacation Response defines a
"VacationResponse" object to represent an autoresponder to
incoming email messages.
Servers that implement the VacationResponse as a Sieve script
that resides among other user scripts are subject to the
following requirements:
MUST allow the VacationResponse Sieve script to be fetched
by the SieveScript/get method.
MUST allow the VacationResponse Sieve script to be
activated or deactivated via the "onSuccessActivateScript" argument to
the SieveScript/set method.
MUST NOT allow the VacationResponse Sieve script to be
destroyed or have its content updated by the
SieveScript/set 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.
Security ConsiderationsAll security considerations discussed in
JMAP
and Sieve
apply to this specification.Additionally, implementations MUST treat Sieve script content
as untrusted data. As such, script parsers MUST fail gracefully
in the face of syntactically invalid or malicious content and
MUST be prepared to deal with resource exhaustion (e.g.,
allocation of enormous strings, lists, or command blocks).
IANA ConsiderationsJMAP Capability Registration for "sieve"IANA has registered "sieve" in the "JMAP Capabilities" registry as follows:
Capability Name:
urn:ietf:params:jmap:sieve
Reference:
RFC 9661
Intended Use:
common
Change Controller:
IETF
Security and Privacy Considerations:
RFC 9661,
JMAP Data Type Registration for "SieveScript"IANA has registered "SieveScript" in the "JMAP Data Types" registry as follows:
Type Name:
SieveScript
Can Reference Blobs:
Yes
Can Use for State Change:
Yes
Capability:
urn:ietf:params:jmap:sieve
Reference:
RFC 9661
JMAP Error Codes Registry
IANA has registered the following two new error codes in the
"JMAP Error Codes" registry, as defined in
.
invalidSieve
JMAP Error Code:
invalidSieve
Intended Use:
common
Change Controller:
IETF
Reference:
RFC 9661,
Description:
The SieveScript violates the
Sieve grammar, and/or one
or more extensions mentioned in the script's "require"
statement(s) are not supported by the Sieve interpreter.
sieveIsActive
JMAP Error Code:
sieveIsActive
Intended Use:
common
Change Controller:
IETF
Reference:
RFC 9661,
Description:
The client tried to destroy the active
SieveScript.
ReferencesNormative ReferencesKey words for use in RFCs to Indicate Requirement LevelsIn many standards track documents several words are used to signify the requirements in the specification. These words are often capitalized. This document defines these words as they should be interpreted in IETF documents. This document specifies an Internet Best Current Practices for the Internet Community, and requests discussion and suggestions for improvements.UTF-8, a transformation format of ISO 10646ISO/IEC 10646-1 defines a large character set called the Universal Character Set (UCS) which encompasses most of the world's writing systems. The originally proposed encodings of the UCS, however, were not compatible with many current applications and protocols, and this has led to the development of UTF-8, the object of this memo. UTF-8 has the characteristic of preserving the full US-ASCII range, providing compatibility with file systems, parsers and other software that rely on US-ASCII values but are transparent to other values. This memo obsoletes and replaces RFC 2279.Uniform Resource Identifier (URI): Generic SyntaxA Uniform Resource Identifier (URI) is a compact sequence of characters that identifies an abstract or physical resource. This specification defines the generic URI syntax and a process for resolving URI references that might be in relative form, along with guidelines and security considerations for the use of URIs on the Internet. The URI syntax defines a grammar that is a superset of all valid URIs, allowing an implementation to parse the common components of a URI reference without knowing the scheme-specific requirements of every possible identifier. This specification does not define a generative grammar for URIs; that task is performed by the individual specifications of each URI scheme. [STANDARDS-TRACK]Unicode Format for Network InterchangeThe Internet today is in need of a standardized form for the transmission of internationalized "text" information, paralleling the specifications for the use of ASCII that date from the early days of the ARPANET. This document specifies that format, using UTF-8 with normalization and specific line-ending sequences. [STANDARDS-TRACK]Sieve: An Email Filtering LanguageThis document describes a language for filtering email messages at time of final delivery. It is designed to be implementable on either a mail client or mail server. It is meant to be extensible, simple, and independent of access protocol, mail architecture, and operating system. It is suitable for running on a mail server where users may not be allowed to execute arbitrary programs, such as on black box Internet Message Access Protocol (IMAP) servers, as the base language has no variables, loops, or ability to shell out to external programs. [STANDARDS-TRACK]Sieve Email Filtering: Extension for NotificationsUsers go to great lengths to be notified as quickly as possible that they have received new mail. Most of these methods involve polling to check for new messages periodically. A push method handled by the final delivery agent gives users quicker notifications and saves server resources. This document does not specify the notification method, but it is expected that using existing instant messaging infrastructure such as Extensible Messaging and Presence Protocol (XMPP), or Global System for Mobile Communications (GSM) Short Message Service (SMS) messages will be popular. This document describes an extension to the Sieve mail filtering language that allows users to give specific rules for how and when notifications should be sent. [STANDARDS-TRACK]Sieve Extension: Externally Stored ListsThe Sieve email filtering language can be used to implement email whitelisting, blacklisting, personal distribution lists, and other sorts of list matching. Currently, this requires that all members of such lists be hard-coded in the script itself. Whenever a member of a list is added or deleted, the script needs to be updated and possibly uploaded to a mail server.This document defines a Sieve extension for accessing externally stored lists -- lists whose members are stored externally to the script, such as using the Lightweight Directory Access Protocol (LDAP), the Application Configuration Access Protocol (ACAP), vCard Extensions to WebDAV (CardDAV), or relational databases. [STANDARDS-TRACK]Ambiguity of Uppercase vs Lowercase in RFC 2119 Key WordsRFC 2119 specifies common key words that may be used in protocol specifications. This document aims to reduce the ambiguity by clarifying that only UPPERCASE usage of the key words have the defined special meanings.The JSON Meta Application Protocol (JMAP)This document specifies a protocol for clients to efficiently query, fetch, and modify JSON-based data objects, with support for push notification of changes and fast resynchronisation and for out-of- band binary data upload/download.The JSON Meta Application Protocol (JMAP) for MailThis document specifies a data model for synchronising email data with a server using the JSON Meta Application Protocol (JMAP). Clients can use this to efficiently search, access, organise, and send messages, and to get push notifications for fast resynchronisation when new messages are delivered or a change is made in another client.Informative ReferencesSieve Email Filtering: Imap4flags ExtensionRecent discussions have shown that it is desirable to set different IMAP (RFC 3501) flags on message delivery. This can be done, for example, by a Sieve interpreter that works as a part of a Mail Delivery Agent.This document describes an extension to the Sieve mail filtering language for setting IMAP flags. The extension allows setting of both IMAP system flags and IMAP keywords. [STANDARDS-TRACK]Sieve Email Filtering: Ihave ExtensionThis document describes the "ihave" extension to the Sieve email filtering language. The "ihave" extension provides a means to write scripts that can take advantage of optional Sieve features but can still run when those optional features are not available. The extension also defines a new error control command intended to be used to report situations where no combination of available extensions satisfies the needs of the script. [STANDARDS-TRACK]A Protocol for Remotely Managing Sieve ScriptsSieve scripts allow users to filter incoming email. Message stores are commonly sealed servers so users cannot log into them, yet users must be able to update their scripts on them. This document describes a protocol "ManageSieve" for securely managing Sieve scripts on a remote server. This protocol allows a user to have multiple scripts, and also alerts a user to syntactically flawed scripts. [STANDARDS TRACK]HTTP/1.1The Hypertext Transfer Protocol (HTTP) is a stateless application-level protocol for distributed, collaborative, hypertext information systems. This document specifies the HTTP/1.1 message syntax, message parsing, connection management, and related security concerns.This document obsoletes portions of RFC 7230.JSON Meta Application Protocol (JMAP) Blob Management ExtensionThe JSON Meta Application Protocol (JMAP) base protocol (RFC 8620) provides the ability to upload and download arbitrary binary data via HTTP POST and GET on a defined endpoint. This binary data is called a "blob".This extension adds additional ways to create and access blobs by making inline method calls within a standard JMAP request.This extension also adds a reverse lookup mechanism to discover where blobs are referenced within other data types.JSON Meta Application Protocol (JMAP) for QuotasThis document specifies a data model for handling quotas on accounts with a server using the JSON Meta Application Protocol (JMAP).AcknowledgmentsThe concepts in this document are based largely on those in
.
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: , ,
, , , and .Author's AddressFastmail US LLC1429 Walnut Street, Suite 1201PhiladelphiaPA19102United States of Americamurch@fastmailteam.com