MailSlurp JS / TrackingControllerApi

Class: TrackingControllerApi

TrackingControllerApi - object-oriented interface

export

Hierarchy

Table of contents

Constructors

Properties

Methods

Constructors

constructor

new TrackingControllerApi(configuration?, basePath?, fetch?)

Parameters

NameType
configuration?Configuration
basePathstring
fetchFetchAPI

Inherited from

BaseAPI.constructor

Defined in

src/generated/api.ts:59

Properties

basePath

Protected basePath: string

Inherited from

BaseAPI.basePath


configuration

Protected configuration: Configuration

Inherited from

BaseAPI.configuration

Defined in

src/generated/api.ts:57


fetch

Protected fetch: FetchAPI

Inherited from

BaseAPI.fetch

Methods

createTrackingPixel

createTrackingPixel(createTrackingPixelOptions, options?): Promise<TrackingPixelDto>

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.

summary Create tracking pixel

throws {RequiredError}

memberof TrackingControllerApi

Parameters

NameTypeDescription
createTrackingPixelOptionsCreateTrackingPixelOptionscreateTrackingPixelOptions
options?any-

Returns

Promise<TrackingPixelDto>

Defined in

src/generated/api.ts:29174


getAllTrackingPixels

getAllTrackingPixels(before?, page?, searchFilter?, since?, size?, sort?, options?): Promise<PageTrackingPixelProjection>

List tracking pixels in paginated form

summary Get tracking pixels

throws {RequiredError}

memberof TrackingControllerApi

Parameters

NameType
before?Date
page?number
searchFilter?string
since?Date
size?number
sort?"ASC"
options?any

Returns

Promise<PageTrackingPixelProjection>

Defined in

src/generated/api.ts:29197


getTrackingPixel

getTrackingPixel(id, options?): Promise<TrackingPixelDto>

summary Get pixel

throws {RequiredError}

memberof TrackingControllerApi

Parameters

NameTypeDescription
idstringid
options?any-

Returns

Promise<TrackingPixelDto>

Defined in

src/generated/api.ts:29225