• Article

Mailbox.RetentionHoldEnabled Property

Gets or sets a value that indicates whether the contents of the mailbox are subject to retention.

Namespace:  Microsoft.Exchange.Data.Directory.Management
Assembly:  Microsoft.Exchange.Data.Directory (in Microsoft.Exchange.Data.Directory.dll)

Syntax

'Declaration
<ParameterAttribute(Mandatory := False)> _
Public Property RetentionHoldEnabled As Boolean
    Get
    Set
'Usage
Dim instance As Mailbox
Dim value As Boolean

value = instance.RetentionHoldEnabled

instance.RetentionHoldEnabled = value

[ParameterAttribute(Mandatory = false)]
public bool RetentionHoldEnabled { get; set; }

Property Value

Type: System.Boolean
true if the contents of the mailbox are subject to retention; otherwise, false.

Remarks

To set the start date for retention hold, set the StartDateForRetentionHold property. To set the end date for retention hold, set the EndDateForRetentionHold property.