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.

  Parameters:

  createTrackingPixelOptions - createTrackingPixelOptions

• createTrackingPixelRequestConfig

   final RequestConfig createTrackingPixelRequestConfig(CreateTrackingPixelOptions createTrackingPixelOptions)

  To obtain the request config of the operation createTrackingPixel

  Parameters:

  createTrackingPixelOptions - createTrackingPixelOptions

• getAllTrackingPixels

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

  Get tracking pixels List tracking pixels in paginated form

  Parameters:

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

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

  searchFilter - Optional search filter (optional)

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

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

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

• getAllTrackingPixelsRequestConfig

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

  To obtain the request config of the operation getAllTrackingPixels

  Parameters:

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

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

  searchFilter - Optional search filter (optional)

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

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

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

• getTrackingPixel

   final TrackingPixelDto getTrackingPixel(UUID id)

  Get pixel

  Parameters:

  id - id

• getTrackingPixelRequestConfig

   final RequestConfig getTrackingPixelRequestConfig(UUID id)

  To obtain the request config of the operation getTrackingPixel

  Parameters:

  id - id