GithubBackup/cloudflare_temp_email
1
0
Fork 0
mirror of https://github.com/dreamhunter2333/cloudflare_temp_email.git synced 2026-06-09 17:39:56 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: add private site password hint to all API docs (#850)

Browse Source 
docs: add x-custom-auth private site password hint to all API docs

Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
This commit is contained in:
Dream Hunter
2026-03-02 18:04:27 +08:00
committed by GitHub
parent 9b7a80ef54
commit a2d37b8183
6 changed files with 58 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
vitepress-docs/docs/en/guide/feature/mail-api.md
View File

@@ -11,7 +11,7 @@ res = requests.get(
f"https://<your-worker-address>/api/mails?limit={limit}&offset={offset}",
headers={
"Authorization": f"Bearer {your-JWT-password}",
# "x-custom-auth": "<your-website-password>", # If custom password is enabled
# "x-custom-auth": "<your-website-password>", # If private site password is enabled
"Content-Type": "application/json"
}
)
@@ -33,7 +33,10 @@ querystring = {
"address":"xxxx@awsl.uk"
}
headers = {"x-admin-auth": "<your-Admin-password>"}
headers = {
"x-admin-auth": "<your-Admin-password>",
# "x-custom-auth": "<your-website-password>", # If private site password is enabled
}
response = requests.get(url, headers=headers, params=querystring)
@@ -52,7 +55,10 @@ import requests
mail_id = 1
url = f"https://<your-worker-address>/admin/mails/{mail_id}"
headers = {"x-admin-auth": "<your-Admin-password>"}
headers = {
"x-admin-auth": "<your-Admin-password>",
# "x-custom-auth": "<your-website-password>", # If private site password is enabled
}
response = requests.delete(url, headers=headers)
@@ -69,7 +75,10 @@ import requests
address_id = 1
url = f"https://<your-worker-address>/admin/delete_address/{address_id}"
headers = {"x-admin-auth": "<your-Admin-password>"}
headers = {
"x-admin-auth": "<your-Admin-password>",
# "x-custom-auth": "<your-website-password>", # If private site password is enabled
}
response = requests.delete(url, headers=headers)
@@ -86,7 +95,10 @@ import requests
address_id = 1
url = f"https://<your-worker-address>/admin/clear_inbox/{address_id}"
headers = {"x-admin-auth": "<your-Admin-password>"}
headers = {
"x-admin-auth": "<your-Admin-password>",
# "x-custom-auth": "<your-website-password>", # If private site password is enabled
}
response = requests.delete(url, headers=headers)
@@ -103,7 +115,10 @@ import requests
address_id = 1
url = f"https://<your-worker-address>/admin/clear_sent_items/{address_id}"
headers = {"x-admin-auth": "<your-Admin-password>"}
headers = {
"x-admin-auth": "<your-Admin-password>",
# "x-custom-auth": "<your-website-password>", # If private site password is enabled
}
response = requests.delete(url, headers=headers)
@@ -126,7 +141,10 @@ querystring = {
"address":"xxxx@awsl.uk"
}
headers = {"x-user-token": "<your-user-JWT-token>"}
headers = {
"x-user-token": "<your-user-JWT-token>",
# "x-custom-auth": "<your-website-password>", # If private site password is enabled
}
response = requests.get(url, headers=headers, params=querystring)

2
vitepress-docs/docs/en/guide/feature/new-address-api.md
View File

@@ -16,6 +16,7 @@ res = requests.post(
},
headers={
'x-admin-auth': "<your_website_admin_password>",
# "x-custom-auth": "<your_website_password>", # If private site password is enabled
"Content-Type": "application/json"
}
)
@@ -59,6 +60,7 @@ def fetch_email_data(name):
},
headers={
'x-admin-auth': "<your_website_admin_password>",
# "x-custom-auth": "<your_website_password>", # If private site password is enabled
"Content-Type": "application/json"
}
)

3
vitepress-docs/docs/en/guide/feature/send-mail-api.md
View File

