# Class: BulkActionsControllerApi

BulkActionsControllerApi - object-oriented interface

export

class BulkActionsControllerApi

extends {BaseAPI}

# Hierarchy

  • BaseAPI

    BulkActionsControllerApi

# Constructors

# constructor

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

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

# 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

# bulkCreateInboxes

bulkCreateInboxes(count: number, options?: any): Promise‹Inbox[]›

Defined in src/generated/api.ts:4220

summary Bulk create Inboxes (email addresses)

throws {RequiredError}

memberof BulkActionsControllerApi

Parameters:

Name Type Description
count number Number of inboxes to be created in bulk
options? any -

Returns: Promise‹Inbox[]›


# bulkDeleteInboxes

bulkDeleteInboxes(ids: Array‹string›, options?: any): Promise‹Response›

Defined in src/generated/api.ts:4235

summary Bulk Delete Inboxes

throws {RequiredError}

memberof BulkActionsControllerApi

Parameters:

Name Type Description
ids Array‹string› ids
options? any -

Returns: Promise‹Response›


# bulkSendEmails

bulkSendEmails(bulkSendEmailOptions: BulkSendEmailOptions, options?: any): Promise‹Response›

Defined in src/generated/api.ts:4250

summary Bulk Send Emails

throws {RequiredError}

memberof BulkActionsControllerApi

Parameters:

Name Type Description
bulkSendEmailOptions BulkSendEmailOptions bulkSendEmailOptions
options? any -

Returns: Promise‹Response›