Exchange Provider::CreateOfflineAddressList

  • Article

The CreateOfflineAddressList method creates an offline address list (OAL) for customers. This method will set the OAL as a well-known object in the organization, by using the otherWellKnownObjects attribute. This combines the DN of the OAL with a special globally unique identifier (GUID) that identifies it as an OAL, assuming that only one address list (a copy of the GAL) is included with the OAL.

The CreateOfflineAddressList method performs the following steps:

  • Creates the OAL in the Offline Address Lists container.

  • Grants the following permissions to the principals specified in <readAccess>.

    • Read

    • Execute

    • Read Permissions

    • List Contents

    • Read Properties

  • Sets the new offline address list as an otherWellKnownObjects attribute on the organization, by using the value: WKGUID=D22DFCC5B73645e99E16C9AD3D61F34F.

Arguments

Input argument Required Description

Path

Yes

The Lightweight directory access protocol (LDAP) path of the organization.

Name

No

The name of OAL. The default is the Relative Distinguished Name (RDN) of the organization.

ReadAccess

No

The groups and users that have read access to the address list. This parameter can have multi-values, such as an LDAP path, a DN, a UPN, or DOMAIN\SAMAccount, as shown in the following example:

<readAccess>LDAP://server/cn=johnc,ou=litware,dc=fabrikam,dc=com 
</readAccess> 
<readAccess>LDAP://cn=johnc,ou=litware,dc=fabrikam,dc=com</readAccess> 
<readAccess>cn=johnc,ou=litware,dc=fabrikam,dc=com</readAccess> 
<readAccess>johnc@litware.com</readAccess> 
<readAccess>fabrikam\johnc</readAccess>

PublicMDB

No

The DN of the public MDB that will host the OAB. The MDB must be associated with the MAPI Public Folder Tree. The first MDB is associated with the MAPI Public Folder Tree, by default, as shown in the following examples:

<publicMDB>CN=Public Folder Store (EXSMTP01),CN=First Storage Group,CN=InformationStore,CN=EXSMTP01,CN=Servers,CN=First Administrative Group,CN=Administrative Groups,CN=First Organization,CN=Exchange,CN=Services,CN=Configuration,DC=fabrikam,DC=com 
</publicMDB> 
<publicMDB>LDAP://CN=Public Folder Store (EXSMTP01),CN=First Storage Group,CN=InformationStore,CN=EXSMTP01,CN=Servers,CN=First Administrative Group,CN=Administrative Groups,CN=First Organization,CN=Exchange,CN=Services,CN=Configuration,dc=fabrikam,dc=com 
</publicMDB> 
<publicMDB>LDAP://DC01/CN=Public Folder Store (EXSMTP01),CN=First Storage Group,CN=InformationStore,CN=EXSMTP01,CN=Servers,CN=First Administrative Group,CN=Administrative Groups,CN=First Organization,CN=Exchange,CN=Services,CN=Configuration, 
dc=fabrikam,dc=com 
</publicMDB>

OfflineABStyle

No

Contains the status of the default Exchange address book schedule, as stored in the offlineABSchedule attribute. By default, offlineABStyle is set to run. Following are examples of offlineABStyle:

<offlineABStyle>NeverRun</offlineABStyle>  
<offlineABStyle>Run</offlineABStyle>  
<offlineABStyle>AlwaysRun</offlineABStyle>

OfflineVersion

No

The version of the OAB. By default, this value is set to zero, which indicates that the OAB version is not required to be compatible with either Microsoft Exchange Server 4.0 or 5.0. For example:

<offlineVersion>0</offlineVersion>  
<offlineVersion>1</offlineVersion>  
<offlineVersion>2</offlineVersion>

Output Parameters

The CreateOfflineAddressList method can return the following Exchange-specific error codes:

  • 0x82000065 - The publicMDB does not point to a Public MDB.

  • 0x82000066 - The MDB specified by publicMDB does not host the MAPI Public Folder Tree.

Remarks

Rollback Calls

The CreateOfflineAddressList method calls the DeleteOfflineAddressList method on transaction rollback.

Sample Code

Example XML Request

The following is an example of an XML request for the CreateOfflineAddressList method of the Exchange Provider:

<request> 
    <data/> 
        <procedure> 
            <execute namespace='Exchange Provider' 
             procedure='CreateOfflineAddressList'> 
                <executeData> 
                <path>  
                 LDAP://fabrikam.com/OU=litware, 
                 OU=consolidatedmessenger,DC=fabrikam, 
                 DC=com 
                </path> 
                <name>litware</name> 
                <readAccess>  
                 LDAP://fabrikam.com/ 
                 CN=litware_admins,OU=litware,OU=consolidatedmessenger, 
                 DC=fabrikam,DC=com 
                </readAccess> 
                <readAccess>  
                 LDAP://fabrikam.com/ 
                 CN=litware_users,OU=litware,OU=consolidatedmessenger, 
                 DC=fabrikam,DC=com 
                </readAccess> 
                </executeData> 
            </execute> 
        </procedure> 
</request>

Example XML Response

No example XML response.

Applies To

Exchange Provider API for:

  • Hosted Messaging and Collaboration version 3.5

  • Hosted Messaging and Collaboration version 3.0

See also

Tasks

Exchange Provider::DeleteOfflineAddressList
Exchange Provider::RebuildOfflineAddressList