Export (0) Print
Expand All

Set-CASMailbox

 

Applies to: Exchange Server 2013, Exchange Online

Topic Last Modified: 2014-03-12

This cmdlet is available in on-premises Exchange Server 2013 and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Set-CASMailbox cmdlet to configure client access settings on a mailbox. For example, you can configure settings for Microsoft Exchange ActiveSync, Microsoft Outlook Web App, POP3, and IMAP4.

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

Set-CASMailbox -Identity <MailboxIdParameter> [-ActiveSyncAllowedDeviceIDs <MultiValuedProperty>] [-ActiveSyncBlockedDeviceIDs <MultiValuedProperty>] [-ActiveSyncDebugLogging <$true | $false>] [-ActiveSyncEnabled <$true | $false>] [-ActiveSyncMailboxPolicy <MailboxPolicyIdParameter>] [-Confirm [<SwitchParameter>]] [-DisplayName <String>] [-DomainController <Fqdn>] [-ECPEnabled <$true | $false>] [-EmailAddresses <ProxyAddressCollection>] [-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>] [-ImapSuppressReadReceipt <$true | $false>] [-ImapUseProtocolDefaults <$true | $false>] [-MAPIBlockOutlookNonCachedMode <$true | $false>] [-MAPIBlockOutlookRpcHttp <$true | $false>] [-MAPIBlockOutlookVersions <String>] [-MAPIEnabled <$true | $false>] [-Name <String>] [-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>] [-PopSuppressReadReceipt <$true | $false>] [-PopUseProtocolDefaults <$true | $false>] [-PrimarySmtpAddress <SmtpAddress>] [-ResetAutoBlockedDevices <SwitchParameter>] [-SamAccountName <String>] [-ShowGalAsDefaultView <$true | $false>] [-WhatIf [<SwitchParameter>]]

This example disables Outlook Web App and POP3 access for the user adam@contoso.com.

Set-CASMailbox adam@contoso.com -OWAEnabled $false -PopEnabled $false

This example enables Exchange ActiveSync debug logging and specifies the Exchange ActiveSync mailbox policy named Management for the user adam@contoso.com.

Set-CASMailbox adam@contoso.com -ActiveSyncDebugLogging $true -ActiveSyncMailboxPolicy Management

This example sets the display name and disables Outlook Anywhere access for the user tony@contoso.com.

Set-CASMailbox tony@contoso.com -DisplayName "Tony Smith" -MAPIBlockOutlookRpcHttp $true

You need to be assigned permissions before you can run this cmdlet. Although all parameters for this cmdlet are listed in this topic, you may not have access to some parameters if they're not included in the permissions assigned to you. To see what permissions you need, see the "Client protocol settings" entry in the Recipients permissions topic.

 

Parameter Required Type Description

Identity

Required

Microsoft.Exchange.Configuration.Tasks.MailboxIdParameter

The Identity parameter specifies the mailbox that you want to configure.

This parameter accepts the following values:

  • Alias

    Example: JPhillips

  • Canonical DN

    Example: Atlanta.Corp.Contoso.Com/Users/JPhillips

  • Display Name

    Example: Jeff Phillips

  • Distinguished Name (DN)

    Example: CN=JPhillips,CN=Users,DC=Atlanta,DC=Corp,DC=contoso,DC=com

  • Domain\Account

    Example: Atlanta\JPhillips

  • GUID

    Example: fb456636-fe7d-4d58-9d15-5af57d0354c2

  • Immutable ID

    Example: fb456636-fe7d-4d58-9d15-5af57d0354c2@contoso.com

  • Legacy Exchange DN

    Example: /o=Contoso/ou=AdministrativeGroup/cn=Recipients/cn=JPhillips

  • SMTP Address

    Example: Jeff.Phillips@contoso.com

  • User Principal Name

    Example: JPhillips@contoso.com

ActiveSyncAllowedDeviceIDs

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The ActiveSyncAllowedDeviceIDs parameter specifies one or more Exchange ActiveSync device IDs that are allowed to synchronize with the mailbox. A device ID is a text string that uniquely identifies the device. Use the Get-MobileDevice cmdlet to see the devices that have Exchange ActiveSync partnerships with the mailbox.

To enter multiple values and overwrite any existing entries, use the following syntax: <value1>,<value2>.... If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "<value1>","<value2>"....

To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="<value1>","<value2>"...; Remove="<value1>","<value2>"...}.

To clear the list of device IDs, use the value $null for this parameter.

