Commands › Exchange Online

Test-SiteMailbox

Exchange Online ExchangeOnlineManagement Test-*

Test the site mailbox to Microsoft SharePoint connectivity and to test whether users have the correct permissions to use a site mailbox. This cmdlet should be used for troubleshooting and diagnostic purposes. Site mailboxes were deprecated in Exchange Online and SharePoint Online in 2017. For more information, see Deprecation of Site Mailboxes.

Quick start script

# Test-SiteMailbox — quick start (serv365.ai)
# 1. Connect (app-only shown; interactive: omit the certificate parameters)
Connect-ExchangeOnline -CertificateThumbprint $thumb -AppId $appId -Organization $org

# 2. Run and inspect
Test-SiteMailbox | Format-List

# 3. Export for evidence / drift tracking
Test-SiteMailbox | Export-Clixml .\SiteMailbox-$(Get-Date -Format yyyyMMdd).xml

Syntax

Test-SiteMailbox [[-Identity] <RecipientIdParameter>]
 [-BypassOwnerCheck]
 [-Confirm]
 [-RequestorIdentity <RecipientIdParameter>]
 [-SharePointUrl <Uri>]
 [-UseAppTokenOnly]
 [-WhatIf]
 [<CommonParameters>]

Parameters (7)

Parameter	Type	What it controls
-Identity	RecipientIdParameter	The Identity parameter specifies the site mailbox that you want to test. 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.
-RequestorIdentity	RecipientIdParameter	The RequestorIdentity parameter specifies the user to test for correct permissions to the SharePoint site mailbox. You can use any value that uniquely identifies the user. For example:
-SharePointUrl	Uri	The SharePointUrl parameter specifies the SharePoint URL where the site mailbox is hosted, for example, "https://myserver/teams/edu".
-UseAppTokenOnly	SwitchParameter	The UseAppTokenOnly switch specifies that you want to test the site mailbox by using the identity of the Exchange server. You don't need to specify a value with this switch.
-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.