Skip to main content
Skip table of contents

Email Security MAP file format description

Any data to be synchronized to Retarus for the Email Security service uses a specific format, the MAP format. The corresponding MAP file contains information to your domains, the valid email addresses, alias addresses, as well as individual settings such as mapping email addresses to profiles, etc.

General information

The MAP file is an UTF8 text file. To indicate the end of the data, the last line needs to contain four plus signs (“++++”) as an end-of-file marker, on an individual line by itself. If this marker is missing, the file will not be processed by the import mechanisms.

At the beginning of each line containing data, the Retarus customer ID and the corresponding domain is required to indicate which customer and which domain the data of this line is to be mapped to. The customer ID and the domain are separated by a pipe character (“|”).

Example

12345|domain1.de

The following data such as email addresses etc. are delimited by a TAB.

Detailed information on available data fields

For each domain, the records of type DIR: and DOMAIN: are mandatory. The other records of type MAP:, PROFILE:, UCFG:, and P13N: are optional.

Field

Description

Occurrence

Data type

Properties

Example

DOMAIN:

Declares a domain as a valid domain that is to be included in the directory.

Mandatory. Exactly once per domain.

Internet
Email
Domain

12345|domain1.de DOMAIN: domain1.de

DIR:

Declares an email address to be included in the directory. All email addresses must be specified with such a record, including alias addresses. Only email addresses with such a record will be accepted as valid addresses by the Retarus DirFilter.

Mandatory. Exactly once per email address.

Email
Address

12345|domain1.de DIR: john.doe@domain1.de
12345|domain1.de DIR: doe@domain1.de

MAP:

This record maps an alias address to its corresponding primary email address. Two values are specified: The first value is the alias address to be mapped, the second value is the primary address to which the alias should be mapped to.

This ensures that any spam received for an alias address will be included in the antispam report of the primary address.

Optional; exactly once per alias email address.

1. Email Address

2. Email Address

1. Address: The alias email address to map.

2. Address: The primary email address

12345|domain1.de MAP: doe@domain1.de
john.doe@domain1.de

12345|domain2.com MAP: john.doe@domain2.com
john.doe@domain1.de

PROFILE:

This maps an email address to a profile of the Email Security service.

Two values are specified: the email address to map and the profile to map the email address to.

Optional; exactly once per email address

1. Email Address

2. Profile name (string not containing any spaces)

1. The email address to map.

2. The name of the profile to map the address to.

12345|domain1.de PROFILE: doe@domain1.de
Germany_Marketing

12345|domain2.com PROFILE: john.doe@domain2.com
USA_Sales

UCFG:

This record maps individual settings to an email address, such as time zone, antispam report template, etc.

The first value specifies the email address for which the settings should be mapped, the second value contains in JSON format the settings. Both key and value are enclosed by quotes, keys are separated from values by colons. Multiple key/value pairs are separated from one another via a comma.

Optional; exactly once per email address

1. Email address

2. JSON string; field name and field value enclosed by quotes.

expiryDays: time in days for which messages will remain in the quarantine before deletion; may not exceed the value agreed upon in the contract.

templateName: The name of the antispam report email template to use for this user.

wdHourBitSet: times in hours during weekdays when antispam reports should be sent to the user. The times are enclosed in square brackets, the individual time values are separated by commas ([h,h,h]). weHourBitSet: times in full hours during weekends when antispam reports should be sent to the user. The times are enclosed in square brackets, the individual time values are separated by commas ([h,h,h]).

timeZoneId: Time zone to be used for sending the antispam report.

12345|domain1.de UCFG: john.doe@domain1.de {"expiryDays":30,"templateName":"deRetarus","wdHourBitSet":[8],"weHourBitSet":[10],"timeZoneId":"Europe/Berlin"}
12345|domain2.com UCFG: vorname.nachname@domain2.com {"expiryDays":27,"templateName":"enRetarus","wdHourBitSet":[9,15],"weHourBitSet":[14],"timeZoneId":"USA/Chicago"}

P13N:

This records maps personal information to an email address used for the Email Security option Signature & Disclaimer such as first name, last name, phone number, etc.

The first value specifies the email address for which the settings should be mapped, the second value contains in JSON format the settings. Both key and value are enclosed by quotes, keys are separated from values by colons. Multiple key/value pairs are separated from one another via a comma.

Optional; exactly once per email address.

1. Email address

2. JSON string; field name and field value enclosed by quotes.

Custom field names and values can be used for the personalization information.

12345|domain1.de P13N: john.doe@domain1.de {"surname":"Doe", "firstname":"John", "position":"Account Manager", phone":"+49 (89) 5528-0", "fax":"+49 (89) 5528-1919", "mail":"john.doe@domain1.de"}

If a file contains multiple lines assigning values to an email address, the last line’s information will be applied, and the previous lines will be ignored.

See below an example of a map file’s content:

NONE
12345|domain1.de DIR: max.mustermann@domain1.de
12345|domain1.de DIR: mustermann@domain1.de
12345|domain1.de DIR: test.user@domain1.de
12345|domain1.de DIR: dertestuser@domain1.de
12345|domain1.de DOMAIN: domain1.de
12345|domain1.de MAP: mustermann@domain1.de max.mustermann@domain1.de
12345|domain1.de MAP: dertestuser@domain1.de test.user@domain1.de
12345|domain2.com DIR: max.mustermann@domain2.com
12345|domain2.com DIR: mustermann@domain2.com
12345|domain2.com DIR: vorname.nachname@domain2.com
12345|domain2.com DIR: nachname@domain2.com
12345|domain2.com DOMAIN: domain2.com
12345|domain2.com MAP: max.mustermann@domain2.com max.mustermann@domain1.de
12345|domain2.com MAP: mustermann@domain2.com max.mustermann@domain1.de
12345|domain2.com MAP: vorname.nachname@domain2.com test.user@domain1.de
12345|domain2.com MAP: nachname@domain2.com test.user@domain1.de
12345|domain2.com UCFG: max.mustermann@domain1.de {"expiryDays":27,"templateName":"deRetarus","wdHourBitSet":[8,12,15],"weHourBitSet":[10],"timeZoneId":"Europe/Berlin"}
12345|domain2.com UCFG: vorname.nachname@domain2.com {"expiryDays":27,"templateName":"enRetarus","wdHourBitSet":[10,16],"weHourBitSet":[14],"timeZoneId":"USA/Chicago"} ++++
JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.