Email Security

email_security

Email Security

Investigate

email_security.investigate

Methods

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

Returns information for each email that matches the search parameter(s). If the search takes too long, the endpoint returns 202 with a Location header pointing to a polling endpoint where results can be retrieved once ready.

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

Retrieves detailed information about a specific email message, including headers, metadata, and security scan results.

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_security.investigate.move

Methods

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

Moves a single email message to a different folder or changes its quarantine status.

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

Maximum batch size: 1000 messages per request

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

Generates a preview of an email message for safe viewing without executing any embedded content.

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_security.investigate.reclassify

Methods

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

Submits an email message for reclassification, updating its threat assessment based on new analysis.

email_security.investigate.release

Methods

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

Releases a quarantined email message, allowing it to be delivered to the recipient.

email_security.investigate.trace

Methods

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

Gets the delivery trace for an email message, showing its path through email security processing.

Email Security

Phishguard

email_security.phishguard

email_security.phishguard.reports

Methods

Get Phish Guard Reports -> SinglePage<{ id, content, created_at, 7 more... }>
get/accounts/{account_id}/email-security/phishguard/reports

Retrieves PhishGuard reports showing phishing attempts and suspicious email patterns detected.

email_security.settings

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}

Retrieves details for a specific email allow policy, including its matching criteria and scope.

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

Creates a new email allow policy that permits specific senders, domains, or patterns to bypass security scanning.

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}

Updates an existing email allow policy, modifying its matching criteria or scope.

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

Removes an email allow policy. Previously allowed senders will be subject to normal security scanning.

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

Lists all blocked sender entries with their patterns and block reasons.

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

Gets information about a specific blocked sender entry, including the pattern and block reason.

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

Adds a sender pattern to the email block list, preventing messages from matching senders from being delivered.

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

Modifies a blocked sender entry, updating its pattern or block reason.

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

Removes a sender from the email block list, allowing their messages to be delivered normally.

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}

Gets configuration details for a specific domain in email security.

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

Updates configuration for a domain in email security.

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

Bulk removes multiple domains from email security configuration in a single request.

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}

Retrieves a display name entry used for impersonation protection.

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

Creates a display name entry for email security impersonation protection.

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}

Updates a display name entry used for impersonation protection.

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

Removes a display name from impersonation protection monitoring.

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}

Gets information about a specific trusted domain entry.

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

Adds a domain to the trusted domains list for email security, reducing false positive detections.

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}

Modifies a trusted domain entry's configuration.

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

Removes a domain from the trusted domains list, subjecting it to normal security scanning.

Email Security

Submissions

email_security.submissions

Methods

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

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