JMAP for Sieve Scripts
draft-ietf-jmap-sieve-04

Document Type Active Internet-Draft (jmap WG)
Author Kenneth Murchison 
Last updated 2021-02-03
Stream IETF
Intended RFC status Proposed Standard
Formats plain text xml pdf htmlized (tools) htmlized bibtex
Stream WG state WG Document
Document shepherd No shepherd assigned
IESG IESG state I-D Exists
Consensus Boilerplate Yes
Telechat date
Responsible AD (None)
Send notices to (None)
JMAP                                                        K. Murchison
Internet-Draft                                                  Fastmail
Intended status: Standards Track                        February 3, 2021
Expires: August 7, 2021

                         JMAP for Sieve Scripts
                        draft-ietf-jmap-sieve-04

Abstract

   This document specifies a data model for managing Sieve scripts on a
   server using the JSON Meta Application Protocol (JMAP).

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 August 7, 2021.

Copyright Notice

   Copyright (c) 2021 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
   (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 Simplified BSD License text as described in Section 4.e of
   the Trust Legal Provisions and are provided without warranty as
   described in the Simplified BSD License.

Murchison                Expires August 7, 2021                 [Page 1]
Internet-Draft                 JMAP Sieve                  February 2021

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  . . . . . . . . . . . . .   3
   2.  Sieve Scripts . . . . . . . . . . . . . . . . . . . . . . . .   5
     2.1.  SieveScript/get . . . . . . . . . . . . . . . . . . . . .   6
     2.2.  SieveScript/set . . . . . . . . . . . . . . . . . . . . .   6
       2.2.1.  Examples  . . . . . . . . . . . . . . . . . . . . . .   8
     2.3.  SieveScript/query . . . . . . . . . . . . . . . . . . . .  15
     2.4.  SieveScript/validate  . . . . . . . . . . . . . . . . . .  15
     2.5.  SieveScript/test  . . . . . . . . . . . . . . . . . . . .  16
       2.5.1.  Example . . . . . . . . . . . . . . . . . . . . . . .  19
   3.  Compatibility with JMAP Vacation Response . . . . . . . . . .  22
   4.  Security Considerations . . . . . . . . . . . . . . . . . . .  22
   5.  IANA Considerations . . . . . . . . . . . . . . . . . . . . .  22
     5.1.  JMAP Capability Registration for "sieve"  . . . . . . . .  22
     5.2.  JMAP Error Codes Registry . . . . . . . . . . . . . . . .  22
       5.2.1.  invalidScript . . . . . . . . . . . . . . . . . . . .  23
       5.2.2.  scriptIsActive  . . . . . . . . . . . . . . . . . . .  23
   6.  Acknowledgments . . . . . . . . . . . . . . . . . . . . . . .  23
   7.  References  . . . . . . . . . . . . . . . . . . . . . . . . .  23
     7.1.  Normative References  . . . . . . . . . . . . . . . . . .  23
     7.2.  Informative References  . . . . . . . . . . . . . . . . .  24
   Appendix A.  Change History (To be removed by RFC Editor before
                publication) . . . . . . . . . . . . . . . . . . . .  25
   Author's Address  . . . . . . . . . . . . . . . . . . . . . . . .  27

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.

   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.

Murchison                Expires August 7, 2021                 [Page 2]
Internet-Draft                 JMAP Sieve                  February 2021

1.1.  Notational Conventions

   The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
   "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and
Show full document text