3.1.4.1.3.3 ConversationActionType

  • Article

The ConversationActionType complex type specifies a single action to be applied to a conversation.

 <xs:complexType name="ConversationActionType">
     <xs:sequence>
         <xs:element name="Action" type="t:ConversationActionTypeType" minOccurs="1" maxOccurs="1"/>
         <xs:element name="ConversationId" type="t:ItemIdType" minOccurs="1" maxOccurs="1"/>
         <xs:element name="ContextFolderId" type="t:TargetFolderIdType" minOccurs="0" maxOccurs="1"/>
         <xs:element name="ConversationLastSyncTime" type="xs:dateTime" minOccurs="0" maxOccurs="1"/>
         <xs:element name="ProcessRightAway" type="xs:boolean" minOccurs="0" maxOccurs="1"/>
         <xs:element name="DestinationFolderId" type="t:TargetFolderIdType" minOccurs="0" maxOccurs="1"/>
         <xs:element name="Categories" type="t:ArrayOfStringsType" minOccurs="0" maxOccurs="1"/>
         <xs:element name="EnableAlwaysDelete" type="xs:boolean" minOccurs="0" maxOccurs="1"/>
         <xs:element name="IsRead" type="xs:boolean" minOccurs="0" maxOccurs="1"/>
         <xs:element name="DeleteType" type="t:DisposalType" minOccurs="0" maxOccurs="1"/>
         <xs:element name="RetentionPolicyType" type="t:RetentionType" minOccurs="0" maxOccurs="1"/>
       <xs:element name="RetentionPolicyTagId" type="xs:string" minOccurs="0" maxOccurs="1"/>
       <xs:element name="Flag" type="t:FlagType" minOccurs="0" maxOccurs="1"/>
       <xs:element name="SuppressReadReceipts" type="xs:boolean" minOccurs="0" maxOccurs="1"/>
     </xs:sequence>
 </xs:complexType>
 

The following table lists and describes the child elements of the ConversationActionType complex type.

Element

Type

Description

Action

t:ConversationActionTypeType (section 3.1.4.1.4.1)

Specifies the action to perform on the conversation specified by the ConversationId element. This element MUST be present.

ConversationId

t:ItemIdType ([MS-OXWSCORE] section 2.2.4.25)

Specifies the conversation identifier of the targeted conversation for applying an action. This element MUST be present.

ContextFolderId

t:TargetFolderIdType ([MS-OXWSFOLD] section 2.2.4.16)

Specifies the folder that is targeted for actions that use folders. This element MUST be present when copying, deleting, moving, and setting the read state on conversation items in a target folder. This element MUST NOT be present when copying, deleting, moving, and setting the read state on all conversation items in a mailbox.

ConversationLastSyncTime

xs:dateTime ([XMLSCHEMA2])

Specifies the date and time that a conversation was last synchronized. This element MUST be present when trying to delete all items in a conversation that were received up to the specified time. All items received after the specified time MUST NOT be deleted.

ProcessRightAway

xs:boolean ([XMLSCHEMA2])

Specifies whether the response is sent as soon as the action starts processing on the server, or whether the response is sent after the action has completed. This element MUST be present for the response to be sent asynchronous to the requested action.

DestinationFolderId

t:TargetFolderIdType ([MS-OXWSFOLD] section 2.2.4.16)

Specifies the destination folder for copy and move actions. This element MUST be present when the Action element value is set to "AlwaysMove", "Move", or "Copy".

Categories

t:ArrayOfStringsType ([MS-OXWSCDATA] section 2.2.4.13)

Specifies the categories to set on items in a conversation. This element MUST be present when the Action element value is set to "AlwaysCategorize".

EnableAlwaysDelete

xs:boolean ([XMLSCHEMA2])

Specifies a flag that enables deletion for all new items in a conversation. This element MUST be present when the Action element value is set to "AlwaysDelete".

IsRead

xs:boolean ([XMLSCHEMA2])

Specifies a flag that enables setting the read state of items in a conversation. This element MUST be present when the Action element value is set to "SetReadState".

DeleteType

t:DisposalType ([MS-OXWSCDATA] section 2.2.5.9)

Specifies how items in a conversation are deleted. This element MUST be present when the Action element value is set to "AlwaysDelete" or "Delete".

RetentionPolicyType

RetentionType ([MS-OXWSURPT] section 2.2.5.1)

Specifies the retention policy for the item.<1>

RetentionPolicyTagId

xs:string ([XMLSCHEMA2])

Specifies the retention policy tag identifier.<2>

Flag

FlagType ([MS-OXWSCORE] section 2.2.4.23)

Specifies a flag on an item.<3>

SuppressReadReceipts

xs:boolean ([XMLSCHEMA2])

Specifies whether to suppress a read receipt.<4>