--- title: Rules --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/typescript) [Email Routing](https://developers.cloudflare.com/api/typescript/resources/email_routing) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Rules ##### [List account or zone routing rules](https://developers.cloudflare.com/api/typescript/resources/email_routing/subresources/rules/methods/list) client.emailRouting.rules.list(RuleListParams {account\_id, zone\_id, enabled, 2 more } params?, RequestOptionsoptions?): V4PagePaginationArray< [AccountRule]() {id, actions, enabled, 6 more } > GET/{accounts\_or\_zones}/{account\_or\_zone\_id}/email/routing/rules ##### [Get routing rule](https://developers.cloudflare.com/api/typescript/resources/email_routing/subresources/rules/methods/get) client.emailRouting.rules.get(stringruleIdentifier, RuleGetParams {zone\_id } params, RequestOptionsoptions?): [EmailRoutingRule]() {id, actions, enabled, 5 more } GET/zones/{zone\_id}/email/routing/rules/{rule\_identifier} ##### [Create routing rule](https://developers.cloudflare.com/api/typescript/resources/email_routing/subresources/rules/methods/create) client.emailRouting.rules.create(RuleCreateParams {zone\_id, actions, matchers, 5 more } params, RequestOptionsoptions?): [EmailRoutingRule]() {id, actions, enabled, 5 more } POST/zones/{zone\_id}/email/routing/rules ##### [Update routing rule](https://developers.cloudflare.com/api/typescript/resources/email_routing/subresources/rules/methods/update) client.emailRouting.rules.update(stringruleIdentifier, RuleUpdateParams {zone\_id, actions, matchers, 5 more } params, RequestOptionsoptions?): [EmailRoutingRule]() {id, actions, enabled, 5 more } PUT/zones/{zone\_id}/email/routing/rules/{rule\_identifier} ##### [Delete routing rule](https://developers.cloudflare.com/api/typescript/resources/email_routing/subresources/rules/methods/delete) client.emailRouting.rules.delete(stringruleIdentifier, RuleDeleteParams {zone\_id } params, RequestOptionsoptions?): [EmailRoutingRule]() {id, actions, enabled, 5 more } DELETE/zones/{zone\_id}/email/routing/rules/{rule\_identifier} ##### ModelsExpand Collapse
Action {type, value } Actions pattern.
type: "drop"| "forward"| "worker" Type of supported action. One of the following: "drop" Link to this property "forward" Link to this property "worker" Link to this property
Link to this property value?: Array<string> List of values for the action. Currently limited to a single value. Link to this property
[Link to this property](<#(resource)%20email_routing.rules%20%3E%20(model)%20action%20%3E%20(schema)>)
EmailRoutingRule {id, actions, enabled, 5 more } id?: string Routing rule identifier. maxLength32 Link to this property
actions?: Array<Action {type, value } > List actions patterns.
type: "drop"| "forward"| "worker" Type of supported action. One of the following: "drop" Link to this property "forward" Link to this property "worker" Link to this property
Link to this property value?: Array<string> List of values for the action. Currently limited to a single value. Link to this property
Link to this property
enabled?: true| false Routing rule status. One of the following: true Link to this property false Link to this property
Link to this property
matchers?: Array<Matcher {type, field, value } > Matching patterns to forward to your actions.
type: "all"| "literal" Type of matcher. One of the following: "all" Link to this property "literal" Link to this property
Link to this property field?: "to" Field for type matcher. Link to this property value?: string Value for matcher. maxLength90 Link to this property
Link to this property name?: string Routing rule name. maxLength256 Link to this property priority?: number Priority of the routing rule. minimum0 Link to this property
source?: "api"| "wrangler" Who manages the rule. api covers dashboard, generic API, and Terraform; wrangler means the rule is managed by a Worker’s wrangler.jsonc. Defaults to api when omitted on write. One of the following: "api" Link to this property "wrangler" Link to this property
Link to this property Deprecatedtag?: string Routing rule tag. (Deprecated, replaced by routing rule identifier) maxLength32 Link to this property
[Link to this property](<#(resource)%20email_routing.rules%20%3E%20(model)%20email_routing_rule%20%3E%20(schema)>)
Matcher {type, field, value } Matching pattern to forward your actions.
type: "all"| "literal" Type of matcher. One of the following: "all" Link to this property "literal" Link to this property
Link to this property field?: "to" Field for type matcher. Link to this property value?: string Value for matcher. maxLength90 Link to this property
[Link to this property](<#(resource)%20email_routing.rules%20%3E%20(model)%20matcher%20%3E%20(schema)>) #### RulesCatch Alls ##### [Get catch-all rule](https://developers.cloudflare.com/api/typescript/resources/email_routing/subresources/rules/subresources/catch_alls/methods/get) client.emailRouting.rules.catchAlls.get(CatchAllGetParams {zone\_id } params, RequestOptionsoptions?): [CatchAllGetResponse]() {id, actions, enabled, 4 more } GET/zones/{zone\_id}/email/routing/rules/catch\_all ##### [Update catch-all rule](https://developers.cloudflare.com/api/typescript/resources/email_routing/subresources/rules/subresources/catch_alls/methods/update) client.emailRouting.rules.catchAlls.update(CatchAllUpdateParams {zone\_id, actions, matchers, 4 more } params, RequestOptionsoptions?): [CatchAllUpdateResponse]() {id, actions, enabled, 4 more } PUT/zones/{zone\_id}/email/routing/rules/catch\_all ##### ModelsExpand Collapse
CatchAllAction {type, value } Action for the catch-all routing rule.
type: "drop"| "forward"| "worker" Type of action for catch-all rule. One of the following: "drop" Link to this property "forward" Link to this property "worker" Link to this property
Link to this property value?: Array<string> List of values for the action. Currently limited to a single value. Link to this property
[Link to this property](<#(resource)%20email_routing.rules.catch_alls%20%3E%20(model)%20catch_all_action%20%3E%20(schema)>)
CatchAllMatcher {type } Matcher for catch-all routing rule. type: "all" Type of matcher. Default is ‘all’. Link to this property
[Link to this property](<#(resource)%20email_routing.rules.catch_alls%20%3E%20(model)%20catch_all_matcher%20%3E%20(schema)>)
CatchAllGetResponse {id, actions, enabled, 4 more } id?: string Routing rule identifier. maxLength32 Link to this property
actions?: Array<CatchAllAction {type, value } > List actions for the catch-all routing rule.
type: "drop"| "forward"| "worker" Type of action for catch-all rule. One of the following: "drop" Link to this property "forward" Link to this property "worker" Link to this property
Link to this property value?: Array<string> List of values for the action. Currently limited to a single value. Link to this property
Link to this property
enabled?: true| false Routing rule status. One of the following: true Link to this property false Link to this property
Link to this property
matchers?: Array<CatchAllMatcher {type } > List of matchers for the catch-all routing rule. type: "all" Type of matcher. Default is ‘all’. Link to this property
Link to this property name?: string Routing rule name. maxLength256 Link to this property
source?: "api"| "wrangler" Who manages the rule. api covers dashboard, generic API, and Terraform; wrangler means the rule is managed by a Worker’s wrangler.jsonc. Defaults to api when omitted on write. One of the following: "api" Link to this property "wrangler" Link to this property
Link to this property Deprecatedtag?: string Routing rule tag. (Deprecated, replaced by routing rule identifier) maxLength32 Link to this property
[Link to this property](<#(resource)%20email_routing.rules.catch_alls%20%3E%20(model)%20catch_all_get_response%20%3E%20(schema)>)
CatchAllUpdateResponse {id, actions, enabled, 4 more } id?: string Routing rule identifier. maxLength32 Link to this property
actions?: Array<CatchAllAction {type, value } > List actions for the catch-all routing rule.
type: "drop"| "forward"| "worker" Type of action for catch-all rule. One of the following: "drop" Link to this property "forward" Link to this property "worker" Link to this property
Link to this property value?: Array<string> List of values for the action. Currently limited to a single value. Link to this property
Link to this property
enabled?: true| false Routing rule status. One of the following: true Link to this property false Link to this property
Link to this property
matchers?: Array<CatchAllMatcher {type } > List of matchers for the catch-all routing rule. type: "all" Type of matcher. Default is ‘all’. Link to this property
Link to this property name?: string Routing rule name. maxLength256 Link to this property
source?: "api"| "wrangler" Who manages the rule. api covers dashboard, generic API, and Terraform; wrangler means the rule is managed by a Worker’s wrangler.jsonc. Defaults to api when omitted on write. One of the following: "api" Link to this property "wrangler" Link to this property
Link to this property Deprecatedtag?: string Routing rule tag. (Deprecated, replaced by routing rule identifier) maxLength32 Link to this property
[Link to this property](<#(resource)%20email_routing.rules.catch_alls%20%3E%20(model)%20catch_all_update_response%20%3E%20(schema)>)