- Trang tìm kiếm
- Mục lục
API email
Thư viện
Hiện tại, chúng tôi chưa phát hành bất kỳ trình bao bọc API nào nhưng chúng tôi dự định sẽ thực hiện điều đó trong tương lai gần. Gửi email đến api@forwardemail.net nếu bạn muốn được thông báo khi trình bao bọc API của một ngôn ngữ lập trình cụ thể được phát hành. Trong khi đó, bạn có thể sử dụng các thư viện yêu cầu HTTP được đề xuất này trong ứng dụng của mình hoặc chỉ cần sử dụng Xoăn như trong các ví dụ dưới đây.
Ngôn ngữ | Thư viện |
---|---|
hồng ngọc | Faraday |
Python | yêu cầu |
Java | OkHttp |
PHP | ăn tham |
JavaScript | siêu chất (chúng tôi là người bảo trì) |
Node.js | siêu chất (chúng tôi là người bảo trì) |
Đi | mạng/http |
.NET | RestSharp |
URI cơ sở
Đường dẫn URI cơ sở HTTP hiện tại là: https://api.forwardemail.net
.
Xác thực
Tất cả các điểm cuối đều yêu cầu Mã API được đặt làm giá trị "tên người dùng" của yêu cầu Ủy quyền cơ bản tiêu đề. Đừng lo lắng – dưới đây sẽ có các ví dụ dành cho bạn nếu bạn không chắc đây là gì.
Lỗi
Nếu có bất kỳ lỗi nào xảy ra, nội dung phản hồi của yêu cầu API sẽ chứa thông báo lỗi chi tiết.
Mã số | Tên |
---|---|
200 | OK |
400 | Yêu cầu xấu |
401 | Không được phép |
403 | Cấm |
404 | Không tìm thấy |
429 | Quá nhiều yêu cầu |
500 | Lỗi máy chủ nội bộ |
501 | Không được thực hiện |
502 | Cổng xấu |
503 | dịch vụ Không sẵn có |
504 | Cổng Time-out |
Bản địa hóa
Dịch vụ của chúng tôi được dịch sang hơn 25 ngôn ngữ khác nhau. Tất cả thông báo phản hồi API được dịch sang ngôn ngữ cuối cùng được phát hiện của người dùng thực hiện yêu cầu API. Bạn có thể ghi đè điều này bằng cách chuyển một tùy chỉnh Accept-Language
tiêu đề. Hãy dùng thử bằng cách sử dụng trình đơn ngôn ngữ thả xuống ở cuối trang này.
Phân trang
Nếu bạn muốn được thông báo khi có tính năng phân trang, vui lòng gửi email api@forwardemail.net.
Nhật ký
Truy xuất nhật ký
API của chúng tôi theo chương trình cho phép bạn tải xuống nhật ký cho tài khoản của mình. Việc gửi yêu cầu đến điểm cuối này sẽ xử lý tất cả nhật ký cho tài khoản của bạn và gửi chúng qua email cho bạn dưới dạng tệp đính kèm (Gzip nén CSV tập tin bảng tính) sau khi hoàn thành.
Điều này cho phép bạn tạo các công việc nền với một công việc lương thấp hoặc sử dụng của chúng tôi Phần mềm lập kế hoạch công việc Node.js Bree để nhận nhật ký bất cứ khi nào bạn muốn. Lưu ý rằng điểm cuối này được giới hạn ở 10
yêu cầu mỗi ngày.
Tệp đính kèm là dạng chữ thường của email-deliverability-logs-YYYY-MM-DD-h-mm-A-z.csv.gz
và bản thân email chứa bản tóm tắt ngắn gọn về nhật ký được truy xuất. Bạn cũng có thể tải xuống nhật ký bất cứ lúc nào từ Tài khoản của tôi → Nhật ký
GET /v1/logs/download
Tham số chuỗi truy vấn | Yêu cầu | Kiểu | Sự miêu tả |
---|---|---|---|
domain | KHÔNG | Chuỗi (FQDN) | Lọc nhật ký theo tên miền đủ điều kiện ("FQDN"). Nếu bạn không cung cấp thông tin này thì tất cả nhật ký trên tất cả các miền sẽ được truy xuất. |
q | KHÔNG | Sợi dây | Tìm kiếm nhật ký theo email, tên miền, tên bí danh, địa chỉ IP hoặc ngày (M/Y , M/D/YY , M-D , M-D-YY , hoặc M.D.YY định dạng). |
Yêu cầu ví dụ:
curl https://api.forwardemail.net/v1/logs/download \
-u API_TOKEN:
Ví dụ Cron job (vào lúc nửa đêm hàng ngày):
0 0 * * * /usr/bin/curl https://api.forwardemail.net/v1/logs/download -u API_TOKEN: &>/dev/null
Lưu ý rằng bạn có thể sử dụng các dịch vụ như Crontab.guru để xác thực cú pháp biểu thức công việc định kỳ của bạn.
Ví dụ Cron job (vào lúc nửa đêm hàng ngày và với nhật ký của ngày hôm trước):
Đối với MacOS:
0 0 * * * /usr/bin/curl https://api.forwardemail.net/v1/logs/download?q=`date -v-1d -u "+%-m/%-d/%y"` -u API_TOKEN: &>/dev/null
Đối với Linux và Ubuntu:
0 0 * * * /usr/bin/curl https://api.forwardemail.net/v1/logs/download?q=`date --date "-1 days" -u "+%-m/%-d/%y"` -u API_TOKEN: &>/dev/null
Tài khoản
Tạo tài khoản
POST /v1/account
Thông số cơ thể | Yêu cầu | Kiểu | Sự miêu tả |
---|---|---|---|
email | Đúng | Chuỗi (Email) | Địa chỉ email |
password | Đúng | Sợi dây | Mật khẩu |
Yêu cầu ví dụ:
curl -X POST https://api.forwardemail.net/v1/account \
-u API_TOKEN: \
-d "email=user%40gmail.com"
Truy xuất tài khoản
GET /v1/account
Yêu cầu ví dụ:
curl https://api.forwardemail.net/v1/account \
-u API_TOKEN:
Cập nhật tài khoản
PUT /v1/account
Thông số cơ thể | Yêu cầu | Kiểu | Sự miêu tả |
---|---|---|---|
email | KHÔNG | Chuỗi (Email) | Địa chỉ email |
given_name | KHÔNG | Sợi dây | Tên đầu tiên |
family_name | KHÔNG | Sợi dây | Họ |
avatar_url | KHÔNG | Chuỗi (URL) | Liên kết đến hình ảnh đại diện |
Yêu cầu ví dụ:
curl -X PUT https://api.forwardemail.net/v1/account \
-u API_TOKEN: \
-d "email=user%40gmail.com"
Hãy đảm bảo rằng bạn đã làm theo hướng dẫn thiết lập cho miền của mình. Những hướng dẫn này có thể được tìm thấy tại Tài khoản của tôi → Tên miền → Cài đặt → Cấu hình SMTP gửi đi. Bạn cần đảm bảo thiết lập DKIM, Return-Path và DMARC để gửi SMTP đi bằng miền của bạn.
Liệt kê email
Lưu ý rằng điểm cuối này không trả về địa chỉ email đã được tạo message
, headers
, accepted
, cũng không rejectedErrors
của cải.
Để trả về những thuộc tính đó và giá trị của chúng, vui lòng sử dụng Truy xuất email điểm cuối có ID email.
Điểm cuối này sẽ quay trở lại nhiều nhất 50
kết quả tại một thời điểm. Nếu bạn muốn truy vấn nhiều trang thì hãy nối thêm ?page=NUMBER
Ở đâu NUMBER
là một số nguyên, ví dụ: ?page=1
.
GET /v1/emails
Tham số chuỗi truy vấn | Yêu cầu | Kiểu | Sự miêu tả |
---|---|---|---|
q | KHÔNG | Chuỗi (hỗ trợ RegExp) | Tìm kiếm email theo siêu dữ liệu |
domain | KHÔNG | Chuỗi (hỗ trợ RegExp) | Tìm kiếm email theo tên miền |
page | KHÔNG | Con số | Trang trả về kết quả (mặc định là 1 ) |
`giới hạn | KHÔNG | Con số | Số kết quả trên mỗi trang trả về (mặc định là 50 – mức tối đa là 50 và tối thiểu là 10 ) |
Yêu cầu ví dụ:
curl https://api.forwardemail.net/v1/emails \
-u API_TOKEN:
Tạo email
API tạo email của chúng tôi được lấy cảm hứng và tận dụng cấu hình tùy chọn thư của Nodemailer. Hãy trì hoãn việc Cấu hình tin nhắn Nodemailer cho tất cả các thông số cơ thể dưới đây.
Lưu ý rằng ngoại trừ envelope
Và dkim
(vì chúng tôi tự động đặt chúng cho bạn), chúng tôi hỗ trợ tất cả các tùy chọn Nodemailer. Chúng tôi tự động thiết lập disableFileAccess
Và disableUrlAccess
tùy chọn để true
vì mục đích an ninh.
Bạn nên vượt qua tùy chọn duy nhất của raw
với email đầy đủ thô của bạn bao gồm các tiêu đề hoặc vượt qua các tùy chọn tham số cơ thể riêng lẻ bên dưới.
POST /v1/emails
Thông số cơ thể | Yêu cầu | Kiểu | Sự miêu tả |
---|---|---|---|
from | KHÔNG | Chuỗi (Email) | Địa chỉ email của người gửi (phải tồn tại dưới dạng bí danh của miền). |
to | KHÔNG | Chuỗi hoặc mảng | Danh sách được phân tách bằng dấu phẩy hoặc Mảng người nhận cho tiêu đề "Tới". |
cc | KHÔNG | Chuỗi hoặc mảng | Danh sách được phân tách bằng dấu phẩy hoặc Mảng người nhận cho tiêu đề "Cc". |
bcc | KHÔNG | Chuỗi hoặc mảng | Danh sách được phân tách bằng dấu phẩy hoặc Mảng người nhận cho tiêu đề "Bcc". |
subject | KHÔNG | Sợi dây | Chủ đề của email. |
text | KHÔNG | Chuỗi hoặc bộ đệm | Phiên bản văn bản gốc của tin nhắn. |
html | KHÔNG | Chuỗi hoặc bộ đệm | Phiên bản HTML của tin nhắn. |
attachments | KHÔNG | Mảng | Một mảng các đối tượng đính kèm (xem Các trường chung của Nodemailer). |
sender | KHÔNG | Sợi dây | Địa chỉ email cho tiêu đề "Người gửi" (xem Các trường nâng cao hơn của Nodemailer). |
replyTo | KHÔNG | Sợi dây | Địa chỉ email cho tiêu đề "Trả lời". |
inReplyTo | KHÔNG | Sợi dây | ID tin nhắn mà tin nhắn được trả lời. |
references | KHÔNG | Chuỗi hoặc mảng | Danh sách được phân tách bằng dấu cách hoặc Mảng ID tin nhắn. |
attachDataUrls | KHÔNG | Boolean | Nếu như true sau đó chuyển đổi data: hình ảnh trong nội dung HTML của tin nhắn vào các tệp đính kèm được nhúng. |
watchHtml | KHÔNG | Sợi dây | Phiên bản HTML cụ thể của thông báo trên Apple Watch (theo tài liệu Nodemailer, những chiếc đồng hồ mới nhất không yêu cầu cài đặt điều này). |
amp | KHÔNG | Sợi dây | Phiên bản HTML cụ thể của AMP4EMAIL của tin nhắn (xem Ví dụ của Nodemailer). |
icalEvent | KHÔNG | Sự vật | Sự kiện iCalendar để sử dụng làm nội dung tin nhắn thay thế (xem Sự kiện lịch của Nodemailer). |
alternatives | KHÔNG | Mảng | Mảng nội dung tin nhắn thay thế (xem Nội dung thay thế của Nodemailer). |
encoding | KHÔNG | Sợi dây | Mã hóa cho chuỗi văn bản và HTML (mặc định là "utf-8" , nhưng hỗ trợ "hex" Và "base64" giá trị mã hóa là tốt). |
raw | KHÔNG | Chuỗi hoặc bộ đệm | Một thông báo có định dạng RFC822 được tạo tùy chỉnh để sử dụng (thay vì thông báo được tạo bởi Nodemailer - xem Nguồn tùy chỉnh của Nodemailer). |
textEncoding | KHÔNG | Sợi dây | Mã hóa bắt buộc phải được sử dụng cho các giá trị văn bản (hoặc "quoted-printable" hoặc "base64" ). Giá trị mặc định là giá trị gần nhất được phát hiện (để sử dụng ASCII "quoted-printable" ). |
priority | KHÔNG | Sợi dây | Mức độ ưu tiên cho email (có thể là "high" , "normal" (mặc định) hoặc "low" ). Lưu ý rằng một giá trị của "normal" không đặt tiêu đề ưu tiên (đây là hành vi mặc định). Nếu một giá trị của "high" hoặc "low" được thiết lập thì X-Priority , X-MSMail-Priority , Và Importance tiêu đề sẽ được thiết lập tương ứng. |
headers | KHÔNG | Đối tượng hoặc mảng | Một đối tượng hoặc một mảng các trường tiêu đề bổ sung cần đặt (xem Tiêu đề tùy chỉnh của Nodemailer). |
messageId | KHÔNG | Sợi dây | Giá trị Message-ID tùy chọn cho tiêu đề "Message-ID" (giá trị mặc định sẽ được tạo tự động nếu không được đặt – lưu ý rằng giá trị này sẽ tuân thủ đặc điểm kỹ thuật RFC2822). |
date | KHÔNG | Chuỗi hoặc Ngày | Giá trị Ngày tùy chọn sẽ được sử dụng nếu tiêu đề Ngày bị thiếu sau khi phân tích cú pháp, nếu không, chuỗi UTC hiện tại sẽ được sử dụng nếu không được đặt. Tiêu đề ngày không được cách thời điểm hiện tại quá 30 ngày. |
list | KHÔNG | Sự vật | Đối tượng tùy chọn của List-* tiêu đề (xem Tiêu đề danh sách của Nodemailer). |
Yêu cầu ví dụ:
curl -X POST https://api.forwardemail.net/v1/emails \
-u API_TOKEN: \
-d "from=alias@example.com" \
-d "to=user%40gmail.com" \
-d "subject=test" \
-d "text=test"
Yêu cầu ví dụ:
curl -X POST https://api.forwardemail.net/v1/emails \
-u API_TOKEN: \
-d "raw=`cat file.eml`"
Truy xuất email
GET /v1/emails/:id
Yêu cầu ví dụ:
curl https://api.forwardemail.net/v1/emails/:id \
-u API_TOKEN:
Xóa email
Xóa email sẽ đặt trạng thái thành "rejected"
(và sau đó không xử lý nó trong hàng đợi) khi và chỉ nếu trạng thái hiện tại là một trong "pending"
, "queued"
, hoặc "deferred"
. Chúng tôi có thể tự động lọc email sau 30 ngày kể từ khi chúng được tạo và/hoặc gửi – do đó bạn nên giữ một bản sao của email SMTP gửi đi trong ứng dụng khách, cơ sở dữ liệu hoặc ứng dụng của mình. Bạn có thể tham chiếu giá trị ID email của chúng tôi trong cơ sở dữ liệu của mình nếu muốn – giá trị này được trả về từ cả hai Tạo email Và Truy xuất email điểm cuối.
DELETE /v1/emails/:id
Yêu cầu ví dụ:
curl -X DELETE https://api.forwardemail.net/v1/emails/:id \
-u API_TOKEN:
Tên miền
/v1/domains/:domain_name
vì đường dẫn của chúng có thể thay thế được với ID của miền :domain_id
. Điều này có nghĩa là bạn có thể tham khảo tên miền bằng name
hoặc id
giá trị.
Liệt kê tên miền
GET /v1/domains
Tham số chuỗi truy vấn | Yêu cầu | Kiểu | Sự miêu tả |
---|---|---|---|
q | KHÔNG | Chuỗi (hỗ trợ RegExp) | Tìm kiếm tên miền theo tên |
name | KHÔNG | Chuỗi (hỗ trợ RegExp) | Tìm kiếm tên miền theo tên |
Yêu cầu ví dụ:
curl https://api.forwardemail.net/v1/domains \
-u API_TOKEN:
Tạo tên miền
POST /v1/domains
Thông số cơ thể | Yêu cầu | Kiểu | Sự miêu tả |
---|---|---|---|
domain | Đúng | Chuỗi (FQDN hoặc IP) | Tên miền đủ điều kiện ("FQDN") hoặc địa chỉ IP |
plan | KHÔNG | Chuỗi (đếm được) | Loại kế hoạch (phải là "free" , "enhanced_protection" , hoặc "team" , mặc định là "free" hoặc gói trả phí hiện tại của người dùng nếu có) |
catchall | KHÔNG | Chuỗi (địa chỉ email được phân tách) hoặc Boolean | Tạo một bí danh chung mặc định, mặc định là true (nếu như true nó sẽ sử dụng địa chỉ email của người dùng API làm người nhận và nếu false sẽ không có thông tin tổng hợp nào được tạo). Nếu một Chuỗi được chuyển thì đó là danh sách các địa chỉ email được phân tách để sử dụng làm người nhận (được phân tách bằng dấu ngắt dòng, dấu cách và/hoặc dấu phẩy) |
has_adult_content_protection | KHÔNG | Boolean | Có bật tính năng bảo vệ nội dung người lớn của Trình quét thư rác trên miền này hay không |
has_phishing_protection | KHÔNG | Boolean | Có bật tính năng bảo vệ lừa đảo bằng Trình quét thư rác trên miền này hay không |
has_executable_protection | KHÔNG | Boolean | Có bật tính năng bảo vệ thực thi của Trình quét Thư rác trên miền này hay không |
has_virus_protection | KHÔNG | Boolean | Có bật tính năng bảo vệ chống vi-rút Spam Scanner trên miền này hay không |
has_recipient_verification | KHÔNG | Boolean | Miền chung mặc định về việc có yêu cầu người nhận bí danh nhấp vào liên kết xác minh email để email đi qua hay không |
retention_days | KHÔNG | Con số | Số nguyên giữa 0 Và 30 tương ứng với số ngày lưu giữ để lưu trữ các email SMTP gửi đi sau khi được gửi thành công hoặc bị lỗi vĩnh viễn. Mặc định là 0 , điều đó có nghĩa là các email SMTP gửi đi sẽ bị xóa và xử lý lại ngay lập tức để bảo mật cho bạn. |
Yêu cầu ví dụ:
curl -X POST https://api.forwardemail.net/v1/domains \
-u API_TOKEN: \
-d domain=example.com \
-d plan=free
Truy xuất tên miền
GET /v1/domains/example.com
Yêu cầu ví dụ:
curl https://api.forwardemail.net/v1/domains/example.com \
-u API_TOKEN:
Xác minh bản ghi tên miền
GET /v1/domains/example.com/verify-records
Yêu cầu ví dụ:
curl https://api.forwardemail.net/v1/domains/example.com/verify-records \
-u API_TOKEN:
Cập nhật miền
PUT /v1/domains/example.com
Thông số cơ thể | Yêu cầu | Kiểu | Sự miêu tả |
---|---|---|---|
smtp_port | KHÔNG | Chuỗi hoặc số | Cổng tùy chỉnh để định cấu hình cho chuyển tiếp SMTP (mặc định là "25" ) |
has_adult_content_protection | KHÔNG | Boolean | Có bật tính năng bảo vệ nội dung người lớn của Trình quét thư rác trên miền này hay không |
has_phishing_protection | KHÔNG | Boolean | Có bật tính năng bảo vệ lừa đảo bằng Trình quét thư rác trên miền này hay không |
has_executable_protection | KHÔNG | Boolean | Có bật tính năng bảo vệ thực thi của Trình quét Thư rác trên miền này hay không |
has_virus_protection | KHÔNG | Boolean | Có bật tính năng bảo vệ chống vi-rút Spam Scanner trên miền này hay không |
has_recipient_verification | KHÔNG | Boolean | Miền chung mặc định về việc có yêu cầu người nhận bí danh nhấp vào liên kết xác minh email để email đi qua hay không |
retention_days | KHÔNG | Con số | Số nguyên giữa 0 Và 30 tương ứng với số ngày lưu giữ để lưu trữ các email SMTP gửi đi sau khi được gửi thành công hoặc bị lỗi vĩnh viễn. Mặc định là 0 , điều đó có nghĩa là các email SMTP gửi đi sẽ bị xóa và xử lý lại ngay lập tức để bảo mật cho bạn. |
Yêu cầu ví dụ:
curl -X PUT https://api.forwardemail.net/v1/domains/example.com \
-u API_TOKEN:
Xóa tên miền
DELETE /v1/domains/:domain_name
Yêu cầu ví dụ:
curl -X DELETE https://api.forwardemail.net/v1/domains/:domain_name \
-u API_TOKEN:
Mời
Chấp nhận lời mời tên miền
GET /v1/domains/:domain_name/invites
Yêu cầu ví dụ:
curl https://api.forwardemail.net/v1/domains/:domain_name/invites \
-u API_TOKEN:
Tạo lời mời tên miền
POST /v1/domains/example.com/invites
Thông số cơ thể | Yêu cầu | Kiểu | Sự miêu tả |
---|---|---|---|
email | Đúng | Chuỗi (Email) | Địa chỉ email để mời vào danh sách thành viên tên miền |
group | Đúng | Chuỗi (đếm được) | Nhóm để thêm người dùng vào thành viên miền với (có thể là một trong "admin" hoặc "user" ) |
Yêu cầu ví dụ:
curl -X POST https://api.forwardemail.net/v1/domains/example.com/invites \
-u API_TOKEN: \
-d "email=user%40gmail.com" \
-d group=admin
Xóa lời mời tên miền
DELETE /v1/domains/:domain_name/invites
Thông số cơ thể | Yêu cầu | Kiểu | Sự miêu tả |
---|---|---|---|
email | Đúng | Chuỗi (Email) | Địa chỉ email cần xóa khỏi danh sách thành viên tên miền |
Yêu cầu ví dụ:
curl -X DELETE https://api.forwardemail.net/v1/domains/:domain_name/invites \
-u API_TOKEN:
Các thành viên
Cập nhật thành viên miền
PUT /v1/domains/example.com/members/:member_id
Thông số cơ thể | Yêu cầu | Kiểu | Sự miêu tả |
---|---|---|---|
group | Đúng | Chuỗi (đếm được) | Nhóm để cập nhật người dùng thành thành viên tên miền với (có thể là một trong "admin" hoặc "user" ) |
Yêu cầu ví dụ:
curl -X PUT https://api.forwardemail.net/v1/domains/example.com/members/:member_id \
-u API_TOKEN:
Xóa thành viên miền
DELETE /v1/domains/:domain_name/members/:member_id
Yêu cầu ví dụ:
curl -X DELETE https://api.forwardemail.net/v1/domains/:domain_name/members/:member_id \
-u API_TOKEN:
Bí danh
Liệt kê bí danh tên miền
GET /v1/domains/example.com/aliases
Tham số chuỗi truy vấn | Yêu cầu | Kiểu | Sự miêu tả |
---|---|---|---|
q | KHÔNG | Chuỗi (hỗ trợ RegExp) | Tìm kiếm bí danh trong miền theo tên, nhãn hoặc người nhận |
name | KHÔNG | Chuỗi (hỗ trợ RegExp) | Tìm kiếm bí danh trong một miền theo tên |
recipient | KHÔNG | Chuỗi (hỗ trợ RegExp) | Tìm kiếm bí danh trong miền theo người nhận |
Yêu cầu ví dụ:
curl https://api.forwardemail.net/v1/domains/example.com/aliases \
-u API_TOKEN:
Tạo bí danh tên miền mới
POST /v1/domains/example.com/aliases
Thông số cơ thể | Yêu cầu | Kiểu | Sự miêu tả |
---|---|---|---|
name | KHÔNG | Sợi dây | Tên bí danh (nếu không được cung cấp hoặc để trống thì bí danh ngẫu nhiên sẽ được tạo) |
recipients | KHÔNG | Chuỗi hoặc mảng | Danh sách người nhận (phải là Chuỗi hoặc Mảng ngắt dòng/dấu cách/được phân tách bằng dấu phẩy gồm các địa chỉ email hợp lệ, tên miền đủ điều kiện ("FQDN"), địa chỉ IP và/hoặc URL webhook – và nếu không được cung cấp hoặc để trống Array thì email của người dùng thực hiện yêu cầu API sẽ được đặt làm người nhận) |
description | KHÔNG | Sợi dây | Mô tả bí danh |
labels | KHÔNG | Chuỗi hoặc mảng | Danh sách các nhãn (phải là Chuỗi hoặc Mảng được phân tách bằng dấu ngắt dòng/dấu cách/bằng dấu phẩy) |
has_recipient_verification | KHÔNG | Boolean | Yêu cầu người nhận nhấp vào liên kết xác minh email để email đi qua (mặc định là cài đặt của miền nếu không được đặt rõ ràng trong nội dung yêu cầu) |
is_enabled | KHÔNG | Boolean | Bật hay tắt bí danh này (nếu bị tắt, email sẽ không được định tuyến đến đâu nhưng sẽ trả về mã trạng thái thành công). Nếu một giá trị được truyền, nó sẽ được chuyển đổi thành boolean bằng cách sử dụng boolean) |
has_imap | KHÔNG | Boolean | Bật hay tắt bộ nhớ IMAP cho bí danh này (nếu tắt, các email gửi đến nhận được sẽ không được lưu trữ vào lưu trữ IMAP. Nếu một giá trị được truyền, nó sẽ được chuyển đổi thành boolean bằng cách sử dụng boolean) |
has_pgp | KHÔNG | Boolean | Nên bật hay tắt Mã hóa OpenPGP vì Lưu trữ email được mã hóa IMAP/POP3 sử dụng bí danh' public_key . |
public_key | KHÔNG | Sợi dây | Khóa công khai OpenPGP ở định dạng ASCII Armor (bấm vào đây để xem một ví dụ; ví dụ. Khóa GPG cho support@forwardemail.net ). Điều này chỉ áp dụng nếu bạn có has_pgp đặt thành true . Tìm hiểu thêm về mã hóa đầu cuối trong Câu hỏi thường gặp của chúng tôi. |
Yêu cầu ví dụ:
curl -X POST https://api.forwardemail.net/v1/domains/example.com/aliases \
-u API_TOKEN:
Truy xuất bí danh tên miền
Bạn có thể truy xuất bí danh tên miền bằng cách id
Hoặc của nó name
giá trị.
GET /v1/domains/:domain_name/aliases/:alias_id
Yêu cầu ví dụ:
curl https://api.forwardemail.net/v1/domains/:domain_name/aliases/:alias_id \
-u API_TOKEN:
GET /v1/domains/:domain_name/aliases/:alias_name
Yêu cầu ví dụ:
curl https://api.forwardemail.net/v1/domains/:domain_name/aliases/:alias_name \
-u API_TOKEN:
Cập nhật bí danh tên miền
PUT /v1/domains/example.com/aliases/:alias_id
Thông số cơ thể | Yêu cầu | Kiểu | Sự miêu tả |
---|---|---|---|
name | KHÔNG | Sợi dây | Tên bí danh |
recipients | KHÔNG | Chuỗi hoặc mảng | Danh sách người nhận (phải là Chuỗi hoặc chuỗi ngắt dòng/dấu cách/được phân tách bằng dấu phẩy gồm các địa chỉ email hợp lệ, tên miền đủ điều kiện ("FQDN"), địa chỉ IP và/hoặc URL webhook) |
description | KHÔNG | Sợi dây | Mô tả bí danh |
labels | KHÔNG | Chuỗi hoặc mảng | Danh sách các nhãn (phải là Chuỗi hoặc Mảng được phân tách bằng dấu ngắt dòng/dấu cách/bằng dấu phẩy) |
has_recipient_verification | KHÔNG | Boolean | Yêu cầu người nhận nhấp vào liên kết xác minh email để email đi qua (mặc định là cài đặt của miền nếu không được đặt rõ ràng trong nội dung yêu cầu) |
is_enabled | KHÔNG | Boolean | Bật hay tắt bí danh này (nếu bị tắt, email sẽ không được định tuyến đến đâu nhưng sẽ trả về mã trạng thái thành công) |
has_imap | KHÔNG | Boolean | Bật hay tắt bộ nhớ IMAP cho bí danh này (nếu tắt, các email gửi đến nhận được sẽ không được lưu trữ vào lưu trữ IMAP. Nếu một giá trị được truyền, nó sẽ được chuyển đổi thành boolean bằng cách sử dụng boolean) |
has_pgp | KHÔNG | Boolean | Nên bật hay tắt Mã hóa OpenPGP vì Lưu trữ email được mã hóa IMAP/POP3 sử dụng bí danh' public_key . |
public_key | KHÔNG | Sợi dây | Khóa công khai OpenPGP ở định dạng ASCII Armor (bấm vào đây để xem một ví dụ; ví dụ. Khóa GPG cho support@forwardemail.net ). Điều này chỉ áp dụng nếu bạn có has_pgp đặt thành true . Tìm hiểu thêm về mã hóa đầu cuối trong Câu hỏi thường gặp của chúng tôi. |
Yêu cầu ví dụ:
curl -X PUT https://api.forwardemail.net/v1/domains/example.com/aliases/:alias_id \
-u API_TOKEN:
Xóa bí danh tên miền
DELETE /v1/domains/:domain_name/aliases/:alias_id
Yêu cầu ví dụ:
curl -X DELETE https://api.forwardemail.net/v1/domains/:domain_name/aliases/:alias_id \
-u API_TOKEN: