Exchange Provider::CreateExchangeVirtualDirectory

  • Article

The CreateExchangeVirtualDirectory method creates a virtual directory for a hosted organization to enable access to Outlook Web Access (OWA) by typing a URL such as https://mail.consolidatedmessenger.com/litware into a Web browser. The virtual directory will be associated with the SMTP domain for Litware (in this case the SMTP domain name is litware.com).

To ensure that only SSL connections are accepted and that access through Hypertext Transfer Protocol (HTTP) is denied, the flag MD_ACCESS_SSL is set on the property MD_SSL_ACCESS_PERM. You must also update the associated Active Directory object, otherwise DS2MB will override the metabase settings.

Arguments

Input argument Required Description

SMTPDomain

Yes

The SMTP Domain associated with the virtual directory. This parameter is required if the folderPath parameter is not set or when it is set to MBX. The SMTPDomain parameter is optional if the folderPath parameter is set to anything other than MBX.

Server

Yes

The Exchange Server NetBIOS name.

ServerInstance

Yes

An instance ID of the virtual server on which to create the virtual directory.

Name

Yes

The name of the virtual directory. This parameter should not include the character "." in the virtual directory name specification.

SSLEnable

No

Set to True to require SSL on the virtual server. The default is False if the Exchange Server is a back-end server, and True if the Exchange Server is a front-end server. For example:

<sslEnable>true</sslEnable>

FolderPath

No

The path to the top-level public folder exposed by the virtual directory. If this parameter is not set, the virtual directory will expose mailboxes. The default value is MBX. The following is an example of specifying this parameter:

<folderPath>Public Folders\litware</folderPath>

\AuthenticationDomain

No

The default domain used by basic authentication. The default value is "\". The following is an example of specifying this parameter:

<authenticationDomain>DomainName</authenticationDomain>

DefaultLogonDomain

No

Sends a remote procedure call (RPC) to the server to get the domain name. The default value for this parameter is the domain name of the Exchange Server. The following is an example of specifying this parameter:

<defaultLogonDomain>DomainName</defaultLogonDomain>

Note

When creating mailbox vdirs, set the smtpDomain but not the folderPath. When creating public folder vdirs, set the folderPath but not the smtpDomain.

Remarks

Rollback Calls

The CreateExchangeVirtualDirectory method calls the DeleteExchangeVirtualDirectory method on transaction rollback.

Sample Code

Example XML Request

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

<request> 
    <data/> 
        <procedure> 
            <execute namespace='Exchange Provider' 
             procedure='CreateExchangeVirtualDirectory'> 
                <executeData> 
                <smtpDomain>litware.com</smtpDomain> 
                <Server>Exchserv1</Server> 
                <serverInstance>1</serverInstance> 
                <name>litware</name> 
                <sslEnable>true</sslEnable> 
                </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::DeleteExchangeVirtualDirectory