MailSlurp JS

Globals / SentEmailsControllerApi

Class: SentEmailsControllerApi

SentEmailsControllerApi - object-oriented interface

export

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Inherited from BaseAPI.constructor

Defined in src/generated/api.ts:57

Parameters:

NameTypeDefault value
configuration?Configuration-
basePathstringBASE_PATH
fetchFetchAPIportableFetch

Returns: SentEmailsControllerApi

Properties

basePath

Protected basePath: string

Inherited from BaseAPI.basePath

Defined in src/generated/api.ts:61


configuration

Protected configuration: Configuration

Inherited from BaseAPI.configuration

Defined in src/generated/api.ts:57


fetch

Protected fetch: FetchAPI

Inherited from BaseAPI.fetch

Defined in src/generated/api.ts:62

Methods

getAllSentTrackingPixels

getAllSentTrackingPixels(page?: number, searchFilter?: string, size?: number, sort?: “ASC” | “DESC”, options?: any): Promise<PageTrackingPixelProjection>

Defined in src/generated/api.ts:25686

summary Get all sent email tracking pixels in paginated form

throws {RequiredError}

memberof SentEmailsControllerApi

Parameters:

NameType
page?number
searchFilter?string
size?number
sort?“ASC”
options?any

Returns: Promise<PageTrackingPixelProjection>


getSentEmail

getSentEmail(id: string, options?: any): Promise<SentEmailDto>

Defined in src/generated/api.ts:25709

summary Get sent email receipt

throws {RequiredError}

memberof SentEmailsControllerApi

Parameters:

NameTypeDescription
idstringid
options?any-

Returns: Promise<SentEmailDto>


getSentEmailHTMLContent

getSentEmailHTMLContent(id: string, options?: any): Promise

Defined in src/generated/api.ts:25724

summary Get sent email HTML content

throws {RequiredError}

memberof SentEmailsControllerApi

Parameters:

NameTypeDescription
idstringid
options?any-

Returns: Promise


getSentEmailTrackingPixels

getSentEmailTrackingPixels(id: string, page?: number, searchFilter?: string, size?: number, sort?: “ASC” | “DESC”, options?: any): Promise<PageTrackingPixelProjection>

Defined in src/generated/api.ts:25742

summary Get all tracking pixels for a sent email in paginated form

throws {RequiredError}

memberof SentEmailsControllerApi

Parameters:

NameTypeDescription
idstringid
page?number-
searchFilter?string-
size?number-
sort?“ASC”“DESC”
options?any-

Returns: Promise<PageTrackingPixelProjection>


getSentEmails

getSentEmails(inboxId?: string, page?: number, searchFilter?: string, size?: number, sort?: “ASC” | “DESC”, options?: any): Promise<PageSentEmailProjection>

Defined in src/generated/api.ts:25774

summary Get all sent emails in paginated form

throws {RequiredError}

memberof SentEmailsControllerApi

Parameters:

NameType
inboxId?string
page?number
searchFilter?string
size?number
sort?“ASC”
options?any

Returns: Promise<PageSentEmailProjection>


getSentOrganizationEmails

getSentOrganizationEmails(inboxId?: string, page?: number, searchFilter?: string, size?: number, sort?: “ASC” | “DESC”, options?: any): Promise<PageSentEmailProjection>

Defined in src/generated/api.ts:25804

summary Get all sent organization emails in paginated form

throws {RequiredError}

memberof SentEmailsControllerApi

Parameters:

NameType
inboxId?string
page?number
searchFilter?string
size?number
sort?“ASC”
options?any

Returns: Promise<PageSentEmailProjection>