Commands › Exchange Online

Update-SiteMailbox

Exchange Online ExchangeOnlineManagement Update-*

Trigger a Microsoft SharePoint synchronization. This command synchronizes document content membership and permissions into Microsoft Exchange. You might need to perform this action when troubleshooting document or membership synchronization issues. Site mailboxes were deprecated in Exchange Online and SharePoint Online in 2017. For more information, see Deprecation of Site Mailboxes.

Quick start script

# Update-SiteMailbox — 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-SiteMailbox
$before | Format-List

# 3. Make the change (dry run first)
Update-SiteMailbox -Identity <RecipientIdParameter> -WhatIf
Update-SiteMailbox -Identity <RecipientIdParameter>

# 4. Verify and diff
$after = Get-SiteMailbox
Compare-Object ($before | Out-String) ($after | Out-String)

Syntax

Update-SiteMailbox [-Identity] <RecipientIdParameter>
 [-BypassOwnerCheck]
 [-Confirm]
 [-FullSync]
 [-Organization <OrganizationIdParameter>]
 [-Server <String>]
 [-Target <TargetType>]
 [-WhatIf]
 [<CommonParameters>]

Parameters (8)

Parameter	Type	Required	What it controls
-Identity	RecipientIdParameter	yes	The Identity parameter specifies the site mailbox that you want to update. You can use any value that uniquely identifies the site mailbox. For example:
-BypassOwnerCheck	SwitchParameter		The BypassOwnerCheck parameter is used when the account that's running the command isn't a member or owner of the site mailbox. You don't need to specify a value with this switch.
-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.
-FullSync	SwitchParameter		The FullSync switch specifies a full synchronization. You don't need to specify a value with this switch.
-Organization	OrganizationIdParameter		This parameter is reserved for internal Microsoft use.
-Server	String		The Server parameter specifies the fully qualified domain name (FQDN) or the Microsoft SharePoint server on which the site mailbox is located.
-Target	TargetType		The Target parameter specifies whether to update the SharePoint documents, the site mailbox's membership list or both. This parameter accepts the following values:
-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.

Reference facts derived from Microsoft documentation, © Microsoft, licensed CC BY 4.0; restructured with original guidance by serv365.ai.