Skip to content

This is a simple wrapper of node-ses. It only comtemplates the send email functionality, but later it will be added more. Just ping me or open pull request and contribute :)

License

Notifications You must be signed in to change notification settings

NextNC/nestjs-ses

Repository files navigation

NestJS SES (AWS emails)

NPM Version Package License NPM Downloads

Introduction

This is a simple wrapper of node-ses. It only comtemplates the send email functionality, but later it will be added more. Just ping me or open pull request and contribute :)

Installation

npm install @nextnm/nestjs-ses

Usage

Importing module

import { SesModule } from '@nextnm/nestjs-ses';
@Module({
  imports: [
    SesModule.forRoot({
      secret: '<YOUR SECRET>',
      apiKey: '<YOUR API_KEY>',
      region: 'eu-west-1',
    }),
  ],
  providers: [],
  exports: [],
})
export class YourModule {}

Interfaces

interface EmailOptions {
  from: string;
  to: string;
  subject: string;
  html?: string;
  replyTo?: string;
  cc: string;
  bcc: string[];
  altText?: string;
}

Calling Send Method

import { SesService } from '@nextnm/nestjs-ses';
import { SesEmailOptions } from '@nextnm/nestjs-ses'

@Injectable()
export class YourService {
  constructor(private sesService: SesService) {
    const options: SesEmailOptions = {
      from:'',
      to:'',
      subject:'',
      html:'',
      replyTo:'',
      cc:'',
      bcc:'',
      altText:'',
    };

    await this.sesService.sendEmail(options);
  }

Contributing

Contributions welcome! See Contributing.

Notes

This project is not endorsed by or affiliated with AWS.

Author

Nuno Carvalhão Site

License

Licensed under the MIT License - see the LICENSE file for details.

About

This is a simple wrapper of node-ses. It only comtemplates the send email functionality, but later it will be added more. Just ping me or open pull request and contribute :)

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published