--- title: Settings --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/typescript) [Email Security](https://developers.cloudflare.com/api/typescript/resources/email_security) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Settings #### SettingsAllow Policies ##### [List email allow policies](https://developers.cloudflare.com/api/typescript/resources/email_security/subresources/settings/subresources/allow_policies/methods/list) client.emailSecurity.settings.allowPolicies.list(AllowPolicyListParams {account\_id, direction, is\_acceptable\_sender, 9 more } params, RequestOptionsoptions?): V4PagePaginationArray< [AllowPolicyListResponse]() {id, created\_at, last\_modified, 12 more } > GET/accounts/{account\_id}/email-security/settings/allow\_policies ##### [Get an email allow policy](https://developers.cloudflare.com/api/typescript/resources/email_security/subresources/settings/subresources/allow_policies/methods/get) client.emailSecurity.settings.allowPolicies.get(stringpolicyID, AllowPolicyGetParams {account\_id } params, RequestOptionsoptions?): [AllowPolicyGetResponse]() {id, created\_at, last\_modified, 12 more } GET/accounts/{account\_id}/email-security/settings/allow\_policies/{policy\_id} ##### [Create email allow policy](https://developers.cloudflare.com/api/typescript/resources/email_security/subresources/settings/subresources/allow_policies/methods/create) client.emailSecurity.settings.allowPolicies.create(AllowPolicyCreateParams {account\_id, is\_acceptable\_sender, is\_exempt\_recipient, 9 more } params, RequestOptionsoptions?): [AllowPolicyCreateResponse]() {id, created\_at, last\_modified, 12 more } POST/accounts/{account\_id}/email-security/settings/allow\_policies ##### [Update an email allow policy](https://developers.cloudflare.com/api/typescript/resources/email_security/subresources/settings/subresources/allow_policies/methods/edit) client.emailSecurity.settings.allowPolicies.edit(stringpolicyID, AllowPolicyEditParams {account\_id, comments, is\_acceptable\_sender, 9 more } params, RequestOptionsoptions?): [AllowPolicyEditResponse]() {id, created\_at, last\_modified, 12 more } PATCH/accounts/{account\_id}/email-security/settings/allow\_policies/{policy\_id} ##### [Delete an email allow policy](https://developers.cloudflare.com/api/typescript/resources/email_security/subresources/settings/subresources/allow_policies/methods/delete) client.emailSecurity.settings.allowPolicies.delete(stringpolicyID, AllowPolicyDeleteParams {account\_id } params, RequestOptionsoptions?): [AllowPolicyDeleteResponse]() {id } DELETE/accounts/{account\_id}/email-security/settings/allow\_policies/{policy\_id} ##### [Batch allow policy operations](https://developers.cloudflare.com/api/typescript/resources/email_security/subresources/settings/subresources/allow_policies/methods/batch) client.emailSecurity.settings.allowPolicies.batch(AllowPolicyBatchParams {account\_id, deletes, patches, 2 more } params, RequestOptionsoptions?): [AllowPolicyBatchResponse]() {deletes, patches, posts, puts } POST/accounts/{account\_id}/email-security/settings/allow\_policies/batch ##### ModelsExpand Collapse
AllowPolicyListResponse {id, created\_at, last\_modified, 12 more } An email allow policy. id: string Allow policy identifier. formatuuid Link to this property created\_at: string formatdate-time Link to this property Deprecatedlast\_modified: string Use modified_at instead. Deprecated, use modified_at instead. End of life: November 1, 2026. formatdate-time Link to this property comments?: string| null maxLength1024 Link to this property is\_acceptable\_sender?: boolean Exempts messages from this sender from Spam, Spoof and Bulk dispositions only; Malicious and Suspicious dispositions still apply. Link to this property is\_exempt\_recipient?: boolean Bypasses all detections for messages to this recipient. Link to this property Deprecatedis\_recipient?: boolean Use is_exempt_recipient instead. Deprecated as of July 1, 2025. Use is_exempt_recipient instead. End of life: July 1, 2026. Link to this property is\_regex?: boolean Link to this property Deprecatedis\_sender?: boolean Use is_trusted_sender instead. Deprecated as of July 1, 2025. Use is_trusted_sender instead. End of life: July 1, 2026. Link to this property Deprecatedis\_spoof?: boolean Use is_acceptable_sender instead. Deprecated as of July 1, 2025. Use is_acceptable_sender instead. End of life: July 1, 2026. Link to this property is\_trusted\_sender?: boolean Bypasses all detections and link following for messages from this sender. Link to this property modified\_at?: string formatdate-time Link to this property pattern?: string The pattern value to match. The format depends on pattern_type: a valid email address for EMAIL (e.g. user@example.com), a valid domain name for DOMAIN (e.g. example.com), or a plain IPv4 or IPv6 address or CIDR block for IP (e.g. 1.2.3.4, 1.2.3.0/24, 2606:4700:4700::1111, or 2606:4700:4700::/48); the API rejects private or unique-local, loopback, link-local, unspecified, and IPv4 broadcast addresses, including their IPv4-mapped IPv6 equivalents. maxLength1024 minLength1 Link to this property
pattern\_type?: "EMAIL"| "DOMAIN"| "IP"| "UNKNOWN" Type of pattern matching. - EMAIL: matches a full email address (e.g. user@example.com) - DOMAIN: matches a domain name (e.g. example.com) - IP: matches a plain IPv4 or IPv6 address (e.g. 1.2.3.4 or 2606:4700:4700::1111) or CIDR block (e.g. 1.2.3.0/24 or 2606:4700:4700::/48). The API rejects private or unique-local, loopback, link-local, unspecified, and IPv4 broadcast addresses, including their IPv4-mapped IPv6 equivalents. - UNKNOWN: deprecated; you cannot use this when creating or updating policies, but it may appear on existing entries. One of the following: "EMAIL" Link to this property "DOMAIN" Link to this property "IP" Link to this property "UNKNOWN" Link to this property
Link to this property verify\_sender?: boolean Enforce DMARC, SPF or DKIM authentication. When on, Email Security only honors policies that pass authentication. Link to this property
[Link to this property](<#(resource)%20email_security.settings.allow_policies%20%3E%20(model)%20allow_policy_list_response%20%3E%20(schema)>)
AllowPolicyGetResponse {id, created\_at, last\_modified, 12 more } An email allow policy. id: string Allow policy identifier. formatuuid Link to this property created\_at: string formatdate-time Link to this property Deprecatedlast\_modified: string Use modified_at instead. Deprecated, use modified_at instead. End of life: November 1, 2026. formatdate-time Link to this property comments?: string| null maxLength1024 Link to this property is\_acceptable\_sender?: boolean Exempts messages from this sender from Spam, Spoof and Bulk dispositions only; Malicious and Suspicious dispositions still apply. Link to this property is\_exempt\_recipient?: boolean Bypasses all detections for messages to this recipient. Link to this property Deprecatedis\_recipient?: boolean Use is_exempt_recipient instead. Deprecated as of July 1, 2025. Use is_exempt_recipient instead. End of life: July 1, 2026. Link to this property is\_regex?: boolean Link to this property Deprecatedis\_sender?: boolean Use is_trusted_sender instead. Deprecated as of July 1, 2025. Use is_trusted_sender instead. End of life: July 1, 2026. Link to this property Deprecatedis\_spoof?: boolean Use is_acceptable_sender instead. Deprecated as of July 1, 2025. Use is_acceptable_sender instead. End of life: July 1, 2026. Link to this property is\_trusted\_sender?: boolean Bypasses all detections and link following for messages from this sender. Link to this property modified\_at?: string formatdate-time Link to this property pattern?: string The pattern value to match. The format depends on pattern_type: a valid email address for EMAIL (e.g. user@example.com), a valid domain name for DOMAIN (e.g. example.com), or a plain IPv4 or IPv6 address or CIDR block for IP (e.g. 1.2.3.4, 1.2.3.0/24, 2606:4700:4700::1111, or 2606:4700:4700::/48); the API rejects private or unique-local, loopback, link-local, unspecified, and IPv4 broadcast addresses, including their IPv4-mapped IPv6 equivalents. maxLength1024 minLength1 Link to this property
pattern\_type?: "EMAIL"| "DOMAIN"| "IP"| "UNKNOWN" Type of pattern matching. - EMAIL: matches a full email address (e.g. user@example.com) - DOMAIN: matches a domain name (e.g. example.com) - IP: matches a plain IPv4 or IPv6 address (e.g. 1.2.3.4 or 2606:4700:4700::1111) or CIDR block (e.g. 1.2.3.0/24 or 2606:4700:4700::/48). The API rejects private or unique-local, loopback, link-local, unspecified, and IPv4 broadcast addresses, including their IPv4-mapped IPv6 equivalents. - UNKNOWN: deprecated; you cannot use this when creating or updating policies, but it may appear on existing entries. One of the following: "EMAIL" Link to this property "DOMAIN" Link to this property "IP" Link to this property "UNKNOWN" Link to this property
Link to this property verify\_sender?: boolean Enforce DMARC, SPF or DKIM authentication. When on, Email Security only honors policies that pass authentication. Link to this property
[Link to this property](<#(resource)%20email_security.settings.allow_policies%20%3E%20(model)%20allow_policy_get_response%20%3E%20(schema)>)
AllowPolicyCreateResponse {id, created\_at, last\_modified, 12 more } An email allow policy. id: string Allow policy identifier. formatuuid Link to this property created\_at: string formatdate-time Link to this property Deprecatedlast\_modified: string Use modified_at instead. Deprecated, use modified_at instead. End of life: November 1, 2026. formatdate-time Link to this property comments?: string| null maxLength1024 Link to this property is\_acceptable\_sender?: boolean Exempts messages from this sender from Spam, Spoof and Bulk dispositions only; Malicious and Suspicious dispositions still apply. Link to this property is\_exempt\_recipient?: boolean Bypasses all detections for messages to this recipient. Link to this property Deprecatedis\_recipient?: boolean Use is_exempt_recipient instead. Deprecated as of July 1, 2025. Use is_exempt_recipient instead. End of life: July 1, 2026. Link to this property is\_regex?: boolean Link to this property Deprecatedis\_sender?: boolean Use is_trusted_sender instead. Deprecated as of July 1, 2025. Use is_trusted_sender instead. End of life: July 1, 2026. Link to this property Deprecatedis\_spoof?: boolean Use is_acceptable_sender instead. Deprecated as of July 1, 2025. Use is_acceptable_sender instead. End of life: July 1, 2026. Link to this property is\_trusted\_sender?: boolean Bypasses all detections and link following for messages from this sender. Link to this property modified\_at?: string formatdate-time Link to this property pattern?: string The pattern value to match. The format depends on pattern_type: a valid email address for EMAIL (e.g. user@example.com), a valid domain name for DOMAIN (e.g. example.com), or a plain IPv4 or IPv6 address or CIDR block for IP (e.g. 1.2.3.4, 1.2.3.0/24, 2606:4700:4700::1111, or 2606:4700:4700::/48); the API rejects private or unique-local, loopback, link-local, unspecified, and IPv4 broadcast addresses, including their IPv4-mapped IPv6 equivalents. maxLength1024 minLength1 Link to this property
pattern\_type?: "EMAIL"| "DOMAIN"| "IP"| "UNKNOWN" Type of pattern matching. - EMAIL: matches a full email address (e.g. user@example.com) - DOMAIN: matches a domain name (e.g. example.com) - IP: matches a plain IPv4 or IPv6 address (e.g. 1.2.3.4 or 2606:4700:4700::1111) or CIDR block (e.g. 1.2.3.0/24 or 2606:4700:4700::/48). The API rejects private or unique-local, loopback, link-local, unspecified, and IPv4 broadcast addresses, including their IPv4-mapped IPv6 equivalents. - UNKNOWN: deprecated; you cannot use this when creating or updating policies, but it may appear on existing entries. One of the following: "EMAIL" Link to this property "DOMAIN" Link to this property "IP" Link to this property "UNKNOWN" Link to this property
Link to this property verify\_sender?: boolean Enforce DMARC, SPF or DKIM authentication. When on, Email Security only honors policies that pass authentication. Link to this property
[Link to this property](<#(resource)%20email_security.settings.allow_policies%20%3E%20(model)%20allow_policy_create_response%20%3E%20(schema)>)
AllowPolicyEditResponse {id, created\_at, last\_modified, 12 more } An email allow policy. id: string Allow policy identifier. formatuuid Link to this property created\_at: string formatdate-time Link to this property Deprecatedlast\_modified: string Use modified_at instead. Deprecated, use modified_at instead. End of life: November 1, 2026. formatdate-time Link to this property comments?: string| null maxLength1024 Link to this property is\_acceptable\_sender?: boolean Exempts messages from this sender from Spam, Spoof and Bulk dispositions only; Malicious and Suspicious dispositions still apply. Link to this property is\_exempt\_recipient?: boolean Bypasses all detections for messages to this recipient. Link to this property Deprecatedis\_recipient?: boolean Use is_exempt_recipient instead. Deprecated as of July 1, 2025. Use is_exempt_recipient instead. End of life: July 1, 2026. Link to this property is\_regex?: boolean Link to this property Deprecatedis\_sender?: boolean Use is_trusted_sender instead. Deprecated as of July 1, 2025. Use is_trusted_sender instead. End of life: July 1, 2026. Link to this property Deprecatedis\_spoof?: boolean Use is_acceptable_sender instead. Deprecated as of July 1, 2025. Use is_acceptable_sender instead. End of life: July 1, 2026. Link to this property is\_trusted\_sender?: boolean Bypasses all detections and link following for messages from this sender. Link to this property modified\_at?: string formatdate-time Link to this property pattern?: string The pattern value to match. The format depends on pattern_type: a valid email address for EMAIL (e.g. user@example.com), a valid domain name for DOMAIN (e.g. example.com), or a plain IPv4 or IPv6 address or CIDR block for IP (e.g. 1.2.3.4, 1.2.3.0/24, 2606:4700:4700::1111, or 2606:4700:4700::/48); the API rejects private or unique-local, loopback, link-local, unspecified, and IPv4 broadcast addresses, including their IPv4-mapped IPv6 equivalents. maxLength1024 minLength1 Link to this property
pattern\_type?: "EMAIL"| "DOMAIN"| "IP"| "UNKNOWN" Type of pattern matching. - EMAIL: matches a full email address (e.g. user@example.com) - DOMAIN: matches a domain name (e.g. example.com) - IP: matches a plain IPv4 or IPv6 address (e.g. 1.2.3.4 or 2606:4700:4700::1111) or CIDR block (e.g. 1.2.3.0/24 or 2606:4700:4700::/48). The API rejects private or unique-local, loopback, link-local, unspecified, and IPv4 broadcast addresses, including their IPv4-mapped IPv6 equivalents. - UNKNOWN: deprecated; you cannot use this when creating or updating policies, but it may appear on existing entries. One of the following: "EMAIL" Link to this property "DOMAIN" Link to this property "IP" Link to this property "UNKNOWN" Link to this property
Link to this property verify\_sender?: boolean Enforce DMARC, SPF or DKIM authentication. When on, Email Security only honors policies that pass authentication. Link to this property
[Link to this property](<#(resource)%20email_security.settings.allow_policies%20%3E%20(model)%20allow_policy_edit_response%20%3E%20(schema)>)
AllowPolicyDeleteResponse {id } id: string Allow policy identifier. formatuuid Link to this property
[Link to this property](<#(resource)%20email_security.settings.allow_policies%20%3E%20(model)%20allow_policy_delete_response%20%3E%20(schema)>)
AllowPolicyBatchResponse {deletes, patches, posts, puts }
deletes?: Array<Delete> id: string Allow policy identifier. formatuuid Link to this property
Link to this property
patches?: Array<Patch> id: string Allow policy identifier. formatuuid Link to this property created\_at: string formatdate-time Link to this property Deprecatedlast\_modified: string Use modified_at instead. Deprecated, use modified_at instead. End of life: November 1, 2026. formatdate-time Link to this property comments?: string| null maxLength1024 Link to this property is\_acceptable\_sender?: boolean Exempts messages from this sender from Spam, Spoof and Bulk dispositions only; Malicious and Suspicious dispositions still apply. Link to this property is\_exempt\_recipient?: boolean Bypasses all detections for messages to this recipient. Link to this property Deprecatedis\_recipient?: boolean Use is_exempt_recipient instead. Deprecated as of July 1, 2025. Use is_exempt_recipient instead. End of life: July 1, 2026. Link to this property is\_regex?: boolean Link to this property Deprecatedis\_sender?: boolean Use is_trusted_sender instead. Deprecated as of July 1, 2025. Use is_trusted_sender instead. End of life: July 1, 2026. Link to this property Deprecatedis\_spoof?: boolean Use is_acceptable_sender instead. Deprecated as of July 1, 2025. Use is_acceptable_sender instead. End of life: July 1, 2026. Link to this property is\_trusted\_sender?: boolean Bypasses all detections and link following for messages from this sender. Link to this property modified\_at?: string formatdate-time Link to this property pattern?: string The pattern value to match. The format depends on pattern_type: a valid email address for EMAIL (e.g. user@example.com), a valid domain name for DOMAIN (e.g. example.com), or a plain IPv4 or IPv6 address or CIDR block for IP (e.g. 1.2.3.4, 1.2.3.0/24, 2606:4700:4700::1111, or 2606:4700:4700::/48); the API rejects private or unique-local, loopback, link-local, unspecified, and IPv4 broadcast addresses, including their IPv4-mapped IPv6 equivalents. maxLength1024 minLength1 Link to this property
pattern\_type?: "EMAIL"| "DOMAIN"| "IP"| "UNKNOWN" Type of pattern matching. - EMAIL: matches a full email address (e.g. user@example.com) - DOMAIN: matches a domain name (e.g. example.com) - IP: matches a plain IPv4 or IPv6 address (e.g. 1.2.3.4 or 2606:4700:4700::1111) or CIDR block (e.g. 1.2.3.0/24 or 2606:4700:4700::/48). The API rejects private or unique-local, loopback, link-local, unspecified, and IPv4 broadcast addresses, including their IPv4-mapped IPv6 equivalents. - UNKNOWN: deprecated; you cannot use this when creating or updating policies, but it may appear on existing entries. One of the following: "EMAIL" Link to this property "DOMAIN" Link to this property "IP" Link to this property "UNKNOWN" Link to this property
Link to this property verify\_sender?: boolean Enforce DMARC, SPF or DKIM authentication. When on, Email Security only honors policies that pass authentication. Link to this property
Link to this property
posts?: Array<Post> id: string Allow policy identifier. formatuuid Link to this property created\_at: string formatdate-time Link to this property Deprecatedlast\_modified: string Use modified_at instead. Deprecated, use modified_at instead. End of life: November 1, 2026. formatdate-time Link to this property comments?: string| null maxLength1024 Link to this property is\_acceptable\_sender?: boolean Exempts messages from this sender from Spam, Spoof and Bulk dispositions only; Malicious and Suspicious dispositions still apply. Link to this property is\_exempt\_recipient?: boolean Bypasses all detections for messages to this recipient. Link to this property Deprecatedis\_recipient?: boolean Use is_exempt_recipient instead. Deprecated as of July 1, 2025. Use is_exempt_recipient instead. End of life: July 1, 2026. Link to this property is\_regex?: boolean Link to this property Deprecatedis\_sender?: boolean Use is_trusted_sender instead. Deprecated as of July 1, 2025. Use is_trusted_sender instead. End of life: July 1, 2026. Link to this property Deprecatedis\_spoof?: boolean Use is_acceptable_sender instead. Deprecated as of July 1, 2025. Use is_acceptable_sender instead. End of life: July 1, 2026. Link to this property is\_trusted\_sender?: boolean Bypasses all detections and link following for messages from this sender. Link to this property modified\_at?: string formatdate-time Link to this property pattern?: string The pattern value to match. The format depends on pattern_type: a valid email address for EMAIL (e.g. user@example.com), a valid domain name for DOMAIN (e.g. example.com), or a plain IPv4 or IPv6 address or CIDR block for IP (e.g. 1.2.3.4, 1.2.3.0/24, 2606:4700:4700::1111, or 2606:4700:4700::/48); the API rejects private or unique-local, loopback, link-local, unspecified, and IPv4 broadcast addresses, including their IPv4-mapped IPv6 equivalents. maxLength1024 minLength1 Link to this property
pattern\_type?: "EMAIL"| "DOMAIN"| "IP"| "UNKNOWN" Type of pattern matching. - EMAIL: matches a full email address (e.g. user@example.com) - DOMAIN: matches a domain name (e.g. example.com) - IP: matches a plain IPv4 or IPv6 address (e.g. 1.2.3.4 or 2606:4700:4700::1111) or CIDR block (e.g. 1.2.3.0/24 or 2606:4700:4700::/48). The API rejects private or unique-local, loopback, link-local, unspecified, and IPv4 broadcast addresses, including their IPv4-mapped IPv6 equivalents. - UNKNOWN: deprecated; you cannot use this when creating or updating policies, but it may appear on existing entries. One of the following: "EMAIL" Link to this property "DOMAIN" Link to this property "IP" Link to this property "UNKNOWN" Link to this property
Link to this property verify\_sender?: boolean Enforce DMARC, SPF or DKIM authentication. When on, Email Security only honors policies that pass authentication. Link to this property
Link to this property
puts?: Array<Put> id: string Allow policy identifier. formatuuid Link to this property created\_at: string formatdate-time Link to this property Deprecatedlast\_modified: string Use modified_at instead. Deprecated, use modified_at instead. End of life: November 1, 2026. formatdate-time Link to this property comments?: string| null maxLength1024 Link to this property is\_acceptable\_sender?: boolean Exempts messages from this sender from Spam, Spoof and Bulk dispositions only; Malicious and Suspicious dispositions still apply. Link to this property is\_exempt\_recipient?: boolean Bypasses all detections for messages to this recipient. Link to this property Deprecatedis\_recipient?: boolean Use is_exempt_recipient instead. Deprecated as of July 1, 2025. Use is_exempt_recipient instead. End of life: July 1, 2026. Link to this property is\_regex?: boolean Link to this property Deprecatedis\_sender?: boolean Use is_trusted_sender instead. Deprecated as of July 1, 2025. Use is_trusted_sender instead. End of life: July 1, 2026. Link to this property Deprecatedis\_spoof?: boolean Use is_acceptable_sender instead. Deprecated as of July 1, 2025. Use is_acceptable_sender instead. End of life: July 1, 2026. Link to this property is\_trusted\_sender?: boolean Bypasses all detections and link following for messages from this sender. Link to this property modified\_at?: string formatdate-time Link to this property pattern?: string The pattern value to match. The format depends on pattern_type: a valid email address for EMAIL (e.g. user@example.com), a valid domain name for DOMAIN (e.g. example.com), or a plain IPv4 or IPv6 address or CIDR block for IP (e.g. 1.2.3.4, 1.2.3.0/24, 2606:4700:4700::1111, or 2606:4700:4700::/48); the API rejects private or unique-local, loopback, link-local, unspecified, and IPv4 broadcast addresses, including their IPv4-mapped IPv6 equivalents. maxLength1024 minLength1 Link to this property
pattern\_type?: "EMAIL"| "DOMAIN"| "IP"| "UNKNOWN" Type of pattern matching. - EMAIL: matches a full email address (e.g. user@example.com) - DOMAIN: matches a domain name (e.g. example.com) - IP: matches a plain IPv4 or IPv6 address (e.g. 1.2.3.4 or 2606:4700:4700::1111) or CIDR block (e.g. 1.2.3.0/24 or 2606:4700:4700::/48). The API rejects private or unique-local, loopback, link-local, unspecified, and IPv4 broadcast addresses, including their IPv4-mapped IPv6 equivalents. - UNKNOWN: deprecated; you cannot use this when creating or updating policies, but it may appear on existing entries. One of the following: "EMAIL" Link to this property "DOMAIN" Link to this property "IP" Link to this property "UNKNOWN" Link to this property
Link to this property verify\_sender?: boolean Enforce DMARC, SPF or DKIM authentication. When on, Email Security only honors policies that pass authentication. Link to this property
Link to this property
[Link to this property](<#(resource)%20email_security.settings.allow_policies%20%3E%20(model)%20allow_policy_batch_response%20%3E%20(schema)>) #### SettingsBlock Senders ##### [List blocked email senders](https://developers.cloudflare.com/api/typescript/resources/email_security/subresources/settings/subresources/block_senders/methods/list) client.emailSecurity.settings.blockSenders.list(BlockSenderListParams {account\_id, direction, order, 5 more } params, RequestOptionsoptions?): V4PagePaginationArray< [BlockSenderListResponse]() {id, comments, created\_at, 5 more } > GET/accounts/{account\_id}/email-security/settings/block\_senders ##### [Get a blocked email sender](https://developers.cloudflare.com/api/typescript/resources/email_security/subresources/settings/subresources/block_senders/methods/get) client.emailSecurity.settings.blockSenders.get(stringpatternID, BlockSenderGetParams {account\_id } params, RequestOptionsoptions?): [BlockSenderGetResponse]() {id, comments, created\_at, 5 more } GET/accounts/{account\_id}/email-security/settings/block\_senders/{pattern\_id} ##### [Create blocked email sender](https://developers.cloudflare.com/api/typescript/resources/email_security/subresources/settings/subresources/block_senders/methods/create) client.emailSecurity.settings.blockSenders.create(BlockSenderCreateParams {account\_id, is\_regex, pattern, 2 more } params, RequestOptionsoptions?): [BlockSenderCreateResponse]() {id, comments, created\_at, 5 more } POST/accounts/{account\_id}/email-security/settings/block\_senders ##### [Update a blocked email sender](https://developers.cloudflare.com/api/typescript/resources/email_security/subresources/settings/subresources/block_senders/methods/edit) client.emailSecurity.settings.blockSenders.edit(stringpatternID, BlockSenderEditParams {account\_id, comments, is\_regex, 2 more } params, RequestOptionsoptions?): [BlockSenderEditResponse]() {id, comments, created\_at, 5 more } PATCH/accounts/{account\_id}/email-security/settings/block\_senders/{pattern\_id} ##### [Delete a blocked email sender](https://developers.cloudflare.com/api/typescript/resources/email_security/subresources/settings/subresources/block_senders/methods/delete) client.emailSecurity.settings.blockSenders.delete(stringpatternID, BlockSenderDeleteParams {account\_id } params, RequestOptionsoptions?): [BlockSenderDeleteResponse]() {id } DELETE/accounts/{account\_id}/email-security/settings/block\_senders/{pattern\_id} ##### [Batch blocked sender operations](https://developers.cloudflare.com/api/typescript/resources/email_security/subresources/settings/subresources/block_senders/methods/batch) client.emailSecurity.settings.blockSenders.batch(BlockSenderBatchParams {account\_id, deletes, patches, 2 more } params, RequestOptionsoptions?): [BlockSenderBatchResponse]() {deletes, patches, posts, puts } POST/accounts/{account\_id}/email-security/settings/block\_senders/batch ##### ModelsExpand Collapse
BlockSenderListResponse {id, comments, created\_at, 5 more } A blocked sender pattern. id?: string Blocked sender pattern identifier. formatuuid Link to this property comments?: string| null maxLength1024 Link to this property created\_at?: string formatdate-time Link to this property is\_regex?: boolean Whether pattern is a regular expression instead of a literal value. Link to this property Deprecatedlast\_modified?: string Use modified_at instead. Deprecated, use modified_at instead. End of life: November 1, 2026. formatdate-time Link to this property modified\_at?: string formatdate-time Link to this property pattern?: string The pattern value to match. The format depends on pattern_type: a valid email address for EMAIL (e.g. user@example.com), a valid domain name for DOMAIN (e.g. example.com), or a plain IPv4 or IPv6 address or CIDR block for IP (e.g. 1.2.3.4, 1.2.3.0/24, 2606:4700:4700::1111, or 2606:4700:4700::/48); the API rejects private or unique-local, loopback, link-local, unspecified, and IPv4 broadcast addresses, including their IPv4-mapped IPv6 equivalents. maxLength1024 minLength1 Link to this property
pattern\_type?: "EMAIL"| "DOMAIN"| "IP"| "UNKNOWN" Type of pattern matching. - EMAIL: matches a full email address (e.g. user@example.com) - DOMAIN: matches a domain name (e.g. example.com) - IP: matches a plain IPv4 or IPv6 address (e.g. 1.2.3.4 or 2606:4700:4700::1111) or CIDR block (e.g. 1.2.3.0/24 or 2606:4700:4700::/48). The API rejects private or unique-local, loopback, link-local, unspecified, and IPv4 broadcast addresses, including their IPv4-mapped IPv6 equivalents. - UNKNOWN: deprecated; you cannot use this when creating or updating policies, but it may appear on existing entries. One of the following: "EMAIL" Link to this property "DOMAIN" Link to this property "IP" Link to this property "UNKNOWN" Link to this property
Link to this property
[Link to this property](<#(resource)%20email_security.settings.block_senders%20%3E%20(model)%20block_sender_list_response%20%3E%20(schema)>)
BlockSenderGetResponse {id, comments, created\_at, 5 more } A blocked sender pattern. id?: string Blocked sender pattern identifier. formatuuid Link to this property comments?: string| null maxLength1024 Link to this property created\_at?: string formatdate-time Link to this property is\_regex?: boolean Whether pattern is a regular expression instead of a literal value. Link to this property Deprecatedlast\_modified?: string Use modified_at instead. Deprecated, use modified_at instead. End of life: November 1, 2026. formatdate-time Link to this property modified\_at?: string formatdate-time Link to this property pattern?: string The pattern value to match. The format depends on pattern_type: a valid email address for EMAIL (e.g. user@example.com), a valid domain name for DOMAIN (e.g. example.com), or a plain IPv4 or IPv6 address or CIDR block for IP (e.g. 1.2.3.4, 1.2.3.0/24, 2606:4700:4700::1111, or 2606:4700:4700::/48); the API rejects private or unique-local, loopback, link-local, unspecified, and IPv4 broadcast addresses, including their IPv4-mapped IPv6 equivalents. maxLength1024 minLength1 Link to this property
pattern\_type?: "EMAIL"| "DOMAIN"| "IP"| "UNKNOWN" Type of pattern matching. - EMAIL: matches a full email address (e.g. user@example.com) - DOMAIN: matches a domain name (e.g. example.com) - IP: matches a plain IPv4 or IPv6 address (e.g. 1.2.3.4 or 2606:4700:4700::1111) or CIDR block (e.g. 1.2.3.0/24 or 2606:4700:4700::/48). The API rejects private or unique-local, loopback, link-local, unspecified, and IPv4 broadcast addresses, including their IPv4-mapped IPv6 equivalents. - UNKNOWN: deprecated; you cannot use this when creating or updating policies, but it may appear on existing entries. One of the following: "EMAIL" Link to this property "DOMAIN" Link to this property "IP" Link to this property "UNKNOWN" Link to this property
Link to this property
[Link to this property](<#(resource)%20email_security.settings.block_senders%20%3E%20(model)%20block_sender_get_response%20%3E%20(schema)>)
BlockSenderCreateResponse {id, comments, created\_at, 5 more } A blocked sender pattern. id?: string Blocked sender pattern identifier. formatuuid Link to this property comments?: string| null maxLength1024 Link to this property created\_at?: string formatdate-time Link to this property is\_regex?: boolean Whether pattern is a regular expression instead of a literal value. Link to this property Deprecatedlast\_modified?: string Use modified_at instead. Deprecated, use modified_at instead. End of life: November 1, 2026. formatdate-time Link to this property modified\_at?: string formatdate-time Link to this property pattern?: string The pattern value to match. The format depends on pattern_type: a valid email address for EMAIL (e.g. user@example.com), a valid domain name for DOMAIN (e.g. example.com), or a plain IPv4 or IPv6 address or CIDR block for IP (e.g. 1.2.3.4, 1.2.3.0/24, 2606:4700:4700::1111, or 2606:4700:4700::/48); the API rejects private or unique-local, loopback, link-local, unspecified, and IPv4 broadcast addresses, including their IPv4-mapped IPv6 equivalents. maxLength1024 minLength1 Link to this property
pattern\_type?: "EMAIL"| "DOMAIN"| "IP"| "UNKNOWN" Type of pattern matching. - EMAIL: matches a full email address (e.g. user@example.com) - DOMAIN: matches a domain name (e.g. example.com) - IP: matches a plain IPv4 or IPv6 address (e.g. 1.2.3.4 or 2606:4700:4700::1111) or CIDR block (e.g. 1.2.3.0/24 or 2606:4700:4700::/48). The API rejects private or unique-local, loopback, link-local, unspecified, and IPv4 broadcast addresses, including their IPv4-mapped IPv6 equivalents. - UNKNOWN: deprecated; you cannot use this when creating or updating policies, but it may appear on existing entries. One of the following: "EMAIL" Link to this property "DOMAIN" Link to this property "IP" Link to this property "UNKNOWN" Link to this property
Link to this property
[Link to this property](<#(resource)%20email_security.settings.block_senders%20%3E%20(model)%20block_sender_create_response%20%3E%20(schema)>)
BlockSenderEditResponse {id, comments, created\_at, 5 more } A blocked sender pattern. id?: string Blocked sender pattern identifier. formatuuid Link to this property comments?: string| null maxLength1024 Link to this property created\_at?: string formatdate-time Link to this property is\_regex?: boolean Whether pattern is a regular expression instead of a literal value. Link to this property Deprecatedlast\_modified?: string Use modified_at instead. Deprecated, use modified_at instead. End of life: November 1, 2026. formatdate-time Link to this property modified\_at?: string formatdate-time Link to this property pattern?: string The pattern value to match. The format depends on pattern_type: a valid email address for EMAIL (e.g. user@example.com), a valid domain name for DOMAIN (e.g. example.com), or a plain IPv4 or IPv6 address or CIDR block for IP (e.g. 1.2.3.4, 1.2.3.0/24, 2606:4700:4700::1111, or 2606:4700:4700::/48); the API rejects private or unique-local, loopback, link-local, unspecified, and IPv4 broadcast addresses, including their IPv4-mapped IPv6 equivalents. maxLength1024 minLength1 Link to this property
pattern\_type?: "EMAIL"| "DOMAIN"| "IP"| "UNKNOWN" Type of pattern matching. - EMAIL: matches a full email address (e.g. user@example.com) - DOMAIN: matches a domain name (e.g. example.com) - IP: matches a plain IPv4 or IPv6 address (e.g. 1.2.3.4 or 2606:4700:4700::1111) or CIDR block (e.g. 1.2.3.0/24 or 2606:4700:4700::/48). The API rejects private or unique-local, loopback, link-local, unspecified, and IPv4 broadcast addresses, including their IPv4-mapped IPv6 equivalents. - UNKNOWN: deprecated; you cannot use this when creating or updating policies, but it may appear on existing entries. One of the following: "EMAIL" Link to this property "DOMAIN" Link to this property "IP" Link to this property "UNKNOWN" Link to this property
Link to this property
[Link to this property](<#(resource)%20email_security.settings.block_senders%20%3E%20(model)%20block_sender_edit_response%20%3E%20(schema)>)
BlockSenderDeleteResponse {id } id: string Blocked sender pattern identifier. formatuuid Link to this property
[Link to this property](<#(resource)%20email_security.settings.block_senders%20%3E%20(model)%20block_sender_delete_response%20%3E%20(schema)>)
BlockSenderBatchResponse {deletes, patches, posts, puts }
deletes?: Array<Delete> id: string Blocked sender pattern identifier. formatuuid Link to this property
Link to this property
patches?: Array<Patch> id?: string Blocked sender pattern identifier. formatuuid Link to this property comments?: string| null maxLength1024 Link to this property created\_at?: string formatdate-time Link to this property is\_regex?: boolean Whether pattern is a regular expression instead of a literal value. Link to this property Deprecatedlast\_modified?: string Use modified_at instead. Deprecated, use modified_at instead. End of life: November 1, 2026. formatdate-time Link to this property modified\_at?: string formatdate-time Link to this property pattern?: string The pattern value to match. The format depends on pattern_type: a valid email address for EMAIL (e.g. user@example.com), a valid domain name for DOMAIN (e.g. example.com), or a plain IPv4 or IPv6 address or CIDR block for IP (e.g. 1.2.3.4, 1.2.3.0/24, 2606:4700:4700::1111, or 2606:4700:4700::/48); the API rejects private or unique-local, loopback, link-local, unspecified, and IPv4 broadcast addresses, including their IPv4-mapped IPv6 equivalents. maxLength1024 minLength1 Link to this property
pattern\_type?: "EMAIL"| "DOMAIN"| "IP"| "UNKNOWN" Type of pattern matching. - EMAIL: matches a full email address (e.g. user@example.com) - DOMAIN: matches a domain name (e.g. example.com) - IP: matches a plain IPv4 or IPv6 address (e.g. 1.2.3.4 or 2606:4700:4700::1111) or CIDR block (e.g. 1.2.3.0/24 or 2606:4700:4700::/48). The API rejects private or unique-local, loopback, link-local, unspecified, and IPv4 broadcast addresses, including their IPv4-mapped IPv6 equivalents. - UNKNOWN: deprecated; you cannot use this when creating or updating policies, but it may appear on existing entries. One of the following: "EMAIL" Link to this property "DOMAIN" Link to this property "IP" Link to this property "UNKNOWN" Link to this property
Link to this property
Link to this property
posts?: Array<Post> id?: string Blocked sender pattern identifier. formatuuid Link to this property comments?: string| null maxLength1024 Link to this property created\_at?: string formatdate-time Link to this property is\_regex?: boolean Whether pattern is a regular expression instead of a literal value. Link to this property Deprecatedlast\_modified?: string Use modified_at instead. Deprecated, use modified_at instead. End of life: November 1, 2026. formatdate-time Link to this property modified\_at?: string formatdate-time Link to this property pattern?: string The pattern value to match. The format depends on pattern_type: a valid email address for EMAIL (e.g. user@example.com), a valid domain name for DOMAIN (e.g. example.com), or a plain IPv4 or IPv6 address or CIDR block for IP (e.g. 1.2.3.4, 1.2.3.0/24, 2606:4700:4700::1111, or 2606:4700:4700::/48); the API rejects private or unique-local, loopback, link-local, unspecified, and IPv4 broadcast addresses, including their IPv4-mapped IPv6 equivalents. maxLength1024 minLength1 Link to this property
pattern\_type?: "EMAIL"| "DOMAIN"| "IP"| "UNKNOWN" Type of pattern matching. - EMAIL: matches a full email address (e.g. user@example.com) - DOMAIN: matches a domain name (e.g. example.com) - IP: matches a plain IPv4 or IPv6 address (e.g. 1.2.3.4 or 2606:4700:4700::1111) or CIDR block (e.g. 1.2.3.0/24 or 2606:4700:4700::/48). The API rejects private or unique-local, loopback, link-local, unspecified, and IPv4 broadcast addresses, including their IPv4-mapped IPv6 equivalents. - UNKNOWN: deprecated; you cannot use this when creating or updating policies, but it may appear on existing entries. One of the following: "EMAIL" Link to this property "DOMAIN" Link to this property "IP" Link to this property "UNKNOWN" Link to this property
Link to this property
Link to this property
puts?: Array<Put> id?: string Blocked sender pattern identifier. formatuuid Link to this property comments?: string| null maxLength1024 Link to this property created\_at?: string formatdate-time Link to this property is\_regex?: boolean Whether pattern is a regular expression instead of a literal value. Link to this property Deprecatedlast\_modified?: string Use modified_at instead. Deprecated, use modified_at instead. End of life: November 1, 2026. formatdate-time Link to this property modified\_at?: string formatdate-time Link to this property pattern?: string The pattern value to match. The format depends on pattern_type: a valid email address for EMAIL (e.g. user@example.com), a valid domain name for DOMAIN (e.g. example.com), or a plain IPv4 or IPv6 address or CIDR block for IP (e.g. 1.2.3.4, 1.2.3.0/24, 2606:4700:4700::1111, or 2606:4700:4700::/48); the API rejects private or unique-local, loopback, link-local, unspecified, and IPv4 broadcast addresses, including their IPv4-mapped IPv6 equivalents. maxLength1024 minLength1 Link to this property
pattern\_type?: "EMAIL"| "DOMAIN"| "IP"| "UNKNOWN" Type of pattern matching. - EMAIL: matches a full email address (e.g. user@example.com) - DOMAIN: matches a domain name (e.g. example.com) - IP: matches a plain IPv4 or IPv6 address (e.g. 1.2.3.4 or 2606:4700:4700::1111) or CIDR block (e.g. 1.2.3.0/24 or 2606:4700:4700::/48). The API rejects private or unique-local, loopback, link-local, unspecified, and IPv4 broadcast addresses, including their IPv4-mapped IPv6 equivalents. - UNKNOWN: deprecated; you cannot use this when creating or updating policies, but it may appear on existing entries. One of the following: "EMAIL" Link to this property "DOMAIN" Link to this property "IP" Link to this property "UNKNOWN" Link to this property
Link to this property
Link to this property
[Link to this property](<#(resource)%20email_security.settings.block_senders%20%3E%20(model)%20block_sender_batch_response%20%3E%20(schema)>) #### SettingsContent Policies ##### [List content policies](https://developers.cloudflare.com/api/typescript/resources/email_security/subresources/settings/subresources/content_policies/methods/list) client.emailSecurity.settings.contentPolicies.list(ContentPolicyListParams {account\_id, direction, enabled, 5 more } params, RequestOptionsoptions?): V4PagePaginationArray< [ContentPolicyListResponse]() {id, created\_at, enabled, 5 more } > GET/accounts/{account\_id}/email-security/settings/content\_policies ##### [Get a content policy](https://developers.cloudflare.com/api/typescript/resources/email_security/subresources/settings/subresources/content_policies/methods/get) client.emailSecurity.settings.contentPolicies.get(stringpolicyID, ContentPolicyGetParams {account\_id } params, RequestOptionsoptions?): [ContentPolicyGetResponse]() {id, created\_at, enabled, 5 more } GET/accounts/{account\_id}/email-security/settings/content\_policies/{policy\_id} ##### [Create a content policy](https://developers.cloudflare.com/api/typescript/resources/email_security/subresources/settings/subresources/content_policies/methods/create) client.emailSecurity.settings.contentPolicies.create(ContentPolicyCreateParams {account\_id, enabled, name, 3 more } params, RequestOptionsoptions?): [ContentPolicyCreateResponse]() {id, created\_at, enabled, 5 more } POST/accounts/{account\_id}/email-security/settings/content\_policies ##### [Update a content policy](https://developers.cloudflare.com/api/typescript/resources/email_security/subresources/settings/subresources/content_policies/methods/edit) client.emailSecurity.settings.contentPolicies.edit(stringpolicyID, ContentPolicyEditParams {account\_id, enabled, name, 3 more } params, RequestOptionsoptions?): [ContentPolicyEditResponse]() {id, created\_at, enabled, 5 more } PATCH/accounts/{account\_id}/email-security/settings/content\_policies/{policy\_id} ##### [Delete a content policy](https://developers.cloudflare.com/api/typescript/resources/email_security/subresources/settings/subresources/content_policies/methods/delete) client.emailSecurity.settings.contentPolicies.delete(stringpolicyID, ContentPolicyDeleteParams {account\_id } params, RequestOptionsoptions?): [ContentPolicyDeleteResponse]() {id } DELETE/accounts/{account\_id}/email-security/settings/content\_policies/{policy\_id} ##### [Batch content policy operations](https://developers.cloudflare.com/api/typescript/resources/email_security/subresources/settings/subresources/content_policies/methods/batch) client.emailSecurity.settings.contentPolicies.batch(ContentPolicyBatchParams {account\_id, deletes, patches, 2 more } params, RequestOptionsoptions?): [ContentPolicyBatchResponse]() {deletes, patches, posts, puts } POST/accounts/{account\_id}/email-security/settings/content\_policies/batch ##### ModelsExpand Collapse
ContentPolicyListResponse {id, created\_at, enabled, 5 more } A content policy pattern that matches against the subject or body of an email. id?: string Content policy identifier. formatuuid Link to this property created\_at?: string formatdate-time Link to this property enabled?: boolean Whether the policy is active. Link to this property modified\_at?: string formatdate-time Link to this property name?: string Human-readable name of the policy. maxLength256 minLength1 Link to this property notes?: string| null Optional note describing the purpose of the policy. maxLength4096 Link to this property pattern?: string Regular expression the policy matches against. maxLength2048 minLength1 Link to this property
targets?: Array<"SUBJECT"| "BODY"> Parts of the email the pattern is matched against. One of the following: "SUBJECT" Link to this property "BODY" Link to this property
Link to this property
[Link to this property](<#(resource)%20email_security.settings.content_policies%20%3E%20(model)%20content_policy_list_response%20%3E%20(schema)>)
ContentPolicyGetResponse {id, created\_at, enabled, 5 more } A content policy pattern that matches against the subject or body of an email. id?: string Content policy identifier. formatuuid Link to this property created\_at?: string formatdate-time Link to this property enabled?: boolean Whether the policy is active. Link to this property modified\_at?: string formatdate-time Link to this property name?: string Human-readable name of the policy. maxLength256 minLength1 Link to this property notes?: string| null Optional note describing the purpose of the policy. maxLength4096 Link to this property pattern?: string Regular expression the policy matches against. maxLength2048 minLength1 Link to this property
targets?: Array<"SUBJECT"| "BODY"> Parts of the email the pattern is matched against. One of the following: "SUBJECT" Link to this property "BODY" Link to this property
Link to this property
[Link to this property](<#(resource)%20email_security.settings.content_policies%20%3E%20(model)%20content_policy_get_response%20%3E%20(schema)>)
ContentPolicyCreateResponse {id, created\_at, enabled, 5 more } A content policy pattern that matches against the subject or body of an email. id?: string Content policy identifier. formatuuid Link to this property created\_at?: string formatdate-time Link to this property enabled?: boolean Whether the policy is active. Link to this property modified\_at?: string formatdate-time Link to this property name?: string Human-readable name of the policy. maxLength256 minLength1 Link to this property notes?: string| null Optional note describing the purpose of the policy. maxLength4096 Link to this property pattern?: string Regular expression the policy matches against. maxLength2048 minLength1 Link to this property
targets?: Array<"SUBJECT"| "BODY"> Parts of the email the pattern is matched against. One of the following: "SUBJECT" Link to this property "BODY" Link to this property
Link to this property
[Link to this property](<#(resource)%20email_security.settings.content_policies%20%3E%20(model)%20content_policy_create_response%20%3E%20(schema)>)
ContentPolicyEditResponse {id, created\_at, enabled, 5 more } A content policy pattern that matches against the subject or body of an email. id?: string Content policy identifier. formatuuid Link to this property created\_at?: string formatdate-time Link to this property enabled?: boolean Whether the policy is active. Link to this property modified\_at?: string formatdate-time Link to this property name?: string Human-readable name of the policy. maxLength256 minLength1 Link to this property notes?: string| null Optional note describing the purpose of the policy. maxLength4096 Link to this property pattern?: string Regular expression the policy matches against. maxLength2048 minLength1 Link to this property
targets?: Array<"SUBJECT"| "BODY"> Parts of the email the pattern is matched against. One of the following: "SUBJECT" Link to this property "BODY" Link to this property
Link to this property
[Link to this property](<#(resource)%20email_security.settings.content_policies%20%3E%20(model)%20content_policy_edit_response%20%3E%20(schema)>)
ContentPolicyDeleteResponse {id } id: string Content policy identifier. formatuuid Link to this property
[Link to this property](<#(resource)%20email_security.settings.content_policies%20%3E%20(model)%20content_policy_delete_response%20%3E%20(schema)>)
ContentPolicyBatchResponse {deletes, patches, posts, puts }
deletes?: Array<Delete> id: string Content policy identifier. formatuuid Link to this property
Link to this property
patches?: Array<Patch> id?: string Content policy identifier. formatuuid Link to this property created\_at?: string formatdate-time Link to this property enabled?: boolean Whether the policy is active. Link to this property modified\_at?: string formatdate-time Link to this property name?: string Human-readable name of the policy. maxLength256 minLength1 Link to this property notes?: string| null Optional note describing the purpose of the policy. maxLength4096 Link to this property pattern?: string Regular expression the policy matches against. maxLength2048 minLength1 Link to this property
targets?: Array<"SUBJECT"| "BODY"> Parts of the email the pattern is matched against. One of the following: "SUBJECT" Link to this property "BODY" Link to this property
Link to this property
Link to this property
posts?: Array<Post> id?: string Content policy identifier. formatuuid Link to this property created\_at?: string formatdate-time Link to this property enabled?: boolean Whether the policy is active. Link to this property modified\_at?: string formatdate-time Link to this property name?: string Human-readable name of the policy. maxLength256 minLength1 Link to this property notes?: string| null Optional note describing the purpose of the policy. maxLength4096 Link to this property pattern?: string Regular expression the policy matches against. maxLength2048 minLength1 Link to this property
targets?: Array<"SUBJECT"| "BODY"> Parts of the email the pattern is matched against. One of the following: "SUBJECT" Link to this property "BODY" Link to this property
Link to this property
Link to this property
puts?: Array<Put> id?: string Content policy identifier. formatuuid Link to this property created\_at?: string formatdate-time Link to this property enabled?: boolean Whether the policy is active. Link to this property modified\_at?: string formatdate-time Link to this property name?: string Human-readable name of the policy. maxLength256 minLength1 Link to this property notes?: string| null Optional note describing the purpose of the policy. maxLength4096 Link to this property pattern?: string Regular expression the policy matches against. maxLength2048 minLength1 Link to this property
targets?: Array<"SUBJECT"| "BODY"> Parts of the email the pattern is matched against. One of the following: "SUBJECT" Link to this property "BODY" Link to this property
Link to this property
Link to this property
[Link to this property](<#(resource)%20email_security.settings.content_policies%20%3E%20(model)%20content_policy_batch_response%20%3E%20(schema)>) #### SettingsDomains ##### [List protected email domains](https://developers.cloudflare.com/api/typescript/resources/email_security/subresources/settings/subresources/domains/methods/list) client.emailSecurity.settings.domains.list(DomainListParams {account\_id, active\_delivery\_mode, allowed\_delivery\_mode, 8 more } params, RequestOptionsoptions?): V4PagePaginationArray< [DomainListResponse]() {id, allowed\_delivery\_modes, authorization, 19 more } > GET/accounts/{account\_id}/email-security/settings/domains ##### [Get an email domain](https://developers.cloudflare.com/api/typescript/resources/email_security/subresources/settings/subresources/domains/methods/get) client.emailSecurity.settings.domains.get(stringdomainID, DomainGetParams {account\_id } params, RequestOptionsoptions?): [DomainGetResponse]() {id, allowed\_delivery\_modes, authorization, 19 more } GET/accounts/{account\_id}/email-security/settings/domains/{domain\_id} ##### [Replace an email domain](https://developers.cloudflare.com/api/typescript/resources/email_security/subresources/settings/subresources/domains/methods/update) client.emailSecurity.settings.domains.update(stringdomainID, DomainUpdateParams {account\_id, allowed\_delivery\_modes, drop\_dispositions, 8 more } params, RequestOptionsoptions?): [DomainUpdateResponse]() {id, allowed\_delivery\_modes, authorization, 19 more } PUT/accounts/{account\_id}/email-security/settings/domains/{domain\_id} ##### [Update an email domain](https://developers.cloudflare.com/api/typescript/resources/email_security/subresources/settings/subresources/domains/methods/edit) client.emailSecurity.settings.domains.edit(stringdomainID, DomainEditParams {account\_id, allowed\_delivery\_modes, drop\_dispositions, 8 more } params, RequestOptionsoptions?): [DomainEditResponse]() {id, allowed\_delivery\_modes, authorization, 19 more } PATCH/accounts/{account\_id}/email-security/settings/domains/{domain\_id} ##### [Add a new email domain](https://developers.cloudflare.com/api/typescript/resources/email_security/subresources/settings/subresources/domains/methods/create) client.emailSecurity.settings.domains.create(DomainCreateParams {account\_id, allowed\_delivery\_modes, domain, 9 more } params, RequestOptionsoptions?): [DomainCreateResponse]() {id, allowed\_delivery\_modes, authorization, 19 more } POST/accounts/{account\_id}/email-security/settings/domains ##### [Unprotect an email domain](https://developers.cloudflare.com/api/typescript/resources/email_security/subresources/settings/subresources/domains/methods/delete) client.emailSecurity.settings.domains.delete(stringdomainID, DomainDeleteParams {account\_id } params, RequestOptionsoptions?): [DomainDeleteResponse]() {id } DELETE/accounts/{account\_id}/email-security/settings/domains/{domain\_id} ##### [Batch domain operations](https://developers.cloudflare.com/api/typescript/resources/email_security/subresources/settings/subresources/domains/methods/batch) client.emailSecurity.settings.domains.batch(DomainBatchParams {account\_id, deletes, patches, 2 more } params, RequestOptionsoptions?): [DomainBatchResponse]() {deletes, patches, posts, puts } POST/accounts/{account\_id}/email-security/settings/domains/batch ##### [Unprotect multiple email domains](https://developers.cloudflare.com/api/typescript/resources/email_security/subresources/settings/subresources/domains/methods/bulk_delete) Deprecated client.emailSecurity.settings.domains.bulkDelete(DomainBulkDeleteParams {account\_id } params, RequestOptionsoptions?): SinglePage< [DomainBulkDeleteResponse]() {id } > DELETE/accounts/{account\_id}/email-security/settings/domains ##### ModelsExpand Collapse
DomainListResponse {id, allowed\_delivery\_modes, authorization, 19 more } id?: string Domain identifier. formatuuid Link to this property
allowed\_delivery\_modes?: Array<"DIRECT"| "BCC"| "JOURNAL"| 2 more> One of the following: "DIRECT" Link to this property "BCC" Link to this property "JOURNAL" Link to this property "API" Link to this property "RETRO\_SCAN" Link to this property
Link to this property
authorization?: Authorization| null authorized: boolean Link to this property timestamp: string formatdate-time Link to this property status\_message?: string| null Link to this property
Link to this property created\_at?: string formatdate-time Link to this property
dmarc\_status?: "none"| "good"| "invalid"| null One of the following: "none" Link to this property "good" Link to this property "invalid" Link to this property
Link to this property domain?: string Link to this property
drop\_dispositions?: Array<"MALICIOUS"| "MALICIOUS-BEC"| "SUSPICIOUS"| 7 more> One of the following: "MALICIOUS" Link to this property "MALICIOUS-BEC" Link to this property "SUSPICIOUS" Link to this property "SPOOF" Link to this property "SPAM" Link to this property "BULK" Link to this property "ENCRYPTED" Link to this property "EXTERNAL" Link to this property "UNKNOWN" Link to this property "NONE" Link to this property
Link to this property
emails\_processed?: EmailsProcessed| null timestamp: string formatdate-time Link to this property total\_emails\_processed: number minimum0 Link to this property total\_emails\_processed\_previous: number minimum0 Link to this property
Link to this property
folder?: "AllItems"| "Inbox"| null The mailbox folder to scan, for API-scanning domains. One of the following: "AllItems" Link to this property "Inbox" Link to this property
Link to this property
inbox\_provider?: "Microsoft"| "Google"| null One of the following: "Microsoft" Link to this property "Google" Link to this property
Link to this property integration\_id?: string| null formatuuid Link to this property ip\_restrictions?: Array<string> Link to this property Deprecatedlast\_modified?: string Use modified_at instead. Deprecated, use modified_at instead. End of life: November 1, 2026. formatdate-time Link to this property lookback\_hops?: number Link to this property modified\_at?: string formatdate-time Link to this property o365\_tenant\_id?: string| null Link to this property
regions?: Array<"GLOBAL"| "AU"| "DE"| 2 more> One of the following: "GLOBAL" Link to this property "AU" Link to this property "DE" Link to this property "IN" Link to this property "US" Link to this property
Link to this property require\_tls\_inbound?: boolean| null Link to this property require\_tls\_outbound?: boolean| null Link to this property
spf\_status?: "none"| "good"| "neutral"| 2 more| null One of the following: "none" Link to this property "good" Link to this property "neutral" Link to this property "open" Link to this property "invalid" Link to this property
Link to this property
status?: "PENDING"| "ACTIVE"| "FAILED"| "TIMEOUT"| null One of the following: "PENDING" Link to this property "ACTIVE" Link to this property "FAILED" Link to this property "TIMEOUT" Link to this property
Link to this property transport?: string Link to this property
[Link to this property](<#(resource)%20email_security.settings.domains%20%3E%20(model)%20domain_list_response%20%3E%20(schema)>)
DomainGetResponse {id, allowed\_delivery\_modes, authorization, 19 more } id?: string Domain identifier. formatuuid Link to this property
allowed\_delivery\_modes?: Array<"DIRECT"| "BCC"| "JOURNAL"| 2 more> One of the following: "DIRECT" Link to this property "BCC" Link to this property "JOURNAL" Link to this property "API" Link to this property "RETRO\_SCAN" Link to this property
Link to this property
authorization?: Authorization| null authorized: boolean Link to this property timestamp: string formatdate-time Link to this property status\_message?: string| null Link to this property
Link to this property created\_at?: string formatdate-time Link to this property
dmarc\_status?: "none"| "good"| "invalid"| null One of the following: "none" Link to this property "good" Link to this property "invalid" Link to this property
Link to this property domain?: string Link to this property
drop\_dispositions?: Array<"MALICIOUS"| "MALICIOUS-BEC"| "SUSPICIOUS"| 7 more> One of the following: "MALICIOUS" Link to this property "MALICIOUS-BEC" Link to this property "SUSPICIOUS" Link to this property "SPOOF" Link to this property "SPAM" Link to this property "BULK" Link to this property "ENCRYPTED" Link to this property "EXTERNAL" Link to this property "UNKNOWN" Link to this property "NONE" Link to this property
Link to this property
emails\_processed?: EmailsProcessed| null timestamp: string formatdate-time Link to this property total\_emails\_processed: number minimum0 Link to this property total\_emails\_processed\_previous: number minimum0 Link to this property
Link to this property
folder?: "AllItems"| "Inbox"| null The mailbox folder to scan, for API-scanning domains. One of the following: "AllItems" Link to this property "Inbox" Link to this property
Link to this property
inbox\_provider?: "Microsoft"| "Google"| null One of the following: "Microsoft" Link to this property "Google" Link to this property
Link to this property integration\_id?: string| null formatuuid Link to this property ip\_restrictions?: Array<string> Link to this property Deprecatedlast\_modified?: string Use modified_at instead. Deprecated, use modified_at instead. End of life: November 1, 2026. formatdate-time Link to this property lookback\_hops?: number Link to this property modified\_at?: string formatdate-time Link to this property o365\_tenant\_id?: string| null Link to this property
regions?: Array<"GLOBAL"| "AU"| "DE"| 2 more> One of the following: "GLOBAL" Link to this property "AU" Link to this property "DE" Link to this property "IN" Link to this property "US" Link to this property
Link to this property require\_tls\_inbound?: boolean| null Link to this property require\_tls\_outbound?: boolean| null Link to this property
spf\_status?: "none"| "good"| "neutral"| 2 more| null One of the following: "none" Link to this property "good" Link to this property "neutral" Link to this property "open" Link to this property "invalid" Link to this property
Link to this property
status?: "PENDING"| "ACTIVE"| "FAILED"| "TIMEOUT"| null One of the following: "PENDING" Link to this property "ACTIVE" Link to this property "FAILED" Link to this property "TIMEOUT" Link to this property
Link to this property transport?: string Link to this property
[Link to this property](<#(resource)%20email_security.settings.domains%20%3E%20(model)%20domain_get_response%20%3E%20(schema)>)
DomainUpdateResponse {id, allowed\_delivery\_modes, authorization, 19 more } id?: string Domain identifier. formatuuid Link to this property
allowed\_delivery\_modes?: Array<"DIRECT"| "BCC"| "JOURNAL"| 2 more> One of the following: "DIRECT" Link to this property "BCC" Link to this property "JOURNAL" Link to this property "API" Link to this property "RETRO\_SCAN" Link to this property
Link to this property
authorization?: Authorization| null authorized: boolean Link to this property timestamp: string formatdate-time Link to this property status\_message?: string| null Link to this property
Link to this property created\_at?: string formatdate-time Link to this property
dmarc\_status?: "none"| "good"| "invalid"| null One of the following: "none" Link to this property "good" Link to this property "invalid" Link to this property
Link to this property domain?: string Link to this property
drop\_dispositions?: Array<"MALICIOUS"| "MALICIOUS-BEC"| "SUSPICIOUS"| 7 more> One of the following: "MALICIOUS" Link to this property "MALICIOUS-BEC" Link to this property "SUSPICIOUS" Link to this property "SPOOF" Link to this property "SPAM" Link to this property "BULK" Link to this property "ENCRYPTED" Link to this property "EXTERNAL" Link to this property "UNKNOWN" Link to this property "NONE" Link to this property
Link to this property
emails\_processed?: EmailsProcessed| null timestamp: string formatdate-time Link to this property total\_emails\_processed: number minimum0 Link to this property total\_emails\_processed\_previous: number minimum0 Link to this property
Link to this property
folder?: "AllItems"| "Inbox"| null The mailbox folder to scan, for API-scanning domains. One of the following: "AllItems" Link to this property "Inbox" Link to this property
Link to this property
inbox\_provider?: "Microsoft"| "Google"| null One of the following: "Microsoft" Link to this property "Google" Link to this property
Link to this property integration\_id?: string| null formatuuid Link to this property ip\_restrictions?: Array<string> Link to this property Deprecatedlast\_modified?: string Use modified_at instead. Deprecated, use modified_at instead. End of life: November 1, 2026. formatdate-time Link to this property lookback\_hops?: number Link to this property modified\_at?: string formatdate-time Link to this property o365\_tenant\_id?: string| null Link to this property
regions?: Array<"GLOBAL"| "AU"| "DE"| 2 more> One of the following: "GLOBAL" Link to this property "AU" Link to this property "DE" Link to this property "IN" Link to this property "US" Link to this property
Link to this property require\_tls\_inbound?: boolean| null Link to this property require\_tls\_outbound?: boolean| null Link to this property
spf\_status?: "none"| "good"| "neutral"| 2 more| null One of the following: "none" Link to this property "good" Link to this property "neutral" Link to this property "open" Link to this property "invalid" Link to this property
Link to this property
status?: "PENDING"| "ACTIVE"| "FAILED"| "TIMEOUT"| null One of the following: "PENDING" Link to this property "ACTIVE" Link to this property "FAILED" Link to this property "TIMEOUT" Link to this property
Link to this property transport?: string Link to this property
[Link to this property](<#(resource)%20email_security.settings.domains%20%3E%20(model)%20domain_update_response%20%3E%20(schema)>)
DomainEditResponse {id, allowed\_delivery\_modes, authorization, 19 more } id?: string Domain identifier. formatuuid Link to this property
allowed\_delivery\_modes?: Array<"DIRECT"| "BCC"| "JOURNAL"| 2 more> One of the following: "DIRECT" Link to this property "BCC" Link to this property "JOURNAL" Link to this property "API" Link to this property "RETRO\_SCAN" Link to this property
Link to this property
authorization?: Authorization| null authorized: boolean Link to this property timestamp: string formatdate-time Link to this property status\_message?: string| null Link to this property
Link to this property created\_at?: string formatdate-time Link to this property
dmarc\_status?: "none"| "good"| "invalid"| null One of the following: "none" Link to this property "good" Link to this property "invalid" Link to this property
Link to this property domain?: string Link to this property
drop\_dispositions?: Array<"MALICIOUS"| "MALICIOUS-BEC"| "SUSPICIOUS"| 7 more> One of the following: "MALICIOUS" Link to this property "MALICIOUS-BEC" Link to this property "SUSPICIOUS" Link to this property "SPOOF" Link to this property "SPAM" Link to this property "BULK" Link to this property "ENCRYPTED" Link to this property "EXTERNAL" Link to this property "UNKNOWN" Link to this property "NONE" Link to this property
Link to this property
emails\_processed?: EmailsProcessed| null timestamp: string formatdate-time Link to this property total\_emails\_processed: number minimum0 Link to this property total\_emails\_processed\_previous: number minimum0 Link to this property
Link to this property
folder?: "AllItems"| "Inbox"| null The mailbox folder to scan, for API-scanning domains. One of the following: "AllItems" Link to this property "Inbox" Link to this property
Link to this property
inbox\_provider?: "Microsoft"| "Google"| null One of the following: "Microsoft" Link to this property "Google" Link to this property
Link to this property integration\_id?: string| null formatuuid Link to this property ip\_restrictions?: Array<string> Link to this property Deprecatedlast\_modified?: string Use modified_at instead. Deprecated, use modified_at instead. End of life: November 1, 2026. formatdate-time Link to this property lookback\_hops?: number Link to this property modified\_at?: string formatdate-time Link to this property o365\_tenant\_id?: string| null Link to this property
regions?: Array<"GLOBAL"| "AU"| "DE"| 2 more> One of the following: "GLOBAL" Link to this property "AU" Link to this property "DE" Link to this property "IN" Link to this property "US" Link to this property
Link to this property require\_tls\_inbound?: boolean| null Link to this property require\_tls\_outbound?: boolean| null Link to this property
spf\_status?: "none"| "good"| "neutral"| 2 more| null One of the following: "none" Link to this property "good" Link to this property "neutral" Link to this property "open" Link to this property "invalid" Link to this property
Link to this property
status?: "PENDING"| "ACTIVE"| "FAILED"| "TIMEOUT"| null One of the following: "PENDING" Link to this property "ACTIVE" Link to this property "FAILED" Link to this property "TIMEOUT" Link to this property
Link to this property transport?: string Link to this property
[Link to this property](<#(resource)%20email_security.settings.domains%20%3E%20(model)%20domain_edit_response%20%3E%20(schema)>)
DomainCreateResponse {id, allowed\_delivery\_modes, authorization, 19 more } id?: string Domain identifier. formatuuid Link to this property
allowed\_delivery\_modes?: Array<"DIRECT"| "BCC"| "JOURNAL"| 2 more> One of the following: "DIRECT" Link to this property "BCC" Link to this property "JOURNAL" Link to this property "API" Link to this property "RETRO\_SCAN" Link to this property
Link to this property
authorization?: Authorization| null authorized: boolean Link to this property timestamp: string formatdate-time Link to this property status\_message?: string| null Link to this property
Link to this property created\_at?: string formatdate-time Link to this property
dmarc\_status?: "none"| "good"| "invalid"| null One of the following: "none" Link to this property "good" Link to this property "invalid" Link to this property
Link to this property domain?: string Link to this property
drop\_dispositions?: Array<"MALICIOUS"| "MALICIOUS-BEC"| "SUSPICIOUS"| 7 more> One of the following: "MALICIOUS" Link to this property "MALICIOUS-BEC" Link to this property "SUSPICIOUS" Link to this property "SPOOF" Link to this property "SPAM" Link to this property "BULK" Link to this property "ENCRYPTED" Link to this property "EXTERNAL" Link to this property "UNKNOWN" Link to this property "NONE" Link to this property
Link to this property
emails\_processed?: EmailsProcessed| null timestamp: string formatdate-time Link to this property total\_emails\_processed: number minimum0 Link to this property total\_emails\_processed\_previous: number minimum0 Link to this property
Link to this property
folder?: "AllItems"| "Inbox"| null The mailbox folder to scan, for API-scanning domains. One of the following: "AllItems" Link to this property "Inbox" Link to this property
Link to this property
inbox\_provider?: "Microsoft"| "Google"| null One of the following: "Microsoft" Link to this property "Google" Link to this property
Link to this property integration\_id?: string| null formatuuid Link to this property ip\_restrictions?: Array<string> Link to this property Deprecatedlast\_modified?: string Use modified_at instead. Deprecated, use modified_at instead. End of life: November 1, 2026. formatdate-time Link to this property lookback\_hops?: number Link to this property modified\_at?: string formatdate-time Link to this property o365\_tenant\_id?: string| null Link to this property
regions?: Array<"GLOBAL"| "AU"| "DE"| 2 more> One of the following: "GLOBAL" Link to this property "AU" Link to this property "DE" Link to this property "IN" Link to this property "US" Link to this property
Link to this property require\_tls\_inbound?: boolean| null Link to this property require\_tls\_outbound?: boolean| null Link to this property
spf\_status?: "none"| "good"| "neutral"| 2 more| null One of the following: "none" Link to this property "good" Link to this property "neutral" Link to this property "open" Link to this property "invalid" Link to this property
Link to this property
status?: "PENDING"| "ACTIVE"| "FAILED"| "TIMEOUT"| null One of the following: "PENDING" Link to this property "ACTIVE" Link to this property "FAILED" Link to this property "TIMEOUT" Link to this property
Link to this property transport?: string Link to this property
[Link to this property](<#(resource)%20email_security.settings.domains%20%3E%20(model)%20domain_create_response%20%3E%20(schema)>)
DomainDeleteResponse {id } id: string Domain identifier. formatuuid Link to this property
[Link to this property](<#(resource)%20email_security.settings.domains%20%3E%20(model)%20domain_delete_response%20%3E%20(schema)>)
DomainBatchResponse {deletes, patches, posts, puts }
deletes: Array<Delete> id: string Domain identifier. formatuuid Link to this property
Link to this property
patches: Array<Patch> id?: string Domain identifier. formatuuid Link to this property
allowed\_delivery\_modes?: Array<"DIRECT"| "BCC"| "JOURNAL"| 2 more> One of the following: "DIRECT" Link to this property "BCC" Link to this property "JOURNAL" Link to this property "API" Link to this property "RETRO\_SCAN" Link to this property
Link to this property
authorization?: Authorization| null authorized: boolean Link to this property timestamp: string formatdate-time Link to this property status\_message?: string| null Link to this property
Link to this property created\_at?: string formatdate-time Link to this property
dmarc\_status?: "none"| "good"| "invalid"| null One of the following: "none" Link to this property "good" Link to this property "invalid" Link to this property
Link to this property domain?: string Link to this property
drop\_dispositions?: Array<"MALICIOUS"| "MALICIOUS-BEC"| "SUSPICIOUS"| 7 more> One of the following: "MALICIOUS" Link to this property "MALICIOUS-BEC" Link to this property "SUSPICIOUS" Link to this property "SPOOF" Link to this property "SPAM" Link to this property "BULK" Link to this property "ENCRYPTED" Link to this property "EXTERNAL" Link to this property "UNKNOWN" Link to this property "NONE" Link to this property
Link to this property
emails\_processed?: EmailsProcessed| null timestamp: string formatdate-time Link to this property total\_emails\_processed: number minimum0 Link to this property total\_emails\_processed\_previous: number minimum0 Link to this property
Link to this property
folder?: "AllItems"| "Inbox"| null The mailbox folder to scan, for API-scanning domains. One of the following: "AllItems" Link to this property "Inbox" Link to this property
Link to this property
inbox\_provider?: "Microsoft"| "Google"| null One of the following: "Microsoft" Link to this property "Google" Link to this property
Link to this property integration\_id?: string| null formatuuid Link to this property ip\_restrictions?: Array<string> Link to this property Deprecatedlast\_modified?: string Use modified_at instead. Deprecated, use modified_at instead. End of life: November 1, 2026. formatdate-time Link to this property lookback\_hops?: number Link to this property modified\_at?: string formatdate-time Link to this property o365\_tenant\_id?: string| null Link to this property
regions?: Array<"GLOBAL"| "AU"| "DE"| 2 more> One of the following: "GLOBAL" Link to this property "AU" Link to this property "DE" Link to this property "IN" Link to this property "US" Link to this property
Link to this property require\_tls\_inbound?: boolean| null Link to this property require\_tls\_outbound?: boolean| null Link to this property
spf\_status?: "none"| "good"| "neutral"| 2 more| null One of the following: "none" Link to this property "good" Link to this property "neutral" Link to this property "open" Link to this property "invalid" Link to this property
Link to this property
status?: "PENDING"| "ACTIVE"| "FAILED"| "TIMEOUT"| null One of the following: "PENDING" Link to this property "ACTIVE" Link to this property "FAILED" Link to this property "TIMEOUT" Link to this property
Link to this property transport?: string Link to this property
Link to this property
posts: Array<Post> id?: string Domain identifier. formatuuid Link to this property
allowed\_delivery\_modes?: Array<"DIRECT"| "BCC"| "JOURNAL"| 2 more> One of the following: "DIRECT" Link to this property "BCC" Link to this property "JOURNAL" Link to this property "API" Link to this property "RETRO\_SCAN" Link to this property
Link to this property
authorization?: Authorization| null authorized: boolean Link to this property timestamp: string formatdate-time Link to this property status\_message?: string| null Link to this property
Link to this property created\_at?: string formatdate-time Link to this property
dmarc\_status?: "none"| "good"| "invalid"| null One of the following: "none" Link to this property "good" Link to this property "invalid" Link to this property
Link to this property domain?: string Link to this property
drop\_dispositions?: Array<"MALICIOUS"| "MALICIOUS-BEC"| "SUSPICIOUS"| 7 more> One of the following: "MALICIOUS" Link to this property "MALICIOUS-BEC" Link to this property "SUSPICIOUS" Link to this property "SPOOF" Link to this property "SPAM" Link to this property "BULK" Link to this property "ENCRYPTED" Link to this property "EXTERNAL" Link to this property "UNKNOWN" Link to this property "NONE" Link to this property
Link to this property
emails\_processed?: EmailsProcessed| null timestamp: string formatdate-time Link to this property total\_emails\_processed: number minimum0 Link to this property total\_emails\_processed\_previous: number minimum0 Link to this property
Link to this property
folder?: "AllItems"| "Inbox"| null The mailbox folder to scan, for API-scanning domains. One of the following: "AllItems" Link to this property "Inbox" Link to this property
Link to this property
inbox\_provider?: "Microsoft"| "Google"| null One of the following: "Microsoft" Link to this property "Google" Link to this property
Link to this property integration\_id?: string| null formatuuid Link to this property ip\_restrictions?: Array<string> Link to this property Deprecatedlast\_modified?: string Use modified_at instead. Deprecated, use modified_at instead. End of life: November 1, 2026. formatdate-time Link to this property lookback\_hops?: number Link to this property modified\_at?: string formatdate-time Link to this property o365\_tenant\_id?: string| null Link to this property
regions?: Array<"GLOBAL"| "AU"| "DE"| 2 more> One of the following: "GLOBAL" Link to this property "AU" Link to this property "DE" Link to this property "IN" Link to this property "US" Link to this property
Link to this property require\_tls\_inbound?: boolean| null Link to this property require\_tls\_outbound?: boolean| null Link to this property
spf\_status?: "none"| "good"| "neutral"| 2 more| null One of the following: "none" Link to this property "good" Link to this property "neutral" Link to this property "open" Link to this property "invalid" Link to this property
Link to this property
status?: "PENDING"| "ACTIVE"| "FAILED"| "TIMEOUT"| null One of the following: "PENDING" Link to this property "ACTIVE" Link to this property "FAILED" Link to this property "TIMEOUT" Link to this property
Link to this property transport?: string Link to this property
Link to this property
puts: Array<Put> id?: string Domain identifier. formatuuid Link to this property
allowed\_delivery\_modes?: Array<"DIRECT"| "BCC"| "JOURNAL"| 2 more> One of the following: "DIRECT" Link to this property "BCC" Link to this property "JOURNAL" Link to this property "API" Link to this property "RETRO\_SCAN" Link to this property
Link to this property
authorization?: Authorization| null authorized: boolean Link to this property timestamp: string formatdate-time Link to this property status\_message?: string| null Link to this property
Link to this property created\_at?: string formatdate-time Link to this property
dmarc\_status?: "none"| "good"| "invalid"| null One of the following: "none" Link to this property "good" Link to this property "invalid" Link to this property
Link to this property domain?: string Link to this property
drop\_dispositions?: Array<"MALICIOUS"| "MALICIOUS-BEC"| "SUSPICIOUS"| 7 more> One of the following: "MALICIOUS" Link to this property "MALICIOUS-BEC" Link to this property "SUSPICIOUS" Link to this property "SPOOF" Link to this property "SPAM" Link to this property "BULK" Link to this property "ENCRYPTED" Link to this property "EXTERNAL" Link to this property "UNKNOWN" Link to this property "NONE" Link to this property
Link to this property
emails\_processed?: EmailsProcessed| null timestamp: string formatdate-time Link to this property total\_emails\_processed: number minimum0 Link to this property total\_emails\_processed\_previous: number minimum0 Link to this property
Link to this property
folder?: "AllItems"| "Inbox"| null The mailbox folder to scan, for API-scanning domains. One of the following: "AllItems" Link to this property "Inbox" Link to this property
Link to this property
inbox\_provider?: "Microsoft"| "Google"| null One of the following: "Microsoft" Link to this property "Google" Link to this property
Link to this property integration\_id?: string| null formatuuid Link to this property ip\_restrictions?: Array<string> Link to this property Deprecatedlast\_modified?: string Use modified_at instead. Deprecated, use modified_at instead. End of life: November 1, 2026. formatdate-time Link to this property lookback\_hops?: number Link to this property modified\_at?: string formatdate-time Link to this property o365\_tenant\_id?: string| null Link to this property
regions?: Array<"GLOBAL"| "AU"| "DE"| 2 more> One of the following: "GLOBAL" Link to this property "AU" Link to this property "DE" Link to this property "IN" Link to this property "US" Link to this property
Link to this property require\_tls\_inbound?: boolean| null Link to this property require\_tls\_outbound?: boolean| null Link to this property
spf\_status?: "none"| "good"| "neutral"| 2 more| null One of the following: "none" Link to this property "good" Link to this property "neutral" Link to this property "open" Link to this property "invalid" Link to this property
Link to this property
status?: "PENDING"| "ACTIVE"| "FAILED"| "TIMEOUT"| null One of the following: "PENDING" Link to this property "ACTIVE" Link to this property "FAILED" Link to this property "TIMEOUT" Link to this property
Link to this property transport?: string Link to this property
Link to this property
[Link to this property](<#(resource)%20email_security.settings.domains%20%3E%20(model)%20domain_batch_response%20%3E%20(schema)>)
DomainBulkDeleteResponse {id } id: string Domain identifier. formatuuid Link to this property
[Link to this property](<#(resource)%20email_security.settings.domains%20%3E%20(model)%20domain_bulk_delete_response%20%3E%20(schema)>) #### SettingsImpersonation Registry ##### [List impersonation registry entries](https://developers.cloudflare.com/api/typescript/resources/email_security/subresources/settings/subresources/impersonation_registry/methods/list) client.emailSecurity.settings.impersonationRegistry.list(ImpersonationRegistryListParams {account\_id, direction, order, 4 more } params, RequestOptionsoptions?): V4PagePaginationArray< [ImpersonationRegistryListResponse]() {id, comments, created\_at, 9 more } > GET/accounts/{account\_id}/email-security/settings/impersonation\_registry ##### [Get an impersonation registry entry](https://developers.cloudflare.com/api/typescript/resources/email_security/subresources/settings/subresources/impersonation_registry/methods/get) client.emailSecurity.settings.impersonationRegistry.get(stringimpersonationRegistryID, ImpersonationRegistryGetParams {account\_id } params, RequestOptionsoptions?): [ImpersonationRegistryGetResponse]() {id, comments, created\_at, 9 more } GET/accounts/{account\_id}/email-security/settings/impersonation\_registry/{impersonation\_registry\_id} ##### [Create impersonation registry entry](https://developers.cloudflare.com/api/typescript/resources/email_security/subresources/settings/subresources/impersonation_registry/methods/create) client.emailSecurity.settings.impersonationRegistry.create(ImpersonationRegistryCreateParams {account\_id, email, is\_email\_regex, 6 more } params, RequestOptionsoptions?): [ImpersonationRegistryCreateResponse]() {id, comments, created\_at, 9 more } POST/accounts/{account\_id}/email-security/settings/impersonation\_registry ##### [Update an impersonation registry entry](https://developers.cloudflare.com/api/typescript/resources/email_security/subresources/settings/subresources/impersonation_registry/methods/edit) client.emailSecurity.settings.impersonationRegistry.edit(stringimpersonationRegistryID, ImpersonationRegistryEditParams {account\_id, comments, directory\_id, 6 more } params, RequestOptionsoptions?): [ImpersonationRegistryEditResponse]() {id, comments, created\_at, 9 more } PATCH/accounts/{account\_id}/email-security/settings/impersonation\_registry/{impersonation\_registry\_id} ##### [Delete an impersonation registry entry](https://developers.cloudflare.com/api/typescript/resources/email_security/subresources/settings/subresources/impersonation_registry/methods/delete) client.emailSecurity.settings.impersonationRegistry.delete(stringimpersonationRegistryID, ImpersonationRegistryDeleteParams {account\_id } params, RequestOptionsoptions?): [ImpersonationRegistryDeleteResponse]() {id } DELETE/accounts/{account\_id}/email-security/settings/impersonation\_registry/{impersonation\_registry\_id} ##### ModelsExpand Collapse
ImpersonationRegistryListResponse {id, comments, created\_at, 9 more } An impersonation registry entry. id?: string Impersonation registry entry identifier. formatuuid Link to this property comments?: string| null Optional note describing the entry. Link to this property created\_at?: string formatdate-time Link to this property directory\_id?: number| null Identifier of the directory the entry was synced from, when directory-synced. Link to this property directory\_node\_id?: number| null Identifier of the directory node the entry was synced from, when directory-synced. Link to this property email?: string Email address (or pattern) of the protected identity. Link to this property Deprecatedexternal\_directory\_node\_id?: string| null This field is deprecated. Deprecated. External identifier of the directory node. Link to this property is\_email\_regex?: boolean Whether email is a regular expression instead of a literal address. Link to this property Deprecatedlast\_modified?: string Use modified_at instead. Deprecated, use modified_at instead. End of life: November 1, 2026. formatdate-time Link to this property modified\_at?: string formatdate-time Link to this property name?: string Display name of the protected identity. maxLength1024 Link to this property
provenance?: "A1S\_INTERNAL"| "SNOOPY-CASB\_OFFICE\_365"| "SNOOPY-OFFICE\_365"| "SNOOPY-GOOGLE\_DIRECTORY"| null Source the entry was created from. One of the following: "A1S\_INTERNAL" Link to this property "SNOOPY-CASB\_OFFICE\_365" Link to this property "SNOOPY-OFFICE\_365" Link to this property "SNOOPY-GOOGLE\_DIRECTORY" Link to this property
Link to this property
[Link to this property](<#(resource)%20email_security.settings.impersonation_registry%20%3E%20(model)%20impersonation_registry_list_response%20%3E%20(schema)>)
ImpersonationRegistryGetResponse {id, comments, created\_at, 9 more } An impersonation registry entry. id?: string Impersonation registry entry identifier. formatuuid Link to this property comments?: string| null Optional note describing the entry. Link to this property created\_at?: string formatdate-time Link to this property directory\_id?: number| null Identifier of the directory the entry was synced from, when directory-synced. Link to this property directory\_node\_id?: number| null Identifier of the directory node the entry was synced from, when directory-synced. Link to this property email?: string Email address (or pattern) of the protected identity. Link to this property Deprecatedexternal\_directory\_node\_id?: string| null This field is deprecated. Deprecated. External identifier of the directory node. Link to this property is\_email\_regex?: boolean Whether email is a regular expression instead of a literal address. Link to this property Deprecatedlast\_modified?: string Use modified_at instead. Deprecated, use modified_at instead. End of life: November 1, 2026. formatdate-time Link to this property modified\_at?: string formatdate-time Link to this property name?: string Display name of the protected identity. maxLength1024 Link to this property
provenance?: "A1S\_INTERNAL"| "SNOOPY-CASB\_OFFICE\_365"| "SNOOPY-OFFICE\_365"| "SNOOPY-GOOGLE\_DIRECTORY"| null Source the entry was created from. One of the following: "A1S\_INTERNAL" Link to this property "SNOOPY-CASB\_OFFICE\_365" Link to this property "SNOOPY-OFFICE\_365" Link to this property "SNOOPY-GOOGLE\_DIRECTORY" Link to this property
Link to this property
[Link to this property](<#(resource)%20email_security.settings.impersonation_registry%20%3E%20(model)%20impersonation_registry_get_response%20%3E%20(schema)>)
ImpersonationRegistryCreateResponse {id, comments, created\_at, 9 more } An impersonation registry entry. id?: string Impersonation registry entry identifier. formatuuid Link to this property comments?: string| null Optional note describing the entry. Link to this property created\_at?: string formatdate-time Link to this property directory\_id?: number| null Identifier of the directory the entry was synced from, when directory-synced. Link to this property directory\_node\_id?: number| null Identifier of the directory node the entry was synced from, when directory-synced. Link to this property email?: string Email address (or pattern) of the protected identity. Link to this property Deprecatedexternal\_directory\_node\_id?: string| null This field is deprecated. Deprecated. External identifier of the directory node. Link to this property is\_email\_regex?: boolean Whether email is a regular expression instead of a literal address. Link to this property Deprecatedlast\_modified?: string Use modified_at instead. Deprecated, use modified_at instead. End of life: November 1, 2026. formatdate-time Link to this property modified\_at?: string formatdate-time Link to this property name?: string Display name of the protected identity. maxLength1024 Link to this property
provenance?: "A1S\_INTERNAL"| "SNOOPY-CASB\_OFFICE\_365"| "SNOOPY-OFFICE\_365"| "SNOOPY-GOOGLE\_DIRECTORY"| null Source the entry was created from. One of the following: "A1S\_INTERNAL" Link to this property "SNOOPY-CASB\_OFFICE\_365" Link to this property "SNOOPY-OFFICE\_365" Link to this property "SNOOPY-GOOGLE\_DIRECTORY" Link to this property
Link to this property
[Link to this property](<#(resource)%20email_security.settings.impersonation_registry%20%3E%20(model)%20impersonation_registry_create_response%20%3E%20(schema)>)
ImpersonationRegistryEditResponse {id, comments, created\_at, 9 more } An impersonation registry entry. id?: string Impersonation registry entry identifier. formatuuid Link to this property comments?: string| null Optional note describing the entry. Link to this property created\_at?: string formatdate-time Link to this property directory\_id?: number| null Identifier of the directory the entry was synced from, when directory-synced. Link to this property directory\_node\_id?: number| null Identifier of the directory node the entry was synced from, when directory-synced. Link to this property email?: string Email address (or pattern) of the protected identity. Link to this property Deprecatedexternal\_directory\_node\_id?: string| null This field is deprecated. Deprecated. External identifier of the directory node. Link to this property is\_email\_regex?: boolean Whether email is a regular expression instead of a literal address. Link to this property Deprecatedlast\_modified?: string Use modified_at instead. Deprecated, use modified_at instead. End of life: November 1, 2026. formatdate-time Link to this property modified\_at?: string formatdate-time Link to this property name?: string Display name of the protected identity. maxLength1024 Link to this property
provenance?: "A1S\_INTERNAL"| "SNOOPY-CASB\_OFFICE\_365"| "SNOOPY-OFFICE\_365"| "SNOOPY-GOOGLE\_DIRECTORY"| null Source the entry was created from. One of the following: "A1S\_INTERNAL" Link to this property "SNOOPY-CASB\_OFFICE\_365" Link to this property "SNOOPY-OFFICE\_365" Link to this property "SNOOPY-GOOGLE\_DIRECTORY" Link to this property
Link to this property
[Link to this property](<#(resource)%20email_security.settings.impersonation_registry%20%3E%20(model)%20impersonation_registry_edit_response%20%3E%20(schema)>)
ImpersonationRegistryDeleteResponse {id } id: string Impersonation registry entry identifier. formatuuid Link to this property
[Link to this property](<#(resource)%20email_security.settings.impersonation_registry%20%3E%20(model)%20impersonation_registry_delete_response%20%3E%20(schema)>) #### SettingsSending Domain Restrictions ##### [List sending domain restrictions](https://developers.cloudflare.com/api/typescript/resources/email_security/subresources/settings/subresources/sending_domain_restrictions/methods/list) client.emailSecurity.settings.sendingDomainRestrictions.list(SendingDomainRestrictionListParams {account\_id, direction, order, 3 more } params, RequestOptionsoptions?): V4PagePaginationArray< [SendingDomainRestrictionListResponse]() {id, comments, created\_at, 4 more } > GET/accounts/{account\_id}/email-security/settings/sending\_domain\_restrictions ##### [Get a sending domain restriction](https://developers.cloudflare.com/api/typescript/resources/email_security/subresources/settings/subresources/sending_domain_restrictions/methods/get) client.emailSecurity.settings.sendingDomainRestrictions.get(stringsendingDomainRestrictionID, SendingDomainRestrictionGetParams {account\_id } params, RequestOptionsoptions?): [SendingDomainRestrictionGetResponse]() {id, comments, created\_at, 4 more } GET/accounts/{account\_id}/email-security/settings/sending\_domain\_restrictions/{sending\_domain\_restriction\_id} ##### [Create a sending domain restriction](https://developers.cloudflare.com/api/typescript/resources/email_security/subresources/settings/subresources/sending_domain_restrictions/methods/create) client.emailSecurity.settings.sendingDomainRestrictions.create(SendingDomainRestrictionCreateParams {account\_id, domain, exclude, comments } params, RequestOptionsoptions?): [SendingDomainRestrictionCreateResponse]() {id, comments, created\_at, 4 more } POST/accounts/{account\_id}/email-security/settings/sending\_domain\_restrictions ##### [Update a sending domain restriction](https://developers.cloudflare.com/api/typescript/resources/email_security/subresources/settings/subresources/sending_domain_restrictions/methods/edit) client.emailSecurity.settings.sendingDomainRestrictions.edit(stringsendingDomainRestrictionID, SendingDomainRestrictionEditParams {account\_id, comments, domain, exclude } params, RequestOptionsoptions?): [SendingDomainRestrictionEditResponse]() {id, comments, created\_at, 4 more } PATCH/accounts/{account\_id}/email-security/settings/sending\_domain\_restrictions/{sending\_domain\_restriction\_id} ##### [Delete a sending domain restriction](https://developers.cloudflare.com/api/typescript/resources/email_security/subresources/settings/subresources/sending_domain_restrictions/methods/delete) client.emailSecurity.settings.sendingDomainRestrictions.delete(stringsendingDomainRestrictionID, SendingDomainRestrictionDeleteParams {account\_id } params, RequestOptionsoptions?): [SendingDomainRestrictionDeleteResponse]() {id } DELETE/accounts/{account\_id}/email-security/settings/sending\_domain\_restrictions/{sending\_domain\_restriction\_id} ##### ModelsExpand Collapse
SendingDomainRestrictionListResponse {id, comments, created\_at, 4 more } A sending domain restriction that enforces TLS (Transport Layer Security) requirements for emails from specific domains. If TLS is required, the system drops mail without TLS from the specified domain. id?: string Sending domain restriction identifier. formatuuid Link to this property comments?: string| null maxLength1024 Link to this property created\_at?: string formatdate-time Link to this property domain?: string Domain that requires TLS enforcement. Link to this property exclude?: Array<string> Subdomains to exempt from TLS requirements. Link to this property Deprecatedlast\_modified?: string Use modified_at instead. Deprecated, use modified_at instead. End of life: November 1, 2026. formatdate-time Link to this property modified\_at?: string formatdate-time Link to this property
[Link to this property](<#(resource)%20email_security.settings.sending_domain_restrictions%20%3E%20(model)%20sending_domain_restriction_list_response%20%3E%20(schema)>)
SendingDomainRestrictionGetResponse {id, comments, created\_at, 4 more } A sending domain restriction that enforces TLS (Transport Layer Security) requirements for emails from specific domains. If TLS is required, the system drops mail without TLS from the specified domain. id?: string Sending domain restriction identifier. formatuuid Link to this property comments?: string| null maxLength1024 Link to this property created\_at?: string formatdate-time Link to this property domain?: string Domain that requires TLS enforcement. Link to this property exclude?: Array<string> Subdomains to exempt from TLS requirements. Link to this property Deprecatedlast\_modified?: string Use modified_at instead. Deprecated, use modified_at instead. End of life: November 1, 2026. formatdate-time Link to this property modified\_at?: string formatdate-time Link to this property
[Link to this property](<#(resource)%20email_security.settings.sending_domain_restrictions%20%3E%20(model)%20sending_domain_restriction_get_response%20%3E%20(schema)>)
SendingDomainRestrictionCreateResponse {id, comments, created\_at, 4 more } A sending domain restriction that enforces TLS (Transport Layer Security) requirements for emails from specific domains. If TLS is required, the system drops mail without TLS from the specified domain. id?: string Sending domain restriction identifier. formatuuid Link to this property comments?: string| null maxLength1024 Link to this property created\_at?: string formatdate-time Link to this property domain?: string Domain that requires TLS enforcement. Link to this property exclude?: Array<string> Subdomains to exempt from TLS requirements. Link to this property Deprecatedlast\_modified?: string Use modified_at instead. Deprecated, use modified_at instead. End of life: November 1, 2026. formatdate-time Link to this property modified\_at?: string formatdate-time Link to this property
[Link to this property](<#(resource)%20email_security.settings.sending_domain_restrictions%20%3E%20(model)%20sending_domain_restriction_create_response%20%3E%20(schema)>)
SendingDomainRestrictionEditResponse {id, comments, created\_at, 4 more } A sending domain restriction that enforces TLS (Transport Layer Security) requirements for emails from specific domains. If TLS is required, the system drops mail without TLS from the specified domain. id?: string Sending domain restriction identifier. formatuuid Link to this property comments?: string| null maxLength1024 Link to this property created\_at?: string formatdate-time Link to this property domain?: string Domain that requires TLS enforcement. Link to this property exclude?: Array<string> Subdomains to exempt from TLS requirements. Link to this property Deprecatedlast\_modified?: string Use modified_at instead. Deprecated, use modified_at instead. End of life: November 1, 2026. formatdate-time Link to this property modified\_at?: string formatdate-time Link to this property
[Link to this property](<#(resource)%20email_security.settings.sending_domain_restrictions%20%3E%20(model)%20sending_domain_restriction_edit_response%20%3E%20(schema)>)
SendingDomainRestrictionDeleteResponse {id } id: string Sending domain restriction identifier. formatuuid Link to this property
[Link to this property](<#(resource)%20email_security.settings.sending_domain_restrictions%20%3E%20(model)%20sending_domain_restriction_delete_response%20%3E%20(schema)>) #### SettingsTrusted Domains ##### [List trusted email domains](https://developers.cloudflare.com/api/typescript/resources/email_security/subresources/settings/subresources/trusted_domains/methods/list) client.emailSecurity.settings.trustedDomains.list(TrustedDomainListParams {account\_id, direction, is\_recent, 6 more } params, RequestOptionsoptions?): V4PagePaginationArray< [TrustedDomainListResponse]() {id, comments, created\_at, 6 more } > GET/accounts/{account\_id}/email-security/settings/trusted\_domains ##### [Get a trusted email domain](https://developers.cloudflare.com/api/typescript/resources/email_security/subresources/settings/subresources/trusted_domains/methods/get) client.emailSecurity.settings.trustedDomains.get(stringtrustedDomainID, TrustedDomainGetParams {account\_id } params, RequestOptionsoptions?): [TrustedDomainGetResponse]() {id, comments, created\_at, 6 more } GET/accounts/{account\_id}/email-security/settings/trusted\_domains/{trusted\_domain\_id} ##### [Create trusted email domain](https://developers.cloudflare.com/api/typescript/resources/email_security/subresources/settings/subresources/trusted_domains/methods/create) client.emailSecurity.settings.trustedDomains.create(TrustedDomainCreateParams {account\_id, is\_recent, is\_regex, 3 more } params, RequestOptionsoptions?): [TrustedDomainCreateResponse]() {id, comments, created\_at, 6 more } POST/accounts/{account\_id}/email-security/settings/trusted\_domains ##### [Update a trusted email domain](https://developers.cloudflare.com/api/typescript/resources/email_security/subresources/settings/subresources/trusted_domains/methods/edit) client.emailSecurity.settings.trustedDomains.edit(stringtrustedDomainID, TrustedDomainEditParams {account\_id, comments, is\_recent, 3 more } params, RequestOptionsoptions?): [TrustedDomainEditResponse]() {id, comments, created\_at, 6 more } PATCH/accounts/{account\_id}/email-security/settings/trusted\_domains/{trusted\_domain\_id} ##### [Delete a trusted email domain](https://developers.cloudflare.com/api/typescript/resources/email_security/subresources/settings/subresources/trusted_domains/methods/delete) client.emailSecurity.settings.trustedDomains.delete(stringtrustedDomainID, TrustedDomainDeleteParams {account\_id } params, RequestOptionsoptions?): [TrustedDomainDeleteResponse]() {id } DELETE/accounts/{account\_id}/email-security/settings/trusted\_domains/{trusted\_domain\_id} ##### [Batch trusted domain operations](https://developers.cloudflare.com/api/typescript/resources/email_security/subresources/settings/subresources/trusted_domains/methods/batch) client.emailSecurity.settings.trustedDomains.batch(TrustedDomainBatchParams {account\_id, deletes, patches, 2 more } params, RequestOptionsoptions?): [TrustedDomainBatchResponse]() {deletes, patches, posts, puts } POST/accounts/{account\_id}/email-security/settings/trusted\_domains/batch ##### ModelsExpand Collapse
TrustedDomainListResponse {id, comments, created\_at, 6 more } A trusted email domain. id?: string Trusted domain identifier. formatuuid Link to this property comments?: string| null maxLength1024 Link to this property created\_at?: string formatdate-time Link to this property is\_recent?: boolean Select to prevent recently registered domains from triggering a Suspicious or Malicious disposition. Link to this property is\_regex?: boolean Whether pattern is a regular expression instead of a literal domain. Link to this property is\_similarity?: boolean Select for partner or other approved domains that have similar spelling to your connected domains. Prevents listed domains from triggering a Spoof disposition. Link to this property Deprecatedlast\_modified?: string Use modified_at instead. Deprecated, use modified_at instead. End of life: November 1, 2026. formatdate-time Link to this property modified\_at?: string formatdate-time Link to this property pattern?: string The domain pattern to trust, e.g. example.com. maxLength1024 minLength1 Link to this property
[Link to this property](<#(resource)%20email_security.settings.trusted_domains%20%3E%20(model)%20trusted_domain_list_response%20%3E%20(schema)>)
TrustedDomainGetResponse {id, comments, created\_at, 6 more } A trusted email domain. id?: string Trusted domain identifier. formatuuid Link to this property comments?: string| null maxLength1024 Link to this property created\_at?: string formatdate-time Link to this property is\_recent?: boolean Select to prevent recently registered domains from triggering a Suspicious or Malicious disposition. Link to this property is\_regex?: boolean Whether pattern is a regular expression instead of a literal domain. Link to this property is\_similarity?: boolean Select for partner or other approved domains that have similar spelling to your connected domains. Prevents listed domains from triggering a Spoof disposition. Link to this property Deprecatedlast\_modified?: string Use modified_at instead. Deprecated, use modified_at instead. End of life: November 1, 2026. formatdate-time Link to this property modified\_at?: string formatdate-time Link to this property pattern?: string The domain pattern to trust, e.g. example.com. maxLength1024 minLength1 Link to this property
[Link to this property](<#(resource)%20email_security.settings.trusted_domains%20%3E%20(model)%20trusted_domain_get_response%20%3E%20(schema)>)
TrustedDomainCreateResponse {id, comments, created\_at, 6 more } A trusted email domain. id?: string Trusted domain identifier. formatuuid Link to this property comments?: string| null maxLength1024 Link to this property created\_at?: string formatdate-time Link to this property is\_recent?: boolean Select to prevent recently registered domains from triggering a Suspicious or Malicious disposition. Link to this property is\_regex?: boolean Whether pattern is a regular expression instead of a literal domain. Link to this property is\_similarity?: boolean Select for partner or other approved domains that have similar spelling to your connected domains. Prevents listed domains from triggering a Spoof disposition. Link to this property Deprecatedlast\_modified?: string Use modified_at instead. Deprecated, use modified_at instead. End of life: November 1, 2026. formatdate-time Link to this property modified\_at?: string formatdate-time Link to this property pattern?: string The domain pattern to trust, e.g. example.com. maxLength1024 minLength1 Link to this property
[Link to this property](<#(resource)%20email_security.settings.trusted_domains%20%3E%20(model)%20trusted_domain_create_response%20%3E%20(schema)>)
TrustedDomainEditResponse {id, comments, created\_at, 6 more } A trusted email domain. id?: string Trusted domain identifier. formatuuid Link to this property comments?: string| null maxLength1024 Link to this property created\_at?: string formatdate-time Link to this property is\_recent?: boolean Select to prevent recently registered domains from triggering a Suspicious or Malicious disposition. Link to this property is\_regex?: boolean Whether pattern is a regular expression instead of a literal domain. Link to this property is\_similarity?: boolean Select for partner or other approved domains that have similar spelling to your connected domains. Prevents listed domains from triggering a Spoof disposition. Link to this property Deprecatedlast\_modified?: string Use modified_at instead. Deprecated, use modified_at instead. End of life: November 1, 2026. formatdate-time Link to this property modified\_at?: string formatdate-time Link to this property pattern?: string The domain pattern to trust, e.g. example.com. maxLength1024 minLength1 Link to this property
[Link to this property](<#(resource)%20email_security.settings.trusted_domains%20%3E%20(model)%20trusted_domain_edit_response%20%3E%20(schema)>)
TrustedDomainDeleteResponse {id } id: string Trusted domain identifier. formatuuid Link to this property
[Link to this property](<#(resource)%20email_security.settings.trusted_domains%20%3E%20(model)%20trusted_domain_delete_response%20%3E%20(schema)>)
TrustedDomainBatchResponse {deletes, patches, posts, puts }
deletes?: Array<Delete> id: string Trusted domain identifier. formatuuid Link to this property
Link to this property
patches?: Array<Patch> id?: string Trusted domain identifier. formatuuid Link to this property comments?: string| null maxLength1024 Link to this property created\_at?: string formatdate-time Link to this property is\_recent?: boolean Select to prevent recently registered domains from triggering a Suspicious or Malicious disposition. Link to this property is\_regex?: boolean Whether pattern is a regular expression instead of a literal domain. Link to this property is\_similarity?: boolean Select for partner or other approved domains that have similar spelling to your connected domains. Prevents listed domains from triggering a Spoof disposition. Link to this property Deprecatedlast\_modified?: string Use modified_at instead. Deprecated, use modified_at instead. End of life: November 1, 2026. formatdate-time Link to this property modified\_at?: string formatdate-time Link to this property pattern?: string The domain pattern to trust, e.g. example.com. maxLength1024 minLength1 Link to this property
Link to this property
posts?: Array<Post> id?: string Trusted domain identifier. formatuuid Link to this property comments?: string| null maxLength1024 Link to this property created\_at?: string formatdate-time Link to this property is\_recent?: boolean Select to prevent recently registered domains from triggering a Suspicious or Malicious disposition. Link to this property is\_regex?: boolean Whether pattern is a regular expression instead of a literal domain. Link to this property is\_similarity?: boolean Select for partner or other approved domains that have similar spelling to your connected domains. Prevents listed domains from triggering a Spoof disposition. Link to this property Deprecatedlast\_modified?: string Use modified_at instead. Deprecated, use modified_at instead. End of life: November 1, 2026. formatdate-time Link to this property modified\_at?: string formatdate-time Link to this property pattern?: string The domain pattern to trust, e.g. example.com. maxLength1024 minLength1 Link to this property
Link to this property
puts?: Array<Put> id?: string Trusted domain identifier. formatuuid Link to this property comments?: string| null maxLength1024 Link to this property created\_at?: string formatdate-time Link to this property is\_recent?: boolean Select to prevent recently registered domains from triggering a Suspicious or Malicious disposition. Link to this property is\_regex?: boolean Whether pattern is a regular expression instead of a literal domain. Link to this property is\_similarity?: boolean Select for partner or other approved domains that have similar spelling to your connected domains. Prevents listed domains from triggering a Spoof disposition. Link to this property Deprecatedlast\_modified?: string Use modified_at instead. Deprecated, use modified_at instead. End of life: November 1, 2026. formatdate-time Link to this property modified\_at?: string formatdate-time Link to this property pattern?: string The domain pattern to trust, e.g. example.com. maxLength1024 minLength1 Link to this property
Link to this property
[Link to this property](<#(resource)%20email_security.settings.trusted_domains%20%3E%20(model)%20trusted_domain_batch_response%20%3E%20(schema)>) #### SettingsURL Ignore Patterns ##### [List URL ignore patterns](https://developers.cloudflare.com/api/typescript/resources/email_security/subresources/settings/subresources/url_ignore_patterns/methods/list) client.emailSecurity.settings.urlIgnorePatterns.list(URLIgnorePatternListParams {account\_id, page, per\_page } params, RequestOptionsoptions?): V4PagePaginationArray< [URLIgnorePatternListResponse]() {id, created\_at, pattern, 3 more } > GET/accounts/{account\_id}/email-security/settings/url\_ignore\_patterns ##### [Get a URL ignore pattern](https://developers.cloudflare.com/api/typescript/resources/email_security/subresources/settings/subresources/url_ignore_patterns/methods/get) client.emailSecurity.settings.urlIgnorePatterns.get(stringpatternID, URLIgnorePatternGetParams {account\_id } params, RequestOptionsoptions?): [URLIgnorePatternGetResponse]() {id, created\_at, pattern, 3 more } GET/accounts/{account\_id}/email-security/settings/url\_ignore\_patterns/{pattern\_id} ##### [Create a URL ignore pattern](https://developers.cloudflare.com/api/typescript/resources/email_security/subresources/settings/subresources/url_ignore_patterns/methods/create) client.emailSecurity.settings.urlIgnorePatterns.create(URLIgnorePatternCreateParams {account\_id, pattern, comments } params, RequestOptionsoptions?): [URLIgnorePatternCreateResponse]() {id, created\_at, pattern, 3 more } POST/accounts/{account\_id}/email-security/settings/url\_ignore\_patterns ##### [Update a URL ignore pattern](https://developers.cloudflare.com/api/typescript/resources/email_security/subresources/settings/subresources/url_ignore_patterns/methods/edit) client.emailSecurity.settings.urlIgnorePatterns.edit(stringpatternID, URLIgnorePatternEditParams {account\_id, comments, pattern } params, RequestOptionsoptions?): [URLIgnorePatternEditResponse]() {id, created\_at, pattern, 3 more } PATCH/accounts/{account\_id}/email-security/settings/url\_ignore\_patterns/{pattern\_id} ##### [Delete a URL ignore pattern](https://developers.cloudflare.com/api/typescript/resources/email_security/subresources/settings/subresources/url_ignore_patterns/methods/delete) client.emailSecurity.settings.urlIgnorePatterns.delete(stringpatternID, URLIgnorePatternDeleteParams {account\_id } params, RequestOptionsoptions?): [URLIgnorePatternDeleteResponse]() {id } DELETE/accounts/{account\_id}/email-security/settings/url\_ignore\_patterns/{pattern\_id} ##### ModelsExpand Collapse
URLIgnorePatternListResponse {id, created\_at, pattern, 3 more } A URL ignore pattern that exempts matching URLs from Email Security’s URL rewriting. id: string URL ignore pattern identifier. formatuuid Link to this property created\_at: string formatdate-time Link to this property pattern: string Regular expression identifying URLs to exempt from rewriting. maxLength1024 minLength1 Link to this property comments?: string| null Optional note describing the reason for the ignore pattern. maxLength1024 Link to this property Deprecatedlast\_modified?: string Use modified_at instead. Deprecated, use modified_at instead. End of life: November 1, 2026. formatdate-time Link to this property modified\_at?: string formatdate-time Link to this property
[Link to this property](<#(resource)%20email_security.settings.url_ignore_patterns%20%3E%20(model)%20url_ignore_pattern_list_response%20%3E%20(schema)>)
URLIgnorePatternGetResponse {id, created\_at, pattern, 3 more } A URL ignore pattern that exempts matching URLs from Email Security’s URL rewriting. id: string URL ignore pattern identifier. formatuuid Link to this property created\_at: string formatdate-time Link to this property pattern: string Regular expression identifying URLs to exempt from rewriting. maxLength1024 minLength1 Link to this property comments?: string| null Optional note describing the reason for the ignore pattern. maxLength1024 Link to this property Deprecatedlast\_modified?: string Use modified_at instead. Deprecated, use modified_at instead. End of life: November 1, 2026. formatdate-time Link to this property modified\_at?: string formatdate-time Link to this property
[Link to this property](<#(resource)%20email_security.settings.url_ignore_patterns%20%3E%20(model)%20url_ignore_pattern_get_response%20%3E%20(schema)>)
URLIgnorePatternCreateResponse {id, created\_at, pattern, 3 more } A URL ignore pattern that exempts matching URLs from Email Security’s URL rewriting. id: string URL ignore pattern identifier. formatuuid Link to this property created\_at: string formatdate-time Link to this property pattern: string Regular expression identifying URLs to exempt from rewriting. maxLength1024 minLength1 Link to this property comments?: string| null Optional note describing the reason for the ignore pattern. maxLength1024 Link to this property Deprecatedlast\_modified?: string Use modified_at instead. Deprecated, use modified_at instead. End of life: November 1, 2026. formatdate-time Link to this property modified\_at?: string formatdate-time Link to this property
[Link to this property](<#(resource)%20email_security.settings.url_ignore_patterns%20%3E%20(model)%20url_ignore_pattern_create_response%20%3E%20(schema)>)
URLIgnorePatternEditResponse {id, created\_at, pattern, 3 more } A URL ignore pattern that exempts matching URLs from Email Security’s URL rewriting. id: string URL ignore pattern identifier. formatuuid Link to this property created\_at: string formatdate-time Link to this property pattern: string Regular expression identifying URLs to exempt from rewriting. maxLength1024 minLength1 Link to this property comments?: string| null Optional note describing the reason for the ignore pattern. maxLength1024 Link to this property Deprecatedlast\_modified?: string Use modified_at instead. Deprecated, use modified_at instead. End of life: November 1, 2026. formatdate-time Link to this property modified\_at?: string formatdate-time Link to this property
[Link to this property](<#(resource)%20email_security.settings.url_ignore_patterns%20%3E%20(model)%20url_ignore_pattern_edit_response%20%3E%20(schema)>)
URLIgnorePatternDeleteResponse {id } id: string URL ignore pattern identifier. formatuuid Link to this property
[Link to this property](<#(resource)%20email_security.settings.url_ignore_patterns%20%3E%20(model)%20url_ignore_pattern_delete_response%20%3E%20(schema)>)