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

فهرست دامنه‌ها

هر دامنه روی فضای کاری، با وضعیت دریافت، ارسال، ردیابی و فایل‌هایش.

GETapi.openemail.uk/domains

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

GET /domains

هر دامنه روی فضای کاری، با وضعیت دریافت، ارسال، ردیابی و فایل‌هایش.

دریافت و ارسال از هم جدا هستند

هر دامنه دریافت و ارسال را به‌صورت دو شیء وضعیتِ مستقل گزارش می‌کند. receiving.verified یعنی MX دامنه نامه‌اش را به اینجا می‌آورد و چالش مالکیتش منتشر شده، پس دامنه می‌تواند تحویل بگیرد. این هیچ چیزی دربارهٔ خروجی نمی‌گوید.

sending نیمهٔ خروجی است، و به‌جای یک بررسی تازه از بررسی امضای ذخیره‌شدهٔ دامنه خوانده می‌شود. sending.status یکی از verified، pending، failed، no_identity یا unknown است، sending.canSend می‌گوید که آیا ارسال از این دامنه همین حالا پذیرفته می‌شود، sending.checkedAt تاریخ آن حکم است، sending.error آخرین شکست را با خود دارد، و sending.note جمله‌ای است که وضعیت را توضیح می‌دهد. حکم منفی‌ای که بیش از یک روز از آن گذشته باشد به‌جای رد، ناشناخته به شمار می‌آید، پس canSend می‌تواند درست باشد در حالی که status برابر pending است.

tracking شیء سومی است، دربارهٔ دامنهٔ ردیابی سفارشی و اختیاری دامنه، نه دربارهٔ نامه‌اش. tracking.status تا وقتی یکی تنظیم نشود none است، چه در برنامه و چه با PATCH /domains/{id} که صفحه‌اش هر فیلد را توضیح می‌دهد.

storage شیء چهارمی با همان فیلدهاست، دربارهٔ دامنهٔ فایل‌های سفارشی و اختیاری دامنه: نامی که پیوندهای دانلودِ فایل‌های ارسالی از آن دامنه از آن استفاده می‌کنند. به همان شکل و در همان صفحه تنظیم می‌شود، و storage.status تا وقتی یکی تنظیم نشود none است.

نمونه

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

curl
curl "$OE/domains" -H "$AUTH"
پاسخ
{  "object": "list",  "data": [    {      "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      },      "createdAt": "2026-08-14T09:55:11.000Z"    }  ]}

lastCheckedAt برابر null یعنی هرگز به DNS نگاه نشده: «هنوز نگاه نکرده‌ایم»، نه «شکست خورد». سی ثانیه پس از افزودن یک دامنه، این دو خیلی متفاوت خوانده می‌شوند.