complexType "folderType"
Namespace:
http://schemas.microsoft.com/hs/2001/10/myInbox
Content:
complex, 3 attributes, 5 elements, elem. wildcard
Defined:
globally in myInbox.xsd; see XML source
Includes:
definitions of 5 elements, elem. wildcard
Used:
at 1 location
XML Representation Summary
<...
   
 = 
xsd:nonNegativeInteger
 = 
xsd:hexBinary
 = 
xsd:string
   
>
   
Content: 
</...>
Content Model Elements (5):
childFolderCount (in folder in myInbox), name (type hs:localizableString), parentFolder (in folder in myInbox), type (in folder in myInbox), unread (in folder in myInbox)
All Direct / Indirect Based Elements (1):
folder (in myInbox)
Known Usage Locations
Annotation
Folder elements in myInbox are containers for messages, although not directly. Messages are related to folders via the /myInbox/message/messageStatus/folder ref="" attribute. Folders can be orgainized heirarchically, although again not directly. Instead, folder containment is modeled using the /myInbox/folder/parentFolder ref="" attribute. If a folder is deleted, all associated messages, folders and their messages are deleted. It is recommended that instead of deleting a folder directly, you move it to the type="deleted" folder first. There are 4 built in types of folders and these can be identified by four special type element values: /folder/type = 'inbox' is the Inbox folder /folder/type = 'sent' is the Sent Items folder /folder/type = 'drafts' is the Drafts folder /folder/type = 'deleted' is the Deleted Items folder These four special folders will always exist in a provisioned .NET Inbox account. They can never be deleted or modified. To create user defined folders, you can use the standard .NET My Services insert method and set the type to 'custom'. Custom folders can be deleted or modified.
XML Source (see within schema source)
<xsd:complexType name="folderType">
<xsd:annotation>
<xsd:documentation>
Folder elements in myInbox are containers for messages, although not directly. Messages are related
to folders via the /myInbox/message/messageStatus/folder ref="" attribute. Folders can be orgainized
heirarchically, although again not directly. Instead, folder containment is modeled using the
/myInbox/folder/parentFolder ref="" attribute. If a folder is deleted, all associated messages, folders
and their messages are deleted. It is recommended that instead of deleting a folder directly, you move it
to the type="deleted" folder first.

There are 4 built in types of folders and these can be identified by four special type element values:
/folder/type = 'inbox' is the Inbox folder
/folder/type = 'sent' is the Sent Items folder
/folder/type = 'drafts' is the Drafts folder
/folder/type = 'deleted' is the Deleted Items folder

These four special folders will always exist in a provisioned .NET Inbox account. They can never be deleted
or modified.

