Skip to content

/AWS1/IF_SE2=>LISTSUPPRESSEDDESTINATIONS()

About ListSuppressedDestinations

Retrieves a list of email addresses that are on the suppression list for your account or for a specific tenant. To target a tenant's suppression list, specify the TenantName parameter. If you omit TenantName, the operation targets the account-level suppression list.

Method Signature

METHODS /AWS1/IF_SE2~LISTSUPPRESSEDDESTINATIONS
  IMPORTING
    !IV_TENANTNAME TYPE /AWS1/SE2TENANTNAME OPTIONAL
    !IT_REASONS TYPE /AWS1/CL_SE2SUPIONLISTRSNS_W=>TT_SUPPRESSIONLISTREASONS OPTIONAL
    !IV_STARTDATE TYPE /AWS1/SE2TIMESTAMP OPTIONAL
    !IV_ENDDATE TYPE /AWS1/SE2TIMESTAMP OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/SE2NEXTTOKEN OPTIONAL
    !IV_PAGESIZE TYPE /AWS1/SE2MAXITEMS OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_se2listsupeddstsrsp
  RAISING
    /AWS1/CX_SE2BADREQUESTEX
    /AWS1/CX_SE2INVALIDNEXTTOKENEX
    /AWS1/CX_SE2NOTFOUNDEXCEPTION
    /AWS1/CX_SE2TOOMANYREQUESTSEX
    /AWS1/CX_SE2CLIENTEXC
    /AWS1/CX_SE2SERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Optional arguments:

iv_tenantname TYPE /AWS1/SE2TENANTNAME /AWS1/SE2TENANTNAME

The name of the tenant whose suppression list you want to retrieve. If you omit this parameter, the operation targets the account-level suppression list.

it_reasons TYPE /AWS1/CL_SE2SUPIONLISTRSNS_W=>TT_SUPPRESSIONLISTREASONS TT_SUPPRESSIONLISTREASONS

The factors that caused the email address to be added to the suppression list for your account or for a specific tenant.

iv_startdate TYPE /AWS1/SE2TIMESTAMP /AWS1/SE2TIMESTAMP

Used to filter the list of suppressed email destinations so that it only includes addresses that were added to the list after a specific date.

iv_enddate TYPE /AWS1/SE2TIMESTAMP /AWS1/SE2TIMESTAMP

Used to filter the list of suppressed email destinations so that it only includes addresses that were added to the list before a specific date.

iv_nexttoken TYPE /AWS1/SE2NEXTTOKEN /AWS1/SE2NEXTTOKEN

A token returned from a previous call to ListSuppressedDestinations to indicate the position in the list of suppressed email addresses.

iv_pagesize TYPE /AWS1/SE2MAXITEMS /AWS1/SE2MAXITEMS

The number of results to show in a single call to ListSuppressedDestinations. If the number of results is larger than the number you specified in this parameter, then the response includes a NextToken element, which you can use to obtain additional results.

RETURNING

oo_output TYPE REF TO /aws1/cl_se2listsupeddstsrsp /AWS1/CL_SE2LISTSUPEDDSTSRSP

Examples

Syntax Example

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->listsuppresseddestinations(
  it_reasons = VALUE /aws1/cl_se2supionlistrsns_w=>tt_suppressionlistreasons(
    ( new /aws1/cl_se2supionlistrsns_w( |string| ) )
  )
  iv_enddate = '20150101000000.0000000'
  iv_nexttoken = |string|
  iv_pagesize = 123
  iv_startdate = '20150101000000.0000000'
  iv_tenantname = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  LOOP AT lo_result->get_suppresseddstsummaries( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_emailaddress = lo_row_1->get_emailaddress( ).
      lv_suppressionlistreason = lo_row_1->get_reason( ).
      lv_timestamp = lo_row_1->get_lastupdatetime( ).
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.