ActiveSyncBlockedDeviceIDs

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The ActiveSyncBlockedDeviceIDs parameter specifies one or more Exchange ActiveSync device IDs that aren't allowed to synchronize with the mailbox. A device ID is a text string that uniquely identifies the device. Use the Get-MobileDevice cmdlet to see the devices that have Exchange ActiveSync partnerships with the mailbox.

To enter multiple values and overwrite any existing entries, use the following syntax: <value1>,<value2>.... If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "<value1>","<value2>"....

To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="<value1>","<value2>"...; Remove="<value1>","<value2>"...}.

To clear the list of device IDs, use the value $null for this parameter.

ActiveSyncDebugLogging

Optional

System.Boolean

The ActiveSyncDebugLogging parameter enables or disables Exchange ActiveSync debug logging for the mailbox. Valid input for this parameter is $true or $false. The default value is $false.

ActiveSyncEnabled

Optional

System.Boolean

The ActiveSyncEnabled parameter enables or disables Exchange ActiveSync for the mailbox. Valid input for this parameter is $true or $false. The default value is $true. Note that when you set this parameter to $false, the other Exchange ActiveSync settings in this cmdlet are ignored.

ActiveSyncMailboxPolicy

Optional

Microsoft.Exchange.Configuration.Tasks.MailboxPolicyIdParameter

The ActiveSyncMailboxPolicy parameter specifies the Exchange ActiveSync mailbox policy for the mailbox. You can use any value that uniquely identifies the Exchange ActiveSync mailbox policy. For example:

  • Name

  • Distinguished name (DN)

  • GUID

The name of the default Exchange ActiveSync mailbox policy is Default.

Confirm

Optional

System.Management.Automation.SwitchParameter

The Confirm switch causes the command to pause processing and requires you to acknowledge what the command will do before processing continues. You don't have to specify a value with the Confirm switch.

DisplayName

Optional

System.String

This parameter is available only in on-premises Exchange 2013.

The DisplayName parameter specifies the display name for the mailbox.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

This parameter is available only in on-premises Exchange 2013.

The DomainController parameter specifies the fully qualified domain name (FQDN) of the domain controller that writes this configuration change to Active Directory.

ECPEnabled

Optional

System.Boolean

This parameter is available only in on-premises Exchange 2013.

The ECPEnabled parameter enables or disables access to the Exchange admin center (EAC) for the specified user. Valid input for this parameter is $true or $false. The default value is $true.

EmailAddresses

Optional

Microsoft.Exchange.Data.ProxyAddressCollection

This parameter is available only in on-premises Exchange 2013.

The EmailAddresses parameter specifies all the proxy addresses of the recipient. It includes the primary SMTP address as one of the proxy addresses. Typically, the primary SMTP address and other proxy address are set by email address policies. However, you can use this parameter to configure other proxy addresses for the recipient. For more information, see Email address policies.

Valid syntax for this parameter is [<Type>]:<emailaddress1>,[<Type>]:<emailaddress2>.... The optional <Type> value indicates the type of email address. Some examples of valid type values include:

  • SMTP   The primary SMTP address

  • smtp   Other SMTP email addresses

  • X400   X.400 addresses

  • X500   X.500 addresses

If you don't include a <Type> value for an email address, the value smtp is assumed.

To specify the primary SMTP email address, you can use any of the following methods:

  • Use the <Type> value SMTP.

  • The first email address when you don't use the <Type> value SMTP, and when you don't use any <Type> values, or when there are multiple <Type> values of smtp

  • Use the PrimarySmtpAddress parameter instead. You can't use the EmailAddresses parameter and the PrimarySmtpAddress parameter in the same command.

When you specify one or more proxy address by using the EmailAddresses parameter, those values replace any exiting proxy addresses that are configured for the recipient. To add or remove specify proxy addresses without affecting other values, use the following syntax: @{Add="[<Type>]:<emailaddress1>","[<Type>]:<emailaddress2>"...; Remove="[<Type>]:<emailaddress2>","[<Type>]:<emailaddress2>"...}

ImportantImportant:
Exchange doesn't validate custom address types (including X.400 addresses) for proper formatting. You need to ensure that any custom addresses comply with the format requirements for that address type.

EwsAllowEntourage

Optional

System.Boolean

The EwsAllowEntourage parameter enables or disables access to the mailbox by Microsoft Entourage clients that use Exchange Web Services (for example, Entourage 2008 for Mac, Web Services Edition).

Valid input for this parameter is $true or $false. The default value is $true.

EwsAllowList

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The EwsAllowList parameter specifies the Exchange Web Services applications (user agent strings) that are allowed to access the mailbox.

