Hosted Email 2007::GetOrganizationDomains

  • Article

This procedure returns a listing of SMTP Domains for a specified organization.

Arguments

Input Arguments Required Description

<path>

Yes

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

<preferredDomainController>

Yes

The Fully Qualified Domain Name (FQDN) of a domain controller.
Output Arguments Description

<SMTPDomains>

A collection of SMTP domains.

<SMTPDomains/ SMTPDomain>

The container element for SMTP domain details.

<SMTPDomains/ SMTPDomain/ domainName>

The name of the domain.

<SMTPDomains/ SMTPDomain/ domainTypeName>

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.

Schema Definition

Input

<executeData>  
        <path>1..1 </path> 
        <preferredDomainController>1..1 </preferredDomainController> 
</executeData>

Output

<executeData>  
        <SMTPDomains>1..1  
                <SMTPDomain>0..unbounded  
                        <domainName>1..1 </domainName> 
                        <domainTypeName>1..1 </domainTypeName> 
                </SMTPDomain> 
        </SMTPDomains> 
</executeData>

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> 
    <!--FQDN of a domain controller. --> 
    <preferredDomainController>AD01.Fabrikam.com</preferredDomainController> 
  </data> 
  <procedure> 
    <execute namespace="Hosted Email 2007" procedure="GetOrganizationDomains" impersonate="1"> 
      <before source="data" sourcePath="path" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="preferredDomainController" destination="executeData" mode="move" /> 
      <after source="executeData" destination="data" mode="merge" /> 
    </execute> 
  </procedure> 
</request>

Example XML Response

<response> 
  <data> 
    <!--A collection of SMTP Domains--> 
    <SMTPDomains> 
      <!--Container element for SMTP domain details--> 
      <SMTPDomain> 
        <!--The name of the domain--> 
        <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.--> 
        <domainTypeName>InternalRelay</domainTypeName> 
      </SMTPDomain> 
    </SMTPDomains> 
  </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::CreateConsumerVanityDomain
Hosted Email 2007::CreateSMTPDomain
Hosted Email 2007::DeleteSMTPDomain