MailSlurp JS

Globals / BulkActionsControllerApi

# Class: BulkActionsControllerApi

BulkActionsControllerApi - object-oriented interface

export

# Hierarchy

  • BaseAPI

    BulkActionsControllerApi

# Index

# Constructors

# Properties

# Methods

# Constructors

# constructor

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

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

# 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

# bulkCreateInboxes

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

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

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&lt;string>, options?: any): Promise<Response>

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

summary Bulk Delete Inboxes

throws {RequiredError}

memberof BulkActionsControllerApi

# Parameters:

Name Type Description
ids Array&lt;string> ids
options? any -

Returns: Promise<Response>


# bulkSendEmails

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

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

summary Bulk Send Emails

throws {RequiredError}

memberof BulkActionsControllerApi

# Parameters:

Name Type Description
bulkSendEmailOptions BulkSendEmailOptions bulkSendEmailOptions
options? any -

Returns: Promise<Response>