📝Email

The module that handles the email delivery.

Imports

Service

import { EmailService } from 'niro-health';

Module

import { EmailModule } from 'niro-health';

Interface

import type { IEmailService } from 'niro-health';

Environment Variables

SMTP

name	description
SMTP_HOST	The SMTP host.
SMTP_PORT	The SMTP port.
SMTP_SECURE	The SMTP secure.
SMTP_USERNAME	The SMTP username.
SMTP_PASSWORD	The SMTP password.

Write .env file with environment variable. Below has an example:

.env

SMTP_HOST="smtp.mail.com"
SMTP_PORT="587"
SMTP_SECURE="false"
SMTP_USERNAME="[e-mail]"
SMTP_PASSWORD="YOUR_SMTP_PASSWORD"

AWS

name	description
AWS_ACCESS_KEY_ID	The AWS access key id.
AWS_SECRET_ACCESS_KEY	The AWS secret access key.

Write .env file with environment variable. Below has an example:

.env

AWS_ACCESS_KEY_ID="AKIA56N57H7KHQVADY55"
AWS_SECRET_ACCESS_KEY="zbVU1PUZFeNbrW0sAP2uG3qRUjT8yD5hqnmhrCr1"

Method of Use

To use this module, you need to inject it into the desired service.

import { Module } from '@nestjs/common';
import {
  EmailService,
  ConfigurationService,
  ValidatorRegexpService,
  StringExService,
  AwsCoreService,
  AwsConfigurationService,
  AwsStsService,
} from 'niro-health';
import { AppController } from './app.controller';
import { AppService } from './app.service';

@Module({
  controllers: [AppController],
  providers: [
    AppService,
    {
      provide: 'IEmailService',
      useClass: EmailService,
    },
    {
      provide: 'IConfigurationService',
      useClass: ConfigurationService,
    },
    {
      provide: 'IValidatorRegexpService',
      useClass: ValidatorRegexpService,
    },
    {
      provide: 'IStringExService',
      useClass: StringExService,
    },
    {
      provide: 'IAwsCoreService',
      useClass: AwsCoreService,
    },
    {
      provide: 'IAwsConfigurationService',
      useClass: AwsConfigurationService,
    },
    {
      provide: 'IAwsStsService',
      useClass: AwsStsService,
    },
  ],
})
export class AppModule {}

Injecting the module into our service.

import { Inject, Injectable } from '@nestjs/common';
import type { IEmailService } from 'niro-health';

@Injectable()
export class AppService {
  constructor(
    @Inject('IEmailService')
    private readonly emailService: IEmailService,
  ) {}

  async test() {
    return await this.emailService.test(
      {
          subject: 'Testing application',
          to: ['[e-mail]'],
      },
      'email-test',
    );
  }
}

With dependencies

You will need to inject the following interfaces.

Interface	Service
IConfigurationService	Link to Service documentation
IValidatorRegexpService	Link to Service documentation
IStringExService	Link to Service documentation
IAwsCoreService	Link to Service documentation
IAwsConfigurationService	Link to Service documentation
IAwsStsService	Link to Service documentation

Properties

Property	Scope	Description
_pathTemplates	private	The path where the templates are located.
_strategy	private	The strategy to use to send the email.
_from	private	The sender of the email.
_priority	private	The priority of the email.
_cc	private	The CC (Carbon Copy) of the email.
_cco	private	The CCO (Carbon Copy Hidden) of the email.
get pathTemplates	public	Set the path where the templates are located.
get pathTemplates	public	Get the path where the templates are located.
set strategy	public	Set the strategy to use to send the email.
get strategy	public	Get the strategy to use to send the email.
set from	public	Set the sender of the email.
get from	public	Get the sender of the email.
set priority	public	Set the priority of the email.
get priority	public	Get the priority of the email.
set cc	public	Set the CC (Carbon Copy) of the email.
get cc	public	Get the CC (Carbon Copy) of the email.
set cco	public	Set the CCO (Carbon Copy Hidden) of the email.
get cco	public	Get the CCO (Carbon Copy Hidden) of the email.

Methods

Method	Scope	Description
resetCC	public	Reset list the CC (Carbon Copy) of the email.
resetCCO	public	Reset list the CCO (Carbon Copy Hidden) of the email.
test	public	Send a test email.
send	public	Send an email.