MailSlurpAPI.Api.TrackingController (mailslurp v12.8.2)

API calls for all endpoints tagged TrackingController.

Link to this section Summary

Functions

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.

Get tracking pixels List tracking pixels in paginated form

Link to this section Functions

Link to this function

create_tracking_pixel(connection, create_tracking_pixel_options, opts \\ [])

Specs

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

  • connection (MailSlurpAPI.Connection): Connection to server
  • create_tracking_pixel_options (CreateTrackingPixelOptions): createTrackingPixelOptions
  • opts (KeywordList): [optional] Optional parameters

    Returns

} on success {:error, info} on failure

Link to this function

get_all_tracking_pixels(connection, opts \\ [])

Specs

get_all_tracking_pixels(Tesla.Env.client(), keyword()) ::
  {:ok, MailSlurpAPI.Model.PageTrackingPixelProjection.t()}
  | {:error, Tesla.Env.t()}

Get tracking pixels List tracking pixels in paginated form

Parameters

  • connection (MailSlurpAPI.Connection): Connection to server
  • opts (KeywordList): [optional] Optional parameters
    • :page (integer()): Optional page index in list pagination
    • :search_filter (String.t): Optional search filter
    • :size (integer()): Optional page size in list pagination
    • :sort (String.t): Optional createdAt sort direction ASC or DESC

      Returns

} on success {:error, info} on failure

Link to this function

get_tracking_pixel(connection, id, opts \\ [])

Specs

get_tracking_pixel(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, MailSlurpAPI.Model.TrackingPixelDto.t()} | {:error, Tesla.Env.t()}

Get pixel

Parameters

  • connection (MailSlurpAPI.Connection): Connection to server
  • id (String.t): id
  • opts (KeywordList): [optional] Optional parameters

    Returns

} on success {:error, info} on failure