Hosted Email 2007::CreateSMTPDomain

This procedure creates a new accepted domain for an organization.

Arguments

Input Arguments Required Description

<organization>

Yes

A valid Lightweight Directory Access Protocol (LDAP) path of the organization.

<domainName>

Yes

This parameter specifies a unique name for the accepted domain object.

<preferredDomainController>

Yes

The domain controller to use for Active Directory actions.

<domainType>

No

This parameter 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. Enum

  • Authoritative

  • InternalRelay

  • ExternalRelay

Remarks

A new domain will be added to the uPNSuffixes attribute of the organization.

This procedure in Hosted Messaging and Collaboration version 4.5 is modified to handle the scenario where the specified domainName has already been created as an accepted domain and is owned by the parent or reseller organization. This is necessary to support rollup of SMTP Domain ownership, in that if a reseller organization owns an SMTP domain, all Tenants of that reseller can also own that SMTP domain as an asset in the Managed Plans database. This procedure already supports the scenario of creating an SMTP domain owned by a reseller organization.

Security

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

Schema Definition

Input

<executeData>  
<organization>1..1 </organization> 
<preferredDomainController>1..1 </preferredDomainController> 
<domainName>1..1 </domainName> 
<domainType>0..1 </domainType> 
</executeData> 
 

Output

<executeData>1..1 </executeData>

Sample Code

Example XML Request

<request> 
  <data> 
    <!--The LDAP Path of the organization--> 
    <organization>LDAP://OU=AlpineSkiHouse,OU=ConsolidatedMessenger,OU=Hosting,DC=Fabrikam,DC=Com</organization> 
    <!--The domain controller to use for Active Directory actions.--> 
    <preferredDomainController>AD01.Fabrikam.Com</preferredDomainController> 
    <!--This parameter specifies a unique name for the accepted domain object.--> 
    <domainName>AlpineSkiHouse.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="CreateSMTPDomain" impersonate="1"> 
      <before source="data" sourcePath="organization" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="preferredDomainController" 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 /> 
</response> 

Applies To

  • Hosted Messaging and Collaboration version 4.5

  • Hosted Messaging and Collaboration version 4.0

See also

Tasks

Managed Email 2007::CreateSMTPDomain
Hosted Email 2007::DeleteSMTPDomain
Hosted Email 2007::CreateConsumerVanityDomain
Hosted Email 2007::GetOrganizationDomains