Constructor Detail

• TrackingControllerApi

  TrackingControllerApi(String xApiKey, String basePath)

Method Detail

• getBaseUrl

   final String getBaseUrl()

• createTrackingPixel

   final TrackingPixelDto createTrackingPixel(CreateTrackingPixelOptions createTrackingPixelOptions)

  Create tracking pixel Create a tracking pixel. A tracking pixel is an image that can be embedded in an email. When the email is viewed and the image is seen MailSlurp will mark the pixel as seen. Use tracking pixels to monitor email open events. You can receive open notifications via webhook or by fetching the pixel.

• createTrackingPixelRequestConfig

   final RequestConfig createTrackingPixelRequestConfig(CreateTrackingPixelOptions createTrackingPixelOptions)

  To obtain the request config of the operation createTrackingPixel

• getAllTrackingPixels

   final PageTrackingPixelProjection getAllTrackingPixels(Integer page, Integer size, String sort, String searchFilter, OffsetDateTime since, OffsetDateTime before)

  Get tracking pixels List tracking pixels in paginated form

  Parameters:

  page - Optional page index in list pagination (optional, default to 0)

  size - Optional page size in list pagination (optional, default to 20)

  sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)

  searchFilter - Optional search filter (optional)

  since - Filter by created at after the given timestamp (optional)

  before - Filter by created at before the given timestamp (optional)

• getAllTrackingPixelsRequestConfig

   final RequestConfig getAllTrackingPixelsRequestConfig(Integer page, Integer size, String sort, String searchFilter, OffsetDateTime since, OffsetDateTime before)

  To obtain the request config of the operation getAllTrackingPixels

  Parameters:

  page - Optional page index in list pagination (optional, default to 0)

  size - Optional page size in list pagination (optional, default to 20)

  sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)

  searchFilter - Optional search filter (optional)

  since - Filter by created at after the given timestamp (optional)

  before - Filter by created at before the given timestamp (optional)

• getTrackingPixel

   final TrackingPixelDto getTrackingPixel(UUID id)

  Get pixel

• getTrackingPixelRequestConfig

   final RequestConfig getTrackingPixelRequestConfig(UUID id)

  To obtain the request config of the operation getTrackingPixel