Class EmailNotifier

description: The main service of the EmailNotifier module.
since: v0.3.2

Hierarchy

EmailNotifier

Implements

Notifier

Index

Constructors

constructor

Properties

enableMailer

Methods

Constructors

constructor

new EmailNotifier(configService: ConfigService<Record<string, unknown>, false>, mailerService: MailerService): EmailNotifier

- Defined in src/notifier/services/EmailNotifier.ts:38
The constructor of the service.

Parameters
- configService: ConfigService<Record<string, unknown>, false>
- mailerService: MailerService
Returns EmailNotifier

Properties

Private enableMailer

enableMailer: boolean

Methods

sendInternal

sendInternal(emailDetails: ISendMailOptions): Promise<any>

Implementation of Notifier.sendInternal
- Defined in src/notifier/services/EmailNotifier.ts:53
Method to send email notifications internally.

async
Parameters
- emailDetails: ISendMailOptions
  
  The necessary details for the notification.
Returns Promise<any>

sendPublic

sendPublic(emailDetails: ISendMailOptions): Promise<any>

Implementation of Notifier.sendPublic
- Defined in src/notifier/services/EmailNotifier.ts:70
Method to send email notifications publicly.

async
Parameters
- emailDetails: ISendMailOptions
  
  The necessary details for the notification.
Returns Promise<any>

Generated using TypeDoc