Hosted Email 2007::CreateUserPlan

This procedure creates a new plan for a user mailbox.

Arguments

Remarks

Modifying the attributes of a plan does not automatically apply these new values to the plan member.

Security

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

Schema Definition

Input

<executeData>  
        <preferredDomainController>1..1 </preferredDomainController> 
        <planName>1..1 </planName> 
        <description>1..1 </description> 
        <features>1..1  
                <prohibitSendQuota>1..1 </prohibitSendQuota> 
                <issueWarningQuota>0..1 </issueWarningQuota> 
                <maxSendSize>0..1 </maxSendSize> 
                <maxReceiveSize>0..1 </maxReceiveSize> 
                <prohibitSendReceiveQuota>0..1 </prohibitSendReceiveQuota> 
                <recipientLimits>0..1 </recipientLimits> 
                <hiddenFromAddressListsEnabled>0..1 </hiddenFromAddressListsEnabled> 
                <imapEnabled>1..1 </imapEnabled> 
                <popEnabled>1..1 </popEnabled> 
                <owaEnabled>1..1 </owaEnabled> 
                <mapiEnabled>1..1 </mapiEnabled> 
                <activeSyncEnabled>0..1 </activeSyncEnabled> 
                <mapiBlockOutlookNonCachedMode>0..1 </mapiBlockOutlookNonCachedMode> 
                <mapiBlockOutlookRpcHttp>0..1 </mapiBlockOutlookRpcHttp> 
                <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>             
        </features> 
</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 unique name of the plan--> 
    <planName>PlatinumMailbox</planName> 
    <!--The description of the plan--> 
    <description>Platinum eMail services with full Outlook client access</description> 
    <!----> 
    <features> 
      <!--Specifies the mailbox size 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 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 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>1</hiddenFromAddressListsEnabled> 
      <!--Specifies whether the IMAP4 protocol is enabled for this mailbox.--> 
      <imapEnabled>1</imapEnabled> 
      <!--Specifies whether the POP3 protocol is enabled for this mailbox.--> 
      <popEnabled>1</popEnabled> 
      <!--Enables Outlook Web Access.--> 
      <owaEnabled>1</owaEnabled> 
      <!--Specifies whether the MAPI protocol is enabled for this mailbox.--> 
      <mapiEnabled>1</mapiEnabled> 
      <!--Specifies whether ActiveSync is enabled for this mailbox.--> 
      <activeSyncEnabled>1</activeSyncEnabled> 
      <!--Specifies whether Outlook can be used in non-cached mode.--> 
      <mapiBlockOutlookNonCachedMode>1</mapiBlockOutlookNonCachedMode> 
      <!--Specifies whether clients can connect to Outlook by using Outlook Anywhere.--> 
      <mapiBlockOutlookRpcHttp>0</mapiBlockOutlookRpcHttp> 
      <!--Specifies whether all address lists are available in Outlook Web Access.--> 
      <owaAllAddressListsEnabled>0</owaAllAddressListsEnabled> 
      <!--Specifies whether contacts are enabled in Outlook Web Access.--> 
      <owaContactsEnabled>1</owaContactsEnabled> 
      <!--Specifies whether calendaring is enabled in Outlook Web Access.--> 
      <owaCalendarEnabled>1</owaCalendarEnabled> 
      <!--Specifies whether a user can change their password in Outlook Web Access.--> 
      <owaChangePasswordEnabled>0</owaChangePasswordEnabled> 
      <!--Specifies whether the Journal folder can be accessed in Outlook Web Access.--> 
      <owaJournalEnabled>1</owaJournalEnabled> 
      <!--Specifies whether tasks are enabled in Outlook Web Access.--> 
      <owaTasksEnabled>1</owaTasksEnabled> 
      <!--Specifies whether Sticky Notes are enabled in Outlook Web Access.--> 
      <owaNotesEnabled>1</owaNotesEnabled> 
      <!--Specifies whether calendar reminders are enabled in Outlook Web Access.--> 
      <owaRemindersAndNotificationsEnabled>1</owaRemindersAndNotificationsEnabled> 
      <!--Specifies whether Outlook Web Access Premium version is enabled.--> 
      <owaPremiumClientEnabled>1</owaPremiumClientEnabled> 
      <!--Specifies whether the spelling checker is enabled in Outlook Web Access.--> 
      <owaSpellCheckerEnabled>1</owaSpellCheckerEnabled> 
      <!--Specifies whether search folders are enabled in Outlook Web Access.--> 
      <owaSearchFoldersEnabled>1</owaSearchFoldersEnabled> 
      <!--Specifies whether the signature feature is enabled in Outlook Web Access.--> 
      <owaSignaturesEnabled>1</owaSignaturesEnabled> 
      <!--Specifies whether theme selection is enabled in Outlook Web Access.--> 
      <owaThemeSelectionEnabled>1</owaThemeSelectionEnabled> 
      <!--Specifies whether junk e-mail is enabled in Outlook Web Access.--> 
      <owaJunkEmailEnabled>1</owaJunkEmailEnabled> 
      <!--Specifies whether Unified Messaging (UM) integration is enabled in Outlook Web Access.--> 
      <owaUMIntegrationEnabled>1</owaUMIntegrationEnabled> 
      <!--Specifies whether Outlook Web Access Exchange ActiveSync mobile options are enabled.--> 
      <owaActiveSyncIntegrationEnabled>1</owaActiveSyncIntegrationEnabled> 
      <!--Specifies whether Universal Naming Convention (UNC) access is permitted when users select This is a private computer on the logon page.--> 
      <owaUNCAccessOnPrivateComputersEnabled>1</owaUNCAccessOnPrivateComputersEnabled> 
      <!--Specifies whether UNC access is permitted when users select This is a public or shared computer on the logon page.--> 
      <owaUNCAccessOnPublicComputersEnabled>1</owaUNCAccessOnPublicComputersEnabled> 
      <!--Specifies whether SharePoint Portal Server access is permitted when users select This is a private computer on the logon page.--> 
      <owaWSSAccessOnPrivateComputersEnabled>1</owaWSSAccessOnPrivateComputersEnabled> 
      <!--Specifies whether SharePoint Portal Server access is permitted when users select This is a public or shared computer on the logon page.--> 
      <owaWSSAccessOnPublicComputersEnabled>1</owaWSSAccessOnPublicComputersEnabled> 
      <!--Specifies whether the viewing of public folders is enabled in Outlook Web Access.--> 
      <owaPublicFoldersEnabled>1</owaPublicFoldersEnabled> 
      <!--Specifies whether recovery of deleted items is enabled in Outlook Web Access.--> 
      <owaRecoverDeletedItemsEnabled>1</owaRecoverDeletedItemsEnabled> 
      <!--Specifies whether rules can be accessed in Outlook Web Access. If this parameter is set to 0, server rules will continue to function, but cannot be modified in Outlook Web Access.--> 
      <owaRulesEnabled>1</owaRulesEnabled> 
      <!--Specifies whether viewing of e-mail that is encrypted by using S/MIME is supported in Outlook Web Access.--> 
      <owaSMimeEnabled>1</owaSMimeEnabled> 
    </features> 
  </data> 
  <procedure> 
    <execute namespace="Hosted Email 2007" procedure="CreateUserPlan" impersonate="1"> 
      <before source="data" sourcePath="preferredDomainController" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="planName" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="description" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="features" 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::ChangeUserPlanAssignment
Hosted Email 2007::CreateOrganizationPlan
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