MailUser.LitigationHoldEnabled Property

Gets or sets a value that indicates whether the user’s mailbox is on litigation hold.

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

Syntax

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

value = instance.LitigationHoldEnabled

instance.LitigationHoldEnabled = value
[ParameterAttribute(Mandatory = false)]
public bool LitigationHoldEnabled { get; set; }

Property Value

Type: System.Boolean
true if the user’s mailbox is on litigation hold; otherwise, false.

Remarks

The default value is false.

If a user’s mailbox is on litigation hold, deleted items and all versions of changed items are retained in the Recoverable Items folder. Items that are purged from the dumpster are also retained and the items are held indefinitely. If litigation hold is enabled, single-item recovery quotas are not applied.