marlonb/mailcrab

MailCrab

用于开发环境的电子邮件测试服务器，使用Rust编写。

受https://github.com/mailhog/MailHog%E5%92%8CMailCatcher%E5%90%AF%E5%8F%91%E3%80%82

MailCrab最初是作为Rust练习创建的，尝试了Axum和Yew功能组件，但最重要的是因为编写Rust代码非常有趣。

TLDR

docker run --rm -p 1080:1080 -p 1025:1025 docker.xuanyuan.run/marlonb/mailcrab:latest

特性

• 接受所有邮件的SMTP服务器
• Web界面用于查看和检查所有传入电子邮件
• 查看格式化邮件、下载附件、查看邮件头信息或完整原始邮件内容
• 通过Docker运行在所有amd64和arm64平台
• 仅7.77 MB的Docker镜像

!https://raw.githubusercontent.com/tweedegolf/mailcrab/main/frontend/img/screen.png

技术概述

后端服务器和前端均使用Rust编写。后端通过可配置端口上的未加密连接接收电子邮件。所有邮件在应用运行期间存储在内存中。API公开所有接收的邮件：

• /api/messages 返回所有邮件元数据
• /api/message/[id] 根据id返回完整邮件
• /ws 当收到新邮件时，向每个连接的客户端发送邮件元数据

前端最初调用/api/messages获取所有现有邮件元数据，然后通过WebSocket连接订阅新邮件。打开邮件时，使用/api/message/[id]端点检索完整邮件正文和原始邮件内容。

后端还通过WebSocket接受一些命令，用于将邮件标记为已读、删除单封邮件或删除所有邮件。

安装和使用

运行MailCrab只需Docker。使用以下命令启动MailCrab：

docker run --rm -p 1080:1080 -p 1025:1025 docker.xuanyuan.run/marlonb/mailcrab:latest

打开浏览器并导航至http://localhost:1080%E4%BB%A5%E6%9F%A5%E7%9C%8BWeb%E7%95%8C%E9%9D%A2%E3%80%82

默认SMTP端口为1025，默认HTTP端口为1080。您可以使用环境变量（SMTP_PORT和HTTP_PORT）配置SMTP和HTTP端口，或通过Docker端口映射暴露不同端口：

docker run --rm -p 3000:1080 -p 2525:1025 docker.xuanyuan.run/marlonb/mailcrab:latest

在docker-compose.yml文件中的使用：

version: "3.8"
services:
    mailcrab:
        image: docker.xuanyuan.run/marlonb/mailcrab:latest
        ports:
            - "1080:1080"
            - "1025:1025"
        networks: [default]

开发

安装https://www.rust-lang.org/learn/get-started%E5%92%8CTrunk

# 克隆代码
git clone ***:tweedegolf/mailcrab.git

# 启动后端
cd backend
cargo run

# 启动前端（在新终端窗口中）
cd ../frontend
trunk serve

# 可选：定期发送测试消息
cd ../backend
cargo test