Share via

Managed Email 2007::CreateSMTPDomain

  • Article

This procedure creates a new accepted domain for an organization.

Arguments

Input Arguments Required Description

<organization>

Yes

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

<domainName>

Yes

The domain controller to use for Active Directory actions.

<preferredDomainController>

Yes

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

<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

Security

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

Error Handling

Error condition Error text

SMTP Domain exists but the tenant or reseller org do not have ownership

The SMTP Domain %domainName% is not available.

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 the SMTP domain to be established as an accepted domain.  Wildcard character can be used to specify all subdomains of a given domain, as shown in the following example:   *.contoso.com.   However, wildcard characters cannot be embed, as shown in the following example:   domain.*.contoso.com.   The domain name string may not contain more than 256 characters.--> 
    <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="Managed 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>

Applies To

  • Hosted Messaging and Collaboration version 4.5

  • Hosted Messaging and Collaboration version 4.0

See also

Tasks

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