email_security

package
v5.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 14, 2025 License: Apache-2.0 Imports: 16 Imported by: 0

Documentation

Index

Constants

View Source
const AuditLogActorTypeAdmin = shared.AuditLogActorTypeAdmin

This is an alias to an internal value.

View Source
const AuditLogActorTypeCloudflare = shared.AuditLogActorTypeCloudflare

This is an alias to an internal value.

View Source
const AuditLogActorTypeUser = shared.AuditLogActorTypeUser

This is an alias to an internal value.

View Source
const CertificateCADigicert = shared.CertificateCADigicert

This is an alias to an internal value.

View Source
const CertificateCAGoogle = shared.CertificateCAGoogle

This is an alias to an internal value.

View Source
const CertificateCALetsEncrypt = shared.CertificateCALetsEncrypt

This is an alias to an internal value.

View Source
const CertificateCASSLCom = shared.CertificateCASSLCom

This is an alias to an internal value.

View Source
const CertificateRequestTypeKeylessCertificate = shared.CertificateRequestTypeKeylessCertificate

This is an alias to an internal value.

View Source
const CertificateRequestTypeOriginECC = shared.CertificateRequestTypeOriginECC

This is an alias to an internal value.

View Source
const CertificateRequestTypeOriginRSA = shared.CertificateRequestTypeOriginRSA

This is an alias to an internal value.

View Source
const CloudflareTunnelConfigSrcCloudflare = shared.CloudflareTunnelConfigSrcCloudflare

This is an alias to an internal value.

View Source
const CloudflareTunnelConfigSrcLocal = shared.CloudflareTunnelConfigSrcLocal

This is an alias to an internal value.

View Source
const CloudflareTunnelStatusDegraded = shared.CloudflareTunnelStatusDegraded

This is an alias to an internal value.

View Source
const CloudflareTunnelStatusDown = shared.CloudflareTunnelStatusDown

This is an alias to an internal value.

View Source
const CloudflareTunnelStatusHealthy = shared.CloudflareTunnelStatusHealthy

This is an alias to an internal value.

View Source
const CloudflareTunnelStatusInactive = shared.CloudflareTunnelStatusInactive

This is an alias to an internal value.

View Source
const CloudflareTunnelTunTypeCNI = shared.CloudflareTunnelTunTypeCNI

This is an alias to an internal value.

View Source
const CloudflareTunnelTunTypeCfdTunnel = shared.CloudflareTunnelTunTypeCfdTunnel

This is an alias to an internal value.

View Source
const CloudflareTunnelTunTypeGRE = shared.CloudflareTunnelTunTypeGRE

This is an alias to an internal value.

View Source
const CloudflareTunnelTunTypeIPSec = shared.CloudflareTunnelTunTypeIPSec

This is an alias to an internal value.

View Source
const CloudflareTunnelTunTypeMagic = shared.CloudflareTunnelTunTypeMagic

This is an alias to an internal value.

View Source
const CloudflareTunnelTunTypeWARP = shared.CloudflareTunnelTunTypeWARP

This is an alias to an internal value.

View Source
const CloudflareTunnelTunTypeWARPConnector = shared.CloudflareTunnelTunTypeWARPConnector

This is an alias to an internal value.

View Source
const MemberPoliciesAccessAllow = shared.MemberPoliciesAccessAllow

This is an alias to an internal value.

View Source
const MemberPoliciesAccessDeny = shared.MemberPoliciesAccessDeny

This is an alias to an internal value.

View Source
const MemberStatusAccepted = shared.MemberStatusAccepted

This is an alias to an internal value.

View Source
const MemberStatusPending = shared.MemberStatusPending

This is an alias to an internal value.

View Source
const RatePlanIDBusiness = shared.RatePlanIDBusiness

This is an alias to an internal value.

View Source
const RatePlanIDEnterprise = shared.RatePlanIDEnterprise

This is an alias to an internal value.

View Source
const RatePlanIDFree = shared.RatePlanIDFree

This is an alias to an internal value.

View Source
const RatePlanIDLite = shared.RatePlanIDLite

This is an alias to an internal value.

View Source
const RatePlanIDPartnersBusiness = shared.RatePlanIDPartnersBusiness

This is an alias to an internal value.

View Source
const RatePlanIDPartnersEnterprise = shared.RatePlanIDPartnersEnterprise

This is an alias to an internal value.

View Source
const RatePlanIDPartnersFree = shared.RatePlanIDPartnersFree

This is an alias to an internal value.

View Source
const RatePlanIDPartnersPro = shared.RatePlanIDPartnersPro

This is an alias to an internal value.

View Source
const RatePlanIDPro = shared.RatePlanIDPro

This is an alias to an internal value.

View Source
const RatePlanIDProPlus = shared.RatePlanIDProPlus

This is an alias to an internal value.

View Source
const SortDirectionAsc = shared.SortDirectionAsc

This is an alias to an internal value.

View Source
const SortDirectionDesc = shared.SortDirectionDesc

This is an alias to an internal value.

View Source
const SubscriptionFrequencyMonthly = shared.SubscriptionFrequencyMonthly

This is an alias to an internal value.

View Source
const SubscriptionFrequencyQuarterly = shared.SubscriptionFrequencyQuarterly

This is an alias to an internal value.

View Source
const SubscriptionFrequencyWeekly = shared.SubscriptionFrequencyWeekly

This is an alias to an internal value.

View Source
const SubscriptionFrequencyYearly = shared.SubscriptionFrequencyYearly

This is an alias to an internal value.

View Source
const SubscriptionStateAwaitingPayment = shared.SubscriptionStateAwaitingPayment

This is an alias to an internal value.

View Source
const SubscriptionStateCancelled = shared.SubscriptionStateCancelled

This is an alias to an internal value.

View Source
const SubscriptionStateExpired = shared.SubscriptionStateExpired

This is an alias to an internal value.

View Source
const SubscriptionStateFailed = shared.SubscriptionStateFailed

This is an alias to an internal value.

View Source
const SubscriptionStatePaid = shared.SubscriptionStatePaid

This is an alias to an internal value.

View Source
const SubscriptionStateProvisioned = shared.SubscriptionStateProvisioned

This is an alias to an internal value.

View Source
const SubscriptionStateTrial = shared.SubscriptionStateTrial

This is an alias to an internal value.

View Source
const TokenPolicyEffectAllow = shared.TokenPolicyEffectAllow

This is an alias to an internal value.

View Source
const TokenPolicyEffectDeny = shared.TokenPolicyEffectDeny

This is an alias to an internal value.

View Source
const TokenStatusActive = shared.TokenStatusActive

This is an alias to an internal value.

View Source
const TokenStatusDisabled = shared.TokenStatusDisabled

This is an alias to an internal value.

View Source
const TokenStatusExpired = shared.TokenStatusExpired

This is an alias to an internal value.

Variables

This section is empty.

Functions

This section is empty.

Types

type ASN

type ASN = shared.ASN

This is an alias to an internal type.

type ASNParam

type ASNParam = shared.ASNParam

This is an alias to an internal type.

type AuditLog

type AuditLog = shared.AuditLog

This is an alias to an internal type.

type AuditLogAction

type AuditLogAction = shared.AuditLogAction

This is an alias to an internal type.

type AuditLogActor

type AuditLogActor = shared.AuditLogActor

This is an alias to an internal type.

type AuditLogActorType

type AuditLogActorType = shared.AuditLogActorType

The type of actor, whether a User, Cloudflare Admin, or an Automated System.

This is an alias to an internal type.

type AuditLogOwner

type AuditLogOwner = shared.AuditLogOwner

This is an alias to an internal type.

type AuditLogResource

type AuditLogResource = shared.AuditLogResource

This is an alias to an internal type.

type CertificateCA

type CertificateCA = shared.CertificateCA

The Certificate Authority that will issue the certificate

This is an alias to an internal type.

type CertificateRequestType

type CertificateRequestType = shared.CertificateRequestType

Signature type desired on certificate ("origin-rsa" (rsa), "origin-ecc" (ecdsa), or "keyless-certificate" (for Keyless SSL servers).

This is an alias to an internal type.

type CloudflareTunnel

type CloudflareTunnel = shared.CloudflareTunnel

A Cloudflare Tunnel that connects your origin to Cloudflare's edge.

This is an alias to an internal type.

type CloudflareTunnelConfigSrc added in v5.1.0

type CloudflareTunnelConfigSrc = shared.CloudflareTunnelConfigSrc

Indicates if this is a locally or remotely configured tunnel. If `local`, manage the tunnel using a YAML file on the origin machine. If `cloudflare`, manage the tunnel on the Zero Trust dashboard.

This is an alias to an internal type.

type CloudflareTunnelConnection

type CloudflareTunnelConnection = shared.CloudflareTunnelConnection

This is an alias to an internal type.

type CloudflareTunnelStatus

type CloudflareTunnelStatus = shared.CloudflareTunnelStatus

The status of the tunnel. Valid values are `inactive` (tunnel has never been run), `degraded` (tunnel is active and able to serve traffic but in an unhealthy state), `healthy` (tunnel is active and able to serve traffic), or `down` (tunnel can not serve traffic as it has no connections to the Cloudflare Edge).

This is an alias to an internal type.

type CloudflareTunnelTunType

type CloudflareTunnelTunType = shared.CloudflareTunnelTunType

The type of tunnel.

This is an alias to an internal type.

type EmailSecurityService

type EmailSecurityService struct {
	Options     []option.RequestOption
	Investigate *InvestigateService
	Settings    *SettingService
	Submissions *SubmissionService
}

EmailSecurityService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewEmailSecurityService method instead.

func NewEmailSecurityService

func NewEmailSecurityService(opts ...option.RequestOption) (r *EmailSecurityService)

NewEmailSecurityService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

type Error

type Error = apierror.Error

type ErrorData

type ErrorData = shared.ErrorData

This is an alias to an internal type.

type ErrorDataSource

type ErrorDataSource = shared.ErrorDataSource

This is an alias to an internal type.

type InvestigateDetectionGetParams

type InvestigateDetectionGetParams struct {
	// Account Identifier
	AccountID param.Field[string] `path:"account_id,required"`
}

type InvestigateDetectionGetResponse

type InvestigateDetectionGetResponse struct {
	Action           string                                          `json:"action,required"`
	Attachments      []InvestigateDetectionGetResponseAttachment     `json:"attachments,required"`
	Headers          []InvestigateDetectionGetResponseHeader         `json:"headers,required"`
	Links            []InvestigateDetectionGetResponseLink           `json:"links,required"`
	SenderInfo       InvestigateDetectionGetResponseSenderInfo       `json:"sender_info,required"`
	ThreatCategories []InvestigateDetectionGetResponseThreatCategory `json:"threat_categories,required"`
	Validation       InvestigateDetectionGetResponseValidation       `json:"validation,required"`
	FinalDisposition InvestigateDetectionGetResponseFinalDisposition `json:"final_disposition,nullable"`
	JSON             investigateDetectionGetResponseJSON             `json:"-"`
}

func (*InvestigateDetectionGetResponse) UnmarshalJSON

func (r *InvestigateDetectionGetResponse) UnmarshalJSON(data []byte) (err error)

type InvestigateDetectionGetResponseAttachment

type InvestigateDetectionGetResponseAttachment struct {
	Size        int64                                               `json:"size,required"`
	ContentType string                                              `json:"content_type,nullable"`
	Detection   InvestigateDetectionGetResponseAttachmentsDetection `json:"detection,nullable"`
	Encrypted   bool                                                `json:"encrypted,nullable"`
	Name        string                                              `json:"name,nullable"`
	JSON        investigateDetectionGetResponseAttachmentJSON       `json:"-"`
}

func (*InvestigateDetectionGetResponseAttachment) UnmarshalJSON

func (r *InvestigateDetectionGetResponseAttachment) UnmarshalJSON(data []byte) (err error)

type InvestigateDetectionGetResponseAttachmentsDetection

type InvestigateDetectionGetResponseAttachmentsDetection string
const (
	InvestigateDetectionGetResponseAttachmentsDetectionMalicious    InvestigateDetectionGetResponseAttachmentsDetection = "MALICIOUS"
	InvestigateDetectionGetResponseAttachmentsDetectionMaliciousBec InvestigateDetectionGetResponseAttachmentsDetection = "MALICIOUS-BEC"
	InvestigateDetectionGetResponseAttachmentsDetectionSuspicious   InvestigateDetectionGetResponseAttachmentsDetection = "SUSPICIOUS"
	InvestigateDetectionGetResponseAttachmentsDetectionSpoof        InvestigateDetectionGetResponseAttachmentsDetection = "SPOOF"
	InvestigateDetectionGetResponseAttachmentsDetectionSpam         InvestigateDetectionGetResponseAttachmentsDetection = "SPAM"
	InvestigateDetectionGetResponseAttachmentsDetectionBulk         InvestigateDetectionGetResponseAttachmentsDetection = "BULK"
	InvestigateDetectionGetResponseAttachmentsDetectionEncrypted    InvestigateDetectionGetResponseAttachmentsDetection = "ENCRYPTED"
	InvestigateDetectionGetResponseAttachmentsDetectionExternal     InvestigateDetectionGetResponseAttachmentsDetection = "EXTERNAL"
	InvestigateDetectionGetResponseAttachmentsDetectionUnknown      InvestigateDetectionGetResponseAttachmentsDetection = "UNKNOWN"
	InvestigateDetectionGetResponseAttachmentsDetectionNone         InvestigateDetectionGetResponseAttachmentsDetection = "NONE"
)

func (InvestigateDetectionGetResponseAttachmentsDetection) IsKnown

type InvestigateDetectionGetResponseEnvelope

type InvestigateDetectionGetResponseEnvelope struct {
	Errors   []shared.ResponseInfo                       `json:"errors,required"`
	Messages []shared.ResponseInfo                       `json:"messages,required"`
	Result   InvestigateDetectionGetResponse             `json:"result,required"`
	Success  bool                                        `json:"success,required"`
	JSON     investigateDetectionGetResponseEnvelopeJSON `json:"-"`
}

func (*InvestigateDetectionGetResponseEnvelope) UnmarshalJSON

func (r *InvestigateDetectionGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type InvestigateDetectionGetResponseFinalDisposition

type InvestigateDetectionGetResponseFinalDisposition string
const (
	InvestigateDetectionGetResponseFinalDispositionMalicious    InvestigateDetectionGetResponseFinalDisposition = "MALICIOUS"
	InvestigateDetectionGetResponseFinalDispositionMaliciousBec InvestigateDetectionGetResponseFinalDisposition = "MALICIOUS-BEC"
	InvestigateDetectionGetResponseFinalDispositionSuspicious   InvestigateDetectionGetResponseFinalDisposition = "SUSPICIOUS"
	InvestigateDetectionGetResponseFinalDispositionSpoof        InvestigateDetectionGetResponseFinalDisposition = "SPOOF"
	InvestigateDetectionGetResponseFinalDispositionSpam         InvestigateDetectionGetResponseFinalDisposition = "SPAM"
	InvestigateDetectionGetResponseFinalDispositionBulk         InvestigateDetectionGetResponseFinalDisposition = "BULK"
	InvestigateDetectionGetResponseFinalDispositionEncrypted    InvestigateDetectionGetResponseFinalDisposition = "ENCRYPTED"
	InvestigateDetectionGetResponseFinalDispositionExternal     InvestigateDetectionGetResponseFinalDisposition = "EXTERNAL"
	InvestigateDetectionGetResponseFinalDispositionUnknown      InvestigateDetectionGetResponseFinalDisposition = "UNKNOWN"
	InvestigateDetectionGetResponseFinalDispositionNone         InvestigateDetectionGetResponseFinalDisposition = "NONE"
)

func (InvestigateDetectionGetResponseFinalDisposition) IsKnown

type InvestigateDetectionGetResponseHeader

type InvestigateDetectionGetResponseHeader struct {
	Name  string                                    `json:"name,required"`
	Value string                                    `json:"value,required"`
	JSON  investigateDetectionGetResponseHeaderJSON `json:"-"`
}

func (*InvestigateDetectionGetResponseHeader) UnmarshalJSON

func (r *InvestigateDetectionGetResponseHeader) UnmarshalJSON(data []byte) (err error)
type InvestigateDetectionGetResponseLink struct {
	Href string                                  `json:"href,required"`
	Text string                                  `json:"text,nullable"`
	JSON investigateDetectionGetResponseLinkJSON `json:"-"`
}

func (*InvestigateDetectionGetResponseLink) UnmarshalJSON

func (r *InvestigateDetectionGetResponseLink) UnmarshalJSON(data []byte) (err error)

type InvestigateDetectionGetResponseSenderInfo

type InvestigateDetectionGetResponseSenderInfo struct {
	// The name of the autonomous system.
	AsName string `json:"as_name,nullable"`
	// The number of the autonomous system.
	AsNumber int64                                         `json:"as_number,nullable"`
	Geo      string                                        `json:"geo,nullable"`
	IP       string                                        `json:"ip,nullable"`
	Pld      string                                        `json:"pld,nullable"`
	JSON     investigateDetectionGetResponseSenderInfoJSON `json:"-"`
}

func (*InvestigateDetectionGetResponseSenderInfo) UnmarshalJSON

func (r *InvestigateDetectionGetResponseSenderInfo) UnmarshalJSON(data []byte) (err error)

type InvestigateDetectionGetResponseThreatCategory

type InvestigateDetectionGetResponseThreatCategory struct {
	ID          int64                                             `json:"id,required"`
	Description string                                            `json:"description,nullable"`
	Name        string                                            `json:"name,nullable"`
	JSON        investigateDetectionGetResponseThreatCategoryJSON `json:"-"`
}

func (*InvestigateDetectionGetResponseThreatCategory) UnmarshalJSON

func (r *InvestigateDetectionGetResponseThreatCategory) UnmarshalJSON(data []byte) (err error)

type InvestigateDetectionGetResponseValidation

type InvestigateDetectionGetResponseValidation struct {
	Comment string                                         `json:"comment,nullable"`
	DKIM    InvestigateDetectionGetResponseValidationDKIM  `json:"dkim,nullable"`
	DMARC   InvestigateDetectionGetResponseValidationDMARC `json:"dmarc,nullable"`
	SPF     InvestigateDetectionGetResponseValidationSPF   `json:"spf,nullable"`
	JSON    investigateDetectionGetResponseValidationJSON  `json:"-"`
}

func (*InvestigateDetectionGetResponseValidation) UnmarshalJSON

func (r *InvestigateDetectionGetResponseValidation) UnmarshalJSON(data []byte) (err error)

type InvestigateDetectionGetResponseValidationDKIM

type InvestigateDetectionGetResponseValidationDKIM string
const (
	InvestigateDetectionGetResponseValidationDKIMPass    InvestigateDetectionGetResponseValidationDKIM = "pass"
	InvestigateDetectionGetResponseValidationDKIMNeutral InvestigateDetectionGetResponseValidationDKIM = "neutral"
	InvestigateDetectionGetResponseValidationDKIMFail    InvestigateDetectionGetResponseValidationDKIM = "fail"
	InvestigateDetectionGetResponseValidationDKIMError   InvestigateDetectionGetResponseValidationDKIM = "error"
	InvestigateDetectionGetResponseValidationDKIMNone    InvestigateDetectionGetResponseValidationDKIM = "none"
)

func (InvestigateDetectionGetResponseValidationDKIM) IsKnown

type InvestigateDetectionGetResponseValidationDMARC

type InvestigateDetectionGetResponseValidationDMARC string
const (
	InvestigateDetectionGetResponseValidationDMARCPass    InvestigateDetectionGetResponseValidationDMARC = "pass"
	InvestigateDetectionGetResponseValidationDMARCNeutral InvestigateDetectionGetResponseValidationDMARC = "neutral"
	InvestigateDetectionGetResponseValidationDMARCFail    InvestigateDetectionGetResponseValidationDMARC = "fail"
	InvestigateDetectionGetResponseValidationDMARCError   InvestigateDetectionGetResponseValidationDMARC = "error"
	InvestigateDetectionGetResponseValidationDMARCNone    InvestigateDetectionGetResponseValidationDMARC = "none"
)

func (InvestigateDetectionGetResponseValidationDMARC) IsKnown

type InvestigateDetectionGetResponseValidationSPF

type InvestigateDetectionGetResponseValidationSPF string
const (
	InvestigateDetectionGetResponseValidationSPFPass    InvestigateDetectionGetResponseValidationSPF = "pass"
	InvestigateDetectionGetResponseValidationSPFNeutral InvestigateDetectionGetResponseValidationSPF = "neutral"
	InvestigateDetectionGetResponseValidationSPFFail    InvestigateDetectionGetResponseValidationSPF = "fail"
	InvestigateDetectionGetResponseValidationSPFError   InvestigateDetectionGetResponseValidationSPF = "error"
	InvestigateDetectionGetResponseValidationSPFNone    InvestigateDetectionGetResponseValidationSPF = "none"
)

func (InvestigateDetectionGetResponseValidationSPF) IsKnown

type InvestigateDetectionService

type InvestigateDetectionService struct {
	Options []option.RequestOption
}

InvestigateDetectionService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewInvestigateDetectionService method instead.

func NewInvestigateDetectionService

func NewInvestigateDetectionService(opts ...option.RequestOption) (r *InvestigateDetectionService)

NewInvestigateDetectionService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*InvestigateDetectionService) Get

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

type InvestigateGetParams

type InvestigateGetParams struct {
	// Account Identifier
	AccountID param.Field[string] `path:"account_id,required"`
}

type InvestigateGetResponse

type InvestigateGetResponse struct {
	ID                string      `json:"id,required"`
	ActionLog         interface{} `json:"action_log,required"`
	ClientRecipients  []string    `json:"client_recipients,required"`
	DetectionReasons  []string    `json:"detection_reasons,required"`
	IsPhishSubmission bool        `json:"is_phish_submission,required"`
	IsQuarantined     bool        `json:"is_quarantined,required"`
	// The identifier of the message.
	PostfixID        string                                 `json:"postfix_id,required"`
	Properties       InvestigateGetResponseProperties       `json:"properties,required"`
	Ts               string                                 `json:"ts,required"`
	AlertID          string                                 `json:"alert_id,nullable"`
	DeliveryMode     InvestigateGetResponseDeliveryMode     `json:"delivery_mode,nullable"`
	EdfHash          string                                 `json:"edf_hash,nullable"`
	FinalDisposition InvestigateGetResponseFinalDisposition `json:"final_disposition,nullable"`
	Findings         []InvestigateGetResponseFinding        `json:"findings,nullable"`
	From             string                                 `json:"from,nullable"`
	FromName         string                                 `json:"from_name,nullable"`
	MessageID        string                                 `json:"message_id,nullable"`
	SentDate         string                                 `json:"sent_date,nullable"`
	Subject          string                                 `json:"subject,nullable"`
	ThreatCategories []string                               `json:"threat_categories,nullable"`
	To               []string                               `json:"to,nullable"`
	ToName           []string                               `json:"to_name,nullable"`
	Validation       InvestigateGetResponseValidation       `json:"validation,nullable"`
	JSON             investigateGetResponseJSON             `json:"-"`
}

func (*InvestigateGetResponse) UnmarshalJSON

func (r *InvestigateGetResponse) UnmarshalJSON(data []byte) (err error)

type InvestigateGetResponseDeliveryMode

type InvestigateGetResponseDeliveryMode string
const (
	InvestigateGetResponseDeliveryModeDirect                InvestigateGetResponseDeliveryMode = "DIRECT"
	InvestigateGetResponseDeliveryModeBcc                   InvestigateGetResponseDeliveryMode = "BCC"
	InvestigateGetResponseDeliveryModeJournal               InvestigateGetResponseDeliveryMode = "JOURNAL"
	InvestigateGetResponseDeliveryModeReviewSubmission      InvestigateGetResponseDeliveryMode = "REVIEW_SUBMISSION"
	InvestigateGetResponseDeliveryModeDMARCUnverified       InvestigateGetResponseDeliveryMode = "DMARC_UNVERIFIED"
	InvestigateGetResponseDeliveryModeDMARCFailureReport    InvestigateGetResponseDeliveryMode = "DMARC_FAILURE_REPORT"
	InvestigateGetResponseDeliveryModeDMARCAggregateReport  InvestigateGetResponseDeliveryMode = "DMARC_AGGREGATE_REPORT"
	InvestigateGetResponseDeliveryModeThreatIntelSubmission InvestigateGetResponseDeliveryMode = "THREAT_INTEL_SUBMISSION"
	InvestigateGetResponseDeliveryModeSimulationSubmission  InvestigateGetResponseDeliveryMode = "SIMULATION_SUBMISSION"
	InvestigateGetResponseDeliveryModeAPI                   InvestigateGetResponseDeliveryMode = "API"
	InvestigateGetResponseDeliveryModeRetroScan             InvestigateGetResponseDeliveryMode = "RETRO_SCAN"
)

func (InvestigateGetResponseDeliveryMode) IsKnown

type InvestigateGetResponseEnvelope

type InvestigateGetResponseEnvelope struct {
	Errors   []shared.ResponseInfo              `json:"errors,required"`
	Messages []shared.ResponseInfo              `json:"messages,required"`
	Result   InvestigateGetResponse             `json:"result,required"`
	Success  bool                               `json:"success,required"`
	JSON     investigateGetResponseEnvelopeJSON `json:"-"`
}

func (*InvestigateGetResponseEnvelope) UnmarshalJSON

func (r *InvestigateGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type InvestigateGetResponseFinalDisposition

type InvestigateGetResponseFinalDisposition string
const (
	InvestigateGetResponseFinalDispositionMalicious    InvestigateGetResponseFinalDisposition = "MALICIOUS"
	InvestigateGetResponseFinalDispositionMaliciousBec InvestigateGetResponseFinalDisposition = "MALICIOUS-BEC"
	InvestigateGetResponseFinalDispositionSuspicious   InvestigateGetResponseFinalDisposition = "SUSPICIOUS"
	InvestigateGetResponseFinalDispositionSpoof        InvestigateGetResponseFinalDisposition = "SPOOF"
	InvestigateGetResponseFinalDispositionSpam         InvestigateGetResponseFinalDisposition = "SPAM"
	InvestigateGetResponseFinalDispositionBulk         InvestigateGetResponseFinalDisposition = "BULK"
	InvestigateGetResponseFinalDispositionEncrypted    InvestigateGetResponseFinalDisposition = "ENCRYPTED"
	InvestigateGetResponseFinalDispositionExternal     InvestigateGetResponseFinalDisposition = "EXTERNAL"
	InvestigateGetResponseFinalDispositionUnknown      InvestigateGetResponseFinalDisposition = "UNKNOWN"
	InvestigateGetResponseFinalDispositionNone         InvestigateGetResponseFinalDisposition = "NONE"
)

func (InvestigateGetResponseFinalDisposition) IsKnown

type InvestigateGetResponseFinding

type InvestigateGetResponseFinding struct {
	Detail string                            `json:"detail,nullable"`
	Name   string                            `json:"name,nullable"`
	Value  string                            `json:"value,nullable"`
	JSON   investigateGetResponseFindingJSON `json:"-"`
}

func (*InvestigateGetResponseFinding) UnmarshalJSON

func (r *InvestigateGetResponseFinding) UnmarshalJSON(data []byte) (err error)

type InvestigateGetResponseProperties

type InvestigateGetResponseProperties struct {
	AllowlistedPattern     string                                                 `json:"allowlisted_pattern"`
	AllowlistedPatternType InvestigateGetResponsePropertiesAllowlistedPatternType `json:"allowlisted_pattern_type"`
	BlocklistedMessage     bool                                                   `json:"blocklisted_message"`
	BlocklistedPattern     string                                                 `json:"blocklisted_pattern"`
	WhitelistedPatternType InvestigateGetResponsePropertiesWhitelistedPatternType `json:"whitelisted_pattern_type"`
	JSON                   investigateGetResponsePropertiesJSON                   `json:"-"`
}

func (*InvestigateGetResponseProperties) UnmarshalJSON

func (r *InvestigateGetResponseProperties) UnmarshalJSON(data []byte) (err error)

type InvestigateGetResponsePropertiesAllowlistedPatternType

type InvestigateGetResponsePropertiesAllowlistedPatternType string
const (
	InvestigateGetResponsePropertiesAllowlistedPatternTypeQuarantineRelease       InvestigateGetResponsePropertiesAllowlistedPatternType = "quarantine_release"
	InvestigateGetResponsePropertiesAllowlistedPatternTypeAcceptableSender        InvestigateGetResponsePropertiesAllowlistedPatternType = "acceptable_sender"
	InvestigateGetResponsePropertiesAllowlistedPatternTypeAllowedSender           InvestigateGetResponsePropertiesAllowlistedPatternType = "allowed_sender"
	InvestigateGetResponsePropertiesAllowlistedPatternTypeAllowedRecipient        InvestigateGetResponsePropertiesAllowlistedPatternType = "allowed_recipient"
	InvestigateGetResponsePropertiesAllowlistedPatternTypeDomainSimilarity        InvestigateGetResponsePropertiesAllowlistedPatternType = "domain_similarity"
	InvestigateGetResponsePropertiesAllowlistedPatternTypeDomainRecency           InvestigateGetResponsePropertiesAllowlistedPatternType = "domain_recency"
	InvestigateGetResponsePropertiesAllowlistedPatternTypeManagedAcceptableSender InvestigateGetResponsePropertiesAllowlistedPatternType = "managed_acceptable_sender"
)

func (InvestigateGetResponsePropertiesAllowlistedPatternType) IsKnown

type InvestigateGetResponsePropertiesWhitelistedPatternType

type InvestigateGetResponsePropertiesWhitelistedPatternType string
const (
	InvestigateGetResponsePropertiesWhitelistedPatternTypeQuarantineRelease       InvestigateGetResponsePropertiesWhitelistedPatternType = "quarantine_release"
	InvestigateGetResponsePropertiesWhitelistedPatternTypeAcceptableSender        InvestigateGetResponsePropertiesWhitelistedPatternType = "acceptable_sender"
	InvestigateGetResponsePropertiesWhitelistedPatternTypeAllowedSender           InvestigateGetResponsePropertiesWhitelistedPatternType = "allowed_sender"
	InvestigateGetResponsePropertiesWhitelistedPatternTypeAllowedRecipient        InvestigateGetResponsePropertiesWhitelistedPatternType = "allowed_recipient"
	InvestigateGetResponsePropertiesWhitelistedPatternTypeDomainSimilarity        InvestigateGetResponsePropertiesWhitelistedPatternType = "domain_similarity"
	InvestigateGetResponsePropertiesWhitelistedPatternTypeDomainRecency           InvestigateGetResponsePropertiesWhitelistedPatternType = "domain_recency"
	InvestigateGetResponsePropertiesWhitelistedPatternTypeManagedAcceptableSender InvestigateGetResponsePropertiesWhitelistedPatternType = "managed_acceptable_sender"
)

func (InvestigateGetResponsePropertiesWhitelistedPatternType) IsKnown

type InvestigateGetResponseValidation

type InvestigateGetResponseValidation struct {
	Comment string                                `json:"comment,nullable"`
	DKIM    InvestigateGetResponseValidationDKIM  `json:"dkim,nullable"`
	DMARC   InvestigateGetResponseValidationDMARC `json:"dmarc,nullable"`
	SPF     InvestigateGetResponseValidationSPF   `json:"spf,nullable"`
	JSON    investigateGetResponseValidationJSON  `json:"-"`
}

func (*InvestigateGetResponseValidation) UnmarshalJSON

func (r *InvestigateGetResponseValidation) UnmarshalJSON(data []byte) (err error)

type InvestigateGetResponseValidationDKIM

type InvestigateGetResponseValidationDKIM string
const (
	InvestigateGetResponseValidationDKIMPass    InvestigateGetResponseValidationDKIM = "pass"
	InvestigateGetResponseValidationDKIMNeutral InvestigateGetResponseValidationDKIM = "neutral"
	InvestigateGetResponseValidationDKIMFail    InvestigateGetResponseValidationDKIM = "fail"
	InvestigateGetResponseValidationDKIMError   InvestigateGetResponseValidationDKIM = "error"
	InvestigateGetResponseValidationDKIMNone    InvestigateGetResponseValidationDKIM = "none"
)

func (InvestigateGetResponseValidationDKIM) IsKnown

type InvestigateGetResponseValidationDMARC

type InvestigateGetResponseValidationDMARC string
const (
	InvestigateGetResponseValidationDMARCPass    InvestigateGetResponseValidationDMARC = "pass"
	InvestigateGetResponseValidationDMARCNeutral InvestigateGetResponseValidationDMARC = "neutral"
	InvestigateGetResponseValidationDMARCFail    InvestigateGetResponseValidationDMARC = "fail"
	InvestigateGetResponseValidationDMARCError   InvestigateGetResponseValidationDMARC = "error"
	InvestigateGetResponseValidationDMARCNone    InvestigateGetResponseValidationDMARC = "none"
)

func (InvestigateGetResponseValidationDMARC) IsKnown

type InvestigateGetResponseValidationSPF

type InvestigateGetResponseValidationSPF string
const (
	InvestigateGetResponseValidationSPFPass    InvestigateGetResponseValidationSPF = "pass"
	InvestigateGetResponseValidationSPFNeutral InvestigateGetResponseValidationSPF = "neutral"
	InvestigateGetResponseValidationSPFFail    InvestigateGetResponseValidationSPF = "fail"
	InvestigateGetResponseValidationSPFError   InvestigateGetResponseValidationSPF = "error"
	InvestigateGetResponseValidationSPFNone    InvestigateGetResponseValidationSPF = "none"
)

func (InvestigateGetResponseValidationSPF) IsKnown

type InvestigateListParams

type InvestigateListParams struct {
	// Account Identifier
	AccountID param.Field[string] `path:"account_id,required"`
	// Determines if the message action log is included in the response.
	ActionLog param.Field[bool]   `query:"action_log"`
	AlertID   param.Field[string] `query:"alert_id"`
	// Determines if the search results will include detections or not.
	DetectionsOnly param.Field[bool] `query:"detections_only"`
	// The sender domains the search filters by.
	Domain param.Field[string] `query:"domain"`
	// The end of the search date range. Defaults to `now`.
	End param.Field[time.Time] `query:"end" format:"date-time"`
	// The dispositions the search filters by.
	FinalDisposition param.Field[InvestigateListParamsFinalDisposition] `query:"final_disposition"`
	// The message actions the search filters by.
	MessageAction param.Field[InvestigateListParamsMessageAction] `query:"message_action"`
	MessageID     param.Field[string]                             `query:"message_id"`
	Metric        param.Field[string]                             `query:"metric"`
	// The page number of paginated results.
	Page param.Field[int64] `query:"page"`
	// The number of results per page.
	PerPage param.Field[int64] `query:"per_page"`
	// The space-delimited term used in the query. The search is case-insensitive.
	//
	// The content of the following email metadata fields are searched:
	//
	// - alert_id
	// - CC
	// - From (envelope_from)
	// - From Name
	// - final_disposition
	// - md5 hash (of any attachment)
	// - sha1 hash (of any attachment)
	// - sha256 hash (of any attachment)
	// - name (of any attachment)
	// - Reason
	// - Received DateTime (yyyy-mm-ddThh:mm:ss)
	// - Sent DateTime (yyyy-mm-ddThh:mm:ss)
	// - ReplyTo
	// - To (envelope_to)
	// - To Name
	// - Message-ID
	// - smtp_helo_server_ip
	// - smtp_previous_hop_ip
	// - x_originating_ip
	// - Subject
	Query     param.Field[string] `query:"query"`
	Recipient param.Field[string] `query:"recipient"`
	Sender    param.Field[string] `query:"sender"`
	// The beginning of the search date range. Defaults to `now - 30 days`.
	Start   param.Field[time.Time] `query:"start" format:"date-time"`
	Subject param.Field[string]    `query:"subject"`
}

func (InvestigateListParams) URLQuery

func (r InvestigateListParams) URLQuery() (v url.Values)

URLQuery serializes InvestigateListParams's query parameters as `url.Values`.

type InvestigateListParamsFinalDisposition

type InvestigateListParamsFinalDisposition string

The dispositions the search filters by.

const (
	InvestigateListParamsFinalDispositionMalicious  InvestigateListParamsFinalDisposition = "MALICIOUS"
	InvestigateListParamsFinalDispositionSuspicious InvestigateListParamsFinalDisposition = "SUSPICIOUS"
	InvestigateListParamsFinalDispositionSpoof      InvestigateListParamsFinalDisposition = "SPOOF"
	InvestigateListParamsFinalDispositionSpam       InvestigateListParamsFinalDisposition = "SPAM"
	InvestigateListParamsFinalDispositionBulk       InvestigateListParamsFinalDisposition = "BULK"
	InvestigateListParamsFinalDispositionNone       InvestigateListParamsFinalDisposition = "NONE"
)

func (InvestigateListParamsFinalDisposition) IsKnown

type InvestigateListParamsMessageAction

type InvestigateListParamsMessageAction string

The message actions the search filters by.

const (
	InvestigateListParamsMessageActionPreview            InvestigateListParamsMessageAction = "PREVIEW"
	InvestigateListParamsMessageActionQuarantineReleased InvestigateListParamsMessageAction = "QUARANTINE_RELEASED"
	InvestigateListParamsMessageActionMoved              InvestigateListParamsMessageAction = "MOVED"
)

func (InvestigateListParamsMessageAction) IsKnown

type InvestigateListResponse

type InvestigateListResponse struct {
	ID                string      `json:"id,required"`
	ActionLog         interface{} `json:"action_log,required"`
	ClientRecipients  []string    `json:"client_recipients,required"`
	DetectionReasons  []string    `json:"detection_reasons,required"`
	IsPhishSubmission bool        `json:"is_phish_submission,required"`
	IsQuarantined     bool        `json:"is_quarantined,required"`
	// The identifier of the message.
	PostfixID        string                                  `json:"postfix_id,required"`
	Properties       InvestigateListResponseProperties       `json:"properties,required"`
	Ts               string                                  `json:"ts,required"`
	AlertID          string                                  `json:"alert_id,nullable"`
	DeliveryMode     InvestigateListResponseDeliveryMode     `json:"delivery_mode,nullable"`
	EdfHash          string                                  `json:"edf_hash,nullable"`
	FinalDisposition InvestigateListResponseFinalDisposition `json:"final_disposition,nullable"`
	Findings         []InvestigateListResponseFinding        `json:"findings,nullable"`
	From             string                                  `json:"from,nullable"`
	FromName         string                                  `json:"from_name,nullable"`
	MessageID        string                                  `json:"message_id,nullable"`
	SentDate         string                                  `json:"sent_date,nullable"`
	Subject          string                                  `json:"subject,nullable"`
	ThreatCategories []string                                `json:"threat_categories,nullable"`
	To               []string                                `json:"to,nullable"`
	ToName           []string                                `json:"to_name,nullable"`
	Validation       InvestigateListResponseValidation       `json:"validation,nullable"`
	JSON             investigateListResponseJSON             `json:"-"`
}

func (*InvestigateListResponse) UnmarshalJSON

func (r *InvestigateListResponse) UnmarshalJSON(data []byte) (err error)

type InvestigateListResponseDeliveryMode

type InvestigateListResponseDeliveryMode string
const (
	InvestigateListResponseDeliveryModeDirect                InvestigateListResponseDeliveryMode = "DIRECT"
	InvestigateListResponseDeliveryModeBcc                   InvestigateListResponseDeliveryMode = "BCC"
	InvestigateListResponseDeliveryModeJournal               InvestigateListResponseDeliveryMode = "JOURNAL"
	InvestigateListResponseDeliveryModeReviewSubmission      InvestigateListResponseDeliveryMode = "REVIEW_SUBMISSION"
	InvestigateListResponseDeliveryModeDMARCUnverified       InvestigateListResponseDeliveryMode = "DMARC_UNVERIFIED"
	InvestigateListResponseDeliveryModeDMARCFailureReport    InvestigateListResponseDeliveryMode = "DMARC_FAILURE_REPORT"
	InvestigateListResponseDeliveryModeDMARCAggregateReport  InvestigateListResponseDeliveryMode = "DMARC_AGGREGATE_REPORT"
	InvestigateListResponseDeliveryModeThreatIntelSubmission InvestigateListResponseDeliveryMode = "THREAT_INTEL_SUBMISSION"
	InvestigateListResponseDeliveryModeSimulationSubmission  InvestigateListResponseDeliveryMode = "SIMULATION_SUBMISSION"
	InvestigateListResponseDeliveryModeAPI                   InvestigateListResponseDeliveryMode = "API"
	InvestigateListResponseDeliveryModeRetroScan             InvestigateListResponseDeliveryMode = "RETRO_SCAN"
)

func (InvestigateListResponseDeliveryMode) IsKnown

type InvestigateListResponseFinalDisposition

type InvestigateListResponseFinalDisposition string
const (
	InvestigateListResponseFinalDispositionMalicious    InvestigateListResponseFinalDisposition = "MALICIOUS"
	InvestigateListResponseFinalDispositionMaliciousBec InvestigateListResponseFinalDisposition = "MALICIOUS-BEC"
	InvestigateListResponseFinalDispositionSuspicious   InvestigateListResponseFinalDisposition = "SUSPICIOUS"
	InvestigateListResponseFinalDispositionSpoof        InvestigateListResponseFinalDisposition = "SPOOF"
	InvestigateListResponseFinalDispositionSpam         InvestigateListResponseFinalDisposition = "SPAM"
	InvestigateListResponseFinalDispositionBulk         InvestigateListResponseFinalDisposition = "BULK"
	InvestigateListResponseFinalDispositionEncrypted    InvestigateListResponseFinalDisposition = "ENCRYPTED"
	InvestigateListResponseFinalDispositionExternal     InvestigateListResponseFinalDisposition = "EXTERNAL"
	InvestigateListResponseFinalDispositionUnknown      InvestigateListResponseFinalDisposition = "UNKNOWN"
	InvestigateListResponseFinalDispositionNone         InvestigateListResponseFinalDisposition = "NONE"
)

func (InvestigateListResponseFinalDisposition) IsKnown

type InvestigateListResponseFinding

type InvestigateListResponseFinding struct {
	Detail string                             `json:"detail,nullable"`
	Name   string                             `json:"name,nullable"`
	Value  string                             `json:"value,nullable"`
	JSON   investigateListResponseFindingJSON `json:"-"`
}

func (*InvestigateListResponseFinding) UnmarshalJSON

func (r *InvestigateListResponseFinding) UnmarshalJSON(data []byte) (err error)

type InvestigateListResponseProperties

type InvestigateListResponseProperties struct {
	AllowlistedPattern     string                                                  `json:"allowlisted_pattern"`
	AllowlistedPatternType InvestigateListResponsePropertiesAllowlistedPatternType `json:"allowlisted_pattern_type"`
	BlocklistedMessage     bool                                                    `json:"blocklisted_message"`
	BlocklistedPattern     string                                                  `json:"blocklisted_pattern"`
	WhitelistedPatternType InvestigateListResponsePropertiesWhitelistedPatternType `json:"whitelisted_pattern_type"`
	JSON                   investigateListResponsePropertiesJSON                   `json:"-"`
}

func (*InvestigateListResponseProperties) UnmarshalJSON

func (r *InvestigateListResponseProperties) UnmarshalJSON(data []byte) (err error)

type InvestigateListResponsePropertiesAllowlistedPatternType

type InvestigateListResponsePropertiesAllowlistedPatternType string
const (
	InvestigateListResponsePropertiesAllowlistedPatternTypeQuarantineRelease       InvestigateListResponsePropertiesAllowlistedPatternType = "quarantine_release"
	InvestigateListResponsePropertiesAllowlistedPatternTypeAcceptableSender        InvestigateListResponsePropertiesAllowlistedPatternType = "acceptable_sender"
	InvestigateListResponsePropertiesAllowlistedPatternTypeAllowedSender           InvestigateListResponsePropertiesAllowlistedPatternType = "allowed_sender"
	InvestigateListResponsePropertiesAllowlistedPatternTypeAllowedRecipient        InvestigateListResponsePropertiesAllowlistedPatternType = "allowed_recipient"
	InvestigateListResponsePropertiesAllowlistedPatternTypeDomainSimilarity        InvestigateListResponsePropertiesAllowlistedPatternType = "domain_similarity"
	InvestigateListResponsePropertiesAllowlistedPatternTypeDomainRecency           InvestigateListResponsePropertiesAllowlistedPatternType = "domain_recency"
	InvestigateListResponsePropertiesAllowlistedPatternTypeManagedAcceptableSender InvestigateListResponsePropertiesAllowlistedPatternType = "managed_acceptable_sender"
)

func (InvestigateListResponsePropertiesAllowlistedPatternType) IsKnown

type InvestigateListResponsePropertiesWhitelistedPatternType

type InvestigateListResponsePropertiesWhitelistedPatternType string
const (
	InvestigateListResponsePropertiesWhitelistedPatternTypeQuarantineRelease       InvestigateListResponsePropertiesWhitelistedPatternType = "quarantine_release"
	InvestigateListResponsePropertiesWhitelistedPatternTypeAcceptableSender        InvestigateListResponsePropertiesWhitelistedPatternType = "acceptable_sender"
	InvestigateListResponsePropertiesWhitelistedPatternTypeAllowedSender           InvestigateListResponsePropertiesWhitelistedPatternType = "allowed_sender"
	InvestigateListResponsePropertiesWhitelistedPatternTypeAllowedRecipient        InvestigateListResponsePropertiesWhitelistedPatternType = "allowed_recipient"
	InvestigateListResponsePropertiesWhitelistedPatternTypeDomainSimilarity        InvestigateListResponsePropertiesWhitelistedPatternType = "domain_similarity"
	InvestigateListResponsePropertiesWhitelistedPatternTypeDomainRecency           InvestigateListResponsePropertiesWhitelistedPatternType = "domain_recency"
	InvestigateListResponsePropertiesWhitelistedPatternTypeManagedAcceptableSender InvestigateListResponsePropertiesWhitelistedPatternType = "managed_acceptable_sender"
)

func (InvestigateListResponsePropertiesWhitelistedPatternType) IsKnown

type InvestigateListResponseValidation

type InvestigateListResponseValidation struct {
	Comment string                                 `json:"comment,nullable"`
	DKIM    InvestigateListResponseValidationDKIM  `json:"dkim,nullable"`
	DMARC   InvestigateListResponseValidationDMARC `json:"dmarc,nullable"`
	SPF     InvestigateListResponseValidationSPF   `json:"spf,nullable"`
	JSON    investigateListResponseValidationJSON  `json:"-"`
}

func (*InvestigateListResponseValidation) UnmarshalJSON

func (r *InvestigateListResponseValidation) UnmarshalJSON(data []byte) (err error)

type InvestigateListResponseValidationDKIM

type InvestigateListResponseValidationDKIM string
const (
	InvestigateListResponseValidationDKIMPass    InvestigateListResponseValidationDKIM = "pass"
	InvestigateListResponseValidationDKIMNeutral InvestigateListResponseValidationDKIM = "neutral"
	InvestigateListResponseValidationDKIMFail    InvestigateListResponseValidationDKIM = "fail"
	InvestigateListResponseValidationDKIMError   InvestigateListResponseValidationDKIM = "error"
	InvestigateListResponseValidationDKIMNone    InvestigateListResponseValidationDKIM = "none"
)

func (InvestigateListResponseValidationDKIM) IsKnown

type InvestigateListResponseValidationDMARC

type InvestigateListResponseValidationDMARC string
const (
	InvestigateListResponseValidationDMARCPass    InvestigateListResponseValidationDMARC = "pass"
	InvestigateListResponseValidationDMARCNeutral InvestigateListResponseValidationDMARC = "neutral"
	InvestigateListResponseValidationDMARCFail    InvestigateListResponseValidationDMARC = "fail"
	InvestigateListResponseValidationDMARCError   InvestigateListResponseValidationDMARC = "error"
	InvestigateListResponseValidationDMARCNone    InvestigateListResponseValidationDMARC = "none"
)

func (InvestigateListResponseValidationDMARC) IsKnown

type InvestigateListResponseValidationSPF

type InvestigateListResponseValidationSPF string
const (
	InvestigateListResponseValidationSPFPass    InvestigateListResponseValidationSPF = "pass"
	InvestigateListResponseValidationSPFNeutral InvestigateListResponseValidationSPF = "neutral"
	InvestigateListResponseValidationSPFFail    InvestigateListResponseValidationSPF = "fail"
	InvestigateListResponseValidationSPFError   InvestigateListResponseValidationSPF = "error"
	InvestigateListResponseValidationSPFNone    InvestigateListResponseValidationSPF = "none"
)

func (InvestigateListResponseValidationSPF) IsKnown

type InvestigateMoveBulkParams

type InvestigateMoveBulkParams struct {
	// Account Identifier
	AccountID   param.Field[string]                               `path:"account_id,required"`
	Destination param.Field[InvestigateMoveBulkParamsDestination] `json:"destination,required"`
	PostfixIDs  param.Field[[]string]                             `json:"postfix_ids,required"`
}

func (InvestigateMoveBulkParams) MarshalJSON

func (r InvestigateMoveBulkParams) MarshalJSON() (data []byte, err error)

type InvestigateMoveBulkParamsDestination

type InvestigateMoveBulkParamsDestination string
const (
	InvestigateMoveBulkParamsDestinationInbox                     InvestigateMoveBulkParamsDestination = "Inbox"
	InvestigateMoveBulkParamsDestinationJunkEmail                 InvestigateMoveBulkParamsDestination = "JunkEmail"
	InvestigateMoveBulkParamsDestinationDeletedItems              InvestigateMoveBulkParamsDestination = "DeletedItems"
	InvestigateMoveBulkParamsDestinationRecoverableItemsDeletions InvestigateMoveBulkParamsDestination = "RecoverableItemsDeletions"
	InvestigateMoveBulkParamsDestinationRecoverableItemsPurges    InvestigateMoveBulkParamsDestination = "RecoverableItemsPurges"
)

func (InvestigateMoveBulkParamsDestination) IsKnown

type InvestigateMoveBulkResponse

type InvestigateMoveBulkResponse struct {
	CompletedTimestamp time.Time                       `json:"completed_timestamp,required" format:"date-time"`
	ItemCount          int64                           `json:"item_count,required"`
	Destination        string                          `json:"destination,nullable"`
	MessageID          string                          `json:"message_id,nullable"`
	Operation          string                          `json:"operation,nullable"`
	Recipient          string                          `json:"recipient,nullable"`
	Status             string                          `json:"status,nullable"`
	JSON               investigateMoveBulkResponseJSON `json:"-"`
}

func (*InvestigateMoveBulkResponse) UnmarshalJSON

func (r *InvestigateMoveBulkResponse) UnmarshalJSON(data []byte) (err error)

type InvestigateMoveNewParams

type InvestigateMoveNewParams struct {
	// Account Identifier
	AccountID   param.Field[string]                              `path:"account_id,required"`
	Destination param.Field[InvestigateMoveNewParamsDestination] `json:"destination,required"`
}

func (InvestigateMoveNewParams) MarshalJSON

func (r InvestigateMoveNewParams) MarshalJSON() (data []byte, err error)

type InvestigateMoveNewParamsDestination

type InvestigateMoveNewParamsDestination string
const (
	InvestigateMoveNewParamsDestinationInbox                     InvestigateMoveNewParamsDestination = "Inbox"
	InvestigateMoveNewParamsDestinationJunkEmail                 InvestigateMoveNewParamsDestination = "JunkEmail"
	InvestigateMoveNewParamsDestinationDeletedItems              InvestigateMoveNewParamsDestination = "DeletedItems"
	InvestigateMoveNewParamsDestinationRecoverableItemsDeletions InvestigateMoveNewParamsDestination = "RecoverableItemsDeletions"
	InvestigateMoveNewParamsDestinationRecoverableItemsPurges    InvestigateMoveNewParamsDestination = "RecoverableItemsPurges"
)

func (InvestigateMoveNewParamsDestination) IsKnown

type InvestigateMoveNewResponse

type InvestigateMoveNewResponse struct {
	CompletedTimestamp time.Time                      `json:"completed_timestamp,required" format:"date-time"`
	ItemCount          int64                          `json:"item_count,required"`
	Destination        string                         `json:"destination,nullable"`
	MessageID          string                         `json:"message_id,nullable"`
	Operation          string                         `json:"operation,nullable"`
	Recipient          string                         `json:"recipient,nullable"`
	Status             string                         `json:"status,nullable"`
	JSON               investigateMoveNewResponseJSON `json:"-"`
}

func (*InvestigateMoveNewResponse) UnmarshalJSON

func (r *InvestigateMoveNewResponse) UnmarshalJSON(data []byte) (err error)

type InvestigateMoveService

type InvestigateMoveService struct {
	Options []option.RequestOption
}

InvestigateMoveService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewInvestigateMoveService method instead.

func NewInvestigateMoveService

func NewInvestigateMoveService(opts ...option.RequestOption) (r *InvestigateMoveService)

NewInvestigateMoveService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*InvestigateMoveService) Bulk

Move multiple messages

func (*InvestigateMoveService) BulkAutoPaging

Move multiple messages

func (*InvestigateMoveService) New

Move a message

func (*InvestigateMoveService) NewAutoPaging

Move a message

type InvestigatePreviewGetParams

type InvestigatePreviewGetParams struct {
	// Account Identifier
	AccountID param.Field[string] `path:"account_id,required"`
}

type InvestigatePreviewGetResponse

type InvestigatePreviewGetResponse struct {
	// A base64 encoded PNG image of the email.
	Screenshot string                            `json:"screenshot,required"`
	JSON       investigatePreviewGetResponseJSON `json:"-"`
}

func (*InvestigatePreviewGetResponse) UnmarshalJSON

func (r *InvestigatePreviewGetResponse) UnmarshalJSON(data []byte) (err error)

type InvestigatePreviewGetResponseEnvelope

type InvestigatePreviewGetResponseEnvelope struct {
	Errors   []shared.ResponseInfo                     `json:"errors,required"`
	Messages []shared.ResponseInfo                     `json:"messages,required"`
	Result   InvestigatePreviewGetResponse             `json:"result,required"`
	Success  bool                                      `json:"success,required"`
	JSON     investigatePreviewGetResponseEnvelopeJSON `json:"-"`
}

func (*InvestigatePreviewGetResponseEnvelope) UnmarshalJSON

func (r *InvestigatePreviewGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type InvestigatePreviewNewParams

type InvestigatePreviewNewParams struct {
	// Account Identifier
	AccountID param.Field[string] `path:"account_id,required"`
	// The identifier of the message.
	PostfixID param.Field[string] `json:"postfix_id,required"`
}

func (InvestigatePreviewNewParams) MarshalJSON

func (r InvestigatePreviewNewParams) MarshalJSON() (data []byte, err error)

type InvestigatePreviewNewResponse

type InvestigatePreviewNewResponse struct {
	// A base64 encoded PNG image of the email.
	Screenshot string                            `json:"screenshot,required"`
	JSON       investigatePreviewNewResponseJSON `json:"-"`
}

func (*InvestigatePreviewNewResponse) UnmarshalJSON

func (r *InvestigatePreviewNewResponse) UnmarshalJSON(data []byte) (err error)

type InvestigatePreviewNewResponseEnvelope

type InvestigatePreviewNewResponseEnvelope struct {
	Errors   []shared.ResponseInfo                     `json:"errors,required"`
	Messages []shared.ResponseInfo                     `json:"messages,required"`
	Result   InvestigatePreviewNewResponse             `json:"result,required"`
	Success  bool                                      `json:"success,required"`
	JSON     investigatePreviewNewResponseEnvelopeJSON `json:"-"`
}

func (*InvestigatePreviewNewResponseEnvelope) UnmarshalJSON

func (r *InvestigatePreviewNewResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type InvestigatePreviewService

type InvestigatePreviewService struct {
	Options []option.RequestOption
}

InvestigatePreviewService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewInvestigatePreviewService method instead.

func NewInvestigatePreviewService

func NewInvestigatePreviewService(opts ...option.RequestOption) (r *InvestigatePreviewService)

NewInvestigatePreviewService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*InvestigatePreviewService) Get

Returns a preview of the message body as a base64 encoded PNG image for non-benign messages.

func (*InvestigatePreviewService) New

Preview for non-detection messages

type InvestigateRawGetParams

type InvestigateRawGetParams struct {
	// Account Identifier
	AccountID param.Field[string] `path:"account_id,required"`
}

type InvestigateRawGetResponse

type InvestigateRawGetResponse struct {
	// A UTF-8 encoded eml file of the email.
	Raw  string                        `json:"raw,required"`
	JSON investigateRawGetResponseJSON `json:"-"`
}

func (*InvestigateRawGetResponse) UnmarshalJSON

func (r *InvestigateRawGetResponse) UnmarshalJSON(data []byte) (err error)

type InvestigateRawGetResponseEnvelope

type InvestigateRawGetResponseEnvelope struct {
	Errors   []shared.ResponseInfo                 `json:"errors,required"`
	Messages []shared.ResponseInfo                 `json:"messages,required"`
	Result   InvestigateRawGetResponse             `json:"result,required"`
	Success  bool                                  `json:"success,required"`
	JSON     investigateRawGetResponseEnvelopeJSON `json:"-"`
}

func (*InvestigateRawGetResponseEnvelope) UnmarshalJSON

func (r *InvestigateRawGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type InvestigateRawService

type InvestigateRawService struct {
	Options []option.RequestOption
}

InvestigateRawService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewInvestigateRawService method instead.

func NewInvestigateRawService

func NewInvestigateRawService(opts ...option.RequestOption) (r *InvestigateRawService)

NewInvestigateRawService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*InvestigateRawService) Get

Returns the raw eml of any non-benign message.

type InvestigateReclassifyNewParams

type InvestigateReclassifyNewParams struct {
	// Account Identifier
	AccountID           param.Field[string]                                            `path:"account_id,required"`
	ExpectedDisposition param.Field[InvestigateReclassifyNewParamsExpectedDisposition] `json:"expected_disposition,required"`
	// Base64 encoded content of the EML file
	EmlContent            param.Field[string] `json:"eml_content"`
	EscalatedSubmissionID param.Field[string] `json:"escalated_submission_id"`
}

func (InvestigateReclassifyNewParams) MarshalJSON

func (r InvestigateReclassifyNewParams) MarshalJSON() (data []byte, err error)

type InvestigateReclassifyNewParamsExpectedDisposition

type InvestigateReclassifyNewParamsExpectedDisposition string
const (
	InvestigateReclassifyNewParamsExpectedDispositionNone       InvestigateReclassifyNewParamsExpectedDisposition = "NONE"
	InvestigateReclassifyNewParamsExpectedDispositionBulk       InvestigateReclassifyNewParamsExpectedDisposition = "BULK"
	InvestigateReclassifyNewParamsExpectedDispositionMalicious  InvestigateReclassifyNewParamsExpectedDisposition = "MALICIOUS"
	InvestigateReclassifyNewParamsExpectedDispositionSpam       InvestigateReclassifyNewParamsExpectedDisposition = "SPAM"
	InvestigateReclassifyNewParamsExpectedDispositionSpoof      InvestigateReclassifyNewParamsExpectedDisposition = "SPOOF"
	InvestigateReclassifyNewParamsExpectedDispositionSuspicious InvestigateReclassifyNewParamsExpectedDisposition = "SUSPICIOUS"
)

func (InvestigateReclassifyNewParamsExpectedDisposition) IsKnown

type InvestigateReclassifyNewResponse

type InvestigateReclassifyNewResponse = interface{}

type InvestigateReclassifyNewResponseEnvelope

type InvestigateReclassifyNewResponseEnvelope struct {
	Errors   []shared.ResponseInfo                        `json:"errors,required"`
	Messages []shared.ResponseInfo                        `json:"messages,required"`
	Result   InvestigateReclassifyNewResponse             `json:"result,required"`
	Success  bool                                         `json:"success,required"`
	JSON     investigateReclassifyNewResponseEnvelopeJSON `json:"-"`
}

func (*InvestigateReclassifyNewResponseEnvelope) UnmarshalJSON

func (r *InvestigateReclassifyNewResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type InvestigateReclassifyService

type InvestigateReclassifyService struct {
	Options []option.RequestOption
}

InvestigateReclassifyService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewInvestigateReclassifyService method instead.

func NewInvestigateReclassifyService

func NewInvestigateReclassifyService(opts ...option.RequestOption) (r *InvestigateReclassifyService)

NewInvestigateReclassifyService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*InvestigateReclassifyService) New

Change email classfication

type InvestigateReleaseBulkParams

type InvestigateReleaseBulkParams struct {
	// Account Identifier
	AccountID param.Field[string] `path:"account_id,required"`
	// A list of messages identfied by their `postfix_id`s that should be released.
	Body []string `json:"body,required"`
}

func (InvestigateReleaseBulkParams) MarshalJSON

func (r InvestigateReleaseBulkParams) MarshalJSON() (data []byte, err error)

type InvestigateReleaseBulkResponse

type InvestigateReleaseBulkResponse struct {
	// The identifier of the message.
	PostfixID   string                             `json:"postfix_id,required"`
	Delivered   []string                           `json:"delivered,nullable"`
	Failed      []string                           `json:"failed,nullable"`
	Undelivered []string                           `json:"undelivered,nullable"`
	JSON        investigateReleaseBulkResponseJSON `json:"-"`
}

func (*InvestigateReleaseBulkResponse) UnmarshalJSON

func (r *InvestigateReleaseBulkResponse) UnmarshalJSON(data []byte) (err error)

type InvestigateReleaseService

type InvestigateReleaseService struct {
	Options []option.RequestOption
}

InvestigateReleaseService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewInvestigateReleaseService method instead.

func NewInvestigateReleaseService

func NewInvestigateReleaseService(opts ...option.RequestOption) (r *InvestigateReleaseService)

NewInvestigateReleaseService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*InvestigateReleaseService) Bulk

Release messages from quarantine

func (*InvestigateReleaseService) BulkAutoPaging

Release messages from quarantine

type InvestigateService

InvestigateService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewInvestigateService method instead.

func NewInvestigateService

func NewInvestigateService(opts ...option.RequestOption) (r *InvestigateService)

NewInvestigateService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*InvestigateService) Get

