Skip to main content

MailerParameters

@webda/core

Class: MailerParameters

Defined in: packages/core/src/services/mailer.service.ts:74

Parameters for the Mailer service configuration

Configures the email transport, templates directory and template engine

Extends​

Constructors​

Constructor​

new MailerParameters(): MailerParameters

Returns​

MailerParameters

Inherited from​

ServiceParameters.constructor

Properties​

emailTemplateOptions?​

optional emailTemplateOptions?: any

Defined in: packages/core/src/services/mailer.service.ts:94

See​

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

sender​

sender: string

Defined in: packages/core/src/services/mailer.service.ts:90

Define the default sender

SES?​

optional SES?: any

Defined in: packages/core/src/services/mailer.service.ts:102

SES AWS Bean if transport === "ses"

templates?​

optional templates?: string

Defined in: packages/core/src/services/mailer.service.ts:80

Specify which folder contains templates

Default​

"templates"

templatesEngine?​

optional templatesEngine?: string

Defined in: packages/core/src/services/mailer.service.ts:86

Template engine to use

Default​

"mustache"

transport?​

optional transport?: string

Defined in: packages/core/src/services/mailer.service.ts:98

Define the type of transport to use

type​

type: string

Defined in: packages/core/src/services/serviceparameters.ts:10

Type of the service

Inherited from​

ServiceParameters.type

Methods​

load()​

load(params?): this

Defined in: packages/core/src/services/mailer.service.ts:113

Load and apply defaults to the mailer parameters

Sets default templates directory to "./templates/", engine to "mustache", and configures juice resource options for CSS inlining

Parameters​

params?​

any = {}

Raw parameters to load

Returns​

this

this instance with defaults applied

Overrides​

ServiceParameters.load

update()​

update(params?, delta): this

Defined in: packages/core/src/services/serviceparameters.ts:35

Update parameters and call watchers if a parameter was changed

Parameters​

params?​

any = {}

the service parameters

delta​

any

the delta

Returns​

this

this for chaining

Inherited from​

ServiceParameters.update

with()​

with(callback): this

Defined in: packages/core/src/services/serviceparameters.ts:65

Watch for changes on the parameters and call watchers when a parameter is changed

Parameters​

callback​

(params) => void

the callback function

Returns​

this

this for chaining

Inherited from​

ServiceParameters.with