Skip to main content This browser is no longer supported. Show
Upgrade to Microsoft Edge to take advantage of the latest features, security updates, and technical support. Set-CASMailbox
This cmdlet is available in on-premises Exchange 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 Exchange ActiveSync, Outlook, Outlook on the web, POP3, and IMAP4. For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax. In this articleSyntax
DescriptionYou 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. ExamplesExample 1
This example disables Outlook on the web and POP3 access for the user . Example 2
This example enables Exchange ActiveSync debug logging and specifies the Exchange ActiveSync mailbox policy named Management for the user . Example 3
This example sets the display name and disables Outlook Anywhere access for the user . Parameters-ActiveSyncAllowedDeviceIDsTheActiveSyncAllowedDeviceIDs 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: To add or remove one or more values without affecting any existing entries, use the following syntax: To clear the list of device IDs, use the value $null for this parameter.
-ActiveSyncBlockedDeviceIDsThe 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: To add or remove one or more values without affecting any existing entries, use the following syntax: To clear the list of device IDs, use the value $null for this parameter.
-ActiveSyncDebugLoggingThe ActiveSyncDebugLogging parameter enables or disables Exchange ActiveSync debug logging for the mailbox. Valid values are:
-ActiveSyncEnabled-ActiveSyncMailboxPolicyThe 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:
The name of the default Exchange ActiveSync mailbox policy is Default. However, to reset this parameter back to the default value, use the value $null. The value $null also changes the value of the ActiveSyncMailboxPolicyIsDefaulted property to True. If you specify the value Default for the ActiveSyncMailboxPolicy parameter, the value of the ActiveSyncMailboxPolicyIsDefaulted property remains False.
-ActiveSyncSuppressReadReceiptThe ActiveSyncSuppressReadReceipt parameter controls the behavior of read receipts for Exchange ActiveSync clients that access the mailbox. Valid values are:
-ConfirmThe 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.
-DisplayNameThis parameter is available only in on-premises Exchange. 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 (").
-DomainControllerThis parameter is available only in on-premises Exchange. 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.
-ECPEnabledThis parameter is available only in on-premises Exchange. The ECPEnabled parameter enables or disables access the Exchange admin center (EAC) or the Exchange Control Panel (ECP) for the specified user. Valid values are:
-EmailAddressesThis parameter is available only in on-premises Exchange. 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 Server. Valid syntax for this parameter is
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:
To replace all existing proxy email addresses with the values you specify, use the following syntax: To add or remove specify proxy addresses
without affecting other existing values, use the following syntax:
-EwsAllowEntourageThe 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).
-EwsAllowListThe 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: To add or remove one or more values without affecting any existing entries, use the following
syntax: This parameter is meaningful only when the EwsEnabled parameter is set to $true, and the EwsApplicationAccessPolicy parameter is set to EnforceAllowList.
-EwsAllowMacOutlookThe EwsAllowMacOutlook parameter enables or disables access to the mailbox by Outlook for Mac clients that use Exchange Web Services (for example, Outlook for Mac 2011 or later). Valid values are:
In the cloud-based service, access for Outlook for Mac clients that use Microsoft Sync technology is controlled by the MacOutlookEnabled parameter.
-EwsAllowOutlookThe EwsAllowOutlook parameter enables or disables access to the mailbox by Outlook clients that use Exchange Web Services. Outlook uses Exchange Web Services for free/busy, out-of-office settings, and calendar sharing. Valid values are:
-EwsApplicationAccessPolicyThe EwsApplicationAccessPolicy parameter controls access to the mailbox using Exchange Web Services applications. Valid values for this parameter are:
This parameter doesn't affect access to the mailbox using Entourage, Outlook for Mac, and Outlook. Access to the mailbox using these clients is controlled by the EwsAllowEntourage, EwsAllowMacOutlook and EwsAllowOutlook parameters.
-EwsBlockListThe EwsBlockList parameter specifies the Exchange Web Services applications (user agent strings) that aren't allowed to access the mailbox using Exchange Web Services. To enter multiple values and overwrite any existing entries, use the following syntax: To add or remove one or more values without affecting any existing
entries, use the following syntax: This parameter is meaningful only when the EwsEnabled parameter is set to $true, and the EwsApplicationAccessPolicy parameter is set to EnforceBlockList.
-EwsEnabledThe EwsEnabled parameter enables or disables access to the mailbox using Exchange Web Services clients. Valid values are:
-HasActiveSyncDevicePartnershipThis parameter is available only in Exchange Server 2010. The HasActiveSyncDevicePartnership parameter specifies whether the mailbox has an Exchange ActiveSync device partnership established. Valid values are:
-IdentityThe Identity parameter specifies the mailbox that you want to configure. You can use any value that uniquely identifies the mailbox. For example:
-IgnoreDefaultScopeThis parameter is available only in on-premises Exchange. The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange PowerShell session, and to use the entire forest as the scope. You don't need to specify a value with this switch. This switch enables the command to access Active Directory objects that aren't currently available in the default scope, but also introduces the following restrictions:
-ImapEnabled-ImapEnableExactRFC822SizeThis parameter is available only in on-premises Exchange. The ImapEnableExactRFC822Size parameter specifies how message sizes are presented to IMAP4 clients that access the mailbox. Valid values are:
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.
-ImapForceICalForCalendarRetrievalOptionThe ImapForceICalForCalendarRetrievalOption parameter specifies how meeting requests are presented to IMAP4 clients that access the mailbox. Valid values are:
To change the value of this parameter, you also need to set the value of the ImapUseProtocolDefaults parameter to $false.
-ImapMessagesRetrievalMimeFormatThe 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:
To change the value of this parameter, you also need to set the value of the ImapUseProtocolDefaults parameter to $false.
-ImapSuppressReadReceiptThe ImapSuppressReadReceipt parameter controls the behavior of read receipts for IMAP4 clients that access the mailbox. Valid values are:
To change the value of this parameter, you also need to set the value of the ImapUseProtocolDefaults parameter to $false.
-ImapUseProtocolDefaultsThe ImapUseProtocolDefaults parameter specifies whether to use the IMAP4 protocol defaults for the mailbox. Valid values are:
You need to set this parameter to $false when you use any of the following IMAP4 parameters:
-IsOptimizedForAccessibilityThis parameter is functional only in on-premises Exchange. The IsOptimizedForAccessibility parameter specifies whether the mailbox is configured to use the light version of Outlook on the web. Valid values are:
-MacOutlookEnabledThis parameter is available only in the cloud-based service. The MacOutlookEnabled parameter enables or disables access to the mailbox using Outlook for Mac clients that use Microsoft Sync technology. Valid values are:
Access for older Outlook for Mac clients that use Exchange Web Services is controlled by the EwsAllowMacOutlook parameter.
-MAPIBlockOutlookExternalConnectivityThis parameter is available only in on-premises Exchange. 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:
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.
-MAPIBlockOutlookNonCachedModeThis parameter is available only in on-premises Exchange. The MAPIBlockOutlookNonCachedMode parameter controls access to the mailbox using Outlook in online or offline mode. Valid values are:
-MAPIBlockOutlookRpcHttpThis parameter is available only in on-premises Exchange. The MAPIBlockOutlookRpcHttp parameter enables or disables access to the mailbox in Outlook using Outlook Anywhere. Valid values are:
-MAPIBlockOutlookVersionsThis parameter is available only in on-premises Exchange. The MAPIBlockOutlookVersions parameter blocks access to the mailbox for specific versions of Outlook. For example, if you specify the value 15.0.4569, 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.
-MAPIEnabledThe MAPIEnabled parameter enables or disables access to the mailbox using MAPI clients (for example, Outlook). Valid values are:
For more information, seeEnable or disable MAPI for a mailbox in Exchange Online, or Enable or disable MAPI access to mailboxes in Exchange Server.
-MapiHttpEnabledThis parameter is available only in on-premises Exchange. The MapiHttpEnabled parameter enables or disables access to the mailbox in Outlook using MAPI over HTTP. Valid values are:
-NameThis parameter is available only in on-premises Exchange. 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 (").
-OneWinNativeOutlookEnabledThis parameter is available only in the cloud-based service. The OneWinNativeOutlookEnabled parameter enables or disables access to the mailbox using the new Outlook for Windows. Valid values are:
-OutlookMobileEnabledThis parameter is available only in the cloud-based service. The OutlookMobileEnabled parameter enables or disables access to the mailbox using Outlook for iOS and Android. Valid values are:
-OWAEnabledThe OWAEnabled parameter enables or disables access to the mailbox using Outlook on the web (formerly known as Outlook Web App or OWA). Valid values are:
For more information, see Enable or disable Outlook on the web for a mailbox in Exchange Online, or Enable or disable Outlook on the web access to mailboxes in Exchange Server.
-OWAforDevicesEnabledThe OWAforDevicesEnabled parameter enables or disables access to the mailbox using the older Outlook Web App (OWA) app on iOS and Android devices. Valid values are:
-OwaMailboxPolicyThe 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:
The name of the default Outlook on the web mailbox policy is Default.
-PopEnabledThe PopEnabled parameter enables or disables access to the mailbox using POP3 clients. Valid values are:
For more information, see Enable or Disable POP3 or IMAP4 access for a user in Exchange Online, or Enable or disable POP3 or IMAP4 access to mailboxes in Exchange Server.
-PopEnableExactRFC822SizeThis parameter is available only in on-premises Exchange. The PopEnableExactRFC822Size parameter specifies how message sizes are presented to POP3 clients that access the mailbox. Valid values are:
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.
-PopForceICalForCalendarRetrievalOptionThe PopForceICalForCalendarRetrievalOption parameter specifies how meeting requests are presented to POP3 clients that access the mailbox. Valid values are:
To change the value of this parameter, you also need to set the value of the PopUseProtocolDefaults parameter to $false.
-PopMessagesRetrievalMimeFormatThe 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:
To change the value of this parameter, you also need to set the value of the PopUseProtocolDefaults parameter to $false.
-PopSuppressReadReceiptThe PopSuppressReadReceipt parameter controls the behavior of read receipts for POP3 clients that access the mailbox. Valid values are:
To change the value of this parameter, you also need to set the value of the PopUseProtocolDefaults parameter to $false.
-PopUseProtocolDefaultsThe PopUseProtocolDefaults parameter specifies whether to use the POP3 protocol defaults for the mailbox. Valid values are:
You need to set this parameter to $false when you use any of following parameters:
-PrimarySmtpAddressThis parameter is available only in on-premises Exchange. The PrimarySmtpAddress parameter specifies the primary return email address that's used for the recipient. You can't use the EmailAddresses and PrimarySmtpAddress parameters in the same command.
-PublicFolderClientAccessThe PublicFolderClientAccess parameter enables or disables access to public folders in Microsoft Outlook. Valid values are:
-ResetAutoBlockedDevicesThis parameter is available only in on-premises Exchange. 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.
-SamAccountNameThis parameter is available only in on-premises Exchange. 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 following 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.
-ShowGalAsDefaultViewThe ShowGalAsDefaultView parameter specifies whether the global address list (GAL) is the default recipient picker for messages. Valid values are:
-SmtpClientAuthenticationDisabledThis parameter is available only in the cloud-based service. The SmtpClientAuthenticationDisabled parameter specifies whether to disable authenticated SMTP (SMTP AUTH) for the mailbox. Examples of clients and services that require authenticated SMTP to send email messages include:
Valid values for this parameter are:
To selectively enable authenticated SMTP for specific mailboxes only: disable authenticated SMTP at the organizational level ($true), enable it for the specific mailboxes ($false), and leave the rest of the mailboxes with their default value ($null).
-UniversalOutlookEnabledThis parameter is available only in the cloud-based service. The UniversalOutlookEnabled parameter enables or disables access to the mailbox using Windows 10 Mail and Calendar. Valid values are:
-WhatIfThe 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.
InputsInput types 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. OutputsOutput types 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. FeedbackSubmit and view feedback for Which of the following allows other mobile devices to wirelessly share your mobile device's Internet connection?You can use your phone's mobile data to connect another phone, tablet, or computer to the internet. Sharing a connection this way is called tethering or using a hotspot. Some phones can share Wi-Fi connection by tethering. Most Android phones can share mobile data by Wi-Fi, Bluetooth, or USB.
Which of the following is the most common input method for mobile devices?Which of the following is the most common input method for mobile devices? Most mobile devices today use capacitive touch screens, which allow the user to use their finger as an input device.
What is the process to synchronize a Bluetooth device to a mobile device?The steps, in order, are as follows: enable Bluetooth, enable pairing, find a device for pairing, enter the appropriate PIN code, and test connectivity. In a mobile device, which of the following are examples of RTOSs? (Choose two.)
Which standard is used to encrypt and decrypt email messages on mobile devices?To send encrypted messages, install an S/MIME certificate for your email account. You can get S/MIME certificates from a certificate authority (CA) or, if you're using an Exchange account, from your organization. You also need the recipient's certificate (public key).
|