Share via

2.2.4.5 t:BaseFolderType

  • Article

The BaseFolderType complex type specifies the base type for folders. 

 <xs:complexType name="BaseFolderType"
   abstract="true"
 > 
   <xs:sequence>
     <xs:element name="FolderId"
       type="t:FolderIdType"
       minOccurs="0"
      />
     <xs:element name="ParentFolderId"
       type="t:FolderIdType"
       minOccurs="0"
      />
     <xs:element name="FolderClass"
       type="xs:string"
       minOccurs="0"
      />
     <xs:element name="DisplayName"
       type="xs:string"
       minOccurs="0"
      />
     <xs:element name="TotalCount"
       type="xs:int"
       minOccurs="0"
      />
     <xs:element name="ChildFolderCount"
       type="xs:int"
       minOccurs="0"
      />
     <xs:element name="ExtendedProperty"
       type="t:ExtendedPropertyType"
       minOccurs="0"
       maxOccurs="unbounded"
      />
     <xs:element name="ManagedFolderInformation"
       type="t:ManagedFolderInformationType"
       minOccurs="0"
      />
     <xs:element name="EffectiveRights"
       type="t:EffectiveRightsType"
       minOccurs="0"
      />
     <xs:element name="DistinguishedFolderId"
       type="t:DistinguishedFolderIdNameType"
       minOccurs="0"
      />
     <xs:element name="PolicyTag"
       type="t:RetentionTagType"
       minOccurs="0"
      />
     <xs:element name="ArchiveTag"
       type="t:RetentionTagType"
       minOccurs="0"
      />
     <xs:element name="ReplicaList" 
       type="t:ArrayOfStringsType" 
       minOccurs="0" 
      />
   </xs:sequence>
 </xs:complexType>
 

The following table lists the child elements of the BaseFolderType complex type.

Element name

Type

Description

FolderId

t:FolderIdType ([MS-OXWSCDATA] section 2.2.4.35)

Specifies the folder identifier and change key. This element can be present and cannot be set during folder creation. The maximum length for the FolderIdType element Id attribute and the maximum length for the FolerIdType ChangeKey attribute is 512 bytes after base64 decoding.

ParentFolderId

t:FolderIdType

Specifies the folder identifier and change key for the parent folder. This element can be present and cannot be set during folder creation. The maximum length for the FolderIdType element Id attribute and the maximum length for the FolerIdType ChangeKey attribute is 512 bytes after base64 decoding.

FolderClass

xs:string ([XMLSCHEMA2])

Specifies the folder class. This value MUST be "IPF.Appointment" for Calendar folders, "IPF.Contact" for Contacts folders, "IPF.Journal" for journal folders, "IPF.Note" for mail folders, "IPF.StickyNote" for note folders, and "IPF.Task" for Tasks folders. The folders class can be a custom class. The following example shows how to set a custom folder class: "IPF.<folderclass>", where <folderclass> is the name of the custom class. This element can be present.

DisplayName

xs:string

Specifies the display name of the folder. This element can be present. This element is required in a CreateFolder operation request.

TotalCount

xs:int ([XMLSCHEMA2])

Specifies the total number of items in a folder. This property MUST be read-only for a client and is returned only in a response. This element can be present.

ChildFolderCount

xs:int

Specifies the total number of child folders in a folder. This property MUST be read-only for a client and is returned only in a response. This element can be present.

ExtendedProperty

t:ExtendedPropertyType ([MS-OXWSXPROP] section 2.1.5)

Specifies the set of extended properties on a folder. This element can be present.

ManagedFolderInformation

t:ManagedFolderInformationType (section 2.2.4.13)

Specifies metadata for a managed folder. This property MUST be read-only for a client and is only returned in a response. This element can be present.

EffectiveRights

t:EffectiveRightsType ([MS-OXWSCDATA] section 2.2.4.29)

Specifies the operations that the user that is logged user can perform on the folder. This property MUST be read-only for a client and is returned only in a response.  This element can be present.

DistinguishedFolderId

t:DistinguishedFolderIdNameType ([MS-OXWSCDATA] section 2.2.5.10)

Specifies an identifier for a folder that can be referenced by name. This element only supports "conversationhistory", "adminauditlogs", and "recoverableitemsroot" when it is present in a Folder, CalendarFolder, ContactsFolder, or TasksFolder element of NonEmptyArrayOfFoldersType complex type in CreateFolder operation.<2>

PolicyTag

t:RetentionTagType ([MS-OXWSURPT] section 2.2.4.1)

Specifies the retention policy.<3>

ArchiveTag

t:RetentionTagType

Specifies that the item is archived.<4>

ReplicaList

t:ArrayofStringsType ([MS-OXWSCDATA] section 2.2.4.13)

A list of replicas of a public folder.<5>

The FolderType complex type, as specified in section 2.2.4.12, CalendarFolderType complex type, as specified in [MS-OXWSMTGS] section 2.2.4.5, and ContactsFolderType complex type, as specified in [MS-OXWSCONT] section 3.1.4.1.1.6, extend the BaseFolderType complex type.