Skip to content

Commit df9850d

Browse files
chrisdachrisda
committed
Update Set-RemoteMailbox.md
Per Issue #1894
1 parent 4879719 commit df9850d

File tree

1 file changed

+166
-129
lines changed

1 file changed

+166
-129
lines changed

‎exchange/exchange-ps/exchange/federation-and-hybrid/Set-RemoteMailbox.md

Lines changed: 166 additions & 129 deletions
Original file line numberDiff line numberDiff line change
@@ -18,30 +18,67 @@ For information about the parameter sets in the Syntax section below, see Exchan
1818
## SYNTAX
1919

2020
```
21-
Set-RemoteMailbox [-Identity] <RemoteMailboxIdParameter> [-AcceptMessagesOnlyFrom <MultiValuedProperty>]
21+
Set-RemoteMailbox [-Identity] <RemoteMailboxIdParameter>
22+
[-AcceptMessagesOnlyFrom <MultiValuedProperty>]
2223
[-AcceptMessagesOnlyFromDLMembers <MultiValuedProperty>]
23-
[-AcceptMessagesOnlyFromSendersOrMembers <MultiValuedProperty>] [-Alias <String>] [-ArchiveGuid <Guid>]
24-
[-ArchiveName <MultiValuedProperty>] [-BypassModerationFromSendersOrMembers <MultiValuedProperty>] [-Confirm]
25-
[-CustomAttribute1 <String>] [-CustomAttribute10 <String>] [-CustomAttribute11 <String>]
26-
[-CustomAttribute12 <String>] [-CustomAttribute13 <String>] [-CustomAttribute14 <String>]
27-
[-CustomAttribute15 <String>] [-CustomAttribute2 <String>] [-CustomAttribute3 <String>]
28-
[-CustomAttribute4 <String>] [-CustomAttribute5 <String>] [-CustomAttribute6 <String>]
29-
[-CustomAttribute7 <String>] [-CustomAttribute8 <String>] [-CustomAttribute9 <String>] [-DisplayName <String>]
30-
[-DomainController <Fqdn>] [-EmailAddresses <ProxyAddressCollection>]
31-
[-EmailAddressPolicyEnabled <$true | $false>] [-ExchangeGuid <Guid>]
32-
[-ExtensionCustomAttribute1 <MultiValuedProperty>] [-ExtensionCustomAttribute2 <MultiValuedProperty>]
33-
[-ExtensionCustomAttribute3 <MultiValuedProperty>] [-ExtensionCustomAttribute4 <MultiValuedProperty>]
34-
[-ExtensionCustomAttribute5 <MultiValuedProperty>] [-GrantSendOnBehalfTo <MultiValuedProperty>]
35-
[-HiddenFromAddressListsEnabled <$true | $false>] [-IgnoreDefaultScope] [-ImmutableId <String>]
36-
[-MailTipTranslations <MultiValuedProperty>] [-ModeratedBy <MultiValuedProperty>]
37-
[-ModerationEnabled <$true | $false>] [-Name <String>] [-PrimarySmtpAddress <SmtpAddress>]
38-
[-RejectMessagesFrom <MultiValuedProperty>] [-RejectMessagesFromDLMembers <MultiValuedProperty>]
39-
[-RejectMessagesFromSendersOrMembers <MultiValuedProperty>] [-RemoteRoutingAddress <ProxyAddress>]
40-
[-RemovePicture] [-RemoveSpokenName] [-RequireSenderAuthenticationEnabled <$true | $false>]
41-
[-ResetPasswordOnNextLogon <$true | $false>] [-SamAccountName <String>]
42-
[-SendModerationNotifications <Never | Internal | Always>] [-Type <Regular | Room | Equipment | Shared>]
43-
[-UserPrincipalName <String>] [-WhatIf] [-WindowsEmailAddress <SmtpAddress>] [-ACLableSyncedObjectEnabled]
44-
[-MailTip <String>] [-RecoverableItemsQuota <Unlimited>] [-RecoverableItemsWarningQuota <Unlimited>]
24+
[-AcceptMessagesOnlyFromSendersOrMembers <MultiValuedProperty>]
25+
[-ACLableSyncedObjectEnabled]
26+
[-Alias <String>]
27+
[-ArchiveGuid <Guid>]
28+
[-ArchiveName <MultiValuedProperty>]
29+
[-BypassModerationFromSendersOrMembers <MultiValuedProperty>]
30+
[-Confirm]
31+
[-CustomAttribute1 <String>]
32+
[-CustomAttribute10 <String>]
33+
[-CustomAttribute11 <String>]
34+
[-CustomAttribute12 <String>]
35+
[-CustomAttribute13 <String>]
36+
[-CustomAttribute14 <String>]
37+
[-CustomAttribute15 <String>]
38+
[-CustomAttribute2 <String>]
39+
[-CustomAttribute3 <String>]
40+
[-CustomAttribute4 <String>]
41+
[-CustomAttribute5 <String>]
42+
[-CustomAttribute6 <String>]
43+
[-CustomAttribute7 <String>]
44+
[-CustomAttribute8 <String>]
45+
[-CustomAttribute9 <String>]
46+
[-DisplayName <String>]
47+
[-DomainController <Fqdn>]
48+
[-EmailAddresses <ProxyAddressCollection>]
49+
[-EmailAddressPolicyEnabled <$true | $false>]
50+
[-ExchangeGuid <Guid>]
51+
[-ExtensionCustomAttribute1 <MultiValuedProperty>]
52+
[-ExtensionCustomAttribute2 <MultiValuedProperty>]
53+
[-ExtensionCustomAttribute3 <MultiValuedProperty>]
54+
[-ExtensionCustomAttribute4 <MultiValuedProperty>]
55+
[-ExtensionCustomAttribute5 <MultiValuedProperty>]
56+
[-GrantSendOnBehalfTo <MultiValuedProperty>]
57+
[-HiddenFromAddressListsEnabled <$true | $false>]
58+
[-IgnoreDefaultScope]
59+
[-ImmutableId <String>]
60+
[-MailTip <String>]
61+
[-MailTipTranslations <MultiValuedProperty>]
62+
[-ModeratedBy <MultiValuedProperty>]
63+
[-ModerationEnabled <$true | $false>]
64+
[-Name <String>]
65+
[-PrimarySmtpAddress <SmtpAddress>]
66+
[-RecoverableItemsQuota <Unlimited>]
67+
[-RecoverableItemsWarningQuota <Unlimited>]
68+
[-RejectMessagesFrom <MultiValuedProperty>]
69+
[-RejectMessagesFromDLMembers <MultiValuedProperty>]
70+
[-RejectMessagesFromSendersOrMembers <MultiValuedProperty>]
71+
[-RemoteRoutingAddress <ProxyAddress>]
72+
[-RemovePicture]
73+
[-RemoveSpokenName]
74+
[-RequireSenderAuthenticationEnabled <$true | $false>]
75+
[-ResetPasswordOnNextLogon <$true | $false>]
76+
[-SamAccountName <String>]
77+
[-SendModerationNotifications <Never | Internal | Always>]
78+
[-Type <Regular | Room | Equipment | Shared>]
79+
[-UserPrincipalName <String>]
80+
[-WhatIf]
81+
[-WindowsEmailAddress <SmtpAddress>]
4582
[<CommonParameters>]
4683
```
4784

@@ -222,6 +259,21 @@ Accept pipeline input: False
222259
Accept wildcard characters: False
223260
```
224261
262+
### -ACLableSyncedObjectEnabled
263+
The ACLableSyncedObjectEnabled switch specifies whether the remote mailbox is an ACLableSyncedMailboxUser. To enable this, use this switch without a value. To disable this, use this exact syntax: -ACLableSyncedObjectEnabled:$false.
264+
265+
```yaml
266+
Type: SwitchParameter
267+
Parameter Sets: (All)
268+
Aliases:
269+
Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
270+
Required: False
271+
Position: Named
272+
Default value: None
273+
Accept pipeline input: False
274+
Accept wildcard characters: False
275+
```
276+
225277
### -Alias
226278
The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value.
227279
@@ -233,7 +285,7 @@ If you don't use the Alias parameter when you create a recipient, the value of a
233285
234286
- Recipients with user accounts (for example, user mailboxes, and mail users): The left side of the MicrosoftOnlineServicesID or UserPrincipalName parameter is used. For example, [email protected] results in the Alias property value helpdesk.
235287
236-
- Recipeints without user accounts (for example, room mailboxes, mail contacts, and distribution groups): The value of the Name parameter is used. Spaces are removed and unsupported characters are converted to question marks (?).
288+
- Recipients without user accounts (for example, room mailboxes, mail contacts, and distribution groups): The value of the Name parameter is used. Spaces are removed and unsupported characters are converted to question marks (?).
237289
238290
If you modify the Alias value of an existing recipient, the primary email address is automatically updated only in environments where the recipient is subject to email address policies (the EmailAddressPolicyEnabled property is True for the recipient).
239291
@@ -834,6 +886,27 @@ Accept pipeline input: False
834886
Accept wildcard characters: False
835887
```
836888
889+
### -MailTip
890+
The MailTip parameter specifies the custom MailTip text for this recipient. The MailTip is shown to senders when they start drafting an email message to this recipient. If the value contains spaces, enclose the value in quotation marks (").
891+
892+
When you add a MailTip to a recipient, two things happen:
893+
894+
- HTML tags are automatically added to the text. For example, if you enter the text: "This mailbox is not monitored", the MailTip automatically becomes: \<html\>\<body\>This mailbox is not monitored\</body\>\</html\>. Additional HTML tags aren't supported, and the length of the MailTip can't exceed 175 displayed characters.
895+
896+
- The text is automatically added to the MailTipTranslations property of the recipient as the default value: default:\<MailTip text\>. If you modify the MailTip text, the default value is automatically updated in the MailTipTranslations property, and vice-versa.
897+
898+
```yaml
899+
Type: String
900+
Parameter Sets: (All)
901+
Aliases:
902+
Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
903+
Required: False
904+
Position: Named
905+
Default value: None
906+
Accept pipeline input: False
907+
Accept wildcard characters: False
908+
```
909+
837910
### -MailTipTranslations
838911
The MailTipTranslations parameter specifies additional languages for the custom MailTip text that's defined by the MailTip parameter. HTML tags are automatically added to the MailTip translation, additional HTML tags aren't supported, and the length of the MailTip translation can't exceed 175 displayed characters.
839912
@@ -945,6 +1018,72 @@ Accept pipeline input: False
9451018
Accept wildcard characters: False
9461019
```
9471020
1021+
### -RecoverableItemsQuota
1022+
The RecoverableItemsQuota parameter specifies the maximum size for the Recoverable Items folder of the mailbox. If the Recoverable Items folder reaches or exceeds this size, it no longer accepts messages.
1023+
1024+
A valid value is a number up to 1.999999999 terabytes (2199023254528 bytes) or the value unlimited. The default value is 30 gigabytes (32212254720 bytes).
1025+
1026+
When you enter a number, you can qualify it with one of the following units:
1027+
1028+
- B (bytes)
1029+
1030+
- KB (kilobytes)
1031+
1032+
- MB (megabytes)
1033+
1034+
- GB (gigabytes)
1035+
1036+
- TB (terabytes)
1037+
1038+
Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte.
1039+
1040+
The RecoverableItemsQuota value must be greater than or equal to the RecoverableItemsWarningQuota value.
1041+
1042+
```yaml
1043+
Type: Unlimited
1044+
Parameter Sets: (All)
1045+
Aliases:
1046+
Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
1047+
Required: False
1048+
Position: Named
1049+
Default value: None
1050+
Accept pipeline input: False
1051+
Accept wildcard characters: False
1052+
```
1053+
1054+
### -RecoverableItemsWarningQuota
1055+
The RecoverableItemsWarningQuota parameter specifies the warning threshold for the size of the Recoverable Items folder for the mailbox. If the Recoverable Items folder reaches or exceeds this size, Exchange logs an event to the application event log.
1056+
1057+
A valid value is a number up to 1.999999999 terabytes (2199023254528 bytes) or the value unlimited. The default value is 20 gigabytes (21474836480 bytes).
1058+
1059+
When you enter a number, you can qualify it with one of the following units:
1060+
1061+
- B (bytes)
1062+
1063+
- KB (kilobytes)
1064+
1065+
- MB (megabytes)
1066+
1067+
- GB (gigabytes)
1068+
1069+
- TB (terabytes)
1070+
1071+
Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte.
1072+
1073+
The RecoverableItemsWarningQuota value must be less than or equal to the RecoverableItemsQuota value.
1074+
1075+
```yaml
1076+
Type: Unlimited
1077+
Parameter Sets: (All)
1078+
Aliases:
1079+
Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
1080+
Required: False
1081+
Position: Named
1082+
Default value: None
1083+
Accept pipeline input: False
1084+
Accept wildcard characters: False
1085+
```
1086+
9481087
### -RejectMessagesFrom
9491088
The RejectMessagesFrom parameter specifies who isn't allowed to send messages to this recipient. Messages from these senders are rejected.
9501089
@@ -1082,7 +1221,7 @@ Accept wildcard characters: False
10821221
```
10831222
10841223
### -RemovePicture
1085-
The RemovePictureswitch specifies whether to remove the picture from the mail user. You don't need to specify a value with this switch.
1224+
The RemovePicture switch specifies whether to remove the picture from the mail user. You don't need to specify a value with this switch.
10861225
10871226
You can add a picture to a mail user by using the Import-RecipientDataProperty cmdlet.
10881227
@@ -1099,7 +1238,7 @@ Accept wildcard characters: False
10991238
```
11001239
11011240
### -RemoveSpokenName
1102-
The RemoveSpokenNameswitch specifies whether to remove the spoken name from the mail user. You don't need to specify a value with this switch.
1241+
The RemoveSpokenName switch specifies whether to remove the spoken name from the mail user. You don't need to specify a value with this switch.
11031242
11041243
You can add a picture to a mail user by using the Import-RecipientDataProperty cmdlet.
11051244
@@ -1210,7 +1349,7 @@ Notes on the value Shared:
12101349
12111350
- Shared is available only in Exchange 2013 CU21 or later and Exchange 2016 CU10 or later. To use this value, you also need to run setup.exe /PrepareAD. For more information, see [KB4133605](https://support.microsoft.com/help/4133605/cmdlets-to-create-modify-remote-shared-mailbox-in-on-premises-exchange).
12121351
1213-
- You can only use Shared on a mailbox that was originally created in Exchange Online. If the mailbox was originally created in on-premises Exchange and then migrated to Exchange Online, you need to migrate the mailbox back to on-premises Exchange, convert the mailbox to a shared mailbox in on-premises Exchange, and then migrate the shared mailbox to Exchange Online.
1352+
- You can only use Shared on a mailbox that was originally created in Exchange Online. If the mailbox was originally created in on-premises Exchange and then migrated to Exchange Online, you need to migrate the mailbox back to on-premises Exchange, convert the mailbox to a shared mailbox in on-premises Exchange, and then migrate the shared mailbox to Exchange Online. Or, you can change the RemoteRecipientType property value of the on-premises mailbox to "ProvisionMailbox, Migrated, DeprovisionArchive" by running the following command on an Exchange server: Set-ADUser -Identity "\<UserName\>" -Replace @{msExchRemoteRecipientTYpe="21"}.
12141353
12151354
```yaml
12161355
Type: Regular | Room | Equipment
@@ -1275,108 +1414,6 @@ Accept pipeline input: False
12751414
Accept wildcard characters: False
12761415
```
12771416
1278-
### -ACLableSyncedObjectEnabled
1279-
The ACLableSyncedObjectEnabled switch specfies whether the remote mailbox is an ACLableSyncedMailboxUser. To enable this, use this switch without a value. To disable this, use this exact syntax: -ACLableSyncedObjectEnabled:$false.
1280-
1281-
```yaml
1282-
Type: SwitchParameter
1283-
Parameter Sets: (All)
1284-
Aliases:
1285-
Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
1286-
Required: False
1287-
Position: Named
1288-
Default value: None
1289-
Accept pipeline input: False
1290-
Accept wildcard characters: False
1291-
```
1292-
1293-
### -MailTip
1294-
The MailTip parameter specifies the custom MailTip text for this recipient. The MailTip is shown to senders when they start drafting an email message to this recipient. If the value contains spaces, enclose the value in quotation marks (").
1295-
1296-
When you add a MailTip to a recipient, two things happen:
1297-
1298-
- HTML tags are automatically added to the text. For example, if you enter the text: "This mailbox is not monitored", the MailTip automatically becomes: \<html\>\<body\>This mailbox is not monitored\</body\>\</html\>. Additional HTML tags aren't supported, and the length of the MailTip can't exceed 175 displayed characters.
1299-
1300-
- The text is automatically added to the MailTipTranslations property of the recipient as the default value: default:\<MailTip text\>. If you modify the MailTip text, the default value is automatically updated in the MailTipTranslations property, and vice-versa.
1301-
1302-
```yaml
1303-
Type: String
1304-
Parameter Sets: (All)
1305-
Aliases:
1306-
Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
1307-
Required: False
1308-
Position: Named
1309-
Default value: None
1310-
Accept pipeline input: False
1311-
Accept wildcard characters: False
1312-
```
1313-
1314-
### -RecoverableItemsQuota
1315-
The RecoverableItemsQuota parameter specifies the maximum size for the Recoverable Items folder of the mailbox. If the Recoverable Items folder reaches or exceeds this size, it no longer accepts messages.
1316-
1317-
A valid value is a number up to 1.999999999 terabytes (2199023254528 bytes) or the value unlimited. The default value is 30 gigabytes (32212254720 bytes).
1318-
1319-
When you enter a number, you can qualify it with one of the following units:
1320-
1321-
- B (bytes)
1322-
1323-
- KB (kilobytes)
1324-
1325-
- MB (megabytes)
1326-
1327-
- GB (gigabytes)
1328-
1329-
- TB (terabytes)
1330-
1331-
Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte.
1332-
1333-
The RecoverableItemsQuota value must be greater than or equal to the RecoverableItemsWarningQuota value.
1334-
1335-
```yaml
1336-
Type: Unlimited
1337-
Parameter Sets: (All)
1338-
Aliases:
1339-
Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
1340-
Required: False
1341-
Position: Named
1342-
Default value: None
1343-
Accept pipeline input: False
1344-
Accept wildcard characters: False
1345-
```
1346-
1347-
### -RecoverableItemsWarningQuota
1348-
The RecoverableItemsWarningQuota parameter specifies the warning threshold for the size of the Recoverable Items folder for the mailbox. If the Recoverable Items folder reaches or exceeds this size, Exchange logs an event to the application event log.
1349-
1350-
A valid value is a number up to 1.999999999 terabytes (2199023254528 bytes) or the value unlimited. The default value is 20 gigabytes (21474836480 bytes).
1351-
1352-
When you enter a number, you can qualify it with one of the following units:
1353-
1354-
- B (bytes)
1355-
1356-
- KB (kilobytes)
1357-
1358-
- MB (megabytes)
1359-
1360-
- GB (gigabytes)
1361-
1362-
- TB (terabytes)
1363-
1364-
Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte.
1365-
1366-
The RecoverableItemsWarningQuota value must be less than or equal to the RecoverableItemsQuota value.
1367-
1368-
```yaml
1369-
Type: Unlimited
1370-
Parameter Sets: (All)
1371-
Aliases:
1372-
Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
1373-
Required: False
1374-
Position: Named
1375-
Default value: None
1376-
Accept pipeline input: False
1377-
Accept wildcard characters: False
1378-
```
1379-
13801417
### CommonParameters
13811418
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
13821419

0 commit comments

Comments
 (0)