Email Security
Email SecurityInvestigate
Search email messages
GET/accounts/{account_id}/email-security/investigate
Get message details
GET/accounts/{account_id}/email-security/investigate/{postfix_id}
ModelsExpand Collapse
InvestigateListResponse object { id, action_log, client_recipients, 29 more }
InvestigateListResponse object { id, action_log, client_recipients, 29 more }
properties: object { allowlisted_pattern, allowlisted_pattern_type, blocklisted_message, 2 more }
properties: object { allowlisted_pattern, allowlisted_pattern_type, blocklisted_message, 2 more }
Deprecatedfindings: optional array of object { attachment, detail, detection, 6 more } Deprecated: use /investigate/{id}/detections instead.
Deprecatedfindings: optional array of object { attachment, detail, detection, 6 more }
Deprecated: use /investigate/{id}/detections instead.
post_delivery_operations: optional array of "PREVIEW" or "QUARANTINE_RELEASE" or "SUBMISSION" or "MOVE"
post_delivery_operations: optional array of "PREVIEW" or "QUARANTINE_RELEASE" or "SUBMISSION" or "MOVE"
InvestigateGetResponse object { id, action_log, client_recipients, 29 more }
InvestigateGetResponse object { id, action_log, client_recipients, 29 more }
properties: object { allowlisted_pattern, allowlisted_pattern_type, blocklisted_message, 2 more }
properties: object { allowlisted_pattern, allowlisted_pattern_type, blocklisted_message, 2 more }
Deprecatedfindings: optional array of object { attachment, detail, detection, 6 more } Deprecated: use /investigate/{id}/detections instead.
Deprecatedfindings: optional array of object { attachment, detail, detection, 6 more }
Deprecated: use /investigate/{id}/detections instead.
post_delivery_operations: optional array of "PREVIEW" or "QUARANTINE_RELEASE" or "SUBMISSION" or "MOVE"
post_delivery_operations: optional array of "PREVIEW" or "QUARANTINE_RELEASE" or "SUBMISSION" or "MOVE"
Email SecurityInvestigateDetections
Get message detection details
GET/accounts/{account_id}/email-security/investigate/{postfix_id}/detections
ModelsExpand Collapse
DetectionGetResponse object { action, attachments, findings, 6 more }
DetectionGetResponse object { action, attachments, findings, 6 more }
findings: array of object { attachment, detail, detection, 6 more }
findings: array of object { attachment, detail, detection, 6 more }
Email SecurityInvestigatePreview
Get email preview
GET/accounts/{account_id}/email-security/investigate/{postfix_id}/preview
Preview for non-detection messages
POST/accounts/{account_id}/email-security/investigate/preview
Email SecurityInvestigateRaw
Get raw email content
GET/accounts/{account_id}/email-security/investigate/{postfix_id}/raw
Email SecurityInvestigateTrace
Get email trace
GET/accounts/{account_id}/email-security/investigate/{postfix_id}/trace
Email SecurityInvestigateMove
Move a message
POST/accounts/{account_id}/email-security/investigate/{postfix_id}/move
Move multiple messages
POST/accounts/{account_id}/email-security/investigate/move
Email SecurityInvestigateReclassify
Change email classification
POST/accounts/{account_id}/email-security/investigate/{postfix_id}/reclassify
Email SecurityInvestigateRelease
Release messages from quarantine
POST/accounts/{account_id}/email-security/investigate/release
Email SecurityPhishguard
Email SecurityPhishguardReports
Get `PhishGuard` reports
GET/accounts/{account_id}/email-security/phishguard/reports
Email SecuritySettings
Email SecuritySettingsAllow Policies
List email allow policies
GET/accounts/{account_id}/email-security/settings/allow_policies
Get an email allow policy
GET/accounts/{account_id}/email-security/settings/allow_policies/{policy_id}
Create an email allow policy
POST/accounts/{account_id}/email-security/settings/allow_policies
Update an email allow policy
PATCH/accounts/{account_id}/email-security/settings/allow_policies/{policy_id}
Delete an email allow policy
DELETE/accounts/{account_id}/email-security/settings/allow_policies/{policy_id}
ModelsExpand Collapse
AllowPolicyListResponse object { id, created_at, is_acceptable_sender, 11 more }
AllowPolicyListResponse object { id, created_at, is_acceptable_sender, 11 more }
is_acceptable_sender: boolean
Messages from this sender will be exempted from Spam, Spoof and Bulk dispositions. Note: This will not exempt messages with Malicious or Suspicious dispositions.
AllowPolicyGetResponse object { id, created_at, is_acceptable_sender, 11 more }
AllowPolicyGetResponse object { id, created_at, is_acceptable_sender, 11 more }
is_acceptable_sender: boolean
Messages from this sender will be exempted from Spam, Spoof and Bulk dispositions. Note: This will not exempt messages with Malicious or Suspicious dispositions.
AllowPolicyCreateResponse object { id, created_at, is_acceptable_sender, 11 more }
AllowPolicyCreateResponse object { id, created_at, is_acceptable_sender, 11 more }
is_acceptable_sender: boolean
Messages from this sender will be exempted from Spam, Spoof and Bulk dispositions. Note: This will not exempt messages with Malicious or Suspicious dispositions.
AllowPolicyEditResponse object { id, created_at, is_acceptable_sender, 11 more }
AllowPolicyEditResponse object { id, created_at, is_acceptable_sender, 11 more }
is_acceptable_sender: boolean
Messages from this sender will be exempted from Spam, Spoof and Bulk dispositions. Note: This will not exempt messages with Malicious or Suspicious dispositions.
Email SecuritySettingsBlock Senders
List blocked email senders
GET/accounts/{account_id}/email-security/settings/block_senders
Get a blocked email sender
GET/accounts/{account_id}/email-security/settings/block_senders/{pattern_id}
Create a blocked email sender
POST/accounts/{account_id}/email-security/settings/block_senders
Update a blocked email sender
PATCH/accounts/{account_id}/email-security/settings/block_senders/{pattern_id}
Delete a blocked email sender
DELETE/accounts/{account_id}/email-security/settings/block_senders/{pattern_id}
ModelsExpand Collapse
Email SecuritySettingsDomains
List protected email domains
GET/accounts/{account_id}/email-security/settings/domains
Get an email domain
GET/accounts/{account_id}/email-security/settings/domains/{domain_id}
Update an email domain
PATCH/accounts/{account_id}/email-security/settings/domains/{domain_id}
Unprotect an email domain
DELETE/accounts/{account_id}/email-security/settings/domains/{domain_id}
Unprotect multiple email domains
DELETE/accounts/{account_id}/email-security/settings/domains
ModelsExpand Collapse
DomainListResponse object { id, allowed_delivery_modes, created_at, 17 more }
DomainListResponse object { id, allowed_delivery_modes, created_at, 17 more }
DomainGetResponse object { id, allowed_delivery_modes, created_at, 17 more }
DomainGetResponse object { id, allowed_delivery_modes, created_at, 17 more }
DomainEditResponse object { id, allowed_delivery_modes, created_at, 17 more }
DomainEditResponse object { id, allowed_delivery_modes, created_at, 17 more }
Email SecuritySettingsImpersonation Registry
List entries in impersonation registry
GET/accounts/{account_id}/email-security/settings/impersonation_registry
Get an entry in impersonation registry
GET/accounts/{account_id}/email-security/settings/impersonation_registry/{display_name_id}
Create an entry in impersonation registry
POST/accounts/{account_id}/email-security/settings/impersonation_registry
Update an entry in impersonation registry
PATCH/accounts/{account_id}/email-security/settings/impersonation_registry/{display_name_id}
Delete an entry from impersonation registry
DELETE/accounts/{account_id}/email-security/settings/impersonation_registry/{display_name_id}
ModelsExpand Collapse
Email SecuritySettingsTrusted Domains
List trusted email domains
GET/accounts/{account_id}/email-security/settings/trusted_domains
Get a trusted email domain
GET/accounts/{account_id}/email-security/settings/trusted_domains/{trusted_domain_id}
Create a trusted email domain
POST/accounts/{account_id}/email-security/settings/trusted_domains
Update a trusted email domain
PATCH/accounts/{account_id}/email-security/settings/trusted_domains/{trusted_domain_id}
Delete a trusted email domain
DELETE/accounts/{account_id}/email-security/settings/trusted_domains/{trusted_domain_id}
ModelsExpand Collapse
TrustedDomainListResponse object { id, created_at, is_recent, 5 more }
TrustedDomainListResponse object { id, created_at, is_recent, 5 more }
TrustedDomainGetResponse object { id, created_at, is_recent, 5 more }
TrustedDomainGetResponse object { id, created_at, is_recent, 5 more }
TrustedDomainCreateResponse = object { id, created_at, is_recent, 5 more } or array of object { id, created_at, is_recent, 5 more }
TrustedDomainCreateResponse = object { id, created_at, is_recent, 5 more } or array of object { id, created_at, is_recent, 5 more }
One of the following:
EmailSecurityTrustedDomain object { id, created_at, is_recent, 5 more }
EmailSecurityTrustedDomain object { id, created_at, is_recent, 5 more }
array of object { id, created_at, is_recent, 5 more }
array of object { id, created_at, is_recent, 5 more }
TrustedDomainEditResponse object { id, created_at, is_recent, 5 more }
TrustedDomainEditResponse object { id, created_at, is_recent, 5 more }
Email SecuritySubmissions
Get reclassify submissions
GET/accounts/{account_id}/email-security/submissions
ModelsExpand Collapse
SubmissionListResponse object { requested_ts, submission_id, customer_status, 15 more }
SubmissionListResponse object { requested_ts, submission_id, customer_status, 15 more }