FolderShape

Topic Last Modified: 2006-06-11

The FolderShape element identifies the folder properties to include in a GetFolder, FindFolder, or SyncFolderHierarchy response.

Syntax

<FolderShape>
   <BaseShape/>
   <AdditionalProperties/>
</FolderShape>

Type

FolderResponseShapeType

Attributes and Elements

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

Attributes

None.

Child Elements

Element Description

BaseShape

Identifies the basic configuration of properties to return in a response.

AdditionalProperties

Identifies additional properties to return in a response.

Parent Elements

Element Description

FindFolder

Defines a request to identify folders in a mailbox.

The following is the XPath expression to this element:

/FindFolder

GetFolder

Defines a request to get a folder from the Exchange store.

The following is the XPath expression to this element:

/GetFolder

SyncFolderHierarchy

Defines a request to synchronize a folder hierarchy on a client.

The following is the XPath expression to this element:

/SyncFolderHierarchy

Remarks

The FolderShape element is a required child element of the FindFolder element.

The schema that describes this element is located in the EWS virtual directory of the computer that is running Microsoft Exchange Server 2007 that has the Client Access server role installed.

Example

The following example of a request demonstrates how to find all folders located in the first level of the Inbox folder.

<?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>

Element Information

Namespace

http://schemas.microsoft.com/exchange/services/2006/messages

Schema Name

Messages schema

Validation File

Messages.xsd

Can be Empty

False

See Also

Reference

FindFolder