Skip to content

Class: MissedEmailControllerApi

Hierarchy

  • BaseAPI

    MissedEmailControllerApi

Table of contents

Constructors

Properties

Methods

Constructors

constructor

new MissedEmailControllerApi(configuration?)

Parameters

Name Type
configuration Configuration

Inherited from

BaseAPI.constructor

Properties

configuration

Protected configuration: Configuration

Inherited from

BaseAPI.configuration

Methods

getAllMissedEmails

getAllMissedEmails(requestParameters, initOverrides?): Promise<PageMissedEmailProjection>

Get all MissedEmails in paginated format

Parameters

Name Type
requestParameters GetAllMissedEmailsRequest
initOverrides? RequestInit

Returns

Promise<PageMissedEmailProjection>


getAllMissedEmailsRaw

getAllMissedEmailsRaw(requestParameters, initOverrides?): Promise<ApiResponse<PageMissedEmailProjection>>

Get all MissedEmails in paginated format

Parameters

Name Type
requestParameters GetAllMissedEmailsRequest
initOverrides? RequestInit

Returns

Promise<ApiResponse<PageMissedEmailProjection>>


getAllUnknownMissedEmails

getAllUnknownMissedEmails(requestParameters, initOverrides?): Promise<PageUnknownMissedEmailProjection>

Unknown missed emails are emails that were sent to MailSlurp but could not be assigned to an existing inbox. Get all unknown missed emails in paginated format

Parameters

Name Type
requestParameters GetAllUnknownMissedEmailsRequest
initOverrides? RequestInit

Returns

Promise<PageUnknownMissedEmailProjection>


getAllUnknownMissedEmailsRaw

getAllUnknownMissedEmailsRaw(requestParameters, initOverrides?): Promise<ApiResponse<PageUnknownMissedEmailProjection>>

Unknown missed emails are emails that were sent to MailSlurp but could not be assigned to an existing inbox. Get all unknown missed emails in paginated format

Parameters

Name Type
requestParameters GetAllUnknownMissedEmailsRequest
initOverrides? RequestInit

Returns

Promise<ApiResponse<PageUnknownMissedEmailProjection>>


getMissedEmail

getMissedEmail(requestParameters, initOverrides?): Promise<MissedEmail>

List emails that were missed due to plan limits. Get MissedEmail

Parameters

Name Type
requestParameters GetMissedEmailRequest
initOverrides? RequestInit

Returns

Promise<MissedEmail>


getMissedEmailRaw

getMissedEmailRaw(requestParameters, initOverrides?): Promise<ApiResponse<MissedEmail>>

List emails that were missed due to plan limits. Get MissedEmail

Parameters

Name Type
requestParameters GetMissedEmailRequest
initOverrides? RequestInit

Returns

Promise<ApiResponse<MissedEmail>>


request

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

Parameters

Name Type
context RequestOpts
initOverrides? RequestInit

Returns

Promise<Response>

Inherited from

BaseAPI.request


restoreMissedEmails

restoreMissedEmails(initOverrides?): Promise<void>

If emails were missed due to a plan limit they are saved as missed emails. If support team enables the canRestore flag these emails can be reload into your account using this method. Restore missed emails

Parameters

Name Type
initOverrides? RequestInit

Returns

Promise<void>


restoreMissedEmailsRaw

restoreMissedEmailsRaw(initOverrides?): Promise<ApiResponse<void>>

If emails were missed due to a plan limit they are saved as missed emails. If support team enables the canRestore flag these emails can be reload into your account using this method. Restore missed emails

Parameters

Name Type
initOverrides? RequestInit

Returns

Promise<ApiResponse<void>>


waitForNthMissedEmail

waitForNthMissedEmail(requestParameters, initOverrides?): Promise<MissedEmail>

Wait for 0 based missed email Wait for Nth missed email

Parameters

Name Type
requestParameters WaitForNthMissedEmailRequest
initOverrides? RequestInit

Returns

Promise<MissedEmail>


waitForNthMissedEmailRaw

waitForNthMissedEmailRaw(requestParameters, initOverrides?): Promise<ApiResponse<MissedEmail>>

Wait for 0 based missed email Wait for Nth missed email

Parameters

Name Type
requestParameters WaitForNthMissedEmailRequest
initOverrides? RequestInit

Returns

Promise<ApiResponse<MissedEmail>>


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