Interface ITrackingControllerApiAsync

Represents a collection of functions to interact with the API endpoints

Inherited Members
Namespace: mailslurp.Api
Assembly: mailslurp.dll
Syntax
public interface ITrackingControllerApiAsync : IApiAccessor

Methods

View Source

CreateTrackingPixelAsync(CreateTrackingPixelOptions, int, CancellationToken)

Create tracking pixel

Declaration
Task<TrackingPixelDto> CreateTrackingPixelAsync(CreateTrackingPixelOptions createTrackingPixelOptions, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
CreateTrackingPixelOptions createTrackingPixelOptions
int operationIndex

Index associated with the operation.
CancellationToken cancellationToken

Cancellation Token to cancel the request.
Returns
Type Description
Task<TrackingPixelDto>

Task 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
View Source

CreateTrackingPixelWithHttpInfoAsync(CreateTrackingPixelOptions, int, CancellationToken)

Create tracking pixel

Declaration
Task<ApiResponse<TrackingPixelDto>> CreateTrackingPixelWithHttpInfoAsync(CreateTrackingPixelOptions createTrackingPixelOptions, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
CreateTrackingPixelOptions createTrackingPixelOptions
int operationIndex

Index associated with the operation.
CancellationToken cancellationToken

Cancellation Token to cancel the request.
Returns
Type Description
Task<ApiResponse<TrackingPixelDto>>

Task of ApiResponse (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
View Source

GetAllTrackingPixelsAsync(int?, int?, string, string, DateTime?, DateTime?, int, CancellationToken)

Get tracking pixels

Declaration
Task<PageTrackingPixelProjection> GetAllTrackingPixelsAsync(int? page = null, int? size = null, string sort = null, string searchFilter = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0, CancellationToken cancellationToken = default)
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.
CancellationToken cancellationToken

Cancellation Token to cancel the request.
Returns
Type Description
Task<PageTrackingPixelProjection>

Task of PageTrackingPixelProjection
Remarks

List tracking pixels in paginated form

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetAllTrackingPixelsWithHttpInfoAsync(int?, int?, string, string, DateTime?, DateTime?, int, CancellationToken)

Get tracking pixels

Declaration
Task<ApiResponse<PageTrackingPixelProjection>> GetAllTrackingPixelsWithHttpInfoAsync(int? page = null, int? size = null, string sort = null, string searchFilter = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0, CancellationToken cancellationToken = default)
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.
CancellationToken cancellationToken

Cancellation Token to cancel the request.
Returns
Type Description
Task<ApiResponse<PageTrackingPixelProjection>>

Task of ApiResponse (PageTrackingPixelProjection)
Remarks

List tracking pixels in paginated form

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetTrackingPixelAsync(Guid, int, CancellationToken)

Get pixel

Declaration
Task<TrackingPixelDto> GetTrackingPixelAsync(Guid id, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
System.Guid id
int operationIndex

Index associated with the operation.
CancellationToken cancellationToken

Cancellation Token to cancel the request.
Returns
Type Description
Task<TrackingPixelDto>

Task of TrackingPixelDto
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetTrackingPixelWithHttpInfoAsync(Guid, int, CancellationToken)

Get pixel

Declaration
Task<ApiResponse<TrackingPixelDto>> GetTrackingPixelWithHttpInfoAsync(Guid id, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
System.Guid id
int operationIndex

Index associated with the operation.
CancellationToken cancellationToken

Cancellation Token to cancel the request.
Returns
Type Description
Task<ApiResponse<TrackingPixelDto>>

Task of ApiResponse (TrackingPixelDto)
Exceptions
Type Condition
ApiException

Thrown when fails to make API call