--- language: "en" --- # Transactional Email ## Transactional Email Enjoy first-class inbox placement, guaranteed throughput rates, and increased customer engagement with our reliable transactional email delivery. [GET STARTED](https://docs.retarus.com/tem/product-sheet-transactional-email-1.md) ### Last Updated * #### [Suppression List](https://docs.retarus.com/tem/suppression-list.md) May 27, 2024 * #### [Smart Delivery Optimization (SDO)](https://docs.retarus.com/tem/smart-delivery-optimization-sdo.md) May 24, 2024 * #### [Feedback Loops](https://docs.retarus.com/tem/feedback-loop-service.md) May 07, 2024 ### Featured * #### [Transactional Email Description](https://docs.retarus.com/tem/transactional-email-description.md) Using Retarus Transactional Email, large volumes of emails can be sent from business application directly, without burdening the customer's own email infrastru... * #### [Transactional Email Dashboard](https://docs.retarus.com/tem/dashboard.md) The Transactional Email dashboard delivers a real-time overview of your email traffic, allowing you to: Monitor overall delivery performance for submitted emai... ### Documentation * #### [Features in detail](https://docs.retarus.com/tem/features-in-detail.md) * [Suppression List](https://docs.retarus.com/tem/suppression-list.md) * [Smart Delivery Optimization (SDO)](https://docs.retarus.com/tem/smart-delivery-optimization-sdo.md) * [Feedback Loops](https://docs.retarus.com/tem/feedback-loop-service.md) * [Basic configuration](https://docs.retarus.com/tem/basic-configuration.md) * [CSA Feature and headers](https://docs.retarus.com/tem/csa-header.md) * [15 more pages](https://docs.retarus.com/tem/features-in-detail.md) * #### [Service Administration \& Onboarding Process](https://docs.retarus.com/tem/service-administration-onboarding-process.md) * [Service administration hierarchy](https://docs.retarus.com/tem/service-administration-hierarchy.md) * [Onboarding process](https://docs.retarus.com/tem/onboarding-process.md) * [Customer Onboarding Sheet for Transactional Email](https://docs.retarus.com/tem/transactional-email-setup-sheet.md) * [Outgoing IP addresses](https://docs.retarus.com/tem/outgoing-ip-addresses.md) * [Best practices \& recommendations](https://docs.retarus.com/tem/transactional-email-best-practices.md) * [1 more pages](https://docs.retarus.com/tem/service-administration-onboarding-process.md) * #### [Administration Portal (myEAS)](https://docs.retarus.com/tem/administration-portal-myeas.md) * [Technical Accounts](https://docs.retarus.com/tem/technical-accounts-list.md) * #### [API Documentation](https://docs.retarus.com/tem/api-documentation.md) * [API Endpoints](https://docs.retarus.com/tem/api-endpoint.md) * [Account Authentication](https://docs.retarus.com/tem/account-authentication.md) * [Relation between JobRequest and Account](https://docs.retarus.com/tem/relation-between-jobrequest-and-account.md) * [Job validations](https://docs.retarus.com/tem/job-validations-rest.md) * [REST API (objects)](https://docs.retarus.com/tem/rest-api-objects.md) * [1 more pages](https://docs.retarus.com/tem/api-documentation.md) * #### [Events Webhook](https://docs.retarus.com/tem/status-notifications.md) * [Notification - Non-Delivery Report (NDR)](https://docs.retarus.com/tem/notification-non-delivery-report-ndr.md) * [Notes](https://docs.retarus.com/tem/notes.md) * [Web Service](https://docs.retarus.com/tem/web-service.md) * [Retry logic for status notifications](https://docs.retarus.com/tem/retry-logic-for-status-notifications.md) * [Event types and scenarios](https://docs.retarus.com/tem/event-types.md) * [3 more pages](https://docs.retarus.com/tem/status-notifications.md) * #### [Reporting in Transactional Email](https://docs.retarus.com/tem/transactional-email-reporting.md) * [Transactional Email Dashboard](https://docs.retarus.com/tem/dashboard.md) * [Email Live Search](https://docs.retarus.com/tem/eas-live-search.md) * [CSV reporting](https://docs.retarus.com/tem/csv-reporting.md) * [Reporting in myEAS](https://docs.retarus.com/tem/reporting-in-myeas.md) * [Reporting GraphQL API β†—](https://docs.retarus.com/tem/reporting-graphql-api.md) * [1 more pages](https://docs.retarus.com/tem/transactional-email-reporting.md) * #### [Connectors \& Add-Ins](https://docs.retarus.com/tem/connector-add-on-tutorials.md) * [Adobe: Email Adapter on Experience Cloud (SMTP)](https://docs.retarus.com/tem/adobe-email-adapter-on-experience-cloud-smtp.md) * [Salesforce: Setting up the SMTP Adapter](https://docs.retarus.com/tem/configuring-the-smtp-adapter-for-salesforce.md) * [SAP: Email connector on BTP Integration Suite](https://docs.retarus.com/tem/sap-email-connector-on-btp-integration-suite.md) * [SAP: Integration Flows with Open Connectors on BTP Integration Suite](https://docs.retarus.com/tem/sap-integration-flows-with-open-connectors-on-btp-.md) * [SAP: Setting up the SMTP Adapter BC-SMTP Connector](https://docs.retarus.com/tem/sap-integrating-an-smtp-relay-in-sap-s-4hana.md) * [1 more pages](https://docs.retarus.com/tem/connector-add-on-tutorials.md) * #### [Annex](https://docs.retarus.com/tem/annex.md) * [A detailed look into your Transactional Email invoice](https://docs.retarus.com/tem/detailed-look-into-transactional-email-invoice.md) --- language: "en" --- # 3rd party Archiving The "3rd party Archiving" feature offers the possibility for our customers to use the Archiving solution of their choice for keeping legal long-term evidence that an email has been sent using the Transactional Email service. From a technical point of view, it consists in adding a default Bcc: recipient at the EnvelopeTo level for each request processed through a specific Technical Account. Therefore, the configured email address can be used to route email into the 3rd party Archiving solution accordingly. ![2024-07-11 09_44_30-Review_Graphics_3PartyArchive-1.pdf - Adobe Acrobat Reader (64-bit).png](https://docs.retarus.com/__attachments/a_e58b9597b44490204947d97820c3ea42a9b0ba1a3d7bdd691f56eeed78d419b9/2024-07-11%2009_44_30-Review_Graphics_3PartyArchive-1.pdf%20-%20Adobe%20Acrobat%20Reader%20(64-bit).png?cb=5ac9593e3a5af4b6cb8936782c1b2144) ## How to use it this Feature? During the Onboarding phase, or during the Run phase, ask the Implementation Team to configure the "3rd party Archiving" feature: * Technical Account configuration: * Specify on which Technical Account you want to configure this feature. * Provide at least one valid email address that will be used as a default Bcc: recipient. * REST APIs: * The feature is triggered by default for all JobRequest using a defined Technical Account with this feature enabled. There is no parameter to control this at the JobRequest level. If no default Bcc: addresses should be added, another Technical Account must be used for which this feature is not configured. * SMTP Adapter: * Some SMTP applications do not offer the possibility to configure any Bcc: email address at the EnvelopeTo level when sending emails out. * Therefore, Transactional Email offers the possibility to mitigate such situation by declaring a default Bcc: email address for all JobRequest sent via the configured Technical Account. * The feature is triggered by default for all JobRequest using a defined Technical Account with this feature enabled. There is no parameter to control this at the JobRequest level. If no default Bcc: addresses should be added, another Technical Account must be used for which this feature is not configured. * 3^rd^ party Archiving solution: * This solution must be able to receive SMTP connections from the Internet. * The domain name used for the default Bcc: address(es) must have a valid MX Record and verified SPF and DKIM entries into the related DNS zone. * For each email sent using Transactional Email with the "3rd party Archiving" feature enabled, one email will be sent to the default Bcc: email address(es). * Retarus does not recommend a specific Archiving solution editor for the moment. ### Notes * Retarus Transactional Email does not offer for the moment a built-in storage for long-term legal retention. Transactional Email still does not offer the possibility to read and export full email content from the myEAS Live Search interface. * For being able to store and resend jobs during 45 days, please read the section [Trace \& Recover](https://docs.retarus.com/tem/trace-recover-smtp-only.md) (SMTP only). * The configured Bcc: addresses are not subject to the restrictions of [Trusted Domains](https://docs.retarus.com/tem/trusted-domains.md) feature and [Prohibited role-based recipient name](https://docs.retarus.com/tem/prohibited-objects-rest.md). Thus, to avoid misconfiguration and therefore missing to store legal evidence of an email that have been sent out. * Up to 10 different Bcc: email addresses can be configured. * Using this feature results in adding at least +1 recipient to every JobRequest processed by Transactional Email: * These additional default Bcc: recipients (up to 10) will be counted and automatically charged according to your pricing plan. * The overall limitation of 1000 recipients per JobRequest for the REST interface is still applicable when using the "3rd party Archiving" feature. * In the myEAS Live Search, myEAS Report or Push Notifications, the default Bcc: recipient is considered as a separate recipient. * The default Bcc: email address is configured at the Technical Account L2 level (see [Service administration hierarchy](https://docs.retarus.com/tem/service-administration-hierarchy.md)). --- language: "en" --- # Account Authentication ## Authentication using REST API ### Basic authentication (credentials) You must use username and password for each request. For this case, it is required to set the API username and password: * Authorization header base64 encoded: e.g. "Basic d2lraTpwZWRpYQ==" (\:\) * While the API is exposed only over HTTPS, the credentials are encrypted. ### IP Allowlist (optional) During the Onboarding phase, you can configure an additional layer of security by using IP-Allowlist to allow REST JobRequests only from defined IPs: * IP Allowlist is optional; * By default, if no source IPs are defined, then there are no restrictions: all IPs are allowed; * Credentials (see paragraph above) are still mandatory for each JobRequest; * Only IPv4 is supported; * All IPs have to be defined explicitly, we do not support IP-ranges (eg. 1.2.3.4/24); * A maximum of 50 IPs per IP version can be defined (50 for IPv6 and 50 for IPv4); * IPs are provided as HTTP Header X-Real-IP: 11.22.33.44; * If the header X-Real-IP: 11.22.33.44 is not present, requests will be rejected. Retarus recommends configuring IP Allowlisting as a complementary authentication mechanism to increase security. IP Allowlist is currently not supported for SMTP JobRequests. ## Authentication using SMTP Adatper ### Basic authentication (credentials) You are able to use username and password for each request. For this case, it is required to set the API username and password. Those credentials must be base64 encoded. * There are two different authentication mechanisms supported: Plain and Login. * We support the following SMTP ports: * 25 * 587 * 2525 * TLS versions supported: * version 1.2 * version 1.3 * enforced TLS only, we do not support Opportunistic TLS * We do not support SSL ### Source IP authentication (alternative) As an alternative to using credentials (username and password), authentication can be done using Source IPs for SMTP JobRequest. In this case, an Authorization header is required: * If the mail sender uses SMTP AUTH, Basic Auth is used with the provided credentials. For authentication via sender IP address a custom form of the Authorization header is used: * Authorization: IPv4 \; * Only IPv4 is supported; * Up to 100 IP addresses can be defined. Authentication method using Credentials can still be used for the Technical Account. Source IP authentication is currently only supported for Technical Account with SMTP allowed interface. ### Samples #### Auth Plain ~> EHLO client.example.com <~ 250-mail-de1.retarus.com <~ 250-PIPELINING <~ 250-SIZE 20000000 <~ 250-ETRN <~ 250-AUTH PLAIN <~ 250-AUTH=PLAIN <~ 250-ENHANCEDSTATUSCODES <~ 250-8BITMIME <~ 250 DSN ~> AUTH PLAIN AHEhLXXXXZXIyAHpVcitRRRWw5XXX4 <~ 235 2.7.0 Authentication successful #### Auth Login ~> EHLO client.example.com <~ 250-mail-de.retarus.com <~ 250-PIPELINING <~ 250-SIZE 20000000 <~ 250-ETRN <~ 250-AUTH PLAIN LOGIN <~ 250-AUTH=PLAIN LOGIN <~ 250-ENHANCEDSTATUSCODES <~ 250-8BITMIME <~ 250-DSN <~ 250 CHUNKING ~> AUTH LOGIN <~ 334 VXNlcm5hbWU6 ~> eW91clVzZXJuYW1l <~ 334 UGFzc3dvcmQ6 ~> eW91clBhc3N3b3Jk <~ 235 2.7.0 Authentication successful ~> AUTH LOGIN eW91clVzZXJuYW1l <~ 334 UGFzc3dvcmQ6 ~> eW91clBhc3N3b3Jk <~ 235 2.7.0 Authentication successful --- language: "en" --- # Administration Portal (myEAS) The new administration console for Transactional Email, available in myEAS, allows you to manage your Technical Account configurations independently. You can now read, update, delete, and create your setup without the need to raise a Service Request. This portal provides a clear overview of your Technical Accounts and Sender Domains. > πŸ“Œ **Gradual rollout** > > The full configuration capabilities will be released in phases throughout the year. Initially, the Technical Accounts list and Basic Parameters are available to facilitate quick setup and provisioning. * [Technical Accounts](https://docs.retarus.com/tem/technical-accounts-list.md) ## Access Privileges By default, all myEAS users with the "Customer Admin" role can view the Administration section in the left navigation panel. A "Customer Admin" can grant additional privileges to the "Customer Staff" user role via the [User Management](https://docs.retarus.com/eas/user-settings.md) section in the classic EAS administration portal. To do this, simply select "Yes" for the "Access to Technical Accounts configuration" setting. ![classicEAS_TEM_UserSet_TechAccConfig.png](https://docs.retarus.com/__attachments/a_e90bb63252bd086fd5c9c26cd994a70bc2b7cef61d3cd86f390c8839dd4abbc2/classicEAS_TEM_UserSet_TechAccConfig.png?cb=c1ed6cb32ef31316d23e27804854dd13) --- language: "en" --- # Adobe: Email Adapter on Experience Cloud (SMTP) This tutorial outlines the setup of an Email Adapter on the Adobe Experience Cloud via SMTP Gateway. Through a setup of an Email Connector further Adobe Applications can be connected to send out via the Retarus Messaging Platform transactional and high volume oriented use cases. Retarus provides a comprehensive feature set, which can be added on demand for different applicability of use cases. ## Prerequisites * Access to the Adobe Experience Cloud with administrative privileges * [Retarus Transactional Email](https://www.retarus.com/services/email-infrastructure/transactional-email/) Account with credentials for SMTP Gateway ## How to get started 1. Gather Retarus SMTP Details First, obtain the necessary SMTP details from Retarus to configure the SMTP adapter: * **SMTP Server**: The hostname or IP address of the Retarus SMTP server. * **Port**: The port number used for SMTP connections. Typically, this is 587 for connections using STARTTLS or 465 for SSL/TLS connections. * **Username and Password**: Your Retarus account credentials for SMTP authentication. * **Security Protocol**: Confirm whether Retarus requires STARTTLS or SSL/TLS for encrypting SMTP connections. 2. Access Adobe Experience Cloud SMTP Gateway Navigate to the SMTP Gateway configuration within your Adobe Experience Cloud: * **Login to Adobe Experience Cloud**: Use your administrative credentials to log in. * **Navigate to Email Configuration**: Find the section for email configurations or SMTP Gateway settings, typically under the administration or integration settings. Further Information related Adobe's Email Service provided in [Adobe's Experience League Email Service Tutorial](https://experienceleague.adobe.com/docs/experience-manager-learn/cloud-service/networking/examples/email-service.html?lang=en) ![image-20240618-123309.png](https://docs.retarus.com/__attachments/a_0f999b8efa0d6083caddb18d3fe338b7b46d73dd9d9d4583bc7b82e382e7a0a8/image-20240618-123309.png?cb=07acc603d0ea97dd7452a018b10e497e) 3. Access Adobe Experience Cloud SMTP Gateway Navigate to the SMTP Gateway configuration within your Adobe Experience Cloud: * **Login to Adobe Experience Cloud**: Use your administrative credentials to log in. * **Navigate to Email Configuration**: Find the section for email configurations or SMTP Gateway settings, typically under the administration or integration settings. 4. Configure the SMTP Adapter With the SMTP details from Retarus, configure the SMTP adapter in Adobe Experience Cloud: * **Add a New SMTP Gateway**: Look for an option to add or configure an SMTP Gateway. * **Enter SMTP Details**: * **SMTP Server**: Enter the Retarus SMTP server hostname or IP address. * **Port**: Specify the port number provided by Retarus. * **Username and Password**: Enter your Retarus SMTP credentials. * **Security Protocol**: Choose STARTTLS or SSL/TLS based on Retarus's requirements. * **Advanced Settings** (if applicable): * **Email From Address**: Specify the default sender email address, if required by Retarus. * **Timeouts and Retry Policies**: Configure these based on your operational requirements. 5. Test the SMTP Integration Before deploying the integration into production, conduct thorough testing: * **Create Test Email Campaigns**: Set up test email campaigns in Adobe Experience Cloud targeting a limited number of recipients. * **Send Test Emails**: Use the newly configured SMTP gateway to send test emails. * **Verify Delivery**: Check the delivery status of the test emails and confirm receipt. * **Review Logs**: Examine any logs or error messages to ensure the SMTP connection and email delivery are functioning as expected. 6. Deploy and Monitor After successful testing, move forward with deploying the integration: * **Deploy Integration**: Activate or finalize the SMTP Gateway configuration for production use. * **Monitor Performance**: Regularly monitor the integration for any issues, paying close attention to delivery rates, bounce rates, and any error logs --- language: "en" --- # Allowed Sender Address By default, any email addresses from a registered domain can be used as a sender address. But during the Implementation phase, it is possible to define a restricted list of email addresses that can issue an email through Transactional Email service. This has been meant to increase security and prevent misuse of a sender domain. Here are the prerequisites for using this feature: * Ask to enable this feature during Implementation or by opening a Service Request; * Allowed email addresses must match the registered sender domain; * A maximum of 50 different email addresses per sender domain can be configured; * Role-based addresses are forbidden (see "[Prohibited role-based Sender \& Recipient Names](https://docs.retarus.com/tem/prohibited-objects-rest.md)" section). This feature is available for both SMTP and REST facade. --- language: "en" --- # Annex * [A detailed look into your Transactional Email invoice](https://docs.retarus.com/tem/detailed-look-into-transactional-email-invoice.md) --- language: "en" --- # AntiVirus Multiscan Retarus checks messages for viruses within our own infrastructure. We don't transmit any data to third party providers. The check is carried out with two virus scanners from different suppliers chosen by Retarus. Retarus updates the scanners as soon as the manufacturers provide updates or new releases. If a virus is detected, Retarus deletes the infected messages. Status information on infected emails is transmitted to the customer via API callback (HTTP Push Status Notifications). The AntiVirus MultiScan feature must be activated for a specific Technical Account. Into the configuration it can be defined: * if only attachments are scanned (allContentPart=FALSE), * or if attachments ++and++ the email body are scanned (allContentPart=TRUE). After activating the feature for your Technical Account, you can use it via the REST or SMTP request. The object description for that feature can be found in the current API description. ![image-20240508-073018.png](https://docs.retarus.com/__attachments/a_9b44724545f0882b13cbe7c303dc3ff01400fefe5784ec75985e7939b118aa96/image-20240508-073018.png?cb=3f4dfdd95a0206f5f2507989a7224ed1) All requests which come through our infrastructure will be checked if the AntiVirus MultiScan feature is active. If the feature was activated the system pull out all attachments and/or html-body within the message and routes their contents to a specified antivirus scanner services, collects and evaluates their feedback. Our service provides different defined results of a virus scan: * OK: The entire Job will be sent. * INFECTED: The Job will be discarded. If our service detects a virus we discard the entire job and provide you the details via our HTTP Push Notification Service with the following β€žEvent Type". | **Event/phase** | **Event/state** | **Event/type** | **Event/subType** | **Description** | |-----------------|-----------------|----------------|-------------------|-------------------------------------------------------------| | PROCESS | FINISHED | DROPPED | VIRUS_DETECTED | Retarus Virus Engine detected a virus. Email not delivered. | ## Sample push notification JSON { "notifications":[ [ { "meta":{ "event":{ "description":"INFECTED: attachments / are infected.", "phase":"PROCESS", "state":"FINISHED", "subType":"VIRUS_DETECTED", "ts":"2019-11-14T13:14:05.699Z", "type":"DROPPED" }, "mail":{ "email":" recipient@sample.com ", "from":"sender@sample.com ", "id":"186248a8-b695-49be-ba51-bbc0b8e7931a#85213bcf#85b5fb36", "mimeFrom":"sender@sample.com " }, "tag":"1daaa3a665636cf44844b68b33dc0573ca1f0d6ee96d7e079c488490305c1d79" } } ] ] } ## Synchronous response If the Technical Account configuration does not permit this feature and a JobRequest explicitly requests the activation of AntiVirus, the JobRequest will be rejected immediately. JSON { "meta": { "jobId": "308a020f-4f71-4f4d-853d-9ccfca0b2645", "state": { "type": "REJECTED", "subType": "DISABLED_IN_ACCOUNT_CONFIG", "phase": "PRE_PROCESS", "description": "Feature antivirus is disabled in AccountConfig for this account/domain" } } } ## Monitoring and updating antivirus engines The database used by our antivirus engines is continuously updated. The latest version is checked by an automated procedure. Also, checking and importing new findings is carried out by a process completely independent of the Antivirus service. In order to check the Antivirus service for availability, a corresponding health check was included in our Transactional Email monitoring. In addition, a further check was activated to check whether the currently used Antivirus version matches the latest published version. The AntiVirus MultiScan service is within our Transactional Email infrastructure and it is not directly connected to the service that renews the database of known viruses. That means, there is no impact on our service during database updates. --- language: "en" --- # API Documentation * [API Endpoints](https://docs.retarus.com/tem/api-endpoint.md) * [Account Authentication](https://docs.retarus.com/tem/account-authentication.md) * [Relation between JobRequest and Account](https://docs.retarus.com/tem/relation-between-jobrequest-and-account.md) * [Job validations](https://docs.retarus.com/tem/job-validations-rest.md) * [REST API (objects)](https://docs.retarus.com/tem/rest-api-objects.md) * [SMTP Adapter (header parametrization)](https://docs.retarus.com/tem/smtp-adapter-header-parametrization.md) --- language: "en" --- # API Endpoints ## Active/Active Europe/Germany You'll need to update your destination endpoint and use the ones listed below. | **Endpoints** || |-------------------------------------------------------------|-----------------------------------------------------------------------------| | **Endpoint REST** | **Endpoint SMTP** | | (Ports: 80, 443) | [mail-de.retarus.com](http://mail-de.retarus.com/) (Ports: 25 / 2525 / 587) | See [Data center operations](https://docs.retarus.com/tem/data-center-operations.md) for more information. ## Active/Active USA You'll need to update your destination endpoint and use the ones listed below. | **Endpoints** || |-------------------------------------------------------------|-----------------------------------------------------------------------------| | **Endpoint REST** | **Endpoint SMTP** | | (Ports: 80, 443) | [mail-us.retarus.com](http://mail-us.retarus.com/) (Ports: 25 / 2525 / 587) | See [Data center operations](https://docs.retarus.com/tem/data-center-operations.md) for more information. ## Singapore Datacenter You'll need to update your destination endpoint and use the ones listed below. | **Endpoints** || |--------------------------------------------------------------|-------------------------------------------------------------------------------| | **Endpoint REST** | **Endpoint SMTP** | | (Ports: 80, 443) | [mail-sg1.retarus.com](http://mail-sg1.retarus.com/) (Ports: 25 / 2525 / 587) | ## Switzerland Datacenter You'll need to update your destination endpoint and use the ones listed below. | **Endpoints** || |--------------------------------------------------------------|-------------------------------------------------------------------------------| | **Endpoint REST** | **Endpoint SMTP** | | (Ports: 80, 443) | [mail-ch1.retarus.com](http://mail-ch1.retarus.com/) (Ports: 25 / 2525 / 587) | --- language: "en" --- # Basic configuration ## SPF * The Sender Policy Framework is a means of sender verification designed to make sender address forgery or impersonation more difficult. This allows the receiving server to verify if the system sending on behalf of a domain is in fact authorized to send messages with the sender domain in question. To authorize the Retarus relays to send messages on your behalf, add the following SPF record to your DNS: v=spf1 include:_spf.general.transactional-mail-a.com ~all * For the 'MAIL FROM' address specified in the SMTP communication between email servers, an SPF-From Record must be entered, thereby allowing an SPF test to be carried out on the recipient side. The SPF Record must end in "-all" or "∼all". In case the necessary entries are not made on the Customer's side within ten (10) business days, the re-verification efforts and expenses will be charged in accordance with Retarus' agreed hourly rates. ## DKIM The use of the DKIM (DomainKeys Identified Mail) method is mandatory. For each sender domain registered with Retarus on behalf of the Customer, the Customer must store a corresponding DKIM key in their DNS (generated and provided by Retarus). If the Customer fails to make the necessary entries within ten (10) business days, the reverification will be billed in accordance with Retarus' agreed hourly rates. ## DMARC DMARC lets Customer tell receiving servers what to do with messages from the Customer's domain that don't pass SPF or DKIM. The authenticating domain must be the same domain that's in the message From: header. It is the responsibility of the Customer to publish a DMARC record within the DNS zone for each sender domain. If there is no DMARC record, create one with a "none" tag policy as below: v=DMARC1; p=none; rua=mailto:rua@example.com; ruf=mailto:ruf@example.com; fo=1 --- language: "en" --- # Basic View The Basic View is the default view available to all users with access to UDR Reporting in the myEAS portal. It provides an immediate overview of Transactional Email activity using a predefined set of columns. ![image-20260422-152556.png](https://docs.retarus.com/__attachments/a_da9160330b1ac44aefa652bfababf962d56c617d37d01fa87246e9d540c63046/image-20260422-152556.png?cb=9f3543d888e9e4ae522a2da15c275196) Basic View loads automatically when you open the UDR Reporting page. You can sort any visible column, apply quick date ranges, and export your current dataset without additional configuration. ## Key features * **Predefined columns** Displays a fixed set of core columns relevant to UDR reporting (e.g., **Creation Time** , **Message From** , **Message To** , **Status**) * **Main filters** Filter data by key fields (**Message To Domain** , **Substatus** , **SMTP Status Code** , **Cost Center** , and **Technical Account Id**) --- language: "en" --- # Bounce & Response Manager An important technical requirement is that the inbound channel requires Envelope-From Address Rewriting or MX route to [Retarus Email Security](https://www.retarus.com/services/email-security/). The [Retarus Bounce and Response Manager](https://www.retarus.com/services/secure-email-platform-tech-specs/#bounce-and-response-manager) adds the inbound channel to Retarus Transactional Email by allowing you to control, organize and define routing of all incoming email traffic, even for high email volumes. It is an add-on to Transactional Email for inbound emails that keeps out-of-office replies and hard bounces separate from legitimate customer inquiries to facilitate faster response and reply times. All email replies to messages processed by Retarus Transactional Email and which receive an envelope from-address managed by Retarus can be managed by the Bounce and Response Manager. Email replies are checked for viruses, then automatically rewritten by Retarus Inbound Address Rewriting and forwarded to the customer. ## Use cases * Asynchronous bounces should be filtered out and not reach you. * You need separation of incoming emails: manage, organize and define routing of incoming replies to transactional emails. * Traffic handling and workflow automation for marketing support and contact center. * You need a cloud-based solution, with high performance and compliance standards, for complex enterprise environments that is fully integrated into Retarus Secure Email Platform. ![image-20240508-140720.png](https://docs.retarus.com/__attachments/a_ee42578052d3abe2db59ca68c242247feaaa314f8f78182107f1b45ae9c4c0b4/image-20240508-140720.png?cb=39af4f625fad36c403de0c28c3f66be1) --- language: "en" --- # Bounced email addresses to delete For many reasons, it is not recommended to simply delete all erroneous email addresses that have been acknowledged with a 5.x x SMTP status code from the central data. Rather, the text in the "Reason" field should also be evaluated. This allows you to build up a certain classification at the same time. To detect "**Unknown User**", we recommend searching for the following keywords / strings in the SMTP reason text: * Disabled * No such user * No such address * No such recipient * No such mailbox * Mailbox unavailable * User doesn't have * User not found * User unknown * Unknown user * Unknown or illegal alias * Invalid recipient * Invalid user * Invalid mailbox * Does not exist * Recipient unknown * Recipient not found * Bad destination * Unroutable address * Address rejected (attention, because often used in case of policy errors!) * Recipient rejected (attention, because often used in case of policy errors!) To detect **syntactical or DNS errors**(no A or MX record etc.), we recommend searching for the following keywords / strings in the SMTP reason text: * Host or domain name not found * Syntactic incorrect address * Network is unreachable * Connection timed out * Connection refused * No information available * Loops back to myself * No route to host * Malformed or unexpected name server reply * Timed out while receiving the initial server greeting * nullMX * *\[empty reason text\]* For users with a permanently full mailbox, we recommend searching for the following keywords / strings in the SMTP reason text. * quota * mailbox full --- language: "en" --- # Configure date range and timezone for UDR reports The timezone and date range settings control the time period and timezone for the data displayed in the UDR report. ![image-20260422-090325.png](https://docs.retarus.com/__attachments/a_3e2ceca30231cc9d38d2fe9e95cb6797a5c8d0330226cad5089eb21a6639f3f2/image-20260422-090325.png?cb=69d5bd2883b07e36ca7f30638d833cac) ## Changing the timezone 1. Open the **Usage Report (UDR)**reporting screen. 2. Click the **DATE RANGE** tab. β†’ The section expands to display the date picker panel. 3. In the **Timezone** dropdown, select your desired timezone. 4. Click **Generate Report** . β†’ The report is generated and displayed using the selected timezone. ## Selecting a date and time range You can generate reports for a specific custom date/time range or choose a preset quick range. The default range is **Last 24 hours**. > πŸ“Œ **Temporary data and time preferences** > > Date, time, and timezone settings are temporary. They reset to default values when you exit UDR Reporting. To set a custom range: 1. Open the **Usage Report (UDR)** reporting screen. 2. Click the **DATE RANGE** tab. 3. In the **Choose interval** field, use the two-month calendar to select a start and end date. 4. Adjust the time if needed. β†’ The selected range can span up to 45 days within the six-month retention period. 5. Click **Generate Report** . β†’ The report is generated and displayed for the specified interval. To use a preset quick range: 1. In the **Quick Ranges** section, click one of the available options. β†’ The report is generated immediately after selecting a quick range. > πŸ“Œ **Timezone and date range are not saved in views** > > Timezone and date range settings are not part of any saved view configuration. When you load a custom view or switch back to Basic View, you need to set your preferred timezone and date range again. --- language: "en" --- # Salesforce: Setting up the SMTP Adapter This tutorial describes the necessary steps to connect to the Retarus Transactional Email (SMTP Adapter) for email traffic originated from Salesforce. This adapter setup will allow to create and submit arbitrary numbers of Salesforce-originated emails to the cloud service, which takes care of the whole SMTP based processing and reporting chain. **The Email SMTP Adapter** from Retarus - takes care of all aspects of business email processing, including bounce handling, advanced security features, active reputation management up to cutting edge emergency fallback environments. The implementation of the adapter consists of three main steps outlined in the following chapters: * Setting up the email relay * Establish an email domain filter * Testing the solution ## Prerequisites To perform the steps outlined here, the following prerequisites must be given: * Retarus [Transactional Email Description](https://docs.retarus.com/tem/transactional-email-description.md) * 'Retarus Transactional Email SMTP' service is booked, provisioned, and activated. * Email service login credentials (user/account name and password) available * Target hostname etc. available Account names here won't usually be people names, but more something like `lhsdf-SKs3EaaaaabEq3mHn_GehH3jD2s@mail-de.retarus.com:25` These credentials will be provided by Retarus ## Adapter Setup 1. Create the Email Relay Connection This chapter describes how to set up an email relay for Salesforce-generated mails by configuring Salesforce to automatically route outbound emails through the Retarus email services using SMTP. PS, if emails originate from more than one domain, it is possible to configure multiple email relays, for instance one relay for each domain. **Open 'Setup'** ![grafik-20240522-092108.png](https://docs.retarus.com/__attachments/a_49eed2eb5149ae7d013ef7ab1b24294390cffb10259423789435254b851a2765/grafik-20240522-092108.png?cb=bca3b93da8fa998b9690483b0f5b3d2f) ### **Select 'Email Relays' from the left-hand menu** ![grafik-20240522-092200.png](https://docs.retarus.com/__attachments/a_10e8dbd83dca56b40856af10b7765b88c405a5de9861e3656002d56dd2347eef/grafik-20240522-092200.png?cb=b865f1eb73d6dcce46c7f12b949ef65c) #### **Select 'Create Email Relay'** ![grafik-20240522-092225.png](https://docs.retarus.com/__attachments/a_a764fe7495646bbecbad408bb8af30709bd22f634f6aa3094ea3f1e75a36cb35/grafik-20240522-092225.png?cb=e17ade6073ee50aed5b4ad1f1195096a) #### **Configure the relay using the settings outlined below.** ![grafik-20240522-092309.png](https://docs.retarus.com/__attachments/a_4af2bdd5b5d6387233aa08e771c5b24255d9a5bfe19f32bc11e99d9f9a3157ab/grafik-20240522-092309.png?cb=b23229157f6cc2a2fbc8be710e452128) | Setting | Configure | Description | |-------------------|------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | Host | t.b.a. | The hostname of the sending Retarus SMTP server for a specific sending domain. This information will be made available through Retarus in the service setup phase. Host names use the following format: `..`. **Example** [mail-de.retarus.com](http://mail-de.retarus.com/) | | Port | 25, 587, or 2525 | The port number of your company's SMTP server. Relaying of email is supported on port numbers 25 (preferred), 587, or 2525. | | TLS Setting | Required Verify | The Retarus service requires enabled TLS to operate. Select "Required Verify". | | Enable SMTP auth? | ACTIVATED | In the Retarus environment, Auth Plain is used with User name and Password provided by Retarus. Make sure that the checkbox is activated. | | Auth Type | Auth Plain | Select "Auth Plain". | | Username | t.b.a. | Specify the user name for relay host SMTP authentication. If "Enable SMTP Auth" is set to true, this field is required. | | Password | t.b.a. | Provide the password for relay host SMTP authentication | | Confirm password | t.b.a. | Confirm your password | 2. Setting up an Email Domain Filter Next, we establish an email domain filter which determines whether an email relay is restricted to specific domains. We configure the filter for the relay we established in the last chapter. #### **Select 'Email Domain Filter'** Select From setup menu: email β†’ email delivery settings β†’ email domain filters #### **Select 'Create Email Domains Filter'** and configure according to the table below ![grafik-20240522-094043.png](https://docs.retarus.com/__attachments/a_795850610d31e5f55da98626c4f2ba16d283c4934c55722842469c8efc2e0159/grafik-20240522-094043.png?cb=cd8851193c8aa146433ac15f490c84a5) | Setting | Description | |------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | Sender Domain | Restricts the email relay to sending emails based on the listed sender domains. This field accepts comma-separated values and supports the wildcard character \* (default). | | Recipient Domain | Restricts the email relay to sending emails based on the listed recipient domains. This field accepts comma-separated values and supports the wildcard character \* (default) | | Email Relay | Select here the email relay for the domain filter, which was created before. | | Active | Enables or disables the domain filter. For the Retarus adapter described here, activate the filter. | It's surely good advice to discuss the best definition of domain filters, in particular the usage of wildcards, ahead of the go-live. Don't hesitate to discuss this subject with your Retarus representatives, too. **Finally, save the page.** 3. Configuring Deliverability Settings Once the email relay is enabled in Salesforce, companies do not necessarily need all the Salesforce Email Deliverability settings located in Setup, e. g. Bounce Management with Email Relay. Some of these settings modify the envelope-From address of emails sent from Salesforce. The header From address remains set to the sender's email address. The return-path in the headers is also modified. This change in the email headers may affect email delivery to your email server, as the modified return-path includes a Variable Envelope Return Path value (VERP). * Example of a standard return-path: [name@domain.com](mailto:name@domain.com) * Example of a VERP return-path: \ #### Select 'Deliverability' Select from setup menu Email β†’ Deliverability #### Configure Deliverability options Disable the following two email deliverability options when using email relay with Retarus: * Turn off "Activate Bounce Management" as the Sender Domain will be overwritten and therefore no accepted at Retarus Transactional Email * Turn off "Enable compliance with standard email security mechanisms" * Turn on "Configure TLS settings for outbound emails" with "Required Verify" ![grafik-20240522-094518.png](https://docs.retarus.com/__attachments/a_c7a06147f48f57bac64ea9fb319cbd7fc3624db2f94f8fd68ff707e5ae0c6936/grafik-20240522-094518.png?cb=8a5cc4a5598bf3cd043d4c1da63afaad) 4. Configuring Deliverability Settings Once the email relay is enabled in Salesforce, companies do not necessarily need all the Salesforce Email Deliverability settings located in Setup, e. g. Bounce Management with Email Relay. Some of these settings modify the envelope-From address of emails sent from Salesforce. The header From address remains set to the sender's email address. The return-path in the headers is also modified. This change in the email headers may affect email delivery to your email server, as the modified return-path includes a Variable Envelope Return Path value (VERP). * Example of a standard return-path: [name@domain.com](mailto:name@domain.com) * Example of a VERP return-path: \ #### Select 'Deliverability' Select from setup menu Email β†’ Deliverability #### Configure deliverability options Disable the following two email deliverability options when using email relay with Retarus: * Turn off "Activate Bounce Management" as the Sender Domain will be overwritten and therefore no accepted at Retarus Transactional Email. * Turn off "Enable compliance with standard email security mechanisms". * Turn on "Configure TLS settings for outbound emails" with "Required Verify". After disabling the settings, outbound email sent from Salesforce to your relay server will show both envelope-from and return-path as [name@domain.com](mailto:name@domain.com). #### Disable enhanced email Do to the fact, that Salesforce is rewriting the Email From Address for Open and Link Tracking, Enhanced Email has to be disabled. ![grafik-20240522-094625.png](https://docs.retarus.com/__attachments/a_f721c62d4d6c1c7fc5610540b91c81a1d6ea8368ab8da2003d204b6a7476cdae/grafik-20240522-094625.png?cb=712c89f19189677c6fef01fa83919cdc) 5. Verification of the Adapter in Salesforce To verify the configured adaptor, we set up a little test scenario and send perform a test email transmission. ### Test setup In order to test the adapter, we * create a new account * create a new contact * send a mail to the contact from the contacts page We assume familiarity with the process of creating an account and a contact with email address in Salesforce. We will skip most of the details here. Please refer to the official Salesforce documentation or help base in case of anyquestions. ### Expected results After a successful mail transmission, we should see an acknowledgment directly in the contactspage - mail summary. #### **Add test account** ![Salesforce Screenshots TEM-20240614-121125.png](https://docs.retarus.com/__attachments/a_d4b95de259de97a5b05b0d2b6783ad2781b88998d05b2a11c7bbf77431c86227/Salesforce%20Screenshots%20TEM-20240614-121125.png?cb=7bc8346d0ccb67f6521efd62507763f8) #### **Add test contact with an email address** ![grafik-20240522-094905.png](https://docs.retarus.com/__attachments/a_2d939cca21ee704b44769f7a3864b50f930eecf424508323380f2542b9cc98b9/grafik-20240522-094905.png?cb=8cf7be8f6b51aa2783c9b42b71ae081f) Create a test contact with an email address. #### **Write and send email from the contacts page** ![grafik-20240522-094936.png](https://docs.retarus.com/__attachments/a_797a2bfffba9ed1b11074fdeb985ae628c8a9b6f6460efabbb49e8f4dda483f4/grafik-20240522-094936.png?cb=62e2b7b7b4f2f5440e37cbc4b3a2d61b) ![grafik-20240522-094947.png](https://docs.retarus.com/__attachments/a_47e7d6410878299f5cb57f0a109262106c3858573b43a539c1652afaf7925e9b/grafik-20240522-094947.png?cb=b17e2618120158bac887543ee0fdccd8) #### **Check email transmission in Salesforce** Successfully sent emails will be listed in your email summary. ![grafik-20240522-095024.png](https://docs.retarus.com/__attachments/a_cb7813532cb1591f2917ac82bf7fa4dc0d95a543a9ea0cfe1f9042da6e027972/grafik-20240522-095024.png?cb=cb86870abe9a59a65b7b8ac1fbc73120) 6. Verify in Retarus EAS (Retarus Enterprise Administration Portal) ### EAS Portal To check and monitor the email traffic, we go to the Enterprise Administration Services Portal. Visit: and log in with your EAS admin account credentials. Do not confuse the EAS login with either SMTP server credentials nor Transactional Email account ID's. Service stakeholders and administrators obtain an EAS user account in the setup phase from retarus or their own respective admins. Please note that the availability of reporting or tracking views in EAS and myEAS depends on certain rights, which must be assigned to your EAS user login. In case you miss something, please contact your administrator and check your portal user security level. The EAS provides access to configuration options as well as reporting and tracking overviews. In the top menu, select "Transactional Email" and in the left-hand menu, "Reporting." You should be able to find and investigate the emails sent from your Salesforce tenant. 7. Tips for Usage and Roll-Out ### Activate the Multiple Email Relay Feature From Setup, enter Email Relay Activation in the Quick Find box, and select Email Relay Activation. Select Try it now. If you have an existing email relay, your host information is preserved when you activate the multiple email relay feature. --- language: "en" --- # Connectors & Add-Ins * [Adobe: Email Adapter on Experience Cloud (SMTP)](https://docs.retarus.com/tem/adobe-email-adapter-on-experience-cloud-smtp.md) * [Salesforce: Setting up the SMTP Adapter](https://docs.retarus.com/tem/configuring-the-smtp-adapter-for-salesforce.md) * [SAP: Email connector on BTP Integration Suite](https://docs.retarus.com/tem/sap-email-connector-on-btp-integration-suite.md) * [SAP: Integration Flows with Open Connectors on BTP Integration Suite](https://docs.retarus.com/tem/sap-integration-flows-with-open-connectors-on-btp-.md) * [SAP: Setting up the SMTP Adapter BC-SMTP Connector](https://docs.retarus.com/tem/sap-integrating-an-smtp-relay-in-sap-s-4hana.md) * [SMTP Concentrator](https://docs.retarus.com/tem/smtp-concentrator.md) --- language: "en" --- # CSA Feature and headers ## Overview Transactional Email offers sending emails via IP registered to the Certified Sender Alliance. By doing, so, the inbox placement is improved when delivering emails to Internet Service Providers and Mailbox Providers part of the CSA Partnership ([official Participants list](https://certified-senders.org/participants/)). The CSA feature has been meant as a control setting to make sure emails sent via CSA-certified IPs comply with [Certified Sender Alliance criteria](https://certified-senders.org/regulations/ip-certification/en/criteria.pdf). Among other technical requirements that Retarus handles during Onboarding phase, the CSA feature enforce the following conditions: * List-Help header when sending non-list-based, transactional emails; * or List-Unsubscribe header when sending list-based, promotional emails. The subsequent selection of the appropriate header depends on the content of the email to be sent and is the responsibility of the Transactional Email end-customers. ## Feature activation By default, the CSA feature is not available upon Technical Account creation. Only a Retarus Admin, via a Support Request, can enable and configure it in case CSA-certified outgoing IPs have been booked. Depending on the mailflow typology to be processed through the Technical Account and assigned Sender Domain(s), the CSA feature will be configured accordingly. ## How to use the feature During Processing, the CSA feature configuration will be tested against the incoming message. If the JobRequest fails the validation of the configuration, the request is synchronously rejected. Every email sent must contain either a "List-Unsubscribe" header or a "List-Help". ### List-Unsubscribe The "List-Unsubscribe" header is required for promotional/list-based mailing and must be inserted with a "POST HTTPS" link including "One-Click-Unsubscribe". The specified link must enable direct one-click unsubscription at least at list level. *Example of valid inserted headers:* List-Unsubscribe: List-Unsubscribe-Post: List-Unsubscribe=One-Click ++Special++: to fulfill with Bulk Sender best practices as well, when a List-Unsubscribe URL is detected for a REST JobRequest, a "List-Unsubscribe=One-Click" value for the List-Unsubscribe-Post header is automatically added before sending. ### List-Help For transactional/non-list-based mailings, the "List-Help" header must be set as an alternative to the "List-Unsubscribe" header. The "List-Help" header must contain at least a "mailto:" address or an HTTP**S** link. HTTP links are not permitted. Both the use of the "mailto:" address and the HTTPS link must give the recipient the opportunity to receive information about the reason why the email was sent to them and why it is not possible to unsubscribe at list level. *Example:* *with an email address:* List-Help: *with a HTTPS link:* List-Help: *with both:* List-Help: , --- language: "en" --- # CSV reporting > πŸ“Œ This feature is only available in the EAS portal. Retarus provides a daily dispatch report in CSV format on the EAS portal. The reports are available to the customer for collection. The CSV-file will be available for Download for 180 days. Only transactions that have a final status are recorded in the report. Transactions that are still being processed are not listed. The report can be split into several partial files and made available in compressed form (for example, in ZIP format). Note: Setting up a CSV report requires temporary data storage for the purpose of service fulfillment. The stored data contains information about message processing as well as personalized data, e.g. email addresses of senders and recipients. The following information is provided: * customerNo * account * jobId * dateRecieved * recipientEmailId * recipient * transmitter eventType * eventSubType * eventPhase * eventState * eventDescription * dateFinished * deliveryTimeSec * responseCode * dsn * reason --- language: "en" --- # Custom views If you frequently use the same filters or column settings, you can save them as a custom view. This allows you to quickly restore your preferred report configuration without adjusting it each time. ## Saving a custom view 1. Click **COLUMNS** . β†’ The left side panel opens showing all available columns. ![image-20260423-082933.png](https://docs.retarus.com/__attachments/a_9c580c75e3dde47f4f89cdc31ff2287805315f1a7fc8a62d7a7654d0d859880f/image-20260423-082933.png?cb=186ac55d17d45055e823d23c4d48f063) 2. Select or deselect columns as needed. * Hidden columns can be re-added at any time. * The **Creation Time** column remains visible and cannot be hidden. 3. Click the **MAIN FILTERS** tab and apply your desired filters. ![image-20260423-083132.png](https://docs.retarus.com/__attachments/a_8eea0357b4493165b5c4dfdda4a5411531a1eaf89edc17bf09aea39ccbc1f3d6/image-20260423-083132.png?cb=600832a5a3df10be91c6f2e940a5438d) 4. Click **SAVE VIEW** . β†’ The **Save View** dialog opens. ![image-20260423-083231.png](https://docs.retarus.com/__attachments/a_7188287fd4f7b622d3cbcf3bf8e0e73867ec7bf199ebea14d0f159c69ad609f9/image-20260423-083231.png?cb=f9df09a65d4f0176a8d2de7bd06e7c31) 5. Enter a name for your custom view (up to 25 characters). 6. *Optional:* Provide a brief description of the view's purpose (up to 60 characters). 7. *Optional:* Set the view as default by clicking **Set as default** . The default view loads automatically when you open UDR Reporting. The option becomes active once a valid name is entered. 8. Click **Create**. Once saved, the view appears in the **CUSTOM VIEWS** list. To apply it, select the view from the list. ![image-20260423-083429.png](https://docs.retarus.com/__attachments/a_3f5eb9e49b34d0307bbb20c74ce42e959877e2eb94a687a2c1f8d8884f4d7a0c/image-20260423-083429.png?cb=6b1220d772f7628da5d7eb97923a6342) ## Updating a custom view There are two ways to update an existing custom view. ### Update view content (columns or filters) If you modify the active report (for example, by adding or hiding columns, or changing applied filters), you can save these adjustments back to the same view: 1. Select the custom view whose content you want to update. 2. Make your desired changes in the reporting screen. 3. Click **SAVE VIEW** . β†’ The **Save View** dialog opens. ![image-20260423-083748.png](https://docs.retarus.com/__attachments/a_4d23fd467f1fe082eab75b888bafd1a61bed93b1a91849ba0405e3f895b5120a/image-20260423-083748.png?cb=de29384a025bc2d08bd78d17e71cf0d6) 4. Click **SAVE \& UPDATE** to apply your new layout to the currently selected view. You can also create a new view from the same dialog by entering a new name and clicking **CREATE NEW**. ### Update view properties 1. In the list of available views, click **MANAGE CUSTOM VIEWS** . β†’ The **Manage Custom Views** dialog opens. ![image-20260423-084130.png](https://docs.retarus.com/__attachments/a_80a9d8fb26dc17387e897bd8fbb6eeb761d1aa13f084e977b4323161e17d39c5/image-20260423-084130.png?cb=199107e078d352c7bf7b5d4d95a19b3d) 2. Locate the view whose properties you want to change. 3. Update the name, description, or default flag as needed. 4. Click **Save** to confirm your changes. ## Deleting a custom view 1. Open the **Manage Custom Views** dialog. 2. Click the trash icon next to the view you want to delete. β†’ A confirmation dialog opens. 3. Click **Yes, delete** to confirm. β†’ The view is permanently removed from your custom views list. --- language: "en" --- # Transactional Email Dashboard The Transactional Email dashboard delivers a real-time overview of your email traffic, allowing you to: * Monitor overall delivery performance for submitted emails. * Identify issues, including hard bounces, soft bounces, and dropped messages. * Detect unusual patterns or sudden drops in performance across various time intervals. * Access detailed insights quickly using linked tools such as **Live Search** or **Reporting**. The dashboard supports both operational monitoring and proactive issue detection, helping you maintain high deliverability and a strong sender reputation. ![image-20260225-074409.png](https://docs.retarus.com/__attachments/a_d8f4a437d29cbe696249824e85c3649f83a1bf9315f35f2159c50515ed1403f6/image-20260225-074409.png?cb=9d0a69dd48507deab8f6743055328a58) Disclaimer: Displayed Email Transaction Metrics \& Chart Values The email transaction data shown in this dashboard is retrieved from our monitoring system and visualized over fixed time intervals (e.g., 15 minutes). To ensure responsiveness and scalability, we may use data extrapolation or interpolation depending on query timing and data availability. This approach keeps metrics **fast and clear for spotting trends**. Please note: * Discrepancies may occur between displayed values and exact counts due to metric sampling or system approximations. Shorter time periods capture fewer data points, which can increase statistical variance. * These differences are expected and **do not indicate data loss or errors** in the underlying systems. * Displayed metrics are intended for trend monitoring and operational decisions, not for exact reconciliation or accounting purposes. * For exact totals, refer to the Transactional Email Reporting area in myEAS. * We continuously improve our monitoring logic to ensure high data accuracy. The dashboard uses a set of shared components and interactions consistent across all Retarus products. For general information about chart controls and visualization features, refer to [Working with charts](https://docs.retarus.com/eas/working-with-charts.md). ## Dashboard layout overview The dashboard consists of several key areas: * Timeframe selection and auto-refresh controls at the top * **Transactions Overview** panel with high-level status cards * **Hard Bounce Events** panel for bounce classification * Transactional Email--specific charts (**Delivery Rate %** , **Message Rate**) ## Timeframe and auto-refresh You can adjust the displayed timeframe using either quick ranges or a custom date and time range. Auto-refresh is available when a quick range is selected, ensuring that your data updates continuously during active sending periods. ![image-20251124-093430.png](https://docs.retarus.com/__attachments/a_f0cc4aeaa024f40350feec8cda4efad97e0aadf0b65987120a452cd163f47e1a/image-20251124-093430.png?cb=b75a25aac30f81b848e23f0b426f0c74) For detailed information on timeframe controls and auto-refresh behavior, see [Working with charts](https://docs.retarus.com/eas/working-with-charts.md). ## Transactions Overview The **Transactions Overview** panel summarizes the lifecycle of your submitted emails within the selected timeframe. Each status is shown as a metric card that displays the total count and a percentage value. ![2025-06-03 16_52_09-Window.png](https://docs.retarus.com/__attachments/a_afeb3077128c9d00d13983d628e408278968f77510c5c12f29b4fec6135a271d/2025-06-03%2016_52_09-Window.png?cb=0540d8898e01edc455208e1240b01b8a) ### Cards definition | **Card** | **Description** | **Percentage relation** | |---------------------|------------------------------------------------------------------------------------------------------------------------------------|-------------------------| | **Submitted Total** | Emails successfully received and accepted for processing. Each message is tracked from this point until it reaches a final status. | --- | | **Dropped** | Messages removed during processing before being sent---often due to suppression list rules. | `% of Submitted` | | **Sent** | Emails processed and sent out by the Transactional Email service. | `% of Submitted` | | **Delivered** | Emails successfully delivered to the recipient's server. | `% of Sent` | | **Hard Bounced** | Emails permanently undeliverable due to issues such as invalid addresses or recipient server rejection. | `% of Sent` | | **Soft Bounced** | Emails temporarily undeliverable and classified as final soft bounces after several attempts. | `% of Sent` | ### Cards thresholds To help monitor deliverability, certain metric cards include visual alerts. Colors and labels indicate whether values fall within typical industry ranges. ![screenshot_TEM_MetricCardAlerts_Labeled_Coloured.png](https://docs.retarus.com/__attachments/a_23de688ddfe74841fedcd3fcb8947502755bc49206c73e86a2b5cee0c1380636/screenshot_TEM_MetricCardAlerts_Labeled_Coloured.png?cb=7017eb4e1f5d71b07689c498abe271b8) | **Card** | **Healthy** | **Monitor** | **Investigate** | |------------------|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------| | **Dropped** | \< 2% | 2% -- 5% A common cause of high message drop rates is recipient removal by the Suppression List. Update your Sending List to exclude these recipients. | \> 5% A potential issue has been identified. Analyze the Reporting to determine the cause of the high drop rate and implement corrective actions. | | **Delivered** | \> 97% | 95% -- 97% You can further improve your delivery rate by reviewing the [Email Deliverability Guide](https://www.retarus.com/wp-content/uploads/2021/09/retarus_2021-deliverability-guide_en.pdf). | \< 95% Review the hard and soft bounce SMTP response codes in the Reporting to identify delivery issues. | | **Hard Bounced** | \< 2% | 2% -- 5% Maintain a healthy Sending List by removing hard bounces promptly and reviewing unengaged subscribers periodically. | \> 5% Review the hard bounce SMTP response codes. Clean your Sending List and examine your opt-in procedure to protect your sender reputation. | | **Soft Bounced** | \< 2% | 2% -- 5% Review the soft bounce SMTP response codes in the Reporting to understand temporary delivery failures. | \> 5% Review your sending volume and rate. A significant increase in email volume can cause throttling. | ## Hard Bounce Events The **Hard Bounce Events** panel shows the specific causes of hard-bounced emails. Hard bounces are permanent delivery failures that typically indicate issues with the recipient address or domain configuration. The panel categorizes messages by common hard bounce reasons, helping you quickly identify delivery problems. Click any hard bounce card to view the prefiltered Reporting for that SMTP status code. ![image-20251124-103045.png](https://docs.retarus.com/__attachments/a_281737327f116b818dc87c0f179c183acdd11dee464eb615b70441072c5d7c7e/image-20251124-103045.png?cb=18c473b5522f58215133e6ab62d79ffb) | **Status** | **Description and possible actions** | **SMTP status code** | |----------------------------------|-------------------------------------------------------------------------------------------------------------------|----------------------| | **Mailbox unavailable** | Invalid or disabled email addresses. Remove them from your Sending List. | 550 | | **Domain not found** | Recipient domain unrecognized. Check domain syntax. | 500 | | **Recipient policy restriction** | Transaction failed due to local policy or restriction. Review the SMTP response codes from the recipient servers. | 554 | | **Full mailbox** | The recipient's mailbox is full and cannot accept more emails. Reduce the message size or retry later. | 552 | | **Domain blocklisted** | Your sender domain may be blocklisted. Ensure messages do not contain spam or malware characteristics. | 553 | ## Delivery Rate % The **Delivery Rate %**chart shows how successfully your emails were delivered over time. It plots the percentage of delivered messages against all sent messages in hourly intervals within the selected timeframe. This chart helps you spot trends quickly and take proactive steps before delivery issues impact performance at scale. The **Delivery Rate %** chart shows the percentage of successfully delivered emails over time in hourly intervals. Use this chart to identify trends and address delivery issues before they impact performance at scale. ![2025-06-03 21_15_49-Window.png](https://docs.retarus.com/__attachments/a_fc41f1e40e7c330df0721a5600d6c6bea64cf27e329a8c23716a9245f9e07b06/2025-06-03%2021_15_49-Window.png?cb=12c0819fa37e9d8e4c0b5f206c0ca8e7) * A consistently high delivery rate (over 95%) indicates your emails are reliably reaching recipient servers. * Spikes or drops may signal delivery problems, such as increased bounce or drop rates, or changes in recipient behavior or infrastructure. * Lower rates during specific timeframes may result from issues with your sending list, message content, or recipient servers. ## Message Rate The **Message Rate** chart shows the distribution of email activity, helping you understand message volume and delivery outcomes over time. It combines all accepted emails into stacked bars, with each status represented by a different color. This chart is especially useful for teams sending in hourly batches or managing time-sensitive campaigns. ![image-20251124-103739.png](https://docs.retarus.com/__attachments/a_8e2307f9a1aa4afff807b1bf605e475a9c237a59b39f6b80785b559815c4a14b/image-20251124-103739.png?cb=80370b0d6f187de2e80497ba5d175373) By default, the **Delivered** traffic is hidden to improve chart readability. The height of each bar reflects the total number of messages processed during each period, allowing you to: * Identify periods of high or low traffic * Visualize how failures (bounces, drops) affect total volume * Compare delivery success rates across different times of day ## Investigating Delivery Issues If unusual patterns appear in the dashboard: * Select an appropriate timeframe to focus on the affected interval. * Review metric cards for elevated bounce or drop rates. * Use the charts to pinpoint when issues began or how they progressed. * Open Reporting by clicking a status or event category. * Review SMTP response codes to identify the underlying cause. * Correlate patterns with campaign activity or sending list changes. ![image-20251124-103956.png](https://docs.retarus.com/__attachments/a_d558db20819bf8bf7644b99110eb003b50f28f7e90ece210add00dba16eeab45/image-20251124-103956.png?cb=5bf286daef5da9449a35ce93af3002e1) --- language: "en" --- # Data center operations With Retarus Transactional Email Infrastructure, you can send outbound emails to recipients worldwide. Retarus transmits your messages over the internet to the intended recipients, with full support for SPF and DKIM authentication. Retarus prioritizes security, flexibility, and high availability for all cloud-based messaging services. To ensure availability, Retarus maintains an **Active/Active setup** with geographically separate data centers in each region, connected via DNS round-robin. Both data centers in each region provide complete functionality for Retarus Transactional Email services. ## Data center infrastructure ### Locations \& certifications | **Region** | **Data centers** | **Distance** | **Certifications/standards** | |--------------------|----------------------------|----------------------|------------------------------| | **Europe/Germany** | Frankfurt Munich | \~400 km (250 miles) | ISO22301 ISO27001 PCI-DSS | | **USA** | Ashburn (VA) Secaucus (NJ) | \~400 km (250 miles) | SSAE 18 SOC 1 \& 2 Type II | ### Data centers in Europe/Germany ![image-20250819-072645.png](https://docs.retarus.com/__attachments/a_bf11714ba28111353fcb74dfdf5a003de6353dc4538df0b867b730e53686bafa/image-20250819-072645.png?cb=281c00e0eee26c6c2685dbe42b7a6e29) ### Data centers in USA ![image-20250819-072430.png](https://docs.retarus.com/__attachments/a_f096d7f1ccb896cf66dd62a1d0ba86dc6fa4ccc5a34b71b1e1efb9d57c7efe24/image-20250819-072430.png?cb=a207d76d62d308b03025b6b8975d8688) **Security measures (both regions)** * Access monitored via cameras and security guards * Multiple physical access barriers (e.g., mantraps, biometric scanners) * Authorized personnel access only * Employees (active and retired) bound to privacy and non-disclosure obligations (GDPR in EU; corporate standards in USA) ## Infrastructure operations * Both data centers in each region support the full feature set of Retarus Transactional Email services. * For dedicated IP addresses in an Active/Active setup, you must order an additional dedicated IP addres**s** separately through the article catalog. ## Configuration requirements To use the distributed infrastructure effectively, you must: * **Configure system endpoints** Use the regional endpoints listed below in your application configuration. * **Manage DNS cache** Regularly clean your DNS cache to ensure proper failover. If the cache is not refreshed, your systems may continue addressing a faulty data center. * **Update firewall rules** Allow the Push notification sender IP addresses listed below. No Retarus-side configuration is required: all backend configuration is handled automatically. ## Endpoints | **Region** | **REST endpoint (port 443)** | **SMTP endpoint (ports 25 / 2525 / 587)** | |--------------------|--------------------------------------------|-------------------------------------------| | **Europe/Germany** | `https://mail-de.retarus.com/rest/v2/jobs` | `mail-de.retarus.com` | | **USA** | `https://mail-us.retarus.com/rest/v2/jobs` | `mail-us.retarus.com` | ## Push notification sender IPs | **Region** | **Data center** | **IP addresses** | |--------------------|----------------------------|-------------------------------------------------------| | **Europe/Germany** | Frankfurt Munich | 94.199.93.207 94.199.93.205 94.199.89.13 94.199.89.15 | | **USA** | Ashburn (VA) Secaucus (NJ) | 199.204.15.68 207.126.137.69 | ## DNS configuration ### SPF Records (clobal) Include the Retarus default SPF record in your DNS configuration to cover all outbound IP addresses used by Retarus: v=spf1 include:_spf.general.transactional-mail-a.com ~all If you implemented this SPF record during the onboarding process, no additional changes are required. ### DKIM (global) DKIM administration is managed centrally by Retarus. No action is required on your part in the event of a data center outage, as DKIM keys and configuration are synchronized across all data centers. --- language: "en" --- # A detailed look into your Transactional Email invoice At Retarus, we value transparency. When you receive an invoice from us, you should never be unsure about who you're paying or what you're paying for. This page walks you through your invoice step by step, so you can easily read and understand each section. > πŸ“Œ **Sample invoice** > > You can download a sample invoice as a PDF to see the complete layout. > > > [Download sample invoice (PDF)](https://docs.retarus.com/__attachments/a_e9394caaf0f63247ac21110330841d2ac9bad26d4971654c426e09326b221345/TEM_Sample_Invoice.PDF.md?cb=2b643ebd408ebb13d7f4182093f7d268) ## Name and address of your company ![image-20260112-085253.png](https://docs.retarus.com/__attachments/a_dcad8b43c3b260759ea566725025c2d7a7656f5bc3aa648bd56b2a89af44c028/image-20260112-085253.png?cb=9eb923d492910a307301834642129cc2) This section shows your company's billing address, which we use to determine your applicable taxes and ensure the invoice reaches the right recipient. ## Reference details ![image-20260112-085345.png](https://docs.retarus.com/__attachments/a_c8186c29d1873f02651ae869caf9520e88e4d43e4e3c3e0ac480b29e5e92e793/image-20260112-085345.png?cb=47ef44014bbe5f8737079982647f6a7e) This section gives you all key information at a glance: * Your unique invoice identifier and the date it was issued. * Shows which page you're viewing and the total number of pages. * Your internal reference information (if provided). * Any message or note you've shared with us. * Your company's VAT registration number. * Your unique Retarus customer identifier. * The Retarus department handling your account. * Our supplier number for your records (if applicable). ## Purchase order number ![image-20260112-085811.png](https://docs.retarus.com/__attachments/a_85ff6c213d6e2f7da7d5a3752ef9e954ecfe46bff99a86cd96f40c5d9f1dd474/image-20260112-085811.png?cb=672cc0d2ed608bf1e6f063c547508024) ## Itemized cost breakdown ![image-20260112-085932.png](https://docs.retarus.com/__attachments/a_ec9ced52d24d4c0f54ebaab99d1dfe86d12d979974e7b2669ffe3138817b3813/image-20260112-085932.png?cb=bb200913fc492a8279944cbddf7a8cfc) This is the centerpiece of your invoice. It breaks down all your charges by product and usage, showing: * The Retarus product you're using (e.g., `Transactional Email`). * The month covered by the charges (e.g., `10.2024`). * Detailed line items for each service component. * Number of units consumed or reserved. * Price per unit. * Any applicable accounts. * The calculated cost for each line item. This gives you maximum transparency and insight into your product usage and the associated charges. ## Tax details and sum total ![image-20260112-090619.png](https://docs.retarus.com/__attachments/a_f9aae4cc491c35db54a8e7fbc3fd177586d819aecc3f6da807403d21746a6699/image-20260112-090619.png?cb=adfed7d28224c7dea763f50c6f3068dd) This section shows: * **Net total** The sum of all charges before tax. * **Value-added tax** The applicable VAT rate (e.g., 19.00%) and the calculated tax amount. The VAT calculation is based on your company address and the applicable tax regulations in your region. * **Total Amount** Your final invoice amount including all taxes. ## Payment terms ![image-20260112-095018.png](https://docs.retarus.com/__attachments/a_33383eab372f5d30c9c600cc4cdc1a055b8efdcf6c1002485ce24643cec0b142/image-20260112-095018.png?cb=64ca1d826598a924be66d668ecbc5c10) This section provides all the information you need to pay your bill: * Payment terms (e.g., "30 days net"). * Due date by which payment must be received. * The total amount to be paid. ## Final remarks We hope this helps you better understand your invoice and gives you the insights into your usage, charges, and payment terms that you need. If you have any further questions, please do not hesitate to contact your customer care representative. --- language: "en" --- # Email Live Search The **Email Live Search** feature helps you and your IT team quickly locate outgoing emails and analyze their processing status within the **Retarus Transactional Email** infrastructure. Live Search provides detailed insights to improve support efficiency and system security. ## Accessing Live Search To access Live Search: 1. Open the Live Search page using one of the following options: * Click **Live Search** in the EAS navigation menu ![image-20250226-092730.png](https://docs.retarus.com/__attachments/a_69cac00506049eb34897d750859905c87580fe0085142532d3ac0b9c3575d527/image-20250226-092730.png?cb=59c103d6ad9b33a29af292d7a45c6eef) * Click **Live Search** in the myEAS navigation menu. ![image-20260714-144315.png](https://docs.retarus.com/__attachments/a_21cf9d9ae0ee02c63cca061f768f6194781029fececdbff3fae5ff63aeee7c28/image-20260714-144315.png?cb=3441b3f072c7afb06dc75400c2aaf724) 2. On the **Live Search** page, select **Email Research** . β†’ The **Results** page opens. ![image-20260714-145431.png](https://docs.retarus.com/__attachments/a_a5f93d3371962d6fc6be0b6414314c0a065d788f57a9e88f378f55da8e0923e4/image-20260714-145431.png?cb=1f63cb63256541d434708627a6534252) ## Searching for emails You can search for emails using various criteria, including: * Sender * Recipient * Message ID * Reference ID * Campaign ID * SMTP Status Code * Application Source IP * Job ID * Cost Center * Technical Account You can use partial search terms, such as `"info"` or `"inf"`, to find `info@retarus.com`. Matching emails appear directly below the search mask. ![image-20260714-145551.png](https://docs.retarus.com/__attachments/a_24047d73b1567193f8e8e32515143e7e166f44347bc748f59fd7af8900720c28/image-20260714-145551.png?cb=ee87aff273c94afe142e5a9c66a67019) ### How to search 1. Enter your search parameters in the provided fields. 2. Click **Apply Filters** to display the results. ## Viewing email details After finding the email you need, click the **Details** button for a specific result to access: * Meta-information, such as the date, RMX ID, MTA ID, sender/recipient details, and source IP address. * Processing status, showing each step in the email's journey. * Tracking information, offering further insights into the message flow. * If applicable, the profile name is displayed to help verify user settings (e.g., profile-based blocklists or allowlists). The following screenshot shows an example of the results you may see when using Email Search. ![image-20240507-083009.png](https://docs.retarus.com/__attachments/a_79f1e081e8f2c72135667576265034d9f34dd6192b185345becc2e201d851149/image-20240507-083009.png?cb=f05b273cb1508246ec6e6f46512edf3f) It displays tracking information, with all details shown in the order they were processed. ![image-20240507-083109.png](https://docs.retarus.com/__attachments/a_b1532e9ff082eea0f96bc04ee69551cf914d2096f955b208f81ac14386702de1/image-20240507-083109.png?cb=223c27e8f72502b32f7a3359db069e36) --- language: "en" --- # Email report sample ![image-20240507-081639.png](https://docs.retarus.com/__attachments/a_6b46f9e08eff8080d352cd8bce9dbb23e83a2b99436c9bade7fb69b3384e0bb2/image-20240507-081639.png?cb=af76a4ea998a593f42f59e8879c8b5ec) --- language: "en" --- # Enforced TLS The use of enforced TLS is supported. During the basic configuration of the service, a hybrid encryption protocol is defined at the dispatch domain level to be used for each dispatch. Thus, an encrypted dispatch (enforced TLS) is tried with each dispatch by the customer with the given domain. The dispatch is aborted as soon as no encrypted success is accepted on the receiving side. It is mandatory for Certified Senders Alliance (CSA) IPs to use the enforced TLS for their emails deliveries. Retarus Transactional Email can cover: * TLS 1.2 or TLS 1.3; * Encryption standards (cipher suites): the most widely used standards on the market (for instance AES-256); * Encryption key length: maximum 2048 bits; * Certificate Authority: Digicert; --- language: "en" --- # EnvelopeFrom Address Rewriting ![image-20240508-135757.png](https://docs.retarus.com/__attachments/a_5b08802eb37d6a780f06ef868d5a6d32823d099b1df11e5ef9c7c2eafc919f0f/image-20240508-135757.png?cb=a4541eb803ba8b504c0bae27a362f94f) With the **EnvelopeFrom Address Rewriting** service, you can modify the EnvelopeFrom address of each email during processing. Common reasons for using this service include company policies that restrict the use of the customer's own domain for certain communications (e.g., when contacting private individuals), requirements during a merger or acquisition, or security measures to protect the company's domain and network from potential attacks. This service automatically rewrites outbound email addresses (recipient and/or domain part). Technically, it modifies the EnvelopeTo address of emails based on a mapping list provided by the customer. The mapping file must include full email addresses (domain-only entries are not supported) and follow the required structure. Whitespaces are automatically removed during processing. JSON { "from":{ "address":"local-part@sender-domain.com" }, "rewriteFrom":{ "address":"local-part@customer-rewrite-domain.com" } } We also offer the [Bounce and Response Manager](https://docs.retarus.com/tem/bounce-and-response-manager.md). It helps manage all email replies received via the EnvelopeFrom address handled by Retarus. The service can automatically process replies and forward messages that require personal review. > πŸ“Œ If you would like to use this service, please contact Retarus for further details and activation. ## Push Notification samples To ensure maximum visibility, Retarus includes additional information about this service in the push notification. JSON { "meta":{ "account":"m4a_test_user", "customerNo":"99999", "tenant":"Test User", "receivedTs":"2020-10-16T05:54:11.043Z", "jobId":"rcpt-632cdc56-6480-406b-8faf-5a7e70876d0c", "version":"1" }, "notifications":[ { "meta":{ "tag":"a813f47bca9ded6b0305885e235c073e886168b8b63eb5e99d02d00bcc7a6371", "mail":{ "id":"rcpt-632cdc56-6480-406b-8faf-5a7e70876d0c", "email":"recipient ", "from":"sender@sample.com", "mimeFrom":"sender@sample.com", "rewriteFrom":"sender@rewrite-sample.com" }, "event":{ "type":"DELIVERED", "phase":"DELIVER", "state":"FINISHED", "subType ":"OK", "ts":"2020-10-16T05:54:18.000Z", "description":"mail delivered" } }, "content":{ "mime":{ "messageId":"<20201016-...54463a38@retarus.com>", "size":"884" }, "smtp":{ "responseCode":"250", "reason":"sent (250 2.0.0 Ok: queued as 3yFnZW2mNlzPk9y)", "relay":"mailin4.rmx.de[82.135.18.227]:25", "dsn":"2.0.0", "transportEncryption":{ "requested":true, "established":true, "properties":{ "protocol":"TLS1.2", "cipherSuite":"example-cipher-suite" } } } } } ] } --- language: "en" --- # Event types and scenarios ## Summary of all possible Tracking Points Some Events are only available depending of the facade used (REST or SMTP Adapter) |-----------------|-----------------|----------------------|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **Event/phase** | **Event/state** | **Event/type** | **Event/subType** | **Description** | | PRE_PROCESS | FINISHED | DROPPED | PREVIOUSLY_BOUNCED | Recipient address found in suppression list. Recipient previously bounced. Email not delivered (includes unknown user). | | PRE_PROCESS | FINISHED | DROPPED | FORBIDDEN_RECIPIENT | Forbidden local part. | | PRE_PROCESS | FINISHED | DROPPED | INVALID_ADDRESS | Recipient address syntactically incorrect. Email not delivered. | | PRE_PROCESS | FINISHED | DROPPED | SUPPRESSED | Fallback for all fainer grained, dedicated suppression types (see above) which are currently not known by a component (e.g. for migration-pathes). | | PRE_PROCESS | FINISHED | DROPPED | VALIDATION_ERROR | Fallback for recipient validations. | | PROCESS | INITIAL | STARTED | PROCESSING_STARTED | Only if no validation errors on receiving. Thus optional in case of event.type=dropped. | | PROCESS | INTERMEDIATE | PROCESSING | COMPONENT_SKIPPED | | | PROCESS | INTERMEDIATE | PROCESSING | COMPONENT_FINISHED | Internal component requested during processing is finished, continuing further processing steps. | | PROCESS | INTERMEDIATE | SMIME_SIGNING | OK | Message has been received, signed and ready for further processed. | | PROCESS | INTERMEDIATE | PROCESSED | PROCESSING_FINISHED | Message has been received, processing is finished and is ready to be delivered. | | PROCESS | FINISHED | DROPPED | PROCESSING_FAILED | Internal processing errors. eg. missing data, invalid parameter, etc. | | PROCESS | FINISHED | DROPPED | VIRUS_DETECTED | Retarus Virus Engine detected a virus. Email not delivered. | | PROCESS | INTERMEDIATE | TRACE_RECOVER_ STORE | OK | Stored until \ for trace and recover. | | DELIVER | FINISHED | DELIVERED | OK | | | DELIVER | INTERMEDIATE | DEFERRED | SOFT_BOUNCE | Email deferred. Further attempts pending. | | DELIVER | FINISHED | BOUNCED | HARD_BOUNCE | Email Bounced. Recipient may be added to suppression list. | | DELIVER | FINISHED | DROPPED | INVALID_DKIM_SIGNATURE | Validation of DKIM-signature in OpenDKIM verifier-milter failed and config-settings impose in this case the mail to be dropped. | | DELIVER | FINISHED | BOUNCED | SOFT_BOUNCE | Email bounced. All attempts failed. Timeout. | | SMART_DELIVERY | FINISHED | DROPPED | PROCESSING_FAILED | Internal processing errors. eg. missing data, invalid parameter, etc. | | SMART_DELIVERY | INTERMEDIATE | PROCESSED | PROCESSING_FINISHED | Message has been received, processing is finished and is ready to be delivered. | | SMART_DELIVERY | FINISHED | DELIVERED | OK | | | SMART_DELIVERY | INTERMEDIATE | DEFERRED | SOFT_BOUNCE | Email deferred. Further attempts pending. | | SMART_DELIVERY | FINISHED | BOUNCED | HARD_BOUNCE | Email Bounced. Recipient may be added to suppression list. | | SMART_DELIVERY | FINISHED | BOUNCED | SOFT_BOUNCE | Email bounced. All attempts failed. Timeout. | | SMART_DELIVERY | INTERMEDIATE | DELAYED | RATE_LIMITED | Further processing is delayed because of the recipient ISP / Mail-Provider indicates the sender is trying to sent too many messages based on the sender reputation or ISP Quota / Rate-Limit. | | READ | POST_DELIVERY | OPEN | MAIL_OPENED | Recipient opened email. | | READ | POST_DELIVERY | CLICK | LINK_CLICKED | Recipient clicked the named link. | | POST_PROCESS | POST_DELIVERY | FEEDBACK_LOOP | COMPLAINT | Recipient has sent a complaint to their ISP. | | TRIGGER | POST_DELIVERY | PASSWORD_MAIL | OK | | | TRIGGER | POST_DELIVERY | PASSWORD_MAIL | FAILED | Failed to trigger password email. | | TRIGGER | POST_DELIVERY | PASSWORD_MAIL | NOT_TRIGGERED | Original mail was not delivered, password action not triggered. | | RESEND | POST_DELIVERY | TRACE_RECOVER | OK | Job resend with new jobId \. | | RESEND | POST_DELIVERY | TRACE_RECOVER | FAILED | Internal processing error. | ## Tracking Points per scenario ### Email successfully delivered |---|-----------------|-----------------|----------------|---------------------| | # | **Event/phase** | **Event/state** | **Event/type** | **Event/subType** | | 1 | PROCESS | INITIAL | STARTED | PROCESSING_STARTED | | 2 | PROCESS | INTERMEDIATE | PROCESSING | COMPONENT_FINISHED | | 3 | PROCESS | INTERMEDIATE | PROCESSED | PROCESSING_FINISHED | | 4 | DELIVER | FINISHED | DELIVERED | OK | ### Email soft-bounced and finally delivered |---|-----------------|-----------------|----------------|---------------------| | # | **Event/phase** | **Event/state** | **Event/type** | **Event/subType** | | 1 | PROCESS | INITIAL | STARTED | PROCESSING_STARTED | | 2 | PROCESS | INTERMEDIATE | PROCESSING | COMPONENT_FINISHED | | 3 | PROCESS | INTERMEDIATE | PROCESSED | PROCESSING_FINISHED | | 4 | SMART_DELIVERY | INTERMEDIATE | DEFERRED | SOFT_BOUNCE | | 5 | SMART_DELIVERY | FINISHED | DELIVERED | OK | ### Email finally soft-bounced after several retries |---|-----------------|-----------------|----------------|---------------------| | # | **Event/phase** | **Event/state** | **Event/type** | **Event/subType** | | 1 | PROCESS | INITIAL | STARTED | PROCESSING_STARTED | | 2 | PROCESS | INTERMEDIATE | PROCESSING | COMPONENT_FINISHED | | 3 | PROCESS | INTERMEDIATE | PROCESSED | PROCESSING_FINISHED | | 4 | SMART_DELIVERY | INTERMEDIATE | DEFERRED | SOFT_BOUNCE | | 6 | SMART_DELIVERY | FINISHED | BOUNCED | SOFT_BOUNCE | ### Email hard bounced |---|-----------------|-----------------|----------------|---------------------| | # | **Event/phase** | **Event/state** | **Event/type** | **Event/subType** | | 1 | PROCESS | INITIAL | STARTED | PROCESSING_STARTED | | 2 | PROCESS | INTERMEDIATE | PROCESSING | COMPONENT_FINISHED | | 3 | PROCESS | INTERMEDIATE | PROCESSED | PROCESSING_FINISHED | | 4 | DELIVER | FINISHED | BOUNCED | HARD_BOUNCE | ### Recipient found into the Suppression List |---|-----------------|-----------------|----------------|--------------------| | # | **Event/phase** | **Event/state** | **Event/type** | **Event/subType** | | 1 | PRE_PROCESS | FINISHED | DROPPED | PREVIOUSLY_BOUNCED | ### Message dropped due to processing failure |---|-----------------|-----------------|----------------|-------------------| | # | **Event/phase** | **Event/state** | **Event/type** | **Event/subType** | | 1 | PROCESS | FINISHED | DROPPED | PROCESSING_FAILED | ### Message dropped due to Forbidden Receiver Local Part |---|-----------------|-----------------|----------------|---------------------| | # | **Event/phase** | **Event/state** | **Event/type** | **Event/subType** | | 1 | PRE_PROCESS | FINISHED | DROPPED | FORBIDDEN_RECIPIENT | ### Message dropped due to syntax error |---|-----------------|-----------------|----------------|-------------------| | # | **Event/phase** | **Event/state** | **Event/type** | **Event/subType** | | 1 | PRE_PROCESS | FINISHED | DROPPED | VALIDATION_ERROR | ### Delivery adapted by SDO Outbound, email delivered |---|-----------------|-----------------|----------------|---------------------| | # | **Event/phase** | **Event/state** | **Event/type** | **Event/subType** | | 1 | PROCESS | INITIAL | STARTED | PROCESSING_STARTED | | 2 | SMART_DELIVERY | INTERMEDIATE | DELAYED | RATE_LIMITED | | 3 | SMART_DELIVERY | INTERMEDIATE | PROCESSED | PROCESSING_FINISHED | | 4 | SMART_DELIVERY | INTERMEDIATE | DEFERRED | SOFT_BOUNCE | | 5 | SMART_DELIVERY | FINISHED | DELIVERED | OK | ### Delivery adapted by SDO Outbound, finally bounced |---|-----------------|-----------------|----------------|---------------------| | # | **Event/phase** | **Event/state** | **Event/type** | **Event/subType** | | 1 | PROCESS | INITIAL | STARTED | PROCESSING_STARTED | | 2 | SMART_DELIVERY | INTERMEDIATE | DELAYED | RATE_LIMITED | | 3 | SMART_DELIVERY | INTERMEDIATE | PROCESSED | PROCESSING_FINISHED | | 4 | SMART_DELIVERY | INTERMEDIATE | DEFERRED | SOFT_BOUNCE | | 5 | SMART_DELIVERY | FINISHED | BOUNCED | SOFT_BOUNCE | ### Email resent via Trace \& Recover |---|-----------------|-----------------|----------------------|---------------------| | # | **Event/phase** | **Event/state** | **Event/type** | **Event/subType** | | 1 | PROCESS | INITIAL | STARTED | PROCESSING_STARTED | | 2 | PROCESS | INTERMEDIATE | PROCESSING | COMPONENT_FINISHED | | 3 | PROCESS | INTERMEDIATE | TRACE_RECOVER_ STORE | OK | | 4 | PROCESS | INTERMEDIATE | PROCESSED | PROCESSING_FINISHED | | 5 | PROCESS | INTERMEDIATE | PROCESSED | PROCESSING_FINISHED | | 6 | DELIVER | FINISHED | BOUNCED | HARD_BOUNCE | | 7 | RESEND | POST_DELIVERY | TRACE_RECOVER | OK | ### Email opened after delivery |---|-----------------|-----------------|----------------|---------------------| | # | **Event/phase** | **Event/state** | **Event/type** | **Event/subType** | | 1 | PROCESS | INITIAL | STARTED | PROCESSING_STARTED | | 2 | PROCESS | INTERMEDIATE | PROCESSING | COMPONENT_FINISHED | | 3 | PROCESS | INTERMEDIATE | PROCESSING | COMPONENT_FINISHED | | 4 | PROCESS | INTERMEDIATE | PROCESSED | PROCESSING_FINISHED | | 5 | DELIVER | FINISHED | DELIVERED | OK | | 6 | READ | POST_DELIVERY | OPEN | MAIL_OPENED | ### Email clicked after delivery |---|-----------------|-----------------|----------------|---------------------| | # | **Event/phase** | **Event/state** | **Event/type** | **Event/subType** | | 1 | PROCESS | INITIAL | STARTED | PROCESSING_STARTED | | 2 | PROCESS | INTERMEDIATE | PROCESSING | COMPONENT_FINISHED | | 3 | PROCESS | INTERMEDIATE | PROCESSING | COMPONENT_FINISHED | | 4 | PROCESS | INTERMEDIATE | PROCESSED | PROCESSING_FINISHED | | 5 | DELIVER | FINISHED | DELIVERED | OK | | 6 | READ | POST_DELIVERY | CLICK | LINK_CLICKED | --- language: "en" --- # Export UDR reports You can export UDR reports as Excel or CSV files directly from myEAS. Reports can be used for further analysis, record-keeping, or archiving. ## File format limits * Excel: up to 250,000 records * CSV: up to 500,000 records If you try to download a report that exceeds these limits, you see an error message indicating that the maximum number of records has been exceeded. ## Exporting a report 1. Open the UDR Reporting screen (**TRANSACTIONAL EMAIL** -- **Usage Report**). 2. Apply any filters, date range, sorting, or column selections you want to include in the export. ![image-20260422-150354.png](https://docs.retarus.com/__attachments/a_eccc06a520bd93bfc3fed506a353a228c42f817e368196fb4aa4082933eb6d57/image-20260422-150354.png?cb=61dbf5ac755b3c345ed52f85c6e8e382) 3. Click **DOWNLOAD REPORT** . β†’ The file format dialog opens. ![image-20260422-150531.png](https://docs.retarus.com/__attachments/a_e1dd50573b850ebd143fce7b1722d4bd3f3d3c017802de2e8f2ce86eec4d4414/image-20260422-150531.png?cb=f21208a940e38ca8aa3214cc3d73727f) 4. Select **Excel** or **CSV** . β†’ A message confirms that the file is being prepared. The export runs in the background. β†’ When the file is ready, a notification appears in the top navigation bar, in the **Notifications** area. ## How exports work When you download a UDR report, the file may not exactly match what you see on screen in myEAS. The exported file includes: * All visible columns from your current view * All records within the selected date and time range * Data sorted by **Creation Time** in ascending order The exported file does not include: * Any applied filters * Any applied sorting ## Viewing export notifications ![image-20260714-150001.png](https://docs.retarus.com/__attachments/a_f2bc8afa912964afd0991cf54568b72d74965dd2e3592f04b2cc9fb63ca183c1/image-20260714-150001.png?cb=602bb38215f09306006e7f59a6fe78ae) 1. Click the **Notifications** icon (bell) in the top navigation bar. β†’ The **Notifications** sidebar opens, defaulting to the **My own** tab. ![image-20260714-150200.png](https://docs.retarus.com/__attachments/a_ad7e217758bf15f095ae3534f506fdfad5055fea30fa1f7c009b4df9f028c5f6/image-20260714-150200.png?cb=bba26f8baee631fdb59ce3e0c2ebd0e6) Each notification includes: * **Title** *Transactional Email (Excel or CSV) + creation timestamp* * **Timestamp** *From \ to \* * **Description** Instructions for downloading your generated report Unread notifications are highlighted. Click **Mark all as read** to clear them. Notifications expire after 3 days, while exported report files remain available for 5 days. To open the file directly from a notification, click **See it in myEAS Home**. ## Viewing exported reports You can view and manage your recent exports from the myEAS Home page, in the **Reporting: My recently generated reports** section. ![image-20260714-150256.png](https://docs.retarus.com/__attachments/a_3a79f777a802adbd52b52ccf6f3b9deddf6512efcddca3ec2d249c19398cdea4/image-20260714-150256.png?cb=dcbc483787863bf5de24ed0cc8eb1f1e) See [Recently generated reports](https://docs.retarus.com/eas/recently-generated-reports.md) for details. --- language: "en" --- # Feature routing The Feature Routing enhance the architecture such that multiple features can be applied by job and improve job the routin within the system. In case a feature cannot be reached during processing or no authorization to use it exists, the request will be dropped with the message "VALIDATION_ERROR". --- language: "en" --- # Features in detail * [Suppression List](https://docs.retarus.com/tem/suppression-list.md) * [Smart Delivery Optimization (SDO)](https://docs.retarus.com/tem/smart-delivery-optimization-sdo.md) * [Feedback Loops](https://docs.retarus.com/tem/feedback-loop-service.md) * [Basic configuration](https://docs.retarus.com/tem/basic-configuration.md) * [CSA Feature and headers](https://docs.retarus.com/tem/csa-header.md) * [Spam Score Check](https://docs.retarus.com/tem/spam-score-check.md) * [Prohibited objects](https://docs.retarus.com/tem/prohibited-objects-rest.md) * [Open \& Link Tracking (REST only)](https://docs.retarus.com/tem/open-link-tracking.md) * [Template rendering](https://docs.retarus.com/tem/template-rendering.md) * [Secure Document Handling (REST only)](https://docs.retarus.com/tem/secure-document-handling-rest-only.md) * [AntiVirus Multiscan](https://docs.retarus.com/tem/antivirus-multiscan.md) * [Trusted Domains](https://docs.retarus.com/tem/trusted-domains.md) * [EnvelopeFrom Address Rewriting](https://docs.retarus.com/tem/envelope-from-address-rewriting-rest.md) * [3rd party Archiving](https://docs.retarus.com/tem/3rd-party-archiving.md) * [Enforced TLS](https://docs.retarus.com/tem/enforced-tls.md) * [Relay Service](https://docs.retarus.com/tem/relay-service.md) * [Allowed Sender Address](https://docs.retarus.com/tem/allowed-sender-address.md) * [Message Signing](https://docs.retarus.com/tem/message-signing.md) * [Trace \& Recover (SMTP only)](https://docs.retarus.com/tem/trace-recover-smtp-only.md) * [Bounce \& Response Manager](https://docs.retarus.com/tem/bounce-and-response-manager.md) --- language: "en" --- # Feedback Loops The recipient of your message has actively decided to classify your email as spam. We recommend that you maintain your distribution list in such a way that no further delivery is made to the complainant. The complaints are returned in an automated process. Retarus extracts the complaint information and returns it by email to your Reply-To address. After successful transmission, all related information is deleted and not archived (GDPR compliant). If you receive a notification, action is needed in order not to endanger your reputation with the respective Internet Service Provider. * [Description](https://docs.retarus.com/tem/feedback-loops-description.md) * [Email report sample](https://docs.retarus.com/tem/email-report-sample.md) * [Push notification sample](https://docs.retarus.com/tem/push-notification-sample.md) --- language: "en" --- # Description Internet Service Providers (ISPs) that provide a feedback loop service do not create it in a standardized form, so it is not possible to add additional information. The reason for this is that ISPs make most of the information within the email headers unrecognizable, so that no traceability of specific information is possible at this point. The only thing that is constantly reported back in information from the ISPs is the following information: * Reply-To-Address / From-Address * Sender-Email-Address of the original email * Sender Domain * Sender-Domain of the original email * Retarus-Message-ID * The Message-ID (=JobID[\*](https://docs.retarus.com/tem/feedback-loops-description.md)) is already provided to you about our Push Notification service * Receipt date * Time-Stamp when was the message sent to the recipient These are queried in the Retarus FBL Service, sent via email (sender = [reputation@research.retarus.de)](mailto:reputation@research.retarus.de) to the Reply-To-Address/From-Address of the original email, or returned to a previously defined mailbox and then deleted afterwards. You have also to possibility to receive alle Feedback-Loop-Information via our Push Notification service. If you would like more information, please contact your Technical Consultant. ![image-20240507-081545.png](https://docs.retarus.com/__attachments/a_73186a157e01d303eaff4d2fe4db0801caf1112e2ac8a798489324e40ef194d0/image-20240507-081545.png?cb=bf62f72081fe52e75e293e4453a997ee) --- language: "en" --- # Job validation errors |-------------------------------------------------|-----------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **Category** | **Comment** | **state-subType** | **References to request (substitutions for \)** | | Unauthorized (401) | Login or PW wrong during Technical Account authentication | UNAUTHORIZED | - | | Internal error (500, 503, 504) | A processing failure occurred in processing component | INTERNAL_ERROR | - | | Parse error (400) | Invalid JSON syntax | INVALID_JSON_SYNTAX | Exception occured on JSON parsing | | Limit exceeded (400, 413) | Limit regarding size or count is exceeded | LIMIT_EXCEEDED **Count**limit exceeded for \ **Size**limit exceeded for \ Request body **size**limit exceeded | * attachments (max. 20) * recipients.recipient (min. 1, max. 100) * recipients.mail (max. 1000) * recipients.recipient.mail.xHeaders (max. 10) * mail.xHeaders (max. 10) | | Limit exceeded (400, 413) | Limit regarding size or count is exceeded | LIMIT_EXCEEDED **Count**limit exceeded for \ **Size**limit exceeded for \ Request body **size**limit exceeded | * subject.content (max. 998 chars) * attachments.attachment.name (max. 254 chars) * attachments.attachment.contentType (max. 100 chars) * attachments.attachment.contentId (max. 100 chars) * recipients.recipient.email.to.\ (max. 254 chars) * recipients.recipient.email.cc.\ (max. 254 chars) * recipients.recipient.email.bcc.\ (max. 254 chars) * recipients.recipient.email.replyTo (max. 254 chars) * recipients.recipient.reference (max. 50 chars) * mail.from (max. 254 chars) * mail.mimeFrom (max. 254 chars) * mail.replyTo (max. 254 chars) * job.referenceJob (max. 50 chars) * job.costCenter (max. 50 chars) * job.campaignId (max. 50 chars) * notification.endPoint.url (max. 1000 chars) * notification.endPoint.headers (max. 10000 chars) * notification.endPoint.authentication.user (max. 100 chars) * notification.endPoint.authentication.password (max. 100 chars) | | Limit exceeded (400, 413) | Limit regarding size or count is exceeded | LIMIT_EXCEEDED **Count**limit exceeded for \ **Size**limit exceeded for \ Request body **size**limit exceeded | * Overall request body \> 26.214.400 chars (25 MB) | | Missing value (400) | A mandatory value was not provided by caller | MISSING_VALUE Missing mandatory value for \ | * subject.content * body.content (if body present) * body.contentType (if body present) * alternative.content (if alternative present) * attachments.attachment.name (if attachment present) * attachments.attachment.content (if attachment present) * attachments.attachment.contentType (if attachment present) * recipients.recipient.mail.to * mail.from * notification.endPoint (if notification present) * notification.endPoint.url (if notification present) * notification.endPoint.authentication.method (if authentication present) * notification.endPoint.authentication.user (if authentication present) * notification.endPoint.authentication.password (if authentication present) * recipients.recipient.email.xHeaders.name * mail.xHeaders.name * recipients * recipients.recipient * recipients.recipient.email.to.email * recipients.recipient.email.cc.email * recipients.recipient.email.bcc.email * recipients.recipient.email.replyTo.email * mail.from.email * mail.mimeFrom.email * mail.replyTo.email | | Invalid value (400) | A provided value doesn't match the corresponding set of allowed values | INVALID_VALUE Invalidvaluefor\ | * subject.contentEncoding * subject.contentTransferEncoding * subject.charset * body.contentType * body.contentEncoding * body.contentTransferEncoding * body.charset * alternative.contentEncoding * alternative.contentTransferEncoding * alternative.charset * recipients.recipient.mail.priority * recipients.recipient.mail.xHeaders.name * mail.priority * mail.xHeaders.name * notification.endPoint.authentication.method * job.features.openTracking * job.features.linkTracking * recipients.recipient.features.openTracking * recipients.recipient.features.linkTracking | | Invalid format (400) | A provided value doesn't match the supported format | INVALID_FORMAT Invalidformatfor\ | * attachments.attachment.contentType (allowed format: "\/\" with \ and \ having min. length = 1) * attachments.attachment.content(onlybase64 allowed) | | Forbidden due to Technical Account config (403) | A prerequisite check results in an unsupported value | FORBIDDEN_BY_CONFIG Unsupported value for \ | * spf.lastCheck (last SPF-validation failed for this sender-domain and leaved this flag=false in config) * dkim.lastCheck (last DKIM-validation failed for this sender-domain and leaved this flag=false in config) * locked (Technical Account is locked) * dataCenter (Technical Account has access permissions only to the unique configured dataCenter, e.g. FFM) * interface (Technical Account has access permissions only to the configured interface-types and versions, e.g. REST V2.0.1) | | Forbidden due to request params (403) | A provided property contains an unsupported value | FORBIDDEN_PARAMS Unsupported value for \ | attachments.attachment.name (forbidden file extension) | | Invalid sender (400) | Syntactically incorrect sender- address | INVALID_SENDER Invalidsyntaxfor\ | * mail.from * mail.mimeFrom * recipients.recipient.mail.replyTo * mail.replyTo | | Forbidden sender (403) | from not configured (sender domain not in configured sender domains); domain of mime-from not identical to from | FORBIDDEN_SENDER Unsupported value for \ | * mail.from * mail.mimeFrom | --- language: "en" --- # Job validations The following validations have to be considered: * Total size of any generated MIME-message must be \<= 25 MB; else job will be rejected. * If the contentTransferEncoding = base64, then the resulting total size of generated MIME- message will be estimated by "total size resulting from JSON-fields in job-request" + 30%. * The subject is mandatory, and a missing subject will default to an empty string. Referred to sender domain: * If the last DKIM check wasn't successful, then the job can be rejected. * If the last SPF check wasn't successful, then the job can be rejected. Syntactical email address validation occurs according to RFC 5322 by using the following regex: (?:[a-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[a-z0-9!#$%&'*+/=?^_`{|}~-]+)*|"(?:[\x01-\x08\x0b\x0c\x0e- \x1f\x21\x23-\x5b\x5d-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])*")@(?:(?:[a-z0-9](?:[a-z0-9-]*[a-z0- 9])?\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?|\[(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0- 5]|2[0-4][0-9]|[01]?[0-9][0-9]?|[a-z0-9-]*[a-z0-9]:(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21-\x5a\x53- \x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])+)\]) --- language: "en" --- # JobRequest method ## Requirements The request will accept only HTTP-method POST and Content-type="application/json". The caller must ensure the charset of the JSON in the body-content to be UTF-8. Definition of "Key: Value": an element must exist with non-empty content (not allowed: key: NULL, key: ""). ## REST Method This method allows you to create an email job. Legend: (m) for mandatory; (o) for optional. ### Subject (m) |-----------------------------|----------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **Elements (m/o)** | **Default** | **Description** | | contentEncoding (o) | plain | Encoding provided in caller's request. Allowed values: plain, quoted-printable, base64 Content examples: **plain:** 'testââÀüü' **quoted-printable:** '=?UTF-8?Q?test=C3=B6=C3=B6=C3=A4=C3=BC=C3=BC?=' **base64:** 'dGVzdMO2w7bDpMO8w7w=' | | contentTransferEncoding (o) | as results by applying javax.mail mechanism to subject.content | Encoding of rendered MIME Allowed values: base64 | | charset (o) | UTF-8 | All standard charsets supported by Java 8, e.g.: "US-ASCII", "ISO-8859-1", "UTF-8", "UTF-16", "UTF-16LE" and "UTF-16BE". | | content (m) | - | Subject will be "folded" every 78-chars by "\\", as described in . Max. 500 chars | | features (o) | | | | template (o) | - | Clarification for using Freemarker Template in subject Only base64 characters are allowed Content examples: Subject-Standard-Text ${name} | ### body (o) |-------------------------------------------|-------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **Elements (m/o)** | **Default** | **Description** | | contentType (m, if parent element exists) | - | Allowed values. text/plain, text/html If value = text/plain and an alternative is present, the alternative will not be generated into MIME-message. | | contentEncoding (o) | plain | Encoding provided in caller's request. Allowed values: plain, quoted-printable, base64. | | contentTransferEncoding (o) | as results by applying javax.mail mechanism to body.content | Encoding of rendered MIME Allowed values: base64 | | charset (o) | UTF-8 | All standard charsets supported by Java 8, e.g.: "US-ASCII", "ISO-8859-1", "UTF-8", "UTF-16", "UTF-16LE" and "UTF-16BE". | | content (m, if parent element exists)) | - | For any feature that requires to parse of the HTML content (like open tracking), a valid HTML, incl. JSON-LD, content with \ \& \ tags is mandatory. | | template (o) | - | Clarification for using Freemarker Template in subject. Only base64 characters are allowed. Content examples: Subject-Standard-Text ${name} | ### alternative (o) |---------------------------------------|--------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------| | **Elements (m/o)** | **Default** | **Description** | | contentEncoding (o) | plain | Encoding provided in caller's request. Allowed values: plain, quoted-printable, base64 | | contentTransferEncoding (o) | as results by applying javax.mail mechanism to alternative.content | Encoding of rendered MIME Allowed values: base64 | | charset (o) | UTF-8 | All standard charsets supported by Java 8, e.g.: "US-ASCII", "ISO-8859-1", "UTF-8", "UTF-16", "UTF-16LE" and "UTF-16BE". | | content (m, if parent element exists) | - | If present, always considered as contentType = text/plain | | template (o) | - | Clarification for using Freemarker Template in subject Only base64 characters are allowed Content examples: Subject-Standard-Text ${name} | ### attachments (o) |--------------------------|-------------|----------------------------------| | **Elements (m/o)** | **Default** | **Description** | | attachment \ (o) | - | Max. 20 "attachment"-subelements | ### attachment |-------------------------------------------|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------| | **Elements (m/o)** | **Default** | **Description** | | name (m, if parent element exists) | - | Attachment file name, max. 250 chars. Note: Unsupported attachment file extensions are listed in a chapter below. | | contentType (m, if parent element exists) | - | Max. 100 chars; only ASCII. Allowed format: "\/\" e.g. application/pdf \ and \ min. length = 1 | | contentId (o) | - | Anchor for references used to embed inline images in html parts. e.g. can used with "contentType": "image/jpeg" max. 100 chars | | content (m, if parent element exists) | - | Content has to be provided always in base64-encoding | | secureDocument (o) | false | Trigger point for activation for Secure Document Handling. NOTE: Encryption with referenced attachment by Templating Store Manager is not possible | ### recipients (m) |--------------------|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **Elements (m/o)** | **Default** | **Description** | | mail \ (m) | - | for each recipient-subelement in this array, a MIME-message will be built. Min. 1 "recipient"-subelement; Max. 100 "recipient"-subelements; Max. 1000 "address"-subelements | ### recipients (m) |------------------------|-------------|-------------------------------------------------------------------------| | **Elements (m/o)** | **Default** | **Description** | | features \ (o) | - | for each recipient-subelement in this array, features can be activated. | ### recipients/features (o) |--------------------|-------------|-----------------------------------------------------------------------------------------| | **Elements (m/o)** | **Default** | **Description** | | openTracking (o) | - | for each recipient-subelement in this array the feature open tracking can be activated. | ### recipients/features/openTracking (o) |--------------------------------------|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **Elements (m/o)** | **Default** | **Description** | | active (m, if parent element exists) | false | Enables or disables open tracking for the related recipient. It overwrites the same option eventually set on job level. This feature requires a valid HTML content. Job will be rejected in case of an invalid HTML content. The HTML content must contain both \ and \ tags. Allowed values: true, false | | linkTracking (o) | - | for each recipient-subelement in this array the feature link tracking can be activated. | ### recipients/features/linkTracking (o) |--------------------------------------|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **Elements (m/o)** | **Default** | **Description** | | active (m, if parent element exists) | false | Enables or disables link tracking for the related recipient. It overwrites the same option eventually set on job level. This feature requires a valid HTML content. Job will be rejected in case of an invalid HTML content. The HTML content must contain both \ and \ tags. Allowed values: true, false ++*Restriction*++: For the usage of Link-Tracking all URLs within the HTML-Code must be shorter than 250 characters. | | templating \ (o) | - | for each recipient-subelement in this array the feature Templating can be activated. | ### recipients/features/templating (o) |-------------------------------|-------------|--------------------------------------------------------------| | **Elements (m/o)** | **Default** | **Description** | | personalization \ (o) | - | Clarification of Personalization fields for using Templating | ### recipients/features/templating/personalization (o) |-----------------------|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **Elements (m/o)** | **Default** | **Description** | | *\*(m) | - | Map of "custom variables". They must exist for using the templating in your message. Min. 1, Max: 15 variables, for a maximum of 50 characters for each variable. Request-Sample: *"personalization":* *{* *"name": "Ignaz", "street": "Ignaz street" ,* *....,* *"zip": "12345"* *}* | ### recipients/recipient/mail (m) |--------------------------------|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **Elements (m/o)** | **Default** | **Description** | | to / email (m) | - | Array of email-subelements, which represents a corresponding receiver email address. For each email subelement a SMTP email will be generated and sent separately - trackable by a corresponding email-ID. Each array entry may contain the friendly name between quotas. In this case the email address has to be delimited by angle brackets. Max. 254 chars per email address. Must contain syntactical correct email addresses. Furthermore, each email address can be checked against the Technical Account specific suppression list. Duplicates in this array will be ignored. ++More information about how to define a recipient's address can be++ ++found in a chapter below!++ | | Cc / email (o) | - | Carbon Copy - Array of email-subelements, which represents a corresponding receiver email address. For each email subelement a SMTP email will be generated and sent separately - trackable by a corresponding email ID. Each array-entry may contain the friendly name between quotas. In this case the email address has to be delimited by angle brackets. Max. 254 chars per email address. Must contain syntactical correct email addresses. Furthermore, each email address can be checked against the Technical Account specific suppression list. Duplicates in this array will be ignored. | | bcc / email (o) | - | Blind Carbon Copy - Array of email-subelements, which represents a corresponding receiver email address. For each email subelement a SMTP email will be generated and sent separately - trackable by a corresponding email ID. Each array-entry may contain the friendly name between quotas. In this case the email address has to be delimited by angle brackets. Max. 254 chars per email address. Must contain syntactical correct email addresses. Furthermore, each email address can be checked against the Technical Account specific suppression list. Duplicates in this array will be ignored. | | replyTo / email (o) | Configurable by domain | ReplyTo - If exists, it overwrites the mail/replyTo for the MIME- message which belongs to the containing recipient-subelement. May contain the friendly name between quotas. In this case the email address has to be delimited by angle brackets. Max. 254 chars. Must contain syntactical correct email address. | | inReplyTo (o) | - | If exists, it overwrites the mail/inReplyTo for the Mime-message which belongs to the containing recipient-subelement. | | priority (o) | NORMAL | If exists, it overwrites the mail/priority for the MIME-message which belongs to the containing recipient-subelement. Note: "priority" is not used to prioritize the emails within the sending queue! Allowed values: HIGH, NORMAL, LOW | | listUnsubscribe (o) / (CSA: m) | - | Can be used by caller's systems for their own unsubscribe handling. Highly recommended for marketing emails. Supported by specific major ISPs (like Google Gmail). By default, when a List-Unsubscribe URL or mailto: is detected, a One- Click-Post Header is automatically added. Either "listHelp" or "listUnsubscribe" ++must++ be specified in order to be CSA compliant. | | listHelp (o) / (CSA: m) | - | Can be used to provide an access point for detailed user support information. Recommended for transactional emails, as an alternative to the "listUnsubscribe" header. Supported by specific major ISPs (like Google Gmail). Either "listHelp" or "listUnsubscribe" ++must++ be specified in order to be CSA compliant. | | xHeaders (o) | - | Map of "custom" x-headers. if exists, it overwrites the mail/ xheaders/\ for the MIME message which belongs to the containing recipient-subelement. Header names may not be null, empty or only blanks. Header-values will be "folded" every 78-chars by "\\", as described in Header-name has to start with (ignore-case) "X-". Headers with name like (ignore-case) "X-RETARUS-\*" or "RETARUS-\*" will be ignored. Max. header count = 10 For using Google-FBL you are able to integrate the required Element "FeedbackID" - Feedback-ID: a:b:c:SenderId) Feedback-ID is the name of the Header to be embedded. a, b, c are optional fields that can be used by the sender to embed up to 3 Identifiers (campaign/customer/other). SenderId is a mandatory unique Identifier (5--15 characters) chosen by the sender. It should be consistent across the mail stream. | ### recipients/recipient (o) |--------------------|-------------|---------------------------------------------------------------------------------------------------------------------| | **Elements (m/o)** | **Default** | **Description** | | reference (o) | - | Offers the possibility to add a reference, which can be processed afterwards in the caller's systems. Max. 50 chars | ### mail (m) |----------------------|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **Elements (m/o)** | **Default** | **Description** | | from / email (m) | - | SMTP-from; this property is also the source for validating the registered sender-domain. May contain the friendly name between quotas. In this case the email address has to be delimited by angle brackets. Max. 254 chars. Must contain syntactical correct email address. Has to be a valid entry in list of registered sender addresses for this domain in domain settings. | | mimeFrom / email (o) | mail.from | MIME-from; May contain the friendly name between quotas. In this case the address has to be delimited by angle brackets. Max. 254 chars. Must contain syntactical correct email address. Has to be a valid entry in list of registered sender addresses for this domain in domain settings. | | replyTo / email (o) | Configurable by domain | replyTo-entry which has to be inserted in MIME message May contain the friendly name between quotas. In this case the address has to be delimited by angle brackets. Max. 254 chars. Must contain syntactical correct email address. | | inReplyTo (o) | - | inReplyTo-entry which will be inserted in MIME message. | | priority (o) | NORMAL | priority which has to be set for the MIME message if not provided, the default will be used. Allowed values: HIGH, NORMAL, LOW | | xHeaders (o) | - | Map of "custom" x-headers, which will be set in the MIME message. Header name has to start with "X-". Header names may not be null, empty or only blanks. Header-values will be "folded" every 78-chars by "\\", as described in Headers with name like (ignore-case) "X-RETARUS-\*" or "RETARUS- \*" will be ignored. Max. header count = 10 For using Google-FBL you are able to integrate the required Element "FeedbackID" - Feedback-ID: a:b:c:SenderId) Feedback-ID is the name of the Header to be embedded. a, b, c are optional fields that can be used by the sender to embed up to 3 Identifiers (campaign/customer/other). SenderId is a mandatory unique Identifier (5--15 characters) chosen by the sender. It should be consistent across the mail stream. | ### job (o) |--------------------|-------------|-------------------------------------------------------------------------------------------------------------------------------------------| | **Elements (m/o)** | **Default** | **Description** | | referenceJob (o) | - | Offers the possibility to add a customer's reference, which can be processed afterwards in the caller's systems. Max. 50 chars | | costCenter (o) | - | Offers the possibility to add a customer's costCenter, which can be processed afterwards in the caller's (billing) systems. Max. 50 chars | | campaignId (o) | - | Offers the possibility to add a customer's campaignId, which can be processed afterwards in the caller's (CRM) systems. Max. 50 chars | | features (o) | - | Definition of feature options | ### features/openTracking (o) |--------------------------------------|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **Elements (m/o)** | **Default** | **Description** | | active (m, if parent element exists) | false | Enables open tracking for all recipients. Option can be individually overwritten on recipient level. This feature requires a valid HTML content. Job will be rejected in case of an invalid HTML content. The HTML content must contain both \ and \ tags. Allowed values: true, false | ### features/linkTracking (o) |--------------------------------------|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **Elements (m/o)** | **Default** | **Description** | | active (m, if parent element exists) | false | Enables link tracking for all recipients. Option can be individually overwritten on recipient level. This feature requires a valid HTML content. Job will be rejected in case of an invalid HTML content. The HTML content must contain both \ and \ tags. Allowed values: true, false Restriction: For the usage of Link-Tracking all URLs within the HTML- Code must be shorter than 250 characters. | ### features/templating (o) |--------------------------------------|-------------|-------------------------------------------------------------------| | **Elements (m/o)** | **Default** | **Description** | | active (m, if parent element exists) | false | Enables templating for all recipients Allowed values: true, false | ### features/antivirus (o) |--------------------------------------|-------------|------------------------------------------------------------------| | **Elements (m/o)** | **Default** | **Description** | | active (m, if parent element exists) | false | Enables antivirus for all recipients Allowed values: true, false | ### features/secureDocument (o) |--------------------------------------|-------------|-------------------------------------------------------------------------------------------------------------------------------| | **Elements (m/o)** | **Default** | **Description** | | active (m, if parent element exists) | false | Enables Secure Document Handling for all recipients Allowed values: true, false | | filename (o) | - | always considered as contentType = text/plain | | subjectPrefix (o) | - | always considered as contentType = text/plain e.g. "Password for: \" | | password/type (m) | - | For using secure Document, you must have to define which kind of password strength should be use. * medium * high * very_high | ### features/messageSigning (o) |------------------|-------------|-------------------------------------------------------------------------| | **Element m/o)** | **Default** | **Description** | | active (o) | false | Enables message signing for all recipients. Allowed values: true, false | ### notification/endPoint All content is assumed to be provided with charset = UTF-8. |-----------------------------------|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **Elements (m/o)** | **Default** | **Description** | | url (m, if parent element exists) | - | 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 | | headers (o) | - | Map of custom headers provided by caller for being propagated into each notification-call. Max. 10000 chars | ### notification/endpoint/authentication |----------------------------------------|-------------|------------------------------------------------------------------------------------------------------------| | **Elements (m/o)** | **Default** | **Description** | | method (m, if parent element exists) | BASIC | Allowed values: BASIC Alternatively, the Authorization header can be defined directly in the header field. | | user (m, if parent element exists) | - | User name for accessing target endPoint described in notification. /url | | password (m, if parent element exists) | - | Password for accessing target endPoint described in notification. /url | During the Implementation phase, it is also possible to store default values within the configuration for scenarios in which some of the aforementioned variables are not utilized in every REST JobRequest. Please be aware that all details of the Push Notification service must always be provided in full. For instance, ifyou specify a webservice that necessitates authentication with a username and password, these credentials must be explicitly added in the REST JobRequest. In such cases, no default values from configuration will be used. Refer to [Web Service](https://docs.retarus.com/tem/web-service.md) for further details. --- language: "en" --- # Managing reporting views You can manage how UDR Reporting data is displayed by switching between available views and setting a preferred default view. ## Switching between views 1. Open the UDR Reporting screen (**TRANSACTIONAL EMAIL** -- **Reporting**). 2. Click the report views dropdown at the top of the table. β†’ The list of available views is displayed. ![Screenshot 2026-04-23 103421.png](https://docs.retarus.com/__attachments/a_30a89840c2ca82b33331eb54431f8cc28eec3cf5fb724b5bb5a61c5c9af66fd6/Screenshot%202026-04-23%20103421.png?cb=6b1220d772f7628da5d7eb97923a6342) 3. Select the desired view: * Under **Main Views** , choose **Basic View**. * Under **Custom Views**, select a saved custom view. ## Setting a view as default By default, **Basic View** loads each time you open UDR Reporting. To load your preferred view automatically, set it as the default. You can set a view as default in several ways: * **When creating a new view** Activate the **Set as default** option in the **Save View** dialog. ![image-20260423-085137.png](https://docs.retarus.com/__attachments/a_16212f8160b1dc9ddc99ad053d151a62ec2f67483d394dbfc105d132609d640f/image-20260423-085137.png?cb=93e92fb3ccc02988bebcc8abe0452bd1) * **From the view list (dropdown)** Click the flag icon next to the view name. The flag turns orange to indicate it is the default. ![image-20260423-085222.png](https://docs.retarus.com/__attachments/a_c7c85ca42a00dffa9f30462005dc2dc6c91f44f58a0ade0b450098bc33760077/image-20260423-085222.png?cb=4a2efaaa7d7a49164f35cf3c30208c9f) * **When updating a custom view** Click the flag icon while editing the view in the **Manage Custom Views** dialog. The flag turns orange to confirm it has been set as default. ![image-20260423-085304.png](https://docs.retarus.com/__attachments/a_da91e010a84613f1df8280ae1d087712ddd460ba7649798bb5098a6d9914616b/image-20260423-085304.png?cb=a2c0baa1804d89a6bb21cc2a9b1ed1ea) --- language: "en" --- # Message Signing ## Message Signing feature overview The Message Signing feature offers you the ability to digitally sign emails sent out by your company's applications. This digital signature attached to your outbound email adds an extra layer of security by providing confidentiality, integrity, and authenticity. As a result, organizations increase both trust and awareness of their application email messages by providing assurance to the recipient that the content of the email legitimately comes from your organization. ![2024-08-09 10_16_10-PowerPoint Slide Show - TEM - Message Signing feature - high-level presentatio.png](https://docs.retarus.com/__attachments/a_b054954b58cc97057245cfea694c2263ca1d8754ae39522764a0f0146adb49f7/2024-08-09%2010_16_10-PowerPoint%20Slide%20Show%20%20-%20%20TEM%20-%20Message%20Signing%20feature%20-%20high-level%20presentatio.png?cb=2e026c621de92429728c1bf0189a05b5) \*Public Key Infrastructure Message Signing feature is only available for the German datacenters for the moment. ## What is a digital signature? A digital signature is used to authenticate and protect communication across the Internet by verifying the message has been sent by that named sender. This to protect both sender and recipient from unauthorized access and phishing attempts. Adding a digital signature enhanced integrity, authenticity and commitment for Applications outbound emails: * integrity: check that the message has not been altered or tampered with; * authenticity: the message does in fact come from the sender; * commitment: the sender should not be able to deny having written it. By creating a unique digital fingerprint, digital signatures provide the highest level of security assurance by verifying the signer's identity. This is done through a trusted third party, known as a Certificate Authority (CA). ## How a digitally signed email looks like? Gmail webmailer ![2024-09-25 16_24_47-PowerPoint Slide Show - WIP TEM Message Signing - Sales enablement V4.pptx.png](https://docs.retarus.com/__attachments/a_6e7155d0a34b104b617c8ad214ad3f2726e8ca6e1502b3db5810e67c6c537e77/2024-09-25%2016_24_47-PowerPoint%20Slide%20Show%20%20-%20%20WIP%20TEM%20Message%20Signing%20-%20Sales%20enablement%20V4.pptx.png?cb=3e2a8025718d127dffb9c05e13b5f5c8) Outlook mail client ![2024-09-25 16_26_17-PowerPoint Slide Show - WIP TEM Message Signing - Sales enablement V4.pptx.png](https://docs.retarus.com/__attachments/a_228c8dc4fff1ab107bbbf1e7b0cfea01f36ea41aa90b81ca7bef6614cf1ca812/2024-09-25%2016_26_17-PowerPoint%20Slide%20Show%20%20-%20%20WIP%20TEM%20Message%20Signing%20-%20Sales%20enablement%20V4.pptx.png?cb=7be88bdd3e648a4bb142470fd2f1ecc8) Mobile mail client ![2024-09-25 16_26_56-PowerPoint Slide Show - WIP TEM Message Signing - Sales enablement V4.pptx.png](https://docs.retarus.com/__attachments/a_511867df41ae9a71025d5cfb6119474ebc65a93fd9928f22d8bd9ff78f4621fd/2024-09-25%2016_26_56-PowerPoint%20Slide%20Show%20%20-%20%20WIP%20TEM%20Message%20Signing%20-%20Sales%20enablement%20V4.pptx.png?cb=4f0f5a69a7b789f3409a0d2520326bdd) ## Requirements ### Technical integration requirements * Message Signing feature booked and configured for at least one Transactional Email Technical Account * Technical Account configured for data processing in german datacenters only * Secure/Multipurpose Internet Mail Extensions (S/MIME) certificate only, delivered by a Certificate Authority (also known as "paid certificate") *For PGP or self-signed certificate, please contact our Technical Consultant team to qualify the potential integration.* ### Recipient requirements Most of the mailbox providers integrate a built-in S/MIME certificate reader. For users accessing their emails through a webmailer, they might need to ask their administrator to install an additional extension. --- language: "en" --- # Message Signing FAQ ## General What is the difference between an electronical signature and digitallty signed an email? An electronic signature is a simple digital representation (like typing your name or inserting an image of a handwritten signature) used to sign documents. A digitally signed email, on the other hand, uses encryption to authenticate the sender and ensure the message's integrity. Digital signatures rely on certificates and cryptography to verify the email's origin and prevent tampering, making them more secure than regular electronic signatures. So a digital signature is always an electronic signature while an electronic signature is not always a digital signature. What is the legal value of sending a digitally signed email? It depends on your local regulation. What are the benefits of digitally signing emails sent by applications? As from the last years the number of spam and phishing emails have increased, recipients are more and more reluctant to open emails they received. Digitally sign emails sent by your business applications will make your communication more trustworthy and increase the probability that recipients actually open your messages. Does digitally signing an email improve its inbox placement? No. Some Mail Transfer Agents (MTA) may favour emails that have been signed, but in general digital signature increase the acceptance of the recipients, for instance by not reporting it as a spam, phishing attempt or simply opening the email instead of deleting it right away. How can recipients understand that the email I sent has been digitally signed? Most mailbox providers, such as Gmail or Outlook, integrate a built-in certificate reader. Of course, every provider has its own way to display the information into the User Interface. Most of the time, a green mark is added near the sender email address to highlight that it has been verified. Please review the examples described into the section "[How a digitally signed email looks like?](https://retaruscloud.atlassian.net/wiki/spaces/TE/pages/edit-v2/108068875#How-a-digitally-signed-email-looks-like%3F)". In which context should I use the Message Signing feature? Every digital communication consisting in providing sensitive content is a good candidate for using the Message Signing feature. In a Business-to-Consumer (B2C) context, it could be about sending invoices, order confirmations or parcel tracking notifications. In some highly regulated market, such the banking sector, digital signature Does resending an email with Trace \& Recover will break the digital signature? No. In case your are both using the Message Signing and Trace \& Recover features, they will have no impacts on your mailflow. Trace \& Recover stores your original email without the signature attached. Each time you resend that stored email to a new recipient, this email will go through the signing mechanism again. What is the pricing model for the Message Signing feature? This service is billed per sender address per month. Each S/MIME certificate you import into the built-in Message Signing PKI is related to one specific sender address. We rely on this number of sender address(es) to charge you. On top of this, you pay your regular Transactional Email monthly volume consumption. Please contact your Sales contact to get more details about the pricing. ## Authentication and security Why should I use a DKIM key if I use an S/MIME certificate? SPF, DKIM and DMARC and S/MIME are complementary. These are several authentication and security layers. While SPF, DKIM and DMARC standards are closely monitored by Internet Service Providers and mailbox providers to evaluate the legitimacy of the sender domain, S/MIME is an additional layer that verify the sender identity. These authentications methods combined ensure protection againt phishing and email tampering. I'm already part of the TrustedDialog program, what is the benefit of using Message Signing feature? [TrustedDialog program](https://www.united-internet-media.de/en/products-and-solutions/dialogsolutions/trusteddialog/) is only relying on DKIM. The Message Signing feature for Transactional Email, however, is all about certificate-based S/MIME signing. The main difference is that Message Signing at the recipient level proves the authenticity of the sender and ensures the message has not been modified in transit. Furthermore, the checkmark added into the recipient inbox is only visible for specific participating mail services, such as GMX, Freenet, 1\&1, Deutsche Telekom and web.de. Retarus is relying on a more agnostic approach by adopting the S/MIME standard. Is enforcing TLS a signing mechanism? No, enforced TLS is not a signing mechanism. It ensures that emails are encrypted during transmission between mail servers, protecting them from being intercepted. However, TLS does not provide sender authentication or message integrity. What part of the email is actually signed by the certificate? It is about signing the email body (including attachment), not the Headers or it will break the signature for every hop during transmission. ## Certificate management I do not owned a paid certificate? Can Retarus provide me one? Retarus does not act as a Certificate Authority. However, Retarus can support you into the process of getting your own digital certificate by putting you in touch with its preferred partner Swiss Sign. Generally, in 3 weeks your company will receive its unique digital certificate, Retarus will had it directly into the Message Signing built-in PKI (Public Key Infrastructure). What is a Certificate Authority (CA)? A Certificate Authority is a company that acts to validate the identities of entities (such as websites, email addresses, companies, or individual persons) and bind them to cryptographic keys through the issuance of electronic documents known as digital certificates. Does Retarus recommend a specific Certificate Authority? Retarus has build a partnership with Swiss Sign to help its customers to get certificates. However, Retarus has no competence to recommend any particular Certificate Authority on the market. I already bought a signing certificate, can I use it with the Message Signing feature? Of course! Our Implementation Team can import your existing S/MIME certificate(s) into the Message Signing PKI and link them to your Transactional Email Technical Account. To do so, please open a Service Request. Can I use wildcard certificates with the Message Signing feature? A wildcard certificate is a single certificate which can sign all local parts belonging to the same domain name. Wilcard certificates are not permitted for the moment. Are self-signed certificate working with the Message Signing feature? Retarus recommends to use a paid S/MIME certificate to digitally sign emails as this method is the most common and used standard on the market. How can I upload and manage by myself my certificates with the Message Signing feature without opening a Service Request? This is possible. Retarus has built an unique tool to streamline key management from your infrastructure into the Message Signing PKI: the "User Synchronisation Encryption" tool. Please contact our Technical Consultant team to implement this tool. --- language: "en" --- # Message Signing setup and usage ## Setup overview | **Step** | **Description** | |-------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | Step 1: book the Message Signing feature | Contact your main Sale contact to order the Message Signing add-on and update your Transactional Email contract. | | Step 2: feature configuration at the Account level | Get in touch with our Implementation Team to configure the Message Signing feature. Choose for which Account(s) you want to enable this feature and define the default expected behaviour. | | Step 3: get a paid S/MIME certificate | You can buy a S/MIME certificate from any Certificate Authority of your choice. Note: Retarus has a preferred partnership with Swiss Sign to not only help you ordering a paid certificate but also automatically upload it into our built-in Public Key Infrastructure (PKI), see step 4. | | Step 4: upload your S/MIME cetificate(s) | During the Implementation phase of the Message Signing feature, or by opening a Service Request, you can provide us your existing S/MIME certificate(s) to be uploaded into the built-in Public Key Infrastructure (PKI). Note: you can upload and manage your certificates by yourself using our User Synchronisation Encryption (USE) tool. Please contact our Support Team to request the set up of this tool. | | Step 5: connect your source Applications to the Technical Account | As now the Message Signing feature is fully configured, you can now connect all your source Applications to the Technical Account for which the feature has been enabled. See "[Account authentication](https://docs.retarus.com/tem/account-authentication.md)" section. | ## How to use the Message Signing feature There are 3 complementary layers to control the Message Signing feature: 1. the default configuration set at the Transactional Email Technical Account with which your source Application is authenticated to; 2. use the signing flag into the JobRequest you sent to that Technical Account, working with REST APIs or SMTP Header; 3. the S/MIME certificate uploaded into the Message Signing PKI (Public Key Infrastructure), you have 2 options: 1. using our User Synchronisation Encryption (USE) tool and uploading your certificate by yourself; 2. or contact our Support Team to request your S/MIME certificate to be uploaded by us. ### Technical Account configuration First of all, the Message Signing feature must have been booked, enabled and configured at the Technical Account level by our Implementation team. Thus to allow JobRequest to use this feature. 2 parameters must be set: * `active`: define if the feature is authorized to be used with the Technical Account or not, means that if the Technical Account allows to route the JobRequest to the built-in signing component; * `defaultActive`: define the default behaviour expected if nothing is explictly set into the JobRequest sent to the Technical Account (see the paragraph below). Please review all the potential configuration scenarios and related results [later below](https://docs.retarus.com/tem/message-signing-setup-and-usage#MessageSigningsetupandusage-Wrapup). It is recommended to implement one dedicated Technical Account for all your business applications requiring the sent signed emails and force the signing mechanism for all JobRequests sent to this Technical Account. To do so, ask to set the `defaultActive` parameter to `true`, therefore you don't even need to explictly set the signing flag into any JobRequest. ### JobRequest Just as the vast majority of Transactional Email features, Message Signing can be controled at the JobRequest level. Thus to provide you sufficient flexibility to choose which email must be sent out signed or not. If the signing flag is explicitly defined at the JobRequest level (`true `or `false`), it overwrittes the Technical Account `defaultActive` configuration. #### REST APIs With Message Signing you have the possibility to flag which email within a REST JobRequest should sent out signed using your S/MIME certificate, example: { "mail": ... "job": { ... "features": { "messageSigning": { "active": true } } } } Find more information about this Message Signing [REST parameter here](https://docs.retarus.com/tem/jobrequest-method.md) or on the [Transactional Email API developer portal](https://developers.retarus.com/docs/transactional-email/api/sending-email/). #### SMTP Adapter With Message Signing you have the possibility to flag which email within a SMTP JobRequest should sent out signed using your S/MIME certificate, example: `X-RETARUS-M4A-MESSAGE-SIGNING-ACTIVE: true` Find more information about this Message Signing [SMTP Header here](https://docs.retarus.com/tem/smtp-adapter-header-parametrization.md). ### Public Key Infrastructure Each S/MIME certificate that have been imported into the Message Signing PKI (Public Key Infrastructure) is related to one specific sender address: * to sign an email the EnvelopeFrom address set into the JobRequest must match at least one S/MIME signing key uploaded into the Message Signing PKI; * If a JobRequest asks to digitally sign an email with a sender address not matching a S/MIME certificate uploaded into the PKI, the JobRequest will be considered as "PROCESSING_FAILED". Several S/MIME certificates can be uploaded into the Message Signing PKI. The sender address set into these certifcates is the key identifier to know which signing key to apply to the JobRequest. ### Wrap up To trigger the Message Signing feature and send signed emails you must: 1. Sent a JobRequest with an EnvelopeFrom matching a S/MIME certificate uploaded into the PKI 2. **AND** 1. Set explicitly the signing flag to `active: true` into that JobRequest 2. **OR** set the default Technical Account configuration to `defaultActive: true` All potential scenarios | **JobRequest signing flag** (REST or SMTP) | Technical **Account configuration** | **Public Key Infrastructure** | **Result** | |--------------------------------------------|-------------------------------------|---------------------------------------------------|---------------------------| | *empty* | defaultActive: true | EnvelopeFrom matching a S/MIME certificate | Email is signed and sent | | active: true | defaultActive: true | EnvelopeFrom matching a S/MIME certificate | Email is signed and sent | | active: false | defaultActive: true | EnvelopeFrom matching a S/MIME certificate | Email sent and not signed | | *empty* | defaultActive: false | EnvelopeFrom matching a S/MIME certificate | Email sent and not signed | | active: true | defaultActive: false | EnvelopeFrom matching a S/MIME certificate | Email is signed and sent | | active: false | defaultActive: false | EnvelopeFrom matching a S/MIME certificate | Email sent and not signed | | *empty* | defaultActive: true | EnvelopeFrom **not**matching a S/MIME certificate | PROCESSING_FAILED | | active: true | defaultActive: true | EnvelopeFrom **not**matching a S/MIME certificate | PROCESSING_FAILED | | active: false | defaultActive: true | EnvelopeFrom **not**matching a S/MIME certificate | PROCESSING_FAILED | | *empty* | defaultActive: false | EnvelopeFrom **not**matching a S/MIME certificate | PROCESSING_FAILED | | active: true | defaultActive: false | EnvelopeFrom **not**matching a S/MIME certificate | PROCESSING_FAILED | | active: false | defaultActive: false | EnvelopeFrom **not**matching a S/MIME certificate | PROCESSING_FAILED | ## Tracking Points for administrators ### myEAS Live Search **Email successfully signed** ![2024-09-25 16_17_32-PowerPoint Slide Show - WIP TEM Message Signing - Sales enablement V4.pptx.png](https://docs.retarus.com/__attachments/a_db8bdaefe42cdb8a30885192b1b2a0c594a564f421037a852fc798621b7bd080/2024-09-25%2016_17_32-PowerPoint%20Slide%20Show%20%20-%20%20WIP%20TEM%20Message%20Signing%20-%20Sales%20enablement%20V4.pptx.png?cb=58950b0f15b57ba294bb263547f5d002) ### Push Notification samples **SMIME_SIGNING (intermediate)** Phase: PROCESS Type: SMIME_SIGNING State: INTERMEDIATE Subtype: OK JSON { "meta":{ "event": { "description": "The mail was signed successfully.", "phase": "PROCESS", "state": "INTERMEDIATE", "subType": "OK", "ts": "2024-11-08T07:38:42.224Z", "type": "SMIME_SIGNING" }, **SMIME_SIGNING FAILED** Phase: PROCESS Type: DROPPED State: FINISHED Subtype: PROCESSING_FAILED JSON { "meta":{ "event": { "description": "signature with given key identifier (sender.address@your-domain) failed", "phase": "PROCESS", "state": "FINISHED", "subType": "PROCESSING_FAILED", "ts": "2024-11-12T08:46:45.680Z", "type": "DROPPED" }, --- language: "en" --- # Minimum sample JobRequest (JSON) JSON { "subject":{ "content":"subject" }, "body":{ "contentType":"text/plain", "content":"hello world" }, "recipients":[ { "mail":{ "to":[ { "email":"to_friendly" } ] } } ], "mail":{ "from":{ "email":"smpt_from_friendly" } } } --- language: "en" --- # Notes ## At least once In order to assure delivery of notification-events their send process is based also on retries. Thus, there may exist cases where a notification-event is sent more than once. The notification receiver can deduplicate such occurrences by using the "tag"-property which identifies a notification event uniquely. ## No order guarantees Due to the high-scaling asynchronous processing and the delivery handling no order can be guaranteed for the notification-events of one receiver-recipient. ## Optional values In fact, all values are optional in the implementation of Notification Service validation, so JSON can be empty. From a customer point of view, values marked as 'Optional', are not required to be present. --- language: "en" --- # Notification - Non-Delivery Report (NDR) A non-delivery report (NDR) is a report that is automatically generated by a mail server to inform the sender that their email message was not successfully delivered. The NDR is received in the form of an email from the sender's mail server and contains information on why the delivery was unsuccessful. Most often, this is due to an incorrect destination email address entered into the "To" field or the recipient's inbox being full and no longer able to receive new messages. Non-delivery reports are also known as non-delivery receipts, bounced messages, non-delivery notifications (NDN) or delivery status notifications (DSN). Non-delivery reports are generated by mail servers based on a standard SMTP 500 error coding system. Specifically, they are generated by the sender's mail server based on an SMTP 500 error code that is provided by the recipient's mail server. All of these scenarios are valid delivery failure scenarios and have their own SMTP 500 code that informs the sender why the email has bounced. However, errors that bar the message from being delivered can occur at many stages during mail delivery, such as: * The sender's mail server being unable to find the receiver mail server for any reason. * The mail having been received but the server storage suddenly becoming full, resulting in the mailer daemon being unable to replicate the mail. * The recipient has configured the email server to forward emails to another mail server which has failed for some reason. All of these scenarios are valid delivery failure scenarios and have their own SMTP 500 codes that inform the sender why the email has bounced. Sample error codes for NDRs include: * 4.2.2 --- The recipient has exceeded their mailbox limit * 5.1.x --- Problem with the recipient email address * 5.4.0---DNS problem --- language: "en" --- # Push Notification samples ## PRE_PROCESS ### PREVIOUSLY_BOUNCED Phase: PRE_PROCESS Type: DROPPED State: FINISHED Subtype: PREVIOUSLY_BOUNCED JSON { "meta":{ "account":"m4a_test_user", "customerNo":"99999", "tenant":"Test User", "receivedTs":"2020-10-16T05:58:43.487Z", "jobId":"7e5251d9-8661-43c3-bb00-0c1caf168c3f", "version":"1" }, "notifications":[ { "meta":{ "tag":"e014f03fdab1153427faa64e7103a63dce5dfec3bb74602be2bab31d0db9aa71", "mail":{ "id":"7e5251d9-8661-...-7f3b-472e-8d02-5735ef65cc0c", "email":"recipient@sample.com", "from":"sender@sample.com", "mimeFrom":"sender@sample.com" //optional }, "event":{ "type":"DROPPED", "phase":"PRE_PROCESS", // optional "state":"FINISHED", // optional "subType":"PREVIOUSLY_BOUNCED", // optional "ts":"2020-10-16T05:58:43.535Z", "description":"ts=\"2020-07-28T04:16:06.448Z\", reason=\"[5.2.0] bounced (host mx-in02.eu.retarus.com[94.199.89.39] said: 550 5.2.0 mailbox unavailable. \"" ) } } ] } ### FORBIDDEN_RECIPIENT Phase: PRE_PROCESS Type: DROPPED State: FINISHED Subtype: FORBIDDEN_RECIPIENT JSON { "meta":{ "account":"m4a_test_user", "customerNo":"99999", "tenant":"Test User", //optional "receivedTs":"2020-10-16T06:38:24.774Z", "jobId":"7e5251d9-8661-43c3-bb00-0c1caf168c3f", "version":"1" }, "notifications":[ { "meta":{ "tag":"fe5f6eba9d910ac646bad72e3b10024556c169774feeb2ee2b6c1e99c8962f0b", "mail":{ "id":"00194e4e-f4ff-...-41d8-ae79-e48c95429c52", "email":"recipient@sample.com", "from":"sender@sample.com", "mimeFrom":"sender@sample.com" //optional }, "event":{ "type":"DROPPED", "phase":"PRE_PROCESS", //optional "state":"FINISHED", //optional "subType":"FORBIDDEN_RECIPIENT", //optional "ts":"2020-10-16T06:38:24.884Z", "description":"Reason: Local part forbidden by config" //optional } } } ] } ### INVALID_ADDRESS Phase: PRE_PROCESS Type: DROPPED State: FINISHED Subtype: INVALID_ADDRESS JSON { "meta":{ "account":"m4a_test_user", "customerNo":"99999", "tenant":"Test User", //optional "receivedTs":"2020-10-16T06:41:46.604Z", "jobId":"7e5251d9-8661-43c3-bb00-0c1caf168c3f", "version":"1" }, "notifications":[ { "meta":{ "tag":"9d6a9d0b33174441459ede813b5f1060103cb3576089424bd926e30f4b1a2272", "mail":{ "id":"470da7c0-acd5-...9d16-b775d8b761e6", "email":"recipient@sample.com", "from":"sender@sample.com", "mimeFrom":"sender@sample.com" //optional }, "event":{ "type":"DROPPED", "phase":"PRE_PROCESS", //optional "state":"FINISHED", //optional "subType":"INVALID_ADDRESS", //optional "ts":"2020-10-16T06:41:46.725Z" } } } ] } ### VALIDATION_ERROR Phase: PRE_PROCESS Type: DROPPED State: FINISHED Subtype: VALIDATION_ERROR JSON { "meta":{ "account":"m4a_test_user", "customerNo":"99999", "tenant":"Test User", "receivedTs":"2020-10-16T06:41:46.604Z", "jobId":"rcpt-632cdc56-6480-406b-8faf-5a7e70876d0c", "version":"1" }, "notifications":[ { "meta":{ "tag":"9d6a9d0b33174441459ede813b5f1060103cb3576089424bd926e30f4b1a2272", "mail":{ "id":"rcpt-632cdc56-6480-406b-8faf-5a7e70876d0c", "email":"recipient ", "from":"sender@sample.com", "mimeFrom":"sender@sample.com" }, "event":{ "type":"DROPPED", "phase":"PRE_PROCESS", "state":"FINISHED", "subType":"VALIDATION_ERROR", "ts":"2020-10-16T06:41:46.725Z" } } } ] } ## PROCESS ### PROCESSING_STARTED Phase: PROCESS Type: STARTED State: INITIAL Subtype: PROCESSING_STARTED JSON { "meta":{ "account":"m4a_test_user", "customerNo":"99999", "tenant":"Test User", //optional "receivedTs":"2020-10-16T05:42:08.106Z", "jobId":"7e5251d9-8661-43c3-bb00-0c1caf168c3f", "version":"1" }, "notifications":[ { "meta":{ "tag":"4c95541c6739d08a4a8c01c5bfb05bcac82c3111ddcf50ed63c75ac24fbf8483", "mail":{ "id":"48b90838-...-ca200e692a8c", "email":"recipient@sample.com", "from":"sender@sample.com", "mimeFrom":"sender@sample.com" //optional }, "event":{ "type":"STARTED", "phase":"PROCESS", //optional "state":"INITIAL", //optional "subType":"PROCESSING_STARTED", //optional "ts":"2020-10-16T05:42:08.247Z", "description":"Mime message generated." //optional } }, "content":{ //optional "mime":{ //optional "size":"973" //optional } } } ] } ### SMIME_SIGNING OK Phase: PROCESS Type: SMIME_SIGNING State: INTERMEDIATE Subtype: OK JSON { "meta":{ "event": { "description": "The mail was signed successfully.", "phase": "PROCESS", "state": "INTERMEDIATE", "subType": "OK", "ts": "2024-11-08T07:38:42.224Z", "type": "SMIME_SIGNING" }, ### SMIME_SIGNING FAILED Phase: PROCESS Type: DROPPED State: FINISHED Subtype: PROCESSING_FAILED JSON { "meta":{ "event": { "description": "signature with given key identifier (sender.address@your-domain) failed", "phase": "PROCESS", "state": "FINISHED", "subType": "PROCESSING_FAILED", "ts": "2024-11-12T08:46:45.680Z", "type": "DROPPED" }, ### VIRUS_DETECTED Phase: PROCESS Type: DROPPED State: FINISHED Subtype: VIRUS_DETECTED JSON { "notifications":[ [ { "meta":{ "event":{ "description":"Job processing successfully started.", "phase":"PROCESS", "state":"INITIAL", "subType":"PROCESSING_STARTED", "ts":"2020-11-14T13:14:05.423Z", "type":"STARTED" }, "mail":{ "email":"recipient@sample.com", "from":"sender@sample.com", "id":"186248a8-b695-49be-ba51-bbc0b8e7931a#85213bcf#85b5fb36", "mimeFrom":" sender@sample.com " }, "tag":"092212c3c19124a3400ba3d742cc77ec36ea4f48b4e4271eb9d2d5f703ae2ba8" } } ], [ { "meta":{ "event":{ "description":"INFECTED: attachments are infected.", "phase":"PROCESS", "state":"FINISHED", "subType":"VIRUS_DETECTED", "ts":"2020-11-14T13:14:05.699Z", "type":"DROPPED" }, "mail":{ "email":" recipient@sample.com ", "from":" sender@sample.com ", "id":"186248a8-b695-49be-ba51-bbc0b8e7931a#85213bcf#85b5fb36", "mimeFrom":" sender@sample.com " }, "tag":"1daaa3a665636cf44844b68b33dc0573ca1f0d6ee96d7e079c488490305c1d79" } } ] ] } ### PROCESSING_FINISHED Phase: PROCESS Type: FINISHED State: INTERMEDIATE Subtype: PROCESSING_FINISHED JSON { "meta":{ "account":"m4a_test_user", "customerNo":"99999", "tenant":"Test User", //optional "receivedTs":"2020-10-16T05:42:08.106Z", "jobId":"7e5251d9-8661-43c3-bb00-0c1caf168c3f", "version":"1" }, "notifications":[ { "meta":{ "tag":"252db60267fe7b3d6160bcfd4876687e46f53182ec6a36f22f9a99a419292628", "mail":{ "id":"48b90838-...87f3-ca200e692a8c", "email":"recipient@sample.com", "from":"sender@sample.com", "mimeFrom":"sender@sample.com" //optional }, "event":{ "type":"PROCESSED", "phase":"PROCESS", //optional "state":"INTERMEDIATE", //optional "subType":"PROCESSING_FINISHED", //optional "ts":"2020-10-16T05:42:08.000Z", "description":"mail enqueued" //optional } }, "content":{ "mime":{ //optional "messageId":"<20201016-...0e692a8c@retarus.com>", //optional "size":"973" //optional } } } ] } ## DELIVER ### OK Phase: DELIVER Type: DELIVERED State: FINISHED Subtype: OK JSON { "meta":{ "account":"m4a_test_user", "customerNo":"99999", "tenant":"Test User", //optional "receivedTs":"2020-10-16T05:54:11.043Z", "jobId":"7e5251d9-8661-43c3-bb00-0c1caf168c3f", "version":"1" }, "notifications":[ { "meta":{ "tag":"a813f47bca9ded6b0305885e235c073e886168b8b63eb5e99d02d00bcc7a6371", "mail":{ "id":"6393ae2f-7c...-862b-880754463a38", "email":"recipient@sample.com", "from":"sender@sample.com", "mimeFrom":"sender@sample.com" //optional }, "event":{ "type":"DELIVERED", "phase":"DELIVER", //optional "state":"FINISHED", //optional "subType":"OK", //optional "ts":"2020-10-16T05:54:18.000Z", "description":"mail delivered" //optional } }, "content":{ //optional "mime":{ //optional "messageId":"<20201016-...54463a38@retarus.com>", //optional "size":"884" //optional }, "smtp":{ //optional "responseCode":"250", "reason":"sent (250 2.0.0 Ok: queued as 3yFnZW2mNlzPk9y)", //optional "relay":"mailin4.rmx.de[82.135.18.227]:25", //optional "dsn":"2.0.0", "transportEncryption":{ //optional "requested":true, //optional "established":true, //optional "properties":{ //optional "protocol":"TLS1.2", //optional "cipherSuite":""example-cipher-suite" //optional } } } } } ] } ### SOFT_BOUNCE (intermediate) Phase: DELIVER Type: DELIVERED State: INTERMEDIATE Subtype: SOFT_BOUNCE JSON { "meta":{ "account":"m4a_test_user", "customerNo":"99999", "tenant":"Test User", "receivedTs":"2020-10-16T05:42:08.106Z", "jobId":"rcpt-632cdc56-6480-406b-8faf-5a7e70876d0c", "version":"1" }, "notifications":[ { "meta":{ "tag":"f7ad03bb2e2cece0194d2d9798dc6574d7e47f92e6cbc60c98529237f16b4924", "mail":{ "id":"rcpt-632cdc56-6480-406b-8faf-5a7e70876d0c", "email":"recipient ", "from":"sender@sample.com", "mimeFrom":"sender@sample.com" }, "event":{ "type":"DEFERRED", "phase":"DELIVER", "state":"INTERMEDIATE", "subType":"SOFT_BOUNCE", "ts":"2020-10-16T05:42:09.000Z", "description":"delivery attempt failed" } }, "content":{ "mime":{ "messageId":"<20201016-...-aa1e- -87f3-cac@retarus.com>", "size":"973" }, "smtp":{ "responseCode":"400", "reason":"deferred (host mx.sample.com[94.231.123.123] said: 450 4.1.8 : Sender address rejected: Domain not found (in reply to RCPT TO command))", "relay":"mx.sample.com[94.231.123.123]:25", "dsn":"4.1.8" } } } ] } ### SOFT_BOUNCE (finished) Phase: DELIVER Type: BOUNCED State: FINISHED Subtype: SOFT_BOUNCE JSON { "meta":{ "account":"m4a_test_user", "customerNo":"99999", "tenant":"Test User", "receivedTs":"2020-10-16T06:02:50.678Z", "jobId":"rcpt-632cdc56-6480-406b-8faf-5a7e70876d0c", "version":"1" }, "notifications":[ { "meta":{ "tag":"acafe0bab35289f8d4c09a8be3855dcf56618f27f257e83ebea5d07a062fdf4e", "mail":{ "id":"rcpt-632cdc56-6480-406b-8faf-5a7e70876d0c", "email":"recipient ", "from":"sender@sample.com", "mimeFrom":"sender@sample.com" }, "event":{ "type":"BOUNCED", "phase":"DELIVER", "state":"FINISHED", "subType":"SOFT_BOUNCE", "ts":"2020-10-16T06:02:50.000Z", "description":"retries exceeded" } }, "content":{ "mime":{ "messageId":"", "size":"886" }, "smtp":{ "responseCode":"400", "reason":"deferred (host mx.sample.com[94.231.123.123] said: 450 4.1.8 : Sender address rejected: Domain not found (in reply to RCPT TO command))", "relay":"mx.sample.com[94.231.123.123]:25", "dsn":"4.1.8" } } } ] } ### HARD_BOUNCE Phase: DELIVER Type: BOUNCED State: FINISHED Subtype: HARD_BOUNCE JSON { "meta":{ "account":"m4a_test_user", "customerNo":"99999", "tenant":"Test User", //optional "receivedTs":"2020-10-16T06:02:50.678Z", "jobId":"7e5251d9-8661-43c3-bb00-0c1caf168c3f", "version":"1" }, "notifications":[ { "meta":{ "tag":"acafe0bab35289f8d4c09a8be3855dcf56618f27f257e83ebea5d07a062fdf4e", "mail":{ "id":"...2-ac35-942840c4a989", "email":"recipient@sample.com", "from":"sender@sample.com", "mimeFrom":"sender@sample.com" //optional }, "event":{ "type":"BOUNCED", "phase":"DELIVER", //optional "state":"FINISHED", //optional "subType":"HARD_BOUNCE", //optional "ts":"2020-10-16T06:02:50.000Z", "description":"delivery attempt failed" //optional } }, "content":{ //optional "mime":{ //optional "messageId":"<20201016-...c4a989@retarus.com>", //optional "size":"886" //optional }, "smtp":{ //optional "responseCode":"500", "reason":"bounced (Host or domain name not found. Name service error for name=sample.com type=A: Host not found)", //optional "relay":"none", //optional "dsn":"5.4.4" //optional } } } ] } ## SMART_DELIVERY ### OK Phase: SMART_DELIVERY Type: DELIVERED State: FINISHED Subtype: OK JSON { "meta":{ "account":"m4a_test_user", "customerNo":"99999", "tenant":"Test User", "receivedTs":"2020-10-16T05:54:11.043Z", "jobId":"rcpt-632cdc56-6480-406b-8faf-5a7e70876d0c", "version":"1" }, "notifications":[ { "meta":{ "tag":"a813f47bca9ded6b0305885e235c073e886168b8b63eb5e99d02d00bcc7a6371", "mail":{ "id":"rcpt-632cdc56-6480-406b-8faf-5a7e70876d0c", "email":"recipient ", "from":"sender@sample.com", "mimeFrom":"sender@sample.com" }, "event":{ "type":"DELIVERED", "phase":"SMART_DELIVERY", "state":"FINISHED", "subType":"OK", "ts":"2020-10-16T05:54:18.000Z", "description":"mail delivered" } }, "content":{ "mime":{ "messageId":"<20201016-...54463a38@retarus.com>", "size":"884" }, "smtp":{ "responseCode":"250", "reason":"sent (250 2.0.0 Ok: queued as 3yFnZW2mNlzPk9y)", "relay":"mailin4.rmx.de[82.135.18.227]:25", "dsn":"2.0.0", "transportEncryption":{ "requested":true, "established":true, "properties":{ "protocol":"TLS1.2", "cipherSuite":"example-cipher-suite" } } } } } ] } ### PROCESSING_FINISHED Phase: SMART_DELIVERY Type: FINISHED State: INTERMEDIATE Subtype: PROCESSING_FINISHED JSON { "meta":{ "account":"m4a_test_user", "customerNo":"99999", "tenant":"Test User", "receivedTs":"2020-10-16T05:42:08.106Z", "jobId":"rcpt-632cdc56-6480-406b-8faf-5a7e70876d0c", "version":"1" }, "notifications":[ { "meta":{ "tag":"252db60267fe7b3d6160bcfd4876687e46f53182ec6a36f22f9a99a419292628", "mail":{ "id":"rcpt-632cdc56-6480-406b-8faf-5a7e70876d0c", "email":"recipient ", "from":"sender@sample.com", "mimeFrom":"sender@sample.com" }, "event":{ "type":"PROCESSED", "phase":"SMART_DELIVERY", "state":"INTERMEDIATE", "subType":"PROCESSING_FINISHED", "ts":"2020-10-16T05:42:08.000Z", "description":"mail enqueued" } }, "content":{ "mime":{ "messageId":"<20201016-...0e692a8c@retarus.com>", "size":"973" } } } ] } ## POST_PROCESS ### INFORMATION Phase: POST_PROCESS Type: SPAM_SCORE_CHECK State: POST_DELIVERY Subtype: INFORMATION JSON { "meta":{ "account":"m4a_test_user", "customerNo":"99999", "tenant":"Test User", "receivedTs":"2020-10-16T05:42:08.106Z", "referenceJob":"rcpt-632cdc56-6480-406b-8faf-5a7e70876d0c", "version":"1" }, "notifications":[ { "meta":{ "tag":"252db60267fe7b3d6160bcfd4876687e46f53182ec6a36f22f9a99a419292628", "mail":{ "id":"rcpt-632cdc56-6480-406b-8faf-5a7e70876d0c", "from":"sender@sample.com" }, "event":{ "type":"SPAM_SCORE_CHECK", "phase":"POST_PROCESS", "state":"POST_DELIVERY", "subType":"INFORMATION", "ts":"2020-10-16T05:42:08.000Z" } }, "content":{ "mime":{ "messageId":"<20201016-...0e692a8c@retarus.com>" }, "spamscore":{ "reslut":"45" } } } ] } ## READ ### MAIL_OPENED (REST only) Phase: READ Type: OPEN State: POST_DELIVERY Subtype: MAIL_OPENED "meta": { "version": "1", "jobId": "rcpt-632cdc56-6480-406b-8faf-5a7e70876d0c", "receivedTs": "2020-09-27T16:22:27.605Z", "account": "m4a_test_user", "customerNo": "99999", "tenant": "Test User", // optional "campaignId": "Newsletter004.2020", // optional "referenceJob": "rcpt-632cdc56-6480-406b-8faf-5a7e70876d0c", // optional "trackEndTs": "2020-10-27T16:22:27.605Z" // optional }, "notifications": [ { "meta": { "tag": "a813f4b0305885...8b63eb5e99d02d00bcc7a6371", "mail": { "id": "rcpt-632cdc56-6480-406b-8faf-5a7e70876d0c", "email": "recipient ", "from": "sender@example.com", "mimeFrom": "sender@example.com" // optional }, "event": { "type": "OPEN", "phase": "READ", // optional "state": "POST_DELIVERY", // optional "subType":"MAIL_OPENED", // optional "ts": "2020-10-16T05:54:18.000Z", "description": "mail opened" // optional } }, "content": { "open": { "ip": "123.456.789", "userAgent": "Mozilla/5.0 (Windows NT 6.1; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/64.0.3282.167 Safari/537.36", "device": { "type": "Computer", // optional "brand": "Other", // optional "model": "Other", // optional "hasTouch": false } "os": { "name":"Windows 7", // optional "version": "Unknown" // optional }, "client": { "name":"Chrome", // optional "version": "64.0.3282", // optional "isMail": false // optional } } } } ] } ### LINK_CLICKED (REST only) Phase: READ Type: CLICK State: POST_DELIVERY Subtype: LINK_CLICKED { "meta": { "version": "1", "jobId": "rcpt-632cdc56-6480-406b-8faf-5a7e70876d0c", "receivedTs": "2020-09-27T16:22:27.605Z", "account": "m4a_test_user", "customerNo": "99999", "tenant": "Test User", // optional "campaignId": "Newsletter004.2020", // optional "referenceJob": "rcpt-632cdc56-6480-406b-8faf-5a7e70876d0c", // optional "trackEndTs": "2020-10-27T16:22:27.605Z" // optional }, "notifications": [ { "meta": { "tag": "a813f47bc..b63eb5e99d02d00bcc7a6371", "mail": { "id": "rcpt-632cdc56-6480-406b-8faf-5a7e70876d0c", "email": "recipient ", "from": "sender@example.com", "mimeFrom": "sender@example.com" // optional }, "event": { "type": "CLICK", "phase": "READ", // optional "state": "POST_DELIVERY", // optional "subType":"MAIL_CLICKED", // optional "ts": "2020-10-16T05:54:18.000Z", "description": "mail opened" // optional } }, "content": { "click": { "url": "http://www.retarus.com", "ip": "123.456.789", "userAgent": "Mozilla/5.0 (Windows NT 6.1; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/64.0.3282.167 Safari/537.36", "device": { "type": "Computer", // optional "brand": "Other", // optional "model": "Other", // optional "hasTouch": false } "os": { "name":"Windows 7", // optional "version": "Unknown" // optional }, "client": { "name":"Chrome", // optional "version": "64.0.3282", // optional "isMail": false // optional } } } } ] } --- language: "en" --- # Observability Metrics Observability Metrics for Transactional Email provide real-time insight into email processing, delivery behavior, and system performance. You can access Observability Metrics in two ways: * **myEAS Dashboard** The [myEAS Dashboard](https://docs.retarus.com/tem/dashboard.md) displays Observability Metrics through pre-defined visualizations. No additional setup is required. Use this option for operational monitoring and quick visibility into email traffic. * **Integration into your own platform** You can also integrate metrics into your Prometheus-compatible observability platform through the Retarus federation endpoint. This option gives you full control over dashboards, alerting, filtering, and data retention. The following sections describe how to configure this integration. > πŸ“Œ **Observability Metrics overview** > > For a general explanation of Observability Metrics, including data format and access model, refer to [Observability Metrics overview](https://docs.retarus.com/int/observability-metrics-overview.md). ## Setup overview Setting up Observability Metrics for Transactional Email consists of three steps. Step 1: Book the Observability Metrics add-on Contact your Retarus sales representative to order the Observability Metrics add-on and update your contract. Step 2: Retarus prepares the setup The Retarus Operations team sets up your dedicated Observability instance and endpoint. Step 3: Receive credentials and endpoint Retarus provides you with the credentials and the specific API endpoint for the Observability instance. ## Endpoint and authentication ### Endpoint `https://api.retarus.com/stable/retarus/metrics/v1/federate/[your_customer_number]` ### Authentication Access requires Basic authentication. ## Requirements * **Host** You must run a Prometheus server in your environment. * **Connectivity** Your system must be able to reach the Retarus Observability Metrics federation endpoint over a public HTTPS connection. * **Configuration** Your `prometheus.yml` configuration file must include a `scrape_configs` section to retrieve metrics from the Retarus federation endpoint. * **Scrape interval** Observability Metrics use a pull-based model. You define the scrape interval in your Prometheus configuration. The minimum supported scrape interval is 1 minute. Shorter intervals do not provide fresher data. ## Prometheus scrape configuration To retrieve metrics, configure your Prometheus server to scrape the Retarus federation endpoint. scrape_configs: - job_name: federate_retarus scrape_interval: 5m honor_labels: true metrics_path: /stable/retarus/metrics/v1/federate/[your_customer_number] scheme: https params: 'match[]': - '{__name__=~".+"}' basic_auth: username: [your_username] password: [your_password] static_configs: - targets: - 'api.retarus.com:443' ## Available metrics Transactional Email exposes the following core metrics for email processing and delivery: * `temudr_count_total` Running counter of all emails (per recipient). * `temudr_duration_seconds_sum` Total processing time in the system for a single email. * `temudr_duration_seconds_count` Number of data points capturing processing time. This metric is used to calculate the average processing time by dividing `temudr_duration_seconds_sum` by `temudr_duration_seconds_count` with the same label filters. rate(temudr_duration_seconds_sum{interface="$interface", status="$status",event_phase="$eventphase"}[$__rate_interval]) / rate(temudr_duration_seconds_count{interface="$interface", status="$status", event_phase="$eventphase"}[$__rate_interval]) ## Metrics labels Transactional Email metrics include the following labels. | **Name** | **Description** | **Possible values** | |-----------------|-----------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------| | `datacenter` | Indicates which Retarus datacenter processed and sent the message. | DE1, DE2, US1, US2, SG1, CH1 | | `event_phase` | Shows the phase in which the message reached its final processing status. | PRE_PROCESS, PROCESS, DELIVER, SMART_DELIVERY | | `event_subtype` | Provides more detailed information about the final status of a message after processing. | VALIDATION_ERROR, INVALID_ADDRESS, FORBIDDEN_RECIPIENT, PROCESSING_FAILED, SUPPRESSED, PREVIOUSLY_BOUNCED, OK, HARD_BOUNCE, SOFT_BOUNCE | | `interface` | Indicates the entry interface used to submit the message to the Transactional Email service. | rest, smtp | | `status` | Gives general information about the final status of the processed message. | OK, ERROR | | `status_code` | The SMTP status response code received by Transactional Email MTAs (Mail Transfer Agents). | | | `substatus` | Used to group messages according to the three main expected outputs after submitting a job request. | DELIVERED, BOUNCED, DROPPED | | `tenant` | Indicates which tenant the Transactional Email Technical Account is assigned to. | multiple | | `user_id` | The Technical Account ID under which the message was processed. | multiple | ## Usage * Use the provided federation endpoint (compatible with Prometheus federation) to retrieve metrics data. * Filter data using federation queries or process it locally within your own system. * Control how long metrics data is retained within your own observability platform. ## Observability Metrics vs. Events Webhook Observability Metrics and the Events Webhook serve different purposes. | **Aspect** | **Observability Metrics** | **Events Webhook** | |------------------|------------------------------------------------------------------------|----------------------------------------------------------------------------| | Purpose | Monitor system health and performance trends | Trigger immediate downstream actions | | Use case example | "How many emails have been hardbounced per second over the last hour?" | "What is the recipient domain for email #11235 that has been hardbounced?" | | Mechanism | Pull: data is retrieved at defined intervals | Push: Retarus sends data when generated | | Period | Defined intervals (via scrape configuration) | Continuous, instant flow | | Data type | Aggregated data tracking event rates | Full context of an individual event | | Data format | OpenMetrics format | JSON or XML payload | | Data destination | Observability platform via a specific API endpoint | Web service via a webhook | | Suitable for | Dashboards, capacity planning, threshold-based alerting | Real-time workflows, automation, inter-service communication | --- language: "en" --- # Onboarding process |---------|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **No.** | **Responsibility** | **Task** | | 0 | Customer \& Retarus | Discuss recommended preliminary considerations / implementation scenario. Customer will receive a Setup Sheet. | | 1 | Customer | Fill out Transactional Email Setup Sheet. | | 2 | Retarus | CuNo, Technical Accounts and/or domains will be configured. Sender Addresses and webservice receiving status notifications will be tested (if defaults given). IP addresses will be registered for CSA. Created Technical Account / domain will be locked. Retarus returns the Setup Sheet. | | 3 | Customer | Extend DNS records (SPF, DKIM). Add confirmation that all changes have been made to support ticket. | | 4 | Retarus | Perform standard test process incl. DNS validation of SPF, DKIM, MX and A records of all sending domains. Technical Account will be unlocked. Send email confirmation that setup is ready for UAT. | | 5 | Customer | Perform UAT and send email confirming that service setup has been accepted and is up and running. Onboarding process finished. | --- language: "en" --- # Open & Link Tracking (REST only) ## Presentation Open Tracking allows Customer to determine the opening rate of emails, while Link Tracking enables Customer to track the opening rate of links contained in emails. The respective email body and/or the link will be modified so that the messages can be analyzed. ![2024-09-19 16_03_03-PowerPoint Slide Show - THOMAS - Transactional Email presentation and demo.ppt.png](https://docs.retarus.com/__attachments/a_a58a9daa8fb581dfde3a398b71afe211d0c1a1c4acff44276747cd16e489fd10/2024-09-19%2016_03_03-PowerPoint%20Slide%20Show%20%20-%20%20THOMAS%20-%20Transactional%20Email%20presentation%20and%20demo.ppt.png?cb=cc5d06ef8f9ec9afa0d437634fcf01bf) Open and Link Tracking Tracking Points (push notification or into myEAS Live Search) work up to 45 days after sending the email. After this period of time, you won't be able to receive any more information about how many times recipients opened your emails or clicked on the link in your emails. ## Feature-specific parameters | **Parameters** | **Definition** | **Validations** | |-------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------| | Track Start Days | Defines the number of days after an email is sent before Transactional Email notifications begin generating Open and Click events. | Default. Always set to 0 day | | Track End Days | Defines how many days after sending an email the Transactional Email processing system stops tracking opens and clicks. This sets the maximum timeframe for event tracking after delivery. | Editable. Minimum: 1 day Maximum: 45 days | | Redirect End Days | For Link Tracking only, defines how long rewritten links within the email body remain redirected to the Retarus endpoint for tracking purposes. | Default. Always set to 45 days | ## How it works ### Open Tracking When a JobRequest is requesting to enable the Open Tracking feature, Transactional Email generates an image and a unique URL during the processing and before sending the message. This image is then included into the email body in the form of a single pixel. When the email is delivered and opened, the image is loaded, and Transactional Email service then gets this request. Thanks to the image unique URL, Transactional Email is then able to generate a Tracking Point to let you know that the email has been opened. Some email clients disable by default the possibility to display image(s) from an email. End-recipients must allow uploading pictures to make the Open Tracking feature working. The image unique URL is generated into the datacenter where the JobRequest has been processed. This unique URL includes 2 parameters: * the JSON Web token, marked as (t) into the below example * the encrypted payload information, marked as (d) into the below example **Example** `https://track-mail-de2.transactional-mail-d.com/v1/img?t=eyJraWQiOiJ2MSIsInR5cCI6IkpXVCIsImFsZyI6IkhTMjU2In0.eyJzdWIiOiJtNGEyLm90IiwidmVyIjoxLCJkc3QiOiJodHRwOi8vaHR0cC10by1rYWZrYS5tNGEubXVjcmUxLnJldGxv[...]&d=eyJhbGciOiJBMTI4S1ciLCJ6aXAiOiJERUYiLCJraWQiOiJ2MSIsImVuYyI6IkExMjhDQkMtSFMyNTYifQ.WU0SaYcWnASvOcKiYkufqlgdM54yeCZYv4MPI98zAn-UlfodYLHfJw.RmPFHeJSL4O8OdyFyzHC-g.FTROstUTstg-cDkZdQ13oy74DKMaYAMw2J7vXriu[...]` #### JSON Web token This parameter has 2 purposes: 1. Set an expiration date to only track information for a specific period of time. 2. Apply a digital signature to validate that the token is trustworthy and has not been tampered with. A JSON Web token can be read thanks to a JWT decoder like [that one](https://jwt.io/). #### Encrypted payload information The encrypted data contains all the payload information that are mandatory for Transactional Email to generate the Tracking Points when the email is opened: * This payload information is generated during the processing of the email; * No further data are collected when the email is opened (therefore the unique URL loaded); * The only information we collect is the number of times the image has been loaded; ### Link Tracking For Link Tracking, Transactional Email processing system rewrites URL(s) specified in the incoming JobRequest to route them through its servers, enabling click metric collection. When a URL is clicked: * the email's recipient is redirected to Retarus tracking servers, * Transactional Email service receives and logs the request, * a Tracking Point is generated, * the recipient is silently redirected to the original destination URL. This redirection allows Transactional Email to record engagement metrics and confirm that the URL within the email has been clicked. During processing, the original URL is enriched with additional data, resulting in a significantly longer URL that is then inserted into the MIME message. A conservative entry limit of 250 characters has been implemented to stay well within the maximum URL length supported by most browsers. At the end of processing, if the enriched URL size is higher than 2000 characters, the message is dropped before being sent out. Original URL limit, at entry: 250 characters Enriched URL limit, at processing end: 2000 characters Some Internet Service Providers (ISPs) automatically analyze hyperlinks in an email body before delivering the message to the recipient's inbox. This may trigger the Link Tracking feature multiple times. --- language: "en" --- # Outgoing IP addresses ## Default configuration By default, Transactional Email is set up to be sent using IPv4 addresses. If desired, a dedicated IP address can be ordered for one or more sender domains. This can be used to separate email traffic from different applications, to separate parent/subsidiary companies or to implement regional splits. The use of Dedicated IP is recommended from a volume of 1,000,000 emails per month. Since the Transactional Email Service is usually connected in a data center network (Active/Active), the use of Dedicated IP requires a minimum number of two dedicated IP addresses. When Dedicated IP addresses are set up, Retarus provides the customer with IP addresses for use for the duration of the contract. These are integrated into Retarus' blocklist monitoring system. An exchange of the IP address by Retarus is possible at any time. ## Usage of IPv4 Addresses These addresses are particularly recommended if a dedicated IP address is absolutely necessary due to your business model. The usage of IPv4-Addresses includes further service extensions with the following benefits: * The Certified Sender Alliance (CSA) allowlisting program * Feedback Loop Service via API or Email * (deprecated) Microsoft SNDS Program via SFTP or Email > πŸ“Œ **Update on Microsoft SNDS reports** > > Retarus no longer configures the Microsoft SNDS (Smart Network Data Services) feature. Only existing customers who already receive SNDS reports will continue to receive them. --- language: "en" --- # Transactional Email Product Sheet ## Product ### Retarus Transactional Email * REST API for outbound email * SMTP Adapter for outbound email ## Features ### Reputation Management * **Dedicated IP:** provision of customer dedicated IP addresses to separate email traffic of different customers or within a customer landscape (optional) * **Suppression List:**hardbounce prevention, by suppressing previously bounced/unknown recipient email addresses for future send-outs * **Smart Delivery Optimization (SDO)**: SDO automatically adapts the sending behavior to the responses of individual ISPs/ESPs to maximize the message throughput * **Smart Network Data Service (SNDS):**SNDS provides detailed data for each IP address of customers showing their reputation at Microsoft. The information is provided via a report in CSV format * **Feedback Loops:**automatically reports if and which emails are rejected by recipients and prevents resending to recipients who have declined receipt of specific emails from the ISP * **Basic configuration:**SPF, DKIM and DMARC implementation to maintain a high inbox placement * **CSA Certification:**sending IPs are registered with the for higher throughput and better inbox placement for major ISPs, ESPs; available for EU, CH * **Spam Score Check:**spam check of the email content performed by Retarus Email Security to increase inbox placement ### Business Features * **Processing Capacity:** contractually guaranteed throughput/processing capacity, for example 10 million emails per hour, providing top performance and deliverability for time-critical processes * **Open \& Link Tracking**: tracks the opening rate of emails and links contained in emails * **Template Rendering:**support for FreeMarker templating * **Multi-level Service Level Agreements (SLAs):**to assure business and operations critical KPIs * **Email Reporting**: available via API or download via the Retarus myEAS admin portal * **Email Live Search:** allows searching for the current status at the message level in real time via Retarus myEAS * **Secure Document Handling:**password-protected attachments for protecting sensitive contental (password-encrpyted ZIP archive) * **AntiVirus Multiscan:**virus check for outgoing attachments to secure sender reputation * **Trusted Domains**: specify a Trusted Domains list to ensure no messages are ever sent to organizations outside of that list ### Integration Features * **Registered Sender Domain:**only registered sender domains are authorized to send via the API * **IP Allowlisting:** only IPs added to the allowlist will be able to access and use the customer account and features of the service; authentication either via Basic Auth or via allowlisted IP * **Enforced TLS:** TLS encryption for outbound emails is available as standard option; optionally enforced TLS can be activated per sending domain * **DNSSEC:**ensuring the authenticity and integrity of the sending system using DNSSEC * **Status Information:**detailed status notifications for each sending job pushed back via API call * **EnvelopeFrom Address Rewriting**: rewriting of sender email to enable efficient routing of replies * **3rd party Archiving**: keep a legal long-term evidence of emails sent into the Archiving solution of your choice * **Relay Service**: send messages to a custom target email relay ## Add-on modules * **Message Signing**: digitally signed emails sent by Business Applications with your own certificates * **Trace \& Recover**: emails transmitted via SMTP are stored in a short-term storage and trackable via Email Live Search; messages can be resent without restarting the whole process in the originating application; recipient addresses can be changed before resending * **Bounce \& Response Manager**: enhanced bounce \& traffic management ## Connectors ### 3rd Party Integrations * Adobe: email adapter on Experience Cloud (SMTP) * Salesforce: setting up the SMTP Adapter * SAP: Email connector on BTP integration Suite * SAP: Integration flow with Open Connectors on BTP Integration Suite * SMTP Concentrator: send emails securely without exposing them directly to the public Internet * Observability Metrics: pull time series data from Retarus Observability platform --- language: "en" --- # Prohibited objects ## Prohibited Receiver Local Part (REST only) Role-based addresses are company or team email addresses (such as `support@`) rather than personal ones. They are often managed by multiple people, meaning recipients may not have explicitly opted in to receive your emails. Consequently, these addresses tend to have higher complaint and unsubscribe rates, and some can act as spam traps. Most of these role-based addresses are mentioned into the RFC 2142, or comes from widely used conventions. To protect Transactional Email customers, the following role-based local parts are blocked before processing (dropped at synchronous response): abuse@ admin@ billing@ compliance@ devnull@ dns@ ftp@ hostmaster@ inoc@ ispfeedback@ ispsupport@ list-request@ list@ maildaemon@ noc@ no-reply@ noreply@ null@ phish@ phishing@ postmaster@ privacy@ registrar@ root@ security@ spam@ support@ sysadmin@ tech@ undisclosed-recipients@ unsubscribe@ usenet@ uucp@ webmaster@ www@ ## Prohibited Attachment Extensions (REST only) In case an attachment with an extension listed below is detected into the message, the JobRequest is rejected synchronously. .ade .adp .app .asp .bas .bat .cer .chm .cmd .com .cpl .crt .csh .der .exe .fxp .gadget .hlp .hta .inf .ins .isp .its .js .jse .ksh .lib .lnk .mad .maf .mag .mam .maq .mar .mas .mat .mau .mav .maw .mda .mdb .mde .mdt .mdw .mdz .msc .msh .msh1 .msh2 .mshxml .msh1xml .msh2xml .msi .msp .mst .ops .pcd .pif .plg .prf .prg .reg .scf .scr .sct .shb .shs .sys .ps1 .ps1xml .ps2 .ps2xml .psc1 .psc2 .tmp .url .vb .vbe .vbs .vps .vsmacros .vss .vst .vsw .vxd .was .wsc .wsf .wsh .xnk [Next Page](https://docs.retarus.com/llms-full.txt/1)