docs: clarify mail API raw payload semantics (#906)

docs: clarify mail API returns raw RFC822 content
This commit is contained in:
Dream Hunter
2026-03-19 20:31:22 +08:00
committed by GitHub
parent 79b9835fa2
commit e77ab12140
2 changed files with 12 additions and 0 deletions
@@ -17,6 +17,8 @@ res = requests.get(
)
```
**注意**`/api/mails` 按设计返回的是原始 RFC822 数据(如 `source`/`raw`),不保证直接包含 `subject``text``html` 等已解析字段。若要直接读取正文,请在客户端侧解析 `raw`(例如 `mail-parser-wasm``postal-mime`)。
## admin 邮件 API
支持 `address` 过滤
@@ -43,6 +45,8 @@ response = requests.get(url, headers=headers, params=querystring)
print(response.json())
```
**注意**`/admin/mails``/api/mails` 一致,返回的是邮件数据库中的 raw MIME 内容;如需正文/主题等可读字段,请在客户端自行解析 `raw`
**注意**:后端 API 已移除关键词过滤功能。如需按内容过滤邮件,请使用前端界面的过滤输入框,该功能可过滤当前显示的页面。
## admin 删除邮件 API
@@ -151,4 +155,6 @@ response = requests.get(url, headers=headers, params=querystring)
print(response.json())
```
**注意**`/user_api/mails` 同样返回原始 RFC822 内容;请在客户端解析后提取 `subject``text``html`
**注意**:后端 API 已移除关键词过滤功能。如需按内容过滤邮件,请使用前端界面的过滤输入框,该功能可过滤当前显示的页面。