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

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

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

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"

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

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

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:

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

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

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

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

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

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:

Liệt kê bí danh tên 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 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

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: