Export (0) Print
Expand All

New-MessageClassification

Applies to: Exchange Server 2010

Topic Last Modified: 2011-03-19

Use the New-MessageClassification cmdlet to create a message classification instance in your Exchange organization.


New-MessageClassification -Name <String> -DisplayName <String> -SenderDescription <String> [-ClassificationID <Guid>] [-Confirm [<SwitchParameter>]] [-DisplayPrecedence <Highest | Higher | High | MediumHigh | Medium | MediumLow | Low | Lower | Lowest>] [-DomainController <Fqdn>] [-Organization <OrganizationIdParameter>] [-RecipientDescription <String>] [-RetainClassificationEnabled <$true | $false>] [-UserDisplayEnabled <$true | $false>] [-WhatIf [<SwitchParameter>]]


New-MessageClassification -Name <String> -DisplayName <String> -Locale <CultureInfo> -SenderDescription <String> [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-Organization <OrganizationIdParameter>] [-RecipientDescription <String>] [-WhatIf [<SwitchParameter>]]

Parameter Required Type Description

DisplayName

Required

System.String

The DisplayName parameter specifies the display name for the message classification instance. The display name is used by Outlook users to select the appropriate message classification before they send a message.

Bb124400.note(en-us,EXCHG.140).gifNote:
The message classification XML file must be present on the sender's computer for the display name to be displayed.

If the UserDisplayEnabled parameter is set to $true, the display name is displayed for the recipient, even if no message classification XML file is installed.

When you specify a name that includes spaces, you must enclose the name in quotation marks ("), for example, "Display Name". The DisplayName parameter can contain a maximum of 64 characters.

Locale

Required

System.Globalization.CultureInfo

The Locale parameter specifies a locale-specific version of the message classification. You must also pass the Identity parameter of the default existing message classification when you create a new locale-specific version.

Valid input for the Locale parameter is the string names listed in the Culture Name column in the Microsoft .NET Class Library class reference available at CultureInfo.

Name

Required

System.String

The Name parameter specifies 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 name in quotation marks ("), for example, "Adminstrative Name". The Name parameter can contain a maximum of 256 characters.

SenderDescription

Required

System.String

The SenderDescription parameter specifies to the sender what the message classification is intended to achieve. The text that 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 ("), for example, "This is the sender description that explains when to use this message classification". The SenderDescription parameter can contain a maximum of 1,024 characters.

ClassificationID

Optional

System.Guid

The ClassificationID parameter specifies a classification ID of an existing message classification that you want to import and use in your Exchange organization. Use this parameter if you're configuring message classifications that span two Exchange forests in the same enterprise.

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.

DisplayPrecedence

Optional

Microsoft.Exchange.Data.Directory.SystemConfiguration.ClassificationDisplayPrecedenceLevel

The DisplayPrecedence parameter specifies the relative precedence of the message classification to other message classifications that may be applied to a specified message. Although Outlook only lets a user specify a single classification on a specified message, transport rules may apply other classifications. This parameter sets the precedence on a specified classification for what's 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 Medium.

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. The DomainController parameter isn't supported on the Edge Transport server role. The Edge Transport server role writes only to the Active Directory Lightweight Directory Services (AD LDS) instance.

Organization

Optional

Microsoft.Exchange.Configuration.Tasks.OrganizationIdParameter

The Organization parameter is reserved for internal Microsoft use.

RecipientDescription

Optional

System.String

The RecipientDescription parameter specifies to the recipient what the message classification is intended to achieve. The text that 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 ("), for example, "This is the recipient description that explains how to treat the message that has been classified". The RecipientDescription parameter can contain a maximum of 1,024 characters.

If you don't enter a value for this parameter, the description that you enter for the SenderDescription parameter is used.

RetainClassificationEnabled

Optional

System.Boolean

The RetainClassificationEnabled parameter specifies whether the message classification should persist with the message if the message is forwarded or replied to.

The default value is $true.

UserDisplayEnabled

Optional

System.Boolean

The UserDisplayEnabled parameter specifies whether the values that you entered for the DisplayName and RecipientDescription parameters are displayed in the recipient's Outlook message.

If you set the UserDisplayEnabled parameter to $false, messages sent to recipients that have this message classification don't display any classification information.

The default value is $true.

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.

After you create a new message classification, you can specify the message classification as a transport rule predicate. Before Microsoft Office Outlook 2007 and Microsoft Office Outlook Web App users can apply the message classification to messages, you must update the end-user systems with the message classification XML file created by the Export-OutlookClassification.ps1 script file. The Export-OutlookClassification.ps1 script file is located in the \Program Files\Microsoft\Exchange Server\V14\Scripts directory.

When you create a message classification, it has no locale. By default, the new message classification is used for all locales. After a default message classification is defined, you can add new locales of the classification by running the New-MessageClassification cmdlet and by specifying the default message classification identity that you want to localize.

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 "Message classifications" entry in the Transport Permissions topic.

This example creates the message classification MyMessageClassification with the following properties:

  • The display name is New Message Classification.
  • The sender description is "This is the description text".
New-MessageClassification -Name MyMessageClassification -DisplayName "New Message Classification" -SenderDescription "This is the description text"

This example creates a locale-specific (Spanish - Spain) version of an existing message classification MyMessageClassification.

New-MessageClassification -Identity MyMessageClassification -Locale es-ES -DisplayName "España Example " -SenderDescription "Este es el texto de la descripción"
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft