Share via

3.1.4.5.3.1 SetHoldOnMailboxesType

  • Article

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

The SetHoldOnMailboxesType complex type specifies a request to set a query-based hold on mailboxes. This type extends the BaseRequestType complex type, as described in [MS-OXWSCDATA] section 2.2.4.17.

 <xs:complexType name="SetHoldOnMailboxesType" xmlns:xs="http://www.w3.org/2001/XMLSchema">
   <xs:complexContent mixed="false">
     <xs:extension base="tns:BaseRequestType">
       <xs:sequence>
         <xs:element minOccurs="1" name="ActionType" type="t:HoldActionType"/>
         <xs:element minOccurs="1" name="HoldId" type="xs:string"/>
         <xs:element minOccurs="1" name="Query" type="xs:string"/>
         <xs:element minOccurs="0" name="Mailboxes" type="t:ArrayOfStringsType"/>
         <xs:element minOccurs="0" name="Language" type="xs:string"/>
         <xs:element minOccurs="0" name="IncludeNonIndexableItems" type="xs:boolean"/>
         <xs:element minOccurs="0" name="Deduplication" type="xs:boolean"/>
         <xs:element minOccurs="0" name="InPlaceHoldIdentity" type="xs:string"/>
         <xs:element minOccurs="0" name="ItemHoldPeriod" type="xs:string"/>
       </xs:sequence>
     </xs:extension>
   </xs:complexContent>
 </xs:complexType>

ActionType: An element of type HoldActionType , as defined in section 3.1.4.5.4.1 that represents the type of action.

HoldId: An element of type string, as defined in [XMLSCHEMA2] section 3.2.1, that represents the identifier of the hold.

Query:  An element of type string that represents a query.

Mailboxes: An element of type ArrayOfStringsType, as defined in [MS-OXWSCDATA] section 2.2.4.13, contains a set of distinguished names (DN) that represent the mailboxes to which the query-based hold will apply.

Language: An element of type string that represents the language of the query, for example, "en-us".<5>

IncludeNonIndexableItems: An element of type boolean, as defined in [XMLSCHEMA2] section 3.2.2, that indicates whether to include items that cannot be indexed.

Deduplication: An element of type boolean that indicates whether to remove duplicates from the search result.

InPlaceHoldIdentity: An element of type string that specifies the identity of a hold that preserves the mailbox items.

ItemHoldPeriod: An element of type string that specifies the time period for the hold.