# Class: AttachmentControllerApi

AttachmentControllerApi - object-oriented interface

export

class AttachmentControllerApi

extends {BaseAPI}

# Hierarchy

  • BaseAPI

    AttachmentControllerApi

# Constructors

# constructor

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

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

# 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

# uploadAttachment

uploadAttachment(uploadOptions: UploadAttachmentOptions, options?: any): Promise‹string[]›

Defined in src/generated/api.ts:3811

When sending emails with attachments first upload each attachment with this endpoint. Record the returned attachment IDs. Then use these attachment IDs in the SendEmailOptions when sending an email. This means that attachments can easily be reused.

summary Upload an attachment for sending

throws {RequiredError}

memberof AttachmentControllerApi

Parameters:

Name Type Description
uploadOptions UploadAttachmentOptions uploadOptions
options? any -

Returns: Promise‹string[]›


# uploadMultipartForm

uploadMultipartForm(file: any, contentType?: string, contentTypeHeader?: string, filename?: string, xFilename?: string, options?: any): Promise‹string[]›

Defined in src/generated/api.ts:3833

When sending emails with attachments first upload each attachment with this endpoint. Record the returned attachment IDs. Then use these attachment IDs in the SendEmailOptions when sending an email. This means that attachments can easily be reused.

summary Upload an attachment for sending using Multipart Form

throws {RequiredError}

memberof AttachmentControllerApi

Parameters:

Name Type Description
file any file
contentType? string -
contentTypeHeader? string -
filename? string -
xFilename? string -
options? any -

Returns: Promise‹string[]›