Internet Engineering Task Force (IETF)                      K. Murchison
Request for Comments: 9661                                      Fastmail
Category: Standards Track                                 September 2024
ISSN: 2070-1721
        
The JSON Meta Application Protocol (JMAP) for Sieve Scripts
Sieveスクリプト用のJSONメタアプリケーションプロトコル(JMAP)
Abstract
概要

This 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.

このドキュメントは、JSON Metaアプリケーションプロトコル(JMAP)を使用してサーバー上で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.

このドキュメントは、インターネットエンジニアリングタスクフォース(IETF)の製品です。IETFコミュニティのコンセンサスを表しています。公開レビューを受けており、インターネットエンジニアリングステアリンググループ(IESG)からの出版が承認されています。インターネット標準の詳細については、RFC 7841のセクション2で入手できます。

Information about the current status of this document, any errata, and how to provide feedback on it may be obtained at https://www.rfc-editor.org/info/rfc9661.

このドキュメントの現在のステータス、任意のERRATA、およびそれに関するフィードバックを提供する方法に関する情報は、https://www.rfc-editor.org/info/rfc9661で取得できます。

著作権表示

Copyright (c) 2024 IETF Trust and the persons identified as the document authors. All rights reserved.

著作権(c)2024 IETF Trustおよび文書著者として特定された人。無断転載を禁じます。

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.

このドキュメントは、BCP 78およびIETFドキュメント(https://trustee.ietf.org/license-info)に関連するIETF Trustの法的規定の対象となります。この文書に関するあなたの権利と制限を説明するので、これらの文書を注意深く確認してください。このドキュメントから抽出されたコードコンポーネントには、セクション4.Eで説明されている法的規定のセクション4.Eで説明されており、改訂されたBSDライセンスで説明されている保証なしで提供されるように、改訂されたBSDライセンステキストを含める必要があります。

Table of Contents
目次
   1.  Introduction
     1.1.  Notational Conventions
     1.2.  Addition to the Capabilities Object
       1.2.1.  urn:ietf:params:jmap:sieve
       1.2.2.  Example
   2.  Sieve Scripts
     2.1.  Sieve Script Properties
     2.2.  Sieve Script Content
     2.3.  SieveScript/get
       2.3.1.  Examples
     2.4.  SieveScript/set
       2.4.1.  Examples
     2.5.  SieveScript/query
     2.6.  SieveScript/validate
   3.  Quotas
   4.  Compatibility with JMAP Vacation Response
   5.  Security Considerations
   6.  IANA Considerations
     6.1.  JMAP Capability Registration for "sieve"
     6.2.  JMAP Data Type Registration for "SieveScript"
     6.3.  JMAP Error Codes Registry
       6.3.1.  invalidSieve
       6.3.2.  sieveIsActive
   7.  References
     7.1.  Normative References
     7.2.  Informative References
   Acknowledgments
   Author's Address
        
1. Introduction
1. はじめに

The JSON Meta Application Protocol (JMAP) [RFC8620] 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.

JSON Meta Application Protocol(JMAP)[RFC8620]は、クライアントとサーバー間のメール、カレンダー、連絡先などのデータを同期するための一般的なプロトコルです。モバイル環境とWeb環境に最適化されており、さまざまなデータ型に一貫したインターフェイスを提供することを目的としています。

This specification defines a data model for managing Sieve scripts [RFC5228] 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.

この仕様では、JMAPを使用してサーバーでSieve Scripts [RFC5228]を管理するためのデータモデルを定義します。データモデルは、ManageSieve [RFC5804]およびJMAPを介して同じスクリプトへの一貫したアクセスを提供できるように設計されています。

1.1. Notational Conventions
1.1. 表記規則

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.

「必須」、「必要」、「必須」、「shall」、「shall」、「suff」、 "not"、 "becommended"、 "becommented"、 "may"、 "optional「このドキュメントでは、BCP 14 [RFC2119] [RFC8174]で説明されているように解釈されます。

Type signatures, examples, and property descriptions in this document follow the conventions established in Section 1.1 of [RFC8620]. This document also uses data types and terminology established in Sections 1.2 through 1.6 of [RFC8620].

このドキュメントのタイプシグネチャ、例、およびプロパティの説明は、[RFC8620]のセクション1.1で確立された規則に従っています。このドキュメントでは、[RFC8620]のセクション1.2〜1.6で確立されたデータ型と用語も使用しています。

The term "SieveScript" (with this specific capitalization) is used to refer to the data type defined in Section 2 and instances of this data type used throughout this document. Servers MUST support all properties specified for the data type defined in this document.

「Sievescript」という用語(この特定の大文字を使用)は、セクション2で定義されているデータ型と、このドキュメント全体で使用されるこのデータ型のインスタンスを参照するために使用されます。サーバーは、このドキュメントで定義されているデータ型に指定されたすべてのプロパティをサポートする必要があります。

For brevity, JMAP API examples (see Section 3 of [RFC8620]) 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 [RFC9112].

簡潔にするために、JMAP APIの例([RFC8620]のセクション3を参照)は、「リクエスト」オブジェクトの「メソッドコール」プロパティと「応答」オブジェクトの「MethodSponses」プロパティのみを表示します。他のすべての例は、HTTP/1.1プロトコル[RFC9112]を使用して示されています。

1.2. Addition to the Capabilities Object
1.2. 機能オブジェクトに加えます

The "capabilities" object is returned as part of the JMAP Session object; see [RFC8620], Section 2. This document defines one additional capability URI.

「機能」オブジェクトは、JMAPセッションオブジェクトの一部として返されます。[RFC8620]、セクション2を参照してください。このドキュメントでは、1つの追加機能URIを定義しています。

1.2.1. urn:ietf:params:jmap:sieve
1.2.1. urn:ietf:params:jmap:sive

The 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:

urn:ietf:params:jmap:sive uriは、Sievescriptデータ型と関連するAPIメソッドのサポートを表します。JMAPセッション「機能」プロパティのこのプロパティの値は、サーバー機能に関する次の情報を含める必要があるオブジェクトです。

*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:

アカウントの「accountcapability」プロパティ内のこのプロパティの値は、会計1つのサーバー機能に関する次の情報を含める必要があるオブジェクトです。

*maxSizeScriptName*:

*maxsizeScriptName*:

UnsignedInt

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).

