Share via


Exchange 2007 Provider::GetSMTPDomain

This procedure returns a collection of the AcceptedDomains.

Arguments

Input Arguments Required Description

<preferredDomainController>

Yes

The domain controller to use for Active Directory (AD) actions.

<identity>

No

This parameter specifies the accepted domain to retrieve.

Output Arguments Description

<acceptedDomains>

The collection of Accepted Domains.

<acceptedDomains/ acceptedDomain>

The details of an Accepted Domain.

<acceptedDomains/ acceptedDomain/ domainName>

This parameter specifies the Simple Mail Transfer Protocol (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 embeded, as shown in the following example: domain.*.contoso.com. The domain name string may not contain more than 256 characters.

<acceptedDomains/ acceptedDomain/ domainType>

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

<acceptedDomains/ acceptedDomain/ addressBookEnabled>

This parameter indicates whether AddressBook is enabled.

<acceptedDomains/ acceptedDomain/ default >

This parameter indicates the default domain.

<acceptedDomains/ acceptedDomain/ adminDisplayName>

This parameter indicates the administrator's display name.

<acceptedDomains/ acceptedDomain/ exchangeVersion>

This parameter indicates the Exchange Version.

<acceptedDomains/ acceptedDomain/ name>

This parameter indicates the name of the AcceptedDomain.

<acceptedDomains/ acceptedDomain/ distinguishedName>

This parameter indicates the distinguished Name of the AcceptedDomain.

<acceptedDomains/ acceptedDomain/ identity>

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

<acceptedDomains/ acceptedDomain/ guid>

This parameter indicates the GUID of the AcceptedDomain.

<acceptedDomains/ acceptedDomain/ objectCategory>

This parameter indicates the Active Directory Object Category.

<acceptedDomains/ acceptedDomain/ objectClass>

This parameter indicates the ObjectClass values.

<acceptedDomain/ objectClass/ value>

This parameter indicates the ObjectClass value.

<acceptedDomains/ acceptedDomain/ whenChanged>

This parameter indicates when the object was changed.

<acceptedDomains/ acceptedDomain/ whenCreated>

This parameter indicates when the object was created.

<acceptedDomains/ acceptedDomain/ originatingServer>

This parameter indicates the originating Server.

<acceptedDomains/ acceptedDomain/ isValid>

This parameter indicates whether the ADPresentationObject is valid.

Remarks

Rollback Method: Not implemented

Sample Code

Example XML Request

<request> 
  <data> 
    <!--The domain controller to use for Active Directory actions.--> 
    <preferredDomainController>AD01.Fabrikam.Com</preferredDomainController> 
    <!--Specifies the accepted domain to retrieve.--> 
    <identity>AlpineSkiHouse.com</identity> 
  </data> 
  <procedure> 
    <execute namespace="Exchange 2007 Provider" procedure="GetSMTPDomain" impersonate="1"> 
      <before source="data" sourcePath="preferredDomainController" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="identity" destination="executeData" mode="move" /> 
      <after source="executeData" destination="data" mode="merge" /> 
    </execute> 
  </procedure> 
</request>

Example XML Response

<response> 
  <data> 
    <!--Collection of Accepted Domains.--> 
    <acceptedDomains> 
      <!--Details of an Accepted Domain--> 
      <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.com</name> 
        <!--Distinguished Name of the AcceptedDomain.--> 
        <distinguishedName>CN=AlpineSkiHouse.com,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.com</identity> 
        <!--GUID of the AcceptedDomain.--> 
        <guid>5a5f7a3a-d656-4ddc-b6cf-a28c3d40013a</guid> 
        <!--AD Object Category--> 
        <objectCategory>fabrikam.com/Configuration/Schema/ms-Exch-Accepted-Domain</objectCategory> 
        <!--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> 
        <!--ADPresentationObject is valid--> 
        <isValid>true</isValid> 
      </acceptedDomain> 
    </acceptedDomains> 
  </data> 
</response>

Applies To

Exchange 2007 Provider Namespace for:

  • Hosted Messaging and Collaboration version 4.5

  • Hosted Messaging and Collaboration version 4.0

See also

Tasks

Hosted Email 2007::CreateSMTPDomain
Hosted Email 2007::CreateConsumerVanityDomain
Hosted Email 2007::GetOrganizationDomains