MailSlurp JS / CommonActionsControllerApi

Class: CommonActionsControllerApi

CommonActionsControllerApi - object-oriented interface

export

Hierarchy

  • BaseAPI

    CommonActionsControllerApi

Table of contents

Constructors

Properties

Methods

Constructors

constructor

new CommonActionsControllerApi(configuration?, basePath?, fetch?)

Parameters

NameType
configuration?Configuration
basePathstring
fetchFetchAPI

Inherited from

BaseAPI.constructor

Defined in

src/generated/api.ts:59

Properties

basePath

Protected basePath: string

Inherited from

BaseAPI.basePath


configuration

Protected configuration: Configuration

Inherited from

BaseAPI.configuration

Defined in

src/generated/api.ts:57


fetch

Protected fetch: FetchAPI

Inherited from

BaseAPI.fetch

Methods

createNewEmailAddress

createNewEmailAddress(allowTeamAccess?, description?, emailAddress?, expiresAt?, expiresIn?, favourite?, inboxType?, name?, tags?, useDomainPool?, options?): Promise<Inbox>

Returns an Inbox with an id and an emailAddress

summary Create new random inbox

throws {RequiredError}

memberof CommonActionsControllerApi

Parameters

NameType
allowTeamAccess?boolean
description?string
emailAddress?string
expiresAt?Date
expiresIn?number
favourite?boolean
inboxType?"HTTP_INBOX"
name?string
tags?string[]
useDomainPool?boolean
options?any

Returns

Promise<Inbox>

Defined in

src/generated/api.ts:11662


createNewEmailAddress1

createNewEmailAddress1(allowTeamAccess?, description?, emailAddress?, expiresAt?, expiresIn?, favourite?, inboxType?, name?, tags?, useDomainPool?, options?): Promise<Inbox>

Returns an Inbox with an id and an emailAddress

summary Create new random inbox

throws {RequiredError}

memberof CommonActionsControllerApi

Parameters

NameType
allowTeamAccess?boolean
description?string
emailAddress?string
expiresAt?Date
expiresIn?number
favourite?boolean
inboxType?"HTTP_INBOX"
name?string
tags?string[]
useDomainPool?boolean
options?any

Returns

Promise<Inbox>

Defined in

src/generated/api.ts:11709


emptyInbox

emptyInbox(inboxId, options?): Promise<Response>

Deletes all emails

summary Delete all emails in an inbox

throws {RequiredError}

memberof CommonActionsControllerApi

Parameters

NameTypeDescription
inboxIdstringinboxId
options?any-

Returns

Promise<Response>

Defined in

src/generated/api.ts:11747


sendEmailSimple

sendEmailSimple(emailOptions, options?): Promise<Response>

If no senderId or inboxId provided a random email address will be used to send from.

summary Send an email

throws {RequiredError}

memberof CommonActionsControllerApi

Parameters

NameTypeDescription
emailOptionsSimpleSendEmailOptionsemailOptions
options?any-

Returns

Promise<Response>

Defined in

src/generated/api.ts:11762