Skip to main content

MailerParameters

@webda/core • Readme | API


Class: MailerParameters

Interface to specify the Service parameters

Extends​

Constructors​

new MailerParameters(params)​

new MailerParameters(params): MailerParameters

Parameters​

• params: any

Returns​

MailerParameters

Overrides​

ServiceParameters.constructor

Source​

packages/core/src/services/mailer.ts:98

Properties​

SES​

SES: any

SES AWS Bean if transport === "ses"

Source​

packages/core/src/services/mailer.ts:96


emailTemplateOptions?​

emailTemplateOptions?: any

See​

https://www.npmjs.com/package/email-templates

Source​

packages/core/src/services/mailer.ts:88


openapi?​

openapi?: OpenAPIWebdaDefinition

OpenAPI override

Schema Ignore​

Inherited from​

ServiceParameters.openapi

Source​

packages/core/src/services/service.ts:260


sender​

sender: string

Define the default sender

Source​

packages/core/src/services/mailer.ts:84


templates?​

templates?: string

Specify which foldeer contains templates

Default​

"templates"

Source​

packages/core/src/services/mailer.ts:74


templatesEngine?​

templatesEngine?: string

Template engine to usee

Default​

"mustache"

Source​

packages/core/src/services/mailer.ts:80


transport?​

transport?: string

Define the type of transport to use

Source​

packages/core/src/services/mailer.ts:92


type​

type: string

Type of the service

Inherited from​

ServiceParameters.type

Source​

packages/core/src/services/service.ts:251


url?​

url?: string

URL on which to serve the content

Inherited from​

ServiceParameters.url

Source​

packages/core/src/services/service.ts:255