Class EmailService

Hierarchy

BaseNotificationService
- EmailService

Index

Constructors

constructor

Properties

Methods

isReady
send

Constructors

constructor

new EmailService(options?: EmailServiceOptions): EmailService

Overrides BaseNotificationService.constructor
- Defined in email/EmailService.ts:43
Instantiates a new email service instance.

Parameters
- Default value options: EmailServiceOptions = {}
  
  The email service options
Returns EmailService

Properties

name

name: string

The service name for verbose logging.

Protected options

options: EmailServiceOptions

The email service options

Protected Optional templateEngine

templateEngine: Template

Protected Optional transporter

transporter: nodemailer.Transporter

Methods

isReady

isReady(): Promise<boolean>

- Defined in email/EmailService.ts:93
Verifies if the SMTP connection is OK.

Returns Promise<boolean>

send

send(message: EmailMessageSchema): Promise<any>

Overrides BaseNotificationService.send
- Defined in email/EmailService.ts:112
Sends an email message.

Parameters
- message: EmailMessageSchema
  
  The message options
Returns Promise<any>

Generated using TypeDoc