Set-MailboxComplianceConfiguration

  • Article

Applies to: Exchange Server 2010

Use the Set-MailboxComplianceConfiguration cmdlet to enable AutoTagging for a mailbox. Before enabling AutoTagging for a mailbox, the mailbox user must have tagged at least 500 messages using either item-level or folder-level tags.

Syntax

Set-MailboxComplianceConfiguration -Identity <MailboxIdParameter> [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-IgnoreDefaultScope <SwitchParameter>] [-RetentionAutoTaggingEnabled <$true | $false>] [-WhatIf [<SwitchParameter>]]

Parameters

Parameter Required Type Description

Identity

Required

Microsoft.Exchange.Configuration.Tasks.MailboxIdParameter

The Identity parameter specifies the mailbox. You can use one of the following values:

  • GUID
  • DistinguishedName (DN)
  • Domain\Account
  • User principal name (UPN)
  • LegacyExchangeDN
  • SmtpAddress
  • Alias

Confirm

Optional

System.Management.Automation.SwitchParameter

The Confirm switch causes the command to pause processing and requires you to acknowledge what the command will do before processing continues. You don't have to specify a value with the Confirm switch.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

The DomainController parameter specifies the fully qualified domain name (FQDN) of the domain controller that writes this configuration change to Active Directory.

IgnoreDefaultScope

Optional

System.Management.Automation.SwitchParameter

The IgnoreDefaultScope parameter isn't available in this release.

RetentionAutoTaggingEnabled

Optional

System.Boolean

The RetentionAutoTaggingEnabled parameter specifies whether to enable retention AutoTagging.

You can use one of the following values:

  • $true   This value enables AutoTagging.
  • $false   This value disables AutoTagging.

WhatIf

Optional

System.Management.Automation.SwitchParameter

The WhatIf switch instructs the command to simulate the actions that it would take on the object. By using the WhatIf switch, you can view what changes would occur without having to apply any of those changes. You don't have to specify a value with the WhatIf switch.

Detailed Description

You need to be assigned permissions before you can run this cmdlet. Although all parameters for this cmdlet are listed in this topic, you may not have access to some parameters if they're not included in the permissions assigned to you. To see what permissions you need, see the "Messaging records management" entry in the Messaging Policy and Compliance Permissions topic.

Input Types

Return Types

Errors

Error Description

 

 

Examples

EXAMPLE 1

This example enables AutoTagging for the mailbox Joe@Contoso.com.

Set-MailboxComplianceConfiguration Joe@Contoso.com -RetentionAutoTaggingEnabled $true