Hosted Email 2007::MailEnableTenant

  • Article

This procedure rolls up the tasks required to enable a tenant for Hosted Email services. This includes the subscribe, addAvailablePlans and CreateSMTPDomain tasks.

This procedure is not specific to the IIW (Individual Information Worker) scenario, it can be used for both IIW tenants and Business tenants. However, it does have some specialized handling for the IIW scenario, specifically the ability to identify parent from user path, in order to subscribe the appropriate object.

Arguments

Input Schema

Input Arguments Required Description

<path>

Yes

The Lightweight Directory Access Protocol (LDAP) path of the business tenant or IIW tenant user. If user object path is specified, path will be set to the users objects owningOrganization.

<planName>

Yes

The Organization planName supplied to the Hosted Email 2007::Subscribe method.

<availablePlans>

Yes

The container node for the list of available user plans.

<availablePlans/planName>

Yes

The name of a user plan to be added to the tenant as an available plan. The name of the desired service plan. It can occur multiple times in the node.

<domainName>

Yes

This is the SMTPDomain that should be add as an SMTPDomain owned by the tenant. It will be added to the list of Accepted domains if it does not already exist.

<domainType>

No

This description of the user object.

<preferredDomainController>

Yes

The name of the preferred Domain Controller.

Output Schema

A successful response will mirror the input data.

Remarks

Security

Explicit test should be performed for userCreators role.

Sample Code

Example XML Request

<request> 
  <data> 
    <!--LDAP path of the organization. --> 
    <path>LDAP://OU=AlpineSkiHouse,OU=ConsolidatedMessenger,OU=Hosting,DC=Fabrikam,DC=Com</path> 
    <!--The domain controller to use for Active Directory actions.--> 
    <preferredDomainController>AD01.Fabrikam.Com</preferredDomainController> 
    <!--The Exchange Hosting Plan to apply to the organization.--> 
    <planName>BronzeMailHosting</planName> 
    <!--Container node for the list of available user plans.--> 
    <availablePlans> 
      <!--This is the name of a user plan to be added to the tenant as an available plan--> 
      <planName>BronzeMailBox</planName> 
    </availablePlans> 
    <!--SMTPDomain that should be add as an SMTPDomain owned by the tenant, it will be added to the list of Accepted domains if it does not already exist--> 
    <domainName>jackhome.com</domainName> 
    <!--Specifies the type of accepted domain to be configured.  In an authoritative domain, messages are delivered to a recipient that has a domain account in your Exchange organization. In an internal relay domain, messages are relayed to a server that is outside your Exchange organization, but still under the authority of your company or IT department. Use the internal relay domain if you want to treat the messages to this domain as internal messages. In an external relay domain, messages are relayed to an e-mail server, outside your organization, which you do not control.  The default value is Authoritative.--> 
    <domainType>InternalRelay</domainType> 
  </data> 
  <procedure> 
    <execute namespace="Hosted Email 2007" procedure="MailEnableTenant" impersonate="1"> 
      <before source="data" sourcePath="path" 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="availablePlans" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="domainName" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="domainType" destination="executeData" mode="move" /> 
      <after source="executeData" destination="data" mode="merge" /> 
    </execute> 
  </procedure> 
</request>

Example XML Response

<response> 
  <data> 
    <!--LDAP path of the organization. --> 
    <path>LDAP://OU=AlpineSkiHouse,OU=ConsolidatedMessenger,OU=Hosting,DC=Fabrikam,DC=Com</path> 
    <!--The domain controller to use for Active Directory actions.--> 
    <preferredDomainController>AD01.Fabrikam.Com</preferredDomainController> 
    <!--The Exchange Hosting Plan to apply to the organization.--> 
    <planName>BronzeMailHosting</planName> 
    <!--Container node for the list of available user plans.--> 
    <availablePlans> 
      <!--This is the name of a user plan to be added to the tenant as an available plan--> 
      <planName>BasicMailBox</planName> 
    </availablePlans> 
    <!--SMTPDomain that should be add as an SMTPDomain owned by the tenant, it will be added to the list of Accepted domains if it does not already exist--> 
    <domainName>jackhome.com</domainName> 
    <!--Specifies the type of accepted domain to be configured.  In an authoritative domain, messages are delivered to a recipient that has a domain account in your Exchange organization. In an internal relay domain, messages are relayed to a server that is outside your Exchange organization, but still under the authority of your company or IT department. Use the internal relay domain if you want to treat the messages to this domain as internal messages. In an external relay domain, messages are relayed to an e-mail server, outside your organization, which you do not control.  The default value is Authoritative.--> 
    <domainType>InternalRelay</domainType> 
  </data> 
</response>

Applies To

Hosted Email 2007 Namespace for:

  • Hosted Messaging and Collaboration version 4.5