Export (0) Print
Expand All

Set-CASMailbox (RTM)

 

Applies to: Exchange Server 2007

Topic Last Modified: 2007-06-11

The Set-CASMailbox cmdlet sets client access-related attributes for Microsoft Exchange ActiveSync, Microsoft Office Outlook Web Access, Post Office Protocol version 3 (POP3), and Internet Message Access Protocol version 4rev1 (IMAP4) for a specified user.


set-CASMailbox -Identity <MailboxIdParameter> [-ActiveSyncAllowedDeviceIDs <MultiValuedProperty>] [-ActiveSyncEnabled <$true | $false>] [-ActiveSyncMailboxPolicy <MailboxPolicyIdParameter>] [-ActiveSyncDebugLogging <Nullable>] [-DisplayName <String>] [-DomainController <Fqdn>] [-EmailAddresses <ProxyAddressCollection>] [-HasActiveSyncDevicePartnership <$true | $false>] [-ImapEnabled <$true | $false>] [-ImapMessagesRetrievalMimeFormat <TextOnly | HtmlOnly | HtmlAndTextAlternative | TextEnrichedOnly | TextEnrichedAndTextAlternative | BestBodyFormat>] [-ImapUseProtocolDefaults <$true | $false>] [-MAPIBlockOutlookNonCachedMode <$true | $false>] [-MAPIBlockOutlookRpcHttp <$true | $false>] [-MAPIBlockOutlookVersions <String>] [-MAPIEnabled <$true | $false>] [-Name <String>] [-OWAActiveSyncIntegrationEnabled <Nullable>] [-OWAAllAddressListsEnabled <Nullable>] [-OWACalendarEnabled <Nullable>] [-OWAChangePasswordEnabled <Nullable>] [-OWAContactsEnabled <Nullable>] [-OWAEnabled <$true | $false>] [-OWAJournalEnabled <Nullable>] [-OWAJunkEmailEnabled <Nullable>] [-OWANotesEnabled <Nullable>] [-OWAPremiumClientEnabled <Nullable>] [-OWARemindersAndNotificationsEnabled <Nullable>] [-OWASearchFoldersEnabled <Nullable>] [-OWASignaturesEnabled <Nullable>] [-OWASpellCheckerEnabled <Nullable>] [-OWATasksEnabled <Nullable>] [-OWAThemeSelectionEnabled <Nullable>] [-OWAUMIntegrationEnabled <Nullable>] [-OWAUNCAccessOnPrivateComputersEnabled <Nullable>] [-OWAUNCAccessOnPublicComputersEnabled <Nullable>] [-OWAWSSAccessOnPrivateComputersEnabled <Nullable>] [-OWAWSSAccessOnPublicComputersEnabled <Nullable>] [-PopEnabled <$true | $false>] [-PopMessagesRetrievalMimeFormat <TextOnly | HtmlOnly | HtmlAndTextAlternative | TextEnrichedOnly | TextEnrichedAndTextAlternative | BestBodyFormat>] [-PopUseProtocolDefaults <$true | $false>] [-PrimarySmtpAddress <SmtpAddress>] [-ProtocolSettings <MultiValuedProperty>] [-SamAccountName <String>]


