MailSlurp JS / BulkActionsControllerApi

Class: BulkActionsControllerApi

BulkActionsControllerApi - object-oriented interface

export

Hierarchy

  • BaseAPI

    BulkActionsControllerApi

Table of contents

Constructors

Properties

Methods

Constructors

constructor

new BulkActionsControllerApi(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

bulkCreateInboxes

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

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[]>

Defined in

src/generated/api.ts:10930


bulkDeleteInboxes

bulkDeleteInboxes(ids, options?): Promise<Response>

summary Bulk Delete Inboxes

throws {RequiredError}

memberof BulkActionsControllerApi

Parameters

NameTypeDescription
idsstring[]ids
options?any-

Returns

Promise<Response>

Defined in

src/generated/api.ts:10945


bulkSendEmails

bulkSendEmails(bulkSendEmailOptions, options?): Promise<Response>

summary Bulk Send Emails

throws {RequiredError}

memberof BulkActionsControllerApi

Parameters

NameTypeDescription
bulkSendEmailOptionsBulkSendEmailOptionsbulkSendEmailOptions
options?any-

Returns

Promise<Response>

Defined in

src/generated/api.ts:10960