Skip to content

Commit 36c7ebf

Browse files
authored
Merge pull request MicrosoftDocs#3432 from markjjo/markjjo-working
updated descriptions for mailbox and optionalinmailbox parameters
2 parents 3c96b00 + dba6627 commit 36c7ebf

File tree

2 files changed

+27
-3
lines changed

2 files changed

+27
-3
lines changed

exchange/exchange-ps/exchange/policy-and-compliance-retention/Get-RetentionPolicyTag.md

Lines changed: 26 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,29 @@ Accept wildcard characters: False
129129
```
130130
131131
### -Mailbox
132-
The Mailbox parameter isn't available in this release.
132+
The Mailbox parameter returns the retention tags that are assigned to the retention policy that's applied to the specified mailbox. You can use any value that uniquely identifies the mailbox. For example:
133+
134+
- Name
135+
136+
- Alias
137+
138+
- Distinguished name (DN)
139+
140+
- Canonical DN
141+
142+
- \<domain name\>\\\<account name\>
143+
144+
- Email address
145+
146+
- GUID
147+
148+
- LegacyExchangeDN
149+
150+
- SamAccountName
151+
152+
- User ID or user principal name (UPN)
153+
154+
This parameter only returns default policy tags (DPTs) and personal tags; it doesn't return retention policy tags.
133155
134156
```yaml
135157
Type: MailboxIdParameter
@@ -144,7 +166,9 @@ Accept wildcard characters: False
144166
```
145167
146168
### -OptionalInMailbox
147-
The OptionalInMailbox parameter isn't available in this release.
169+
The OptionalInMailbox parameter is used with the Mailbox parameter to return any opt-in retention tags that are assigned to the specified mailbox. You don't need to specify a value with this switch.
170+
171+
An opt-in retention tag is a personal tag that was explicitly assigned to the mailbox with the Set-RetentionPolicyTag -Mailbox -OptionalInMailbox command.
148172
149173
```yaml
150174
Type: SwitchParameter

exchange/exchange-ps/exchange/policy-and-compliance-retention/Set-RetentionPolicyTag.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -385,7 +385,7 @@ Accept wildcard characters: False
385385
```
386386
387387
### -OptionalInMailbox
388-
The OptionalInMailbox parameter is used with the Mailbox parameter to specify opt-in retention tags available to the mailbox.
388+
The OptionalInMailbox parameter is used with the Mailbox parameter to assign personal tags to the mailbox. You can use this parameter to make available to a user a personal tag that isn't assigned to the retention policy applied to the specified mailbox. You can specify multiple personal tags separated by commas.
389389
390390
```yaml
391391
Type: RetentionPolicyTagIdParameter[]

0 commit comments

Comments
 (0)