Internet Draft R. Gellens Document: draft-gellens-acap-sieve-00.txt QUALCOMM Expires: 28 August 2000 28 February 2000 ACAP Profile for Sieve Script Access Status of this Memo: This document is an Internet-Draft and is in full conformance with all provisions of Section 10 of RFC2026. Internet-Drafts are working documents of the Internet Engineering Task Force (IETF), its areas, and its working groups. Note that other groups may also distribute working documents as Internet-Drafts. 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." The list of current Internet-Drafts can be accessed at The list of Internet-Draft Shadow Directories can be accessed at . A version of this draft document is intended for submission to the RFC editor as a Proposed Standard for the Internet Community. Discussion and suggestions for improvement are requested. Copyright Notice Copyright (C) The Internet Society 2000. All Rights Reserved. Gellens Expires August 2000 [Page 1] Internet Draft ACAP Profile for Sieve Script Access>February 2000 Table of Contents 1. Abstract . . . . . . . . . . . . . . . . . . . . . . . . . . 2 2. Conventions Used in this Document . . . . . . . . . . . . . . 2 3. Comments . . . . . . . . . . . . . . . . . . . . . . . . . . 2 4. Sieve ACAP Profile Overview . . . . . . . . . . . . . . . . . 2 5. Commands . . . . . . . . . . . . . . . . . . . . . . . . . . 3 6. Responses . . . . . . . . . . . . . . . . . . . . . . . . . . 4 7. Datasets and Attributes . . . . . . . . . . . . . . . . . . 4 8. Multiple Sieve Scripts . . . . . . . . . . . . . . . . . . . 5 9. Example Session . . . . . . . . . . . . . . . . . . . . . . 5 10. References . . . . . . . . . . . . . . . . . . . . . . . . . 6 11. Security Considerations . . . . . . . . . . . . . . . . . . 6 12. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 6 13. Author's Address . . . . . . . . . . . . . . . . . . . . . . 6 14. Full Copyright Statement . . . . . . . . . . . . . . . . . . 6 1. Abstract The Sieve [SIEVE] language provides a very useful interoperable syntax for mail filtering. The Email Account Dataset Class [ACAP-EMAIL] provides an extensible and interoperable means of accessing and controlling Sieve scripts, but requires an ACAP [ACAP] server. This memo proposes a profile of ACAP which is suitable for accessing Sieve scripts, very easy to implement in clients and servers, and upwardly compatible with ACAP. 2. Conventions Used in this Document The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in RFC 2119 [KEYWORDS]. 3. Comments Public comments can be sent to the Sieve mailing list, . To subscribe, send a message to with the word SUBSCRIBE as the body. Private comments should be sent to the author. 4. Sieve ACAP Profile Overview The Sieve ACAP Profile uses ACAP commands and syntax but provides access only to Sieve-related [SIEVE] attributes in an actual or virtual Email Account Dataset [ACAP-EMAIL]. Clients can store and retrieve Sieve scripts. If supported by the server, syntax errors Gellens Expires August 2000 [Page 2] Internet Draft ACAP Profile for Sieve Script Access>February 2000 and warnings for just-stored scripts, and/or run-time errors and warnings, are also available. By using a profile of ACAP, we get a ready-made protocol designed for just this type of activity which is very easy to implement, and most importantly, an easy upgrade path. A client which uses this profile can also talk to a full ACAP server. Full ACAP provides many features not available in the profile, such as Access Control Lists (ACLs), sophisticated searching (including change notification), and of course unlimited attributes and datasets. The goal of this profile is to provide the minimum functionality required to access and store Sieve scripts, in a way that is as easy as possible to implement in clients and servers, with a sensible upgrade mechanism (in this case, to full ACAP). This profile of ACAP uses port xxx. The normal ACAP sequence is followed (client opens connection, server responds with an initial greeting, etc.) 5. Commands The supported ACAP commands (with the RFC 2244 section numbers) are: AUTHENTICATE (6.3.1) SEARCH (6.4.1) STORE (6.6.1) NOOP (6.2.1) LOGOUT (6.2.4) Note that the SEARCH and STORE commands are severely limited as to the datasets and attributes which may be accessed, and the command elements which may be used. Servers MAY choose to support only those command elements specifically mentioned here. The SEARCH command MUST NOT use a dataset name not permitted by section 7, Datasets and Attributes. The RETURN modifier MAY be used. Other modifiers SHOULD NOT be used. The RETURN modifier MUST only specify attributes permitted by section 7, Datasets and Attributes. The EQUAL criteria SHOULD be used. Other criteria SHOULD NOT be used. The EQUAL criteria SHOULD specify an attribute of "ENTRY", a comparator of "i;octet", and a value permitted by section 7. A typical SEARCH command is: Gellens Expires August 2000 [Page 3] Internet Draft ACAP Profile for Sieve Script Access>February 2000 t1 SEARCH "/email/~/" RETURN ("email.sieve.script") EQUAL "entry" "i;octet" "sieve" The SEARCH command results in typically one ENTRY intermediate response and one MODTIME intermediate response, followed by an OK response. The STORE command MUST be passed one entry store list. The entry path normally refers to the "sieve" (or another) entry in the "email" dataset (for example, "/email/~/sieve" ). See section 7. Attribute store items MUST use attribute names which begin with "email.sieve." The NOCREATE modifier MUST NOT be used. The UNCHANGEDSINCE modifier MAY be used. A typical STORE command is: t2 STORE ("/email/~/sieve" "email.sieve.script"