Cloudflare API | Email Security

Detections

EmailSecurity.Investigate.Detections

Methods

client.emailSecurity.investigate.detections.get(, , ):

DetectionGetResponse

get/accounts/{account_id}/email-security/investigate/{postfix_id}/detections

Returns detection details such as threat categories and sender information for non-benign messages.

Move

EmailSecurity.Investigate.Move

Methods

client.emailSecurity.investigate.move.create(, , ):

MoveCreateResponse

post/accounts/{account_id}/email-security/investigate/{postfix_id}/move

Move a message

client.emailSecurity.investigate.move.bulk(, ):

MoveBulkResponse

post/accounts/{account_id}/email-security/investigate/move

Move multiple messages

Preview

EmailSecurity.Investigate.Preview

Methods

client.emailSecurity.investigate.preview.get(, , ):

PreviewGetResponse

get/accounts/{account_id}/email-security/investigate/{postfix_id}/preview

Returns a preview of the message body as a base64 encoded PNG image for non-benign messages.

client.emailSecurity.investigate.preview.create(, ):

PreviewCreateResponse

post/accounts/{account_id}/email-security/investigate/preview

Preview for non-detection messages

Raw

EmailSecurity.Investigate.Raw

Methods

client.emailSecurity.investigate.raw.get(, , ):

RawGetResponse

get/accounts/{account_id}/email-security/investigate/{postfix_id}/raw

Returns the raw eml of any non-benign message.

Reclassify

EmailSecurity.Investigate.Reclassify

Methods

client.emailSecurity.investigate.reclassify.create(, , ):

ReclassifyCreateResponse

post/accounts/{account_id}/email-security/investigate/{postfix_id}/reclassify

Change email classfication

Release

EmailSecurity.Investigate.Release

Methods

client.emailSecurity.investigate.release.bulk(, ):

ReleaseBulkResponse

post/accounts/{account_id}/email-security/investigate/release

Release messages from quarantine

Trace

EmailSecurity.Investigate.Trace

Methods

client.emailSecurity.investigate.trace.get(, , ):

TraceGetResponse

get/accounts/{account_id}/email-security/investigate/{postfix_id}/trace

Get email trace

Email Security

Settings

EmailSecurity.Settings

Allow Policies

EmailSecurity.Settings.AllowPolicies

Methods

client.emailSecurity.settings.allowPolicies.list(, ):

AllowPolicyCreateResponse

AllowPolicyListResponse

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

Lists, searches, and sorts an account’s email allow policies.

client.emailSecurity.settings.allowPolicies.get(, , ):

AllowPolicyGetResponse

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

Get an email allow policy

client.emailSecurity.settings.allowPolicies.create(, ):

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

Create an email allow policy

client.emailSecurity.settings.allowPolicies.edit(, , ):

AllowPolicyEditResponse

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

Update an email allow policy

client.emailSecurity.settings.allowPolicies.delete(, , ):

AllowPolicyDeleteResponse

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

Delete an email allow policy

Block Senders

EmailSecurity.Settings.BlockSenders

Methods

client.emailSecurity.settings.blockSenders.list(, ):

BlockSenderCreateResponse

BlockSenderListResponse

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

List blocked email senders

client.emailSecurity.settings.blockSenders.get(, , ):

BlockSenderGetResponse

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

Get a blocked email sender

client.emailSecurity.settings.blockSenders.create(, ):

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

Create a blocked email sender

client.emailSecurity.settings.blockSenders.edit(, , ):

BlockSenderEditResponse

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

Update a blocked email sender

client.emailSecurity.settings.blockSenders.delete(, , ):

BlockSenderDeleteResponse

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

Delete a blocked email sender

Domains

EmailSecurity.Settings.Domains

Methods

client.emailSecurity.settings.domains.list(, ):

DomainListResponse

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

Lists, searches, and sorts an account’s email domains.

client.emailSecurity.settings.domains.get(, , ):

DomainGetResponse

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

Get an email domain

client.emailSecurity.settings.domains.edit(, , ):

DomainEditResponse

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

Update an email domain

client.emailSecurity.settings.domains.delete(, , ):

DomainDeleteResponse

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

Unprotect an email domain

client.emailSecurity.settings.domains.bulkDelete(, ):

DomainBulkDeleteResponse

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

Unprotect multiple email domains

Impersonation Registry

EmailSecurity.Settings.ImpersonationRegistry

Methods

client.emailSecurity.settings.impersonationRegistry.list(, ):

ImpersonationRegistryListResponse

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

Lists, searches, and sorts entries in the impersonation registry.

client.emailSecurity.settings.impersonationRegistry.get(, , ):

ImpersonationRegistryGetResponse

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

Get an entry in impersonation registry

client.emailSecurity.settings.impersonationRegistry.create(, ):

ImpersonationRegistryCreateResponse

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

Create an entry in impersonation registry

client.emailSecurity.settings.impersonationRegistry.edit(, , ):

ImpersonationRegistryEditResponse

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

Update an entry in impersonation registry

client.emailSecurity.settings.impersonationRegistry.delete(, , ):

ImpersonationRegistryDeleteResponse

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

Delete an entry from impersonation registry

Trusted Domains

EmailSecurity.Settings.TrustedDomains

Methods

client.emailSecurity.settings.trustedDomains.list(, ):

TrustedDomainListResponse

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

Lists, searches, and sorts an account’s trusted email domains.

client.emailSecurity.settings.trustedDomains.get(, , ):

TrustedDomainGetResponse

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

Get a trusted email domain

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

TrustedDomainCreateResponse

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

Create a trusted email domain

client.emailSecurity.settings.trustedDomains.edit(, , ):

TrustedDomainEditResponse

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

Update a trusted email domain

client.emailSecurity.settings.trustedDomains.delete(, , ):

TrustedDomainDeleteResponse

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

Delete a trusted email domain

Email Security

Submissions

EmailSecurity.Submissions

Methods

client.emailSecurity.submissions.list(, ):