Nodemailer 技术文档

1. 安装指南

1.1 安装 Node.js

在使用 Nodemailer 之前，请确保你已经安装了 Node.js。Nodemailer 支持 Node.js 6.0.0 及以上版本。你可以通过以下命令检查 Node.js 是否已安装：

node -v

如果未安装，请访问 Node.js 官方网站 下载并安装适合你操作系统的版本。

1.2 安装 Nodemailer

使用 npm 安装 Nodemailer：

npm install nodemailer

2. 项目的使用说明

2.1 基本用法

Nodemailer 是一个用于从 Node.js 发送电子邮件的库。以下是一个简单的示例，展示如何使用 Nodemailer 发送邮件：

const nodemailer = require('nodemailer');

// 创建一个 SMTP 传输对象
let transporter = nodemailer.createTransport({
    host: 'smtp.example.com',
    port: 587,
    secure: false, // true for 465, false for other ports
    auth: {
        user: '[e-mail]',
        pass: 'password'
    }
});

// 定义邮件选项
let mailOptions = {
    from: '"发件人" <[e-mail]>',
    to: '[e-mail]',
    subject: 'Hello ✔',
    text: '这是一封测试邮件',
    html: '<b>这是一封测试邮件</b>'
};

// 发送邮件
transporter.sendMail(mailOptions, (error, info) => {
    if (error) {
        return console.log(error);
    }
    console.log('Message sent: %s', info.messageId);
});

2.2 使用 Gmail

如果你使用 Gmail 发送邮件，请注意 Gmail 的限制。你可以参考 Gmail 使用指南 获取更多信息。

2.3 处理常见问题

• SyntaxError: 如果你遇到 SyntaxError，请确保你使用的是 Node.js 6.0.0 及以上版本。
• ETIMEDOUT 错误: 检查防火墙设置，确保端口未被阻止。
• TLS 错误: 确保 secure 选项设置正确，并检查 Node.js 的 TLS 支持。

3. 项目 API 使用文档

3.1 createTransport(options)

创建一个 SMTP 传输对象。options 参数包含以下字段：

• host: SMTP 服务器地址。
• port: SMTP 服务器端口。
• secure: 是否使用 SSL/TLS。
• auth: 认证信息，包含 user 和 pass。

3.2 sendMail(mailOptions, callback)

发送邮件。mailOptions 参数包含以下字段：

• from: 发件人地址。
• to: 收件人地址。
• subject: 邮件主题。
• text: 邮件文本内容。
• html: 邮件 HTML 内容。

callback 函数在邮件发送完成后调用，包含 error 和 info 参数。

4. 项目安装方式

4.1 通过 npm 安装

使用以下命令安装 Nodemailer：

npm install nodemailer

4.2 手动下载

你也可以从 GitHub 下载源代码，并手动安装依赖。

---

通过以上文档，你应该能够顺利安装和使用 Nodemailer 发送电子邮件。如果在使用过程中遇到问题，请参考官方文档或访问 Stack Overflow 寻求帮助。