SMTPd

The Oracle Communications Unified Assurance SMTP Aggregator listens for SMTP connections to receive emails, reads the emails sent, parses the results with customizable rules, and creates de-duplicated events within Unified Assurance.

You can run this application as a service using the Services UI.

Default Service

The following table shows the settings for the default service. Actual values are in bold, descriptions of values are in plaintext.

Field Value
Package coreCollection-app
Name Event SMTP Aggregator
Program bin/core/collection/SMTPd
Arguments This field is blank. There is no default value.
Description SMTP Aggregator listens for incoming email messages and aggregates into events
Failover Type Standalone (Supported: Standalone, Primary, Redundant/Backup)
Status Disabled
Privileged This option is selected.

See Services in Unified Assurance User's Guide for general information about the settings for services.

See Using Application Primary/Backup Failover for more information about the different failover types.

Default Configuration

The following table shows the default configurations for the application. Actual values are in bold, descriptions of values are in plaintext.

Name Default Value Possible Values Notes
BaseRules collection/event/smtp/base.rules Text, 255 characters The relative path to the application Base Rules file.
BranchDir core/default Text, 255 characters The relative path to the rules directory.
ConnectionSecurity None (Plaintext) None (Plaintext), SSL (Secure on connect), TLS (Negotiated) Lowest available secure connection protocol (i.e. if either SSL (Secure on Connect) or TLS (Negotiated) selected, plaintext connection is not available) - NO RELOAD CONFIG SUPPORT
Host <SERVER FQDN> Text, 255 characters DNS name or IP Address for the SMTP server. Can associate to a particular interface. - NO RELOAD CONFIG SUPPORT
IncludeRules collection/event/smtp/base.includes Text, 255 characters The relative path to the application Include Rules file.
LoadRules collection/event/smtp/base.load Text, 255 characters The relative path to the application Load Rules file.
LogFile logs/EventSMTPServer.log Text, 255 characters The relative path to the log file.
LogLevel ERROR OFF, FATAL, ERROR, WARN, INFO, DEBUG The logging level for the application.
ShardID 1 An integer Database shard to be used.
Threads 3 An integer Number of process threads created. The aggregator takes a third of this value (rounded up) for database threads unless overridden by the DBThreads application configuration.
Capture Disabled Enabled or Disabled (Optional) If enabled, saves the raw message in the Log.
DBThreads This field is blank. There is no default value. An integer (Optional) Number of database threads to be created. If not specified, defaults to a third (rounded up) of Threads application configuration.
DisableDNS Disabled Enabled or Disabled (Optional) If enabled, uses IP address instead of hostname for the event Node.
FailoverBufferLimit 0 An integer (Optional) Enables Failover Standby buffer that keeps N-seconds worth of syslogs and replays this buffer when becoming Failover Active. (0=off N=seconds to keep) See Tokens: $buffer and $received
FieldSetFile This field is blank. There is no default value. Text, 255 characters (Optional) Path to csv file containing custom list of fields that will be used when inserting data. (Requires InsertSQLFile.)
InsertSQLFile This field is blank. There is no default value. Text, 255 characters (Optional) Path to file containing custom SQL Insert statement for handling of event inserts. (Requires FieldSetFile.)
Port This field is blank. There is no default value. An integer (Optional) Port for message collection. Defaults to SMTP:25/SMTPS:465 - NO RELOAD CONFIG SUPPORT

Rules

This aggregator uses the Unified Assurance standard rules architecture in Perl syntax. For information about creating rules, see the following in Unified Assurance Developer's Guide:

Tokens

The aggregator exposes the following tokens for rules processing.

Token Description
$AppConfig Hash reference to the application configuration name-value pairs that were configured. (i.e. use $AppConfig->{'Host'} to retrieve the set value for 'Host'.)
$Event Reference to the hash that is used to create and insert the Event data into the database. Keys map to the fields within the table used and values assigned are inserted in the database to that field. (e.g. $Event->{'IPAddress'} = '192.0.2.1' to assign the event IP address to '192.0.2.1') At least the 'Node' and 'Summary' fields must be set, or no event is inserted.
$IP IP of client email was sent from
$DNS DNS of client email was sent from (if available)
$received epoch time email was received by the aggregator
$buffer Flag for if was buffered during standby and was replayed (0 = No, 1 = Yes)
$SubjectOfMessage Subject of Received Email
$FromEmailAddress First From Email Address header content (may contain multiple emails)
$ToEmailAddress First To Email Address header content (may contain multiple emails)
$CCEmailAddress First CC Email Address header content (may contain multiple emails)
$BodyOfMessage Body of Received Email. ('text/plain' = PlainBody, 'text/html' = HTMLBody, 'multipart/*' = PlainBody)
$RawEmail Raw undecoded Email including headers
$ContentType Content Type of message
$ToAddresses Array reference to all To header contents (usually the same as $Recipients or $ToEmailAddress)
$FromAddresses Array reference to all From header contents (usually the same as $Sender or $FromEmailAddress)
$CCAddresses Array reference to all CC header contents
$ReceivedHeaders Array reference to all Received header contents (contains list of servers mail went through)
$PlainBody Email body. In text/html content type this contains the plaintext stripped of any HTML tags
$HTMLBody Email body for text/html content type
$Sender Sender's email
$Recipients Recipient email(s) (delimited by , or ;)
$EmailObject Email::MIME object representing the email. For advanced parsing operations only
$discard_flag Flag for discard (0 = No, 1 = Yes)
$Count Message Counter
$CustomHash Custom key, value cache available across all rules. Contents commonly defined in Load Rules then used in Base or other rules. NOTE: This variable is a shared object and any additional sub hashes or arrays must be shared before use or it will cause the error: Invalid value for shared scalar. Instantiate the sub hash/array using '&share({})' e.g. 
$CustomHash->{SubObject} = &share({});
$StorageHash Internal cache used as the StorageHash option when calling rules functions such as FindDeviceID(). NOTE: The structure of this cache is subject to change! Not recommended for custom global storage or manual manipulation; use $CustomHash.

Administration Details

The following list shows the technical details you will need for advanced administration of the application: