api.md

EmailSecurity

Investigate

Response Types:

• email_security.InvestigateListResponse
• email_security.InvestigateGetResponse

Methods:

• client.EmailSecurity.Investigate.List(ctx context.Context, params email_security.InvestigateListParams) (*pagination.V4PagePaginationArray[email_security.InvestigateListResponse], error)
• client.EmailSecurity.Investigate.Get(ctx context.Context, investigateID string, params email_security.InvestigateGetParams) (*email_security.InvestigateGetResponse, error)

Detections

Response Types:

• email_security.InvestigateDetectionGetResponse

Methods:

• client.EmailSecurity.Investigate.Detections.Get(ctx context.Context, investigateID string, query email_security.InvestigateDetectionGetParams) (*email_security.InvestigateDetectionGetResponse, error)

Preview

Response Types:

• email_security.InvestigatePreviewNewResponse
• email_security.InvestigatePreviewGetResponse

Methods:

• client.EmailSecurity.Investigate.Preview.New(ctx context.Context, params email_security.InvestigatePreviewNewParams) (*email_security.InvestigatePreviewNewResponse, error)
• client.EmailSecurity.Investigate.Preview.Get(ctx context.Context, investigateID string, query email_security.InvestigatePreviewGetParams) (*email_security.InvestigatePreviewGetResponse, error)

Raw

Response Types:

• email_security.InvestigateRawGetResponse

Methods:

• client.EmailSecurity.Investigate.Raw.Get(ctx context.Context, investigateID string, query email_security.InvestigateRawGetParams) (*email_security.InvestigateRawGetResponse, error)

Trace

Response Types:

• email_security.InvestigateTraceGetResponse

Methods:

• client.EmailSecurity.Investigate.Trace.Get(ctx context.Context, investigateID string, query email_security.InvestigateTraceGetParams) (*email_security.InvestigateTraceGetResponse, error)

Move

Response Types:

• email_security.InvestigateMoveNewResponse
• email_security.InvestigateMoveBulkResponse

Methods:

• client.EmailSecurity.Investigate.Move.New(ctx context.Context, investigateID string, params email_security.InvestigateMoveNewParams) (*pagination.SinglePage[email_security.InvestigateMoveNewResponse], error)
• client.EmailSecurity.Investigate.Move.Bulk(ctx context.Context, params email_security.InvestigateMoveBulkParams) (*pagination.SinglePage[email_security.InvestigateMoveBulkResponse], error)

Reclassify

Response Types:

• email_security.InvestigateReclassifyNewResponse

Methods:

• client.EmailSecurity.Investigate.Reclassify.New(ctx context.Context, investigateID string, params email_security.InvestigateReclassifyNewParams) (*email_security.InvestigateReclassifyNewResponse, error)

Release

Response Types:

• email_security.InvestigateReleaseBulkResponse

Methods:

• client.EmailSecurity.Investigate.Release.Bulk(ctx context.Context, params email_security.InvestigateReleaseBulkParams) (*pagination.SinglePage[email_security.InvestigateReleaseBulkResponse], error)

Bulk

Response Types:

• email_security.InvestigateBulkNewResponse
• email_security.InvestigateBulkListResponse
• email_security.InvestigateBulkDeleteResponse
• email_security.InvestigateBulkGetResponse

Methods:

• client.EmailSecurity.Investigate.Bulk.New(ctx context.Context, params email_security.InvestigateBulkNewParams) (*email_security.InvestigateBulkNewResponse, error)
• client.EmailSecurity.Investigate.Bulk.List(ctx context.Context, params email_security.InvestigateBulkListParams) (*pagination.V4PagePaginationArray[email_security.InvestigateBulkListResponse], error)
• client.EmailSecurity.Investigate.Bulk.Delete(ctx context.Context, jobID string, body email_security.InvestigateBulkDeleteParams) (*email_security.InvestigateBulkDeleteResponse, error)
• client.EmailSecurity.Investigate.Bulk.Get(ctx context.Context, jobID string, query email_security.InvestigateBulkGetParams) (*email_security.InvestigateBulkGetResponse, error)

Cancel

Response Types:

• email_security.InvestigateBulkCancelNewResponse

Methods:

• client.EmailSecurity.Investigate.Bulk.Cancel.New(ctx context.Context, jobID string, body email_security.InvestigateBulkCancelNewParams) (*email_security.InvestigateBulkCancelNewResponse, error)

Messages

Response Types:

• email_security.InvestigateBulkMessageListResponse

Methods:

• client.EmailSecurity.Investigate.Bulk.Messages.List(ctx context.Context, jobID string, params email_security.InvestigateBulkMessageListParams) (*pagination.V4PagePaginationArray[email_security.InvestigateBulkMessageListResponse], error)

Phishguard

Reports

Response Types:

• email_security.PhishguardReportListResponse

Methods:

• client.EmailSecurity.Phishguard.Reports.List(ctx context.Context, params email_security.PhishguardReportListParams) (*pagination.V4PagePaginationArray[email_security.PhishguardReportListResponse], error)

Settings

AllowPolicies

Response Types:

• email_security.SettingAllowPolicyNewResponse
• email_security.SettingAllowPolicyListResponse
• email_security.SettingAllowPolicyDeleteResponse
• email_security.SettingAllowPolicyBatchResponse
• email_security.SettingAllowPolicyEditResponse
• email_security.SettingAllowPolicyGetResponse

Methods:

• client.EmailSecurity.Settings.AllowPolicies.New(ctx context.Context, params email_security.SettingAllowPolicyNewParams) (*email_security.SettingAllowPolicyNewResponse, error)
• client.EmailSecurity.Settings.AllowPolicies.List(ctx context.Context, params email_security.SettingAllowPolicyListParams) (*pagination.V4PagePaginationArray[email_security.SettingAllowPolicyListResponse], error)
• client.EmailSecurity.Settings.AllowPolicies.Delete(ctx context.Context, policyID string, body email_security.SettingAllowPolicyDeleteParams) (*email_security.SettingAllowPolicyDeleteResponse, error)
• client.EmailSecurity.Settings.AllowPolicies.Batch(ctx context.Context, params email_security.SettingAllowPolicyBatchParams) (*email_security.SettingAllowPolicyBatchResponse, error)
• client.EmailSecurity.Settings.AllowPolicies.Edit(ctx context.Context, policyID string, params email_security.SettingAllowPolicyEditParams) (*email_security.SettingAllowPolicyEditResponse, error)
• client.EmailSecurity.Settings.AllowPolicies.Get(ctx context.Context, policyID string, query email_security.SettingAllowPolicyGetParams) (*email_security.SettingAllowPolicyGetResponse, error)

BlockSenders

Response Types:

• email_security.SettingBlockSenderNewResponse
• email_security.SettingBlockSenderListResponse
• email_security.SettingBlockSenderDeleteResponse
• email_security.SettingBlockSenderBatchResponse
• email_security.SettingBlockSenderEditResponse
• email_security.SettingBlockSenderGetResponse

Methods:

• client.EmailSecurity.Settings.BlockSenders.New(ctx context.Context, params email_security.SettingBlockSenderNewParams) (*email_security.SettingBlockSenderNewResponse, error)
• client.EmailSecurity.Settings.BlockSenders.List(ctx context.Context, params email_security.SettingBlockSenderListParams) (*pagination.V4PagePaginationArray[email_security.SettingBlockSenderListResponse], error)
• client.EmailSecurity.Settings.BlockSenders.Delete(ctx context.Context, patternID string, body email_security.SettingBlockSenderDeleteParams) (*email_security.SettingBlockSenderDeleteResponse, error)
• client.EmailSecurity.Settings.BlockSenders.Batch(ctx context.Context, params email_security.SettingBlockSenderBatchParams) (*email_security.SettingBlockSenderBatchResponse, error)
• client.EmailSecurity.Settings.BlockSenders.Edit(ctx context.Context, patternID string, params email_security.SettingBlockSenderEditParams) (*email_security.SettingBlockSenderEditResponse, error)
• client.EmailSecurity.Settings.BlockSenders.Get(ctx context.Context, patternID string, query email_security.SettingBlockSenderGetParams) (*email_security.SettingBlockSenderGetResponse, error)

ContentPolicies

Response Types:

• email_security.SettingContentPolicyNewResponse
• email_security.SettingContentPolicyListResponse
• email_security.SettingContentPolicyDeleteResponse
• email_security.SettingContentPolicyBatchResponse
• email_security.SettingContentPolicyEditResponse
• email_security.SettingContentPolicyGetResponse

Methods:

