ExchangeService.SetRetentionPolicyForItemsInConversations Method

Definition

Sets the retention policy for items in conversation. The SetRetentionPolicyForItemsInConversations(IEnumerable<KeyValuePair<ConversationId,Nullable<DateTime>>>, FolderId, RetentionType, Nullable<Guid>) method is applicable for clients that target Exchange Online and versions of Exchange starting with Exchange Server 2013.

public:
 Microsoft::Exchange::WebServices::Data::ServiceResponseCollection<Microsoft::Exchange::WebServices::Data::ServiceResponse ^> ^ SetRetentionPolicyForItemsInConversations(System::Collections::Generic::IEnumerable<System::Collections::Generic::KeyValuePair<Microsoft::Exchange::WebServices::Data::ConversationId ^, Nullable<DateTime>>> ^ idLastSyncTimePairs, Microsoft::Exchange::WebServices::Data::FolderId ^ contextFolderId, Microsoft::Exchange::WebServices::Data::RetentionType retentionPolicyType, Nullable<Guid> retentionPolicyTagId);
public Microsoft.Exchange.WebServices.Data.ServiceResponseCollection<Microsoft.Exchange.WebServices.Data.ServiceResponse> SetRetentionPolicyForItemsInConversations (System.Collections.Generic.IEnumerable<System.Collections.Generic.KeyValuePair<Microsoft.Exchange.WebServices.Data.ConversationId,Nullable<DateTime>>> idLastSyncTimePairs, Microsoft.Exchange.WebServices.Data.FolderId contextFolderId, Microsoft.Exchange.WebServices.Data.RetentionType retentionPolicyType, Nullable<Guid> retentionPolicyTagId);
Public Function SetRetentionPolicyForItemsInConversations (idLastSyncTimePairs As IEnumerable(Of KeyValuePair(Of ConversationId, Nullable(Of DateTime))), contextFolderId As FolderId, retentionPolicyType As RetentionType, retentionPolicyTagId As Nullable(Of Guid)) As ServiceResponseCollection(Of ServiceResponse)

Parameters

idLastSyncTimePairs
IEnumerable<KeyValuePair<ConversationId,Nullable<DateTime>>>

A collection of conversation IDs and an associated time stamp used to determine which conversations need to be updated.

contextFolderId
FolderId

The ID of the folder that contains the conversation.

retentionPolicyType
RetentionType

The tagged item is either archived or deleted.

retentionPolicyTagId
Nullable<Guid>

The retention policy tag ID. Setting the reference to a null reference (Nothing in Visual Basic) clears the policy.

Returns

The results of the applied retention policy change.

Remarks

Calling this method results in a call to Exchange Web Services (EWS) Managed API.

Applies to