Skip to content
Cloudflare API
Start here
API Reference
Email Security

Settings

SettingsAllow Policies

List email allow policies
email_security.settings.allow_policies.list(AllowPolicyListParams**kwargs) -> SyncV4PagePaginationArray[AllowPolicyListResponse]
GET/accounts/{account_id}/email-security/settings/allow_policies
Get an email allow policy
email_security.settings.allow_policies.get(strpolicy_id, AllowPolicyGetParams**kwargs) -> AllowPolicyGetResponse
GET/accounts/{account_id}/email-security/settings/allow_policies/{policy_id}
Create email allow policy
email_security.settings.allow_policies.create(AllowPolicyCreateParams**kwargs) -> AllowPolicyCreateResponse
POST/accounts/{account_id}/email-security/settings/allow_policies
Update an email allow policy
email_security.settings.allow_policies.edit(strpolicy_id, AllowPolicyEditParams**kwargs) -> AllowPolicyEditResponse
PATCH/accounts/{account_id}/email-security/settings/allow_policies/{policy_id}
Delete an email allow policy
email_security.settings.allow_policies.delete(strpolicy_id, AllowPolicyDeleteParams**kwargs) -> AllowPolicyDeleteResponse
DELETE/accounts/{account_id}/email-security/settings/allow_policies/{policy_id}
Batch allow policy operations
email_security.settings.allow_policies.batch(AllowPolicyBatchParams**kwargs) -> AllowPolicyBatchResponse
POST/accounts/{account_id}/email-security/settings/allow_policies/batch
ModelsExpand Collapse
class AllowPolicyListResponse: …

An email allow policy.

id: str

Allow policy identifier.

formatuuid
created_at: datetime
formatdate-time
Deprecatedlast_modified: datetime

Use modified_at instead.

Deprecated, use modified_at instead. End of life: November 1, 2026.

formatdate-time
comments: Optional[str]
maxLength1024
expires_at: Optional[datetime]

Timestamp at which the policy expires. After this time, Email Security ignores the policy. The value must lie in the future. Send null to clear the expiration.

formatdate-time
is_acceptable_sender: Optional[bool]

Exempts messages from this sender from Spam, Spoof and Bulk dispositions only; Malicious and Suspicious dispositions still apply.

is_exempt_recipient: Optional[bool]

Bypasses all detections for messages to this recipient.

Deprecatedis_recipient: Optional[bool]

Use is_exempt_recipient instead.

Deprecated as of July 1, 2025. Use is_exempt_recipient instead. End of life: July 1, 2026.

is_regex: Optional[bool]
Deprecatedis_sender: Optional[bool]

Use is_trusted_sender instead.

Deprecated as of July 1, 2025. Use is_trusted_sender instead. End of life: July 1, 2026.

Deprecatedis_spoof: Optional[bool]

Use is_acceptable_sender instead.

Deprecated as of July 1, 2025. Use is_acceptable_sender instead. End of life: July 1, 2026.

is_trusted_sender: Optional[bool]

Bypasses all detections and link following for messages from this sender.

modified_at: Optional[datetime]
formatdate-time
pattern: Optional[str]

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. The API also rejects a pattern that equals a domain onboarded to the account, ignoring case.

