Fastify¶
适用于 Fastify(Node.js 18+)应用的集成指南。Mailexam 通过 Nodemailer 作为 SMTP 接入。
勿与 FastAPI 混淆
FastAPI 是 Python 框架。本指南介绍 Node.js 的 Fastify。
前置条件¶
- Mailexam 账户,以及已创建并具备 SMTP 凭据的项目。
- Node.js 18+ 及 npm。
从项目的欢迎邮件(或控制台)中复制:
YOUR_LOGIN— SMTP 登录名(例如xxxxx);YOUR_PASSWORD— SMTP 密码(与登录名成对的唯一凭据);- 主机 —
YOUR_LOGIN.mailexam.cn(与登录名一致)。
1. 依赖¶
package.json:
{
"type": "commonjs",
"scripts": {
"start": "node server.js"
},
"dependencies": {
"dotenv": "^16.0.0",
"fastify": "^5.0.0",
"nodemailer": "^6.9.0"
}
}
2. 环境变量¶
项目根目录的 .env 文件(勿将密码提交到 git):
MAILEXAM_LOGIN=YOUR_LOGIN
MAILEXAM_PASSWORD=YOUR_PASSWORD
MAILEXAM_PORT=587
MAIL_FROM=noreply@example.test
SMTP 主机:YOUR_LOGIN.mailexam.cn。
发件人地址
MAIL_FROM 可以是任意测试地址——邮件进入 Mailexam,而非真实收件人。
备选端口¶
3. Nodemailer 传输¶
// mail.js
const nodemailer = require('nodemailer');
function createTransport() {
const login = process.env.MAILEXAM_LOGIN;
const port = Number(process.env.MAILEXAM_PORT || 587);
return nodemailer.createTransport({
host: `${login}.mailexam.cn`,
port,
secure: port === 465,
auth: {
user: login,
pass: process.env.MAILEXAM_PASSWORD,
},
});
}
async function sendTest({ to, subject, text }) {
const transport = createTransport();
await transport.sendMail({
from: process.env.MAIL_FROM || 'noreply@example.test',
to: to || 'user@example.test',
subject: subject || 'Fastify + Mailexam',
text: text || '来自 Fastify 的 Mailexam 测试',
});
}
module.exports = { sendTest };
4. Fastify 路由¶
// server.js
require('dotenv').config();
const Fastify = require('fastify');
const { sendTest } = require('./mail');
const app = Fastify({ logger: true });
app.post('/mail/test', async (request) => {
const { to, subject, text } = request.body ?? {};
await sendTest({ to, subject, text });
return { status: 'ok' };
});
const start = async () => {
try {
await app.listen({ port: 3000, host: '127.0.0.1' });
} catch (err) {
app.log.error(err);
process.exit(1);
}
};
start();
启动并验证:
curl -X POST http://127.0.0.1:3000/mail/test \
-H 'Content-Type: application/json' \
-d '{"to":"user@example.test","subject":"测试","text":"你好"}'
邮件将出现在 Mailexam 控制台 → 您的项目 → 收件箱。
5. 本地开发与 CI¶
| 环境 | 建议 |
|---|---|
local |
.env + require('dotenv').config() |
| CI | GitLab CI/CD Variables 中的密钥 MAILEXAM_LOGIN、MAILEXAM_PASSWORD |
.gitlab-ci.yml 示例:
variables:
MAILEXAM_LOGIN: $MAILEXAM_LOGIN
MAILEXAM_PASSWORD: $MAILEXAM_PASSWORD
MAILEXAM_PORT: "587"
MAIL_FROM: "noreply@example.test"
集成测试后,通过 Mailexam API 验证投递。
6. 常见问题¶
连接超时 / 认证失败
host须为{login}.mailexam.cn,auth.user— 邮件中的同一登录名。- 登录名和密码为同一项目的邮件成对凭据。
587 端口与 TLS
- 587:
secure: false(STARTTLS)。465:secure: true。
请求体为空
- 发送 JSON 并设置
Content-Type: application/json头。
控制台中看不到邮件
- 查看同一 Mailexam 项目的收件箱。
- SMTP 错误时检查 Fastify 日志(
logger: true)。
参见¶
- 示例目录
- Fastify 实现示例
- Hapi 和 NestJS — 其他 Node.js 框架
- FastAPI — Python,非 Node.js
- Mailexam API 文档
- Fastify 文档