docs: fix user API auth and add admin delete API docs (#836)

This commit is contained in:
Dream Hunter
2026-02-16 15:49:26 +08:00
committed by GitHub
parent bde08b9d55
commit 566c6536d1
11 changed files with 1208 additions and 1544 deletions
@@ -42,6 +42,74 @@ print(response.json())
**注意**:后端 API 已移除关键词过滤功能。如需按内容过滤邮件,请使用前端界面的过滤输入框,该功能可过滤当前显示的页面。
## admin 删除邮件 API
通过邮件 ID 删除单封邮件。
```python
import requests
mail_id = 1
url = f"https://<你的worker地址>/admin/mails/{mail_id}"
headers = {"x-admin-auth": "<你的Admin密码>"}
response = requests.delete(url, headers=headers)
print(response.json())
```
## admin 删除邮箱地址 API
通过邮箱地址 ID 删除邮箱地址(同时删除该地址关联的邮件、发件权限和用户绑定)。
```python
import requests
address_id = 1
url = f"https://<你的worker地址>/admin/delete_address/{address_id}"
headers = {"x-admin-auth": "<你的Admin密码>"}
response = requests.delete(url, headers=headers)
print(response.json())
```
## admin 清空收件箱 API
通过邮箱地址 ID 清空该地址的所有收件。
```python
import requests
address_id = 1
url = f"https://<你的worker地址>/admin/clear_inbox/{address_id}"
headers = {"x-admin-auth": "<你的Admin密码>"}
response = requests.delete(url, headers=headers)
print(response.json())
```
## admin 清空发件箱 API
通过邮箱地址 ID 清空该地址的所有发件。
```python
import requests
address_id = 1
url = f"https://<你的worker地址>/admin/clear_sent_items/{address_id}"
headers = {"x-admin-auth": "<你的Admin密码>"}
response = requests.delete(url, headers=headers)
print(response.json())
```
## user 邮件 API
支持 `address` 过滤
@@ -58,7 +126,7 @@ querystring = {
"address":"xxxx@awsl.uk"
}
headers = {"x-admin-auth": "<你的Admin密码>"}
headers = {"x-user-token": "<你的用户JWT Token>"}
response = requests.get(url, headers=headers, params=querystring)