Equisys technical notes

Technical guidance, explanations and fixes for our products

HOWTO: Configuring Zetafax e-mail gateway with the Novell GroupWise NLM API



ID: ZTN1064

This Zetafax technical note applies to:

  • Zetafax 6.00b to 7.5
  • Novell GroupWise 5.5
  • Novell GroupWise NLM API 4.1


In Zetafax version 7.5 and below, the Zetafax e-mail gateway uses the GroupWise NLM (NetWare loadable module) API to communicate with the GroupWise mail server. The GroupWise domain, that you install the API to, must have the GroupWise Message transfer agent (MTA) running. This technical note assumes that you have purchased and installed the GroupWise NLM API and are familiar with the Netware administrator program NWADMIN32.

For later versions of Zetafax, please refer to our SMTP Email gateway configuration technote:  ZTN1418-HOWTO: Configure the Zetafax Email Gateway for SMTP

More information

Configuring the GroupWise API

  1. Launch NWADMIN32 and select the GroupWise domain object where you have installed the API.
  2. From the 'Object' menu click 'Create.' to launch the 'New Object' dialog box.

  1. Select 'GroupWise Gateway/Internet Agent' from the list and click OK to continue.
  2. Choose the 'Gateway' radio button on the 'Create GroupWise Gateway/Internet Agent' dialog and ensure the following fields are completed before clicking the 'Create' button.

Gateway Name:

The name of the gateway (e.g. FAX)

Gateway Home Directory:

Select the name of the API directory from the list box (e.g. API41 by default).

  1. Highlight the newly created gateway object.
  2. From the 'Object' menu click 'Details.' to launch the 'GroupWise Gateway/Internet Agent:FAX' dialog box, and click on the 'Required Parameters' tab.
  3. By default the 'Gateway File Paths' are mapped drive paths (These will not work), edit the paths to point to the root directory of the API using the syntax SERVER\VOLUME:PATH (e.g. EQNW411\SYS:\MAIL\GWDOM\WPGATE\API41 where 'API41' is the name of the directory where the GroupWise API files are installed).

  1. Ensure the 'Addressing Format:' is set to Component for the gateway to function correctly and click OK.

Starting the GroupWise NLM API

  1. The NLM is loaded at the system console prompt using the following syntax 'load NGWAPI /home-< server> /< volume> :\< path> '. The full path to the API is required unless you include it in the servers search path or it resides in the SYS:SYSTEM directory (e.g. LOAD NGWAPI /HOME-EQNW411/SYS:\MAIL\GWDOM\WPGATE\API41).
  2. Once the GroupWise API has started, verify that the API subdirectories have been created in the GroupWise API directory (e.g. API_IN, API_OUT etc).

Enabling the Zetafax gateway

  1. Ensure that the Zetafax server computer is running the 'Microsoft client for Novell Networks' on Windows 95/98 or the 'Gateway services for Netware' on NT4 rather than the Netware 32 bit clients.
  2. Install the Zetafax e-mail gateway software from the Zetafax CD-ROM or download from the web at www.equisys.com.
  3. Run the Zetafax configuration program (ZFSETUP.EXE) from Start> Programs> Zetafax and select 'Change server settings' to launch the 'Zetafax - Configuration options' dialog.
  4. Highlight the 'Mail' category and select the 'Enabled' radio button to enable the e-mail gateway.
  5. Click the 'Add Mail...' button and double-click Novell GroupWise to add it to the list of installed drivers. Click OK to continue.
  6. Click the 'Configure.' button and highlight 'Novell GroupWise' from the list and click setup to launch the 'Novell GroupWise Setup Service' dialog.

  1. Enter the GroupWise domain name where you installed and configured the API in the 'GroupWise Domain Name' text box.
  2. Select the 'NLM Api' radio button and set the 'Retry interval' to 30 seconds.
  3. Enter the gateway name you specified during the configuration of the GroupWise API (e.g. FAX) in the 'GroupWise FAX (API Gateway) name:' text box and ensure that the 'GroupWise FAX (API Gateway) Path:' is valid. Click OK to continue.
  4. Click the 'Rendering.' button to configure the server based rendering applications that allow e-mail attachments to be rendered by Zetafax.
  5. Click OK to exit the 'Zetafax - Configuration options' dialog. You will be prompted that Zetafax needs to build a list of the GroupWise users to enable them to use the e-mail gateway. Click OK to continue.
  6. Enter the GroupWise domain name where you installed and configured the API in the 'Main Domain Name' text box, and the corresponding GroupWise post office for the above domain in the 'Main Post Office Name' text box. The API path will automatically be populated. Click OK to import the users from the specified post office.

  1. Once the import is complete use the Zetafax configuration program (ZFSETUP.EXE) and select 'Users and user groups' to enable these users.
  2. If you have an existing user configured, you can enable this user to use the e-mail gateway by highlighting the user's entry and clicking the 'Edit' button. Alternatively, to create a new user, click the 'New' button.
  3. To allow a user to send and receive messages from GroupWise via Zetafax check the box marked 'Allow sending from e-mail gateway' and 'Forward received messages via e-mail' the 'E-mail user name' text box will be automatically populated with the corresponding GroupWise user. If the Zetafax user is unable to be mapped to the corresponding GroupWise user, use the 'Browse' button to select it manually.

  1. Repeat this procedure for all users you wish to enable to use the e-mail gateway.

Testing the Zetafax gateway.

Once the GroupWise user has a Zetafax account he is now able to send faxes from his mail client. This is achieved by following the instructions below.

  1. Launch the GroupWise client using a valid mailbox of a user configured to use the Zetafax e-mail gateway.
  2. Click 'New> Mail' from the File Menu to display the 'Mail To:' dialog box.
  3. Enter the address in the 'To' field in the following format:
< Recipient name> [< Organisation> ]@< Fax number> @Fax

e.g. Jim Jones[ABC inc]@4567@Fax

This entry will be stored in the 'Frequent Contacts' tab of the GroupWise address book for future use.

  1. Compose the e-mail and click send.
  2. Zetafax will receive the mail from the GroupWise API, populate the coversheet with the recipient's details and render the attachments then send the fax. After a few minutes, Zetafax will return a notification to the users GroupWise inbox, indicating whether the message was successfully sent or not.


For additional information on Zetafax and Novell GroupWise, please see page 345 of the Zetafax software guide 'Installing the Zetafax e-mail gateway for Novell GroupWise'.

ZTN1418-HOWTO: Configure the Zetafax Email Gateway for SMTP

Last updated: 05 July 2005 (GC/DH/EB)

Equisys Logo, Document Management and Expense Management for Business Central

Replaced by script