- trang tìm kiếm
- Mục lục
API chuyển tiếp email
Thư viện
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@ionaryemail.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ôn ngữ | Thư viện |
---|---|
Hồng ngọc | Faraday |
Con trăn | yêu cầu |
Java | Được rồi |
PHP | ăn tham |
JavaScript | siêu tốc (chúng tôi là người bảo trì) |
Node.js | siêu tốc (chúng tôi là người bảo trì) |
Đi | mạng / http |
.NET | RestSharp |
URI cơ sở
Đường dẫn URI cơ sở HTTP hiện tại là: https://api.forwardemail.net
.
Xác thực
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ì.
Lỗi
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.
Mã | Tên |
---|---|
200 | OK |
400 | Yêu cầu xấu |
401 | Không được phép |
403 | Cấm |
404 | Không tìm thấy |
429 | Quá nhiều yêu cầu |
500 | Lỗi máy chủ nội bộ |
501 | Không được thực hiện |
502 | Cổng xấu |
503 | dịch vụ Không sẵn có |
504 | Cổng Time-out |
Bản địa hóa
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.
Phân trang
Nếu bạn muốn được thông báo khi có phân trang, vui lòng gửi email api@ionaryemail.net.
Tài khoản
Tạo tài khoản
POST /v1/account
Thông số cơ thể | Cần thiết | Kiểu | Sự miêu tả |
---|---|---|---|
email | Đúng | Chuỗi (Email) | Địa chỉ email |
password | Đúng | Chuỗi | Mậ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 -X GET 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ể | Cần thiết | Kiểu | Sự miêu tả |
---|---|---|---|
email | Không | Chuỗi (Email) | Địa chỉ email |
given_name | Không | Chuỗi | Tên đầu tiên |
family_name | Không | Chuỗi | Họ |
avatar_url | Không | Chuỗi (URL) | Liên kết đến hì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"
Tên miền
/v1/domains/:domain_name
vì đường dẫn của chúng có thể hoán đổi cho nhau bằng ID của miền :domain_id
. Điều này có nghĩa là bạn có thể tham chiếu đến miền bằng name
hoặc là id
giá trị.
Liệt kê tên miền
GET /v1/domains
Tham số chuỗi truy vấn | Cần thiết | Kiểu | Sự miêu tả |
---|---|---|---|
name | Không | Chuỗi (được hỗ trợ RegExp) | Tìm kiếm tên miền theo tên |
alias | Không | Chuỗi (được hỗ trợ RegExp) | Tìm kiếm tên miền theo tên bí danh |
recipient | Không | Chuỗi (được hỗ trợ RegExp) | Tìm kiếm tên miền theo người nhận |
Yêu cầu ví dụ:
curl -X GET https://api.forwardemail.net/v1/domains \
-u API_TOKEN:
Tạo tên miền
POST /v1/domains
Thông số cơ thể | Cần thiết | Kiểu | Sự miêu tả |
---|---|---|---|
domain | Đúng | Chuỗi (FQDN hoặc IP) | Tên miền đủ điều kiện ("FQDN") hoặc địa chỉ IP |
plan | Không | Chuỗi (liệt kê) | 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 trên một) |
catchall | Không | Chuỗi (địa chỉ email được phân tách) hoặc Boolean | Tạo bí danh nhận toàn bộ thư mặc định, mặc định là true (nếu 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 không có tất cả sẽ được tạo). Nếu một Chuỗi được chuyển, thì đó là danh sách đị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_protection | Không | Boolean | Có bật tính năng bảo vệ nội dung người lớn Spam Scanner trên miền này hay không |
has_phishing_protection | Không | Boolean | Có bật tính năng bảo vệ chống lừa đảo Spam Scanner trên miền này hay không |
has_executable_protection | Không | Boolean | Có bật tính năng bảo vệ thực thi Spam Scanner trên miền này hay không |
has_virus_protection | Không | Boolean | Có 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_verification | Không | Boolean | Miền toàn cầu 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 |
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 -X GET 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 -X GET 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
Thông số cơ thể | Cần thiết | Kiểu | Sự miêu tả |
---|---|---|---|
smtp_port | Không | Chuỗ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_protection | Không | Boolean | Có bật tính năng bảo vệ nội dung người lớn Spam Scanner trên miền này hay không |
has_phishing_protection | Không | Boolean | Có bật tính năng bảo vệ chống lừa đảo Spam Scanner trên miền này hay không |
has_executable_protection | Không | Boolean | Có bật tính năng bảo vệ thực thi Spam Scanner trên miền này hay không |
has_virus_protection | Không | Boolean | Có 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_verification | Không | Boolean | Miền toàn cầu 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 |
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:
Mời
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 -X GET 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
Thông số cơ thể | Cần thiết | Kiểu | Sự miêu tả |
---|---|---|---|
email | Đúng | Chuỗi (Email) | Địa chỉ email để mời vào danh sách thành viên tên miền |
group | Đúng | Chuỗi (liệt kê) | Nhóm để thêm người dùng vào tư cách thành viên miền với (có thể là một trong số "admin" hoặc là "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 tên miền mời
DELETE /v1/domains/:domain_name/invites
Thông số cơ thể | Cần thiết | Kiểu | Sự miêu tả |
---|---|---|---|
email | Đúng | Chuỗi (Email) | Địa chỉ email để 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ác thành viên
Cập nhật thành viên tên miền
PUT /v1/domains/example.com/members/:member_id
Thông số cơ thể | Cần thiết | Kiểu | Sự miêu tả |
---|---|---|---|
group | Đúng | Chuỗi (liệt kê) | Nhóm để cập nhật người dùng lên thành viên miền với (có thể là một trong số "admin" hoặc là "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 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:
Bí danh
Liệt kê bí danh miền
GET /v1/domains/example.com/aliases
Tham số chuỗi truy vấn | Cần thiết | Kiểu | Sự miêu tả |
---|---|---|---|
name | Không | Chuỗi (được hỗ trợ RegExp) | Tìm kiếm bí danh trong miền theo tên |
recipient | Không | Chuỗi (được hỗ trợ RegExp) | Tìm kiếm bí danh trong miền của người nhận |
Yêu cầu ví dụ:
curl -X GET 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ể | Cần thiết | Kiểu | Sự miêu tả |
---|---|---|---|
name | Đúng | Chuỗi | Tên bí danh |
recipients | Đúng | Chuỗi hoặc mảng | Danh sách người nhận (phải là chuỗi ngắt dòng / dấu cách / dấu cách được phân tách bằng dấu phẩy hoặc Mảng địa chỉ email hợp lệ, tên miền đủ điều kiện ("FQDN"), địa chỉ IP và / hoặc URL của webhook) |
description | Không | Chuỗi | Mô tả bí danh |
labels | Không | Chuỗi hoặc mảng | Danh sách các nhãn (phải là chuỗi hoặc mảng được phân tách bằng dấu phẩy / dấu cách |
has_recipient_verification | Không | Boolean | Có bật để yêu cầu người nhận nhấp vào liên kết xác minh email để email đi qua hay không (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_enabled | Không | Boolean | Có bật hay không để tắt bí danh này (nếu bị tắt, email sẽ không được chuyển đến đâu nhưng trả về mã trạng thái thành công) |
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
Thông số cơ thể | Cần thiết | Kiểu | Sự miêu tả |
---|---|---|---|
name | Không | Chuỗi | Tên bí danh |
recipients | Đúng | Chuỗi hoặc mảng | Danh sách người nhận (phải là chuỗi ngắt dòng / dấu cách / dấu cách được phân tách bằng dấu phẩy hoặc Mảng địa chỉ email hợp lệ, tên miền đủ điều kiện ("FQDN"), địa chỉ IP và / hoặc URL của webhook) |
description | Không | Chuỗi | Mô tả bí danh |
labels | Không | Chuỗi hoặc mảng | Danh sách các nhãn (phải là chuỗi hoặc mảng được phân tách bằng dấu phẩy / dấu cách |
has_recipient_verification | Không | Boolean | Có bật để yêu cầu người nhận nhấp vào liên kết xác minh email để email đi qua hay không (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_enabled | Không | Boolean | Có bật hay không để tắt bí danh này (nếu bị tắt, email sẽ không được chuyển đến đâu nhưng trả về mã trạng thái thành công) |
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: