Hosted Exchange::CreateSMTPProxyAddress

  • Article

This procedure adds an SMTP proxy address to a specified user's list of proxy addresses.

Arguments

Input argument Required Description

<path>

Yes

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

<preferredDomainController>

Yes

<proxyAddress>

Yes

The SMTP proxy address to add to the user. i.e. user@domain.com.

<proxyAddress>/@setPrimary

No

Optional attribute indicating that the specified proxy address should become the primary address for the user. 1 = primary and 0 = secondary. 0 is the default of the attribute is not present in the proxyAddress element. Example <proxyAddress setPrimary="1">jimc@alpineskihouse.com</proxyAddress>.

  • setPrimary Behavior - If the specified address is a new address for the user, then this address is created and set as the secondary domain. If an existing primary address was already defined, the existing primary address is modified to be a secondary address.

    If the specified address exists for the user and it is a secondary address, then the address is set to the primary address, and the current primary address is set to a secondary address.

    If the specified address exists and is currently the primary address, then no action is taken and no error is generated.

    Dd252437.note(en-us,TechNet.10).gifNote
    The proxyAddress element assumes that the proxy address passed is a secondary proxy address for the user. The value will be modified and applied to the user with the following format: smtp:<username>@<domainsuffix>. For example; smtp:jimc@alpineskihouse.com. The procedure does verify that the domain suffix of the proxy address is a valid SMTP domain for the user's organization.

<customerTypeName>

No

BusinessUser and ConsumerUser are the two allowed inputs for this parameter. If not provided the procedure defaults to BusinessUser.

Remarks

Security

Impersonate Caller.

Caller Tested for OrgCreator permissions.

Sample Code

Example XML Request

<?xml version="1.0" encoding="iso-8859-1" ?> 
        <request>   
                <procedure>       
                        <execute namespace="Hosted Exchange" procedure="CreateSMTPProxyAddress" impersonate="1">       
                                <executeData>         
                                        <path>LDAP://cn=user@alpineskihouse.com,ou=alpineskihouse,OU=consolidatedmessenger,OU=Hosting,DC=fabrikam,DC=Com</path>         
                                        <proxyAddress>user@skihouse.com</proxyAddress>         
                                        <preferredDomainController>AD01.fabrikam.com</preferredDomainController>       
                                </executeData>       
                        <after source="executeData" destination="data" mode="merge"/>     
                </execute>   
        </procedure> 
</request>

Example XML Response

<?xml version="1.0" encoding="iso-8859-1" ?> 
        <request>  <procedure>       
                <execute namespace="Hosted Exchange" procedure="CreateSMTPProxyAddress" impersonate="1">       
                        <executeData>         
                                <path>LDAP://cn=user@alpineskihouse.com,ou=alpineskihouse,OU=consolidatedmessenger,OU=Hosting,DC=fabrikam,DC=Com</path>         
                                <proxyAddress setPrimary="1">user@skihouse.com</proxyAddress>         
                                <preferredDomainController>AD01.fabrikam.com</preferredDomainController>       
                        </executeData>       
                        <after source="executeData" destination="data" mode="merge"/>     
                </execute>   
        </procedure> 
</request>

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::DeleteSMTPProxyAddress