تخطَّ إلى المستندات
API

حظر جهة اتصال

يضع العنوان في قائمة حظر مساحة العمل، القائمة التي يحررها `PATCH /settings` بوصفها `blockedSenders`، كي يُرفض بريده من ذلك الحين. وهذا هو حظر على جهة اتصال في التطبيق. ولا يلزم أن يكون العنوان جهة اتصال.

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

ينفّذ الاستدعاء الحقيقي على مساحة عملك، بمفتاحك أنت.

POST /contacts/{email}/block

يضع العنوان في قائمة حظر مساحة العمل، القائمة التي يحررها PATCH /settings بوصفها blockedSenders، كي يُرفض بريده من ذلك الحين. وهذا هو حظر على جهة اتصال في التطبيق. ولا يلزم أن يكون العنوان جهة اتصال.

مثال

يتطلب settings:write، لأنه يكتب قائمة الحظر لا جهة الاتصال. ورمّز @ ضمن الـ URL.

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 خطأ ويسمّي blockedBy تلك القاعدة. لذا فإرسال الاستدعاء نفسه مجددًا آمن.

العنوان الذي فيه أقل من حرفين أو رقمين هو 422 blocklist_entry_too_broad.