Get message details

func (*InvestigateService) List

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

func (*InvestigateService) ListAutoPaging

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

type InvestigateTraceGetParams

type InvestigateTraceGetParams struct {
	// Account Identifier
	AccountID param.Field[string] `path:"account_id,required"`
}

type InvestigateTraceGetResponse

type InvestigateTraceGetResponse struct {
	Inbound  InvestigateTraceGetResponseInbound  `json:"inbound,required"`
	Outbound InvestigateTraceGetResponseOutbound `json:"outbound,required"`
	JSON     investigateTraceGetResponseJSON     `json:"-"`
}

func (*InvestigateTraceGetResponse) UnmarshalJSON

func (r *InvestigateTraceGetResponse) UnmarshalJSON(data []byte) (err error)

type InvestigateTraceGetResponseEnvelope

type InvestigateTraceGetResponseEnvelope struct {
	Errors   []shared.ResponseInfo                   `json:"errors,required"`
	Messages []shared.ResponseInfo                   `json:"messages,required"`
	Result   InvestigateTraceGetResponse             `json:"result,required"`
	Success  bool                                    `json:"success,required"`
	JSON     investigateTraceGetResponseEnvelopeJSON `json:"-"`
}

func (*InvestigateTraceGetResponseEnvelope) UnmarshalJSON

func (r *InvestigateTraceGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type InvestigateTraceGetResponseInbound

type InvestigateTraceGetResponseInbound struct {
	Lines   []InvestigateTraceGetResponseInboundLine `json:"lines,nullable"`
	Pending bool                                     `json:"pending,nullable"`
	JSON    investigateTraceGetResponseInboundJSON   `json:"-"`
}

func (*InvestigateTraceGetResponseInbound) UnmarshalJSON

func (r *InvestigateTraceGetResponseInbound) UnmarshalJSON(data []byte) (err error)

type InvestigateTraceGetResponseInboundLine

type InvestigateTraceGetResponseInboundLine struct {
	Lineno  int64                                      `json:"lineno,required"`
	Message string                                     `json:"message,required"`
	Ts      time.Time                                  `json:"ts,required" format:"date-time"`
	JSON    investigateTraceGetResponseInboundLineJSON `json:"-"`
}

func (*InvestigateTraceGetResponseInboundLine) UnmarshalJSON

func (r *InvestigateTraceGetResponseInboundLine) UnmarshalJSON(data []byte) (err error)

type InvestigateTraceGetResponseOutbound

type InvestigateTraceGetResponseOutbound struct {
	Lines   []InvestigateTraceGetResponseOutboundLine `json:"lines,nullable"`
	Pending bool                                      `json:"pending,nullable"`
	JSON    investigateTraceGetResponseOutboundJSON   `json:"-"`
}

func (*InvestigateTraceGetResponseOutbound) UnmarshalJSON

func (r *InvestigateTraceGetResponseOutbound) UnmarshalJSON(data []byte) (err error)

type InvestigateTraceGetResponseOutboundLine

type InvestigateTraceGetResponseOutboundLine struct {
	Lineno  int64                                       `json:"lineno,required"`
	Message string                                      `json:"message,required"`
	Ts      time.Time                                   `json:"ts,required" format:"date-time"`
	JSON    investigateTraceGetResponseOutboundLineJSON `json:"-"`
}

func (*InvestigateTraceGetResponseOutboundLine) UnmarshalJSON

func (r *InvestigateTraceGetResponseOutboundLine) UnmarshalJSON(data []byte) (err error)

type InvestigateTraceService

type InvestigateTraceService struct {
	Options []option.RequestOption
}

InvestigateTraceService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewInvestigateTraceService method instead.

func NewInvestigateTraceService

func NewInvestigateTraceService(opts ...option.RequestOption) (r *InvestigateTraceService)

NewInvestigateTraceService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*InvestigateTraceService) Get

Get email trace

type Member

type Member = shared.Member

This is an alias to an internal type.

type MemberPoliciesAccess

type MemberPoliciesAccess = shared.MemberPoliciesAccess

Allow or deny operations against the resources.

This is an alias to an internal type.

type MemberPoliciesPermissionGroup

type MemberPoliciesPermissionGroup = shared.MemberPoliciesPermissionGroup

A named group of permissions that map to a group of operations against resources.

This is an alias to an internal type.

type MemberPoliciesPermissionGroupsMeta

type MemberPoliciesPermissionGroupsMeta = shared.MemberPoliciesPermissionGroupsMeta

Attributes associated to the permission group.

This is an alias to an internal type.

type MemberPoliciesResourceGroup

type MemberPoliciesResourceGroup = shared.MemberPoliciesResourceGroup

A group of scoped resources.

This is an alias to an internal type.

type MemberPoliciesResourceGroupsMeta

type MemberPoliciesResourceGroupsMeta = shared.MemberPoliciesResourceGroupsMeta

Attributes associated to the resource group.

This is an alias to an internal type.

type MemberPoliciesResourceGroupsScope

type MemberPoliciesResourceGroupsScope = shared.MemberPoliciesResourceGroupsScope

A scope is a combination of scope objects which provides additional context.

This is an alias to an internal type.

type MemberPoliciesResourceGroupsScopeObject

type MemberPoliciesResourceGroupsScopeObject = shared.MemberPoliciesResourceGroupsScopeObject

A scope object represents any resource that can have actions applied against invite.

This is an alias to an internal type.

type MemberPolicy

type MemberPolicy = shared.MemberPolicy

This is an alias to an internal type.

type MemberStatus

type MemberStatus = shared.MemberStatus

A member's status in the account.

This is an alias to an internal type.

type MemberUser

type MemberUser = shared.MemberUser

Details of the user associated to the membership.

This is an alias to an internal type.

type Permission

type Permission = shared.Permission

This is an alias to an internal type.

type PermissionGrant

type PermissionGrant = shared.PermissionGrant

This is an alias to an internal type.

type PermissionGrantParam

type PermissionGrantParam = shared.PermissionGrantParam

This is an alias to an internal type.

type RatePlan

type RatePlan = shared.RatePlan

The rate plan applied to the subscription.

This is an alias to an internal type.

type RatePlanID

type RatePlanID = shared.RatePlanID

The ID of the rate plan.

This is an alias to an internal type.

type RatePlanParam

type RatePlanParam = shared.RatePlanParam

The rate plan applied to the subscription.

This is an alias to an internal type.

type ResponseInfo

type ResponseInfo = shared.ResponseInfo

This is an alias to an internal type.

type ResponseInfoSource

type ResponseInfoSource = shared.ResponseInfoSource

This is an alias to an internal type.

type Role

type Role = shared.Role

This is an alias to an internal type.

type RoleParam

type RoleParam = shared.RoleParam

This is an alias to an internal type.

type RolePermissions

type RolePermissions = shared.RolePermissions

This is an alias to an internal type.

type RolePermissionsParam

type RolePermissionsParam = shared.RolePermissionsParam

This is an alias to an internal type.

type SettingAllowPolicyDeleteParams

type SettingAllowPolicyDeleteParams struct {
	// Account Identifier
	AccountID param.Field[string] `path:"account_id,required"`
}

type SettingAllowPolicyDeleteResponse

type SettingAllowPolicyDeleteResponse struct {
	// The unique identifier for the allow policy.
	ID   int64                                `json:"id,required"`
	JSON settingAllowPolicyDeleteResponseJSON `json:"-"`
}

func (*SettingAllowPolicyDeleteResponse) UnmarshalJSON

func (r *SettingAllowPolicyDeleteResponse) UnmarshalJSON(data []byte) (err error)

type SettingAllowPolicyDeleteResponseEnvelope

type SettingAllowPolicyDeleteResponseEnvelope struct {
	Errors   []shared.ResponseInfo                        `json:"errors,required"`
	Messages []shared.ResponseInfo                        `json:"messages,required"`
	Result   SettingAllowPolicyDeleteResponse             `json:"result,required"`
	Success  bool                                         `json:"success,required"`
	JSON     settingAllowPolicyDeleteResponseEnvelopeJSON `json:"-"`
}

func (*SettingAllowPolicyDeleteResponseEnvelope) UnmarshalJSON

func (r *SettingAllowPolicyDeleteResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type SettingAllowPolicyEditParams

type SettingAllowPolicyEditParams struct {
	// Account Identifier
	AccountID param.Field[string] `path:"account_id,required"`
	Comments  param.Field[string] `json:"comments"`
	// Messages from this sender will be exempted from Spam, Spoof and Bulk
	// dispositions. Note: This will not exempt messages with Malicious or Suspicious
	// dispositions.
	IsAcceptableSender param.Field[bool] `json:"is_acceptable_sender"`
	// Messages to this recipient will bypass all detections.
	IsExemptRecipient param.Field[bool] `json:"is_exempt_recipient"`
	IsRegex           param.Field[bool] `json:"is_regex"`
	// Messages from this sender will bypass all detections and link following.
	IsTrustedSender param.Field[bool]                                    `json:"is_trusted_sender"`
	Pattern         param.Field[string]                                  `json:"pattern"`
	PatternType     param.Field[SettingAllowPolicyEditParamsPatternType] `json:"pattern_type"`
	// Enforce DMARC, SPF or DKIM authentication. When on, Email Security only honors
	// policies that pass authentication.
	VerifySender param.Field[bool] `json:"verify_sender"`
}

func (SettingAllowPolicyEditParams) MarshalJSON

func (r SettingAllowPolicyEditParams) MarshalJSON() (data []byte, err error)

type SettingAllowPolicyEditParamsPatternType

type SettingAllowPolicyEditParamsPatternType string
const (
	SettingAllowPolicyEditParamsPatternTypeEmail   SettingAllowPolicyEditParamsPatternType = "EMAIL"
	SettingAllowPolicyEditParamsPatternTypeDomain  SettingAllowPolicyEditParamsPatternType = "DOMAIN"
	SettingAllowPolicyEditParamsPatternTypeIP      SettingAllowPolicyEditParamsPatternType = "IP"
	SettingAllowPolicyEditParamsPatternTypeUnknown SettingAllowPolicyEditParamsPatternType = "UNKNOWN"
)

func (SettingAllowPolicyEditParamsPatternType) IsKnown

type SettingAllowPolicyEditResponse

type SettingAllowPolicyEditResponse struct {
	// The unique identifier for the allow policy.
	ID        int64     `json:"id,required"`
	CreatedAt time.Time `json:"created_at,required" format:"date-time"`
	// Messages from this sender will be exempted from Spam, Spoof and Bulk
	// dispositions. Note: This will not exempt messages with Malicious or Suspicious
	// dispositions.
	IsAcceptableSender bool `json:"is_acceptable_sender,required"`
	// Messages to this recipient will bypass all detections.
	IsExemptRecipient bool `json:"is_exempt_recipient,required"`
	IsRegex           bool `json:"is_regex,required"`
	// Messages from this sender will bypass all detections and link following.
	IsTrustedSender bool                                      `json:"is_trusted_sender,required"`
	LastModified    time.Time                                 `json:"last_modified,required" format:"date-time"`
	Pattern         string                                    `json:"pattern,required"`
	PatternType     SettingAllowPolicyEditResponsePatternType `json:"pattern_type,required"`
	// Enforce DMARC, SPF or DKIM authentication. When on, Email Security only honors
	// policies that pass authentication.
	VerifySender bool   `json:"verify_sender,required"`
	Comments     string `json:"comments,nullable"`
	// Deprecated: deprecated
	IsRecipient bool `json:"is_recipient"`
	// Deprecated: deprecated
	IsSender bool `json:"is_sender"`
	// Deprecated: deprecated
	IsSpoof bool                               `json:"is_spoof"`
	JSON    settingAllowPolicyEditResponseJSON `json:"-"`
}

func (*SettingAllowPolicyEditResponse) UnmarshalJSON

func (r *SettingAllowPolicyEditResponse) UnmarshalJSON(data []byte) (err error)

type SettingAllowPolicyEditResponseEnvelope

type SettingAllowPolicyEditResponseEnvelope struct {
	Errors   []shared.ResponseInfo                      `json:"errors,required"`
	Messages []shared.ResponseInfo                      `json:"messages,required"`
	Result   SettingAllowPolicyEditResponse             `json:"result,required"`
	Success  bool                                       `json:"success,required"`
	JSON     settingAllowPolicyEditResponseEnvelopeJSON `json:"-"`
}

func (*SettingAllowPolicyEditResponseEnvelope) UnmarshalJSON

func (r *SettingAllowPolicyEditResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type SettingAllowPolicyEditResponsePatternType

type SettingAllowPolicyEditResponsePatternType string
const (
	SettingAllowPolicyEditResponsePatternTypeEmail   SettingAllowPolicyEditResponsePatternType = "EMAIL"
	SettingAllowPolicyEditResponsePatternTypeDomain  SettingAllowPolicyEditResponsePatternType = "DOMAIN"
	SettingAllowPolicyEditResponsePatternTypeIP      SettingAllowPolicyEditResponsePatternType = "IP"
	SettingAllowPolicyEditResponsePatternTypeUnknown SettingAllowPolicyEditResponsePatternType = "UNKNOWN"
)

func (SettingAllowPolicyEditResponsePatternType) IsKnown

type SettingAllowPolicyGetParams

type SettingAllowPolicyGetParams struct {
	// Account Identifier
	AccountID param.Field[string] `path:"account_id,required"`
}

type SettingAllowPolicyGetResponse

type SettingAllowPolicyGetResponse struct {
	// The unique identifier for the allow policy.
	ID        int64     `json:"id,required"`
	CreatedAt time.Time `json:"created_at,required" format:"date-time"`
	// Messages from this sender will be exempted from Spam, Spoof and Bulk
	// dispositions. Note: This will not exempt messages with Malicious or Suspicious
	// dispositions.
	IsAcceptableSender bool `json:"is_acceptable_sender,required"`
	// Messages to this recipient will bypass all detections.
	IsExemptRecipient bool `json:"is_exempt_recipient,required"`
	IsRegex           bool `json:"is_regex,required"`
	// Messages from this sender will bypass all detections and link following.
	IsTrustedSender bool                                     `json:"is_trusted_sender,required"`
	LastModified    time.Time                                `json:"last_modified,required" format:"date-time"`
	Pattern         string                                   `json:"pattern,required"`
	PatternType     SettingAllowPolicyGetResponsePatternType `json:"pattern_type,required"`
	// Enforce DMARC, SPF or DKIM authentication. When on, Email Security only honors
	// policies that pass authentication.
	VerifySender bool   `json:"verify_sender,required"`
	Comments     string `json:"comments,nullable"`
	// Deprecated: deprecated
	IsRecipient bool `json:"is_recipient"`
	// Deprecated: deprecated
	IsSender bool `json:"is_sender"`
	// Deprecated: deprecated
	IsSpoof bool                              `json:"is_spoof"`
	JSON    settingAllowPolicyGetResponseJSON `json:"-"`
}

func (*SettingAllowPolicyGetResponse) UnmarshalJSON

func (r *SettingAllowPolicyGetResponse) UnmarshalJSON(data []byte) (err error)

type SettingAllowPolicyGetResponseEnvelope

type SettingAllowPolicyGetResponseEnvelope struct {
	Errors   []shared.ResponseInfo                     `json:"errors,required"`
	Messages []shared.ResponseInfo                     `json:"messages,required"`
	Result   SettingAllowPolicyGetResponse             `json:"result,required"`
	Success  bool                                      `json:"success,required"`
	JSON     settingAllowPolicyGetResponseEnvelopeJSON `json:"-"`
}

func (*SettingAllowPolicyGetResponseEnvelope) UnmarshalJSON

func (r *SettingAllowPolicyGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type SettingAllowPolicyGetResponsePatternType

type SettingAllowPolicyGetResponsePatternType string
const (
	SettingAllowPolicyGetResponsePatternTypeEmail   SettingAllowPolicyGetResponsePatternType = "EMAIL"
	SettingAllowPolicyGetResponsePatternTypeDomain  SettingAllowPolicyGetResponsePatternType = "DOMAIN"
	SettingAllowPolicyGetResponsePatternTypeIP      SettingAllowPolicyGetResponsePatternType = "IP"
	SettingAllowPolicyGetResponsePatternTypeUnknown SettingAllowPolicyGetResponsePatternType = "UNKNOWN"
)

func (SettingAllowPolicyGetResponsePatternType) IsKnown

type SettingAllowPolicyListParams

type SettingAllowPolicyListParams struct {
	// Account Identifier
	AccountID param.Field[string] `path:"account_id,required"`
	// The sorting direction.
	Direction          param.Field[SettingAllowPolicyListParamsDirection] `query:"direction"`
	IsAcceptableSender param.Field[bool]                                  `query:"is_acceptable_sender"`
	IsExemptRecipient  param.Field[bool]                                  `query:"is_exempt_recipient"`
	IsRecipient        param.Field[bool]                                  `query:"is_recipient"`
	IsSender           param.Field[bool]                                  `query:"is_sender"`
	IsSpoof            param.Field[bool]                                  `query:"is_spoof"`
	IsTrustedSender    param.Field[bool]                                  `query:"is_trusted_sender"`
	// The field to sort by.
	Order param.Field[SettingAllowPolicyListParamsOrder] `query:"order"`
	// The page number of paginated results.
	Page        param.Field[int64]                                   `query:"page"`
	Pattern     param.Field[string]                                  `query:"pattern"`
	PatternType param.Field[SettingAllowPolicyListParamsPatternType] `query:"pattern_type"`
	// The number of results per page.
	PerPage param.Field[int64] `query:"per_page"`
	// Allows searching in multiple properties of a record simultaneously. This
	// parameter is intended for human users, not automation. Its exact behavior is
	// intentionally left unspecified and is subject to change in the future.
	Search       param.Field[string] `query:"search"`
	VerifySender param.Field[bool]   `query:"verify_sender"`
}

func (SettingAllowPolicyListParams) URLQuery

func (r SettingAllowPolicyListParams) URLQuery() (v url.Values)

URLQuery serializes SettingAllowPolicyListParams's query parameters as `url.Values`.

type SettingAllowPolicyListParamsDirection

type SettingAllowPolicyListParamsDirection string

The sorting direction.

const (
	SettingAllowPolicyListParamsDirectionAsc  SettingAllowPolicyListParamsDirection = "asc"
	SettingAllowPolicyListParamsDirectionDesc SettingAllowPolicyListParamsDirection = "desc"
)

func (SettingAllowPolicyListParamsDirection) IsKnown

type SettingAllowPolicyListParamsOrder

type SettingAllowPolicyListParamsOrder string

The field to sort by.

const (
	SettingAllowPolicyListParamsOrderPattern   SettingAllowPolicyListParamsOrder = "pattern"
	SettingAllowPolicyListParamsOrderCreatedAt SettingAllowPolicyListParamsOrder = "created_at"
)

func (SettingAllowPolicyListParamsOrder) IsKnown

type SettingAllowPolicyListParamsPatternType

type SettingAllowPolicyListParamsPatternType string
const (
	SettingAllowPolicyListParamsPatternTypeEmail   SettingAllowPolicyListParamsPatternType = "EMAIL"
	SettingAllowPolicyListParamsPatternTypeDomain  SettingAllowPolicyListParamsPatternType = "DOMAIN"
	SettingAllowPolicyListParamsPatternTypeIP      SettingAllowPolicyListParamsPatternType = "IP"
	SettingAllowPolicyListParamsPatternTypeUnknown SettingAllowPolicyListParamsPatternType = "UNKNOWN"
)

func (SettingAllowPolicyListParamsPatternType) IsKnown

type SettingAllowPolicyListResponse

type SettingAllowPolicyListResponse struct {
	// The unique identifier for the allow policy.
	ID        int64     `json:"id,required"`
	CreatedAt time.Time `json:"created_at,required" format:"date-time"`
	// Messages from this sender will be exempted from Spam, Spoof and Bulk
	// dispositions. Note: This will not exempt messages with Malicious or Suspicious
	// dispositions.
	IsAcceptableSender bool `json:"is_acceptable_sender,required"`
	// Messages to this recipient will bypass all detections.
	IsExemptRecipient bool `json:"is_exempt_recipient,required"`
	IsRegex           bool `json:"is_regex,required"`
	// Messages from this sender will bypass all detections and link following.
	IsTrustedSender bool                                      `json:"is_trusted_sender,required"`
	LastModified    time.Time                                 `json:"last_modified,required" format:"date-time"`
	Pattern         string                                    `json:"pattern,required"`
	PatternType     SettingAllowPolicyListResponsePatternType `json:"pattern_type,required"`
	// Enforce DMARC, SPF or DKIM authentication. When on, Email Security only honors
	// policies that pass authentication.
	VerifySender bool   `json:"verify_sender,required"`
	Comments     string `json:"comments,nullable"`
	// Deprecated: deprecated
	IsRecipient bool `json:"is_recipient"`
	// Deprecated: deprecated
	IsSender bool `json:"is_sender"`
	// Deprecated: deprecated
	IsSpoof bool                               `json:"is_spoof"`
	JSON    settingAllowPolicyListResponseJSON `json:"-"`
}

func (*SettingAllowPolicyListResponse) UnmarshalJSON

func (r *SettingAllowPolicyListResponse) UnmarshalJSON(data []byte) (err error)

type SettingAllowPolicyListResponsePatternType

type SettingAllowPolicyListResponsePatternType string
const (
	SettingAllowPolicyListResponsePatternTypeEmail   SettingAllowPolicyListResponsePatternType = "EMAIL"
	SettingAllowPolicyListResponsePatternTypeDomain  SettingAllowPolicyListResponsePatternType = "DOMAIN"
	SettingAllowPolicyListResponsePatternTypeIP      SettingAllowPolicyListResponsePatternType = "IP"
	SettingAllowPolicyListResponsePatternTypeUnknown SettingAllowPolicyListResponsePatternType = "UNKNOWN"
)

func (SettingAllowPolicyListResponsePatternType) IsKnown

type SettingAllowPolicyNewParams

type SettingAllowPolicyNewParams struct {
	// Account Identifier
	AccountID param.Field[string] `path:"account_id,required"`
	// Messages from this sender will be exempted from Spam, Spoof and Bulk
	// dispositions. Note: This will not exempt messages with Malicious or Suspicious
	// dispositions.
	IsAcceptableSender param.Field[bool] `json:"is_acceptable_sender,required"`
	// Messages to this recipient will bypass all detections.
	IsExemptRecipient param.Field[bool] `json:"is_exempt_recipient,required"`
	IsRegex           param.Field[bool] `json:"is_regex,required"`
	// Messages from this sender will bypass all detections and link following.
	IsTrustedSender param.Field[bool]                                   `json:"is_trusted_sender,required"`
	Pattern         param.Field[string]                                 `json:"pattern,required"`
	PatternType     param.Field[SettingAllowPolicyNewParamsPatternType] `json:"pattern_type,required"`
	// Enforce DMARC, SPF or DKIM authentication. When on, Email Security only honors
	// policies that pass authentication.
	VerifySender param.Field[bool]   `json:"verify_sender,required"`
	Comments     param.Field[string] `json:"comments"`
	IsRecipient  param.Field[bool]   `json:"is_recipient"`
	IsSender     param.Field[bool]   `json:"is_sender"`
	IsSpoof      param.Field[bool]   `json:"is_spoof"`
}

func (SettingAllowPolicyNewParams) MarshalJSON

func (r SettingAllowPolicyNewParams) MarshalJSON() (data []byte, err error)

type SettingAllowPolicyNewParamsPatternType

type SettingAllowPolicyNewParamsPatternType string
const (
	SettingAllowPolicyNewParamsPatternTypeEmail   SettingAllowPolicyNewParamsPatternType = "EMAIL"
	SettingAllowPolicyNewParamsPatternTypeDomain  SettingAllowPolicyNewParamsPatternType = "DOMAIN"
	SettingAllowPolicyNewParamsPatternTypeIP      SettingAllowPolicyNewParamsPatternType = "IP"
	SettingAllowPolicyNewParamsPatternTypeUnknown SettingAllowPolicyNewParamsPatternType = "UNKNOWN"
)

func (SettingAllowPolicyNewParamsPatternType) IsKnown

type SettingAllowPolicyNewResponse

type SettingAllowPolicyNewResponse struct {
	// The unique identifier for the allow policy.
	ID        int64     `json:"id,required"`
	CreatedAt time.Time `json:"created_at,required" format:"date-time"`
	// Messages from this sender will be exempted from Spam, Spoof and Bulk
	// dispositions. Note: This will not exempt messages with Malicious or Suspicious
	// dispositions.
	IsAcceptableSender bool `json:"is_acceptable_sender,required"`
	// Messages to this recipient will bypass all detections.
	IsExemptRecipient bool `json:"is_exempt_recipient,required"`
	IsRegex           bool `json:"is_regex,required"`
	// Messages from this sender will bypass all detections and link following.
	IsTrustedSender bool                                     `json:"is_trusted_sender,required"`
	LastModified    time.Time                                `json:"last_modified,required" format:"date-time"`
	Pattern         string                                   `json:"pattern,required"`
	PatternType     SettingAllowPolicyNewResponsePatternType `json:"pattern_type,required"`
	// Enforce DMARC, SPF or DKIM authentication. When on, Email Security only honors
	// policies that pass authentication.
	VerifySender bool   `json:"verify_sender,required"`
	Comments     string `json:"comments,nullable"`
	// Deprecated: deprecated
	IsRecipient bool `json:"is_recipient"`
	// Deprecated: deprecated
	IsSender bool `json:"is_sender"`
	// Deprecated: deprecated
	IsSpoof bool                              `json:"is_spoof"`
	JSON    settingAllowPolicyNewResponseJSON `json:"-"`
}

func (*SettingAllowPolicyNewResponse) UnmarshalJSON

func (r *SettingAllowPolicyNewResponse) UnmarshalJSON(data []byte) (err error)

type SettingAllowPolicyNewResponseEnvelope

type SettingAllowPolicyNewResponseEnvelope struct {
	Errors   []shared.ResponseInfo                     `json:"errors,required"`
	Messages []shared.ResponseInfo                     `json:"messages,required"`
	Result   SettingAllowPolicyNewResponse             `json:"result,required"`
	Success  bool                                      `json:"success,required"`
	JSON     settingAllowPolicyNewResponseEnvelopeJSON `json:"-"`
}

func (*SettingAllowPolicyNewResponseEnvelope) UnmarshalJSON

func (r *SettingAllowPolicyNewResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type SettingAllowPolicyNewResponsePatternType

type SettingAllowPolicyNewResponsePatternType string
const (
	SettingAllowPolicyNewResponsePatternTypeEmail   SettingAllowPolicyNewResponsePatternType = "EMAIL"
	SettingAllowPolicyNewResponsePatternTypeDomain  SettingAllowPolicyNewResponsePatternType = "DOMAIN"
	SettingAllowPolicyNewResponsePatternTypeIP      SettingAllowPolicyNewResponsePatternType = "IP"
	SettingAllowPolicyNewResponsePatternTypeUnknown SettingAllowPolicyNewResponsePatternType = "UNKNOWN"
)

func (SettingAllowPolicyNewResponsePatternType) IsKnown

type SettingAllowPolicyService

type SettingAllowPolicyService struct {
	Options []option.RequestOption
}

SettingAllowPolicyService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewSettingAllowPolicyService method instead.

func NewSettingAllowPolicyService

func NewSettingAllowPolicyService(opts ...option.RequestOption) (r *SettingAllowPolicyService)

NewSettingAllowPolicyService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*SettingAllowPolicyService) Delete

Delete an email allow policy

func (*SettingAllowPolicyService) Edit

Update an email allow policy

func (*SettingAllowPolicyService) Get

Get an email allow policy

func (*SettingAllowPolicyService) List

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

func (*SettingAllowPolicyService) ListAutoPaging

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

func (*SettingAllowPolicyService) New

Create an email allow policy

type SettingBlockSenderDeleteParams

type SettingBlockSenderDeleteParams struct {
	// Account Identifier
	AccountID param.Field[string] `path:"account_id,required"`
}

type SettingBlockSenderDeleteResponse

type SettingBlockSenderDeleteResponse struct {
	// The unique identifier for the allow policy.
	ID   int64                                `json:"id,required"`
	JSON settingBlockSenderDeleteResponseJSON `json:"-"`
}

func (*SettingBlockSenderDeleteResponse) UnmarshalJSON

func (r *SettingBlockSenderDeleteResponse) UnmarshalJSON(data []byte) (err error)

type SettingBlockSenderDeleteResponseEnvelope

type SettingBlockSenderDeleteResponseEnvelope struct {
	Errors   []shared.ResponseInfo                        `json:"errors,required"`
	Messages []shared.ResponseInfo                        `json:"messages,required"`
	Result   SettingBlockSenderDeleteResponse             `json:"result,required"`
	Success  bool                                         `json:"success,required"`
	JSON     settingBlockSenderDeleteResponseEnvelopeJSON `json:"-"`
}

func (*SettingBlockSenderDeleteResponseEnvelope) UnmarshalJSON

func (r *SettingBlockSenderDeleteResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type SettingBlockSenderEditParams

type SettingBlockSenderEditParams struct {
	// Account Identifier
	AccountID   param.Field[string]                                  `path:"account_id,required"`
	Comments    param.Field[string]                                  `json:"comments"`
	IsRegex     param.Field[bool]                                    `json:"is_regex"`
	Pattern     param.Field[string]                                  `json:"pattern"`
	PatternType param.Field[SettingBlockSenderEditParamsPatternType] `json:"pattern_type"`
}

func (SettingBlockSenderEditParams) MarshalJSON

func (r SettingBlockSenderEditParams) MarshalJSON() (data []byte, err error)

type SettingBlockSenderEditParamsPatternType

type SettingBlockSenderEditParamsPatternType string
const (
	SettingBlockSenderEditParamsPatternTypeEmail   SettingBlockSenderEditParamsPatternType = "EMAIL"
	SettingBlockSenderEditParamsPatternTypeDomain  SettingBlockSenderEditParamsPatternType = "DOMAIN"
	SettingBlockSenderEditParamsPatternTypeIP      SettingBlockSenderEditParamsPatternType = "IP"
	SettingBlockSenderEditParamsPatternTypeUnknown SettingBlockSenderEditParamsPatternType = "UNKNOWN"
)

func (SettingBlockSenderEditParamsPatternType) IsKnown

type SettingBlockSenderEditResponse

type SettingBlockSenderEditResponse struct {
	// The unique identifier for the allow policy.
	ID           int64                                     `json:"id,required"`
	CreatedAt    time.Time                                 `json:"created_at,required" format:"date-time"`
	IsRegex      bool                                      `json:"is_regex,required"`
	LastModified time.Time                                 `json:"last_modified,required" format:"date-time"`
	Pattern      string                                    `json:"pattern,required"`
	PatternType  SettingBlockSenderEditResponsePatternType `json:"pattern_type,required"`
	Comments     string                                    `json:"comments,nullable"`
	JSON         settingBlockSenderEditResponseJSON        `json:"-"`
}

func (*SettingBlockSenderEditResponse) UnmarshalJSON

func (r *SettingBlockSenderEditResponse) UnmarshalJSON(data []byte) (err error)

type SettingBlockSenderEditResponseEnvelope

type SettingBlockSenderEditResponseEnvelope struct {
	Errors   []shared.ResponseInfo                      `json:"errors,required"`
	Messages []shared.ResponseInfo                      `json:"messages,required"`
	Result   SettingBlockSenderEditResponse             `json:"result,required"`
	Success  bool                                       `json:"success,required"`
	JSON     settingBlockSenderEditResponseEnvelopeJSON `json:"-"`
}

func (*SettingBlockSenderEditResponseEnvelope) UnmarshalJSON

func (r *SettingBlockSenderEditResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type SettingBlockSenderEditResponsePatternType

type SettingBlockSenderEditResponsePatternType string
const (
	SettingBlockSenderEditResponsePatternTypeEmail   SettingBlockSenderEditResponsePatternType = "EMAIL"
	SettingBlockSenderEditResponsePatternTypeDomain  SettingBlockSenderEditResponsePatternType = "DOMAIN"
	SettingBlockSenderEditResponsePatternTypeIP      SettingBlockSenderEditResponsePatternType = "IP"
	SettingBlockSenderEditResponsePatternTypeUnknown SettingBlockSenderEditResponsePatternType = "UNKNOWN"
)

func (SettingBlockSenderEditResponsePatternType) IsKnown

type SettingBlockSenderGetParams

type SettingBlockSenderGetParams struct {
	// Account Identifier
	AccountID param.Field[string] `path:"account_id,required"`
}

type SettingBlockSenderGetResponse

type SettingBlockSenderGetResponse struct {
	// The unique identifier for the allow policy.
	ID           int64                                    `json:"id,required"`
	CreatedAt    time.Time                                `json:"created_at,required" format:"date-time"`
	IsRegex      bool                                     `json:"is_regex,required"`
	LastModified time.Time                                `json:"last_modified,required" format:"date-time"`
	Pattern      string                                   `json:"pattern,required"`
	PatternType  SettingBlockSenderGetResponsePatternType `json:"pattern_type,required"`
	Comments     string                                   `json:"comments,nullable"`
	JSON         settingBlockSenderGetResponseJSON        `json:"-"`
}

func (*SettingBlockSenderGetResponse) UnmarshalJSON

func (r *SettingBlockSenderGetResponse) UnmarshalJSON(data []byte) (err error)

type SettingBlockSenderGetResponseEnvelope

type SettingBlockSenderGetResponseEnvelope struct {
	Errors   []shared.ResponseInfo                     `json:"errors,required"`
	Messages []shared.ResponseInfo                     `json:"messages,required"`
	Result   SettingBlockSenderGetResponse             `json:"result,required"`
	Success  bool                                      `json:"success,required"`
	JSON     settingBlockSenderGetResponseEnvelopeJSON `json:"-"`
}

func (*SettingBlockSenderGetResponseEnvelope) UnmarshalJSON

func (r *SettingBlockSenderGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type SettingBlockSenderGetResponsePatternType

type SettingBlockSenderGetResponsePatternType string
const (
	SettingBlockSenderGetResponsePatternTypeEmail   SettingBlockSenderGetResponsePatternType = "EMAIL"
	SettingBlockSenderGetResponsePatternTypeDomain  SettingBlockSenderGetResponsePatternType = "DOMAIN"
	SettingBlockSenderGetResponsePatternTypeIP      SettingBlockSenderGetResponsePatternType = "IP"
	SettingBlockSenderGetResponsePatternTypeUnknown SettingBlockSenderGetResponsePatternType = "UNKNOWN"
)

func (SettingBlockSenderGetResponsePatternType) IsKnown

type SettingBlockSenderListParams

type SettingBlockSenderListParams struct {
	// Account Identifier
	AccountID param.Field[string] `path:"account_id,required"`
	// The sorting direction.
	Direction param.Field[SettingBlockSenderListParamsDirection] `query:"direction"`
	// The field to sort by.
	Order param.Field[SettingBlockSenderListParamsOrder] `query:"order"`
	// The page number of paginated results.
	Page        param.Field[int64]                                   `query:"page"`
	Pattern     param.Field[string]                                  `query:"pattern"`
	PatternType param.Field[SettingBlockSenderListParamsPatternType] `query:"pattern_type"`
	// The number of results per page.
	PerPage param.Field[int64] `query:"per_page"`
	// Allows searching in multiple properties of a record simultaneously. This
	// parameter is intended for human users, not automation. Its exact behavior is
	// intentionally left unspecified and is subject to change in the future.
	Search param.Field[string] `query:"search"`
}

func (SettingBlockSenderListParams) URLQuery

func (r SettingBlockSenderListParams) URLQuery() (v url.Values)

URLQuery serializes SettingBlockSenderListParams's query parameters as `url.Values`.

type SettingBlockSenderListParamsDirection

type SettingBlockSenderListParamsDirection string

The sorting direction.

const (
	SettingBlockSenderListParamsDirectionAsc  SettingBlockSenderListParamsDirection = "asc"
	SettingBlockSenderListParamsDirectionDesc SettingBlockSenderListParamsDirection = "desc"
)

func (SettingBlockSenderListParamsDirection) IsKnown

type SettingBlockSenderListParamsOrder

type SettingBlockSenderListParamsOrder string

The field to sort by.

const (
	SettingBlockSenderListParamsOrderPattern   SettingBlockSenderListParamsOrder = "pattern"
	SettingBlockSenderListParamsOrderCreatedAt SettingBlockSenderListParamsOrder = "created_at"
)

func (SettingBlockSenderListParamsOrder) IsKnown

type SettingBlockSenderListParamsPatternType

type SettingBlockSenderListParamsPatternType string
const (
	SettingBlockSenderListParamsPatternTypeEmail   SettingBlockSenderListParamsPatternType = "EMAIL"
	SettingBlockSenderListParamsPatternTypeDomain  SettingBlockSenderListParamsPatternType = "DOMAIN"
	SettingBlockSenderListParamsPatternTypeIP      SettingBlockSenderListParamsPatternType = "IP"
	SettingBlockSenderListParamsPatternTypeUnknown SettingBlockSenderListParamsPatternType = "UNKNOWN"
)

func (SettingBlockSenderListParamsPatternType) IsKnown

type SettingBlockSenderListResponse

type SettingBlockSenderListResponse struct {
	// The unique identifier for the allow policy.
	ID           int64                                     `json:"id,required"`
	CreatedAt    time.Time                                 `json:"created_at,required" format:"date-time"`
	IsRegex      bool                                      `json:"is_regex,required"`
	LastModified time.Time                                 `json:"last_modified,required" format:"date-time"`
	Pattern      string                                    `json:"pattern,required"`
	PatternType  SettingBlockSenderListResponsePatternType `json:"pattern_type,required"`
	Comments     string                                    `json:"comments,nullable"`
	JSON         settingBlockSenderListResponseJSON        `json:"-"`
}

func (*SettingBlockSenderListResponse) UnmarshalJSON

func (r *SettingBlockSenderListResponse) UnmarshalJSON(data []byte) (err error)

type SettingBlockSenderListResponsePatternType

type SettingBlockSenderListResponsePatternType string
const (
	SettingBlockSenderListResponsePatternTypeEmail   SettingBlockSenderListResponsePatternType = "EMAIL"
	SettingBlockSenderListResponsePatternTypeDomain  SettingBlockSenderListResponsePatternType = "DOMAIN"
	SettingBlockSenderListResponsePatternTypeIP      SettingBlockSenderListResponsePatternType = "IP"
	SettingBlockSenderListResponsePatternTypeUnknown SettingBlockSenderListResponsePatternType = "UNKNOWN"
)

func (SettingBlockSenderListResponsePatternType) IsKnown

type SettingBlockSenderNewParams

type SettingBlockSenderNewParams struct {
	// Account Identifier
	AccountID   param.Field[string]                                 `path:"account_id,required"`
	IsRegex     param.Field[bool]                                   `json:"is_regex,required"`
	Pattern     param.Field[string]                                 `json:"pattern,required"`
	PatternType param.Field[SettingBlockSenderNewParamsPatternType] `json:"pattern_type,required"`
	Comments    param.Field[string]                                 `json:"comments"`
}

func (SettingBlockSenderNewParams) MarshalJSON

func (r SettingBlockSenderNewParams) MarshalJSON() (data []byte, err error)

type SettingBlockSenderNewParamsPatternType

type SettingBlockSenderNewParamsPatternType string
const (
	SettingBlockSenderNewParamsPatternTypeEmail   SettingBlockSenderNewParamsPatternType = "EMAIL"
	SettingBlockSenderNewParamsPatternTypeDomain  SettingBlockSenderNewParamsPatternType = "DOMAIN"
	SettingBlockSenderNewParamsPatternTypeIP      SettingBlockSenderNewParamsPatternType = "IP"
	SettingBlockSenderNewParamsPatternTypeUnknown SettingBlockSenderNewParamsPatternType = "UNKNOWN"
)

func (SettingBlockSenderNewParamsPatternType) IsKnown

type SettingBlockSenderNewResponse

type SettingBlockSenderNewResponse struct {
	// The unique identifier for the allow policy.
	ID           int64                                    `json:"id,required"`
	CreatedAt    time.Time                                `json:"created_at,required" format:"date-time"`
	IsRegex      bool                                     `json:"is_regex,required"`
	LastModified time.Time                                `json:"last_modified,required" format:"date-time"`
	Pattern      string                                   `json:"pattern,required"`
	PatternType  SettingBlockSenderNewResponsePatternType `json:"pattern_type,required"`
	Comments     string                                   `json:"comments,nullable"`
	JSON         settingBlockSenderNewResponseJSON        `json:"-"`
}

func (*SettingBlockSenderNewResponse) UnmarshalJSON

func (r *SettingBlockSenderNewResponse) UnmarshalJSON(data []byte) (err error)

type SettingBlockSenderNewResponseEnvelope

type SettingBlockSenderNewResponseEnvelope struct {
	Errors   []shared.ResponseInfo                     `json:"errors,required"`
	Messages []shared.ResponseInfo                     `json:"messages,required"`
	Result   SettingBlockSenderNewResponse             `json:"result,required"`
	Success  bool                                      `json:"success,required"`
	JSON     settingBlockSenderNewResponseEnvelopeJSON `json:"-"`
}

func (*SettingBlockSenderNewResponseEnvelope) UnmarshalJSON

func (r *SettingBlockSenderNewResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type SettingBlockSenderNewResponsePatternType

type SettingBlockSenderNewResponsePatternType string
const (
	SettingBlockSenderNewResponsePatternTypeEmail   SettingBlockSenderNewResponsePatternType = "EMAIL"
	SettingBlockSenderNewResponsePatternTypeDomain  SettingBlockSenderNewResponsePatternType = "DOMAIN"
	SettingBlockSenderNewResponsePatternTypeIP      SettingBlockSenderNewResponsePatternType = "IP"
	SettingBlockSenderNewResponsePatternTypeUnknown SettingBlockSenderNewResponsePatternType = "UNKNOWN"
)

func (SettingBlockSenderNewResponsePatternType) IsKnown

type SettingBlockSenderService

type SettingBlockSenderService struct {
	Options []option.RequestOption
}

SettingBlockSenderService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewSettingBlockSenderService method instead.

func NewSettingBlockSenderService

func NewSettingBlockSenderService(opts ...option.RequestOption) (r *SettingBlockSenderService)

NewSettingBlockSenderService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*SettingBlockSenderService) Delete

Delete a blocked email sender

func (*SettingBlockSenderService) Edit

Update a blocked email sender

func (*SettingBlockSenderService) Get

Get a blocked email sender

func (*SettingBlockSenderService) List

List blocked email senders

func (*SettingBlockSenderService) ListAutoPaging

List blocked email senders

func (*SettingBlockSenderService) New

Create a blocked email sender

type SettingDomainBulkDeleteParams

type SettingDomainBulkDeleteParams struct {
	// Account Identifier
	AccountID param.Field[string] `path:"account_id,required"`
}

type SettingDomainBulkDeleteResponse

type SettingDomainBulkDeleteResponse struct {
	// The unique identifier for the domain.
	ID   int64                               `json:"id,required"`
	JSON settingDomainBulkDeleteResponseJSON `json:"-"`
}

func (*SettingDomainBulkDeleteResponse) UnmarshalJSON

func (r *SettingDomainBulkDeleteResponse) UnmarshalJSON(data []byte) (err error)

type SettingDomainDeleteParams

type SettingDomainDeleteParams struct {
	// Account Identifier
	AccountID param.Field[string] `path:"account_id,required"`
}

type SettingDomainDeleteResponse

type SettingDomainDeleteResponse struct {
	// The unique identifier for the domain.
	ID   int64                           `json:"id,required"`
	JSON settingDomainDeleteResponseJSON `json:"-"`
}

func (*SettingDomainDeleteResponse) UnmarshalJSON

func (r *SettingDomainDeleteResponse) UnmarshalJSON(data []byte) (err error)

type SettingDomainDeleteResponseEnvelope

type SettingDomainDeleteResponseEnvelope struct {
	Errors   []shared.ResponseInfo                   `json:"errors,required"`
	Messages []shared.ResponseInfo                   `json:"messages,required"`
	Result   SettingDomainDeleteResponse             `json:"result,required"`
	Success  bool                                    `json:"success,required"`
	JSON     settingDomainDeleteResponseEnvelopeJSON `json:"-"`
}

func (*SettingDomainDeleteResponseEnvelope) UnmarshalJSON

func (r *SettingDomainDeleteResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type SettingDomainEditParams

type SettingDomainEditParams struct {
	// Account Identifier
	AccountID            param.Field[string]                                       `path:"account_id,required"`
	IPRestrictions       param.Field[[]string]                                     `json:"ip_restrictions,required"`
	AllowedDeliveryModes param.Field[[]SettingDomainEditParamsAllowedDeliveryMode] `json:"allowed_delivery_modes"`
	Domain               param.Field[string]                                       `json:"domain"`
	DropDispositions     param.Field[[]SettingDomainEditParamsDropDisposition]     `json:"drop_dispositions"`
	Folder               param.Field[SettingDomainEditParamsFolder]                `json:"folder"`
	IntegrationID        param.Field[string]                                       `json:"integration_id" format:"uuid"`
	LookbackHops         param.Field[int64]                                        `json:"lookback_hops"`
	RequireTLSInbound    param.Field[bool]                                         `json:"require_tls_inbound"`
	RequireTLSOutbound   param.Field[bool]                                         `json:"require_tls_outbound"`
	Transport            param.Field[string]                                       `json:"transport"`
}

func (SettingDomainEditParams) MarshalJSON

func (r SettingDomainEditParams) MarshalJSON() (data []byte, err error)

type SettingDomainEditParamsAllowedDeliveryMode

type SettingDomainEditParamsAllowedDeliveryMode string
const (
	SettingDomainEditParamsAllowedDeliveryModeDirect    SettingDomainEditParamsAllowedDeliveryMode = "DIRECT"
	SettingDomainEditParamsAllowedDeliveryModeBcc       SettingDomainEditParamsAllowedDeliveryMode = "BCC"
	SettingDomainEditParamsAllowedDeliveryModeJournal   SettingDomainEditParamsAllowedDeliveryMode = "JOURNAL"
	SettingDomainEditParamsAllowedDeliveryModeAPI       SettingDomainEditParamsAllowedDeliveryMode = "API"
	SettingDomainEditParamsAllowedDeliveryModeRetroScan SettingDomainEditParamsAllowedDeliveryMode = "RETRO_SCAN"
)

func (SettingDomainEditParamsAllowedDeliveryMode) IsKnown

type SettingDomainEditParamsDropDisposition

type SettingDomainEditParamsDropDisposition string
const (
	SettingDomainEditParamsDropDispositionMalicious    SettingDomainEditParamsDropDisposition = "MALICIOUS"
	SettingDomainEditParamsDropDispositionMaliciousBec SettingDomainEditParamsDropDisposition = "MALICIOUS-BEC"
	SettingDomainEditParamsDropDispositionSuspicious   SettingDomainEditParamsDropDisposition = "SUSPICIOUS"
	SettingDomainEditParamsDropDispositionSpoof        SettingDomainEditParamsDropDisposition = "SPOOF"
	SettingDomainEditParamsDropDispositionSpam         SettingDomainEditParamsDropDisposition = "SPAM"
	SettingDomainEditParamsDropDispositionBulk         SettingDomainEditParamsDropDisposition = "BULK"
	SettingDomainEditParamsDropDispositionEncrypted    SettingDomainEditParamsDropDisposition = "ENCRYPTED"
	SettingDomainEditParamsDropDispositionExternal     SettingDomainEditParamsDropDisposition = "EXTERNAL"
	SettingDomainEditParamsDropDispositionUnknown      SettingDomainEditParamsDropDisposition = "UNKNOWN"
	SettingDomainEditParamsDropDispositionNone         SettingDomainEditParamsDropDisposition = "NONE"
)

func (SettingDomainEditParamsDropDisposition) IsKnown

type SettingDomainEditParamsFolder

type SettingDomainEditParamsFolder string
const (
	SettingDomainEditParamsFolderAllItems SettingDomainEditParamsFolder = "AllItems"
	SettingDomainEditParamsFolderInbox    SettingDomainEditParamsFolder = "Inbox"
)

func (SettingDomainEditParamsFolder) IsKnown

func (r SettingDomainEditParamsFolder) IsKnown() bool

type SettingDomainEditResponse

type SettingDomainEditResponse struct {
	// The unique identifier for the domain.
	ID                   int64                                          `json:"id,required"`
	AllowedDeliveryModes []SettingDomainEditResponseAllowedDeliveryMode `json:"allowed_delivery_modes,required"`
	CreatedAt            time.Time                                      `json:"created_at,required" format:"date-time"`
	Domain               string                                         `json:"domain,required"`
	DropDispositions     []SettingDomainEditResponseDropDisposition     `json:"drop_dispositions,required"`
	IPRestrictions       []string                                       `json:"ip_restrictions,required"`
	LastModified         time.Time                                      `json:"last_modified,required" format:"date-time"`
	LookbackHops         int64                                          `json:"lookback_hops,required"`
	Transport            string                                         `json:"transport,required"`
	Authorization        SettingDomainEditResponseAuthorization         `json:"authorization,nullable"`
	EmailsProcessed      SettingDomainEditResponseEmailsProcessed       `json:"emails_processed,nullable"`
	Folder               SettingDomainEditResponseFolder                `json:"folder,nullable"`
	InboxProvider        SettingDomainEditResponseInboxProvider         `json:"inbox_provider,nullable"`
	IntegrationID        string                                         `json:"integration_id,nullable" format:"uuid"`
	O365TenantID         string                                         `json:"o365_tenant_id,nullable"`
	RequireTLSInbound    bool                                           `json:"require_tls_inbound,nullable"`
	RequireTLSOutbound   bool                                           `json:"require_tls_outbound,nullable"`
	JSON                 settingDomainEditResponseJSON                  `json:"-"`
}

func (*SettingDomainEditResponse) UnmarshalJSON

func (r *SettingDomainEditResponse) UnmarshalJSON(data []byte) (err error)

type SettingDomainEditResponseAllowedDeliveryMode

type SettingDomainEditResponseAllowedDeliveryMode string
const (
	SettingDomainEditResponseAllowedDeliveryModeDirect    SettingDomainEditResponseAllowedDeliveryMode = "DIRECT"
	SettingDomainEditResponseAllowedDeliveryModeBcc       SettingDomainEditResponseAllowedDeliveryMode = "BCC"
	SettingDomainEditResponseAllowedDeliveryModeJournal   SettingDomainEditResponseAllowedDeliveryMode = "JOURNAL"
	SettingDomainEditResponseAllowedDeliveryModeAPI       SettingDomainEditResponseAllowedDeliveryMode = "API"
	SettingDomainEditResponseAllowedDeliveryModeRetroScan SettingDomainEditResponseAllowedDeliveryMode = "RETRO_SCAN"
)

func (SettingDomainEditResponseAllowedDeliveryMode) IsKnown

type SettingDomainEditResponseAuthorization

type SettingDomainEditResponseAuthorization struct {
	Authorized    bool                                       `json:"authorized,required"`
	Timestamp     time.Time                                  `json:"timestamp,required" format:"date-time"`
	StatusMessage string                                     `json:"status_message,nullable"`
	JSON          settingDomainEditResponseAuthorizationJSON `json:"-"`
}

func (*SettingDomainEditResponseAuthorization) UnmarshalJSON

func (r *SettingDomainEditResponseAuthorization) UnmarshalJSON(data []byte) (err error)

type SettingDomainEditResponseDropDisposition

type SettingDomainEditResponseDropDisposition string
const (
	SettingDomainEditResponseDropDispositionMalicious    SettingDomainEditResponseDropDisposition = "MALICIOUS"
	SettingDomainEditResponseDropDispositionMaliciousBec SettingDomainEditResponseDropDisposition = "MALICIOUS-BEC"
	SettingDomainEditResponseDropDispositionSuspicious   SettingDomainEditResponseDropDisposition = "SUSPICIOUS"
	SettingDomainEditResponseDropDispositionSpoof        SettingDomainEditResponseDropDisposition = "SPOOF"
	SettingDomainEditResponseDropDispositionSpam         SettingDomainEditResponseDropDisposition = "SPAM"
	SettingDomainEditResponseDropDispositionBulk         SettingDomainEditResponseDropDisposition = "BULK"
	SettingDomainEditResponseDropDispositionEncrypted    SettingDomainEditResponseDropDisposition = "ENCRYPTED"
	SettingDomainEditResponseDropDispositionExternal     SettingDomainEditResponseDropDisposition = "EXTERNAL"
	SettingDomainEditResponseDropDispositionUnknown      SettingDomainEditResponseDropDisposition = "UNKNOWN"
	SettingDomainEditResponseDropDispositionNone         SettingDomainEditResponseDropDisposition = "NONE"
)

func (SettingDomainEditResponseDropDisposition) IsKnown

type SettingDomainEditResponseEmailsProcessed

type SettingDomainEditResponseEmailsProcessed struct {
	Timestamp                    time.Time                                    `json:"timestamp,required" format:"date-time"`
	TotalEmailsProcessed         int64                                        `json:"total_emails_processed,required"`
	TotalEmailsProcessedPrevious int64                                        `json:"total_emails_processed_previous,required"`
	JSON                         settingDomainEditResponseEmailsProcessedJSON `json:"-"`
}

func (*SettingDomainEditResponseEmailsProcessed) UnmarshalJSON

func (r *SettingDomainEditResponseEmailsProcessed) UnmarshalJSON(data []byte) (err error)

type SettingDomainEditResponseEnvelope

type SettingDomainEditResponseEnvelope struct {
	Errors   []shared.ResponseInfo                 `json:"errors,required"`
	Messages []shared.ResponseInfo                 `json:"messages,required"`
	Result   SettingDomainEditResponse             `json:"result,required"`
	Success  bool                                  `json:"success,required"`
	JSON     settingDomainEditResponseEnvelopeJSON `json:"-"`
}

func (*SettingDomainEditResponseEnvelope) UnmarshalJSON

func (r *SettingDomainEditResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type SettingDomainEditResponseFolder

type SettingDomainEditResponseFolder string
const (
	SettingDomainEditResponseFolderAllItems SettingDomainEditResponseFolder = "AllItems"
	SettingDomainEditResponseFolderInbox    SettingDomainEditResponseFolder = "Inbox"
)

func (SettingDomainEditResponseFolder) IsKnown

type SettingDomainEditResponseInboxProvider

type SettingDomainEditResponseInboxProvider string
const (
	SettingDomainEditResponseInboxProviderMicrosoft SettingDomainEditResponseInboxProvider = "Microsoft"
	SettingDomainEditResponseInboxProviderGoogle    SettingDomainEditResponseInboxProvider = "Google"
)

func (SettingDomainEditResponseInboxProvider) IsKnown

type SettingDomainGetParams

type SettingDomainGetParams struct {
	// Account Identifier
	AccountID param.Field[string] `path:"account_id,required"`
}

type SettingDomainGetResponse

type SettingDomainGetResponse struct {
	// The unique identifier for the domain.
	ID                   int64                                         `json:"id,required"`
	AllowedDeliveryModes []SettingDomainGetResponseAllowedDeliveryMode `json:"allowed_delivery_modes,required"`
	CreatedAt            time.Time                                     `json:"created_at,required" format:"date-time"`
	Domain               string                                        `json:"domain,required"`
	DropDispositions     []SettingDomainGetResponseDropDisposition     `json:"drop_dispositions,required"`
	IPRestrictions       []string                                      `json:"ip_restrictions,required"`
	LastModified         time.Time                                     `json:"last_modified,required" format:"date-time"`
	LookbackHops         int64                                         `json:"lookback_hops,required"`
	Transport            string                                        `json:"transport,required"`
	Authorization        SettingDomainGetResponseAuthorization         `json:"authorization,nullable"`
	EmailsProcessed      SettingDomainGetResponseEmailsProcessed       `json:"emails_processed,nullable"`
	Folder               SettingDomainGetResponseFolder                `json:"folder,nullable"`
	InboxProvider        SettingDomainGetResponseInboxProvider         `json:"inbox_provider,nullable"`
	IntegrationID        string                                        `json:"integration_id,nullable" format:"uuid"`
	O365TenantID         string                                        `json:"o365_tenant_id,nullable"`
	RequireTLSInbound    bool                                          `json:"require_tls_inbound,nullable"`
	RequireTLSOutbound   bool                                          `json:"require_tls_outbound,nullable"`
	JSON                 settingDomainGetResponseJSON                  `json:"-"`
}

func (*SettingDomainGetResponse) UnmarshalJSON

func (r *SettingDomainGetResponse) UnmarshalJSON(data []byte) (err error)

type SettingDomainGetResponseAllowedDeliveryMode

type SettingDomainGetResponseAllowedDeliveryMode string
const (
	SettingDomainGetResponseAllowedDeliveryModeDirect    SettingDomainGetResponseAllowedDeliveryMode = "DIRECT"
	SettingDomainGetResponseAllowedDeliveryModeBcc       SettingDomainGetResponseAllowedDeliveryMode = "BCC"
	SettingDomainGetResponseAllowedDeliveryModeJournal   SettingDomainGetResponseAllowedDeliveryMode = "JOURNAL"
	SettingDomainGetResponseAllowedDeliveryModeAPI       SettingDomainGetResponseAllowedDeliveryMode = "API"
	SettingDomainGetResponseAllowedDeliveryModeRetroScan SettingDomainGetResponseAllowedDeliveryMode = "RETRO_SCAN"
)

func (SettingDomainGetResponseAllowedDeliveryMode) IsKnown

type SettingDomainGetResponseAuthorization

type SettingDomainGetResponseAuthorization struct {
	Authorized    bool                                      `json:"authorized,required"`
	Timestamp     time.Time                                 `json:"timestamp,required" format:"date-time"`
	StatusMessage string                                    `json:"status_message,nullable"`
	JSON          settingDomainGetResponseAuthorizationJSON `json:"-"`
}

func (*SettingDomainGetResponseAuthorization) UnmarshalJSON

func (r *SettingDomainGetResponseAuthorization) UnmarshalJSON(data []byte) (err error)

type SettingDomainGetResponseDropDisposition

type SettingDomainGetResponseDropDisposition string
const (
	SettingDomainGetResponseDropDispositionMalicious    SettingDomainGetResponseDropDisposition = "MALICIOUS"
	SettingDomainGetResponseDropDispositionMaliciousBec SettingDomainGetResponseDropDisposition = "MALICIOUS-BEC"
	SettingDomainGetResponseDropDispositionSuspicious   SettingDomainGetResponseDropDisposition = "SUSPICIOUS"
	SettingDomainGetResponseDropDispositionSpoof        SettingDomainGetResponseDropDisposition = "SPOOF"
	SettingDomainGetResponseDropDispositionSpam         SettingDomainGetResponseDropDisposition = "SPAM"
	SettingDomainGetResponseDropDispositionBulk         SettingDomainGetResponseDropDisposition = "BULK"
	SettingDomainGetResponseDropDispositionEncrypted    SettingDomainGetResponseDropDisposition = "ENCRYPTED"
	SettingDomainGetResponseDropDispositionExternal     SettingDomainGetResponseDropDisposition = "EXTERNAL"
	SettingDomainGetResponseDropDispositionUnknown      SettingDomainGetResponseDropDisposition = "UNKNOWN"
	SettingDomainGetResponseDropDispositionNone         SettingDomainGetResponseDropDisposition = "NONE"
)

func (SettingDomainGetResponseDropDisposition) IsKnown

type SettingDomainGetResponseEmailsProcessed

type SettingDomainGetResponseEmailsProcessed struct {
	Timestamp                    time.Time                                   `json:"timestamp,required" format:"date-time"`
	TotalEmailsProcessed         int64                                       `json:"total_emails_processed,required"`
	TotalEmailsProcessedPrevious int64                                       `json:"total_emails_processed_previous,required"`
	JSON                         settingDomainGetResponseEmailsProcessedJSON `json:"-"`
}

func (*SettingDomainGetResponseEmailsProcessed) UnmarshalJSON

func (r *SettingDomainGetResponseEmailsProcessed) UnmarshalJSON(data []byte) (err error)

type SettingDomainGetResponseEnvelope

type SettingDomainGetResponseEnvelope struct {
	Errors   []shared.ResponseInfo                `json:"errors,required"`
	Messages []shared.ResponseInfo                `json:"messages,required"`
	Result   SettingDomainGetResponse             `json:"result,required"`
	Success  bool                                 `json:"success,required"`
	JSON     settingDomainGetResponseEnvelopeJSON `json:"-"`
}

func (*SettingDomainGetResponseEnvelope) UnmarshalJSON

func (r *SettingDomainGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type SettingDomainGetResponseFolder

type SettingDomainGetResponseFolder string
const (
	SettingDomainGetResponseFolderAllItems SettingDomainGetResponseFolder = "AllItems"
	SettingDomainGetResponseFolderInbox    SettingDomainGetResponseFolder = "Inbox"
)

func (SettingDomainGetResponseFolder) IsKnown

type SettingDomainGetResponseInboxProvider

type SettingDomainGetResponseInboxProvider string
const (
	SettingDomainGetResponseInboxProviderMicrosoft SettingDomainGetResponseInboxProvider = "Microsoft"
	SettingDomainGetResponseInboxProviderGoogle    SettingDomainGetResponseInboxProvider = "Google"
)

func (SettingDomainGetResponseInboxProvider) IsKnown

type SettingDomainListParams

type SettingDomainListParams struct {
	// Account Identifier
	AccountID param.Field[string] `path:"account_id,required"`
	// Filters response to domains with the currently active delivery mode.
	ActiveDeliveryMode param.Field[SettingDomainListParamsActiveDeliveryMode] `query:"active_delivery_mode"`
	// Filters response to domains with the provided delivery mode.
	AllowedDeliveryMode param.Field[SettingDomainListParamsAllowedDeliveryMode] `query:"allowed_delivery_mode"`
	// The sorting direction.
	Direction param.Field[SettingDomainListParamsDirection] `query:"direction"`
	// Filters results by the provided domains, allowing for multiple occurrences.
	Domain param.Field[[]string] `query:"domain"`
	// The field to sort by.
	Order param.Field[SettingDomainListParamsOrder] `query:"order"`
	// The page number of paginated results.
	Page param.Field[int64] `query:"page"`
	// The number of results per page.
	PerPage param.Field[int64] `query:"per_page"`
	// Allows searching in multiple properties of a record simultaneously. This
	// parameter is intended for human users, not automation. Its exact behavior is
	// intentionally left unspecified and is subject to change in the future.
	Search param.Field[string] `query:"search"`
}

func (SettingDomainListParams) URLQuery

func (r SettingDomainListParams) URLQuery() (v url.Values)

URLQuery serializes SettingDomainListParams's query parameters as `url.Values`.

type SettingDomainListParamsActiveDeliveryMode

type SettingDomainListParamsActiveDeliveryMode string

Filters response to domains with the currently active delivery mode.

const (
	SettingDomainListParamsActiveDeliveryModeDirect    SettingDomainListParamsActiveDeliveryMode = "DIRECT"
	SettingDomainListParamsActiveDeliveryModeBcc       SettingDomainListParamsActiveDeliveryMode = "BCC"
	SettingDomainListParamsActiveDeliveryModeJournal   SettingDomainListParamsActiveDeliveryMode = "JOURNAL"
	SettingDomainListParamsActiveDeliveryModeAPI       SettingDomainListParamsActiveDeliveryMode = "API"
	SettingDomainListParamsActiveDeliveryModeRetroScan SettingDomainListParamsActiveDeliveryMode = "RETRO_SCAN"
)

func (SettingDomainListParamsActiveDeliveryMode) IsKnown

type SettingDomainListParamsAllowedDeliveryMode

type SettingDomainListParamsAllowedDeliveryMode string

Filters response to domains with the provided delivery mode.

const (
	SettingDomainListParamsAllowedDeliveryModeDirect    SettingDomainListParamsAllowedDeliveryMode = "DIRECT"
	SettingDomainListParamsAllowedDeliveryModeBcc       SettingDomainListParamsAllowedDeliveryMode = "BCC"
	SettingDomainListParamsAllowedDeliveryModeJournal   SettingDomainListParamsAllowedDeliveryMode = "JOURNAL"
	SettingDomainListParamsAllowedDeliveryModeAPI       SettingDomainListParamsAllowedDeliveryMode = "API"
	SettingDomainListParamsAllowedDeliveryModeRetroScan SettingDomainListParamsAllowedDeliveryMode = "RETRO_SCAN"
)

func (SettingDomainListParamsAllowedDeliveryMode) IsKnown

type SettingDomainListParamsDirection

type SettingDomainListParamsDirection string

The sorting direction.

const (
	SettingDomainListParamsDirectionAsc  SettingDomainListParamsDirection = "asc"
	SettingDomainListParamsDirectionDesc SettingDomainListParamsDirection = "desc"
)

func (SettingDomainListParamsDirection) IsKnown

type SettingDomainListParamsOrder

type SettingDomainListParamsOrder string

The field to sort by.

const (
	SettingDomainListParamsOrderDomain    SettingDomainListParamsOrder = "domain"
	SettingDomainListParamsOrderCreatedAt SettingDomainListParamsOrder = "created_at"
)

func (SettingDomainListParamsOrder) IsKnown

func (r SettingDomainListParamsOrder) IsKnown() bool

type SettingDomainListResponse

type SettingDomainListResponse struct {
	// The unique identifier for the domain.
	ID                   int64                                          `json:"id,required"`
	AllowedDeliveryModes []SettingDomainListResponseAllowedDeliveryMode `json:"allowed_delivery_modes,required"`
	CreatedAt            time.Time                                      `json:"created_at,required" format:"date-time"`
	Domain               string                                         `json:"domain,required"`
	DropDispositions     []SettingDomainListResponseDropDisposition     `json:"drop_dispositions,required"`
	IPRestrictions       []string                                       `json:"ip_restrictions,required"`
	LastModified         time.Time                                      `json:"last_modified,required" format:"date-time"`
	LookbackHops         int64                                          `json:"lookback_hops,required"`
	Transport            string                                         `json:"transport,required"`
	Authorization        SettingDomainListResponseAuthorization         `json:"authorization,nullable"`
	EmailsProcessed      SettingDomainListResponseEmailsProcessed       `json:"emails_processed,nullable"`
	Folder               SettingDomainListResponseFolder                `json:"folder,nullable"`
	InboxProvider        SettingDomainListResponseInboxProvider         `json:"inbox_provider,nullable"`
	IntegrationID        string                                         `json:"integration_id,nullable" format:"uuid"`
	O365TenantID         string                                         `json:"o365_tenant_id,nullable"`
	RequireTLSInbound    bool                                           `json:"require_tls_inbound,nullable"`
	RequireTLSOutbound   bool                                           `json:"require_tls_outbound,nullable"`
	JSON                 settingDomainListResponseJSON                  `json:"-"`
}

func (*SettingDomainListResponse) UnmarshalJSON

func (r *SettingDomainListResponse) UnmarshalJSON(data []byte) (err error)

type SettingDomainListResponseAllowedDeliveryMode

type SettingDomainListResponseAllowedDeliveryMode string
const (
	SettingDomainListResponseAllowedDeliveryModeDirect    SettingDomainListResponseAllowedDeliveryMode = "DIRECT"
	SettingDomainListResponseAllowedDeliveryModeBcc       SettingDomainListResponseAllowedDeliveryMode = "BCC"
	SettingDomainListResponseAllowedDeliveryModeJournal   SettingDomainListResponseAllowedDeliveryMode = "JOURNAL"
	SettingDomainListResponseAllowedDeliveryModeAPI       SettingDomainListResponseAllowedDeliveryMode = "API"
	SettingDomainListResponseAllowedDeliveryModeRetroScan SettingDomainListResponseAllowedDeliveryMode = "RETRO_SCAN"
)

func (SettingDomainListResponseAllowedDeliveryMode) IsKnown

type SettingDomainListResponseAuthorization

type SettingDomainListResponseAuthorization struct {
	Authorized    bool                                       `json:"authorized,required"`
	Timestamp     time.Time                                  `json:"timestamp,required" format:"date-time"`
	StatusMessage string                                     `json:"status_message,nullable"`
	JSON          settingDomainListResponseAuthorizationJSON `json:"-"`
}

func (*SettingDomainListResponseAuthorization) UnmarshalJSON

func (r *SettingDomainListResponseAuthorization) UnmarshalJSON(data []byte) (err error)

type SettingDomainListResponseDropDisposition

type SettingDomainListResponseDropDisposition string
const (
	SettingDomainListResponseDropDispositionMalicious    SettingDomainListResponseDropDisposition = "MALICIOUS"
	SettingDomainListResponseDropDispositionMaliciousBec SettingDomainListResponseDropDisposition = "MALICIOUS-BEC"
	SettingDomainListResponseDropDispositionSuspicious   SettingDomainListResponseDropDisposition = "SUSPICIOUS"
	SettingDomainListResponseDropDispositionSpoof        SettingDomainListResponseDropDisposition = "SPOOF"
	SettingDomainListResponseDropDispositionSpam         SettingDomainListResponseDropDisposition = "SPAM"
	SettingDomainListResponseDropDispositionBulk         SettingDomainListResponseDropDisposition = "BULK"
	SettingDomainListResponseDropDispositionEncrypted    SettingDomainListResponseDropDisposition = "ENCRYPTED"
	SettingDomainListResponseDropDispositionExternal     SettingDomainListResponseDropDisposition = "EXTERNAL"
	SettingDomainListResponseDropDispositionUnknown      SettingDomainListResponseDropDisposition = "UNKNOWN"
	SettingDomainListResponseDropDispositionNone         SettingDomainListResponseDropDisposition = "NONE"
)

func (SettingDomainListResponseDropDisposition) IsKnown

type SettingDomainListResponseEmailsProcessed

type SettingDomainListResponseEmailsProcessed struct {
	Timestamp                    time.Time                                    `json:"timestamp,required" format:"date-time"`
	TotalEmailsProcessed         int64                                        `json:"total_emails_processed,required"`
	TotalEmailsProcessedPrevious int64                                        `json:"total_emails_processed_previous,required"`
	JSON                         settingDomainListResponseEmailsProcessedJSON `json:"-"`
}

func (*SettingDomainListResponseEmailsProcessed) UnmarshalJSON

func (r *SettingDomainListResponseEmailsProcessed) UnmarshalJSON(data []byte) (err error)

type SettingDomainListResponseFolder

type SettingDomainListResponseFolder string
const (
	SettingDomainListResponseFolderAllItems SettingDomainListResponseFolder = "AllItems"
	SettingDomainListResponseFolderInbox    SettingDomainListResponseFolder = "Inbox"
)

func (SettingDomainListResponseFolder) IsKnown

type SettingDomainListResponseInboxProvider

type SettingDomainListResponseInboxProvider string
const (
	SettingDomainListResponseInboxProviderMicrosoft SettingDomainListResponseInboxProvider = "Microsoft"
	SettingDomainListResponseInboxProviderGoogle    SettingDomainListResponseInboxProvider = "Google"
)

func (SettingDomainListResponseInboxProvider) IsKnown

type SettingDomainService

type SettingDomainService struct {
	Options []option.RequestOption
}

SettingDomainService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewSettingDomainService method instead.

func NewSettingDomainService

func NewSettingDomainService(opts ...option.RequestOption) (r *SettingDomainService)

NewSettingDomainService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*SettingDomainService) BulkDelete

Unprotect multiple email domains

func (*SettingDomainService) BulkDeleteAutoPaging

Unprotect multiple email domains

func (*SettingDomainService) Delete

Unprotect an email domain

func (*SettingDomainService) Edit

Update an email domain

func (*SettingDomainService) Get

Get an email domain

func (*SettingDomainService) List

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

func (*SettingDomainService) ListAutoPaging

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

type SettingImpersonationRegistryDeleteParams

type SettingImpersonationRegistryDeleteParams struct {
	// Account Identifier
	AccountID param.Field[string] `path:"account_id,required"`
}

type SettingImpersonationRegistryDeleteResponse

type SettingImpersonationRegistryDeleteResponse struct {
	ID   int64                                          `json:"id,required"`
	JSON settingImpersonationRegistryDeleteResponseJSON `json:"-"`
}

func (*SettingImpersonationRegistryDeleteResponse) UnmarshalJSON

func (r *SettingImpersonationRegistryDeleteResponse) UnmarshalJSON(data []byte) (err error)

type SettingImpersonationRegistryDeleteResponseEnvelope

type SettingImpersonationRegistryDeleteResponseEnvelope struct {
	Errors   []shared.ResponseInfo                                  `json:"errors,required"`
	Messages []shared.ResponseInfo                                  `json:"messages,required"`
	Result   SettingImpersonationRegistryDeleteResponse             `json:"result,required"`
	Success  bool                                                   `json:"success,required"`
	JSON     settingImpersonationRegistryDeleteResponseEnvelopeJSON `json:"-"`
}

func (*SettingImpersonationRegistryDeleteResponseEnvelope) UnmarshalJSON

func (r *SettingImpersonationRegistryDeleteResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type SettingImpersonationRegistryEditParams

type SettingImpersonationRegistryEditParams struct {
	// Account Identifier
	AccountID    param.Field[string] `path:"account_id,required"`
	Email        param.Field[string] `json:"email"`
	IsEmailRegex param.Field[bool]   `json:"is_email_regex"`
	Name         param.Field[string] `json:"name"`
}

func (SettingImpersonationRegistryEditParams) MarshalJSON

func (r SettingImpersonationRegistryEditParams) MarshalJSON() (data []byte, err error)

type SettingImpersonationRegistryEditResponse

type SettingImpersonationRegistryEditResponse struct {
	ID              int64     `json:"id,required"`
	CreatedAt       time.Time `json:"created_at,required" format:"date-time"`
	Email           string    `json:"email,required"`
	IsEmailRegex    bool      `json:"is_email_regex,required"`
	LastModified    time.Time `json:"last_modified,required" format:"date-time"`
	Name            string    `json:"name,required"`
	Comments        string    `json:"comments,nullable"`
	DirectoryID     int64     `json:"directory_id,nullable"`
	DirectoryNodeID int64     `json:"directory_node_id,nullable"`
	// Deprecated: deprecated
	ExternalDirectoryNodeID string                                       `json:"external_directory_node_id,nullable"`
	Provenance              string                                       `json:"provenance,nullable"`
	JSON                    settingImpersonationRegistryEditResponseJSON `json:"-"`
}

func (*SettingImpersonationRegistryEditResponse) UnmarshalJSON

func (r *SettingImpersonationRegistryEditResponse) UnmarshalJSON(data []byte) (err error)

type SettingImpersonationRegistryEditResponseEnvelope

type SettingImpersonationRegistryEditResponseEnvelope struct {
	Errors   []shared.ResponseInfo                                `json:"errors,required"`
	Messages []shared.ResponseInfo                                `json:"messages,required"`
	Result   SettingImpersonationRegistryEditResponse             `json:"result,required"`
	Success  bool                                                 `json:"success,required"`
	JSON     settingImpersonationRegistryEditResponseEnvelopeJSON `json:"-"`
}

func (*SettingImpersonationRegistryEditResponseEnvelope) UnmarshalJSON

func (r *SettingImpersonationRegistryEditResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type SettingImpersonationRegistryGetParams

type SettingImpersonationRegistryGetParams struct {
	// Account Identifier
	AccountID param.Field[string] `path:"account_id,required"`
}

type SettingImpersonationRegistryGetResponse

type SettingImpersonationRegistryGetResponse struct {
	ID              int64     `json:"id,required"`
	CreatedAt       time.Time `json:"created_at,required" format:"date-time"`
	Email           string    `json:"email,required"`
	IsEmailRegex    bool      `json:"is_email_regex,required"`
	LastModified    time.Time `json:"last_modified,required" format:"date-time"`
	Name            string    `json:"name,required"`
	Comments        string    `json:"comments,nullable"`
	DirectoryID     int64     `json:"directory_id,nullable"`
	DirectoryNodeID int64     `json:"directory_node_id,nullable"`
	// Deprecated: deprecated
	ExternalDirectoryNodeID string                                      `json:"external_directory_node_id,nullable"`
	Provenance              string                                      `json:"provenance,nullable"`
	JSON                    settingImpersonationRegistryGetResponseJSON `json:"-"`
}

func (*SettingImpersonationRegistryGetResponse) UnmarshalJSON

func (r *SettingImpersonationRegistryGetResponse) UnmarshalJSON(data []byte) (err error)

type SettingImpersonationRegistryGetResponseEnvelope

type SettingImpersonationRegistryGetResponseEnvelope struct {
	Errors   []shared.ResponseInfo                               `json:"errors,required"`
	Messages []shared.ResponseInfo                               `json:"messages,required"`
	Result   SettingImpersonationRegistryGetResponse             `json:"result,required"`
	Success  bool                                                `json:"success,required"`
	JSON     settingImpersonationRegistryGetResponseEnvelopeJSON `json:"-"`
}

func (*SettingImpersonationRegistryGetResponseEnvelope) UnmarshalJSON

func (r *SettingImpersonationRegistryGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type SettingImpersonationRegistryListParams

type SettingImpersonationRegistryListParams struct {
	// Account Identifier
	AccountID param.Field[string] `path:"account_id,required"`
	// The sorting direction.
	Direction param.Field[SettingImpersonationRegistryListParamsDirection] `query:"direction"`
	// The field to sort by.
	Order param.Field[SettingImpersonationRegistryListParamsOrder] `query:"order"`
	// The page number of paginated results.
	Page param.Field[int64] `query:"page"`
	// The number of results per page.
	PerPage    param.Field[int64]                                            `query:"per_page"`
	Provenance param.Field[SettingImpersonationRegistryListParamsProvenance] `query:"provenance"`
	// Allows searching in multiple properties of a record simultaneously. This
	// parameter is intended for human users, not automation. Its exact behavior is
	// intentionally left unspecified and is subject to change in the future.
	Search param.Field[string] `query:"search"`
}

func (SettingImpersonationRegistryListParams) URLQuery

URLQuery serializes SettingImpersonationRegistryListParams's query parameters as `url.Values`.

type SettingImpersonationRegistryListParamsDirection

type SettingImpersonationRegistryListParamsDirection string

The sorting direction.

const (
	SettingImpersonationRegistryListParamsDirectionAsc  SettingImpersonationRegistryListParamsDirection = "asc"
	SettingImpersonationRegistryListParamsDirectionDesc SettingImpersonationRegistryListParamsDirection = "desc"
)

func (SettingImpersonationRegistryListParamsDirection) IsKnown

type SettingImpersonationRegistryListParamsOrder

type SettingImpersonationRegistryListParamsOrder string

The field to sort by.

const (
	SettingImpersonationRegistryListParamsOrderName      SettingImpersonationRegistryListParamsOrder = "name"
	SettingImpersonationRegistryListParamsOrderEmail     SettingImpersonationRegistryListParamsOrder = "email"
	SettingImpersonationRegistryListParamsOrderCreatedAt SettingImpersonationRegistryListParamsOrder = "created_at"
)

func (SettingImpersonationRegistryListParamsOrder) IsKnown

type SettingImpersonationRegistryListParamsProvenance

type SettingImpersonationRegistryListParamsProvenance string
const (
	SettingImpersonationRegistryListParamsProvenanceA1SInternal           SettingImpersonationRegistryListParamsProvenance = "A1S_INTERNAL"
	SettingImpersonationRegistryListParamsProvenanceSnoopyCasbOffice365   SettingImpersonationRegistryListParamsProvenance = "SNOOPY-CASB_OFFICE_365"
	SettingImpersonationRegistryListParamsProvenanceSnoopyOffice365       SettingImpersonationRegistryListParamsProvenance = "SNOOPY-OFFICE_365"
	SettingImpersonationRegistryListParamsProvenanceSnoopyGoogleDirectory SettingImpersonationRegistryListParamsProvenance = "SNOOPY-GOOGLE_DIRECTORY"
)

func (SettingImpersonationRegistryListParamsProvenance) IsKnown

type SettingImpersonationRegistryListResponse

type SettingImpersonationRegistryListResponse struct {
	ID              int64     `json:"id,required"`
	CreatedAt       time.Time `json:"created_at,required" format:"date-time"`
	Email           string    `json:"email,required"`
	IsEmailRegex    bool      `json:"is_email_regex,required"`
	LastModified    time.Time `json:"last_modified,required" format:"date-time"`
	Name            string    `json:"name,required"`
	Comments        string    `json:"comments,nullable"`
	DirectoryID     int64     `json:"directory_id,nullable"`
	DirectoryNodeID int64     `json:"directory_node_id,nullable"`
	// Deprecated: deprecated
	ExternalDirectoryNodeID string                                       `json:"external_directory_node_id,nullable"`
	Provenance              string                                       `json:"provenance,nullable"`
	JSON                    settingImpersonationRegistryListResponseJSON `json:"-"`
}

func (*SettingImpersonationRegistryListResponse) UnmarshalJSON

func (r *SettingImpersonationRegistryListResponse) UnmarshalJSON(data []byte) (err error)

type SettingImpersonationRegistryNewParams

type SettingImpersonationRegistryNewParams struct {
	// Account Identifier
	AccountID    param.Field[string] `path:"account_id,required"`
	Email        param.Field[string] `json:"email,required"`
	IsEmailRegex param.Field[bool]   `json:"is_email_regex,required"`
	Name         param.Field[string] `json:"name,required"`
}

func (SettingImpersonationRegistryNewParams) MarshalJSON

func (r SettingImpersonationRegistryNewParams) MarshalJSON() (data []byte, err error)

type SettingImpersonationRegistryNewResponse

type SettingImpersonationRegistryNewResponse struct {
	ID              int64     `json:"id,required"`
	CreatedAt       time.Time `json:"created_at,required" format:"date-time"`
	Email           string    `json:"email,required"`
	IsEmailRegex    bool      `json:"is_email_regex,required"`
	LastModified    time.Time `json:"last_modified,required" format:"date-time"`
	Name            string    `json:"name,required"`
	Comments        string    `json:"comments,nullable"`
	DirectoryID     int64     `json:"directory_id,nullable"`
	DirectoryNodeID int64     `json:"directory_node_id,nullable"`
	// Deprecated: deprecated
	ExternalDirectoryNodeID string                                      `json:"external_directory_node_id,nullable"`
	Provenance              string                                      `json:"provenance,nullable"`
	JSON                    settingImpersonationRegistryNewResponseJSON `json:"-"`
}

func (*SettingImpersonationRegistryNewResponse) UnmarshalJSON

func (r *SettingImpersonationRegistryNewResponse) UnmarshalJSON(data []byte) (err error)

type SettingImpersonationRegistryNewResponseEnvelope

type SettingImpersonationRegistryNewResponseEnvelope struct {
	Errors   []shared.ResponseInfo                               `json:"errors,required"`
	Messages []shared.ResponseInfo                               `json:"messages,required"`
	Result   SettingImpersonationRegistryNewResponse             `json:"result,required"`
	Success  bool                                                `json:"success,required"`
	JSON     settingImpersonationRegistryNewResponseEnvelopeJSON `json:"-"`
}

func (*SettingImpersonationRegistryNewResponseEnvelope) UnmarshalJSON

func (r *SettingImpersonationRegistryNewResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type SettingImpersonationRegistryService

type SettingImpersonationRegistryService struct {
	Options []option.RequestOption
}

SettingImpersonationRegistryService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewSettingImpersonationRegistryService method instead.

func NewSettingImpersonationRegistryService

func NewSettingImpersonationRegistryService(opts ...option.RequestOption) (r *SettingImpersonationRegistryService)

NewSettingImpersonationRegistryService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*SettingImpersonationRegistryService) Delete

Delete an entry from impersonation registry

func (*SettingImpersonationRegistryService) Edit

Update an entry in impersonation registry

func (*SettingImpersonationRegistryService) Get

Get an entry in impersonation registry

func (*SettingImpersonationRegistryService) List

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

func (*SettingImpersonationRegistryService) ListAutoPaging

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

func (*SettingImpersonationRegistryService) New

Create an entry in impersonation registry

type SettingService

type SettingService struct {
	Options               []option.RequestOption
	AllowPolicies         *SettingAllowPolicyService
	BlockSenders          *SettingBlockSenderService
	Domains               *SettingDomainService
	ImpersonationRegistry *SettingImpersonationRegistryService
	TrustedDomains        *SettingTrustedDomainService
}

SettingService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewSettingService method instead.

func NewSettingService

func NewSettingService(opts ...option.RequestOption) (r *SettingService)

NewSettingService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

type SettingTrustedDomainDeleteParams

type SettingTrustedDomainDeleteParams struct {
	// Account Identifier
	AccountID param.Field[string] `path:"account_id,required"`
}

type SettingTrustedDomainDeleteResponse

type SettingTrustedDomainDeleteResponse struct {
	// The unique identifier for the trusted domain.
	ID   int64                                  `json:"id,required"`
	JSON settingTrustedDomainDeleteResponseJSON `json:"-"`
}

func (*SettingTrustedDomainDeleteResponse) UnmarshalJSON

func (r *SettingTrustedDomainDeleteResponse) UnmarshalJSON(data []byte) (err error)

type SettingTrustedDomainDeleteResponseEnvelope

type SettingTrustedDomainDeleteResponseEnvelope struct {
	Errors   []shared.ResponseInfo                          `json:"errors,required"`
	Messages []shared.ResponseInfo                          `json:"messages,required"`
	Result   SettingTrustedDomainDeleteResponse             `json:"result,required"`
	Success  bool                                           `json:"success,required"`
	JSON     settingTrustedDomainDeleteResponseEnvelopeJSON `json:"-"`
}

func (*SettingTrustedDomainDeleteResponseEnvelope) UnmarshalJSON

func (r *SettingTrustedDomainDeleteResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type SettingTrustedDomainEditParams

type SettingTrustedDomainEditParams struct {
	// Account Identifier
	AccountID param.Field[string] `path:"account_id,required"`
	Comments  param.Field[string] `json:"comments"`
	// Select to prevent recently registered domains from triggering a Suspicious or
	// Malicious disposition.
	IsRecent param.Field[bool] `json:"is_recent"`
	IsRegex  param.Field[bool] `json:"is_regex"`
	// Select for partner or other approved domains that have similar spelling to your
	// connected domains. Prevents listed domains from triggering a Spoof disposition.
	IsSimilarity param.Field[bool]   `json:"is_similarity"`
	Pattern      param.Field[string] `json:"pattern"`
}

func (SettingTrustedDomainEditParams) MarshalJSON

func (r SettingTrustedDomainEditParams) MarshalJSON() (data []byte, err error)

type SettingTrustedDomainEditResponse

type SettingTrustedDomainEditResponse struct {
	// The unique identifier for the trusted domain.
	ID        int64     `json:"id,required"`
	CreatedAt time.Time `json:"created_at,required" format:"date-time"`
	// Select to prevent recently registered domains from triggering a Suspicious or
	// Malicious disposition.
	IsRecent bool `json:"is_recent,required"`
	IsRegex  bool `json:"is_regex,required"`
	// Select for partner or other approved domains that have similar spelling to your
	// connected domains. Prevents listed domains from triggering a Spoof disposition.
	IsSimilarity bool                                 `json:"is_similarity,required"`
	LastModified time.Time                            `json:"last_modified,required" format:"date-time"`
	Pattern      string                               `json:"pattern,required"`
	Comments     string                               `json:"comments,nullable"`
	JSON         settingTrustedDomainEditResponseJSON `json:"-"`
}

func (*SettingTrustedDomainEditResponse) UnmarshalJSON

func (r *SettingTrustedDomainEditResponse) UnmarshalJSON(data []byte) (err error)

type SettingTrustedDomainEditResponseEnvelope

type SettingTrustedDomainEditResponseEnvelope struct {
	Errors   []shared.ResponseInfo                        `json:"errors,required"`
	Messages []shared.ResponseInfo                        `json:"messages,required"`
	Result   SettingTrustedDomainEditResponse             `json:"result,required"`
	Success  bool                                         `json:"success,required"`
	JSON     settingTrustedDomainEditResponseEnvelopeJSON `json:"-"`
}

func (*SettingTrustedDomainEditResponseEnvelope) UnmarshalJSON

func (r *SettingTrustedDomainEditResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type SettingTrustedDomainGetParams

type SettingTrustedDomainGetParams struct {
	// Account Identifier
	AccountID param.Field[string] `path:"account_id,required"`
}

type SettingTrustedDomainGetResponse

type SettingTrustedDomainGetResponse struct {
	// The unique identifier for the trusted domain.
	ID        int64     `json:"id,required"`
	CreatedAt time.Time `json:"created_at,required" format:"date-time"`
	// Select to prevent recently registered domains from triggering a Suspicious or
	// Malicious disposition.
	IsRecent bool `json:"is_recent,required"`
	IsRegex  bool `json:"is_regex,required"`
	// Select for partner or other approved domains that have similar spelling to your
	// connected domains. Prevents listed domains from triggering a Spoof disposition.
	IsSimilarity bool                                `json:"is_similarity,required"`
	LastModified time.Time                           `json:"last_modified,required" format:"date-time"`
	Pattern      string                              `json:"pattern,required"`
	Comments     string                              `json:"comments,nullable"`
	JSON         settingTrustedDomainGetResponseJSON `json:"-"`
}

func (*SettingTrustedDomainGetResponse) UnmarshalJSON

func (r *SettingTrustedDomainGetResponse) UnmarshalJSON(data []byte) (err error)

type SettingTrustedDomainGetResponseEnvelope

type SettingTrustedDomainGetResponseEnvelope struct {
	Errors   []shared.ResponseInfo                       `json:"errors,required"`
	Messages []shared.ResponseInfo                       `json:"messages,required"`
	Result   SettingTrustedDomainGetResponse             `json:"result,required"`
	Success  bool                                        `json:"success,required"`
	JSON     settingTrustedDomainGetResponseEnvelopeJSON `json:"-"`
}

func (*SettingTrustedDomainGetResponseEnvelope) UnmarshalJSON

func (r *SettingTrustedDomainGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type SettingTrustedDomainListParams

type SettingTrustedDomainListParams struct {
	// Account Identifier
	AccountID param.Field[string] `path:"account_id,required"`
	// The sorting direction.
	Direction    param.Field[SettingTrustedDomainListParamsDirection] `query:"direction"`
	IsRecent     param.Field[bool]                                    `query:"is_recent"`
	IsSimilarity param.Field[bool]                                    `query:"is_similarity"`
	// The field to sort by.
	Order param.Field[SettingTrustedDomainListParamsOrder] `query:"order"`
	// The page number of paginated results.
	Page    param.Field[int64]  `query:"page"`
	Pattern param.Field[string] `query:"pattern"`
	// The number of results per page.
	PerPage param.Field[int64] `query:"per_page"`
	// Allows searching in multiple properties of a record simultaneously. This
	// parameter is intended for human users, not automation. Its exact behavior is
	// intentionally left unspecified and is subject to change in the future.
	Search param.Field[string] `query:"search"`
}

func (SettingTrustedDomainListParams) URLQuery

func (r SettingTrustedDomainListParams) URLQuery() (v url.Values)

URLQuery serializes SettingTrustedDomainListParams's query parameters as `url.Values`.

type SettingTrustedDomainListParamsDirection

type SettingTrustedDomainListParamsDirection string

The sorting direction.

const (
	SettingTrustedDomainListParamsDirectionAsc  SettingTrustedDomainListParamsDirection = "asc"
	SettingTrustedDomainListParamsDirectionDesc SettingTrustedDomainListParamsDirection = "desc"
)

func (SettingTrustedDomainListParamsDirection) IsKnown

type SettingTrustedDomainListParamsOrder

type SettingTrustedDomainListParamsOrder string

The field to sort by.

const (
	SettingTrustedDomainListParamsOrderPattern   SettingTrustedDomainListParamsOrder = "pattern"
	SettingTrustedDomainListParamsOrderCreatedAt SettingTrustedDomainListParamsOrder = "created_at"
)

func (SettingTrustedDomainListParamsOrder) IsKnown

type SettingTrustedDomainListResponse

type SettingTrustedDomainListResponse struct {
	// The unique identifier for the trusted domain.
	ID        int64     `json:"id,required"`
	CreatedAt time.Time `json:"created_at,required" format:"date-time"`
	// Select to prevent recently registered domains from triggering a Suspicious or
	// Malicious disposition.
	IsRecent bool `json:"is_recent,required"`
	IsRegex  bool `json:"is_regex,required"`
	// Select for partner or other approved domains that have similar spelling to your
	// connected domains. Prevents listed domains from triggering a Spoof disposition.
	IsSimilarity bool                                 `json:"is_similarity,required"`
	LastModified time.Time                            `json:"last_modified,required" format:"date-time"`
	Pattern      string                               `json:"pattern,required"`
	Comments     string                               `json:"comments,nullable"`
	JSON         settingTrustedDomainListResponseJSON `json:"-"`
}

func (*SettingTrustedDomainListResponse) UnmarshalJSON

func (r *SettingTrustedDomainListResponse) UnmarshalJSON(data []byte) (err error)

type SettingTrustedDomainNewParams

type SettingTrustedDomainNewParams struct {
	// Account Identifier
	AccountID param.Field[string]                    `path:"account_id,required"`
	Body      SettingTrustedDomainNewParamsBodyUnion `json:"body,required"`
}

func (SettingTrustedDomainNewParams) MarshalJSON

func (r SettingTrustedDomainNewParams) MarshalJSON() (data []byte, err error)

type SettingTrustedDomainNewParamsBodyArray

type SettingTrustedDomainNewParamsBodyArray []SettingTrustedDomainNewParamsBodyArrayItem

type SettingTrustedDomainNewParamsBodyArrayItem

type SettingTrustedDomainNewParamsBodyArrayItem struct {
	// Select to prevent recently registered domains from triggering a Suspicious or
	// Malicious disposition.
	IsRecent param.Field[bool] `json:"is_recent,required"`
	IsRegex  param.Field[bool] `json:"is_regex,required"`
	// Select for partner or other approved domains that have similar spelling to your
	// connected domains. Prevents listed domains from triggering a Spoof disposition.
	IsSimilarity param.Field[bool]   `json:"is_similarity,required"`
	Pattern      param.Field[string] `json:"pattern,required"`
	Comments     param.Field[string] `json:"comments"`
}

func (SettingTrustedDomainNewParamsBodyArrayItem) MarshalJSON

func (r SettingTrustedDomainNewParamsBodyArrayItem) MarshalJSON() (data []byte, err error)

type SettingTrustedDomainNewParamsBodyEmailSecurityCreateTrustedDomain

type SettingTrustedDomainNewParamsBodyEmailSecurityCreateTrustedDomain struct {
	// Select to prevent recently registered domains from triggering a Suspicious or
	// Malicious disposition.
	IsRecent param.Field[bool] `json:"is_recent,required"`
	IsRegex  param.Field[bool] `json:"is_regex,required"`
	// Select for partner or other approved domains that have similar spelling to your
	// connected domains. Prevents listed domains from triggering a Spoof disposition.
	IsSimilarity param.Field[bool]   `json:"is_similarity,required"`
	Pattern      param.Field[string] `json:"pattern,required"`
	Comments     param.Field[string] `json:"comments"`
}

func (SettingTrustedDomainNewParamsBodyEmailSecurityCreateTrustedDomain) MarshalJSON

type SettingTrustedDomainNewParamsBodyUnion

type SettingTrustedDomainNewParamsBodyUnion interface {
	// contains filtered or unexported methods
}

Satisfied by email_security.SettingTrustedDomainNewParamsBodyEmailSecurityCreateTrustedDomain, email_security.SettingTrustedDomainNewParamsBodyArray.

type SettingTrustedDomainNewResponseArray

type SettingTrustedDomainNewResponseArray []SettingTrustedDomainNewResponseArrayItem

type SettingTrustedDomainNewResponseArrayItem

type SettingTrustedDomainNewResponseArrayItem struct {
	// The unique identifier for the trusted domain.
	ID        int64     `json:"id,required"`
	CreatedAt time.Time `json:"created_at,required" format:"date-time"`
	// Select to prevent recently registered domains from triggering a Suspicious or
	// Malicious disposition.
	IsRecent bool `json:"is_recent,required"`
	IsRegex  bool `json:"is_regex,required"`
	// Select for partner or other approved domains that have similar spelling to your
	// connected domains. Prevents listed domains from triggering a Spoof disposition.
	IsSimilarity bool                                         `json:"is_similarity,required"`
	LastModified time.Time                                    `json:"last_modified,required" format:"date-time"`
	Pattern      string                                       `json:"pattern,required"`
	Comments     string                                       `json:"comments,nullable"`
	JSON         settingTrustedDomainNewResponseArrayItemJSON `json:"-"`
}

func (*SettingTrustedDomainNewResponseArrayItem) UnmarshalJSON

func (r *SettingTrustedDomainNewResponseArrayItem) UnmarshalJSON(data []byte) (err error)

type SettingTrustedDomainNewResponseEmailSecurityTrustedDomain

type SettingTrustedDomainNewResponseEmailSecurityTrustedDomain struct {
	// The unique identifier for the trusted domain.
	ID        int64     `json:"id,required"`
	CreatedAt time.Time `json:"created_at,required" format:"date-time"`
	// Select to prevent recently registered domains from triggering a Suspicious or
	// Malicious disposition.
	IsRecent bool `json:"is_recent,required"`
	IsRegex  bool `json:"is_regex,required"`
	// Select for partner or other approved domains that have similar spelling to your
	// connected domains. Prevents listed domains from triggering a Spoof disposition.
	IsSimilarity bool                                                          `json:"is_similarity,required"`
	LastModified time.Time                                                     `json:"last_modified,required" format:"date-time"`
	Pattern      string                                                        `json:"pattern,required"`
	Comments     string                                                        `json:"comments,nullable"`
	JSON         settingTrustedDomainNewResponseEmailSecurityTrustedDomainJSON `json:"-"`
}

func (*SettingTrustedDomainNewResponseEmailSecurityTrustedDomain) UnmarshalJSON

type SettingTrustedDomainNewResponseEnvelope

type SettingTrustedDomainNewResponseEnvelope struct {
	Errors   []shared.ResponseInfo                       `json:"errors,required"`
	Messages []shared.ResponseInfo                       `json:"messages,required"`
	Result   SettingTrustedDomainNewResponseUnion        `json:"result,required"`
	Success  bool                                        `json:"success,required"`
	JSON     settingTrustedDomainNewResponseEnvelopeJSON `json:"-"`
}

func (*SettingTrustedDomainNewResponseEnvelope) UnmarshalJSON

func (r *SettingTrustedDomainNewResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type SettingTrustedDomainNewResponseUnion

type SettingTrustedDomainNewResponseUnion interface {
	// contains filtered or unexported methods
}

Union satisfied by SettingTrustedDomainNewResponseEmailSecurityTrustedDomain or SettingTrustedDomainNewResponseArray.

type SettingTrustedDomainService

type SettingTrustedDomainService struct {
	Options []option.RequestOption
}

SettingTrustedDomainService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewSettingTrustedDomainService method instead.

func NewSettingTrustedDomainService

func NewSettingTrustedDomainService(opts ...option.RequestOption) (r *SettingTrustedDomainService)

NewSettingTrustedDomainService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*SettingTrustedDomainService) Delete

Delete a trusted email domain

func (*SettingTrustedDomainService) Edit

Update a trusted email domain

func (*SettingTrustedDomainService) Get

Get a trusted email domain

func (*SettingTrustedDomainService) List

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

func (*SettingTrustedDomainService) ListAutoPaging

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

func (*SettingTrustedDomainService) New

Create a trusted email domain

type SortDirection

type SortDirection = shared.SortDirection

Direction to order DNS records in.

This is an alias to an internal type.

type SubmissionListParams

type SubmissionListParams struct {
	// Account Identifier
	AccountID param.Field[string] `path:"account_id,required"`
	// The end of the search date range. Defaults to `now`.
	End                 param.Field[time.Time]                               `query:"end" format:"date-time"`
	OriginalDisposition param.Field[SubmissionListParamsOriginalDisposition] `query:"original_disposition"`
	OutcomeDisposition  param.Field[SubmissionListParamsOutcomeDisposition]  `query:"outcome_disposition"`
	// The page number of paginated results.
	Page param.Field[int64] `query:"page"`
	// The number of results per page.
	PerPage              param.Field[int64]                                    `query:"per_page"`
	Query                param.Field[string]                                   `query:"query"`
	RequestedDisposition param.Field[SubmissionListParamsRequestedDisposition] `query:"requested_disposition"`
	// The beginning of the search date range. Defaults to `now - 30 days`.
	Start        param.Field[time.Time]                `query:"start" format:"date-time"`
	Status       param.Field[string]                   `query:"status"`
	SubmissionID param.Field[string]                   `query:"submission_id"`
	Type         param.Field[SubmissionListParamsType] `query:"type"`
}

func (SubmissionListParams) URLQuery

func (r SubmissionListParams) URLQuery() (v url.Values)

URLQuery serializes SubmissionListParams's query parameters as `url.Values`.

type SubmissionListParamsOriginalDisposition

type SubmissionListParamsOriginalDisposition string
const (
	SubmissionListParamsOriginalDispositionMalicious  SubmissionListParamsOriginalDisposition = "MALICIOUS"
	SubmissionListParamsOriginalDispositionSuspicious SubmissionListParamsOriginalDisposition = "SUSPICIOUS"
	SubmissionListParamsOriginalDispositionSpoof      SubmissionListParamsOriginalDisposition = "SPOOF"
	SubmissionListParamsOriginalDispositionSpam       SubmissionListParamsOriginalDisposition = "SPAM"
	SubmissionListParamsOriginalDispositionBulk       SubmissionListParamsOriginalDisposition = "BULK"
	SubmissionListParamsOriginalDispositionNone       SubmissionListParamsOriginalDisposition = "NONE"
)

func (SubmissionListParamsOriginalDisposition) IsKnown

type SubmissionListParamsOutcomeDisposition

type SubmissionListParamsOutcomeDisposition string
const (
	SubmissionListParamsOutcomeDispositionMalicious  SubmissionListParamsOutcomeDisposition = "MALICIOUS"
	SubmissionListParamsOutcomeDispositionSuspicious SubmissionListParamsOutcomeDisposition = "SUSPICIOUS"
	SubmissionListParamsOutcomeDispositionSpoof      SubmissionListParamsOutcomeDisposition = "SPOOF"
	SubmissionListParamsOutcomeDispositionSpam       SubmissionListParamsOutcomeDisposition = "SPAM"
	SubmissionListParamsOutcomeDispositionBulk       SubmissionListParamsOutcomeDisposition = "BULK"
	SubmissionListParamsOutcomeDispositionNone       SubmissionListParamsOutcomeDisposition = "NONE"
)

func (SubmissionListParamsOutcomeDisposition) IsKnown

type SubmissionListParamsRequestedDisposition

type SubmissionListParamsRequestedDisposition string
const (
	SubmissionListParamsRequestedDispositionMalicious  SubmissionListParamsRequestedDisposition = "MALICIOUS"
	SubmissionListParamsRequestedDispositionSuspicious SubmissionListParamsRequestedDisposition = "SUSPICIOUS"
	SubmissionListParamsRequestedDispositionSpoof      SubmissionListParamsRequestedDisposition = "SPOOF"
	SubmissionListParamsRequestedDispositionSpam       SubmissionListParamsRequestedDisposition = "SPAM"
	SubmissionListParamsRequestedDispositionBulk       SubmissionListParamsRequestedDisposition = "BULK"
	SubmissionListParamsRequestedDispositionNone       SubmissionListParamsRequestedDisposition = "NONE"
)

func (SubmissionListParamsRequestedDisposition) IsKnown

type SubmissionListParamsType

type SubmissionListParamsType string
const (
	SubmissionListParamsTypeTeam SubmissionListParamsType = "TEAM"
	SubmissionListParamsTypeUser SubmissionListParamsType = "USER"
)

func (SubmissionListParamsType) IsKnown

func (r SubmissionListParamsType) IsKnown() bool

type SubmissionListResponse

type SubmissionListResponse struct {
	RequestedTs          time.Time                                  `json:"requested_ts,required" format:"date-time"`
	SubmissionID         string                                     `json:"submission_id,required"`
	OriginalDisposition  SubmissionListResponseOriginalDisposition  `json:"original_disposition,nullable"`
	OriginalEdfHash      string                                     `json:"original_edf_hash,nullable"`
	Outcome              string                                     `json:"outcome,nullable"`
	OutcomeDisposition   SubmissionListResponseOutcomeDisposition   `json:"outcome_disposition,nullable"`
	RequestedBy          string                                     `json:"requested_by,nullable"`
	RequestedDisposition SubmissionListResponseRequestedDisposition `json:"requested_disposition,nullable"`
	Status               string                                     `json:"status,nullable"`
	Subject              string                                     `json:"subject,nullable"`
	Type                 string                                     `json:"type,nullable"`
	JSON                 submissionListResponseJSON                 `json:"-"`
}

func (*SubmissionListResponse) UnmarshalJSON

func (r *SubmissionListResponse) UnmarshalJSON(data []byte) (err error)

type SubmissionListResponseOriginalDisposition

type SubmissionListResponseOriginalDisposition string
const (
	SubmissionListResponseOriginalDispositionMalicious    SubmissionListResponseOriginalDisposition = "MALICIOUS"
	SubmissionListResponseOriginalDispositionMaliciousBec SubmissionListResponseOriginalDisposition = "MALICIOUS-BEC"
	SubmissionListResponseOriginalDispositionSuspicious   SubmissionListResponseOriginalDisposition = "SUSPICIOUS"
	SubmissionListResponseOriginalDispositionSpoof        SubmissionListResponseOriginalDisposition = "SPOOF"
	SubmissionListResponseOriginalDispositionSpam         SubmissionListResponseOriginalDisposition = "SPAM"
	SubmissionListResponseOriginalDispositionBulk         SubmissionListResponseOriginalDisposition = "BULK"
	SubmissionListResponseOriginalDispositionEncrypted    SubmissionListResponseOriginalDisposition = "ENCRYPTED"
	SubmissionListResponseOriginalDispositionExternal     SubmissionListResponseOriginalDisposition = "EXTERNAL"
	SubmissionListResponseOriginalDispositionUnknown      SubmissionListResponseOriginalDisposition = "UNKNOWN"
	SubmissionListResponseOriginalDispositionNone         SubmissionListResponseOriginalDisposition = "NONE"
)

func (SubmissionListResponseOriginalDisposition) IsKnown

type SubmissionListResponseOutcomeDisposition

type SubmissionListResponseOutcomeDisposition string
const (
	SubmissionListResponseOutcomeDispositionMalicious    SubmissionListResponseOutcomeDisposition = "MALICIOUS"
	SubmissionListResponseOutcomeDispositionMaliciousBec SubmissionListResponseOutcomeDisposition = "MALICIOUS-BEC"
	SubmissionListResponseOutcomeDispositionSuspicious   SubmissionListResponseOutcomeDisposition = "SUSPICIOUS"
	SubmissionListResponseOutcomeDispositionSpoof        SubmissionListResponseOutcomeDisposition = "SPOOF"
	SubmissionListResponseOutcomeDispositionSpam         SubmissionListResponseOutcomeDisposition = "SPAM"
	SubmissionListResponseOutcomeDispositionBulk         SubmissionListResponseOutcomeDisposition = "BULK"
	SubmissionListResponseOutcomeDispositionEncrypted    SubmissionListResponseOutcomeDisposition = "ENCRYPTED"
	SubmissionListResponseOutcomeDispositionExternal     SubmissionListResponseOutcomeDisposition = "EXTERNAL"
	SubmissionListResponseOutcomeDispositionUnknown      SubmissionListResponseOutcomeDisposition = "UNKNOWN"
	SubmissionListResponseOutcomeDispositionNone         SubmissionListResponseOutcomeDisposition = "NONE"
)

func (SubmissionListResponseOutcomeDisposition) IsKnown

type SubmissionListResponseRequestedDisposition

type SubmissionListResponseRequestedDisposition string
const (
	SubmissionListResponseRequestedDispositionMalicious    SubmissionListResponseRequestedDisposition = "MALICIOUS"
	SubmissionListResponseRequestedDispositionMaliciousBec SubmissionListResponseRequestedDisposition = "MALICIOUS-BEC"
	SubmissionListResponseRequestedDispositionSuspicious   SubmissionListResponseRequestedDisposition = "SUSPICIOUS"
	SubmissionListResponseRequestedDispositionSpoof        SubmissionListResponseRequestedDisposition = "SPOOF"
	SubmissionListResponseRequestedDispositionSpam         SubmissionListResponseRequestedDisposition = "SPAM"
	SubmissionListResponseRequestedDispositionBulk         SubmissionListResponseRequestedDisposition = "BULK"
	SubmissionListResponseRequestedDispositionEncrypted    SubmissionListResponseRequestedDisposition = "ENCRYPTED"
	SubmissionListResponseRequestedDispositionExternal     SubmissionListResponseRequestedDisposition = "EXTERNAL"
	SubmissionListResponseRequestedDispositionUnknown      SubmissionListResponseRequestedDisposition = "UNKNOWN"
	SubmissionListResponseRequestedDispositionNone         SubmissionListResponseRequestedDisposition = "NONE"
)

func (SubmissionListResponseRequestedDisposition) IsKnown

type SubmissionService

type SubmissionService struct {
	Options []option.RequestOption
}

SubmissionService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewSubmissionService method instead.

func NewSubmissionService

func NewSubmissionService(opts ...option.RequestOption) (r *SubmissionService)

NewSubmissionService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*SubmissionService) List

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

func (*SubmissionService) ListAutoPaging

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

type Subscription

type Subscription = shared.Subscription

This is an alias to an internal type.

type SubscriptionFrequency

type SubscriptionFrequency = shared.SubscriptionFrequency

How often the subscription is renewed automatically.

This is an alias to an internal type.

type SubscriptionParam

type SubscriptionParam = shared.SubscriptionParam

This is an alias to an internal type.

type SubscriptionState

type SubscriptionState = shared.SubscriptionState

The state that the subscription is in.

This is an alias to an internal type.

type Token

type Token = shared.Token

This is an alias to an internal type.

type TokenCondition

type TokenCondition = shared.TokenCondition

This is an alias to an internal type.

type TokenConditionCIDRList

type TokenConditionCIDRList = shared.TokenConditionCIDRList

IPv4/IPv6 CIDR.

This is an alias to an internal type.

type TokenConditionCIDRListParam

type TokenConditionCIDRListParam = shared.TokenConditionCIDRListParam

IPv4/IPv6 CIDR.

This is an alias to an internal type.

type TokenConditionParam

type TokenConditionParam = shared.TokenConditionParam

This is an alias to an internal type.

type TokenConditionRequestIP

type TokenConditionRequestIP = shared.TokenConditionRequestIP

Client IP restrictions.

This is an alias to an internal type.

type TokenConditionRequestIPParam

type TokenConditionRequestIPParam = shared.TokenConditionRequestIPParam

Client IP restrictions.

This is an alias to an internal type.

type TokenParam

type TokenParam = shared.TokenParam

This is an alias to an internal type.

type TokenPolicy

type TokenPolicy = shared.TokenPolicy

This is an alias to an internal type.

type TokenPolicyEffect

type TokenPolicyEffect = shared.TokenPolicyEffect

Allow or deny operations against the resources.

This is an alias to an internal type.

type TokenPolicyParam

type TokenPolicyParam = shared.TokenPolicyParam

This is an alias to an internal type.

type TokenPolicyPermissionGroup

type TokenPolicyPermissionGroup = shared.TokenPolicyPermissionGroup

A named group of permissions that map to a group of operations against resources.

This is an alias to an internal type.

type TokenPolicyPermissionGroupParam

type TokenPolicyPermissionGroupParam = shared.TokenPolicyPermissionGroupParam

A named group of permissions that map to a group of operations against resources.

This is an alias to an internal type.

type TokenPolicyPermissionGroupsMeta

type TokenPolicyPermissionGroupsMeta = shared.TokenPolicyPermissionGroupsMeta

Attributes associated to the permission group.

This is an alias to an internal type.

type TokenPolicyPermissionGroupsMetaParam

type TokenPolicyPermissionGroupsMetaParam = shared.TokenPolicyPermissionGroupsMetaParam

Attributes associated to the permission group.

This is an alias to an internal type.

type TokenPolicyResourcesIAMResourcesTypeObjectNested

type TokenPolicyResourcesIAMResourcesTypeObjectNested = shared.TokenPolicyResourcesIAMResourcesTypeObjectNested

Map of nested resource permissions

This is an alias to an internal type.

type TokenPolicyResourcesIAMResourcesTypeObjectNestedParam

type TokenPolicyResourcesIAMResourcesTypeObjectNestedParam = shared.TokenPolicyResourcesIAMResourcesTypeObjectNestedParam

Map of nested resource permissions

This is an alias to an internal type.

type TokenPolicyResourcesIAMResourcesTypeObjectString

type TokenPolicyResourcesIAMResourcesTypeObjectString = shared.TokenPolicyResourcesIAMResourcesTypeObjectString

Map of simple string resource permissions

This is an alias to an internal type.

type TokenPolicyResourcesIAMResourcesTypeObjectStringParam

type TokenPolicyResourcesIAMResourcesTypeObjectStringParam = shared.TokenPolicyResourcesIAMResourcesTypeObjectStringParam

Map of simple string resource permissions

This is an alias to an internal type.

type TokenPolicyResourcesUnion

type TokenPolicyResourcesUnion = shared.TokenPolicyResourcesUnion

A list of resource names that the policy applies to.

This is an alias to an internal type.

type TokenPolicyResourcesUnionParam

type TokenPolicyResourcesUnionParam = shared.TokenPolicyResourcesUnionParam

A list of resource names that the policy applies to.

This is an alias to an internal type.

type TokenStatus

type TokenStatus = shared.TokenStatus

Status of the token.

This is an alias to an internal type.

type TokenValue

type TokenValue = shared.TokenValue

The token value.

This is an alias to an internal type.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL