پرش به مستندات
API

دریافت یک دامنه

نشانی‌هایی را که روی دامنه وجود دارند و اینکه هرکدام فعال است یا نه هم می‌افزاید.

GETapi.openemail.uk/domains/{id}

فراخوانی واقعی را با کلید خودتان روی فضای کاری شما اجرا می‌کند.

GET /domains/{id}

نشانی‌هایی را که روی دامنه وجود دارند و اینکه هرکدام فعال است یا نه هم می‌افزاید.

نمونه

به domains:read نیاز دارد.

curl
curl "$OE/domains/b3e1f0a4-6c2d-4e8a-9f17-2d5c8a0b4e6f" -H "$AUTH"
پاسخ
{  "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"}

نشانی غیرفعال دیگر تحویل‌پذیر نیست. نامه‌ای که به آن می‌رود در زمان SMTP رد می‌شود، پس فرستنده به‌جای سکوت یک bounce می‌گیرد.

آنچه هنوز نمی‌توانید اینجا انجام دهید

هنوز منتشر نشده

نوشتن‌هایی که این منبع می‌پذیرد، دامنهٔ ردیابی سفارشی و دامنهٔ فایل‌های سفارشی‌اند، هر دو از راه PATCH /domains/{id}. بقیهٔ راه‌اندازی یک دامنه فعلاً فقط در برنامه است.

  • افزودن یک دامنه، و خواندن رکوردهای DNS که باید منتشر شوند. GET گزارش می‌دهد که دامنه تأیید نشده، اما نمی‌گوید کدام رکورد کم است.
  • راه‌اندازی بررسی دوبارهٔ receiving یا sending. هیچ‌کدام نقطه پایانی ندارند، و هیچ‌کدام هم لازم ندارند: یک جاروب ساعتی خودش هر دامنهٔ تأییدنشده را دوباره بررسی می‌کند، پس منتشر کردن رکوردها و رهاکردنشان همهٔ کار است. به‌جای نظرسنجی روی GET /domains، مشترک domain.verified و domain.sending_changed شوید تا همان لحظه که یکی از آن‌ها تکان خورد به شما گفته شود. PATCH /domains/{id} تنها دامنهٔ ردیابی و دامنهٔ فایل‌ها را بررسی می‌کند.
  • ساختن، غیرفعال‌کردن یا مسیردهی یک نشانی. به‌اشتراک‌گذاشتنِ یکی ساخته شده، چون POST /members/{userId}/addresses نشانی‌ای موجود را در سطح member یا viewer به کسی می‌دهد. آنچه این منبع نمی‌تواند بکند، به‌وجودآوردنِ خودِ نشانی است.

همهٔ این‌ها در برنامه زیر Settings ← Domains هست. آنچه کم است سطح API است، نه خودِ قابلیت.