MailSlurp JS

Globals / CommonActionsControllerApi

# Class: CommonActionsControllerApi

CommonActionsControllerApi - object-oriented interface

export

# Hierarchy

  • BaseAPI

    CommonActionsControllerApi

# Index

# Constructors

# Properties

# Methods

# Constructors

# constructor

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

Inherited from BaseAPI.constructor

Defined in src/generated/api.ts:57 (opens new window)

# Parameters:

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

Returns: CommonActionsControllerApi

# Properties

# basePath

Protected basePath: string

Inherited from BaseAPI.basePath

Defined in src/generated/api.ts:61 (opens new window)


# configuration

Protected configuration: Configuration

Inherited from BaseAPI.configuration

Defined in src/generated/api.ts:57 (opens new window)


# fetch

Protected fetch: FetchAPI

Inherited from BaseAPI.fetch

Defined in src/generated/api.ts:62 (opens new window)

# Methods

# createNewEmailAddress

createNewEmailAddress(options?: any): Promise<Inbox>

Defined in src/generated/api.ts:5187 (opens new window)

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>


# createNewEmailAddress1

createNewEmailAddress1(options?: any): Promise<Inbox>

Defined in src/generated/api.ts:5200 (opens new window)

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:5214 (opens new window)

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(emailOptions: SimpleSendEmailOptions, options?: any): Promise<Response>

Defined in src/generated/api.ts:5229 (opens new window)

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:

Name Type Description
emailOptions SimpleSendEmailOptions emailOptions
options? any -

Returns: Promise<Response>