Share via

3.1.4.1.3.4 RetentionPolicyTagType

  • Article

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

The RetentionPolicyTagType complex type specifies a retention policy tag.

 <xs:complexType name="RetentionPolicyTagType" xmlns:xs="http://www.w3.org/2001/XMLSchema">
   <xs:sequence>
     <xs:element minOccurs="1" maxOccurs="1" name="DisplayName" type="xs:string"/>
     <xs:element minOccurs="1" maxOccurs="1" name="RetentionId" type="t:GuidType"/>
     <xs:element minOccurs="1" maxOccurs="1" name="RetentionPeriod" type="xs:int"/>
     <xs:element minOccurs="1" maxOccurs="1" name="Type" type="t:ElcFolderType"/>
     <xs:element minOccurs="1" maxOccurs="1" name="RetentionAction" type="t:RetentionActionType"/>
     <xs:element minOccurs="0" maxOccurs="1" name="Description" type="xs:string"/>
     <xs:element minOccurs="1" maxOccurs="1" name="IsVisible" type="xs:boolean"/>
     <xs:element minOccurs="1" maxOccurs="1" name="OptedInto" type="xs:boolean"/>
     <xs:element minOccurs="1" maxOccurs="1" name="IsArchive" type="xs:boolean"/>
   </xs:sequence>
 </xs:complexType>

DisplayName: An element of type string, as defined in [XMLSCHEMA2/2] section 3.2.1, that specifies the name of the retention policy.

RetentionId: An element of type GuidType, as defined in [MS-OXWSXPROP] section 2.1.7, that contains the retention tag identifier.

RetentionPeriod: An element of type int, as defined in [XMLSCHEMA2/2] section 3.3.17, that contains the number of days the retention is in effect.

Type: An element of type ElcFolderType, as defined in section 3.1.4.1.4.1, that indicates the type of the folder being used in a retention policy.

RetentionAction: An element that is of the RetentionActionType simple type, as defined in section 3.1.4.1.4.2, that contains the action performed by the retention tag.

Description:  An element of type string that contains the descriptive text for the retention policy.

IsVisible: An element of type boolean, as defined in [XMLSCHEMA2/2] section 3.2.2, that indicates whether the retention policy is visible to users.

OptedInto: An element of type boolean that indicates whether the user opted in to the retention policy.

IsArchive: An element of type boolean that indicates whether this is a move to archive the tag.