--- title: Email Sending --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/typescript) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Email Sending ##### [Send an email](https://developers.cloudflare.com/api/typescript/resources/email_sending/methods/send) client.emailSending.send(EmailSendingSendParams {account\_id, body } params, RequestOptionsoptions?): [EmailSendingSendResponse]() {delivered, message\_id, permanent\_bounces, 2 more } POST/accounts/{account\_id}/email/sending/send ##### [Send a raw MIME email](https://developers.cloudflare.com/api/typescript/resources/email_sending/methods/send_raw) client.emailSending.sendRaw(EmailSendingSendRawParams {account\_id, from, mime\_message, recipients } params, RequestOptionsoptions?): [EmailSendingSendRawResponse]() {delivered, message\_id, permanent\_bounces, 2 more } POST/accounts/{account\_id}/email/sending/send\_raw ##### ModelsExpand Collapse
EmailSendingSendResponse {delivered, message\_id, permanent\_bounces, 2 more } delivered: Array<string> Email addresses to which the message was delivered immediately. Link to this property message\_id: string Message ID of the sent email. Link to this property permanent\_bounces: Array<string> Email addresses that permanently bounced. Link to this property queued: Array<string> Email addresses for which delivery was queued for later. Link to this property suppressed\_recipients: Array<string> Email addresses dropped because they are on the suppression list. Returned when suppressed-recipient dropping is enabled for the sending subdomain; otherwise the request fails instead. Link to this property
[Link to this property](<#(resource)%20email_sending%20%3E%20(model)%20email_sending_send_response%20%3E%20(schema)>)
EmailSendingSendRawResponse {delivered, message\_id, permanent\_bounces, 2 more } delivered: Array<string> Email addresses to which the message was delivered immediately. Link to this property message\_id: string Message ID of the sent email. Link to this property permanent\_bounces: Array<string> Email addresses that permanently bounced. Link to this property queued: Array<string> Email addresses for which delivery was queued for later. Link to this property suppressed\_recipients: Array<string> Email addresses dropped because they are on the suppression list. Returned when suppressed-recipient dropping is enabled for the sending subdomain; otherwise the request fails instead. Link to this property
[Link to this property](<#(resource)%20email_sending%20%3E%20(model)%20email_sending_send_raw_response%20%3E%20(schema)>) #### Email SendingSuppressions ##### [List account Email Sending suppressions](https://developers.cloudflare.com/api/typescript/resources/email_sending/subresources/suppressions/methods/list) client.emailSending.suppressions.list(SuppressionListParams {account\_id, cursor, email, 5 more } params, RequestOptionsoptions?): CursorPagination< [SuppressionListResponse]() {id, created\_at, email, 5 more } > GET/accounts/{account\_id}/email/sending/suppressions ##### [Get account Email Sending suppression](https://developers.cloudflare.com/api/typescript/resources/email_sending/subresources/suppressions/methods/get) client.emailSending.suppressions.get(stringsuppressionID, SuppressionGetParams {account\_id } params, RequestOptionsoptions?): [SuppressionGetResponse]() {id, created\_at, email, 5 more } GET/accounts/{account\_id}/email/sending/suppressions/{suppression\_id} ##### [Create account Email Sending suppression](https://developers.cloudflare.com/api/typescript/resources/email_sending/subresources/suppressions/methods/create) client.emailSending.suppressions.create(SuppressionCreateParams {account\_id, email, expires\_at, 2 more } params, RequestOptionsoptions?): [SuppressionCreateResponse]() {id, scope } POST/accounts/{account\_id}/email/sending/suppressions ##### [Update account Email Sending suppression](https://developers.cloudflare.com/api/typescript/resources/email_sending/subresources/suppressions/methods/edit) client.emailSending.suppressions.edit(stringsuppressionID, SuppressionEditParams {account\_id, expires\_at, note, scope } params, RequestOptionsoptions?): [SuppressionEditResponse]() {id, created\_at, email, 5 more } PATCH/accounts/{account\_id}/email/sending/suppressions/{suppression\_id} ##### [Delete account Email Sending suppression](https://developers.cloudflare.com/api/typescript/resources/email_sending/subresources/suppressions/methods/delete) client.emailSending.suppressions.delete(stringsuppressionID, SuppressionDeleteParams {account\_id } params, RequestOptionsoptions?): [SuppressionDeleteResponse]() {id, scope } DELETE/accounts/{account\_id}/email/sending/suppressions/{suppression\_id} ##### [Bulk import account Email Sending suppressions](https://developers.cloudflare.com/api/typescript/resources/email_sending/subresources/suppressions/methods/import) client.emailSending.suppressions.import(SuppressionImportParams {account\_id, items } params, RequestOptionsoptions?): [SuppressionImportResponse]() {deduplicated, errors, invalid, 4 more } POST/accounts/{account\_id}/email/sending/suppressions/bulk ##### ModelsExpand Collapse
SuppressionListResponse {id, created\_at, email, 5 more } id: string Unique identifier for this suppression. formatuuid Link to this property created\_at: string When the suppression was created. formatdate-time Link to this property email: string The suppressed email address. formatemail Link to this property expires\_at: string| null When the suppression expires. Null for a permanent suppression. formatdate-time Link to this property read\_only: boolean Whether clients may mutate this suppression. This is determined by the server and must not be inferred from reason. Link to this property reason: string Why the address is suppressed: manual, complaint, hard_bounce, soft_bounce, or policy. Link to this property note?: string| null Advisory note for this suppression, if any. Link to this property
scope?: Type {type } | UnionMember1 {type, value } Where the suppression applies: account for every sending domain of the account, or sending_domain for one envelope MAIL FROM domain. One of the following:
Type {type } type: "account" Blocks the recipient for every sending domain of the account. Link to this property
Link to this property
UnionMember1 {type, value } type: "sending\_domain" Blocks the recipient only for mail whose envelope MAIL FROM uses value. Link to this property value: string The sending domain: the domain part of the envelope MAIL FROM, lowercase, without a trailing dot. maxLength1024 Link to this property
Link to this property
Link to this property
[Link to this property](<#(resource)%20email_sending.suppressions%20%3E%20(model)%20suppression_list_response%20%3E%20(schema)>)
SuppressionGetResponse {id, created\_at, email, 5 more } id: string Unique identifier for this suppression. formatuuid Link to this property created\_at: string When the suppression was created. formatdate-time Link to this property email: string The suppressed email address. formatemail Link to this property expires\_at: string| null When the suppression expires. Null for a permanent suppression. formatdate-time Link to this property read\_only: boolean Whether clients may mutate this suppression. This is determined by the server and must not be inferred from reason. Link to this property reason: string Why the address is suppressed: manual, complaint, hard_bounce, soft_bounce, or policy. Link to this property note?: string| null Advisory note for this suppression, if any. Link to this property
scope?: Type {type } | UnionMember1 {type, value } Where the suppression applies: account for every sending domain of the account, or sending_domain for one envelope MAIL FROM domain. One of the following:
Type {type } type: "account" Blocks the recipient for every sending domain of the account. Link to this property
Link to this property
UnionMember1 {type, value } type: "sending\_domain" Blocks the recipient only for mail whose envelope MAIL FROM uses value. Link to this property value: string The sending domain: the domain part of the envelope MAIL FROM, lowercase, without a trailing dot. maxLength1024 Link to this property
Link to this property
Link to this property
[Link to this property](<#(resource)%20email_sending.suppressions%20%3E%20(model)%20suppression_get_response%20%3E%20(schema)>)
SuppressionCreateResponse {id, scope } id: string The suppression’s identifier. formatuuid Link to this property
scope?: Type {type } | UnionMember1 {type, value } Where the suppression applies: account for every sending domain of the account, or sending_domain for one envelope MAIL FROM domain. One of the following:
Type {type } type: "account" Blocks the recipient for every sending domain of the account. Link to this property
Link to this property
UnionMember1 {type, value } type: "sending\_domain" Blocks the recipient only for mail whose envelope MAIL FROM uses value. Link to this property value: string The sending domain: the domain part of the envelope MAIL FROM, lowercase, without a trailing dot. maxLength1024 Link to this property
Link to this property
Link to this property
[Link to this property](<#(resource)%20email_sending.suppressions%20%3E%20(model)%20suppression_create_response%20%3E%20(schema)>)
SuppressionEditResponse {id, created\_at, email, 5 more } id: string Unique identifier for this suppression. formatuuid Link to this property created\_at: string When the suppression was created. formatdate-time Link to this property email: string The suppressed email address. formatemail Link to this property expires\_at: string| null When the suppression expires. Null for a permanent suppression. formatdate-time Link to this property read\_only: boolean Whether clients may mutate this suppression. This is determined by the server and must not be inferred from reason. Link to this property reason: string Why the address is suppressed: manual, complaint, hard_bounce, soft_bounce, or policy. Link to this property note?: string| null Advisory note for this suppression, if any. Link to this property
scope?: Type {type } | UnionMember1 {type, value } Where the suppression applies: account for every sending domain of the account, or sending_domain for one envelope MAIL FROM domain. One of the following:
Type {type } type: "account" Blocks the recipient for every sending domain of the account. Link to this property
Link to this property
UnionMember1 {type, value } type: "sending\_domain" Blocks the recipient only for mail whose envelope MAIL FROM uses value. Link to this property value: string The sending domain: the domain part of the envelope MAIL FROM, lowercase, without a trailing dot. maxLength1024 Link to this property
Link to this property
Link to this property
[Link to this property](<#(resource)%20email_sending.suppressions%20%3E%20(model)%20suppression_edit_response%20%3E%20(schema)>)
SuppressionDeleteResponse {id, scope } id: string The suppression’s identifier. formatuuid Link to this property
scope?: Type {type } | UnionMember1 {type, value } Where the suppression applies: account for every sending domain of the account, or sending_domain for one envelope MAIL FROM domain. One of the following:
Type {type } type: "account" Blocks the recipient for every sending domain of the account. Link to this property
Link to this property
UnionMember1 {type, value } type: "sending\_domain" Blocks the recipient only for mail whose envelope MAIL FROM uses value. Link to this property value: string The sending domain: the domain part of the envelope MAIL FROM, lowercase, without a trailing dot. maxLength1024 Link to this property
Link to this property
Link to this property
[Link to this property](<#(resource)%20email_sending.suppressions%20%3E%20(model)%20suppression_delete_response%20%3E%20(schema)>)
SuppressionImportResponse {deduplicated, errors, invalid, 4 more } deduplicated: number Number of items dropped because their email address and scope repeated an earlier item in this request. Counted once and excluded from items. Link to this property errors: number Number of items that failed to import due to an unexpected error. Link to this property invalid: number Number of items with an invalid email address or sending domain. Link to this property
items: Array<Item> Per-item results, in the same order as the request body. index: number Zero-based index of this item in the request body. Link to this property
status: "processed"| "invalid"| "error"| "skipped" Outcome for this item. One of the following: "processed" Link to this property "invalid" Link to this property "error" Link to this property "skipped" Link to this property
Link to this property id?: string The created or promoted suppression’s identifier. Present when status is processed. formatuuid Link to this property email?: string The submitted email address for this item. formatemail Link to this property error?: string Human-readable error message. Present when status is invalid, error, or skipped. Link to this property
scope?: Type {type } | UnionMember1 {type, value } Where the suppression applies: account for every sending domain of the account, or sending_domain for one envelope MAIL FROM domain. One of the following:
Type {type } type: "account" Blocks the recipient for every sending domain of the account. Link to this property
Link to this property
UnionMember1 {type, value } type: "sending\_domain" Blocks the recipient only for mail whose envelope MAIL FROM uses value. Link to this property value: string The sending domain: the domain part of the envelope MAIL FROM, lowercase, without a trailing dot. maxLength1024 Link to this property
Link to this property
Link to this property
Link to this property processed: number Number of items successfully created or promoted. Link to this property skipped: number Number of items skipped because the existing suppression is not customer-managed (for example, a read-only policy suppression). Link to this property total: number Total number of items in the request body, including duplicates. Link to this property
[Link to this property](<#(resource)%20email_sending.suppressions%20%3E%20(model)%20suppression_import_response%20%3E%20(schema)>) #### Email SendingSubdomains ##### [List sending subdomains](https://developers.cloudflare.com/api/typescript/resources/email_sending/subresources/subdomains/methods/list) client.emailSending.subdomains.list(SubdomainListParams {zone\_id } params, RequestOptionsoptions?): SinglePage< [SubdomainListResponse]() {enabled, name, tag, 6 more } > GET/zones/{zone\_id}/email/sending/subdomains ##### [Get a sending subdomain](https://developers.cloudflare.com/api/typescript/resources/email_sending/subresources/subdomains/methods/get) client.emailSending.subdomains.get(stringsubdomainID, SubdomainGetParams {zone\_id } params, RequestOptionsoptions?): [SubdomainGetResponse]() {enabled, name, tag, 6 more } GET/zones/{zone\_id}/email/sending/subdomains/{subdomain\_id} ##### [Create a sending subdomain](https://developers.cloudflare.com/api/typescript/resources/email_sending/subresources/subdomains/methods/create) client.emailSending.subdomains.create(SubdomainCreateParams {zone\_id, name } params, RequestOptionsoptions?): [SubdomainCreateResponse]() {enabled, name, tag, 6 more } POST/zones/{zone\_id}/email/sending/subdomains ##### [Update a sending subdomain](https://developers.cloudflare.com/api/typescript/resources/email_sending/subresources/subdomains/methods/edit) client.emailSending.subdomains.edit(stringsubdomainID, SubdomainEditParams {zone\_id, drop\_suppressed\_recipients, preview\_enabled } params, RequestOptionsoptions?): [SubdomainEditResponse]() {enabled, name, tag, 6 more } PATCH/zones/{zone\_id}/email/sending/subdomains/{subdomain\_id} ##### [Delete a sending subdomain](https://developers.cloudflare.com/api/typescript/resources/email_sending/subresources/subdomains/methods/delete) client.emailSending.subdomains.delete(stringsubdomainID, SubdomainDeleteParams {zone\_id } params, RequestOptionsoptions?): [SubdomainDeleteResponse]() {errors, messages, success } DELETE/zones/{zone\_id}/email/sending/subdomains/{subdomain\_id} ##### ModelsExpand Collapse
SubdomainListResponse {enabled, name, tag, 6 more } enabled: boolean Whether Email Sending is enabled on this subdomain. Link to this property name: string The exact domain name or a leftmost wildcard such as *.example.com. Link to this property tag: string Sending subdomain identifier. maxLength32 Link to this property created?: string The date and time the destination address has been created. formatdate-time Link to this property dkim\_selector?: string The DKIM selector used for email signing. Wildcard rows publish the selector and sign with d=<base>. Link to this property drop\_suppressed\_recipients?: boolean Whether a send request that includes a recipient suppressed on this subdomain drops that recipient and still delivers to the rest, instead of failing the entire request. Link to this property modified?: string The date and time the destination address was last modified. formatdate-time Link to this property preview\_enabled?: boolean Whether sent messages from this subdomain can be previewed in the activity log. Link to this property return\_path\_domain?: string The return-path domain used for bounce handling. Wildcard rows use cf-bounce.<base>. Link to this property
[Link to this property](<#(resource)%20email_sending.subdomains%20%3E%20(model)%20subdomain_list_response%20%3E%20(schema)>)
SubdomainGetResponse {enabled, name, tag, 6 more } enabled: boolean Whether Email Sending is enabled on this subdomain. Link to this property name: string The exact domain name or a leftmost wildcard such as *.example.com. Link to this property tag: string Sending subdomain identifier. maxLength32 Link to this property created?: string The date and time the destination address has been created. formatdate-time Link to this property dkim\_selector?: string The DKIM selector used for email signing. Wildcard rows publish the selector and sign with d=<base>. Link to this property drop\_suppressed\_recipients?: boolean Whether a send request that includes a recipient suppressed on this subdomain drops that recipient and still delivers to the rest, instead of failing the entire request. Link to this property modified?: string The date and time the destination address was last modified. formatdate-time Link to this property preview\_enabled?: boolean Whether sent messages from this subdomain can be previewed in the activity log. Link to this property return\_path\_domain?: string The return-path domain used for bounce handling. Wildcard rows use cf-bounce.<base>. Link to this property
[Link to this property](<#(resource)%20email_sending.subdomains%20%3E%20(model)%20subdomain_get_response%20%3E%20(schema)>)
SubdomainCreateResponse {enabled, name, tag, 6 more } enabled: boolean Whether Email Sending is enabled on this subdomain. Link to this property name: string The exact domain name or a leftmost wildcard such as *.example.com. Link to this property tag: string Sending subdomain identifier. maxLength32 Link to this property created?: string The date and time the destination address has been created. formatdate-time Link to this property dkim\_selector?: string The DKIM selector used for email signing. Wildcard rows publish the selector and sign with d=<base>. Link to this property drop\_suppressed\_recipients?: boolean Whether a send request that includes a recipient suppressed on this subdomain drops that recipient and still delivers to the rest, instead of failing the entire request. Link to this property modified?: string The date and time the destination address was last modified. formatdate-time Link to this property preview\_enabled?: boolean Whether sent messages from this subdomain can be previewed in the activity log. Link to this property return\_path\_domain?: string The return-path domain used for bounce handling. Wildcard rows use cf-bounce.<base>. Link to this property
[Link to this property](<#(resource)%20email_sending.subdomains%20%3E%20(model)%20subdomain_create_response%20%3E%20(schema)>)
SubdomainEditResponse {enabled, name, tag, 6 more } enabled: boolean Whether Email Sending is enabled on this subdomain. Link to this property name: string The exact domain name or a leftmost wildcard such as *.example.com. Link to this property tag: string Sending subdomain identifier. maxLength32 Link to this property created?: string The date and time the destination address has been created. formatdate-time Link to this property dkim\_selector?: string The DKIM selector used for email signing. Wildcard rows publish the selector and sign with d=<base>. Link to this property drop\_suppressed\_recipients?: boolean Whether a send request that includes a recipient suppressed on this subdomain drops that recipient and still delivers to the rest, instead of failing the entire request. Link to this property modified?: string The date and time the destination address was last modified. formatdate-time Link to this property preview\_enabled?: boolean Whether sent messages from this subdomain can be previewed in the activity log. Link to this property return\_path\_domain?: string The return-path domain used for bounce handling. Wildcard rows use cf-bounce.<base>. Link to this property
[Link to this property](<#(resource)%20email_sending.subdomains%20%3E%20(model)%20subdomain_edit_response%20%3E%20(schema)>)
SubdomainDeleteResponse {errors, messages, success }
errors: Array<Error> code: number minimum1000 Link to this property message: string Link to this property documentation\_url?: string Link to this property
source?: Source {pointer } pointer?: string Link to this property
Link to this property
Link to this property
messages: Array<Message> code: number minimum1000 Link to this property message: string Link to this property documentation\_url?: string Link to this property
source?: Source {pointer } pointer?: string Link to this property
Link to this property
Link to this property success: true Whether the API call was successful. Link to this property
[Link to this property](<#(resource)%20email_sending.subdomains%20%3E%20(model)%20subdomain_delete_response%20%3E%20(schema)>) #### Email SendingSubdomainsDNS ##### [Get sending subdomain DNS records](https://developers.cloudflare.com/api/typescript/resources/email_sending/subresources/subdomains/subresources/dns/methods/get) client.emailSending.subdomains.dns.get(stringsubdomainID, DNSGetParams {zone\_id } params, RequestOptionsoptions?): SinglePage< [DNSRecord]() {content, name, priority, 2 more } > GET/zones/{zone\_id}/email/sending/subdomains/{subdomain\_id}/dns