Hosted Email 2007::CreateOrganizationPlan

This procedure creates an organization plan.

Arguments

Input Arguments Type Required Description

<preferredDomainController>

string

Yes

The domain controller to use for Active Directory actions.

<planName>

string

Yes

The unique name of the plan.

<description>

string

Yes

The description of the plan.

<features>

complexType

Yes

This is an XML node that contains the features that were set on the Plan.

<features/ mailStore>

complexType

Yes

The container element for mail storage settings.

<features/ mailStore/ dynamicQuota>

integer

Yes

This parameter specifies if Exchange Resource Management dynamically increases an organization quota when the limit is reached.

<features/ mailStore/ megabytes>

integer

No

This parameter specifies the number of megabytes to pre-allocate to an organization for mailboxes. If not specified then dynamicQuota should be set to true..

<features/ mailStore/ shared>

integer

Yes

This parameter specifies shared or dedicated. 1 = shared, 0 = dedicated.

<features/ mailStore/ algorithm>

enum

Yes

This parameter specifies the mail store selection algorithm. Enum:

  • tightPack attempts to use the smallest number of mail stores

  • level - level seeks to spread allocations evenly across available stores

  • minStoreCount - minStoreCount attempts to minimize the number of stores allocated to each organization.

<features/ publicStore>

complexType

No

The container element for public storage settings.

<features/ publicStore/ megabytes>

integer

Yes

This parameter specifies the number of megabytes to allocate for an organizations public folder. If this option is not specified, an organization will not be able to create a public folder.

<features/ outlookClient>

enum

No

This parameter specifies the outlook client type, in order to select OAB distribution method. Enum:

  • Legacy - Users are expected to use Outlook 2003 for email access. The organization's OAB will be distributed and downloaded from public folder mailbox servers (even for Outlook 2007 users). Legacy provides backward compatibility with HMC 4.0.

  • Outlook2007 - Users are expected to use Outlook 2007 clients for mail access. The organization's OAB will be distributed and downloaded from web URLs.

  • All -Users are expected to use Outlook 2007 and Outlook 2003 for email access. Outlook 2007 users will download the organization's OAB from web URLs, while Outlook 2003 users will download the OAB from public folder mailbox servers.

Remarks

This plan type is not valid for Consumer Organizations.

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  
                <mailStore>1..1  
                        <dynamicQuota>1..1 </dynamicQuota> 
                        <megabytes>0..1 </megabytes> 
                        <shared>1..1 </shared> 
                        <algorithm>1..1 </algorithm> 
                </mailStore> 
                <publicStore>0..1  
                        <megabytes>1..1 </megabytes> 
                </publicStore> 
        </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>PlatinumMailHosting</planName> 
    <!--The description of the plan--> 
    <description>Platinum eMail services with full Outlook client access</description> 
    <features> 
      <!--Container element for mail storage settings--> 
      <mailStore> 
        <!--Specify if Exchange Resource Management dynamically increases an organization quota when the limit is reached.--> 
        <dynamicQuota>0</dynamicQuota> 
        <!--Specifies Specify the number of megabytes to pre-allocate to an organization for mailboxes. If not specified then dynamicQuota should be set to true.--> 
        <megabytes>10000</megabytes> 
        <!--Specify shared or dedicated. 1 = shared, 0 = dedicated.--> 
        <shared>1</shared> 
        <!--Specify the mail store selection algorithm.--> 
        <algorithm>tightPack</algorithm> 
      </mailStore> 
      <!--Container element for public storage settings--> 
      <publicStore> 
        <!--Specifies Specify the number of megabytes to allocate for an organizations public folder. If this option is not specified an organization will not be able to create a public folder--> 
        <megabytes>10000</megabytes> 
      </publicStore> 
      <!--Specifies the outlook client type, in order to select OAB distribution method.--> 
      <outlookClient>Outlook2007</outlookClient> 
    </features> 
  </data> 
  <procedure> 
    <execute namespace="Hosted Email 2007" procedure="CreateOrganizationPlan" 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::ChangeOrganizationPlanAssignment
Hosted Email 2007::ChangeUserPlanAssignment
Hosted Email 2007::AddAvailablePlans
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