To create user defined folders, you can use the standard .NET My Services insert method and set the type to 'custom'.
Custom folders can be deleted or modified.
</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:element name="name" type="hs:localizableString">
<xsd:annotation>
<xsd:documentation>
This element contains the name of the e-mail folder. For the four special folders,
this element is read only. For custom folders, this element can be edited.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="type" type="folderTypeEnum">
<xsd:annotation>
<xsd:documentation>
This element contains a type identifier for this folder. And will contain the value
'inbox, 'sent', 'drafts' or 'delete' for the four special folders. For all other folders, this
value will be 'custom'
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element maxOccurs="1" minOccurs="0" name="unread" type="xsd:unsignedLong">
<xsd:annotation>
<xsd:documentation>
The calculated count of the unread messages associated with this folder. This element is read only.
</xsd:documentation>
<xsd:appinfo>
<xdb:system type="calculatedFieldEarlyBound"/>
</xsd:appinfo>
</xsd:annotation>
</xsd:element>
<xsd:element maxOccurs="1" minOccurs="0" name="parentFolder" type="refType">
<xsd:annotation>
<xsd:documentation>
This element contains a ref attribute that specifies the ID of the parent folder.
For top-level folders, this attribute == "". This attribute cannot be set on the four special folders
as they must always remain top level folders
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element maxOccurs="1" minOccurs="0" name="childFolderCount" type="xsd:unsignedLong">
<xsd:annotation>
<xsd:documentation>
This calculated attribute indicates how many subfolders that folder contains. See also 'parentFolder'.
</xsd:documentation>
<xsd:appinfo>
<xdb:system type="calculatedFieldEarlyBound"/>
</xsd:appinfo>
</xsd:annotation>
</xsd:element>
<xsd:any maxOccurs="unbounded" minOccurs="0" namespace="##other" processContents="skip"/>
</xsd:sequence>
<xsd:attributeGroup ref="hs:standardBlueAttributeGroup"/>
</xsd:complexType>
Attribute Detail (all declarations; 3/3)
changeNumber
Type:
hs:changeNumberType
Use:
required
Defined:
locally within hs:standardBlueAttributeGroup attributeGroup
XML Source (see within schema source)
<xsd:attribute name="changeNumber" type="changeNumberType" use="required"/>
creator
Type:
hs:creatorType
Use:
required
Defined:
locally within hs:standardBlueAttributeGroup attributeGroup
XML Source (see within schema source)
<xsd:attribute name="creator" type="creatorType" use="required"/>
id
Type:
hs:idType
Use:
required
Defined:
locally within hs:standardBlueAttributeGroup attributeGroup
XML Source (see within schema source)
<xsd:attribute name="id" type="idType" use="required"/>
Content Element Detail (all declarations; 6/6)
childFolderCount
Type:
xsd:unsignedLong, predefined, simple content
Defined:
locally within (this) folderType complexType
This calculated attribute indicates how many subfolders that folder contains. See also 'parentFolder'.
XML Source (see within schema source)
<xsd:element maxOccurs="1" minOccurs="0" name="childFolderCount" type="xsd:unsignedLong">
<xsd:annotation>
<xsd:documentation>
This calculated attribute indicates how many subfolders that folder contains. See also 'parentFolder'.
</xsd:documentation>
<xsd:appinfo>
<xdb:system type="calculatedFieldEarlyBound"/>
</xsd:appinfo>
</xsd:annotation>
</xsd:element>
name
Type:
hs:localizableString, simple content
Defined:
locally within (this) folderType complexType
This element contains the name of the e-mail folder. For the four special folders, this element is read only. For custom folders, this element can be edited.
XML Source (see within schema source)
<xsd:element name="name" type="hs:localizableString">
<xsd:annotation>
<xsd:documentation>
This element contains the name of the e-mail folder. For the four special folders,
this element is read only. For custom folders, this element can be edited.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
parentFolder
Type:
refType, empty content
Defined:
locally within (this) folderType complexType
This element contains a ref attribute that specifies the ID of the parent folder. For top-level folders, this attribute == "". This attribute cannot be set on the four special folders as they must always remain top level folders
XML Source (see within schema source)
<xsd:element maxOccurs="1" minOccurs="0" name="parentFolder" type="refType">
<xsd:annotation>
<xsd:documentation>
This element contains a ref attribute that specifies the ID of the parent folder.
For top-level folders, this attribute == "". This attribute cannot be set on the four special folders
as they must always remain top level folders
</xsd:documentation>
</xsd:annotation>
</xsd:element>
type
Type:
folderTypeEnum, simple content
Defined:
locally within (this) folderType complexType
This element contains a type identifier for this folder. And will contain the value 'inbox, 'sent', 'drafts' or 'delete' for the four special folders. For all other folders, this value will be 'custom'
XML Source (see within schema source)
<xsd:element name="type" type="folderTypeEnum">
<xsd:annotation>
<xsd:documentation>
This element contains a type identifier for this folder. And will contain the value
'inbox, 'sent', 'drafts' or 'delete' for the four special folders. For all other folders, this
value will be 'custom'
</xsd:documentation>
</xsd:annotation>
</xsd:element>
unread
Type:
xsd:unsignedLong, predefined, simple content
Defined:
locally within (this) folderType complexType
The calculated count of the unread messages associated with this folder. This element is read only.
XML Source (see within schema source)
<xsd:element maxOccurs="1" minOccurs="0" name="unread" type="xsd:unsignedLong">
<xsd:annotation>
<xsd:documentation>
The calculated count of the unread messages associated with this folder. This element is read only.
</xsd:documentation>
<xsd:appinfo>
<xdb:system type="calculatedFieldEarlyBound"/>
</xsd:appinfo>
</xsd:annotation>
</xsd:element>
{any element with non-schema namespace}
Defined:
within (this) folderType complexType
XML Source (see within schema source)
<xsd:any maxOccurs="unbounded" minOccurs="0" namespace="##other" processContents="skip"/>