BaseShape
Last modified: October 13, 2012
Applies to: Exchange Online | Exchange Server 2007 | Exchange Server 2010 | Exchange Server 2013 | Office 365
The BaseShape element identifies the set of properties to return in an item or folder response.
<BaseShape>IdOnly or Default or AllProperties</BaseShape>
DefaultShapeNamesType
The following sections describe attributes, child elements, and parent elements.
Attributes
None.
Child elements
None
Parent elements
|
Element |
Description |
|---|---|
|
Identifies the folder properties to include in the GetFolder, FindFolder, or SyncFolderHierarchy response. The following are the XPath expressions to this element:
|
|
|
Identifies the item properties and content to include in a GetItem, FindItem, or SyncFolderItems response. The following are the XPath expressions to this element:
|
A text value is required. The following table lists the possible text values.
|
Value |
Description |
|---|---|
|
IdOnly |
Returns only the item or folder ID. |
|
Default |
Returns a set of properties that are defined as the default for the item or folder. |
|
AllProperties |
Returns all the properties used by the Exchange Business Logic layer to construct a folder. |
The following table lists the default properties that are returned for a FindFolder request. All subfolders of a given folder are returned in order by name.
|
Folder |
Default Properties |
|---|---|
|
Inbox |
FolderId, display name, unread count, total count, subfolder count |
|
Contacts |
FolderId, display name, total count, subfolder count |
|
Calendar |
FolderId, display name, subfolder count |
|
Drafts |
FolderId, display name, unread count, total count, subfolder count |
|
Deleted items |
FolderId, display name, unread count, total count, subfolder count |
|
Other folders |
FolderId, display name, unread count, total count, subfolder count |
|
Outbox |
FolderId, display name, unread count, total count, subfolder count |
|
Tasks |
FolderId, display name, past due count, total count, subfolder count |
|
Notes |
FolderId, display name, total count, subfolder count |
To return properties in addition to those identified by the BaseShape element, use the AdditionalProperties element.
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:t="http://schemas.microsoft.com/exchange/services/2006/types">
<soap:Body>
<FindFolder Traversal="Shallow" xmlns="http://schemas.microsoft.com/exchange/services/2006/messages">
<FolderShape>
<t:BaseShape>Default</t:BaseShape>
</FolderShape>
<ParentFolderIds>
<t:DistinguishedFolderId Id="inbox"/>
</ParentFolderIds>
</FindFolder>
</soap:Body>
</soap:Envelope>