📝 docs: Add documentation

2025-12-11 03:29:07 +00:00
parent 50e695a1bb
commit 99e7f6062d
135 changed files with 79115 additions and 8 deletions
@@ -0,0 +1,149 @@
+<div v-pre>
+
+# 邮件日志
+
+查看系统发送的所有邮件记录,包含发送状态和内容。
+
+## 表格列说明
+
+### 平台 (Platform)
+邮件发送平台(Badge显示):
+- SMTP
+- SendGrid
+- Mailgun
+- AWS SES
+- 其他邮件服务商
+
+### 收件人 (To)
+接收邮件的邮箱地址。
+
+### 主题 (Subject)
+邮件主题。
+
+### 内容 (Content)
+邮件内容(JSON格式显示):
+- 纯文本内容
+- HTML内容
+- 模板变量
+- 最大显示480px宽度
+
+### 状态 (Status)
+邮件发送状态(Badge显示):
+- **已发送** (绿色) - 成功发送
+- **发送失败** (红色) - 发送失败
+- **未知** (灰色) - 状态未知
+
+### 时间 (Time)
+邮件发送时间。
+
+## 筛选功能
+
+### 关键词搜索
+搜索收件人地址或邮件主题。
+
+### 日期筛选
+选择查看指定日期的邮件记录,默认今天。
+
+## 使用场景
+
+### 场景一: 查看今日邮件
+
+1. 默认显示今天的邮件记录
+2. 查看发送数量
+3. 检查发送状态
+4. 统计成功率
+
+### 场景二: 排查发送失败
+
+**检查失败邮件**:
+1. 筛选"发送失败"状态
+2. 查看收件人地址
+3. 检查邮件内容
+4. 分析失败原因
+5. 重新发送或修复配置
+
+### 场景三: 验证邮件内容
+
+**检查邮件模板**:
+1. 搜索特定主题
+2. 查看邮件内容
+3. 验证变量替换
+4. 确认格式正确
+
+### 场景四: 追踪用户邮件
+
+**查看用户收信**:
+1. 搜索用户邮箱
+2. 查看所有邮件
+3. 确认是否送达
+4. 验证邮件类型
+
+## 邮件类型
+
+### 系统邮件
+- 注册验证邮件
+- 密码重置邮件
+- 登录验证码
+- 账户通知
+
+### 营销邮件
+- 推广邮件
+- 活动通知
+- 优惠信息
+- 产品更新
+
+### 交易邮件
+- 订单确认
+- 支付成功
+- 发票通知
+- 到期提醒
+
+## 发送监控
+
+### 成功率监控
+关注指标:
+- 每日发送总量
+- 发送成功率
+- 失败率趋势
+- 不同平台表现
+
+### 异常处理
+发现问题时:
+1. 检查SMTP配置
+2. 验证邮件服务商状态
+3. 检查发送频率限制
+4. 查看错误日志
+
+## 邮件内容说明
+
+### JSON格式
+内容字段包含:
+```json
+{
+  "text": "纯文本内容",
+  "html": "<p>HTML内容</p>",
+  "variables": {
+    "username": "用户名",
+    "code": "验证码"
+  }
+}
+```
+
+### 变量替换
+- {{username}}: 用户名
+- {{code}}: 验证码
+- {{link}}: 链接地址
+- {{expire}}: 过期时间
+
+## 重要提示
+
+1. **日志保留**: 根据系统配置保留
+2. **内容截断**: 过长内容会被截断显示
+3. **JSON显示**: 内容以JSON格式展示
+4. **平台识别**: 通过平台字段识别发送渠道
+5. **状态监控**: 关注发送失败记录
+6. **隐私保护**: 邮件内容可能包含敏感信息
+7. **定期检查**: 每日检查发送状态
+8. **配额管理**: 注意邮件服务商配额限制
+
+</div>