mailslurp
v15.17.22

MailSlurpAPI.Api.TrackingController (mailslurp v15.17.22)

API calls for all endpoints tagged TrackingController.

Summary

Functions

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

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_all_tracking_pixels(connection, opts \\ [])

Get tracking pixels List tracking pixels in paginated form

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

Get pixel

Functions

Link to this function

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

@spec create_tracking_pixel(
  Tesla.Env.client(),
  MailSlurpAPI.Model.CreateTrackingPixelOptions.t(),
  keyword()
) :: {:ok, MailSlurpAPI.Model.TrackingPixelDto.t()} | {:error, Tesla.Env.t()}

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):
  • opts (KeywordList): [optional] Optional parameters

Returns

} on success {:error, info} on failure

Link to this function

get_all_tracking_pixels(connection, opts \\ [])

@spec 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
    • :size (integer()): Optional page size in list pagination
    • :sort (String.t): Optional createdAt sort direction ASC or DESC
    • :search_filter (String.t): Optional search filter
    • :since (DateTime.t): Filter by created at after the given timestamp
    • :before (DateTime.t): Filter by created at before the given timestamp

Returns

} on success {:error, info} on failure

Link to this function

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

@spec 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):
  • opts (KeywordList): [optional] Optional parameters

Returns

} on success {:error, info} on failure