api.md

EmailSecurity

Investigate

Types:

• InvestigateListResponse
• InvestigateGetResponse

Methods:

• client.emailSecurity.investigate.list({ ...params }) -> InvestigateListResponsesV4PagePaginationArray
• client.emailSecurity.investigate.get(investigateId, { ...params }) -> InvestigateGetResponse

Detections

Types:

• DetectionGetResponse

Methods:

• client.emailSecurity.investigate.detections.get(investigateId, { ...params }) -> DetectionGetResponse

Preview

Types:

• PreviewCreateResponse
• PreviewGetResponse

Methods:

• client.emailSecurity.investigate.preview.create({ ...params }) -> PreviewCreateResponse
• client.emailSecurity.investigate.preview.get(investigateId, { ...params }) -> PreviewGetResponse

Raw

Types:

• RawGetResponse

Methods:

• client.emailSecurity.investigate.raw.get(investigateId, { ...params }) -> RawGetResponse

Trace

Types:

• TraceGetResponse

Methods:

• client.emailSecurity.investigate.trace.get(investigateId, { ...params }) -> TraceGetResponse

Move

Types:

• MoveCreateResponse
• MoveBulkResponse

Methods:

• client.emailSecurity.investigate.move.create(investigateId, { ...params }) -> MoveCreateResponsesSinglePage
• client.emailSecurity.investigate.move.bulk({ ...params }) -> MoveBulkResponsesSinglePage

Reclassify

Types:

• ReclassifyCreateResponse

Methods:

• client.emailSecurity.investigate.reclassify.create(investigateId, { ...params }) -> ReclassifyCreateResponse

Release

Types:

• ReleaseBulkResponse

Methods:

• client.emailSecurity.investigate.release.bulk([ ...body ]) -> ReleaseBulkResponsesSinglePage

Phishguard

Reports

Types:

• ReportListResponse

Methods:

• client.emailSecurity.phishguard.reports.list({ ...params }) -> ReportListResponsesSinglePage

Settings

AllowPolicies

Types:

• AllowPolicyCreateResponse
• AllowPolicyListResponse
• AllowPolicyDeleteResponse
• AllowPolicyEditResponse
• AllowPolicyGetResponse

Methods:

• client.emailSecurity.settings.allowPolicies.create({ ...params }) -> AllowPolicyCreateResponse
• client.emailSecurity.settings.allowPolicies.list({ ...params }) -> AllowPolicyListResponsesV4PagePaginationArray
• client.emailSecurity.settings.allowPolicies.delete(policyId, { ...params }) -> AllowPolicyDeleteResponse
• client.emailSecurity.settings.allowPolicies.edit(policyId, { ...params }) -> AllowPolicyEditResponse
• client.emailSecurity.settings.allowPolicies.get(policyId, { ...params }) -> AllowPolicyGetResponse

BlockSenders

Types:

• BlockSenderCreateResponse
• BlockSenderListResponse
• BlockSenderDeleteResponse
• BlockSenderEditResponse
• BlockSenderGetResponse

Methods:

• client.emailSecurity.settings.blockSenders.create({ ...params }) -> BlockSenderCreateResponse
• client.emailSecurity.settings.blockSenders.list({ ...params }) -> BlockSenderListResponsesV4PagePaginationArray
• client.emailSecurity.settings.blockSenders.delete(patternId, { ...params }) -> BlockSenderDeleteResponse
• client.emailSecurity.settings.blockSenders.edit(patternId, { ...params }) -> BlockSenderEditResponse
• client.emailSecurity.settings.blockSenders.get(patternId, { ...params }) -> BlockSenderGetResponse

Domains

Types:

• DomainListResponse
• DomainDeleteResponse
• DomainEditResponse
• DomainGetResponse

Methods:

• client.emailSecurity.settings.domains.list({ ...params }) -> DomainListResponsesV4PagePaginationArray
• client.emailSecurity.settings.domains.delete(domainId, { ...params }) -> DomainDeleteResponse
• client.emailSecurity.settings.domains.edit(domainId, { ...params }) -> DomainEditResponse
• client.emailSecurity.settings.domains.get(domainId, { ...params }) -> DomainGetResponse

