magentaaps/eboks-client

批量发送客户端镜像文档

镜像概述

本镜像为一款专注于批量发送任务的客户端工具，旨在提供高效、便捷的批量发送处理能力，支持多种批量发送场景，帮助用户快速实现消息、通知、邮件等内容的批量分发。

核心功能与特性

• 多场景支持：适配批量消息发送、邮件分发、系统通知推送等多种批量发送需求
• 轻量高效：镜像体积小巧，资源占用低，运行效率高
• 灵活配置：支持通过环境变量或配置文件自定义发送参数，适应不同发送场景
• 批量处理：内置任务队列机制，支持大规模批量发送任务有序执行

使用场景与适用范围

• 企业内部通知批量推送（如员工公告、制度更新通知）
• 营销活动邮件/短信批量发送
• 系统告警信息批量分发（如服务器异常、业务指标告警）
• 各类需要批量触达用户的自动化业务场景

使用方法与配置说明

基本使用流程

1. 准备发送列表文件（包含目标地址、内容等信息）
2. 配置发送服务器参数（地址、端口、认证信息等）
3. 通过Docker命令启动容器，挂载发送列表文件并指定配置参数

Docker Run 命令示例

bash
docker run -d \
  --name batch-sender \
  -e SEND_SERVER=smtp.example.com \
  -e SEND_PORT=587 \
  -e AUTH_USER=sender@example.com \
  -e AUTH_PASSWORD=your_auth_token \
  -v /local/path/to/send_list.txt:/app/send_list.txt \
  -v /local/path/to/templates:/app/templates \
  [镜像名称]:[版本标签]

环境变量配置说明

发送列表文件格式

发送列表文件为文本文件，每行一条发送记录，字段间用逗号分隔，格式示例：

recipient1@example.com,template1,param1=value1;param2=value2
recipient2@example.com,template2,param1=value3;param2=value4

• 第1字段：目标接收地址（如***、手机号）
• 第2字段：内容模板文件名（需放置于TEMPLATE_DIR目录）
• 第3字段：模板参数（键值对形式，用于动态替换模板内容）

配置文件方式

若需更复杂配置，可通过挂载配置文件实现。创建config.yaml文件并挂载至容器/app/config.yaml路径，示例配置：

yaml
server:
  address: smtp.example.com
  port: 587
  timeout: 30s
auth:
  user: sender@example.com
  password: your_auth_token
task:
  send_interval: 1000ms
  concurrent: 5
  retry_count: 3
  retry_interval: 5000ms
paths:
  send_list: /app/send_list.txt
  template_dir: /app/templates
logging:
  level: INFO
  output: /app/logs/sender.log

数据持久化

如需保存发送日志或任务状态，可挂载日志目录：

bash
-v /local/path/to/logs:/app/logs

注意事项

• 发送前需确保发送服务器允许客户端连接，已配置正确的端口和认证信息
• 大规模发送时建议适当调整CONCURRENT_TASKS和SEND_INTERVAL参数，避免触发服务器频率限制
• 敏感信息（如AUTH_PASSWORD）建议通过Docker Secrets或环境变量注入，避免硬编码
• 发送列表文件需确保编码格式为UTF-8，避免中文乱码问题