catch_alls
Creates, updates, deletes, gets or lists a catch_alls resource.
Overview
| Name | catch_alls |
| Type | Resource |
| Id | cloudflare.email_routing.catch_alls |
Fields
The following fields are returned by SELECT queries:
- list
Get catch-all rule response
| Name | Datatype | Description |
|---|---|---|
id | string | Routing rule identifier. (example: a7e6fb77503c41d8a7f3113c6918f10c) |
name | string | Routing rule name. (example: Send to user@example.net rule.) |
actions | array | List actions for the catch-all routing rule. |
enabled | boolean | Routing rule status. (true, false) |
matchers | array | List of matchers for the catch-all routing rule. |
tag | string | Routing rule tag. (Deprecated, replaced by routing rule identifier) (example: a7e6fb77503c41d8a7f3113c6918f10c) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list | select | zone_id | Get information on the default catch-all routing rule. | |
update | replace | zone_id, actions, matchers | Enable or disable catch-all routing rule, or change action to forward to specific destination address. Forward actions require all destination addresses to be verified. |
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 |
|---|---|---|
zone_id | string | The Cloudflare zone ID. |
SELECT examples
- list
Get information on the default catch-all routing rule.
SELECT
id,
name,
actions,
enabled,
matchers,
tag
FROM cloudflare.email_routing.catch_alls
WHERE zone_id = '{{ zone_id }}' -- required
;
REPLACE examples
- update
Enable or disable catch-all routing rule, or change action to forward to specific destination address. Forward actions require all destination addresses to be verified.
REPLACE cloudflare.email_routing.catch_alls
SET
actions = '{{ actions }}',
enabled = {{ enabled }},
matchers = '{{ matchers }}',
name = '{{ name }}'
WHERE
zone_id = '{{ zone_id }}' --required
AND actions = '{{ actions }}' --required
AND matchers = '{{ matchers }}' --required
RETURNING
errors,
messages,
result,
success;