ImpersonationRegistry

Types:

• ImpersonationRegistryCreateResponse
• ImpersonationRegistryListResponse
• ImpersonationRegistryDeleteResponse
• ImpersonationRegistryEditResponse
• ImpersonationRegistryGetResponse

Methods:

• client.emailSecurity.settings.impersonationRegistry.create({ ...params }) -> ImpersonationRegistryCreateResponse
• client.emailSecurity.settings.impersonationRegistry.list({ ...params }) -> ImpersonationRegistryListResponsesV4PagePaginationArray
• client.emailSecurity.settings.impersonationRegistry.delete(impersonationRegistryId, { ...params }) -> ImpersonationRegistryDeleteResponse
• client.emailSecurity.settings.impersonationRegistry.edit(impersonationRegistryId, { ...params }) -> ImpersonationRegistryEditResponse
• client.emailSecurity.settings.impersonationRegistry.get(impersonationRegistryId, { ...params }) -> ImpersonationRegistryGetResponse

SendingDomainRestrictions

Types:

• SendingDomainRestrictionCreateResponse
• SendingDomainRestrictionListResponse
• SendingDomainRestrictionDeleteResponse
• SendingDomainRestrictionEditResponse
• SendingDomainRestrictionGetResponse

Methods:

• client.emailSecurity.settings.sendingDomainRestrictions.create({ ...params }) -> SendingDomainRestrictionCreateResponse
• client.emailSecurity.settings.sendingDomainRestrictions.list({ ...params }) -> SendingDomainRestrictionListResponsesV4PagePaginationArray
• client.emailSecurity.settings.sendingDomainRestrictions.delete(sendingDomainRestrictionId, { ...params }) -> SendingDomainRestrictionDeleteResponse
• client.emailSecurity.settings.sendingDomainRestrictions.edit(sendingDomainRestrictionId, { ...params }) -> SendingDomainRestrictionEditResponse
• client.emailSecurity.settings.sendingDomainRestrictions.get(sendingDomainRestrictionId, { ...params }) -> SendingDomainRestrictionGetResponse

TrustedDomains

Types:

• TrustedDomainCreateResponse
• TrustedDomainListResponse
• TrustedDomainDeleteResponse
• TrustedDomainEditResponse
• TrustedDomainGetResponse

Methods:

• client.emailSecurity.settings.trustedDomains.create({ ...params }) -> TrustedDomainCreateResponse
• client.emailSecurity.settings.trustedDomains.list({ ...params }) -> TrustedDomainListResponsesV4PagePaginationArray
• client.emailSecurity.settings.trustedDomains.delete(trustedDomainId, { ...params }) -> TrustedDomainDeleteResponse
• client.emailSecurity.settings.trustedDomains.edit(trustedDomainId, { ...params }) -> TrustedDomainEditResponse
• client.emailSecurity.settings.trustedDomains.get(trustedDomainId, { ...params }) -> TrustedDomainGetResponse

URLIgnorePatterns

Types:

• URLIgnorePatternCreateResponse
• URLIgnorePatternListResponse
• URLIgnorePatternDeleteResponse
• URLIgnorePatternEditResponse
• URLIgnorePatternGetResponse

Methods:

• client.emailSecurity.settings.urlIgnorePatterns.create({ ...params }) -> URLIgnorePatternCreateResponse
• client.emailSecurity.settings.urlIgnorePatterns.list({ ...params }) -> URLIgnorePatternListResponsesV4PagePaginationArray
• client.emailSecurity.settings.urlIgnorePatterns.delete(patternId, { ...params }) -> URLIgnorePatternDeleteResponse
• client.emailSecurity.settings.urlIgnorePatterns.edit(patternId, { ...params }) -> URLIgnorePatternEditResponse
• client.emailSecurity.settings.urlIgnorePatterns.get(patternId, { ...params }) -> URLIgnorePatternGetResponse

Submissions

Types:

• SubmissionListResponse

Methods:

• client.emailSecurity.submissions.list({ ...params }) -> SubmissionListResponsesV4PagePaginationArray