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

دریافت نشانی برنامه وب

نشانی برنامه وب فضای کاری، اینکه افراد می‌توانند آنجا وارد شوند یا نه، و رکورد CNAME که لازم دارد. وقتی هیچ نشانی‌ای تنظیم نشده باشد، `status` برابر `none` است و `domains` دامنه‌هایی را فهرست می‌کند که نشانی می‌تواند زیر آن‌ها قرار بگیرد.

GET/app-host

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

GET /app-host

نشانی برنامه وب فضای کاری، اینکه افراد می‌توانند آنجا وارد شوند یا نه، و رکورد CNAME که لازم دارد. وقتی هیچ نشانی‌ای تنظیم نشده باشد، status برابر none است و domains دامنه‌هایی را فهرست می‌کند که نشانی می‌تواند زیر آن‌ها قرار بگیرد.

نشانی برنامه وب چیست

shell
export OE=https://api.openemail.ukexport AUTH="Authorization: Bearer $OPENEMAIL_API_KEY"

فضای کاری با طرح پولی می‌تواند برنامهٔ وب را، علاوه بر openemail.uk، روی زیردامنه‌ای از یکی از دامنه‌های تأییدشده‌اش هم باز کند، مانند mailbox.acme.com. این همان نشانی‌ای است که زبانهٔ برنامه با برند شما در تنظیمات ظاهرِ فضای کاری تنظیم می‌کند، و هر فضای کاری حداکثر یکی دارد.

فقط اعضای فضای کاری، افرادی که با یکی از نشانی‌هایش وارد می‌شوند و هر کسی که دعوت‌نامهٔ در انتظار دارد می‌توانند آنجا وارد شوند، و فقط آن‌ها ایمیل‌های بازنشانی گذرواژه و تأیید را از آنجا دریافت می‌کنند. تا وقتی فضای کاری در صفحهٔ ظاهر خود لوگویی تنظیم نکند، شبیه openemail.uk است و سپس لوگو، نشان و نام فضای کاری را به‌جای مال ما نشان می‌دهد. از آن پس ایمیل‌هایی که OpenEmail برایشان می‌فرستد برند را دارند، به همین نشانی پیوند می‌دهند و پس از تأیید رکوردهای امضای آن دامنه، از noreply@ دامنهٔ آن فرستاده می‌شوند.

به یک رکورد CNAME نیاز دارد که record آن را به‌تفصیل نشان می‌دهد. نشانی تا وقتی رکورد پاسخ دهد و گواهی‌اش صادر شود pending است، و پس از آن active. در طرح رایگان نشانی نگه داشته می‌شود اما متوقف است: paused برابر true است و تا وقتی فضای کاری دوباره روی طرح پولی نرود هیچ‌کس نمی‌تواند آنجا وارد شود.

نمونه

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

curl
curl "$OE/app-host" -H "$AUTH"
پاسخ
{  "object": "app_host",  "id": "ahost_3f9c2a71d0b84e56a1c7f2e9",  "host": "mailbox.acme.com",  "domainId": "b3e1f0a4-6c2d-4e8a-9f17-2d5c8a0b4e6f",  "domain": "acme.com",  "status": "active",  "active": true,  "paused": false,  "target": "cname.openemail.uk",  "record": {    "type": "CNAME",    "name": "mailbox.acme.com",    "value": "cname.openemail.uk"  },  "error": null,  "checkedAt": "2026-10-01T09:12:30.000Z",  "verifiedAt": "2026-10-01T09:04:11.000Z",  "available": true,  "paidPlan": true,  "domains": ["acme.com"],  "suggested": "mailbox.acme.com"}

خواندن آن، اگر آخرین بررسی نشانی بیش از 15 ثانیه پیش بوده باشد، آن را دوباره بررسی می‌کند، پس برای منتظر ماندن تا true شدن active همین مسیر را پیاپی بپرسید.

active فقط وقتی true است که status برابر active باشد و فضای کاری روی طرح پولی باشد. paused وقتی true است که نشانی‌ای تنظیم شده باشد و فضای کاری روی طرح رایگان باشد.

صندوق ورودی شما،
با شرایط خودتان.

زیرساخت ایمیل برای کسب‌وکارها، هوش مصنوعی، عامل‌ها و ایمیل شخصی. ساخته‌شده برای مقیاس، حریم خصوصی و کنترل. هر چه ایمیل باید از روز نخست می‌داشت.

© 2026 OpenEmail. همه حقوق محفوظ است.