digiserve/ab-notification-email

ab_service_notification_email 镜像文档

镜像概述和主要用途

ab_service_notification_email 是一个专注于通过SMTP协议发送通知的服务镜像。该镜像旨在提供一个轻量级、可配置的解决方案，用于处理系统、应用或服务产生的各类通知消息，并通过标准SMTP协议将这些消息发送至指定的***地址，实现通知的自动化传递。

核心功能和特性

核心功能

• 支持SMTP协议发送通知消息，兼容标准SMTP服务器。

主要特性

• 配置灵活：支持通过环境变量或配置文件设置SMTP服务器地址、端口、认证信息等核心参数。
• 轻量级设计：基于精简基础镜像构建，资源占用低，部署高效。
• 易于集成：可快速与现有系统、应用或自动化流程集成，无需复杂依赖。
• 兼容性强：兼容主流SMTP服务器（如SendGrid、Gmail SMTP、企业自建SMTP服务器等）。

使用场景和适用范围

使用场景

• 系统告警通知：服务器异常、资源超限（CPU/内存/磁盘使用率过高）、服务崩溃等系统级告警消息的发送。
• 应用事件通知：用户注册成功、订单状态变更、密码重置请求、账号异常登录等应用内事件通知。
• 服务状态通知：服务启动/停止、定时任务执行结果、数据同步状态等服务运行状态通知。

适用范围

适用于各类需要通过邮件形式发送通知的系统、应用、服务或自动化流程，尤其适合对通知发送有标准化、自动化需求的场景。

使用方法和配置说明

基本使用（docker run 命令）

通过环境变量配置SMTP参数并启动服务：

bash
docker run -d \
  --name ab-service-notification-email \
  -e SMTP_HOST=smtp.example.com \
  -e SMTP_PORT=587 \
  -e SMTP_USER=your-email@example.com \
  -e SMTP_PASSWORD=your-smtp-password \
  -e SMTP_FROM=notifications@example.com \
  docker.xuanyuan.run/ab_service_notification_email

Docker Compose 配置示例

创建 docker-compose.yml 文件，配置服务参数：

yaml
version: '3'
services:
  notification-email:
    image: docker.xuanyuan.run/ab_service_notification_email
    container_name: ab-service-notification-email
    environment:
      - SMTP_HOST=smtp.example.com  # SMTP服务器地址（必填）
      - SMTP_PORT=587               # SMTP服务器端口（默认：25；SSL通常为465，TLS通常为587）
      - SMTP_USER=your-email@example.com  # SMTP认证用户名（必填，通常为发件人邮箱）
      - SMTP_PASSWORD=your-smtp-password  # SMTP认证密码（必填，部分服务商为应用专用密码）
      - SMTP_FROM=notifications@example.com  # 发件人邮箱地址（必填）
      - SMTP_USE_TLS=true           # 是否启用TLS加密（可选，默认：true）
      - NOTIFICATION_SUBJECT=系统通知  # 默认通知主题（可选，可在发送时动态覆盖）
    restart: unless-stopped

启动服务：

bash
docker-compose up -d

配置参数说明

发送通知示例

服务启动后，可通过向服务暴露的接口（如HTTP API，具体接口需参考服务内部实现）发送请求来触发通知发送。例如，若服务提供HTTP POST接口 /send，可通过以下方式发送通知：

bash
curl -X POST http://localhost:8080/send \
  -H "Content-Type: application/json" \
  -d '{
    "to": "recipient@example.com",
    "subject": "订单状态更新",
    "body": "您的订单#12345已发货，请注意查收。"
  }'

注：具体接口定义和请求格式需根据服务内部实现确定，以上为通用示例。