NestJS Mailer 模块使用教程

2024-09-16 08:38:07作者：廉彬冶Miranda

1. 项目目录结构及介绍

NestJS Mailer 模块的目录结构如下：

nest-mailer/
├── src/
│   ├── app.module.ts
│   ├── mailer/
│   │   ├── mailer.module.ts
│   │   ├── mailer.service.ts
│   │   └── mailer.controller.ts
│   ├── main.ts
├── config/
│   ├── mailer.config.ts
├── package.json
├── tsconfig.json
└── README.md

目录结构说明：

src/: 项目源代码目录。
- app.module.ts: 应用的主模块文件，负责导入和配置其他模块。
- mailer/: Mailer 模块的目录，包含与邮件发送相关的代码。
  - mailer.module.ts: Mailer 模块的定义文件，负责导入和配置 Mailer 服务。
  - mailer.service.ts: Mailer 服务的实现文件，包含邮件发送的具体逻辑。
  - mailer.controller.ts: Mailer 控制器的实现文件，处理与邮件发送相关的 HTTP 请求。
- main.ts: 项目的启动文件，负责启动 NestJS 应用。
config/: 配置文件目录。
- mailer.config.ts: Mailer 模块的配置文件，包含邮件服务器的配置信息。
package.json: 项目的依赖管理文件，包含项目的依赖和脚本。
tsconfig.json: TypeScript 配置文件，定义 TypeScript 编译选项。
README.md: 项目的说明文档，包含项目的介绍、安装和使用说明。

2. 项目的启动文件介绍

`main.ts`

main.ts 是 NestJS 应用的启动文件，负责启动应用并监听指定端口。以下是 main.ts 的示例代码：

import { NestFactory } from '@nestjs/core';
import { AppModule } from './app.module';

async function bootstrap() {
  const app = await NestFactory.create(AppModule);
  await app.listen(3000);
}
bootstrap();

启动文件说明：

NestFactory.create(AppModule): 创建 NestJS 应用实例，传入应用的主模块 AppModule。
app.listen(3000): 启动应用并监听 3000 端口。

3. 项目的配置文件介绍

`mailer.config.ts`

mailer.config.ts 是 Mailer 模块的配置文件，包含邮件服务器的配置信息。以下是 mailer.config.ts 的示例代码：

export default {
  transport: {
    host: 'smtp.example.com',
    port: 587,
    secure: false,
    auth: {
      user: 'your-email@example.com',
      pass: 'your-password',
    },
  },
  defaults: {
    from: '"No Reply" <noreply@example.com>',
  },
};

配置文件说明：

transport: 邮件服务器的配置信息。
- host: 邮件服务器的主机地址。
- port: 邮件服务器的端口号。
- secure: 是否使用 SSL/TLS 加密连接。
- auth: 邮件服务器的认证信息，包含用户名和密码。
defaults: 默认的邮件发送配置。
- from: 默认的发件人地址。