Skip to content
Cloudflare API
Start here
API Reference

Email Security

Email SecurityInvestigate

Search email messages
client.EmailSecurity.Investigate.List(ctx, params) (*V4PagePaginationArray[InvestigateListResponse], error)
GET/accounts/{account_id}/email-security/investigate
Get message details
client.EmailSecurity.Investigate.Get(ctx, postfixID, query) (*InvestigateGetResponse, error)
GET/accounts/{account_id}/email-security/investigate/{postfix_id}

Email SecurityInvestigateDetections

Get message detection details
client.EmailSecurity.Investigate.Detections.Get(ctx, postfixID, query) (*InvestigateDetectionGetResponse, error)
GET/accounts/{account_id}/email-security/investigate/{postfix_id}/detections

Email SecurityInvestigatePreview

Get email preview
client.EmailSecurity.Investigate.Preview.Get(ctx, postfixID, query) (*InvestigatePreviewGetResponse, error)
GET/accounts/{account_id}/email-security/investigate/{postfix_id}/preview
Preview for non-detection messages
client.EmailSecurity.Investigate.Preview.New(ctx, params) (*InvestigatePreviewNewResponse, error)
POST/accounts/{account_id}/email-security/investigate/preview

Email SecurityInvestigateRaw

Get raw email content
client.EmailSecurity.Investigate.Raw.Get(ctx, postfixID, query) (*InvestigateRawGetResponse, error)
GET/accounts/{account_id}/email-security/investigate/{postfix_id}/raw

Email SecurityInvestigateTrace

Get email trace
client.EmailSecurity.Investigate.Trace.Get(ctx, postfixID, query) (*InvestigateTraceGetResponse, error)
GET/accounts/{account_id}/email-security/investigate/{postfix_id}/trace

Email SecurityInvestigateMove

Move a message
client.EmailSecurity.Investigate.Move.New(ctx, postfixID, params) (*SinglePage[InvestigateMoveNewResponse], error)
POST/accounts/{account_id}/email-security/investigate/{postfix_id}/move
Move multiple messages
client.EmailSecurity.Investigate.Move.Bulk(ctx, params) (*SinglePage[InvestigateMoveBulkResponse], error)
POST/accounts/{account_id}/email-security/investigate/move

Email SecurityInvestigateReclassify

Change email classification
client.EmailSecurity.Investigate.Reclassify.New(ctx, postfixID, params) (*InvestigateReclassifyNewResponse, error)
POST/accounts/{account_id}/email-security/investigate/{postfix_id}/reclassify

Email SecurityInvestigateRelease

Release messages from quarantine
client.EmailSecurity.Investigate.Release.Bulk(ctx, params) (*SinglePage[InvestigateReleaseBulkResponse], error)
POST/accounts/{account_id}/email-security/investigate/release

Email SecurityPhishguard

Email SecurityPhishguardReports

Get `PhishGuard` reports
client.EmailSecurity.Phishguard.Reports.List(ctx, params) (*SinglePage[PhishguardReportListResponse], error)
GET/accounts/{account_id}/email-security/phishguard/reports

Email SecuritySettings

Email SecuritySettingsAllow 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 an 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}

Email SecuritySettingsBlock 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 a 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}

Email SecuritySettingsDomains

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}
Unprotect multiple email domains
client.EmailSecurity.Settings.Domains.BulkDelete(ctx, body) (*SinglePage[SettingDomainBulkDeleteResponse], error)
DELETE/accounts/{account_id}/email-security/settings/domains

Email SecuritySettingsImpersonation 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 entry in impersonation registry
client.EmailSecurity.Settings.ImpersonationRegistry.Get(ctx, displayNameID, query) (*SettingImpersonationRegistryGetResponse, error)
GET/accounts/{account_id}/email-security/settings/impersonation_registry/{display_name_id}
Create an entry in impersonation registry
client.EmailSecurity.Settings.ImpersonationRegistry.New(ctx, params) (*SettingImpersonationRegistryNewResponse, error)
POST/accounts/{account_id}/email-security/settings/impersonation_registry
Update an entry in impersonation registry
client.EmailSecurity.Settings.ImpersonationRegistry.Edit(ctx, displayNameID, params) (*SettingImpersonationRegistryEditResponse, error)
PATCH/accounts/{account_id}/email-security/settings/impersonation_registry/{display_name_id}
Delete an entry from impersonation registry
client.EmailSecurity.Settings.ImpersonationRegistry.Delete(ctx, displayNameID, body) (*SettingImpersonationRegistryDeleteResponse, error)
DELETE/accounts/{account_id}/email-security/settings/impersonation_registry/{display_name_id}

Email SecuritySettingsTrusted 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 a trusted email domain
client.EmailSecurity.Settings.TrustedDomains.New(ctx, params) (*SettingTrustedDomainNewResponseUnion, 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}

Email SecuritySubmissions

Get reclassify submissions
client.EmailSecurity.Submissions.List(ctx, params) (*V4PagePaginationArray[SubmissionListResponse], error)
GET/accounts/{account_id}/email-security/submissions