@@ -18,7 +18,7 @@ res = requests.post(
"http://localhost:8787/api/send_mail",
json=send_body, headers={
"Authorization": f"Bearer {your_JWT_password}",
# "x-custom-auth": "<your_website_password>", # If custom password is enabled
# "x-custom-auth": "<your_website_password>", # If private site password is enabled
"Content-Type": "application/json"
}
)
@@ -36,6 +36,7 @@ send_body = {
res = requests.post(
"http://localhost:8787/external/api/send_mail",
json=send_body, headers={
# "x-custom-auth": "<your_website_password>", # If private site password is enabled
"Content-Type": "application/json"
}
)

32
vitepress-docs/docs/zh/guide/feature/mail-api.md
View File

@@ -11,7 +11,7 @@ res = requests.get(
f"https://<你的worker地址>/api/mails?limit={limit}&offset={offset}",
headers={
"Authorization": f"Bearer {你的JWT密码}",
# "x-custom-auth": "<你的网站密码>", # 如果启用了自定义密码
# "x-custom-auth": "<你的网站密码>", # 如果启用了私有站点密码
"Content-Type": "application/json"
}
)
@@ -33,7 +33,10 @@ querystring = {
"address":"xxxx@awsl.uk"
}
headers = {"x-admin-auth": "<你的Admin密码>"}
headers = {
"x-admin-auth": "<你的Admin密码>",
# "x-custom-auth": "<你的网站密码>", # 如果启用了私有站点密码
}
response = requests.get(url, headers=headers, params=querystring)
@@ -52,7 +55,10 @@ import requests
mail_id = 1
url = f"https://<你的worker地址>/admin/mails/{mail_id}"
headers = {"x-admin-auth": "<你的Admin密码>"}
headers = {
"x-admin-auth": "<你的Admin密码>",
# "x-custom-auth": "<你的网站密码>", # 如果启用了私有站点密码
}
response = requests.delete(url, headers=headers)
@@ -69,7 +75,10 @@ import requests
address_id = 1
url = f"https://<你的worker地址>/admin/delete_address/{address_id}"
headers = {"x-admin-auth": "<你的Admin密码>"}
headers = {
"x-admin-auth": "<你的Admin密码>",
# "x-custom-auth": "<你的网站密码>", # 如果启用了私有站点密码
}
response = requests.delete(url, headers=headers)
@@ -86,7 +95,10 @@ import requests
address_id = 1
url = f"https://<你的worker地址>/admin/clear_inbox/{address_id}"
headers = {"x-admin-auth": "<你的Admin密码>"}
headers = {
"x-admin-auth": "<你的Admin密码>",
# "x-custom-auth": "<你的网站密码>", # 如果启用了私有站点密码
}
response = requests.delete(url, headers=headers)
@@ -103,7 +115,10 @@ import requests
address_id = 1
url = f"https://<你的worker地址>/admin/clear_sent_items/{address_id}"
headers = {"x-admin-auth": "<你的Admin密码>"}
headers = {
"x-admin-auth": "<你的Admin密码>",
# "x-custom-auth": "<你的网站密码>", # 如果启用了私有站点密码
}
response = requests.delete(url, headers=headers)
@@ -126,7 +141,10 @@ querystring = {
"address":"xxxx@awsl.uk"
}
headers = {"x-user-token": "<你的用户JWT Token>"}
headers = {
"x-user-token": "<你的用户JWT Token>",
# "x-custom-auth": "<你的网站密码>", # 如果启用了私有站点密码
}
response = requests.get(url, headers=headers, params=querystring)

2
vitepress-docs/docs/zh/guide/feature/new-address-api.md
View File

@@ -16,6 +16,7 @@ res = requests.post(
},
headers={
'x-admin-auth': "<你的网站admin密码>",
# "x-custom-auth": "<你的网站密码>", # 如果启用了私有站点密码
"Content-Type": "application/json"
}
)
@@ -59,6 +60,7 @@ def fetch_email_data(name):
},
headers={
'x-admin-auth': "<你的网站admin密码>",
# "x-custom-auth": "<你的网站密码>", # 如果启用了私有站点密码
"Content-Type": "application/json"
}
)

3
vitepress-docs/docs/zh/guide/feature/send-mail-api.md
View File

@@ -18,7 +18,7 @@ res = requests.post(
"http://localhost:8787/api/send_mail",
json=send_body, headers={
"Authorization": f"Bearer {你的JWT密码}",
# "x-custom-auth": "<你的网站密码>", # 如果启用了自定义密码
# "x-custom-auth": "<你的网站密码>", # 如果启用了私有站点密码
"Content-Type": "application/json"
}
)
@@ -36,6 +36,7 @@ send_body = {
res = requests.post(
"http://localhost:8787/external/api/send_mail",
json=send_body, headers={
# "x-custom-auth": "<你的网站密码>", # 如果启用了私有站点密码
"Content-Type": "application/json"
}
)