API Reference

Email Security

Settings

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Allow 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(intpolicy_id, AllowPolicyGetParams**kwargs) -> AllowPolicyGetResponse

GET/accounts/{account_id}/email-security/settings/allow_policies/{policy_id}

Create an 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(intpolicy_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(intpolicy_id, AllowPolicyDeleteParams**kwargs) -> AllowPolicyDeleteResponse

DELETE/accounts/{account_id}/email-security/settings/allow_policies/{policy_id}

ModelsExpand Collapse

class AllowPolicyListResponse: …

id: int

The unique identifier for the allow policy.

formatint32

created_at: datetime

formatdate-time

is_acceptable_sender: bool

Messages from this sender will be exempted from Spam, Spoof and Bulk dispositions. Note: This will not exempt messages with Malicious or Suspicious dispositions.

is_exempt_recipient: bool

Messages to this recipient will bypass all detections.

is_regex: bool

is_trusted_sender: bool

Messages from this sender will bypass all detections and link following.

last_modified: datetime

formatdate-time

pattern: str

maxLength1024

minLength1

pattern_type: Literal["EMAIL", "DOMAIN", "IP", "UNKNOWN"]

One of the following:

"EMAIL"

"DOMAIN"

"IP"

"UNKNOWN"

verify_sender: bool

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

comments: Optional[str]

maxLength1024

Deprecatedis_recipient: Optional[bool]

Deprecatedis_sender: Optional[bool]

Deprecatedis_spoof: Optional[bool]

class AllowPolicyGetResponse: …

id: int

The unique identifier for the allow policy.

formatint32

created_at: datetime

formatdate-time

is_acceptable_sender: bool

Messages from this sender will be exempted from Spam, Spoof and Bulk dispositions. Note: This will not exempt messages with Malicious or Suspicious dispositions.

is_exempt_recipient: bool

Messages to this recipient will bypass all detections.

is_regex: bool

is_trusted_sender: bool

Messages from this sender will bypass all detections and link following.

last_modified: datetime

formatdate-time

pattern: str

maxLength1024

minLength1

pattern_type: Literal["EMAIL", "DOMAIN", "IP", "UNKNOWN"]

One of the following:

"EMAIL"

"DOMAIN"

"IP"

"UNKNOWN"

verify_sender: bool

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

comments: Optional[str]

maxLength1024

Deprecatedis_recipient: Optional[bool]

Deprecatedis_sender: Optional[bool]

Deprecatedis_spoof: Optional[bool]

class AllowPolicyCreateResponse: …

id: int

The unique identifier for the allow policy.

formatint32

created_at: datetime

formatdate-time

is_acceptable_sender: bool

Messages from this sender will be exempted from Spam, Spoof and Bulk dispositions. Note: This will not exempt messages with Malicious or Suspicious dispositions.

is_exempt_recipient: bool

Messages to this recipient will bypass all detections.

is_regex: bool

is_trusted_sender: bool

Messages from this sender will bypass all detections and link following.

last_modified: datetime

formatdate-time

pattern: str

maxLength1024

minLength1

pattern_type: Literal["EMAIL", "DOMAIN", "IP", "UNKNOWN"]

One of the following:

"EMAIL"

"DOMAIN"

"IP"

"UNKNOWN"

verify_sender: bool

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

comments: Optional[str]

maxLength1024

Deprecatedis_recipient: Optional[bool]

Deprecatedis_sender: Optional[bool]

Deprecatedis_spoof: Optional[bool]

class AllowPolicyEditResponse: …

id: int

The unique identifier for the allow policy.

formatint32

created_at: datetime

formatdate-time

is_acceptable_sender: bool

Messages from this sender will be exempted from Spam, Spoof and Bulk dispositions. Note: This will not exempt messages with Malicious or Suspicious dispositions.

is_exempt_recipient: bool

Messages to this recipient will bypass all detections.

is_regex: bool

is_trusted_sender: bool

Messages from this sender will bypass all detections and link following.

last_modified: datetime

formatdate-time

pattern: str

maxLength1024

minLength1

pattern_type: Literal["EMAIL", "DOMAIN", "IP", "UNKNOWN"]

One of the following:

"EMAIL"

"DOMAIN"

"IP"

"UNKNOWN"

verify_sender: bool

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

comments: Optional[str]

maxLength1024

Deprecatedis_recipient: Optional[bool]

Deprecatedis_sender: Optional[bool]

Deprecatedis_spoof: Optional[bool]

class AllowPolicyDeleteResponse: …

id: int

The unique identifier for the allow policy.

formatint32