JMAP for Sieve Scripts

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.2. SieveScript/set

This is a standard "/set" method as described in [RFC8620], Section 5.3 but with the following additional request arguments, either of which may be omitted:¶

• replaceOnCreate: Boolean (default: false)¶

  If false, any attempt to create a SieveScript having the same "name" property as an existing SieveScript MUST be rejected with a "scriptNameExists" SetError. If true, the existing SieveScript will be destroyed and the new SieveScript created as a single atomic action. The id of the replaced SieveScript MUST be reported in the "destroyed" argument in the response.¶

• onSuccessActivateScript: Id|null¶

  The id of the SieveScript to activate if the create/update/destroy succeeds. (For references to SieveScript creations, this is equivalent to a creation-reference, so the id will be the creation id prefixed with a "#".) If null, the currently active script (if any) will be deactivated. If this argument is not present in the request, the currently active script (if any) will remain as such. The id of the activated acript MUST be reported in the "created" or "updated" argument in the response as appropriate. The id of the deactivated script, if any, MUST be reported in the "updated" argument in the response unless the script was also destroyed.¶

This method provides similar functionality to the PUTSCRIPT, DELETESCRIPT, RENAMESCRIPT, and SETACTIVE commands in [RFC5804].¶

When creating or updating a script, a client MUST include either a content or a blobId property. A request that includes neither or both properties MUST be rejected with an "invalidProperties" SetError. The server MUST check the script content for syntactic validity, which includes checking that all Sieve extensions mentioned in Sieve script "require" statement(s) are supported by the Sieve interpreter. (Note that if the Sieve interpreter supports the Sieve "ihave" extension [RFC5463], any unrecognized/unsupported extension mentioned in the "ihave" test MUST NOT cause the syntactic validation failure.) A script of zero length SHOULD be considered invalid. If the script content is invalid the request MUST be rejected with a "invalidScript" SetError.¶

Note that simply activating or deactivating a script without changing any script content is accomplished via a request containing an "onSuccessActivateScript" argument and null "create", "update", and "delete" arguments.¶

The following extra SetError types are defined:¶

For "create":¶

• scriptNameExists:¶

  A SieveScript already exists with the given name property, and the "replaceOnCreate" argument was false. An existingId property of type Id MUST be included on the SetError object with the id of the existing SieveScript.¶

• tooManyScripts:¶

  Creating the SieveScript would exceed the maxNumberScripts limit (see Section 1.3.1).¶

For "create" and "update":¶

• invalidScript:¶

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

For "destroy":¶

• scriptIsActive:¶

  The SieveScript is active and the "onSuccessActivateScript" argument was not present.¶

2.5. SieveScript/test

This method is used by the client to ask the Sieve interpreter to evaluate a Sieve script against a set of emails and report what actions would be performed for each.¶

The SieveScript/test method takes the following arguments:¶

• accountId: Id¶

  The id of the account to use.¶

• scriptBlobId: Id¶

  The id of the blob containing the SieveScript to test against.¶

• emailBlobIds: Id[]¶

  The ids of the blobs containing the Emails [RFC8621] to test against.¶

• envelope: Envelope|null¶

  Information that the Sieve interpreter should assume was present in the SMTP transaction that delivered the email when evaluating "envelope" tests. If null, all "envelope" tests MUST eveluate to false. See Section 7 of Email [RFC8621] for the contents of the Envelope object.¶

• lastVacationResponse: Date|null¶

  The date-time at which the Sieve interpreter should assume that it last auto-replied to the sender of the email, or null if the Sieve interpreter should assume that it has not auto-replied to the sender.¶

The response has the following arguments:¶

• accountId: Id¶

  The id of the account used for this call.¶

• completed: Id[Action[]]|null¶

  A map of the blob id to a set of Action types for each Email successfully processed by the script, or null if none. The Action data type is a tuple, represented as a JSON array containing two elements:¶

  1. A String name of the Sieve action (e.g., "keep").¶

  2. A String[*] object containing named arguments for that action (e.g., ":flags" or "mailbox").¶

• notCompleted: Id[SetError]|null¶

  A map of the blob id to a SetError object for each Email that was not successfully processed by the script, or null if none. A "serverFail" SetError (see Section 3.6.2 of [RFC8620]) MUST be used to indicate a Sieve interpreter run-time error.¶

The following additional errors may be returned instead of the "SieveScript/test" response:¶

• "blobNotFound": The script referenced by the blob id could not be found.¶
• "invalidScript": The referenced script is invalid (see Section 2.2).¶
• "serverFail": The referenced script failed preparation to be executed for some other reason.¶

The name to use for each argument is a direct mapping of the argument names as given in the specification of each action. Tagged and optional arguments MUST use the name of the tag, minus the leading ":". Positional arguments MUST use the name of the argument inside of the angle brackets ("<" and ">") in the "Usage" line in the specification for the action.¶

The JSON data type to use for each argument value is a direct mapping from its Sieve data type, per the following table:¶

Recommendations for constructing the list of arguments are as follows:¶

• Tagged arguments SHOULD procede positional arguments.¶
• Optional arguments in which the value is supplied by the Sieve interpreter SHOULD be included (e.g., ":from" and ":subject" arguments to the "vacation" [RFC5230] action).¶
• Optional arguments in which the value is supplied by a Sieve variable SHOULD be included (e.g., "keep" or "fileinto" actions without an explicit ":flags" argument, but "imap4flags" [RFC5232] have been set on the internal variable).¶
• Optional arguments in which the value is the specfied default MAY be omitted.¶
• Tagged arguments that are only used to determine whether the action will be executed and have no impact on the result of the action MAY be omitted (e.g., ":days" and ":addresses" arguments to the vacation action).¶

require [ "imapflags", "editheader", "vacation", "fcc" ];
setflag "$SieveFiltered";
addheader :last "X-Sieve-Filtered" "yes";
vacation :days 3 :fcc "INBOX.Sent" :flags "\\Answered" text:
Gone fishing.
.
;

From: "Some Example Sender" <example@example.net>
To: test@example.com
Subject: test email
Date: Wed, 23 Sep 2020 12:11:11 -0500
MIME-Version: 1.0
Content-Type: text/plain; charset="UTF-8"

This is a test email.

{
  "using": [
    "urn:ietf:params:jmap:core",
    "urn:ietf:params:jmap:sieve",
    "urn:ietf:params:jmap:mail"
  ],
  "methodCalls": [
    [
      "SieveScript/test",
      {
        "scriptBlobId": "B123",
        "emailBlobIds": [
          "B456"
        ],
        "envelope": {
          "mailFrom": {
            "email": "example@example.net",
            "parameters": null
          },
          "rcptTo": [
            {
              "email": "test@example.com",
              "parameters": null
            }
          ]
        },
        "lastVacationResponse": null
      },
      "R1"
    ]
  ]
}

{
  "methodResponses": [
    [
      "SieveScript/test",
      {
        "accountId": "test",
        "completed": {
          "B456": [
            [
              "addheader",
              {
                "last": true,
                "field-name": "X-Sieve-Filtered",
                "value": "yes"
              }
            ],
            [
              "vacation",
              {
                "fcc": "INBOX.Sent",
                "flags": [
                  "\\answered"
                ],
                "subject": "Auto: test email",
                "from": "test@example.com",
                "reason": "Gone fishing."
              }
            ],
            [
              "keep",
              {
                "flags": [
                  "$SieveFiltered"
                ]
              }
            ]
          ]
        },
        "notCompleted": null
      },
      "R1"
    ]
  ],
  "sessionState": "0"
}