API email

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ọcFaraday
Pythonyêu cầu
JavaOkHttp
PHPăn tham
JavaScriptsiêu chất (chúng tôi là người bảo trì)
Node.jssiêu chất (chúng tôi là người bảo trì)
Đimạng/http
.NETRestSharp

Đường dẫn URI cơ sở HTTP hiện tại là: https://api.forwardemail.net.

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ì.

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
200OK
400Yêu cầu xấu
401Không được phép
403Cấm
404Không tìm thấy
429Quá nhiều yêu cầu
500Lỗi máy chủ nội bộ
501Không được thực hiện
502Cổng xấu
503dịch vụ Không sẵn có
504Cổng Time-out
Mẹo: Nếu bạn nhận được mã trạng thái 5xx (điều này sẽ không xảy ra), vui lòng liên hệ với chúng tôi theo địa chỉ api@forwardemail.net và chúng tôi sẽ giúp bạn giải quyết vấn đề của bạn ngay lập tức.

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.

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.

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ấnYêu cầuKiểuSự miêu tả
domainKHÔNGChuỗ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.
qKHÔNGSợi dâyTì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ạo tài khoản

POST /v1/account

Thông số cơ thểYêu cầuKiểuSự miêu tả
emailĐúngChuỗi (Email)Địa chỉ email
passwordĐúngSợi dâyMậ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ầuKiểuSự miêu tả
emailKHÔNGChuỗi (Email)Địa chỉ email
given_nameKHÔNGSợi dâyTên đầu tiên
family_nameKHÔNGSợi dâyHọ
avatar_urlKHÔNGChuỗ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.

Nhận giới hạn email

Đây là một điểm cuối đơn giản trả về một đối tượng JSON chứa countlimit về số lượng tin nhắn gửi đi SMTP hàng ngày trên cơ sở mỗi tài khoản.

GET /v1/emails/limit

Yêu cầu ví dụ:

