Set-CASMailboxPlan

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 (https://technet.microsoft.com/library/bb123552.aspx).

Syntax

Set-CASMailboxPlan
   [-Identity] <MailboxPlanIdParameter>
   [-ActiveSyncDebugLogging <$true | $false>]
   [-ActiveSyncEnabled <$true | $false>]
   [-ActiveSyncMailboxPolicy <MailboxPolicyIdParameter>]
   [-Confirm]
   [-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]
   [-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]
   [<CommonParameters>]

Description

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 (https://technet.microsoft.com/library/mt432940.aspx).

Examples

-------------------------- Example 1 --------------------------

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

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

Required Parameters

-Identity

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).

Type:MailboxPlanIdParameter
Position:1
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
Applies to:Exchange Online

Optional Parameters

-ActiveSyncDebugLogging

This parameter is reserved for internal Microsoft use.

Type:$true | $false
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online
-ActiveSyncEnabled

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.

Type:$true | $false
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online
-ActiveSyncMailboxPolicy

This parameter is reserved for internal Microsoft use.

Type:MailboxPolicyIdParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online
-Confirm

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.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online
-DisplayName

This parameter is reserved for internal Microsoft use.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online
-DomainController

This parameter is reserved for internal Microsoft use.

Type:Fqdn
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online
-ECPEnabled

This parameter is reserved for internal Microsoft use.

Type:$true | $false
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online
-EwsAllowEntourage

This parameter is reserved for internal Microsoft use.

Type:$true | $false
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online
-EwsAllowList

This parameter is reserved for internal Microsoft use.

Type:MultiValuedProperty
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online
-EwsAllowMacOutlook

This parameter is reserved for internal Microsoft use.

Type:$true | $false
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online
-EwsAllowOutlook

This parameter is reserved for internal Microsoft use.

Type:$true | $false
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online
-EwsApplicationAccessPolicy

This parameter is reserved for internal Microsoft use.

Type:EnforceAllowList | EnforceBlockList
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online
-EwsBlockList

This parameter is reserved for internal Microsoft use.

Type:MultiValuedProperty
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online
-EwsEnabled

This parameter is reserved for internal Microsoft use.

Type:$true | $false
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online
-IgnoreDefaultScope

This parameter is reserved for internal Microsoft use.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online
-ImapEnableExactRFC822Size

This parameter is reserved for internal Microsoft use.

Type:$true | $false
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online
-ImapEnabled

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.

Type:$true | $false
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online
-ImapForceICalForCalendarRetrievalOption

This parameter is reserved for internal Microsoft use.

Type:$true | $false
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online
-ImapMessagesRetrievalMimeFormat

This parameter is reserved for internal Microsoft use.

Type:TextOnly | HtmlOnly | HtmlAndTextAlternative | TextEnrichedOnly | TextEnrichedAndTextAlternative | BestBodyFormat | Tnef
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online
-ImapProtocolLoggingEnabled

This parameter is reserved for internal Microsoft use.

Type:$true | $false
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online
-ImapSuppressReadReceipt

This parameter is reserved for internal Microsoft use.

Type:$true | $false
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online
-ImapUseProtocolDefaults

This parameter is reserved for internal Microsoft use.

Type:$true | $false
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online
-MAPIBlockOutlookNonCachedMode

This parameter is reserved for internal Microsoft use.

Type:$true | $false
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online
-MAPIBlockOutlookRpcHttp

This parameter is reserved for internal Microsoft use.

Type:$true | $false
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online
-MAPIBlockOutlookVersions

This parameter is reserved for internal Microsoft use.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online
-MAPIEnabled

This parameter is reserved for internal Microsoft use.

Type:$true | $false
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online
-OWAEnabled

This parameter is reserved for internal Microsoft use.

Type:$true | $false
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online
-OWAforDevicesEnabled

This parameter is reserved for internal Microsoft use.

Type:$true | $false
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online
-OwaMailboxPolicy

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.

Type:MailboxPolicyIdParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online
-PopEnableExactRFC822Size

This parameter is reserved for internal Microsoft use.

Type:$true | $false
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online
-PopEnabled

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.

Type:$true | $false
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online
-PopForceICalForCalendarRetrievalOption

This parameter is reserved for internal Microsoft use.

Type:$true | $false
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online
-PopMessagesRetrievalMimeFormat

This parameter is reserved for internal Microsoft use.

Type:TextOnly | HtmlOnly | HtmlAndTextAlternative | TextEnrichedOnly | TextEnrichedAndTextAlternative | BestBodyFormat | Tnef
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online
-PopProtocolLoggingEnabled

This parameter is reserved for internal Microsoft use.

Type:$true | $false
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online
-PopSuppressReadReceipt

This parameter is reserved for internal Microsoft use.

Type:$true | $false
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online
-PopUseProtocolDefaults

This parameter is reserved for internal Microsoft use.

Type:$true | $false
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online
-RemotePowerShellEnabled

This parameter is reserved for internal Microsoft use.

Type:$true | $false
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online
-WhatIf

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.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online

Inputs

To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data.

Outputs

To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data.