Interface ITrackingControllerApiSync
Represents a collection of functions to interact with the API endpoints
Inherited Members
Namespace: mailslurp.Api
Assembly: mailslurp.dll
Syntax
public interface ITrackingControllerApiSync : IApiAccessorMethods
View SourceCreateTrackingPixel(CreateTrackingPixelOptions, int)
Create tracking pixel
Declaration
TrackingPixelDto CreateTrackingPixel(CreateTrackingPixelOptions createTrackingPixelOptions, int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| CreateTrackingPixelOptions | createTrackingPixelOptions | |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| TrackingPixelDto | TrackingPixelDto |
Remarks
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.
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
CreateTrackingPixelWithHttpInfo(CreateTrackingPixelOptions, int)
Create tracking pixel
Declaration
ApiResponse<TrackingPixelDto> CreateTrackingPixelWithHttpInfo(CreateTrackingPixelOptions createTrackingPixelOptions, int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| CreateTrackingPixelOptions | createTrackingPixelOptions | |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| ApiResponse<TrackingPixelDto> | ApiResponse of TrackingPixelDto |
Remarks
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.
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetAllTrackingPixels(int?, int?, string, string, DateTime?, DateTime?, int)
Get tracking pixels
Declaration
PageTrackingPixelProjection GetAllTrackingPixels(int? page = null, int? size = null, string sort = null, string searchFilter = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| int? | page | Optional page index in list pagination (optional, default to 0) |
| int? | size | Optional page size in list pagination (optional, default to 20) |
| string | sort | Optional createdAt sort direction ASC or DESC (optional, default to ASC) |
| string | searchFilter | Optional search filter (optional) |
| DateTime? | since | Filter by created at after the given timestamp (optional) |
| DateTime? | before | Filter by created at before the given timestamp (optional) |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| PageTrackingPixelProjection | PageTrackingPixelProjection |
Remarks
List tracking pixels in paginated form
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetAllTrackingPixelsWithHttpInfo(int?, int?, string, string, DateTime?, DateTime?, int)
Get tracking pixels
Declaration
ApiResponse<PageTrackingPixelProjection> GetAllTrackingPixelsWithHttpInfo(int? page = null, int? size = null, string sort = null, string searchFilter = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| int? | page | Optional page index in list pagination (optional, default to 0) |
| int? | size | Optional page size in list pagination (optional, default to 20) |
| string | sort | Optional createdAt sort direction ASC or DESC (optional, default to ASC) |
| string | searchFilter | Optional search filter (optional) |
| DateTime? | since | Filter by created at after the given timestamp (optional) |
| DateTime? | before | Filter by created at before the given timestamp (optional) |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| ApiResponse<PageTrackingPixelProjection> | ApiResponse of PageTrackingPixelProjection |
Remarks
List tracking pixels in paginated form
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetTrackingPixel(Guid, int)
Get pixel
Declaration
TrackingPixelDto GetTrackingPixel(Guid id, int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| System.Guid | id | |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| TrackingPixelDto | TrackingPixelDto |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetTrackingPixelWithHttpInfo(Guid, int)
Get pixel
Declaration
ApiResponse<TrackingPixelDto> GetTrackingPixelWithHttpInfo(Guid id, int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| System.Guid | id | |
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| ApiResponse<TrackingPixelDto> | ApiResponse of TrackingPixelDto |
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |