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 đề (ngoại trừ Liên hệ bí danh, Lịch bí danh, Và Hộp thư bí danh mà sử dụng một tạo tên người dùng và mật khẩu bí danh)..

Đừng lo lắng – các ví dụ được cung cấp bên dưới 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.

[!TIP] Nếu bạn nhận được mã trạng thái 5xx (điều này không nên 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.

[!LƯU Ý] Tính đến ngày 1 tháng 11 năm 2024, các điểm cuối API cho Liệt kê tên miền Và Liệt kê bí danh tên miền sẽ mặc định là 1000 kết quả tối đa trên mỗi trang. Nếu bạn muốn chọn tham gia hành vi này sớm, bạn có thể chuyển ?paginate=true như một tham số chuỗi truy vấn bổ sung cho URL cho truy vấn điểm cuối.

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

Tài sản 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ị nhỏ nhất là 10 và tối đa là 50 (trừ khi có ghi chú khác).

Để xác định 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):

Yêu cầu ví dụ:

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

[!LƯU Ý] Không giống như các điểm cuối API khác, những điểm cuối này yêu cầu Xác thực "username" bằng với tên người dùng bí danh và "password" bằng với mật khẩu được tạo bí danh làm tiêu đề Ủy quyền cơ bản.

[!CẢNH BÁO] Phần điểm cuối này đang trong quá trình hoàn thiện và sẽ được phát hành (hy vọng là vậy) vào năm 2024. Trong thời gian chờ đợi, vui lòng sử dụng ứng dụng khách IMAP từ menu thả xuống "Ứng dụng" trong phần điều hướng của trang web của chúng tôi.

[!NOTE] Hỗ trợ CardDAV hiện chưa khả dụng, hãy theo dõi cuộc thảo luận này trên GitHub để biết thông tin cập nhật.

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 lạc

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 lạc

DELETE /v1/contacts/:id

Sắp ra mắt

[!LƯU Ý] Không giống như các điểm cuối API khác, những điểm cuối này yêu cầu Xác thực "username" bằng với tên người dùng bí danh và "password" bằng với mật khẩu được tạo bí danh làm tiêu đề Ủy quyền cơ bản.

[!CẢNH BÁO] Phần điểm cuối này đang trong quá trình hoàn thiện và sẽ được phát hành (hy vọng là vậy) vào năm 2024. Trong thời gian chờ đợi, vui lòng sử dụng ứng dụng khách IMAP từ menu thả xuống "Ứng dụng" trong phần điều hướng của trang web của chúng tôi.

Danh sách lịch

GET /v1/calendars

Sắp ra mắt

Tạo lịch

POST /v1/calendars

Sắp ra mắt

Lấy lại 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

[!LƯU Ý] Không giống như các điểm cuối API khác, những điểm cuối này yêu cầu Xác thực "username" bằng với tên người dùng bí danh và "password" bằng với mật khẩu được tạo bí danh làm tiêu đề Ủy quyền cơ bản.

[!CẢNH BÁO] Phần điểm cuối này đang trong quá trình hoàn thiện và sẽ được phát hành (hy vọng là vậy) vào năm 2024. Trong thời gian chờ đợi, vui lòng sử dụng ứng dụng khách IMAP từ menu thả xuống "Ứng dụng" trong phần điều hướng của trang web của chúng tôi.

Hãy đả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.

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

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

GET /v1/messages

Sắp ra mắt

Tạo tin nhắn

[!LƯU Ý] Điều này sẽ NOT gửi email – nó chỉ đơn giản là thêm tin nhắn vào thư mục hộp thư của bạn (ví dụ: điều này tương tự như IMAP APPEND lệnh). Nếu bạn muốn gửi email, hãy xem Tạo email SMTP gửi đi bên dưới. Sau khi tạo email SMTP gửi đi, bạn có thể thêm một bản sao của email đó bằng điểm cuối này vào hộp thư bí danh của mình để lưu trữ.

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

[!TIP] Điểm cuối thư mục với đường dẫn của thư mục /v1/folders/:path vì điểm cuối của chúng có thể hoán đổi với ID của thư mục :id. Điều này có nghĩa là bạn có thể tham chiếu đến thư mục bằng cách path hoặc id giá trị.

[!CẢNH BÁO] Phần điểm cuối này đang trong quá trình hoàn thiện và sẽ được phát hành (hy vọng là vậy) vào năm 2024. Trong thời gian chờ đợi, vui lòng sử dụng ứng dụng khách IMAP từ menu thả xuống "Ứng dụng" trong phần điều hướng của trang web của chúng tôi.

Danh sách 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

Hãy đả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.

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 SMTP gửi đi

Đây là một điểm cuối đơn giản trả về một đối tượng JSON chứa count Và limit 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ê 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 email message, headers, cũng không rejectedErrors.

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

GET /v1/emails

Yêu cầu ví dụ:

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

Đ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 được tìm thấy trong tiêu đề (ví dụ: dòng chủ đề của Subject: 🤓 Hello đượ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

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`"

Lấy email SMTP gửi đi

GET /v1/emails/:id

Yêu cầu ví dụ:

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

Xóa email SMTP gửi đi

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:

[!TIP] Điểm cuối miền với tên miền /v1/domains/:domain_name vì điểm cuối của chúng có thể hoán đổi 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

[!LƯU Ý] Tính đến ngày 1 tháng 11 năm 2024, các điểm cuối API cho Liệt kê tên miền Và Liệt kê bí danh tên miền sẽ mặc định là 1000 kết quả tối đa trên mỗi trang. Nếu bạn muốn chọn tham gia hành vi này sớm, bạn có thể chuyển ?paginate=true như một tham số chuỗi truy vấn bổ sung cho URL cho truy vấn điểm cuối. Xem Phân trang để biết thêm thông tin chi tiết.

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

[!QUAN TRỌNG] Nếu người dùng được mời đã là thành viên được chấp nhận của bất kỳ miền nào khác mà quản trị viên mời họ là thành viên, thì nó sẽ tự động chấp nhận lời mời và không gửi email.

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:

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

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

[!LƯU Ý] Tính đến ngày 1 tháng 11 năm 2024, các điểm cuối API cho Liệt kê tên miền Và Liệt kê bí danh tên miền sẽ mặc định là 1000 kết quả tối đa trên mỗi trang. Nếu bạn muốn chọn tham gia hành vi này sớm, bạn có thể chuyển ?paginate=true như một tham số chuỗi truy vấn bổ sung cho URL cho truy vấn điểm cuối. Xem Phân trang để biết thêm thông tin chi tiết.

GET /v1/domains/example.com/aliases

Yêu cầu ví dụ:

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

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:

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ó phải được tích hợp sẵn trong tất cả các khía cạnh của sản phẩm. Như được yêu cầu cao trong một Thảo luận về Hướng dẫn về quyền riêng tư và hơn thế nữa vấn đề GitHub của chúng tôi chúng tôi đã thêm cái này.

Mã hóa bản ghi TXT

POST /v1/encrypt

Yêu cầu ví dụ:

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