MailSlurp JS

Globals / CommonActionsControllerApi

Class: CommonActionsControllerApi

CommonActionsControllerApi - object-oriented interface

export

Hierarchy

  • BaseAPI

    CommonActionsControllerApi

Index

Constructors

Properties

Methods

Constructors

constructor

Inherited from BaseAPI.constructor

Defined in src/generated/api.ts:57

Parameters:

NameTypeDefault value
configuration?Configuration-
basePathstringBASE_PATH
fetchFetchAPIportableFetch

Returns: CommonActionsControllerApi

Properties

basePath

Protected basePath: string

Inherited from BaseAPI.basePath

Defined in src/generated/api.ts:61


configuration

Protected configuration: Configuration

Inherited from BaseAPI.configuration

Defined in src/generated/api.ts:57


fetch

Protected fetch: FetchAPI

Inherited from BaseAPI.fetch

Defined in src/generated/api.ts:62

Methods

createNewEmailAddress

createNewEmailAddress(allowTeamAccess?: boolean, expiresAt?: Date, expiresIn?: number, useDomainPool?: boolean, options?: any): Promise<Inbox>

Defined in src/generated/api.ts:9840

Returns an Inbox with an id and an emailAddress

summary Create new random inbox

throws {RequiredError}

memberof CommonActionsControllerApi

Parameters:

NameType
allowTeamAccess?boolean
expiresAt?Date
expiresIn?number
useDomainPool?boolean
options?any

Returns: Promise<Inbox>


createNewEmailAddress1

createNewEmailAddress1(allowTeamAccess?: boolean, expiresAt?: Date, expiresIn?: number, useDomainPool?: boolean, options?: any): Promise<Inbox>

Defined in src/generated/api.ts:9869

Returns an Inbox with an id and an emailAddress

summary Create new random inbox

throws {RequiredError}

memberof CommonActionsControllerApi

Parameters:

NameType
allowTeamAccess?boolean
expiresAt?Date
expiresIn?number
useDomainPool?boolean
options?any

Returns: Promise<Inbox>


emptyInbox

emptyInbox(inboxId: string, options?: any): Promise

Defined in src/generated/api.ts:9895

Deletes all emails

summary Delete all emails in an inbox

throws {RequiredError}

memberof CommonActionsControllerApi

Parameters:

NameTypeDescription
inboxIdstringinboxId
options?any-

Returns: Promise


sendEmailSimple

sendEmailSimple(emailOptions: SimpleSendEmailOptions, options?: any): Promise

Defined in src/generated/api.ts:9910

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