Package io.mailtrap.api.trackingoptouts

Interface TrackingOptOuts

All Known Implementing Classes:
TrackingOptOutsImpl
public interface TrackingOptOuts

  • Method Details

    • getTrackingOptOuts

      TrackingOptOutListResponse getTrackingOptOuts(TrackingOptOutListFilter filter)
      List email addresses that have opted out of open and click tracking. The endpoint returns up to 1000 records per request; pass the previous response's lastId to fetch the next page.
      Parameters:
      filter - - optional filtering and pagination parameters
      Returns:
      the page of tracking opt-outs and the cursor for the next page

    • createTrackingOptOut

      TrackingOptOut createTrackingOptOut(CreateTrackingOptOutRequest request)
      Add an email address to the tracking opt-out list for a sending domain.
      Parameters:
      request - - request data
      Returns:
      the created tracking opt-out

    • deleteTrackingOptOut

      TrackingOptOut deleteTrackingOptOut(String trackingOptOutId)
      Remove an email address from the tracking opt-out list so open and click tracking can apply again.
      Parameters:
      trackingOptOutId - - unique tracking opt-out ID
      Returns:
      the attributes of the deleted tracking opt-out