maxLength1024
minLength1
pattern_type: Optional[Literal["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"
"DOMAIN"
"IP"
"UNKNOWN"
verify_sender: Optional[bool]

Enforce DMARC, SPF or DKIM authentication. When on, Email Security only honors policies that pass authentication.

class AllowPolicyGetResponse: …

An email allow policy.

id: str

Allow policy identifier.

formatuuid
created_at: datetime
formatdate-time
Deprecatedlast_modified: datetime

Use modified_at instead.

Deprecated, use modified_at instead. End of life: November 1, 2026.

formatdate-time
comments: Optional[str]
maxLength1024
expires_at: Optional[datetime]

Timestamp at which the policy expires. After this time, Email Security ignores the policy. The value must lie in the future. Send null to clear the expiration.

formatdate-time
is_acceptable_sender: Optional[bool]

Exempts messages from this sender from Spam, Spoof and Bulk dispositions only; Malicious and Suspicious dispositions still apply.

is_exempt_recipient: Optional[bool]

Bypasses all detections for messages to this recipient.

Deprecatedis_recipient: Optional[bool]

Use is_exempt_recipient instead.

Deprecated as of July 1, 2025. Use is_exempt_recipient instead. End of life: July 1, 2026.

is_regex: Optional[bool]
Deprecatedis_sender: Optional[bool]

Use is_trusted_sender instead.

Deprecated as of July 1, 2025. Use is_trusted_sender instead. End of life: July 1, 2026.

Deprecatedis_spoof: Optional[bool]

Use is_acceptable_sender instead.

Deprecated as of July 1, 2025. Use is_acceptable_sender instead. End of life: July 1, 2026.

is_trusted_sender: Optional[bool]

Bypasses all detections and link following for messages from this sender.

modified_at: Optional[datetime]
formatdate-time
pattern: Optional[str]

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. The API also rejects a pattern that equals a domain onboarded to the account, ignoring case.

maxLength1024
minLength1
pattern_type: Optional[Literal["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"
"DOMAIN"
"IP"
"UNKNOWN"
verify_sender: Optional[bool]

Enforce DMARC, SPF or DKIM authentication. When on, Email Security only honors policies that pass authentication.

class AllowPolicyCreateResponse: …

An email allow policy.

id: str

Allow policy identifier.

formatuuid
created_at: datetime
formatdate-time
Deprecatedlast_modified: datetime

Use modified_at instead.

Deprecated, use modified_at instead. End of life: November 1, 2026.

formatdate-time
comments: Optional[str]
maxLength1024
expires_at: Optional[datetime]

Timestamp at which the policy expires. After this time, Email Security ignores the policy. The value must lie in the future. Send null to clear the expiration.

formatdate-time
is_acceptable_sender: Optional[bool]

Exempts messages from this sender from Spam, Spoof and Bulk dispositions only; Malicious and Suspicious dispositions still apply.

is_exempt_recipient: Optional[bool]

Bypasses all detections for messages to this recipient.

Deprecatedis_recipient: Optional[bool]

Use is_exempt_recipient instead.

Deprecated as of July 1, 2025. Use is_exempt_recipient instead. End of life: July 1, 2026.

is_regex: Optional[bool]
Deprecatedis_sender: Optional[bool]

Use is_trusted_sender instead.

Deprecated as of July 1, 2025. Use is_trusted_sender instead. End of life: July 1, 2026.

Deprecatedis_spoof: Optional[bool]

Use is_acceptable_sender instead.

Deprecated as of July 1, 2025. Use is_acceptable_sender instead. End of life: July 1, 2026.

is_trusted_sender: Optional[bool]

Bypasses all detections and link following for messages from this sender.

modified_at: Optional[datetime]
formatdate-time
pattern: Optional[str]

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. The API also rejects a pattern that equals a domain onboarded to the account, ignoring case.

maxLength1024
minLength1
pattern_type: Optional[Literal["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"
"DOMAIN"
"IP"
"UNKNOWN"
verify_sender: Optional[bool]

Enforce DMARC, SPF or DKIM authentication. When on, Email Security only honors policies that pass authentication.

class AllowPolicyEditResponse: …

An email allow policy.

id: str

Allow policy identifier.

formatuuid
created_at: datetime
formatdate-time
Deprecatedlast_modified: datetime

Use modified_at instead.

Deprecated, use modified_at instead. End of life: November 1, 2026.

formatdate-time
comments: Optional[str]
maxLength1024
expires_at: Optional[datetime]

Timestamp at which the policy expires. After this time, Email Security ignores the policy. The value must lie in the future. Send null to clear the expiration.

formatdate-time
is_acceptable_sender: Optional[bool]

Exempts messages from this sender from Spam, Spoof and Bulk dispositions only; Malicious and Suspicious dispositions still apply.

is_exempt_recipient: Optional[bool]

Bypasses all detections for messages to this recipient.

Deprecatedis_recipient: Optional[bool]

Use is_exempt_recipient instead.

Deprecated as of July 1, 2025. Use is_exempt_recipient instead. End of life: July 1, 2026.

is_regex: Optional[bool]
Deprecatedis_sender: Optional[bool]

Use is_trusted_sender instead.

Deprecated as of July 1, 2025. Use is_trusted_sender instead. End of life: July 1, 2026.

Deprecatedis_spoof: Optional[bool]

Use is_acceptable_sender instead.

Deprecated as of July 1, 2025. Use is_acceptable_sender instead. End of life: July 1, 2026.

is_trusted_sender: Optional[bool]

Bypasses all detections and link following for messages from this sender.

modified_at: Optional[datetime]
formatdate-time
pattern: Optional[str]

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. The API also rejects a pattern that equals a domain onboarded to the account, ignoring case.

maxLength1024
minLength1
pattern_type: Optional[Literal["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"
"DOMAIN"
"IP"
"UNKNOWN"
verify_sender: Optional[bool]

Enforce DMARC, SPF or DKIM authentication. When on, Email Security only honors policies that pass authentication.

class AllowPolicyDeleteResponse: …
id: str

Allow policy identifier.

formatuuid
class AllowPolicyBatchResponse: …
deletes: Optional[List[Delete]]
id: str

Allow policy identifier.

formatuuid
patches: Optional[List[Patch]]
id: str

Allow policy identifier.

formatuuid
created_at: datetime
formatdate-time
Deprecatedlast_modified: datetime

Use modified_at instead.

Deprecated, use modified_at instead. End of life: November 1, 2026.

formatdate-time
comments: Optional[str]
maxLength1024
expires_at: Optional[datetime]

Timestamp at which the policy expires. After this time, Email Security ignores the policy. The value must lie in the future. Send null to clear the expiration.

formatdate-time
is_acceptable_sender: Optional[bool]

Exempts messages from this sender from Spam, Spoof and Bulk dispositions only; Malicious and Suspicious dispositions still apply.

is_exempt_recipient: Optional[bool]

Bypasses all detections for messages to this recipient.

Deprecatedis_recipient: Optional[bool]

Use is_exempt_recipient instead.

Deprecated as of July 1, 2025. Use is_exempt_recipient instead. End of life: July 1, 2026.

is_regex: Optional[bool]
Deprecatedis_sender: Optional[bool]

Use is_trusted_sender instead.

Deprecated as of July 1, 2025. Use is_trusted_sender instead. End of life: July 1, 2026.

Deprecatedis_spoof: Optional[bool]

Use is_acceptable_sender instead.

Deprecated as of July 1, 2025. Use is_acceptable_sender instead. End of life: July 1, 2026.

is_trusted_sender: Optional[bool]

Bypasses all detections and link following for messages from this sender.

modified_at: Optional[datetime]
formatdate-time
pattern: Optional[str]

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. The API also rejects a pattern that equals a domain onboarded to the account, ignoring case.

maxLength1024
minLength1
pattern_type: Optional[Literal["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"
"DOMAIN"
"IP"
"UNKNOWN"
verify_sender: Optional[bool]

Enforce DMARC, SPF or DKIM authentication. When on, Email Security only honors policies that pass authentication.

posts: Optional[List[Post]]
id: str

Allow policy identifier.

formatuuid
created_at: datetime
formatdate-time
Deprecatedlast_modified: datetime

Use modified_at instead.

Deprecated, use modified_at instead. End of life: November 1, 2026.

formatdate-time
comments: Optional[str]
maxLength1024
expires_at: Optional[datetime]

Timestamp at which the policy expires. After this time, Email Security ignores the policy. The value must lie in the future. Send null to clear the expiration.

formatdate-time
is_acceptable_sender: Optional[bool]

Exempts messages from this sender from Spam, Spoof and Bulk dispositions only; Malicious and Suspicious dispositions still apply.

is_exempt_recipient: Optional[bool]

Bypasses all detections for messages to this recipient.

Deprecatedis_recipient: Optional[bool]

Use is_exempt_recipient instead.

Deprecated as of July 1, 2025. Use is_exempt_recipient instead. End of life: July 1, 2026.

is_regex: Optional[bool]
Deprecatedis_sender: Optional[bool]

Use is_trusted_sender instead.

Deprecated as of July 1, 2025. Use is_trusted_sender instead. End of life: July 1, 2026.

Deprecatedis_spoof: Optional[bool]

Use is_acceptable_sender instead.

Deprecated as of July 1, 2025. Use is_acceptable_sender instead. End of life: July 1, 2026.

is_trusted_sender: Optional[bool]

Bypasses all detections and link following for messages from this sender.

modified_at: Optional[datetime]
formatdate-time
pattern: Optional[str]

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. The API also rejects a pattern that equals a domain onboarded to the account, ignoring case.

maxLength1024
minLength1
pattern_type: Optional[Literal["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"
"DOMAIN"
"IP"
"UNKNOWN"
verify_sender: Optional[bool]

Enforce DMARC, SPF or DKIM authentication. When on, Email Security only honors policies that pass authentication.

puts: Optional[List[Put]]
id: str

Allow policy identifier.

formatuuid
created_at: datetime
formatdate-time
Deprecatedlast_modified: datetime

Use modified_at instead.

Deprecated, use modified_at instead. End of life: November 1, 2026.

formatdate-time
comments: Optional[str]
maxLength1024
expires_at: Optional[datetime]

Timestamp at which the policy expires. After this time, Email Security ignores the policy. The value must lie in the future. Send null to clear the expiration.

formatdate-time
is_acceptable_sender: Optional[bool]

Exempts messages from this sender from Spam, Spoof and Bulk dispositions only; Malicious and Suspicious dispositions still apply.

is_exempt_recipient: Optional[bool]

Bypasses all detections for messages to this recipient.

Deprecatedis_recipient: Optional[bool]

Use is_exempt_recipient instead.

Deprecated as of July 1, 2025. Use is_exempt_recipient instead. End of life: July 1, 2026.

is_regex: Optional[bool]
Deprecatedis_sender: Optional[bool]

Use is_trusted_sender instead.

Deprecated as of July 1, 2025. Use is_trusted_sender instead. End of life: July 1, 2026.

Deprecatedis_spoof: Optional[bool]

Use is_acceptable_sender instead.

Deprecated as of July 1, 2025. Use is_acceptable_sender instead. End of life: July 1, 2026.

is_trusted_sender: Optional[bool]

Bypasses all detections and link following for messages from this sender.

modified_at: Optional[datetime]
formatdate-time
pattern: Optional[str]

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. The API also rejects a pattern that equals a domain onboarded to the account, ignoring case.

maxLength1024
minLength1
pattern_type: Optional[Literal["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"
"DOMAIN"
"IP"
"UNKNOWN"
verify_sender: Optional[bool]

Enforce DMARC, SPF or DKIM authentication. When on, Email Security only honors policies that pass authentication.

SettingsBlock Senders

List blocked email senders
email_security.settings.block_senders.list(BlockSenderListParams**kwargs) -> SyncV4PagePaginationArray[BlockSenderListResponse]
GET/accounts/{account_id}/email-security/settings/block_senders
Get a blocked email sender
email_security.settings.block_senders.get(strpattern_id, BlockSenderGetParams**kwargs) -> BlockSenderGetResponse
GET/accounts/{account_id}/email-security/settings/block_senders/{pattern_id}
Create blocked email sender
email_security.settings.block_senders.create(BlockSenderCreateParams**kwargs) -> BlockSenderCreateResponse
POST/accounts/{account_id}/email-security/settings/block_senders
Update a blocked email sender
email_security.settings.block_senders.edit(strpattern_id, BlockSenderEditParams**kwargs) -> BlockSenderEditResponse
PATCH/accounts/{account_id}/email-security/settings/block_senders/{pattern_id}
Delete a blocked email sender
email_security.settings.block_senders.delete(strpattern_id, BlockSenderDeleteParams**kwargs) -> BlockSenderDeleteResponse
DELETE/accounts/{account_id}/email-security/settings/block_senders/{pattern_id}
Batch blocked sender operations
email_security.settings.block_senders.batch(BlockSenderBatchParams**kwargs) -> BlockSenderBatchResponse
POST/accounts/{account_id}/email-security/settings/block_senders/batch
ModelsExpand Collapse
class BlockSenderListResponse: …

A blocked sender pattern.

id: Optional[str]

Blocked sender pattern identifier.

formatuuid
comments: Optional[str]
maxLength1024
created_at: Optional[datetime]
formatdate-time
expires_at: Optional[datetime]

Timestamp at which the pattern expires. After this time, Email Security ignores the pattern. The value must lie in the future. Send null to clear the expiration.

formatdate-time
is_regex: Optional[bool]

Whether pattern is a regular expression instead of a literal value.

Deprecatedlast_modified: Optional[datetime]

Use modified_at instead.

Deprecated, use modified_at instead. End of life: November 1, 2026.

formatdate-time
modified_at: Optional[datetime]
formatdate-time
pattern: Optional[str]

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
pattern_type: Optional[Literal["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"
"DOMAIN"
"IP"
"UNKNOWN"
class BlockSenderGetResponse: …

A blocked sender pattern.

id: Optional[str]

Blocked sender pattern identifier.

formatuuid
comments: Optional[str]
maxLength1024
created_at: Optional[datetime]
formatdate-time
expires_at: Optional[datetime]

Timestamp at which the pattern expires. After this time, Email Security ignores the pattern. The value must lie in the future. Send null to clear the expiration.

formatdate-time
is_regex: Optional[bool]

Whether pattern is a regular expression instead of a literal value.

Deprecatedlast_modified: Optional[datetime]

Use modified_at instead.

Deprecated, use modified_at instead. End of life: November 1, 2026.

formatdate-time
modified_at: Optional[datetime]
formatdate-time
pattern: Optional[str]

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
pattern_type: Optional[Literal["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"
"DOMAIN"
"IP"
"UNKNOWN"
class BlockSenderCreateResponse: …

A blocked sender pattern.

id: Optional[str]

Blocked sender pattern identifier.

formatuuid
comments: Optional[str]
maxLength1024
created_at: Optional[datetime]
formatdate-time
expires_at: Optional[datetime]

Timestamp at which the pattern expires. After this time, Email Security ignores the pattern. The value must lie in the future. Send null to clear the expiration.

formatdate-time
is_regex: Optional[bool]

Whether pattern is a regular expression instead of a literal value.

Deprecatedlast_modified: Optional[datetime]

Use modified_at instead.

Deprecated, use modified_at instead. End of life: November 1, 2026.

formatdate-time
modified_at: Optional[datetime]
formatdate-time
pattern: Optional[str]

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
pattern_type: Optional[Literal["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"
"DOMAIN"
"IP"
"UNKNOWN"
class BlockSenderEditResponse: …

A blocked sender pattern.

id: Optional[str]

Blocked sender pattern identifier.

formatuuid
comments: Optional[str]
maxLength1024
created_at: Optional[datetime]
formatdate-time
expires_at: Optional[datetime]

Timestamp at which the pattern expires. After this time, Email Security ignores the pattern. The value must lie in the future. Send null to clear the expiration.

formatdate-time
is_regex: Optional[bool]

Whether pattern is a regular expression instead of a literal value.

Deprecatedlast_modified: Optional[datetime]

Use modified_at instead.

Deprecated, use modified_at instead. End of life: November 1, 2026.

formatdate-time
modified_at: Optional[datetime]
formatdate-time
pattern: Optional[str]

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
pattern_type: Optional[Literal["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"
"DOMAIN"
"IP"
"UNKNOWN"
class BlockSenderDeleteResponse: …
id: str

Blocked sender pattern identifier.

formatuuid
class BlockSenderBatchResponse: …
deletes: Optional[List[Delete]]
id: str

Blocked sender pattern identifier.

formatuuid
patches: Optional[List[Patch]]
id: Optional[str]

Blocked sender pattern identifier.

formatuuid
comments: Optional[str]
maxLength1024
created_at: Optional[datetime]
formatdate-time
expires_at: Optional[datetime]

Timestamp at which the pattern expires. After this time, Email Security ignores the pattern. The value must lie in the future. Send null to clear the expiration.

formatdate-time
is_regex: Optional[bool]

Whether pattern is a regular expression instead of a literal value.

Deprecatedlast_modified: Optional[datetime]

Use modified_at instead.

Deprecated, use modified_at instead. End of life: November 1, 2026.

formatdate-time
modified_at: Optional[datetime]
formatdate-time
pattern: Optional[str]

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
pattern_type: Optional[Literal["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"
"DOMAIN"
"IP"
"UNKNOWN"
posts: Optional[List[Post]]
id: Optional[str]

Blocked sender pattern identifier.

formatuuid
comments: Optional[str]
maxLength1024
created_at: Optional[datetime]
formatdate-time
expires_at: Optional[datetime]

Timestamp at which the pattern expires. After this time, Email Security ignores the pattern. The value must lie in the future. Send null to clear the expiration.

formatdate-time
is_regex: Optional[bool]

Whether pattern is a regular expression instead of a literal value.

Deprecatedlast_modified: Optional[datetime]

Use modified_at instead.

Deprecated, use modified_at instead. End of life: November 1, 2026.

formatdate-time
modified_at: Optional[datetime]
formatdate-time
pattern: Optional[str]

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
pattern_type: Optional[Literal["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"
"DOMAIN"
"IP"
"UNKNOWN"
puts: Optional[List[Put]]
id: Optional[str]

Blocked sender pattern identifier.

formatuuid
comments: Optional[str]
maxLength1024
created_at: Optional[datetime]
formatdate-time
expires_at: Optional[datetime]

Timestamp at which the pattern expires. After this time, Email Security ignores the pattern. The value must lie in the future. Send null to clear the expiration.

formatdate-time
is_regex: Optional[bool]

Whether pattern is a regular expression instead of a literal value.

Deprecatedlast_modified: Optional[datetime]

Use modified_at instead.

Deprecated, use modified_at instead. End of life: November 1, 2026.

formatdate-time
modified_at: Optional[datetime]
formatdate-time
pattern: Optional[str]

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
pattern_type: Optional[Literal["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"
"DOMAIN"
"IP"
"UNKNOWN"

SettingsContent Policies

List content policies
email_security.settings.content_policies.list(ContentPolicyListParams**kwargs) -> SyncV4PagePaginationArray[ContentPolicyListResponse]
GET/accounts/{account_id}/email-security/settings/content_policies
Get a content policy
email_security.settings.content_policies.get(strpolicy_id, ContentPolicyGetParams**kwargs) -> ContentPolicyGetResponse
GET/accounts/{account_id}/email-security/settings/content_policies/{policy_id}
Create a content policy
email_security.settings.content_policies.create(ContentPolicyCreateParams**kwargs) -> ContentPolicyCreateResponse
POST/accounts/{account_id}/email-security/settings/content_policies
Update a content policy
email_security.settings.content_policies.edit(strpolicy_id, ContentPolicyEditParams**kwargs) -> ContentPolicyEditResponse
PATCH/accounts/{account_id}/email-security/settings/content_policies/{policy_id}
Delete a content policy
email_security.settings.content_policies.delete(strpolicy_id, ContentPolicyDeleteParams**kwargs) -> ContentPolicyDeleteResponse
DELETE/accounts/{account_id}/email-security/settings/content_policies/{policy_id}
Batch content policy operations
email_security.settings.content_policies.batch(ContentPolicyBatchParams**kwargs) -> ContentPolicyBatchResponse
POST/accounts/{account_id}/email-security/settings/content_policies/batch
ModelsExpand Collapse
class ContentPolicyListResponse: …

A content policy pattern that matches against the subject or body of an email.

id: Optional[str]

Content policy identifier.

formatuuid
created_at: Optional[datetime]
formatdate-time
enabled: Optional[bool]

Whether the policy is active.

expires_at: Optional[datetime]

Timestamp at which the policy expires. After this time, Email Security ignores the policy. The value must lie in the future. Send null to clear the expiration.

formatdate-time
modified_at: Optional[datetime]
formatdate-time
name: Optional[str]

Human-readable name of the policy.

maxLength256
minLength1
notes: Optional[str]

Optional note describing the purpose of the policy.

maxLength4096
pattern: Optional[str]

Regular expression the policy matches against.

maxLength2048
minLength1
targets: Optional[List[Literal["SUBJECT", "BODY"]]]

Parts of the email the pattern is matched against.

One of the following:
"SUBJECT"
"BODY"
class ContentPolicyGetResponse: …

A content policy pattern that matches against the subject or body of an email.

id: Optional[str]

Content policy identifier.

formatuuid
created_at: Optional[datetime]
formatdate-time
enabled: Optional[bool]

Whether the policy is active.

expires_at: Optional[datetime]

Timestamp at which the policy expires. After this time, Email Security ignores the policy. The value must lie in the future. Send null to clear the expiration.

formatdate-time
modified_at: Optional[datetime]
formatdate-time
name: Optional[str]

Human-readable name of the policy.

maxLength256
minLength1
notes: Optional[str]

Optional note describing the purpose of the policy.

maxLength4096
pattern: Optional[str]

Regular expression the policy matches against.

maxLength2048
minLength1
targets: Optional[List[Literal["SUBJECT", "BODY"]]]

Parts of the email the pattern is matched against.

One of the following:
"SUBJECT"
"BODY"
class ContentPolicyCreateResponse: …

A content policy pattern that matches against the subject or body of an email.

id: Optional[str]

Content policy identifier.

formatuuid
created_at: Optional[datetime]
formatdate-time
enabled: Optional[bool]

Whether the policy is active.

expires_at: Optional[datetime]

Timestamp at which the policy expires. After this time, Email Security ignores the policy. The value must lie in the future. Send null to clear the expiration.

formatdate-time
modified_at: Optional[datetime]
formatdate-time
name: Optional[str]

Human-readable name of the policy.

maxLength256
minLength1
notes: Optional[str]

Optional note describing the purpose of the policy.

maxLength4096
pattern: Optional[str]

Regular expression the policy matches against.

maxLength2048
minLength1
targets: Optional[List[Literal["SUBJECT", "BODY"]]]

Parts of the email the pattern is matched against.

One of the following:
"SUBJECT"
"BODY"
class ContentPolicyEditResponse: …

A content policy pattern that matches against the subject or body of an email.

id: Optional[str]

Content policy identifier.

formatuuid
created_at: Optional[datetime]
formatdate-time
enabled: Optional[bool]

Whether the policy is active.

expires_at: Optional[datetime]

Timestamp at which the policy expires. After this time, Email Security ignores the policy. The value must lie in the future. Send null to clear the expiration.

formatdate-time
modified_at: Optional[datetime]
formatdate-time
name: Optional[str]

Human-readable name of the policy.

maxLength256
minLength1
notes: Optional[str]

Optional note describing the purpose of the policy.

maxLength4096
pattern: Optional[str]

Regular expression the policy matches against.

maxLength2048
minLength1
targets: Optional[List[Literal["SUBJECT", "BODY"]]]

Parts of the email the pattern is matched against.

One of the following:
"SUBJECT"
"BODY"
class ContentPolicyDeleteResponse: …
id: str

Content policy identifier.

formatuuid
class ContentPolicyBatchResponse: …
deletes: Optional[List[Delete]]
id: str

Content policy identifier.

formatuuid
patches: Optional[List[Patch]]
id: Optional[str]

Content policy identifier.

formatuuid
created_at: Optional[datetime]
formatdate-time
enabled: Optional[bool]

Whether the policy is active.

expires_at: Optional[datetime]

Timestamp at which the policy expires. After this time, Email Security ignores the policy. The value must lie in the future. Send null to clear the expiration.

formatdate-time
modified_at: Optional[datetime]
formatdate-time
name: Optional[str]

Human-readable name of the policy.

maxLength256
minLength1
notes: Optional[str]

Optional note describing the purpose of the policy.

maxLength4096
pattern: Optional[str]

Regular expression the policy matches against.

maxLength2048
minLength1
targets: Optional[List[Literal["SUBJECT", "BODY"]]]

Parts of the email the pattern is matched against.

One of the following:
"SUBJECT"
"BODY"
posts: Optional[List[Post]]
id: Optional[str]

Content policy identifier.

formatuuid
created_at: Optional[datetime]
formatdate-time
enabled: Optional[bool]

Whether the policy is active.

expires_at: Optional[datetime]

Timestamp at which the policy expires. After this time, Email Security ignores the policy. The value must lie in the future. Send null to clear the expiration.

formatdate-time
modified_at: Optional[datetime]
formatdate-time
name: Optional[str]

Human-readable name of the policy.

maxLength256
minLength1
notes: Optional[str]

Optional note describing the purpose of the policy.

maxLength4096
pattern: Optional[str]

Regular expression the policy matches against.

maxLength2048
minLength1
targets: Optional[List[Literal["SUBJECT", "BODY"]]]

Parts of the email the pattern is matched against.

One of the following:
"SUBJECT"
"BODY"
puts: Optional[List[Put]]
id: Optional[str]

Content policy identifier.

formatuuid
created_at: Optional[datetime]
formatdate-time
enabled: Optional[bool]

Whether the policy is active.

expires_at: Optional[datetime]

Timestamp at which the policy expires. After this time, Email Security ignores the policy. The value must lie in the future. Send null to clear the expiration.

formatdate-time
modified_at: Optional[datetime]
formatdate-time
name: Optional[str]

Human-readable name of the policy.

maxLength256
minLength1
notes: Optional[str]

Optional note describing the purpose of the policy.

maxLength4096
pattern: Optional[str]

Regular expression the policy matches against.

maxLength2048
minLength1
targets: Optional[List[Literal["SUBJECT", "BODY"]]]

Parts of the email the pattern is matched against.

One of the following:
"SUBJECT"
"BODY"

SettingsDomains

List protected email domains
email_security.settings.domains.list(DomainListParams**kwargs) -> SyncV4PagePaginationArray[DomainListResponse]
GET/accounts/{account_id}/email-security/settings/domains
Get an email domain
email_security.settings.domains.get(strdomain_id, DomainGetParams**kwargs) -> DomainGetResponse
GET/accounts/{account_id}/email-security/settings/domains/{domain_id}
Replace an email domain
email_security.settings.domains.update(strdomain_id, DomainUpdateParams**kwargs) -> DomainUpdateResponse
PUT/accounts/{account_id}/email-security/settings/domains/{domain_id}
Update an email domain
email_security.settings.domains.edit(strdomain_id, DomainEditParams**kwargs) -> DomainEditResponse
PATCH/accounts/{account_id}/email-security/settings/domains/{domain_id}
Add a new email domain
email_security.settings.domains.create(DomainCreateParams**kwargs) -> DomainCreateResponse
POST/accounts/{account_id}/email-security/settings/domains
Unprotect an email domain
email_security.settings.domains.delete(strdomain_id, DomainDeleteParams**kwargs) -> DomainDeleteResponse
DELETE/accounts/{account_id}/email-security/settings/domains/{domain_id}
Batch domain operations
email_security.settings.domains.batch(DomainBatchParams**kwargs) -> DomainBatchResponse
POST/accounts/{account_id}/email-security/settings/domains/batch
Unprotect multiple email domains
Deprecated
email_security.settings.domains.bulk_delete(DomainBulkDeleteParams**kwargs) -> SyncSinglePage[DomainBulkDeleteResponse]
DELETE/accounts/{account_id}/email-security/settings/domains
ModelsExpand Collapse
class DomainListResponse: …
id: Optional[str]

Domain identifier.

formatuuid
allowed_delivery_modes: Optional[List[Literal["DIRECT", "BCC", "JOURNAL", 2 more]]]
One of the following:
"DIRECT"
"BCC"
"JOURNAL"
"API"
"RETRO_SCAN"
authorization: Optional[Authorization]
authorized: bool
timestamp: datetime
formatdate-time
status_message: Optional[str]
created_at: Optional[datetime]
formatdate-time
dmarc_status: Optional[Literal["none", "good", "invalid"]]
One of the following:
"none"
"good"
"invalid"
domain: Optional[str]
drop_dispositions: Optional[List[Literal["MALICIOUS", "MALICIOUS-BEC", "SUSPICIOUS", 7 more]]]
One of the following:
"MALICIOUS"
"MALICIOUS-BEC"
"SUSPICIOUS"
"SPOOF"
"SPAM"
"BULK"
"ENCRYPTED"
"EXTERNAL"
"UNKNOWN"
"NONE"
emails_processed: Optional[EmailsProcessed]
timestamp: datetime
formatdate-time
total_emails_processed: int
minimum0
total_emails_processed_previous: int
minimum0
folder: Optional[Literal["AllItems", "Inbox"]]

The mailbox folder to scan, for API-scanning domains.

One of the following:
"AllItems"
"Inbox"
inbox_provider: Optional[Literal["Microsoft", "Google"]]
One of the following:
"Microsoft"
"Google"
integration_id: Optional[str]
formatuuid
ip_restrictions: Optional[List[str]]
Deprecatedlast_modified: Optional[datetime]

Use modified_at instead.

Deprecated, use modified_at instead. End of life: November 1, 2026.

formatdate-time
lookback_hops: Optional[int]
modified_at: Optional[datetime]
formatdate-time
o365_tenant_id: Optional[str]
regions: Optional[List[Literal["GLOBAL", "AU", "DE", 2 more]]]
One of the following:
"GLOBAL"
"AU"
"DE"
"IN"
"US"
require_tls_inbound: Optional[bool]
require_tls_outbound: Optional[bool]
spf_status: Optional[Literal["none", "good", "neutral", 2 more]]
One of the following:
"none"
"good"
"neutral"
"open"
"invalid"
status: Optional[Literal["PENDING", "ACTIVE", "FAILED", "TIMEOUT"]]
One of the following:
"PENDING"
"ACTIVE"
"FAILED"
"TIMEOUT"
transport: Optional[str]
class DomainGetResponse: …
id: Optional[str]

Domain identifier.

formatuuid
allowed_delivery_modes: Optional[List[Literal["DIRECT", "BCC", "JOURNAL", 2 more]]]
One of the following:
"DIRECT"
"BCC"
"JOURNAL"
"API"
"RETRO_SCAN"
authorization: Optional[Authorization]
authorized: bool
timestamp: datetime
formatdate-time
status_message: Optional[str]
created_at: Optional[datetime]
formatdate-time
dmarc_status: Optional[Literal["none", "good", "invalid"]]
One of the following:
"none"
"good"
"invalid"
domain: Optional[str]
drop_dispositions: Optional[List[Literal["MALICIOUS", "MALICIOUS-BEC", "SUSPICIOUS", 7 more]]]
One of the following:
"MALICIOUS"
"MALICIOUS-BEC"
"SUSPICIOUS"
"SPOOF"
"SPAM"
"BULK"
"ENCRYPTED"
"EXTERNAL"
"UNKNOWN"
"NONE"
emails_processed: Optional[EmailsProcessed]
timestamp: datetime
formatdate-time
total_emails_processed: int
minimum0
total_emails_processed_previous: int
minimum0
folder: Optional[Literal["AllItems", "Inbox"]]

The mailbox folder to scan, for API-scanning domains.

One of the following:
"AllItems"
"Inbox"
inbox_provider: Optional[Literal["Microsoft", "Google"]]
One of the following:
"Microsoft"
"Google"
integration_id: Optional[str]
formatuuid
ip_restrictions: Optional[List[str]]
Deprecatedlast_modified: Optional[datetime]

Use modified_at instead.

Deprecated, use modified_at instead. End of life: November 1, 2026.

formatdate-time
lookback_hops: Optional[int]
modified_at: Optional[datetime]
formatdate-time
o365_tenant_id: Optional[str]
regions: Optional[List[Literal["GLOBAL", "AU", "DE", 2 more]]]
One of the following:
"GLOBAL"
"AU"
"DE"
"IN"
"US"
require_tls_inbound: Optional[bool]
require_tls_outbound: Optional[bool]
spf_status: Optional[Literal["none", "good", "neutral", 2 more]]
One of the following:
"none"
"good"
"neutral"
"open"
"invalid"
status: Optional[Literal["PENDING", "ACTIVE", "FAILED", "TIMEOUT"]]
One of the following:
"PENDING"
"ACTIVE"
"FAILED"
"TIMEOUT"
transport: Optional[str]
class DomainUpdateResponse: …
id: Optional[str]

Domain identifier.

formatuuid
allowed_delivery_modes: Optional[List[Literal["DIRECT", "BCC", "JOURNAL", 2 more]]]
One of the following:
"DIRECT"
"BCC"
"JOURNAL"
"API"
"RETRO_SCAN"
authorization: Optional[Authorization]
authorized: bool
timestamp: datetime
formatdate-time
status_message: Optional[str]
created_at: Optional[datetime]
formatdate-time
dmarc_status: Optional[Literal["none", "good", "invalid"]]
One of the following:
"none"
"good"
"invalid"
domain: Optional[str]
drop_dispositions: Optional[List[Literal["MALICIOUS", "MALICIOUS-BEC", "SUSPICIOUS", 7 more]]]
One of the following:
"MALICIOUS"
"MALICIOUS-BEC"
"SUSPICIOUS"
"SPOOF"
"SPAM"
"BULK"
"ENCRYPTED"
"EXTERNAL"
"UNKNOWN"
"NONE"
emails_processed: Optional[EmailsProcessed]
timestamp: datetime
formatdate-time
total_emails_processed: int
minimum0
total_emails_processed_previous: int
minimum0
folder: Optional[Literal["AllItems", "Inbox"]]

The mailbox folder to scan, for API-scanning domains.

One of the following:
"AllItems"
"Inbox"
inbox_provider: Optional[Literal["Microsoft", "Google"]]
One of the following:
"Microsoft"
"Google"
integration_id: Optional[str]
formatuuid
ip_restrictions: Optional[List[str]]
Deprecatedlast_modified: Optional[datetime]

Use modified_at instead.

Deprecated, use modified_at instead. End of life: November 1, 2026.

formatdate-time
lookback_hops: Optional[int]
modified_at: Optional[datetime]
formatdate-time
o365_tenant_id: Optional[str]
regions: Optional[List[Literal["GLOBAL", "AU", "DE", 2 more]]]
One of the following:
"GLOBAL"
"AU"
"DE"
"IN"
"US"
require_tls_inbound: Optional[bool]
require_tls_outbound: Optional[bool]
spf_status: Optional[Literal["none", "good", "neutral", 2 more]]
One of the following:
"none"
"good"
"neutral"
"open"
"invalid"
status: Optional[Literal["PENDING", "ACTIVE", "FAILED", "TIMEOUT"]]
One of the following:
"PENDING"
"ACTIVE"
"FAILED"
"TIMEOUT"
transport: Optional[str]
class DomainEditResponse: …
id: Optional[str]

Domain identifier.

formatuuid
allowed_delivery_modes: Optional[List[Literal["DIRECT", "BCC", "JOURNAL", 2 more]]]
One of the following:
"DIRECT"
"BCC"
"JOURNAL"
"API"
"RETRO_SCAN"
authorization: Optional[Authorization]
authorized: bool
timestamp: datetime
formatdate-time
status_message: Optional[str]
created_at: Optional[datetime]
formatdate-time
dmarc_status: Optional[Literal["none", "good", "invalid"]]
One of the following:
"none"
"good"
"invalid"
domain: Optional[str]
drop_dispositions: Optional[List[Literal["MALICIOUS", "MALICIOUS-BEC", "SUSPICIOUS", 7 more]]]
One of the following:
"MALICIOUS"
"MALICIOUS-BEC"
"SUSPICIOUS"
"SPOOF"
"SPAM"
"BULK"
"ENCRYPTED"
"EXTERNAL"
"UNKNOWN"
"NONE"
emails_processed: Optional[EmailsProcessed]
timestamp: datetime
formatdate-time
total_emails_processed: int
minimum0
total_emails_processed_previous: int
minimum0
folder: Optional[Literal["AllItems", "Inbox"]]

The mailbox folder to scan, for API-scanning domains.

One of the following:
"AllItems"
"Inbox"
inbox_provider: Optional[Literal["Microsoft", "Google"]]
One of the following:
"Microsoft"
"Google"
integration_id: Optional[str]
formatuuid
ip_restrictions: Optional[List[str]]
Deprecatedlast_modified: Optional[datetime]

Use modified_at instead.

Deprecated, use modified_at instead. End of life: November 1, 2026.

formatdate-time
lookback_hops: Optional[int]
modified_at: Optional[datetime]
formatdate-time
o365_tenant_id: Optional[str]
regions: Optional[List[Literal["GLOBAL", "AU", "DE", 2 more]]]
One of the following:
"GLOBAL"
"AU"
"DE"
"IN"
"US"
require_tls_inbound: Optional[bool]
require_tls_outbound: Optional[bool]
spf_status: Optional[Literal["none", "good", "neutral", 2 more]]
One of the following:
"none"
"good"
"neutral"
"open"
"invalid"
status: Optional[Literal["PENDING", "ACTIVE", "FAILED", "TIMEOUT"]]
One of the following:
"PENDING"
"ACTIVE"
"FAILED"
"TIMEOUT"
transport: Optional[str]
class DomainCreateResponse: …
id: Optional[str]

Domain identifier.

formatuuid
allowed_delivery_modes: Optional[List[Literal["DIRECT", "BCC", "JOURNAL", 2 more]]]
One of the following:
"DIRECT"
"BCC"
"JOURNAL"
"API"
"RETRO_SCAN"
authorization: Optional[Authorization]
authorized: bool
timestamp: datetime
formatdate-time
status_message: Optional[str]
created_at: Optional[datetime]
formatdate-time
dmarc_status: Optional[Literal["none", "good", "invalid"]]
One of the following:
"none"
"good"
"invalid"
domain: Optional[str]
drop_dispositions: Optional[List[Literal["MALICIOUS", "MALICIOUS-BEC", "SUSPICIOUS", 7 more]]]
One of the following:
"MALICIOUS"
"MALICIOUS-BEC"
"SUSPICIOUS"
"SPOOF"
"SPAM"
"BULK"
"ENCRYPTED"
"EXTERNAL"
"UNKNOWN"
"NONE"
emails_processed: Optional[EmailsProcessed]
timestamp: datetime
formatdate-time
total_emails_processed: int
minimum0
total_emails_processed_previous: int
minimum0
folder: Optional[Literal["AllItems", "Inbox"]]

The mailbox folder to scan, for API-scanning domains.

One of the following:
"AllItems"
"Inbox"
inbox_provider: Optional[Literal["Microsoft", "Google"]]
One of the following:
"Microsoft"
"Google"
integration_id: Optional[str]
formatuuid
ip_restrictions: Optional[List[str]]
Deprecatedlast_modified: Optional[datetime]

Use modified_at instead.

Deprecated, use modified_at instead. End of life: November 1, 2026.

formatdate-time
lookback_hops: Optional[int]
modified_at: Optional[datetime]
formatdate-time
o365_tenant_id: Optional[str]
regions: Optional[List[Literal["GLOBAL", "AU", "DE", 2 more]]]
One of the following:
"GLOBAL"
"AU"
"DE"
"IN"
"US"
require_tls_inbound: Optional[bool]
require_tls_outbound: Optional[bool]
spf_status: Optional[Literal["none", "good", "neutral", 2 more]]
One of the following:
"none"
"good"
"neutral"
"open"
"invalid"
status: Optional[Literal["PENDING", "ACTIVE", "FAILED", "TIMEOUT"]]
One of the following:
"PENDING"
"ACTIVE"
"FAILED"
"TIMEOUT"
transport: Optional[str]
class DomainDeleteResponse: …
id: str

Domain identifier.

formatuuid
class DomainBatchResponse: …
deletes: List[Delete]
id: str

Domain identifier.

formatuuid
patches: List[Patch]
id: Optional[str]

Domain identifier.

formatuuid
allowed_delivery_modes: Optional[List[Literal["DIRECT", "BCC", "JOURNAL", 2 more]]]
One of the following:
"DIRECT"
"BCC"
"JOURNAL"
"API"
"RETRO_SCAN"
authorization: Optional[PatchAuthorization]
authorized: bool
timestamp: datetime
formatdate-time
status_message: Optional[str]
created_at: Optional[datetime]
formatdate-time
dmarc_status: Optional[Literal["none", "good", "invalid"]]
One of the following:
"none"
"good"
"invalid"
domain: Optional[str]
drop_dispositions: Optional[List[Literal["MALICIOUS", "MALICIOUS-BEC", "SUSPICIOUS", 7 more]]]
One of the following:
"MALICIOUS"
"MALICIOUS-BEC"
"SUSPICIOUS"
"SPOOF"
"SPAM"
"BULK"
"ENCRYPTED"
"EXTERNAL"
"UNKNOWN"
"NONE"
emails_processed: Optional[PatchEmailsProcessed]
timestamp: datetime
formatdate-time
total_emails_processed: int
minimum0
total_emails_processed_previous: int
minimum0
folder: Optional[Literal["AllItems", "Inbox"]]

The mailbox folder to scan, for API-scanning domains.

One of the following:
"AllItems"
"Inbox"
inbox_provider: Optional[Literal["Microsoft", "Google"]]
One of the following:
"Microsoft"
"Google"
integration_id: Optional[str]
formatuuid
ip_restrictions: Optional[List[str]]
Deprecatedlast_modified: Optional[datetime]

Use modified_at instead.

Deprecated, use modified_at instead. End of life: November 1, 2026.

formatdate-time
lookback_hops: Optional[int]
modified_at: Optional[datetime]
formatdate-time
o365_tenant_id: Optional[str]
regions: Optional[List[Literal["GLOBAL", "AU", "DE", 2 more]]]
One of the following:
"GLOBAL"
"AU"
"DE"
"IN"
"US"
require_tls_inbound: Optional[bool]
require_tls_outbound: Optional[bool]
spf_status: Optional[Literal["none", "good", "neutral", 2 more]]
One of the following:
"none"
"good"
"neutral"
"open"
"invalid"
status: Optional[Literal["PENDING", "ACTIVE", "FAILED", "TIMEOUT"]]
One of the following:
"PENDING"
"ACTIVE"
"FAILED"
"TIMEOUT"
transport: Optional[str]
posts: List[Post]
id: Optional[str]

Domain identifier.

formatuuid
allowed_delivery_modes: Optional[List[Literal["DIRECT", "BCC", "JOURNAL", 2 more]]]
One of the following:
"DIRECT"
"BCC"
"JOURNAL"
"API"
"RETRO_SCAN"
authorization: Optional[PostAuthorization]
authorized: bool
timestamp: datetime
formatdate-time
status_message: Optional[str]
created_at: Optional[datetime]
formatdate-time
dmarc_status: Optional[Literal["none", "good", "invalid"]]
One of the following:
"none"
"good"
"invalid"
domain: Optional[str]
drop_dispositions: Optional[List[Literal["MALICIOUS", "MALICIOUS-BEC", "SUSPICIOUS", 7 more]]]
One of the following:
"MALICIOUS"
"MALICIOUS-BEC"
"SUSPICIOUS"
"SPOOF"
"SPAM"
"BULK"
"ENCRYPTED"
"EXTERNAL"
"UNKNOWN"
"NONE"
emails_processed: Optional[PostEmailsProcessed]
timestamp: datetime
formatdate-time
total_emails_processed: int
minimum0
total_emails_processed_previous: int
minimum0
folder: Optional[Literal["AllItems", "Inbox"]]

The mailbox folder to scan, for API-scanning domains.

One of the following:
"AllItems"
"Inbox"
inbox_provider: Optional[Literal["Microsoft", "Google"]]
One of the following:
"Microsoft"
"Google"
integration_id: Optional[str]
formatuuid
ip_restrictions: Optional[List[str]]
Deprecatedlast_modified: Optional[datetime]

Use modified_at instead.

Deprecated, use modified_at instead. End of life: November 1, 2026.

formatdate-time
lookback_hops: Optional[int]
modified_at: Optional[datetime]
formatdate-time
o365_tenant_id: Optional[str]
regions: Optional[List[Literal["GLOBAL", "AU", "DE", 2 more]]]
One of the following:
"GLOBAL"
"AU"
"DE"
"IN"
"US"
require_tls_inbound: Optional[bool]
require_tls_outbound: Optional[bool]
spf_status: Optional[Literal["none", "good", "neutral", 2 more]]
One of the following:
"none"
"good"
"neutral"
"open"
"invalid"
status: Optional[Literal["PENDING", "ACTIVE", "FAILED", "TIMEOUT"]]
One of the following:
"PENDING"
"ACTIVE"
"FAILED"
"TIMEOUT"
transport: Optional[str]
puts: List[Put]
id: Optional[str]

Domain identifier.

formatuuid
allowed_delivery_modes: Optional[List[Literal["DIRECT", "BCC", "JOURNAL", 2 more]]]
One of the following:
"DIRECT"
"BCC"
"JOURNAL"
"API"
"RETRO_SCAN"
authorization: Optional[PutAuthorization]
authorized: bool
timestamp: datetime
formatdate-time
status_message: Optional[str]
created_at: Optional[datetime]
formatdate-time
dmarc_status: Optional[Literal["none", "good", "invalid"]]
One of the following:
"none"
"good"
"invalid"
domain: Optional[str]
drop_dispositions: Optional[List[Literal["MALICIOUS", "MALICIOUS-BEC", "SUSPICIOUS", 7 more]]]
One of the following:
"MALICIOUS"
"MALICIOUS-BEC"
"SUSPICIOUS"
"SPOOF"
"SPAM"
"BULK"
"ENCRYPTED"
"EXTERNAL"
"UNKNOWN"
"NONE"
emails_processed: Optional[PutEmailsProcessed]
timestamp: datetime
formatdate-time
total_emails_processed: int
minimum0
total_emails_processed_previous: int
minimum0
folder: Optional[Literal["AllItems", "Inbox"]]

The mailbox folder to scan, for API-scanning domains.

One of the following:
"AllItems"
"Inbox"
inbox_provider: Optional[Literal["Microsoft", "Google"]]
One of the following:
"Microsoft"
"Google"
integration_id: Optional[str]
formatuuid
ip_restrictions: Optional[List[str]]
Deprecatedlast_modified: Optional[datetime]

Use modified_at instead.

Deprecated, use modified_at instead. End of life: November 1, 2026.

formatdate-time
lookback_hops: Optional[int]
modified_at: Optional[datetime]
formatdate-time
o365_tenant_id: Optional[str]
regions: Optional[List[Literal["GLOBAL", "AU", "DE", 2 more]]]
One of the following:
"GLOBAL"
"AU"
"DE"
"IN"
"US"
require_tls_inbound: Optional[bool]
require_tls_outbound: Optional[bool]
spf_status: Optional[Literal["none", "good", "neutral", 2 more]]
One of the following:
"none"
"good"
"neutral"
"open"
"invalid"
status: Optional[Literal["PENDING", "ACTIVE", "FAILED", "TIMEOUT"]]
One of the following:
"PENDING"
"ACTIVE"
"FAILED"
"TIMEOUT"
transport: Optional[str]
class DomainBulkDeleteResponse: …
id: str

Domain identifier.

formatuuid

SettingsImpersonation Registry

List impersonation registry entries
email_security.settings.impersonation_registry.list(ImpersonationRegistryListParams**kwargs) -> SyncV4PagePaginationArray[ImpersonationRegistryListResponse]
GET/accounts/{account_id}/email-security/settings/impersonation_registry
Get an impersonation registry entry
email_security.settings.impersonation_registry.get(strimpersonation_registry_id, ImpersonationRegistryGetParams**kwargs) -> ImpersonationRegistryGetResponse
GET/accounts/{account_id}/email-security/settings/impersonation_registry/{impersonation_registry_id}
Create impersonation registry entry
email_security.settings.impersonation_registry.create(ImpersonationRegistryCreateParams**kwargs) -> ImpersonationRegistryCreateResponse
POST/accounts/{account_id}/email-security/settings/impersonation_registry
Update an impersonation registry entry
email_security.settings.impersonation_registry.edit(strimpersonation_registry_id, ImpersonationRegistryEditParams**kwargs) -> ImpersonationRegistryEditResponse
PATCH/accounts/{account_id}/email-security/settings/impersonation_registry/{impersonation_registry_id}
Delete an impersonation registry entry
email_security.settings.impersonation_registry.delete(strimpersonation_registry_id, ImpersonationRegistryDeleteParams**kwargs) -> ImpersonationRegistryDeleteResponse
DELETE/accounts/{account_id}/email-security/settings/impersonation_registry/{impersonation_registry_id}
ModelsExpand Collapse
class ImpersonationRegistryListResponse: …

An impersonation registry entry.

id: Optional[str]

Impersonation registry entry identifier.

formatuuid
comments: Optional[str]

Optional note describing the entry.

created_at: Optional[datetime]
formatdate-time
directory_id: Optional[int]

Identifier of the directory the entry was synced from, when directory-synced.

directory_node_id: Optional[int]

Identifier of the directory node the entry was synced from, when directory-synced.

email: Optional[str]

Email address (or pattern) of the protected identity.

Deprecatedexternal_directory_node_id: Optional[str]

This field is deprecated.

Deprecated. External identifier of the directory node.

is_email_regex: Optional[bool]

Whether email is a regular expression instead of a literal address.

Deprecatedlast_modified: Optional[datetime]

Use modified_at instead.

Deprecated, use modified_at instead. End of life: November 1, 2026.

formatdate-time
modified_at: Optional[datetime]
formatdate-time
name: Optional[str]

Display name of the protected identity.

maxLength1024
provenance: Optional[Literal["A1S_INTERNAL", "SNOOPY-CASB_OFFICE_365", "SNOOPY-OFFICE_365", "SNOOPY-GOOGLE_DIRECTORY"]]

Source the entry was created from.

One of the following:
"A1S_INTERNAL"
"SNOOPY-CASB_OFFICE_365"
"SNOOPY-OFFICE_365"
"SNOOPY-GOOGLE_DIRECTORY"
class ImpersonationRegistryGetResponse: …

An impersonation registry entry.

id: Optional[str]

Impersonation registry entry identifier.

formatuuid
comments: Optional[str]

Optional note describing the entry.

created_at: Optional[datetime]
formatdate-time
directory_id: Optional[int]

Identifier of the directory the entry was synced from, when directory-synced.

directory_node_id: Optional[int]

Identifier of the directory node the entry was synced from, when directory-synced.

email: Optional[str]

Email address (or pattern) of the protected identity.

Deprecatedexternal_directory_node_id: Optional[str]

This field is deprecated.

Deprecated. External identifier of the directory node.

is_email_regex: Optional[bool]

Whether email is a regular expression instead of a literal address.

Deprecatedlast_modified: Optional[datetime]

Use modified_at instead.

Deprecated, use modified_at instead. End of life: November 1, 2026.

formatdate-time
modified_at: Optional[datetime]
formatdate-time
name: Optional[str]

Display name of the protected identity.

maxLength1024
provenance: Optional[Literal["A1S_INTERNAL", "SNOOPY-CASB_OFFICE_365", "SNOOPY-OFFICE_365", "SNOOPY-GOOGLE_DIRECTORY"]]

Source the entry was created from.

One of the following:
"A1S_INTERNAL"
"SNOOPY-CASB_OFFICE_365"
"SNOOPY-OFFICE_365"
"SNOOPY-GOOGLE_DIRECTORY"
class ImpersonationRegistryCreateResponse: …

An impersonation registry entry.

id: Optional[str]

Impersonation registry entry identifier.

formatuuid
comments: Optional[str]

Optional note describing the entry.

created_at: Optional[datetime]
formatdate-time
directory_id: Optional[int]

Identifier of the directory the entry was synced from, when directory-synced.

directory_node_id: Optional[int]

Identifier of the directory node the entry was synced from, when directory-synced.

email: Optional[str]

Email address (or pattern) of the protected identity.

Deprecatedexternal_directory_node_id: Optional[str]

This field is deprecated.

Deprecated. External identifier of the directory node.

is_email_regex: Optional[bool]

Whether email is a regular expression instead of a literal address.

Deprecatedlast_modified: Optional[datetime]

Use modified_at instead.

Deprecated, use modified_at instead. End of life: November 1, 2026.

formatdate-time
modified_at: Optional[datetime]
formatdate-time
name: Optional[str]

Display name of the protected identity.

maxLength1024
provenance: Optional[Literal["A1S_INTERNAL", "SNOOPY-CASB_OFFICE_365", "SNOOPY-OFFICE_365", "SNOOPY-GOOGLE_DIRECTORY"]]

Source the entry was created from.

One of the following:
"A1S_INTERNAL"
"SNOOPY-CASB_OFFICE_365"
"SNOOPY-OFFICE_365"
"SNOOPY-GOOGLE_DIRECTORY"
class ImpersonationRegistryEditResponse: …

An impersonation registry entry.

id: Optional[str]

Impersonation registry entry identifier.

formatuuid
comments: Optional[str]

Optional note describing the entry.

created_at: Optional[datetime]
formatdate-time
directory_id: Optional[int]

Identifier of the directory the entry was synced from, when directory-synced.

directory_node_id: Optional[int]

Identifier of the directory node the entry was synced from, when directory-synced.

email: Optional[str]

Email address (or pattern) of the protected identity.

Deprecatedexternal_directory_node_id: Optional[str]

This field is deprecated.

Deprecated. External identifier of the directory node.

is_email_regex: Optional[bool]

Whether email is a regular expression instead of a literal address.

Deprecatedlast_modified: Optional[datetime]

Use modified_at instead.

Deprecated, use modified_at instead. End of life: November 1, 2026.

formatdate-time
modified_at: Optional[datetime]
formatdate-time
name: Optional[str]

Display name of the protected identity.

maxLength1024
provenance: Optional[Literal["A1S_INTERNAL", "SNOOPY-CASB_OFFICE_365", "SNOOPY-OFFICE_365", "SNOOPY-GOOGLE_DIRECTORY"]]

Source the entry was created from.

One of the following:
"A1S_INTERNAL"
"SNOOPY-CASB_OFFICE_365"
"SNOOPY-OFFICE_365"
"SNOOPY-GOOGLE_DIRECTORY"
class ImpersonationRegistryDeleteResponse: …
id: str

Impersonation registry entry identifier.

formatuuid

SettingsSending Domain Restrictions

List sending domain restrictions
email_security.settings.sending_domain_restrictions.list(SendingDomainRestrictionListParams**kwargs) -> SyncV4PagePaginationArray[SendingDomainRestrictionListResponse]
GET/accounts/{account_id}/email-security/settings/sending_domain_restrictions
Get a sending domain restriction
email_security.settings.sending_domain_restrictions.get(strsending_domain_restriction_id, SendingDomainRestrictionGetParams**kwargs) -> SendingDomainRestrictionGetResponse
GET/accounts/{account_id}/email-security/settings/sending_domain_restrictions/{sending_domain_restriction_id}
Create a sending domain restriction
email_security.settings.sending_domain_restrictions.create(SendingDomainRestrictionCreateParams**kwargs) -> SendingDomainRestrictionCreateResponse
POST/accounts/{account_id}/email-security/settings/sending_domain_restrictions
Update a sending domain restriction
email_security.settings.sending_domain_restrictions.edit(strsending_domain_restriction_id, SendingDomainRestrictionEditParams**kwargs) -> SendingDomainRestrictionEditResponse
PATCH/accounts/{account_id}/email-security/settings/sending_domain_restrictions/{sending_domain_restriction_id}
Delete a sending domain restriction
email_security.settings.sending_domain_restrictions.delete(strsending_domain_restriction_id, SendingDomainRestrictionDeleteParams**kwargs) -> SendingDomainRestrictionDeleteResponse
DELETE/accounts/{account_id}/email-security/settings/sending_domain_restrictions/{sending_domain_restriction_id}
ModelsExpand Collapse
class SendingDomainRestrictionListResponse: …

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: Optional[str]

Sending domain restriction identifier.

formatuuid
comments: Optional[str]
maxLength1024
created_at: Optional[datetime]
formatdate-time
domain: Optional[str]

Domain that requires TLS enforcement.

exclude: Optional[List[str]]

Subdomains to exempt from TLS requirements.

Deprecatedlast_modified: Optional[datetime]

Use modified_at instead.

Deprecated, use modified_at instead. End of life: November 1, 2026.

formatdate-time
modified_at: Optional[datetime]
formatdate-time
class SendingDomainRestrictionGetResponse: …

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: Optional[str]

Sending domain restriction identifier.

formatuuid
comments: Optional[str]
maxLength1024
created_at: Optional[datetime]
formatdate-time
domain: Optional[str]

Domain that requires TLS enforcement.

exclude: Optional[List[str]]

Subdomains to exempt from TLS requirements.

Deprecatedlast_modified: Optional[datetime]

Use modified_at instead.

Deprecated, use modified_at instead. End of life: November 1, 2026.

formatdate-time
modified_at: Optional[datetime]
formatdate-time
class SendingDomainRestrictionCreateResponse: …

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: Optional[str]

Sending domain restriction identifier.

formatuuid
comments: Optional[str]
maxLength1024
created_at: Optional[datetime]
formatdate-time
domain: Optional[str]

Domain that requires TLS enforcement.

exclude: Optional[List[str]]

Subdomains to exempt from TLS requirements.

Deprecatedlast_modified: Optional[datetime]

Use modified_at instead.

Deprecated, use modified_at instead. End of life: November 1, 2026.

formatdate-time
modified_at: Optional[datetime]
formatdate-time
class SendingDomainRestrictionEditResponse: …

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: Optional[str]

Sending domain restriction identifier.

formatuuid
comments: Optional[str]
maxLength1024
created_at: Optional[datetime]
formatdate-time
domain: Optional[str]

Domain that requires TLS enforcement.

exclude: Optional[List[str]]

Subdomains to exempt from TLS requirements.

Deprecatedlast_modified: Optional[datetime]

Use modified_at instead.

Deprecated, use modified_at instead. End of life: November 1, 2026.

formatdate-time
modified_at: Optional[datetime]
formatdate-time
class SendingDomainRestrictionDeleteResponse: …
id: str

Sending domain restriction identifier.

formatuuid

SettingsTrusted Domains

List trusted email domains
email_security.settings.trusted_domains.list(TrustedDomainListParams**kwargs) -> SyncV4PagePaginationArray[TrustedDomainListResponse]
GET/accounts/{account_id}/email-security/settings/trusted_domains
Get a trusted email domain
email_security.settings.trusted_domains.get(strtrusted_domain_id, TrustedDomainGetParams**kwargs) -> TrustedDomainGetResponse
GET/accounts/{account_id}/email-security/settings/trusted_domains/{trusted_domain_id}
Create trusted email domain
email_security.settings.trusted_domains.create(TrustedDomainCreateParams**kwargs) -> TrustedDomainCreateResponse
POST/accounts/{account_id}/email-security/settings/trusted_domains
Update a trusted email domain
email_security.settings.trusted_domains.edit(strtrusted_domain_id, TrustedDomainEditParams**kwargs) -> TrustedDomainEditResponse
PATCH/accounts/{account_id}/email-security/settings/trusted_domains/{trusted_domain_id}
Delete a trusted email domain
email_security.settings.trusted_domains.delete(strtrusted_domain_id, TrustedDomainDeleteParams**kwargs) -> TrustedDomainDeleteResponse
DELETE/accounts/{account_id}/email-security/settings/trusted_domains/{trusted_domain_id}
Batch trusted domain operations
email_security.settings.trusted_domains.batch(TrustedDomainBatchParams**kwargs) -> TrustedDomainBatchResponse
POST/accounts/{account_id}/email-security/settings/trusted_domains/batch
ModelsExpand Collapse
class TrustedDomainListResponse: …

A trusted email domain.

id: Optional[str]

Trusted domain identifier.

formatuuid
comments: Optional[str]
maxLength1024
created_at: Optional[datetime]
formatdate-time
is_recent: Optional[bool]

Select to prevent recently registered domains from triggering a Suspicious or Malicious disposition.

is_regex: Optional[bool]

Whether pattern is a regular expression instead of a literal domain.

is_similarity: Optional[bool]

Select for partner or other approved domains that have similar spelling to your connected domains. Prevents listed domains from triggering a Spoof disposition.

Deprecatedlast_modified: Optional[datetime]

Use modified_at instead.

Deprecated, use modified_at instead. End of life: November 1, 2026.

formatdate-time
modified_at: Optional[datetime]
formatdate-time
pattern: Optional[str]

The domain pattern to trust, e.g. example.com.

maxLength1024
minLength1
class TrustedDomainGetResponse: …

A trusted email domain.

id: Optional[str]

Trusted domain identifier.

formatuuid
comments: Optional[str]
maxLength1024
created_at: Optional[datetime]
formatdate-time
is_recent: Optional[bool]

Select to prevent recently registered domains from triggering a Suspicious or Malicious disposition.

is_regex: Optional[bool]

Whether pattern is a regular expression instead of a literal domain.

is_similarity: Optional[bool]

Select for partner or other approved domains that have similar spelling to your connected domains. Prevents listed domains from triggering a Spoof disposition.

Deprecatedlast_modified: Optional[datetime]

Use modified_at instead.

Deprecated, use modified_at instead. End of life: November 1, 2026.

formatdate-time
modified_at: Optional[datetime]
formatdate-time
pattern: Optional[str]

The domain pattern to trust, e.g. example.com.

maxLength1024
minLength1
class TrustedDomainCreateResponse: …

A trusted email domain.

id: Optional[str]

Trusted domain identifier.

formatuuid
comments: Optional[str]
maxLength1024
created_at: Optional[datetime]
formatdate-time
is_recent: Optional[bool]

Select to prevent recently registered domains from triggering a Suspicious or Malicious disposition.

is_regex: Optional[bool]

Whether pattern is a regular expression instead of a literal domain.

is_similarity: Optional[bool]

Select for partner or other approved domains that have similar spelling to your connected domains. Prevents listed domains from triggering a Spoof disposition.

Deprecatedlast_modified: Optional[datetime]

Use modified_at instead.

Deprecated, use modified_at instead. End of life: November 1, 2026.

formatdate-time
modified_at: Optional[datetime]
formatdate-time
pattern: Optional[str]

The domain pattern to trust, e.g. example.com.

maxLength1024
minLength1
class TrustedDomainEditResponse: …

A trusted email domain.

id: Optional[str]

Trusted domain identifier.

formatuuid
comments: Optional[str]
maxLength1024
created_at: Optional[datetime]
formatdate-time
is_recent: Optional[bool]

Select to prevent recently registered domains from triggering a Suspicious or Malicious disposition.

is_regex: Optional[bool]

Whether pattern is a regular expression instead of a literal domain.

is_similarity: Optional[bool]

Select for partner or other approved domains that have similar spelling to your connected domains. Prevents listed domains from triggering a Spoof disposition.

Deprecatedlast_modified: Optional[datetime]

Use modified_at instead.

Deprecated, use modified_at instead. End of life: November 1, 2026.

formatdate-time
modified_at: Optional[datetime]
formatdate-time
pattern: Optional[str]

The domain pattern to trust, e.g. example.com.

maxLength1024
minLength1
class TrustedDomainDeleteResponse: …
id: str

Trusted domain identifier.

formatuuid
class TrustedDomainBatchResponse: …
deletes: Optional[List[Delete]]
id: str

Trusted domain identifier.

formatuuid
patches: Optional[List[Patch]]
id: Optional[str]

Trusted domain identifier.

formatuuid
comments: Optional[str]
maxLength1024
created_at: Optional[datetime]
formatdate-time
is_recent: Optional[bool]

Select to prevent recently registered domains from triggering a Suspicious or Malicious disposition.

is_regex: Optional[bool]

Whether pattern is a regular expression instead of a literal domain.

is_similarity: Optional[bool]

Select for partner or other approved domains that have similar spelling to your connected domains. Prevents listed domains from triggering a Spoof disposition.

Deprecatedlast_modified: Optional[datetime]

Use modified_at instead.

Deprecated, use modified_at instead. End of life: November 1, 2026.

formatdate-time
modified_at: Optional[datetime]
formatdate-time
pattern: Optional[str]

The domain pattern to trust, e.g. example.com.

maxLength1024
minLength1
posts: Optional[List[Post]]
id: Optional[str]

Trusted domain identifier.

formatuuid
comments: Optional[str]
maxLength1024
created_at: Optional[datetime]
formatdate-time
is_recent: Optional[bool]

Select to prevent recently registered domains from triggering a Suspicious or Malicious disposition.

is_regex: Optional[bool]

Whether pattern is a regular expression instead of a literal domain.

is_similarity: Optional[bool]

Select for partner or other approved domains that have similar spelling to your connected domains. Prevents listed domains from triggering a Spoof disposition.

Deprecatedlast_modified: Optional[datetime]

Use modified_at instead.

Deprecated, use modified_at instead. End of life: November 1, 2026.

formatdate-time
modified_at: Optional[datetime]
formatdate-time
pattern: Optional[str]

The domain pattern to trust, e.g. example.com.

maxLength1024
minLength1
puts: Optional[List[Put]]
id: Optional[str]

Trusted domain identifier.

formatuuid
comments: Optional[str]
maxLength1024
created_at: Optional[datetime]
formatdate-time
is_recent: Optional[bool]

Select to prevent recently registered domains from triggering a Suspicious or Malicious disposition.

is_regex: Optional[bool]

Whether pattern is a regular expression instead of a literal domain.

is_similarity: Optional[bool]

Select for partner or other approved domains that have similar spelling to your connected domains. Prevents listed domains from triggering a Spoof disposition.

Deprecatedlast_modified: Optional[datetime]

Use modified_at instead.

Deprecated, use modified_at instead. End of life: November 1, 2026.

formatdate-time
modified_at: Optional[datetime]
formatdate-time
pattern: Optional[str]

The domain pattern to trust, e.g. example.com.

maxLength1024
minLength1

SettingsURL Ignore Patterns

List URL ignore patterns
email_security.settings.url_ignore_patterns.list(URLIgnorePatternListParams**kwargs) -> SyncV4PagePaginationArray[URLIgnorePatternListResponse]
GET/accounts/{account_id}/email-security/settings/url_ignore_patterns
Get a URL ignore pattern
email_security.settings.url_ignore_patterns.get(strpattern_id, URLIgnorePatternGetParams**kwargs) -> URLIgnorePatternGetResponse
GET/accounts/{account_id}/email-security/settings/url_ignore_patterns/{pattern_id}
Create a URL ignore pattern
email_security.settings.url_ignore_patterns.create(URLIgnorePatternCreateParams**kwargs) -> URLIgnorePatternCreateResponse
POST/accounts/{account_id}/email-security/settings/url_ignore_patterns
Update a URL ignore pattern
email_security.settings.url_ignore_patterns.edit(strpattern_id, URLIgnorePatternEditParams**kwargs) -> URLIgnorePatternEditResponse
PATCH/accounts/{account_id}/email-security/settings/url_ignore_patterns/{pattern_id}
Delete a URL ignore pattern
email_security.settings.url_ignore_patterns.delete(strpattern_id, URLIgnorePatternDeleteParams**kwargs) -> URLIgnorePatternDeleteResponse
DELETE/accounts/{account_id}/email-security/settings/url_ignore_patterns/{pattern_id}
ModelsExpand Collapse
class URLIgnorePatternListResponse: …

A URL ignore pattern that exempts matching URLs from Email Security’s URL rewriting.

id: str

URL ignore pattern identifier.

formatuuid
created_at: datetime
formatdate-time
pattern: str

Regular expression identifying URLs to exempt from rewriting.

maxLength1024
minLength1
comments: Optional[str]

Optional note describing the reason for the ignore pattern.

maxLength1024
Deprecatedlast_modified: Optional[datetime]

Use modified_at instead.

Deprecated, use modified_at instead. End of life: November 1, 2026.

formatdate-time
modified_at: Optional[datetime]
formatdate-time
class URLIgnorePatternGetResponse: …

A URL ignore pattern that exempts matching URLs from Email Security’s URL rewriting.

id: str

URL ignore pattern identifier.

formatuuid
created_at: datetime
formatdate-time
pattern: str

Regular expression identifying URLs to exempt from rewriting.

maxLength1024
minLength1
comments: Optional[str]

Optional note describing the reason for the ignore pattern.

maxLength1024
Deprecatedlast_modified: Optional[datetime]

Use modified_at instead.

Deprecated, use modified_at instead. End of life: November 1, 2026.

formatdate-time
modified_at: Optional[datetime]
formatdate-time
class URLIgnorePatternCreateResponse: …

A URL ignore pattern that exempts matching URLs from Email Security’s URL rewriting.

id: str

URL ignore pattern identifier.

formatuuid
created_at: datetime
formatdate-time
pattern: str

Regular expression identifying URLs to exempt from rewriting.

maxLength1024
minLength1
comments: Optional[str]

Optional note describing the reason for the ignore pattern.

maxLength1024
Deprecatedlast_modified: Optional[datetime]

Use modified_at instead.

Deprecated, use modified_at instead. End of life: November 1, 2026.

formatdate-time
modified_at: Optional[datetime]
formatdate-time
class URLIgnorePatternEditResponse: …

A URL ignore pattern that exempts matching URLs from Email Security’s URL rewriting.

id: str

URL ignore pattern identifier.

formatuuid
created_at: datetime
formatdate-time
pattern: str

Regular expression identifying URLs to exempt from rewriting.

maxLength1024
minLength1
comments: Optional[str]

Optional note describing the reason for the ignore pattern.

maxLength1024
Deprecatedlast_modified: Optional[datetime]

Use modified_at instead.

Deprecated, use modified_at instead. End of life: November 1, 2026.

formatdate-time
modified_at: Optional[datetime]
formatdate-time
class URLIgnorePatternDeleteResponse: …
id: str

URL ignore pattern identifier.

formatuuid