unemail 项目使用教程

1. 项目的目录结构及介绍

unemail 是一个轻量级的 TypeScript 邮件发送库，支持多种邮件服务提供商。以下是项目的目录结构及其介绍：

unemail/
├── .github/              # GitHub 工作流程和配置文件
├── playground/           # 演示和示例代码
├── scripts/              # 脚本文件
├── src/                  # 源代码目录
│   ├── providers/        # 邮件服务提供商的实现
│   ├── utils/            # 实用工具函数
│   └── index.ts          # 主入口文件
├── test/                 # 测试文件
├── .env.example          # 环境变量示例文件
├── .gitignore            # Git 忽略文件
├── LICENSE               # 项目许可证文件
├── README.md             # 项目说明文件
├── build.config.ts       # 构建配置文件
├── eslint.config.mjs     # ESLint 配置文件
├── package.json          # 项目包配置文件
├── pnpm-lock.yaml        # pnpm 锁文件
├── pnpm-workspace.yaml   # pnpm 工作空间配置文件
└── renovate.json         # Renovate 配置文件

2. 项目的启动文件介绍

src/index.ts 是项目的启动文件，它包含了创建邮件服务的主要功能。以下是启动文件的基本内容：

export { createEmailService } from './emailService';

这个文件导出了创建邮件服务的主要函数 createEmailService，用户可以通过这个函数创建一个邮件服务实例。

3. 项目的配置文件介绍

项目的配置文件主要包括 .env.example 和 src/utils/config.ts。

• .env.example 文件包含了一些环境变量的示例，这些环境变量可以被用来配置不同的邮件服务提供商。例如：

API_KEY=your-api-key
ENDPOINT=https://api.example.com/email

• src/utils/config.ts 文件负责读取环境变量并返回配置对象。以下是配置文件的基本内容：

// config.ts
import { config } from 'dotenv';

config(); // 加载环境变量

const emailConfig = {
  apiKey: process.env.API_KEY,
  endpoint: process.env.ENDPOINT,
  // 其他配置...
};

export default emailConfig;

在项目的实际使用中，用户需要根据自己选择的服务提供商来配置这些环境变量，以确保邮件服务能够正确地发送邮件。