set-CASMailbox [-ActiveSyncAllowedDeviceIDs <MultiValuedProperty>] [-ActiveSyncEnabled <$true | $false>] [-ActiveSyncMailboxPolicy <MailboxPolicyIdParameter>] [-ActiveSyncDebugLogging <Nullable>] [-DisplayName <String>] [-DomainController <Fqdn>] [-EmailAddresses <ProxyAddressCollection>] [-HasActiveSyncDevicePartnership <$true | $false>] [-ImapEnabled <$true | $false>] [-ImapMessagesRetrievalMimeFormat <TextOnly | HtmlOnly | HtmlAndTextAlternative | TextEnrichedOnly | TextEnrichedAndTextAlternative | BestBodyFormat>] [-ImapUseProtocolDefaults <$true | $false>] [-Instance <CASMailbox>] [-MAPIBlockOutlookNonCachedMode <$true | $false>] [-MAPIBlockOutlookRpcHttp <$true | $false>] [-MAPIBlockOutlookVersions <String>] [-MAPIEnabled <$true | $false>] [-Name <String>] [-OWAActiveSyncIntegrationEnabled <Nullable>] [-OWAAllAddressListsEnabled <Nullable>] [-OWACalendarEnabled <Nullable>] [-OWAChangePasswordEnabled <Nullable>] [-OWAContactsEnabled <Nullable>] [-OWAEnabled <$true | $false>] [-OWAJournalEnabled <Nullable>] [-OWAJunkEmailEnabled <Nullable>] [-OWANotesEnabled <Nullable>] [-OWAPremiumClientEnabled <Nullable>] [-OWARemindersAndNotificationsEnabled <Nullable>] [-OWASearchFoldersEnabled <Nullable>] [-OWASignaturesEnabled <Nullable>] [-OWASpellCheckerEnabled <Nullable>] [-OWATasksEnabled <Nullable>] [-OWAThemeSelectionEnabled <Nullable>] [-OWAUMIntegrationEnabled <Nullable>] [-OWAUNCAccessOnPrivateComputersEnabled <Nullable>] [-OWAUNCAccessOnPublicComputersEnabled <Nullable>] [-OWAWSSAccessOnPrivateComputersEnabled <Nullable>] [-OWAWSSAccessOnPublicComputersEnabled <Nullable>] [-PopEnabled <$true | $false>] [-PopMessagesRetrievalMimeFormat <TextOnly | HtmlOnly | HtmlAndTextAlternative | TextEnrichedOnly | TextEnrichedAndTextAlternative | BestBodyFormat>] [-PopUseProtocolDefaults <$true | $false>] [-PrimarySmtpAddress <SmtpAddress>] [-ProtocolSettings <MultiValuedProperty>] [-SamAccountName <String>]

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

To run the Set-CASMailbox cmdlet, the account you use must be delegated the following:

  • Exchange Recipient Administrator role

For more information about permissions, delegating roles, and the rights that are required to administer Exchange Server 2007, see Permission Considerations.

 

Parameter Required Type Description

Identity

Required

Microsoft.Exchange.Configuration.Tasks.MailboxIdParameter

This parameter can be the Active Directory Object ID or a string that represents the GUID, distinguished name, domain or account, user principal name (UPN), legacy Exchange distinguished name, Simple Mail Transfer Protocol (SMTP) address, or alias.

ActiveSyncAllowedDeviceIDs

Optional

Microsoft.Exchange.Data.MultiValuedProperty

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

ActiveSyncDebugLogging

Optional

System.Nullable

This parameter specifies whether error logging is enabled for mobile devices.

ActiveSyncMailboxPolicy

Optional

Microsoft.Exchange.Configuration.Tasks.MailboxPolicyIdParameter

This parameter specifies the name of the Exchange ActiveSync mailbox policy for the mailbox.

ActiveSyncEnabled

Optional

System.Boolean

This parameter enables or disables Exchange ActiveSync.

DisplayName

Optional

System.String

This parameter is the display name for the mailbox.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

This parameter specifies the fully qualified domain name (FQDN) of the domain controller that writes configuration changes to the Active Directory directory service.

EmailAddresses

Optional

Microsoft.Exchange.Data.ProxyAddressCollection

This parameter specifies the e-mail address for the mailbox.

HasActiveSyncDevicePartnership

Optional

System.Boolean

This parameter specifies whether the mailbox has an active sync device partnership established.

ImapEnabled

Optional

System.Boolean

This parameter specifies whether the IMAP4 protocol is enabled for this mailbox.

ImapMessagesRetrievalMimeFormat

Optional

Microsoft.Exchange.Data.Directory.SystemConfiguration.MimeTextFormat

This parameter specifies the format of messages that are retrieved from the server.

ImapUseProtocolDefaults

Optional

System.Boolean

This parameter specifies whether to use protocol defaults for the IMAP4 protocol.

Instance

Optional

Microsoft.Exchange.Data.Directory.Management.CASMailbox

This parameter specifies an instance of a Client Access server.

MAPIBlockOutlookNonCachedMode

Optional

System.Boolean

This parameter specifies whether Outlook can be used in online mode.

MAPIBlockOutlookRpcHttp

Optional

System.Boolean

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

MAPIBlockOutlookVersions

Optional

System.String

This parameter specifies whether certain versions of Outlook are blocked.

MAPIEnabled

Optional

System.Boolean

This parameter specifies whether the MAPI protocol is enabled for the mailbox.

Name

