Applies to: Exchange Server 2010 SP3, Exchange Server 2010 SP2

Topic Last Modified: 2012-11-16

Use the Set-CASMailbox cmdlet to set attributes related to client access for Microsoft Exchange ActiveSync, Microsoft Office Outlook Web App, POP3, and IMAP4 for a specified user.

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>] [-EmwsEnabled <$true \| $false>] [-EwsAllowEntourage <$true \| $false>] [-EwsAllowList <MultiValuedProperty>] [-EwsAllowMacOutlook <$true \| $false>] [-EwsAllowOutlook <$true \| $false>] [-EwsApplicationAccessPolicy <EnforceAllowList \| EnforceBlockList>] [-EwsBlockList <MultiValuedProperty>] [-EwsEnabled <$true \| $false>] [-HasActiveSyncDevicePartnership <$true \| $false>] [-IgnoreDefaultScope <SwitchParameter>] [-ImapEnabled <$true \| $false>] [-ImapEnableExactRFC822Size <$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>] [-OwaMailboxPolicy <MailboxPolicyIdParameter>] [-PopEnabled <$true \| $false>] [-PopEnableExactRFC822Size <$true \| $false>] [-PopMessagesRetrievalMimeFormat <TextOnly \| HtmlOnly \| HtmlAndTextAlternative \| TextEnrichedOnly \| TextEnrichedAndTextAlternative \| BestBodyFormat \| Tnef>] [-PopSuppressReadReceipt <$true \| $false>] [-PopUseProtocolDefaults <$true \| $false>] [-PrimarySmtpAddress <SmtpAddress>] [-SamAccountName <String>] [-ShowGalAsDefaultView <$true \| $false>] [-WhatIf [<SwitchParameter>]]

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>]
[-EmwsEnabled <$true | $false>] [-EwsAllowEntourage <$true
| $false>] [-EwsAllowList <MultiValuedProperty>]
[-EwsAllowMacOutlook <$true | $false>] [-EwsAllowOutlook
<$true | $false>] [-EwsApplicationAccessPolicy
<EnforceAllowList | EnforceBlockList>] [-EwsBlockList
<MultiValuedProperty>] [-EwsEnabled <$true | $false>]
[-HasActiveSyncDevicePartnership <$true | $false>]
[-IgnoreDefaultScope <SwitchParameter>] [-ImapEnabled
<$true | $false>] [-ImapEnableExactRFC822Size <$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>] [-OwaMailboxPolicy <MailboxPolicyIdParameter>]
[-PopEnabled <$true | $false>] [-PopEnableExactRFC822Size
<$true | $false>] [-PopMessagesRetrievalMimeFormat
<TextOnly | HtmlOnly | HtmlAndTextAlternative | TextEnrichedOnly
| TextEnrichedAndTextAlternative | BestBodyFormat | Tnef>]
[-PopSuppressReadReceipt <$true | $false>]
[-PopUseProtocolDefaults <$true | $false>]
[-PrimarySmtpAddress <SmtpAddress>] [-SamAccountName
<String>] [-ShowGalAsDefaultView <$true | $false>]
[-WhatIf [<SwitchParameter>]]

Detailed Description

The Set-CASMailbox cmdlet operates on one mailbox at a time. You can configure properties for Outlook Web App, Exchange ActiveSync, POP3, and IMAP4 by using this cmdlet. You can configure a single property or multiple properties by using one statement.

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 Access user settings" entry in the Client Access Permissions topic.

Parameters

Parameter Required Type Description

Identity

Required

Microsoft.Exchange.Configuration.Tasks.MailboxIdParameter

The Identity parameter specifies the mailbox ID. You can use the following values:

GUID
Distinguished name (DN)
User principal name (UPN)
SMTP address
Alias

ActiveSyncAllowedDeviceIDs

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The ActiveSyncAllowedDeviceIDs parameter accepts a list of device IDs that are allowed to synchronize with the mailbox.

However, devices are not blocked from synchronizing unless this parameter is used together with settings that are defined by the set-ActiveSyncOrganizationSettings –DefaultAccessLevel cmdlet.

Note:
When you use the set-ActiveSyncOrganizationSettings –DefaultAccessLevel cmdlet, devices can still be blocked if they do not comply with a specific ActiveSync policy, regardless of whether the device is allowed by the list that is provided to ActiveSyncAllowedDeviceIDs.

For more information about the set-ActiveSyncOrganizationSettings –DefaultAccessLevel cmdlet, see Set-ActiveSyncOrganizationSettings

