magentaaps/os2mo-smtp

MO-Email agent Docker镜像文档

镜像概述

MO-Email agent是一款基于Docker的轻量级邮件代理工具，旨在提供简单、高效的邮件处理能力。该镜像封装了邮件代理核心功能，可快速部署为独立服务，用于处理邮件的发送、接收、转发及协议转换，支持SMTP、POP3、IMAP等主流邮件协议，适用于需要集成邮件功能的应用系统、自动化通知工具及邮件流量管理场景。

核心功能和特性

核心功能

• 多协议支持：兼容SMTP（邮件发送）、POP3（邮件接收）、IMAP（邮件访问）等主流邮件协议，满足不同邮件交互需求。
• 邮件转发：支持基于规则的邮件转发，可根据发件人、收件人、主题等条件自动转发邮件至指定地址。
• 轻量级设计：镜像体积小，资源占用低，可在低配置环境中稳定运行。

主要特性

• 简单配置：通过环境变量或配置文件即可完成基础配置，无需复杂的系统级设置。
• 安全加密：支持TLS/SSL加密传输，保障邮件数据在传输过程中的安全性。
• 日志记录：内置日志模块，记录邮件处理过程、错误信息及访问日志，便于问题排查。
• 高可用性：支持多实例部署，可通过负载均衡实现邮件服务的高可用。

使用场景

典型应用场景

• 自动化邮件通知：集成到监控系统、CI/CD工具中，用于发送告警通知、构建结果等自动化邮件。
• 应用程序邮件集成：为无内置邮件功能的应用提供邮件发送能力，如ERP系统、CRM系统的邮件通知模块。
• 邮件转发服务：作为中间代理，转发不同邮件服务器间的邮件流量，解决跨域邮件投递问题。
• 测试环境邮件隔离：在测试环境中部署，拦截或重定向测试邮件，避免测试邮件发送至真实用户。

使用方法

前提条件

• 已安装Docker Engine（20.10+）或Docker Desktop。
• 已安装Docker Compose（如需使用compose部署）。

Docker Run 部署

通过docker run命令快速启动MO-Email agent容器：

bash
docker run -d \
  --name mo-email-agent \
  -p 25:25 \          # SMTP端口映射（默认25）
  -p 110:110 \        # POP3端口映射（默认110）
  -p 143:143 \        # IMAP端口映射（默认143）
  -e SMTP_PORT=25 \   # 容器内SMTP服务端口（默认25）
  -e POP3_PORT=110 \  # 容器内POP3服务端口（默认110）
  -e IMAP_PORT=143 \  # 容器内IMAP服务端口（默认143）
  -e TLS_ENABLED=true \  # 启用TLS加密（默认false）
  -v ./config:/app/config \  # 挂载配置文件目录（可选，优先级高于环境变量）
  -v ./logs:/app/logs \      # 挂载日志目录（可选）
  mo-email-agent:latest

Docker Compose 部署

创建docker-compose.yml文件，通过Compose一键部署：

yaml
version: '3.8'
services:
  mo-email-agent:
    image: mo-email-agent:latest
    container_name: mo-email-agent
    ports:
      - "25:25"   # SMTP端口
      - "110:110" # POP3端口
      - "143:143" # IMAP端口
    environment:
      - SMTP_PORT=25
      - POP3_PORT=110
      - IMAP_PORT=143
      - TLS_ENABLED=true
      - LOG_LEVEL=info  # 日志级别：debug/info/warn/error（默认info）
    volumes:
      - ./config:/app/config  # 配置文件目录（本地目录需提前创建）
      - ./logs:/app/logs      # 日志目录（本地目录需提前创建）
    restart: unless-stopped  # 容器退出时自动重启（除非手动停止）

启动命令：

bash
docker-compose up -d

配置参数说明

环境变量

配置文件（可选）

若需更复杂的配置（如自定义转发规则、邮件过滤等），可通过挂载配置文件实现。配置文件默认路径为容器内/app/config/config.yaml，本地目录需提前创建该文件并挂载（如上述部署命令中的-v ./config:/app/config）。

示例config.yaml结构：

yaml
# 邮件转发规则
forward_rules:
  - from: "alerts@example.com"       # 匹配发件人
    to: "admin@example.com"          # 转发目标地址
    subject_contains: "ERROR"        # 主题包含关键词（可选）
# 邮件过滤
filter:
  block_senders: ["spam@example.com"] # 阻止发件人列表
  allow_subjects: ["^Order.*"]        # 允许主题正则（可选）

容器管理

查看日志

bash
docker logs -f mo-email-agent  # 实时查看日志

停止/重启容器

bash
docker stop mo-email-agent     # 停止容器
docker restart mo-email-agent  # 重启容器

卸载容器

bash
docker rm -f mo-email-agent    # 删除容器（-f强制删除运行中容器）

常见问题

Q：邮件发送失败，如何排查？

A：1. 检查容器日志：docker logs mo-email-agent，查看是否有连接错误或认证失败信息；2. 确认SMTP端口映射是否正确，宿主机防火墙是否开放对应端口；3. 若启用TLS，检查客户端是否支持TLS连接。

Q：如何更新镜像？

A：1. 拉取最新镜像：docker pull mo-email-agent:latest；2. 停止并删除旧容器：docker rm -f mo-email-agent；3. 重新执行部署命令启动新容器。