Commands › Exchange Online

New-SiteMailbox

Exchange Online ExchangeOnlineManagement New-*

The New-SiteMailbox cmdlet is used by the Microsoft SharePoint and Microsoft Exchange user interfaces to create site mailboxes. We recommend that you don't use this cmdlet; instead use SharePoint to create the site mailbox. This cmdlet should only be used for diagnostic and troubleshooting purposes. Site mailboxes were deprecated in Exchange Online and SharePoint Online in 2017. For more information, see Deprecation of Site Mailboxes.

Quick start script

# New-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)
New-SiteMailbox -SharePointUrl <Uri> -WhatIf
New-SiteMailbox -SharePointUrl <Uri>

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

Syntax

New-SiteMailbox [[-DisplayName] <String>] -SharePointUrl <Uri>
 [-Alias <String>]
 [-Confirm]
 [-Database <DatabaseIdParameter>]
 [-DomainController <Fqdn>]
 [-Force]
 [-Name <String>]
 [-OrganizationalUnit <OrganizationalUnitIdParameter>]
 [-OverrideRecipientQuotas]
 [-WhatIf]
 [<CommonParameters>]

Parameters (11)

Parameter	Type	Required	What it controls
-DisplayName	String		The DisplayName parameter specifies the display name that displays in the user's global address list and on SharePoint.
-SharePointUrl	Uri	yes	The SharePointUrl parameter specifies the SharePoint URL where the site mailbox is hosted, for example, "https://myserver/teams/edu".
-Alias	String		The Alias parameter specifies the alias of the site mailbox.
-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.
-Database	DatabaseIdParameter		The Database parameter specifies the mailbox database that holds the mailbox data for the site mailbox. You can use any value that uniquely identifies the database. For example:
-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...
-Force	SwitchParameter		The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch.
-Name	String		The Name parameter specifies the name of the site mailbox.
-OrganizationalUnit	OrganizationalUnitIdParameter		The OrganizationalUnit parameter specifies the organizational unit in which the site mailbox resides.
-OverrideRecipientQuotas	SwitchParameter		This parameter is reserved for internal Microsoft use.
-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.