Skip to content

Class: BounceControllerApi

Hierarchy

Table of contents

Constructors

Properties

Methods

Constructors

constructor

• new BounceControllerApi(configuration?)

Parameters

Name Type
configuration Configuration

Inherited from

BaseAPI.constructor

Properties

configuration

• Protected configuration: Configuration

Inherited from

BaseAPI.configuration

Methods

filterBouncedRecipient

▸ filterBouncedRecipient(requestParameters, initOverrides?): Promise<FilterBouncedRecipientsResult>

Prevent email sending errors by remove recipients who have resulted in past email bounces or complaints Filter a list of email recipients and remove those who have bounced

Parameters

Name Type
requestParameters FilterBouncedRecipientRequest
initOverrides? RequestInit

Returns

Promise<FilterBouncedRecipientsResult>

filterBouncedRecipientRaw

▸ filterBouncedRecipientRaw(requestParameters, initOverrides?): Promise<ApiResponse<FilterBouncedRecipientsResult>>

Prevent email sending errors by remove recipients who have resulted in past email bounces or complaints Filter a list of email recipients and remove those who have bounced

Parameters

Name Type
requestParameters FilterBouncedRecipientRequest
initOverrides? RequestInit

Returns

Promise<ApiResponse<FilterBouncedRecipientsResult>>

getBouncedEmail

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

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

Parameters

Name Type
requestParameters GetBouncedEmailRequest
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

Name Type
requestParameters GetBouncedEmailRequest
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

Name Type
requestParameters GetBouncedEmailsRequest
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

Name Type
requestParameters GetBouncedEmailsRequest
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

Name Type
requestParameters GetBouncedRecipientRequest
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

Name Type
requestParameters GetBouncedRecipientRequest
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

Name Type
requestParameters GetBouncedRecipientsRequest
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

Name Type
requestParameters GetBouncedRecipientsRequest
initOverrides? RequestInit

Returns

Promise<ApiResponse<PageBouncedRecipients>>

getComplaints

▸ getComplaints(requestParameters, initOverrides?): Promise<PageComplaint>

SMTP complaints made against your account Get paginated list of complaints.

Parameters

Name Type
requestParameters GetComplaintsRequest
initOverrides? RequestInit

Returns

Promise<PageComplaint>

getComplaintsRaw

▸ getComplaintsRaw(requestParameters, initOverrides?): Promise<ApiResponse<PageComplaint>>

SMTP complaints made against your account Get paginated list of complaints.

Parameters

Name Type
requestParameters GetComplaintsRequest
initOverrides? RequestInit

Returns

Promise<ApiResponse<PageComplaint>>

request

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

Parameters

Name Type
context RequestOpts
initOverrides? RequestInit

Returns

Promise<Response>

Inherited from

BaseAPI.request

withMiddleware

▸ withMiddleware<T>(this, ...middlewares): T

Type parameters

Name Type
T extends BaseAPI<T>

Parameters

Name Type
this T
...middlewares Middleware[]

Returns

T

Inherited from

BaseAPI.withMiddleware

withPostMiddleware

▸ withPostMiddleware<T>(this, ...postMiddlewares): T

Type parameters

Name Type
T extends BaseAPI<T>

Parameters

Name Type
this T
...postMiddlewares (context: ResponseContext) => Promise<void

Returns

T

Inherited from

BaseAPI.withPostMiddleware

withPreMiddleware

▸ withPreMiddleware<T>(this, ...preMiddlewares): T

Type parameters

Name Type
T extends BaseAPI<T>

Parameters

Name Type
this T
...preMiddlewares (context: RequestContext) => Promise<void

Returns

T

Inherited from

BaseAPI.withPreMiddleware