Email Manager Service Overview

Email Manager Service Overview

The Email Manager service runs as a Windows Service and is usually installed on a “server” style machine that does not get powered down.

HelpMaster Services

Before the service can be started, you will need to specify the “Log On As” user account.  Typically, this account is a dedicated “HelpMaster service account” that has been created to run all of the HelpMaster services (Email Manager, Priority Manager, Automation, Active Directory etc).  For further inforamation about this account, see HelpMaster Service Account

The Email Manager service is the working element of the Email Manager - it is the application that executes all of the Email Manager profiles that you have defined.  Once it has been installed and configured, it requires no further maintenance or configuration.  It will run continuously on the machine and perform all of the HelpMaster Email Manager activity.

The Email Manager service will log events in both the Windows Event Log, as well as the HelpMaster database.  See Email Manager event log for further details.

Configure the Email Manager Service

Note : Before the Email Manager Windows service will start, please ensure that you have…

  1. Installed the Email Manager Service
  2. Configured the general Email Manager settings
  3. Set the database connection that the Email Manager service will use

In order to configure the settings for the Email Manager Service, do the following.

  1. Click Start menu

  2. Select Settings > Control Panel > Administrative Tools > Services to display the Windows Services screen

     

  3. Right-click the HelpMaster Email Manager Service to display the Properties screen

    The Startup type: should be set to Automatic (Delayed Start).  This will allow the service to automatically start after the machine has been rebooted.  

  4. Click on the Log On tab

    Click This account and choose the service account that you previously created which has sufficient network and email system security permissions. Enter the password twice as shown  

  5. Click OK or Apply

Starting the Email Manager Windows Service

Once all of the configuration settings have been set, you will need to start the Email Manager service to start processing email.  This is performed via the Email Manager Service Setup screen.  This screen can be accessed via the Desktop Edition > HelpMaster Modules > Email Manager Service Setup menu, or directly through the Email Manager via the Open > Email Manager Service Setup menu.

In order to start the Email Manager Service, do the following.

  1. Click Start menu
  2. Select Settings > Control Panel > Administrative Tools > Services to display the Windows Services screen 
  3. Right-click on the HelpMaster Email Manager Service service and select Start from the popup menu.
  4. If all of the settings have been configured correctly, the Email Manager service should start successfully.  To verify this you can check the system event message in the Applications section of the Windows Event Log.
  5. All Email Manager service activity will appear in the log files of Email Manager Management console 

Note : As soon as the Email Manager Service start successfully, it will start working upon your HelpMaster database and any Email Manager profiles that are marked as enabled.  To disable profiles, refer to Managing Profiles

Stopping the Email Manager Windows Service

Stopping or pausing the service is similar to starting it.  Click the Stop button to stop the Email Manager service.

Additional Configuration

The Desktop edition of HelpMaster also displays information about the Email Manager Service.

This screen can be accessed via the Desktop Edition > Automation > Email Manager Service Setup menu, or directly through the Email Manager via the Open > Email Manager Service Setup menu

Service Name

This is the name of the Email Manager service as displayed in the list of available Windows Services.  Click on the button Windows Services Viewer to display all of the services installed on the selected machine.  This name here is provided for identification purposes only.

Display Name

This is the name of the Email Manager service as displayed in the list of available Windows Services.  Click on the button Windows Services Viewer to display all of the services installed on the selected machine.  This name here is provided for identification purposes only.

Service Path

This is the path where the Email Manager service is installed.  Click on the button Windows Services Viewer to display all of the services installed on the selected machine.  This name here is provided for identification purposes only.

Service Database

This setting refers to the HelpMaster database that the service will work against.  Click on the icon of a database to set the database connection.  This is a mandatory configuration step.

Testing a Domain/User name

The Email Manager Service needs a Windows account to run as.  This account should have sufficient network security permission to to the following things

  1. Access the HelpMaster SQL Sever database.  Requires both read and write privileges.  See database permissions
  2. Access the HelpMaster network Working Folders .  Requires read privileges.  Note that these working folders are not the same folders in the email system.  These are the file-based working folders that HelpMaster uses to store attachments etc.
  3. Access to all of the Email folders that were specified for each of the Email Manager profiles.  This includes all of the inboxes that were are scanned, as well as all of the “move to” folders that were specified.  The service account user name should also have sufficient network security privilege to send on behalf of any email addresses / accounts that were specified for each of the Email Manager profiles that have been defined.
  4. Local Admin rights - only if the service account is not the owner of the mailbox being scanned.  If you are scanning email accounts that are not owned by the service account, then you will have to grant Local Admin rights to the service account.

Password

This is the password for the service account.  Remember that network passwords can expire, which will affect the performance of a running service.

After you have set the Service account user name and set the password, click on the Test User button to perform a system check of the security credentials required.  If the user account that was specified passes all of these tests, it will be set as the service account, and the service should start and work as expected using this account/password combination.

If the security test fails, you will need to do one of the following

  1. Use another account that has more network security privileges
  2. Modify the existing account so that it does have increased security privileges in the area that the test failed for.

If after doing these things the security test fails, please try browsing the HelpMaster knowledge base articles for further solutions.

Timer interval

The Email Manager service will execute each of the enabled Email Manger profiles in their specified order at regular time intervals based on the value specified in this box.

Failed email folder

When an email fails to be processed for any reason, the Email Manager will move the email to this location and write an event log in the Failed Email Log.  Note that email is only moved here if it has been “picked up” by one of the search filters within a profile, and then unable to be processed for some reason.  Email that is not “picked up” by any search filter within a profile is simply left in the inbox without further processing.

Event Logging

By default, the HelpMaster Email Manager writes logs for all activity it performs to both the HelpMaster database, as well as a Windows Event log.

Logging options are found under the Event Logging Options tab.

Check the “Verbose logging” checkbox to log very detailled logs.  When this check box is checked, the Email Manager will write a comprehensive event log for every action that it performs.  This may be useful for diagnosing configuration problems, or simply for testing and viewing what the Email Manager is doing.  Due to the fact that verbose logging can very quickly fill your event log with much information, this feature will automatically turn itself off after the number of intervals you specify.  To turn it on again, simply check the box again.

See Also

HelpMaster Service Account

Email Manager service configuration