Share via


Set-MessageClassification (RTM)

Microsoft Exchange Server 2007 will reach end of support on April 11, 2017. To stay supported, you will need to upgrade. For more information, see Resources to help you upgrade your Office 2007 servers and clients.

 

Applies to: Exchange Server 2007

Use the Set-MessageClassification cmdlet to configure an existing message classification instance in your Exchange organization.

Syntax

Set-MessageClassification -Identity <MessageClassificationIdParameter> [-ClassificationID <Guid>] [-DisplayName <String>] [-DisplayPrecedence <Highest | Higher | High | MediumHigh | Medium | MediumLow | Low | Lower | Lowest>] [-DomainController <Fqdn>] [-Name <String>] [-RecipientDescription <String>] [-RetainClassificationEnabled <$true | $false>] [-SenderDescription <String>] [-UserDisplayEnabled <$true | $false>]

Set-MessageClassification [-ClassificationID <Guid>] [-DisplayName <String>] [-DisplayPrecedence <Highest | Higher | High | MediumHigh | Medium | MediumLow | Low | Lower | Lowest>] [-DomainController <Fqdn>] [-Instance <MessageClassification>] [-Name <String>] [-RecipientDescription <String>] [-RetainClassificationEnabled <$true | $false>] [-SenderDescription <String>] [-UserDisplayEnabled <$true | $false>]

Detailed Description

To run the Set-MessageClassification cmdlet, the account you use must be delegated the following:

  • Exchange Organization Administrator role

For more information about permissions, delegating roles, and the rights that are required to administer Microsoft Exchange Server 2007, see Permission Considerations.

Parameters

Parameter Required Type Description

Identity

Required

Microsoft.Exchange.Configuration.Tasks.MessageClassificationIdParameter

The Identity parameter can take a string value, which is the Name value, or the GUID.

ClassificationID

Optional

System.Guid

Use this parameter to specify a GUID of an existing message classification that you want to use in your Exchange organization. Use this parameter if you are configuring message classifications to span two Exchange forests in the same organization.

DisplayName

Optional

System.String

Use this parameter to specify the display name for the message classification instance. The display name appears in Microsoft Office 2007 and is used by Microsoft Outlook users to select the appropriate message classification before they send a message.

When you specify a name that includes spaces, you must enclose the whole name in quotation marks, as follows, for example, "Display Name". The DisplayName parameter must contain 64 or fewer characters.

DisplayPrecedence

Optional

Microsoft.Exchange.Data.Directory.SystemConfiguration.ClassificationDisplayPrecedenceLevel

Use this parameter to specify the relative precedence of the message classification to other message classifications that may be applied to a given message. Although Outlook only lets a user specify a single classification on a given message, transport rules may apply other classifications. This parameter sets the precedence on a given classification for what is displayed to the recipient in Outlook. The classification with the highest precedence is shown first, and the subsequent classifications, which are those with lesser precedence as defined by this parameter, are appended in the appropriate order thereafter.

Valid input for the DisplayPrecedence parameter is Highest, Higher, High, MediumHigh, Medium, MediumLow, Low, Lower, and Lowest.

The default value is Mediuum.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

To specify the fully qualified domain name (FQDN) of the domain controller that writes this configuration change to the Active Directory directory service, include the DomainController parameter on the command. The DomainController parameter is not supported on computers that have the Edge Transport server role installed. The Edge Transport server role only writes to and reads from the local Active Directory Application Mode (ADAM) instance.

Instance

Optional

Microsoft.Exchange.Data.Directory.SystemConfiguration.MessageClassification

Use this parameter to pass a whole object to the command to be processed. This parameter is mainly used in scripts where a whole object must be passed to the command.

Name

Optional

System.String

Use this parameter to specify the administrative name for the message classification instance. The name is used to administer the message classification instance. When you specify a name that includes spaces, you must enclose the whole name in quotation marks, as follows, for example, "Adminstrative Name". The Name parameter must contain 256 or fewer characters.

RecipientDescription

Optional

System.String

Use this parameter to explain to the recipient what the message classification was intended to achieve. The text you enter in this parameter is viewed by Outlook users when they receive a message that has this message classification. Enclose the description in quotation marks, as follows, for example, "This is the recipient description that explains how to treat the message that has been classified". The RecipientDescription parameter must contain 1024 or fewer characters.

If you do not enter a value for this parameter, the description that you enter for SenderDescription is used.

RetainClassificationEnabled

Optional

System.Boolean

Use this parameter to specify whether the message classification should persist with the message if the message is forwarded or replied to.

The default value is $true.

SenderDescription

Optional

System.String

Use this parameter to explain to the sender what the message classification is intended to achieve. The text you enter in this parameter is used by Outlook users to select the appropriate message classification before they send a message. Enclose the description in quotation marks, as follows, for example, "This is the sender description that explains when to use this message classification". The SenderDescription parameter must contain 1024 or fewer characters.

UserDisplayEnabled

Optional

System.Boolean

When the UserDisplayEnabled parameter is set to $true, it displays the text that you entered in the DisplayName and RecipientDescription parameters to the recipient of messages that are sent with this message classification.

The default value is $true.

Example

The following code example sets the confidentiality action to "None" and the display precedence to "false" for the message classification instance that has an Identity parameter of "Example". It also specifies that the message classification should not persist with the message if the message is forwarded or replied to.

Set-MessageClassification -Identity Example -ConfidentialityAction None -DisplayPrecedence -RetainClassificationEnabled: $false