Share via

Managed Email 2007::CreateOfflineAddressBook

  • Article

This procedure creates an offline address book for a business organization.

Arguments

Input Arguments Type Required Description

<preferredDomainController>

string

Yes

The name of the Active Directory domain controller.

<organization>

string

Yes

The LDAP path of the organization object that is associated with the address list.

<name>

string

Yes

The name that describes the OAB object in Exchange System Manager .The name cannot exceed 64 characters, and it cannot include a carriage return or a backslash (\).

<versions>

complexType

No

This parameter specifies the version list of supported OAB.

<versions/ version>

enum

No

This parameter specifies what version of OAB to generate. Enum:

  • Version2

  • Version3

  • Verison4

If this parameter is not set, the default value is all of the three. But web based OAB only supports Version4.

<readAccess>

complexType

No

The container for a collection of LDAP path of groups or users that will be granted read access to the new Address List.

<readAccess/ value>

string

No

The LDAP path of a user or group that will be granted read access to the new address list.

<publicFolderDistributionEnabled>

boolean

No

If the value is true, the OAB will be distributed via public folders. Default: False

<algorithm>

enum

No

This parameter specifies the OAB Server selection algorithm. Enum: 1. tightPack --attempts to use the smallest number of servers 2. level - seeks to spread allocations evenly across servers. The default value is tightPack.

<webDistributionEnabled>

boolean

No

If the value is true, the OAB will be distributed via web distribution points. Default: True.

<MBXGenSvr>

string

No

This parameter specifies the mail server on which the OAB is generated.

<OABCASPool>

string

No

Name of the OABCASPool. If WebDistributionEanbled = True, a value must exist in either OABCASPool or OABCASPoolTag.

If this value is not null, ignore the input schema for OABCASPoolTag.

<OABCASPoolTag>

string

No

A tag name representing the pool.

If OABCASPool is not specified and a tag value is not null, filter the list of available pools with the tag value, and select one pool.

If multiple pools match the tag value and are returned, use the first returned pool.

Remarks

Security

The caller must be at least a member of role: UserCreators.

Schema Definition

Input

<executeData> 
    <preferredDomainController>1..1</preferredDomainController> 
    <organization>1..1</organization> 
    <name>1..1</name> 
    <versions> 
        0..1 
        <version>0..unbounded</version> 
    </versions> 
    <readAccess> 
        0..1 
        <value>1..unbounded</value> 
    </readAccess> 
    <publicFolderDistributionEnabled>0..1</publicFolderDistributionEnabled> 
    <algorithm>0..1</algorithm> 
    <webDistributionEnabled>0..1</webDistributionEnabled> 
    <mbxGenSvr>0..1</mbxGenSvr> 
    <oabCASPool>0..1</oabCASPool> 
    <oabCASPoolTag>0..1</oabCASPoolTag> 
</executeData>

Output

<executeData>1..1 </executeData>

Sample Code

Example XML Request

<request> 
  <data> 
    <!--The domain controller to use for Active Directory actions.--> 
    <preferredDomainController>AD01.Fabrikam.Com</preferredDomainController> 
    <!--The LDAP path of the organization object that is associated with the address list.--> 
    <organization>LDAP://OU=AlpineSkiHouse,OU=ConsolidatedMessenger,OU=Hosting,DC=fabrikam,DC=com</organization> 
    <!--The desired name for the new address list. The name cannot exceed 64 characters, and it cannot include a carriage return or a backslash (\).--> 
    <name>AlpineSkiHouse OAL</name> 
    <!--Specifies what version of OAB to generate.--> 
    <versions> 
      <!--Specifies a version of OAB to generate.--> 
      <version>Version4</version> 
    </versions> 
    <!--Container for a collection of LDAP path of groups or users that will be granted read access to the new Address List.--> 
    <readAccess> 
      <!--LDAP path of a user or group that will be granted read access to the new address list.--> 
      <value>LDAP://CN=Admins@AlpineSkiHouse,OU=AlpineSkiHouse,OU=ConsolidatedMessenger,OU=Hosting,DC=Fabrikam,DC=Com</value> 
    </readAccess> 
    <!--If the value is true, the OAB will be distributed via public folders.--> 
    <publicFolderDistributionEnabled>true</publicFolderDistributionEnabled> 
    <!--Specify the algorithm to create OAB. Default is tightPack.-->
    <algorithm>level</algorithm> 
    <!--If the value is true, the OAB will be distributed via web distribution point.--> 
    <webDistributionEnabled>true</webDistributionEnabled> 
    <!--Specify the mail server on which the OAB is generated.--> 
    <mbxGenSvr>EXMBXOAB01</mbxGenSvr> 
    <!--Name of the OABCASPool. If WebDistributionEanbled = True, then a value must exist in either OABCASPool or OABCASPoolTag. If this value is not null, ignore the input schema for OABCASPoolTag.--> 
    <oabCASPool>CasOABPool001</oabCASPool> 
    <!--A tag name representing the pool. If OABCASPool is not specified, and a tag value is not null, filter the list of available pools with the tag value, and select one pool. If multiple pools match the tag value and are returned, use the first pool returned.--> 
    <oabCASPoolTag>Non HA</oabCASPoolTag> 
  </data> 
  <procedure> 
    <execute namespace="Managed Email 2007" procedure="CreateOfflineAddressBook" impersonate="1"> 
      <before source="data" sourcePath="preferredDomainController" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="organization" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="name" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="versions" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="readAccess" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="publicFolderDistributionEnabled" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="webDistributionEnabled" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="mbxGenSvr" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="oabCASPool" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="oabCASPoolTag" destination="executeData" mode="move" /> 
      <after source="executeData" destination="data" mode="merge" /> 
    </execute> 
  </procedure> 
</request>

Applies To

  • Hosted Messaging and Collaboration version 4.5

  • Hosted Messaging and Collaboration version 4.0

See also

Other Resources

API Name [HMC SDK]