SmarterMail - Ensim Integration

 

March, 2004

 

Copyright © 2003-2004 SmarterTools Inc. All rights reserved.


Contents

  1. Introduction
  2. Installation and Setup
  3. Troubleshooting

 


1. Introduction (TOP)

This document provides information on how to implement and use the Ensim Control Panel Plug-in for SmarterMail Professional Edition.  This plug-in can be applied to Ensim Webppliance(tm) Pro for Windows v3.2.0 and higher, herein referred to as Ensim.

This integration allows for control of many aspects of SmarterMail from directly within Ensim.  Please follow the instructions contained in this readme carefully, as proper configuration is required for the plug-in to work properly.


2. Installation and Setup (TOP)

2.1. License

Before Unzipping and Installing this product, be sure to read the License Agreement (included with this software) carefully. By using the software, you also accept and agree to the License Agreement.

2.2. System Requirements

In order for this plug-in to function properly, please ensure that you meet the following prerequisites:

2.2. Unzip the software

Unzip the software to a folder on your computer's hard drive. The unzipped folders and files will have a structure similar to this :

2.3. Modify the config.xml file, if necessary

You will need to modify the config.xml file if you have changed any of the following:

If you have not changed any of the items above, please skip to section 2.4.

To change the config.xml file, perform the following steps:

  1. Open Windows Explorer and open the directory to which you extracted the plug-in
  2. Right-click on config.xml and choose "Edit" or "Open with Notepad"
  3. If you have changed the global admin username or password in SmarterMail, change the following values:
    1. authUsername = new SmarterMail global admin username
    2. authPassword = new SmarterMail global admin password
  4. If you have elected to not use the SmarterMail web server, and have chosen to use IIS instead, change the following value:
    1. url = new URL used to reach the SmarterMail web interface.  Note: if you are not using port 80, the default port for IIS, you must specify the port in the URL also, like localhost:9999 or 192.168.1.190:900.
  5. If you have used the SmarterMail web server configuration utility to change the default settings change the following value:
    1. url = new URL used to reach the SmarterMail web interface.  Note: if you are not using port 80, the default port for IIS, you must specify the port in the URL also, like localhost:9999 or 192.168.1.190:900.
  6. Save the file
  7. Once completed, drag the new config.xml file over SmarterMail_Addon.zip to replace the file in the archive

Failure to properly complete these steps on a non-default configuration will result in failure of the software to work.

2.4. Move SmarterMail_Addon.zip to C:\

Using Windows Explorer, copy the file SmarterMail_Addon.zip to the root of C:.  This is necessary in order to properly register the plug-in with Ensim.

2.5. Register the Plug-in 

Go back to the temporary directory where you unzipped SmarterMail_Addon_Setup.zip, and double-click on setup.bat.  This will call the Ensim RegisterMailAddon API.  A series of message boxes will appear during installation.  Simply click on OK to each box, and the process will continue.  If the registration of SmarterMail fails, it will appear in one of the above mentioned message boxes.

When the registration succeeds, SmarterMail will be active in Ensim.


3. Troubleshooting (TOP)

If you are experiencing difficulty installing and running the plug-in, please use one of the following sources of support:

 


Copyright (c) 2003-2003 SmarterTools Inc. All rights reserved.