draft-ietf-imapext-annotate-03.txt   draft-ietf-imapext-annotate-04.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-03.txt January 2002 Document: draft-ietf-imapext-annotate-04.txt March 2002
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 19, line ? skipping to change at page 20, line ?
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 2002. All Rights Reserved.
Gellens & Daboo Expires June 2002 [Page 1] Internet Draft IMAP ANNOTATE Extension January 2002 Gellens & Daboo Expires August 2002 [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 Change History . . . . . . . . . . . . . . . . . . . . . . . 3 4 Change History . . . . . . . . . . . . . . . . . . . . . . . 3
5 Introduction and Overview . . . . . . . . . . . . . . . . . . 4 5 Introduction and Overview . . . . . . . . . . . . . . . . . . 4
6 Data Model . . . . . . . . . . . . . . . . . . . . . . . . . 5 6 Data Model . . . . . . . . . . . . . . . . . . . . . . . . . 5
6.1 Overview . . . . . . . . . . . . . . . . . . . . . . . . 5 6.1 Overview . . . . . . . . . . . . . . . . . . . . . . . . 5
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 . . . . . . . . . . . . . . . . . . . . . 6
6.2.2 Attribute Names . . . . . . . . . . . . . . . . . . 7 6.2.2 Attribute Names . . . . . . . . . . . . . . . . . . 8
7 Private versus Shared and Access Control . . . . . . . . . . 8 7 Private versus Shared and Access Control . . . . . . . . . . 8
8 IMAP Protocol Changes . . . . . . . . . . . . . . . . . . . 9 8 IMAP Protocol Changes . . . . . . . . . . . . . . . . . . . 9
8.1 Optional parameters with the SELECT/EXAMINE commands . . 9 8.1 Optional parameters with the SELECT/EXAMINE commands . . 9
8.2 ANNOTATION Message Data Item in FETCH Command . . . . . 10 8.2 ANNOTATION Message Data Item in FETCH Command . . . . . 10
8.3 ANNOTATION Message Data Item in FETCH Response . . . . . 11 8.3 ANNOTATION Message Data Item in FETCH Response . . . . . 12
8.4 ANNOTATION Message Data Item in STORE . . . . . . . . . 13 8.4 ANNOTATION Message Data Item in STORE . . . . . . . . . 13
8.5 ANNOTATION Message Data Item in APPEND . . . . . . . . . 14 8.5 ANNOTATION interaction with COPY . . . . . . . . . . . . 14
8.6 ANNOTATION Criterion in SEARCH . . . . . . . . . . . . . 14 8.6 ANNOTATION Message Data Item in APPEND . . . . . . . . . 14
8.7 ANNOTATION Key in SORT . . . . . . . . . . . . . . . . . 15 8.7 ANNOTATION Criterion in SEARCH . . . . . . . . . . . . . 15
9 Formal Syntax . . . . . . . . . . . . . . . . . . . . . . . 15 8.8 ANNOTATION Key in SORT . . . . . . . . . . . . . . . . . 15
10 IANA Considerations . . . . . . . . . . . . . . . . . . . . . 17 9 Formal Syntax . . . . . . . . . . . . . . . . . . . . . . . . 16
10.1 Entry and Attribute Registration Template . . . . . . . 17 10 IANA Considerations . . . . . . . . . . . . . . . . . . . . 18
11 Security Considerations . . . . . . . . . . . . . . . . . . . 17 10.1 Entry and Attribute Registration Template . . . . . . . . 18
11 Security Considerations . . . . . . . . . . . . . . . . . . 18
12 References . . . . . . . . . . . . . . . . . . . . . . . . . 18 12 References . . . . . . . . . . . . . . . . . . . . . . . . . 18
13 Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 18 13 Acknowledgments . . . . . . . . . . . . . . . . . . . . . . 19
14 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . 18 14 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . 19
15 Full Copyright Statement . . . . . . . . . . . . . . . . . . 19 15 Full Copyright Statement . . . . . . . . . . . . . . . . . . 19
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
skipping to change at page 19, line ? skipping to change at page 20, line ?
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 August 2002 [Page 2]
Formal syntax is defined using ABNF [ABNF] as modified by [IMAP4]. Formal syntax is defined using ABNF [ABNF] as modified by [IMAP4].
Gellens & Daboo Expires June 2002 [Page 2] Internet Draft IMAP ANNOTATE Extension January 2002
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 Change History 4 Change History
Changes from -03 to -04:
1. Fixed attrib/attrib-match grammar to use "." instead of "/".
2. Add text for server to reject unknown <part-specifier>.
3. Do not allow empty part-specifier.
4. Store NIL to value to delete.
5. Comment on COPY interaction with ANNOTATE.
6. Added comment that IMAP flags are mapped one-to-one with their
corresponding FLAGS items.
7. Added comment that the recent flag annotation is read-only.
Changes from -02 to -03: Changes from -02 to -03:
1. Removed reference to status modtime item. 1. Removed reference to status modtime item.
2. Added missing 'notify' and 'ret' dsn annotations for 2. Added missing 'notify' and 'ret' dsn annotations for
/message/smtp-envelope. /message/smtp-envelope.
3. Added requirement to store data permanently - no 3. Added requirement to store data permanently - no
'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.
skipping to change at page 19, line ? skipping to change at page 20, line ?
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:
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.
Gellens & Daboo Expires August 2002 [Page 3]
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"
Gellens & Daboo Expires June 2002 [Page 3] Internet Draft IMAP ANNOTATE Extension January 2002
in CAPABILITY command response. in CAPABILITY command response.
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
skipping to change at page 19, line ? skipping to change at page 20, line ?
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:
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 extension mechanism for adding parameters to the f) adds a new requirement on the COPY command
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
would significantly reduce IMAP interoperability. would significantly reduce IMAP interoperability.
Gellens & Daboo Expires August 2002 [Page 4]
If a server supports annotations, then it MUST store all annotation If a server supports annotations, then it MUST store all annotation
data permanently, i.e. there is no concept of 'session only' data permanently, i.e. there is no concept of 'session only'
annotations that would correspond to the behaviour of 'session' annotations that would correspond to the behaviour of 'session'
flags as defined in the IMAP base specification. The exception to flags as defined in the IMAP base specification. The exception to
this is IMAP flags (which are accessible directly through this is IMAP flags (which are accessible directly through
annotations) which may be 'session only' as determined by the FLAGS annotations) which may be 'session only' as determined by the FLAGS
and PERMANENTFLAGS responses to a SELECT or EXAMINE command. and PERMANENTFLAGS responses to a SELECT or EXAMINE command.
This extension also introduces a generalised mechanism for adding This extension also introduces a generalised mechanism for adding
parameters to the SELECT or EXAMINE commands. It is anticipated parameters to the SELECT or EXAMINE commands. It is anticipated
that other extensions may want to utilise this, so it is not that other extensions may want to utilise this, so it is not
strictly dependent on the ANNOTATE extension being present. strictly dependent on the ANNOTATE extension being present.
Gellens & Daboo Expires June 2002 [Page 4] Internet Draft IMAP ANNOTATE Extension January 2002
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
which contains a set of standard attributes. A single coherent unit which contains a set of standard attributes. A single coherent unit
of "metadata" for a message is stored as a single entry, made up of of "metadata" for a message is stored as a single entry, made up of
skipping to change at page 19, line ? skipping to change at page 20, line ?
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.
Entry and attribute names MUST NOT contain asterisk ("*") or percent Entry and attribute names MUST NOT contain asterisk ("*") or percent
("%") characters and MUST be valid UTF-8 strings which do not ("%") characters and MUST be valid UTF-8 strings which do not
Gellens & Daboo Expires August 2002 [Page 5]
contain the NULL octet. Invalid entry or attribute names result in contain the NULL octet. Invalid entry or attribute names result 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.
Gellens & Daboo Expires June 2002 [Page 5] Internet Draft IMAP ANNOTATE Extension January 2002
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. 10.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.
skipping to change at page 19, line ? skipping to change at page 20, line ?
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 /message/flags/answered
/message/flags/flagged /message/flags/flagged
/message/flags/deleted /message/flags/deleted
/message/flags/seen /message/flags/seen
/message/flags/draft /message/flags/draft
/message/flags/recent /message/flags/recent
These correspond to the standard IMAP flags. These attributes represent the standard IMAP flags as returned
by the FLAGS fetch item. Changes to these annotations are
reflected in the standard IMAP flags. The recent attribute is
read only, clients MUST NOT attempt to change it.
/message/flags/redirected /message/flags/redirected
/message/flags/forwarded /message/flags/forwarded
The 'redirected' flag indicates that a message has been handed 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. 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.
Gellens & Daboo Expires August 2002 [Page 6]
/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
/message/smtp-envelope entry or any sub-entries or any of their /message/smtp-envelope entry or any sub-entries or any of their
attributes, except in messages which have the DRAFT flag set. attributes, except in messages which have the DRAFT flag set.
/message/smtp-envelope/from /message/smtp-envelope/from
/message/smtp-envelope/to /message/smtp-envelope/to
/message/smtp-envelope/orcpt /message/smtp-envelope/orcpt
/message/smtp-envelope/envid /message/smtp-envelope/envid
/message/smtp-envelope/notify /message/smtp-envelope/notify
/message/smtp-envelope/ret /message/smtp-envelope/ret
Contains the properties of the SMTP envelope: 'from' is the Contains the properties of the SMTP envelope: 'from' is the
return-path of the message; 'to' is the recipient of the return-path of the message; 'to' is the recipient of the
message. 'notify', 'orcpt', 'ret' and 'envid' contain the message. 'notify', 'orcpt', 'ret' and 'envid' contain the
Gellens & Daboo Expires June 2002 [Page 6] Internet Draft IMAP ANNOTATE Extension January 2002
notification options, original recipient, envelope ID and return notification options, original recipient, envelope ID and return
options as specified in [SMTP-DSN]. options as specified in [SMTP-DSN].
/message/subject /message/subject
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.
/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]. The server MUST return a BAD response if the client
uses an incorrect part specifier (either incorrect syntax or a
specifier referring to a non-existent part). The server MUST
return a BAD response if the client uses an empty part specifier
(which is used in [IMAP4] to represent the entire message).
/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
Gellens & Daboo Expires August 2002 [Page 7]
/body/<part-specifier>/flags/flagged /body/<part-specifier>/flags/flagged
/body/<part-specifier>/flags/forwarded /body/<part-specifier>/flags/forwarded
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 10.1 for the registration template.
Gellens & Daboo Expires June 2002 [Page 7] Internet Draft IMAP ANNOTATE Extension January 2002
All attribute names implicitly have a ".priv" and a ".shared" suffix All attribute names implicitly have a ".priv" and a ".shared" suffix
which maps to private and shared versions of the entry. Searching which maps to private and shared versions of the entry. Searching
or fetching without using either suffix includes both. The client or fetching without using either suffix includes both. The client
MUST specify either a ".priv" or ".shared" suffix when storing an MUST specify either a ".priv" or ".shared" suffix when storing an
annotation. annotation.
value value
The data value of the attribute. A UTF8 string representing the data value of the attribute. To
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.
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.
skipping to change at page 19, line ? skipping to change at page 20, line ?
client specific attributes. The vendor-token MUST be registered client specific attributes. The vendor-token MUST be registered
with IANA. with IANA.
7 Private versus Shared and Access Control 7 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.
Gellens & Daboo Expires August 2002 [Page 8]
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. An example of such use is a annotations in a shared environment. An example of such use is a
shared IMAP folder containing bug reports. Engineers may want to shared IMAP folder containing bug reports. Engineers may want to
use annotations to add information to existing messages, indicate use annotations to add information to existing messages, indicate
assignments, status, etc. This use requires shared annotations. 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.
There are also situations in which both shared and private There are also situations in which both shared and private
annotations are useful. For example, an administrator may want to annotations are useful. For example, an administrator may want to
set shared annotations on messages in a shared folder, which set shared annotations on messages in a shared folder, which
individual users may wish to supplement with additional notes. individual users may wish to supplement with additional notes.
Gellens & Daboo Expires June 2002 [Page 8] Internet Draft IMAP ANNOTATE Extension January 2002
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. There is also 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 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.
skipping to change at page 19, line ? skipping to change at page 20, line ?
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
extension - other extensions can use it with a server that does not extension - other extensions can use it with a server that does not
implement ANNOTATE. implement ANNOTATE.
Gellens & Daboo Expires August 2002 [Page 9]
Optional parameters to the SELECT or EXAMINE commands are added as a Optional parameters to the SELECT or EXAMINE commands are added as a
parenthesised list of atoms or strings, and appear after the mailbox parenthesised list of atoms or strings, and appear after the mailbox
name in the standard SELECT or EXAMINE command. The order of name in the standard SELECT or EXAMINE command. The order of
individual parameters is arbitrary. Individual parameters may individual parameters is arbitrary. Individual parameters may
consist of one or more atoms or strings in a specific order. If a consist of one or more atoms or strings in a specific order. If a
parameter consists of more than one atom or string, it MUST appear parameter consists of more than one atom or string, it MUST appear
in its own parenthesised list. Any parameter not defined by in its own parenthesised list. Any parameter not defined by
extensions that the server supports MUST be rejected with a NO extensions that the server supports MUST be rejected with a NO
response. response.
Example: Example:
C: a SELECT INBOX (ANNOTATE) C: a SELECT INBOX (ANNOTATE)
S: ... S: ...
S: a OK SELECT complete S: a OK SELECT complete
In the above example, a single parameter is used with the In the above example, a single parameter is used with the
SELECT command. SELECT command.
C: a EXAMINE INBOX (ANNOTATE (RESPONSES "UID Responses") MODTIME) C: a EXAMINE INBOX (ANNOTATE (RESPONSES "UID Responses") MODTIME)
S: ... S: ...
Gellens & Daboo Expires June 2002 [Page 9] Internet Draft IMAP ANNOTATE Extension January 2002
S: a OK EXAMINE complete S: a OK EXAMINE complete
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
skipping to change at page 19, line ? skipping to change at page 20, line ?
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" S: * 1 FETCH (ANNOTATION ("/message/comment"
("value.priv" "My comment" ("value.priv" "My comment"
"value.shared" "Group note"))) "value.shared" "Group note")))
Gellens & Daboo Expires August 2002 [Page 10]
S: a OK Fetch complete S: a OK Fetch complete
In the above example, the content of the "value" attribute In the above example, the content of the "value" attribute
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"
Gellens & Daboo Expires June 2002 [Page 10] Internet Draft IMAP ANNOTATE Extension January 2002
"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
skipping to change at page 19, line ? skipping to change at page 20, line ?
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
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.
Gellens & Daboo Expires August 2002 [Page 11]
Examples: Examples:
C: a FETCH 1 (ANNOTATION C: a FETCH 1 (ANNOTATION
(("/message/comment" "/message/subject") "value.priv")) (("/message/comment" "/message/subject") "value.priv"))
S: * 1 FETCH (ANNOTATION S: * 1 FETCH (ANNOTATION
(("/message/comment" ("value.priv" "What a chowder-head")) (("/message/comment" ("value.priv" "What a chowder-head"))
("/message/subject" ("value.priv" "How to crush beer ("/message/subject" ("value.priv" "How to crush beer
cans")))) cans"))))
S: a OK Fetch complete S: a OK Fetch complete
In the above example, the contents of the private "value" attributes In the above example, the contents of the private "value" attributes
for the two entries "/message/comment" and "/message/subject" are for the two entries "/message/comment" and "/message/subject" are
requested by the client and returned by the server. requested by the client and returned by the server.
8.3 ANNOTATION Message Data Item in FETCH Response 8.3 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 June 2002 [Page 11] Internet Draft IMAP ANNOTATE Extension January 2002
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.priv" "My comment" ("value.priv" "My comment"
"value.shared" NIL))) "value.shared" NIL)))
S: a OK Fetch complete S: a OK Fetch complete
skipping to change at page 19, line ? skipping to change at page 20, line ?
"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.
C: a FETCH 1 (ANNOTATION C: a FETCH 1 (ANNOTATION
("/message/comment" ("value" "size"))) ("/message/comment" ("value" "size")))
Gellens & Daboo Expires August 2002 [Page 12]
S: * 1 FETCH (ANNOTATION S: * 1 FETCH (ANNOTATION
(("/message/comment" (("/message/comment"
("value.priv" "My comment" ("value.priv" "My comment"
"value.shared" NIL "value.shared" NIL
"size.priv" "10" "size.priv" "10"
"size.shared" 0)))) "size.shared" 0))))
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. Since the client did not specify a is returned by the server. Since the client did not specify a
skipping to change at page 19, line ? skipping to change at page 20, line ?
attributes have values; the shared attributes are NIL. attributes have values; the shared attributes are NIL.
Servers MUST NOT include ANNOTATION data in unsolicited responses Servers MUST NOT include ANNOTATION data in unsolicited responses
unless the client used the ANNOTATE select parameter when it issued unless the client used the ANNOTATE select parameter when it issued
the last SELECT or EXAMINE command. This restriction avoids sending the last SELECT or EXAMINE command. This restriction avoids sending
ANNOTATION data to a client unless the client explicitly asks for ANNOTATION data to a client unless the client explicitly asks for
it. it.
Servers SHOULD send ANNOTATION message data items in unsolicited Servers SHOULD send ANNOTATION message data items in unsolicited
FETCH responses if an annotation entry is changed by a third-party, FETCH responses if an annotation entry is changed by a third-party,
Gellens & Daboo Expires June 2002 [Page 12] Internet Draft IMAP ANNOTATE Extension January 2002
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.
8.4 ANNOTATION Message Data Item in STORE 8.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.
skipping to change at page 19, line ? skipping to change at page 20, line ?
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))
S: a OK Store complete S: a OK Store complete
Gellens & Daboo Expires August 2002 [Page 13]
In the above example, the shared "value" attribute of the entry In the above example, the shared "value" attribute of the entry
"/message/comment" is removed. "/message/comment" is removed by storing NIL into the attribute.
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.priv" C: a STORE 1 ANNOTATION ("/message/comment" ("value.priv"
"Get tix Tuesday") "Get tix Tuesday")
"/message/subject" ("value.priv" "/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
private attribute "value" is created for each entry if not already private attribute "value" is created for each entry if not already
present, or replaced if they exist. present, or replaced if they exist.
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 June 2002 [Page 13] Internet Draft IMAP ANNOTATE Extension January 2002
Example: Example:
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.
8.5 ANNOTATION Message Data Item in APPEND 8.5 ANNOTATION interaction with COPY
The COPY command can be used to move messages from one mailbox to
another on the same server. Servers that support the ANNOTATION
extension MUST copy all the annotation data associated with any
messages being copied via the COPY command. The only exception to
this is if the destination mailbox permissions are such that either
the '.priv' or '.shared' annotations are not allowed.
8.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"
("value.priv" "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 August 2002 [Page 14]
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 with a private value is added to a In the above example, a comment with a private value is added to a
new message appended to the mailbox. The ellipsis represents the new message appended to the mailbox. The ellipsis represents the
bulk of the message. bulk of the message.
8.6 ANNOTATION Criterion in SEARCH 8.7 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"
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
Gellens & Daboo Expires June 2002 [Page 14] Internet Draft IMAP ANNOTATE Extension January 2002
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.
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
are returned in the search results. are returned in the search results.
8.7 ANNOTATION Key in SORT 8.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.
Gellens & Daboo Expires August 2002 [Page 15]
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.shared") UTF-8 C: a SORT (ANNOTATION "/message/subject" "value.shared") UTF-8
ALL ALL
skipping to change at page 19, line ? skipping to change at page 20, line ?
9 Formal Syntax 9 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
Gellens & Daboo Expires June 2002 [Page 15] Internet Draft IMAP ANNOTATE Extension January 2002
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]
[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) ")"
skipping to change at page 19, line ? skipping to change at page 20, line ?
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
Gellens & Daboo Expires August 2002 [Page 16]
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
entries = entry-match / entries = entry-match /
skipping to change at page 19, line ? skipping to change at page 20, line ?
; any character, excluding NUL ; any character, excluding NUL
atom-slash = any utf8-char except "/" atom-slash = any utf8-char except "/"
atom-dot = any utf8-char except "." atom-dot = any utf8-char except "."
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
Gellens & Daboo Expires June 2002 [Page 16] Internet Draft IMAP ANNOTATE Extension January 2002
attrib-match-atom = 1*(list-wildcards / atom-dot) attrib-match-atom = 1*(list-wildcards / atom-dot)
*(list-wildcards / atom-dot) *(list-wildcards / atom-dot)
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
; accept optional parameters ; accept optional parameters
examine =/ *(SP "(" select-param *(SP select-param) ")" examine =/ *(SP "(" select-param *(SP select-param) ")"
skipping to change at page 19, line ? skipping to change at page 20, line ?
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
; ANNOTATE extension ; ANNOTATE extension
Gellens & Daboo Expires August 2002 [Page 17]
10 IANA Considerations 10 IANA Considerations
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 10.1 Entry and Attribute Registration Template
To: iana@iana.org To: iana@iana.org
Subject: IMAP Annotate Registration Subject: IMAP Annotate Registration
skipping to change at page 19, line ? skipping to change at page 20, line ?
Description: _______________________ Description: _______________________
____________________________________ ____________________________________
____________________________________ ____________________________________
Contact person: ____________________ Contact person: ____________________
email: ____________________ email: ____________________
Gellens & Daboo Expires June 2002 [Page 17] Internet Draft IMAP ANNOTATE Extension January 2002
11 Security Considerations 11 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 12 References
skipping to change at page 19, line ? skipping to change at page 20, line ?
[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, [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 August 2002 [Page 18]
[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.
[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-07.txt> <http://www.ietf.org/internet-drafts/draft-ietf-imapext-sort-07.txt>
skipping to change at page 19, line ? skipping to change at page 20, line ?
14 Authors' Addresses 14 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 June 2002 [Page 18] Internet Draft IMAP ANNOTATE Extension January 2002
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
15 Full Copyright Statement 15 Full Copyright Statement
skipping to change at page 19, line ? skipping to change at page 20, line ?
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
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
Gellens & Daboo Expires August 2002 [Page 19]
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
TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING
BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION
 End of changes. 

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