Allowed list

It is possible to define a specific sending-safe list at the sandbox level, to have a safe environment for testing purpose.

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 your customers.

NOTE

This feature is now available on production and non-production sandboxes.

The 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. This can prevent you from sending emails accidentally to real customer addresses when you are in a testing environment.

CAUTION

This feature only applies to the email channel.

Enable the allowed list

To enable the allowed list, follow the steps below.

  1. Access the Channels > Email configuration > Allow list menu.

  2. Click Edit.

  3. Select Enable allowed list.

  4. Click Save. The allowed list is enabled.

The allowed list logic applies when the feature is enabled and if the allowed list is not empty. Learn more in this section.

NOTE

When enabled, the allowed list feature is honored when executing journeys, but also when testing messages with proofs and testing journeys using the test mode.

Add entities to the allowed list

To add new email addresses or domains to the allowed list for a specific sandbox, you must call the suppression API with the ALLOWED value for the listType attribute. For example:

You can perform the Add, Delete and Get operations.

NOTE

The allowed list can contain up to 1,000 entries.

Learn more on making API calls in the Adobe Experience Platform APIs reference documentation.

Allowed list logic

When the allowed list is empty, the allowed list logic is not applied. This means that you can send emails to any profiles, provided they are not on the suppression list.

When the allowed list is not empty, the allowed list logic is applied:

  • If an entity is not on the allowed list, and not on the suppression list, the corresponding recipient will not receive the email, the reason being Not allowed.

  • If an entity is on the allowed list, and not on the suppression list, the email can be sent to the corresponding recipient. However, if the entity is also on the suppression list, the corresponding recipient will not receive the email, the reason being Suppressed.

NOTE

The profiles with Not allowed status are excluded during the message sending process. Therefore, while the Journey reports will show these profiles as having moved through the journey (Read Segment and Message activities), the Email reports will not include them in the Sent metrics as they are filtered out prior to email sending.

Learn more on the Live Report and Global Report.

Exclusion reporting

When this feature is enabled on a non-production sandbox, 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 Adobe 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'

On this page