Class MissedEmailControllerApi

Hierarchy

BaseAPI
- MissedEmailControllerApi

Index

Constructors

Properties

Methods

getAllMissedEmails getAllMissedEmailsRaw getAllUnknownMissedEmails getAllUnknownMissedEmailsRaw getMissedEmail getMissedEmailRaw request restoreMissedEmails restoreMissedEmailsRaw waitForNthMissedEmail waitForNthMissedEmailRaw withMiddleware withPostMiddleware withPreMiddleware

Constructors

constructor

new MissedEmailControllerApi(configuration?: Configuration): MissedEmailControllerApi
Parameters
- configuration: Configuration = ...
Returns MissedEmailControllerApi

Inherited from BaseAPI.constructor

Properties

`Protected` configuration

configuration: Configuration = ...

Methods

getAllMissedEmails

getAllMissedEmails(requestParameters: GetAllMissedEmailsRequest, initOverrides?: RequestInit): Promise<PageMissedEmailProjection>
Get all MissedEmails in paginated format
Parameters
- requestParameters: GetAllMissedEmailsRequest
- Optional initOverrides: RequestInit
Returns Promise<PageMissedEmailProjection>

getAllMissedEmailsRaw

getAllMissedEmailsRaw(requestParameters: GetAllMissedEmailsRequest, initOverrides?: RequestInit): Promise<ApiResponse<PageMissedEmailProjection>>
Get all MissedEmails in paginated format
Parameters
- requestParameters: GetAllMissedEmailsRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<PageMissedEmailProjection>>

getAllUnknownMissedEmails

getAllUnknownMissedEmails(requestParameters: GetAllUnknownMissedEmailsRequest, initOverrides?: RequestInit): 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
- requestParameters: GetAllUnknownMissedEmailsRequest
- Optional initOverrides: RequestInit
Returns Promise<PageUnknownMissedEmailProjection>

getAllUnknownMissedEmailsRaw

getAllUnknownMissedEmailsRaw(requestParameters: GetAllUnknownMissedEmailsRequest, initOverrides?: RequestInit): 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
- requestParameters: GetAllUnknownMissedEmailsRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<PageUnknownMissedEmailProjection>>

getMissedEmail

getMissedEmail(requestParameters: GetMissedEmailRequest, initOverrides?: RequestInit): Promise<MissedEmailDto>
List emails that were missed due to plan limits. Get MissedEmail
Parameters
- requestParameters: GetMissedEmailRequest
- Optional initOverrides: RequestInit
Returns Promise<MissedEmailDto>

getMissedEmailRaw

getMissedEmailRaw(requestParameters: GetMissedEmailRequest, initOverrides?: RequestInit): Promise<ApiResponse<MissedEmailDto>>
List emails that were missed due to plan limits. Get MissedEmail
Parameters
- requestParameters: GetMissedEmailRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<MissedEmailDto>>

`Protected` request

request(context: RequestOpts, initOverrides?: RequestInit): Promise<Response>
Parameters
- context: RequestOpts
- Optional initOverrides: RequestInit
Returns Promise<Response>

Inherited from BaseAPI.request

restoreMissedEmails

restoreMissedEmails(initOverrides?: RequestInit): 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
- Optional initOverrides: RequestInit
Returns Promise<void>

restoreMissedEmailsRaw

restoreMissedEmailsRaw(initOverrides?: RequestInit): 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
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<void>>

waitForNthMissedEmail

waitForNthMissedEmail(requestParameters: WaitForNthMissedEmailRequest, initOverrides?: RequestInit): Promise<MissedEmailDto>
Wait for 0 based index missed email Wait for Nth missed email
Parameters
- requestParameters: WaitForNthMissedEmailRequest
- Optional initOverrides: RequestInit
Returns Promise<MissedEmailDto>

waitForNthMissedEmailRaw

waitForNthMissedEmailRaw(requestParameters: WaitForNthMissedEmailRequest, initOverrides?: RequestInit): Promise<ApiResponse<MissedEmailDto>>
Wait for 0 based index missed email Wait for Nth missed email
Parameters
- requestParameters: WaitForNthMissedEmailRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<MissedEmailDto>>

withMiddleware

withMiddleware<T>(this: T, ...middlewares: Middleware[]): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...middlewares: Middleware[]
Returns T

Inherited from BaseAPI.withMiddleware

withPostMiddleware

withPostMiddleware<T>(this: T, ...postMiddlewares: ((context: ResponseContext) => Promise<void | Response>)[]): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...postMiddlewares: ((context: ResponseContext) => Promise<void | Response>)[]
Returns T

Inherited from BaseAPI.withPostMiddleware

withPreMiddleware

withPreMiddleware<T>(this: T, ...preMiddlewares: ((context: RequestContext) => Promise<void | FetchParams>)[]): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...preMiddlewares: ((context: RequestContext) => Promise<void | FetchParams>)[]
Returns T

Inherited from BaseAPI.withPreMiddleware

Class MissedEmailControllerApi

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

configuration: Configuration = ...

Returns MissedEmailControllerApi

Properties

Protected configuration

Methods

getAllMissedEmails

Parameters

requestParameters: GetAllMissedEmailsRequest

Optional initOverrides: RequestInit

Returns Promise<PageMissedEmailProjection>

getAllMissedEmailsRaw

Parameters

requestParameters: GetAllMissedEmailsRequest

Optional initOverrides: RequestInit

Returns Promise<ApiResponse<PageMissedEmailProjection>>

getAllUnknownMissedEmails

Parameters

requestParameters: GetAllUnknownMissedEmailsRequest

Optional initOverrides: RequestInit

Returns Promise<PageUnknownMissedEmailProjection>

getAllUnknownMissedEmailsRaw

Parameters

requestParameters: GetAllUnknownMissedEmailsRequest

Optional initOverrides: RequestInit

Returns Promise<ApiResponse<PageUnknownMissedEmailProjection>>

getMissedEmail

Parameters

requestParameters: GetMissedEmailRequest

Optional initOverrides: RequestInit

Returns Promise<MissedEmailDto>

getMissedEmailRaw

Parameters

requestParameters: GetMissedEmailRequest

Optional initOverrides: RequestInit

Returns Promise<ApiResponse<MissedEmailDto>>

Protected request

Parameters

context: RequestOpts

Optional initOverrides: RequestInit

Returns Promise<Response>

restoreMissedEmails

Parameters

Optional initOverrides: RequestInit

Returns Promise<void>

restoreMissedEmailsRaw

Parameters

Optional initOverrides: RequestInit

Returns Promise<ApiResponse<void>>

waitForNthMissedEmail

Parameters

requestParameters: WaitForNthMissedEmailRequest

Optional initOverrides: RequestInit

Returns Promise<MissedEmailDto>

waitForNthMissedEmailRaw

Parameters

requestParameters: WaitForNthMissedEmailRequest

Optional initOverrides: RequestInit

Returns Promise<ApiResponse<MissedEmailDto>>

withMiddleware

Type Parameters

T extends BaseAPI<T>

Parameters

this: T

Rest ...middlewares: Middleware[]

Returns T

withPostMiddleware

Type Parameters

T extends BaseAPI<T>

Parameters

this: T

Rest ...postMiddlewares: ((context: ResponseContext) => Promise<void | Response>)[]

`Protected` configuration

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Protected` request

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Rest` ...middlewares: Middleware[]

`Rest` ...postMiddlewares: ((context: ResponseContext) => Promise<void | Response>)[]

`Rest` ...preMiddlewares: ((context: RequestContext) => Promise<void | FetchParams>)[]