Rules

List routing rules

client.EmailRouting.Rules.List(ctx, params) (*V4PagePaginationArray[EmailRoutingRule], error)

GET/zones/{zone_id}/email/routing/rules

Get routing rule

client.EmailRouting.Rules.Get(ctx, ruleIdentifier, query) (*EmailRoutingRule, error)

GET/zones/{zone_id}/email/routing/rules/{rule_identifier}

Create routing rule

client.EmailRouting.Rules.New(ctx, params) (*EmailRoutingRule, error)

POST/zones/{zone_id}/email/routing/rules

Update routing rule

client.EmailRouting.Rules.Update(ctx, ruleIdentifier, params) (*EmailRoutingRule, error)

PUT/zones/{zone_id}/email/routing/rules/{rule_identifier}

Delete routing rule

client.EmailRouting.Rules.Delete(ctx, ruleIdentifier, body) (*EmailRoutingRule, error)

DELETE/zones/{zone_id}/email/routing/rules/{rule_identifier}

ModelsExpand Collapse

type Action struct{…}

Actions pattern.

Type ActionType

Type of supported action.

One of the following:

const ActionTypeDrop ActionType = "drop"

const ActionTypeForward ActionType = "forward"

const ActionTypeWorker ActionType = "worker"

Value []stringoptional

type EmailRoutingRule struct{…}

ID stringoptional

Routing rule identifier.

maxLength32

Actions []Actionoptional

List actions patterns.

Type ActionType

Type of supported action.

One of the following:

const ActionTypeDrop ActionType = "drop"

const ActionTypeForward ActionType = "forward"

const ActionTypeWorker ActionType = "worker"

Value []stringoptional

Enabled EmailRoutingRuleEnabledoptional

Routing rule status.

One of the following:

const EmailRoutingRuleEnabledTrue EmailRoutingRuleEnabled = true

const EmailRoutingRuleEnabledFalse EmailRoutingRuleEnabled = false

Matchers []Matcheroptional

Matching patterns to forward to your actions.

Type MatcherType

Type of matcher.

One of the following:

const MatcherTypeAll MatcherType = "all"

const MatcherTypeLiteral MatcherType = "literal"

Field MatcherFieldoptional

Field for type matcher.

Value stringoptional

Value for matcher.

maxLength90

Name stringoptional

Routing rule name.

maxLength256

Priority float64optional

Priority of the routing rule.

minimum0

DeprecatedTag stringoptional

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

maxLength32

type Matcher struct{…}

Matching pattern to forward your actions.

Type MatcherType

Type of matcher.

One of the following:

const MatcherTypeAll MatcherType = "all"

const MatcherTypeLiteral MatcherType = "literal"

Field MatcherFieldoptional

Field for type matcher.

Value stringoptional

Value for matcher.

maxLength90

RulesCatch Alls

Get catch-all rule

client.EmailRouting.Rules.CatchAlls.Get(ctx, query) (*RuleCatchAllGetResponse, error)

GET/zones/{zone_id}/email/routing/rules/catch_all

Update catch-all rule

client.EmailRouting.Rules.CatchAlls.Update(ctx, params) (*RuleCatchAllUpdateResponse, error)

PUT/zones/{zone_id}/email/routing/rules/catch_all

ModelsExpand Collapse

type CatchAllAction struct{…}

Action for the catch-all routing rule.

Type CatchAllActionType

Type of action for catch-all rule.

One of the following:

const CatchAllActionTypeDrop CatchAllActionType = "drop"

const CatchAllActionTypeForward CatchAllActionType = "forward"

const CatchAllActionTypeWorker CatchAllActionType = "worker"

Value []stringoptional

type CatchAllMatcher struct{…}

Matcher for catch-all routing rule.

Type CatchAllMatcherType

Type of matcher. Default is 'all'.