Hosted Exchange::CreateConsumerVanityDomain

  • Article

Adds an SMTP Domain name to recipient policies and sets it as the primary domain for a consumer user. Procedure was shipped with HVE 1.0.

Arguments

Input argument Required Description

<path>

Yes

Valid Lightweight Directory Access Protocol (LDAP) path of the user object.

<name>

Yes

Name of the user. Used to generate the new SMTP email address by combining name with SMTPDomain.

<SMTPDomain>

Yes

Valid domain name.

<preferredDomainController>

Yes

<createSMTPDomain>

No

Optionally create the SMTP domain in recipient policies. Omit if you are in an event sink environment.

Remarks

Security

  • Impersonate caller.

  • Caller tested for UserCreator role.

Sample Code

Example XML Request

<?xml version="1.0"?> 
<request> 
        <procedure> 
                <execute namespace="Hosted Exchange" procedure="CreateConsumerVanityDomain" impersonate="1"> 
                        <executeData> 
                                <path>LDAP://CN=joes@litwareinc.com,OU=litwareinc,OU=WH,OU=Hosting,DC=fabrikam,DC=Com</path> 
                                <name>joes</name> 
                                <SMTPDomain>joesmith.com</SMTPDomain>        
                                <createSMTPDomain/> 
                                <preferredDomainController>AD01.fabrikam.com</preferredDomainController> 
                        </executeData> 
                        <after source="executeData" destination="data" mode="merge"/> 
                </execute> 
        </procedure> 
</request>

Example XML Response

No example XML response.

Applies To

Hosted Exchange Namespace API for:

  • Hosted Messaging and Collaboration version 3.5

  • Hosted Messaging and Collaboration version 3.0

See also

Tasks

Hosted Exchange::CreateSMTPDomain
Hosted Exchange::DeleteSMTPDomain