MailSlurp JS

Globals / ExportControllerApi

Class: ExportControllerApi

ExportControllerApi - object-oriented interface

export

Hierarchy

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

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

exportEntities

exportEntities(apiKey: string, exportType: “INBOXES” | “CONTACTS” | “ATTACHMENTS” | “EMAILS”, outputFormat: “CSV_DEFAULT” | “CSV_EXCEL”, createdEarliestTime?: Date, createdOldestTime?: Date, excludePreviouslyExported?: boolean, filter?: string, listSeparatorToken?: string, options?: any): Promise

Defined in src/generated/api.ts:16738

summary Export inboxes link callable via browser

throws {RequiredError}

memberof ExportControllerApi

Parameters:

NameTypeDescription
apiKeystringapiKey
exportType“INBOXES”“CONTACTS”
outputFormat“CSV_DEFAULT”“CSV_EXCEL”
createdEarliestTime?Date-
createdOldestTime?Date-
excludePreviouslyExported?boolean-
filter?string-
listSeparatorToken?string-
options?any-

Returns: Promise


getExportLink(exportOptions: ExportOptions, exportType: “INBOXES” | “CONTACTS” | “ATTACHMENTS” | “EMAILS”, apiKey?: string, options?: any): Promise<ExportLink>

Defined in src/generated/api.ts:16772

summary Get export link

throws {RequiredError}

memberof ExportControllerApi

Parameters:

NameTypeDescription
exportOptionsExportOptionsexportOptions
exportType“INBOXES”“CONTACTS”
apiKey?string-
options?any-

Returns: Promise<ExportLink>