Commands › Exchange Online

Set-MailboxPlan

Exchange Online ExchangeOnlineManagement Set-*

Modify the settings of mailbox plans in the cloud-based service.

Quick start script

# Set-MailboxPlan — 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-MailboxPlan
$before | Format-List

# 3. Make the change (dry run first)
Set-MailboxPlan -Identity <MailboxPlanIdParameter> -WhatIf
Set-MailboxPlan -Identity <MailboxPlanIdParameter>

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

Syntax

Set-MailboxPlan [-Identity] <MailboxPlanIdParameter>
 [-Confirm]
 [-Force]
 [-IsDefault]
 [-IssueWarningQuota <Unlimited>]
 [-MaxReceiveSize <Unlimited>]
 [-MaxSendSize <Unlimited>]
 [-ProhibitSendQuota <Unlimited>]
 [-ProhibitSendReceiveQuota <Unlimited>]
 [-RecipientLimits <Unlimited>]
 [-RetainDeletedItemsFor <EnhancedTimeSpan>]
 [-RetentionPolicy <MailboxPolicyIdParameter>]
 [-RoleAssignmentPolicy <MailboxPolicyIdParameter>]
 [-WhatIf]
 [<CommonParameters>]

Parameters (14)

Parameter	Type	Required	What it controls
-Identity	MailboxPlanIdParameter	yes	The Identity parameter specifies the mailbox plan that you want to modify. You can use any value that uniquely identifies the mailbox plan. 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.
-Force	SwitchParameter		The Force switch hides warning or confirmation messages. You don't need to specify a value with this switch.
-IsDefault	SwitchParameter		The IsDefault switch specifies that the mailbox plan is the default mailbox plan. You don't need to specify a value with this switch.
-IssueWarningQuota	Unlimited		The IssueWarningQuota parameter specifies the warning threshold for the size of the mailboxes that are created or enabled using the mailbox plan. If the mailbox reaches or exceeds this size, the user receives a...
-MaxReceiveSize	Unlimited		The MaxReceiveSize parameter specifies the maximum size of a message that can be sent to the mailbox. Messages larger than the maximum size are rejected.
-MaxSendSize	Unlimited		The MaxSendSize parameter specifies the maximum size of a message that can be sent by the mailbox.
-ProhibitSendQuota	Unlimited		The ProhibitSendQuota parameter specifies a size limit for the mailbox. If the mailbox reaches or exceeds this size, the mailbox can't send new messages, and the user receives a descriptive warning message.
-ProhibitSendReceiveQuota	Unlimited		The ProhibitSendReceiveQuota parameter specifies a size limit for the mailbox. If the mailbox reaches or exceeds this size, the mailbox can't send or receive new messages. Messages sent to the mailbox are returned to...
-RecipientLimits	Unlimited		This parameter is reserved for internal Microsoft use.
-RetainDeletedItemsFor	EnhancedTimeSpan		The RetainDeletedItemsFor parameter specifies the length of time to keep soft-deleted items for the mailbox. Soft-deleted items are items that have been deleted by using any of these methods:
-RetentionPolicy	MailboxPolicyIdParameter		The RetentionPolicy parameter specifies the retention policy that's applied to new mailboxes that you create. You can use any value that uniquely identifies the policy. For example:
-RoleAssignmentPolicy	MailboxPolicyIdParameter		The RoleAssignmentPolicy parameter specifies the role assignment policy that's applied to the mailbox. You can use any value that uniquely identifies the role assignment policy. For example:
-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.