https://github.com/gfreezy/mailhook
自动将邮件转发到飞书
https://github.com/gfreezy/mailhook
bot feishu hook mail
Last synced: 4 months ago
JSON representation
自动将邮件转发到飞书
- Host: GitHub
- URL: https://github.com/gfreezy/mailhook
- Owner: gfreezy
- Created: 2021-03-15T16:30:44.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-06-28T11:00:49.000Z (over 1 year ago)
- Last Synced: 2025-03-06T09:59:14.221Z (7 months ago)
- Topics: bot, feishu, hook, mail
- Language: Rust
- Homepage:
- Size: 371 KB
- Stars: 8
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Mailhook
自动将邮件转发到飞书群。邮件支持附件，附件也会自动转发到飞书群。
## 机器人使用方法
1. 将机器人拉入群
2. 机器人会回复一个自动生成的邮件地址，往这个邮件地址发送的邮件会自动转发到群内
3. 从群中删除机器人可关闭转发功能
4. 在群内 at 机器人会自动回复邮件地址
## 如何配置飞书机器人
在飞书开放平台创建一个应用，获取 app id 和 app secret，然后配置事件订阅 URL 为 `http://your.domain/event`。
## 如何启动
```bash
FEISHU_APP_ID=app_id FEISHU_APP_SECRET=app_secret MAIL_DOMAIN=mail.domain WEB_DOMAIN=web.domain mailhook
```
- `FEISHU_APP_ID` 和 `FEISHU_APP_SECRET` 为飞书应用的 app id 和 app secret
- `MAIL_DOMAIN` 为邮件域名，用于生成邮件地址。例如 `mail.xcf.io` 生成的邮件地址为 `e89sadfs98ydf@mail.xcf.io`, `xcf.io` 生成的邮件地址为 `e89sadfs98ydf@xcf.io`。
- `WEB_DOMAIN` 为网站域名，用于生成原始邮件下载地址
## 开放端口
`Mailhook` 启动后会监听：
1. `8088` 端口，用于接收飞书的回调。
2. `25` 端口，用于接收邮件。
因为监听了 25 端口，所以启动需要 root 权限。
## DNS 配置
如果自动生成的域名为 `e89sadfs98ydf@xcf.io`，则需要在 `xcf.io` DNS 中加入 MX 记录。IP 地址对应为服务部署的 IP 地址。
```
MX @ 12.23.3.12
```
如果自动生成的域名为 `e89sadfs98ydf@mail.xcf.io`，则需要在 `xcf.io` DNS 中加入 MX 记录。IP 地址对应为服务部署的 IP 地址。
```
MX mail 12.23.3.12
```
## Docker 启动
```bash
docker run -p 8088:8088 -p 25:25 -e FEISHU_APP_ID=app_id -e FEISHU_APP_SECRET=app_secret -e MAIL_DOMAIN=mail.domain -e WEB_DOMAIN=web.domain gfreezy/mailhook
```
## Docker-compose 启动
1. 修改 `docker-compose.yml` 中的环境变量: FEISHU_APP_ID, FEISHU_APP_SECRET, MAIL_DOMAIN, WEB_DOMAIN
2. 启动
```bash
docker-compose up
```
## Release New Docker Image
```bash
./release-image.sh
```