Skip to content
Start here

Catch Alls

Get catch-all rule
email_routing.rules.catch_alls.get(CatchAllGetParams**kwargs) -> CatchAllGetResponse
GET/zones/{zone_id}/email/routing/rules/catch_all
Update catch-all rule
email_routing.rules.catch_alls.update(CatchAllUpdateParams**kwargs) -> CatchAllUpdateResponse
PUT/zones/{zone_id}/email/routing/rules/catch_all
ModelsExpand Collapse
class CatchAllAction:

Action for the catch-all routing rule.

type: Literal["drop", "forward", "worker"]

Type of action for catch-all rule.

One of the following:
"drop"
"forward"
"worker"
value: Optional[List[str]]
class CatchAllMatcher:

Matcher for catch-all routing rule.

type: Literal["all"]

Type of matcher. Default is ‘all’.

class CatchAllGetResponse:
id: Optional[str]

Routing rule identifier.

maxLength32
actions: Optional[List[CatchAllAction]]

List actions for the catch-all routing rule.

type: Literal["drop", "forward", "worker"]

Type of action for catch-all rule.

One of the following:
"drop"
"forward"
"worker"
value: Optional[List[str]]
enabled: Optional[Literal[true, false]]

Routing rule status.

One of the following:
true
false
matchers: Optional[List[CatchAllMatcher]]

List of matchers for the catch-all routing rule.

type: Literal["all"]

Type of matcher. Default is ‘all’.

name: Optional[str]

Routing rule name.

maxLength256
Deprecatedtag: Optional[str]

Routing rule tag. (Deprecated, replaced by routing rule identifier)

maxLength32
class CatchAllUpdateResponse:
id: Optional[str]

Routing rule identifier.

maxLength32
actions: Optional[List[CatchAllAction]]

List actions for the catch-all routing rule.

type: Literal["drop", "forward", "worker"]

Type of action for catch-all rule.

One of the following:
"drop"
"forward"
"worker"
value: Optional[List[str]]
enabled: Optional[Literal[true, false]]

Routing rule status.

One of the following:
true
false
matchers: Optional[List[CatchAllMatcher]]

List of matchers for the catch-all routing rule.

type: Literal["all"]

Type of matcher. Default is ‘all’.

name: Optional[str]

Routing rule name.

maxLength256
Deprecatedtag: Optional[str]

Routing rule tag. (Deprecated, replaced by routing rule identifier)

maxLength32