Settings

SettingsAllow Policies

List email allow policies

client.emailSecurity.settings.allowPolicies.list(, ?): V4PagePaginationArray<AllowPolicyListResponse { id, created_at, is_acceptable_sender, 11 more } >

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

Get an email allow policy

client.emailSecurity.settings.allowPolicies.get(, , ?): AllowPolicyGetResponse { id, created_at, is_acceptable_sender, 11 more }

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

Create an email allow policy

client.emailSecurity.settings.allowPolicies.create(, ?): AllowPolicyCreateResponse { id, created_at, is_acceptable_sender, 11 more }

POST/accounts/{account_id}/email-security/settings/allow_policies

Update an email allow policy

client.emailSecurity.settings.allowPolicies.edit(, , ?): AllowPolicyEditResponse { id, created_at, is_acceptable_sender, 11 more }

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

Delete an email allow policy

client.emailSecurity.settings.allowPolicies.delete(, , ?): AllowPolicyDeleteResponse { id }

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

ModelsExpand Collapse

AllowPolicyListResponse { id, created_at, is_acceptable_sender, 11 more }

id: number

The unique identifier for the allow policy.

formatint32

created_at: string

formatdate-time

is_acceptable_sender: boolean

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: boolean

Messages to this recipient will bypass all detections.

is_regex: boolean

is_trusted_sender: boolean

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

last_modified: string

formatdate-time

pattern: string

maxLength1024

minLength1

pattern_type: "EMAIL" | "DOMAIN" | "IP" | "UNKNOWN"

One of the following:

"EMAIL"

"DOMAIN"

"IP"

"UNKNOWN"

verify_sender: boolean

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

comments?: string | null

maxLength1024

Deprecatedis_recipient?: boolean

Deprecatedis_sender?: boolean

Deprecatedis_spoof?: boolean

AllowPolicyGetResponse { id, created_at, is_acceptable_sender, 11 more }

id: number

The unique identifier for the allow policy.

formatint32

created_at: string

formatdate-time

is_acceptable_sender: boolean

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: boolean

Messages to this recipient will bypass all detections.

is_regex: boolean

is_trusted_sender: boolean

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

last_modified: string

formatdate-time

pattern: string

maxLength1024

minLength1

pattern_type: "EMAIL" | "DOMAIN" | "IP" | "UNKNOWN"

One of the following:

"EMAIL"

"DOMAIN"

"IP"

"UNKNOWN"

verify_sender: boolean

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

comments?: string | null

maxLength1024

Deprecatedis_recipient?: boolean

Deprecatedis_sender?: boolean

Deprecatedis_spoof?: boolean

AllowPolicyCreateResponse { id, created_at, is_acceptable_sender, 11 more }

id: number

The unique identifier for the allow policy.

formatint32

created_at: string

formatdate-time

is_acceptable_sender: boolean

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: boolean

Messages to this recipient will bypass all detections.

is_regex: boolean

is_trusted_sender: boolean

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

last_modified: string

formatdate-time

pattern: string

maxLength1024

minLength1

pattern_type: "EMAIL" | "DOMAIN" | "IP" | "UNKNOWN"

One of the following:

"EMAIL"

"DOMAIN"

"IP"

"UNKNOWN"

verify_sender: boolean

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

comments?: string | null

maxLength1024

Deprecatedis_recipient?: boolean

Deprecatedis_sender?: boolean

Deprecatedis_spoof?: boolean

AllowPolicyEditResponse { id, created_at, is_acceptable_sender, 11 more }

id: number

The unique identifier for the allow policy.

formatint32

created_at: string

formatdate-time

is_acceptable_sender: boolean

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: boolean

Messages to this recipient will bypass all detections.

is_regex: boolean

is_trusted_sender: boolean

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

last_modified: string

formatdate-time

pattern: string

maxLength1024

minLength1

pattern_type: "EMAIL" | "DOMAIN" | "IP" | "UNKNOWN"

One of the following:

"EMAIL"

"DOMAIN"

"IP"

"UNKNOWN"

verify_sender: boolean

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

comments?: string | null

maxLength1024

Deprecatedis_recipient?: boolean

Deprecatedis_sender?: boolean

Deprecatedis_spoof?: boolean

AllowPolicyDeleteResponse { id }

id: number

The unique identifier for the allow policy.

formatint32

SettingsBlock Senders

List blocked email senders

client.emailSecurity.settings.blockSenders.list(, ?): V4PagePaginationArray<BlockSenderListResponse { id, created_at, is_regex, 4 more } >

GET/accounts/{account_id}/email-security/settings/block_senders

Get a blocked email sender

client.emailSecurity.settings.blockSenders.get(, , ?): BlockSenderGetResponse { id, created_at, is_regex, 4 more }

GET/accounts/{account_id}/email-security/settings/block_senders/{pattern_id}

Create a blocked email sender

client.emailSecurity.settings.blockSenders.create(, ?): BlockSenderCreateResponse { id, created_at, is_regex, 4 more }

POST/accounts/{account_id}/email-security/settings/block_senders

Update a blocked email sender

client.emailSecurity.settings.blockSenders.edit(, , ?): BlockSenderEditResponse { id, created_at, is_regex, 4 more }

PATCH/accounts/{account_id}/email-security/settings/block_senders/{pattern_id}

Delete a blocked email sender

client.emailSecurity.settings.blockSenders.delete(, , ?): BlockSenderDeleteResponse { id }

DELETE/accounts/{account_id}/email-security/settings/block_senders/{pattern_id}

ModelsExpand Collapse

BlockSenderListResponse { id, created_at, is_regex, 4 more }

id: number

The unique identifier for the allow policy.

formatint32

created_at: string

formatdate-time

is_regex: boolean

last_modified: string

formatdate-time

pattern: string

maxLength1024

minLength1

pattern_type: "EMAIL" | "DOMAIN" | "IP" | "UNKNOWN"

One of the following:

"EMAIL"

"DOMAIN"

"IP"

"UNKNOWN"

comments?: string | null

maxLength1024

BlockSenderGetResponse { id, created_at, is_regex, 4 more }

id: number

The unique identifier for the allow policy.

formatint32

created_at: string

formatdate-time

is_regex: boolean

last_modified: string

formatdate-time

pattern: string

maxLength1024

minLength1

pattern_type: "EMAIL" | "DOMAIN" | "IP" | "UNKNOWN"

One of the following:

"EMAIL"

"DOMAIN"

"IP"

"UNKNOWN"

comments?: string | null

maxLength1024

BlockSenderCreateResponse { id, created_at, is_regex, 4 more }

id: number

The unique identifier for the allow policy.

formatint32

created_at: string

formatdate-time

is_regex: boolean

last_modified: string

formatdate-time

pattern: string

maxLength1024

minLength1

pattern_type: "EMAIL" | "DOMAIN" | "IP" | "UNKNOWN"

One of the following:

"EMAIL"

"DOMAIN"

"IP"

"UNKNOWN"

comments?: string | null

maxLength1024

BlockSenderEditResponse { id, created_at, is_regex, 4 more }

id: number

The unique identifier for the allow policy.

formatint32

created_at: string

formatdate-time

is_regex: boolean

last_modified: string

formatdate-time

pattern: string

maxLength1024

minLength1

pattern_type: "EMAIL" | "DOMAIN" | "IP" | "UNKNOWN"

One of the following:

"EMAIL"

"DOMAIN"

"IP"

"UNKNOWN"

comments?: string | null

maxLength1024

BlockSenderDeleteResponse { id }

id: number

The unique identifier for the allow policy.

formatint32

SettingsDomains

List protected email domains

client.emailSecurity.settings.domains.list(, ?): V4PagePaginationArray<DomainListResponse { id, allowed_delivery_modes, created_at, 17 more } >

GET/accounts/{account_id}/email-security/settings/domains

Get an email domain

client.emailSecurity.settings.domains.get(, , ?): DomainGetResponse { id, allowed_delivery_modes, created_at, 17 more }

GET/accounts/{account_id}/email-security/settings/domains/{domain_id}

Update an email domain

client.emailSecurity.settings.domains.edit(, , ?): DomainEditResponse { id, allowed_delivery_modes, created_at, 17 more }

PATCH/accounts/{account_id}/email-security/settings/domains/{domain_id}

Unprotect an email domain

client.emailSecurity.settings.domains.delete(, , ?): DomainDeleteResponse { id }

DELETE/accounts/{account_id}/email-security/settings/domains/{domain_id}

Unprotect multiple email domains

client.emailSecurity.settings.domains.bulkDelete(, ?): SinglePage<DomainBulkDeleteResponse { id } >

DELETE/accounts/{account_id}/email-security/settings/domains

ModelsExpand Collapse

DomainListResponse { id, allowed_delivery_modes, created_at, 17 more }

id: number

The unique identifier for the domain.

formatint32

allowed_delivery_modes: Array<"DIRECT" | "BCC" | "JOURNAL" | 2 more>

One of the following:

"DIRECT"

"BCC"

"JOURNAL"

"API"

"RETRO_SCAN"

created_at: string

formatdate-time

domain: string

drop_dispositions: Array<"MALICIOUS" | "MALICIOUS-BEC" | "SUSPICIOUS" | 7 more>

One of the following:

"MALICIOUS"

"MALICIOUS-BEC"

"SUSPICIOUS"

"SPOOF"

"SPAM"

"BULK"

"ENCRYPTED"

"EXTERNAL"

"UNKNOWN"

"NONE"

ip_restrictions: Array<string>

last_modified: string

formatdate-time

lookback_hops: number

formatint32

regions: Array<"GLOBAL" | "AU" | "DE" | 2 more>

One of the following:

"GLOBAL"

"AU"

"DE"

"IN"

"US"

transport: string

authorization?: Authorization | null

authorized: boolean

timestamp: string

formatdate-time

status_message?: string | null

dmarc_status?: "none" | "good" | "invalid" | null

One of the following:

"none"

"good"

"invalid"

emails_processed?: EmailsProcessed | null

timestamp: string

formatdate-time

total_emails_processed: number

formatint32

minimum0

total_emails_processed_previous: number

formatint32

minimum0

folder?: "AllItems" | "Inbox" | null

One of the following:

"AllItems"

"Inbox"

inbox_provider?: "Microsoft" | "Google" | null

One of the following:

"Microsoft"

"Google"

integration_id?: string | null

formatuuid

o365_tenant_id?: string | null

require_tls_inbound?: boolean | null

require_tls_outbound?: boolean | null

spf_status?: "none" | "good" | "neutral" | 2 more | null

One of the following:

"none"

"good"

"neutral"

"open"

"invalid"

DomainGetResponse { id, allowed_delivery_modes, created_at, 17 more }

id: number

The unique identifier for the domain.

formatint32

allowed_delivery_modes: Array<"DIRECT" | "BCC" | "JOURNAL" | 2 more>

One of the following:

"DIRECT"

"BCC"

"JOURNAL"

"API"

"RETRO_SCAN"

created_at: string

formatdate-time

domain: string

drop_dispositions: Array<"MALICIOUS" | "MALICIOUS-BEC" | "SUSPICIOUS" | 7 more>

One of the following:

"MALICIOUS"

"MALICIOUS-BEC"

"SUSPICIOUS"

"SPOOF"

"SPAM"

"BULK"

"ENCRYPTED"

"EXTERNAL"

"UNKNOWN"

"NONE"

ip_restrictions: Array<string>

last_modified: string

formatdate-time

lookback_hops: number

formatint32

regions: Array<"GLOBAL" | "AU" | "DE" | 2 more>

One of the following:

"GLOBAL"

"AU"

"DE"

"IN"

"US"

transport: string

authorization?: Authorization | null

authorized: boolean

timestamp: string

formatdate-time

status_message?: string | null

dmarc_status?: "none" | "good" | "invalid" | null

One of the following:

"none"

"good"

"invalid"

emails_processed?: EmailsProcessed | null

timestamp: string

formatdate-time

total_emails_processed: number

formatint32

minimum0

total_emails_processed_previous: number

formatint32

minimum0

folder?: "AllItems" | "Inbox" | null

One of the following:

"AllItems"

"Inbox"

inbox_provider?: "Microsoft" | "Google" | null

One of the following:

"Microsoft"

"Google"

integration_id?: string | null

formatuuid

o365_tenant_id?: string | null

require_tls_inbound?: boolean | null

require_tls_outbound?: boolean | null

spf_status?: "none" | "good" | "neutral" | 2 more | null

One of the following:

"none"

"good"

