Set-CASMailboxPlan

 

Applies to: Exchange Online

Topic Last Modified: 2017-03-29

This cmdlet is available only in the cloud-based service.

Use the Get-CASMailboxPlan cmdlet to modify Client Access services (CAS) mailbox plans in the cloud-based organization.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Set-CASMailboxPlan -Identity <MailboxPlanIdParameter> [-ActiveSyncDebugLogging <$true | $false>] [-ActiveSyncEnabled <$true | $false>] [-ActiveSyncMailboxPolicy <MailboxPolicyIdParameter>] [-Confirm [<SwitchParameter>]] [-DisplayName <String>] [-DomainController <Fqdn>] [-ECPEnabled <$true | $false>] [-EwsAllowEntourage <$true | $false>] [-EwsAllowList <MultiValuedProperty>] [-EwsAllowMacOutlook <$true | $false>] [-EwsAllowOutlook <$true | $false>] [-EwsApplicationAccessPolicy <EnforceAllowList | EnforceBlockList>] [-EwsBlockList <MultiValuedProperty>] [-EwsEnabled <$true | $false>] [-IgnoreDefaultScope <SwitchParameter>] [-ImapEnabled <$true | $false>] [-ImapEnableExactRFC822Size <$true | $false>] [-ImapForceICalForCalendarRetrievalOption <$true | $false>] [-ImapMessagesRetrievalMimeFormat <TextOnly | HtmlOnly | HtmlAndTextAlternative | TextEnrichedOnly | TextEnrichedAndTextAlternative | BestBodyFormat | Tnef>] [-ImapProtocolLoggingEnabled <$true | $false>] [-ImapSuppressReadReceipt <$true | $false>] [-ImapUseProtocolDefaults <$true | $false>] [-MAPIBlockOutlookNonCachedMode <$true | $false>] [-MAPIBlockOutlookRpcHttp <$true | $false>] [-MAPIBlockOutlookVersions <String>] [-MAPIEnabled <$true | $false>] [-OWAEnabled <$true | $false>] [-OWAforDevicesEnabled <$true | $false>] [-OwaMailboxPolicy <MailboxPolicyIdParameter>] [-PopEnabled <$true | $false>] [-PopEnableExactRFC822Size <$true | $false>] [-PopForceICalForCalendarRetrievalOption <$true | $false>] [-PopMessagesRetrievalMimeFormat <TextOnly | HtmlOnly | HtmlAndTextAlternative | TextEnrichedOnly | TextEnrichedAndTextAlternative | BestBodyFormat | Tnef>] [-PopProtocolLoggingEnabled <$true | $false>] [-PopSuppressReadReceipt <$true | $false>] [-PopUseProtocolDefaults <$true | $false>] [-RemotePowerShellEnabled <$true | $false>] [-WhatIf [<SwitchParameter>]]

This example disables Exchange ActiveSync and POP3 access to mailboxes in the CAS mailbox plan named ExchangeOnlineEnterprise.

Set-CASMailboxPlan -Identity ExchangeOnlineEnterprise -ActiveSyncEnabled $false -PopEnabled $false

CAS mailbox plans control client access settings for all mailboxes that have the plans assigned to them (for example, Exchange ActiveSync, POP, IMAP, and Outlook on the web settings).

You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet.

 

Parameter Required Type Description

Identity

Required

Microsoft.Exchange.Configuration.Tasks.MailboxPlanIdParameter

The Identity parameter specifies the CAS mailbox plan that you want to modify. You can use any value that uniquely identifies the CAS mailbox plan. For example:

  • Name

  • Display Name

  • Distinguished name (DN)

  • GUID

Typically, the name of the CAS mailbox plan is the same as the corresponding mailbox plan (for example, ExchangeOnlineEnterprise).

ActiveSyncDebugLogging

Optional

System.Boolean

This parameter is reserved for internal Microsoft use.

ActiveSyncEnabled

Optional

System.Boolean

The ActiveSyncEnabled parameter specifies whether to enable or disable Exchange ActiveSync access to mailboxes that have the CAS mailbox plan applied to them. Valid values are:

  • $true   ActiveSync access to mailboxes is enabled.

  • $false       ActiveSync access to mailboxes is disabled.

ActiveSyncMailboxPolicy

Optional

Microsoft.Exchange.Configuration.Tasks.MailboxPolicyIdParameter

This parameter is reserved for internal Microsoft use.

Confirm

Optional

System.Management.Automation.SwitchParameter

