Documentation
¶
Index ¶
- Constants
- type ASN
- type ASNParam
- type AuditLog
- type AuditLogAction
- type AuditLogActor
- type AuditLogActorType
- type AuditLogOwner
- type AuditLogResource
- type CertificateCA
- type CertificateRequestType
- type CloudflareTunnel
- type CloudflareTunnelConnection
- type CloudflareTunnelStatus
- type CloudflareTunnelTunType
- type EmailSecurityService
- type Error
- type ErrorData
- type InvestigateDetectionsParams
- type InvestigateDetectionsResponse
- type InvestigateDetectionsResponseAttachment
- type InvestigateDetectionsResponseAttachmentsDetection
- type InvestigateDetectionsResponseEnvelope
- type InvestigateDetectionsResponseFinalDisposition
- type InvestigateDetectionsResponseHeader
- type InvestigateDetectionsResponseLink
- type InvestigateDetectionsResponseSenderInfo
- type InvestigateDetectionsResponseThreatCategory
- type InvestigateDetectionsResponseValidation
- type InvestigateDetectionsResponseValidationDKIM
- type InvestigateDetectionsResponseValidationDMARC
- type InvestigateDetectionsResponseValidationSPF
- type InvestigateGetParams
- type InvestigateGetResponse
- type InvestigateGetResponseDeliveryMode
- type InvestigateGetResponseEnvelope
- type InvestigateGetResponseFinalDisposition
- type InvestigateGetResponseValidation
- type InvestigateGetResponseValidationDKIM
- type InvestigateGetResponseValidationDMARC
- type InvestigateGetResponseValidationSPF
- type InvestigateListParams
- type InvestigateListParamsFinalDisposition
- type InvestigateListParamsMessageAction
- type InvestigateListResponse
- type InvestigateListResponseDeliveryMode
- type InvestigateListResponseFinalDisposition
- type InvestigateListResponseValidation
- type InvestigateListResponseValidationDKIM
- type InvestigateListResponseValidationDMARC
- type InvestigateListResponseValidationSPF
- type InvestigatePreviewParams
- type InvestigatePreviewResponse
- type InvestigatePreviewResponseEnvelope
- type InvestigateRawParams
- type InvestigateRawResponse
- type InvestigateRawResponseEnvelope
- type InvestigateService
- func (r *InvestigateService) Detections(ctx context.Context, postfixID string, query InvestigateDetectionsParams, ...) (res *InvestigateDetectionsResponse, err error)
- func (r *InvestigateService) Get(ctx context.Context, postfixID string, query InvestigateGetParams, ...) (res *InvestigateGetResponse, err error)
- func (r *InvestigateService) List(ctx context.Context, params InvestigateListParams, ...) (res *pagination.V4PagePaginationArray[InvestigateListResponse], err error)
- func (r *InvestigateService) ListAutoPaging(ctx context.Context, params InvestigateListParams, ...) *pagination.V4PagePaginationArrayAutoPager[InvestigateListResponse]
- func (r *InvestigateService) Preview(ctx context.Context, postfixID string, query InvestigatePreviewParams, ...) (res *InvestigatePreviewResponse, err error)
- func (r *InvestigateService) Raw(ctx context.Context, postfixID string, query InvestigateRawParams, ...) (res *InvestigateRawResponse, err error)
- func (r *InvestigateService) Trace(ctx context.Context, postfixID string, query InvestigateTraceParams, ...) (res *InvestigateTraceResponse, err error)
- type InvestigateTraceParams
- type InvestigateTraceResponse
- type InvestigateTraceResponseEnvelope
- type InvestigateTraceResponseInbound
- type InvestigateTraceResponseInboundLine
- type InvestigateTraceResponseOutbound
- type InvestigateTraceResponseOutboundLine
- type MemberParam
- type MemberRoleParam
- type MemberRolesPermissionsParam
- type MemberStatus
- type MemberUserParam
- type Permission
- type PermissionGrant
- type PermissionGrantParam
- type PhishguardListParams
- type PhishguardListResponse
- type PhishguardListResponseDisposition
- type PhishguardListResponseFields
- type PhishguardListResponseTag
- type PhishguardService
- func (r *PhishguardService) List(ctx context.Context, params PhishguardListParams, opts ...option.RequestOption) (res *pagination.SinglePage[PhishguardListResponse], err error)
- func (r *PhishguardService) ListAutoPaging(ctx context.Context, params PhishguardListParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[PhishguardListResponse]
- type RatePlan
- type RatePlanParam
- type ResponseInfo
- type Role
- type SettingAllowPatternDeleteParams
- type SettingAllowPatternDeleteResponse
- type SettingAllowPatternDeleteResponseEnvelope
- type SettingAllowPatternEditParams
- type SettingAllowPatternEditParamsPatternType
- type SettingAllowPatternEditResponse
- type SettingAllowPatternEditResponseEnvelope
- type SettingAllowPatternEditResponsePatternType
- type SettingAllowPatternGetParams
- type SettingAllowPatternGetResponse
- type SettingAllowPatternGetResponseEnvelope
- type SettingAllowPatternGetResponsePatternType
- type SettingAllowPatternListParams
- type SettingAllowPatternListParamsDirection
- type SettingAllowPatternListParamsOrder
- type SettingAllowPatternListParamsPatternType
- type SettingAllowPatternListResponse
- type SettingAllowPatternListResponsePatternType
- type SettingAllowPatternNewParams
- type SettingAllowPatternNewParamsBodyArray
- type SettingAllowPatternNewParamsBodyEmailSecurityCreateAllowPattern
- type SettingAllowPatternNewParamsBodyEmailSecurityCreateAllowPatternPatternType
- type SettingAllowPatternNewParamsBodyUnion
- type SettingAllowPatternNewResponseArray
- type SettingAllowPatternNewResponseArrayItem
- type SettingAllowPatternNewResponseArrayPatternType
- type SettingAllowPatternNewResponseEmailSecurityAllowPattern
- type SettingAllowPatternNewResponseEmailSecurityAllowPatternPatternType
- type SettingAllowPatternNewResponseEnvelope
- type SettingAllowPatternNewResponseUnion
- type SettingAllowPatternService
- func (r *SettingAllowPatternService) Delete(ctx context.Context, patternID int64, body SettingAllowPatternDeleteParams, ...) (res *SettingAllowPatternDeleteResponse, err error)
- func (r *SettingAllowPatternService) Edit(ctx context.Context, patternID int64, params SettingAllowPatternEditParams, ...) (res *SettingAllowPatternEditResponse, err error)
- func (r *SettingAllowPatternService) Get(ctx context.Context, patternID int64, query SettingAllowPatternGetParams, ...) (res *SettingAllowPatternGetResponse, err error)
- func (r *SettingAllowPatternService) List(ctx context.Context, params SettingAllowPatternListParams, ...) (res *pagination.V4PagePaginationArray[SettingAllowPatternListResponse], ...)
- func (r *SettingAllowPatternService) ListAutoPaging(ctx context.Context, params SettingAllowPatternListParams, ...) *pagination.V4PagePaginationArrayAutoPager[SettingAllowPatternListResponse]
- func (r *SettingAllowPatternService) New(ctx context.Context, params SettingAllowPatternNewParams, ...) (res *SettingAllowPatternNewResponseUnion, err error)
- type SettingBlockSenderDeleteParams
- type SettingBlockSenderDeleteResponse
- type SettingBlockSenderDeleteResponseEnvelope
- type SettingBlockSenderEditParams
- type SettingBlockSenderEditParamsPatternType
- type SettingBlockSenderEditResponse
- type SettingBlockSenderEditResponseEnvelope
- type SettingBlockSenderEditResponsePatternType
- type SettingBlockSenderGetParams
- type SettingBlockSenderGetResponse
- type SettingBlockSenderGetResponseEnvelope
- type SettingBlockSenderGetResponsePatternType
- type SettingBlockSenderListParams
- type SettingBlockSenderListParamsDirection
- type SettingBlockSenderListParamsOrder
- type SettingBlockSenderListParamsPatternType
- type SettingBlockSenderListResponse
- type SettingBlockSenderListResponsePatternType
- type SettingBlockSenderNewParams
- type SettingBlockSenderNewParamsBodyArray
- type SettingBlockSenderNewParamsBodyEmailSecurityCreateBlockedSender
- type SettingBlockSenderNewParamsBodyEmailSecurityCreateBlockedSenderPatternType
- type SettingBlockSenderNewParamsBodyUnion
- type SettingBlockSenderNewResponseArray
- type SettingBlockSenderNewResponseArrayItem
- type SettingBlockSenderNewResponseArrayPatternType
- type SettingBlockSenderNewResponseEmailSecurityBlockedSender
- type SettingBlockSenderNewResponseEmailSecurityBlockedSenderPatternType
- type SettingBlockSenderNewResponseEnvelope
- type SettingBlockSenderNewResponseUnion
- type SettingBlockSenderService
- func (r *SettingBlockSenderService) Delete(ctx context.Context, patternID int64, body SettingBlockSenderDeleteParams, ...) (res *SettingBlockSenderDeleteResponse, err error)
- func (r *SettingBlockSenderService) Edit(ctx context.Context, patternID int64, params SettingBlockSenderEditParams, ...) (res *SettingBlockSenderEditResponse, err error)
- func (r *SettingBlockSenderService) Get(ctx context.Context, patternID int64, query SettingBlockSenderGetParams, ...) (res *SettingBlockSenderGetResponse, err error)
- func (r *SettingBlockSenderService) List(ctx context.Context, params SettingBlockSenderListParams, ...) (res *pagination.V4PagePaginationArray[SettingBlockSenderListResponse], ...)
- func (r *SettingBlockSenderService) ListAutoPaging(ctx context.Context, params SettingBlockSenderListParams, ...) *pagination.V4PagePaginationArrayAutoPager[SettingBlockSenderListResponse]
- func (r *SettingBlockSenderService) New(ctx context.Context, params SettingBlockSenderNewParams, ...) (res *SettingBlockSenderNewResponseUnion, err error)
- type SettingDomainDeleteParams
- type SettingDomainDeleteResponse
- type SettingDomainDeleteResponseEnvelope
- type SettingDomainEditParams
- type SettingDomainEditResponse
- type SettingDomainEditResponseAllowedDeliveryMode
- type SettingDomainEditResponseEnvelope
- type SettingDomainListParams
- type SettingDomainListParamsAllowedDeliveryMode
- type SettingDomainListParamsDirection
- type SettingDomainListParamsOrder
- type SettingDomainListResponse
- type SettingDomainListResponseAllowedDeliveryMode
- type SettingDomainService
- func (r *SettingDomainService) Delete(ctx context.Context, domainID int64, body SettingDomainDeleteParams, ...) (res *SettingDomainDeleteResponse, err error)
- func (r *SettingDomainService) Edit(ctx context.Context, domainID int64, params SettingDomainEditParams, ...) (res *SettingDomainEditResponse, err error)
- func (r *SettingDomainService) List(ctx context.Context, params SettingDomainListParams, ...) (res *pagination.V4PagePaginationArray[SettingDomainListResponse], err error)
- func (r *SettingDomainService) ListAutoPaging(ctx context.Context, params SettingDomainListParams, ...) *pagination.V4PagePaginationArrayAutoPager[SettingDomainListResponse]
- type SettingImpersonationRegistryDeleteParams
- type SettingImpersonationRegistryDeleteResponse
- type SettingImpersonationRegistryDeleteResponseEnvelope
- type SettingImpersonationRegistryEditParams
- type SettingImpersonationRegistryEditResponse
- type SettingImpersonationRegistryEditResponseEnvelope
- type SettingImpersonationRegistryGetParams
- type SettingImpersonationRegistryGetResponse
- type SettingImpersonationRegistryGetResponseEnvelope
- type SettingImpersonationRegistryListParams
- type SettingImpersonationRegistryListParamsDirection
- type SettingImpersonationRegistryListParamsOrder
- type SettingImpersonationRegistryListParamsProvenance
- type SettingImpersonationRegistryListResponse
- type SettingImpersonationRegistryNewParams
- type SettingImpersonationRegistryNewParamsBodyArray
- type SettingImpersonationRegistryNewParamsBodyEmailSecurityCreateDisplayName
- type SettingImpersonationRegistryNewParamsBodyUnion
- type SettingImpersonationRegistryNewResponseArray
- type SettingImpersonationRegistryNewResponseArrayItem
- type SettingImpersonationRegistryNewResponseEmailSecurityDisplayName
- type SettingImpersonationRegistryNewResponseEnvelope
- type SettingImpersonationRegistryNewResponseUnion
- type SettingImpersonationRegistryService
- func (r *SettingImpersonationRegistryService) Delete(ctx context.Context, displayNameID int64, ...) (res *SettingImpersonationRegistryDeleteResponse, err error)
- func (r *SettingImpersonationRegistryService) Edit(ctx context.Context, displayNameID int64, ...) (res *SettingImpersonationRegistryEditResponse, err error)
- func (r *SettingImpersonationRegistryService) Get(ctx context.Context, displayNameID int64, ...) (res *SettingImpersonationRegistryGetResponse, err error)
- func (r *SettingImpersonationRegistryService) List(ctx context.Context, params SettingImpersonationRegistryListParams, ...) (...)
- func (r *SettingImpersonationRegistryService) ListAutoPaging(ctx context.Context, params SettingImpersonationRegistryListParams, ...) ...
- func (r *SettingImpersonationRegistryService) New(ctx context.Context, params SettingImpersonationRegistryNewParams, ...) (res *SettingImpersonationRegistryNewResponseUnion, err error)
- type SettingService
- type SettingTrustedDomainDeleteParams
- type SettingTrustedDomainDeleteResponse
- type SettingTrustedDomainDeleteResponseEnvelope
- type SettingTrustedDomainEditParams
- type SettingTrustedDomainEditResponse
- type SettingTrustedDomainEditResponseEnvelope
- type SettingTrustedDomainGetParams
- type SettingTrustedDomainGetResponse
- type SettingTrustedDomainGetResponseEnvelope
- type SettingTrustedDomainListParams
- type SettingTrustedDomainListParamsDirection
- type SettingTrustedDomainListParamsOrder
- type SettingTrustedDomainListResponse
- type SettingTrustedDomainNewParams
- type SettingTrustedDomainNewParamsBodyArray
- type SettingTrustedDomainNewParamsBodyEmailSecurityCreateTrustedDomain
- type SettingTrustedDomainNewParamsBodyUnion
- type SettingTrustedDomainNewResponseArray
- type SettingTrustedDomainNewResponseArrayItem
- type SettingTrustedDomainNewResponseEmailSecurityTrustedDomain
- type SettingTrustedDomainNewResponseEnvelope
- type SettingTrustedDomainNewResponseUnion
- type SettingTrustedDomainService
- func (r *SettingTrustedDomainService) Delete(ctx context.Context, patternID int64, body SettingTrustedDomainDeleteParams, ...) (res *SettingTrustedDomainDeleteResponse, err error)
- func (r *SettingTrustedDomainService) Edit(ctx context.Context, patternID int64, params SettingTrustedDomainEditParams, ...) (res *SettingTrustedDomainEditResponse, err error)
- func (r *SettingTrustedDomainService) Get(ctx context.Context, patternID int64, query SettingTrustedDomainGetParams, ...) (res *SettingTrustedDomainGetResponse, err error)
- func (r *SettingTrustedDomainService) List(ctx context.Context, params SettingTrustedDomainListParams, ...) (res *pagination.V4PagePaginationArray[SettingTrustedDomainListResponse], ...)
- func (r *SettingTrustedDomainService) ListAutoPaging(ctx context.Context, params SettingTrustedDomainListParams, ...) *pagination.V4PagePaginationArrayAutoPager[SettingTrustedDomainListResponse]
- func (r *SettingTrustedDomainService) New(ctx context.Context, params SettingTrustedDomainNewParams, ...) (res *SettingTrustedDomainNewResponseUnion, err error)
- type SortDirection
- type Subscription
- type SubscriptionFrequency
- type SubscriptionParam
- type SubscriptionState
Constants ¶
const AuditLogActorTypeAdmin = shared.AuditLogActorTypeAdmin
This is an alias to an internal value.
const AuditLogActorTypeCloudflare = shared.AuditLogActorTypeCloudflare
This is an alias to an internal value.
const AuditLogActorTypeUser = shared.AuditLogActorTypeUser
This is an alias to an internal value.
const CertificateCADigicert = shared.CertificateCADigicert
This is an alias to an internal value.
const CertificateCAGoogle = shared.CertificateCAGoogle
This is an alias to an internal value.
const CertificateCALetsEncrypt = shared.CertificateCALetsEncrypt
This is an alias to an internal value.
const CertificateCASSLCom = shared.CertificateCASSLCom
This is an alias to an internal value.
const CertificateRequestTypeKeylessCertificate = shared.CertificateRequestTypeKeylessCertificate
This is an alias to an internal value.
const CertificateRequestTypeOriginECC = shared.CertificateRequestTypeOriginECC
This is an alias to an internal value.
const CertificateRequestTypeOriginRSA = shared.CertificateRequestTypeOriginRSA
This is an alias to an internal value.
const CloudflareTunnelStatusDegraded = shared.CloudflareTunnelStatusDegraded
This is an alias to an internal value.
const CloudflareTunnelStatusDown = shared.CloudflareTunnelStatusDown
This is an alias to an internal value.
const CloudflareTunnelStatusHealthy = shared.CloudflareTunnelStatusHealthy
This is an alias to an internal value.
const CloudflareTunnelStatusInactive = shared.CloudflareTunnelStatusInactive
This is an alias to an internal value.
const CloudflareTunnelTunTypeCNI = shared.CloudflareTunnelTunTypeCNI
This is an alias to an internal value.
const CloudflareTunnelTunTypeCfdTunnel = shared.CloudflareTunnelTunTypeCfdTunnel
This is an alias to an internal value.
const CloudflareTunnelTunTypeGRE = shared.CloudflareTunnelTunTypeGRE
This is an alias to an internal value.
const CloudflareTunnelTunTypeIPSec = shared.CloudflareTunnelTunTypeIPSec
This is an alias to an internal value.
const CloudflareTunnelTunTypeWARPConnector = shared.CloudflareTunnelTunTypeWARPConnector
This is an alias to an internal value.
const MemberStatusAccepted = shared.MemberStatusAccepted
This is an alias to an internal value.
const MemberStatusPending = shared.MemberStatusPending
This is an alias to an internal value.
const SortDirectionAsc = shared.SortDirectionAsc
This is an alias to an internal value.
const SortDirectionDesc = shared.SortDirectionDesc
This is an alias to an internal value.
const SubscriptionFrequencyMonthly = shared.SubscriptionFrequencyMonthly
This is an alias to an internal value.
const SubscriptionFrequencyQuarterly = shared.SubscriptionFrequencyQuarterly
This is an alias to an internal value.
const SubscriptionFrequencyWeekly = shared.SubscriptionFrequencyWeekly
This is an alias to an internal value.
const SubscriptionFrequencyYearly = shared.SubscriptionFrequencyYearly
This is an alias to an internal value.
const SubscriptionStateAwaitingPayment = shared.SubscriptionStateAwaitingPayment
This is an alias to an internal value.
const SubscriptionStateCancelled = shared.SubscriptionStateCancelled
This is an alias to an internal value.
const SubscriptionStateExpired = shared.SubscriptionStateExpired
This is an alias to an internal value.
const SubscriptionStateFailed = shared.SubscriptionStateFailed
This is an alias to an internal value.
const SubscriptionStatePaid = shared.SubscriptionStatePaid
This is an alias to an internal value.
const SubscriptionStateProvisioned = shared.SubscriptionStateProvisioned
This is an alias to an internal value.
const SubscriptionStateTrial = shared.SubscriptionStateTrial
This is an alias to an internal value.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
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 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
Phishguard *PhishguardService
Settings *SettingService
}
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 InvestigateDetectionsResponse ¶
type InvestigateDetectionsResponse struct {
Action string `json:"action,required"`
Attachments []InvestigateDetectionsResponseAttachment `json:"attachments,required"`
Headers []InvestigateDetectionsResponseHeader `json:"headers,required"`
Links []InvestigateDetectionsResponseLink `json:"links,required"`
SenderInfo InvestigateDetectionsResponseSenderInfo `json:"sender_info,required"`
ThreatCategories []InvestigateDetectionsResponseThreatCategory `json:"threat_categories,required"`
Validation InvestigateDetectionsResponseValidation `json:"validation,required"`
FinalDisposition InvestigateDetectionsResponseFinalDisposition `json:"final_disposition,nullable"`
JSON investigateDetectionsResponseJSON `json:"-"`
}
func (*InvestigateDetectionsResponse) UnmarshalJSON ¶
func (r *InvestigateDetectionsResponse) UnmarshalJSON(data []byte) (err error)
type InvestigateDetectionsResponseAttachment ¶
type InvestigateDetectionsResponseAttachment struct {
Size int64 `json:"size,required"`
ContentType string `json:"content_type,nullable"`
Detection InvestigateDetectionsResponseAttachmentsDetection `json:"detection,nullable"`
Encrypted bool `json:"encrypted,nullable"`
Name string `json:"name,nullable"`
JSON investigateDetectionsResponseAttachmentJSON `json:"-"`
}
func (*InvestigateDetectionsResponseAttachment) UnmarshalJSON ¶
func (r *InvestigateDetectionsResponseAttachment) UnmarshalJSON(data []byte) (err error)
type InvestigateDetectionsResponseAttachmentsDetection ¶
type InvestigateDetectionsResponseAttachmentsDetection string
const ( InvestigateDetectionsResponseAttachmentsDetectionMalicious InvestigateDetectionsResponseAttachmentsDetection = "MALICIOUS" InvestigateDetectionsResponseAttachmentsDetectionMaliciousBec InvestigateDetectionsResponseAttachmentsDetection = "MALICIOUS-BEC" InvestigateDetectionsResponseAttachmentsDetectionSuspicious InvestigateDetectionsResponseAttachmentsDetection = "SUSPICIOUS" InvestigateDetectionsResponseAttachmentsDetectionSpoof InvestigateDetectionsResponseAttachmentsDetection = "SPOOF" InvestigateDetectionsResponseAttachmentsDetectionSpam InvestigateDetectionsResponseAttachmentsDetection = "SPAM" InvestigateDetectionsResponseAttachmentsDetectionBulk InvestigateDetectionsResponseAttachmentsDetection = "BULK" InvestigateDetectionsResponseAttachmentsDetectionEncrypted InvestigateDetectionsResponseAttachmentsDetection = "ENCRYPTED" InvestigateDetectionsResponseAttachmentsDetectionExternal InvestigateDetectionsResponseAttachmentsDetection = "EXTERNAL" InvestigateDetectionsResponseAttachmentsDetectionUnknown InvestigateDetectionsResponseAttachmentsDetection = "UNKNOWN" InvestigateDetectionsResponseAttachmentsDetectionNone InvestigateDetectionsResponseAttachmentsDetection = "NONE" )
func (InvestigateDetectionsResponseAttachmentsDetection) IsKnown ¶
func (r InvestigateDetectionsResponseAttachmentsDetection) IsKnown() bool
type InvestigateDetectionsResponseEnvelope ¶
type InvestigateDetectionsResponseEnvelope struct {
Errors []shared.ResponseInfo `json:"errors,required"`
Messages []shared.ResponseInfo `json:"messages,required"`
Result InvestigateDetectionsResponse `json:"result,required"`
Success bool `json:"success,required"`
JSON investigateDetectionsResponseEnvelopeJSON `json:"-"`
}
func (*InvestigateDetectionsResponseEnvelope) UnmarshalJSON ¶
func (r *InvestigateDetectionsResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type InvestigateDetectionsResponseFinalDisposition ¶
type InvestigateDetectionsResponseFinalDisposition string
const ( InvestigateDetectionsResponseFinalDispositionMalicious InvestigateDetectionsResponseFinalDisposition = "MALICIOUS" InvestigateDetectionsResponseFinalDispositionMaliciousBec InvestigateDetectionsResponseFinalDisposition = "MALICIOUS-BEC" InvestigateDetectionsResponseFinalDispositionSuspicious InvestigateDetectionsResponseFinalDisposition = "SUSPICIOUS" InvestigateDetectionsResponseFinalDispositionSpoof InvestigateDetectionsResponseFinalDisposition = "SPOOF" InvestigateDetectionsResponseFinalDispositionSpam InvestigateDetectionsResponseFinalDisposition = "SPAM" InvestigateDetectionsResponseFinalDispositionBulk InvestigateDetectionsResponseFinalDisposition = "BULK" InvestigateDetectionsResponseFinalDispositionEncrypted InvestigateDetectionsResponseFinalDisposition = "ENCRYPTED" InvestigateDetectionsResponseFinalDispositionExternal InvestigateDetectionsResponseFinalDisposition = "EXTERNAL" InvestigateDetectionsResponseFinalDispositionUnknown InvestigateDetectionsResponseFinalDisposition = "UNKNOWN" InvestigateDetectionsResponseFinalDispositionNone InvestigateDetectionsResponseFinalDisposition = "NONE" )
func (InvestigateDetectionsResponseFinalDisposition) IsKnown ¶
func (r InvestigateDetectionsResponseFinalDisposition) IsKnown() bool
type InvestigateDetectionsResponseHeader ¶
type InvestigateDetectionsResponseHeader struct {
Name string `json:"name,required"`
Value string `json:"value,required"`
JSON investigateDetectionsResponseHeaderJSON `json:"-"`
}
func (*InvestigateDetectionsResponseHeader) UnmarshalJSON ¶
func (r *InvestigateDetectionsResponseHeader) UnmarshalJSON(data []byte) (err error)
type InvestigateDetectionsResponseLink ¶
type InvestigateDetectionsResponseLink struct {
Href string `json:"href,required"`
Text string `json:"text,nullable"`
JSON investigateDetectionsResponseLinkJSON `json:"-"`
}
func (*InvestigateDetectionsResponseLink) UnmarshalJSON ¶
func (r *InvestigateDetectionsResponseLink) UnmarshalJSON(data []byte) (err error)
type InvestigateDetectionsResponseSenderInfo ¶
type InvestigateDetectionsResponseSenderInfo struct {
// Name of the autonomous system
AsName string `json:"as_name,nullable"`
// 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 investigateDetectionsResponseSenderInfoJSON `json:"-"`
}
func (*InvestigateDetectionsResponseSenderInfo) UnmarshalJSON ¶
func (r *InvestigateDetectionsResponseSenderInfo) UnmarshalJSON(data []byte) (err error)
type InvestigateDetectionsResponseThreatCategory ¶
type InvestigateDetectionsResponseThreatCategory struct {
ID int64 `json:"id,required"`
Description string `json:"description,nullable"`
Name string `json:"name,nullable"`
JSON investigateDetectionsResponseThreatCategoryJSON `json:"-"`
}
func (*InvestigateDetectionsResponseThreatCategory) UnmarshalJSON ¶
func (r *InvestigateDetectionsResponseThreatCategory) UnmarshalJSON(data []byte) (err error)
type InvestigateDetectionsResponseValidation ¶
type InvestigateDetectionsResponseValidation struct {
Comment string `json:"comment,nullable"`
DKIM InvestigateDetectionsResponseValidationDKIM `json:"dkim,nullable"`
DMARC InvestigateDetectionsResponseValidationDMARC `json:"dmarc,nullable"`
SPF InvestigateDetectionsResponseValidationSPF `json:"spf,nullable"`
JSON investigateDetectionsResponseValidationJSON `json:"-"`
}
func (*InvestigateDetectionsResponseValidation) UnmarshalJSON ¶
func (r *InvestigateDetectionsResponseValidation) UnmarshalJSON(data []byte) (err error)
type InvestigateDetectionsResponseValidationDKIM ¶
type InvestigateDetectionsResponseValidationDKIM string
const ( InvestigateDetectionsResponseValidationDKIMPass InvestigateDetectionsResponseValidationDKIM = "pass" InvestigateDetectionsResponseValidationDKIMNeutral InvestigateDetectionsResponseValidationDKIM = "neutral" InvestigateDetectionsResponseValidationDKIMFail InvestigateDetectionsResponseValidationDKIM = "fail" InvestigateDetectionsResponseValidationDKIMError InvestigateDetectionsResponseValidationDKIM = "error" InvestigateDetectionsResponseValidationDKIMNone InvestigateDetectionsResponseValidationDKIM = "none" )
func (InvestigateDetectionsResponseValidationDKIM) IsKnown ¶
func (r InvestigateDetectionsResponseValidationDKIM) IsKnown() bool
type InvestigateDetectionsResponseValidationDMARC ¶
type InvestigateDetectionsResponseValidationDMARC string
const ( InvestigateDetectionsResponseValidationDMARCPass InvestigateDetectionsResponseValidationDMARC = "pass" InvestigateDetectionsResponseValidationDMARCNeutral InvestigateDetectionsResponseValidationDMARC = "neutral" InvestigateDetectionsResponseValidationDMARCFail InvestigateDetectionsResponseValidationDMARC = "fail" InvestigateDetectionsResponseValidationDMARCError InvestigateDetectionsResponseValidationDMARC = "error" InvestigateDetectionsResponseValidationDMARCNone InvestigateDetectionsResponseValidationDMARC = "none" )
func (InvestigateDetectionsResponseValidationDMARC) IsKnown ¶
func (r InvestigateDetectionsResponseValidationDMARC) IsKnown() bool
type InvestigateDetectionsResponseValidationSPF ¶
type InvestigateDetectionsResponseValidationSPF string
const ( InvestigateDetectionsResponseValidationSPFPass InvestigateDetectionsResponseValidationSPF = "pass" InvestigateDetectionsResponseValidationSPFNeutral InvestigateDetectionsResponseValidationSPF = "neutral" InvestigateDetectionsResponseValidationSPFFail InvestigateDetectionsResponseValidationSPF = "fail" InvestigateDetectionsResponseValidationSPFError InvestigateDetectionsResponseValidationSPF = "error" InvestigateDetectionsResponseValidationSPFNone InvestigateDetectionsResponseValidationSPF = "none" )
func (InvestigateDetectionsResponseValidationSPF) IsKnown ¶
func (r InvestigateDetectionsResponseValidationSPF) IsKnown() bool
type InvestigateGetParams ¶
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"`
MessageID string `json:"message_id,required"`
// Message identifier
PostfixID string `json:"postfix_id,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"`
From string `json:"from,nullable"`
FromName string `json:"from_name,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 ¶
func (r InvestigateGetResponseDeliveryMode) IsKnown() bool
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 ¶
func (r InvestigateGetResponseFinalDisposition) IsKnown() bool
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 ¶
func (r InvestigateGetResponseValidationDKIM) IsKnown() bool
type InvestigateGetResponseValidationDMARC ¶
type InvestigateGetResponseValidationDMARC string
const ( InvestigateGetResponseValidationDMARCPass InvestigateGetResponseValidationDMARC = "pass" InvestigateGetResponseValidationDMARCNeutral InvestigateGetResponseValidationDMARC = "neutral" InvestigateGetResponseValidationDMARCFail InvestigateGetResponseValidationDMARC = "fail" InvestigateGetResponseValidationDMARCError InvestigateGetResponseValidationDMARC = "error" InvestigateGetResponseValidationDMARCNone InvestigateGetResponseValidationDMARC = "none" )
func (InvestigateGetResponseValidationDMARC) IsKnown ¶
func (r InvestigateGetResponseValidationDMARC) IsKnown() bool
type InvestigateGetResponseValidationSPF ¶
type InvestigateGetResponseValidationSPF string
const ( InvestigateGetResponseValidationSPFPass InvestigateGetResponseValidationSPF = "pass" InvestigateGetResponseValidationSPFNeutral InvestigateGetResponseValidationSPF = "neutral" InvestigateGetResponseValidationSPFFail InvestigateGetResponseValidationSPF = "fail" InvestigateGetResponseValidationSPFError InvestigateGetResponseValidationSPF = "error" InvestigateGetResponseValidationSPFNone InvestigateGetResponseValidationSPF = "none" )
func (InvestigateGetResponseValidationSPF) IsKnown ¶
func (r InvestigateGetResponseValidationSPF) IsKnown() bool
type InvestigateListParams ¶
type InvestigateListParams struct {
// Account Identifier
AccountID param.Field[string] `path:"account_id,required"`
// Controls whether the message action log in included in the response.
ActionLog param.Field[bool] `query:"action_log"`
AlertID param.Field[string] `query:"alert_id"`
// If `false`, the search includes non-detections.
DetectionsOnly param.Field[bool] `query:"detections_only"`
// Filter by the sender domain
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"`
// Filter messages by the provided disposition.
FinalDisposition param.Field[InvestigateListParamsFinalDisposition] `query:"final_disposition"`
// Filter messages by actions applied to them
MessageAction param.Field[InvestigateListParamsMessageAction] `query:"message_action"`
MessageID param.Field[string] `query:"message_id"`
Metric param.Field[string] `query:"metric"`
// Page number of paginated results.
Page param.Field[int64] `query:"page"`
// Number of results to display.
PerPage param.Field[int64] `query:"per_page"`
// Space delimited query term(s). 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"`
}
func (InvestigateListParams) URLQuery ¶
func (r InvestigateListParams) URLQuery() (v url.Values)
URLQuery serializes InvestigateListParams's query parameters as `url.Values`.
type InvestigateListParamsFinalDisposition ¶
type InvestigateListParamsFinalDisposition string
Filter messages by the provided disposition.
const ( InvestigateListParamsFinalDispositionMalicious InvestigateListParamsFinalDisposition = "MALICIOUS" InvestigateListParamsFinalDispositionSuspicious InvestigateListParamsFinalDisposition = "SUSPICIOUS" InvestigateListParamsFinalDispositionSpoof InvestigateListParamsFinalDisposition = "SPOOF" InvestigateListParamsFinalDispositionSpam InvestigateListParamsFinalDisposition = "SPAM" InvestigateListParamsFinalDispositionBulk InvestigateListParamsFinalDisposition = "BULK" )
func (InvestigateListParamsFinalDisposition) IsKnown ¶
func (r InvestigateListParamsFinalDisposition) IsKnown() bool
type InvestigateListParamsMessageAction ¶
type InvestigateListParamsMessageAction string
Filter messages by actions applied to them
const ( InvestigateListParamsMessageActionPreview InvestigateListParamsMessageAction = "PREVIEW" InvestigateListParamsMessageActionQuarantineReleased InvestigateListParamsMessageAction = "QUARANTINE_RELEASED" InvestigateListParamsMessageActionMoved InvestigateListParamsMessageAction = "MOVED" )
func (InvestigateListParamsMessageAction) IsKnown ¶
func (r InvestigateListParamsMessageAction) IsKnown() bool
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"`
MessageID string `json:"message_id,required"`
// Message identifier
PostfixID string `json:"postfix_id,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"`
From string `json:"from,nullable"`
FromName string `json:"from_name,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 ¶
func (r InvestigateListResponseDeliveryMode) IsKnown() bool
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 ¶
func (r InvestigateListResponseFinalDisposition) IsKnown() bool
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 ¶
func (r InvestigateListResponseValidationDKIM) IsKnown() bool
type InvestigateListResponseValidationDMARC ¶
type InvestigateListResponseValidationDMARC string
const ( InvestigateListResponseValidationDMARCPass InvestigateListResponseValidationDMARC = "pass" InvestigateListResponseValidationDMARCNeutral InvestigateListResponseValidationDMARC = "neutral" InvestigateListResponseValidationDMARCFail InvestigateListResponseValidationDMARC = "fail" InvestigateListResponseValidationDMARCError InvestigateListResponseValidationDMARC = "error" InvestigateListResponseValidationDMARCNone InvestigateListResponseValidationDMARC = "none" )
func (InvestigateListResponseValidationDMARC) IsKnown ¶
func (r InvestigateListResponseValidationDMARC) IsKnown() bool
type InvestigateListResponseValidationSPF ¶
type InvestigateListResponseValidationSPF string
const ( InvestigateListResponseValidationSPFPass InvestigateListResponseValidationSPF = "pass" InvestigateListResponseValidationSPFNeutral InvestigateListResponseValidationSPF = "neutral" InvestigateListResponseValidationSPFFail InvestigateListResponseValidationSPF = "fail" InvestigateListResponseValidationSPFError InvestigateListResponseValidationSPF = "error" InvestigateListResponseValidationSPFNone InvestigateListResponseValidationSPF = "none" )
func (InvestigateListResponseValidationSPF) IsKnown ¶
func (r InvestigateListResponseValidationSPF) IsKnown() bool
type InvestigatePreviewResponse ¶
type InvestigatePreviewResponse struct {
// Base64 encoded PNG image
Screenshot string `json:"screenshot,required"`
JSON investigatePreviewResponseJSON `json:"-"`
}
func (*InvestigatePreviewResponse) UnmarshalJSON ¶
func (r *InvestigatePreviewResponse) UnmarshalJSON(data []byte) (err error)
type InvestigatePreviewResponseEnvelope ¶
type InvestigatePreviewResponseEnvelope struct {
Errors []shared.ResponseInfo `json:"errors,required"`
Messages []shared.ResponseInfo `json:"messages,required"`
Result InvestigatePreviewResponse `json:"result,required"`
Success bool `json:"success,required"`
JSON investigatePreviewResponseEnvelopeJSON `json:"-"`
}
func (*InvestigatePreviewResponseEnvelope) UnmarshalJSON ¶
func (r *InvestigatePreviewResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type InvestigateRawParams ¶
type InvestigateRawResponse ¶
type InvestigateRawResponse struct {
// UTF-8 encoded eml file
Raw string `json:"raw,required"`
JSON investigateRawResponseJSON `json:"-"`
}
func (*InvestigateRawResponse) UnmarshalJSON ¶
func (r *InvestigateRawResponse) UnmarshalJSON(data []byte) (err error)
type InvestigateRawResponseEnvelope ¶
type InvestigateRawResponseEnvelope struct {
Errors []shared.ResponseInfo `json:"errors,required"`
Messages []shared.ResponseInfo `json:"messages,required"`
Result InvestigateRawResponse `json:"result,required"`
Success bool `json:"success,required"`
JSON investigateRawResponseEnvelopeJSON `json:"-"`
}
func (*InvestigateRawResponseEnvelope) UnmarshalJSON ¶
func (r *InvestigateRawResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type InvestigateService ¶
type InvestigateService struct {
Options []option.RequestOption
}
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) Detections ¶
func (r *InvestigateService) Detections(ctx context.Context, postfixID string, query InvestigateDetectionsParams, opts ...option.RequestOption) (res *InvestigateDetectionsResponse, err error)
For emails that have a detection, this endpoint returns detection details such as threat categories, sender information, and links.
func (*InvestigateService) Get ¶
func (r *InvestigateService) Get(ctx context.Context, postfixID string, query InvestigateGetParams, opts ...option.RequestOption) (res *InvestigateGetResponse, err error)
Get message details
func (*InvestigateService) List ¶
func (r *InvestigateService) List(ctx context.Context, params InvestigateListParams, opts ...option.RequestOption) (res *pagination.V4PagePaginationArray[InvestigateListResponse], err error)
This endpoint returns information for each email that matches the search parameter(s).
func (*InvestigateService) ListAutoPaging ¶
func (r *InvestigateService) ListAutoPaging(ctx context.Context, params InvestigateListParams, opts ...option.RequestOption) *pagination.V4PagePaginationArrayAutoPager[InvestigateListResponse]
This endpoint returns information for each email that matches the search parameter(s).
func (*InvestigateService) Preview ¶
func (r *InvestigateService) Preview(ctx context.Context, postfixID string, query InvestigatePreviewParams, opts ...option.RequestOption) (res *InvestigatePreviewResponse, err error)
For emails that have a detection, this endpoint returns a preview of the message body as a base64 encoded PNG image.
func (*InvestigateService) Raw ¶
func (r *InvestigateService) Raw(ctx context.Context, postfixID string, query InvestigateRawParams, opts ...option.RequestOption) (res *InvestigateRawResponse, err error)
For emails that have a detection, this endpoint returns the raw email as an EML file.
func (*InvestigateService) Trace ¶
func (r *InvestigateService) Trace(ctx context.Context, postfixID string, query InvestigateTraceParams, opts ...option.RequestOption) (res *InvestigateTraceResponse, err error)
Get email trace
type InvestigateTraceParams ¶
type InvestigateTraceResponse ¶
type InvestigateTraceResponse struct {
Inbound InvestigateTraceResponseInbound `json:"inbound,required"`
Outbound InvestigateTraceResponseOutbound `json:"outbound,required"`
JSON investigateTraceResponseJSON `json:"-"`
}
func (*InvestigateTraceResponse) UnmarshalJSON ¶
func (r *InvestigateTraceResponse) UnmarshalJSON(data []byte) (err error)
type InvestigateTraceResponseEnvelope ¶
type InvestigateTraceResponseEnvelope struct {
Errors []shared.ResponseInfo `json:"errors,required"`
Messages []shared.ResponseInfo `json:"messages,required"`
Result InvestigateTraceResponse `json:"result,required"`
Success bool `json:"success,required"`
JSON investigateTraceResponseEnvelopeJSON `json:"-"`
}
func (*InvestigateTraceResponseEnvelope) UnmarshalJSON ¶
func (r *InvestigateTraceResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type InvestigateTraceResponseInbound ¶
type InvestigateTraceResponseInbound struct {
Lines []InvestigateTraceResponseInboundLine `json:"lines,nullable"`
JSON investigateTraceResponseInboundJSON `json:"-"`
}
func (*InvestigateTraceResponseInbound) UnmarshalJSON ¶
func (r *InvestigateTraceResponseInbound) UnmarshalJSON(data []byte) (err error)
type InvestigateTraceResponseInboundLine ¶
type InvestigateTraceResponseInboundLine struct {
Lineno int64 `json:"lineno,required"`
Message string `json:"message,required"`
Ts time.Time `json:"ts,required" format:"date-time"`
JSON investigateTraceResponseInboundLineJSON `json:"-"`
}
func (*InvestigateTraceResponseInboundLine) UnmarshalJSON ¶
func (r *InvestigateTraceResponseInboundLine) UnmarshalJSON(data []byte) (err error)
type InvestigateTraceResponseOutbound ¶
type InvestigateTraceResponseOutbound struct {
Lines []InvestigateTraceResponseOutboundLine `json:"lines,nullable"`
JSON investigateTraceResponseOutboundJSON `json:"-"`
}
func (*InvestigateTraceResponseOutbound) UnmarshalJSON ¶
func (r *InvestigateTraceResponseOutbound) UnmarshalJSON(data []byte) (err error)
type InvestigateTraceResponseOutboundLine ¶
type InvestigateTraceResponseOutboundLine struct {
Lineno int64 `json:"lineno,required"`
Message string `json:"message,required"`
Ts time.Time `json:"ts,required" format:"date-time"`
JSON investigateTraceResponseOutboundLineJSON `json:"-"`
}
func (*InvestigateTraceResponseOutboundLine) UnmarshalJSON ¶
func (r *InvestigateTraceResponseOutboundLine) UnmarshalJSON(data []byte) (err error)
type MemberRoleParam ¶
type MemberRoleParam = shared.MemberRoleParam
This is an alias to an internal type.
type MemberRolesPermissionsParam ¶
type MemberRolesPermissionsParam = shared.MemberRolesPermissionsParam
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 MemberUserParam ¶
type MemberUserParam = shared.MemberUserParam
Details of the user associated to the membership.
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 PhishguardListParams ¶
type PhishguardListParams struct {
// Account Identifier
AccountID param.Field[string] `path:"account_id,required"`
FromDate param.Field[time.Time] `query:"from_date,required" format:"date"`
ToDate param.Field[time.Time] `query:"to_date,required" format:"date"`
}
func (PhishguardListParams) URLQuery ¶
func (r PhishguardListParams) URLQuery() (v url.Values)
URLQuery serializes PhishguardListParams's query parameters as `url.Values`.
type PhishguardListResponse ¶
type PhishguardListResponse struct {
ID int64 `json:"id,required"`
Content string `json:"content,required"`
Disposition PhishguardListResponseDisposition `json:"disposition,required"`
Fields PhishguardListResponseFields `json:"fields,required"`
Priority string `json:"priority,required"`
Title string `json:"title,required"`
Ts time.Time `json:"ts,required" format:"date-time"`
Tags []PhishguardListResponseTag `json:"tags,nullable"`
JSON phishguardListResponseJSON `json:"-"`
}
func (*PhishguardListResponse) UnmarshalJSON ¶
func (r *PhishguardListResponse) UnmarshalJSON(data []byte) (err error)
type PhishguardListResponseDisposition ¶
type PhishguardListResponseDisposition string
const ( PhishguardListResponseDispositionMalicious PhishguardListResponseDisposition = "MALICIOUS" PhishguardListResponseDispositionMaliciousBec PhishguardListResponseDisposition = "MALICIOUS-BEC" PhishguardListResponseDispositionSuspicious PhishguardListResponseDisposition = "SUSPICIOUS" PhishguardListResponseDispositionSpoof PhishguardListResponseDisposition = "SPOOF" PhishguardListResponseDispositionSpam PhishguardListResponseDisposition = "SPAM" PhishguardListResponseDispositionBulk PhishguardListResponseDisposition = "BULK" PhishguardListResponseDispositionEncrypted PhishguardListResponseDisposition = "ENCRYPTED" PhishguardListResponseDispositionExternal PhishguardListResponseDisposition = "EXTERNAL" PhishguardListResponseDispositionUnknown PhishguardListResponseDisposition = "UNKNOWN" PhishguardListResponseDispositionNone PhishguardListResponseDisposition = "NONE" )
func (PhishguardListResponseDisposition) IsKnown ¶
func (r PhishguardListResponseDisposition) IsKnown() bool
type PhishguardListResponseFields ¶
type PhishguardListResponseFields struct {
PostfixID string `json:"postfix_id,required"`
To []string `json:"to,required"`
Ts time.Time `json:"ts,required" format:"date-time"`
From string `json:"from,nullable"`
JSON phishguardListResponseFieldsJSON `json:"-"`
}
func (*PhishguardListResponseFields) UnmarshalJSON ¶
func (r *PhishguardListResponseFields) UnmarshalJSON(data []byte) (err error)
type PhishguardListResponseTag ¶
type PhishguardListResponseTag struct {
Category string `json:"category,required"`
Value string `json:"value,required"`
JSON phishguardListResponseTagJSON `json:"-"`
}
func (*PhishguardListResponseTag) UnmarshalJSON ¶
func (r *PhishguardListResponseTag) UnmarshalJSON(data []byte) (err error)
type PhishguardService ¶
type PhishguardService struct {
Options []option.RequestOption
}
PhishguardService 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 NewPhishguardService method instead.
func NewPhishguardService ¶
func NewPhishguardService(opts ...option.RequestOption) (r *PhishguardService)
NewPhishguardService 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 (*PhishguardService) List ¶
func (r *PhishguardService) List(ctx context.Context, params PhishguardListParams, opts ...option.RequestOption) (res *pagination.SinglePage[PhishguardListResponse], err error)
Get PhishGuard reports
func (*PhishguardService) ListAutoPaging ¶
func (r *PhishguardService) ListAutoPaging(ctx context.Context, params PhishguardListParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[PhishguardListResponse]
Get PhishGuard reports
type RatePlanParam ¶
type RatePlanParam = shared.RatePlanParam
The rate plan applied to the subscription.
This is an alias to an internal type.
type SettingAllowPatternDeleteResponse ¶
type SettingAllowPatternDeleteResponse struct {
ID int64 `json:"id,required"`
JSON settingAllowPatternDeleteResponseJSON `json:"-"`
}
func (*SettingAllowPatternDeleteResponse) UnmarshalJSON ¶
func (r *SettingAllowPatternDeleteResponse) UnmarshalJSON(data []byte) (err error)
type SettingAllowPatternDeleteResponseEnvelope ¶
type SettingAllowPatternDeleteResponseEnvelope struct {
Errors []shared.ResponseInfo `json:"errors,required"`
Messages []shared.ResponseInfo `json:"messages,required"`
Result SettingAllowPatternDeleteResponse `json:"result,required"`
Success bool `json:"success,required"`
JSON settingAllowPatternDeleteResponseEnvelopeJSON `json:"-"`
}
func (*SettingAllowPatternDeleteResponseEnvelope) UnmarshalJSON ¶
func (r *SettingAllowPatternDeleteResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type SettingAllowPatternEditParams ¶
type SettingAllowPatternEditParams struct {
// Account Identifier
AccountID param.Field[string] `path:"account_id,required"`
Comments param.Field[string] `json:"comments"`
IsRecipient param.Field[bool] `json:"is_recipient"`
IsRegex param.Field[bool] `json:"is_regex"`
IsSender param.Field[bool] `json:"is_sender"`
IsSpoof param.Field[bool] `json:"is_spoof"`
Pattern param.Field[string] `json:"pattern"`
PatternType param.Field[SettingAllowPatternEditParamsPatternType] `json:"pattern_type"`
VerifySender param.Field[bool] `json:"verify_sender"`
}
func (SettingAllowPatternEditParams) MarshalJSON ¶
func (r SettingAllowPatternEditParams) MarshalJSON() (data []byte, err error)
type SettingAllowPatternEditParamsPatternType ¶
type SettingAllowPatternEditParamsPatternType string
const ( SettingAllowPatternEditParamsPatternTypeEmail SettingAllowPatternEditParamsPatternType = "EMAIL" SettingAllowPatternEditParamsPatternTypeDomain SettingAllowPatternEditParamsPatternType = "DOMAIN" SettingAllowPatternEditParamsPatternTypeIP SettingAllowPatternEditParamsPatternType = "IP" SettingAllowPatternEditParamsPatternTypeUnknown SettingAllowPatternEditParamsPatternType = "UNKNOWN" )
func (SettingAllowPatternEditParamsPatternType) IsKnown ¶
func (r SettingAllowPatternEditParamsPatternType) IsKnown() bool
type SettingAllowPatternEditResponse ¶
type SettingAllowPatternEditResponse struct {
ID int64 `json:"id,required"`
CreatedAt time.Time `json:"created_at,required" format:"date-time"`
IsRecipient bool `json:"is_recipient,required"`
IsRegex bool `json:"is_regex,required"`
IsSender bool `json:"is_sender,required"`
IsSpoof bool `json:"is_spoof,required"`
LastModified time.Time `json:"last_modified,required" format:"date-time"`
Pattern string `json:"pattern,required"`
PatternType SettingAllowPatternEditResponsePatternType `json:"pattern_type,required"`
VerifySender bool `json:"verify_sender,required"`
Comments string `json:"comments,nullable"`
JSON settingAllowPatternEditResponseJSON `json:"-"`
}
func (*SettingAllowPatternEditResponse) UnmarshalJSON ¶
func (r *SettingAllowPatternEditResponse) UnmarshalJSON(data []byte) (err error)
type SettingAllowPatternEditResponseEnvelope ¶
type SettingAllowPatternEditResponseEnvelope struct {
Errors []shared.ResponseInfo `json:"errors,required"`
Messages []shared.ResponseInfo `json:"messages,required"`
Result SettingAllowPatternEditResponse `json:"result,required"`
Success bool `json:"success,required"`
JSON settingAllowPatternEditResponseEnvelopeJSON `json:"-"`
}
func (*SettingAllowPatternEditResponseEnvelope) UnmarshalJSON ¶
func (r *SettingAllowPatternEditResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type SettingAllowPatternEditResponsePatternType ¶
type SettingAllowPatternEditResponsePatternType string
const ( SettingAllowPatternEditResponsePatternTypeEmail SettingAllowPatternEditResponsePatternType = "EMAIL" SettingAllowPatternEditResponsePatternTypeDomain SettingAllowPatternEditResponsePatternType = "DOMAIN" SettingAllowPatternEditResponsePatternTypeIP SettingAllowPatternEditResponsePatternType = "IP" SettingAllowPatternEditResponsePatternTypeUnknown SettingAllowPatternEditResponsePatternType = "UNKNOWN" )
func (SettingAllowPatternEditResponsePatternType) IsKnown ¶
func (r SettingAllowPatternEditResponsePatternType) IsKnown() bool
type SettingAllowPatternGetResponse ¶
type SettingAllowPatternGetResponse struct {
ID int64 `json:"id,required"`
CreatedAt time.Time `json:"created_at,required" format:"date-time"`
IsRecipient bool `json:"is_recipient,required"`
IsRegex bool `json:"is_regex,required"`
IsSender bool `json:"is_sender,required"`
IsSpoof bool `json:"is_spoof,required"`
LastModified time.Time `json:"last_modified,required" format:"date-time"`
Pattern string `json:"pattern,required"`
PatternType SettingAllowPatternGetResponsePatternType `json:"pattern_type,required"`
VerifySender bool `json:"verify_sender,required"`
Comments string `json:"comments,nullable"`
JSON settingAllowPatternGetResponseJSON `json:"-"`
}
func (*SettingAllowPatternGetResponse) UnmarshalJSON ¶
func (r *SettingAllowPatternGetResponse) UnmarshalJSON(data []byte) (err error)
type SettingAllowPatternGetResponseEnvelope ¶
type SettingAllowPatternGetResponseEnvelope struct {
Errors []shared.ResponseInfo `json:"errors,required"`
Messages []shared.ResponseInfo `json:"messages,required"`
Result SettingAllowPatternGetResponse `json:"result,required"`
Success bool `json:"success,required"`
JSON settingAllowPatternGetResponseEnvelopeJSON `json:"-"`
}
func (*SettingAllowPatternGetResponseEnvelope) UnmarshalJSON ¶
func (r *SettingAllowPatternGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type SettingAllowPatternGetResponsePatternType ¶
type SettingAllowPatternGetResponsePatternType string
const ( SettingAllowPatternGetResponsePatternTypeEmail SettingAllowPatternGetResponsePatternType = "EMAIL" SettingAllowPatternGetResponsePatternTypeDomain SettingAllowPatternGetResponsePatternType = "DOMAIN" SettingAllowPatternGetResponsePatternTypeIP SettingAllowPatternGetResponsePatternType = "IP" SettingAllowPatternGetResponsePatternTypeUnknown SettingAllowPatternGetResponsePatternType = "UNKNOWN" )
func (SettingAllowPatternGetResponsePatternType) IsKnown ¶
func (r SettingAllowPatternGetResponsePatternType) IsKnown() bool
type SettingAllowPatternListParams ¶
type SettingAllowPatternListParams struct {
// Account Identifier
AccountID param.Field[string] `path:"account_id,required"`
// The sorting direction.
Direction param.Field[SettingAllowPatternListParamsDirection] `query:"direction"`
IsRecipient param.Field[bool] `query:"is_recipient"`
IsSender param.Field[bool] `query:"is_sender"`
IsSpoof param.Field[bool] `query:"is_spoof"`
// The field to sort by.
Order param.Field[SettingAllowPatternListParamsOrder] `query:"order"`
// Page number of paginated results.
Page param.Field[int64] `query:"page"`
PatternType param.Field[SettingAllowPatternListParamsPatternType] `query:"pattern_type"`
// Number of results to display.
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 (SettingAllowPatternListParams) URLQuery ¶
func (r SettingAllowPatternListParams) URLQuery() (v url.Values)
URLQuery serializes SettingAllowPatternListParams's query parameters as `url.Values`.
type SettingAllowPatternListParamsDirection ¶
type SettingAllowPatternListParamsDirection string
The sorting direction.
const ( SettingAllowPatternListParamsDirectionAsc SettingAllowPatternListParamsDirection = "asc" SettingAllowPatternListParamsDirectionDesc SettingAllowPatternListParamsDirection = "desc" )
func (SettingAllowPatternListParamsDirection) IsKnown ¶
func (r SettingAllowPatternListParamsDirection) IsKnown() bool
type SettingAllowPatternListParamsOrder ¶
type SettingAllowPatternListParamsOrder string
The field to sort by.
const ( SettingAllowPatternListParamsOrderPattern SettingAllowPatternListParamsOrder = "pattern" SettingAllowPatternListParamsOrderCreatedAt SettingAllowPatternListParamsOrder = "created_at" )
func (SettingAllowPatternListParamsOrder) IsKnown ¶
func (r SettingAllowPatternListParamsOrder) IsKnown() bool
type SettingAllowPatternListParamsPatternType ¶
type SettingAllowPatternListParamsPatternType string
const ( SettingAllowPatternListParamsPatternTypeEmail SettingAllowPatternListParamsPatternType = "EMAIL" SettingAllowPatternListParamsPatternTypeDomain SettingAllowPatternListParamsPatternType = "DOMAIN" SettingAllowPatternListParamsPatternTypeIP SettingAllowPatternListParamsPatternType = "IP" SettingAllowPatternListParamsPatternTypeUnknown SettingAllowPatternListParamsPatternType = "UNKNOWN" )
func (SettingAllowPatternListParamsPatternType) IsKnown ¶
func (r SettingAllowPatternListParamsPatternType) IsKnown() bool
type SettingAllowPatternListResponse ¶
type SettingAllowPatternListResponse struct {
ID int64 `json:"id,required"`
CreatedAt time.Time `json:"created_at,required" format:"date-time"`
IsRecipient bool `json:"is_recipient,required"`
IsRegex bool `json:"is_regex,required"`
IsSender bool `json:"is_sender,required"`
IsSpoof bool `json:"is_spoof,required"`
LastModified time.Time `json:"last_modified,required" format:"date-time"`
Pattern string `json:"pattern,required"`
PatternType SettingAllowPatternListResponsePatternType `json:"pattern_type,required"`
VerifySender bool `json:"verify_sender,required"`
Comments string `json:"comments,nullable"`
JSON settingAllowPatternListResponseJSON `json:"-"`
}
func (*SettingAllowPatternListResponse) UnmarshalJSON ¶
func (r *SettingAllowPatternListResponse) UnmarshalJSON(data []byte) (err error)
type SettingAllowPatternListResponsePatternType ¶
type SettingAllowPatternListResponsePatternType string
const ( SettingAllowPatternListResponsePatternTypeEmail SettingAllowPatternListResponsePatternType = "EMAIL" SettingAllowPatternListResponsePatternTypeDomain SettingAllowPatternListResponsePatternType = "DOMAIN" SettingAllowPatternListResponsePatternTypeIP SettingAllowPatternListResponsePatternType = "IP" SettingAllowPatternListResponsePatternTypeUnknown SettingAllowPatternListResponsePatternType = "UNKNOWN" )
func (SettingAllowPatternListResponsePatternType) IsKnown ¶
func (r SettingAllowPatternListResponsePatternType) IsKnown() bool
type SettingAllowPatternNewParams ¶
type SettingAllowPatternNewParams struct {
// Account Identifier
AccountID param.Field[string] `path:"account_id,required"`
Body SettingAllowPatternNewParamsBodyUnion `json:"body,required"`
}
func (SettingAllowPatternNewParams) MarshalJSON ¶
func (r SettingAllowPatternNewParams) MarshalJSON() (data []byte, err error)
type SettingAllowPatternNewParamsBodyArray ¶
type SettingAllowPatternNewParamsBodyArray []SettingAllowPatternNewParamsBodyArray
type SettingAllowPatternNewParamsBodyEmailSecurityCreateAllowPattern ¶
type SettingAllowPatternNewParamsBodyEmailSecurityCreateAllowPattern struct {
IsRecipient param.Field[bool] `json:"is_recipient,required"`
IsRegex param.Field[bool] `json:"is_regex,required"`
IsSender param.Field[bool] `json:"is_sender,required"`
IsSpoof param.Field[bool] `json:"is_spoof,required"`
Pattern param.Field[string] `json:"pattern,required"`
PatternType param.Field[SettingAllowPatternNewParamsBodyEmailSecurityCreateAllowPatternPatternType] `json:"pattern_type,required"`
VerifySender param.Field[bool] `json:"verify_sender,required"`
Comments param.Field[string] `json:"comments"`
}
func (SettingAllowPatternNewParamsBodyEmailSecurityCreateAllowPattern) MarshalJSON ¶
func (r SettingAllowPatternNewParamsBodyEmailSecurityCreateAllowPattern) MarshalJSON() (data []byte, err error)
type SettingAllowPatternNewParamsBodyEmailSecurityCreateAllowPatternPatternType ¶
type SettingAllowPatternNewParamsBodyEmailSecurityCreateAllowPatternPatternType string
const ( SettingAllowPatternNewParamsBodyEmailSecurityCreateAllowPatternPatternTypeEmail SettingAllowPatternNewParamsBodyEmailSecurityCreateAllowPatternPatternType = "EMAIL" SettingAllowPatternNewParamsBodyEmailSecurityCreateAllowPatternPatternTypeDomain SettingAllowPatternNewParamsBodyEmailSecurityCreateAllowPatternPatternType = "DOMAIN" SettingAllowPatternNewParamsBodyEmailSecurityCreateAllowPatternPatternTypeIP SettingAllowPatternNewParamsBodyEmailSecurityCreateAllowPatternPatternType = "IP" SettingAllowPatternNewParamsBodyEmailSecurityCreateAllowPatternPatternTypeUnknown SettingAllowPatternNewParamsBodyEmailSecurityCreateAllowPatternPatternType = "UNKNOWN" )
func (SettingAllowPatternNewParamsBodyEmailSecurityCreateAllowPatternPatternType) IsKnown ¶
func (r SettingAllowPatternNewParamsBodyEmailSecurityCreateAllowPatternPatternType) IsKnown() bool
type SettingAllowPatternNewParamsBodyUnion ¶
type SettingAllowPatternNewParamsBodyUnion interface {
// contains filtered or unexported methods
}
Satisfied by email_security.SettingAllowPatternNewParamsBodyEmailSecurityCreateAllowPattern, email_security.SettingAllowPatternNewParamsBodyArray.
type SettingAllowPatternNewResponseArray ¶
type SettingAllowPatternNewResponseArray []SettingAllowPatternNewResponseArrayItem
type SettingAllowPatternNewResponseArrayItem ¶
type SettingAllowPatternNewResponseArrayItem struct {
ID int64 `json:"id,required"`
CreatedAt time.Time `json:"created_at,required" format:"date-time"`
IsRecipient bool `json:"is_recipient,required"`
IsRegex bool `json:"is_regex,required"`
IsSender bool `json:"is_sender,required"`
IsSpoof bool `json:"is_spoof,required"`
LastModified time.Time `json:"last_modified,required" format:"date-time"`
Pattern string `json:"pattern,required"`
PatternType SettingAllowPatternNewResponseArrayPatternType `json:"pattern_type,required"`
VerifySender bool `json:"verify_sender,required"`
Comments string `json:"comments,nullable"`
JSON settingAllowPatternNewResponseArrayItemJSON `json:"-"`
}
func (*SettingAllowPatternNewResponseArrayItem) UnmarshalJSON ¶
func (r *SettingAllowPatternNewResponseArrayItem) UnmarshalJSON(data []byte) (err error)
type SettingAllowPatternNewResponseArrayPatternType ¶
type SettingAllowPatternNewResponseArrayPatternType string
const ( SettingAllowPatternNewResponseArrayPatternTypeEmail SettingAllowPatternNewResponseArrayPatternType = "EMAIL" SettingAllowPatternNewResponseArrayPatternTypeDomain SettingAllowPatternNewResponseArrayPatternType = "DOMAIN" SettingAllowPatternNewResponseArrayPatternTypeIP SettingAllowPatternNewResponseArrayPatternType = "IP" SettingAllowPatternNewResponseArrayPatternTypeUnknown SettingAllowPatternNewResponseArrayPatternType = "UNKNOWN" )
func (SettingAllowPatternNewResponseArrayPatternType) IsKnown ¶
func (r SettingAllowPatternNewResponseArrayPatternType) IsKnown() bool
type SettingAllowPatternNewResponseEmailSecurityAllowPattern ¶
type SettingAllowPatternNewResponseEmailSecurityAllowPattern struct {
ID int64 `json:"id,required"`
CreatedAt time.Time `json:"created_at,required" format:"date-time"`
IsRecipient bool `json:"is_recipient,required"`
IsRegex bool `json:"is_regex,required"`
IsSender bool `json:"is_sender,required"`
IsSpoof bool `json:"is_spoof,required"`
LastModified time.Time `json:"last_modified,required" format:"date-time"`
Pattern string `json:"pattern,required"`
PatternType SettingAllowPatternNewResponseEmailSecurityAllowPatternPatternType `json:"pattern_type,required"`
VerifySender bool `json:"verify_sender,required"`
Comments string `json:"comments,nullable"`
JSON settingAllowPatternNewResponseEmailSecurityAllowPatternJSON `json:"-"`
}
func (*SettingAllowPatternNewResponseEmailSecurityAllowPattern) UnmarshalJSON ¶
func (r *SettingAllowPatternNewResponseEmailSecurityAllowPattern) UnmarshalJSON(data []byte) (err error)
type SettingAllowPatternNewResponseEmailSecurityAllowPatternPatternType ¶
type SettingAllowPatternNewResponseEmailSecurityAllowPatternPatternType string
const ( SettingAllowPatternNewResponseEmailSecurityAllowPatternPatternTypeEmail SettingAllowPatternNewResponseEmailSecurityAllowPatternPatternType = "EMAIL" SettingAllowPatternNewResponseEmailSecurityAllowPatternPatternTypeDomain SettingAllowPatternNewResponseEmailSecurityAllowPatternPatternType = "DOMAIN" SettingAllowPatternNewResponseEmailSecurityAllowPatternPatternTypeIP SettingAllowPatternNewResponseEmailSecurityAllowPatternPatternType = "IP" SettingAllowPatternNewResponseEmailSecurityAllowPatternPatternTypeUnknown SettingAllowPatternNewResponseEmailSecurityAllowPatternPatternType = "UNKNOWN" )
func (SettingAllowPatternNewResponseEmailSecurityAllowPatternPatternType) IsKnown ¶
func (r SettingAllowPatternNewResponseEmailSecurityAllowPatternPatternType) IsKnown() bool
type SettingAllowPatternNewResponseEnvelope ¶
type SettingAllowPatternNewResponseEnvelope struct {
Errors []shared.ResponseInfo `json:"errors,required"`
Messages []shared.ResponseInfo `json:"messages,required"`
Result SettingAllowPatternNewResponseUnion `json:"result,required"`
Success bool `json:"success,required"`
JSON settingAllowPatternNewResponseEnvelopeJSON `json:"-"`
}
func (*SettingAllowPatternNewResponseEnvelope) UnmarshalJSON ¶
func (r *SettingAllowPatternNewResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type SettingAllowPatternNewResponseUnion ¶
type SettingAllowPatternNewResponseUnion interface {
// contains filtered or unexported methods
}
Union satisfied by email_security.SettingAllowPatternNewResponseEmailSecurityAllowPattern or email_security.SettingAllowPatternNewResponseArray.
type SettingAllowPatternService ¶
type SettingAllowPatternService struct {
Options []option.RequestOption
}
SettingAllowPatternService 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 NewSettingAllowPatternService method instead.
func NewSettingAllowPatternService ¶
func NewSettingAllowPatternService(opts ...option.RequestOption) (r *SettingAllowPatternService)
NewSettingAllowPatternService 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 (*SettingAllowPatternService) Delete ¶
func (r *SettingAllowPatternService) Delete(ctx context.Context, patternID int64, body SettingAllowPatternDeleteParams, opts ...option.RequestOption) (res *SettingAllowPatternDeleteResponse, err error)
Delete an email allow pattern
func (*SettingAllowPatternService) Edit ¶
func (r *SettingAllowPatternService) Edit(ctx context.Context, patternID int64, params SettingAllowPatternEditParams, opts ...option.RequestOption) (res *SettingAllowPatternEditResponse, err error)
Update an email allow pattern
func (*SettingAllowPatternService) Get ¶
func (r *SettingAllowPatternService) Get(ctx context.Context, patternID int64, query SettingAllowPatternGetParams, opts ...option.RequestOption) (res *SettingAllowPatternGetResponse, err error)
Get an email allow pattern
func (*SettingAllowPatternService) List ¶
func (r *SettingAllowPatternService) List(ctx context.Context, params SettingAllowPatternListParams, opts ...option.RequestOption) (res *pagination.V4PagePaginationArray[SettingAllowPatternListResponse], err error)
List, search, and sort an accounts's email allow patterns.
func (*SettingAllowPatternService) ListAutoPaging ¶
func (r *SettingAllowPatternService) ListAutoPaging(ctx context.Context, params SettingAllowPatternListParams, opts ...option.RequestOption) *pagination.V4PagePaginationArrayAutoPager[SettingAllowPatternListResponse]
List, search, and sort an accounts's email allow patterns.
func (*SettingAllowPatternService) New ¶
func (r *SettingAllowPatternService) New(ctx context.Context, params SettingAllowPatternNewParams, opts ...option.RequestOption) (res *SettingAllowPatternNewResponseUnion, err error)
Create an email allow pattern
type SettingBlockSenderDeleteResponse ¶
type SettingBlockSenderDeleteResponse struct {
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 ¶
func (r SettingBlockSenderEditParamsPatternType) IsKnown() bool
type SettingBlockSenderEditResponse ¶
type SettingBlockSenderEditResponse struct {
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 ¶
func (r SettingBlockSenderEditResponsePatternType) IsKnown() bool
type SettingBlockSenderGetResponse ¶
type SettingBlockSenderGetResponse struct {
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 ¶
func (r SettingBlockSenderGetResponsePatternType) IsKnown() bool
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"`
// Page number of paginated results.
Page param.Field[int64] `query:"page"`
PatternType param.Field[SettingBlockSenderListParamsPatternType] `query:"pattern_type"`
// Number of results to display.
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 ¶
func (r SettingBlockSenderListParamsDirection) IsKnown() bool
type SettingBlockSenderListParamsOrder ¶
type SettingBlockSenderListParamsOrder string
The field to sort by.
const ( SettingBlockSenderListParamsOrderPattern SettingBlockSenderListParamsOrder = "pattern" SettingBlockSenderListParamsOrderCreatedAt SettingBlockSenderListParamsOrder = "created_at" )
func (SettingBlockSenderListParamsOrder) IsKnown ¶
func (r SettingBlockSenderListParamsOrder) IsKnown() bool
type SettingBlockSenderListParamsPatternType ¶
type SettingBlockSenderListParamsPatternType string
const ( SettingBlockSenderListParamsPatternTypeEmail SettingBlockSenderListParamsPatternType = "EMAIL" SettingBlockSenderListParamsPatternTypeDomain SettingBlockSenderListParamsPatternType = "DOMAIN" SettingBlockSenderListParamsPatternTypeIP SettingBlockSenderListParamsPatternType = "IP" SettingBlockSenderListParamsPatternTypeUnknown SettingBlockSenderListParamsPatternType = "UNKNOWN" )
func (SettingBlockSenderListParamsPatternType) IsKnown ¶
func (r SettingBlockSenderListParamsPatternType) IsKnown() bool
type SettingBlockSenderListResponse ¶
type SettingBlockSenderListResponse struct {
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 ¶
func (r SettingBlockSenderListResponsePatternType) IsKnown() bool
type SettingBlockSenderNewParams ¶
type SettingBlockSenderNewParams struct {
// Account Identifier
AccountID param.Field[string] `path:"account_id,required"`
Body SettingBlockSenderNewParamsBodyUnion `json:"body,required"`
}
func (SettingBlockSenderNewParams) MarshalJSON ¶
func (r SettingBlockSenderNewParams) MarshalJSON() (data []byte, err error)
type SettingBlockSenderNewParamsBodyArray ¶
type SettingBlockSenderNewParamsBodyArray []SettingBlockSenderNewParamsBodyArray
type SettingBlockSenderNewParamsBodyEmailSecurityCreateBlockedSender ¶
type SettingBlockSenderNewParamsBodyEmailSecurityCreateBlockedSender struct {
IsRegex param.Field[bool] `json:"is_regex,required"`
Pattern param.Field[string] `json:"pattern,required"`
PatternType param.Field[SettingBlockSenderNewParamsBodyEmailSecurityCreateBlockedSenderPatternType] `json:"pattern_type,required"`
Comments param.Field[string] `json:"comments"`
}
func (SettingBlockSenderNewParamsBodyEmailSecurityCreateBlockedSender) MarshalJSON ¶
func (r SettingBlockSenderNewParamsBodyEmailSecurityCreateBlockedSender) MarshalJSON() (data []byte, err error)
type SettingBlockSenderNewParamsBodyEmailSecurityCreateBlockedSenderPatternType ¶
type SettingBlockSenderNewParamsBodyEmailSecurityCreateBlockedSenderPatternType string
const ( SettingBlockSenderNewParamsBodyEmailSecurityCreateBlockedSenderPatternTypeEmail SettingBlockSenderNewParamsBodyEmailSecurityCreateBlockedSenderPatternType = "EMAIL" SettingBlockSenderNewParamsBodyEmailSecurityCreateBlockedSenderPatternTypeDomain SettingBlockSenderNewParamsBodyEmailSecurityCreateBlockedSenderPatternType = "DOMAIN" SettingBlockSenderNewParamsBodyEmailSecurityCreateBlockedSenderPatternTypeIP SettingBlockSenderNewParamsBodyEmailSecurityCreateBlockedSenderPatternType = "IP" SettingBlockSenderNewParamsBodyEmailSecurityCreateBlockedSenderPatternTypeUnknown SettingBlockSenderNewParamsBodyEmailSecurityCreateBlockedSenderPatternType = "UNKNOWN" )
func (SettingBlockSenderNewParamsBodyEmailSecurityCreateBlockedSenderPatternType) IsKnown ¶
func (r SettingBlockSenderNewParamsBodyEmailSecurityCreateBlockedSenderPatternType) IsKnown() bool
type SettingBlockSenderNewParamsBodyUnion ¶
type SettingBlockSenderNewParamsBodyUnion interface {
// contains filtered or unexported methods
}
Satisfied by email_security.SettingBlockSenderNewParamsBodyEmailSecurityCreateBlockedSender, email_security.SettingBlockSenderNewParamsBodyArray.
type SettingBlockSenderNewResponseArray ¶
type SettingBlockSenderNewResponseArray []SettingBlockSenderNewResponseArrayItem
type SettingBlockSenderNewResponseArrayItem ¶
type SettingBlockSenderNewResponseArrayItem struct {
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 SettingBlockSenderNewResponseArrayPatternType `json:"pattern_type,required"`
Comments string `json:"comments,nullable"`
JSON settingBlockSenderNewResponseArrayItemJSON `json:"-"`
}
func (*SettingBlockSenderNewResponseArrayItem) UnmarshalJSON ¶
func (r *SettingBlockSenderNewResponseArrayItem) UnmarshalJSON(data []byte) (err error)
type SettingBlockSenderNewResponseArrayPatternType ¶
type SettingBlockSenderNewResponseArrayPatternType string
const ( SettingBlockSenderNewResponseArrayPatternTypeEmail SettingBlockSenderNewResponseArrayPatternType = "EMAIL" SettingBlockSenderNewResponseArrayPatternTypeDomain SettingBlockSenderNewResponseArrayPatternType = "DOMAIN" SettingBlockSenderNewResponseArrayPatternTypeIP SettingBlockSenderNewResponseArrayPatternType = "IP" SettingBlockSenderNewResponseArrayPatternTypeUnknown SettingBlockSenderNewResponseArrayPatternType = "UNKNOWN" )
func (SettingBlockSenderNewResponseArrayPatternType) IsKnown ¶
func (r SettingBlockSenderNewResponseArrayPatternType) IsKnown() bool
type SettingBlockSenderNewResponseEmailSecurityBlockedSender ¶
type SettingBlockSenderNewResponseEmailSecurityBlockedSender struct {
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 SettingBlockSenderNewResponseEmailSecurityBlockedSenderPatternType `json:"pattern_type,required"`
Comments string `json:"comments,nullable"`
JSON settingBlockSenderNewResponseEmailSecurityBlockedSenderJSON `json:"-"`
}
func (*SettingBlockSenderNewResponseEmailSecurityBlockedSender) UnmarshalJSON ¶
func (r *SettingBlockSenderNewResponseEmailSecurityBlockedSender) UnmarshalJSON(data []byte) (err error)
type SettingBlockSenderNewResponseEmailSecurityBlockedSenderPatternType ¶
type SettingBlockSenderNewResponseEmailSecurityBlockedSenderPatternType string
const ( SettingBlockSenderNewResponseEmailSecurityBlockedSenderPatternTypeEmail SettingBlockSenderNewResponseEmailSecurityBlockedSenderPatternType = "EMAIL" SettingBlockSenderNewResponseEmailSecurityBlockedSenderPatternTypeDomain SettingBlockSenderNewResponseEmailSecurityBlockedSenderPatternType = "DOMAIN" SettingBlockSenderNewResponseEmailSecurityBlockedSenderPatternTypeIP SettingBlockSenderNewResponseEmailSecurityBlockedSenderPatternType = "IP" SettingBlockSenderNewResponseEmailSecurityBlockedSenderPatternTypeUnknown SettingBlockSenderNewResponseEmailSecurityBlockedSenderPatternType = "UNKNOWN" )
func (SettingBlockSenderNewResponseEmailSecurityBlockedSenderPatternType) IsKnown ¶
func (r SettingBlockSenderNewResponseEmailSecurityBlockedSenderPatternType) IsKnown() bool
type SettingBlockSenderNewResponseEnvelope ¶
type SettingBlockSenderNewResponseEnvelope struct {
Errors []shared.ResponseInfo `json:"errors,required"`
Messages []shared.ResponseInfo `json:"messages,required"`
Result SettingBlockSenderNewResponseUnion `json:"result,required"`
Success bool `json:"success,required"`
JSON settingBlockSenderNewResponseEnvelopeJSON `json:"-"`
}
func (*SettingBlockSenderNewResponseEnvelope) UnmarshalJSON ¶
func (r *SettingBlockSenderNewResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type SettingBlockSenderNewResponseUnion ¶
type SettingBlockSenderNewResponseUnion interface {
// contains filtered or unexported methods
}
Union satisfied by email_security.SettingBlockSenderNewResponseEmailSecurityBlockedSender or email_security.SettingBlockSenderNewResponseArray.
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 ¶
func (r *SettingBlockSenderService) Delete(ctx context.Context, patternID int64, body SettingBlockSenderDeleteParams, opts ...option.RequestOption) (res *SettingBlockSenderDeleteResponse, err error)
Delete a blocked email sender
func (*SettingBlockSenderService) Edit ¶
func (r *SettingBlockSenderService) Edit(ctx context.Context, patternID int64, params SettingBlockSenderEditParams, opts ...option.RequestOption) (res *SettingBlockSenderEditResponse, err error)
Update a blocked email sender
func (*SettingBlockSenderService) Get ¶
func (r *SettingBlockSenderService) Get(ctx context.Context, patternID int64, query SettingBlockSenderGetParams, opts ...option.RequestOption) (res *SettingBlockSenderGetResponse, err error)
Get a blocked email sender
func (*SettingBlockSenderService) List ¶
func (r *SettingBlockSenderService) List(ctx context.Context, params SettingBlockSenderListParams, opts ...option.RequestOption) (res *pagination.V4PagePaginationArray[SettingBlockSenderListResponse], err error)
List blocked email senders
func (*SettingBlockSenderService) ListAutoPaging ¶
func (r *SettingBlockSenderService) ListAutoPaging(ctx context.Context, params SettingBlockSenderListParams, opts ...option.RequestOption) *pagination.V4PagePaginationArrayAutoPager[SettingBlockSenderListResponse]
List blocked email senders
func (*SettingBlockSenderService) New ¶
func (r *SettingBlockSenderService) New(ctx context.Context, params SettingBlockSenderNewParams, opts ...option.RequestOption) (res *SettingBlockSenderNewResponseUnion, err error)
Create a blocked email sender
type SettingDomainDeleteResponse ¶
type SettingDomainDeleteResponse struct {
// Unique domain identifier
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"`
Domain param.Field[string] `json:"domain"`
LookbackHops param.Field[int64] `json:"lookback_hops"`
}
func (SettingDomainEditParams) MarshalJSON ¶
func (r SettingDomainEditParams) MarshalJSON() (data []byte, err error)
type SettingDomainEditResponse ¶
type SettingDomainEditResponse struct {
// Unique domain identifier
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"`
LastModified time.Time `json:"last_modified,required" format:"date-time"`
LookbackHops int64 `json:"lookback_hops,required"`
IntegrationID string `json:"integration_id,nullable" format:"uuid"`
O365TenantID string `json:"o365_tenant_id,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 ¶
func (r SettingDomainEditResponseAllowedDeliveryMode) IsKnown() bool
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 SettingDomainListParams ¶
type SettingDomainListParams struct {
// Account Identifier
AccountID param.Field[string] `path:"account_id,required"`
// If present, the response contains only domains with the provided delivery mode.
AllowedDeliveryMode param.Field[SettingDomainListParamsAllowedDeliveryMode] `query:"allowed_delivery_mode"`
// The sorting direction.
Direction param.Field[SettingDomainListParamsDirection] `query:"direction"`
// Filter result by the provided domains. Allows for multiple occurrences, e.g.,
// `domain=example.com&domain=example.xyz`.
Domain param.Field[[]string] `query:"domain"`
// The field to sort by.
Order param.Field[SettingDomainListParamsOrder] `query:"order"`
// Page number of paginated results.
Page param.Field[int64] `query:"page"`
// Number of results to display.
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 SettingDomainListParamsAllowedDeliveryMode ¶
type SettingDomainListParamsAllowedDeliveryMode string
If present, the response contains only 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 ¶
func (r SettingDomainListParamsAllowedDeliveryMode) IsKnown() bool
type SettingDomainListParamsDirection ¶
type SettingDomainListParamsDirection string
The sorting direction.
const ( SettingDomainListParamsDirectionAsc SettingDomainListParamsDirection = "asc" SettingDomainListParamsDirectionDesc SettingDomainListParamsDirection = "desc" )
func (SettingDomainListParamsDirection) IsKnown ¶
func (r SettingDomainListParamsDirection) IsKnown() bool
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 {
// Unique domain identifier
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"`
LastModified time.Time `json:"last_modified,required" format:"date-time"`
LookbackHops int64 `json:"lookback_hops,required"`
IntegrationID string `json:"integration_id,nullable" format:"uuid"`
O365TenantID string `json:"o365_tenant_id,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 ¶
func (r SettingDomainListResponseAllowedDeliveryMode) IsKnown() bool
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) Delete ¶
func (r *SettingDomainService) Delete(ctx context.Context, domainID int64, body SettingDomainDeleteParams, opts ...option.RequestOption) (res *SettingDomainDeleteResponse, err error)
Unprotect an email domain
func (*SettingDomainService) Edit ¶
func (r *SettingDomainService) Edit(ctx context.Context, domainID int64, params SettingDomainEditParams, opts ...option.RequestOption) (res *SettingDomainEditResponse, err error)
Update an email domain
func (*SettingDomainService) List ¶
func (r *SettingDomainService) List(ctx context.Context, params SettingDomainListParams, opts ...option.RequestOption) (res *pagination.V4PagePaginationArray[SettingDomainListResponse], err error)
List, search, and sort an account's email domains.
func (*SettingDomainService) ListAutoPaging ¶
func (r *SettingDomainService) ListAutoPaging(ctx context.Context, params SettingDomainListParams, opts ...option.RequestOption) *pagination.V4PagePaginationArrayAutoPager[SettingDomainListResponse]
List, search, and sort an account's email domains.
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"`
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 string `json:"directory_node_id,nullable"`
Email string `json:"email,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 SettingImpersonationRegistryGetResponse ¶
type SettingImpersonationRegistryGetResponse struct {
ID int64 `json:"id,required"`
CreatedAt time.Time `json:"created_at,required" format:"date-time"`
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 string `json:"directory_node_id,nullable"`
Email string `json:"email,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"`
// Page number of paginated results.
Page param.Field[int64] `query:"page"`
// Number of results to display.
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 ¶
func (r SettingImpersonationRegistryListParams) URLQuery() (v url.Values)
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 ¶
func (r SettingImpersonationRegistryListParamsDirection) IsKnown() bool
type SettingImpersonationRegistryListParamsOrder ¶
type SettingImpersonationRegistryListParamsOrder string
The field to sort by.
const ( SettingImpersonationRegistryListParamsOrderName SettingImpersonationRegistryListParamsOrder = "name" SettingImpersonationRegistryListParamsOrderEmail SettingImpersonationRegistryListParamsOrder = "email" SettingImpersonationRegistryListParamsOrderCreatedAt SettingImpersonationRegistryListParamsOrder = "created_at" )
func (SettingImpersonationRegistryListParamsOrder) IsKnown ¶
func (r SettingImpersonationRegistryListParamsOrder) IsKnown() bool
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 ¶
func (r SettingImpersonationRegistryListParamsProvenance) IsKnown() bool
type SettingImpersonationRegistryListResponse ¶
type SettingImpersonationRegistryListResponse struct {
ID int64 `json:"id,required"`
CreatedAt time.Time `json:"created_at,required" format:"date-time"`
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 string `json:"directory_node_id,nullable"`
Email string `json:"email,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"`
Body SettingImpersonationRegistryNewParamsBodyUnion `json:"body,required"`
}
func (SettingImpersonationRegistryNewParams) MarshalJSON ¶
func (r SettingImpersonationRegistryNewParams) MarshalJSON() (data []byte, err error)
type SettingImpersonationRegistryNewParamsBodyArray ¶
type SettingImpersonationRegistryNewParamsBodyArray []SettingImpersonationRegistryNewParamsBodyArray
type SettingImpersonationRegistryNewParamsBodyEmailSecurityCreateDisplayName ¶
type SettingImpersonationRegistryNewParamsBodyEmailSecurityCreateDisplayName struct {
Email param.Field[string] `json:"email,required"`
IsEmailRegex param.Field[bool] `json:"is_email_regex,required"`
Name param.Field[string] `json:"name,required"`
}
func (SettingImpersonationRegistryNewParamsBodyEmailSecurityCreateDisplayName) MarshalJSON ¶
func (r SettingImpersonationRegistryNewParamsBodyEmailSecurityCreateDisplayName) MarshalJSON() (data []byte, err error)
type SettingImpersonationRegistryNewParamsBodyUnion ¶
type SettingImpersonationRegistryNewParamsBodyUnion interface {
// contains filtered or unexported methods
}
Satisfied by email_security.SettingImpersonationRegistryNewParamsBodyEmailSecurityCreateDisplayName, email_security.SettingImpersonationRegistryNewParamsBodyArray.
type SettingImpersonationRegistryNewResponseArray ¶
type SettingImpersonationRegistryNewResponseArray []SettingImpersonationRegistryNewResponseArrayItem
type SettingImpersonationRegistryNewResponseArrayItem ¶
type SettingImpersonationRegistryNewResponseArrayItem struct {
ID int64 `json:"id,required"`
CreatedAt time.Time `json:"created_at,required" format:"date-time"`
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 string `json:"directory_node_id,nullable"`
Email string `json:"email,nullable"`
Provenance string `json:"provenance,nullable"`
JSON settingImpersonationRegistryNewResponseArrayItemJSON `json:"-"`
}
func (*SettingImpersonationRegistryNewResponseArrayItem) UnmarshalJSON ¶
func (r *SettingImpersonationRegistryNewResponseArrayItem) UnmarshalJSON(data []byte) (err error)
type SettingImpersonationRegistryNewResponseEmailSecurityDisplayName ¶
type SettingImpersonationRegistryNewResponseEmailSecurityDisplayName struct {
ID int64 `json:"id,required"`
CreatedAt time.Time `json:"created_at,required" format:"date-time"`
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 string `json:"directory_node_id,nullable"`
Email string `json:"email,nullable"`
Provenance string `json:"provenance,nullable"`
JSON settingImpersonationRegistryNewResponseEmailSecurityDisplayNameJSON `json:"-"`
}
func (*SettingImpersonationRegistryNewResponseEmailSecurityDisplayName) UnmarshalJSON ¶
func (r *SettingImpersonationRegistryNewResponseEmailSecurityDisplayName) UnmarshalJSON(data []byte) (err error)
type SettingImpersonationRegistryNewResponseEnvelope ¶
type SettingImpersonationRegistryNewResponseEnvelope struct {
Errors []shared.ResponseInfo `json:"errors,required"`
Messages []shared.ResponseInfo `json:"messages,required"`
Result SettingImpersonationRegistryNewResponseUnion `json:"result,required"`
Success bool `json:"success,required"`
JSON settingImpersonationRegistryNewResponseEnvelopeJSON `json:"-"`
}
func (*SettingImpersonationRegistryNewResponseEnvelope) UnmarshalJSON ¶
func (r *SettingImpersonationRegistryNewResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type SettingImpersonationRegistryNewResponseUnion ¶
type SettingImpersonationRegistryNewResponseUnion interface {
// contains filtered or unexported methods
}
Union satisfied by email_security.SettingImpersonationRegistryNewResponseEmailSecurityDisplayName or email_security.SettingImpersonationRegistryNewResponseArray.
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 ¶
func (r *SettingImpersonationRegistryService) Delete(ctx context.Context, displayNameID int64, body SettingImpersonationRegistryDeleteParams, opts ...option.RequestOption) (res *SettingImpersonationRegistryDeleteResponse, err error)
Delete an entry from impersonation registry
func (*SettingImpersonationRegistryService) Edit ¶
func (r *SettingImpersonationRegistryService) Edit(ctx context.Context, displayNameID int64, params SettingImpersonationRegistryEditParams, opts ...option.RequestOption) (res *SettingImpersonationRegistryEditResponse, err error)
Update an entry in impersonation registry
func (*SettingImpersonationRegistryService) Get ¶
func (r *SettingImpersonationRegistryService) Get(ctx context.Context, displayNameID int64, query SettingImpersonationRegistryGetParams, opts ...option.RequestOption) (res *SettingImpersonationRegistryGetResponse, err error)
Get an entry in impersonation registry
func (*SettingImpersonationRegistryService) List ¶
func (r *SettingImpersonationRegistryService) List(ctx context.Context, params SettingImpersonationRegistryListParams, opts ...option.RequestOption) (res *pagination.V4PagePaginationArray[SettingImpersonationRegistryListResponse], err error)
List, search, and sort entries in impersonation registry.
func (*SettingImpersonationRegistryService) ListAutoPaging ¶
func (r *SettingImpersonationRegistryService) ListAutoPaging(ctx context.Context, params SettingImpersonationRegistryListParams, opts ...option.RequestOption) *pagination.V4PagePaginationArrayAutoPager[SettingImpersonationRegistryListResponse]
List, search, and sort entries in impersonation registry.
func (*SettingImpersonationRegistryService) New ¶
func (r *SettingImpersonationRegistryService) New(ctx context.Context, params SettingImpersonationRegistryNewParams, opts ...option.RequestOption) (res *SettingImpersonationRegistryNewResponseUnion, err error)
Create an entry in impersonation registry
type SettingService ¶
type SettingService struct {
Options []option.RequestOption
AllowPatterns *SettingAllowPatternService
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 SettingTrustedDomainDeleteResponse ¶
type SettingTrustedDomainDeleteResponse struct {
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"`
IsRecent param.Field[bool] `json:"is_recent"`
IsRegex param.Field[bool] `json:"is_regex"`
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 {
ID int64 `json:"id,required"`
CreatedAt time.Time `json:"created_at,required" format:"date-time"`
IsRecent bool `json:"is_recent,required"`
IsRegex bool `json:"is_regex,required"`
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 SettingTrustedDomainGetResponse ¶
type SettingTrustedDomainGetResponse struct {
ID int64 `json:"id,required"`
CreatedAt time.Time `json:"created_at,required" format:"date-time"`
IsRecent bool `json:"is_recent,required"`
IsRegex bool `json:"is_regex,required"`
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"`
// Page number of paginated results.
Page param.Field[int64] `query:"page"`
// Number of results to display.
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 ¶
func (r SettingTrustedDomainListParamsDirection) IsKnown() bool
type SettingTrustedDomainListParamsOrder ¶
type SettingTrustedDomainListParamsOrder string
The field to sort by.
const ( SettingTrustedDomainListParamsOrderPattern SettingTrustedDomainListParamsOrder = "pattern" SettingTrustedDomainListParamsOrderCreatedAt SettingTrustedDomainListParamsOrder = "created_at" )
func (SettingTrustedDomainListParamsOrder) IsKnown ¶
func (r SettingTrustedDomainListParamsOrder) IsKnown() bool
type SettingTrustedDomainListResponse ¶
type SettingTrustedDomainListResponse struct {
ID int64 `json:"id,required"`
CreatedAt time.Time `json:"created_at,required" format:"date-time"`
IsRecent bool `json:"is_recent,required"`
IsRegex bool `json:"is_regex,required"`
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 []SettingTrustedDomainNewParamsBodyArray
type SettingTrustedDomainNewParamsBodyEmailSecurityCreateTrustedDomain ¶
type SettingTrustedDomainNewParamsBodyEmailSecurityCreateTrustedDomain struct {
IsRecent param.Field[bool] `json:"is_recent,required"`
IsRegex param.Field[bool] `json:"is_regex,required"`
IsSimilarity param.Field[bool] `json:"is_similarity,required"`
Pattern param.Field[string] `json:"pattern,required"`
Comments param.Field[string] `json:"comments"`
}
func (SettingTrustedDomainNewParamsBodyEmailSecurityCreateTrustedDomain) MarshalJSON ¶
func (r SettingTrustedDomainNewParamsBodyEmailSecurityCreateTrustedDomain) MarshalJSON() (data []byte, err error)
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 {
ID int64 `json:"id,required"`
CreatedAt time.Time `json:"created_at,required" format:"date-time"`
IsRecent bool `json:"is_recent,required"`
IsRegex bool `json:"is_regex,required"`
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 {
ID int64 `json:"id,required"`
CreatedAt time.Time `json:"created_at,required" format:"date-time"`
IsRecent bool `json:"is_recent,required"`
IsRegex bool `json:"is_regex,required"`
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 ¶
func (r *SettingTrustedDomainNewResponseEmailSecurityTrustedDomain) UnmarshalJSON(data []byte) (err error)
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 email_security.SettingTrustedDomainNewResponseEmailSecurityTrustedDomain or email_security.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 ¶
func (r *SettingTrustedDomainService) Delete(ctx context.Context, patternID int64, body SettingTrustedDomainDeleteParams, opts ...option.RequestOption) (res *SettingTrustedDomainDeleteResponse, err error)
Delete a trusted email domain
func (*SettingTrustedDomainService) Edit ¶
func (r *SettingTrustedDomainService) Edit(ctx context.Context, patternID int64, params SettingTrustedDomainEditParams, opts ...option.RequestOption) (res *SettingTrustedDomainEditResponse, err error)
Update a trusted email domain
func (*SettingTrustedDomainService) Get ¶
func (r *SettingTrustedDomainService) Get(ctx context.Context, patternID int64, query SettingTrustedDomainGetParams, opts ...option.RequestOption) (res *SettingTrustedDomainGetResponse, err error)
Get a trusted email domain
func (*SettingTrustedDomainService) List ¶
func (r *SettingTrustedDomainService) List(ctx context.Context, params SettingTrustedDomainListParams, opts ...option.RequestOption) (res *pagination.V4PagePaginationArray[SettingTrustedDomainListResponse], err error)
List, search, and sort an account's trusted email domains.
func (*SettingTrustedDomainService) ListAutoPaging ¶
func (r *SettingTrustedDomainService) ListAutoPaging(ctx context.Context, params SettingTrustedDomainListParams, opts ...option.RequestOption) *pagination.V4PagePaginationArrayAutoPager[SettingTrustedDomainListResponse]
List, search, and sort an account's trusted email domains.
func (*SettingTrustedDomainService) New ¶
func (r *SettingTrustedDomainService) New(ctx context.Context, params SettingTrustedDomainNewParams, opts ...option.RequestOption) (res *SettingTrustedDomainNewResponseUnion, err error)
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 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.