List account Email Sending suppressions

client.EmailSending.Suppressions.List(ctx, params) (*CursorPagination[SuppressionListResponse], error)

GET/accounts/{account_id}/email/sending/suppressions

Lists every active Email Sending suppression owned by the account, including legacy rows with internal zone memberships.

Security

API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example:X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194

ParametersExpand Collapse

params SuppressionListParams

AccountID param.Field[string]

Path param

Cursor param.Field[string]Optional

Query param: Opaque pagination cursor returned as result_info.next_cursor. It carries the filters that produced it.

maxLength2048

Email param.Field[string]Optional

Query param: Exact email-address filter.

formatemail

PerPage param.Field[int64]Optional

Query param

maximum1000

minimum1

Reason param.Field[SuppressionListParamsReason]Optional

Query param

const SuppressionListParamsReasonManual SuppressionListParamsReason = "manual"

const SuppressionListParamsReasonComplaint SuppressionListParamsReason = "complaint"

const SuppressionListParamsReasonHardBounce SuppressionListParamsReason = "hard_bounce"

const SuppressionListParamsReasonSoftBounce SuppressionListParamsReason = "soft_bounce"

const SuppressionListParamsReasonPolicy SuppressionListParamsReason = "policy"

Search param.Field[string]Optional

Query param: A complete address is an exact match; a value ending in @ matches that username across every domain. Prefix searches may return short intermediate pages while the bounded account scan advances.

maxLength320

minLength1

ReturnsExpand Collapse

type SuppressionListResponse struct{…}

ID string

formatuuid

CreatedAt Time

formatdate-time

Email string

formatemail

ExpiresAt Time

formatdate-time

ReadOnly bool

Whether clients may mutate this suppression. This is determined by the server and must not be inferred from reason.

Reason string

Note stringOptional

List account Email Sending suppressions

package main

import (
  "context"
  "fmt"

  "github.com/cloudflare/cloudflare-go"
  "github.com/cloudflare/cloudflare-go/email_sending"
  "github.com/cloudflare/cloudflare-go/option"
)

func main() {
  client := cloudflare.NewClient(
    option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
  )
  page, err := client.EmailSending.Suppressions.List(context.TODO(), email_sending.SuppressionListParams{
    AccountID: cloudflare.F("54442216"),
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", page)
}

{
  "errors": [
    {}
  ],
  "messages": [
    {}
  ],
  "result": [
    {
      "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "created_at": "2019-12-27T18:11:19.117Z",
      "email": "user@example.com",
      "expires_at": "2019-12-27T18:11:19.117Z",
      "read_only": true,
      "reason": "hard_bounce",
      "note": "Imported from CRM"
    }
  ],
  "result_info": {
    "count": 1,
    "next_cursor": "eyJ0IjozLCJwIjoxMjMsImMiOiJjM2RjNWYwYjM0YTE0ZmY4ZTFiM2VjMDQ4OTVlMWIyMiJ9",
    "per_page": 100
  },
  "success": true
}

Returns Examples

{
  "errors": [
    {}
  ],
  "messages": [
    {}
  ],
  "result": [
    {
      "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "created_at": "2019-12-27T18:11:19.117Z",
      "email": "user@example.com",
      "expires_at": "2019-12-27T18:11:19.117Z",
      "read_only": true,
      "reason": "hard_bounce",
      "note": "Imported from CRM"
    }
  ],
  "result_info": {
    "count": 1,
    "next_cursor": "eyJ0IjozLCJwIjoxMjMsImMiOiJjM2RjNWYwYjM0YTE0ZmY4ZTFiM2VjMDQ4OTVlMWIyMiJ9",
    "per_page": 100
  },
  "success": true
}