Aller à la documentation
API

Bloquer un contact

Met l'adresse sur la liste de blocage de l'espace de travail, celle que `PATCH /settings` modifie sous le nom `blockedSenders`, pour que son courrier soit refusé dès lors. C'est Bloquer sur un contact dans l'application. L'adresse n'a pas besoin d'être un contact.

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

Exécute le véritable appel sur votre espace de travail, avec votre propre clé.

POST /contacts/{email}/block

Met l'adresse sur la liste de blocage de l'espace de travail, celle que PATCH /settings modifie sous le nom blockedSenders, pour que son courrier soit refusé dès lors. C'est Bloquer sur un contact dans l'application. L'adresse n'a pas besoin d'être un contact.

Exemple

Nécessite settings:write, car il écrit la liste de blocage et non le contact. Encodez le @ dans l'URL.

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

Une étiquette plus est retirée, si bien que bloquer [email protected] bloque [email protected] et toutes ses étiquettes.

Quand une règle bloque déjà l'adresse, règle sur un domaine entier comprise, rien n'est ajouté : created est faux et blockedBy nomme cette règle. Renvoyer le même appel est donc sans risque.

Une adresse avec moins de deux lettres ou chiffres donne un 422 blocklist_entry_too_broad.