Exchange Provider API

This document provides the details of the Application Programming Interface (API) for the Exchange Provider included with the Microsoft Provisioning System (MPS) component of the , including Hosted Exchange 2003. The document describes the Exchange Provider methods along with input parameters, transaction rollback calls, and other requirements. For each Exchange Provider method, an XML request is also included as an example which can be submitted to MPS.

Developers should use this API document as a reference when creating MPS procedures, custom namespaces, or XML requests that initiate provisioning tasks to manipulate Exchange functionality on a Microsoft Windows Server 2003 or Microsoft Windows 2000 Server.


The Exchange Provider component of MPS contains the programmatic logic to communicate directly with the management interface of Microsoft Exchange Server 2003 . Calls to Exchange Provider methods are handled through the Exchange Provider namespace, which is a dedicated namespace that works with the Exchange Provider to implement provisioning tasks.

To call the methods of the Exchange Provider, you can write an XML request that contains procedures associated with the Exchange Provider namespace, the Hosted Exchange 2003 Namespace, or another custom namespace that you develop. You can also call into the Exchange Provider from the Web Service included with Microsoft Solutions for Hosted Messaging and Collaboration. The Web Service exposes select public methods of the Hosted Exchange 2003 Namespace as Web methods, which can call Exchange Provider methods.

For calls into the Exchange Provider from the Web Service, you can make use of the MPS .NET Client Wrapper API component to generate XML requests containing specific Hosted Exchange Namespace procedures. You then submit these requests into MPS to initiate Exchange-related provisioning tasks. For further details about the API for the MPF .NET Client Wrapper, see "MPF .NET Client Wrapper API" in this volume.

You can install the Exchange Provider with the MPS Deployment Tool, provided with Microsoft Solutions for Hosted Messaging and Collaboration.

Public MethodDescription

Exchange Provider::CreateSMTPDomain

Allows you to create or modify a recipient policy to contain the customer's Simple Mail Transfer Protocol (SMTP) domain (for example,

Exchange Provider::DeleteSMTPDomain

Deletes the SMTP domain(s) for an organization.

Exchange Provider::DeleteMailboxes

Deletes all user mailboxes in a given organizational unit (OU).

Exchange Provider::CreateMailbox

Mailbox-enables an existing user.

Exchange Provider::DeleteMailbox

Deletes a user's mailbox.

Exchange Provider::MailEnableContact

Mail-enables an existing contact.

Exchange Provider::MailDisableContact

Mail-disables an existing contact.

Exchange Provider::MailEnableGroup

Mail-enables a group, which effectively turns the group into a distribution list.

Exchange Provider::MailDisableGroup

Mail-disables a group.

Exchange Provider::MoveMailbox

Moves a mailbox from one mailbox store to another by looking up the user's current mailbox location and moving it to the new destination.

Exchange Provider::EditMailbox

Allows you to edit mailbox settings.

Exchange Provider::CreateFolder

Allows you to create a folder within a Messaging Application Programming Interface (MAPI) top-level hierarchy (TLH) and assign permissions.

Exchange Provider::DeleteFolder

Deletes a folder under a MAPI TLH.

Exchange Provider::ModifyFolder

Modifies folder parameters such as quotas, in addition to setting permissions for a folder in a MAPI TLH.

Exchange Provider::CreateGlobalAddressList

Creates a Global Address List (GAL) and applies permissions.

Exchange Provider::DeleteGlobalAddressList

Removes the GAL from the All Global Address Lists and also updates the Exchange configuration container to reflect the changes.

Exchange Provider::CreateOfflineAddressList

Creates an offline address list (OAL) for customers.

Exchange Provider::DeleteOfflineAddressList

Deletes the OAL for customers.

Exchange Provider::RebuildOfflineAddressList

Rebuilds an offline address list for customers.

Exchange Provider::CreateAddressList

Creates an address list in the All Address Lists container and also sets permissions.

Exchange Provider::DeleteAddressList

Deletes the address list from the All Address Lists container.

Exchange Provider::CreateExchangeVirtualDirectory

Creates a virtual directory for a hosted organization to enable access to Outlook Web Access (OWA) by typing a URL such as into a Web browser.

Exchange Provider::DeleteExchangeVirtualDirectory

Deletes the virtual directory for a hosted organization.

  • Hosted Messaging and Collaboration version 3.5

  • Hosted Messaging and Collaboration version 3.0