Skip to main content
Skip table of contents

SMTP Adapter (header parametrization)

You have the option of using X-Headers within your SMTP header. Below you will find defined X- Headers that activate a specific function within the Transactional Email service:

Header

Value

Description / Limitation / Restriction

 X-RETARUS-M4A-NOTIFICATION-URL

URL

  • Denotes the target for sending the notification messages for this job.

  • Contains also the protocol for sending the notification messages - initially only HTTP/S supported.

  • Max. 1000 chars

 X-RETARUS-M4A-NOTIFICATION-HEADER

 key=value

  • Usage of custom headers provided by caller for being propagated into each notification-call.

  • X-RETARUS-M4A-NOTIFICATION-HEADER: key-1=value-1 X-RETARUS-M4A-NOTIFICATION-HEADER: key-2=value-2

  • Max. 1000 chars (Sum of all key-values)

Duplicate keys are not supported

X-RETARUS-M4A-NOTIFICATION-AUTH-METHOD

 BASIC

  • Allowed values: BASIC

  • Alternatively, the Authorization header can be defined directly in the header field.

 

X-RETARUS-M4A-NOTIFICATION-AUTH-USER

 

String

User name for accessing target endPoint described in notification.. /url

 X-RETARUS-M4A-NOTIFICATION-AUTH-PASSWORD

 String

Password for accessing target-endPoint described in notification.. /url

 X-RETARUS-M4A-REFERENCE

 String

  • Offers the possibility to add a customer's reference, which can be processed afterwards in the caller's systems.

  • Max. 50 chars

 X-RETARUS-M4A-CAMPAIGN-ID

 String

  • Offers the possibility to add a customer's campaignId, which can be processed afterwards in the caller's (CRM) systems.

  • Max. 50 chars

 X-RETARUS-M4A-COST-CENTER

 String

  • Offers the possibility to add a customer's costCenter, which can be processed afterwards in the caller's (billing) systems.

  • Max. 50 chars

X-RETARUS-M4A-ANTIVIRUS-ACTIVE

Boolean

Flag to enable the AntiVirus MultiScan feature.

 X-RETARUS-M4A-TRACE-RECOVER-ACTIVE

 Boolean

  • Flag to enable the Trace & Recover feature, which will result in the marked email being stored for later resend.

  • Can only be used together with active Antivirus.

During the Implementation phase, it is also possible to store default values within the configuration for scenarios in which some the above-mentioned headers are not used in every SMTP request.

Please be aware that all details of the Push Notification service must always be provided in full. For instance, if you specify a web service that necessitates authentication with a username and password, these credentials must be explicitly added accordingly in the Headers. In such cases, no default values from the configuration will be used. Refer to section “Web-Service” for further details.

JavaScript errors detected

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

If this problem persists, please contact our support.