オクテットの最大長は、Sievescriptの名前を許可します。ManageSieveとの互換性のために、これは少なくとも512(最大128のUnicode文字)でなければなりません。

*maxSizeScript*:

*MaxSizeScript*:

UnsignedInt|null

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*:

*maxnumberscripts*:

UnsignedInt|null

unsignedint | null

The maximum number of Sieve scripts the server is willing to store for the user, or null for no limit.

サーバーがユーザーのために保存する意思がある、または制限なしでnullの最大数のふるいスクリプト。

*maxNumberRedirects*:

*maxnumberredirects*:

UnsignedInt|null

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.

スクリプトが単一の評価中に実行できる「リダイレクト」アクションの最大数の「リダイレクト」アクション、または制限なしでnull。これは、スクリプトに含めることができる「リダイレクト」アクションの総数とは異なることに注意してください。

*sieveExtensions*:

*SieveExtensions*:

String[]

弦[]

A list of case-sensitive Sieve capability strings (as listed in the Sieve "require" action; see [RFC5228], Section 3.2) indicating the extensions supported by the Sieve engine.

シーブエンジンがサポートする拡張機能を示す、症例に敏感なふるい能力文字列のリスト(Sieveが「必要」アクションを必要とする。[RFC5228]、セクション3.2を参照)。

*notificationMethods*:

*NotificationMethods*:

String[]|null

string [] | null

A list of URI scheme parts [RFC3986] for notification methods supported by the Sieve "enotify" extension [RFC5435], or null if the extension is not supported by the Sieve engine.

ふるい「Enotify」拡張[RFC5435]によってサポートされる通知方法のためのURIスキームパーツ[RFC3986]のリスト、または拡張がふるいエンジンによってサポートされていない場合はnull。

*externalLists*:

*externAllists*:

String[]|null

string [] | null

