Home

Welcome to the one-word-email-notification wiki!

随机一言 (SuijiYiyan) 项目使用指南

一、项目简介

随机一言是一个自动化每日推送工具，通过调用接口盒子随机一言API获取随机句子，并支持多种渠道推送。适用于个人提醒、团队激励等场景。

核心功能

• 每日自动推送随机句子
• 支持7种通知渠道（邮件/Server酱/钉钉等）
• 本地测试与手动触发功能
• 敏感信息通过GitHub Secrets安全存储

二、快速开始

1. 仓库配置

1. Fork本仓库到你的GitHub账号
2. 在仓库设置中创建以下Secrets：

Secret名称	获取方式	必填
NOTIFY_TYPE	推送渠道代码：email/serverchan/dingtalk等	✓
YIYAN_API_ID	一言开放平台注册获取	✓
YIYAN_API_KEY	一言开放平台对应密钥	✓
SMTP_HOST	邮件服务器地址（如smtp.qq.com）	NOTIFY_TYPE=email时必填
SMTP_PORT	邮件服务器端口（通常465）	NOTIFY_TYPE=email时必填
SMTP_USERNAME	邮件账号	NOTIFY_TYPE=email时必填
SMTP_PASSWORD	邮件授权码	NOTIFY_TYPE=email时必填
EMAIL_FROM	发件人邮箱	NOTIFY_TYPE=email时必填
EMAIL_TO	收件人邮箱	NOTIFY_TYPE=email时必填
SERVERCHAN_KEY	Server酱发送密钥	NOTIFY_TYPE=serverchan时必填

提示：邮件密码建议使用授权码而非登录密码

2. 工作流验证

修改 .github/workflows/daily.yml 后：

1. 提交更改到main分支
2. 在Actions标签页手动触发工作流
3. 查看执行日志确认是否成功

三、高级配置

# 安装依赖
pip install -r requirements.txt

# 测试邮件发送（替换参数）
python main.py --test --category=a \
  --smtp-host=smtp.qq.com \
  --smtp-port=465 \
  --smtp-user=your@qq.com \
  --smtp-pass=your_auth_code \
  --email-from=your@qq.com \
  --email-to=target@example.com

四、故障排查

常见问题

问题现象	解决方案
Actions被组织策略阻止	使用替代方案配置
邮件发送失败	检查SMTP配置和授权码有效性
API返回403	确认YIYAN_API_ID/KEY正确
定时任务不触发	检查cron表达式格式

日志查看

在GitHub Actions执行日志中：

1. 展开Run main script步骤
2. 查看标准输出和错误信息
3. 根据错误代码参考接口盒子随机一言API文档

五、贡献指南

欢迎提交PR！请遵循：

1. 保持代码PEP8规范
2. 新增功能需提供测试用例
3. 修改文档同步更新WIKI

项目持续维护中，遇到问题请提交issue