To enter multiple values and overwrite any existing entries, use the following syntax: <value1>,<value2>.... If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "<value1>","<value2>"....

To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="<value1>","<value2>"...; Remove="<value1>","<value2>"...}.

This parameter is meaningful only when the EwsEnabled parameter is set to $true, and the EwsApplicationAccessPolicy parameter is set to EnforceAllowList.

EwsAllowMacOutlook

Optional

System.Boolean

The EwsAllowMacOutlook parameter enables or disables access to the mailbox by Microsoft Outlook for Mac clients that use Exchange Web Services (for example, Outlook for Mac 2011).

Valid input for this parameter is $true or $false. The default value is $true.

EwsAllowOutlook

Optional

System.Boolean

The EwsAllowOutlook parameter enables or disables access to the mailbox by Microsoft Outlook clients that use Exchange Web Services. Outlook uses Exchange Web Services for free/busy, out-of-office settings, and calendar sharing.

EwsApplicationAccessPolicy

Optional

Microsoft.Exchange.Data.Directory.EwsApplicationAccessPolicy

The EwsApplicationAccessPolicy parameter controls access to the mailbox by using Exchange Web Services applications.

Valid values for this parameter are:

  • EnforceAllowList   Only applications specified in the EwsAllowList parameter are allowed to access the mailbox.

  • EnforceBlockList   Applications specified in the EwsBlockList parameter aren't allowed to access the mailbox, but any other applications can access the mailbox.

This parameter doesn't affect access to the mailbox by using Entourage, Outlook for Mac, and Outlook. Access to the mailbox by using these clients is controlled by the EwsAllowEntourage, EwsAllowMacOutlook and EwsAllowOutlook parameters.

EwsBlockList

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The EwsBlockList parameter specifies the Exchange Web Services applications (user agent strings) that aren't allowed to access the mailbox by using Exchange Web Services.

To enter multiple values and overwrite any existing entries, use the following syntax: <value1>,<value2>.... If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "<value1>","<value2>"....

To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="<value1>","<value2>"...; Remove="<value1>","<value2>"...}.

This parameter is meaningful only when the EwsEnabled parameter is set to $true, and the EwsApplicationAccessPolicy parameter is set to EnforceBlockList.

EwsEnabled

Optional

System.Boolean

The EwsEnabled parameter enables or disables access to the mailbox by using Exchange Web Services clients.

Valid input for this parameter is $true or $false. The default value is $true. Note that when you set this parameter to $false, the other Exchange Web Services settings in this cmdlet are ignored.

IgnoreDefaultScope

Optional

System.Management.Automation.SwitchParameter

This parameter is available only in on-premises Exchange 2013.

The IgnoreDefaultScope parameter instructs the command to ignore the default recipient scope setting for the Exchange Management Shell session and use the entire forest as the scope. This allows the command to access Active Directory objects that aren't currently in the default scope. Using the IgnoreDefaultScope parameter introduces the following restrictions:

  • You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically.

  • You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted.

ImapEnabled

Optional

System.Boolean

The ImapEnabled parameter enables or disables access to the mailbox by using IMAP4 clients.

Valid input for this parameter is $true or $false. The default value is $true. Note that when you set this parameter to $false, the other IMAP4 settings in this cmdlet are ignored.

ImapEnableExactRFC822Size

Optional

System.Boolean

This parameter is available only in on-premises Exchange 2013.

The ImapEnableExactRFC822Size parameter specifies how message sizes are presented to IMAP4 clients that access the mailbox.

Valid values for this parameter are:

  • $true   Calculate the exact message size.

  • $false   Use an estimated message size.

The default value is $false.

We don't recommend changing this value unless you determine that the default setting causes problems for IMAP4 clients. To change the value of this parameter, you also need to set the value of the ImapUseProtocolDefaults parameter to $false.

ImapForceICalForCalendarRetrievalOption

Optional

System.Boolean

The ImapForceICalForCalendarRetrievalOption parameter specifies how meeting requests are presented to IMAP4 clients that access the mailbox.

Valid values for this parameter are:

  • $true   All meeting requests are in the iCal format.

  • $false   All meeting requests appear as Outlook Web App links.

The default value is $false.

To change the value of this parameter, you also need to set the value of the ImapUseProtocolDefaults parameter to $false.

ImapMessagesRetrievalMimeFormat

Optional

Microsoft.Exchange.Data.Directory.SystemConfiguration.MimeTextFormat

The ImapMessagesRetrievalMimeFormat parameter specifies the message format for IMAP4 clients that access the mailbox. You can use an integer or a text value. Valid values are:

  • 0: TextOnly

  • 1: HtmlOnly

  • 2: HtmlAndTextAlternative

  • 3: TextEnrichedOnly

  • 4: TextEnrichedAndTextAlternative

  • 5: BestBodyFormat

  • 6: Tnef

The default value is BestBodyFormat.

To change the value of this parameter, you also need to set the value of the ImapUseProtocolDefaults parameter to $false.

ImapSuppressReadReceipt

Optional

System.Boolean

The ImapSuppressReadReceipt parameter controls the behavior of read receipts for IMAP4 clients that access the mailbox.

Valid values for this parameter are:

  • $true   The user receives a read receipt when the recipient opens the message.

  • $false   The user receives two read receipts: one when the message is downloaded and another when the message is opened.

The default value is $false.

To change the value of this parameter, you also need to set the value of the ImapUseProtocolDefaults parameter to $false.

ImapUseProtocolDefaults

Optional

System.Boolean

The ImapUseProtocolDefaults parameter specifies whether to use the IMAP4 protocol defaults for the mailbox. Valid input for this parameter is $true or $false. The default value is $true.

You need to set the ImapUseProtocolDefaults parameter to $false when you use any of the following IMAP4 parameters:

  • ImapEnableExactRFC822Size

  • ImapForceICalForCalendarRetrievalOption

  • ImapMessagesRetrievalMimeFormat

  • ImapSuppressReadReceipt

MAPIBlockOutlookNonCachedMode

Optional

System.Boolean

This parameter is available only in on-premises Exchange 2013.

The MAPIBlockOutlookNonCachedMode parameter controls access to the mailbox by using Microsoft Outlook in online or offline mode.

Valid values for this parameter are:

  • $true   Only Outlook clients that are configured to use Cached Exchange Mode (offline mode) are allowed to access the mailbox.

  • $false   The state of the Cached Exchange Mode setting isn't checked before Outlook clients are allowed to access the mailbox (online mode and offline mode are allowed).

The default value is $false.

MAPIBlockOutlookRpcHttp

Optional

System.Boolean

This parameter is available only in on-premises Exchange 2013.

The MAPIBlockOutlookRpcHttp parameter enables or disables access to the mailbox by using Outlook Anywhere (RPC over HTTP) in Microsoft Outlook.

Valid values for this parameter are:

  • $true   Only Outlook clients that aren't configured to use Outlook Anywhere (RPC over HTTP) are allowed to access the mailbox. By default, Outlook 2013 is configured to use Outlook Anywhere.

  • $false   Outlook clients that are configured to use Outlook Anywhere (RPC over HTTP) are allowed to access the mailbox.

The default value is $false.

MAPIBlockOutlookVersions

Optional

System.String

This parameter is available only in on-premises Exchange 2013.

The MAPIBlockOutlookVersions parameter blocks access to the mailbox for specific versions of Outlook.

For example, if you specify the value 15.0.4569.1503, only Outlook 2013 Service Pack 1 (SP1) or later clients are allowed to access the mailbox. Earlier versions of Outlook are blocked.

MAPIEnabled

Optional

System.Boolean

The MAPIEnabled parameter enables or disables access to the mailbox by using MAPI clients (for example, Microsoft Outlook).

Valid input for this parameter is $true or $false. The default value is $true. Note that when you set this parameter to $false, the other MAPI settings in this cmdlet are ignored.

Name

Optional

System.String

This parameter is available only in on-premises Exchange 2013.

The Name parameter specifies the name of the mailbox.

OWAEnabled

Optional

System.Boolean

The OWAEnabled parameter enables or disables access to the mailbox by using Outlook Web App.

Valid input for this parameter is $true or $false. The default value is $true. Note that when you set this parameter to $false, the other Outlook Web App settings in this cmdlet are ignored.

OWAforDevicesEnabled

Optional

System.Boolean

The OWAforDevicesEnabled parameter enables or disables access to the mailbox by using OWA for Devices.

Valid input for this parameter is $true or $false. The default value is $true.

OwaMailboxPolicy

Optional

Microsoft.Exchange.Configuration.Tasks.MailboxPolicyIdParameter

The OwaMailboxPolicy parameter specifies the Outlook Web App mailbox policy for the mailbox. You can use any value that uniquely identifies the Outlook Web App mailbox policy. For example:

  • Name

  • Distinguished name (DN)

  • GUID

The name of the default Outlook Web App mailbox policy is Default.

