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 は false になり、blockedBy がそのルールを示します。そのため同じ呼び出しをもう一度送っても安全です。

英字と数字が 2 文字未満のアドレスは 422 blocklist_entry_too_broad です。