发布一个可以独立部署的Nodejs邮件队列模块

发布一个可以独立部署的Node.js邮件队列模块

摘要

主要的想法是把邮件发送功能从主站中分离出来，适合中小网站。这样可以有效减少主站的负载，并确保邮件发送的可靠性。更多详细信息请参见GitHub。

特性

1. 支持多种语言的模板渲染：用户可以根据需要选择不同的模板引擎来渲染邮件内容。
2. 支持对请求端进行IP与Token的校验：确保只有授权的客户端能够提交邮件发送任务。
3. 收到发送任务后，会将任务存入到MongoDB，然后顺序执行发送任务：确保任务的可靠性和顺序性。

安装

这个模块可以通过npm进行安装：

npm install mail-queuer

示例代码

邮件队列服务端（使用Express）

首先，我们需要设置一个简单的Express应用来接收邮件发送请求：

const express = require('express');
const bodyParser = require('body-parser');
const MailQueue = require('mail-queuer');
const app = express();

// 初始化MailQueue
const mailQueue = new MailQueue({
    mongoUri: 'mongodb://localhost:27017/mailqueue',
    templateEngine: 'ejs'
});

app.use(bodyParser.json());

app.post('/send-mail', (req, res) => {
    const { to, subject, template, data } = req.body;

    // IP与Token校验
    if (!req.headers['x-forwarded-for'] || !req.headers['authorization']) {
        return res.status(401).json({ error: 'Unauthorized' });
    }

    // 将邮件任务添加到队列
    mailQueue.addTask({
        to,
        subject,
        template,
        data
    }).then(() => {
        res.json({ success: true });
    }).catch(err => {
        console.error(err);
        res.status(500).json({ error: 'Failed to add task' });
    });
});

const PORT = process.env.PORT || 3000;
app.listen(PORT, () => {
    console.log(`Server is running on port ${PORT}`);
});

邮件队列处理脚本

为了处理存储在MongoDB中的任务，我们可以编写一个单独的脚本来定期检查并发送这些任务：

const MailQueue = require('mail-queuer');

const mailQueue = new MailQueue({
    mongoUri: 'mongodb://localhost:27017/mailqueue',
    templateEngine: 'ejs'
});

async function processTasks() {
    const tasks = await mailQueue.getPendingTasks();
    for (const task of tasks) {
        try {
            await mailQueue.sendMail(task);
            await mailQueue.markAsSent(task._id);
        } catch (err) {
            console.error(err);
            // 可以根据实际情况决定是否重试或记录错误
        }
    }
}

setInterval(processTasks, 60 * 1000); // 每分钟检查一次

GitHub

该项目托管在GitHub上，欢迎贡献和反馈： https://github.com/conis/mail-queuer

这种架构设计不仅可以减轻主站的压力，还能提高邮件发送的稳定性和可靠性。希望这个模块能帮助到你！