fn get_dmarc_reports_status()
Get DMARC Report Status
fn update_configure_dmarc_reports(enabled?: boolean, skip_wizard?: boolean)
Configure DMARC Reports
| Argument | Type | Required | Description |
|---|
| enabled? | boolean | no | Enable or disable DMARC reports for this zone |
| skip_wizard? | boolean | no | Skip the DMARC setup wizard |
fn get_inspect_spf()
Inspect SPF Record
fn get_email_routing_settings()
Get Email Routing settings
fn update_email_routing_settings_replace_email_routing_settings(enabled?: union, skip_wizard?: union, support_subaddress?: union)
Update Email Routing settings
| Argument | Type | Required | Description |
|---|
| enabled? | union | no | State of your zone Email Routing settings. No-op on this endpoint - use `POST... |
| skip_wizard? | union | no | Flag to check if the user skipped the configuration wizard. |
| support_subaddress? | union | no | Whether subaddressing (plus-addressing) is honored when matching incoming mai... |
fn update_email_routing_settings(enabled?: union, skip_wizard?: union, support_subaddress?: union)
Update Email Routing settings
| Argument | Type | Required | Description |
|---|
| enabled? | union | no | State of your zone Email Routing settings. No-op on this endpoint - use `POST... |
| skip_wizard? | union | no | Flag to check if the user skipped the configuration wizard. |
| support_subaddress? | union | no | Whether subaddressing (plus-addressing) is honored when matching incoming mai... |
fn get_email_routing_settings_email_routing_dns_settings(subdomain?: string)
Email Routing - DNS settings
| Argument | Type | Required | Description |
|---|
| subdomain? | string | no | |
fn create_email_routing_settings_enable_email_routing_dns(name?: unknown)
Enable Email Routing
| Argument | Type | Required | Description |
|---|
| name? | unknown | no | |
fn update_email_routing_settings_unlock_email_routing_dns(name?: unknown)
Unlock Email Routing
| Argument | Type | Required | Description |
|---|
| name? | unknown | no | |
fn delete_email_routing_settings_disable_email_routing_dns(name?: unknown)
Disable Email Routing
| Argument | Type | Required | Description |
|---|
| name? | unknown | no | |
fn list_routing_rules(page?: number, per_page?: number, enabled?: boolean)
List routing rules
| Argument | Type | Required | Description |
|---|
| page? | number | no | |
| per_page? | number | no | |
| enabled? | boolean | no | |
fn create_routing_rule(actions: unknown, enabled?: unknown, matchers: unknown, name?: unknown, owner_worker_tag?: unknown, priority?: unknown, source?: unknown)
Create routing rule
| Argument | Type | Required | Description |
|---|
| actions | unknown | yes | |
| enabled? | unknown | no | |
| matchers | unknown | yes | |
| name? | unknown | no | |
| owner_worker_tag? | unknown | no | |
| priority? | unknown | no | |
| source? | unknown | no | |
fn get_catch_all_rule()
Get catch-all rule
fn update_catch_all_rule(actions: unknown, enabled?: unknown, matchers: unknown, name?: unknown, owner_worker_tag?: unknown, source?: unknown)
Update catch-all rule
| Argument | Type | Required | Description |
|---|
| actions | unknown | yes | |
| enabled? | unknown | no | |
| matchers | unknown | yes | |
| name? | unknown | no | |
| owner_worker_tag? | unknown | no | |
| source? | unknown | no | |
fn get_routing_rule(rule_identifier: string)
Get routing rule
| Argument | Type | Required | Description |
|---|
| rule_identifier | string | yes | |
fn update_routing_rule(rule_identifier: string, actions: unknown, enabled?: unknown, matchers: unknown, name?: unknown, owner_worker_tag?: unknown, priority?: unknown, source?: unknown)
Update routing rule
| Argument | Type | Required | Description |
|---|
| rule_identifier | string | yes | |
| actions | unknown | yes | |
| enabled? | unknown | no | |
| matchers | unknown | yes | |
| name? | unknown | no | |
| owner_worker_tag? | unknown | no | |
| priority? | unknown | no | |
| source? | unknown | no | |
fn delete_routing_rule(rule_identifier: string)
Delete routing rule
| Argument | Type | Required | Description |
|---|
| rule_identifier | string | yes | |
fn get_publiclistsuppressionzonerouting(page?: number, per_page?: number, order?: enum, direction?: enum)
List zone email suppressions
| Argument | Type | Required | Description |
|---|
| page? | number | no | |
| per_page? | number | no | |
| order? | enum | no | |
| direction? | enum | no | |
fn create_post_publicnewsuppressionzonerouting(email: string, expires_at?: string)
Create zone email suppression
| Argument | Type | Required | Description |
|---|
| email | string | yes | |
| expires_at? | string | no | |
fn get_publicgetsuppressionzonerouting(suppression_id: string)
Get zone email suppression
| Argument | Type | Required | Description |
|---|
| suppression_id | string | yes | |
fn delete_publicdeletesuppressionzonerouting(suppression_id: string)
Delete zone email suppression
| Argument | Type | Required | Description |
|---|
| suppression_id | string | yes | |
fn list_sending_subdomains()
List sending subdomains
fn create_sending_subdomain(name: string)
Create a sending subdomain
| Argument | Type | Required | Description |
|---|
| name | string | yes | The subdomain name. Must be within the zone. |
fn create_email_sending_subdomains_preview_sending_subdomain(name: string)
Preview sending subdomain DNS
| Argument | Type | Required | Description |
|---|
| name | string | yes | The subdomain name. Must be within the zone. |
fn get_sending_subdomain(subdomain_id: string)
Get a sending subdomain
| Argument | Type | Required | Description |
|---|
| subdomain_id | string | yes | |
fn update_sending_subdomain(subdomain_id: string, preview_enabled: boolean)
Update a sending subdomain
| Argument | Type | Required | Description |
|---|
| subdomain_id | string | yes | |
| preview_enabled | boolean | yes | Whether sent messages from this subdomain can be previewed in the activity log. |
fn delete_sending_subdomain(subdomain_id: string)
Delete a sending subdomain
| Argument | Type | Required | Description |
|---|
| subdomain_id | string | yes | |
fn get_sending_subdomain_dns(subdomain_id: string)
Get sending subdomain DNS records
| Argument | Type | Required | Description |
|---|
| subdomain_id | string | yes | |
fn email_sending_subdomains_fix_sending_subdomain_dns(subdomain_id: string)
Fix sending subdomain DNS records
| Argument | Type | Required | Description |
|---|
| subdomain_id | string | yes | |
fn get_sending_subdomain_dns_status(subdomain_id: string)
Get sending subdomain DNS status
| Argument | Type | Required | Description |
|---|
| subdomain_id | string | yes | |
fn get_publiclistsuppressionzonesending(page?: number, per_page?: number, order?: enum, direction?: enum)
List zone email suppressions
| Argument | Type | Required | Description |
|---|
| page? | number | no | |
| per_page? | number | no | |
| order? | enum | no | |
| direction? | enum | no | |
fn create_post_publicnewsuppressionzonesending(email: string, expires_at?: string)
Create zone email suppression
| Argument | Type | Required | Description |
|---|
| email | string | yes | |
| expires_at? | string | no | |
fn get_publicgetsuppressionzonesending(suppression_id: string)
Get zone email suppression
| Argument | Type | Required | Description |
|---|
| suppression_id | string | yes | |
fn delete_publicdeletesuppressionzonesending(suppression_id: string)
Delete zone email suppression
| Argument | Type | Required | Description |
|---|
| suppression_id | string | yes | |
Resources
dmarc_reports_status(infinite)— Get DMARC Report Status
configure_dmarc_reports(infinite)— Configure DMARC Reports
inspect_spf(infinite)— Inspect SPF Record
email_routing_settings(infinite)— Get Email Routing settings
email_routing_settings_replace_email_routing_settings(infinite)— Update Email Routing settings
email_routing_settings_email_routing_dns_settings(infinite)— Email Routing - DNS settings
email_routing_settings_enable_email_routing_dns(infinite)— Enable Email Routing
email_routing_settings_unlock_email_routing_dns(infinite)— Unlock Email Routing
routing_rules(infinite)— List routing rules
routing_rule(infinite)— Create routing rule
catch_all_rule(infinite)— Get catch-all rule
get_publiclistsuppressionzonerouting(infinite)— List zone email suppressions
post_publicnewsuppressionzonerouting(infinite)— Create zone email suppression
publicgetsuppressionzonerouting(infinite)— Get zone email suppression
sending_subdomains(infinite)— List sending subdomains
sending_subdomain(infinite)— Create a sending subdomain
email_sending_subdomains_preview_sending_subdomain(infinite)— Preview sending subdomain DNS
get_sending_subdomain_dns(infinite)— Get sending subdomain DNS records
email_sending_subdomains_fix_sending_subdomain_dns(infinite)— Fix sending subdomain DNS records
sending_subdomain_dns_status(infinite)— Get sending subdomain DNS status
get_publiclistsuppressionzonesending(infinite)— List zone email suppressions
post_publicnewsuppressionzonesending(infinite)— Create zone email suppression
publicgetsuppressionzonesending(infinite)— Get zone email suppression