Email Sending

Send an email

POST/accounts/{account_id}/email/sending/send

Send a raw MIME email

POST/accounts/{account_id}/email/sending/send_raw

ModelsExpand Collapse

EmailSendingSendResponse object { delivered, message_id, permanent_bounces, queued }

delivered: array of string

Email addresses to which the message was delivered immediately.

message_id: string

Message ID of the sent email.

permanent_bounces: array of string

Email addresses that permanently bounced.

queued: array of string

Email addresses for which delivery was queued for later.

EmailSendingSendRawResponse object { delivered, message_id, permanent_bounces, queued }

delivered: array of string

Email addresses to which the message was delivered immediately.

message_id: string

Message ID of the sent email.

permanent_bounces: array of string

Email addresses that permanently bounced.

queued: array of string

Email addresses for which delivery was queued for later.

Email SendingSubdomains

List sending subdomains

GET/zones/{zone_id}/email/sending/subdomains

Get a sending subdomain

GET/zones/{zone_id}/email/sending/subdomains/{subdomain_id}

Create a sending subdomain

POST/zones/{zone_id}/email/sending/subdomains

Delete a sending subdomain

DELETE/zones/{zone_id}/email/sending/subdomains/{subdomain_id}

ModelsExpand Collapse

SubdomainListResponse object { enabled, name, tag, 5 more }

enabled: boolean

Whether Email Sending is enabled on this subdomain.

The exact domain name or a leftmost wildcard such as *.example.com.

tag: string

Sending subdomain identifier.

maxLength32

created: optional string

The date and time the destination address has been created.

formatdate-time

dkim_selector: optional string

The DKIM selector used for email signing. Wildcard rows publish the selector and sign with d=<base>.

modified: optional string

The date and time the destination address was last modified.

formatdate-time

preview_enabled: optional boolean

Whether sent messages from this subdomain can be previewed in the activity log.

return_path_domain: optional string

The return-path domain used for bounce handling. Wildcard rows use cf-bounce.<base>.

SubdomainGetResponse object { enabled, name, tag, 5 more }

enabled: boolean

Whether Email Sending is enabled on this subdomain.

The exact domain name or a leftmost wildcard such as *.example.com.

tag: string

Sending subdomain identifier.

maxLength32

created: optional string

The date and time the destination address has been created.

formatdate-time

dkim_selector: optional string

The DKIM selector used for email signing. Wildcard rows publish the selector and sign with d=<base>.

modified: optional string

The date and time the destination address was last modified.

formatdate-time

preview_enabled: optional boolean

Whether sent messages from this subdomain can be previewed in the activity log.

return_path_domain: optional string

The return-path domain used for bounce handling. Wildcard rows use cf-bounce.<base>.

SubdomainCreateResponse object { enabled, name, tag, 5 more }

enabled: boolean

Whether Email Sending is enabled on this subdomain.

The exact domain name or a leftmost wildcard such as *.example.com.

tag: string

Sending subdomain identifier.

maxLength32

created: optional string

The date and time the destination address has been created.

formatdate-time

dkim_selector: optional string

The DKIM selector used for email signing. Wildcard rows publish the selector and sign with d=<base>.

modified: optional string

The date and time the destination address was last modified.

formatdate-time

preview_enabled: optional boolean

Whether sent messages from this subdomain can be previewed in the activity log.

return_path_domain: optional string

The return-path domain used for bounce handling. Wildcard rows use cf-bounce.<base>.

SubdomainDeleteResponse object { errors, messages, success }

errors: array of object { code, message, documentation_url, source }

code: number

minimum1000

message: string

documentation_url: optional string

source: optional object { pointer }

pointer: optional string

messages: array of object { code, message, documentation_url, source }

code: number

minimum1000

message: string

documentation_url: optional string

source: optional object { pointer }

pointer: optional string

success: true

Whether the API call was successful.

Email SendingSubdomainsDNS

Get sending subdomain DNS records

GET/zones/{zone_id}/email/sending/subdomains/{subdomain_id}/dns

Email Sending

Send an email

Send a raw MIME email

ModelsExpand Collapse

Email SendingSubdomains

List sending subdomains

Get a sending subdomain

Create a sending subdomain

Delete a sending subdomain

ModelsExpand Collapse

Email SendingSubdomainsDNS

Get sending subdomain DNS records

Addresses

Subdomains

On this page