Share via

Exchange 2007 Provider::SetCASMailbox

  • Article

This method sets CAS mailbox data.

Arguments

Input Arguments Required Description

<Identity>

Yes

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.

<preferredDomainController>

Yes

The domain controller to use for Active Directory actions.

<primarySmtpAddress>

No

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

< imapEnabled>

No

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

<mapiEnabled>

No

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

<owaEnabled>

No

This parameter enables Outlook Web Access.

<popEnabled>

No

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

<activeSyncAllowedDeviceIDs>

No

A list of device IDs that are allowed to synchronize with the mailbox.

<activeSyncAllowedDeviceIDs/ value>

No

The device ID that is allowed to synchronize with the mailbox.

<activeSyncDebugLogging>

No

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

<activeSyncEnabled>

No

This parameter enables or disables Exchange ActiveSync.

<activeSyncMailboxPolicy>

No

This parameter specifies whether an Exchange ActiveSync mailbox policy is applied for the mailbox.

<hasActiveSyncDevicePartnership>

No

This parameter specifies whether the mailbox has a mobile device partnership established.

<imapMessagesRetrievalMimeFormat>

No

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

  • BestBodyFormat

  • HtmlAndTextAlternative

  • HtmlOnly

  • TextEnrichedOnly

  • TextOnly

  • TextEnrichedAndTextAlternative

<imapUseProtocolDefaults>

No

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

< mapiBlockOutlookNonCachedMode>

No

This parameter specifies whether Outlook can be used in non-cached mode.

<mapiBlockOutlookRpcHttp>

No

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

< mapiBlockOutlookVersions>

No

This parameter specifies versions of Outlook that are blocked.

<mapiBlockOutlookVersions/ value>

No

One or more versions of MAPI client versions, in the format X.Y.Z (see How to disable MAPI client access to a computer that is running Exchange Server).

<owaActiveSyncIntegrationEnabled>

No

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

<owaAllAddressListsEnabled>

No

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

<owaCalendarEnabled>

No

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

<owaChangePasswordEnabled>

No

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

<owaContactsEnabled>

No

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

<owaJournalEnabled>

No

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

<owaJunkEmailEnabled>

No

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

<owaNotesEnabled>

No

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

<owaPremiumClientEnabled>

No

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

<owaRemindersAndNotificationsEnabled>

No

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

<owaSearchFoldersEnabled>

No

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

<owaSignaturesEnabled>

No

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

<owaSpellCheckerEnabled>

No

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

<owaTasksEnabled>

No

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

<owaThemeSelectionEnabled>

No

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

<owaUMIntegrationEnabled>

No

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

<owaUNCAccessOnPrivateComputersEnabled>

No

This parameter specifies whether Universal Naming Convention (UNC) access is permitted when users select This is a private computer on the logon page.

<owaUNCAccessOnPublicComputersEnabled>

No

This parameter specifies whether UNC access is permitted when users select This is a public or shared computer on the logon page.

<owaWSSAccessOnPrivateComputersEnabled>

No

This parameter specifies whether SharePoint Portal Server access is permitted when users select This is a private computer on the logon page.

<owaWSSAccessOnPublicComputersEnabled>

No

This parameter specifies whether SharePoint Portal Server access is permitted when users select This is a public or shared computer on the logon page.

<popMessagesRetrievalMimeFormat>

No

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

  • BestBodyFormat

  • HtmlAndTextAlternative

  • HtmlOnly

  • TextEnrichedOnly

  • TextOnly

  • TextEnrichedAndTextAlternative

<popUseProtocolDefaults>

No

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

<owaPublicFoldersEnabled>

No

This parameter specifies whether the viewing of public folders is enabled in Outlook Web Access.

<owaRecoverDeletedItemsEnabled>

No

This parameter specifies whether recovery of deleted items is enabled in Outlook Web Access.

<owaRulesEnabled>

No

This parameter specifies whether rules can be accessed in Outlook Web Access. If this parameter is set to false, server rules will continue to function, but cannot be modified in Outlook Web Access.

<owaSMimeEnabled>

No

This parameter specifies whether viewing of e-mail that is encrypted by using S/MIME is supported in Outlook Web Access.

Schema Defination

Request

<executeData>  
<preferredDomainController>1..1 </preferredDomainController> 
<identity>1..1 </identity> 
<primarySmtpAddress>0..1 </primarySmtpAddress> 
<activeSyncEnabled>0..1 </activeSyncEnabled> 
<activeSyncAllowedDeviceIDs>0..1  
<value>0..unbounded </value> 
</activeSyncAllowedDeviceIDs> 
<activeSyncDebugLogging>0..1 </activeSyncDebugLogging> 
<activeSyncMailboxPolicy>0..1 </activeSyncMailboxPolicy> 
<hasActiveSyncDevicePartnership>0..1 </hasActiveSyncDevicePartnership> 
<imapEnabled>0..1 </imapEnabled> 
<imapMessagesRetrievalMimeFormat>0..1 </imapMessagesRetrievalMimeFormat> 
<imapUseProtocolDefaults>0..1 </imapUseProtocolDefaults> 
<mapiEnabled>0..1 </mapiEnabled> 
<mapiBlockOutlookNonCachedMode>0..1 </mapiBlockOutlookNonCachedMode> 
<mapiBlockOutlookRpcHttp>0..1 </mapiBlockOutlookRpcHttp> 
<mapiBlockOutlookVersions>0..1  
<value>0..unbounded </value> 
</mapiBlockOutlookVersions> 
<owaEnabled>0..1 </owaEnabled> 
<owaActiveSyncIntegrationEnabled>0..1 </owaActiveSyncIntegrationEnabled> 
<owaAllAddressListsEnabled>0..1 </owaAllAddressListsEnabled> 
<owaCalendarEnabled>0..1 </owaCalendarEnabled> 
<owaChangePasswordEnabled>0..1 </owaChangePasswordEnabled> 
<owaContactsEnabled>0..1 </owaContactsEnabled> 
<owaJournalEnabled>0..1 </owaJournalEnabled> 
<owaJunkEmailEnabled>0..1 </owaJunkEmailEnabled> 
<owaNotesEnabled>0..1 </owaNotesEnabled> 
<owaPremiumClientEnabled>0..1 </owaPremiumClientEnabled> 
<owaRemindersAndNotificationsEnabled>0..1 </owaRemindersAndNotificationsEnabled> 
<owaSearchFoldersEnabled>0..1 </owaSearchFoldersEnabled> 
<owaSignaturesEnabled>0..1 </owaSignaturesEnabled> 
<owaSpellCheckerEnabled>0..1 </owaSpellCheckerEnabled> 
<owaTasksEnabled>0..1 </owaTasksEnabled> 
<owaThemeSelectionEnabled>0..1 </owaThemeSelectionEnabled> 
<owaUMIntegrationEnabled>0..1 </owaUMIntegrationEnabled> 
<owaUNCAccessOnPrivateComputersEnabled>0..1 </owaUNCAccessOnPrivateComputersEnabled> 
<owaUNCAccessOnPublicComputersEnabled>0..1 </owaUNCAccessOnPublicComputersEnabled> 
<owaWSSAccessOnPrivateComputersEnabled>0..1 </owaWSSAccessOnPrivateComputersEnabled> 
<owaWSSAccessOnPublicComputersEnabled>0..1 </owaWSSAccessOnPublicComputersEnabled> 
<popEnabled>0..1 </popEnabled> 
<popMessagesRetrievalMimeFormat>0..1 </popMessagesRetrievalMimeFormat> 
<popUseProtocolDefaults>0..1 </popUseProtocolDefaults> 
<owaPublicFoldersEnabled>0..1 </owaPublicFoldersEnabled> 
<owaRecoverDeletedItemsEnabled>0..1 </owaRecoverDeletedItemsEnabled> 
<owaRulesEnabled>0..1 </owaRulesEnabled> 
<owaSMimeEnabled>0..1 </owaSMimeEnabled> 
</executeData>

Response

<executeData>1..1 </executeData>

Remarks

Security

The caller must be at least a member of role: userCreators.

Sample Code

Example XML Request

