draft-ietf-imapext-list-extensions-10.txt   draft-ietf-imapext-list-extensions-11.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 A. Melnikov
Isode Limited Isode Limited
Expires April 2005 October 2004 Expires August 2005 February 2005
IMAP4 LIST Command Extensions IMAP4 LIST Command Extensions
draft-ietf-imapext-list-extensions-10.txt draft-ietf-imapext-list-extensions-11.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 74 skipping to change at line 74
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 terms are introduced where they are referenced for the first time. Other terms are introduced where they are referenced for the first time.
<<Other editorial comments/questions are enclosed like this.>> <<Other editorial comments/questions are enclosed like this.>>
2. Introduction and overview 2. Introduction and overview
The extensions to the LIST command is accomplished by amending The LIST command is extended by amending the syntax to allow
the syntax to allow options to be specified. The list of options options and multiple patterns to be specified. The list of options
replaces the several commands that are currently used to mix and replaces 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: the new syntax is being used if one of compatible, with no ambiguity: the new syntax is being used if one of
the following conditions is true: the following conditions is true:
1). if the first word after the command name begins with a 1). if the first word after the command name begins with a
parenthesis ("LIST selection options"); parenthesis ("LIST selection options");
2). if the second word after the command name begins with a 2). if the second word after the command name begins with a
parenthesis ("multiple mailbox patterns"); parenthesis ("multiple mailbox patterns");
3). if the LIST command has more than 2 parameters 3). if the LIST command has more than 2 parameters
("LIST return options"); ("LIST return options");
skipping to change at line 101 skipping to change at line 101
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 "X-DRAFT-W10-LISTEXT" <<Note to the RFC Editor: capability string "X-DRAFT-W12-LISTEXT" <<Note to the RFC Editor:
the capability name will change upon publication as an RFC>>. the capability name will change upon publication as an RFC>>.
The X-DRAFT-W10-LISTEXT extension makes the The X-DRAFT-W12-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. extend LIST to allow for multiple mailbox patterns. b. extend LIST to allow for multiple mailbox patterns.
c. adds LIST command selection options: SUBSCRIBED, REMOTE and c. adds LIST command selection options: SUBSCRIBED, REMOTE and
MATCHPARENT. RECURSIVEMATCH.
d. adds LIST command return options: SUBSCRIBED and CHILDREN. d. adds LIST command return options: SUBSCRIBED and CHILDREN.
e. adds new mailbox attributes: "\NonExistent", "\PlaceHolder", e. adds new mailbox attributes: "\NonExistent", "\Subscribed",
"\Subscribed", "\Remote", "\HasSubMailboxes", "\Remote", "\HasChildren" and "\HasNoChildren".
"\HasChildren" and "\HasNoChildren". f. adds CHILDINFO extended data item.
3. Extended LIST Command 3. Extended LIST Command
This extension updates the syntax of the LIST command to allow for multiple This extension updates the syntax of the LIST command to allow for multiple
mailbox patterns to be specified, if they are enclosed in parantheses. mailbox patterns to be specified, if they are enclosed in parantheses.
A mailbox name match a list of mailbox patterns if it matches at least A mailbox name match a list of mailbox patterns if it matches at least
one mailbox pattern. Note that if a mailbox name matches multiple mailbox one mailbox pattern. Note that if a mailbox name matches multiple mailbox
patterns from the list, the server should return only a single LIST patterns from the list, the server should return only a single LIST
response. response.
Note that the non-extended LIST command is required to treat an empty Note that the non-extended LIST command is required to treat an empty
("" string) mailbox name argument as a special request to return the ("" string) mailbox name argument as a special request to return the
hierarchy delimiter and the root name of the name given in the hierarchy delimiter and the root name of the name given in the
reference parameter (as per [IMAP4]). However ANY extended LIST command reference parameter (as per [IMAP4]). However ANY extended LIST command
(extended in any of 3 ways specified in section 2, or any combination of (extended in any of 3 ways specified in section 2, or any combination of
therof) MUST NOT treat the empty mailbox name as such special request therof) MUST NOT treat the empty mailbox name as such special request
and any regular processing described in this document applies. and any regular processing described in this document applies.
In particular, if an extended LIST command has multiple mailbox names In particular, if an extended LIST command has multiple mailbox names
and one (or more) of them is the empty string, the empty string MUST be and one (or more) of them is the empty string, the empty string MUST be
ignored for the purpose of matching. <<Open issue: what if one of the ignored for the purpose of matching.
mailbox patterns is invalid for the server? Does it have to reject the
LIST command with BAD response, or should it just ignore invalid patterns?>> Some servers might restrict which patterns are allowed in a LIST command.
If a server doesn't accept a particular pattern, it MUST silently ignore
it.
The LIST command syntax is also extended in two additional ways: by adding a The LIST command syntax is also extended in two additional ways: by adding a
parenthesized list of command options between the command name and the parenthesized list of command options between the command name and the
reference name (LIST selection options) and an optional list of options at reference name (LIST selection options) and an optional list of options at
the end that control what kind of information should be returned (LIST return the end that control what kind of information should be returned (LIST return
options). See the formal syntax in section 6 for specific details. options). See the formal syntax in section 6 for specific details.
A LIST selection option tells the server which mailbox names should be A LIST selection option tells the server which mailbox names should be
selected by the LIST operation. selected by the LIST operation.
The server should return information about all mailbox names that match any The server should return information about all mailbox names that match any
of the "canonical LIST pattern" (as described above) and satisfy additional of the "canonical LIST pattern" (as described above) and satisfy additional
selection criteria (if any) specified by the LIST selection options. Let's selection criteria (if any) specified by the LIST selection options. Let's
call any such mailbox name a "matched mailbox name". call any such mailbox name a "matched mailbox name".
When multiple selection options are specified, the server must return When multiple selection options are specified, the server MUST return
information about mailbox names that satisfy every selection option, unless information about mailbox names that satisfy every selection option, unless
a description of a particular specified option prescribes special rules. a description of a particular specified option prescribes special rules.
An example of an option prescribing special rules is the MATCHPARENT An example of an option prescribing special rules is the RECURSIVEMATCH
selection option described later in this section. selection option described later in this section.
We will use the term "selection criteria" when referring collectively to all We will use the term "selection criteria" when referring collectively to all
selection options specified in a LIST command. selection options specified in a LIST command.
A LIST return option controls which information is returned for each matched A LIST return option controls which information is returned for each matched
mailbox name. Note that return options MUST NOT cause the server to report mailbox name. Note that return options MUST NOT cause the server to report
information about additional mailbox names. If the client has not specified information about additional mailbox names. If the client has not specified
any return option, only information about attributes should be returned by any return option, only information about attributes should be returned by
the server. (Of course the server is allowed to include any other information the server. (Of course the server is allowed to include any other information
at will) at will)
Both selection and return command options will be defined in this document Both selection and return command options will be defined in this document
and in approved extension documents; each option will be enabled by a and in approved extension documents; each option will be enabled by a
capability string (one capability may enable multiple options), and a client capability string (one capability may enable multiple options), and a client
MUST NOT send an option for which the server has not advertised support. 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 BAD response. A server MUST respond to options it does not recognize with a BAD response.
The client SHOULD NOT specify any option more than once, however if the The client SHOULD NOT specify any option more than once, however if the
client does this, the server MUST act as if it recieved the option only once. client does this, the server MUST act as if it received the option only once.
The order in which options are specified by the client is not significant.
This extension is identified by the capability string "X-DRAFT-W10-LISTEXT" <<Each option (except for RECURSIVEMATCH) should have a corresponding
mailbox attribute?>>
This extension is identified by the capability string "X-DRAFT-W12-LISTEXT"
<<Note to the RFC editor: please update upon publication as above>>, and <<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.
Note that extensions that don't require support for an extended LIST Note that extensions that don't require support for an extended LIST
command, but use extended LIST responses (see below), don't need to advertise command, but use extended LIST responses (see below), don't need to advertise
the "X-DRAFT-W10-LISTEXT" capability string. <<Note to the RFC Editor: fix the "X-DRAFT-W12-LISTEXT" capability string. <<Note to the RFC Editor: fix
upon publication as above>> upon publication as above>>
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"))
or... or...
((tablecloth ("fringe" "lacy"))(X-Sample "text" "and even more text")) ((tablecloth ("fringe" "lacy"))(X-Sample "text" "and even more text"))
See the formal grammar, below, for the full syntactic details. See the formal grammar, below, for the full syntactic details.
The server MUST NOT return any extended data item, unless the client has
expressed its ability to support extended LIST responses, for example by
using an extended LIST command.
The server MAY return data in the extended fields that was not solicited The server MAY return data in the extended fields that was not solicited
by the client. The client MUST ignore all extended fields it doesn't by the client. The client MUST ignore all extended fields it doesn't
recognize. recognize.
The X-DRAFT-W10-LISTEXT <<Note to the RFC Editor: fix upon publication>> The X-DRAFT-W12-LISTEXT <<Note to the RFC Editor: fix upon publication>>
capability also defines several new mailbox attributes. capability also defines several new mailbox attributes.
The "\PlaceHolder" attribute indicates that the designated mailbox does not
meet the selection criteria of the given LIST command, but that it
has one or more child mailbox that might (unspecified whether any,
all, or none match the canonical LIST pattern).
The LSUB command indicates this condition by using the "\NoSelect"
attribute, but the LIST (SUBSCRIBED) command MUST NOT do that, since
"\NoSelect" retains its original meaning here. Further, the
"\PlaceHolder" attribute is more general, in that it can be used with any
extended set of selection criteria.
The "\HasSubMailboxes" attribute indicates that the designated mailbox meets
the selection criteria of the given LIST command and also has one or more
child mailbox that might (unspecified whether any, all, or none match the
canonical LIST pattern).
The "\Placeholder" and the "\HasSubMailboxes" attributes MUST only be
returned when the client has specified the MATCHPARENT selection option.
When the MATCHPARENT selection option was specified by the client,
the absence of both \PlaceHolder and \HasSubMailboxes means that the
mailbox meets the selection criteria, but doesn't have any children that
also meets the selection criteria and doesn't match the canonical LIST
pattern. However, absence of both \PlaceHolder and \HasSubMailboxes doesn't
tell whether there are any children that meet the selection criteria and
match the canonical LIST pattern.
The "\PlaceHolder" and the "\HasSubMailboxes" attributes are mutually
exclusive.
Examples 8 and 10 in section 5 demonstrates the difference between
"\Placeholder"/""\HasSubMailboxes" and "\HasChildren" attributes.
The "\NonExistent" attribute indicates that a mailbox does not actually The "\NonExistent" attribute indicates that a mailbox does not actually
exist. Note that this attribute is not meaningful by itself, as mailboxes exist. Note that this attribute is not meaningful by itself, as mailboxes
that match the canonical LIST pattern but don't exist must not be returned that match the canonical LIST pattern but don't exist must not be returned
unless one of the two conditions listed below is also satisfied: unless one of the two conditions listed below is also satisfied:
a) the mailbox also satisfies the selection criteria a) the mailbox also satisfies the selection criteria
b) the mailbox has at least one child mailbox that satisfies the selection b) the mailbox has at least one child mailbox that satisfies the selection
criteria, but doesn't match the canonical LIST pattern. criteria<<, but doesn't match the canonical LIST pattern.>>
In practice this means that the "\NonExistent" attribute is usually returned In practice this means that the "\NonExistent" attribute is usually returned
with one or more of "\PlaceHolder"/"\HasSubMailboxes", "\Subscribed", with one or more of "\Subscribed", "\Remote" or the CHILDINFO extended data
"\Remote" (see their description below). item (see their description below).
The "\NonExistent" attribute implies "\NoSelect". The "\NonExistent" The "\NonExistent" attribute implies "\NoSelect". The "\NonExistent"
attribute MUST be supported and MUST be accurately computed. attribute MUST be supported and MUST be accurately computed.
The following table summarizes when "\NonExistent", "\PlaceHolder" or
"\HasSubMailboxes" attributes are to be returned (Note that
"\PlaceHolder" or "\HasSubMailboxes" attributes are only returned
when MATCHPARENT selection option is specified):
+------+------------+---------------------+--------------------------------+
|exists| meets the | has a child that | returned |
| | selection | meets the selection | LISTEXT attributes |
| | criteria | criteria | |
+------+------------+---------------------+--------------------------------+
| no | no | no | no LIST response returned |
| yes | no | no | no LIST response returned |
| no | yes | no | (\NonExistent) |
| yes | yes | no | () |
| no | no | yes | (\NonExistent \PlaceHolder) |
| yes | no | yes | (\PlaceHolder) |
| no | yes | yes | (\NonExistent \HasSubMailboxes)|
| yes | yes | yes | (\HasSubMailboxes) |
+------+------------+---------------------+--------------------------------+
The selection options defined in this specification are The selection options defined in this specification are
SUBSCRIBED - causes the LIST command to list subscribed SUBSCRIBED - causes the LIST command to list subscribed
names, rather than the existing mailboxes. This will often names, rather than the existing 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 canonical list pattern 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 attributes as returned by this Of particular note are the mailbox attributes as returned by this
skipping to change at line 320 skipping to change at line 276
with the SUBSCRIBED selection option, the RLSUB command. with the SUBSCRIBED selection option, the RLSUB command.
This option defines a new mailbox attribute, "\Remote", that This option defines a new mailbox attribute, "\Remote", that
indicates that a mailbox is a remote mailbox. The "\Remote" indicates that a mailbox is a remote mailbox. The "\Remote"
attribute MUST be accurately computed when the REMOTE option is attribute MUST be accurately computed when the REMOTE option is
specified. 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 selection option. as long as it accepts and ignores the REMOTE selection option.
Note that if the server choses to ignore the REMOTE selection
option, it still has to treat RECURSIVEMATCH REMOTE as a valid
combination of selection options (see also the description of
the RECURSIVEMATCH option below).
MATCHPARENT - when this option is specified, the "\Placeholder" RECURSIVEMATCH - this option forces the server to return
and the "\HasSubMailboxes" attributes MUST be accurate (see their
description above). This might force the server to return
information about parent mailboxes that don't match other information about parent mailboxes that don't match other
selection options, but have some submailboxes that do. selection options, but have some submailboxes that do.
Information about children is returned in the CHILDINFO
extended data item, as described in section 3.3.
Note 1: In order for a parent mailbox to be returned, it still Note 1: In order for a parent mailbox to be returned, it still
has to match the canonical LIST pattern. has to match the canonical LIST pattern.
Note 2: When calculating "\Placeholder"/"\HasSubMailboxes" Note 2: When returning the CHILDINFO extended data item,
attributes, it doesn't matter if the submailbox matches it doesn't matter if the submailbox matches
the canonical LIST pattern or not. See also example 9 in the canonical LIST pattern or not. See also example 9 in
section 5. section 5.
The MATCHPARENT option MUST NOT occur as the only selection option, The RECURSIVEMATCH option MUST NOT occur as the only selection
as it only makes sense when other selection options are also used. option, as it only makes sense when other selection options are
The server MUST return BAD tagged response in such case. also used. The server MUST return BAD tagged response in such case.
Note that even if MATCHPARENT option is specified, the client Note that even if RECURSIVEMATCH option is specified, the client
MUST still be able to handle a case when a "\PlaceHolder"/ MUST still be able to handle a case when a CHILDINFO extended
"\HasSubMailboxes" is returned and there are no submailboxes data item 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.
The return options defined in this specification are The return options defined in this specification are
SUBSCRIBED - causes the LIST command to return subscription SUBSCRIBED - causes the LIST command to return subscription
state for all matching mailbox names. The "\Subscribed" state for all matching mailbox names. The "\Subscribed"
attribute MUST be supported and MUST be accurately computed attribute MUST be supported and MUST be accurately computed
when the SUBSCRIBED return option is specified. when the SUBSCRIBED return option is specified.
CHILDREN - Requests mailbox child information as originally CHILDREN - Requests mailbox child information as originally
proposed in [ChildMbox]. See section 4, below, for details. proposed in [ChildMbox]. See section 4, below, for details.
This option MUST be accepted by all servers, however it MAY This option MUST be accepted by all servers. <<Should the last
be ignored. sentence be deleted?>>
3.1. General principles for returning LIST responses 3.1. General principles for returning LIST responses
This section outlines several principles that can be used by server This section outlines several principles that can be used by server
implementations of this document to decide if a LIST response should be implementations 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.
1) Exactly one LIST response should be returned for each mailbox 1) Exactly one LIST response should be returned for each mailbox
name which matches the canonical LIST pattern. name which matches the canonical LIST pattern.
skipping to change at line 382 skipping to change at line 342
in the responses to the LIST command (Note that the server is allowed in the responses to the LIST command (Note that the server is allowed
to return unsolicited responses at any time. Such responses are not to return unsolicited responses at any time. Such responses are not
governed by this rule): governed by this rule):
a) the mailbox name also satisfies the selection criteria; a) the mailbox name also satisfies the selection criteria;
b) the mailbox name doesn't satisfy the selection criteria, but b) the mailbox name doesn't satisfy the selection criteria, but
it has at least one child mailbox name that satisfies the it has at least one child mailbox name that satisfies the
selection criteria and that doesn't match the canonical LIST selection criteria and that doesn't match the canonical LIST
pattern. pattern.
For more information on this case see the \PlaceHolder For more information on this case see the CHILDINFO extended data
attribute description in Section 3. Note that the "\Placeholder" item described in section 3.3. Note that the CHILDINFO extended
attribute can only be returned when the MATCHPARENT selection data item can only be returned when the RECURSIVEMATCH selection
option is specified. option is specified.
3) Attributes returned in the same LIST response must be treated additively. 3) Attributes 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.
skipping to change at line 412 skipping to change at line 372
The following table summarizes inference rules described in section 3. The following table summarizes inference rules described in section 3.
+--------------------+-------------------+ +--------------------+-------------------+
| returned attribute | implied attribute | | returned attribute | implied attribute |
+--------------------+-------------------+ +--------------------+-------------------+
| \NoInferiors | \HasNoChildren | | \NoInferiors | \HasNoChildren |
| \NonExistent | \NoSelect | | \NonExistent | \NoSelect |
+--------------------+-------------------+ +--------------------+-------------------+
3.3. CHILDINFO extended data item
The CHILDINFO extended data item MUST only be returned when the client
has specified the RECURSIVEMATCH selection option.
The CHILDINFO extended data item in a LIST response describes the
selection criteria that has caused it to be returned and indicates that
the mailbox has one or more child mailbox that match the selection
criteria.
<<The LSUB command indicates this condition by using the "\NoSelect"
attribute, but the LIST (SUBSCRIBED) command MUST NOT do that, since
"\NoSelect" retains its original meaning here. Further, the CHILDINFO
extended data item is more general, in that it can be used with any
extended set of selection criteria.>>
Note: When returning the CHILDINFO extended data item,
it doesn't matter if a child mailbox matches
the canonical LIST pattern or not. See also example 9 in
section 5.
The returned selection criteria allows the client to distinguish
a solicited response from an unsolicited, as well as distinguish
between solicited responses caused by multiple different<<?>> LIST
commands.
<<Suppressing redundant CHILDINFO when parent doesn't match the
selection criteria but has a child that does AND the child also
matches the canonical LIST pattern?>>
<<Add example for (REMOTE RECURSIVEMATCH), when REMOTE is ignored by
the server (i.e. the client has effectively specified CHILDREN)?>>
Examples 8 and 10 in section 5 demonstrates the difference between
present CHILDINFO extended data item and the "\HasChildren" attribute.
The following table summarizes interaction between "\NonExistent"
attribute and CHILDINFO (the first collumn describes if the parent
mailbox exists):
+------+------------+---------------------+--------------------------+
|exists| meets the | has a child that | returned |
| | selection | meets the selection | LISTEXT attributes |
| | criteria | criteria | and CHILDINFO |
+------+------------+---------------------+--------------------------+
| no | no | no |no LIST response returned |
| yes | no | no |no LIST response returned |
| no | yes | no |(\NonExistent <attr>) |
| yes | yes | no |(<attr>) |
| no | no | yes |(\NonExistent) + CHILDINFO|
| yes | no | yes |() + CHILDINFO |
| no | yes | yes |(\NonExistent <attr>) + |
| | | | CHILDINFO |
| yes | yes | yes |(<attr>) + CHILDINFO |
+------+------------+---------------------+--------------------------+
where <attr> is one or more attributes that correspond to the
selection criteria, for example for the SUBSCRIBED option the <attr>
is \Subscribed. <<REMOTE is a special case?>>
<<Is this table still needed?>>
4. The CHILDREN return Option 4. The CHILDREN return Option
The CHILDREN return 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
return 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.
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 CHILDREN return option provides a mechanism for a client to The CHILDREN return option 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 CHILDREN return option defines two new attributes that MAY be The CHILDREN return option 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 return option is provided to indicate that the client command, the CHILDREN return option is provided to indicate that the
particularly wants this information. If the CHILDREN return option client particularly wants this information. If the CHILDREN return
is present, the server SHOULD return these attributes even if their option is present, the server MUST return these attributes even
computation is expensive. if their 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
attribute as a hint. That is, a mailbox MAY be flagged with the attribute as a hint. That is, a mailbox MAY be flagged with the
skipping to change at line 602 skipping to change at line 624
S: * LIST () "/" "INBOX" S: * LIST () "/" "INBOX"
S: * LIST (\NoInferiors) "/" "Drafts" S: * LIST (\NoInferiors) "/" "Drafts"
S: * LIST () "/" "Sent/March2004" S: * LIST () "/" "Sent/March2004"
S: * LIST (\Marked) "/" "Sent/December2003" S: * LIST (\Marked) "/" "Sent/December2003"
S: * LIST () "/" "Sent/August2004" S: * LIST () "/" "Sent/August2004"
S: BBB OK done S: BBB OK done
Example 8: Example 8:
The following example demonstates the difference between The following example demonstates the difference between
\HasChildren and \PlaceHolder/\SubMailboxes. \HasChildren attribute and CHILDINFO extended data item.
Let's assume there is the following hierarchy: Let's assume there is the following hierarchy:
C: C01 LIST "" "*" C: C01 LIST "" "*"
S: * LIST (\Marked \NoInferiors) "/" "inbox" S: * LIST (\Marked \NoInferiors) "/" "inbox"
S: * LIST () "/" "Foo" S: * LIST () "/" "Foo"
S: * LIST () "/" "Foo/Bar" S: * LIST () "/" "Foo/Bar"
S: * LIST () "/" "Foo/Baz" S: * LIST () "/" "Foo/Baz"
S: * LIST () "/" "Moo" S: * LIST () "/" "Moo"
S: C01 OK done S: C01 OK done
skipping to change at line 633 skipping to change at line 655
subscribed mailbox. Then subscribed mailbox. Then
C: C02 LIST (SUBSCRIBED) "" "*" C: C02 LIST (SUBSCRIBED) "" "*"
S: * LIST (\Subscribed) "/" "Foo/Baz" S: * LIST (\Subscribed) "/" "Foo/Baz"
S: C02 OK done S: C02 OK done
Now, if the client issues <LIST (SUBSCRIBED) "" "%">, the server will Now, if the client issues <LIST (SUBSCRIBED) "" "%">, the server will
return no mailboxes (as the mailboxes "Moo", "Foo" and "Inbox" are NOT return no mailboxes (as the mailboxes "Moo", "Foo" and "Inbox" are NOT
subscribed). However, if the client issues: subscribed). However, if the client issues:
C: C04 LIST (SUBSCRIBED MATCHPARENT) "" "%" C: C04 LIST (SUBSCRIBED RECURSIVEMATCH) "" "%"
S: * LIST (\PlaceHolder) "/" "Foo" S: * LIST () "/" "Foo" (("CHILDINFO" ("SUBSCRIBED")))
S: C04 OK done S: C04 OK done
i.e. the mailbox "Foo" is not subscribed, but it has a child that is. i.e. the mailbox "Foo" is not subscribed, but it has a child that is.
A1). If the mailbox "Foo" would have been subscribed instead, the last A1). If the mailbox "Foo" would have been subscribed instead, the last
command would return: command would return:
S: * LIST (\HasSubMailboxes \Subscribed) "/" "Foo" S: * LIST (\Subscribed) "/" "Foo" (("CHILDINFO" ("SUBSCRIBED")))
or even or even
S: * LIST (\HasSubMailboxes \HasChildren \Subscribed) "/" "Foo" S: * LIST (\Subscribed \HasChildren) "/" "Foo" (("CHILDINFO" ("SUBSCRIBED")))
A2). If we assume instead that the mailbox "Foo" is not part of the A2). If we assume instead that the mailbox "Foo" is not part of the
original hierarchy and is not subscribed, the last command will original hierarchy and is not subscribed, the last command will
return return
S: * LIST (\PlaceHolder \NonExistent) "/" "Foo" S: * LIST (\NonExistent) "/" "Foo" (("CHILDINFO" ("SUBSCRIBED")))
B). Now, let's assume that no mailbox is subscribed. In this case B). Now, let's assume that no mailbox is subscribed. In this case
the command <LIST (SUBSCRIBED MATCHPARENT) "" "%"> will return the command <LIST (SUBSCRIBED RECURSIVEMATCH) "" "%"> will return
no responses, as there are no subscribed children (even though no responses, as there are no subscribed children (even though
"Foo" has children). "Foo" has children).
C). And finally, let's assume that the mailboxes "Foo" and "Moo" are C). And finally, let's assume that only the mailboxes "Foo" and "Moo" are
subscribed. In this case the command: subscribed. In this case the command:
C: LIST (SUBSCRIBED MATCHPARENT) "" "%" RETURN (CHILDREN) C: LIST (SUBSCRIBED RECURSIVEMATCH) "" "%" RETURN (CHILDREN)
will return: will return:
S: * LIST (\HasChildren \Subscribed) "/" "Foo" S: * LIST (\HasChildren \Subscribed) "/" "Foo"
S: * LIST (\HasNoChildren \Subscribed) "/" "Moo" S: * LIST (\HasNoChildren \Subscribed) "/" "Moo"
Which means that the mailbox "Foo" has children, but none of them Which means that the mailbox "Foo" has children, but none of them
is subscribed. is subscribed.
Example 9: Example 9:
The following example demonstrates that the calculation of \PlaceHolder The following example demonstrates that the CHILDINFO extended data item
(or \HasSubMailboxes) attributes is not affected by the fact that is returned whether children mailboxes match the canonical LIST pattern
children mailboxes match the canonical LIST pattern. or not.
Let's assume there is the following hierarchy: Let's assume there is the following hierarchy:
C: D01 LIST "" "*" C: D01 LIST "" "*"
S: * LIST (\Marked \NoInferiors) "/" "inbox" S: * LIST (\Marked \NoInferiors) "/" "inbox"
S: * LIST () "/" "foo2" S: * LIST () "/" "foo2"
S: * LIST () "/" "foo2/bar1" S: * LIST () "/" "foo2/bar1"
S: * LIST () "/" "foo2/bar2" S: * LIST () "/" "foo2/bar2"
S: * LIST () "/" "baz2" S: * LIST () "/" "baz2"
S: * LIST () "/" "baz2/bar2" S: * LIST () "/" "baz2/bar2"
skipping to change at line 709 skipping to change at line 731
S: * LIST (\Subscribed) "/" "baz2/bar2" S: * LIST (\Subscribed) "/" "baz2/bar2"
S: * LIST (\Subscribed) "/" "baz2/bar22" S: * LIST (\Subscribed) "/" "baz2/bar22"
S: * LIST (\Subscribed) "/" "baz2/bar222" S: * LIST (\Subscribed) "/" "baz2/bar222"
S: * LIST (\Subscribed) "/" "eps2" S: * LIST (\Subscribed) "/" "eps2"
S: * LIST (\Subscribed) "/" "eps2/mamba" S: * LIST (\Subscribed) "/" "eps2/mamba"
S: * LIST (\Subscribed) "/" "quux2/bar2" S: * LIST (\Subscribed) "/" "quux2/bar2"
S: D02 OK done S: D02 OK done
The client issues the following command first: The client issues the following command first:
C: D03 LIST (MATCHPARENT SUBSCRIBED) "" "*2" C: D03 LIST (RECURSIVEMATCH SUBSCRIBED) "" "*2"
S: * LIST (\PlaceHolder) "/" "foo2" S: * LIST () "/" "foo2" (("CHILDINFO" ("SUBSCRIBED")))
S: * LIST (\Subscribed) "/" "foo2/bar2" S: * LIST (\Subscribed) "/" "foo2/bar2"
S: * LIST (\PlaceHolder) "/" "baz2" S: * LIST () "/" "baz2" (("CHILDINFO" ("SUBSCRIBED")))
S: * LIST (\Subscribed) "/" "baz2/bar2" S: * LIST (\Subscribed) "/" "baz2/bar2"
S: * LIST (\Subscribed) "/" "baz2/bar22" S: * LIST (\Subscribed) "/" "baz2/bar22"
S: * LIST (\Subscribed) "/" "baz2/bar222" S: * LIST (\Subscribed) "/" "baz2/bar222"
S: * LIST (\HasSubMailboxes \Subscribed) "/" "eps2" S: * LIST (\Subscribed) "/" "eps2" (("CHILDINFO" ("SUBSCRIBED")))
S: * LIST (\Subscribed) "/" "quux2/bar2" S: * LIST (\Subscribed) "/" "quux2/bar2"
S: D03 OK done S: D03 OK done
and the server may also include and the server may also include
S: * LIST (\PlaceHolder \NonExistent) "/" "quux2" S: * LIST (\NonExistent) "/" "quux2" (("CHILDINFO" ("SUBSCRIBED")))
The \PlaceHolder attribute is returned for mailboxes "foo2" and The CHILDINFO extended data item is returned for mailboxes "foo2", "baz2"
"baz2" (and the \HasSubMailboxes is returned for the mailbox "eps2"), and "eps2", because all of them have subscribed children,
because all of them have subscribed children,
even though for the mailbox "foo2" only one of the two subscribed even though for the mailbox "foo2" only one of the two subscribed
children match the pattern, for the mailbox "baz2" all the subscribed children match the pattern, for the mailbox "baz2" all the subscribed
children match the pattern and for the mailbox "eps2" none of the children match the pattern and for the mailbox "eps2" none of the
subscribed children match the pattern. subscribed children match the pattern.
Note that if the client issues Note that if the client issues
C: D03 LIST (MATCHPARENT SUBSCRIBED) "" "*" C: D03 LIST (RECURSIVEMATCH SUBSCRIBED) "" "*"
S: * LIST (\PlaceHolder) "/" "foo2" S: * LIST () "/" "foo2" (("CHILDINFO" ("SUBSCRIBED")))
S: * LIST (\Subscribed) "/" "foo2/bar1" S: * LIST (\Subscribed) "/" "foo2/bar1"
S: * LIST (\Subscribed) "/" "foo2/bar2" S: * LIST (\Subscribed) "/" "foo2/bar2"
S: * LIST (\PlaceHolder) "/" "baz2" S: * LIST () "/" "baz2" (("CHILDINFO" ("SUBSCRIBED")))
S: * LIST (\Subscribed) "/" "baz2/bar2" S: * LIST (\Subscribed) "/" "baz2/bar2"
S: * LIST (\Subscribed) "/" "baz2/bar22" S: * LIST (\Subscribed) "/" "baz2/bar22"
S: * LIST (\Subscribed) "/" "baz2/bar222" S: * LIST (\Subscribed) "/" "baz2/bar222"
S: * LIST (\HasSubMailboxes \Subscribed) "/" "eps2" S: * LIST (\Subscribed) "/" "eps2" (("CHILDINFO" ("SUBSCRIBED")))
S: * LIST (\Subscribed) "/" "eps2/mamba" S: * LIST (\Subscribed) "/" "eps2/mamba"
S: * LIST (\Subscribed) "/" "quux2/bar2" S: * LIST (\Subscribed) "/" "quux2/bar2"
S: D03 OK done S: D03 OK done
the mailboxes "foo2", "baz2" and "eps2" still have the same the LIST responses for mailboxes "foo2", "baz2" and "eps2" still have
\PlaceHolder/\HasSubMailboxes attribute, even though this information the CHILDINFO extended data item, even though this information
is redundant and the client can determine it by itself. is redundant and the client can determine it by itself.
Example 10: Example 10:
The following example shows usage of multiple mailbox patterns. The following example shows usage of multiple mailbox patterns.
It also demonstrates that \HasSubmailboxes/\PlaceHolder attributes It also demonstrates that the presence of the CHILDINFO extended data item
don't necessarily imply \HasChildren. doesn't necessarily imply \HasChildren.
C: a1 LIST "" ("foo" "foo/*") C: a1 LIST "" ("foo" "foo/*")
S: * LIST () "/" foo S: * LIST () "/" foo
S: a1 OK done S: a1 OK done
C: a2 LIST (SUBSCRIBED) "" "foo/*" C: a2 LIST (SUBSCRIBED) "" "foo/*"
S: * LIST (\Subscribed \NonExistent) "/" foo/bar S: * LIST (\Subscribed \NonExistent) "/" foo/bar
S: a2 OK done S: a2 OK done
C: a3 LIST (SUBSCRIBED MATCHPARENT) "" foo RETURN (CHILDREN) C: a3 LIST (SUBSCRIBED RECURSIVEMATCH) "" foo RETURN (CHILDREN)
S: * LIST (\Placeholder \HasNoChildren) "/" foo S: * LIST (\HasNoChildren) "/" foo (("CHILDINFO" ("SUBSCRIBED")))
S: a3 OK done S: a3 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].
childinfo-extended-item = "CHILDINFO" SP "(" list-sel-base-opt-quoted
*( SP list-sel-base-opt-quoted ) ")"
; Extended data item returned when the RECURSIVEMATCH
; selection option is specified.
; Note 1: the CHILDINFO tag can be returned
; with and without surrounding quotes, as per
; mbox-list-extended-item-tag production.
; Note 2: The selection options are returned quoted,
; unlike their specification in the extended LIST
; command.
child-mbox-flag = "\HasChildren" / "\HasNoChildren" child-mbox-flag = "\HasChildren" / "\HasNoChildren"
; attributes for CHILDREN return option, at most one ; attributes for CHILDREN return option, at most one
; possible per LIST response ; possible per LIST response
eitem-standard-tag = atom
; a tag for extended list data defined in a Standard
; Track or Experimental RFC.
eitem-vendor-tag = vendor-tag
; a vendor specific tag for extended list data
list = "LIST" [SP list-select-opts] SP mailbox SP mbox-or-pat list = "LIST" [SP list-select-opts] SP mailbox SP mbox-or-pat
[SP list-return-opts] [SP list-return-opts]
list-select-opts = "(" [*(list-select-mod-opt SP) list-select-base-opt list-select-opts = "(" [*(list-select-mod-opt SP) list-select-base-opt
*(SP list-select-opt)] ")" *(SP list-select-opt)] ")"
; list selection options, e.g. REMOTE ; list selection options, e.g. REMOTE
list-select-opt = list-sel-mod-opt / list-sel-base-opt
; An option registration template is described in
; section 8.3 of this document.
list-sel-base-opt = "SUBSCRIBED" / "REMOTE" / option-extension
; options that can be used by themselves
list-sel-base-opt-quoted = <"> list-sel-base-opt <">
list-sel-mod-opt = "RECURSIVEMATCH" / option-extension
; options that require a list-select-base-opt
; to also be present
list-return-opts = "RETURN" SP "(" [return-option *(SP return-option)] ")" list-return-opts = "RETURN" SP "(" [return-option *(SP return-option)] ")"
; list return options, e.g. CHILDREN ; list return options, e.g. CHILDREN
mparent-mbox-flag = "\PlaceHolder" / "\HasSubMailboxes"
; attributes for MATCHPARENT selection option,
; at most one possible per LIST response
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 mbox-list-oflag = child-mbox-flag / "\NonExistent" /
/ "\Subscribed" / "\Remote"
patterns = "(" list-mailbox *(SP list-mailbox) ")"
eitem-vendor-tag = vendor-tag
; a vendor specific tag for extended list data
eitem-standard-tag = atom mbox-or-pat = list-mailbox / patterns
; a tag for extended list data defined in a Standard
; 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 / mparent-mbox-flag / "\NonExistent" /
/ "\Subscribed" / "\Remote"
list-select-opt = list-sel-mod-opt / list-sel-base-opt
; An option registration template is described in
; section 8.3 of this document.
list-sel-base-opt = "SUBSCRIBED" / "REMOTE" / option-extension
; options that can be used by themselves
list-sel-mod-opt = "MATCHPARENT" / option-extension
; options that require a list-select-base-opt
; to also be present
return-option = "SUBSCRIBED" / "CHILDREN" /
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
patterns = "(" list-mailbox *(SP list-mailbox) ")"
return-option = "SUBSCRIBED" / "CHILDREN" /
option-extension
vendor-tag = vendor-token "-" atom vendor-tag = vendor-token "-" atom
7. Security Considerations 7. Security Considerations
This document describes syntactic changes to the specification of the This document describes syntactic changes to the specification of the
IMAP4 commands LIST, LSUB, RLIST, and RLSUB, and the modified LIST IMAP4 commands LIST, LSUB, RLIST, and RLSUB, and the modified LIST
command has the same security considerations as those commands. They command has the same security considerations as those commands. They
are described in [IMAP4] and [MboxRefer]. are described in [IMAP4] and [MboxRefer].
The Child Mailbox Extension provides a client a more efficient means The Child Mailbox Extension provides a client a more efficient means
skipping to change at line 874 skipping to change at line 904
\HasNoChildren attribute. In many cases, however, a server may not \HasNoChildren attribute. In many cases, however, a server may not
be able to efficiently compute whether a user has access to all child be able to efficiently compute whether a user has access to all child
mailboxes. If such a server responds with a \HasChildren attribute, mailboxes. If such a server responds with a \HasChildren attribute,
when in fact the currently authenticated user does not have access to when in fact the currently authenticated user does not have access to
any child mailboxes, potentially more information is conveyed about any child mailboxes, potentially more information is conveyed about
the mailbox than intended. In most situations this will not be a the mailbox than intended. In most situations this will not be a
security concern, because if information regarding whether a mailbox security concern, because if information regarding whether a mailbox
has children is considered sensitive, a user would not be granted has children is considered sensitive, a user would not be granted
access to that mailbox in the first place. access to that mailbox in the first place.
<<The CHILDINFO extended data item has the same security considerations
as the \HasChildren attribute described above.>>
8. IANA Considerations 8. IANA Considerations
8.1. Guidelines for IANA 8.1. Guidelines for IANA
It is requested that IANA creates two new registries for LISTEXT It is requested that IANA creates two new registries for LISTEXT
options and LISTEXT extended response data. The templates and options and LISTEXT extended response data. The templates and
the initial registrations are detailed below. the initial registrations are detailed below.
8.2. Registration procedure and Change control 8.2. Registration procedure and Change control
skipping to change at line 1055 skipping to change at line 1088
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) 4)
To: iana@iana.org To: iana@iana.org
Subject: Registration of LISTEXT option MATCHPARENT Subject: Registration of LISTEXT option RECURSIVEMATCH
LISTEXT option name: MATCHPARENT LISTEXT option name: RECURSIVEMATCH
LISTEXT option type: SELECTION LISTEXT option type: SELECTION
Implied return options(s): (none) Implied return options(s): (none)
LISTEXT option description: Requests that \Placeholder/ LISTEXT option description: Requests that CHILDINFO
\HasSubMailboxes attributes are to be returned. extended data item is to be returned.
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:
skipping to change at line 1106 skipping to change at line 1139
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>
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 X LISTEXT extended data item
LISTEXT extended data item tag: LISTEXT extended data item tag:
LISTEXT extended data item description: LISTEXT extended data item description:
Which LISTEXT option(s) (and their types) causes this extended Which LISTEXT option(s) (and their types) causes this extended
data item to be returned (if any): data item to be returned (if any):
Published specification (optional, recommended): Published specification (optional, recommended):
skipping to change at line 1129 skipping to change at line 1162
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:
Owner/Change controller: Owner/Change controller:
(Any other information that the author deems interesting may be (Any other information that the author deems interesting may be
added below this line.) added below this line.)
8.6. Initial LISTEXT extended data item registrations
It is requested that the LISTEXT extended data item registry is
being populated with the following entries:
1)
To: iana@iana.org
Subject: Registration of CHILDINFO LISTEXT extended data item
LISTEXT extended data item tag: CHILDINFO
LISTEXT extended data item description: The CHILDINFO extended data
item describes the selection criteria that has caused it to be
returned and indicates that the mailbox has one or more child
mailbox that match the selection criteria.
Which LISTEXT option(s) (and their types) causes this extended
data item to be returned (if any): RECURSIVEMATCH selection
option
Published specification : this RFC, section 3.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>
9. References 9. References
9.1. Normative References 9.1. Normative References
[Keywords] Bradner, S., "Key words for use in RFCs to Indicate [Keywords] Bradner, S., "Key words for use in RFCs to Indicate
Requirement Levels", RFC 2119, Harvard University, March 1997. Requirement Levels", RFC 2119, Harvard University, March 1997.
[ABNF] Crocker, D., and Overell, P. "Augmented BNF for Syntax [ABNF] Crocker, D., and Overell, P. "Augmented BNF for Syntax
Specifications: ABNF", RFC 2234, November 1997. Specifications: ABNF", RFC 2234, November 1997.
skipping to change at line 1162 skipping to change at line 1227
Mike Gahrns and Raymond Cheng of Microsoft Corporation originally Mike Gahrns and Raymond Cheng of Microsoft Corporation originally
devised the Child Mailbox Extension and proposed it in 1997; the devised the Child Mailbox Extension and proposed it in 1997; the
idea, as well as most of the text in section 4, is theirs. idea, as well as most of the text in section 4, is theirs.
This document is the result of discussions on the IMAP4 and IMAPEXT This document is the result of discussions on the IMAP4 and IMAPEXT
mailing lists and is meant to reflect consensus of those groups. mailing lists and is meant to reflect consensus of those groups.
In particular, Mark Crispin, Philip Guenther, Cyrus Daboo, Timo Sirainen, In particular, Mark Crispin, Philip Guenther, Cyrus Daboo, Timo Sirainen,
Ken Murchison, Rob Siemborski, Steve Hole, Arnt Gulbrandsen, Larry Ken Murchison, Rob Siemborski, Steve Hole, Arnt Gulbrandsen, Larry
Greenfield, Dave Cridland and Pete Maclean were active participants Greenfield, Dave Cridland and Pete Maclean were active participants
in this discussion or made suggestions to this document. in those discussions or made suggestions to this document.
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
skipping to change at line 1216 skipping to change at line 1281
http://www.ietf.org/ipr. http://www.ietf.org/ipr.
The IETF invites any interested party to bring to its attention any The IETF invites any interested party to bring to its attention any
copyrights, patents or patent applications, or other proprietary copyrights, patents or patent applications, or other proprietary
rights that may cover technology that may be required to implement rights that may cover technology that may be required to implement
this standard. Please address the information to the IETF at this standard. Please address the information to the IETF at
ietf-ipr@ietf.org. ietf-ipr@ietf.org.
14. Full Copyright Statement 14. Full Copyright Statement
Copyright (C) The Internet Society (2004). This document is subject Copyright (C) The Internet Society (2005). This document is subject
to the rights, licenses and restrictions contained in BCP 78, and to the rights, licenses and restrictions contained in BCP 78, and
except as set forth therein, the authors retain all their rights. except as set forth therein, the authors retain all their rights.
This document and the information contained herein are provided on an This document and the information contained herein are provided on an
"AS IS" basis and THE CONTRIBUTOR, THE ORGANIZATION HE/SHE REPRESENTS "AS IS" basis and THE CONTRIBUTOR, THE ORGANIZATION HE/SHE REPRESENTS
OR IS SPONSORED BY (IF ANY), THE INTERNET SOCIETY AND THE INTERNET OR IS SPONSORED BY (IF ANY), THE INTERNET SOCIETY AND THE INTERNET
ENGINEERING TASK FORCE DISCLAIM ALL WARRANTIES, EXPRESS OR IMPLIED, ENGINEERING TASK FORCE DISCLAIM ALL WARRANTIES, EXPRESS OR IMPLIED,
INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE
INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED
WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
 End of changes. 

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