API

Lấy một tên miền

Bổ sung các địa chỉ hiện có trên tên miền và cho biết từng địa chỉ có được bật hay không.

GETapi.openemail.uk/domains/{id}

Chạy lệnh gọi thật với không gian làm việc của bạn, bằng khóa của chính bạn.

GET /domains/{id}

Bổ sung các địa chỉ hiện có trên tên miền và cho biết từng địa chỉ có được bật hay không.

Ví dụ

Cần domains:read.

curl

curl "$OE/domains/b3e1f0a4-6c2d-4e8a-9f17-2d5c8a0b4e6f" -H "$AUTH"

Phản hồi

{  "object": "domain",  "id": "b3e1f0a4-6c2d-4e8a-9f17-2d5c8a0b4e6f",  "domain": "acme.com",  "receiving": {    "verified": true,    "verifiedAt": "2026-08-14T10:02:00.000Z",    "catchAll": false,    "lastCheckedAt": "2026-08-29T06:00:00.000Z",    "error": null  },  "sending": {    "status": "verified",    "canSend": true,    "checkedAt": "2026-08-29T06:00:00.000Z",    "error": null,    "note": "Mail from this domain is signed and can be sent."  },  "tracking": {    "host": "links.acme.com",    "status": "active",    "active": true,    "target": "oelinks3f9a1c7e2b8d4a60.edge.openemail.uk",    "record": { "type": "CNAME", "name": "links.acme.com", "value": "oelinks3f9a1c7e2b8d4a60.edge.openemail.uk" },    "checkedAt": "2026-08-29T06:10:00.000Z",    "verifiedAt": "2026-08-29T06:10:00.000Z",    "error": null  },  "storage": {    "host": "files.acme.com",    "status": "active",    "active": true,    "target": "oefiles81c40d6b2f7e9a35.edge.openemail.uk",    "record": { "type": "CNAME", "name": "files.acme.com", "value": "oefiles81c40d6b2f7e9a35.edge.openemail.uk" },    "checkedAt": "2026-08-29T06:10:00.000Z",    "verifiedAt": "2026-08-29T06:10:00.000Z",    "error": null  },  "addresses": [    { "address": "[email protected]", "enabled": true },    { "address": "[email protected]", "enabled": false }  ],  "createdAt": "2026-08-14T09:55:11.000Z"}

Một địa chỉ bị tắt sẽ không còn nhận được thư. Thư gửi tới nó bị từ chối ngay ở bước SMTP, nên người gửi nhận được thư trả về (bounce) thay vì không nhận được phản hồi gì.

Những việc chưa thể làm ở đây

Chưa phát hành

Các thao tác ghi mà tài nguyên này nhận là tên miền theo dõi tùy chỉnh và tên miền tệp tùy chỉnh, đều qua PATCH /domains/{id}. Phần thiết lập còn lại của tên miền hiện chỉ thực hiện được trong ứng dụng.

Thêm tên miền và đọc các bản ghi DNS cần công bố. GET cho biết tên miền chưa được xác minh nhưng không cho biết bản ghi nào còn thiếu.
Kích hoạt kiểm tra lại receiving hoặc sending. Cả hai đều không có endpoint, và cũng không cần: một lượt quét hằng giờ tự kiểm tra lại mọi tên miền chưa xác minh, nên bạn chỉ cần công bố các bản ghi rồi để nguyên. Hãy đăng ký domain.verified và domain.sending_changed thay vì liên tục gọi GET /domains, và bạn sẽ được báo ngay khi một trong hai thay đổi. PATCH /domains/{id} chỉ kiểm tra tên miền theo dõi và tên miền tệp.
Tạo, tắt hoặc định tuyến một địa chỉ. Việc CHIA SẺ địa chỉ thì đã có, vì POST /members/{userId}/addresses giao một địa chỉ hiện có cho ai đó ở cấp member hoặc viewer. Điều tài nguyên này không làm được là tạo ra địa chỉ.

Tất cả những chức năng này đều có trong ứng dụng tại Cài đặt → Tên miền. Thứ còn thiếu là giao diện API, không phải khả năng.