Edit

BaseShape

  • Article

The BaseShape element identifies the set of properties to return in an item or folder response.

<BaseShape>IdOnly or Default or AllProperties</BaseShape>

DefaultShapeNamesType

Attributes and elements

The following sections describe attributes, child elements, and parent elements.

Attributes

None.

Child elements

None

Parent elements

Element Description
FolderShape
Identifies the folder properties to include in the GetFolder, FindFolder, or SyncFolderHierarchy response.

The following are the XPath expressions to this element:

/GetFolder/FolderShape
/FindFolder/FolderShape
/SyncFolderHierarchy/FolderShape
ItemShape
Identifies the item properties and content to include in a GetItem, FindItem, or SyncFolderItems response.

The following are the XPath expressions to this element:

/GetItem/ItemShape
/FindItem/ItemShape
/SyncFolderItems/ItemShape

Text value

A text value is required. The following table lists the possible text values.

Text values for the BaseShape element

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.

Default properties

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

Remarks

To return properties in addition to those identified by the BaseShape element, use the AdditionalProperties element.

Example

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
  xmlns:t="https://schemas.microsoft.com/exchange/services/2006/types">
  <soap:Body>
    <FindFolder Traversal="Shallow" xmlns="https://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>

Element information

Element Example
Namespace
https://schemas.microsoft.com/exchange/services/2006/types
Schema Name
Types schema
Validation File
Types.xsd
Can be Empty
False

See also