LogoCloudflare API

Email Security

email_security

Email Security

Investigate

email_security.investigate

Methods

Search Email Messages -> V4PagePaginationArray<{ id, action_log, client_recipients, 21 more... }>
get/accounts/{account_id}/email-security/investigate

Returns information for each email that matches the search parameter(s).

Get Message Details -> Envelope<{ id, action_log, client_recipients, 21 more... }>
get/accounts/{account_id}/email-security/investigate/{postfix_id}

Get message details

Email SecurityInvestigate

Detections

email_security.investigate.detections

Methods

Get Message Detection Details -> Envelope<{ action, attachments, headers, 5 more... }>
get/accounts/{account_id}/email-security/investigate/{postfix_id}/detections

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

Email SecurityInvestigate

Move

email_security.investigate.move

Methods

Move A Message -> SinglePage<{ completed_timestamp, item_count, destination, 4 more... }>
post/accounts/{account_id}/email-security/investigate/{postfix_id}/move

Move a message

Move Multiple Messages -> SinglePage<{ completed_timestamp, item_count, destination, 4 more... }>
post/accounts/{account_id}/email-security/investigate/move

Move multiple messages

Email SecurityInvestigate

Preview

email_security.investigate.preview

Methods

Get Email Preview -> Envelope<{ screenshot }>
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.

Preview For Non Detection Messages -> Envelope<{ screenshot }>
post/accounts/{account_id}/email-security/investigate/preview

Preview for non-detection messages

Email SecurityInvestigate

Raw

email_security.investigate.raw

Methods

Get Raw Email Content -> Envelope<{ raw }>
get/accounts/{account_id}/email-security/investigate/{postfix_id}/raw

Returns the raw eml of any non-benign message.

Email SecurityInvestigate

Reclassify

email_security.investigate.reclassify

Methods

Change Email Classfication -> Envelope<unknown>
post/accounts/{account_id}/email-security/investigate/{postfix_id}/reclassify

Change email classfication

Email SecurityInvestigate

Release

email_security.investigate.release

Methods

Release Messages From Quarantine -> SinglePage<{ postfix_id, delivered, failed, 1 more... }>
post/accounts/{account_id}/email-security/investigate/release

Release messages from quarantine

Email SecurityInvestigate

Trace

email_security.investigate.trace

Methods

Get Email Trace -> Envelope<{ inbound, outbound }>
get/accounts/{account_id}/email-security/investigate/{postfix_id}/trace

Get email trace

Email Security

Settings

email_security.settings

Email SecuritySettings

Allow Policies

email_security.settings.allow_policies

Methods

List Email Allow Policies -> V4PagePaginationArray<{ id, created_at, is_acceptable_sender, 11 more... }>
get/accounts/{account_id}/email-security/settings/allow_policies

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

Get An Email Allow Policy -> Envelope<{ id, created_at, is_acceptable_sender, 11 more... }>
get/accounts/{account_id}/email-security/settings/allow_policies/{policy_id}

Get an email allow policy

Create An Email Allow Policy -> Envelope<{ id, created_at, is_acceptable_sender, 11 more... }>
post/accounts/{account_id}/email-security/settings/allow_policies

Create an email allow policy

Update An Email Allow Policy -> Envelope<{ id, created_at, is_acceptable_sender, 11 more... }>
patch/accounts/{account_id}/email-security/settings/allow_policies/{policy_id}

Update an email allow policy

Delete An Email Allow Policy -> Envelope<{ id }>
delete/accounts/{account_id}/email-security/settings/allow_policies/{policy_id}

Delete an email allow policy

Email SecuritySettings

Block Senders

email_security.settings.block_senders

Methods

List Blocked Email Senders -> V4PagePaginationArray<{ id, created_at, is_regex, 4 more... }>
get/accounts/{account_id}/email-security/settings/block_senders

List blocked email senders

Get A Blocked Email Sender -> Envelope<{ id, created_at, is_regex, 4 more... }>
get/accounts/{account_id}/email-security/settings/block_senders/{pattern_id}

Get a blocked email sender