curl https://api.forwardemail.net/v1/emails/limit \
  -u API_TOKEN:

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ấnYêu cầuKiểuSự miêu tả
qKHÔNGChuỗi (hỗ trợ RegExp)Tìm kiếm email theo siêu dữ liệu
domainKHÔNGChuỗi (hỗ trợ RegExp)Tìm kiếm email theo tên miền
pageKHÔNGCon sốTrang trả về kết quả (mặc định là 1)
`giới hạnKHÔNGCon 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ừ envelopedkim (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 disableFileAccessdisableUrlAccess 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ầuKiểuSự miêu tả
fromKHÔNGChuỗ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).
toKHÔNGChuỗi hoặc mảngDanh 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".
ccKHÔNGChuỗi hoặc mảngDanh 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".
bccKHÔNGChuỗi hoặc mảngDanh 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".
subjectKHÔNGSợi dâyChủ đề của email.
textKHÔNGChuỗi hoặc bộ đệmPhiên bản văn bản gốc của tin nhắn.
htmlKHÔNGChuỗi hoặc bộ đệmPhiên bản HTML của tin nhắn.
attachmentsKHÔNGMảngMột mảng các đối tượng đính kèm (xem Các trường chung của Nodemailer).
senderKHÔNGSợ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).
replyToKHÔNGSợi dâyĐịa chỉ email cho tiêu đề "Trả lời".
inReplyToKHÔNGSợi dâyID tin nhắn mà tin nhắn được trả lời.
referencesKHÔNGChuỗi hoặc mảngDanh sách được phân tách bằng dấu cách hoặc Mảng ID tin nhắn.
attachDataUrlsKHÔNGBooleanNế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.
watchHtmlKHÔNGSợi dâyPhiê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).
ampKHÔNGSợi dâyPhiên bản HTML cụ thể của AMP4EMAIL của tin nhắn (xem Ví dụ của Nodemailer).
icalEventKHÔNGSự vậtSự 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).
alternativesKHÔNGMảngMảng nội dung tin nhắn thay thế (xem Nội dung thay thế của Nodemailer).
encodingKHÔNGSợi dâyMã hóa cho chuỗi văn bản và HTML (mặc định là "utf-8", nhưng hỗ trợ "hex""base64" giá trị mã hóa là tốt).
rawKHÔNGChuỗi hoặc bộ đệmMộ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).
textEncodingKHÔNGSợi dâyMã 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").
priorityKHÔNGSợi dâyMứ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.
headersKHÔNGĐối tượng hoặc mảngMộ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).
messageIdKHÔNGSợi dâyGiá 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).
dateKHÔNGChuỗi hoặc NgàyGiá 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.
listKHÔNGSự 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 emailTruy 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:

Mẹo: Điểm cuối miền có 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ấnYêu cầuKiểuSự miêu tả
qKHÔNGChuỗi (hỗ trợ RegExp)Tìm kiếm tên miền theo tên
nameKHÔNGChuỗ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ầuKiểuSự miêu tả
domainĐúngChuỗi (FQDN hoặc IP)Tên miền đủ điều kiện ("FQDN") hoặc địa chỉ IP
planKHÔNGChuỗ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ó)
catchallKHÔNGChuỗi (địa chỉ email được phân tách) hoặc BooleanTạ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_protectionKHÔNGBooleanCó 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_protectionKHÔNGBooleanCó 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_protectionKHÔNGBooleanCó 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_protectionKHÔNGBooleanCó 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_verificationKHÔNGBooleanMiề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_daysKHÔNGCon sốSố nguyên giữa 030 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ầuKiểuSự miêu tả
smtp_portKHÔNGChuỗ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_protectionKHÔNGBooleanCó 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_protectionKHÔNGBooleanCó 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_protectionKHÔNGBooleanCó 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_protectionKHÔNGBooleanCó 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_verificationKHÔNGBooleanMiề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_daysKHÔNGCon sốSố nguyên giữa 030 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:

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ầuKiểuSự miêu tả
emailĐúngChuỗi (Email)Địa chỉ email để mời vào danh sách thành viên tên miền
groupĐúngChuỗ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ầuKiểuSự miêu tả
emailĐúngChuỗ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ậ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ầuKiểuSự miêu tả
groupĐúngChuỗ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:

Tạo mật khẩu bí danh

Lưu ý rằng nếu bạn không gửi hướng dẫn qua email thì tên người dùng và mật khẩu sẽ nằm trong phần phản hồi JSON của một yêu cầu thành công ở định dạng { username: 'alias@yourdomain.com', password: 'some-generated-password' }.

POST /v1/domains/example.com/aliases/:alias_id/generate-password

Thông số cơ thểYêu cầuKiểuSự miêu tả
new_passwordKHÔNGSợi dâyMật khẩu mới tùy chỉnh của bạn để sử dụng cho bí danh. Lưu ý rằng bạn có thể để trống hoặc thiếu hoàn toàn phần này khỏi nội dung yêu cầu API của mình nếu bạn muốn nhận mật khẩu mạnh và được tạo ngẫu nhiên.
passwordKHÔNGSợi dâyMật khẩu hiện tại cho bí danh để thay đổi mật khẩu mà không xóa bộ nhớ hộp thư IMAP hiện có (xem is_override tùy chọn bên dưới nếu bạn không còn mật khẩu hiện tại).
is_overrideKHÔNGBooleanUSE WITH CAUTION: Điều này sẽ ghi đè hoàn toàn mật khẩu và cơ sở dữ liệu bí danh hiện có, đồng thời sẽ xóa vĩnh viễn bộ lưu trữ IMAP hiện có và đặt lại hoàn toàn cơ sở dữ liệu email SQLite của bí danh. Vui lòng tạo bản sao lưu nếu có thể nếu bạn có hộp thư hiện có gắn với bí danh này.
emailed_instructionsKHÔNGSợi dâyĐịa chỉ email để gửi mật khẩu và hướng dẫn thiết lập bí danh tới.

Yêu cầu ví dụ:

curl -X POST https://api.forwardemail.net/v1/domains/example.com/aliases/:alias_id/generate-password \
  -u API_TOKEN:

Liệt kê bí danh tên miền

GET /v1/domains/example.com/aliases

Tham số chuỗi truy vấnYêu cầuKiểuSự miêu tả
qKHÔNGChuỗi (hỗ trợ RegExp)Tìm kiếm bí danh trong miền theo tên, nhãn hoặc người nhận
nameKHÔNGChuỗi (hỗ trợ RegExp)Tìm kiếm bí danh trong một miền theo tên
recipientKHÔNGChuỗ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ầuKiểuSự miêu tả
nameKHÔNGSợi dâyTê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)
recipientsKHÔNGChuỗi hoặc mảngDanh 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)
descriptionKHÔNGSợi dâyMô tả bí danh
labelsKHÔNGChuỗi hoặc mảngDanh 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_verificationKHÔNGBooleanYê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_enabledKHÔNGBooleanBậ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_imapKHÔNGBooleanBậ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_pgpKHÔNGBooleanNên bật hay tắt Mã hóa OpenPGPLưu trữ email được mã hóa IMAP/POP3 sử dụng bí danh' public_key.
public_keyKHÔNGSợi dâyKhó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ầuKiểuSự miêu tả
nameKHÔNGSợi dâyTên bí danh
recipientsKHÔNGChuỗi hoặc mảngDanh 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)
descriptionKHÔNGSợi dâyMô tả bí danh
labelsKHÔNGChuỗi hoặc mảngDanh 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_verificationKHÔNGBooleanYê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_enabledKHÔNGBooleanBậ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_imapKHÔNGBooleanBậ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_pgpKHÔNGBooleanNên bật hay tắt Mã hóa OpenPGPLưu trữ email được mã hóa IMAP/POP3 sử dụng bí danh' public_key.
public_keyKHÔNGSợi dâyKhó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: