Managed Email 2007::GetSMTPDomain

Article
06/17/2010

This procedure returns a collection of the AcceptedDomains.

This procedure for Hosted Messaging and Collaboration version 4.5 is modified to handle the scenario where the specified domainName 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. The modified procedure returns an additional <ownership> node that indicates whether the SMTPDomain is owned at the tenant or the reseller levels.

Arguments

Input Schema

Input Arguments	Required	Description
<organization>	Yes	A valid LDAP 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.

Output Schema for Hosted Messaging and Collaboration version 4.0

Output Arguments	Description
<acceptedDomain>	zero or more accepted domain details.
<acceptedDomain/ domainType>	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
<acceptedDomain/ addressBookEnabled>	tbs
<acceptedDomain/ default>	tbs
<acceptedDomain/ adminDisplayName>	tbs
<acceptedDomain/ exchangeVersion>	tbs
<acceptedDomain/ name>	tbs
<acceptedDomain/ distinguishedName>	tbs
<acceptedDomain/ identity>	The Active Directory Object ID or a string that represents the GUID, distinguished name, domain or account, user principal name (UPN), legacy Exchange distinguished name, Simple Mail Transfer Protocol (SMTP) address, or alias.
<acceptedDomain/ guid>	tbs
<acceptedDomain/ objectCategory>	tbs
<acceptedDomain/ objectClass>	Onject class.
<acceptedDomain/ objectClass/ value>	Object class values.
<acceptedDomain/ whenChanged>	tbs
<acceptedDomain/ whenCreated>	tbs
<acceptedDomain/ originatingServer>	tbs
<acceptedDomain/ isValid>	tbs

Output Schema for Hosted Messaging and Collaboration version 4.5

Output Arguments	Description
<acceptedDomain>	zero or more accepted domain details.
<acceptedDomain/ domainType>	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
<acceptedDomain/ addressBookEnabled>	tbs
<acceptedDomain/ default>	tbs
<acceptedDomain/ adminDisplayName>	tbs
<acceptedDomain/ exchangeVersion>	tbs
<acceptedDomain/ name>	tbs
<acceptedDomain/ distinguishedName>	tbs
<acceptedDomain/ identity>	The Active Directory Object ID or a string that represents the GUID, distinguished name, domain or account, user principal name (UPN), legacy Exchange distinguished name, Simple Mail Transfer Protocol (SMTP) address, or alias.
<acceptedDomain/ guid>	tbs
<acceptedDomain/ objectCategory>	tbs
<acceptedDomain/ objectClass>	Onject class.
<acceptedDomain/ objectClass/ value>	Object class values.
<acceptedDomain/ whenChanged>	tbs
<acceptedDomain/ whenCreated>	tbs
<acceptedDomain/ originatingServer>	tbs
<acceptedDomain/ isValid>	tbs
<ownership>	Its possible values are "tenant" if owned by the supplied tenant organization, or "reseller" if owned by the tenant's reseller organization.

Remarks

Security

Caller must be at least a member of role: userCreators.

Sample Code

Example XML Request

<request> 
    <!--The LDAP path of the organization object that is associated with the address list.--> 
    <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> 
  <procedure> 
    <execute namespace="Managed Email 2007" procedure="GetSMTPDomain" impersonate="1"> 
      <after source="executeData" destination="data" mode="merge" /> 
    </execute> 
  </procedure> 
</request>

Example XML Response

<response> 
  <data> 
    <!--zero or more accepted domain details--> 
    <acceptedDomain> 
      <!--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>Authoritative</domainType> 
      <!--Indicates whether AddressBook is enabled.--> 
      <addressBookEnabled>true</addressBookEnabled> 
      <!--Is default domain.--> 
      <default>false</default> 
      <!--Admin display name.--> 
      <adminDisplayName>admin</adminDisplayName> 
      <!--Exchange Version.--> 
      <exchangeVersion>0.1 (8.0.535.0)</exchangeVersion> 
      <!--Name of the AcceptedDomain.--> 
      <name>AlpineSkiHouse</name> 
      <!--Distinguished Name of the AcceptedDomain.--> 
      <distinguishedName>CN=AlpineSkiHouse,CN=Accepted Domains,CN=Transport Settings,CN=Fabrikam,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=fabrikam,DC=com</distinguishedName> 
      <!--The Active Directory Object ID or a string that represents the GUID, distinguished name, domain or account, user principal name (UPN), legacy Exchange distinguished name, Simple Mail Transfer Protocol (SMTP) address, or alias.--> 
      <identity>AlpineSkiHouse</identity> 
      <!--GUID of the AcceptedDomain.--> 
      <guid>5a5f7a3a-d656-4ddc-b6cf-a28c3d40013a</guid> 
      <!--Active Directory Object Category.--> 
      <objectCategory>fabrikam.com/Configuration/Schema/ms-Exch-Accepted-Domain</objectCategory> 
      <!--Active Directory ObjectClass values.--> 
      <objectClass> 
        <!--ObjectClass values.--> 
        <value>top</value> 
      </objectClass> 
      <!--When the object was changed.--> 
      <whenChanged>11/8/2006 10:51:39 AM</whenChanged> 
      <!--When the object was created.--> 
      <whenCreated>11/8/2006 10:51:39 AM</whenCreated> 
      <!--Originating Server.--> 
      <originatingServer>AD01.fabrikam.com</originatingServer> 
      <!--Active Directory PresentationObject is valid.--> 
      <isValid>true</isValid> 
    </acceptedDomain> 
    <!--Specifies the ownership of the domain. The domain can be owned by the tenant itself or by the tenant's reseller--> 
    <ownership>tenant</ownership> 
  </data> 
</response>

Applies To

Hosted Messaging and Collaboration version 4.5
Hosted Messaging and Collaboration version 4.0

Share via

Managed Email 2007::GetSMTPDomain

Arguments

Remarks

Sample Code

Applies To

See also

Other Resources

Additional resources