email_rules

Creates, updates, deletes, gets or lists an email_rules resource.

Overview

Name	email_rules
Type	Resource
Id	cloudflare.zero_trust.email_rules

Fields

The following fields are returned by SELECT queries:

get

Get Email Scanner Rule response.

Name	Datatype	Description
name	string
rule_id	string (uuid)
action	object
conditions	array	Triggered if all conditions match.
created_at	string (date-time)
description	string
enabled	boolean
priority	integer (int32)
updated_at	string (date-time)

list

List all email scanner rules response.

Name	Datatype	Description
name	string
rule_id	string (uuid)
action	object
conditions	array	Triggered if all conditions match.
created_at	string (date-time)
description	string
enabled	boolean
priority	integer (int32)
updated_at	string (date-time)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	account_id, rule_id		Gets detailed configuration for a specific DLP email scanning rule, including detection patterns and actions.
list	select	account_id		Lists all email scanner rules for an account.
create	insert	account_id, name, enabled, conditions, action		Creates a new DLP email scanning rule that defines what content patterns to detect in email messages and what actions to take.
update	replace	account_id, rule_id, name, enabled, conditions, action
delete	delete	account_id, rule_id		Removes a DLP email scanning rule. The rule will no longer be applied to email messages.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
account_id	string	The Cloudflare account ID.
rule_id	string	The rule ID.

SELECT examples

get

Gets detailed configuration for a specific DLP email scanning rule, including detection patterns and actions.

SELECT
name,
rule_id,
action,
conditions,
created_at,
description,
enabled,
priority,
updated_at
FROM cloudflare.zero_trust.email_rules
WHERE account_id = '{{ account_id }}' -- required
AND rule_id = '{{ rule_id }}' -- required
;

list

Lists all email scanner rules for an account.

SELECT
name,
rule_id,
action,
conditions,
created_at,
description,
enabled,
priority,
updated_at
FROM cloudflare.zero_trust.email_rules
WHERE account_id = '{{ account_id }}' -- required
;

INSERT examples

create

Creates a new DLP email scanning rule that defines what content patterns to detect in email messages and what actions to take.

INSERT INTO cloudflare.zero_trust.email_rules (
action,
conditions,
description,
enabled,
name,
account_id
)
SELECT 
'{{ action }}' /* required */,
'{{ conditions }}' /* required */,
'{{ description }}',
{{ enabled }} /* required */,
'{{ name }}' /* required */,
'{{ account_id }}'
RETURNING
errors,
messages,
result,
success
;

Manifest

# Description fields are for documentation purposes
- name: email_rules
props:
  - name: account_id
    value: "{{ account_id }}"
    description: Required parameter for the email_rules resource.
  - name: action
    value:
      action: "{{ action }}"
      message: "{{ message }}"
  - name: conditions
    description: |
      Triggered if all conditions match.
    value:
      - operator: "{{ operator }}"
        selector: "{{ selector }}"
        value: "{{ value }}"
  - name: description
    value: "{{ description }}"
  - name: enabled
    value: {{ enabled }}
  - name: name
    value: "{{ name }}"

REPLACE examples

update

No description available.

REPLACE cloudflare.zero_trust.email_rules
SET 
action = '{{ action }}',
conditions = '{{ conditions }}',
description = '{{ description }}',
enabled = {{ enabled }},
name = '{{ name }}'
WHERE 
account_id = '{{ account_id }}' --required
AND rule_id = '{{ rule_id }}' --required
AND name = '{{ name }}' --required
AND enabled = {{ enabled }} --required
AND conditions = '{{ conditions }}' --required
AND action = '{{ action }}' --required
RETURNING
errors,
messages,
result,
success;

DELETE examples

delete

Removes a DLP email scanning rule. The rule will no longer be applied to email messages.

DELETE FROM cloudflare.zero_trust.email_rules
WHERE account_id = '{{ account_id }}' --required
AND rule_id = '{{ rule_id }}' --required
;