Aller à la documentation
PHP

Suppressions

`suppressions->list`, `listAll`, `iterate`, `get`, `add` et `remove`.

Toutes les méthodes

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']);}

Les adresses auxquelles cet espace de travail n'enverra pas : rebonds définitifs et plaintes, enregistrés au moment où ils surviennent, et toute adresse bloquée à la main. Un envoi à l'une d'elles est refusé pour ce destinataire avant que rien ne parte. Lire demande settings:read et modifier demande settings:write, les portées qui protègent l'écran Adresses bloquées. reason: ne garde qu'un type, bounce, complaint ou manual, et OpenEmail\Constants\SuppressionReasons les nomme. q: cherche dans les adresses.

list renvoie une OpenEmail\Result\Page, de la plus récente à la plus ancienne, listAll renvoie toutes les lignes dans un seul tableau, et iterate renvoie un Generator qui fournit les lignes une par une. Une ligne est un tableau avec id, email, reason, detail, removable et createdAt, et add prend un seul tableau avec email.

add renvoie la ligne, qu'elle soit nouvelle ou déjà présente : le répéter est donc sans danger, et le client le réessaie après une panne réseau. remove refuse un rebond définitif avec 409 suppression_not_removable, levé sous la forme d'une ConflictException, ce que removable vous indique à l'avance. Une clé limitée à certaines adresses ou certains domaines peut lire la liste mais pas la modifier : add et remove lui répondent par un 422 capability_unsupported.