MailSlurp JS

Globals / BulkActionsControllerApi

Class: BulkActionsControllerApi

BulkActionsControllerApi - object-oriented interface

export

Hierarchy

  • BaseAPI

    BulkActionsControllerApi

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: BulkActionsControllerApi

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

bulkCreateInboxes

bulkCreateInboxes(count: number, options?: any): Promise<Inbox[]>

Defined in src/generated/api.ts:9258

summary Bulk create Inboxes (email addresses)

throws {RequiredError}

memberof BulkActionsControllerApi

Parameters:

NameTypeDescription
countnumberNumber of inboxes to be created in bulk
options?any-

Returns: Promise<Inbox[]>


bulkDeleteInboxes

bulkDeleteInboxes(ids: Array, options?: any): Promise

Defined in src/generated/api.ts:9273

summary Bulk Delete Inboxes

throws {RequiredError}

memberof BulkActionsControllerApi

Parameters:

NameTypeDescription
idsArrayids
options?any-

Returns: Promise


bulkSendEmails

bulkSendEmails(bulkSendEmailOptions: BulkSendEmailOptions, options?: any): Promise

Defined in src/generated/api.ts:9288

summary Bulk Send Emails

throws {RequiredError}

memberof BulkActionsControllerApi

Parameters:

NameTypeDescription
bulkSendEmailOptionsBulkSendEmailOptionsbulkSendEmailOptions
options?any-

Returns: Promise