Email Setup

The Unanet System has several capabilities that rely on the ability to send email.  If you intend to use any of these robust features, you'll first need to set a few properties to enable the use of Email.

The topics covered on this page include:


Setting your Email properties

In order for the E-mail option to work, the Unanet Email parameters must be set. Open the unanet.properties file located on the web server.  Add the following lines to the end of the file (if they are not already there), replacing the bold print with your values:

unatime.email=true
mail.host=MAILSERVER.DOMAIN.com
unatime.email.default_from_address=unatime_admin@DOMAIN.com

To disable the E-mail option, set   unatime.email=false.

Please note, changes to any of the properties files will require a stop and restart of the Servlet Engine (e.g. JRun/Tomcat service) in order for the changes to take effect.

If the users in your Unanet system utilize various email addresses from other domains (i.e., aol.com, yahoo.com, etc.), you may want to check with your email server administrator with regard to the relaying configuration of the SMTP server.

Note:   Relaying has to do with an smtp server's ability to accept messages and deliver them to third parties (perhaps outside your network).  

Typically, even though relaying may be allowed, it is coupled with restrictions or authentication so that the smtp server cannot be used by other parties to send out spam messages.  

Depending on  the email used in your Unanet system, the administrator may need to change the restrictions currently in place to allow any necessary email relaying.  The administrator will likely need to know the domain, machine name and/or IP address of the Unanet server and perhaps the domains of the email addresses used in the Unanet system in order to verify the settings.


Restarting your Servlet Engine

You'll find that whenever you change any Unanet properties files, the changes will only take effect after you restart your Servlet Engine.  How you restart your Servlet Engine depends on your system setup, but usually it is as simple as stopping and restarting a windows service or a Unix process.  For instance, if you used the default JRun 4.0 installation procedures on a Windows platform, you can go to your services window and restart the "Macromedia JRun Default Server" service.  If you are using Tomcat as a service, you simply restart the "Apache Tomcat" service.

Note 2:  If you used the advanced setup for your servlet engine, you'll need to restart the service that corresponds to the Unanet version that you are trying to change.


Testing out Email

Before sending a test Email, make sure you have a valid ID with an Email address created in your Unanet System. Log into your Unanet system as an administrator and navigate to the Administrator/Export/Template/Export page.  Check any one of the listed templates and type in your Email address at the bottom and hit "Submit".  You should receive an email containing the template from your Unanet system.

If you are experiencing email issues, check out the Email Troubleshooting Tips page.


SMTP Authentication

If your email service provider's SMTP server requires authentication  there are a number of properties that can be configured to address this need.  In particular, the following three properties will minimally need to be set in your unanet.properties configuration file (with the necessary servlet engine restart afterwards):

Warning: setting mail.auth=true without setting both mail.user and mail.password will generate start up errors for email.

 

The Unanet Email service will use these credentials to authenticate with the SMTP server when sending messages.

Note: Depending on your email service provider and whether you are using additional features (such as SSL), additional mail properties may need to be configured.  Also note that depending on your servlet engine, your options may be limited (e.g. JRun loads its internal classes first and is currently still on JavaMail 1.3.1 which does not support all settings supported by later JavaMail versions).  

If you are using a hosted SMTP platform (e.g. Google Apps for Business), you will need to add the syntax below in your unanet.properties file in order to start TLS to relay messages. (These properties cannot be edited via the user interface).

In the unanet.properties file you would choose which transport you'll want to use (TLS or SSL), then configure the port. 

mail.smtp.ssl.enable=true
mail.smtp.starttls.enable=true 

(ie. SSL ports for Google -> 587 port for TLS and 465 for SSL)

Example to enable TLS:
mail.smtp.ssl.enable=true
mail.smtp.port=465

Example to enable SSL:
mail.smtp.ssl.enable=true
mail.smtp.port=587

You may need to contact Unanet support to work with you to identify which additional properties may be necessary.  Setting the mail.debug property to true may be useful in troubleshooting mail authentication configuration issues.


Next Step

Step 8 - Finish the Installation

Once you have completed the email setup, you can proceed to step 8 to finish the installation process.