List Suppressed Destinations

sesv2_list_suppressed_destinations

R Documentation

Retrieves a list of email addresses that are on the suppression list for your account¶

Description¶

Retrieves a list of email addresses that are on the suppression list for your account.

Usage¶

sesv2_list_suppressed_destinations(Reasons, StartDate, EndDate,
  NextToken, PageSize)

Arguments¶

Reasons: The factors that caused the email address to be added to .
StartDate: 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.
EndDate: 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.
NextToken: A token returned from a previous call to list_suppressed_destinations to indicate the position in the list of suppressed email addresses.
PageSize: The number of results to show in a single call to list_suppressed_destinations. 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.

Value¶

A list with the following syntax:

list(
  SuppressedDestinationSummaries = list(
    list(
      EmailAddress = "string",
      Reason = "BOUNCE"|"COMPLAINT",
      LastUpdateTime = as.POSIXct(
        "2015-01-01"
      )
    )
  ),
  NextToken = "string"
)

Request syntax¶

svc$list_suppressed_destinations(
  Reasons = list(
    "BOUNCE"|"COMPLAINT"
  ),
  StartDate = as.POSIXct(
    "2015-01-01"
  ),
  EndDate = as.POSIXct(
    "2015-01-01"
  ),
  NextToken = "string",
  PageSize = 123
)