A list of URI scheme parts [RFC3986] for externally stored list types supported by the Sieve "extlists" extension [RFC6134], or null if the extension is not supported by the Sieve engine.

Sieveの「Extlist」拡張[RFC6134]でサポートされている外部から保存されたリストタイプのURIスキームパーツ[RFC3986]のリスト、または拡張がシーブエンジンによってサポートされていない場合はnull。

1.2.2. Example
1.2.2. 例

This example JMAP Session object shows a user that has access to their own Sieve scripts with support for a few Sieve extensions:

この例JMAPセッションオブジェクトは、いくつかのふるい拡張機能をサポートして、自分のふるいスクリプトにアクセスできるユーザーを示しています。

   {
     "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}/",
     ...
   }
        
2. Sieve Scripts
2. ふるいスクリプト

A "SieveScript" object represents a single Sieve script [RFC5228] for filtering email messages at the time of final delivery.

「Sievescript」オブジェクトは、最終配信時に電子メールメッセージをフィルタリングするための単一のふるいスクリプト[RFC5228]を表します。

2.1. Sieve Script Properties
2.1. ふるいスクリプトプロパティ

A "SieveScript" object has the following properties:

「Sievescript」オブジェクトには次のプロパティがあります。

*id*:

*ID*:

Id (immutable; server-set)

ID(不変;サーバーセット)

The id of the script.

スクリプトのID。

*name*:

*名前*:

String|null (optional; default is server dependent)

文字列| null(オプション;デフォルトはサーバー依存)

User-visible name for the SieveScript. If non-null, this MUST be a Net-Unicode string [RFC5198] of at least 1 character in length, subject to the maximum size given in the "capability" object.

Sievescriptのユーザー可視名。非ヌルの場合、これは少なくとも1文字が長さ1文字のネットユニコード文字列[RFC5198]でなければなりません。

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.

ManageSieveとの互換性のために、サーバーは次のUnicode文字のいずれかを含む名前を拒否する必要があります:u+0000-U+001F、U+007F-U+009F、U+2028、または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.

名前は、アカウント内のすべてのSievescriptの中で一意でなければなりません。

*blobId*:

*blobid*:

Id

id

The id of the blob containing the raw octets of the script.

スクリプトの生のオクテットを含むブロブのID。

*isActive*:

*Isactive*:

Boolean (server-set; default: false)

boolean(サーバーセット;デフォルト:false)

Indicator that the SieveScript is actively filtering incoming messages.

Sievescriptが着信メッセージを積極的にフィルタリングしていることを示す指標。

A user may have at most one active script. The SieveScript/set method (Section 2.4) is used for changing the active script or disabling Sieve processing.

ユーザーは、せいぜい1つのアクティブなスクリプトを持っている場合があります。Sievescript/SETメソッド(セクション2.4)は、アクティブなスクリプトを変更したり、ふるい処理を無効にしたりするために使用されます。

2.2. Sieve Script Content
2.2. ふるいスクリプトコンテンツ

A script MUST be UTF-8 content [RFC3629] of at least 1 character in length, subject to the syntax of Sieve [RFC5228]. A script MUST NOT contain any "require" statement(s) mentioning Sieve capability strings not present in the "capability" object (Section 1.2.1). Note that if the Sieve "ihave" capability string [RFC5463] is present in the "capability" object, the script MAY mention unrecognized/ unsupported extensions in the "ihave" test.

スクリプトは、Sieve [RFC5228]の構文に従って、少なくとも1文字の長さが1文字のUTF-8コンテンツ[RFC3629]でなければなりません。スクリプトには、「機能」オブジェクトに存在しないふるい能力文字列に言及する「要求」ステートメントを含めてはなりません(セクション1.2.1)。Sieve "ihave"機能文字列[rfc5463]が「能力」オブジェクトに存在する場合、スクリプトは「ihave」テストで認識されていない/サポートされていない拡張機能に言及する場合があることに注意してください。

Script content is treated as a binary blob and uploaded/downloaded via the mechanisms provided in Sections 6.1 and 6.2 of [RFC8620], respectively, and/or via the JMAP Blob management methods provided in Sections 4.1 and 4.2 of [RFC9404], respectively.

スクリプトコンテンツはバイナリBLOBとして扱われ、それぞれ[RFC8620]のセクション6.1および6.2に記載されているメカニズムを介してアップロード/ダウンロードされます。

Downloading script content via the JMAP downloadUrl or the Blob/get method provides functionality equivalent to that of the GETSCRIPT command defined in [RFC5804].

JMAP downloadurlまたはblob/getメソッドを介してスクリプトコンテンツをダウンロードすると、[rfc5804]で定義されたgetScriptコマンドの機能と同等の機能が提供されます。

2.3. SieveScript/get
2.3. sievescript/get

This is a standard "/get" method as described in [RFC8620], Section 5.1. The "ids" argument may be null to fetch all scripts at once.

これは、[RFC8620]、セクション5.1で説明されている標準「/get」メソッドです。「IDS」引数は、すべてのスクリプトを一度に取得するためにnullである場合があります。

This method provides functionality equivalent to that of the LISTSCRIPTS command defined in [RFC5804].

この方法は、[RFC5804]で定義されているListScriptsコマンドの機能に相当する機能を提供します。

2.3.1. Examples
2.3.1. 例

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 Section 1.2.2:

セクション1.2.2の例で宣伝されているように、JMAP downloadurlを介してスクリプトコンテンツをダウンロードします。

   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 [RFC9404]:

JMAP BLOB管理拡張機能[RFC9404]を使用して、単一のJMAP API要求にスクリプトプロパティとコンテンツを取得します:

   [
     ["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"
     ]
   ]
        
2.4. SieveScript/set
2.4. Sievescript/set

This is a standard "/set" method as described in [RFC8620], Section 5.3, but with the following additional optional request arguments:

これは、[RFC8620]、セクション5.3で説明されている標準の「/セット」メソッドですが、次の追加のオプションリクエスト引数があります。

*onSuccessActivateScript*:

*onsuccessactivatescript*:

Id

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.

