Share via

Hosted Exchange::DeleteConsumerUser

  • Article

This procedure deletes a consumer user, de-allocates mailbox resources, marks the user deleted in the plan database, and records a billing event.

Arguments

Input argument Required Description

<path>

Yes

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

<preferredDomainController>

Yes

<deleteSMTPDomain>

No

If present delete andy SMTP Vanity Domains from recipient policies.

Remarks

Provisioning Steps

  1. Managed Active Directory::TestPermissions_ - UserCreator role.

  2. Hosted Exchange::DeleteCustomerRecord_ - Mark the user deleted in the Customer Plan database.

  3. Hosted Exchange::DeleteMailbox_ - Deallocate the maibox from RM, delete the mailbox.

  4. Hosted Exchange::DeleteUser_ - Delete the user, mark any assets associated wit the user in the Customer Plan database deleted.

Security

  • Impersonate caller.

  • Caller tested for UserCreator role.

Sample Code

Example XML Request

<request>   
        <procedure>     
                <execute namespace="Hosted Exchange" procedure="DeleteConsumerUser" impersonate="1">       
                        <executeData>          
                                <path>LDAP://CN=bob@litwareinc.com,OU=litwareinc,OU=consolidatedmessenger,OU=HOSTING,DC=fabrikam,DC=Com</path>          
                                <deleteSMTPDomain/>          
                                <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::CreateConsumerUser