Class: BounceControllerApi

Hierarchy

Table of contents

Constructors

Properties

Methods

Constructors

constructor

new BounceControllerApi(configuration?)

Parameters

NameType
configurationConfiguration

Inherited from

BaseAPI.constructor

Properties

configuration

Protected configuration: Configuration

Inherited from

BaseAPI.configuration

Methods

getBouncedEmail

getBouncedEmail(requestParameters, initOverrides?): Promise<BouncedEmailDto>

Bounced emails are email you have sent that were rejected by a recipient Get a bounced email.

Parameters

NameType
requestParametersGetBouncedEmailRequest
initOverrides?RequestInit

Returns

Promise<BouncedEmailDto>


getBouncedEmailRaw

getBouncedEmailRaw(requestParameters, initOverrides?): Promise<ApiResponse<BouncedEmailDto»

Bounced emails are email you have sent that were rejected by a recipient Get a bounced email.

Parameters

NameType
requestParametersGetBouncedEmailRequest
initOverrides?RequestInit

Returns

Promise<ApiResponse<BouncedEmailDto»


getBouncedEmails

getBouncedEmails(requestParameters, initOverrides?): Promise<PageBouncedEmail>

Bounced emails are email you have sent that were rejected by a recipient Get paginated list of bounced emails.

Parameters

NameType
requestParametersGetBouncedEmailsRequest
initOverrides?RequestInit

Returns

Promise<PageBouncedEmail>


getBouncedEmailsRaw

getBouncedEmailsRaw(requestParameters, initOverrides?): Promise<ApiResponse<PageBouncedEmail»

Bounced emails are email you have sent that were rejected by a recipient Get paginated list of bounced emails.

Parameters

NameType
requestParametersGetBouncedEmailsRequest
initOverrides?RequestInit

Returns

Promise<ApiResponse<PageBouncedEmail»


getBouncedRecipient

getBouncedRecipient(requestParameters, initOverrides?): Promise<BouncedRecipientDto>

Bounced emails are email you have sent that were rejected by a recipient Get a bounced email.

Parameters

NameType
requestParametersGetBouncedRecipientRequest
initOverrides?RequestInit

Returns

Promise<BouncedRecipientDto>


getBouncedRecipientRaw

getBouncedRecipientRaw(requestParameters, initOverrides?): Promise<ApiResponse<BouncedRecipientDto»

Bounced emails are email you have sent that were rejected by a recipient Get a bounced email.

Parameters

NameType
requestParametersGetBouncedRecipientRequest
initOverrides?RequestInit

Returns

Promise<ApiResponse<BouncedRecipientDto»


getBouncedRecipients

getBouncedRecipients(requestParameters, initOverrides?): Promise<PageBouncedRecipients>

Bounced recipients are email addresses that you have sent emails to that did not accept the sent email. Once a recipient is bounced you cannot send emails to that address. Get paginated list of bounced recipients.

Parameters

NameType
requestParametersGetBouncedRecipientsRequest
initOverrides?RequestInit

Returns

Promise<PageBouncedRecipients>


getBouncedRecipientsRaw

getBouncedRecipientsRaw(requestParameters, initOverrides?): Promise<ApiResponse<PageBouncedRecipients»

Bounced recipients are email addresses that you have sent emails to that did not accept the sent email. Once a recipient is bounced you cannot send emails to that address. Get paginated list of bounced recipients.

Parameters

NameType
requestParametersGetBouncedRecipientsRequest
initOverrides?RequestInit

Returns

Promise<ApiResponse<PageBouncedRecipients»


request

Protected request(context, initOverrides?): Promise<Response>

Parameters

NameType
contextRequestOpts
initOverrides?RequestInit

Returns

Promise<Response>

Inherited from

BaseAPI.request


withMiddleware

withMiddleware<T>(…middlewares): T

Type parameters

NameType
Textends BaseAPI<T>

Parameters

NameType
...middlewaresMiddleware[]

Returns

T

Inherited from

BaseAPI.withMiddleware


withPostMiddleware

withPostMiddleware<T>(…postMiddlewares): T

Type parameters

NameType
Textends BaseAPI<T>

Parameters

NameType
...postMiddlewares(context: ResponseContext) => Promise<void

Returns

T

Inherited from

BaseAPI.withPostMiddleware


withPreMiddleware

withPreMiddleware<T>(…preMiddlewares): T

Type parameters

NameType
Textends BaseAPI<T>

Parameters

NameType
...preMiddlewares(context: RequestContext) => Promise<void

Returns

T

Inherited from

BaseAPI.withPreMiddleware