• client.EmailSecurity.Settings.ContentPolicies.New(ctx context.Context, params email_security.SettingContentPolicyNewParams) (*email_security.SettingContentPolicyNewResponse, error)
• client.EmailSecurity.Settings.ContentPolicies.List(ctx context.Context, params email_security.SettingContentPolicyListParams) (*pagination.V4PagePaginationArray[email_security.SettingContentPolicyListResponse], error)
• client.EmailSecurity.Settings.ContentPolicies.Delete(ctx context.Context, policyID string, body email_security.SettingContentPolicyDeleteParams) (*email_security.SettingContentPolicyDeleteResponse, error)
• client.EmailSecurity.Settings.ContentPolicies.Batch(ctx context.Context, params email_security.SettingContentPolicyBatchParams) (*email_security.SettingContentPolicyBatchResponse, error)
• client.EmailSecurity.Settings.ContentPolicies.Edit(ctx context.Context, policyID string, params email_security.SettingContentPolicyEditParams) (*email_security.SettingContentPolicyEditResponse, error)
• client.EmailSecurity.Settings.ContentPolicies.Get(ctx context.Context, policyID string, query email_security.SettingContentPolicyGetParams) (*email_security.SettingContentPolicyGetResponse, error)

Domains

Response Types:

• email_security.SettingDomainNewResponse
• email_security.SettingDomainUpdateResponse
• email_security.SettingDomainListResponse
• email_security.SettingDomainDeleteResponse
• email_security.SettingDomainBatchResponse
• email_security.SettingDomainBulkDeleteResponse
• email_security.SettingDomainEditResponse
• email_security.SettingDomainGetResponse

Methods:

• client.EmailSecurity.Settings.Domains.New(ctx context.Context, params email_security.SettingDomainNewParams) (*email_security.SettingDomainNewResponse, error)
• client.EmailSecurity.Settings.Domains.Update(ctx context.Context, domainID string, params email_security.SettingDomainUpdateParams) (*email_security.SettingDomainUpdateResponse, error)
• client.EmailSecurity.Settings.Domains.List(ctx context.Context, params email_security.SettingDomainListParams) (*pagination.V4PagePaginationArray[email_security.SettingDomainListResponse], error)
• client.EmailSecurity.Settings.Domains.Delete(ctx context.Context, domainID string, body email_security.SettingDomainDeleteParams) (*email_security.SettingDomainDeleteResponse, error)
• client.EmailSecurity.Settings.Domains.Batch(ctx context.Context, params email_security.SettingDomainBatchParams) (*email_security.SettingDomainBatchResponse, error)
• client.EmailSecurity.Settings.Domains.BulkDelete(ctx context.Context, body email_security.SettingDomainBulkDeleteParams) (*pagination.SinglePage[email_security.SettingDomainBulkDeleteResponse], error)
• client.EmailSecurity.Settings.Domains.Edit(ctx context.Context, domainID string, params email_security.SettingDomainEditParams) (*email_security.SettingDomainEditResponse, error)
• client.EmailSecurity.Settings.Domains.Get(ctx context.Context, domainID string, query email_security.SettingDomainGetParams) (*email_security.SettingDomainGetResponse, error)

ImpersonationRegistry

Response Types:

• email_security.SettingImpersonationRegistryNewResponse
• email_security.SettingImpersonationRegistryListResponse
• email_security.SettingImpersonationRegistryDeleteResponse
• email_security.SettingImpersonationRegistryEditResponse
• email_security.SettingImpersonationRegistryGetResponse

Methods:

• client.EmailSecurity.Settings.ImpersonationRegistry.New(ctx context.Context, params email_security.SettingImpersonationRegistryNewParams) (*email_security.SettingImpersonationRegistryNewResponse, error)
• client.EmailSecurity.Settings.ImpersonationRegistry.List(ctx context.Context, params email_security.SettingImpersonationRegistryListParams) (*pagination.V4PagePaginationArray[email_security.SettingImpersonationRegistryListResponse], error)
• client.EmailSecurity.Settings.ImpersonationRegistry.Delete(ctx context.Context, impersonationRegistryID string, body email_security.SettingImpersonationRegistryDeleteParams) (*email_security.SettingImpersonationRegistryDeleteResponse, error)
• client.EmailSecurity.Settings.ImpersonationRegistry.Edit(ctx context.Context, impersonationRegistryID string, params email_security.SettingImpersonationRegistryEditParams) (*email_security.SettingImpersonationRegistryEditResponse, error)
• client.EmailSecurity.Settings.ImpersonationRegistry.Get(ctx context.Context, impersonationRegistryID string, query email_security.SettingImpersonationRegistryGetParams) (*email_security.SettingImpersonationRegistryGetResponse, error)

SendingDomainRestrictions

Response Types:

• email_security.SettingSendingDomainRestrictionNewResponse
• email_security.SettingSendingDomainRestrictionListResponse
• email_security.SettingSendingDomainRestrictionDeleteResponse
• email_security.SettingSendingDomainRestrictionEditResponse
• email_security.SettingSendingDomainRestrictionGetResponse

Methods:

