Commands › Exchange Online
Set-RemoteMailbox
Modify remote mailboxes. A remote mailbox is a mail user in Active Directory that's associated with a mailbox in the cloud-based service.
Quick start script
# Set-RemoteMailbox — quick start (serv365.ai)
# 1. Connect (app-only shown; interactive: omit the certificate parameters)
Connect-ExchangeOnline -CertificateThumbprint $thumb -AppId $appId -Organization $org
# 2. Capture the current state first — you cannot roll back what you never recorded
$before = Get-RemoteMailbox
$before | Format-List
# 3. Make the change (dry run first)
Set-RemoteMailbox -Identity <RemoteMailboxIdParameter> -WhatIf
Set-RemoteMailbox -Identity <RemoteMailboxIdParameter>
# 4. Verify and diff
$after = Get-RemoteMailbox
Compare-Object ($before | Out-String) ($after | Out-String)Syntax
Set-RemoteMailbox [-Identity] <RemoteMailboxIdParameter>
[-AcceptMessagesOnlyFrom <MultiValuedProperty>]
[-AcceptMessagesOnlyFromDLMembers <MultiValuedProperty>]
[-AcceptMessagesOnlyFromSendersOrMembers <MultiValuedProperty>]
[-ACLableSyncedObjectEnabled]
[-Alias <String>]
[-ArchiveGuid <Guid>]
[-ArchiveName <MultiValuedProperty>]
[-BypassModerationFromSendersOrMembers <MultiValuedProperty>]
[-Confirm]
[-CustomAttribute1 <String>]
[-CustomAttribute10 <String>]
[-CustomAttribute11 <String>]
[-CustomAttribute12 <String>]
[-CustomAttribute13 <String>]
[-CustomAttribute14 <String>]
[-CustomAttribute15 <String>]
[-CustomAttribute2 <String>]
[-CustomAttribute3 <String>]
[-CustomAttribute4 <String>]
[-CustomAttribute5 <String>]
[-CustomAttribute6 <String>]
[-CustomAttribute7 <String>]
[-CustomAttribute8 <String>]
[-CustomAttribute9 <String>]
[-DisplayName <String>]
[-DomainController <Fqdn>]
[-EmailAddresses <ProxyAddressCollection>]
[-EmailAddressPolicyEnabled <Boolean>]
[-ExchangeGuid <Guid>]
[-ExtensionCustomAttribute1 <MultiValuedProperty>]
[-ExtensionCustomAttribute2 <MultiValuedProperty>]
[-ExtensionCustomAttribute3 <MultiValuedProperty>]
[-ExtensionCustomAttribute4 <MultiValuedProperty>]
[-ExtensionCustomAttribute5 <MultiValuedProperty>]
[-GrantSendOnBehalfTo <MultiValuedProperty>]
[-HiddenFromAddressListsEnabled <Boolean>]
[-IgnoreDefaultScope]
[-ImmutableId <String>]
[-MailTip <String>]
[-MailTipTranslations <MultiValuedProperty>]
[-ModeratedBy <MultiValuedProperty>]
[-ModerationEnabled <Boolean>]
[-Name <String>]
[-PrimarySmtpAddress <SmtpAddress>]
[-RecoverableItemsQuota <Unlimited>]
[-RecoverableItemsWarningQuota <Unlimited>]
[-RejectMessagesFrom <MultiValuedProperty>]
[-RejectMessagesFromDLMembers <MultiValuedProperty>]
[-RejectMessagesFromSendersOrMembers <MultiValuedProperty>]
[-RemoteRoutingAddress <ProxyAddress>]
[-RemovePicture]
[-RemoveSpokenName]
[-RequireSenderAuthenticationEnabled <Boolean>]
[-ResetPasswordOnNextLogon <Boolean>]
[-SamAccountName <String>]
[-SendModerationNotifications <TransportModerationNotificationFlags>]
[-Type <ConvertibleRemoteMailboxSubType>]
[-UserPrincipalName <String>]
[-WhatIf]
[-WindowsEmailAddress <SmtpAddress>]
[<CommonParameters>]Parameters (61)
| Parameter | Type | Required | What it controls |
|---|---|---|---|
| -Identity | RemoteMailboxIdParameter | yes | The Identity parameter specifies the remote mailbox (mail user) that you want to modify. You can use any value that uniquely identifies the mail user. For example: |
| -AcceptMessagesOnlyFrom | MultiValuedProperty | The AcceptMessagesOnlyFrom parameter specifies who is allowed to send messages to this recipient. Messages from other senders are rejected. | |
| -AcceptMessagesOnlyFromDLMembers | MultiValuedProperty | The AcceptMessagesOnlyFromDLMembers parameter specifies who is allowed to send messages to this recipient. Messages from other senders are rejected. | |
| -AcceptMessagesOnlyFromSendersOrMembers | MultiValuedProperty | The AcceptMessagesOnlyFromSendersOrMembers parameter specifies who is allowed to send messages to this recipient. Messages from other senders are rejected. | |
| -ACLableSyncedObjectEnabled | SwitchParameter | The ACLableSyncedObjectEnabled switch specifies whether the remote mailbox is an ACLableSyncedMailboxUser. | |
| -Alias | String | 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... | |
| -ArchiveGuid | Guid | This parameter is reserved for internal Microsoft use. | |
| -ArchiveName | MultiValuedProperty | The ArchiveName parameter specifies the name of the archive mailbox. This is the name displayed to users in Outlook on the web (formerly known as Outlook Web App). If the value contains spaces, enclose the value in... | |
| -BypassModerationFromSendersOrMembers | MultiValuedProperty | The BypassModerationFromSendersOrMembers parameter specifies who is allowed to send messages to this moderated recipient without approval from a moderator. Valid values for this parameter are individual senders and... | |
| -Confirm | SwitchParameter | The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on whether the cmdlet requires confirmation before proceeding. | |
| -CustomAttribute1 | String | This parameter specifies a value for the CustomAttribute1 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum... | |
| -CustomAttribute10 | String | This parameter specifies a value for the CustomAttribute10 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum... | |
| -CustomAttribute11 | String | This parameter specifies a value for the CustomAttribute11 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum... | |
| -CustomAttribute12 | String | This parameter specifies a value for the CustomAttribute12 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum... | |
| -CustomAttribute13 | String | This parameter specifies a value for the CustomAttribute13 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum... | |
| -CustomAttribute14 | String | This parameter specifies a value for the CustomAttribute14 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum... | |
| -CustomAttribute15 | String | This parameter specifies a value for the CustomAttribute15 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum... | |
| -CustomAttribute2 | String | This parameter specifies a value for the CustomAttribute2 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum... | |
| -CustomAttribute3 | String | This parameter specifies a value for the CustomAttribute3 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum... | |
| -CustomAttribute4 | String | This parameter specifies a value for the CustomAttribute4 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum... | |
| -CustomAttribute5 | String | This parameter specifies a value for the CustomAttribute5 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum... | |
| -CustomAttribute6 | String | This parameter specifies a value for the CustomAttribute6 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum... | |
| -CustomAttribute7 | String | This parameter specifies a value for the CustomAttribute7 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum... | |
| -CustomAttribute8 | String | This parameter specifies a value for the CustomAttribute8 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum... | |
| -CustomAttribute9 | String | This parameter specifies a value for the CustomAttribute9 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. The maximum... | |
| -DisplayName | String | The DisplayName parameter specifies the display name for the mail user. The display name is visible in the Exchange admin center, address lists, and Outlook. The maximum length is 256 characters. If the value... | |
| -DomainController | Fqdn | 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... | |
| -EmailAddresses | ProxyAddressCollection | The EmailAddresses parameter specifies all email addresses (proxy addresses) for the recipient, including the primary SMTP address. In on-premises Exchange organizations, the primary SMTP address and other proxy... | |
| -EmailAddressPolicyEnabled | Boolean | The EmailAddressPolicyEnabled parameter specifies whether to apply email address policies to this recipient. Valid values are: | |
| -ExchangeGuid | Guid | The ExchangeGuid parameter specifies the ExchangeGuid property value of the mail user, which should match the ExchangeGuid value of the corresponding cloud mailbox. | |
| -ExtensionCustomAttribute1 | MultiValuedProperty | This parameter specifies a value for the ExtensionCustomAttribute1 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You... | |
| -ExtensionCustomAttribute2 | MultiValuedProperty | This parameter specifies a value for the ExtensionCustomAttribute2 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You... | |
| -ExtensionCustomAttribute3 | MultiValuedProperty | This parameter specifies a value for the ExtensionCustomAttribute3 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You... | |
| -ExtensionCustomAttribute4 | MultiValuedProperty | This parameter specifies a value for the ExtensionCustomAttribute4 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You... | |
| -ExtensionCustomAttribute5 | MultiValuedProperty | This parameter specifies a value for the ExtensionCustomAttribute5 property on the recipient. You can use this property to store custom information about the recipient, and to identify the recipient in filters. You... | |
| -GrantSendOnBehalfTo | MultiValuedProperty | The GrantSendOnBehalfTo parameter specifies the DN of recipients that can send messages on behalf of this mail-enabled user. | |
| -HiddenFromAddressListsEnabled | Boolean | The HiddenFromAddressListsEnabled parameter specifies whether this recipient is visible in address lists. Valid values are: | |
| -IgnoreDefaultScope | SwitchParameter | The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. | |
| -ImmutableId | String | The ImmutableId parameter is used by GAL synchronization (GALSync) and specifies a unique and immutable identifier in the form of an SMTP address for an Exchange mailbox used for federated delegation when requesting... | |
| -MailTip | String | 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... | |
| -MailTipTranslations | MultiValuedProperty | 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... | |
| -ModeratedBy | MultiValuedProperty | The ModeratedBy parameter specifies one or more moderators for this recipient. A moderator approves messages sent to the recipient before the messages are delivered. A moderator must be a mailbox, mail user, or mail... | |
| -ModerationEnabled | Boolean | The ModerationEnabled parameter specifies whether moderation is enabled for this recipient. Valid value are: | |
| -Name | String | The Name parameter specifies the unique name of the mail user. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks ("). | |
| -PrimarySmtpAddress | SmtpAddress | The PrimarySmtpAddress parameter specifies the primary return email address that's used for the recipient. You can't use the EmailAddresses and PrimarySmtpAddress parameters in the same command. | |
| -RecoverableItemsQuota | Unlimited | 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. | |
| -RecoverableItemsWarningQuota | Unlimited | 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... | |
| -RejectMessagesFrom | MultiValuedProperty | The RejectMessagesFrom parameter specifies who isn't allowed to send messages to this recipient. Messages from these senders are rejected. | |
| -RejectMessagesFromDLMembers | MultiValuedProperty | The RejectMessagesFromDLMembers parameter specifies who isn't allowed to send messages to this recipient. Messages from these senders are rejected. | |
| -RejectMessagesFromSendersOrMembers | MultiValuedProperty | The RejectMessagesFromSendersOrMembers parameter specifies who isn't allowed to send messages to this recipient. Messages from these senders are rejected. | |
| -RemoteRoutingAddress | ProxyAddress | The RemoteRoutingAddress parameter specifies the SMTP address of the mailbox in the service that's associated with this mail user. | |
| -RemovePicture | SwitchParameter | The RemovePicture switch removes the picture from the mail user. You don't need to specify a value with this switch. | |
| -RemoveSpokenName | SwitchParameter | The RemoveSpokenName switch removes the spoken name from the mail user. You don't need to specify a value with this switch. | |
| -RequireSenderAuthenticationEnabled | Boolean | The RequireSenderAuthenticationEnabled parameter specifies whether to accept messages only from authenticated (internal) senders. Valid values are: | |
| -ResetPasswordOnNextLogon | Boolean | The ResetPasswordOnNextLogon parameter specifies whether the user must change their password the next time they log on. Valid values are: | |
| -SamAccountName | String | The SamAccountName parameter (also known as the pre-Windows 2000 user account or group name) specifies an object identifier that's compatible with older versions of Microsoft Windows client and server operating... | |
| -SendModerationNotifications | TransportModerationNotificationFlags | The SendModerationNotifications parameter specifies when moderation notification messages are sent. Valid values are: | |
| -Type | ConvertibleRemoteMailboxSubType | The Type parameter specifies the type for the mailbox in the service. Valid values are: | |
| -UserPrincipalName | String | The UserPrincipalName parameter specifies the logon name for the user account. The UPN uses an email address format: `username@domain`. Typically, the domain value is the domain where the user account resides. | |
| -WhatIf | SwitchParameter | The WhatIf switch shows what the command does without making any changes. You don't need to specify a value with this switch. | |
| -WindowsEmailAddress | SmtpAddress | The WindowsEmailAddress parameter specifies the Windows email address for this recipient. This is a common Active Directory attribute that's present in all environments, including environments without Exchange. Using... |
Reference facts derived from Microsoft documentation, © Microsoft, licensed CC BY 4.0; restructured with original guidance by serv365.ai.