ActiveSyncBlockedDeviceIDs

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The ActiveSyncBlockedDeviceIDs parameter accepts a list of device IDs that aren't allowed to synchronize with the mailbox.

ActiveSyncDebugLogging

Optional

System.Boolean

The ActiveSyncDebugLogging parameter specifies whether logging is enabled for debugging purposes for Exchange ActiveSync.

ActiveSyncEnabled

Optional

System.Boolean

The ActiveSyncEnabled parameter specifies whether to enable Exchange ActiveSync.

ActiveSyncMailboxPolicy

Optional

Microsoft.Exchange.Configuration.Tasks.MailboxPolicyIdParameter

The ActiveSyncMailboxPolicy parameter specifies the name of the Exchange ActiveSync mailbox policy for the mailbox.

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

The DisplayName parameter specifies the display name for the mailbox.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

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

The ECPEnabled parameter specifies whether the Web management interface is enabled on this Client Access server.

EmailAddresses

Optional

Microsoft.Exchange.Data.ProxyAddressCollection

The EmailAddresses parameter specifies the e-mail address for the mailbox.

EmwsEnabled

Optional

System.Boolean

The EmwsEnabled parameter specifies whether the Exchange Management Web Service is enabled on this Client Access server.

EwsAllowEntourage

Optional

System.Boolean

The EwsAllowEntourage parameter specifies whether to allow or disallow Entourage 2008 for Mac, Web Services Edition to access Exchange Web Services for the user. (Because Entourage 2008 is entirely based on Exchange Web Services, this parameter allows for enabling or disabling Entourage 2008.)

EwsAllowList

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The EwsAllowList parameter specifies the applications (user agent strings) that can access Exchange Web Services when the EwsApplicationAccessPolicy parameter is set to EnforceAllowList.

EwsAllowMacOutlook

Optional

System.Boolean

The EwsAllowMacOutlook parameter specifies whether to allow or disallow Microsoft Outlook for Mac 2011 (soon to be released as a beta) to access Exchange Web Services for the user. (Because Outlook for Mac 2011 is entirely based on Exchange Web Services, this parameter allows for enabling or disabling Outlook for Mac 2011.)

EwsAllowOutlook

Optional

System.Boolean

The EwsAllowOutlook parameter specifies whether to allow or disallow Microsoft Office Outlook 2007 to access Exchange Web Services for the user. 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 specifies which applications other than Entourage, Outlook for Mac 2011 and Outlook can access Exchange Web Services. If set to EnforceAllowList, only applications specified in the EwsAllowList parameter are allowed access to Exchange Web Services. If set to EnforceBlockList, every application is allowed access to Exchange Web Services except the ones specified in the EwsBlockList parameter.

EwsBlockList

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The EwsBlockList parameter specifies the applications (user agent strings) that can't access Exchange Web Services when the EwsApplicationAccessPolicy parameter is set to EnforceBlockList.

EwsEnabled

Optional

System.Boolean

The EwsEnabled parameter specifies whether to globally enable or disable Exchange Web Services access for the user, regardless of which application is making the request.

When the EwsEnabled parameter is set to $false, Exchange Web Services access is turned off regardless of the values of the EwsAllowEntourage parameter. In other words, for the EwsAllowEntourage parameter to be meaningful, Exchange Web Services must be enabled in the first place and thus the EwsEnabled parameter must be set to $true.

HasActiveSyncDevicePartnership

Optional

System.Boolean

The HasActiveSyncDevicePartnership parameter specifies whether the mailbox has an ActiveSync device partnership established.

IgnoreDefaultScope

Optional

System.Management.Automation.SwitchParameter

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 specifies whether the IMAP4 protocol is enabled for this mailbox.

ImapEnableExactRFC822Size

Optional

System.Boolean

The ImapEnableExactRFC822Size parameter specifies the IMAP4 cache size.

ImapMessagesRetrievalMimeFormat

Optional

Microsoft.Exchange.Data.Directory.SystemConfiguration.MimeTextFormat

The ImapMessagesRetrievalMimeFormat parameter specifies the format of the messages retrieved from the server. The possible values are:

0:TextOnly
1:HtmlOnly
2:HtmlAndTextAlternative
3:TextEnrichedOnly
4:TextEnrichedAndTextAlternative
5:BestBodyFormat
6:Tnef

ImapSuppressReadReceipt

Optional

System.Boolean

The IMAPSuppressReadReceipt parameter specifies whether to stop duplicate read receipts from being sent to IMAP4 senders that are using the "send read receipt for messages I send" option in their IMAP4 e-mail program. This option is set to $false by default. By default, IMAP4 senders that use the "send read receipt for messages I send" option receive a read receipt in both of the following circumstances:

When messages they send are downloaded by the recipient.
When the recipient opens the message.

The valid values and descriptions for this parameter are:

$false IMAP4 users are sent a read receipt each time a recipient downloads a message. IMAP4 users are also sent a read receipt when the user opens the message.
$true IMAP4 users that use the "send read receipt for messages I send" option in their e-mail client programs will only receive a read receipt when the recipient opens the message.

ImapUseProtocolDefaults

Optional

System.Boolean

The ImapUseProtocolDefaults parameter specifies whether to use protocol defaults for the IMAP4 protocol.

MAPIBlockOutlookNonCachedMode

Optional

System.Boolean

The MAPIBlockOutlookNonCachedMode parameter specifies whether Microsoft Outlook can be used in online mode.

MAPIBlockOutlookRpcHttp

Optional

System.Boolean

The MAPIBlockOutlookRpcHttp parameter specifies whether clients can connect to Outlook by using Outlook Anywhere.

MAPIBlockOutlookVersions

Optional

System.String

The MAPIBlockOutlookVersions parameter specifies whether certain versions of Outlook are blocked.

MAPIEnabled

Optional

System.Boolean

The MAPIEnabled parameter specifies whether the MAPI protocol is enabled for the mailbox.

Name

Optional

System.String

The Name parameter specifies the name of the mailbox.

OWAEnabled

Optional

System.Boolean

The OWAEnabled parameter enables Outlook Web App.

OwaMailboxPolicy

Optional

Microsoft.Exchange.Configuration.Tasks.MailboxPolicyIdParameter

The OwaMailboxPolicy parameter specifies the active Outlook Web App mailbox policy.

PopEnabled

Optional

System.Boolean

The PopEnabled parameter specifies whether the POP3 protocol is enabled for a mailbox.

PopEnableExactRFC822Size

Optional

System.Boolean

The PopEnableExactRFC822Size parameter specifies the size of the POP3 cache.

PopMessagesRetrievalMimeFormat

Optional

Microsoft.Exchange.Data.Directory.SystemConfiguration.MimeTextFormat

The PopMessagesRetrievalMimeFormat parameter specifies the format of the messages retrieved from the server. The possible values are:

0:TextOnly
1:HtmlOnly
2:HtmlAndTextAlternative
3:TextEnrichedOnly
4:TextEnrichedAndTextAlternative
5:BestBodyFormat
6:Tnef

PopSuppressReadReceipt

Optional

System.Boolean

The PopSuppressReadReceipt parameter specifies whether to stop duplicate read receipts from being sent to POP3 senders that are using the "send read receipt for messages I send" option in their POP3 e-mail program. This option is set to $false by default. By default, POP3 senders that use the "send read receipt for messages I send" option receive a read receipt in both of the following circumstances:

When messages they send are downloaded by the recipient.
When the recipient opens the message.

The valid values and descriptions for this parameter are:

$false POP3 users are sent a read receipt each time a recipient downloads a message. POP3 users are also sent a read receipt when the user opens the message.
$true POP3 users that use the "send read receipt for messages I send" option in their e-mail client programs will only receive a read receipt when the recipient opens the message.

PopUseProtocolDefaults

Optional

System.Boolean

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

PrimarySmtpAddress

Optional

Microsoft.Exchange.Data.SmtpAddress

The PrimarySmtpAddress parameter specifies the primary SMTP address associated with the mailbox.

SamAccountName

Optional

System.String

The SamAccountName parameter specifies the security account name.

ShowGalAsDefaultView

Optional

System.Boolean

The ShowGalAsDefaultView parameter specifies that the global address list (gal) is shown by default when adding message recipients.

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.

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

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

Examples

EXAMPLE 1

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

	Copy Code
Set-CASMailbox -Identity adam@contoso.com -OWAEnabled:$true -POPEnabled:$true

EXAMPLE 2

This example enables Exchange ActiveSync logging, blocks Outlook Anywhere, and specifies the Exchange ActiveSync mailbox policy for the user adam@contoso.com.

	Copy Code
Set-CASMailbox -Identity adam@contoso.com -ActiveSyncDebugLogging:$true -ActiveSyncMailboxPolicy "Management" -MAPIBlockOutlookRpcHttp:$true

EXAMPLE 3

This example sets the display name and enables MAPI access for the user tony@contoso.com.

	Copy Code
Set-CASMailbox -Identity tony@contoso.com -DisplayName "Tony Smith" -MAPIEnabled:$true