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

توقیف‌ها

`suppressions->list`، `listAll`، `iterate`، `get`، `add` و `remove`.

همهٔ متدها

suppressions.php
use OpenEmail\Constants\SuppressionReasons; $complaints = $client->suppressions->listAll(reason: SuppressionReasons::COMPLAINT);echo implode(', ', array_column($complaints, 'email')), PHP_EOL; $row = $client->suppressions->add(['email' => '[email protected]']); if ($row['removable']) {    $client->suppressions->remove($row['id']);}

نشانی‌هایی که این فضای کاری به آن‌ها نمی‌فرستد: برگشت‌های دائمی و شکایت‌ها، که در لحظهٔ رخ دادن ثبت می‌شوند، و هر نشانی‌ای که با دست مسدود شده. ارسال به یکی از آن‌ها پیش از آنکه چیزی بیرون برود برای همان گیرنده رد می‌شود. خواندن به settings:read و تغییر دادن به settings:write نیاز دارد، همان اسکوپ‌هایی که صفحهٔ «نشانی‌های مسدود» با آن‌ها محافظت می‌شود. reason: فقط یک نوع را نگه می‌دارد، bounce، complaint یا manual، و OpenEmail\Constants\SuppressionReasons آن‌ها را نام می‌برد. q: در نشانی‌ها جست‌وجو می‌کند.

list یک OpenEmail\Result\Page برمی‌گرداند، تازه‌ترین اول، listAll همهٔ ردیف‌ها را در یک آرایه برمی‌گرداند، و iterate یک Generator برمی‌گرداند که هر بار یک ردیف را yield می‌کند. هر ردیف یک آرایه است با id، email، reason، detail، removable و createdAt، و add یک آرایه با email می‌گیرد.

add ردیف را برمی‌گرداند، چه تازه باشد چه از پیش بوده باشد، پس تکرارش بی‌ضرر است و کلاینت پس از شکست شبکه آن را دوباره امتحان می‌کند. remove برگشت دائمی را با 409 suppression_not_removable رد می‌کند که به‌صورت ConflictException پرتاب می‌شود، چیزی که removable از پیش به شما می‌گوید. کلیدی که به نشانی‌ها یا دامنه‌های خاصی محدود است می‌تواند فهرست را بخواند و نمی‌تواند تغییرش دهد: add و remove به آن با یک 422 capability_unsupported پاسخ می‌دهند.