The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding.

  • Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false.

  • Most other cmdlets (for example, New-* and Set-* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding.

DisplayName

Optional

System.String

This parameter is reserved for internal Microsoft use.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

This parameter is reserved for internal Microsoft use.

ECPEnabled

Optional

System.Boolean

This parameter is reserved for internal Microsoft use.

EwsAllowEntourage

Optional

System.Boolean

This parameter is reserved for internal Microsoft use.

EwsAllowList

Optional

Microsoft.Exchange.Data.MultiValuedProperty

This parameter is reserved for internal Microsoft use.

EwsAllowMacOutlook

Optional

System.Boolean

This parameter is reserved for internal Microsoft use.

EwsAllowOutlook

Optional

System.Boolean

This parameter is reserved for internal Microsoft use.

EwsApplicationAccessPolicy

Optional

Microsoft.Exchange.Data.Directory.EwsApplicationAccessPolicy

This parameter is reserved for internal Microsoft use.

EwsBlockList

Optional

Microsoft.Exchange.Data.MultiValuedProperty

This parameter is reserved for internal Microsoft use.

EwsEnabled

Optional

System.Boolean

This parameter is reserved for internal Microsoft use.

IgnoreDefaultScope

Optional

System.Management.Automation.SwitchParameter

This parameter is reserved for internal Microsoft use.

ImapEnabled

Optional

System.Boolean

The ImapEnabled parameter specifies whether to enable or disable IMAP4 access to mailboxes that have the CAS mailbox plan applied to them. Valid values are:

  • $true   IMAP4 access to mailboxes is enabled.

  • $false   IMAP4 access to mailboxes is disabled.

ImapEnableExactRFC822Size

Optional

System.Boolean

This parameter is reserved for internal Microsoft use.

ImapForceICalForCalendarRetrievalOption

Optional

System.Boolean

This parameter is reserved for internal Microsoft use.

ImapMessagesRetrievalMimeFormat

Optional

Microsoft.Exchange.Data.Directory.SystemConfiguration.MimeTextFormat

This parameter is reserved for internal Microsoft use.

ImapProtocolLoggingEnabled

Optional

System.Boolean

This parameter is reserved for internal Microsoft use.

ImapSuppressReadReceipt

Optional

System.Boolean

This parameter is reserved for internal Microsoft use.

ImapUseProtocolDefaults

Optional

System.Boolean

This parameter is reserved for internal Microsoft use.

MAPIBlockOutlookNonCachedMode

Optional

System.Boolean

This parameter is reserved for internal Microsoft use.

MAPIBlockOutlookRpcHttp

Optional

System.Boolean

This parameter is reserved for internal Microsoft use.

MAPIBlockOutlookVersions

Optional

System.String

This parameter is reserved for internal Microsoft use.

MAPIEnabled

Optional

System.Boolean

This parameter is reserved for internal Microsoft use.

OWAEnabled

Optional

System.Boolean

This parameter is reserved for internal Microsoft use.

OWAforDevicesEnabled

Optional

System.Boolean

This parameter is reserved for internal Microsoft use.

OwaMailboxPolicy

Optional

Microsoft.Exchange.Configuration.Tasks.MailboxPolicyIdParameter

The OwaMailboxPolicy parameter specifies the Outlook on the web (formerly known as Outlook Web App) mailbox policy that you want applied to mailboxes that have the CAS mailbox plan applied to them. You can use any value that uniquely identifies the Outlook on the web mailbox policy. For example:

  • Name

  • Distinguished name (DN)

  • GUID

You can use the Get-OwaMailboxPolicy cmdlet to view the avaliable Outlook on the web mailbox policies.

PopEnabled

Optional

System.Boolean

The PopEnabled parameter specifies whether to enable or disable POP3 access to mailboxes that have the mailbox plan applied to them. Valid values are:

  • $true   POP3 access to mailboxes is enabled.

  • $false   POP3 access to mailboxes is disabled.

PopEnableExactRFC822Size

Optional

System.Boolean

This parameter is reserved for internal Microsoft use.

PopForceICalForCalendarRetrievalOption

Optional

System.Boolean

This parameter is reserved for internal Microsoft use.

PopMessagesRetrievalMimeFormat

Optional

Microsoft.Exchange.Data.Directory.SystemConfiguration.MimeTextFormat

This parameter is reserved for internal Microsoft use.

PopProtocolLoggingEnabled

Optional

System.Boolean

This parameter is reserved for internal Microsoft use.

PopSuppressReadReceipt

Optional

System.Boolean

This parameter is reserved for internal Microsoft use.

PopUseProtocolDefaults

Optional

System.Boolean

This parameter is reserved for internal Microsoft use.

RemotePowerShellEnabled

Optional

System.Boolean

This parameter is reserved for internal Microsoft use.

WhatIf

Optional

System.Management.Automation.SwitchParameter

The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch.

To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types. If the Input Type field for a cmdlet is blank, the cmdlet doesn’t accept input data.

To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types. If the Output Type field is blank, the cmdlet doesn’t return data.

 
Show: