Set-CASMailbox

Identity

Required

Microsoft.Exchange.Configuration.Tasks.MailboxIdParameter

The Identity parameter specifies the mailbox that you want to configure. You can use any value that uniquely identifies the mailbox.

For example:

• Name

• Display name

• Alias

• Distinguished name (DN)

• Canonical DN

• <domain name>\<account name>

• Email address

• GUID

• LegacyExchangeDN

• SamAccountName

• User ID or user principal name (UPN)

ActiveSyncAllowedDeviceIDs

Optional

Microsoft.Exchange.Data.MultiValuedProperty

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

This parameter is primarily for troubleshooting and will revert to $false in 48 hours for Exchange Online, and in 72 hours for Exchange Server.

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

ActiveSyncSuppressReadReceipt

Optional

System.Boolean

The ActiveSyncSuppressReadReceipt parameter controls the behavior of read receipts for Exchange ActiveSync clients that access the mailbox. Valid values 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. This is the default value.

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 available only in on-premises Exchange 2016.

The DisplayName parameter specifies the display name of the mailbox. The display name is visible in the Exchange admin center and in address lists. The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks (").

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

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

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 (FQDN). For example, dc01.contoso.com.

ECPEnabled

Optional

System.Boolean

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

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

The EmailAddresses parameter specifies all the email addresses (proxy addresses) for the recipient, including the primary SMTP address. In on-premises Exchange organizations, the primary SMTP address and other proxy addresses are typically 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 in Exchange 2016.

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

• SMTP   The primary SMTP address. You can use this value only once in a command.

• smtp   Other SMTP email addresses.

• X400   X.400 addresses in on-premises Exchange.

• X500   X.500 addresses in on-premises Exchange.

If you don't include a <Type> value for an email address, the value smtp is assumed. Note that Exchange doesn't validate the syntax of custom address types (including X.400 addresses). Therefore, you need to verify that any custom addresses are formatted correctly.

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

• Use the <Type> value SMTP on the address.

• The first email address when you don't use any <Type> values, or when you use multiple <Type> values of smtp.

• If it's available, use the PrimarySmtpAddress parameter instead. You can't use the EmailAddresses parameter and the PrimarySmtpAddress parameter in the same command.

To replace all existing proxy email addresses with the values you specify, use the following syntax: "[<Type>]:<emailaddress1>","[<Type>]:<emailaddress2>"....

To add or remove specify proxy addresses without affecting other existing values, use the following syntax: @{Add="[<Type>]:<emailaddress1>","[<Type>]:<emailaddress2>"...; Remove="[<Type>]:<emailaddress2>","[<Type>]:<emailaddress2>"...}.

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 MicrosoftOutlook for Mac clients that use Exchange Web Services (for example, Outlook for Mac 2011 or later).

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 MicrosoftOutlook 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 2016.

The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange Management Shell session, and to use the entire forest as the scope. This allows the command to access Active Directory objects that aren't currently available in the default scope.

Using the IgnoreDefaultScope switch 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 2016.

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 on the web 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

IsOptimizedForAccessibility

Optional

System.Boolean

The IsOptimizedForAccessibility parameter specifies whether the mailbox is configured to use the light version of Outlook on the web. Valid values are:

• $true   The mailbox is configured to use the light version of Outlook on the web.

• $false   The mailbox isn't configured to use the light version of Outlook on the web.

MAPIBlockOutlookExternalConnectivity

Optional

System.Boolean

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

The MAPIBlockOutlookExternalConnectivity parameter enables or disables external access to the mailbox in Outlook by removing the external URLs from the Autodiscover response. This setting affects Outlook Anywhere, MAPI over HTTP, and Exchange Web Services (EWS). Valid values are:

• $true   External Outlook clients can't use Outlook Anywhere, MAPI over HTTP, or EWS to access the mailbox.

• $false   External Outlook clients can use Outlook Anywhere, MAPI over HTTP, or EWS to access the mailbox.

Note: If your organization uses the same Autodiscover URL values for internal and external clients, setting this parameter to $true won't block access for external clients.

MAPIBlockOutlookNonCachedMode

Optional

System.Boolean

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

The MAPIBlockOutlookNonCachedMode parameter controls access to the mailbox by using 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 2016.

The MAPIBlockOutlookRpcHttp parameter enables or disables access to the mailbox in Outlook by using Outlook Anywhere. Valid values are:

• $true   Access to the mailbox by using Outlook Anywhere is disabled.

• $false   Access to the mailbox by using Outlook Anywhere is enabled. This is the default value.

MAPIBlockOutlookVersions

Optional

System.String

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

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.

The default value is blank. To reset this parameter, use the value $null.

MAPIEnabled

Optional

System.Boolean

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

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.

MapiHttpEnabled

Optional

System.Boolean

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

The MapiHttpEnabled parameter enables or disables access to the mailbox in Outlook by using MAPI over HTTP. Valid values are:

• $true   Access to the mailbox by using MAPI over HTTP is enabled.

• $false   Access to the mailbox by using MAPI over HTTP is disabled.

• $null (blank)   The setting isn't configured. The mailbox uses the organization setting for MAPI over HTTP (the MapiHttpEnabled parameter on the Set-OrganizationConfig cmdlet). This is the default value.

Name

Optional

System.String

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

The Name parameter specifies the unique name of the mailbox. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks (").

OWAEnabled

Optional

System.Boolean

The OWAEnabled parameter enables or disables access to the mailbox by using Outlook on the web.

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 on the web settings in this cmdlet are ignored.

OWAforDevicesEnabled

Optional

System.Boolean

The OWAforDevicesEnabled parameter enables or disables access to the mailbox by using Outlook on the web 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 on the web mailbox policy for the mailbox. You can use any value that uniquely identifies the Outlook on the web mailbox policy. For example:

• Name

• Distinguished name (DN)

• GUID

The name of the default Outlook on the web 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 2016.

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 on the web 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 2016.

The PrimarySmtpAddress parameter specifies the primary return email address that's used for the recipient. If it's available on this cmdlet, you can't use the EmailAddresses and PrimarySmtpAddress parameters in the same command.

ResetAutoBlockedDevices

Optional

System.Management.Automation.SwitchParameter

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

The ResetAutoBlockedDevices switch resets the status of blocked mobile devices that have exceeded the limits defined by the Set-ActiveSyncDeviceAutoblockThreshold cmdlet. You don't need to specify a value with this switch.

SamAccountName

Optional

System.String

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

The SamAccountName parameter (also known as the pre-Windows 2000 user account or group name) specifies an object identifier that's compatible with older versions of Microsoft Windows client and server operating systems. The value can contain letters, numbers, spaces, periods (.), and the characters !, #, $, %, ^, &, -, _, {, }, and ~. The last character can't be a period. Unicode characters are allowed, but accented characters may generate collisions (for example, o and ö match). The maximum length is 20 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.

UniversalOutlookEnabled

Optional

System.Boolean

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

The UniversalOutlookEnabled parameter enables or disables access to the mailbox by using Mail and Calendar. Valid values are:

• $true   Access to the mailbox in Mail and Calendar is enabled. This is the default value.

• $false   Access to the mailbox in Mail and Calendar is disabled.

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.