# Class: CommonActionsControllerApi

CommonActionsControllerApi - object-oriented interface

export

class CommonActionsControllerApi

extends {BaseAPI}

# Hierarchy

  • BaseAPI

    CommonActionsControllerApi

# Constructors

# constructor

+ new CommonActionsControllerApi(configuration?: Configuration, basePath: string, fetch: FetchAPI): CommonActionsControllerApi

Inherited from BaseAPI.constructor

Defined in src/generated/api.ts:57

Parameters:

Name Type Default
configuration? Configuration -
basePath string BASE_PATH
fetch FetchAPI portableFetch

Returns: CommonActionsControllerApi

# Properties

# Protected basePath

basePath: string

Inherited from BaseAPI.basePath

Defined in src/generated/api.ts:61


# Protected configuration

configuration: Configuration

Inherited from BaseAPI.configuration

Defined in src/generated/api.ts:57


# Protected fetch

fetch: FetchAPI

Inherited from BaseAPI.fetch

Defined in src/generated/api.ts:62

# Methods

# createNewEmailAddress

createNewEmailAddress(options?: any): Promise‹Inbox

Defined in src/generated/api.ts:4599

Returns an Inbox with an id and an emailAddress

summary Create new random inbox

throws {RequiredError}

memberof CommonActionsControllerApi

Parameters:

Name Type
options? any

Returns: Promise‹Inbox


# emptyInbox

emptyInbox(inboxId: string, options?: any): Promise‹Response›

Defined in src/generated/api.ts:4613

Deletes all emails

summary Delete all emails in an inbox

throws {RequiredError}

memberof CommonActionsControllerApi

Parameters:

Name Type Description
inboxId string inboxId
options? any -

Returns: Promise‹Response›


# sendEmailSimple

sendEmailSimple(sendEmailOptions: SendEmailOptions, options?: any): Promise‹Response›

Defined in src/generated/api.ts:4628

To specify an email address first create an inbox and use that with the other send email methods

summary Send an email from a random email address

throws {RequiredError}

memberof CommonActionsControllerApi

Parameters:

Name Type Description
sendEmailOptions SendEmailOptions sendEmailOptions
options? any -

Returns: Promise‹Response›