Hosted Exchange Namespace API

This document provides the details of the application programming interface (API) for the Hosted Exchange namespace included with the Microsoft® Provisioning System (MPS) in Microsoft Solution for Hosted Messaging and Collaboration version 3.5 and 3.0. Contained herein are descriptions of the procedures of this namespace along with method input parameters and return values. In addition, example XML requests are provided along with typical Extensible Markup Language (XML) responses that the provisioning system returns after a request is submitted to MPS and tasks are completed.

Developers should use this API document as a reference when creating XML requests that initiate the provisioning of Hosted Exchange services or as a basis for review of the Hosted Exchange named procedures that are implemented in the Web Service.

Overview

The Hosted Exchange namespace exposes a set of Microsoft Provisioning Framework (MPF) public named procedures for the provisioning of Hosted Exchange services. This document contains procedures from previously existing Hosted Exchange versions in addition to new procedures for Hosted Exchange in Microsoft® Solution for Hosted Messaging and Collaboration version 3.5 and 3.0.

Changes to LDAP Parameters

The Lightweight Directory Access Protocol (LDAP) parameter, used to specify the distinguished name (DN) including the preferred domain controller in some of the procedures that follow will be removed in a future release of the solution. To prepare for this change, use the LDAP path with no domain controller in those procedures and use the <preferreddomaincontroller> parameter to specify the preferred domain controller.

Dependencies

You install the Hosted Exchange namespace with the MPS Deployment Tool. The functionality of this namespace depends on interaction with other namespaces that are installed with MPS core components, as follows:

In addition, the Hosted Exchange namespace is also dependent on other namespaces. Therefore, you must ensure that you queue the following additional components for installation with the MPS Deployment Tool at deployment design time.

Public Method Description
Hosted Exchange::AddAvailablePlans Adds service plans to the list of available plans for an organization.
Hosted Exchange::ChangeUserMailboxPlan Modifies a customer's mailbox plan to a new specified mailbox plan.
Hosted Exchange::ChangeUserPassword Changes the password of an Active Directory user object.
Hosted Exchange::CreateBusinessOrganization Creates a business organization and Exchange enables the organization.
Hosted Exchange::CreateBusinessUser Creates a business user.
Hosted Exchange::CreateConsumerUser Creates a consumer user with attributes based on a specified service plan.
Hosted Exchange::CreateConsumerVanityDomain Adds an SMTP Domain name to recipient policies and sets it as the primary domain for a consumer user.
Hosted Exchange::CreateDistributionList Creates a distribution list.
Hosted Exchange::CreateMailbox Creates an Exchange mailbox for a specified user.
Hosted Exchange::CreateMailboxPlan Creates a new mailbox service plan in the customer plan database.
Hosted Exchange::CreatePlanFeatureTypes Creates new feature types in the customer plan database.
Hosted Exchange::CreateOrganizationAddressLists Creates a Global Address, Address, and Offline Address lists for a specified organization.
Hosted Exchange::CreatePlanFeatureTypes Creates new feature types in the customer plan database.
Hosted Exchange::CreatePublicFolder Creates the top level public folder for an organization.
Hosted Exchange::CreateResellerOrganization Creates a reseller organization in the specified container.
Hosted Exchange::CreateSMTPDomain Adds an SMTP Domain to a specified organization.
Hosted Exchange::CreateSMTPProxyAddress Adds an SMTP proxy address to a specified user's list of proxy addresses.
Hosted Exchange::DeleteBusinessOrganization Deletes a business organization, de-allocates mailbox resources, marks the organization deleted in the plan database, and records a billing event.
Hosted Exchange::DeleteBusinessUser Deletes a business user, de-allocates mailbox resources, marks the user deleted in the plan database, and records a billing event.
Hosted Exchange::DeleteConsumerUser Deletes a consumer user, de-allocates mailbox resources, marks the user deleted in the plan database, and records a billing event.
Hosted Exchange::DeleteDistributionList Deletes a distribution list.
Hosted Exchange::DeletePublicFolder Deletes the top level public folder for an organization.
Hosted Exchange::DeleteSMTPDomain Deletes an SMTP Domain to a specified organization.
Hosted Exchange::DeleteSMTPProxyAddress Deletes an SMTP proxy address to a specified user's list of proxy addresses.
Hosted Exchange::DisableUser Disables a User object in Active Directory® directory service and records a billing event.
Hosted Exchange::EnableUser Enables a user object in Active Directory and records a billing event.
Hosted Exchange::EnsureExchangeVirtualDirectories Attempts to create a virtual directory on every Exchange server.
Hosted Exchange::ExchangeEnableOrganization Enables an organization for Exchange Mailboxes. Procedure is called by CreateBusinessOrganization.
Hosted Exchange::GetModifiedOrganizations Retrieves a list of organizations that have had membership changes in a given timeframe.
Hosted Exchange::RebuildOfflineAddressList Rebuilds an organization's Offline Address Book.
Hosted Exchange::GetAvailablePlans Retrieves the plans that are defined as available for a specified organization.
Hosted Exchange::CreateSMTPDomain Adds a SMTP Domain to a specified organization.
Hosted Exchange::DeleteSMTPDomain Deletes a SMTP Domain from a specified organization.
Hosted Exchange::CreateSMTPProxyAddress Adds an SMTP proxy address to a specified user's list of proxy addresses.
Hosted Exchange::DeleteSMTPProxyAddress Deletes an SMTP proxy addresses from a specified user's list of proxy addresses.
Hosted Exchange::GetOrganizationDomains Retrieves a listing of SMTP domains assigned to an organization.
Hosted Exchange::GetPlanDetail Retrieves the details of a specified service plan.
Hosted Exchange::GetPlans Returns a listing of service plans based on optional filters.
Hosted Exchange::GetProperties Get properties for a specified object using an LDAP path.
Hosted Exchange::InitializeCustomerPlanDatabase Adds customer, asset, plan, status, feature, and event types to the Customer Plan and Events database that are utilized by the Hosted Exchange Namespace.
Hosted Exchange::InitializeHostedExchange Initializes the Hosted Exchange Namespace.
Hosted Exchange::InitializeNamespaceSecurity Initializes security settings for the Hosted Exchange Namespace procedures.
Hosted Exchange::MakeUserAdmin Adds or removes a customer user from the admin group in the users organization.
Hosted Exchange::ModifyUser Modifies the attributes of a user's Active Directory object.
Hosted Exchange::ModifyDistributionList Modifies a distribution list.
Hosted Exchange::RebuildOfflineAddressList Rebuilds an organization's Offline Address Book.
Hosted Exchange::RemoveAvailablePlans Removes service plans from the list of available plans for an organization.
Hosted Exchange::SetCustomerDatabaseLocation Sets the location of the Customer Plan database in the system registry.
Hosted Exchange::SetUserPassword Set the password of a customer Active Directory® directory service user object.
 Applies To