Commands › Exchange Online

Test-MAPIConnectivity

Exchange Online ExchangeOnlineManagement Test-*

Verify server functionality by logging on to the mailbox that you specify. If you don't specify a mailbox, the cmdlet logs on to the SystemMailbox on the database that you specify.

Quick start script

# Test-MAPIConnectivity — 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-MAPIConnectivity -Identity <MailboxIdParameter> -Database <DatabaseIdParameter> | Format-List

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

Syntax — 3 parameter sets

Database

Test-MAPIConnectivity -Database <DatabaseIdParameter>
 [-ActiveDirectoryTimeout <Int32>]
 [-AllConnectionsTimeout <Int32>]
 [-Confirm]
 [-CopyOnServer <ServerIdParameter>]
 [-DomainController <Fqdn>]
 [-MonitoringContext <Boolean>]
 [-PerConnectionTimeout <Int32>]
 [-WhatIf]
 [<CommonParameters>]

Identity

Test-MAPIConnectivity [-Identity] <MailboxIdParameter>
 [-ActiveDirectoryTimeout <Int32>]
 [-AllConnectionsTimeout <Int32>]
 [-Archive]
 [-Confirm]
 [-CopyOnServer <ServerIdParameter>]
 [-DomainController <Fqdn>]
 [-MonitoringContext <Boolean>]
 [-PerConnectionTimeout <Int32>]
 [-WhatIf]
 [<CommonParameters>]

Server

Test-MAPIConnectivity [-Server <ServerIdParameter>]
 [-ActiveDirectoryTimeout <Int32>]
 [-AllConnectionsTimeout <Int32>]
 [-Confirm]
 [-DomainController <Fqdn>]
 [-IncludePassive]
 [-MonitoringContext <Boolean>]
 [-PerConnectionTimeout <Int32>]
 [-WhatIf]
 [<CommonParameters>]

Parameters (13)

Parameter	Type	Required	What it controls
-Identity	MailboxIdParameter	yes	The Identity parameter specifies a mailbox to test. You can use any value that uniquely identifies the mailbox. For example:
-Database	DatabaseIdParameter	yes	This parameter is available only in on-premises Exchange.
-ActiveDirectoryTimeout	Int32		This parameter is available only in on-premises Exchange.
-AllConnectionsTimeout	Int32		This parameter is available only in on-premises Exchange.
-Archive	SwitchParameter		The Archive switch specifies whether to test the MAPI connectivity of the personal archive that's associated with the specified 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.
-CopyOnServer	ServerIdParameter		This parameter is available only in on-premises Exchange.
-DomainController	Fqdn		This parameter is available only in on-premises Exchange.
-IncludePassive	SwitchParameter		This parameter is available only in on-premises Exchange.
-MonitoringContext	Boolean		This parameter is available only in on-premises Exchange.
-PerConnectionTimeout	Int32		This parameter is available only in on-premises Exchange.
-Server	ServerIdParameter		This parameter is available only in on-premises Exchange.
-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.