mirror of
https://github.com/dreamhunter2333/cloudflare_temp_email.git
synced 2026-07-10 23:13:12 +08:00
docs: fix user API auth and add admin delete API docs (#836)
This commit is contained in:
@@ -42,6 +42,74 @@ print(response.json())
|
||||
|
||||
**Note**: Keyword filtering has been removed from the backend API. If you need to filter emails by content, please use the frontend filter input in the UI, which filters the currently displayed page.
|
||||
|
||||
## Admin Delete Mail API
|
||||
|
||||
Delete a single mail by mail ID.
|
||||
|
||||
```python
|
||||
import requests
|
||||
|
||||
mail_id = 1
|
||||
url = f"https://<your-worker-address>/admin/mails/{mail_id}"
|
||||
|
||||
headers = {"x-admin-auth": "<your-Admin-password>"}
|
||||
|
||||
response = requests.delete(url, headers=headers)
|
||||
|
||||
print(response.json())
|
||||
```
|
||||
|
||||
## Admin Delete Address API
|
||||
|
||||
Delete an email address by address ID (also deletes associated mails, sender permissions, and user bindings).
|
||||
|
||||
```python
|
||||
import requests
|
||||
|
||||
address_id = 1
|
||||
url = f"https://<your-worker-address>/admin/delete_address/{address_id}"
|
||||
|
||||
headers = {"x-admin-auth": "<your-Admin-password>"}
|
||||
|
||||
response = requests.delete(url, headers=headers)
|
||||
|
||||
print(response.json())
|
||||
```
|
||||
|
||||
## Admin Clear Inbox API
|
||||
|
||||
Clear all received mails for an address by address ID.
|
||||
|
||||
```python
|
||||
import requests
|
||||
|
||||
address_id = 1
|
||||
url = f"https://<your-worker-address>/admin/clear_inbox/{address_id}"
|
||||
|
||||
headers = {"x-admin-auth": "<your-Admin-password>"}
|
||||
|
||||
response = requests.delete(url, headers=headers)
|
||||
|
||||
print(response.json())
|
||||
```
|
||||
|
||||
## Admin Clear Sent Items API
|
||||
|
||||
Clear all sent mails for an address by address ID.
|
||||
|
||||
```python
|
||||
import requests
|
||||
|
||||
address_id = 1
|
||||
url = f"https://<your-worker-address>/admin/clear_sent_items/{address_id}"
|
||||
|
||||
headers = {"x-admin-auth": "<your-Admin-password>"}
|
||||
|
||||
response = requests.delete(url, headers=headers)
|
||||
|
||||
print(response.json())
|
||||
```
|
||||
|
||||
## User Mail API
|
||||
|
||||
Supports `address` filter
|
||||
@@ -58,7 +126,7 @@ querystring = {
|
||||
"address":"xxxx@awsl.uk"
|
||||
}
|
||||
|
||||
headers = {"x-admin-auth": "<your-Admin-password>"}
|
||||
headers = {"x-user-token": "<your-user-JWT-token>"}
|
||||
|
||||
response = requests.get(url, headers=headers, params=querystring)
|
||||
|
||||
|
||||
@@ -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)
|
||||
|
||||
|
||||
Reference in New Issue
Block a user