exchdapi.md

exchdapi

Module exchdapi

An COM interface to Exchange's DAPI

Methods

• HrInstallService

   

• HrInstallMailboxAgent

   

• HrCreateMailboxAgentProfile

   

• HrCreateGatewayProfile

   

• HrMailboxAgentExists

   

• HrAdminProgramExists

   

• HrRemoveMailboxAgent

  Removes a Mailbox Agent 

• HrRemoveProfile

  Removes a profile 

• HrEnumOrganizations

  Lists the names of the organizations on the server. 

• HrEnumSites

  Lists the names of the sites in an organization. 

• HrEnumContainers

  Lists the names of the containers on the server 

• HrEnumSiteAdmins

  Lists the administrators for a site. 

• HrGetServiceAccountName

  Obtains the account name for a service. 

exchdapi.HrAdminProgramExists

HrAdminProgramExists()

exchdapi.HrCreateGatewayProfile

HrCreateGatewayProfile(serviceName, profile)

Parameters

• serviceName : string

  The name of the service.

• profile : string

  The profile.

exchdapi.HrCreateMailboxAgentProfile

HrCreateMailboxAgentProfile(serviceName, profile)

Parameters

• serviceName : string

  The name of the service.

• profile : string

  The profile.

exchdapi.HrEnumContainers

[string, ...] = HrEnumContainers(server, siteDN

, fSubtree

) Lists the names of the containers on the server

Parameters

• server : string

  The name of the server

• siteDN : string

  Distinguished name (DN) of the site.

• fSubtree : int

exchdapi.HrEnumOrganizations

[string, ...] = HrEnumOrganizations(rootDN, server

) Lists the names of the organizations on the server.

Parameters

• rootDN : string

  Contains the distinguished name (DN) of the directory information tree (DIT) root.

• server : string

  The name of the server

exchdapi.HrEnumSiteAdmins

[string, ...] = HrEnumSiteAdmins(server, siteDN

) Lists the administrators for a site.

Parameters

• server : string

  The name of the server

• siteDN : string

  Distinguished name (DN) of the site.

exchdapi.HrEnumSites

[string, ...] = HrEnumSites(server, organizationDN

) Lists the names of the sites in an organization.

Parameters

• server : string

  The name of the server

• organizationDN : string

  Contains the distinguished name (DN) of the organization.

exchdapi.HrGetServiceAccountName

string = HrGetServiceAccountName(serviceName, serviceName

) Obtains the account name for a service.

Parameters

• serviceName : string

  The name of the service

• serviceName : string

  The name of the service

exchdapi.HrInstallMailboxAgent

HrInstallMailboxAgent()

exchdapi.HrInstallService

HrInstallService()

exchdapi.HrMailboxAgentExists

HrMailboxAgentExists(server, siteDN, rdn)

Parameters

• server : string

  The name of the server

• siteDN : string

  Contains the distinguished name (DN) of the site.

• rdn : string

  RDN of the site where the mailbox agent might exist.

exchdapi.HrRemoveMailboxAgent

HrRemoveMailboxAgent(server, siteDN, rdn) Removes a Mailbox Agent

Parameters

• server : string

  The name of the server

• siteDN : string

  Contains the distinguished name (DN) of the site.

• rdn : string

  RDN of the site where the mailbox agent exists.

exchdapi.HrRemoveProfile

HrRemoveProfile(profile) Removes a profile

Parameters

• profile : string

  The profile to delete.