draft-ietf-imapext-list-extensions-07.txt   draft-ietf-imapext-list-extensions-08.txt 
IMAP Extensions Working Group B. Leiba IMAP Extensions Working Group B. Leiba
Internet Draft IBM T.J. Watson Research Center Internet Draft IBM T.J. Watson Research Center
A. Melnikov (Ed.) A. Melnikov
Isode Limited Isode Limited
Expires January 2004 July 2004 Expires February 2004 August 2004
IMAP4 LIST Command Extensions IMAP4 LIST Command Extensions
draft-ietf-imapext-list-extensions-07.txt draft-ietf-imapext-list-extensions-08.txt
Status of this Document Status of this Document
By submitting this Internet-Draft, I certify that any applicable By submitting this Internet-Draft, I certify that any applicable
patent or other IPR claims of which I am aware have been disclosed, or patent or other IPR claims of which I am aware have been disclosed, or
will be disclosed, and any of which I become aware will be disclosed, will be disclosed, and any of which I become aware will be disclosed,
in accordance with RFC 3668. in accordance with RFC 3668.
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 line 69 skipping to change at line 69
The words "MUST", "MUST NOT", "SHOULD", "SHOULD NOT", and "MAY" are The words "MUST", "MUST NOT", "SHOULD", "SHOULD NOT", and "MAY" are
used in this document as specified in RFC 2119 [Keywords]. used in this document as specified in RFC 2119 [Keywords].
The term "canonical LIST pattern" refers to The term "canonical LIST pattern" refers to
the canonical pattern constructed internally by the server from the canonical pattern constructed internally by the server from
the reference and mailbox name arguments (Section 6.3.8 of [IMAP4]). the reference and mailbox name arguments (Section 6.3.8 of [IMAP4]).
The [IMAP4] LIST command returns only mailboxes that match the The [IMAP4] LIST command returns only mailboxes that match the
canonical LIST pattern. canonical LIST pattern.
<<Other editorial comments/questions are enclosed like this.>>
2. Introduction and overview 2. Introduction and overview
The extensions to the LIST command will be accomplished by amending The extensions to the LIST command will be accomplished by amending
the syntax to allow options to be specified. The list of options the syntax to allow options to be specified. The list of options
will replace the several commands that are currently used to mix and will replace the several commands that are currently used to mix and
match the information requested. The new syntax is backward- match the information requested. The new syntax is backward-
compatible, with no ambiguity: if the first word after the command compatible, with no ambiguity: <<if the first word after the command
name begins with a parenthesis, the new syntax is being used; if it name begins with a parenthesis, the new syntax is being used; if it
does not, it's in the original syntax. does not, it's in the original syntax>>.
By adding options to the LIST command, we are announcing the intent By adding options to the LIST command, we are announcing the intent
to phase out and eventually to deprecate the RLIST and RLSUB commands to phase out and eventually to deprecate the RLIST and RLSUB commands
described in [MboxRefer]. We are also defining the mechanism to described in [MboxRefer]. We are also defining the mechanism to
request extended mailbox information, such as is described in the request extended mailbox information, such as is described in the
"Child Mailbox Extension" [ChildMbox]. The base "Child Mailbox Extension" [ChildMbox]. The base
LSUB command is not deprecated by this extension; rather, this LSUB command is not deprecated by this extension; rather, this
extension adds a way to obtain subscription information with more extension adds a way to obtain subscription information with more
options, with those server implementations that support it. Clients options, with those server implementations that support it. Clients
that simply need a list of subscribed mailboxes, as provided by the that simply need a list of subscribed mailboxes, as provided by the
LSUB command, SHOULD continue to use that command. LSUB command, SHOULD continue to use that command.
This document defines an IMAP4 extension that is identified by the This document defines an IMAP4 extension that is identified by the
capability string "LISTEXT". The LISTEXT extension makes the capability string "X-DRAFT-W08-LISTEXT" <<the capability name will change
upon publication as an RFC>>. The LISTEXT extension makes the
following changes to the IMAP4 protocol, which are described in following changes to the IMAP4 protocol, which are described in
more details in sections 3 and 4 of this document: more details in sections 3 and 4 of this document:
a. defines new syntax for LIST command options. a. defines new syntax for LIST command options.
b. adds LIST command options: SUBSCRIBED, REMOTE and CHILDREN b. extend LIST to allow for multiple mailbox patterns.
c. adds new mailbox flags "\NonExistent", "\PlaceHolder", c. adds LIST command match options: SUBSCRIBED and REMOTE
d. adds LIST command return options: SUBSCRIBED, REMOTE, CHILDREN
and SUBMAILBOXES.
e. adds new mailbox flags "\NonExistent", "\PlaceHolder",
"\Subscribed", "\Remote", "\HasSubmailboxes", "\Subscribed", "\Remote", "\HasSubmailboxes",
"\HasChildren" and "\HasNoChildren". "\HasChildren" and "\HasNoChildren".
2.1. General principals for returning LIST responses 2.1. General principals for returning LIST responses
This section outlines several principals that can be used by This section outlines several principals that can be used by
implementors of this document to decide if a LIST response should be implementors of this document to decide if a LIST response should be
returned, as well as how many responses and what kind of information returned, as well as how many responses and what kind of information
they may contain. they may contain.
skipping to change at line 136 skipping to change at line 142
3) Flags returned in the same LIST response must be treated additively. 3) Flags returned in the same LIST response must be treated additively.
For example the following response For example the following response
S: * LIST (\Subscribed \NonExistent) "/" "Fruit/Peach" S: * LIST (\Subscribed \NonExistent) "/" "Fruit/Peach"
means that the "Fruit/Peach" mailbox doesn't exist, but it is means that the "Fruit/Peach" mailbox doesn't exist, but it is
subscribed. subscribed.
3. LIST Command Options 3. LIST Command Options
The LIST command syntax is extended by adding a parenthesized list of This extension updates the syntax of the LIST command to allow for multiple
command options between the command name and the reference name (see mailbox patterns to be specified, if they are enclosed in parantheses.
the formal syntax in section 6 for specific details). Command A mailbox match a list of mailbox patterns, if it matches at least one
options will be defined in this document and in approved extension mailbox pattern.
documents; each option will be enabled by a capability string (one
capability may enable multiple options), and a client MUST NOT send The LIST command syntax is also extended in two additional ways: by adding a
an option for which the server has not advertised support. A server parenthesized list of command options between the command name and the reference
name (LIST match options) and an optional list of options at the end that
control what kind of information should be returned (LIST return options).
See the formal syntax in section 6 for specific details. A LIST match option
tells the server which mailboxes should be selected by the LIST operation.
The server should return information about all mailboxes that match any of the
"canonical LIST pattern" (as described above) and satisfy additional selection
criteria (if any) specified by the LIST match options. Let's call any such
mailbox a "matched mailbox". Note, that if multiple match options are specified,
the server MUST return information about intersection of mailboxes that satisfy
any single match option.
A LIST return option controls which information is returned for each matched
mailbox. Note, that some return options may cause the server to report
information about additional mailboxes (e.g. SUBMAILBOXES). If the client
has omitted return options, only flag information should be returned by the
server.
Both match and return command options will be defined in this document and
in approved extension documents; each option will be enabled by a capability
string (one capability may enable multiple options), and a client MUST NOT
send an option for which the server has not advertised support. A server
MUST respond to options it does not recognize with a NO response. MUST respond to options it does not recognize with a NO response.
This extension is identified by the capability string "LISTEXT", and This extension is identified by the capability string "X-DRAFT-W08-LISTEXT"
<<Note to the RFC editor: please update upon publication as above>>, <<and
support for it is a prerequisite for any future extensions that support for it is a prerequisite for any future extensions that
require specialized forms of the LIST command. Such extensions MUST require specialized forms of the LIST command>>. Such extensions MUST
refer to this document and MUST add their function through command refer to this document and MUST add their function through command
options as described herein. options as described herein.
This extension also defines extensions to the LIST response, allowing This extension also defines extensions to the LIST response, allowing
a series of extended fields at the end, a parenthesized list of tagged a series of extended fields at the end, a parenthesized list of tagged
data (also referred to as "extended data item"). The first element of data (also referred to as "extended data item"). The first element of
an extended field is a tag, which identifies type of the data. Tags an extended field is a tag, which identifies type of the data. Tags
MUST be registered with IANA, as described in section 8.5 of this MUST be registered with IANA, as described in section 8.5 of this
document. An example of such extended set might be document. An example of such extended set might be
((tablecloth (("fringe" "lacy")("color" "white")))(X-Sample ((tablecloth (("fringe" "lacy")("color" "white")))(X-Sample
"text")) "text"))
skipping to change at line 195 skipping to change at line 224
Absence of both \PlaceHolder and \HasSubmailboxes means that the mailbox Absence of both \PlaceHolder and \HasSubmailboxes means that the mailbox
meets the selection criterion, but doesn't have any children that also meets the selection criterion, but doesn't have any children that also
meet the selection criterion and don't match the canonical LIST pattern. meet the selection criterion and don't match the canonical LIST pattern.
However, absence of both \PlaceHolder and \HasSubmailboxes doesn't tell However, absence of both \PlaceHolder and \HasSubmailboxes doesn't tell
whether there are any children that meet the selection criterion and match whether there are any children that meet the selection criterion and match
the canonical LIST pattern. the canonical LIST pattern.
<<We probably need an example to illustrate this>> <<We probably need an example to illustrate this>>
The SUBMAILBOXES option described below REQUIRES that the "\Placeholder" The SUBMAILBOXES return option described below REQUIRES that the "\Placeholder"
and the "\HasSubmailboxes" flags be accurately computed. and the "\HasSubmailboxes" flags be accurately computed.
The "\Placeholder"/""\HasSubmailboxes" flag implies "\HasChildren". The "\Placeholder"/""\HasSubmailboxes" flag implies "\HasChildren".
The "\NonExistent" flag indicates that a mailbox does not actually exist. The "\NonExistent" flag indicates that a mailbox does not actually exist.
Note that this flag is not meaningful by itself, as mailboxes that match Note that this flag is not meaningful by itself, as mailboxes that match
the canonical LIST pattern but don't exist must not be returned unless one the canonical LIST pattern but don't exist must not be returned unless one
of the two conditions listed below is also satisfied: of the two conditions listed below is also satisfied:
a) the mailbox also satisfy the selection criteria a) the mailbox also satisfy the selection criteria
skipping to change at line 236 skipping to change at line 265
| no | no | no | no LIST response returned | | no | no | no | no LIST response returned |
| yes | no | no | no LIST response returned | | yes | no | no | no LIST response returned |
| no | yes | no | (\NonExistent) | | no | yes | no | (\NonExistent) |
| yes | yes | no | () | | yes | yes | no | () |
| no | no | yes | (\NonExistent \PlaceHolder) | | no | no | yes | (\NonExistent \PlaceHolder) |
| yes | no | yes | (\PlaceHolder) | | yes | no | yes | (\PlaceHolder) |
| no | yes | yes | (\NonExistent \HasSubmailboxes)| | no | yes | yes | (\NonExistent \HasSubmailboxes)|
| yes | yes | yes | (\HasSubmailboxes) | | yes | yes | yes | (\HasSubmailboxes) |
+------+------------+---------------------+--------------------------------+ +------+------------+---------------------+--------------------------------+
The options defined in this specification are The match options defined in this specification are
SUBSCRIBED - causes the LIST command to list subscribed SUBSCRIBED - causes the LIST command to list subscribed
mailboxes, rather than the actual mailboxes. This will often mailboxes, rather than the actual mailboxes. This will often
be a subset of the actual mailboxes. It's also possible for be a subset of the actual mailboxes. It's also possible for
this list to contain the names of mailboxes that don't exist. this list to contain the names of mailboxes that don't exist.
In any case, the list MUST include exactly those mailbox names In any case, the list MUST include exactly those mailbox names
that match the selection criteria and are subscribed to. This that match the canonical list pattern and are subscribed to. This
option is intended to supplement the LSUB command. option is intended to supplement the LSUB command.
Of particular note are the mailbox flags as returned by this Of particular note are the mailbox flags as returned by this
option, compared with what is returned by LSUB. With the option, compared with what is returned by LSUB. With the
latter, the flags returned may not reflect the actual flag latter, the flags returned may not reflect the actual flag
status on the mailbox, and the \NoSelect flag has a special status on the mailbox, and the \NoSelect flag has a special
meaning (it indicates that this mailbox is not, itself, meaning (it indicates that this mailbox is not, itself,
subscribed, but that it has child mailboxes that are). With subscribed, but that it has child mailboxes that are). With
the SUBSCRIBED option described here, the flags are accurate the SUBSCRIBED match option described here, the flags are accurate
and complete, and have no special meanings. and complete, and have no special meanings.
"LSUB" and "LIST (SUBSCRIBED)" are, thus, not the same thing, "LSUB" and "LIST (SUBSCRIBED)" are, thus, not the same thing,
and some servers must do significant extra work to respond to and some servers must do significant extra work to respond to
"LIST (SUBSCRIBED)". Because of this, clients SHOULD continue "LIST (SUBSCRIBED)". Because of this, clients SHOULD continue
to use "LSUB" unless they specifically want the additional to use "LSUB" unless they specifically want the additional
information offered by "LIST (SUBSCRIBED)". information offered by "LIST (SUBSCRIBED)".
This option defines a new mailbox flag, "\Subscribed" that This option defines a new mailbox flag, "\Subscribed" that
indicates that a mailbox is subscribed to. The "\Subscribed" indicates that a mailbox is subscribed to. The "\Subscribed"
flag MUST be supported and MUST be accurately computed flag MUST be supported and MUST be accurately computed
when the SUBSCRIBED option is specified. when the SUBSCRIBED match option is specified.
<<Note, that the SUBSCRIBED match option implies the SUBSCRIBED
return option (see below).>>
REMOTE - causes the LIST command to show remote mailboxes as REMOTE - causes the LIST command to show remote mailboxes as
well as local ones, as described in [MboxRefer]. This option well as local ones, as described in [MboxRefer]. This option
is intended to replace the RLIST command and, in conjunction is intended to replace the RLIST command and, in conjunction
with the SUBSCRIBED option, the RLSUB command. This option is with the SUBSCRIBED match option, the RLSUB command.
only available on servers that also support RFC 2193.
This option defines a new mailbox flag, "\Remote", that This option defines a new mailbox flag, "\Remote", that
indicates that a mailbox is a remote mailbox. The "\Remote" indicates that a mailbox is a remote mailbox. The "\Remote"
flag MUST be accurately computed when the REMOTE option is flag MUST be accurately computed when the REMOTE option is
specified. specified.
<<Note, that the REMOTE match option implies the REMOTE
return option (see below).>>
The return options defined in this specification are
SUBSCRIBED - causes the LIST command to return subscription
state for all matching <<mailboxes?>>. The "\Subscribed"
flag MUST be supported and MUST be accurately computed
when the SUBSCRIBED return option is specified.
REMOTE - causes the LIST command to show if the matching <<mailbox>>
is local or remote. The "\Remote" flag MUST be accurately computed
when the REMOTE return option is specified.
Note, that a server implementation that doesn't support Note, that a server implementation that doesn't support
any remote mailboxes is compliant with this specification any remote mailboxes is compliant with this specification
as long as it accepts and ignores the REMOTE option. as long as it accepts and ignores the REMOTE return option.
CHILDREN - Requests mailbox child information as originally
proposed in [ChildMbox]. See section 4, below, for details.
This option MUST be accepted by all servers, however it MAY
be ignored.
SUBMAILBOXES - when this option is specified, the "\Placeholder" SUBMAILBOXES - when this option is specified, the "\Placeholder"
and the "\HasSubmailboxes" flags MUST be accurate. and the "\HasSubmailboxes" flags MUST be accurate. This might
force the server to return information for additional mailboxes.
Note, that even it SUBMAILBOXES option is specified, the client Note, that even it SUBMAILBOXES option is specified, the client
still must be able to handle a case when a "\PlaceHolder"/ still must be able to handle a case when a "\PlaceHolder"/
"\HasSubmailboxes" is returned and there are no submailboxes "\HasSubmailboxes" is returned and there are no submailboxes
that meet the selection criteria of the given LIST command, that meet the selection criteria of the given LIST command,
as they can be deleted/renamed after the LIST response was sent, as they can be deleted/renamed after the LIST response was sent,
but before the client had a chance to access them. but before the client had a chance to access them.
CHILDREN - Requests mailbox child information as originally 4. The CHILDREN return Option
proposed in [ChildMbox]. See section 4, below, for details.
This option MUST be accepted by all servers, however it MAY
be ignored.
4. The CHILDREN Option
The CHILDREN option implements the Child Mailbox Extension, The CHILDREN return option implements the Child Mailbox Extension,
originally proposed by Mike Gahrns and Raymond Cheng, of Microsoft originally proposed by Mike Gahrns and Raymond Cheng, of Microsoft
Corporation. Most of the information in this section is taken Corporation. Most of the information in this section is taken
directly from their original specification [ChildMbox]. The CHILDREN directly from their original specification [ChildMbox]. The CHILDREN
option is simply an indication that the client wants this return option is simply an indication that the client wants this
information; a server MAY provide it even if the option is not information; a server MAY provide it even if the option is not
specified, or MAY ignore the option entirely. specified, or MAY ignore the option entirely.
Many IMAP4 [IMAP4] clients present to the user a hierarchical view of Many IMAP4 [IMAP4] clients present to the user a hierarchical view of
the mailboxes that a user has access to. Rather than initially the mailboxes that a user has access to. Rather than initially
presenting to the user the entire mailbox hierarchy, it is often presenting to the user the entire mailbox hierarchy, it is often
preferable to show to the user a collapsed outline list of the preferable to show to the user a collapsed outline list of the
mailbox hierarchy (particularly if there is a large number of mailbox hierarchy (particularly if there is a large number of
mailboxes). The user can then expand the collapsed outline hierarchy mailboxes). The user can then expand the collapsed outline hierarchy
as needed. It is common to include within the collapsed hierarchy a as needed. It is common to include within the collapsed hierarchy a
visual clue (such as a ''+'') to indicate that there are child visual clue (such as a ''+'') to indicate that there are child
mailboxes under a particular mailbox. When the visual clue is mailboxes under a particular mailbox. When the visual clue is
clicked the hierarchy list is expanded to show the child mailboxes. clicked the hierarchy list is expanded to show the child mailboxes.
The Child Mailbox Extension provides a mechanism for a client to The Child Mailbox Extension provides a mechanism for a client to
efficiently determine if a particular mailbox has children, without efficiently determine if a particular mailbox has children, without
issuing a LIST "" * or a LIST "" % for each mailbox name. issuing a LIST "" * or a LIST "" % for each mailbox name.
The Child Mailbox Extension defines two new attributes that MAY be The Child Mailbox Extension defines two new attributes that MAY be
returned within a LIST response: \HasChildren and \HasNoChildren. returned within a LIST response: \HasChildren and \HasNoChildren.
While these attributes MAY be returned in response to any LIST While these attributes MAY be returned in response to any LIST
command, the CHILDREN option is provided to indicate that the client command, the CHILDREN return option is provided to indicate that the client
particularly wants this information. If the CHILDREN option is particularly wants this information. If the CHILDREN return option
present, the server SHOULD return these attributes even if their is present, the server SHOULD return these attributes even if their
computation is expensive. computation is expensive.
\HasChildren - The presence of this attribute indicates that the \HasChildren - The presence of this attribute indicates that the
mailbox has child mailboxes. mailbox has child mailboxes.
A server SHOULD NOT set this attribute if there are child A server SHOULD NOT set this attribute if there are child
mailboxes, and the user does not have permissions to access any mailboxes, and the user does not have permissions to access any
of them. In this case, \HasNoChildren SHOULD be used. of them. In this case, \HasNoChildren SHOULD be used.
In many cases, however, a server may not be able to efficiently In many cases, however, a server may not be able to efficiently
compute whether a user has access to all child mailboxes. As compute whether a user has access to all child mailboxes. As
such a client MUST be prepared to accept the \HasChildren such a client MUST be prepared to accept the \HasChildren
skipping to change at line 349 skipping to change at line 395
In some instances a server that supports the Child Mailbox Extension In some instances a server that supports the Child Mailbox Extension
might not be able to determine whether a mailbox has children. For might not be able to determine whether a mailbox has children. For
example it may have difficulty determining whether there are child example it may have difficulty determining whether there are child
mailboxes when LISTing mailboxes while operating in a particular mailboxes when LISTing mailboxes while operating in a particular
namespace. namespace.
In these cases, a server MAY exclude both the \HasChildren and In these cases, a server MAY exclude both the \HasChildren and
\HasNoChildren attributes in the LIST response. As such, a client \HasNoChildren attributes in the LIST response. As such, a client
can not make any assumptions about whether a mailbox has children can not make any assumptions about whether a mailbox has children
based upon the absence of a single attribute. In particular, some based upon the absence of a single attribute. In particular, some
servers may not be able to combine the SUBSCRIBED and CHILDREN servers may not be able to combine the SUBSCRIBED match option
options. Such servers MUST honour the SUBSCRIBED option, and they and CHILDREN return option. Such servers MUST honour the SUBSCRIBED
will simply ignore the CHILDREN option if both are requested. match option, and they will simply ignore the CHILDREN return option
It is an error for the server to return both a \HasChildren and a if both are requested. It is an error for the server to return both a
\HasNoChildren attribute in a LIST response. \HasChildren and a \HasNoChildren attribute in a LIST response.
Note: the \HasNoChildren attribute should not be confused with the Note: the \HasNoChildren attribute should not be confused with the
IMAP4 [IMAP4] defined attribute \NoInferiors which indicates that no IMAP4 [IMAP4] defined attribute \NoInferiors which indicates that no
child mailboxes exist now and none can be created in the future. child mailboxes exist now and none can be created in the future.
5. Examples 5. Examples
The first example shows the complete local hierarchy that will be The first example shows the complete local hierarchy that will be
used for the other examples. used for the other examples.
skipping to change at line 399 skipping to change at line 445
S: * LIST (\Subscribed) "/" "Vegetable/Broccoli" S: * LIST (\Subscribed) "/" "Vegetable/Broccoli"
S: A02 OK done S: A02 OK done
The next example shows the use of the CHILDREN option. The client, The next example shows the use of the CHILDREN option. The client,
without having to list the second level of hierarchy, now knows which without having to list the second level of hierarchy, now knows which
of the top-level mailboxes have sub-mailboxes (children) and which do of the top-level mailboxes have sub-mailboxes (children) and which do
not. Note that it's not necessary for the server to return the not. Note that it's not necessary for the server to return the
\HasNoChildren flag for the inbox, because the \NoInferiors flag \HasNoChildren flag for the inbox, because the \NoInferiors flag
already implies that, and has a stronger meaning. already implies that, and has a stronger meaning.
C: A03 LIST (CHILDREN) "" "%" C: A03 LIST () "" "%" RETURN (CHILDREN)
S: * LIST (\Marked \NoInferiors) "/" "inbox" S: * LIST (\Marked \NoInferiors) "/" "inbox"
S: * LIST (\HasChildren) "/" "Fruit" S: * LIST (\HasChildren) "/" "Fruit"
S: * LIST (\HasNoChildren) "/" "Tofu" S: * LIST (\HasNoChildren) "/" "Tofu"
S: * LIST (\HasChildren) "/" "Vegetable" S: * LIST (\HasChildren) "/" "Vegetable"
S: A03 OK done S: A03 OK done
In this example we see more mailboxes, which reside on another server In this example we see more mailboxes, which reside on another server
to which we may obtain referrals. This is similar to the command to which we may obtain referrals. This is similar to the command
<RLIST "" "%">. We also see the mixing of two options. Note that in <RLIST "" "%">. Note that in the case of the remote mailboxes, the
the case of the remote mailboxes, the server might or might not be server might or might not be able to include CHILDREN information;
able to include CHILDREN information; it includes it if it can, and it includes it if it can, and omits it if it can't.
omits it if it can't.
C: A04 LIST (REMOTE CHILDREN) "" "%" C: A04 LIST (REMOTE) "" "%" RETURN (CHILDREN)
S: * LIST (\Marked \NoInferiors) "/" "inbox" S: * LIST (\Marked \NoInferiors) "/" "inbox"
S: * LIST (\HasChildren) "/" "Fruit" S: * LIST (\HasChildren) "/" "Fruit"
S: * LIST (\HasNoChildren) "/" "Tofu" S: * LIST (\HasNoChildren) "/" "Tofu"
S: * LIST (\HasChildren) "/" "Vegetable" S: * LIST (\HasChildren) "/" "Vegetable"
S: * LIST (\Remote) "/" "Bread" S: * LIST (\Remote) "/" "Bread"
S: * LIST (\HasChildren \Remote) "/" "Meat" S: * LIST (\HasChildren \Remote) "/" "Meat"
S: A04 OK done S: A04 OK done
The following example also requests the server to include mailboxes,
which reside on another server. The server returns information about
all mailboxes which are subscribed. This is similar to the command
<RLSUB "" "%">. We also see the mixing of two match options.
C: A05 LIST (REMOTE SUBSCRIBED) "" "*"
S: * LIST (\Marked \NoInferiors \Subscribed) "/" "inbox"
S: * LIST (\Subscribed) "/" "Fruit/Banana"
S: * LIST (\Subscribed \NonExistent) "/" "Fruit/Peach"
S: * LIST (\Subscribed) "/" "Vegetable"
S: * LIST (\Subscribed) "/" "Vegetable/Broccoli"
S: * LIST (\Remote \Subscribed) "/" "Bread"
S: A05 OK done
The following example requests the server to include mailboxes,
which reside on another server. The server is requested to return
subscription information for all returned mailboxes. This is different
from the example above. <<Can we say that the output is a superset
of the output in the previous example? What about nonexistent
"Fruit/Peach"?>>
C: A06 LIST (REMOTE) "" "*" RETURN (SUBSCRIBED)
S: * LIST (\Marked \NoInferiors \Subscribed) "/" "inbox"
S: * LIST () "/" "Fruit"
S: * LIST () "/" "Fruit/Apple"
S: * LIST (\Subscribed) "/" "Fruit/Banana"
<<S: * LIST (\Subscribed \NonExistent) "/" "Fruit/Peach">>
S: * LIST () "/" "Tofu"
S: * LIST (\Subscribed) "/" "Vegetable"
S: * LIST (\Subscribed) "/" "Vegetable/Broccoli"
S: * LIST () "/" "Vegetable/Corn"
S: * LIST (\Remote \Subscribed) "/" "Bread"
S: * LIST (\Remote) "/" "Meat"
S: A06 OK done
In the following example the client has specified multiple mailbox
patterns.
C: BBB LIST "" ("INBOX" "Drafts" "Sent/%")
S: * LIST () "/" "INBOX"
S: * LIST (\NoInferiors) "/" "Drafts"
S: * LIST () "/" "Sent/March2004"
S: * LIST (\Marked) "/" "Sent/December2003"
S: * LIST () "/" "Sent/August2004"
S: BBB OK done
6. Formal Syntax 6. Formal Syntax
The following syntax specification uses the augmented Backus-Naur The following syntax specification uses the augmented Backus-Naur
Form (BNF) as described in [ABNF]. Terms not defined here are taken Form (BNF) as described in [ABNF]. Terms not defined here are taken
from [IMAP4]. "vendor-token" is defined in [ACAP]. from [IMAP4]. "vendor-token" is defined in [ACAP].
child-mbox-flag = "\HasChildren" / "\HasNoChildren" child-mbox-flag = "\HasChildren" / "\HasNoChildren"
; flags for Child Mailbox Extension, at most one ; flags for Child Mailbox Extension, at most one
; possible per LIST response ; possible per LIST response
list = "LIST" [SP list-options] SP mailbox SP list-mailbox list = "LIST" [SP list-match-opts] SP mailbox SP mbox_or_pat
[SP list-return-opts]
list-options = "(" [option *(SP option)] ")" list-match-opts = "(" [match-option *(SP match-option)] ")"
; list match options, e.g. REMOTE
list-return-opts = "RETURN" SP "(" [return-option *(SP return-option)] ")"
; list return options, e.g. CHILDREN
mailbox-list = "(" [mbx-list-flags] ")" SP mailbox-list = "(" [mbx-list-flags] ")" SP
(DQUOTE QUOTED-CHAR DQUOTE / nil) SP mailbox (DQUOTE QUOTED-CHAR DQUOTE / nil) SP mailbox
[SP mbox-list-extended] [SP mbox-list-extended]
mbox-list-extended = "(" [mbox-list-extended-item mbox-list-extended = "(" [mbox-list-extended-item
*(SP mbox-list-extended-item)] ")" *(SP mbox-list-extended-item)] ")"
mbox-list-extended-item = "(" mbox-list-extended-item-data ")" mbox-list-extended-item = "(" mbox-list-extended-item-data ")"
mbox-list-extended-item-data = mbox-list-extended-item-tag SP nstring-list mbox-list-extended-item-data = mbox-list-extended-item-tag SP nstring-list
mbox-list-extended-item-tag = astring mbox-list-extended-item-tag = astring
; The content MUST conform to either "eitem-vendor-tag" or ; The content MUST conform to either "eitem-vendor-tag" or
; "eitem-standard-tag" ABNF productions. ; "eitem-standard-tag" ABNF productions.
; A tag registration template is described in section ; A tag registration template is described in section
; 8.5 of this document. ; 8.5 of this document.
mbox_or_pat = list-mailbox / patterns
patterns = "(" list-mailbox *(list-mailbox) ")"
eitem-vendor-tag = vendor-tag eitem-vendor-tag = vendor-tag
; a vendor specific tag for extended list data ; a vendor specific tag for extended list data
eitem-standard-tag = atom eitem-standard-tag = atom
; a tag for extended list data defined in a Standard ; a tag for extended list data defined in a Standard
; Track or Experimental RFC. ; Track or Experimental RFC.
nstring-list = nstring / nstring-list = nstring /
"(" [nstring-list *(SP nstring-list)] ")" "(" [nstring-list *(SP nstring-list)] ")"
;; a recursive list definition ;; a recursive list definition
mbox-list-oflag = child-mbox-flag / "\NonExistent" / "\PlaceHolder" / mbox-list-oflag = child-mbox-flag / "\NonExistent" / "\PlaceHolder" /
"\HasSubmailboxes" / "\Subscribed" / "\Remote" "\HasSubmailboxes" / "\Subscribed" / "\Remote"
option = "SUBSCRIBED" / "CHILDREN" / "REMOTE" / "SUBMAILBOXES" / match-option = "SUBSCRIBED" / "REMOTE" / option-extension
option-extension
; An option registration template is described in section ; An option registration template is described in section
; 8.3 of this document. ; 8.3 of this document.
return-option = "SUBSCRIBED" / "REMOTE" / "CHILDREN" / "SUBMAILBOXES" /
option-extension
option-extension = option-vendor-tag / option-standard-tag option-extension = option-vendor-tag / option-standard-tag
option-vendor-tag = vendor-tag option-vendor-tag = vendor-tag
; a vendor specific option ; a vendor specific option
option-standard-tag= atom option-standard-tag= atom
; an option defined in a Standard Track or ; an option defined in a Standard Track or
; Experimental RFC ; Experimental RFC
vendor-tag = vendor-token "-" atom vendor-tag = vendor-token "-" atom
skipping to change at line 583 skipping to change at line 685
The IESG is considered to be the owner of all LISTEXT options/extended data items The IESG is considered to be the owner of all LISTEXT options/extended data items
which are on the IETF standards track. which are on the IETF standards track.
8.3. Registration template for LISTEXT options 8.3. Registration template for LISTEXT options
To: iana@iana.org To: iana@iana.org
Subject: Registration of LISTEXT option X Subject: Registration of LISTEXT option X
LISTEXT option name: LISTEXT option name:
LISTEXT option type: (One of MATCH or RETURN)
<<Implied return options(s) if the option type is MATCH?>>
LISTEXT option description: LISTEXT option description:
Published specification (optional, recommended): Published specification (optional, recommended):
Security considerations: Security considerations:
Intended usage: Intended usage:
(One of COMMON, LIMITED USE or OBSOLETE) (One of COMMON, LIMITED USE or OBSOLETE)
Person & email address to contact for further information: Person & email address to contact for further information:
skipping to change at line 611 skipping to change at line 717
It is requested that the LISTEXT option registry is being populated It is requested that the LISTEXT option registry is being populated
with the following entries: with the following entries:
1) 1)
To: iana@iana.org To: iana@iana.org
Subject: Registration of LISTEXT option SUBSCRIBED Subject: Registration of LISTEXT option SUBSCRIBED
LISTEXT option name: SUBSCRIBED LISTEXT option name: SUBSCRIBED
LISTEXT option type: MATCH
LISTEXT option description: Causes the LIST command to list LISTEXT option description: Causes the LIST command to list
subscribed mailboxes, rather than the actual mailboxes. subscribed mailboxes, rather than the actual mailboxes.
Published specification : this RFC, section 3. Published specification : this RFC, section 3.
Security considerations: this RFC, section 7. Security considerations: this RFC, section 7.
Intended usage: COMMON Intended usage: COMMON
Person & email address to contact for further information: Person & email address to contact for further information:
skipping to change at line 632 skipping to change at line 740
Owner/Change controller: IESG <iesg@ietf.org> Owner/Change controller: IESG <iesg@ietf.org>
2) 2)
To: iana@iana.org To: iana@iana.org
Subject: Registration of LISTEXT option REMOTE Subject: Registration of LISTEXT option REMOTE
LISTEXT option name: REMOTE LISTEXT option name: REMOTE
LISTEXT option type: MATCH
LISTEXT option description: causes the LIST command to return LISTEXT option description: causes the LIST command to return
remote mailboxes as well as local ones, as described in remote mailboxes as well as local ones, as described in
RFC 2193. RFC 2193.
Published specification : this RFC, section 3. Published specification : this RFC, section 3.
Security considerations: this RFC, section 7. Security considerations: this RFC, section 7.
Intended usage: COMMON Intended usage: COMMON
Person & email address to contact for further information: Person & email address to contact for further information:
Alexey Melnikov <Alexey.Melnikov@isode.com> Alexey Melnikov <Alexey.Melnikov@isode.com>
Owner/Change controller: IESG <iesg@ietf.org> Owner/Change controller: IESG <iesg@ietf.org>
3) 3)
To: iana@iana.org To: iana@iana.org
Subject: Registration of LISTEXT option SUBSCRIBED
LISTEXT option name: SUBSCRIBED
LISTEXT option type: RETURN
LISTEXT option description: Causes the LIST command to return
subscription state.
Published specification : this RFC, section 3.
Security considerations: this RFC, section 7.
Intended usage: COMMON
Person & email address to contact for further information:
Alexey Melnikov <Alexey.Melnikov@isode.com>
Owner/Change controller: IESG <iesg@ietf.org>
4)
To: iana@iana.org
Subject: Registration of LISTEXT option REMOTE
LISTEXT option name: REMOTE
LISTEXT option type: MATCH
LISTEXT option description: causes the LIST command to return
if the mailbox is local or remote, as described in
RFC 2193.
Published specification : this RFC, section 3.
Security considerations: this RFC, section 7.
Intended usage: COMMON
Person & email address to contact for further information:
Alexey Melnikov <Alexey.Melnikov@isode.com>
Owner/Change controller: IESG <iesg@ietf.org>
5)
To: iana@iana.org
Subject: Registration of LISTEXT option SUBMAILBOXES Subject: Registration of LISTEXT option SUBMAILBOXES
LISTEXT option name: SUBMAILBOXES LISTEXT option name: SUBMAILBOXES
LISTEXT option type: RETURN
LISTEXT option description: Requests that \Placeholder/ LISTEXT option description: Requests that \Placeholder/
\HasSubmailboxes flags are to be accurately computed. \HasSubmailboxes flags are to be accurately computed.
Published specification : this RFC, sections 3. Published specification : this RFC, sections 3.
Published specification : this RFC Published specification : this RFC
Security considerations: this RFC, section 7. Security considerations: this RFC, section 7.
Intended usage: COMMON Intended usage: COMMON
Person & email address to contact for further information: Person & email address to contact for further information:
Alexey Melnikov <Alexey.Melnikov@isode.com> Alexey Melnikov <Alexey.Melnikov@isode.com>
Owner/Change controller: IESG <iesg@ietf.org> Owner/Change controller: IESG <iesg@ietf.org>
4) 6)
To: iana@iana.org To: iana@iana.org
Subject: Registration of LISTEXT option CHILDREN Subject: Registration of LISTEXT option CHILDREN
LISTEXT option name: CHILDREN LISTEXT option name: CHILDREN
LISTEXT option type: RETURN
LISTEXT option description: Requests mailbox child information. LISTEXT option description: Requests mailbox child information.
Published specification : this RFC, sections 3 and 4. Published specification : this RFC, sections 3 and 4.
Published specification : this RFC Published specification : this RFC
Security considerations: this RFC, section 7. Security considerations: this RFC, section 7.
Intended usage: COMMON Intended usage: COMMON
skipping to change at line 701 skipping to change at line 862
8.5. Registration template for LISTEXT extended data item 8.5. Registration template for LISTEXT extended data item
To: iana@iana.org To: iana@iana.org
Subject: Registration of LISTEXT extended data item X Subject: Registration of LISTEXT extended data item X
LISTEXT extended data item tag: LISTEXT extended data item tag:
LISTEXT extended data item description: LISTEXT extended data item description:
Which LISTEXT option(s) causes this extended data item Which LISTEXT option(s) (and their types) causes this extended
to be returned (if any): data item to be returned (if any):
Published specification (optional, recommended): Published specification (optional, recommended):
Security considerations: Security considerations:
Intended usage: Intended usage:
(One of COMMON, LIMITED USE or OBSOLETE) (One of COMMON, LIMITED USE or OBSOLETE)
Person & email address to contact for further information: Person & email address to contact for further information:
skipping to change at line 762 skipping to change at line 923
11. Author's Address 11. Author's Address
Barry Leiba Barry Leiba
IBM T.J. Watson Research Center IBM T.J. Watson Research Center
30 Saw Mill River Road 30 Saw Mill River Road
Hawthorne, NY 10532 Hawthorne, NY 10532
Phone: 1-914-784-7941 Phone: 1-914-784-7941
Email: leiba@watson.ibm.com Email: leiba@watson.ibm.com
Alexey Melnikov (Editor) Alexey Melnikov
Isode Limited Isode Limited
5 Castle Business Village 5 Castle Business Village
36 Station Road 36 Station Road
Hampton, Middlesex Hampton, Middlesex
TW12 2BX, UK TW12 2BX, UK
Email: Alexey.Melnikov@isode.com Email: Alexey.Melnikov@isode.com
URI: http://www.melnikov.ca/ URI: http://www.melnikov.ca/
12. IPR Disclosure Acknowledgement 12. IPR Disclosure Acknowledgement
 End of changes. 

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