<request> 
  <data> 
    <!--The domain controller to use for Active Directory actions.--> 
    <preferredDomainController>AD01.Fabrikam.Com</preferredDomainController> 
    <!--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.--> 
    <identity>LDAP://CN=johnc@alpineskihouse.com,OU=AlpineSkiHouse,OU=ConsolidatedMessenger,OU=Hosting,DC=fabrikam,DC=com</identity> 
    <!--Specifies the primary SMTP e-mail address that is associated with the mailbox.--> 
    <primarySmtpAddress>johnc@AlpineSkiHouse.com</primarySmtpAddress> 
    <!--This parameter enables or disables Exchange ActiveSync.--> 
    <activeSyncEnabled>false</activeSyncEnabled> 
    <!--A list of device IDs that are allowed to synchronize with the mailbox.--> 
    <activeSyncAllowedDeviceIDs> 
      <!--Device ID that is allowed to synchronize with the mailbox.--> 
      <value>someID</value> 
    </activeSyncAllowedDeviceIDs> 
    <!--Specifies whether error logging is enabled for mobile devices.--> 
    <activeSyncDebugLogging>2</activeSyncDebugLogging> 
    <!--Specifies whether an Exchange ActiveSync mailbox policy is applied for the mailbox.--> 
    <activeSyncMailboxPolicy>SalesMobilePolicy</activeSyncMailboxPolicy> 
    <!--Specifies whether the mailbox has a mobile device partnership established.--> 
    <hasActiveSyncDevicePartnership>true</hasActiveSyncDevicePartnership> 
    <!--Specifies whether the IMAP4 protocol is enabled for this mailbox.--> 
    <imapEnabled>false</imapEnabled> 
    <!--Specifies the format of messages that are retrieved from the server.--> 
    <imapMessagesRetrievalMimeFormat>TextOnly</imapMessagesRetrievalMimeFormat> 
    <!--Specifies whether to use protocol defaults for the IMAP4 protocol.--> 
    <imapUseProtocolDefaults>false</imapUseProtocolDefaults> 
    <!--Specifies whether the MAPI protocol is enabled for this mailbox.--> 
    <mapiEnabled>false</mapiEnabled> 
    <!--Specifies whether Outlook can be used in non-cached mode.--> 
    <mapiBlockOutlookNonCachedMode>false</mapiBlockOutlookNonCachedMode> 
    <!--Specifies whether clients can connect to Outlook by using Outlook Anywhere.--> 
    <mapiBlockOutlookRpcHttp>false</mapiBlockOutlookRpcHttp> 
    <!--Specifies versions of Outlook that are blocked.--> 
    <mapiBlockOutlookVersions> 
      <!--One or more versions of MAPI client versions, in thhe format X.Y.Z (see https://support.microsoft.com/?kbid=288894).--> 
      <value>5.43.222</value> 
    </mapiBlockOutlookVersions> 
    <!--Enables Outlook Web Access.--> 
    <owaEnabled>false</owaEnabled> 
    <!--Specifies whether Outlook Web Access Exchange ActiveSync mobile options are enabled.--> 
    <owaActiveSyncIntegrationEnabled>false</owaActiveSyncIntegrationEnabled> 
    <!--Specifies whether all address lists are available in Outlook Web Access.--> 
    <owaAllAddressListsEnabled>false</owaAllAddressListsEnabled> 
    <!--Specifies whether calendaring is enabled in Outlook Web Access.--> 
    <owaCalendarEnabled>false</owaCalendarEnabled> 
    <!--Specifies whether a user can change their password in Outlook Web Access.--> 
    <owaChangePasswordEnabled>false</owaChangePasswordEnabled> 
    <!--Specifies whether contacts are enabled in Outlook Web Access.--> 
    <owaContactsEnabled>false</owaContactsEnabled> 
    <!--Specifies whether the Journal folder can be accessed in Outlook Web Access.--> 
    <owaJournalEnabled>false</owaJournalEnabled> 
    <!--Specifies whether junk e-mail is enabled in Outlook Web Access.--> 
    <owaJunkEmailEnabled>false</owaJunkEmailEnabled> 
    <!--Specifies whether Sticky Notes are enabled in Outlook Web Access.--> 
    <owaNotesEnabled>false</owaNotesEnabled> 
    <!--Specifies whether Outlook Web Access Premium version is enabled.--> 
    <owaPremiumClientEnabled>false</owaPremiumClientEnabled> 
    <!--Specifies whether calendar reminders are enabled in Outlook Web Access.--> 
    <owaRemindersAndNotificationsEnabled>false</owaRemindersAndNotificationsEnabled> 
    <!--Specifies whether search folders are enabled in Outlook Web Access.--> 
    <owaSearchFoldersEnabled>false</owaSearchFoldersEnabled> 
    <!--Specifies whether the signature feature is enabled in Outlook Web Access.--> 
    <owaSignaturesEnabled>false</owaSignaturesEnabled> 
    <!--Specifies whether the spelling checker is enabled in Outlook Web Access.--> 
    <owaSpellCheckerEnabled>false</owaSpellCheckerEnabled> 
    <!--Specifies whether tasks are enabled in Outlook Web Access.--> 
    <owaTasksEnabled>false</owaTasksEnabled> 
    <!--Specifies whether theme selection is enabled in Outlook Web Access.--> 
    <owaThemeSelectionEnabled>false</owaThemeSelectionEnabled> 
    <!--Specifies whether Unified Messaging (UM) integration is enabled in Outlook Web Access.--> 
    <owaUMIntegrationEnabled>false</owaUMIntegrationEnabled> 
    <!--Specifies whether Universal Naming Convention (UNC) access is permitted when users select This is a private computer on the logon page.--> 
    <owaUNCAccessOnPrivateComputersEnabled>false</owaUNCAccessOnPrivateComputersEnabled> 
    <!--Specifies whether UNC access is permitted when users select This is a public or shared computer on the logon page.--> 
    <owaUNCAccessOnPublicComputersEnabled>false</owaUNCAccessOnPublicComputersEnabled> 
    <!--Specifies whether SharePoint Portal Server access is permitted when users select This is a private computer on the logon page.--> 
    <owaWSSAccessOnPrivateComputersEnabled>false</owaWSSAccessOnPrivateComputersEnabled> 
    <!--Specifies whether SharePoint Portal Server access is permitted when users select This is a public or shared computer on the logon page.--> 
    <owaWSSAccessOnPublicComputersEnabled>false</owaWSSAccessOnPublicComputersEnabled> 
    <!--Specifies whether the POP3 protocol is enabled for this mailbox.--> 
    <popEnabled>false</popEnabled> 
    <!--Specifies the format of messages that are retrieved from the server.--> 
    <popMessagesRetrievalMimeFormat>HtmlAndTextAlternative</popMessagesRetrievalMimeFormat> 
    <!--Specifies whether to use protocol defaults for the POP3 protocol.--> 
    <popUseProtocolDefaults>false</popUseProtocolDefaults> 
    <!--Specifies whether the viewing of public folders is enabled in Outlook Web Access.--> 
    <owaPublicFoldersEnabled>true</owaPublicFoldersEnabled> 
    <!--Specifies whether recovery of deleted items is enabled in Outlook Web Access.--> 
    <owaRecoverDeletedItemsEnabled>true</owaRecoverDeletedItemsEnabled> 
    <!--Specifies whether rules can be accessed in Outlook Web Access. If this parameter is set to false, server rules will continue to function, but cannot be modified in Outlook Web Access.--> 
    <owaRulesEnabled>true</owaRulesEnabled> 
    <!--Specifies whether viewing of e-mail that is encrypted by using S/MIME is supported in Outlook Web Access.--> 
    <owaSMimeEnabled>true</owaSMimeEnabled> 
  </data> 
  <procedure> 
    <execute namespace="Exchange 2007 Provider" procedure="SetCASMailbox" impersonate="1"> 
      <before source="data" sourcePath="preferredDomainController" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="identity" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="primarySmtpAddress" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="activeSyncEnabled" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="activeSyncAllowedDeviceIDs" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="activeSyncDebugLogging" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="activeSyncMailboxPolicy" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="hasActiveSyncDevicePartnership" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="imapEnabled" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="imapMessagesRetrievalMimeFormat" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="imapUseProtocolDefaults" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="mapiEnabled" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="mapiBlockOutlookNonCachedMode" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="mapiBlockOutlookRpcHttp" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="mapiBlockOutlookVersions" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="owaEnabled" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="owaActiveSyncIntegrationEnabled" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="owaAllAddressListsEnabled" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="owaCalendarEnabled" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="owaChangePasswordEnabled" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="owaContactsEnabled" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="owaJournalEnabled" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="owaJunkEmailEnabled" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="owaNotesEnabled" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="owaPremiumClientEnabled" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="owaRemindersAndNotificationsEnabled" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="owaSearchFoldersEnabled" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="owaSignaturesEnabled" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="owaSpellCheckerEnabled" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="owaTasksEnabled" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="owaThemeSelectionEnabled" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="owaUMIntegrationEnabled" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="owaUNCAccessOnPrivateComputersEnabled" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="owaUNCAccessOnPublicComputersEnabled" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="owaWSSAccessOnPrivateComputersEnabled" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="owaWSSAccessOnPublicComputersEnabled" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="popEnabled" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="popMessagesRetrievalMimeFormat" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="popUseProtocolDefaults" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="owaPublicFoldersEnabled" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="owaRecoverDeletedItemsEnabled" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="owaRulesEnabled" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="owaSMimeEnabled" destination="executeData" mode="move" /> 
      <after source="executeData" destination="data" mode="merge" /> 
    </execute> 
  </procedure> 
</request>

Applies To

Exchange 2007 Provider Namespace for:

  • Hosted Messaging and Collaboration version 4.5

  • Hosted Messaging and Collaboration version 4.0

See also

Tasks

Managed Email 2007::DeleteSMTPDomain
Hosted Email 2007::DeleteSMTPDomain
Hosted Email 2007::CreateConsumerVanityDomain
Hosted Email 2007::GetOrganizationDomains
Exchange 2007 Provider::GetCASMailbox