draft-ietf-imapext-annotate-00.txt   draft-ietf-imapext-annotate-01.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-00.txt July 2000 Document: draft-ietf-imapext-annotate-01.txt February 2001
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. Internet-Drafts are all provisions of Section 10 of RFC2026. Internet-Drafts are
working documents of the Internet Engineering Task Force (IETF), its working documents of the Internet Engineering Task Force (IETF), its
areas, and its working groups. Note that other groups may also areas, and its working groups. Note that other groups may also
distribute working documents as Internet-Drafts. distribute working documents as Internet-Drafts.
skipping to change at page 19, line ? skipping to change at page 19, line ?
at any time. It is inappropriate to use Internet-Drafts as at any time. It is inappropriate to use Internet-Drafts as
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. The list of Internet- http://www.ietf.org/ietf/1id-abstracts.txt. The list of Internet-
Draft Shadow Directories can be accessed at 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 2000. All Rights Reserved. Copyright (C) The Internet Society 2001. All Rights Reserved.
Gellens & Daboo Expires January 2001 [Page 1] Internet Draft IMAP ANNOTATE Extension July 2000 Gellens & Daboo Expires August 2001 [Page 1] Internet Draft IMAP ANNOTATE Extension February 2001
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 Document Meta-Data . . . . . . . . . . . . . . . . . . . . . 3 4 Document Meta-Data . . . . . . . . . . . . . . . . . . . . . 3
4.1 Open Issues . . . . . . . . . . . . . . . . . . . . . . . 3 4.1 Open Issues . . . . . . . . . . . . . . . . . . . . . . . 3
4.2 Change History . . . . . . . . . . . . . . . . . . . . . 3 4.2 Change History . . . . . . . . . . . . . . . . . . . . . 3
5 Introduction and Overview . . . . . . . . . . . . . . . . . . 3 5 Introduction and Overview . . . . . . . . . . . . . . . . . . 4
6 Data Model . . . . . . . . . . . . . . . . . . . . . . . . . 4 6 Data Model . . . . . . . . . . . . . . . . . . . . . . . . . 4
6.1 Overview . . . . . . . . . . . . . . . . . . . . . . . . 4 6.1 Overview . . . . . . . . . . . . . . . . . . . . . . . . 4
6.2 Namespace of Entries and Attributes . . . . . . . . . . 5 6.2 Namespace of Entries and Attributes . . . . . . . . . . 5
6.2.1 Entry Names . . . . . . . . . . . . . . . . . . . . . 5 6.2.1 Entry Names . . . . . . . . . . . . . . . . . . . . . 5
6.2.2 Attribute Names . . . . . . . . . . . . . . . . . . 7 6.2.2 Attribute Names . . . . . . . . . . . . . . . . . . 7
7 Private vs. Non-Private . . . . . . . . . . . . . . . . . . . 7 7 Private versus Shared . . . . . . . . . . . . . . . . . . . . 8
8 IMAP Protocol Changes . . . . . . . . . . . . . . . . . . . 8 8 IMAP Protocol Changes . . . . . . . . . . . . . . . . . . . 9
8.1 ANNOTATION Message Data Item in FETCH Command . . . . . . 8 8.1 ANNOTATION Message Data Item in FETCH Command . . . . . . 9
8.2 ANNOTATION Message Data Item in FETCH Response . . . . . 10 8.2 ANNOTATION Message Data Item in FETCH Response . . . . . 10
8.3 ANNOTATION Message Data Item in STORE . . . . . . . . . . 11 8.3 ANNOTATION Message Data Item in STORE . . . . . . . . . . 12
8.3.1 Conditional Annotation STORE . . . . . . . . . . . . 12 8.4 ANNOTATION Message Data Item in APPEND . . . . . . . . . 13
8.4 ANNOTATION Message Data Item in APPEND . . . . . . . . . 12 8.5 ANNOTATION Criterion in SEARCH . . . . . . . . . . . . . 13
8.5 ANNOTATION-MODTIME Message Data Item in STATUS . . . . . 13 8.6 ANNOTATION Key in SORT . . . . . . . . . . . . . . . . . 14
8.6 ANNOTATION Criterion in SEARCH . . . . . . . . . . . . . 13 8.7 ACL Rights . . . . . . . . . . . . . . . . . . . . . . . 15
8.7 ANNOTATION Key in SORT . . . . . . . . . . . . . . . . . 14 9 Interaction with MODTIME . . . . . . . . . . . . . . . . . . 15
8.8 Annotation Modtime Untagged Response . . . . . . . . . . 14 10 Formal Syntax . . . . . . . . . . . . . . . . . . . . . . . . 15
8.9 ACL Rights . . . . . . . . . . . . . . . . . . . . . . . 15 11 IANA Considerations . . . . . . . . . . . . . . . . . . . . 17
9 Formal Syntax . . . . . . . . . . . . . . . . . . . . . . . . 15 11.1 Entry and Attribute Registration Template . . . . . . . . 17
10 IANA Considerations . . . . . . . . . . . . . . . . . . . . 16 12 Security Considerations . . . . . . . . . . . . . . . . . . 17
10.1 Entry and Attribute Registration Template . . . . . . . . 17 13 References . . . . . . . . . . . . . . . . . . . . . . . . . 17
11 Security Considerations . . . . . . . . . . . . . . . . . . 17 14 Acknowledgments . . . . . . . . . . . . . . . . . . . . . . 18
12 References . . . . . . . . . . . . . . . . . . . . . . . . . 17 15 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . 18
13 Acknowledgments . . . . . . . . . . . . . . . . . . . . . . 18 16 Full Copyright Statement . . . . . . . . . . . . . . . . . . 18
14 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . 18
15 Full Copyright Statement . . . . . . . . . . . . . . . . . . 18
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
Gellens & Daboo Expires January 2001 [Page 2] Internet Draft IMAP ANNOTATE Extension July 2000
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
Gellens & Daboo Expires August 2001 [Page 2] Internet Draft IMAP ANNOTATE Extension February 2001
document are to be interpreted as described in RFC 2119 [KEYWORDS]. document are to be interpreted as described in RFC 2119 [KEYWORDS].
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 Document Meta-Data 4 Document Meta-Data
4.1 Open Issues 4.1 Open Issues
At points in this document open issues are discussed, marked by the At points in this document open issues are discussed, marked by the
text "<<<OPEN-ISSUE>>>". These are items which have not been text "<<<OPEN-ISSUE>>>". These are items which have not been
finalized. Discussion and comment is requested. Please use the finalized. Discussion and comment is requested. Please use the
IETF IMAP Extensions mailing list, as described in section IETF IMAP Extensions mailing list, as described in section
2. 2.
4.2 Change History 4.2 Change History
Changes since -00: Changes from -01 to -02:
1. MODTIME moved to its own draft, which this draft now
depends on. Thus, Conditional Annotation STORE and
related items deleted from this draft.
2. Private versus Shared Annotations: both are possible
(separately addressable using ".priv" and ".shared"
suffixes). There is a per-mailbox setting for the
default. It is an open issue how this is viewed or
changed by the client.
3. In ACLs, the "w" right is needed to updated shared state;
the "s" right is needed to update private state.
4. Various clarifications and text modifications.
5. Added 'forwarded' flag for message parts.
Changes from -00 to -01:
1. Clarified text describing attributions, entries, and 1. Clarified text describing attributions, entries, and
attributes. attributes.
2. Changed 'modifiedsince' to 'modtime'; referenced ACAP spec. 2. Changed 'modifiedsince' to 'modtime'; referenced ACAP spec.
3. Deleted 'queued' flag. 3. Deleted 'queued' flag.
4. Expanded and explained smtp-envelope entry. 4. Expanded and explained smtp-envelope entry.
5. Restricted including ANNOTATION data in unsolicited responses 5. Restricted including ANNOTATION data in unsolicited responses
until the client uses it first. (Open issue as to if needed). until the client uses it first. (Open issue as to if needed).
6. Examples now only use valid entries and attributes. 6. Examples now only use valid entries and attributes.
7. Updated Security Considerations. 7. Updated Security Considerations.
8. Content-Type now defaults to text/plain. 8. Content-Type now defaults to text/plain.
9. Open Issue: Shared vs. private annotations. 9. Open Issue: Shared vs. private annotations.
10. Open issue: Annotation Modtime untagged response or VALIDTIME 10. Open issue: Annotation Modtime untagged response or VALIDTIME
FETCH data. FETCH data.
11. Open issue: Conditional annotation STORE. 11. Open issue: Conditional annotation STORE.
12. ANNOTATION criterion available if both "ANNOTATE" and "SORT" 12. ANNOTATION criterion available if both "ANNOTATE" and "SORT"
in CAPABILITY command response. in CAPABILITY command response.
Gellens & Daboo Expires August 2001 [Page 3] Internet Draft IMAP ANNOTATE Extension February 2001
13. Prohibition on annotations in lieu of base spec functionality. 13. Prohibition on annotations in lieu of base spec functionality.
14. Specified required ACL rights. 14. Specified required ACL rights.
15. ANNOTATION message data item in APPEND. 15. ANNOTATION message data item in APPEND.
16. ANNOTATION-MODTIME message data item in STATUS. 16. ANNOTATION-MODTIME message data item in STATUS.
17. Replaced ATOM_CHAR with utf8-char. 17. Replaced ATOM_CHAR with utf8-char.
18. Updated other ABNF entries. 18. Updated other ABNF entries.
5 Introduction and Overview 5 Introduction and Overview
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
Gellens & Daboo Expires January 2001 [Page 3] Internet Draft IMAP ANNOTATE Extension July 2000
CAPABILITY command response. CAPABILITY command 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 APPEND STORE commands, as well as adding SEARCH and SORT keys and APPEND
and STATUS modifiers. and STATUS modifiers.
This extension makes the following changes to the IMAP4 protocol: This extension makes the following changes to the IMAP4 protocol:
a) adds a new ANNOTATION message data item for use in the FETCH a) adds a new ANNOTATION message data item for use in FETCH
command b) adds a new ANNOTATION message data item for use in STORE
b) adds a new ANNOTATION message data item for use in the STORE c) adds a new ANNOTATION search criterion for use in SEARCH
command d) adds a new ANNOTATION sort key for use in SORT extension
c) adds a new ANNOTATION search criterion for use in the SEARCH e) adds a new ANNOTATION data item for use in APPEND
command
d) adds a new ANNOTATION sort key for use in the SORT command
extension
e) adds a new ANNOTATION data item for use in the APPEND command
f) adds a new ANNOTATION-MODTIME modifier for use in the STATUS
command
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 behavior vendor namespace together with ".PEEK" in fetches. Such behavior
would significantly reduce IMAP interoperability. would significantly reduce IMAP interoperability.
<<<OPEN-ISSUE>>>
A possible exception to this rule is the potential use of annotation
flags in lieu of or as an alternate means of accessing IMAP flags.
The rest of this document describes the data model and protocol The rest of this document describes the data model and protocol
changes more rigorously. changes more rigorously.
6 Data Model 6 Data Model
6.1 Overview 6.1 Overview
The data model used in ANNOTATE is that of a uniquely named entry The data model used in ANNOTATE is that of a uniquely named entry
with a set of uniquely named attributes, each of which has a value. which contains a set of standard attributes. A single coherent unit
A single coherent unit of "metadata" for a message is stored as a of "metadata" for a message is stored as a single entry, made up of
single entry, made up of several attributes. several attributes.
Gellens & Daboo Expires August 2001 [Page 4] Internet Draft IMAP ANNOTATE Extension February 2001
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", "modtime", etc. which contain the properties and such as "value", "modtime", etc. which contain the properties and
data of the entry. data 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
so (see section 8.9 for specifics). so (see section 8.7 for specifics).
Gellens & Daboo Expires January 2001 [Page 4] Internet Draft IMAP ANNOTATE Extension July 2000
6.2 Namespace of Entries and Attributes 6.2 Namespace of Entries and Attributes
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 a string of zero The value of an attribute is NIL (has no value), or is a string of
or more octets. zero or more octets.
Entry and attribute names are not permitted to contain asterisk Entry and attribute names MUST NOT contain asterisk ("*") or percent
("*") or percent ("%") characters and MUST be valid UTF-8 strings ("%") characters and MUST be valid UTF-8 strings which do not
which do not contain NUL. Invalid entry or attribute names result contain the NULL octet. Invalid entry or attribute names result in
in a BAD response in any IMAP commands where they are used. a BAD response in any IMAP commands where they are used.
Use of non-visible UTF-8 characters in entry and attribute names is Use of non-visible UTF-8 characters in entry and attribute names is
strongly discouraged. strongly discouraged.
This specification defines an initial set of entry and attribute This specification defines an initial set of entry and attribute
names available for use in message annotations. In addition, an names available for use in message annotations. In addition, an
extension mechanism is described to allow additional names to be extension mechanism is described to allow additional names to be
added for extensibility. added for extensibility.
6.2.1 Entry Names 6.2.1 Entry Names
Entry names MUST be specified in a standards track or IESG approved Entry names MUST be specified in a standards track or IESG approved
experimental RFC, or fall under the vendor namespace. See section experimental RFC, or fall under the vendor namespace. See section
10.1 for the registration template. 11.1 for the registration template.
/message /message
Defines the top-level of entries associated with an entire Defines the top-level of entries associated with an entire
message. This entry itself does not contain any attributes. message. This entry itself does not contain any attributes.
/message/comment /message/comment
Defines a comment or note associated with an entire message. Defines a comment or note associated with an entire message.
Gellens & Daboo Expires August 2001 [Page 5] Internet Draft IMAP ANNOTATE Extension February 2001
/message/flags /message/flags
Defines the top-level of entries for client-use flags associated Defines the top-level of entries for client-use flags associated
with an entire message. All sub-entries are maintained entirely with an entire message. All sub-entries are maintained entirely
by the client. There is no implicit change to any flag by the by the client. There is no implicit change to any flag by the
server. server.
/message/flags/redirected /message/flags/redirected
/message/flags/forwarded /message/flags/forwarded
Defines client-use flags for an entire message. The "value" Defines client-use flags for an entire message. The "value"
attribute of these entries must be either "1", "0" or NIL. The attribute of these entries must be either "1", "0" or NIL. The
'redirected' flag indicates that a message has been handed off 'redirected' flag indicates that a message has been handed off
to someone else, by resending the message with minimal to someone else, by resending the message with minimal
Gellens & Daboo Expires January 2001 [Page 5] Internet Draft IMAP ANNOTATE Extension July 2000
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. The 'forwarded' flag indicates the message was
resent to another user, embedded within or attached to a new resent to another user, embedded within or attached to a new
message. message.
/message/smtp-envelope /message/smtp-envelope
Defines the top-level of entries which together describe the Defines the top-level of entries which together describe the
SMTP envelope used in delivery of the message. There are no SMTP envelope used in delivery of the message. There are no
attributes at this level. The client SHOULD NOT modify the attributes at this level. The client SHOULD NOT modify the
skipping to change at page 19, line ? skipping to change at page 19, line ?
client-specific attributes. The vendor-token MUST be registered client-specific attributes. The vendor-token MUST be registered
with IANA. with IANA.
/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
[IMAP4]. [IMAP4].
Gellens & Daboo Expires August 2001 [Page 6] Internet Draft IMAP ANNOTATE Extension February 2001
/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.
/body/<part-specifier>/flags/seen /body/<part-specifier>/flags/seen
/body/<part-specifier>/flags/answered /body/<part-specifier>/flags/answered
/body/<part-specifier>/flags/flagged /body/<part-specifier>/flags/flagged
/body/<part-specifier>/flags/forwarded
Gellens & Daboo Expires January 2001 [Page 6] Internet Draft IMAP ANNOTATE Extension July 2000
Defines flags for a specific body part of a message. The Defines flags for a specific body part of a message. The
"value" attribute of these entries must be either "1", "0" or "value" attribute of these entries must be either "1", "0" or
NIL. NIL.
/body/<part-specifier>/vendor/<vendor-token> /body/<part-specifier>/vendor/<vendor-token>
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 as created by a particular product of some part of a message as created by a particular product of some
vendor. This entry can be used by vendors to provide client vendor. This entry can be used by vendors to provide client
specific attributes. The vendor-token MUST be registered with specific attributes. The vendor-token MUST be registered with
IANA. IANA.
6.2.2 Attribute Names 6.2.2 Attribute Names
Attribute names MUST be specified in a standards track or IESG Attribute names MUST be specified in a standards track or IESG
approved experimental RFC, or fall under the vendor namespace. See approved experimental RFC, or fall under the vendor namespace. See
section 10.1 for the registration template. section 11.1 for the registration template.
All attribute names implicitly have a ".priv" and a ".shared" suffix
which maps to private and shared versions of the entry. Searching
or fetching without using either suffix includes both. Storing
without using either suffix stores into the default. The default is
set per-mailbox. See section 7 for more information.
value value
The data value of the attribute. The data value of the attribute.
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.
modtime modtime
An opaque value set by the server when this entry is modified. An opaque value set by the server when this entry is modified.
It can be used by the client to request notification of which It can be used by the client to request notification of which
entries have changed relative to that of a known entry. In entries have changed relative to that of a known entry. In
addition to its use in disconnected/synchronization operations, addition to its use in disconnected/synchronization operations,
it can also be helpful in determining which entries have changed it can also be helpful in determining which entries have changed
while a client is connected. (The value is intended to be used while a client is connected. (The value is intended to be used
Gellens & Daboo Expires August 2001 [Page 7] Internet Draft IMAP ANNOTATE Extension February 2001
only for comparisons within a server, not as an accurate only for comparisons within a server, not as an accurate
timestamp.) It is described more fully in section 3.1.1 of timestamp.) It is described more fully in section 3.1.1 of
[ACAP]. [ACAP].
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.
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.
7 Private vs. Non-Private 7 Private versus Shared
<<<OPEN-ISSUE>>>
Gellens & Daboo Expires January 2001 [Page 7] Internet Draft IMAP ANNOTATE Extension July 2000
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.
If all annotations are private, it is impossible to set annotations If all annotations are private, it is impossible to set annotations
in a shared or otherwise non-private mailbox that are visible to in a shared or otherwise non-private mailbox that are visible to
other users. This eliminates what could be a useful aspect of other users. This eliminates what could be a useful aspect of
annotations in a shared environment. annotations in a shared environment. An example of such use is a
shared IMAP folder containing bug reports. Engineers may want to
use annotations to add information to existing messages, indicate
assignments, status, etc. This use requires shared annotations.
If all annotations are shared, it is impossible to use annotations If all annotations are shared, it is impossible to use annotations
for private notes on messages in shared mailboxes. Also, modifying for private notes on messages in shared mailboxes. Also, modifying
an ACL to permit access to a mailbox by other users may an ACL to permit access to a mailbox by other users may
unintentionally expose private information. unintentionally expose private information.
For example, an administrator may want to set shared annotations on There are also situations in which both shared and private
messages in a shared folder, which individual users may wish to annotations are useful. For example, an administrator may want to
supplement with additional notes. set shared annotations on messages in a shared folder, which
individual users may wish to supplement with additional notes.
If shared and private annotations are to coexist, we need a clear If shared and private annotations are to coexist, we need a clear
way to differentiate them. Also, it should be as easy as possible way to differentiate them. Also, it should be as easy as possible
for a client to access both and not overlook either. for a client to access both and not overlook either. There is also
a danger in allowing a client to store an annotation without knowing
if it is shared or private.
One suggestion is to duplicate all attributes, with 'pers.' and This document proposes two standard suffixes for all attributes:
'shared.' prefixes. For example, instead of there being one 'size' ".shared" and ".priv". A search, fetch, or sort which specifies
attribute in an entry, there would be two: 'pers.size' and neither uses both. A store without using either stores into the
'shared.size'. Both would be returned by default to the client, to
make sure the client didn't miss one. Gellens & Daboo Expires August 2001 [Page 8] Internet Draft IMAP ANNOTATE Extension February 2001
default.
<<<OPEN-ISSUE>>>
This is dangerous since it allows a client to store an entry without
knowing if other users are able to view it.
How a client learns or changes the default is an open issue. One
suggestion is to use an additional ACL bit to indicate the current
default state.
It may be better to remove the default, and force clients to always
explicitly store into one or the other.
8 IMAP Protocol Changes 8 IMAP Protocol Changes
8.1 ANNOTATION Message Data Item in FETCH Command 8.1 ANNOTATION Message Data Item in FETCH Command
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:
C: a FETCH 1 (ANNOTATION ("/message/comment" "value")) C: a FETCH 1 (ANNOTATION ("/message/comment" "value"))
S: * 1 FETCH (ANNOTATION ("/message/comment" (("value" S: * 1 FETCH (ANNOTATION ("/message/comment"
"My comment")))) ("value.priv" "My comment"
"value.shared" "Group note")))
S: a OK Fetch complete S: a OK Fetch complete
Gellens & Daboo Expires January 2001 [Page 8] Internet Draft IMAP ANNOTATE Extension July 2000
In the above example, the content of the "value" attribute for the In the above example, the content of the "value" attribute for the
"/message/comment" entry is requested by the client and returned by "/message/comment" entry is requested by the client and returned by
the server. the server. Since neither ".shared" nor ".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" "modtime"))) C: a FETCH 1 (ANNOTATION ("/message/*" ("value.priv"
"modtime.priv")))
S: * 1 FETCH (ANNOTATION S: * 1 FETCH (ANNOTATION
(("/message/comment" ("value" "My comment"
"modtime" "20000704000001")) Gellens & Daboo Expires August 2001 [Page 9] Internet Draft IMAP ANNOTATE Extension February 2001
("/message/subject" ("value" "Rhinoceroses!"
"modtime" "19991231235959")) (("/message/comment" ("value.priv" "My comment"
("/message/vendor/eudora/label" ("value" "label43" "modtime.priv" "20000704000001"))
"modtime" "20000705101502")) ("/message/subject" ("value.priv" "Rhinoceroses!"
"modtime.priv" "19991231235959"))
("/message/vendor/eudora/label.priv"
("value.priv" "label43"
"modtime.priv" "20000705101502"))
("/message/vendor/eudora/personality" ("/message/vendor/eudora/personality"
("value" "Tallulah Bankhead" ("value.priv" "Tallulah Bankhead"
"modtime" "20000705101558")))) "modtime.priv" "20000705101558"))))
S: a OK Fetch complete S: a OK Fetch complete
In the above example, the contents of the "value" and "modtime" In the above example, the contents of the private "value" and
attributes for any entries in the "/message" hierarchy are requested "modtime" attributes for any entries in the "/message" hierarchy are
by the client and returned by the server. requested by the client and returned by the server.
C: a FETCH 1 (ANNOTATION ("/message/%" "value")) C: a FETCH 1 (ANNOTATION ("/message/%" "value.shared"))
S: * 1 FETCH (ANNOTATION S: * 1 FETCH (ANNOTATION
(("/message/comment" ("value" "Patch Mangler")) (("/message/comment" ("value.shared" "Patch Mangler"))
("/message/subject" ("/message/subject" ("value.shared" "Patches? We don'
("value" "Patches? We don' 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 "value" attributes for In the above example, the contents of the shared "value" attributes
entries at the top level only of the "/message" hierarchy are for entries at the top level only of the "/message" hierarchy are
requested by the client and returned by the server. requested by the client and 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
that multiple items of each type may be returned in a single FETCH that multiple items of each type may be returned in a single FETCH
command. command.
Examples: Examples:
C: a FETCH 1 (ANNOTATION C: a FETCH 1 (ANNOTATION
(("/message/comment" "/message/subject") "value")) (("/message/comment" "/message/subject") "value.priv"))
S: * 1 FETCH (ANNOTATION S: * 1 FETCH (ANNOTATION
(("/message/comment" ("value" "What a chowder-head")) (("/message/comment" ("value.priv" "What a chowder-head"))
("/message/subject" ("value" "How to crush beer cans")))) ("/message/subject" ("value.priv" "How to crush beer
cans"))))
S: a OK Fetch complete S: a OK Fetch complete
Gellens & Daboo Expires January 2001 [Page 9] Internet Draft IMAP ANNOTATE Extension July 2000 In the above example, the contents of the private "value" attributes
for the two entries "/message/comment" and "/message/subject" are
In the above example, the contents of the "value" attributes for the requested by the client and returned by the server.
two entries "/message/comment" and "/message/subject" are requested
by the client and returned by the server.
8.2 ANNOTATION Message Data Item in FETCH Response 8.2 ANNOTATION Message Data Item in FETCH Response
The ANNOTATION message data item in the FETCH response displays The ANNOTATION message data item in the FETCH response displays
information about annotations in a message. information about annotations in a message.
ANNOTATION parenthesised list ANNOTATION parenthesised list
Gellens & Daboo Expires August 2001 [Page 10] Internet Draft IMAP ANNOTATE Extension February 2001
The response consists of a list of entries, each of which has a The response consists of a list of entries, each of which has a
list of attribute-value pairs. list of attribute-value pairs.
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" "My comment")))) ("value.priv" "My comment"
"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. pair is returned by the server. Since the client did not specify a
".shared" or ".priv" suffix, both are returned. Only the private
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" "My comment")) (("/message/comment" ("value.priv" "My comment"
("/message/subject" ("value" "My subject")))) "value.shared" NIL))
("/message/subject" ("value.priv" "My subject"
"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. pair are returned by the server. Since the client did not specify a
".shared" or ".priv" suffix, both are returned. Only the private
attributes have values; the shared attributes are NIL.
C: a FETCH 1 (ANNOTATION C: a FETCH 1 (ANNOTATION
("/message/comment" ("value" "modtime"))) ("/message/comment" ("value" "modtime")))
S: * 1 FETCH (ANNOTATION S: * 1 FETCH (ANNOTATION
(("/message/comment" (("/message/comment"
("value" "My comment" ("value.priv" "My comment"
"modtime" "19990203205432")))) "value.shared" NIL
"modtime.priv" "19990203205432"
"modtime.shared" NIL))))
S: a OK Fetch complete S: a OK Fetch complete
In the above example, a single entry with two attribute-value pairs In the above example, a single entry with two attribute-value pairs
is returned by the server. is returned by the server. Since the client did not specify a
".shared" or ".priv" suffix, both are returned. Only the private
attributes have values; the shared attributes are NIL.
Servers SHOULD send ANNOTATION message data items in unsolicited Servers SHOULD send ANNOTATION message data items in unsolicited
FETCH responses if the annotation is changed by a third-party, FETCH responses if an annotation entry is changed by a third-party.
allowing servers to keep clients updated with changes to annotations This allows servers to keep clients updated with changes to
by other clients. However, servers MUST NOT include ANNOTATION data annotations by other clients.
in unsolicited responses until the client has used ANNOTATION data
in a FETCH command. This restriction avoids sending ANNOTATION data
to a client until the client has shown it is capable of handling it.
Gellens & Daboo Expires January 2001 [Page 10] Internet Draft IMAP ANNOTATE Extension July 2000 Servers MUST NOT include ANNOTATION data in unsolicited responses
until the client has used ANNOTATION data in a FETCH command. This
restriction avoids sending ANNOTATION data to a client until the
Gellens & Daboo Expires August 2001 [Page 11] Internet Draft IMAP ANNOTATE Extension February 2001
client has shown it is capable of handling it.
<<<OPEN-ISSUE>>> <<<OPEN-ISSUE>>>
Is this prohibition really neccesary? Is this prohibition really necessary?
* OK [ANNOTATIONS FLAGS MODTIME <modtime> <set>]
8.3 ANNOTATION Message Data Item in STORE 8.3 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.
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" behavior. This means the server does not implicit ".SILENT" behavior. 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"
("value" "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 attribute "value" with data set to "My not already present) and the private attribute "value" with data set
new comment" is created if not already present, or replaced if it to "My new comment" is created if not already present, or replaced
exists. if it exists.
C: a STORE 1 ANNOTATION ("/message/comment" ("value" NIL)) C: a STORE 1 ANNOTATION ("/message/comment"
("value.shared" NIL))
S: a OK Store complete S: a OK Store complete
In the above example, the "value" attribute of the entry In the above example, the shared "value" attribute of the entry
"/message/comment" is removed. "/message/comment" is removed.
Multiple entries can be set in a single STORE command by listing Multiple entries can be set in a single STORE command by listing
entry-attribute-value pairs in the list. entry-attribute-value pairs in the list.
Example: Example:
C: a STORE 1 ANNOTATION ("/message/comment" ("value" C: a STORE 1 ANNOTATION ("/message/comment" ("value.priv"
"Get tix Tuesday") "Get tix Tuesday")
"/message/subject" ("value" "/message/subject" ("value.priv"
"Wots On")) "Wots On"))
S: a OK Store complete S: a OK Store complete
In the above example, the entries "/message/comment" and In the above example, the entries "/message/comment" and
"/message/subject" are created (if not already present) and the "/message/subject" are created (if not already present) and the
attribute "value" is created for each entry if not already present, private attribute "value" is created for each entry if not already
or replaced if they exist. present, or replaced if they exist.
Gellens & Daboo Expires August 2001 [Page 12] Internet Draft IMAP ANNOTATE Extension February 2001
Multiple attributes can be set in a single STORE command by listing Multiple attributes can be set in a single STORE command by listing
multiple attribute-value pairs in the entry list. multiple attribute-value pairs in the entry list.
Gellens & Daboo Expires January 2001 [Page 11] Internet Draft IMAP ANNOTATE Extension July 2000
Example: Example:
C: a STORE 1 ANNOTATION ("/message/comment" C: a STORE 1 ANNOTATION ("/message/comment"
("value" "My new comment" ("value.priv" "My new comment"
"vendor.foobar" "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 attributes "value" and "vendor.foobar" not already present) and the private attributes "value" and
are created if not already present, or replaced if they exist. "vendor.foobar" are created if not already present, or replaced if
they exist.
8.3.1 Conditional Annotation STORE
<<<OPEN ISSUE>>>
Should there be a STORE modifier which permits the client to detect
and avoid a collision?
MODTIME <modtime>
Instructs the server to abort the STORE and return a NO response
if any specified entry has a modtime attribute greater than the
supplied value.
Examples:
C: a STORE 1 ANNOTATION MODTIME 19720612140000
("/message/comment" ("value" "Tune a Fish?"))
S: a NO Entry modified since specified value
In the above example, the client attempts a STORE into the
"/message/comment" entry which is conditioned on the entry modtime
being 19720612140000 or earlier.
C: a STORE 1 ANNOTATION MODTIME 19720612140000
("/message/comment" ("value" "No Comment")
"/message/subject" ("value" "The King Is Not a Subject"))
S: a NO Entry modified since specified value
In the above example, the client attempts a STORE into the
"/message/comment" and "/message/subject" entries which is
conditioned on neither of the entry modtimes being greater than
19720612140000.
8.4 ANNOTATION Message Data Item in APPEND 8.4 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"
("value" "Don't send until we hear from Sally")) {310} ("value.priv" "Don't send until we hear from Sally")) {310}
S: + Ready for literal data S: + Ready for literal data
Gellens & Daboo Expires January 2001 [Page 12] Internet Draft IMAP ANNOTATE Extension July 2000
C: MIME-Version: 1.0 C: MIME-Version: 1.0
... ...
C: C:
S: a OK APPEND completed S: a OK APPEND completed
In the above example, a comment is added to a new message appended In the above example, a comment with a private value is added to a
to the mailbox. The ellipsis represents the bulk of the message.\ new message appended to the mailbox. The ellipsis represents the
bulk of the message.
8.5 ANNOTATION-MODTIME Message Data Item in STATUS
ANNOTATION-MODTIME
Requests that the STATUS command results include the latest
modtime of all annotation entries of all messages in the
mailbox.
Example:
C: a STATUS cards (ANNOTATION-MODTIME MESSAGES)
S: * STATUS cards (MESSAGES 231
ANNOTATION-MODTIME 19991114020700)
S: a OK STATUS completed
8.6 ANNOTATION Criterion in SEARCH 8.5 ANNOTATION Criterion in SEARCH
The ANNOTATION criterion for the SEARCH command allows a client to The ANNOTATION criterion for the SEARCH command allows a client to
search for a specified string in the value of an annotation entry of search for a specified string in the value of an annotation entry of
a message. a message.
ANNOTATION <entry-name> <attribute-name> <value> ANNOTATION <entry-name> <attribute-name> <value>
Messages that have annotations with entries matching <entry-name> Messages that have annotations with entries matching <entry-name>
and attributes matching <attribute-name> and the specified string and attributes matching <attribute-name> and the specified string
<value> in their values are returned in the SEARCH results. The "*" <value> in their values are returned in the SEARCH results. The "*"
character can be used in the entry or attribute name fields to match character can be used in the entry or attribute name fields to match
any content in those items. The "%" character can be used in the any content in those items. The "%" character can be used in the
entry or attribute name fields to match a single level of hierarchy entry or attribute name fields to match a single level of hierarchy
only. only.
Examples: Examples:
C: a SEARCH ANNOTATION "/message/comment" "value" "IMAP4" C: a SEARCH ANNOTATION "/message/comment" "value" "IMAP4"
Gellens & Daboo Expires August 2001 [Page 13] Internet Draft IMAP ANNOTATE Extension February 2001
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 "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.
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
Gellens & Daboo Expires January 2001 [Page 13] Internet Draft IMAP ANNOTATE Extension July 2000
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 of any entry are returned in the the string "IMAP4" in any attribute (public or private) of any entry
search results. are returned in the search results.
A special case exists when the "modtime" attribute is used as the A special case exists when the "modtime" attribute is used as the
<attribute-name> parameter in the ANNOTATION search criterion. In <attribute-name> parameter in the ANNOTATION search criterion. In
this case the server matches messages when the corresponding this case the server matches messages when the corresponding
"modtime" value is greater than the value supplied in the ANNOTATION "modtime" value is greater than the value supplied in the ANNOTATION
criterion. This allows a client, for example, to find out which criterion. This allows a client, for example, to find out which
messages contain annotations that have changed since the last time messages contain annotations that have changed since the last time
it updated its disconnected cache. it updated its disconnected cache.
Example: Example:
C: a SEARCH ANNOTATION "*" "modtime" "1999101713283412" C: a SEARCH ANNOTATION "*" "modtime" "1999101713283412"
S: * SEARCH 1 3 6 10 15 21 28 36 45 55 S: * SEARCH 1 3 6 10 15 21 28 36 45 55
S: a OK Search complete S: a OK Search complete
In the above example, the message numbers of any messages whose In the above example, the message numbers of any messages whose
"modtime" attribute of any entry exceeds the value "modtime" attribute of any entry exceeds the value
"1999101713283412" are returned in the search results. "1999101713283412" are returned in the search results. Both public
and private attributes are searched.
8.7 ANNOTATION Key in SORT 8.6 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.
ANNOTATION <entry-name> <attribute-name> ANNOTATION <entry-name> <attribute-name>
Messages are sorted using the values of the <attribute-name> Messages are sorted using the values of the <attribute-name>
attributes in the <entry-name> entries. (The charset argument attributes in the <entry-name> entries. (The charset argument
determines sort order, as specified in the SORT extension determines sort order, as specified in the SORT extension
description.) description.)
Examples: Examples:
C: a SORT (ANNOTATION "/message/subject" "value") UTF-8 ALL C: a SORT (ANNOTATION "/message/subject" "value.shared") UTF-8
ALL
Gellens & Daboo Expires August 2001 [Page 14] Internet Draft IMAP ANNOTATE Extension February 2001
S: * SORT 2 3 4 5 1 11 10 6 7 9 8 S: * SORT 2 3 4 5 1 11 10 6 7 9 8
S: a OK Sort complete S: a OK Sort complete
In the above example, the message numbers of all messages are In the above example, the message numbers of all messages are
returned, sorted according to the "value" attribute of the returned, sorted according to the shared "value" attribute of the
"/message/subject" entry. "/message/subject" entry.
Note that the ANNOTATION sort key must include a fully specified Note that the ANNOTATION sort key must include a fully specified
entry and attribute -- wildcards are not allowed. entry and attribute -- wildcards are not allowed.
8.8 Annotation Modtime Untagged Response 8.7 ACL Rights
Gellens & Daboo Expires January 2001 [Page 14] Internet Draft IMAP ANNOTATE Extension July 2000
<<<OPEN-ISSUE>>> The "r" right, as specified in [ACL-EXT], is required to use
annotations in any command other than STORE.
Should there be an untagged Annotation Modtime response? This would The "w" right is needed to use shared annotations in the STORE
be issued by the server during a FETCH or SEARCH command to informs command.
the client of the latest modtime of all entries specified in the
FETCH or returned in the SEARCH results. It would also be issued
following a group of one or more unsolicited FETCH responses to
indicate that the client has received all updates to entries which
have modtime values less than or equal to the indicated modtime
value.
* ANNOTATION-MODTIME <modtime> The "s" right is needed to use private annotations in the STORE
Informs the client of the latest modtime used in immediately command.
prior results.
Example: <<<OPEN-ISSUE>>>
C: a SEARCH ANNOTATION "*" "modtime" "1999101713283412"
S: * SEARCH 1 3 6 10 15 21 28 36 45 55
S: * ANNOTATION-MODTIME 20000624140000
S: a OK Search complete
8.9 ACL Rights Should there be a special ACL bit to indicate if annotations are
shared or private by default for a mailbox?
The "r" right, as specified in [ACL-EXT], is required to use 9 Interaction with MODTIME
annotations in any command other than STORE.
The "w" right is needed to use annotations in the STORE command. The [MODTIME-EXT] document defines an IMAP extension which allows
clients to be supplied with an opaque value called a modtime. The
specific value is server dependent, but has the property that all
such values issued by a server are numerically increasing with
respect to the order of changes. That is, for any two items, the
one that was modified later has a greater modtime.
9 Formal Syntax 10 Formal Syntax
The following syntax specification uses the Augmented Backus-Naur The following syntax specification uses the Augmented Backus-Naur
Form (ABNF) notation as specified in [ABNF]. Form (ABNF) notation as specified in [ABNF].
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 August 2001 [Page 15] Internet Draft IMAP ANNOTATE Extension February 2001
[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 = "(" entry-att *(SP entry-att) ")"
fetch-att =/ fetch-annotate fetch-att =/ fetch-annotate
; modifies original IMAP4 fetch-att ; modifies original IMAP4 fetch-att
Gellens & Daboo Expires January 2001 [Page 15] Internet Draft IMAP ANNOTATE Extension July 2000
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
; modifies original IMAP4 search-key ; modifies original IMAP4 search-key
search-annotate = "ANNOTATION" SP entry-match SP attrib-match search-annotate = "ANNOTATION" SP entry-match SP attrib-match
SP value SP value
sort-key =/ sort-annotate sort-key =/ sort-annotate
; modifies original ; modifies original
; draft-crispin-imapext-sort-xx.txt sort-key ; draft-crispin-imapext-sort-xx.txt sort-key
sort_annotate = "ANNOTATION" SP entry SP attrib sort-annotate = "ANNOTATION" SP entry SP attrib
status =/ "ANNOTATION-MODTIME" status =/ "ANNOTATION-MODTIME"
; modifies original IMAP4 STATUS command ; modifies original IMAP4 STATUS command
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
skipping to change at page 19, line ? skipping to change at page 19, line ?
entry = DQUOTE 1*atom-slash *("/" 1*atom-slash) DQUOTE entry = DQUOTE 1*atom-slash *("/" 1*atom-slash) DQUOTE
entry-match = DQUOTE 1*entry-match-atom entry-match = DQUOTE 1*entry-match-atom
*("/" 1*entry-match-atom) DQUOTE *("/" 1*entry-match-atom) DQUOTE
entry-match-atom = 1*(list-wildcards / atom-slash) entry-match-atom = 1*(list-wildcards / atom-slash)
*(list-wildcards / atom-slash) *(list-wildcards / atom-slash)
attrib = DQUOTE 1*atom-dot *("/" 1*atom-dot) DQUOTE attrib = DQUOTE 1*atom-dot *("/" 1*atom-dot) DQUOTE
attrib-match = DQUOTE 1*attrib-match-atom attrib-match = DQUOTE 1*attrib-match-atom
*("/" 1*attrib-match-atom) DQUOTE *("/" 1*attrib-match-atom) DQUOTE
attrib-match-atom = 1*(list-wildcards / atom-dot) attrib-match-atom = 1*(list-wildcards / atom-dot)
Gellens & Daboo Expires August 2001 [Page 16] Internet Draft IMAP ANNOTATE Extension February 2001
*(list-wildcards / atom-dot) *(list-wildcards / atom-dot)
value = nstring value = nstring
10 IANA Considerations 11 IANA Considerations
Gellens & Daboo Expires January 2001 [Page 16] Internet Draft IMAP ANNOTATE Extension July 2000
Both entry names and attribute names MUST be specified in a Both entry names and attribute names MUST be specified in a
standards track or IESG approved experimental RFC, or fall under the standards track or IESG approved experimental RFC, or fall under the
vendor namespace. Vendor names MUST be registered. vendor namespace. Vendor names MUST be registered.
10.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 _______ [] Vendor [] Open: RFC _______
Name: ______________________________ Name: ______________________________
skipping to change at page 19, line ? skipping to change at page 19, line ?
Description: _______________________ Description: _______________________
____________________________________ ____________________________________
____________________________________ ____________________________________
Contact person: ____________________ Contact person: ____________________
email: ____________________ email: ____________________
11 Security Considerations 12 Security Considerations
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
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.
12 References 13 References
[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.
Gellens & Daboo Expires August 2001 [Page 17] Internet Draft IMAP ANNOTATE Extension February 2001
[ACL-EXT] Myers, "IMAP4 ACL extension", RFC 2086, Carnegie Mellon, [ACL-EXT] Myers, "IMAP4 ACL extension", RFC 2086, Carnegie Mellon,
January 1997. 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.
Gellens & Daboo Expires January 2001 [Page 17] Internet Draft IMAP ANNOTATE Extension July 2000
[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.
[MODTIME-EXT] Melnikov, "IMAP Conditional Store", work in progress.
<http://www.ietf.org/internet-drafts/draft-melnikov-imap-condstore-xx.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-crispin-imapext-sort-xx.txt> <http://www.ietf.org/internet-drafts/draft-ietf-imapext-sort-xx.txt>
13 Acknowledgments 14 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. draft of this document, and to the participants at the ACAP working
dinner in Pittsburgh.
14 Authors' Addresses 15 Authors' Addresses
Randall Gellens
QUALCOMM Incorporated
5775 Morehouse Dr.
San Diego, CA 92121-2779
U.S.A.
Phone: +1 858 651 5115
Email: randy@qualcomm.com
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.
Phone: +1 412 605 0499 Phone: +1 412 605 0499
Email: daboo@cyrusoft.com Email: daboo@cyrusoft.com
Randall Gellens 16 Full Copyright Statement
QUALCOMM Incorporated
5775 Morehouse Dr.
San Diego, CA 92121-2779
U.S.A.
Phone: +1 858 651 5115
Email: randy@qualcomm.com
15 Full Copyright Statement Gellens & Daboo Expires August 2001 [Page 18] Internet Draft IMAP ANNOTATE Extension February 2001
Copyright (C) The Internet Society 2000. All Rights Reserved. Copyright (C) The Internet Society 2001. 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
Gellens & Daboo Expires January 2001 [Page 18] Internet Draft IMAP ANNOTATE Extension July 2000
developing Internet standards in which case the procedures for developing Internet standards in which case the procedures for
copyrights defined in the Internet Standards process must be copyrights defined in the Internet Standards process must be
followed, or as required to translate it into languages other than followed, or as required to translate it into languages other than
English. English.
The limited permissions granted above are perpetual and will not be The limited permissions granted above are perpetual and will not be
revoked by the Internet Society or its successors or assigns. revoked by the Internet Society or its successors or assigns.
This document and the information contained herein is provided on an This document and the information contained herein is provided on an
"AS IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING "AS IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING
 End of changes. 

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