SievescriptのIDは、すべての作成、変更、破壊(ある場合)が成功した場合にのみアクティブにします。(Sievescript Creationsへの参照の場合、これは作成の参照に相当するため、IDは「#」が付いた作成IDになります。)現在アクティブなSIEVEScript(もしあれば)は、指定された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.

省略された場合、またはIDが無効または存在しない場合は無視する必要があり、現在アクティブなSievescript(もしあれば)がそのように残ります。

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.

アクティブ化されたSievescriptのIDは、「Isactive」プロパティの「True」の値を含む、必要に応じて「作成」または「更新された」引数のいずれかで報告する必要があります。非アクティブ化されたSievescriptのIDは、「Isactive」プロパティの「false」の値を含む、応答の「更新された」引数で報告する必要があります。

*onSuccessDeactivateScript*:

*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.

「真」の場合、すべての作品、修正、破壊(もしあれば)が成功した場合にのみ、現在アクティブなSievescript(もしあれば)は無効になります。「false」または省略された場合、現在アクティブなSievescript(もしあれば)がそのように残ります。

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.

非アクティブ化されたSievescriptのIDは、「Isactive」プロパティの「false」の値を含む、応答の「更新された」引数で報告する必要があります。

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.

「onsuccessactivatescript」と「onsuccessdectivatescript」の両方の引数がリクエストに存在する場合、「onsuccessdeactivatescript」を最初に処理する必要があります。どちらの引数がリクエストに存在しない場合、現在アクティブなSievescript(もしあれば)がそのように残ります。

This method provides functionality equivalent to that of the PUTSCRIPT, DELETESCRIPT, RENAMESCRIPT, and SETACTIVE commands defined in [RFC5804].

この方法は、[RFC5804]で定義されているPutScript、Deletescript、Renamescript、およびSetactiveコマンドの機能に相当する機能を提供します。

Script content must first be uploaded as per Section 2.2 prior to referencing it in a SieveScript/set call.

Sievescript/Set Callで参照する前に、スクリプトコンテンツをセクション2.2に従ってアップロードする必要があります。

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.

Sievescriptを作成または更新できない場合、同じ名前の2つのSievescriptが発生するため、サーバーは「既に除外」のセットナーでリクエストを拒否する必要があります。既存のSievescriptのIDを使用して、Type "ID"の「既存の」プロパティをSetErrorオブジェクトに含める必要があります。

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.

Sievescriptを作成または更新できない場合、そのサイズが「maxsizescript」制限を超えているため、サーバーは「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.

Sievescriptを作成できない場合、「MaxNumberscripts」制限を超えるか、サーバーが課したストレージ制限を超える場合、サーバーは「Overquota」Seterrorでリクエストを拒否する必要があります。

The active SieveScript MUST NOT be destroyed unless it is first deactivated in a separate SieveScript/set method call.

Active Sievescriptは、別のSievescript/SETメソッド呼び出しで最初に非アクティブ化されない限り、破壊しないでください。

The following extra SetError types are defined:

次の追加セットエラータイプが定義されています。

For "create" and "update":

「作成」と「更新」の場合:

*invalidSieve*:

*InvalidSieve*:

The SieveScript content 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. The "description" property on the SetError object SHOULD contain a specific error message giving at least the line number of the first error.

Sievescriptコンテンツは、Sieve Grammar [RFC5228]に違反しており、スクリプトの「要求」ステートメントに記載されている1つ以上の拡張機能は、ふるいインタープリターによってサポートされていません。SetErrorオブジェクトの「説明」プロパティには、少なくとも最初のエラーの行番号を与える特定のエラーメッセージを含める必要があります。

For "destroy":

「破壊」のために:

*sieveIsActive*:

*Siveisactive*:

The SieveScript is active.

Sievescriptがアクティブです。

2.4.1. Examples
2.4.1. 例

Upload a script requiring the Imap4Flags Extension [RFC5232] using the JMAP uploadUrl as advertised in the example in Section 1.2.2:

セクション1.2.2の例で宣伝されているJMAP uploadurlを使用して、IMAP4FLAGS拡張機能[RFC5232]を使用するスクリプトをアップロードします。

   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 [RFC9404]:

JMAP BLOB管理拡張機能[RFC9404]を使用してスクリプトコンテンツを更新します。

   {
   [
     ["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"
     ]
   ]
        
2.5. SieveScript/query
2.5. 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:

これは、[RFC8620]、セクション5.5で説明されている標準「/クエリ」メソッドです。「filtercondition」オブジェクトには、次のプロパティがあります。どちらも省略できます。

*name*:

*名前*:

String

The SieveScript "name" property contains the given string.

Sievescriptの「名前」プロパティには、指定された文字列が含まれています。

*isActive*:

*Isactive*:

Boolean

ブールブーリアン

The "isActive" property of the SieveScript must be identical to the value given to match the condition.

Sievescriptの「ISACTIVE」プロパティは、条件に合うように与えられた値と同一でなければなりません。

The following SieveScript properties MUST be supported for sorting:

ソートのために、次のSievescriptプロパティをサポートする必要があります。

* *name*

* *名前*

* *isActive*

* *isactive*

2.6. SieveScript/validate
2.6. Sievescript/validate

This 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*:

*accountid*:

Id

id

The id of the account to use.

使用するアカウントのID。

*blobId*:

*blobid*:

Id

id

The id of the blob containing the raw octets of the script to validate, subject to the same requirements in Section 2.2.

セクション2.2の同じ要件を条件として、検証するスクリプトの生のオクテットを含むBLOBのID。

The response has the following arguments:

応答には次の引数があります。

*accountId*:

*accountid*:

Id

id

The id of the account used for this call.

この呼び出しに使用されたアカウントのID。

*error*:

*エラー*:

SetError|null

SetError | null

An "invalidSieve" SetError object if the script content is invalid (see Section 2.4), or null if the script content is valid.

スクリプトコンテンツが無効な場合(セクション2.4を参照)、またはスクリプトコンテンツが有効な場合はnullの「無効」SetErrorオブジェクト。

This method provides functionality equivalent to that of the CHECKSCRIPT command defined in [RFC5804].

この方法は、[RFC5804]で定義されているチェックスクリプトコマンドの機能に相当する機能を提供します。

Script content must first be uploaded as per Section 2.2 prior to referencing it in a SieveScript/validate call.

Sievescript/Validate Callで参照する前に、スクリプトコンテンツをセクション2.2に従ってアップロードする必要があります。

3. Quotas
3. 割り当て

Servers 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, [RFC9425] defines a data model for users to obtain quota details over JMAP.

サーバーは、悪意のあるユーザーが利用可能なストレージを超えることを防ぐために、Sieve Scriptsに割り当てを課す必要があります。このようなクォータの管理は、この仕様の範囲外です。ただし、[RFC9425]は、JMAPでクォータの詳細を取得するためのユーザーのデータモデルを定義します。

The mechanism for handling SieveScript requests that would place a user over a quota setting is discussed in Section 2.4.

ユーザーをクォータ設定に配置するSievescriptリクエストを処理するメカニズムについては、セクション2.4で説明します。

4. Compatibility with JMAP Vacation Response
4. JMAP休暇対応との互換性

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 among other user scripts are subject to the following requirements:

[RFC8621]のセクション8では、「VacationResponse」オブジェクトを定義して、着信電子メールメッセージの自動応答を表します。他のユーザースクリプトの間に存在するふるいスクリプトとしてvacaceResponseを実装するサーバーには、次の要件の対象となります。

* MUST allow the VacationResponse Sieve script to be fetched by the SieveScript/get method (Section 2.3).

* VacateResponse Sieve ScriptをSievescript/Get Method(セクション2.3)によってフェッチすることを許可する必要があります。

* MUST allow the VacationResponse Sieve script to be activated or deactivated via the "onSuccessActivateScript" argument to the SieveScript/set method (Section 2.4).

* sievescript/setメソッド(セクション2.4)に対する「onsuccessactivatescript」引数を介して、VacateResponse Sieve Siveスクリプトをアクティブ化または非アクティブ化する必要があります。

* MUST NOT allow the VacationResponse Sieve script to be destroyed or have its content updated by the SieveScript/set method (Section 2.4). 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.

* VacateResponse Sieve Scriptを破壊したり、Sievescript/Setメソッド(セクション2.4)によってコンテンツを更新したりすることを許可してはなりません。そのような要求は、「禁止された」セットナーで拒否されなければなりません。「説明」プロパティには、ScriptがVacationResponse/Setメソッドによってのみ変更できるという説明が存在する場合があります。

5. Security Considerations
5. セキュリティに関する考慮事項

All security considerations discussed in JMAP [RFC8620] and Sieve [RFC5228] apply to this specification.

JMAP [RFC8620]およびSIVE [RFC5228]で説明されているすべてのセキュリティ上の考慮事項は、この仕様に適用されます。

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).

さらに、実装は、ふるいスクリプトのコンテンツを信頼されていないデータとして扱う必要があります。そのため、スクリプトパーサーは、構文的に無効または悪意のあるコンテンツに直面して優雅に失敗する必要があり、リソースの疲労(例えば、巨大な文字列、リスト、またはコマンドブロックの割り当て)に対処する準備をする必要があります。

6. IANA Considerations
6. IANAの考慮事項
6.1. JMAP Capability Registration for "sieve"
6.1. 「ふるい」のJMAP機能登録

IANA has registered "sieve" in the "JMAP Capabilities" registry as follows:

IANAは、次のように「JMAP機能」レジストリに「ふるい」を登録しています。

Capability Name:

機能名:

urn:ietf:params:jmap:sieve

urn:ietf:params:jmap:sive

Reference:

参照:

RFC 9661

RFC 9661

Intended Use:

目的の使用:

common

一般コモン通常同じ慣用頻出平凡卑近並並み尋常通俗一介月並み凡常尋常一様唯直よくあるありふれた一般的在り来たり庶民的当たり前の有りがち

Change Controller:

Change Controller:

IETF

IETF

Security and Privacy Considerations:

セキュリティとプライバシーの考慮事項:

RFC 9661, Section 5

RFC 9661、セクション5

6.2. JMAP Data Type Registration for "SieveScript"
6.2. 「Sievescript」のJMAPデータ型登録

IANA has registered "SieveScript" in the "JMAP Data Types" registry as follows:

IANAは、次のように「JMAPデータ型」レジストリに「Sievescript」を登録しています。

Type Name:

タイプ名:

SieveScript

Sievescript

Can Reference Blobs:

塊を参照できます:

Yes

はい

Can Use for State Change:

状態の変更に使用できます:

Yes

はい

Capability:

能力:

urn:ietf:params:jmap:sieve

urn:ietf:params:jmap:sive

Reference:

参照:

RFC 9661

RFC 9661

6.3. JMAP Error Codes Registry
6.3. JMAPエラーコードレジストリ

IANA has registered the following two new error codes in the "JMAP Error Codes" registry, as defined in [RFC8620].

IANAは、[RFC8620]で定義されているように、「JMAPエラーコード」レジストリに次の2つの新しいエラーコードを登録しています。

6.3.1. invalidSieve
6.3.1. 無効です

JMAP Error Code:

JMAPエラーコード:

invalidSieve

無効です

Intended Use:

目的の使用:

common

一般コモン通常同じ慣用頻出平凡卑近並並み尋常通俗一介月並み凡常尋常一様唯直よくあるありふれた一般的在り来たり庶民的当たり前の有りがち

Change Controller:

Change Controller:

IETF

IETF

Reference:

参照:

RFC 9661, Section 2.4

RFC 9661、セクション2.4

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.

SievescriptはSieve Grammar [RFC5228]に違反しており、スクリプトの「要求」ステートメントに記載されている1つ以上の拡張機能は、ふるいインタープリターによってサポートされていません。

6.3.2. sieveIsActive
6.3.2. ふるい障害

JMAP Error Code:

JMAPエラーコード:

sieveIsActive

ふるい障害

Intended Use:

目的の使用:

common

一般コモン通常同じ慣用頻出平凡卑近並並み尋常通俗一介月並み凡常尋常一様唯直よくあるありふれた一般的在り来たり庶民的当たり前の有りがち

Change Controller:

Change Controller:

IETF

IETF

Reference:

参照:

RFC 9661, Section 2.4

RFC 9661、セクション2.4

Description:

説明:

The client tried to destroy the active SieveScript.

クライアントは、アクティブなSievescriptを破壊しようとしました。

7. References
7. 参考文献
7.1. Normative References
7.1. 引用文献
   [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
7.2. 参考引用
   [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>.
        
   [RFC9112]  Fielding, R., Ed., Nottingham, M., Ed., and J. Reschke,
              Ed., "HTTP/1.1", STD 99, RFC 9112, DOI 10.17487/RFC9112,
              June 2022, <https://www.rfc-editor.org/info/rfc9112>.
        
   [RFC9404]  Gondwana, B., Ed., "JSON Meta Application Protocol (JMAP)
              Blob Management Extension", RFC 9404,
              DOI 10.17487/RFC9404, August 2023,
              <https://www.rfc-editor.org/info/rfc9404>.
        
   [RFC9425]  Cordier, R., Ed., "JSON Meta Application Protocol (JMAP)
              for Quotas", RFC 9425, DOI 10.17487/RFC9425, June 2023,
              <https://www.rfc-editor.org/info/rfc9425>.
        
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.

このドキュメントの概念は、主に[RFC5804]の概念に基づいています。著者は、このドキュメントの著者に、このドキュメントに借りたテキストの両方を提供してくれたことに感謝したいと思います。

The author would also like to thank the following individuals for contributing their ideas and support for writing this specification: Joris Baum, Mauro De Gennaro, Bron Gondwana, Neil Jenkins, Alexey Melnikov, and Ricardo Signes.

著者はまた、次の個人に、この仕様を書くためのアイデアとサポートを提供してくれたことに感謝したいと思います:ジョリス・バウム、マウロ・デ・ジェンナロ、ブロン・ゴンドワナ、ニール・ジェンキンス、アレクセイ・メルニコフ、リカルド・サイン。

Author's Address
著者の連絡先
   Kenneth Murchison
   Fastmail US LLC
   1429 Walnut Street, Suite 1201
   Philadelphia, PA 19102
   United States of America
   Email: murch@fastmailteam.com