ドキュメント本文へスキップ
Ruby

配信停止

`suppressions.list`、`list_all`、`iterate`、`get`、`add`、`remove`。

すべてのメソッド

suppressions.rb
complaints = client.suppressions.list_all(reason: "complaint")puts complaints.map { |row| row[:email] } row = client.suppressions.add(email: "[email protected]") client.suppressions.remove(row[:id]) if row[:removable]

このワークスペースが送信しないアドレス:起きた時点で記録されるハードバウンスと苦情、および手作業でブロックしたアドレスです。そのいずれかへの送信は、何かが出ていく前にその受信者の分だけ拒否されます。読むには settings:read、変更するには settings:write が必要で、どちらも「ブロック中のアドレス」画面を保護しているスコープです。reason: は bounce、complaint、manual のいずれか 1 種類だけを残し、OpenEmail::SUPPRESSION_REASONS がそれらを定義しています。

add は、新しい行でも既存の行でもその行を返します。remove はハードバウンスを 409 suppression_not_removable で拒否し、OpenEmail::ConflictError として送出されます。これは removable で事前に分かります。特定のアドレスやドメインに限定されたキーは、リストを読めても変更はできません。