draft-ietf-imapext-annotate-05.txt   draft-ietf-imapext-annotate-06.txt 
IMAP Extensions Working Group R. Gellens IMAP Extensions Working Group R. Gellens
Internet Draft: IMAP ANNOTATE Extension C. Daboo Internet Draft: IMAP ANNOTATE Extension C. Daboo
Document: draft-ietf-imapext-annotate-05.txt November 2002 Document: draft-ietf-imapext-annotate-06.txt March 2003
IMAP ANNOTATE Extension IMAP ANNOTATE Extension
Status of this Memo Status of this Memo
This document is an Internet-Draft and is in full conformance with This document is an Internet-Draft and is in full conformance with
all provisions of Section 10 of RFC2026. all provisions of Section 10 of RFC2026.
Internet-Drafts are working documents of the Internet Engineering Internet-Drafts are working documents of the Internet Engineering
Task Force (IETF), its areas, and its working groups. Note that Task Force (IETF), its areas, and its working groups. Note that
skipping to change at page 20, line ? skipping to change at page 20, line ?
reference material or to cite them other than as "work in progress." 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 current Internet-Drafts can be accessed at
http://www.ietf.org/ietf/1id-abstracts.txt. http://www.ietf.org/ietf/1id-abstracts.txt.
The list of Internet- Draft Shadow Directories can be accessed at The list of Internet- Draft Shadow Directories can be accessed at
http://www.ietf.org/shadow.html. http://www.ietf.org/shadow.html.
Copyright Notice Copyright Notice
Copyright (C) The Internet Society 2002. All Rights Reserved. Copyright (C) The Internet Society 2003. All Rights Reserved.
Gellens & Daboo Expires May 2003 [Page 1] Gellens & Daboo Expires September 2003 [Page 1]
Table of Contents Table of Contents
1 Abstract . . . . . . . . . . . . . . . . . . . . . . . . . . 2 1 Abstract . . . . . . . . . . . . . . . . . . . . . . . . . . 2
2 Discussion . . . . . . . . . . . . . . . . . . . . . . . . . 2 2 Discussion . . . . . . . . . . . . . . . . . . . . . . . . . 2
3 Conventions Used in This Document . . . . . . . . . . . . . . 2 3 Conventions Used in This Document . . . . . . . . . . . . . . 2
4 Open Issues: . . . . . . . . . . . . . . . . . . . . . . . . 3 4 Open Issues . . . . . . . . . . . . . . . . . . . . . . . . 3
5 Change History . . . . . . . . . . . . . . . . . . . . . . . 3 5 Change History . . . . . . . . . . . . . . . . . . . . . . . 3
6 Introduction and Overview . . . . . . . . . . . . . . . . . 4 6 Introduction and Overview . . . . . . . . . . . . . . . . . 4
7 Data Model . . . . . . . . . . . . . . . . . . . . . . . . . 5 7 Data Model . . . . . . . . . . . . . . . . . . . . . . . . . 5
7.1 Overview . . . . . . . . . . . . . . . . . . . . . . . . 5 7.1 Overview . . . . . . . . . . . . . . . . . . . . . . . . 5
7.2 Namespace of Entries and Attributes . . . . . . . . . . . 5 7.2 Namespace of Entries and Attributes . . . . . . . . . . . 6
7.2.1 Entry Names . . . . . . . . . . . . . . . . . . . . 6 7.2.1 Entry Names . . . . . . . . . . . . . . . . . . . . 6
7.2.2 Attribute Names . . . . . . . . . . . . . . . . . . . 8 7.2.2 Attribute Names . . . . . . . . . . . . . . . . . . . 8
8 Private versus Shared and Access Control . . . . . . . . . . 9 8 Private versus Shared and Access Control . . . . . . . . . . 9
9 IMAP Protocol Changes . . . . . . . . . . . . . . . . . . . . 10 9 IMAP Protocol Changes . . . . . . . . . . . . . . . . . . . . 10
9.1 Optional parameters with the SELECT/EXAMINE commands . . 10 9.1 Optional parameters with the SELECT/EXAMINE commands . . 10
9.2 ANNOTATION Message Data Item in FETCH Command . . . . . . 10 9.2 ANNOTATION Message Data Item in FETCH Command . . . . . . 11
9.3 ANNOTATION Message Data Item in FETCH Response . . . . . 12 9.3 ANNOTATION Message Data Item in FETCH Response . . . . . 12
9.4 ANNOTATION Message Data Item in STORE . . . . . . . . . . 13 9.4 ANNOTATION Message Data Item in STORE . . . . . . . . . . 13
9.5 ANNOTATION interaction with COPY . . . . . . . . . . . . 14 9.5 ANNOTATION interaction with COPY . . . . . . . . . . . . 15
9.6 ANNOTATION Message Data Item in APPEND . . . . . . . . . 15 9.6 ANNOTATION Message Data Item in APPEND . . . . . . . . . 15
9.7 ANNOTATION Criterion in SEARCH . . . . . . . . . . . . . 15 9.7 ANNOTATION Criterion in SEARCH . . . . . . . . . . . . . 15
9.8 ANNOTATION Key in SORT . . . . . . . . . . . . . . . . . 16 9.8 ANNOTATION Key in SORT . . . . . . . . . . . . . . . . . 16
10 Formal Syntax . . . . . . . . . . . . . . . . . . . . . . . 16 10 Formal Syntax . . . . . . . . . . . . . . . . . . . . . . . 16
11 IANA Considerations . . . . . . . . . . . . . . . . . . . . . 18 11 IANA Considerations . . . . . . . . . . . . . . . . . . . . . 18
11.1 Entry and Attribute Registration Template . . . . . . . 18 11.1 Entry and Attribute Registration Template . . . . . . . 18
12 Security Considerations . . . . . . . . . . . . . . . . . . . 18 12 Security Considerations . . . . . . . . . . . . . . . . . . . 18
13 References . . . . . . . . . . . . . . . . . . . . . . . . . 18 13 Normative References . . . . . . . . . . . . . . . . . . . . 19
14 Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 19 14 Informative References . . . . . . . . . . . . . . . . . . . 19
15 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . 19 15 Acknowledgments . . . . . . . . . . . . . . . . . . . . . . 19
16 Full Copyright Statement . . . . . . . . . . . . . . . . . . 19 16 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . 19
17 Full Copyright Statement . . . . . . . . . . . . . . . . . . 20
1 Abstract 1 Abstract
The ANNOTATE extension to the Internet Message Access Protocol The ANNOTATE extension to the Internet Message Access Protocol
[IMAP4] permits clients and servers to maintain "metadata" for [IMAP4] permits clients and servers to maintain "metadata" for
messages stored in an IMAP4 mailbox. messages stored in an IMAP4 mailbox.
2 Discussion 2 Discussion
Public comments can be sent to the IETF IMAP Extensions mailing Public comments can be sent to the IETF IMAP Extensions mailing
list, <ietf-imapext@imc.org>. To subscribe, send a message to list, <ietf-imapext@imc.org>. To subscribe, send a message to
<ietf-imapext-request@imc.org> with the word SUBSCRIBE as the body. <ietf-imapext-request@imc.org> with the word SUBSCRIBE as the body.
Private comments should be sent to the authors. Private comments should be sent to the authors.
3 Conventions Used in This Document 3 Conventions Used in This Document
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
"SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this
document are to be interpreted as described in RFC 2119 [KEYWORDS]. document are to be interpreted as described in RFC 2119 [KEYWORDS].
Gellens & Daboo Expires May 2003 [Page 2] Gellens & Daboo Expires September 2003 [Page 2]
Formal syntax is defined using ABNF [ABNF] as modified by [IMAP4]. Formal syntax is defined using ABNF [ABNF] as modified by [IMAP4].
In examples, "C:" and "S:" indicate lines sent by the client and In examples, "C:" and "S:" indicate lines sent by the client and
server respectively. Line breaks not preceded by a "C:" or "S:" are server respectively. Line breaks not preceded by a "C:" or "S:" are
for editorial clarity only. for editorial clarity only.
4 Open Issues: 4 Open Issues
*How to deal with flag vs keyword namespace issues. Should standard 1. Use of utf8 for entry/attributes and values?
IMAP flags go under /message/flags and keywords under
/message/keywords, or should they all go under /message/flags and
follow the exact naming scheme in IMAP (i.e. with '\' prefix in
front of standard flags, and '$' for appropriate keywords)?
5 Change History 5 Change History
Changes from -03 to -04: Changes from -05 to -06:
1. Split references into Normative and Informative.
2. Reworked flags to allow IMAP4 flag prefix to appear in annotation name.
3. Removed smtp-envelope annotation - a future extension can add this.
4. Changed subject to altsubject.
5. Added $MDNSent flag and reference to document.
6. Cleaned up formal syntax to use IMAP string type for entry
and attributes, with requirements on how the string is formatted.
7. Use of ACAP vendor subtree registry for vendor tokens.
8. Fixed STORE syntax.
Changes from -04 to -05:
1. Fixed examples to match formal syntax for FETCH responses where 1. Fixed examples to match formal syntax for FETCH responses where
parenthesis do not appear around entry-att items. parenthesis do not appear around entry-att items.
Changes from -03 to -04: Changes from -03 to -04:
1. Fixed attrib/attrib-match grammar to use "." instead of "/". 1. Fixed attrib/attrib-match grammar to use "." instead of "/".
2. Add text for server to reject unknown <part-specifier>. 2. Add text for server to reject unknown <part-specifier>.
3. Do not allow empty part-specifier. 3. Do not allow empty part-specifier.
4. Store NIL to value to delete. 4. Store NIL to value to delete.
5. Comment on COPY interaction with ANNOTATE. 5. Comment on COPY interaction with ANNOTATE.
6. Added comment that IMAP flags are mapped one-to-one with their 6. Added comment that IMAP flags are mapped one-to-one with their
skipping to change at page 20, line ? skipping to change at page 20, line ?
'session only' annotations. 'session only' annotations.
4. Removed Access Control section. Replaced with comments 4. Removed Access Control section. Replaced with comments
on read-only/read-write mailboxes and storing private or on read-only/read-write mailboxes and storing private or
shared annotations. shared annotations.
5. Removed STORE to default .priv or .shared. 5. Removed STORE to default .priv or .shared.
6. Added section on optional select parameters. 6. Added section on optional select parameters.
Changes from -01 to -02: Changes from -01 to -02:
1. Now require .priv or .shared on store operations. 1. Now require .priv or .shared on store operations.
Gellens & Daboo Expires September 2003 [Page 3]
Changes from -00 to -01: Changes from -00 to -01:
1. MODTIME moved to its own draft, which this draft now 1. MODTIME moved to its own draft, which this draft now
depends on. Thus, Conditional Annotation STORE and depends on. Thus, Conditional Annotation STORE and
related items deleted from this draft. related items deleted from this draft.
2. Private versus Shared Annotations: both are possible 2. Private versus Shared Annotations: both are possible
Gellens & Daboo Expires May 2003 [Page 3]
(separately addressable using ".priv" and ".shared" (separately addressable using ".priv" and ".shared"
suffixes). There is a per-mailbox setting for the suffixes). There is a per-mailbox setting for the
default. It is an open issue how this is viewed or default. It is an open issue how this is viewed or
changed by the client. changed by the client.
3. In ACLs, the "w" right is needed to updated shared state; 3. In ACLs, the "w" right is needed to updated shared state;
the "s" right is needed to update private state. the "s" right is needed to update private state.
4. Various clarifications and text modifications. 4. Various clarifications and text modifications.
5. Added 'forwarded' flag for message parts. 5. Added 'forwarded' flag for message parts.
Changes from pre-imapext to -00: Changes from pre-imapext to -00:
skipping to change at page 20, line ? skipping to change at page 20, line ?
The ANNOTATE extension is present in any IMAP4 implementation which The ANNOTATE extension is present in any IMAP4 implementation which
returns "ANNOTATE" as one of the supported capabilities in the returns "ANNOTATE" as one of the supported capabilities in the
CAPABILITY response. CAPABILITY response.
The ANNOTATE extension adds a new message data item to the FETCH and The ANNOTATE extension adds a new message data item to the FETCH and
STORE commands, as well as adding SEARCH and SORT keys and an APPEND STORE commands, as well as adding SEARCH and SORT keys and an APPEND
modifier. modifier.
This extension makes the following changes to the IMAP4 protocol: This extension makes the following changes to the IMAP4 protocol:
Gellens & Daboo Expires September 2003 [Page 4]
a) adds a new ANNOTATION message data item for use in FETCH a) adds a new ANNOTATION message data item for use in FETCH
b) adds a new ANNOTATION message data item for use in STORE b) adds a new ANNOTATION message data item for use in STORE
c) adds a new ANNOTATION search criterion for use in SEARCH c) adds a new ANNOTATION search criterion for use in SEARCH
d) adds a new ANNOTATION sort key for use in SORT extension d) adds a new ANNOTATION sort key for use in SORT extension
e) adds a new ANNOTATION data item for use in APPEND e) adds a new ANNOTATION data item for use in APPEND
f) adds a new requirement on the COPY command f) adds a new requirement on the COPY command
Gellens & Daboo Expires May 2003 [Page 4]
g) adds a extension mechanism for adding parameters to the g) adds a extension mechanism for adding parameters to the
SELECT/EXAMINE commands and defines the ANNOTATE parameter SELECT/EXAMINE commands and defines the ANNOTATE parameter
The data model used for the storage of annotations is based on that The data model used for the storage of annotations is based on that
of the Application Configuration Access Protocol [ACAP]. Note that of the Application Configuration Access Protocol [ACAP]. Note that
there is no inheritance in annotations. there is no inheritance in annotations.
Clients MUST NOT use annotations in lieu of equivalent IMAP base Clients MUST NOT use annotations in lieu of equivalent IMAP base
specification facilities. For example, use of a "seen" flag in the specification facilities. For example, use of a "seen" flag in the
vendor namespace together with ".PEEK" in fetches. Such behaviour vendor namespace together with ".PEEK" in fetches. Such behaviour
skipping to change at page 20, line ? skipping to change at page 20, line ?
several attributes. several attributes.
For example, a comment added to a message has an entry name of For example, a comment added to a message has an entry name of
"/message/comment". This entry is composed of several attributes "/message/comment". This entry is composed of several attributes
such as "value", "size", etc. which contain the properties and data such as "value", "size", etc. which contain the properties and data
of the entry. of the entry.
The protocol changes to IMAP described below allow a client to The protocol changes to IMAP described below allow a client to
access or change the values of any attributes in any entries in a access or change the values of any attributes in any entries in a
message annotation, assuming it has sufficient access rights to do message annotation, assuming it has sufficient access rights to do
Gellens & Daboo Expires September 2003 [Page 5]
so (see Section 8 for specifics). so (see Section 8 for specifics).
7.2 Namespace of Entries and Attributes 7.2 Namespace of Entries and Attributes
Gellens & Daboo Expires May 2003 [Page 5]
Each message annotation is made up of a set of entries. Each entry Each message annotation is made up of a set of entries. Each entry
has a hierarchical name in UTF-8, with each component of the name has a hierarchical name in UTF-8, with each component of the name
separated by a slash ("/"). separated by a slash ("/").
Each entry is made up of a set of attributes. Each attribute has a Each entry is made up of a set of attributes. Each attribute has a
hierarchical name in UTF-8, with each component of the name hierarchical name in UTF-8, with each component of the name
separated by a period ("."). separated by a period (".").
The value of an attribute is NIL (has no value), or is a string of The value of an attribute is NIL (has no value), or is a string of
zero or more octets. zero or more octets.
skipping to change at page 20, line ? skipping to change at page 20, line ?
/message/comment /message/comment
Defines a comment or note associated with an entire message. Defines a comment or note associated with an entire message.
/message/flags /message/flags
Defines the top-level of entries for flags associated with an Defines the top-level of entries for flags associated with an
entire message. The "value" attribute of each of the entries entire message. The "value" attribute of each of the entries
described below must be either "1", "0" or NIL. "1" corresponds described below must be either "1", "0" or NIL. "1" corresponds
to the flag being set. to the flag being set.
/message/flags/answered Standard [IMAP4] flags always have a '\' prefix character.
/message/flags/flagged Other standard flags have a '$' prefix. The annotation names
/message/flags/deleted used for all flags uses the complete name for that flag,
/message/flags/seen
/message/flags/draft
/message/flags/recent
These attributes represent the standard IMAP flags as returned
by the FLAGS fetch item. Changes to these annotations are
Gellens & Daboo Expires May 2003 [Page 6] Gellens & Daboo Expires September 2003 [Page 6]
reflected in the standard IMAP flags. The recent attribute is including the prefix character.
read only, clients MUST NOT attempt to change it.
/message/flags/redirected The set of standard IMAP flags annotations are:
/message/flags/forwarded
The 'redirected' flag indicates that a message has been handed /message/flags/\answered
/message/flags/\flagged
/message/flags/\deleted
/message/flags/\seen
/message/flags/\draft
/message/flags/\recent
Changes to these annotations are reflected in the standard IMAP
flags. The \recent attribute is read only, clients MUST NOT
attempt to change it.
Note that entry names are sent as [IMAP4] string elements which
requires that '\' characters be escaped in the string.
Additional standard flags are:
/message/flags/$mdnsent
/message/flags/$redirected
/message/flags/$forwarded
The '$mdnsent' flag is used to indicate message disposition
notification processing state [MDNSENT].
The '$redirected' flag indicates that a message has been handed
off to someone else, by resending the message with minimal off to someone else, by resending the message with minimal
alterations, and in such a way that a reply by the new recipient alterations, and in such a way that a reply by the new recipient
is addressed to the original author, not the user who performed is addressed to the original author, not the user who performed
the redirection. The 'forwarded' flag indicates the message was the redirection.
resent to another user, embedded within or attached to a new
message.
/message/smtp-envelope The '$forwarded' flag indicates the message was resent to
Defines the top-level of entries which together describe the another user, embedded within or attached to a new message.
SMTP envelope used in delivery of the message. There are no
attributes at this level. The client SHOULD NOT modify the
/message/smtp-envelope entry or any sub-entries or any of their
attributes, except in messages which have the DRAFT flag set.
/message/smtp-envelope/from
/message/smtp-envelope/to
/message/smtp-envelope/orcpt
/message/smtp-envelope/envid
/message/smtp-envelope/notify
/message/smtp-envelope/ret
Contains the properties of the SMTP envelope: 'from' is the
return-path of the message; 'to' is the recipient of the
message. 'notify', 'orcpt', 'ret' and 'envid' contain the
notification options, original recipient, envelope ID and return
options as specified in [SMTP-DSN].
/message/subject /message/altsubject
Contains text supplied by the message recipient, to be used by Contains text supplied by the message recipient, to be used by
the client instead of the original message Subject. the client instead of the original message Subject.
/message/vendor/<vendor-token> /message/vendor/<vendor-token>
Defines the top-level of entries associated with an entire Defines the top-level of entries associated with an entire
message as created by a particular product of some vendor. message as created by a particular product of some vendor.
These sub-entries can be used by vendors to provide These sub-entries can be used by vendors to provide
client-specific attributes. The vendor-token MUST be registered client-specific attributes. The vendor-token MUST be registered
with IANA. with IANA, using the [ACAP] vendor subtree registry.
/body/<part-specifier> /body/<part-specifier>
Defines the top-level of entries associated with a specific body Defines the top-level of entries associated with a specific body
part of a message. This entry itself does not contain any part of a message. This entry itself does not contain any
attributes. The part-specifier uses the same part specifier attributes. The part-specifier uses the same part specifier
syntax as the BODY message data item in the FETCH command syntax as the BODY message data item in the FETCH command
Gellens & Daboo Expires September 2003 [Page 7]
[IMAP4]. The server MUST return a BAD response if the client [IMAP4]. The server MUST return a BAD response if the client
uses an incorrect part specifier (either incorrect syntax or a uses an incorrect part specifier (either incorrect syntax or a
specifier referring to a non-existent part). The server MUST specifier referring to a non-existent part). The server MUST
return a BAD response if the client uses an empty part specifier return a BAD response if the client uses an empty part specifier
(which is used in [IMAP4] to represent the entire message). (which is used in [IMAP4] to represent the entire message).
Gellens & Daboo Expires May 2003 [Page 7]
/body/<part-specifier>/comment /body/<part-specifier>/comment
Defines a comment or note associated with a specific body part Defines a comment or note associated with a specific body part
of a message. of a message.
/body/<part-specifier>/flags /body/<part-specifier>/flags
Defines the top-level of entries associated with flag state for Defines the top-level of entries associated with flag state for
a specific body part of a message. All sub-entries are a specific body part of a message. All sub-entries are
maintained entirely by the client. There is no implicit change maintained entirely by the client. There is no implicit change
to any flag by the server. to any flag by the server.
skipping to change at page 20, line ? skipping to change at page 20, line ?
annotation. annotation.
value value
A UTF8 string representing the data value of the attribute. To A UTF8 string representing the data value of the attribute. To
delete an annotation, the client can store NIL into the value. delete an annotation, the client can store NIL into the value.
size size
The size of the value, in octets. Set automatically by the The size of the value, in octets. Set automatically by the
server, read-only to clients. server, read-only to clients.
Gellens & Daboo Expires September 2003 [Page 8]
content-type content-type
A MIME [MIME] content type and subtype that describes the nature A MIME [MIME] content type and subtype that describes the nature
of the content of the "value" attribute. If not present, a of the content of the "value" attribute. If not present, a
value of "text/plain; charset=utf8" is assumed. value of "text/plain; charset=utf8" is assumed.
Gellens & Daboo Expires May 2003 [Page 8]
vendor.<vendor-token> vendor.<vendor-token>
Defines an attribute associated with a particular product of Defines an attribute associated with a particular product of
some vendor. This attribute can be used by vendors to provide some vendor. This attribute can be used by vendors to provide
client specific attributes. The vendor-token MUST be registered client specific attributes. The vendor-token MUST be registered
with IANA. with IANA, using the [ACAP] vendor subtree registry.
8 Private versus Shared and Access Control 8 Private versus Shared and Access Control
Some IMAP mailboxes are private, accessible only to the owning user. Some IMAP mailboxes are private, accessible only to the owning user.
Other mailboxes are not, either because the owner has set an ACL Other mailboxes are not, either because the owner has set an ACL
[ACL-EXT] which permits access by other users, or because it is a [ACL-EXT] which permits access by other users, or because it is a
shared mailbox. shared mailbox.
This raises the issue of shared versus private annotations. This raises the issue of shared versus private annotations.
skipping to change at page 20, line ? skipping to change at page 20, line ?
a danger in allowing a client to store an annotation without knowing a danger in allowing a client to store an annotation without knowing
if it is shared or private. if it is shared or private.
This document proposes two standard suffixes for all attributes: This document proposes two standard suffixes for all attributes:
".shared" and ".priv". A search, fetch, or sort which specifies ".shared" and ".priv". A search, fetch, or sort which specifies
neither uses both. Store operations MUST explicitly use .priv or neither uses both. Store operations MUST explicitly use .priv or
.shared suffixes. .shared suffixes.
A user can only store and fetch private annotations on messages in A user can only store and fetch private annotations on messages in
any mailbox which they can SELECT or EXAMINE, including ones which any mailbox which they can SELECT or EXAMINE, including ones which
Gellens & Daboo Expires September 2003 [Page 9]
only open READ-ONLY. A user can only store and fetch shared only open READ-ONLY. A user can only store and fetch shared
annotations on messages in any mailbox that they can SELECT and annotations on messages in any mailbox that they can SELECT and
which opens READ-WRITE. If a client attempts to store or fetch a which opens READ-WRITE. If a client attempts to store or fetch a
shared annotation on a READ-ONLY mailbox, the server MUST respond shared annotation on a READ-ONLY mailbox, the server MUST respond
with a NO response. with a NO response.
Gellens & Daboo Expires May 2003 [Page 9]
9 IMAP Protocol Changes 9 IMAP Protocol Changes
9.1 Optional parameters with the SELECT/EXAMINE commands 9.1 Optional parameters with the SELECT/EXAMINE commands
This extension adds the ability to include one or more parameters This extension adds the ability to include one or more parameters
with the IMAP SELECT or EXAMINE commands, to turn on or off certain with the IMAP SELECT or EXAMINE commands, to turn on or off certain
standard behaviour, or to add new optional behaviours required for a standard behaviour, or to add new optional behaviours required for a
particular extension. It is anticipated that other extensions may particular extension. It is anticipated that other extensions may
want to use this facility, so a generalised approach is given here. want to use this facility, so a generalised approach is given here.
This facility is not dependent on the presence of the ANNOTATE This facility is not dependent on the presence of the ANNOTATE
skipping to change at page 20, line ? skipping to change at page 20, line ?
In the above example, three parameters are used with the In the above example, three parameters are used with the
EXAMINE command. The second parameter consists of two EXAMINE command. The second parameter consists of two
items: an atom followed by a quoted string. items: an atom followed by a quoted string.
C: a SELECT INBOX (BLURDYBLOOP) C: a SELECT INBOX (BLURDYBLOOP)
S: a NO Unknown parameter in SELECT command S: a NO Unknown parameter in SELECT command
In the above example, a parameter not supported by the In the above example, a parameter not supported by the
server is incorrectly used. server is incorrectly used.
Gellens & Daboo Expires September 2003 [Page 10]
The ANNOTATE extension defines a single optional select parameter The ANNOTATE extension defines a single optional select parameter
"ANNOTATE", which is used to turn on unsolicited responses for "ANNOTATE", which is used to turn on unsolicited responses for
annotations as described in Section 9.3. annotations as described in Section 9.3.
9.2 ANNOTATION Message Data Item in FETCH Command 9.2 ANNOTATION Message Data Item in FETCH Command
Gellens & Daboo Expires May 2003 [Page 10]
This extension adds an ANNOTATION message data item to the FETCH This extension adds an ANNOTATION message data item to the FETCH
command. This allows clients to retrieve annotations for a range of command. This allows clients to retrieve annotations for a range of
messages in the currently selected mailbox. messages in the currently selected mailbox.
ANNOTATION <entry-specifier> <attribute-specifier> ANNOTATION <entry-specifier> <attribute-specifier>
The ANNOTATION message data item, when used by the client in the The ANNOTATION message data item, when used by the client in the
FETCH command, takes an entry specifier and an attribute FETCH command, takes an entry specifier and an attribute
specifier. specifier.
Example: Example:
skipping to change at page 20, line ? skipping to change at page 20, line ?
for the "/message/comment" entry is requested by the client for the "/message/comment" entry is requested by the client
and returned by the server. Since neither ".shared" nor and returned by the server. Since neither ".shared" nor
".priv" was specified, both are returned. ".priv" was specified, both are returned.
"*" and "%" wildcard characters can be used in either specifier to "*" and "%" wildcard characters can be used in either specifier to
match one or more characters at that position, with the exception match one or more characters at that position, with the exception
that "%" does not match the hierarchy delimiter for the specifier it that "%" does not match the hierarchy delimiter for the specifier it
appears in (that is, "/" for an entry specifier or "." for an appears in (that is, "/" for an entry specifier or "." for an
attribute specifier). Thus an entry specifier of "/message/%" attribute specifier). Thus an entry specifier of "/message/%"
matches entries such as "/message/comment" and "/message/subject", matches entries such as "/message/comment" and "/message/subject",
but not "/message/flags/redirected". but not "/message/flags/$redirected".
Examples: Examples:
C: a FETCH 1 (ANNOTATION ("/message/*" ("value.priv" C: a FETCH 1 (ANNOTATION ("/message/*" ("value.priv"
"size.priv"))) "size.priv")))
S: * 1 FETCH (ANNOTATION S: * 1 FETCH (ANNOTATION
("/message/comment" ("value.priv" "My comment" ("/message/comment" ("value.priv" "My comment"
"size.priv" "10") "size.priv" "10")
"/message/subject" ("value.priv" "Rhinoceroses!" "/message/subject" ("value.priv" "Rhinoceroses!"
"size.priv" "13") "size.priv" "13")
"/message/vendor/foobar/label.priv" "/message/vendor/foobar/label.priv"
("value.priv" "label43" ("value.priv" "label43"
"size.priv" "7") "size.priv" "7")
"/message/vendor/foobar/personality" "/message/vendor/foobar/personality"
("value.priv" "Tallulah Bankhead" ("value.priv" "Tallulah Bankhead"
"size.priv" "17"))) "size.priv" "17")))
S: a OK Fetch complete S: a OK Fetch complete
Gellens & Daboo Expires September 2003 [Page 11]
In the above example, the contents of the private "value" and "size" In the above example, the contents of the private "value" and "size"
attributes for any entries in the "/message" hierarchy are requested attributes for any entries in the "/message" hierarchy are requested
by the client and returned by the server. by the client and returned by the server.
C: a FETCH 1 (ANNOTATION ("/message/%" "value.shared")) C: a FETCH 1 (ANNOTATION ("/message/%" "value.shared"))
S: * 1 FETCH (ANNOTATION S: * 1 FETCH (ANNOTATION
("/message/comment" ("value.shared" "Patch Mangler") ("/message/comment" ("value.shared" "Patch Mangler")
Gellens & Daboo Expires May 2003 [Page 11]
"/message/subject" ("value.shared" "Patches? We don't "/message/subject" ("value.shared" "Patches? We don't
need no steenkin patches!"))) need no steenkin patches!")))
S: a OK Fetch complete S: a OK Fetch complete
In the above example, the contents of the shared "value" In the above example, the contents of the shared "value"
attributes for entries at the top level only of the attributes for entries at the top level only of the
"/message" hierarchy are requested by the client and "/message" hierarchy are requested by the client and
returned by the server. returned by the server.
Entry and attribute specifiers can be lists of atomic specifiers, so Entry and attribute specifiers can be lists of atomic specifiers, so
skipping to change at page 20, line ? skipping to change at page 20, line ?
Examples: Examples:
C: a FETCH 1 (ANNOTATION ("/message/comment" "value")) C: a FETCH 1 (ANNOTATION ("/message/comment" "value"))
S: * 1 FETCH (ANNOTATION ("/message/comment" S: * 1 FETCH (ANNOTATION ("/message/comment"
("value.priv" "My comment" ("value.priv" "My comment"
"value.shared" NIL))) "value.shared" NIL)))
S: a OK Fetch complete S: a OK Fetch complete
In the above example, a single entry with a single attribute-value In the above example, a single entry with a single attribute-value
pair is returned by the server. Since the client did not specify a pair is returned by the server. Since the client did not specify a
Gellens & Daboo Expires September 2003 [Page 12]
".shared" or ".priv" suffix, both are returned. Only the private ".shared" or ".priv" suffix, both are returned. Only the private
attribute has a value (the shared value is NIL). attribute has a value (the shared value is NIL).
C: a FETCH 1 (ANNOTATION C: a FETCH 1 (ANNOTATION
(("/message/comment" "/message/subject") "value")) (("/message/comment" "/message/subject") "value"))
S: * 1 FETCH (ANNOTATION S: * 1 FETCH (ANNOTATION
("/message/comment" ("value.priv" "My comment" ("/message/comment" ("value.priv" "My comment"
Gellens & Daboo Expires May 2003 [Page 12]
"value.shared" NIL) "value.shared" NIL)
"/message/subject" ("value.priv" "My subject" "/message/subject" ("value.priv" "My subject"
"value.shared" NIL))) "value.shared" NIL)))
S: a OK Fetch complete S: a OK Fetch complete
In the above example, two entries each with a single attribute-value In the above example, two entries each with a single attribute-value
pair are returned by the server. Since the client did not specify a pair are returned by the server. Since the client did not specify a
".shared" or ".priv" suffix, both are returned. Only the private ".shared" or ".priv" suffix, both are returned. Only the private
attributes have values; the shared attributes are NIL. attributes have values; the shared attributes are NIL.
skipping to change at page 20, line ? skipping to change at page 20, line ?
and the ANNOTATE select parameter was used. This allows servers to and the ANNOTATE select parameter was used. This allows servers to
keep clients updated with changes to annotations by other clients. keep clients updated with changes to annotations by other clients.
9.4 ANNOTATION Message Data Item in STORE 9.4 ANNOTATION Message Data Item in STORE
ANNOTATION <parenthesised entry-attribute-value list> ANNOTATION <parenthesised entry-attribute-value list>
Sets the specified list of entries by adding or replacing the Sets the specified list of entries by adding or replacing the
specified attributes with the values provided. Clients can use specified attributes with the values provided. Clients can use
NIL for values of attributes it wants to remove from entries. NIL for values of attributes it wants to remove from entries.
Gellens & Daboo Expires September 2003 [Page 13]
The ANNOTATION message data item used with the STORE command has an The ANNOTATION message data item used with the STORE command has an
implicit ".SILENT" behaviour. This means the server does not implicit ".SILENT" behaviour. This means the server does not
generate an untagged FETCH in response to the STORE command and generate an untagged FETCH in response to the STORE command and
assumes that the client updates its own cache if the command assumes that the client updates its own cache if the command
succeeds. succeeds.
Examples: Examples:
C: a STORE 1 ANNOTATION ("/message/comment" C: a STORE 1 ANNOTATION ("/message/comment"
Gellens & Daboo Expires May 2003 [Page 13]
("value.priv" "My new comment")) ("value.priv" "My new comment"))
S: a OK Store complete S: a OK Store complete
In the above example, the entry "/message/comment" is created (if In the above example, the entry "/message/comment" is created (if
not already present) and the private attribute "value" with data set not already present) and the private attribute "value" with data set
to "My new comment" is created if not already present, or replaced to "My new comment" is created if not already present, or replaced
if it exists. if it exists.
C: a STORE 1 ANNOTATION ("/message/comment" C: a STORE 1 ANNOTATION ("/message/comment"
("value.shared" NIL)) ("value.shared" NIL))
skipping to change at page 20, line ? skipping to change at page 20, line ?
C: a STORE 1 ANNOTATION ("/message/comment" C: a STORE 1 ANNOTATION ("/message/comment"
("value.priv" "My new comment" ("value.priv" "My new comment"
"vendor.foobar.priv" "foo's bar")) "vendor.foobar.priv" "foo's bar"))
S: a OK Store complete S: a OK Store complete
In the above example, the entry "/message/comment" is created (if In the above example, the entry "/message/comment" is created (if
not already present) and the private attributes "value" and not already present) and the private attributes "value" and
"vendor.foobar" are created if not already present, or replaced if "vendor.foobar" are created if not already present, or replaced if
they exist. they exist.
Gellens & Daboo Expires September 2003 [Page 14]
9.5 ANNOTATION interaction with COPY 9.5 ANNOTATION interaction with COPY
The COPY command can be used to move messages from one mailbox to The COPY command can be used to move messages from one mailbox to
another on the same server. Servers that support the ANNOTATION another on the same server. Servers that support the ANNOTATION
extension MUST copy all the annotation data associated with any extension MUST copy all the annotation data associated with any
messages being copied via the COPY command. The only exception to messages being copied via the COPY command. The only exception to
this is if the destination mailbox permissions are such that either this is if the destination mailbox permissions are such that either
Gellens & Daboo Expires May 2003 [Page 14]
the '.priv' or '.shared' annotations are not allowed. the '.priv' or '.shared' annotations are not allowed.
9.6 ANNOTATION Message Data Item in APPEND 9.6 ANNOTATION Message Data Item in APPEND
ANNOTATION <parenthesised entry-attribute-value list> ANNOTATION <parenthesised entry-attribute-value list>
Sets the specified list of entries and attributes in the Sets the specified list of entries and attributes in the
resulting message. resulting message.
Example: Example:
C: a APPEND drafts ANNOTATION ("/message/comment" C: a APPEND drafts ANNOTATION ("/message/comment"
skipping to change at page 20, line ? skipping to change at page 20, line ?
Examples: Examples:
C: a SEARCH ANNOTATION "/message/comment" "value" "IMAP4" C: a SEARCH ANNOTATION "/message/comment" "value" "IMAP4"
S: * SEARCH 2 3 5 7 11 13 17 19 23 S: * SEARCH 2 3 5 7 11 13 17 19 23
S: a OK Search complete S: a OK Search complete
In the above example, the message numbers of any messages containing In the above example, the message numbers of any messages containing
the string "IMAP4" in the shared or private "value" attribute of the the string "IMAP4" in the shared or private "value" attribute of the
"/message/comment" entry are returned in the search results. "/message/comment" entry are returned in the search results.
Gellens & Daboo Expires September 2003 [Page 15]
C: a SEARCH ANNOTATION "*" "*" "IMAP4" C: a SEARCH ANNOTATION "*" "*" "IMAP4"
S: * SEARCH 1 2 3 5 8 13 21 34 S: * SEARCH 1 2 3 5 8 13 21 34
S: a OK Search complete S: a OK Search complete
In the above example, the message numbers of any messages containing In the above example, the message numbers of any messages containing
the string "IMAP4" in any attribute (public or private) of any entry the string "IMAP4" in any attribute (public or private) of any entry
Gellens & Daboo Expires May 2003 [Page 15]
are returned in the search results. are returned in the search results.
9.8 ANNOTATION Key in SORT 9.8 ANNOTATION Key in SORT
The ANNOTATION criterion for the SORT command [SORT-EXT] instructs The ANNOTATION criterion for the SORT command [SORT-EXT] instructs
the server to return the message numbers or UIDs of a mailbox, the server to return the message numbers or UIDs of a mailbox,
sorted using the values of the specified annotations. The sorted using the values of the specified annotations. The
ANNOTATION criterion is available if the server returns both ANNOTATION criterion is available if the server returns both
"ANNOTATE" and "SORT" as supported capabilities in the CAPABILITY "ANNOTATE" and "SORT" as supported capabilities in the CAPABILITY
command response. command response.
skipping to change at page 20, line ? skipping to change at page 20, line ?
Non-terminals referenced but not defined below are as defined by Non-terminals referenced but not defined below are as defined by
[IMAP4]. [IMAP4].
Except as noted otherwise, all alphabetic characters are case- Except as noted otherwise, all alphabetic characters are case-
insensitive. The use of upper or lower case characters to define insensitive. The use of upper or lower case characters to define
token strings is for editorial clarity only. Implementations MUST token strings is for editorial clarity only. Implementations MUST
accept these strings in a case-insensitive fashion. accept these strings in a case-insensitive fashion.
append = "APPEND" SP mailbox [SP flag-list] [SP date-time] append = "APPEND" SP mailbox [SP flag-list] [SP date-time]
Gellens & Daboo Expires September 2003 [Page 16]
[SP "ANNOTATION" SP att-annotate] [SP "ANNOTATION" SP att-annotate]
SP literal SP literal
; modifies original IMAP4 APPEND command ; modifies original IMAP4 APPEND command
att-annotate = "(" entry-att *(SP entry-att) ")" att-annotate = "ANNOTATION" SP "(" entry-att *(SP entry-att) ")"
Gellens & Daboo Expires May 2003 [Page 16]
fetch-att =/ fetch-annotate fetch-att =/ fetch-annotate
; modifies original IMAP4 fetch-att ; modifies original IMAP4 fetch-att
fetch-annotate = "ANNOTATION" SP "(" entries SP attribs ")" fetch-annotate = "ANNOTATION" SP "(" entries SP attribs ")"
fetch-ann-resp = "ANNOTATION" SP "(" entry-att *(SP entry-att) ")" fetch-ann-resp = "ANNOTATION" SP "(" entry-att *(SP entry-att) ")"
store-att-flags =/ att-annotate store-att-flags =/ att-annotate
; modifies original IMAP4 STORE command ; modifies original IMAP4 STORE command
search-key =/ search-annotate search-key =/ search-annotate
skipping to change at page 20, line ? skipping to change at page 20, line ?
sort-annotate = "ANNOTATION" SP entry SP attrib sort-annotate = "ANNOTATION" SP entry SP attrib
entries = entry-match / entries = entry-match /
"(" entry-match *(SP entry-match) ")" "(" entry-match *(SP entry-match) ")"
attribs = attrib-match / attribs = attrib-match /
"(" attrib-match *(SP attrib-match) ")" "(" attrib-match *(SP attrib-match) ")"
entry-att = entry SP "(" att-value *(SP att-value) ")" entry-att = entry SP "(" att-value *(SP att-value) ")"
att-value = attrib SP value att-value = attrib SP value
utf8-char = %x01-FF entry = string
; any character, excluding NUL ; slash-separated path to entry
atom-slash = any utf8-char except "/" ; MUST NOT contain "*" or "%"
atom-dot = any utf8-char except "." entry-match = string
; slash-separated path to entry
entry = DQUOTE 1*atom-slash *("/" 1*atom-slash) DQUOTE ; MAY contain "*" or "%" for use as wildcards
entry-match = DQUOTE 1*entry-match-atom
*("/" 1*entry-match-atom) DQUOTE
entry-match-atom = 1*(list-wildcards / atom-slash)
*(list-wildcards / atom-slash)
attrib = DQUOTE 1*atom-dot *("." 1*atom-dot) DQUOTE attrib = string
attrib-match = DQUOTE 1*attrib-match-atom ; dot-separated attribute name
*("." 1*attrib-match-atom) DQUOTE ; MUST NOT contain "*" or "%"
attrib-match-atom = 1*(list-wildcards / atom-dot) attrib-match = string
*(list-wildcards / atom-dot) ; dot-separated attribute name
; MAY contain "*" or "%" for use as wildcards
value = nstring value = nstring
select =/ *(SP "(" select-param *(SP select-param) ")" select =/ *(SP "(" select-param *(SP select-param) ")"
; modifies the original IMAP4 select command to ; modifies the original IMAP4 select command to
Gellens & Daboo Expires September 2003 [Page 17]
; accept optional parameters ; accept optional parameters
examine =/ *(SP "(" select-param *(SP select-param) ")" examine =/ *(SP "(" select-param *(SP select-param) ")"
Gellens & Daboo Expires May 2003 [Page 17]
; modifies the original IMAP4 examine command to ; modifies the original IMAP4 examine command to
; accept optional parameters ; accept optional parameters
select-param = astring / "(" astring SP astring *(SP astring) ")" select-param = astring / "(" astring SP astring *(SP astring) ")"
; parameters to SELECT may contain one or ; parameters to SELECT may contain one or
; more atoms or strings - multiple items ; more atoms or strings - multiple items
; are always parenthesised ; are always parenthesised
annotate-param = "ANNOTATE" annotate-param = "ANNOTATE"
; defines the select parameter used with ; defines the select parameter used with
skipping to change at page 20, line ? skipping to change at page 20, line ?
vendor namespace. Vendor names MUST be registered. vendor namespace. Vendor names MUST be registered.
11.1 Entry and Attribute Registration Template 11.1 Entry and Attribute Registration Template
To: iana@iana.org To: iana@iana.org
Subject: IMAP Annotate Registration Subject: IMAP Annotate Registration
Please register the following IMAP Annotate item: Please register the following IMAP Annotate item:
[] Entry [] Attribute [] Entry [] Attribute
[] Vendor [] Open: RFC _______
Name: ______________________________ Name: ______________________________
Description: _______________________ Description: _______________________
____________________________________ ____________________________________
____________________________________ ____________________________________
Contact person: ____________________ Contact person: ____________________
email: ____________________ email: ____________________
12 Security Considerations 12 Security Considerations
The ANNOTATE extension does not raise any security considerations
that are not present in the base [IMAP4] protocol, and these issues
are discussed in [IMAP4].
Care must be taken to ensure that annotations whose values are Care must be taken to ensure that annotations whose values are
intended to remain private are not stored in mailboxes which are intended to remain private are not stored in mailboxes which are
accessible to other users. This includes mailboxes owned by the accessible to other users. This includes mailboxes owned by the
Gellens & Daboo Expires September 2003 [Page 18]
user by whose ACLs permit access by others as well as any shared user by whose ACLs permit access by others as well as any shared
mailboxes. mailboxes.
13 References 13 Normative References
Gellens & Daboo Expires May 2003 [Page 18]
[ABNF] Crocker, Overell, "Augmented BNF for Syntax Specifications: [ABNF] Crocker, Overell, "Augmented BNF for Syntax Specifications:
ABNF", RFC 2234, Internet Mail Consortium, Demon Internet Ltd, ABNF", RFC 2234, Internet Mail Consortium, Demon Internet Ltd,
November 1997. November 1997.
[ACAP] Newman, Myers, "ACAP -- Application Configuration Access [ACAP] Newman, Myers, "ACAP -- Application Configuration Access
Protocol", RFC 2244, Innosoft, Netscape, November 1997. Protocol", RFC 2244, Innosoft, Netscape, November 1997.
[ACL-EXT] Myers, "IMAP4 ACL extension", RFC 2086, Carnegie Mellon,
January 1997.
[IMAP4] Crispin, "Internet Message Access Protocol - Version 4rev1", [IMAP4] Crispin, "Internet Message Access Protocol - Version 4rev1",
RFC 2060, University of Washington, December 1996. RFC 2060, University of Washington, December 1996.
[KEYWORDS] Bradner, "Key words for use in RFCs to Indicate [KEYWORDS] Bradner, "Key words for use in RFCs to Indicate
Requirement Levels", RFC 2119, Harvard University, March 1997. Requirement Levels", RFC 2119, Harvard University, March 1997.
[MDNSENT] Melnikov, "MDN profile for IMAP", work in progress.
<http://www.ietf.org/internet-drafts/draft-melnikov-imap-mdn-05.txt>.
[SMTP-DSN] Moore, "SMTP Service Extension for Delivery Status [SMTP-DSN] Moore, "SMTP Service Extension for Delivery Status
Notifications", RFC 1891, University of Tennessee, January 1996. Notifications", RFC 1891, University of Tennessee, January 1996.
[SORT-EXT] Crispin, "Internet Message Access Protocol -- SORT [SORT-EXT] Crispin, "Internet Message Access Protocol -- SORT
Extension", work in progress. Extension", work in progress.
<http://www.ietf.org/internet-drafts/draft-ietf-imapext-sort-10.txt> <http://www.ietf.org/internet-drafts/draft-ietf-imapext-sort-10.txt>
14 Acknowledgments 14 Informative References
[ACL-EXT] Myers, "IMAP4 ACL extension", RFC 2086, Carnegie Mellon,
January 1997.
15 Acknowledgments
Many thanks to Chris Newman for his detailed comments on the first Many thanks to Chris Newman for his detailed comments on the first
draft of this document, and to the participants at the ACAP working draft of this document, and to the participants at the ACAP working
dinner in Pittsburgh. dinner in Pittsburgh.
15 Authors' Addresses 16 Authors' Addresses
Randall Gellens Randall Gellens
QUALCOMM Incorporated QUALCOMM Incorporated
5775 Morehouse Dr. 5775 Morehouse Dr.
San Diego, CA 92121-2779 San Diego, CA 92121-2779
U.S.A. U.S.A.
Email: randy@qualcomm.com Email: randy@qualcomm.com
Gellens & Daboo Expires September 2003 [Page 19]
Cyrus Daboo Cyrus Daboo
Cyrusoft International, Inc. Cyrusoft International, Inc.
Suite 780, 5001 Baum Blvd. Suite 780, 5001 Baum Blvd.
Pittsburgh, PA 15213 Pittsburgh, PA 15213
U.S.A. U.S.A.
Email: daboo@cyrusoft.com Email: daboo@cyrusoft.com
16 Full Copyright Statement 17 Full Copyright Statement
Gellens & Daboo Expires May 2003 [Page 19] Copyright (C) The Internet Society 2003. All Rights Reserved.
Copyright (C) The Internet Society 2002. All Rights Reserved.
This document and translations of it may be copied and furnished to This document and translations of it may be copied and furnished to
others, and derivative works that comment on or otherwise explain it others, and derivative works that comment on or otherwise explain it
or assist in its implementation may be prepared, copied, published or assist in its implementation may be prepared, copied, published
and distributed, in whole or in part, without restriction of any and distributed, in whole or in part, without restriction of any
kind, provided that the above copyright notice and this paragraph kind, provided that the above copyright notice and this paragraph
are included on all such copies and derivative works. However, this are included on all such copies and derivative works. However, this
document itself may not be modified in any way, such as by removing document itself may not be modified in any way, such as by removing
the copyright notice or references to the Internet Society or other the copyright notice or references to the Internet Society or other
Internet organizations, except as needed for the purpose of Internet organizations, except as needed for the purpose of
 End of changes. 

This html diff was produced by rfcdiff 1.23, available from http://www.levkowetz.com/ietf/tools/rfcdiff/