PopEnabled

Optional

System.Boolean

The PopEnabled parameter enables or disables access to the mailbox by using POP3 clients.

Valid input for this parameter is $true or $false. The default value is $true. Note that when you set this parameter to $false, the other POP3 settings in this cmdlet are ignored.

PopEnableExactRFC822Size

Optional

System.Boolean

This parameter is available only in on-premises Exchange 2013.

The PopEnableExactRFC822Size parameter specifies how message sizes are presented to POP3 clients that access the mailbox.

Valid values for this parameter are:

  • $true   Calculate the exact message size.

  • $false   Use an estimated message size.

The default value is $false.

We don't recommend changing this value unless you determine that the default setting causes problems for POP3 clients. To change the value of this parameter, you also need to set the value of the PopUseProtocolDefaults parameter to $false.

PopForceICalForCalendarRetrievalOption

Optional

System.Boolean

The PopForceICalForCalendarRetrievalOption parameter specifies how meeting requests are presented to POP3 clients that access the mailbox.

Valid values for this parameter are:

  • $true   All meeting requests are in the iCal format.

  • $false   All meeting requests appear as Outlook Web App links.

The default value is $false.

To change the value of this parameter, you also need to set the value of the PopUseProtocolDefaults parameter to $false.

PopMessagesRetrievalMimeFormat

Optional

Microsoft.Exchange.Data.Directory.SystemConfiguration.MimeTextFormat

The PopMessagesRetrievalMimeFormat parameter specifies the message format for POP3 clients that access the mailbox. You can use an integer or a text value. Valid values are:

  • 0: TextOnly

  • 1: HtmlOnly

  • 2: HtmlAndTextAlternative

  • 3: TextEnrichedOnly

  • 4: TextEnrichedAndTextAlternative

  • 5: BestBodyFormat

  • 6: Tnef

The default value is BestBodyFormat.

To change the value of this parameter, you also need to set the value of the PopUseProtocolDefaults parameter to $false.

PopSuppressReadReceipt

Optional

System.Boolean

The PopSuppressReadReceipt parameter controls the behavior of read receipts for POP3 clients that access the mailbox.

Valid values for this parameter are:

  • $true   The user receives a read receipt when the recipient opens the message.

  • $false   The user receives two read receipts: one when the message is downloaded and another when the message is opened.

The default value is $false.

To change the value of this parameter, you also need to set the value of the PopUseProtocolDefaults parameter to $false.

PopUseProtocolDefaults

Optional

System.Boolean

The PopUseProtocolDefaults parameter specifies whether to use the POP3 protocol defaults for the mailbox.

Valid input for this parameter is $true or $false. The default value is $true. You need to set the PopUseProtocolDefaults parameter to $false when you use any of following parameters:

  • PopEnableExactRFC822Size

  • PopForceICalForCalendarRetrievalOption

  • PopMessagesRetrievalMimeFormat

  • PopSuppressReadReceipt

PrimarySmtpAddress

Optional

Microsoft.Exchange.Data.SmtpAddress

This parameter is available only in on-premises Exchange 2013.

The PrimarySmtpAddress parameter specifies the primary SMTP email address for the mailbox. This is the From address that external recipients see when they receive a message from this mailbox.

You can't use the PrimarySmtpAddress parameter and the EmailAddresses parameter in the same command.

ResetAutoBlockedDevices

Optional

System.Management.Automation.SwitchParameter

This parameter is available only in on-premises Exchange 2013.

The ResetAutoBlockedDevices switch resets the status of blocked mobile devices that have exceeded the limits defined by the Set-ActiveSyncDeviceAutoblockThreshold cmdlet.

SamAccountName

Optional

System.String

This parameter is available only in on-premises Exchange 2013.

The SamAccountName parameter specifies an account identifier that's compatible with older operating systems. The value of this parameter must be less than 20 characters, and can contain letters, numbers, and the following characters:

  • !

  • #

  • $

  • %

  • ^

  • &

  • -

  • .

  • _

  • {

  • }

  • |

  • ~

ShowGalAsDefaultView

Optional

System.Boolean

The ShowGalAsDefaultView parameter shows the global address list (GAL) as the default recipient picker for messages. Valid input for this parameter is $true or $false. The default value is $true.

WhatIf

Optional

System.Management.Automation.SwitchParameter

The WhatIf switch instructs the command to simulate the actions that it would take on the object. By using the WhatIf switch, you can view what changes would occur without having to apply any of those changes. You don't have to specify a value with the WhatIf 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.

 
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft