--- title: Email Routing --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/go) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Email Routing ##### [Get Email Routing settings](https://developers.cloudflare.com/api/go/resources/email_routing/methods/get) client.EmailRouting.Get(ctx, query) (\*[Settings](), error) GET/zones/{zone\_id}/email/routing ##### [Update Email Routing settings](https://developers.cloudflare.com/api/go/resources/email_routing/methods/edit) client.EmailRouting.Edit(ctx, params) (\*[Settings](), error) PATCH/zones/{zone\_id}/email/routing ##### [Apply Email Routing settings](https://developers.cloudflare.com/api/go/resources/email_routing/methods/update) client.EmailRouting.Update(ctx, params) (\*[Settings](), error) PUT/zones/{zone\_id}/email/routing ##### [Disable Email Routing](https://developers.cloudflare.com/api/go/resources/email_routing/methods/disable) Deprecated client.EmailRouting.Disable(ctx, body) (\*[Settings](), error) POST/zones/{zone\_id}/email/routing/disable ##### [Enable Email Routing](https://developers.cloudflare.com/api/go/resources/email_routing/methods/enable) Deprecated client.EmailRouting.Enable(ctx, body) (\*[Settings](), error) POST/zones/{zone\_id}/email/routing/enable ##### [Unlock Email Routing](https://developers.cloudflare.com/api/go/resources/email_routing/methods/unlock) Deprecated client.EmailRouting.Unlock(ctx, params) (\*[Settings](), error) POST/zones/{zone\_id}/email/routing/unlock ##### ModelsExpand Collapse
type Settings struct{…} ID string Email Routing settings identifier. maxLength32 Link to this property
Enabled SettingsEnabled State of the zone settings for Email Routing. One of the following: const SettingsEnabledTrue SettingsEnabled = true Link to this property const SettingsEnabledFalse SettingsEnabled = false Link to this property
Link to this property Name string Domain of your zone. Link to this property Created TimeOptional The date and time the settings have been created. formatdate-time Link to this property Modified TimeOptional The date and time the settings have been modified. formatdate-time Link to this property
SkipWizard SettingsSkipWizardOptional Flag to check if the user skipped the configuration wizard. One of the following: const SettingsSkipWizardTrue SettingsSkipWizard = true Link to this property const SettingsSkipWizardFalse SettingsSkipWizard = false Link to this property
Link to this property
Status SettingsStatusOptional Show the state of your account, and the type or configuration error. One of the following: const SettingsStatusReady SettingsStatus = "ready" Link to this property const SettingsStatusUnconfigured SettingsStatus = "unconfigured" Link to this property const SettingsStatusMisconfigured SettingsStatus = "misconfigured" Link to this property const SettingsStatusMisconfiguredLocked SettingsStatus = "misconfigured/locked" Link to this property const SettingsStatusUnlocked SettingsStatus = "unlocked" Link to this property
Link to this property
SupportSubaddress SettingsSupportSubaddressOptional Whether subaddressing (plus-addressing) is honored when matching incoming mail against routing rules. One of the following: const SettingsSupportSubaddressTrue SettingsSupportSubaddress = true Link to this property const SettingsSupportSubaddressFalse SettingsSupportSubaddress = false Link to this property
Link to this property DeprecatedTag stringOptional Email Routing settings tag. (Deprecated, replaced by Email Routing settings identifier) maxLength32 Link to this property
[Link to this property](<#(resource)%20email_routing%20%3E%20(model)%20settings%20%3E%20(schema)>) #### Email RoutingDNS ##### [Email Routing - DNS settings](https://developers.cloudflare.com/api/go/resources/email_routing/subresources/dns/methods/get) client.EmailRouting.DNS.Get(ctx, params) (\*\[] [DNSRecord](), error) GET/zones/{zone\_id}/email/routing/dns ##### [Enable Email Routing](https://developers.cloudflare.com/api/go/resources/email_routing/subresources/dns/methods/create) client.EmailRouting.DNS.New(ctx, params) (\*[Settings](), error) POST/zones/{zone\_id}/email/routing/dns ##### [Unlock Email Routing DNS records](https://developers.cloudflare.com/api/go/resources/email_routing/subresources/dns/methods/edit) client.EmailRouting.DNS.Edit(ctx, params) (\*[Settings](), error) PATCH/zones/{zone\_id}/email/routing/dns ##### [Disable Email Routing](https://developers.cloudflare.com/api/go/resources/email_routing/subresources/dns/methods/delete) client.EmailRouting.DNS.Delete(ctx, body) (\*[Settings](), error) DELETE/zones/{zone\_id}/email/routing/dns ##### ModelsExpand Collapse
type DNSRecord struct{…} List of records needed to enable an Email Routing zone. Content stringOptional DNS record content. Link to this property Name stringOptional DNS record name (or @ for the zone apex). maxLength255 Link to this property Priority float64Optional Required for MX, SRV and URI records. Unused by other record types. Records with lower priorities are preferred. maximum65535 minimum0 Link to this property
TTL DNSRecordTTLOptional Time to live, in seconds, of the DNS record. Must be between 60 and 86400, or 1 for ‘automatic’. One of the following: float64 Link to this property type DNSRecordTTL float64 Time to live, in seconds, of the DNS record. Must be between 60 and 86400, or 1 for ‘automatic’. Link to this property
Link to this property
Type DNSRecordTypeOptional DNS record type. One of the following: const DNSRecordTypeA DNSRecordType = "A" Link to this property const DNSRecordTypeAAAA DNSRecordType = "AAAA" Link to this property const DNSRecordTypeCNAME DNSRecordType = "CNAME" Link to this property const DNSRecordTypeHTTPS DNSRecordType = "HTTPS" Link to this property const DNSRecordTypeTXT DNSRecordType = "TXT" Link to this property const DNSRecordTypeSRV DNSRecordType = "SRV" Link to this property const DNSRecordTypeLOC DNSRecordType = "LOC" Link to this property const DNSRecordTypeMX DNSRecordType = "MX" Link to this property const DNSRecordTypeNS DNSRecordType = "NS" Link to this property const DNSRecordTypeCERT DNSRecordType = "CERT" Link to this property const DNSRecordTypeDNSKEY DNSRecordType = "DNSKEY" Link to this property const DNSRecordTypeDS DNSRecordType = "DS" Link to this property const DNSRecordTypeNAPTR DNSRecordType = "NAPTR" Link to this property const DNSRecordTypeSMIMEA DNSRecordType = "SMIMEA" Link to this property const DNSRecordTypeSSHFP DNSRecordType = "SSHFP" Link to this property const DNSRecordTypeSVCB DNSRecordType = "SVCB" Link to this property const DNSRecordTypeTLSA DNSRecordType = "TLSA" Link to this property const DNSRecordTypeURI DNSRecordType = "URI" Link to this property
Link to this property
[Link to this property](<#(resource)%20email_routing.dns%20%3E%20(model)%20dns_record%20%3E%20(schema)>) #### Email RoutingRules ##### [List account or zone routing rules](https://developers.cloudflare.com/api/go/resources/email_routing/subresources/rules/methods/list) client.EmailRouting.Rules.List(ctx, params) (\*V4PagePaginationArray\[[AccountRule]()], error) GET/{accounts\_or\_zones}/{account\_or\_zone\_id}/email/routing/rules ##### [Get routing rule](https://developers.cloudflare.com/api/go/resources/email_routing/subresources/rules/methods/get) client.EmailRouting.Rules.Get(ctx, ruleIdentifier, query) (\*[EmailRoutingRule](), error) GET/zones/{zone\_id}/email/routing/rules/{rule\_identifier} ##### [Create routing rule](https://developers.cloudflare.com/api/go/resources/email_routing/subresources/rules/methods/create) client.EmailRouting.Rules.New(ctx, params) (\*[EmailRoutingRule](), error) POST/zones/{zone\_id}/email/routing/rules ##### [Update routing rule](https://developers.cloudflare.com/api/go/resources/email_routing/subresources/rules/methods/update) client.EmailRouting.Rules.Update(ctx, ruleIdentifier, params) (\*[EmailRoutingRule](), error) PUT/zones/{zone\_id}/email/routing/rules/{rule\_identifier} ##### [Delete routing rule](https://developers.cloudflare.com/api/go/resources/email_routing/subresources/rules/methods/delete) 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" Link to this property const ActionTypeForward ActionType = "forward" Link to this property const ActionTypeWorker ActionType = "worker" Link to this property
Link to this property Value \[]stringOptional 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)>)
type EmailRoutingRule struct{…} ID stringOptional Routing rule identifier. maxLength32 Link to this property
Actions \[]ActionOptional List actions patterns.
Type ActionType Type of supported action. One of the following: const ActionTypeDrop ActionType = "drop" Link to this property const ActionTypeForward ActionType = "forward" Link to this property const ActionTypeWorker ActionType = "worker" Link to this property
Link to this property Value \[]stringOptional List of values for the action. Currently limited to a single value. Link to this property
Link to this property
Enabled EmailRoutingRuleEnabledOptional Routing rule status. One of the following: const EmailRoutingRuleEnabledTrue EmailRoutingRuleEnabled = true Link to this property const EmailRoutingRuleEnabledFalse EmailRoutingRuleEnabled = false Link to this property
Link to this property
Matchers \[]MatcherOptional Matching patterns to forward to your actions.
Type MatcherType Type of matcher. One of the following: const MatcherTypeAll MatcherType = "all" Link to this property const MatcherTypeLiteral MatcherType = "literal" Link to this property
Link to this property Field MatcherFieldOptional Field for type matcher. Link to this property Value stringOptional Value for matcher. maxLength90 Link to this property
Link to this property Name stringOptional Routing rule name. maxLength256 Link to this property Priority float64Optional Priority of the routing rule. minimum0 Link to this property
Source EmailRoutingRuleSourceOptional 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: const EmailRoutingRuleSourceAPI EmailRoutingRuleSource = "api" Link to this property const EmailRoutingRuleSourceWrangler EmailRoutingRuleSource = "wrangler" Link to this property
Link to this property DeprecatedTag stringOptional 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)>)
type Matcher struct{…} Matching pattern to forward your actions.
Type MatcherType Type of matcher. One of the following: const MatcherTypeAll MatcherType = "all" Link to this property const MatcherTypeLiteral MatcherType = "literal" Link to this property
Link to this property Field MatcherFieldOptional Field for type matcher. Link to this property Value stringOptional 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)>) #### Email RoutingRulesCatch Alls ##### [Get catch-all rule](https://developers.cloudflare.com/api/go/resources/email_routing/subresources/rules/subresources/catch_alls/methods/get) client.EmailRouting.Rules.CatchAlls.Get(ctx, query) (\*[RuleCatchAllGetResponse](), error) GET/zones/{zone\_id}/email/routing/rules/catch\_all ##### [Update catch-all rule](https://developers.cloudflare.com/api/go/resources/email_routing/subresources/rules/subresources/catch_alls/methods/update) 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" Link to this property const CatchAllActionTypeForward CatchAllActionType = "forward" Link to this property const CatchAllActionTypeWorker CatchAllActionType = "worker" Link to this property
Link to this property Value \[]stringOptional 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)>)
type CatchAllMatcher struct{…} Matcher for catch-all routing rule. Type CatchAllMatcherType 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)>) #### Email RoutingAccount Rules ##### [List account or zone routing rules](https://developers.cloudflare.com/api/go/resources/email_routing/subresources/account_rules/methods/list) client.EmailRouting.AccountRules.List(ctx, params) (\*V4PagePaginationArray\[[AccountRule]()], error) GET/{accounts\_or\_zones}/{account\_or\_zone\_id}/email/routing/rules ##### ModelsExpand Collapse
type AccountRule struct{…} ID stringOptional Routing rule identifier. maxLength32 Link to this property
Actions \[]ActionOptional List actions patterns.
Type ActionType Type of supported action. One of the following: const ActionTypeDrop ActionType = "drop" Link to this property const ActionTypeForward ActionType = "forward" Link to this property const ActionTypeWorker ActionType = "worker" Link to this property
Link to this property Value \[]stringOptional List of values for the action. Currently limited to a single value. Link to this property
Link to this property
Enabled AccountRuleEnabledOptional Routing rule status. One of the following: const AccountRuleEnabledTrue AccountRuleEnabled = true Link to this property const AccountRuleEnabledFalse AccountRuleEnabled = false Link to this property
Link to this property
Matchers \[]MatcherOptional Matching patterns to forward to your actions.
Type MatcherType Type of matcher. One of the following: const MatcherTypeAll MatcherType = "all" Link to this property const MatcherTypeLiteral MatcherType = "literal" Link to this property
Link to this property Field MatcherFieldOptional Field for type matcher. Link to this property Value stringOptional Value for matcher. maxLength90 Link to this property
Link to this property Name stringOptional Routing rule name. maxLength256 Link to this property Priority float64Optional Priority of the routing rule. minimum0 Link to this property
Source AccountRuleSourceOptional 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: const AccountRuleSourceAPI AccountRuleSource = "api" Link to this property const AccountRuleSourceWrangler AccountRuleSource = "wrangler" Link to this property
Link to this property DeprecatedTag stringOptional Routing rule tag. (Deprecated, replaced by routing rule identifier) maxLength32 Link to this property
Zone AccountRuleZoneOptional Zone information for the routing rule. Name stringOptional Zone name. Link to this property Tag stringOptional Zone tag. maxLength32 Link to this property
Link to this property
[Link to this property](<#(resource)%20email_routing.account_rules%20%3E%20(model)%20account_rule%20%3E%20(schema)>) #### Email RoutingAddresses ##### [List destination addresses](https://developers.cloudflare.com/api/go/resources/email_routing/subresources/addresses/methods/list) client.EmailRouting.Addresses.List(ctx, params) (\*V4PagePaginationArray\[[Address]()], error) GET/accounts/{account\_id}/email/routing/addresses ##### [Get a destination address](https://developers.cloudflare.com/api/go/resources/email_routing/subresources/addresses/methods/get) client.EmailRouting.Addresses.Get(ctx, destinationAddressIdentifier, query) (\*[Address](), error) GET/accounts/{account\_id}/email/routing/addresses/{destination\_address\_identifier} ##### [Create a destination address](https://developers.cloudflare.com/api/go/resources/email_routing/subresources/addresses/methods/create) client.EmailRouting.Addresses.New(ctx, params) (\*[Address](), error) POST/accounts/{account\_id}/email/routing/addresses ##### [Update destination address](https://developers.cloudflare.com/api/go/resources/email_routing/subresources/addresses/methods/edit) client.EmailRouting.Addresses.Edit(ctx, destinationAddressIdentifier, params) (\*[Address](), error) PATCH/accounts/{account\_id}/email/routing/addresses/{destination\_address\_identifier} ##### [Delete destination address](https://developers.cloudflare.com/api/go/resources/email_routing/subresources/addresses/methods/delete) client.EmailRouting.Addresses.Delete(ctx, destinationAddressIdentifier, body) (\*[Address](), error) DELETE/accounts/{account\_id}/email/routing/addresses/{destination\_address\_identifier} ##### ModelsExpand Collapse
type Address struct{…} ID stringOptional Destination address identifier. maxLength32 Link to this property Created TimeOptional The date and time the destination address has been created. formatdate-time Link to this property Email stringOptional The contact email address of the user. maxLength90 Link to this property Modified TimeOptional The date and time the destination address was last modified. formatdate-time Link to this property DeprecatedTag stringOptional Destination address tag. (Deprecated, replaced by destination address identifier) maxLength32 Link to this property Verified TimeOptional The date and time the destination address has been verified. Null means not verified yet. formatdate-time Link to this property
[Link to this property](<#(resource)%20email_routing.addresses%20%3E%20(model)%20address%20%3E%20(schema)>)