Create A Blocked Email Sender -> Envelope<{ id, created_at, is_regex, 4 more... }>
post/accounts/{account_id}/email-security/settings/block_senders

Create a blocked email sender

Update A Blocked Email Sender -> Envelope<{ id, created_at, is_regex, 4 more... }>
patch/accounts/{account_id}/email-security/settings/block_senders/{pattern_id}

Update a blocked email sender

Delete A Blocked Email Sender -> Envelope<{ id }>
delete/accounts/{account_id}/email-security/settings/block_senders/{pattern_id}

Delete a blocked email sender

Email SecuritySettings

Domains

email_security.settings.domains

Methods

List Protected Email Domains -> V4PagePaginationArray<{ id, allowed_delivery_modes, created_at, 17 more... }>
get/accounts/{account_id}/email-security/settings/domains

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

Get An Email Domain -> Envelope<{ id, allowed_delivery_modes, created_at, 17 more... }>
get/accounts/{account_id}/email-security/settings/domains/{domain_id}

Get an email domain

Update An Email Domain -> Envelope<{ id, allowed_delivery_modes, created_at, 17 more... }>
patch/accounts/{account_id}/email-security/settings/domains/{domain_id}

Update an email domain

Unprotect An Email Domain -> Envelope<{ id }>
delete/accounts/{account_id}/email-security/settings/domains/{domain_id}

Unprotect an email domain

Unprotect Multiple Email Domains -> SinglePage<{ id }>
delete/accounts/{account_id}/email-security/settings/domains

Unprotect multiple email domains

Email SecuritySettings

Impersonation Registry

email_security.settings.impersonation_registry

Methods

List Entries In Impersonation Registry -> V4PagePaginationArray<{ id, created_at, email, 8 more... }>
get/accounts/{account_id}/email-security/settings/impersonation_registry

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

Get An Entry In Impersonation Registry -> Envelope<{ id, created_at, email, 8 more... }>
get/accounts/{account_id}/email-security/settings/impersonation_registry/{display_name_id}

Get an entry in impersonation registry

Create An Entry In Impersonation Registry -> Envelope<{ id, created_at, email, 8 more... }>
post/accounts/{account_id}/email-security/settings/impersonation_registry

Create an entry in impersonation registry

Update An Entry In Impersonation Registry -> Envelope<{ id, created_at, email, 8 more... }>
patch/accounts/{account_id}/email-security/settings/impersonation_registry/{display_name_id}

Update an entry in impersonation registry

Delete An Entry From Impersonation Registry -> Envelope<{ id }>
delete/accounts/{account_id}/email-security/settings/impersonation_registry/{display_name_id}

Delete an entry from impersonation registry

Email SecuritySettings

Trusted Domains

email_security.settings.trusted_domains

Methods

List Trusted Email Domains -> V4PagePaginationArray<{ id, created_at, is_recent, 5 more... }>
get/accounts/{account_id}/email-security/settings/trusted_domains

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

Get A Trusted Email Domain -> Envelope<{ id, created_at, is_recent, 5 more... }>
get/accounts/{account_id}/email-security/settings/trusted_domains/{trusted_domain_id}

Get a trusted email domain

Create A Trusted Email Domain -> Envelope<{ id, created_at, is_recent, 5 more... } | Array<{ id, created_at, is_recent, 5 more... }>>
post/accounts/{account_id}/email-security/settings/trusted_domains

Create a trusted email domain

Update A Trusted Email Domain -> Envelope<{ id, created_at, is_recent, 5 more... }>
patch/accounts/{account_id}/email-security/settings/trusted_domains/{trusted_domain_id}

Update a trusted email domain

Delete A Trusted Email Domain -> Envelope<{ id }>
delete/accounts/{account_id}/email-security/settings/trusted_domains/{trusted_domain_id}

Delete a trusted email domain

Email Security

Submissions

email_security.submissions

Methods

Get Reclassify Submissions -> V4PagePaginationArray<{ requested_ts, submission_id, original_disposition, 8 more... }>
get/accounts/{account_id}/email-security/submissions

This endpoint returns information for submissions to made to reclassify emails.