API email

Hiện tại, chúng tôi vẫn 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ẽ làm như vậy 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 đơn giản là sử dụng Xoăn như trong các ví dụ dưới đây.

Đườ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 yêu cầu của bạn 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 đầu trang. Đừng lo lắng - các ví dụ được cung cấp bên dưới cho bạn nếu bạn không chắc chắn đây là gì.

Nếu 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 một thông báo lỗi chi tiết.

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ả cá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 đầu trang. Vui lòng 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ó phân trang, vui lòng gửi email api@forwardemail.net.

Tạo tài khoản

POST /v1/account

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

Yêu cầu ví dụ:

curl -X PUT https://api.forwardemail.net/v1/account \
  -u API_TOKEN: \
  -d "email=user%40gmail.com"

Vui lòng đả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, Đường dẫn trả lại và DMARC để gửi SMTP ra bên ngoài với miền của bạn.

Liệt kê email

Lưu ý rằng điểm cuối này không trả lại email đã tạo message, headers, accepted, cũng không rejectedErrors của cải.

Để trả về các 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 với một 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

Yêu cầu ví dụ:

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

tạo email

API của chúng tôi để tạo email được lấy cảm hứng và tận dụng cấu hình tùy chọn thư của Nodemailer. xin vui lòng trì hoãn để 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 những tùy chọn đó cho bạn), chúng tôi hỗ trợ tất cả các tùy chọn của 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ả tiêu đề hoặc là vượt qua các tùy chọn tham số cơ thể riêng lẻ bên dưới.

POST /v1/emails

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

Việc 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ỉ khi 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 xóa các email sau 30 ngày kể từ khi chúng được tạo và/hoặc gửi đi – do đó, bạn nên giữ một bản sao của các 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 khảo 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 thiết bị đầu 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:

Liệt kê tên miền

GET /v1/domains

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

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

Lấy 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 nhận hồ sơ 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 tên miền

PUT /v1/domains/example.com

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 tên miền mời

POST /v1/domains/example.com/invites

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 tên miền mời

DELETE /v1/domains/:domain_name/invites

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 tên miền

PUT /v1/domains/example.com/members/:member_id

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 tê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:

Liệt kê bí danh miền

GET /v1/domains/example.com/aliases

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

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 miền

Bạn có thể truy xuất bí danh 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

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: