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ẽ sớm ra mắt trong tương lai gần. Vui lòng gửi email đến api@forwardemail.net nếu bạn muốn nhận 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 thời gian chờ đợi, 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ụ bên dưới.

Đườ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 Khóa API của bạn được đặt làm giá trị "tên người dùng" của tiêu đề Ủy quyền cơ bản của yêu cầu (ngoại trừ Liên hệ bí danh, Lịch bí danh và Hộp thư bí danh sử dụng tên người dùng và mật khẩu bí danh đã tạo)..

Đừng lo lắng – các ví dụ được cung cấp bên dưới nếu bạn không chắc chắn đây là gì.

Nếu xảy ra bất kỳ lỗi nào, 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ả các thông báo phản hồi API đều được dịch sang ngôn ngữ gần nhất được phát hiện bởi 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 truyền tiêu đề Accept-Language tùy chỉnh. Bạn có thể dùng thử bằng cách sử dụng menu thả xuống ngôn ngữ ở cuối trang này.

Phân trang được hỗ trợ bởi tất cả các điểm cuối API liệt kê kết quả.

Chỉ cần cung cấp các thuộc tính chuỗi truy vấn page (và tùy chọn limit).

Thuộc tính page phải là một số lớn hơn hoặc bằng 1. Nếu bạn cung cấp limit (cũng là một số), thì giá trị tối thiểu là 10 và tối đa là 50 (trừ khi có ghi chú khác).

Để xác định xem có thêm kết quả hay không, chúng tôi cung cấp các tiêu đề phản hồi HTTP sau (bạn có thể phân tích cú pháp để phân trang theo chương trình):

Ví dụ yêu cầu:

curl https://api.forwardemail.net/v1/domains/example.com/aliases?page=2&pagination=true \
  -u API_TOKEN:

Truy xuất nhật ký

API của chúng tôi cho phép bạn tải xuống nhật ký cho tài khoản của mình theo chương trì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 qua email cho bạn dưới dạng tệp đính kèm (tệp bảng tính Gzip được nén CSV) sau khi hoàn tất.

Tính năng này cho phép bạn tạo các tác vụ nền với Công việc Cron hoặc sử dụng Phần mềm lập lị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 bị giới hạn ở 10 yêu cầu mỗi ngày.

Tệp đính kèm có dạng chữ thường của email-deliverability-logs-YYYY-MM-DD-h-mm-A-z.csv.gz và email chứa bản tóm tắt ngắn gọn về các 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

Ví dụ yêu cầu:

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

Ví dụ về công việc Cron (vào lúc nửa đêm mỗi 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 cron của mình.

Ví dụ về công việc Cron (vào lúc nửa đêm mỗi ngày và có 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

Ví dụ yêu cầu:

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

Ví dụ yêu cầu:

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

Cập nhật tài khoản

PUT /v1/account

Ví dụ yêu cầu:

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

Liệt kê danh bạ

GET /v1/contacts

Sắp ra mắt

Tạo liên hệ

POST /v1/contacts

Sắp ra mắt

Lấy lại liên hệ

GET /v1/contacts/:id

Sắp ra mắt

Cập nhật liên hệ

PUT /v1/contacts/:id

Sắp ra mắt

Xóa liên hệ

DELETE /v1/contacts/:id

Sắp ra mắt

Liệt kê lịch

GET /v1/calendars

Sắp ra mắt

Tạo lịch

POST /v1/calendars

Sắp ra mắt

Truy xuất lịch

GET /v1/calendars/:id

Sắp ra mắt

Cập nhật lịch

PUT /v1/calendars/:id

Sắp ra mắt

Xóa lịch

DELETE /v1/calendars/:id

Sắp ra mắt

Vui lòng đảm bảo rằng bạn đã làm theo hướng dẫn thiết lập cho tên miền của mình.

Bạn có thể tìm thấy hướng dẫn này trong phần Câu hỏi thường gặp Bạn có hỗ trợ nhận email bằng IMAP không? của chúng tôi.

Liệt kê và tìm kiếm tin nhắn

GET /v1/messages

Sắp ra mắt

Tạo tin nhắn

POST /v1/messages

Sắp ra mắt

Lấy lại tin nhắn

GET /v1/messages/:id

Sắp ra mắt

Cập nhật tin nhắn

PUT /v1/messages/:id

Sắp ra mắt

Xóa tin nhắn

DELETE /v1/messages:id

Sắp ra mắt

Liệt kê các thư mục

GET /v1/folders

Sắp ra mắt

Tạo thư mục

POST /v1/folders

Sắp ra mắt

Lấy lại thư mục

GET /v1/folders/:id

Sắp ra mắt

Cập nhật thư mục

PUT /v1/folders/:id

Sắp ra mắt

Xóa thư mục

DELETE /v1/folders/:id

Sắp ra mắt

Sao chép thư mục

POST /v1/folders/:id/copy

Sắp ra mắt

Vui lòng đảm bảo rằng bạn đã làm theo hướng dẫn thiết lập cho tên miền của mình.

Bạn có thể tìm thấy hướng dẫn nà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 tên miền của mình.

Nhận giới hạn email SMTP gửi đi

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

GET /v1/emails/limit

Ví dụ yêu cầu:

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

Liệt kê các email SMTP gửi đi

Lưu ý rằng điểm cuối này không trả về giá trị thuộc tính cho message, headers hay rejectedErrors của email.

Để trả về các thuộc tính đó và giá trị của chúng, vui lòng sử dụng điểm cuối Lấy lại email với ID email.

GET /v1/emails

Ví dụ yêu cầu:

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

Tạo email SMTP gửi đi

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 tin nhắn của Nodemailer. Vui lòng tham khảo Cấu hình tin nhắn Nodemailer cho tất cả các tham số nội dung bên dưới.

Xin lưu ý rằng ngoại trừ envelope và dkim (vì chúng tôi tự động thiết lập 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 các tùy chọn disableFileAccess và disableUrlAccess thành true vì lý do bảo mật.

Bạn nên truyền tùy chọn duy nhất raw vào email đầy đủ thô của bạn bao gồm cả tiêu đề hoặc truyền từng tùy chọn tham số nội dung bên dưới.

Điểm cuối API này sẽ tự động mã hóa biểu tượng cảm xúc cho bạn nếu chúng xuất hiện trong tiêu đề (ví dụ: dòng chủ đề Subject: 🤓 Hello sẽ tự động được chuyển đổi thành Subject: =?UTF-8?Q?=F0=9F=A4=93?= Hello). Mục tiêu của chúng tôi là tạo ra một API email cực kỳ thân thiện với nhà phát triển và không thể bị giả mạo.

POST /v1/emails

Ví dụ yêu cầu:

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"

Ví dụ yêu cầu:

curl -X POST https://api.forwardemail.net/v1/emails \
  -u API_TOKEN: \
  -d "raw=`cat file.eml`"

Truy xuất email SMTP gửi đi

GET /v1/emails/:id

Ví dụ yêu cầu:

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

Xóa email SMTP gửi đi

Việc xóa email sẽ đặt trạng thái thành "rejected" (và sau đó không xử lý email trong hàng đợi) nếu và chỉ khi trạng thái hiện tại là một trong các trạng thái "pending", "queued" hoặc "deferred". Chúng tôi có thể tự động xóa email sau 30 ngày kể từ khi email được tạo và/hoặc gửi – do đó, bạn nên lưu một bản sao email SMTP gửi đi trong máy 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 nếu muốn – giá trị này được trả về từ cả hai điểm cuối Tạo email và Lấy lại email.

DELETE /v1/emails/:id

Ví dụ yêu cầu:

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

Liệt kê các miền

GET /v1/domains

Ví dụ yêu cầu:

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

Tạo tên miền

POST /v1/domains

Ví dụ yêu cầu:

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

Ví dụ yêu cầu:

curl https://api.forwardemail.net/v1/domains/example.com \
  -u API_TOKEN:

Xác minh bản ghi miền

GET /v1/domains/example.com/verify-records

Ví dụ yêu cầu:

curl https://api.forwardemail.net/v1/domains/example.com/verify-records \
  -u API_TOKEN:

Xác minh bản ghi SMTP của miền

GET /v1/domains/example.com/verify-smtp

Ví dụ yêu cầu:

curl https://api.forwardemail.net/v1/domains/example.com/verify-smtp \
  -u API_TOKEN:

Liệt kê mật khẩu bắt tất cả trên toàn miền

GET /v1/domains/example.com/catch-all-passwords

Ví dụ yêu cầu:

curl https://api.forwardemail.net/v1/domains/example.com/catch-all-passwords \
  -u API_TOKEN:

Tạo mật khẩu bắt tất cả trên toàn miền

POST /v1/domains/example.com/catch-all-passwords

Ví dụ yêu cầu:

curl BASE_URL/v1/domains/example.com/catch-all-passwords \
  -u API_TOKEN:

Xóa mật khẩu bắt tất cả trên toàn miền

DELETE /v1/domains/example.com/catch-all-passwords/:token_id

Ví dụ yêu cầu:

curl -X DELETE https://api.forwardemail.net/v1/domains/:domain_name/catch-all-passwords/:token_id \
  -u API_TOKEN:

Cập nhật tên miền

PUT /v1/domains/example.com

Ví dụ yêu cầu:

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

Ví dụ yêu cầu:

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

Ví dụ yêu cầu:

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

Ví dụ yêu cầu:

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

Ví dụ yêu cầu:

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

Ví dụ yêu cầu:

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

Ví dụ yêu cầu:

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 nội dung phản hồi JSON của yêu cầu thành công theo định dạng { username: 'alias@yourdomain.com', password: 'some-generated-password' }.

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

Ví dụ yêu cầu:

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

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

GET /v1/domains/example.com/aliases

Ví dụ yêu cầu:

curl https://api.forwardemail.net/v1/domains/example.com/aliases?pagination=true \
  -u API_TOKEN:

Tạo bí danh tên miền mới

POST /v1/domains/example.com/aliases

Ví dụ yêu cầu:

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ể lấy bí danh tên miền bằng giá trị id hoặc name.

GET /v1/domains/:domain_name/aliases/:alias_id

Ví dụ yêu cầu:

curl https://api.forwardemail.net/v1/domains/:domain_name/aliases/:alias_id \
  -u API_TOKEN:

GET /v1/domains/:domain_name/aliases/:alias_name

Ví dụ yêu cầu:

curl https://api.forwardemail.net/v1/domains/:domain_name/aliases/:alias_name \
  -u API_TOKEN:

Cập nhật bí danh miền

PUT /v1/domains/example.com/aliases/:alias_id

Ví dụ yêu cầu:

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

Ví dụ yêu cầu:

curl -X DELETE https://api.forwardemail.net/v1/domains/:domain_name/aliases/:alias_id \
  -u API_TOKEN:

Chúng tôi cho phép bạn mã hóa hồ sơ ngay cả trên gói miễn phí mà không mất phí. Quyền riêng tư không nên là một tính năng, mà nên được tích hợp sẵn trong mọi khía cạnh của sản phẩm. Theo yêu cầu cao trong Thảo luận về Hướng dẫn Quyền riêng tư và trên các vấn đề GitHub của chúng tôi, chúng tôi đã thêm tính năng này.

Mã hóa bản ghi TXT

POST /v1/encrypt

Ví dụ yêu cầu:

curl -X POST https://api.forwardemail.net/v1/encrypt \
  -d "input=user@gmail.com"