Hosted Email 2007::ChangeUserPlanAssignment

This procedure changes the plan assigned to a user by specifying a new plan.

Note

This procedure is used to change the plan assigned to a user. When it is used to modify an user's mailbox size while the current mail store does not have sufficiently unallocated storage, it will find a new available mail store with sufficient space and update the tenant's organization allocation. However, this procedure does not actually move the user mailbox. Callers need to manually move the user mailbox to the new mail store using Exchange 2007 supported methods. Otherwise, the user mailbox will not be able to grow although new space is allocated for the user.

Arguments

Input Arguments Type Required Description

<preferredDomainController>

string

Yes

The domain controller to use for Active Directory actions.

<user>

string

Yes

The Lightweight Directory Access Protocol (LDAP) path of the user.

<planName>

string

Yes

The Exchange Hosting Plan to apply to the user.

<planOverrides>

string

No

The parameter is used to override default values supplied by plan

<planOverrides/ issueWarningQuota>

string

No

The parameter specifies the mailbox size in bytes at which a warning message is sent to the user. You must specify either an integer or "unlimited." If you set this attribute on a mailbox, that mailbox setting overrides the value that is set for this attribute on the mailbox database.

<planOverrides/ maxSendSize>

string

No

The parameter specifies the maximum size of messages that this mailbox can send. You must specify either an integer or "unlimited."

<planOverrides/ maxReceiveSize>

string

No

The parameter specifies the maximum size in bytes of messages that this mailbox can receive. You must specify either an integer or "unlimited."

<planOverrides/ prohibitSendQuota>

string

No

The parameter specifies the mailbox size in bytes at which the user associated with this mailbox can no longer send messages. You must specify a positive integer between '1000' and '2,147,483,647'. If you set this attribute on a mailbox, that mailbox setting overrides the value that is set for this attribute on the mailbox database.

<planOverrides/ prohibitSendReceiveQuota>

string

No

The parameter specifies the mailbox size in bytes at which the user associated with this mailbox can no longer send or receive messages. You must specify either an integer or "unlimited." If you set this attribute on a mailbox, that mailbox setting overrides the value that is set for this attribute on the mailbox database.

<planOverrides/ recipientLimits>

string

No

The parameter specifies the maximum number of recipients per message to which this mailbox can send. You must specify either an integer or "unlimited." If you set this attribute on a mailbox, that mailbox setting overrides the value that is set for this attribute on the mailbox database.

<planOverrides/ hiddenFromAddressListsEnabled>

boolean

No

The parameter specifies whether this mailbox is hidden from other address lists.

<planOverrides/ imapEnabled>

boolean

No

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

<planOverrides/ popEnabled>

boolean

No

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

<planOverrides/ owaEnabled>

boolean

No

The parameter enables Outlook Web Access.

<planOverrides/ mapiEnabled>

boolean

No

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

<planOverrides/ activeSyncEnabled >

boolean

No

The parameter specifies whether the ActiveSync is enabled for this mailbox.

<planOverrides/ mapiBlockOutlookNonCachedMode>

string

No

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

<planOverrides/ mapiBlockOutlookRpcHttp>

string

No

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

<planOverrides/ owaAllAddressListsEnabled>

boolean

No

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

<planOverrides/ owaCalendarEnabled>

boolean

No

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

<planOverrides/ owaContactsEnabled>

boolean

No

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

<planOverrides/ owaChangePasswordEnabled>

boolean

No

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

<planOverrides/ owaJournalEnabled>

boolean

No

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

<planOverrides/ owaTasksEnabled>

boolean

No

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

<planOverrides/ owaNotesEnabled>

boolean

No

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

<planOverrides/ owaRemindersAndNotificationsEnabled>

boolean

No

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

<planOverrides/ owaPremiumClientEnabled>

boolean

No

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

<planOverrides/ owaSpellCheckerEnabled>

boolean

No

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

<planOverrides/ owaSearchFoldersEnabled>

boolean

No

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

<planOverrides/ owaSignaturesEnabled>

boolean

No

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

<planOverrides/ owaThemeSelectionEnabled>

boolean

No

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

<planOverrides/ owaJunkEmailEnabled>

boolean

No

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

<planOverrides/ owaUMIntegrationEnabled>

boolean

No

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

<planOverrides/ owaActiveSyncIntegrationEnabled>

boolean

No

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

<planOverrides/ owaUNCAccessOnPrivateComputersEnabled>

boolean

No

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

<planOverrides/ owaUNCAccessOnPublicComputersEnabled>

boolean

No

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

<planOverrides/ owaWSSAccessOnPrivateComputersEnabled>

boolean

No

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

<planOverrides/ owaWSSAccessOnPublicComputersEnabled>

boolean

No

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

<planOverrides / mapiBlockOutlookVersions>

string

No

The parameter specifies versions of Outlook that are blocked.

<planOverrides/ mapiBlockOutlookVersions/ value>

string

Yes

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

<planOverrides/ owaPublicFoldersEnabled>

boolean

No

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

<planOverrides/ owaRecoverDeletedItemsEnabled>

boolean

No

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

<planOverrides/ owaRulesEnabled>

boolean

No

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

<planOverrides/ owaSMimeEnabled>

boolean

No

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

Remarks

Security

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

Schema Definition

Input

<executeData>  
        <user>1..1 </user> 
        <preferredDomainController>1..1 </preferredDomainController> 
        <planName>1..1 </planName> 
        <planOverrides>0..1  
                <issueWarningQuota>0..1 </issueWarningQuota> 
                <maxSendSize>0..1 </maxSendSize> 
                <maxReceiveSize>0..1 </maxReceiveSize> 
                <prohibitSendQuota>0..1 </prohibitSendQuota> 
                <prohibitSendReceiveQuota>0..1 </prohibitSendReceiveQuota> 
                <recipientLimits>0..1 </recipientLimits> 
                <hiddenFromAddressListsEnabled>0..1 </hiddenFromAddressListsEnabled> 
                <imapEnabled>0..1 </imapEnabled> 
                <popEnabled>0..1 </popEnabled> 
                <owaEnabled>0..1 </owaEnabled> 
                <mapiEnabled>0..1 </mapiEnabled> 
                <activeSyncEnabled>0..1 </activeSyncEnabled> 
                <mapiBlockOutlookNonCachedMode>0..1 </mapiBlockOutlookNonCachedMode> 
                <mapiBlockOutlookRpcHttp>0..1 </mapiBlockOutlookRpcHttp> 
                <mapiBlockOutlookVersions>0..1  
        <value>1..unbounded </value> 
                </mapiBlockOutlookVersions> 
                <owaAllAddressListsEnabled>0..1 </owaAllAddressListsEnabled> 
                <owaContactsEnabled>0..1 </owaContactsEnabled> 
                <owaCalendarEnabled>0..1 </owaCalendarEnabled> 
                <owaChangePasswordEnabled>0..1 </owaChangePasswordEnabled> 
                <owaJournalEnabled>0..1 </owaJournalEnabled> 
                <owaTasksEnabled>0..1 </owaTasksEnabled> 
                <owaNotesEnabled>0..1 </owaNotesEnabled> 
                <owaRemindersAndNotificationsEnabled>0..1 </owaRemindersAndNotificationsEnabled> 
                <owaPremiumClientEnabled>0..1 </owaPremiumClientEnabled> 
                <owaSpellCheckerEnabled>0..1 </owaSpellCheckerEnabled> 
                <owaSearchFoldersEnabled>0..1 </owaSearchFoldersEnabled> 
                <owaSignaturesEnabled>0..1 </owaSignaturesEnabled> 
                <owaThemeSelectionEnabled>0..1 </owaThemeSelectionEnabled> 
                <owaJunkEmailEnabled>0..1 </owaJunkEmailEnabled> 
                <owaUMIntegrationEnabled>0..1 </owaUMIntegrationEnabled> 
                <owaActiveSyncIntegrationEnabled>0..1 </owaActiveSyncIntegrationEnabled> 
                <owaUNCAccessOnPrivateComputersEnabled>0..1 </owaUNCAccessOnPrivateComputersEnabled> 
                <owaUNCAccessOnPublicComputersEnabled>0..1 </owaUNCAccessOnPublicComputersEnabled> 
                <owaWSSAccessOnPrivateComputersEnabled>0..1 </owaWSSAccessOnPrivateComputersEnabled> 
                <owaWSSAccessOnPublicComputersEnabled>0..1 </owaWSSAccessOnPublicComputersEnabled> 
                <owaPublicFoldersEnabled>0..1 </owaPublicFoldersEnabled> 
                <owaRecoverDeletedItemsEnabled>0..1 </owaRecoverDeletedItemsEnabled> 
                <owaRulesEnabled>0..1 </owaRulesEnabled> 
                <owaSMimeEnabled>0..1 </owaSMimeEnabled> 
        </planOverrides> 
</executeData> 

Output

<executeData>1..1 </executeData>

Sample Code

Example XML Request

<request> 
  <data> 
    <!--LDAP path of the user.--> 
    <user>LDAP://CN=Johnc@AlpineSkiHouse.com,OU=AlpineSkiHouse,OU=ConsolidatedMessenger,OU=Hosting,DC=Fabrikam,DC=Com</user> 
    <!--The domain controller to use for Active Directory actions.--> 
    <preferredDomainController>AD01.Fabrikam.Com</preferredDomainController> 
    <!--The Exchange Hosting Plan to apply to the user.--> 
    <planName>GoldMailbox</planName> 
    <!--Used to override default values supplied by plan--> 
    <planOverrides> 
      <!--Specifies the mailbox size in bytes at which a warning message is sent to the user.  You must specify either an integer or "unlimited."  If you set this attribute on a mailbox, that mailbox setting overrides the value that is set for this attribute on the mailbox database.--> 
      <issueWarningQuota>9000</issueWarningQuota> 
      <!--Specifies the maximum size of messages that this mailbox can send. You must specify either an integer or "unlimited."--> 
      <maxSendSize>10000</maxSendSize> 
      <!--Specifies the maximum size of messages that this mailbox can receive. You must specify either an integer or "unlimited."--> 
      <maxReceiveSize>10000</maxReceiveSize> 
      <!--Specifies the mailbox size in bytes at which the user associated with this mailbox can no longer send messages.  You must specify a positive integer.  If you set this attribute on a mailbox, that mailbox setting overrides the value that is set for this attribute on the mailbox database.--> 
      <prohibitSendQuota>10000</prohibitSendQuota> 
      <!--Specifies the mailbox size in bytes at which the user associated with this mailbox can no longer send or receive messages.  You must specify either an integer or "unlimited."  If you set this attribute on a mailbox, that mailbox setting overrides the value that is set for this attribute on the mailbox database.--> 
      <prohibitSendReceiveQuota>20000</prohibitSendReceiveQuota> 
      <!--Specifies the maximum number of recipients per message to which this mailbox can send.  You must specify either an integer or "unlimited."  If you set this attribute on a mailbox, that mailbox setting overrides the value that is set for this attribute on the mailbox database.--> 
      <recipientLimits>unlimited</recipientLimits> 
      <!--Specifies whether this mailbox is hidden from other address lists.--> 
      <hiddenFromAddressListsEnabled>true</hiddenFromAddressListsEnabled> 
      <!--Specifies whether the IMAP4 protocol is enabled for this mailbox.--> 
      <imapEnabled>true</imapEnabled> 
      <!--Specifies whether the POP3 protocol is enabled for this mailbox.--> 
      <popEnabled>true</popEnabled> 
      <!--Enables Outlook Web Access.--> 
      <owaEnabled>true</owaEnabled> 
      <!--Specifies whether the MAPI protocol is enabled for this mailbox.--> 
      <mapiEnabled>true</mapiEnabled> 
      <!--Specifies whether ActiveSync is enabled for this mailbox.--> 
      <activeSyncEnabled>true</activeSyncEnabled> 
      <!--Specifies whether Outlook can be used in non-cached mode.--> 
      <mapiBlockOutlookNonCachedMode>true</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> 
      <!--Specifies whether all address lists are available in Outlook Web Access.--> 
      <owaAllAddressListsEnabled>false</owaAllAddressListsEnabled> 
      <!--Specifies whether contacts are enabled in Outlook Web Access.--> 
      <owaContactsEnabled>true</owaContactsEnabled> 
      <!--Specifies whether calendaring is enabled in Outlook Web Access.--> 
      <owaCalendarEnabled>true</owaCalendarEnabled> 
      <!--Specifies whether a user can change their password in Outlook Web Access.--> 
      <owaChangePasswordEnabled>false</owaChangePasswordEnabled> 
      <!--Specifies whether the Journal folder can be accessed in Outlook Web Access.--> 
      <owaJournalEnabled>true</owaJournalEnabled> 
      <!--Specifies whether tasks are enabled in Outlook Web Access.--> 
      <owaTasksEnabled>true</owaTasksEnabled> 
      <!--Specifies whether Sticky Notes are enabled in Outlook Web Access.--> 
      <owaNotesEnabled>true</owaNotesEnabled> 
      <!--Specifies whether calendar reminders are enabled in Outlook Web Access.--> 
      <owaRemindersAndNotificationsEnabled>true</owaRemindersAndNotificationsEnabled> 
      <!--Specifies whether Outlook Web Access Premium version is enabled.--> 
      <owaPremiumClientEnabled>true</owaPremiumClientEnabled> 
      <!--Specifies whether the spelling checker is enabled in Outlook Web Access.--> 
      <owaSpellCheckerEnabled>true</owaSpellCheckerEnabled> 
      <!--Specifies whether search folders are enabled in Outlook Web Access.--> 
      <owaSearchFoldersEnabled>true</owaSearchFoldersEnabled> 
      <!--Specifies whether the signature feature is enabled in Outlook Web Access.--> 
      <owaSignaturesEnabled>true</owaSignaturesEnabled> 
      <!--Specifies whether theme selection is enabled in Outlook Web Access.--> 
      <owaThemeSelectionEnabled>true</owaThemeSelectionEnabled> 
      <!--Specifies whether junk e-mail is enabled in Outlook Web Access.--> 
      <owaJunkEmailEnabled>true</owaJunkEmailEnabled> 
      <!--Specifies whether Unified Messaging (UM) integration is enabled in Outlook Web Access.--> 
      <owaUMIntegrationEnabled>true</owaUMIntegrationEnabled> 
      <!--Specifies whether Outlook Web Access Exchange ActiveSync mobile options are enabled.--> 
      <owaActiveSyncIntegrationEnabled>true</owaActiveSyncIntegrationEnabled> 
      <!--Specifies whether Universal Naming Convention (UNC) access is permitted when users select This is a private computer on the logon page.--> 
      <owaUNCAccessOnPrivateComputersEnabled>true</owaUNCAccessOnPrivateComputersEnabled> 
      <!--Specifies whether UNC access is permitted when users select This is a public or shared computer on the logon page.--> 
      <owaUNCAccessOnPublicComputersEnabled>true</owaUNCAccessOnPublicComputersEnabled> 
      <!--Specifies whether SharePoint Portal Server access is permitted when users select This is a private computer on the logon page.--> 
      <owaWSSAccessOnPrivateComputersEnabled>true</owaWSSAccessOnPrivateComputersEnabled> 
      <!--Specifies whether SharePoint Portal Server access is permitted when users select This is a public or shared computer on the logon page.--> 
      <owaWSSAccessOnPublicComputersEnabled>true</owaWSSAccessOnPublicComputersEnabled> 
      <!--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> 
    </planOverrides> 
  </data> 
  <procedure> 
    <execute namespace="Hosted Email 2007" procedure="ChangeUserPlanAssignment" impersonate="1"> 
      <before source="data" sourcePath="user" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="preferredDomainController" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="planName" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="planOverrides" destination="executeData" mode="move" /> 
      <after source="executeData" destination="data" mode="merge" /> 
    </execute> 
  </procedure> 
</request>

Example XML Response

<response>  
        <data /> 
</response> 

Applies To

Hosted Email 2007 Namespace for:

  • Hosted Messaging and Collaboration version 4.5

  • Hosted Messaging and Collaboration version 4.0

See also

Tasks

Hosted Email 2007::AddAvailablePlans
Hosted Email 2007::GetUserPlanAssignment
Hosted Email 2007::CreateOrganizationPlan
Hosted Email 2007::CreateUserPlan
Hosted Email 2007::GetOrganizationAvailablePlans
Hosted Email 2007::GetOrganizationPlan
Hosted Email 2007::GetUserPlanAssignment
Hosted Email 2007::GetServiceInformation
Hosted Email 2007::GetUserPlan
Hosted Email 2007::GetUserPlanAssignment
Hosted Email 2007::Initialize
Hosted Email 2007::ModifyOrganizationPlan
Hosted Email 2007::ModifyUserPlan
Hosted Email 2007::RemoveAvailablePlans
Hosted Email 2007::Subscribe
Hosted Email 2007::Unsubscribe