A mailer module for Nest framework (node.js) using Nodemailer library

Installation

npm install --save @nest-modules/mailer

Usage

Import the MailerModule into the root AppModule.

1//app.module.ts
2import { Module } from '@nestjs/common';
3import { HandlebarsAdapter, MailerModule } from '@nest-modules/mailer';
4
5@Module({
6  imports: [
7    MailerModule.forRoot({
8      transport: 'smtps://user@domain.com:pass@smtp.domain.com',
9      defaults: {
10        from:'"nest-modules" <modules@nestjs.com>',
11      },
12      template: {
13        dir: __dirname + '/templates',
14        adapter: new HandlebarsAdapter(), // or new PugAdapter()
15        options: {
16          strict: true,
17        },
18      },
19    }),
20  ],
21})
22export class AppModule {}

Of course, it is possible to use an async configuration:

1//app.module.ts
2import { Module } from '@nestjs/common';
3import { HandlebarsAdapter, MailerModule } from '@nest-modules/mailer';
4
5@Module({
6  imports: [
7    MailerModule.forRootAsync({
8      useFactory: () => ({
9        transport: 'smtps://user@domain.com:pass@smtp.domain.com',
10        defaults: {
11          from:'"nest-modules" <modules@nestjs.com>',
12        },
13        template: {
14          dir: __dirname + '/templates',
15          adapter: new HandlebarsAdapter(), // or new PugAdapter()
16          options: {
17            strict: true,
18          },
19        },
20      }),
21    }),
22  ],
23})
24export class AppModule {}

Afterwards, MailerService will be available to inject across entire project (without importing any module elsewhere), for example in this way:

1import { Injectable } from '@nestjs/common';
2import { MailerService } from '@nest-modules/mailer';
3
4@Injectable()
5export class ExampleService {
6  constructor(private readonly mailerService: MailerService) {}
7}

MailerProvider exports the sendMail() function to which you can pass the message options (sender, email subject, recipient, body content, etc)

sendMail() accepts the same fields as nodemailer email message

1import { Injectable } from '@nestjs/common';
2import { MailerService } from '@nest-modules/mailer';
3
4@Injectable()
5export class ExampleService {
6  constructor(private readonly mailerService: MailerService) {}
7  
8  public example(): void {
9    this
10      .mailerService
11      .sendMail({
12        to: 'test@nestjs.com', // list of receivers
13        from: 'noreply@nestjs.com', // sender address
14        subject: 'Testing Nest MailerModule ✔', // Subject line
15        text: 'welcome', // plaintext body
16        html: '<b>welcome</b>', // HTML body content
17      })
18      .then(() => {})
19      .catch(() => {});
20  }
21  
22  public example2(): void {
23    this
24      .mailerService
25      .sendMail({
26        to: 'test@nestjs.com',
27        from: 'noreply@nestjs.com',
28        subject: 'Testing Nest Mailermodule with template ✔',
29        template: 'welcome', // The `.pug` or `.hbs` extension is appended automatically.
30        context: {  // Data to be sent to template engine.
31          code: 'cf1a3f828287',
32          username: 'john doe',
33        },
34      })
35      .then(() => {})
36      .catch(() => {});
37  }
38  
39  public example3(): void {
40    this
41      .mailerService
42      .sendMail({
43        to: 'test@nestjs.com',
44        from: 'noreply@nestjs.com',
45        subject: 'Testing Nest Mailermodule with template ✔',
46        template: __dirname + '/welcome', // The `.pug` or `.hbs` extension is appended automatically.
47        context: {  // Data to be sent to template engine.
48          code: 'cf1a3f828287',
49          username: 'john doe',
50        },
51      })
52      .then(() => {})
53      .catch(() => {});
54  }
55}

Contributing

• Paweł Partyka
• Cristiam Diaz
• Pat McGowan
• juandav

License

MIT