API Reference

Email Security

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Settings

SettingsAllow Policies

List email allow policies

client.EmailSecurity.Settings.AllowPolicies.List(ctx, params) (*V4PagePaginationArray[SettingAllowPolicyListResponse], error)

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

Get an email allow policy

client.EmailSecurity.Settings.AllowPolicies.Get(ctx, policyID, query) (*SettingAllowPolicyGetResponse, error)

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

Create email allow policy

client.EmailSecurity.Settings.AllowPolicies.New(ctx, params) (*SettingAllowPolicyNewResponse, error)

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

Update an email allow policy

client.EmailSecurity.Settings.AllowPolicies.Edit(ctx, policyID, params) (*SettingAllowPolicyEditResponse, error)

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

Delete an email allow policy

client.EmailSecurity.Settings.AllowPolicies.Delete(ctx, policyID, body) (*SettingAllowPolicyDeleteResponse, error)

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

SettingsBlock Senders

List blocked email senders

client.EmailSecurity.Settings.BlockSenders.List(ctx, params) (*V4PagePaginationArray[SettingBlockSenderListResponse], error)

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

Get a blocked email sender

client.EmailSecurity.Settings.BlockSenders.Get(ctx, patternID, query) (*SettingBlockSenderGetResponse, error)

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

Create blocked email sender

client.EmailSecurity.Settings.BlockSenders.New(ctx, params) (*SettingBlockSenderNewResponse, error)

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

Update a blocked email sender

client.EmailSecurity.Settings.BlockSenders.Edit(ctx, patternID, params) (*SettingBlockSenderEditResponse, error)

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

Delete a blocked email sender

client.EmailSecurity.Settings.BlockSenders.Delete(ctx, patternID, body) (*SettingBlockSenderDeleteResponse, error)

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

SettingsDomains

List protected email domains

client.EmailSecurity.Settings.Domains.List(ctx, params) (*V4PagePaginationArray[SettingDomainListResponse], error)

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

Get an email domain

client.EmailSecurity.Settings.Domains.Get(ctx, domainID, query) (*SettingDomainGetResponse, error)

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

Update an email domain

client.EmailSecurity.Settings.Domains.Edit(ctx, domainID, params) (*SettingDomainEditResponse, error)

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

Unprotect an email domain

client.EmailSecurity.Settings.Domains.Delete(ctx, domainID, body) (*SettingDomainDeleteResponse, error)

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

SettingsImpersonation Registry

List entries in impersonation registry

client.EmailSecurity.Settings.ImpersonationRegistry.List(ctx, params) (*V4PagePaginationArray[SettingImpersonationRegistryListResponse], error)

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

Get an impersonation registry entry

client.EmailSecurity.Settings.ImpersonationRegistry.Get(ctx, impersonationRegistryID, query) (*SettingImpersonationRegistryGetResponse, error)

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

Create impersonation registry entry

client.EmailSecurity.Settings.ImpersonationRegistry.New(ctx, params) (*SettingImpersonationRegistryNewResponse, error)

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

Update an impersonation registry entry

client.EmailSecurity.Settings.ImpersonationRegistry.Edit(ctx, impersonationRegistryID, params) (*SettingImpersonationRegistryEditResponse, error)

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

Delete an impersonation registry entry

client.EmailSecurity.Settings.ImpersonationRegistry.Delete(ctx, impersonationRegistryID, body) (*SettingImpersonationRegistryDeleteResponse, error)

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

SettingsSending Domain Restrictions

List sending domain restrictions

client.EmailSecurity.Settings.SendingDomainRestrictions.List(ctx, params) (*V4PagePaginationArray[SettingSendingDomainRestrictionListResponse], error)

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

Get a sending domain restriction

client.EmailSecurity.Settings.SendingDomainRestrictions.Get(ctx, sendingDomainRestrictionID, query) (*SettingSendingDomainRestrictionGetResponse, error)

GET/accounts/{account_id}/email-security/settings/sending_domain_restrictions/{sending_domain_restriction_id}

Create a sending domain restriction

client.EmailSecurity.Settings.SendingDomainRestrictions.New(ctx, params) (*SettingSendingDomainRestrictionNewResponse, error)

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

Update a sending domain restriction

client.EmailSecurity.Settings.SendingDomainRestrictions.Edit(ctx, sendingDomainRestrictionID, params) (*SettingSendingDomainRestrictionEditResponse, error)

PATCH/accounts/{account_id}/email-security/settings/sending_domain_restrictions/{sending_domain_restriction_id}

Delete a sending domain restriction

client.EmailSecurity.Settings.SendingDomainRestrictions.Delete(ctx, sendingDomainRestrictionID, body) (*SettingSendingDomainRestrictionDeleteResponse, error)

DELETE/accounts/{account_id}/email-security/settings/sending_domain_restrictions/{sending_domain_restriction_id}

SettingsTrusted Domains

List trusted email domains

client.EmailSecurity.Settings.TrustedDomains.List(ctx, params) (*V4PagePaginationArray[SettingTrustedDomainListResponse], error)

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

Get a trusted email domain

client.EmailSecurity.Settings.TrustedDomains.Get(ctx, trustedDomainID, query) (*SettingTrustedDomainGetResponse, error)

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

Create trusted email domain

client.EmailSecurity.Settings.TrustedDomains.New(ctx, params) (*SettingTrustedDomainNewResponse, error)

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

Update a trusted email domain

client.EmailSecurity.Settings.TrustedDomains.Edit(ctx, trustedDomainID, params) (*SettingTrustedDomainEditResponse, error)

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

Delete a trusted email domain

client.EmailSecurity.Settings.TrustedDomains.Delete(ctx, trustedDomainID, body) (*SettingTrustedDomainDeleteResponse, error)

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

SettingsURL Ignore Patterns

List URL ignore patterns

client.EmailSecurity.Settings.URLIgnorePatterns.List(ctx, params) (*V4PagePaginationArray[SettingURLIgnorePatternListResponse], error)

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

Get a URL ignore pattern

client.EmailSecurity.Settings.URLIgnorePatterns.Get(ctx, patternID, query) (*SettingURLIgnorePatternGetResponse, error)

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

Create a URL ignore pattern

client.EmailSecurity.Settings.URLIgnorePatterns.New(ctx, params) (*SettingURLIgnorePatternNewResponse, error)

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

Update a URL ignore pattern

client.EmailSecurity.Settings.URLIgnorePatterns.Edit(ctx, patternID, params) (*SettingURLIgnorePatternEditResponse, error)

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

Delete a URL ignore pattern

client.EmailSecurity.Settings.URLIgnorePatterns.Delete(ctx, patternID, body) (*SettingURLIgnorePatternDeleteResponse, error)

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