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

مسدود کردن مخاطب

نشانی را در فهرست مسدودی فضای کاری می‌گذارد، همان فهرستی که `PATCH /settings` به‌صورت `blockedSenders` ویرایش می‌کند، تا از آن پس نامه‌اش رد شود. این همان مسدود کردن روی یک مخاطب در برنامه است. نشانی لازم نیست مخاطب باشد.

POSTapi.openemail.uk/contacts/{email}/block

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

POST /contacts/{email}/block

نشانی را در فهرست مسدودی فضای کاری می‌گذارد، همان فهرستی که PATCH /settings به‌صورت blockedSenders ویرایش می‌کند، تا از آن پس نامه‌اش رد شود. این همان مسدود کردن روی یک مخاطب در برنامه است. نشانی لازم نیست مخاطب باشد.

نمونه

به settings:write نیاز دارد، چون فهرست مسدودی را می‌نویسد نه مخاطب را. @ را URL-encode کنید.

curl
curl -X POST "$OE/contacts/offers%2Bweekly%40shop.example/block" -H "$AUTH"
پاسخ
{  "object": "contact_block",  "email": "[email protected]",  "blocked": true,  "blockedBy": { "rule": "[email protected]", "list": "blockedSenders" },  "created": true}

برچسب بعلاوه کنار گذاشته می‌شود، پس مسدود کردن [email protected] نشانی [email protected] و همهٔ برچسب‌هایش را مسدود می‌کند.

وقتی قاعده‌ای از پیش نشانی را مسدود کرده است، از جمله قاعدهٔ کل دامنه، چیزی افزوده نمی‌شود: created برابر false است و blockedBy آن قاعده را نام می‌برد. پس فرستادن دوبارهٔ همان فراخوانی امن است.

نشانی‌ای با کمتر از دو حرف یا رقم 422 blocklist_entry_too_broad است.