"neutral"

"open"

"invalid"

DomainEditResponse { id, allowed_delivery_modes, created_at, 17 more }

id: number

The unique identifier for the domain.

formatint32

allowed_delivery_modes: Array<"DIRECT" | "BCC" | "JOURNAL" | 2 more>

One of the following:

"DIRECT"

"BCC"

"JOURNAL"

"API"

"RETRO_SCAN"

created_at: string

formatdate-time

domain: string

drop_dispositions: Array<"MALICIOUS" | "MALICIOUS-BEC" | "SUSPICIOUS" | 7 more>

One of the following:

"MALICIOUS"

"MALICIOUS-BEC"

"SUSPICIOUS"

"SPOOF"

"SPAM"

"BULK"

"ENCRYPTED"

"EXTERNAL"

"UNKNOWN"

"NONE"

ip_restrictions: Array<string>

last_modified: string

formatdate-time

lookback_hops: number

formatint32

regions: Array<"GLOBAL" | "AU" | "DE" | 2 more>

One of the following:

"GLOBAL"

"AU"

"DE"

"IN"

"US"

transport: string

authorization?: Authorization | null

authorized: boolean

timestamp: string

formatdate-time

status_message?: string | null

dmarc_status?: "none" | "good" | "invalid" | null

One of the following:

"none"

"good"

"invalid"

emails_processed?: EmailsProcessed | null

timestamp: string

formatdate-time

total_emails_processed: number

formatint32

minimum0

total_emails_processed_previous: number

formatint32

minimum0

folder?: "AllItems" | "Inbox" | null

One of the following:

"AllItems"

"Inbox"

inbox_provider?: "Microsoft" | "Google" | null

One of the following:

"Microsoft"

"Google"

integration_id?: string | null

formatuuid

o365_tenant_id?: string | null

require_tls_inbound?: boolean | null

require_tls_outbound?: boolean | null

spf_status?: "none" | "good" | "neutral" | 2 more | null

One of the following:

"none"

"good"

"neutral"

"open"

"invalid"

DomainDeleteResponse { id }

id: number

The unique identifier for the domain.

formatint32

DomainBulkDeleteResponse { id }

id: number

The unique identifier for the domain.

formatint32

SettingsImpersonation Registry

List entries in impersonation registry

client.emailSecurity.settings.impersonationRegistry.list(, ?): V4PagePaginationArray<ImpersonationRegistryListResponse { id, created_at, email, 8 more } >

GET/accounts/{account_id}/email-security/settings/impersonation_registry

Get an entry in impersonation registry

client.emailSecurity.settings.impersonationRegistry.get(, , ?): ImpersonationRegistryGetResponse { id, created_at, email, 8 more }

GET/accounts/{account_id}/email-security/settings/impersonation_registry/{display_name_id}

Create an entry in impersonation registry

client.emailSecurity.settings.impersonationRegistry.create(, ?): ImpersonationRegistryCreateResponse { id, created_at, email, 8 more }

POST/accounts/{account_id}/email-security/settings/impersonation_registry

Update an entry in impersonation registry

client.emailSecurity.settings.impersonationRegistry.edit(, , ?): ImpersonationRegistryEditResponse { id, created_at, email, 8 more }

PATCH/accounts/{account_id}/email-security/settings/impersonation_registry/{display_name_id}

Delete an entry from impersonation registry

client.emailSecurity.settings.impersonationRegistry.delete(, , ?): ImpersonationRegistryDeleteResponse { id }

DELETE/accounts/{account_id}/email-security/settings/impersonation_registry/{display_name_id}

ModelsExpand Collapse

ImpersonationRegistryListResponse { id, created_at, email, 8 more }

id: number

formatint32

created_at: string

formatdate-time

email: string

is_email_regex: boolean

last_modified: string

formatdate-time

maxLength1024

comments?: string | null

directory_id?: number | null

formatint64

directory_node_id?: number | null

formatint64

Deprecatedexternal_directory_node_id?: string | null

provenance?: string | null

ImpersonationRegistryGetResponse { id, created_at, email, 8 more }

id: number

formatint32

created_at: string

formatdate-time

email: string

is_email_regex: boolean

last_modified: string

formatdate-time

maxLength1024

comments?: string | null

directory_id?: number | null

formatint64

directory_node_id?: number | null

formatint64

Deprecatedexternal_directory_node_id?: string | null

provenance?: string | null

ImpersonationRegistryCreateResponse { id, created_at, email, 8 more }

id: number

formatint32

created_at: string

formatdate-time

email: string

is_email_regex: boolean

last_modified: string

formatdate-time

maxLength1024

comments?: string | null

directory_id?: number | null

formatint64

directory_node_id?: number | null

formatint64

Deprecatedexternal_directory_node_id?: string | null

provenance?: string | null

ImpersonationRegistryEditResponse { id, created_at, email, 8 more }

id: number

formatint32

created_at: string

formatdate-time

email: string

is_email_regex: boolean

last_modified: string

formatdate-time

maxLength1024

comments?: string | null

directory_id?: number | null

formatint64

directory_node_id?: number | null

formatint64

Deprecatedexternal_directory_node_id?: string | null

provenance?: string | null

ImpersonationRegistryDeleteResponse { id }

id: number

formatint32

SettingsTrusted Domains

List trusted email domains

client.emailSecurity.settings.trustedDomains.list(, ?): V4PagePaginationArray<TrustedDomainListResponse { id, created_at, is_recent, 5 more } >

GET/accounts/{account_id}/email-security/settings/trusted_domains

Get a trusted email domain

client.emailSecurity.settings.trustedDomains.get(, , ?): TrustedDomainGetResponse { id, created_at, is_recent, 5 more }

GET/accounts/{account_id}/email-security/settings/trusted_domains/{trusted_domain_id}

Create a trusted email domain

client.emailSecurity.settings.trustedDomains.create(, ?): TrustedDomainCreateResponse

POST/accounts/{account_id}/email-security/settings/trusted_domains

Update a trusted email domain

client.emailSecurity.settings.trustedDomains.edit(, , ?): TrustedDomainEditResponse { id, created_at, is_recent, 5 more }

PATCH/accounts/{account_id}/email-security/settings/trusted_domains/{trusted_domain_id}

Delete a trusted email domain

client.emailSecurity.settings.trustedDomains.delete(, , ?): TrustedDomainDeleteResponse { id }

DELETE/accounts/{account_id}/email-security/settings/trusted_domains/{trusted_domain_id}

ModelsExpand Collapse

TrustedDomainListResponse { id, created_at, is_recent, 5 more }

id: number

The unique identifier for the trusted domain.

formatint32

created_at: string

formatdate-time

is_recent: boolean

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

is_regex: boolean

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.

last_modified: string

formatdate-time

pattern: string

maxLength1024

minLength1

comments?: string | null

maxLength1024

TrustedDomainGetResponse { id, created_at, is_recent, 5 more }

id: number

The unique identifier for the trusted domain.

formatint32

created_at: string

formatdate-time

is_recent: boolean

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

is_regex: boolean

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.

last_modified: string

formatdate-time

pattern: string

maxLength1024

minLength1

comments?: string | null

maxLength1024

TrustedDomainCreateResponse = EmailSecurityTrustedDomain { id, created_at, is_recent, 5 more } | Array<UnionMember1>

One of the following:

EmailSecurityTrustedDomain { id, created_at, is_recent, 5 more }

id: number

The unique identifier for the trusted domain.

formatint32

created_at: string

formatdate-time

is_recent: boolean

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

is_regex: boolean

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.

last_modified: string

formatdate-time

pattern: string

maxLength1024

minLength1

comments?: string | null

maxLength1024

Array<UnionMember1>

id: number

The unique identifier for the trusted domain.

formatint32

created_at: string

formatdate-time

is_recent: boolean

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

is_regex: boolean

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.

last_modified: string

formatdate-time

pattern: string

maxLength1024

minLength1

comments?: string | null

maxLength1024

TrustedDomainEditResponse { id, created_at, is_recent, 5 more }

id: number

The unique identifier for the trusted domain.

formatint32

created_at: string

formatdate-time

is_recent: boolean

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

is_regex: boolean

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.

last_modified: string

formatdate-time

pattern: string

maxLength1024

minLength1

comments?: string | null

maxLength1024

TrustedDomainDeleteResponse { id }

id: number

The unique identifier for the trusted domain.

formatint32