Email Parser Configuration Object

Defines the schema for the configuration of email parser settings.

Parameters

The Parser Configuration object schema includes the following attributes:

ParameterDescriptionTypeExample
email_formatThe format of the email content.

Options are:
Plain Text or HTML
String“email_format” : “plain_text”
allow_listAn array of allowed sender emails.

Use a wildcard to allow for a range of email addresses.

If no address is provided, the parser will accept emails from any source and may lead to false alarms or issues.
Array"allow_list" : [
"[email protected]",
"nagios*@incoming.com",
"[email protected]” ]
statusLookup rule to set the alert status.

Attributes:
default_to - the value to populate if no matches are found. Critical is default setting.
source - is the value in the body or subject?
status_map - defines values that map to assigned statuses. Values will be matched in order, stopping at the first match:
-critical
-warning
-ok
-acknowledged
Object“Status” : {
“default_to” : “critical”,
“source” : “body”,
“status_map” : {“critical” : [
“very_bad”,
“serious”,
“critical”],
“warning” : [
“problem”,
“warning”,
“minor”],
“ok” : [
“working”,
“ok”],
“acknowledged” : [
“received”,
“seen”]
}
}
primary_propertyMapping rule for the primary property.

Attributes:
name - title of property. Default is alert_title
source - is the value in the body or subject? Default is subject
extraction - regex rule to extract value
default_to - value if nothing is extracted
Object“primary_property” : {
“name”: “host”,
“source”: “subject”,
“extraction”: ,
“default_to”: “value”}
secondary_propertyMapping rule for the secondary property.

Attributes:
name - title of property
source - is the value in the body or subject
extraction - regex rule to extract value
default_to - value if nothing is extracted
Object“secondary_property” : {
“name”: “check”,
“source”: “subject”,
“extraction”: ,
“default_to”: “value”}
additional_attributesArray of payload field objects to set mapping rules for additional tags. Each object must be defined:

Custom Tag Attributes:
name - title of property
source - is the value in the body or subject?
extraction - regex rule to extract value
default_to - value if nothing is extracted
Object“Additional_attributes” : [
{
“name”: “region”,
“source”: “subject”,
“extraction”: ,
“default_to”: “value”},
{“name”: “tagname”,
“source”: “body”,
“extraction”: ,
“default_to”: “value”}
]