Allowed list allow-list
It is possible to define a specific sending-safe list at the sandbox level.
This allowed list enables you to specify individual email addresses or domains that will be the only recipients or domains authorized to receive the emails you are sending from a specific sandbox.
For example, on a non-production instance, where mistakes can occur, the allowed list ensures you have no risk of sending out unwanted messages to real customer addresses, and therefore provides a secured environment for testing purpose.
Also, when the allowed list is active but empty, no mail will go out. Hence if you encounter some major issue, you can use this feature to stop all outgoing communications from Journey Optimizer until you fix the problem. Learn more on the allowed list logic.
In addition, you can leverage Journey Optimizer Suppression REST API to control your outgoing messages using suppression and allow lists.
Access the allowed list access-allowed-list
To access the detailed list of allowed email addresses and domains, go to Administration > Channels > Email settings, and select Allowed list.
To export the allowed list as a CSV file, select the Download CSV button.
Use the Delete button to permanently remove an entry.
You can search on the email addresses or domains, and filter on the Address type. Once selected, you can clear the filter displayed on top of the list.
Activate the allowed list enable-allow-list
To activate the allowed list, follow the steps below.
-
Access the Channels > Email configuration > Allow list menu.
-
Select the toggle button.
-
Select Activate allowed list. The allowed list is now active.
note note NOTE After you activate the allowed list, there is a 5-minute latency for it to take effect in your journeys and campaigns.
The allowed list logic applies when the feature is active. Learn more in this section.
Deactivate the allowed list deactivate-allow-list
To deactivate the allowed list, follow the steps below.
-
Access the Channels > Email configuration > Allow list menu.
-
Select the toggle button.
-
Select Deactivate allowed list. The allowed list is no longer active.
note note NOTE After you deactivate the allowed list, there is a 5-minute latency for it to take effect in your journeys and campaigns.
The allowed list logic does not apply when the feature is deactivated. Learn more in this section.
Add entities to the allowed list add-entities
To add new email addresses or domains to the allowed list for a specific sandbox, you can either manually populate the list, or use an API call.
Manually populate the allowed list manually-populate-list
You can manually populate the Journey Optimizer allowed list by adding an email address or a domain through the user interface.
To do this, follow the steps below.
-
Select the Add email or domain button.
-
Choose the address type: Email address or Domain address.
-
Enter the email address or domain you want to send emails to.
note note NOTE Make sure you enter a valid email address (such as abc@company.com) or domain (such as abc.company.com). -
Specify a reason if needed.
note note NOTE All ASCII characters comprised between 32 and 126 are allowed in the Reason field. The full list can be found on for example. -
Click Submit.
Add entities using an API call api-call-allowed-list
To populate the allowed list, you can also call the suppression API with the ALLOWED value for the listType attribute. For example:
You can perform the Add, Delete and Get operations.
Learn more on making API calls in the ÃÛ¶¹ÊÓƵ Experience Platform APIs reference documentation.
Download the allowed list download-allowed-list
To export the allowed list as a CSV file, follow the steps below:
-
Select the Download CSV button.
-
Wait until the file is generated.
note note NOTE Download time depends on the file size, meaning the number of addresses that are on the allowed list. One download request can be processed at a time for a given sandbox. -
Once the file is generated, you receive a notification. Click the bell icon on top right of the screen to display it.
-
Click the notification itself to download the file.
note note NOTE The link is valid for 24 hours.
Allowed list logic logic
When the allowed list is active, the following logic applies:
-
If the allowed list is empty, no email will be sent out.
-
If an entity is on the allowed list, and not on the suppression list, the email is sent to the corresponding recipient(s). However, if the entity is also on the suppression list, the corresponding recipient(s) will not receive the email, the reason being Suppressed.
-
If an entity is not on the allowed list (and not on the suppression list), the corresponding recipient(s) will not receive the email, the reason being Not allowed.
When the allowed list is deactivated, all the emails that you are sending from the current sandbox are sent out to all recipients (provided they are not on the suppression list), including real customer addresses.
Exclusion reporting reporting
When the allowed list is active, you can retrieve email addresses or domains that were excluded from a sending because they were not on the allowed list. To do this, you can use the ÃÛ¶¹ÊÓƵ Experience Platform Query Service to make the API calls below.
To get the number of emails that were not sent because the recipients were not on the allowed list, use the following query:
SELECT count(distinct _id) from cjm_message_feedback_event_dataset WHERE
_experience.customerJourneyManagement.messageExecution.messageExecutionID = '<MESSAGE_EXECUTION_ID>' AND
_experience.customerJourneyManagement.messageDeliveryfeedback.feedbackStatus = 'exclude' AND
_experience.customerJourneyManagement.messageDeliveryfeedback.messageExclusion.reason = 'EmailNotAllowed'
To get the list of email addresses that were not sent because the recipients were not on the allowed list, use the following query:
SELECT distinct(_experience.customerJourneyManagement.emailChannelContext.address) from cjm_message_feedback_event_dataset WHERE
_experience.customerJourneyManagement.messageExecution.messageExecutionID IS NOT NULL AND
_experience.customerJourneyManagement.messageDeliveryfeedback.feedbackStatus = 'exclude' AND
_experience.customerJourneyManagement.messageDeliveryfeedback.messageExclusion.reason = 'EmailNotAllowed'