Nodejs Nestjs邮件发送插件@nestjs/mail的使用

@nestjs/mail 是一个用于 NestJS 的邮件发送库，它基于 nodemailer。不过请注意，目前 GitHub 上并没有名为 @nestjs/mail 的官方包。你可以通过 @nestjs-modules/mailer 这个模块来实现邮件发送功能。

下面是一个简单的使用示例：

首先，你需要安装必要的依赖包：

npm install @nestjs-modules/mailer @nestjs/throttler nodemailer

然后在你的 NestJS 项目中配置 @nestjs-modules/mailer：

1. 修改 app.module.ts 文件：添加 MailModule 并配置 SMTP 服务。

import { Module } from '@nestjs/common';
import { MailerModule } from '@nestjs-modules/mailer';
import { HandlebarsAdapter } from '@nestjs-modules/mailer/dist/adapters/handlebars.adapter';

@Module({
  imports: [
    MailerModule.forRoot({
      transport: {
        host: 'smtp.yourserver.com', // SMTP 服务器地址
        port: 587, // SMTP 端口
        secure: false,
        auth: {
          user: 'your-email@example.com', // 邮箱账户
          pass: 'your-email-password', // 邮箱密码
        },
      },
      defaults: {
        from: '"nest-modules" <modules@nestjs.com>', // 默认发件人
      },
      template: {
        adapter: new HandlebarsAdapter(),
        options: {
          strict: true,
        },
      },
    }),
  ],
})
export class AppModule {}

1. 创建一个服务 来发送邮件

import { Injectable } from '@nestjs/common';
import { InjectMailer } from '@nestjs-modules/mailer';

@Injectable()
export class MailService {
  constructor(@InjectMailer() private readonly mailer: MailerService) {}

  async sendUserWelcomeEmail() {
    await this.mailer.sendMail({
      to: 'target.email@example.com', // 目标邮箱
      subject: '欢迎注册', // 邮件主题
      template: './welcome', // 模板文件路径
      context: {
        // 替换模板中的变量
        name: 'John Doe',
      },
    });
  }
}

1. 在控制器中调用服务

import { Controller, Get } from '@nestjs/common';
import { MailService } from './mail.service';

@Controller('mail')
export class MailController {
  constructor(private readonly mailService: MailService) {}

  @Get('send')
  async sendMail() {
    return await this.mailService.sendUserWelcomeEmail();
  }
}

确保你的 SMTP 服务器设置正确，并且你有权限访问该服务器。此外，如果你的邮件内容复杂，建议使用模板引擎（如 Handlebars）来构建邮件内容。

@nestjs-mail 并不是官方或广泛使用的插件名称，可能您指的是 nest-email 或其他类似的库。通常使用 nodemailer 作为底层库来实现邮件发送功能。

例如，你可以使用 nest-email 这个库：

1. 安装依赖：

   npm install nest-email nodemailer
   

2. 在你的 NestJS 模块中配置：

   import { EmailModule } from 'nest-email';
   
   [@Module](/user/Module)({
     imports: [
       EmailModule.forRoot({
         transport: {
           host: 'smtp.example.com',
           port: 587,
           secure: false, // true for 465, false for other ports
           auth: {
             user: 'user@example.com', 
             pass: 'yourpassword'
           }
         },
       }),
     ],
   })
   export class AppModule {}
   

3. 使用服务发送邮件：

   import { EmailService } from 'nest-email';
   
   [@Injectable](/user/Injectable)()
   export class AppService {
     constructor(private readonly emailService: EmailService) {}
   
     async sendMail() {
       await this.emailService.sendMail({
         to: 'recipient@example.com',
         subject: 'Hello',
         text: 'This is a test email.',
       });
     }
   }
   

请根据实际使用的库进行相应调整。