Share via

Managed Email 2007::SetCASMailbox

  • Article

Sets Client Access Server (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

pecifies the primary SMTP e-mail address that is associated with the mailbox.

< imapEnabled>

No

Specifies whether the IMAP4 protocol is enabled for this mailbox.

<mapiEnabled>

No

Specifies whether the MAPI protocol is enabled for this mailbox.

<owaEnabled>

No

Enables Outlook Web Access.

<popEnabled>

No

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

Device ID that is allowed to synchronize with the mailbox.

<activeSyncDebugLogging>

No

Specifies whether error logging is enabled for mobile devices.

<activeSyncEnabled>

No

This parameter enables or disables Exchange ActiveSync.

<activeSyncMailboxPolicy>

No

Specifies whether an Exchange ActiveSync mailbox policy is applied for the mailbox.

<hasActiveSyncDevicePartnership>

No

Specifies whether the mailbox has a mobile device partnership established.

<imapMessagesRetrievalMimeFormat>

No

Specifies the format of messages that are retrieved from the server. Enum

  • TextOnly

  • HtmlOnly

  • HtmlAndTextAlternative

  • TextEnrichedOnly

  • TextEnrichedAndTextAlternative

  • BestBodyFormat

<imapUseProtocolDefaults>

No

Specifies whether to use protocol defaults for the IMAP4 protocol.

< mapiBlockOutlookNonCachedMode>

No

Specifies whether Outlook can be used in non-cached mode.

<mapiBlockOutlookRpcHttp>

No

Specifies whether clients can connect to Outlook by using Outlook Anywhere.

< mapiBlockOutlookVersions>

No

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 https://support.microsoft.com/?kbid=288894).

<owaActiveSyncIntegrationEnabled>

No

Specifies whether Outlook Web Access Exchange ActiveSync mobile options are enabled.

<owaAllAddressListsEnabled>

No

Specifies whether all address lists are available in Outlook Web Access.

<owaCalendarEnabled>

No

Specifies whether calendaring is enabled in Outlook Web Access.

<owaChangePasswordEnabled>

No

Specifies whether a user can change their password in Outlook Web Access.

<owaContactsEnabled>

No

Specifies whether contacts are enabled in Outlook Web Access.

<owaJournalEnabled>

No

Specifies whether the Journal folder can be accessed in Outlook Web Access.

<owaJunkEmailEnabled>

No

Specifies whether junk e-mail is enabled in Outlook Web Access.

<owaNotesEnabled>

No

Specifies whether Sticky Notes are enabled in Outlook Web Access.

<owaPremiumClientEnabled>

No

Specifies whether Outlook Web Access Premium version is enabled.

<owaRemindersAndNotificationsEnabled>

No

Specifies whether calendar reminders are enabled in Outlook Web Access.

<owaSearchFoldersEnabled>

No

Specifies whether search folders are enabled in Outlook Web Access.

<owaSignaturesEnabled>

No

Specifies whether the signature feature is enabled in Outlook Web Access.

<owaSpellCheckerEnabled>

No

Specifies whether the spelling checker is enabled in Outlook Web Access.

<owaTasksEnabled>

No

Specifies whether tasks are enabled in Outlook Web Access.

<owaThemeSelectionEnabled>

No

Specifies whether theme selection is enabled in Outlook Web Access.

<owaUMIntegrationEnabled>

No

Specifies whether Unified Messaging (UM) integration is enabled in Outlook Web Access.

<owaUNCAccessOnPrivateComputersEnabled>

No

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

<owaUNCAccessOnPublicComputersEnabled>

No

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

<owaWSSAccessOnPrivateComputersEnabled>

No

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

<owaWSSAccessOnPublicComputersEnabled>

No

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

<popMessagesRetrievalMimeFormat>

No

Specifies the format of messages that are retrieved from the server. Enum

  • TextOnly

  • HtmlOnly

  • HtmlAndTextAlternative

  • TextEnrichedOnly

  • TextEnrichedAndTextAlternative

  • BestBodyFormat

<popUseProtocolDefaults>

No

Specifies whether to use protocol defaults for the POP3 protocol.

<owaPublicFoldersEnabled>

No

Specifies whether the viewing of public folders is enabled in Outlook Web Access.

<owaRecoverDeletedItemsEnabled>

No

Specifies whether recovery of deleted items is enabled in Outlook Web Access.

<owaRulesEnabled>

No

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

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

Remarks

Security

Caller must be at least a member of role: userCreators.

Schema Definition

Input

<executeData>  
<preferredDomainController>1..1 </preferredDomainController> 
<identity>1..1 </identity> 
<primarySmtpAddress>0..1 </primarySmtpAddress> 
<imapEnabled>0..1 </imapEnabled> 
<mapiEnabled>0..1 </mapiEnabled> 
<owaEnabled>0..1 </owaEnabled> 
<popEnabled>0..1 </popEnabled> 
<activeSyncAllowedDeviceIDs>0..1  
<value>1..unbounded </value> 
</activeSyncAllowedDeviceIDs> 
<activeSyncDebugLogging>0..1 </activeSyncDebugLogging> 
<activeSyncEnabled>0..1 </activeSyncEnabled> 
<activeSyncMailboxPolicy>0..1 </activeSyncMailboxPolicy> 
<hasActiveSyncDevicePartnership>0..1 </hasActiveSyncDevicePartnership> 
<imapMessagesRetrievalMimeFormat>0..1 </imapMessagesRetrievalMimeFormat> 
<imapUseProtocolDefaults>0..1 </imapUseProtocolDefaults> 
<mapiBlockOutlookNonCachedMode>0..1 </mapiBlockOutlookNonCachedMode> 
<mapiBlockOutlookRpcHttp>0..1 </mapiBlockOutlookRpcHttp> 
<mapiBlockOutlookVersions>0..1  
<value>1..unbounded </value> 
</mapiBlockOutlookVersions> 
<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> 
<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>

Output

<executeData>1..1 </executeData>

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> 
    <!--Specifies whether the IMAP4 protocol is enabled for this mailbox.--> 
    <imapEnabled>false</imapEnabled> 
    <!--Specifies whether the MAPI protocol is enabled for this mailbox.--> 
    <mapiEnabled>false</mapiEnabled> 
    <!--Enables Outlook Web Access.--> 
    <owaEnabled>false</owaEnabled> 
    <!--Specifies whether the POP3 protocol is enabled for this mailbox.--> 
    <popEnabled>false</popEnabled> 
    <!--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>someID2</value> 
    </activeSyncAllowedDeviceIDs> 
    <!--Specifies whether error logging is enabled for mobile devices.--> 
    <activeSyncDebugLogging>2</activeSyncDebugLogging> 
    <!--This parameter enables or disables Exchange ActiveSync.--> 
    <activeSyncEnabled>false</activeSyncEnabled> 
    <!--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 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 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.2653.222</value> 
    </mapiBlockOutlookVersions> 
    <!--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 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="Managed Email 2007" 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="imapEnabled" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="mapiEnabled" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="owaEnabled" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="popEnabled" 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="activeSyncEnabled" 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="imapMessagesRetrievalMimeFormat" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="imapUseProtocolDefaults" 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="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="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>

Applies To

  • Hosted Messaging and Collaboration version 4.5

  • Hosted Messaging and Collaboration version 4.0

See also

Other Resources

API Name [HMC SDK]
API Name [HMC SDK]
API Name [HMC SDK]
API Name [HMC SDK]