Skip to content

Commit ba98eb1

Browse files
committed
Updates to MessageClassification cmdlets
General consistency fixes and Locale description updates per Issue #3305
1 parent df8b1b1 commit ba98eb1

File tree

4 files changed

+143
-80
lines changed

4 files changed

+143
-80
lines changed

exchange/exchange-ps/exchange/policy-and-compliance/Get-MessageClassification.md

Lines changed: 25 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,10 @@ For information about the parameter sets in the Syntax section below, see Exchan
2121
## SYNTAX
2222

2323
```
24-
Get-MessageClassification [[-Identity] <MessageClassificationIdParameter>]
25-
[-DomainController <Fqdn>] [-IncludeLocales] [<CommonParameters>]
24+
Get-MessageClassification [[-Identity] <MessageClassificationIdParameter>]
25+
[-DomainController <Fqdn>]
26+
[-IncludeLocales]
27+
[<CommonParameters>]
2628
```
2729

2830
## DESCRIPTION
@@ -39,42 +41,48 @@ This example lists all message classifications in your organization.
3941

4042
## PARAMETERS
4143

42-
### -DomainController
43-
This parameter is available only in on-premises Exchange.
44+
### -Identity
45+
The Identity parameter specifies the message classification that you want to view. You can use any value that uniquely identifies the message classification. For example:
4446

45-
The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com.
47+
- Name
4648

47-
The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data.
49+
- Identity: Default\\<Name\> or \<Locale\>\\<Name\>; for example, "Default\My Message Classification" or "es-ES\My Message Classification".
50+
51+
- ClassificationID (GUID)
4852