Optional

System.String

This parameter specifies the name of the mailbox.

OWAActiveSyncIntegrationEnabled

Optional

System.Nullable

This parameter specifies whether Outlook Web Access Exchange ActiveSync mobile options are enabled.

OWAAllAddressListsEnabled

Optional

System.Nullable

This parameter specifies whether all address lists are available in Outlook Web Access.

OWACalendarEnabled

Optional

System.Nullable

This parameter specifies whether calendaring is enabled in Outlook Web Access.

OWAChangePasswordEnabled

Optional

System.Nullable

This parameter specifies whether a user can change their password in Outlook Web Access.

OWAContactsEnabled

Optional

System.Nullable

This parameter specifies whether contacts are enabled in Outlook Web Access.

OWAEnabled

Optional

System.Boolean

This parameter enables Outlook Web Access.

OWAJournalEnabled

Optional

System.Nullable

This parameter specifies whether the Journal folder can be accessed in Outlook Web Access.

OWAJournalEnabled

Optional

System.Nullable

This parameter specifies whether journaling is enabled in Outlook Web Access.

OWAJunkEmailEnabled

Optional

System.Nullable

This parameter specifies whether management of junk e-mail is enabled in Outlook Web Access.

OWANotesEnabled

Optional

System.Nullable

This parameter specifies whether Sticky Notes are enabled in Outlook Web Access.

OWAPremiumClientEnabled

Optional

System.Nullable

This parameter specifies whether the Outlook Web Access Premium version is enabled.

OWARemindersAndNotificationsEnabled

Optional

System.Nullable

This parameter specifies whether calendar reminders are enabled in Outlook Web Access.

OWASearchFoldersEnabled

Optional

System.Nullable

This parameter specifies whether search folders are enabled in Outlook Web Access.

OWASignaturesEnabled

Optional

System.Nullable

This parameter specifies whether the signature feature is enabled in Outlook Web Access.

OWASpellCheckerEnabled

Optional

System.Nullable

This parameter specifies whether the spelling checker is enabled in Outlook Web Access.

OWATasksEnabled

Optional

System.Nullable

This parameter specifies whether tasks are enabled in Outlook Web Access.

OWAThemeSelectionEnabled

Optional

System.Nullable

This parameter specifies whether theme selection is enabled in Outlook Web Access.

OWAUMIntegrationEnabled

Optional

System.Nullable

This parameter specifies whether Unified Messaging (UM) integration is enabled in Outlook Web Access.

OWAUNCAccessOnPrivateComputersEnabled

Optional

System.Nullable

This parameter specifies whether access to Windows file shares is permitted when users select This is a private computer on the Outlook Web Access logon page.

OWAUNCAccessOnPublicComputersEnabled

Optional

System.Nullable

This parameter specifies whether access to Windows file shares is permitted when users select This is a public or shared computer on the Outlook Web Access logon page.

OWAWSSAccessOnPrivateComputersEnabled

Optional

System.Nullable

This parameter specifies whether Windows SharePoint Services access is permitted when users select This is a private computer on the Outlook Web Access logon page.

OWAWSSAccessOnPublicComputersEnabled

Optional

System.Nullable

This parameter specifies whether Windows SharePoint Services access is permitted when users select This is a public or shared computer on the Outlook Web Access logon page.

PopEnabled

Optional

System.Boolean

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

PopMessagesRetrievalMimeFormat

Optional

Microsoft.Exchange.Data.Directory.SystemConfiguration.MimeTextFormat

This parameter specifies the format of messages that are retrieved from the server.

PopUseProtocolDefaults

Optional

System.Boolean

This parameter specifies whether to use protocol defaults for the POP3 protocol.

PrimarySmtpAddress

Optional

Microsoft.Exchange.Data.SmtpAddress

This parameter specifies the primary SMTP address that is associated with the mailbox.

ProtocolSettings

Optional

Microsoft.Exchange.Data.MultiValuedProperty

This parameter specifies the protocol settings.

SamAccountName

Optional

System.String

This parameter specifies the security account name.

 

Error Description

 

 

 

Exceptions Description

 

 

The following code example enables the change password user interface in Outlook Web Access and enables POP3 for the user adam@contoso.com.

Set-CASMailbox -identity adam@contoso.com -OWATasksEnabled:$true  -POPEnabled:$true
 
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft