Skip to main content

Mailer

@webda/core

Class: Mailer<T>

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

A basic Mailer based on the nodemailer module

Inside config it is the nodemailer module option for the method createTransport ( https://nodemailer.com/ )

Only ses transport module is installed by default

Parameters config: { ... }

Webda Modda​

Extends​

Type Parameters​

T​

T extends MailerParameters = MailerParameters

Constructors​

Constructor​

new Mailer<T>(name, params): Mailer<T>

Defined in: packages/core/src/services/service.ts:192

Service

Parameters​

name​

string

The name of the service

params​

T

The parameters block define in the configuration file

Returns​

Mailer<T>

Inherited from​

AbstractMailer.constructor

Properties​

_compiledCapabilities​

protected _compiledCapabilities: Record<string, any> = {}

Defined in: packages/core/src/services/iservice.ts:58

Capabilities detected at compile-time from @WebdaCapability-tagged interfaces.

Populated during Service.resolve by reading the service's entry in webda.module.json. Each key is a capability name (e.g., "request-filter"), and the value is an empty object {} by default. Override getCapabilities to provide capability-specific configuration or to conditionally disable capabilities.

See​

getCapabilities

Inherited from​

AbstractMailer._compiledCapabilities

_templates​

_templates: TemplatesMap = {}

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

Cache of loaded email template instances by name

_transporter​

_transporter: any

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

Nodemailer transport instance used to send emails

[WEBDA_EVENTS]​

[WEBDA_EVENTS]: object

Defined in: packages/core/src/services/service.ts:166

Set the Webda events here

Inherited from​

AbstractMailer.[WEBDA_EVENTS]

logger​

protected logger: Logger

Defined in: packages/core/src/services/service.ts:179

Logger with class context

Inherited from​

AbstractMailer.logger

metrics​

metrics: object

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

Mailer metrics for tracking sent emails and errors

errors​

errors: Counter

sent​

sent: Counter

Inherited from​

AbstractMailer.metrics

name​

readonly name: string

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

Inherited from​

AbstractMailer.name

parameters​

readonly parameters: T

Defined in: packages/core/src/services/iservice.ts:36

Inherited from​

AbstractMailer.parameters

createConfiguration?​

static optional createConfiguration?: (params) => any

Defined in: packages/core/src/services/iservice.ts:41

Create configuration set by the application on load

Parameters​

params​

any

Returns​

any

Inherited from​

AbstractMailer.createConfiguration

filterConfiguration?​

static optional filterConfiguration?: (params) => any

Defined in: packages/core/src/services/iservice.ts:46

Create configuration set by the application on load

Parameters​

params​

any

Returns​

any

Inherited from​

AbstractMailer.filterConfiguration

Parameters​

static Parameters: typeof ServiceParameters = ServiceParameters

Defined in: packages/core/src/services/service.ts:162

Service parameters

Inherited from​

AbstractMailer.Parameters

Methods​

__clean()​

abstract __clean(): Promise<void>

Defined in: packages/core/src/services/service.ts:492

Clean the service data, can only be used in test mode

Returns​

Promise<void>

Inherited from​

AbstractMailer.__clean

_getTemplate()​

_getTemplate(name): IEmailTemplate

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

Get or create a cached email template instance by name

Lazily creates and caches an Email template using the configured templates directory and engine. Logs a warning if the template does not exist.

Parameters​

name​

string

Template name (must correspond to a directory in the templates folder)

Returns​

IEmailTemplate

The email template instance, or undefined if the template does not exist

addListener()​

addListener<Key>(eventName, listener): this

Defined in: packages/core/src/events/asynceventemitter.ts:83

Type Parameters​

Key​

Key extends never

Parameters​

eventName​

Key

the event name

listener​

(event) => void | Promise<void>

the event listener

Returns​

this

this for chaining

See​

EventEmitter.addListener

Inherited from​

AbstractMailer.addListener

addRoute()​

protected addRoute(url, methods, executer, openapi?, override?): void

Defined in: packages/core/src/services/service.ts:384

Add a route dynamicaly

Parameters​

url​

string

of the route can contains dynamic part like {uuid}

methods​

HttpMethodType[]

the HTTP methods

executer​

Function

Method to execute for this route

openapi?​

OpenAPIWebdaDefinition = {}

the OpenAPI specification

override?​

boolean = false

whether to override existing

Returns​

void

Inherited from​

AbstractMailer.addRoute

authorizeClientEvent()​

authorizeClientEvent(_event, _context): boolean

Defined in: packages/core/src/services/service.ts:337

Authorize a public event subscription

Parameters​

_event​

string

the event name

_context​

OperationContext

the execution context

Returns​

boolean

true if the condition is met

Inherited from​

AbstractMailer.authorizeClientEvent

computeParameters()​

computeParameters(): void

Defined in: packages/core/src/services/service.ts:201

Used to compute or derivate input parameter to attribute

Returns​

void

Deprecated​

Inherited from​

AbstractMailer.computeParameters

emit()​

emit<Key>(event, data): Promise<void>

Defined in: packages/core/src/services/service.ts:473

Emit the event with data and wait for Promise to finish if listener returned a Promise

Type Parameters​

Key​

Key extends never

Parameters​

event​

Key

the event name

data​

object[Key]

the data to process

Returns​

Promise<void>

Inherited from​

AbstractMailer.emit

getCapabilities()​

getCapabilities(): Record<string, any>

Defined in: packages/core/src/services/iservice.ts:86

Return the capabilities of this service.

By default returns capabilities detected at compile-time from

Returns​

Record<string, any>

the result

Webda Capability-tagged​

interfaces in webda.module.json.

Override to disable capabilities based on configuration:

getCapabilities() {
  const caps = super.getCapabilities();
  if (!this.parameters.enabled) delete caps["request-filter"];
  return caps;
}

Inherited from​

AbstractMailer.getCapabilities

getClientEvents()​

getClientEvents(): string[]

Defined in: packages/core/src/services/service.ts:325

Return the events that an external system can subscribe to

Returns​

string[]

the list of results

Inherited from​

AbstractMailer.getClientEvents

getMaxListeners()​

getMaxListeners(): number

Defined in: packages/core/src/events/asynceventemitter.ts:90

Returns​

number

Inherited from​

AbstractMailer.getMaxListeners

getMetric()​

getMetric<T>(type, configuration): T

Defined in: packages/core/src/services/service.ts:310

Add service name label

Type Parameters​

T​

T = Gauge<string> | Counter<string> | Histogram<string>

Parameters​

type​

CustomConstructor<T, [MetricConfiguration<T>]>

the type to look up

configuration​

MetricConfiguration<T>

the configuration

Returns​

T

the result

Inherited from​

AbstractMailer.getMetric

getName()​

getName(): string

Defined in: packages/core/src/services/service.ts:483

Get service name

Returns​

string

the result string

Inherited from​

AbstractMailer.getName

getOpenApiReplacements()​

getOpenApiReplacements(): any

Defined in: packages/core/src/services/service.ts:413

Return variables for replacement in openapi

Returns​

any

the result

Inherited from​

AbstractMailer.getOpenApiReplacements

getOperationId()​

getOperationId(id): string

Defined in: packages/core/src/services/service.ts:371

If undefined is returned it cancel the operation registration

Parameters​

id​

string

the identifier

Returns​

string

the result

Inherited from​

AbstractMailer.getOperationId

getParameters()​

getParameters(): T

Defined in: packages/core/src/services/service.ts:209

Get the service parameters

Returns​

T

the result

Inherited from​

AbstractMailer.getParameters

getService()​

getService<T>(name): ServicesMap[T]

Defined in: packages/core/src/services/service.ts:300

Get a service by name

Type Parameters​

T​

T extends keyof ServicesMap

Parameters​

name​

T

the name to use

Returns​

ServicesMap[T]

the result map

Deprecated​

Use useService, might reconsider

Inherited from​

AbstractMailer.getService

getState()​

getState(): ServiceStates

Defined in: packages/core/src/services/service.ts:172

Get the current state

Returns​

ServiceStates

the result

Inherited from​

AbstractMailer.getState

getUrl()​

getUrl(url, _methods): string

Defined in: packages/core/src/services/service.ts:348

Return the full path url based on parameters

Parameters​

url​

string

relative url to service

_methods​

HttpMethodType[]

in case we need filtering (like Store)

Returns​

string

absolute url or undefined if need to skip the Route

Inherited from​

AbstractMailer.getUrl

handleNotificationFor()​

handleNotificationFor(user): Promise<boolean>

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

Check if notifications can be delivered to a user via email

Parameters​

user​

User | Ident

User or Ident to check for email availability

Returns​

Promise<boolean>

true if the user has an email address

Inherited from​

AbstractMailer.handleNotificationFor

hasNotification()​

hasNotification(name): boolean

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

Check if an email template exists on the filesystem

Parameters​

name​

string

Template name to check

Returns​

boolean

true if the template directory exists

Overrides​

AbstractMailer.hasNotification

init()​

init(): Promise<Mailer<T>>

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

Initialize the nodemailer transport from the service parameters

Returns​

Promise<Mailer<T>>

this instance after transport creation

Overrides​

AbstractMailer.init

initMetrics()​

initMetrics(): void

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

Returns​

void

Inherited from​

AbstractMailer.initMetrics

initOperations()​

initOperations(): void

Defined in: packages/core/src/services/service.ts:420

Init the operations from

Returns​

void

Operation​

decorators on this service

Inherited from​

AbstractMailer.initOperations

listeners()​

listeners(eventName): Function[]

Defined in: packages/core/src/events/asynceventemitter.ts:183

Get all listeners for an event

Parameters​

eventName​

never

the event name

Returns​

Function[]

the list of results

Inherited from​

AbstractMailer.listeners

loadCapabilities()​

protected loadCapabilities(): void

Defined in: packages/core/src/services/service.ts:270

Load capabilities from webda.module.json metadata into _compiledCapabilities.

Called during resolve after dependency injection. Reads the service's type name from parameters, looks it up in the application's module metadata (moddas or beans section), and populates _compiledCapabilities with an empty object for each declared capability name.

Fails silently if the application is not available (e.g., in unit tests where services are instantiated without a full application context).

Returns​

void

Example​

// If webda.module.json contains:
// { "moddas": { "MyApp/HawkService": { "capabilities": ["request-filter", "cors-filter"] } } }
// Then after resolve(), this.getCapabilities() returns:
// { "request-filter": {}, "cors-filter": {} }

See​

getCapabilities

Inherited from​

AbstractMailer.loadCapabilities

log()​

log(level, ...args): void

Defined in: packages/core/src/services/service.ts:513

Parameters​

level​

WorkerLogLevel

to log

args​

...any[]

additional arguments

Returns​

void

Inherited from​

AbstractMailer.log

off()​

off<Key>(eventName, listener): this

Defined in: packages/core/src/events/asynceventemitter.ts:141

Type Parameters​

Key​

Key extends never

Parameters​

eventName​

Key

the event name

listener​

(event) => void

the event listener

Returns​

this

this for chaining

See​

EventEmitter.off

Inherited from​

AbstractMailer.off

on()​

on<Key>(eventName, listener): this

Defined in: packages/core/src/events/asynceventemitter.ts:119

Type Parameters​

Key​

Key extends never

Parameters​

eventName​

Key

the event name

listener​

(event) => void

the event listener

Returns​

this

this for chaining

See​

EventEmitter.once

Inherited from​

AbstractMailer.on

once()​

once<Key>(eventName, listener): this

Defined in: packages/core/src/events/asynceventemitter.ts:108

Type Parameters​

Key​

Key extends never

Parameters​

eventName​

Key

the event name

listener​

(event) => void

the event listener

Returns​

this

this for chaining

See​

EventEmitter.once

Inherited from​

AbstractMailer.once

removeAllListeners()​

removeAllListeners<Key>(eventName?): this

Defined in: packages/core/src/events/asynceventemitter.ts:150

Type Parameters​

Key​

Key extends never

Parameters​

eventName?​

Key

the event name

Returns​

this

this for chaining

See​

EventEmitter.removeAllListeners

Inherited from​

AbstractMailer.removeAllListeners

removeListener()​

removeListener<Key>(eventName, listener): this

Defined in: packages/core/src/events/asynceventemitter.ts:130

Type Parameters​

Key​

Key extends never

Parameters​

eventName​

Key

the event name

listener​

(event) => void

the event listener

Returns​

this

this for chaining

See​

EventEmitter.removeListener

Inherited from​

AbstractMailer.removeListener

resolve()​

resolve(): this

Defined in: packages/core/src/services/service.ts:236

Resolve parameters and load metadata. @Route-declared routes are scanned and registered by Router.discoverRoutes(services) from Core.init() once every service has resolved — nothing to do per-service here.

Returns​

this

the result

Inherited from​

AbstractMailer.resolve

send()​

send(options, callback?): Promise<any>

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

Send an email using the configured nodemailer transport

If a template is specified in options, it will be rendered with the provided replacements before sending. A now Date variable is automatically added to replacements. Falls back to parameters.sender if no from is provided.

Parameters​

options​

MailerSendOptions

Mail options including optional template and replacements

callback?​

any = undefined

Optional callback passed to nodemailer's sendMail

Returns​

Promise<any>

Promise resolving with the nodemailer send result

Throws​

Error if no transporter is configured or the template is unknown

Overrides​

AbstractMailer.send

sendNotification()​

sendNotification(user, notification, replacements): Promise<void>

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

Send a notification email to a user

Resolves the user's email, increments the sent metric, and delegates to send. Increments the error metric on failure.

Parameters​

user​

User | Ident

User or Ident to send the notification to

notification​

string

Template name for the notification

replacements​

any

Template variables for rendering

Returns​

Promise<void>

Throws​

Error if the user has no valid email address

Inherited from​

AbstractMailer.sendNotification

setMaxListeners()​

setMaxListeners(n): this

Defined in: packages/core/src/events/asynceventemitter.ts:97

Parameters​

n​

number

Returns​

this

Inherited from​

AbstractMailer.setMaxListeners

stop()​

stop(): Promise<void>

Defined in: packages/core/src/services/service.ts:217

Shutdown the current service if action need to be taken

Returns​

Promise<void>

Inherited from​

AbstractMailer.stop

toJSON()​

toJSON(): string

Defined in: packages/core/src/services/service.ts:452

Prevent service to be serialized

Returns​

string

the result

Inherited from​

AbstractMailer.toJSON

toString()​

toString(): string

Defined in: packages/core/src/services/service.ts:225

Return service representation

Returns​

string

the result

Inherited from​

AbstractMailer.toString