4953
```yaml
50-
Type: Fqdn
54+
Type: MessageClassificationIdParameter
5155
Parameter Sets: (All)
5256
Aliases:
53-
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
57+
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
5458
Required: False
55-
Position: Named
59+
Position: 1
5660
Default value: None
57-
Accept pipeline input: False
61+
Accept pipeline input: True
5862
Accept wildcard characters: False
5963
```
6064
61-
### -Identity
62-
The Identity parameter specifies the name of the message classification instance that you want to view. When you specify a name that includes spaces, you must enclose the name in quotation marks ("), for example, "Administrative Name".
65+
### -DomainController
66+
This parameter is available only in on-premises Exchange.
67+
68+
The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com.
69+
70+
The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data.
6371
6472
```yaml
65-
Type: MessageClassificationIdParameter
73+
Type: Fqdn
6674
Parameter Sets: (All)
6775
Aliases:
68-
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
76+
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
6977
Required: False
70-
Position: 1
78+
Position: Named
7179
Default value: None
72-
Accept pipeline input: True
80+
Accept pipeline input: False
7381
Accept wildcard characters: False
7482
```
7583
7684
### -IncludeLocales
77-
The IncludeLocales switch specifies whether the command output includes the message classification locale data. When you use the IncludeLocales switch, the output includes the message classification locale data.
85+
The IncludeLocales switch specifies whether to return message classification locale information in the results. You don't need to specify a value with this switch.
7886
7987
```yaml
8088
Type: SwitchParameter

exchange/exchange-ps/exchange/policy-and-compliance/New-MessageClassification.md

Lines changed: 52 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -53,53 +53,49 @@ You need to be assigned permissions before you can run this cmdlet. Although thi
5353

5454
### -------------------------- Example 1 --------------------------
5555
```
56-
New-MessageClassification -Name MyMessageClassification -DisplayName "New Message Classification" -SenderDescription "This is the description text"
56+
New-MessageClassification -Name "My Message Classification" -DisplayName "New Message Classification" -SenderDescription "This is the description text"
5757
```
5858

59-
This example creates the message classification named MyMessageClassification with the following properties:
59+
This example creates the message classification named My Message Classification with the following properties:
6060

6161
- The display name is New Message Classification.
6262

6363
- The sender description is "This is the description text".
6464

6565
### -------------------------- Example 2 --------------------------
6666
```
67-
New-MessageClassification MyMessageClassification -Locale es-ES -DisplayName "España Example" -SenderDescription "Este es el texto de la descripción"
67+
New-MessageClassification -Name "My Message Classification" -Locale es-ES -DisplayName "España Example" -SenderDescription "Este es el texto de la descripción"
6868
```
6969

70-
This example creates a locale-specific (Spanish - Spain) version of an existing message classification MyMessageClassification.
70+
In on-premises Exchange, this example creates a locale-specific (Spanish - Spain) version of an existing message classification named "My Message Classification".
7171

7272
## PARAMETERS
7373

74-
### -DisplayName
75-
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.
76-
77-
The message classification XML file must be present on the sender's computer for the display name to be displayed.
78-
79-
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.
80-
81-
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.
74+
### -Name
75+
The Name parameter specifies the unique name for the message classification. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks (").
8276

8377
```yaml
8478
Type: String
8579
Parameter Sets: (All)
8680
Aliases:
8781
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
8882
Required: True
89-
Position: Named
83+
Position: 1
9084
Default value: None
9185
Accept pipeline input: False
9286
Accept wildcard characters: False
9387
```
9488
95-
### -Locale
96-
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.
89+
### -DisplayName
90+
The DisplayName parameter specifies the title of the message classification that's displayed in Outlook and selected by users. The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks (").
9791
98-
Valid input for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class. For example, da-DK for Danish or ja-JP for Japanese. For more information, see CultureInfo Class (https://go.microsoft.com/fwlink/p/?linkId=184859).
92+
The message classification XML file must be present on the sender's computer for the display name to be displayed.
93+
94+
If the UserDisplayEnabled parameter is set to $true, the value of this parameter is displayed for the recipient, even if no message classification XML file is installed.
9995
10096
```yaml
101-
Type: CultureInfo
102-
Parameter Sets: Localized
97+
Type: String
98+
Parameter Sets: (All)
10399
Aliases:
104100
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
105101
Required: True
@@ -109,23 +105,27 @@ Accept pipeline input: False
109105
Accept wildcard characters: False
110106
```
111107
112-
### -Name
113-
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, "Administrative Name". The Name parameter can contain a maximum of 256 characters.
108+
### -Locale
109+
This parameter is available or functional on in on-premises Exchange.
110+
111+
The Locale parameter specifies a locale-specific version of an existing message classification. You use the -Name parameter to identify the existing message classification, and the SenderDescription parameter to specify the descriptive text in another language.
112+
113+
A valid value for this parameter is a supported culture code value from the Microsoft .NET Framework CultureInfo class (for example, da-DK for Danish or ja-JP for Japanese). For more information, see CultureInfo Class (https://go.microsoft.com/fwlink/p/?linkId=184859).
114114
115115
```yaml
116-
Type: String
117-
Parameter Sets: (All)
116+
Type: CultureInfo
117+
Parameter Sets: Localized
118118
Aliases:
119-
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
119+
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
120120
Required: True
121-
Position: 1
121+
Position: Named
122122
Default value: None
123123
Accept pipeline input: False
124124
Accept wildcard characters: False
125125
```
126126
127127
### -SenderDescription
128-
The SenderDescription parameter specifies the purpose of the message classification to the sender. The value of this parameter is used by Outlook users to select the appropriate message classification before they send a message. Enclose the value 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.
128+
The SenderDescription parameter specifies the the detailed text that's shown to Outlook senders when they select a message classification to apply to a message before they send the message. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks (").
129129
130130
```yaml
131131
Type: String
@@ -140,7 +140,9 @@ Accept wildcard characters: False
140140
```
141141
142142
### -ClassificationID
143-
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.
143+
The ClassificationID parameter specifies the classification ID (GUID) 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 organization.
144+
145+
To find the ClassificationID value of the message classification, replace \<MessageClassificationName\> with the name of the message classification and run the following command: Get-MessageCalssification -Identity "\<MessageClassificationName\>.
144146
145147
```yaml
146148
Type: Guid
@@ -174,11 +176,27 @@ Accept wildcard characters: False
174176
```
175177
176178
### -DisplayPrecedence
177-
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 per message, transport rules may apply other classifications to a message. 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.
179+
The DisplayPrecedence parameter specifies the relative precedence of the message classification to other message classifications that may be applied to a specified message. Valid values are:
178180
179-
Valid input for the DisplayPrecedence parameter is Highest, Higher, High, MediumHigh, Medium, MediumLow, Low, Lower and Lowest.
181+
- Highest
180182
181-
The default value is Medium.
183+
- Higher
184+
185+
- High
186+
187+
- MediumHigh
188+
189+
- Medium (This is the default value)
190+
191+
- MediumLow
192+
193+
- Low
194+
195+
- Lower
196+
197+
- Lowest
198+
199+
Although Outlook only lets a user specify a single classification for a message, transport rules may apply other classifications to a message. 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.
182200
183201
```yaml
184202
Type: Highest | Higher | High | MediumHigh | Medium | MediumLow | Low | Lower | Lowest
@@ -212,11 +230,11 @@ Accept wildcard characters: False
212230
```
213231
214232
### -PermissionMenuVisible
215-
The PermissionMenuVisible parameter specifies whether the values that you entered for the DisplayName and RecipientDescription parameters are displayed in Outlook as the user composes a message.
233+
The PermissionMenuVisible parameter specifies whether the values that you entered for the DisplayName and RecipientDescription parameters are displayed in Outlook as the user composes a message. Valid values are:
216234
217-
If you set the PermissionMenuVisible parameter to $false, users won't be able to assign this message classification to the messages they are composing. However, messages received with this message classification still display the classification information.
235+
- $true: Users can assign the message classification to messages before they're sent, and the classification information is displayed. This is the default value.
218236
219-
The default value is $true.
237+
- $false: Users can't assign the message classification to messages before they're sent, However, messages received with this message classification still display the classification information.
220238
221239
```yaml
222240
Type: $true | $false
@@ -231,9 +249,9 @@ Accept wildcard characters: False
231249
```
232250
233251
### -RecipientDescription
234-
The RecipientDescription parameter specifies the purpose of the message classification to the recipient. The value of this parameter is shown to Outlook users when they receive a message that has this message classification. Enclose the value 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.
252+
The RecipientDescription parameter specifies the the detailed text that's shown to Outlook recipient when they receive a message that has the message classification applied. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks (").
235253
236-
If you don't enter a value for this parameter, the description that you enter for the SenderDescription parameter is used.
254+
If you don't use this parameter, the value of the SenderDescription parameter is used.
237255
238256
```yaml
239257
Type: String

exchange/exchange-ps/exchange/policy-and-compliance/Remove-MessageClassification.md

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,10 @@ For information about the parameter sets in the Syntax section below, see Exchan
2121
## SYNTAX
2222

2323
```
24-
Remove-MessageClassification [-Identity] <MessageClassificationIdParameter> [-Confirm]
25-
[-DomainController <Fqdn>] [-WhatIf] [<CommonParameters>]
24+
Remove-MessageClassification [-Identity] <MessageClassificationIdParameter>
25+
[-Confirm]
26+
[-DomainController <Fqdn>]
27+
[-WhatIf] [<CommonParameters>]
2628
```
2729

2830
## DESCRIPTION
@@ -31,17 +33,22 @@ You need to be assigned permissions before you can run this cmdlet. Although thi
3133
## EXAMPLES
3234

3335
### -------------------------- Example 1 --------------------------
34-
35-
```powershell
36-
Remove-MessageClassification MyMessageClassification
36+
```
37+
Remove-MessageClassification -Identity "My Message Classification"
3738
```
3839

39-
This example removes the message classification named MyMessageClassification.
40+
This example removes the message classification named "My Message Classification".
4041

4142
## PARAMETERS
4243

4344
### -Identity
44-
The Identity parameter specifies the name of the message classification instance that you want to remove. When you specify a name that includes spaces, you must enclose the name in quotation marks ("), for example, "Administrative Name".
45+
The Identity parameter specifies the message classification that you want to remove. You can use any value that uniquely identifies the message classification. For example:
46+
47+
- Name
48+
49+
- Identity: Default\\<Name\> or \<Locale\>\\<Name\>; for example, "Default\My Message Classification" or "es-ES\My Message Classification".
50+
51+
- ClassificationID (GUID)
4552

4653
```yaml
4754
Type: MessageClassificationIdParameter

0 commit comments

Comments
 (0)