andris9/emailengine

EmailEngine Email API

镜像概述和主要用途

EmailEngine是一款无头（Headless）邮件客户端应用，核心功能是将IMAP和SMTP资源通过REST API开放，使开发者能够轻松将邮件账户集成到各类服务中，实现邮件同步、发送及相关管理操作。

核心功能和特性

• 无头架构设计，无需图形界面即可运行
• 通过REST API提供IMAP和SMTP资源访问能力
• 支持邮件同步与发送功能
• 内置管理界面与监控工具
• 与Redis集成作为数据存储

使用场景和适用范围

• 同步用户邮件到自有服务并代表用户发送邮件
• 将应用与特定邮件账户集成（如支持***、通知***等）
• 监控测试***账户的收件箱和垃圾邮件文件夹，分析发送邮件的送达位置
• 开发轻量级网页邮件或移动邮件应用，无需直接处理IMAP和MIME协议

快速启动

• 设置说明

截图

!EmailEngine界面截图1 !EmailEngine界面截图2 !EmailEngine界面截图3

版本和许可

运行以下命令查看EmailEngine及其包含模块的版本和许可信息：

bash
$ emailengine license

系统要求

• Redis – 任何版本

Windows系统无官方Redis版本，可使用替代方案如Memurai。

提示：尽量降低EmailEngine与Redis之间的延迟，建议在同一台机器或同一数据中心运行。同步文件夹时，EmailEngine会为每个邮件执行单独的Redis命令，若延迟较高，同步大量邮件的文件夹会耗时较长。

文档

• API参考
• 博客文章
• Postman用户可导入OpenAPI规范此处

配置EmailEngine

有关配置EmailEngine的详细文档，请参见此处。

应用访问

默认情况下，EmailEngine仅允许本地主机（localhost）连接。如需允许外部访问，可编辑配置文件或使用命令行选项--api.host="0.0.0.0"。启用外部访问后，建议使用防火墙或代理限制仅受信任来源访问。

部署

Ubuntu或Debian

可使用官方安装脚本完成以下设置：

• EmailEngine作为SystemD服务
• Caddy作为反向代理和HTTPS证书处理程序

bash
$ wget https://raw.githubusercontent.com/postalsys/emailengine/master/install.sh
$ chmod +x install.sh
$ ./install.sh example.com

其中example.com是EmailEngine的域名。

注意：已在Ubuntu 20.04和Debian 11上测试，可能不适用于其他操作系统版本。

SystemD

有关将EmailEngine作为SystemD服务运行的详细信息，请参见此处。

Docker

!Docker镜像大小（标签）

有关使用Docker运行EmailEngine的详细文档，请参见此处。

Redis问题解决

EmailEngine使用Redis作为数据存储，Redis将所有数据存储在RAM中。若出现异常，可能导致Redis空间耗尽，使应用无法使用。可通过以下工具排查：

1. Bull队列检查：通过内置Bull Arena UI查看队列状态，访问[***]
2. 键空间扫描：使用以下命令按类型分组扫描Redis键（需与主应用使用相同数据库配置）：

bash
$ emailengine scan > keyspace.csv

监控

应用的/metrics路径提供Prometheus格式的监控指标输出。

日志分析

有关日志配置选项，请参见此处。

如需跟踪特定账户的IMAP流量，可运行：

bash
$ npm run raw -- --filter.account=account1

安全与数据合规

详细信息请参见此处。

许可

本软件根据商业EmailEngine许可授权。