emailgtw
Email Gateway

 The emailgtw probe recieves messages with the subject EMAIL and sends them over the SMTP protocol. The Nimsoft Alarm Server (nas) can be set up to send alarms to the emailgtw probe.

Installation notes

Version 2.20 of this probe allows you to expand time strings offset to the sender's local time if they are in a different timezone. This requires Robot 2.68, Hub 4.20 and NAS 3.03 since the offset was unavailable prior to those versions.

Version 2.00 of this probe allows you to use the email field for a user in NimBUS User Administration in place of a profile for that user. If you want to override the default template and email subject you will need to create a profile.

Version 1.60 of this probe allows you to send emails to defined users when an alarm is assigned to them. If you are using a queue on the Hub the Subject should be changed from "EMAIL" to "EMAIL,alarm_assign". If you are not using a queue you can check the appropriate box in the configuration utility and the probe will subscribe to the alarm_assign messages as well as the EMAIL messages.
Please note that the profile name must match the NimBUS user name exactly for correct operation of email on assignment!

Version 1.41 of this probe requires version 2.03 of the Perl RunTime or SDK to run properly. To test which version is installed you can run the following perl script:
#!perl
use Nimbus::API;
print "$Nimbus::API::VERSION\n";

Some SMTP servers validate the From: address. If this is the case with your SMTP server you should make sure the specified 'Sender email address' is valid.

Variable substitution in Subject and Body when forwarding Alarm messages

Starting with version 1.41 the following variables from the alarm message are supported in the Subject and Body of emails:

  • $level - the severity of the alarm
  • $level_exp - the text representation of that level (e.g critical)
  • $level_col - the colour code for the representation of that level (e.g. critical = #FF0000)
  • $prevlevel - the previous severity of the alarm.
  • $prevlevel_exp - the text representation of that level. (e.g. critical)
  • $prevlevel_col - the colour code for the representation of that level (e.e. critical = #FF000)
  • $subsys - the alarm subsystem
  • $message - the message text
  • $nimid - the message id
  • $nimts - the message timestamp (when it was sent originally)
  • $nimts_exp - the human readable form of $nimts
  • $source - the IP address of the machine that sent the alarm
  • $domain - the NimBUS Domain the Robot is in
  • $hub - the NimBUS Hub the Robot belongs to
  • $robot - the name of the Robot which sent the alarm
  • $prid - the probe ID
  • $hostname - the hostname of the machine that sent the alarm
  • $hostname_strip - the hostname of the machine that sent the alarm without the domain portion (if present)
  • $sid - the subsystem ID in the NAS
  • $supp_key - the suppression key (will often contain the checkpoint)
  • $arrival - the timestamp when the NAS recieved the alarm
  • $arrival_exp - the human readable form of $arrival
  • $aots - the timestamp when the NAS AO last checked the alarm
  • $aots_exp - the human readable form of $aots
  • $supptime - the timestamp of the last suppression of this message
  • $supptime_exp - the human readable form of $supptime
  • $suppcount - the number of times this alarm has been suppressed
  • $count - the number of times this alarm has arrived
  • $exported_by - the NimBUS Address of the NAS which exported this message
  • $exported_type - the type of export
  • $assigned_at - the timestamp when the alarm was assigned to a user
  • $assigned_at_exp - the human readable form of $assigned_at
  • $assigned_to - the user which the alarm was assigned to
  • $assigned_by - the user which assigned the alarm
Revision history
Date Description State Version
29.04.2022

What's New:

  • Updated to support the Microsoft Visual C++ Redistributable for Visual Studio 2017 package version 1.00 (vs2017_vcredist_x64 1.00). This support ensures that the minimum version of the VS 2017 package is equal to or greater than 1.00.
  • Enable the probe to support the SMTP server using TLS 1.2. This support is added only in IM GUI as a beta release.
  • The probe is only supported on Windows 64 bit and Linux 64 bit.
SHA-256 Checksum: ee3c6cbf1859aa866e6b210d4def30326e94b275a1a90d5c50d126dc69b5a1ed 		GA 2.90
17.10.2017

What's New:

  • Added support for Japanese(ISO-2022-JP) and Japanese(Shift_JIS) locales when configuring email messages.

Fixed Defects:

  • The probe was not sending assignment notification to the account users. Salesforce case: 00659512

For Detailed Release Notes-Please refer to

https://docops.ca.com/rest/ca/product/latest/topic?format=rendered&language=&space=UIMPGA&hid=emailgtw_RN

Note: Support case(s) may not be viewable to all

1ef0d3dad28dabf35829fa4553563e51
d9bfa2b55737bafc9a0fb8e9ab85a3dbee412995
2.84
06.01.2017 Fixed Defects:
1. The probe incorrectly converted < and > symbols from alarm messages as > and < respectively in plaintext emails. Support case number 517592
2. Added steps to enable the probe to connect to the SMTP server on Linux platforms. Support case number 581109
For more information, see the SMTP Connection on Linux Robots section in Known Issues and Workarounds.
3. The probe also expanded undefined variables in emails as NULL values. Support case number 584956
For more information, see the Undefined Variable Expansion to NULL Values section in Known Issues and Workarounds.

For Detailed Release Notes-Please refer
https://wiki.ca.com/rest/ca/product/latest/topic?format=rendered&language=&space=UIMPGA&hid=emailgtw_RN

Note: Salesforce case(s) may not be viewable to all 		2.83
27.07.2016 Fixed Defect:
The probe incorrectly converted < and > symbols from alarm messages as html text and displayed them as > and < in email subjects. Support case number 337855

For Detailed Release Notes-Please refer
https://wiki.ca.com/rest/ca/product/latest/topic?format=rendered&language=&space=UIMPGA&hid=emailgtw_RN

Note: Salesforce case(s) may not be viewable to all 		2.82
20.05.2016 Fixed Defects:
The probe incorrectly converted < and > symbols from alarm messages as html text and displayed them as > and < in emails. Support case number 00337855

For Detailed Release Notes-Please refer
https://wiki.ca.com/rest/ca/product/latest/topic?format=rendered&language=&space=UIMPGA&hid=emailgtw_RN

Note: Salesforce case(s) may not be viewable to all 		2.81
22.04.2016 What's New:
Added support to send emails in Traditional Chinese.

Fixed Defects:
1. The probe sent the variable name in the email text if the custom variable did not have a value. Support case number 316627
2. The Admin Console interface of the probe was not available on Linux robots. Support case number 00321875

For Detailed Release Notes-Please refer
https://wiki.ca.com/rest/ca/product/latest/topic?format=rendered&language=&space=UIMPGA&hid=emailgtw_RN

Note: Salesforce case(s) may not be viewable to all 		2.80
08.01.2016 Fixed Defects:
The probe crashed when you manually executed the script. Support Case Number 7005789

For Detailed Release Notes-Please refer
https://wiki.ca.com/rest/ca/product/latest/topic?format=rendered&language=&space=UIMPGA&hid=emailgtw_RN

Note: Salesforce case(s) may not be viewable to all 		2.74
18.09.2015 Fixed Defects:
1. The probe now includes the entire alarm string in the email messages. Salesforce case 00160416
2. Updated the preconfiguration requirements in the Release Notes about installing SMTP Server certificate for using TLS functionality. Salesforce case 00154509

For Detailed Release Notes-Please refer
https://wiki.ca.com/rest/ca/product/latest/topic?format=rendered&language=&space=UIMPGA&hid=emailgtw_RN

Note: Salesforce case(s) may not be viewable to all 		2.73
31.12.2014 Fixed Defects:
Fixed a defect where the probe did not support characters more than 1024 in the Email field in the Profiles section for the exchange server, and the SMTP server. (Salesforce Case: 00145450)
Fixed a defect where the probe was crashing frequently. (Salesforce Case: 00148576)
For Detailed Release Notes-Please refer
https://wiki.ca.com/rest/ca/product/latest/topic?format=rendered&language=&space=UIMPGA&hid=emailgtw_RN
Note:Salesforce case(s) may not be viewable to all 		2.72
21.08.2013 MapiStubLibrary used instead of mapi32.lib Support for Outlook32 bit on 64 bit Windows Test Button functionality for Exchange setup corrected 2.71
22.03.2013 Exchange server support added for 2007/2010 2.70
18.12.2012 Japanese description of windows event log garbled issue fixed Exchange 2007 mail relay issue beacuse of un-necessary authentication is fixed. SMTP authentication should be avoided when user/passwd not supplied in probe GUI. 2.60
30.12.2010 Added fix for SMTP authentication.
2.41
30.09.2010 Added NIS(TNT2) changes.
Fixed memory leak.
2.40
13.07.2010 Added "References: " to message.
2.32
30.09.2009 Added a fix to support blank username and password. 2.31
13.08.2009 Changed the c-client library to imap2007e.
Added support for the platforms: AIX_5_64, HPUX_11_64, LINUX_23_64, SOLARIS_8_sparcv9, win64.
Added backup email address support to track mails sent by emailgtw.
Fixed configurator crash when testing promary server.
Fixed configuration tool problems with profile names contianing only numerics.
Changed configuration tool to allow specifying port number together with the smtp server name in the format :
Changed date expansion for date variables.
SSL Send authentication fix. This was earlier fixed in version 2.11, however the smtp library has been upgraded, thereby loosing this fix. The problem is now corrected by always trying to authenticate if user/password is specified.
 2.30
21.01.2009 Fix: In html mode a newline had gotten into the email body, causing some mail servers (seen on qmail) to return an error.
Fix: The AO-timestamp (which is only for internal use in the NAS) was erroneously a part of the text template, and has been removed. The HTML template did not have this field and is not modified. 		2.21
18.01.2008 Fixed problem with subject being reset to default subject for some recipients in a group.
Added option to group recipients so that one email is sent with multiple recipients in the TO: field instead of a separate email to each recipient.
Content type will be set to text/html if a tag is found. If the use_html flag is set then this is added automatically.
Added new variables which display the time at the alarm sender's time (calculates timezone offsets and generates a time string).
NOTE: Use of the new variables requires that Robot 2.68, Hub 4.20 and NAS 3.03 has been installed accross the infrastructure as the required fields are not present in older component versions.
Fixed problem where sending to multiple recipients could cause a crash due to a memory error.
Retry with authentication if the mail server returns error '554 Relay access denied'. 		2.20
19.10.2007 Fix: Retry connection when connection to Hub drops. Send alarm when there are connection issues.
Fix: Bug in error handling could cause a loss of connection to the Hub. 		2.10
18.09.2006 Windows: Retry connection to server on connection errors. This is an amplification of the error handling for error code 10048 in the previous release.

Add option to ignore TLS for servers that announce the capability but don't actually support it. Windows: Retry connection to server if error code 10048 is returned. This can happen on servers with a large number of sockets in use.

Fix: Strip newlines from subject before sending email, otherwise the mail header gets corrupted. This can cause html mail to appear as plain text. 		2.08
23.03.2006 Fix: $ signs were treated as variables even though they did not match any known variable names and getting removed from the message. Only known variables (see list in the Variable Substitution section below) will be blanked, leaving all other strings containing a $ in the expanded message. 2.04
24.02.2006 GUI's setup dialog has 'Use HTML format' checkbox added which sets the 'use_html' parameter in the config. 2.03
22.12.2005 Fix: SMTP Server test now verifies connection even if no authentication credentials are specified. Used to verify connection to open SMTP servers.
Flag use_html can be set to 'no' in RawConfigure to get cleartext mail. A cleartext template (template.txt is included) should be set if use_html=no. 		2.02
22.12.2005
  • Added $count variable, which is $suppcount + 1, to match alarm list. Template.html uses $count in place of $suppcount to avoid confusion.
  • The probe has been rewritten and no longer requires Perl.
  • SMTP authentication is now supported.
  • Multiple SMTP servers can be specified for redundancy.
  • Alarm severity and subsystem for "SMTP server unavail able" alarm can be configured, but not the alarm text (which uses the error message from the SMTP server).
  • NimBUS Users email addresses, as set in NimBUS User Administration, are used if no profile is present. If neither profile or NimBUS User email exist then the address is used as-is.
  • Profiles can override the default message template and email subject.
  • Confusing Active flag has been renamed. Report checkbox now specifies if the profile should recieve reports. All profiles are active as long as they are defined.
  • GUI has been redesigned.
    		• 2.01
    15.03.2005 Added new variable $hostname_strip which strips out the domain part of the hostname. The template.html file uses this new variable by default. Fixed a bug where a dot (.) as the 76th character on a line would be removed. This caused IP addresses to be changed in some few cases. 1.51
    Requirements
    Platform: Please refer to the Platform Support Matrix located in the Download section of http://support.nimsoft.com
    Software: Access to a SMTP server (does not have to be local),ExServer 2007/2010
    Hardware: None