List all email scanner rules

client.ZeroTrust.DLP.Email.Rules.List(ctx, query) (*SinglePage[DLPEmailRuleListResponse], error)

GET/accounts/{account_id}/dlp/email/rules

Lists all email scanner rules for an account.

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

Accepted Permissions (at least one required)

Zero Trust ReadZero Trust Write

ParametersExpand Collapse

query DLPEmailRuleListParams

AccountID param.Field[string]

ReturnsExpand Collapse

type DLPEmailRuleListResponse struct{…}

Action DLPEmailRuleListResponseAction

Action DLPEmailRuleListResponseActionAction

Message stringOptional

Conditions []DLPEmailRuleListResponseCondition

Triggered if all conditions match.

Operator DLPEmailRuleListResponseConditionsOperator

One of the following:

const DLPEmailRuleListResponseConditionsOperatorInList DLPEmailRuleListResponseConditionsOperator = "InList"

const DLPEmailRuleListResponseConditionsOperatorNotInList DLPEmailRuleListResponseConditionsOperator = "NotInList"

const DLPEmailRuleListResponseConditionsOperatorMatchRegex DLPEmailRuleListResponseConditionsOperator = "MatchRegex"

const DLPEmailRuleListResponseConditionsOperatorNotMatchRegex DLPEmailRuleListResponseConditionsOperator = "NotMatchRegex"

Selector DLPEmailRuleListResponseConditionsSelector

One of the following:

const DLPEmailRuleListResponseConditionsSelectorRecipients DLPEmailRuleListResponseConditionsSelector = "Recipients"

const DLPEmailRuleListResponseConditionsSelectorSender DLPEmailRuleListResponseConditionsSelector = "Sender"

const DLPEmailRuleListResponseConditionsSelectorDLPProfiles DLPEmailRuleListResponseConditionsSelector = "DLPProfiles"

Value DLPEmailRuleListResponseConditionsValueUnion

One of the following:

type DLPEmailRuleListResponseConditionsValueArray []string

UnionString

CreatedAt Time

formatdate-time

Enabled bool

Name string

Priority int64

formatint32

minimum0

RuleID string

formatuuid

UpdatedAt Time

formatdate-time

Description stringOptional

List all email scanner rules

package main

import (
  "context"
  "fmt"

  "github.com/stainless-sdks/cloudflare-go"
  "github.com/stainless-sdks/cloudflare-go/option"
  "github.com/stainless-sdks/cloudflare-go/zero_trust"
)

func main() {
  client := cloudflare.NewClient(
    option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
  )
  page, err := client.ZeroTrust.DLP.Email.Rules.List(context.TODO(), zero_trust.DLPEmailRuleListParams{
    AccountID: cloudflare.F("account_id"),
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", page)
}

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "success": true,
  "result": [
    {
      "action": {
        "action": "Block",
        "message": "message"
      },
      "conditions": [
        {
          "operator": "InList",
          "selector": "Recipients",
          "value": [
            "string"
          ]
        }
      ],
      "created_at": "2019-12-27T18:11:19.117Z",
      "enabled": true,
      "name": "name",
      "priority": 0,
      "rule_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "updated_at": "2019-12-27T18:11:19.117Z",
      "description": "description"
    }
  ]
}

Returns Examples

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "success": true,
  "result": [
    {
      "action": {
        "action": "Block",
        "message": "message"
      },
      "conditions": [
        {
          "operator": "InList",
          "selector": "Recipients",
          "value": [
            "string"
          ]
        }
      ],
      "created_at": "2019-12-27T18:11:19.117Z",
      "enabled": true,
      "name": "name",
      "priority": 0,
      "rule_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "updated_at": "2019-12-27T18:11:19.117Z",
      "description": "description"
    }
  ]
}