Export (0) Print
Expand All

Set-CASMailbox

Applies to: Exchange Server 2010

Topic Last Modified: 2011-03-19

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.


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>] [-HasActiveSyncDevicePartnership <$true | $false>] [-IgnoreDefaultScope <SwitchParameter>] [-ImapEnabled <$true | $false>] [-ImapEnableExactRFC822Size <$true | $false>] [-ImapMessagesRetrievalMimeFormat <TextOnly | HtmlOnly | HtmlAndTextAlternative | TextEnrichedOnly | TextEnrichedAndTextAlternative | BestBodyFormat | Tnef>] [-ImapProtocolLoggingEnabled <$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>] [-PopProtocolLoggingEnabled <$true | $false>] [-PopUseProtocolDefaults <$true | $false>] [-PrimarySmtpAddress <SmtpAddress>] [-SamAccountName <String>] [-WhatIf [<SwitchParameter>]]

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.

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

The ActiveSyncDebugLogging parameter enables Exchange ActiveSync logging on the mailbox.

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.

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:Text Only
  • 1:HTML Only
  • 2:HTML and Alternative Text
  • 3:Enriched Text Only
  • 4:Enriched Text and Alternative Text
  • 5:Best Body Format

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:Text Only
  • 1:HTML Only
  • 2:HTML and Alternative Text
  • 3:Enriched Text Only
  • 4:Enriched Text and Alternative Text
  • 6: Best Body Format

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.

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.

ActiveSyncDebugLogging

Optional

System.Boolean

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

ImapProtocolLoggingEnabled

Optional

System.Boolean

The IMAPProtocolLoggingEnabled parameter specifies whether logging is turned on for IMAP4.

PopProtocolLoggingEnabled

Optional

System.Boolean

The POPProtocolLoggingEnabled parameter specifies whether logging is turned on for POP3.

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.

Error Description

 

 

Exceptions Description

 

 

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

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

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

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

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

Set-CASMailbox -Identity tony@contoso.com -DisplayName "Tony Smith" -MAPIEnabled:$true
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft