Share via

Exchangel 2007 Provider::CreateOfflineAddressBook

  • Article

This method creates an offline address book (OAB) for a customer. And it updates the access rules in Active Directory so that only users in the specified organization have the permission to download the OAB.

Arguments

Input Arguments Type Required Description

<preferredDomainController>

string

Yes

The name of the Active Directory domain controller.

<path>

string

Yes

The Lightweight directory access protocol (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 (\).

<server>

string

Yes

This parameter specifies the mail server on which the OAB is generated. Refer to Managed Email 2007::CreateOfflineAddressBook for the server selection.

<schedule>

string

No

This parameter specifies the interval scheduled for generating the new OAB. values: Never|Always|Mon.01:00-Mon.02:00, Wed.01:00-Wed.02:00.

In the provisioning system, OAB update will be performed by a standalone tool. So managed layer will always set the schedule parameter to "Never" during calls into this procedure.

<versions>

complexType

No

This parameter specifies version list of supported OAB.

<versions/ version>

enum

No

This parameter specifies a 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 support 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

<publicFolderDatabase>

string

No

This parameter specifies the identity of a public folder database.

<webDistributionEnabled>

boolean

No

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

<virtualDirectories>

complexType

No

This parameter specifies the distribution point list of the web based OAB.

<virtualDirectories / virtualDirectory>

string

No

A combination of the CAS server name and the virtual directory path on it.

<SkipPublicFolderInitialization>

boolean

No

This parameter specifies whether to skip an immediate public folder initialization in order to make a better performance. Default: True

Remarks

Rollback Method: DeleteOfflineAddressBook

Security

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

Schema Definition

Input

<executeData> 
    <preferredDomainController>1..1</preferredDomainController> 
    <path>1..1</path> 
    <name>1..1</name> 
    <server>1..1</server> 
    <schedule>0..1</schedule> 
    <versions> 
        0..1 
        <version>0..unbounded</version> 
    </versions> 
    <readAccess> 
        0..1 
        <value>1..unbounded</value> 
    </readAccess> 
    <publicFolderDatabase>0..1</publicFolderDatabase> 
    <publicFolderDistributionEnabled>0..1</publicFolderDistributionEnabled> 
    <webDistributionEnabled>0..1</webDistributionEnabled> 
    <virtualDirectories> 
        0..1 
        <virtualDirectory>1..unbounded</virtualDirectory> 
    </virtualDirectories> 
    <skipPublicFolderInitialization>0..1</skipPublicFolderInitialization> 
</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.--> 
    <path>LDAP://OU=AlpineSkiHouse,OU=ConsolidatedMessenger,OU=Hosting,DC=fabrikam,DC=com</path> 
    <!--The desired name for the new offline address book. The name cannot exceed 64 characters, and it cannot include a carriage return or a backslash (\).--> 
    <name>AlpineSkiHouse OAL</name> 
    <!--Specifies the server that the new OAB will be created on.--> 
    <server>EXMBXOAB01</server> 
    <!--Specifies the interval scheduled for generating the new OAB.  values: Never|Always|Mon.01:00-Mon.02:00, Wed.01:00-Wed.02:00--> 
    <schedule>Never</schedule> 
    <!--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> 
    <!--This parameter specifies the identity of a public folder database.--> 
    <publicFolderDatabase>EXMBXOAB01\SG03\PublicFolderStore01</publicFolderDatabase> 
    <!--If the value is true, the OAB will be distributed via public folders.--> 
    <publicFolderDistributionEnabled>true</publicFolderDistributionEnabled> 
    <!--If the value is true, the OAB will be distributed via web distribution points specified by the virtual directories.--> 
    <webDistributionEnabled>true</webDistributionEnabled> 
    <!--Specifiy the distribution point list of the web based OAB.--> 
    <virtualDirectories> 
      <!--A combination of the CAS server name and the virtual directory path on it.--> 
      <virtualDirectory>EXCASOAB01\OAB (Default Web Site)</virtualDirectory> 
    </virtualDirectories> 
    <!--Specify whether to skip an immediate public folder initialization, in order to make a better performance.--> 
    <skipPublicFolderInitialization>true</skipPublicFolderInitialization> 
  </data> 
  <procedure> 
    <execute namespace="Exchange 2007 Provider" procedure="CreateOfflineAddressBook" impersonate="1"> 
      <before source="data" sourcePath="preferredDomainController" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="path" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="name" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="server" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="schedule" 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="publicFolderDatabase" 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="virtualDirectories" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="skipPublicFolderInitialization" destination="executeData" mode="move" /> 
      <after source="executeData" destination="data" mode="merge" /> 
    </execute> 
  </procedure> 
</request>

Example XML Response

<response>  
        <data /> 
</response>

Applies To

Exchange 2007 Provider Namespace for:

  • Hosted Messaging and Collaboration version 4.5

  • Hosted Messaging and Collaboration version 4.0

See also

Tasks

Exchange 2007 Provider::DeleteOfflineAddressBook
Managed Email 2007::ModifyOfflineAddressBook
Managed Email 2007::RebuildOfflineAddressBook