• client.EmailSecurity.Settings.SendingDomainRestrictions.New(ctx context.Context, params email_security.SettingSendingDomainRestrictionNewParams) (*email_security.SettingSendingDomainRestrictionNewResponse, error)
• client.EmailSecurity.Settings.SendingDomainRestrictions.List(ctx context.Context, params email_security.SettingSendingDomainRestrictionListParams) (*pagination.V4PagePaginationArray[email_security.SettingSendingDomainRestrictionListResponse], error)
• client.EmailSecurity.Settings.SendingDomainRestrictions.Delete(ctx context.Context, sendingDomainRestrictionID string, body email_security.SettingSendingDomainRestrictionDeleteParams) (*email_security.SettingSendingDomainRestrictionDeleteResponse, error)
• client.EmailSecurity.Settings.SendingDomainRestrictions.Edit(ctx context.Context, sendingDomainRestrictionID string, params email_security.SettingSendingDomainRestrictionEditParams) (*email_security.SettingSendingDomainRestrictionEditResponse, error)
• client.EmailSecurity.Settings.SendingDomainRestrictions.Get(ctx context.Context, sendingDomainRestrictionID string, query email_security.SettingSendingDomainRestrictionGetParams) (*email_security.SettingSendingDomainRestrictionGetResponse, error)

TrustedDomains

Response Types:

• email_security.SettingTrustedDomainNewResponse
• email_security.SettingTrustedDomainListResponse
• email_security.SettingTrustedDomainDeleteResponse
• email_security.SettingTrustedDomainBatchResponse
• email_security.SettingTrustedDomainEditResponse
• email_security.SettingTrustedDomainGetResponse

Methods:

• client.EmailSecurity.Settings.TrustedDomains.New(ctx context.Context, params email_security.SettingTrustedDomainNewParams) (*email_security.SettingTrustedDomainNewResponse, error)
• client.EmailSecurity.Settings.TrustedDomains.List(ctx context.Context, params email_security.SettingTrustedDomainListParams) (*pagination.V4PagePaginationArray[email_security.SettingTrustedDomainListResponse], error)
• client.EmailSecurity.Settings.TrustedDomains.Delete(ctx context.Context, trustedDomainID string, body email_security.SettingTrustedDomainDeleteParams) (*email_security.SettingTrustedDomainDeleteResponse, error)
• client.EmailSecurity.Settings.TrustedDomains.Batch(ctx context.Context, params email_security.SettingTrustedDomainBatchParams) (*email_security.SettingTrustedDomainBatchResponse, error)
• client.EmailSecurity.Settings.TrustedDomains.Edit(ctx context.Context, trustedDomainID string, params email_security.SettingTrustedDomainEditParams) (*email_security.SettingTrustedDomainEditResponse, error)
• client.EmailSecurity.Settings.TrustedDomains.Get(ctx context.Context, trustedDomainID string, query email_security.SettingTrustedDomainGetParams) (*email_security.SettingTrustedDomainGetResponse, error)

URLIgnorePatterns

Response Types:

• email_security.SettingURLIgnorePatternNewResponse
• email_security.SettingURLIgnorePatternListResponse
• email_security.SettingURLIgnorePatternDeleteResponse
• email_security.SettingURLIgnorePatternEditResponse
• email_security.SettingURLIgnorePatternGetResponse

Methods:

• client.EmailSecurity.Settings.URLIgnorePatterns.New(ctx context.Context, params email_security.SettingURLIgnorePatternNewParams) (*email_security.SettingURLIgnorePatternNewResponse, error)
• client.EmailSecurity.Settings.URLIgnorePatterns.List(ctx context.Context, params email_security.SettingURLIgnorePatternListParams) (*pagination.V4PagePaginationArray[email_security.SettingURLIgnorePatternListResponse], error)
• client.EmailSecurity.Settings.URLIgnorePatterns.Delete(ctx context.Context, patternID string, body email_security.SettingURLIgnorePatternDeleteParams) (*email_security.SettingURLIgnorePatternDeleteResponse, error)
• client.EmailSecurity.Settings.URLIgnorePatterns.Edit(ctx context.Context, patternID string, params email_security.SettingURLIgnorePatternEditParams) (*email_security.SettingURLIgnorePatternEditResponse, error)
• client.EmailSecurity.Settings.URLIgnorePatterns.Get(ctx context.Context, patternID string, query email_security.SettingURLIgnorePatternGetParams) (*email_security.SettingURLIgnorePatternGetResponse, error)

Submissions

Response Types:

• email_security.SubmissionListResponse

Methods:

• client.EmailSecurity.Submissions.List(ctx context.Context, params email_security.SubmissionListParams) (*pagination.V4PagePaginationArray[email_security.SubmissionListResponse], error)