Commands › Exchange Online

Remove-SyncMailPublicFolder

Exchange Online ExchangeOnlineManagement Remove-*

The Remove-SyncMailPublicFolder cmdlet is used by the Sync-MailPublicFolders.ps1 script to remove mail-enabled public folder recipient objects from Exchange Online (the script synchronizes mail-enabled public folder objects from the source on-premises Exchange organization to Exchange Online). Don't use this cmdlet unless you are directed to do so by Microsoft Customer Service and Support or by specific documentation.

Quick start script

# Remove-SyncMailPublicFolder — 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-SyncMailPublicFolder
$before | Format-List

# 3. Make the change (dry run first)
Remove-SyncMailPublicFolder -Identity <MailPublicFolderIdParameter> -WhatIf
Remove-SyncMailPublicFolder -Identity <MailPublicFolderIdParameter>

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

Syntax

Remove-SyncMailPublicFolder [-Identity] <MailPublicFolderIdParameter>
 [-Confirm]
 [-DomainController <Fqdn>]
 [-WhatIf]
 [<CommonParameters>]

Parameters (4)

ParameterTypeRequiredWhat it controls
-Identity MailPublicFolderIdParameter yes The Identity parameter specifies the mail-enabled public folder object that you want to remove from Exchange Online. For example:
-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.
-DomainController Fqdn 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.