Commands › Exchange Online

Start-MailboxAssistant

Exchange Online ExchangeOnlineManagement Start-*

Start processing of a mailbox by the specified assistant.

Quick start script

# Start-MailboxAssistant — 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
Start-MailboxAssistant -Identity <UserIdParameter> -AssistantName <String> | Format-List

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

Syntax

Start-MailboxAssistant [-Identity] <UserIdParameter> -AssistantName <String>
 [-Confirm]
 [-DomainController <Fqdn>]
 [-Parameters <String>]
 [-SoftDeletedMailbox]
 [-WhatIf]
 [<CommonParameters>]

Parameters (7)

ParameterTypeRequiredWhat it controls
-Identity UserIdParameter yes The Identity parameter specifies the user whose mailbox should be processed by the Mailbox Assistant. Valid values are:
-AssistantName String yes The AssistantName parameter specifies the assistant that should process the mailbox. Valid values are:
-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 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...
-Parameters String This parameter is reserved for internal Microsoft use.
-SoftDeletedMailbox SwitchParameter The SoftDeletedMailbox switch specifies that the mailbox to be processed by the assistant is a soft-deleted mailbox.
-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.