Applies to: Exchange Server 2010 SP3, Exchange Server 2010 SP2

Topic Last Modified: 2012-11-13

Use the Start-RetentionAutoTagLearning cmdlet to start auto-tagging for a specified mailbox or to cross-validate auto-tagging results for the mailbox.

Important:
Messaging records management (MRM) must be configured before the Start-RetentionAutoTagLearning cmdlet can be used. For more information, see Understanding Retention Tags and Retention Policies.

Syntax

Start-RetentionAutoTagLearning [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-WhatIf [<SwitchParameter>]]
Start-RetentionAutoTagLearning -Identity <MailboxIdParameter> [-Clear <SwitchParameter>] [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-Train <SwitchParameter>] [-WhatIf [<SwitchParameter>]]
Start-RetentionAutoTagLearning -Identity <MailboxIdParameter> -CrossValidate <SwitchParameter> [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-NumberOfSegments <Int32>] [-WhatIf [<SwitchParameter>]]

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.

Parameters

Parameter Required Type Description

CrossValidate

Required

System.Management.Automation.SwitchParameter

The CrossValidate switch specifies whether items in the specified mailbox are being auto-tagged.

Identity

Required

Microsoft.Exchange.Configuration.Tasks.MailboxIdParameter

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

  • GUID

  • Distinguished name (DN)

  • Domain\Account

  • User principal name (UPN)

  • LegacyExchangeDN

  • SmtpAddress

  • Alias

Clear

Optional

System.Management.Automation.SwitchParameter

The Clear switch specifies whether to clear auto-tags from the specified mailbox.

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.

NumberOfSegments

Optional

System.Int32

The NumberOfSegments parameter specifies the number of segments. Auto-tagging divides a mailbox into the number of segments specified and learns tagging behavior from n-1 segments. Tags are then predicted for items in the remaining segment based on this behavior. This is done for each segment.

The default value is 10.

The minimum value is 2.

Note:
The NumberOfSegments parameter can be used only in conjunction with the CrossValidate parameter.

Train

Optional

System.Management.Automation.SwitchParameter

The Train switch specifies whether to start the training algorithm for auto-tagging on the specified mailbox. This switch is especially useful for retraining. No values are required with this switch.

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.

Input Types

To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types. If the Input Type field for a cmdlet is blank, the cmdlet doesn’t accept input data.

Return Types

To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types. If the Output Type field is blank, the cmdlet doesn’t return data.

Examples

EXAMPLE1

This example sets user Joe Healy's mailbox to train.

Copy Code 
Start-RetentionAutoTagLearning -Identity "Joe Healy" -Train

EXAMPLE 2

This example sets user Joe Healy's mailbox to cross-validate and sets the number of segments for cross-validation to 15.

Copy Code 
Start-RetentionAutoTagLearning -Identity "Joe Healy" -CrossValidate -NumberOfSegments 15

EXAMPLE 3

This example sets user Joe Healy's mailbox to clear all retention policy tags assigned by auto-tagging.

Copy Code 
Start-RetentionAutoTagLearning -Identity "Joe Healy" -Clear