email_routing

package
v2.0.0-beta.9 Latest Latest
Warning

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

 Go to latest Published: Mar 18, 2024 License: Apache-2.0 Imports: 14 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type EmailCatchAllRule 

type EmailCatchAllRule struct {
	// Routing rule identifier.
	ID string `json:"id"`
	// List actions for the catch-all routing rule.
	Actions []EmailCatchAllRuleAction `json:"actions"`
	// Routing rule status.
	Enabled EmailCatchAllRuleEnabled `json:"enabled"`
	// List of matchers for the catch-all routing rule.
	Matchers []EmailCatchAllRuleMatcher `json:"matchers"`
	// Routing rule name.
	Name string `json:"name"`
	// Routing rule tag. (Deprecated, replaced by routing rule identifier)
	Tag  string                `json:"tag"`
	JSON emailCatchAllRuleJSON `json:"-"`
}

func (*EmailCatchAllRule) UnmarshalJSON 

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

type EmailCatchAllRuleAction 

type EmailCatchAllRuleAction struct {
	// Type of action for catch-all rule.
	Type  EmailCatchAllRuleActionsType `json:"type,required"`
	Value []string                     `json:"value"`
	JSON  emailCatchAllRuleActionJSON  `json:"-"`
}

Action for the catch-all routing rule.

func (*EmailCatchAllRuleAction) UnmarshalJSON 

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

type EmailCatchAllRuleActionsType 

type EmailCatchAllRuleActionsType string

Type of action for catch-all rule. 

const (
	EmailCatchAllRuleActionsTypeDrop    EmailCatchAllRuleActionsType = "drop"
	EmailCatchAllRuleActionsTypeForward EmailCatchAllRuleActionsType = "forward"
	EmailCatchAllRuleActionsTypeWorker  EmailCatchAllRuleActionsType = "worker"
)

type EmailCatchAllRuleEnabled 

type EmailCatchAllRuleEnabled bool

Routing rule status. 

const (
	EmailCatchAllRuleEnabledTrue  EmailCatchAllRuleEnabled = true
	EmailCatchAllRuleEnabledFalse EmailCatchAllRuleEnabled = false
)

type EmailCatchAllRuleMatcher 

type EmailCatchAllRuleMatcher struct {
	// Type of matcher. Default is 'all'.
	Type EmailCatchAllRuleMatchersType `json:"type,required"`
	JSON emailCatchAllRuleMatcherJSON  `json:"-"`
}

Matcher for catch-all routing rule.

func (*EmailCatchAllRuleMatcher) UnmarshalJSON 

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

type EmailCatchAllRuleMatchersType 

type EmailCatchAllRuleMatchersType string

Type of matcher. Default is 'all'. 

const (
	EmailCatchAllRuleMatchersTypeAll EmailCatchAllRuleMatchersType = "all"
)

type EmailDNSRecord 

type EmailDNSRecord struct {
	// DNS record content.
	Content string `json:"content"`
	// DNS record name (or @ for the zone apex).
	Name string `json:"name"`
	// Required for MX, SRV and URI records. Unused by other record types. Records with
	// lower priorities are preferred.
	Priority float64 `json:"priority"`
	// Time to live, in seconds, of the DNS record. Must be between 60 and 86400, or 1
	// for 'automatic'.
	TTL EmailDNSRecordTTL `json:"ttl"`
	// DNS record type.
	Type EmailDNSRecordType `json:"type"`
	JSON emailDNSRecordJSON `json:"-"`
}

List of records needed to enable an Email Routing zone.

func (*EmailDNSRecord) UnmarshalJSON 

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

type EmailDNSRecordTTL 

type EmailDNSRecordTTL interface {
	ImplementsEmailRoutingEmailDNSRecordTTL()
}

Time to live, in seconds, of the DNS record. Must be between 60 and 86400, or 1 for 'automatic'.

Union satisfied by shared.UnionFloat or email_routing.EmailDNSRecordTTLNumber.

type EmailDNSRecordTTLNumber 

type EmailDNSRecordTTLNumber float64
const (
	EmailDNSRecordTTLNumber1 EmailDNSRecordTTLNumber = 1
)

type EmailDNSRecordType 

type EmailDNSRecordType string

DNS record type. 

const (
	EmailDNSRecordTypeA      EmailDNSRecordType = "A"
	EmailDNSRecordTypeAAAA   EmailDNSRecordType = "AAAA"
	EmailDNSRecordTypeCNAME  EmailDNSRecordType = "CNAME"
	EmailDNSRecordTypeHTTPS  EmailDNSRecordType = "HTTPS"
	EmailDNSRecordTypeTXT    EmailDNSRecordType = "TXT"
	EmailDNSRecordTypeSRV    EmailDNSRecordType = "SRV"
	EmailDNSRecordTypeLOC    EmailDNSRecordType = "LOC"
	EmailDNSRecordTypeMX     EmailDNSRecordType = "MX"
	EmailDNSRecordTypeNS     EmailDNSRecordType = "NS"
	EmailDNSRecordTypeCert   EmailDNSRecordType = "CERT"
	EmailDNSRecordTypeDNSKEY EmailDNSRecordType = "DNSKEY"
	EmailDNSRecordTypeDS     EmailDNSRecordType = "DS"
	EmailDNSRecordTypeNAPTR  EmailDNSRecordType = "NAPTR"
	EmailDNSRecordTypeSmimea EmailDNSRecordType = "SMIMEA"
	EmailDNSRecordTypeSSHFP  EmailDNSRecordType = "SSHFP"
	EmailDNSRecordTypeSVCB   EmailDNSRecordType = "SVCB"
	EmailDNSRecordTypeTLSA   EmailDNSRecordType = "TLSA"
	EmailDNSRecordTypeURI    EmailDNSRecordType = "URI"
)

type EmailRoutingService 

type EmailRoutingService struct {
	Options []option.RequestOption
	Routing *RoutingService
}

EmailRoutingService 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 NewEmailRoutingService method instead.

func NewEmailRoutingService 

func NewEmailRoutingService(opts ...option.RequestOption) (r *EmailRoutingService)

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

type Error 

type Error = apierror.Error

type RoutingAddressDeleteResponse 

type RoutingAddressDeleteResponse struct {
	// Destination address identifier.
	ID string `json:"id"`
	// The date and time the destination address has been created.
	Created time.Time `json:"created" format:"date-time"`
	// The contact email address of the user.
	Email string `json:"email"`
	// The date and time the destination address was last modified.
	Modified time.Time `json:"modified" format:"date-time"`
	// Destination address tag. (Deprecated, replaced by destination address
	// identifier)
	Tag string `json:"tag"`
	// The date and time the destination address has been verified. Null means not
	// verified yet.
	Verified time.Time                        `json:"verified" format:"date-time"`
	JSON     routingAddressDeleteResponseJSON `json:"-"`
}

func (*RoutingAddressDeleteResponse) UnmarshalJSON 

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

type RoutingAddressDeleteResponseEnvelope 

type RoutingAddressDeleteResponseEnvelope struct {
	Errors   []RoutingAddressDeleteResponseEnvelopeErrors   `json:"errors,required"`
	Messages []RoutingAddressDeleteResponseEnvelopeMessages `json:"messages,required"`
	Result   RoutingAddressDeleteResponse                   `json:"result,required"`
	// Whether the API call was successful
	Success RoutingAddressDeleteResponseEnvelopeSuccess `json:"success,required"`
	JSON    routingAddressDeleteResponseEnvelopeJSON    `json:"-"`
}

func (*RoutingAddressDeleteResponseEnvelope) UnmarshalJSON 

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

type RoutingAddressDeleteResponseEnvelopeErrors 

type RoutingAddressDeleteResponseEnvelopeErrors struct {
	Code    int64                                          `json:"code,required"`
	Message string                                         `json:"message,required"`
	JSON    routingAddressDeleteResponseEnvelopeErrorsJSON `json:"-"`
}

func (*RoutingAddressDeleteResponseEnvelopeErrors) UnmarshalJSON 

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

type RoutingAddressDeleteResponseEnvelopeMessages 

type RoutingAddressDeleteResponseEnvelopeMessages struct {
	Code    int64                                            `json:"code,required"`
	Message string                                           `json:"message,required"`
	JSON    routingAddressDeleteResponseEnvelopeMessagesJSON `json:"-"`
}

func (*RoutingAddressDeleteResponseEnvelopeMessages) UnmarshalJSON 

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

type RoutingAddressDeleteResponseEnvelopeSuccess 

type RoutingAddressDeleteResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	RoutingAddressDeleteResponseEnvelopeSuccessTrue RoutingAddressDeleteResponseEnvelopeSuccess = true
)

type RoutingAddressGetResponse 

type RoutingAddressGetResponse struct {
	// Destination address identifier.
	ID string `json:"id"`
	// The date and time the destination address has been created.
	Created time.Time `json:"created" format:"date-time"`
	// The contact email address of the user.
	Email string `json:"email"`
	// The date and time the destination address was last modified.
	Modified time.Time `json:"modified" format:"date-time"`
	// Destination address tag. (Deprecated, replaced by destination address
	// identifier)
	Tag string `json:"tag"`
	// The date and time the destination address has been verified. Null means not
	// verified yet.
	Verified time.Time                     `json:"verified" format:"date-time"`
	JSON     routingAddressGetResponseJSON `json:"-"`
}

func (*RoutingAddressGetResponse) UnmarshalJSON 

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

type RoutingAddressGetResponseEnvelope 

type RoutingAddressGetResponseEnvelope struct {
	Errors   []RoutingAddressGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []RoutingAddressGetResponseEnvelopeMessages `json:"messages,required"`
	Result   RoutingAddressGetResponse                   `json:"result,required"`
	// Whether the API call was successful
	Success RoutingAddressGetResponseEnvelopeSuccess `json:"success,required"`
	JSON    routingAddressGetResponseEnvelopeJSON    `json:"-"`
}

func (*RoutingAddressGetResponseEnvelope) UnmarshalJSON 

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

type RoutingAddressGetResponseEnvelopeErrors 

type RoutingAddressGetResponseEnvelopeErrors struct {
	Code    int64                                       `json:"code,required"`
	Message string                                      `json:"message,required"`
	JSON    routingAddressGetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*RoutingAddressGetResponseEnvelopeErrors) UnmarshalJSON 

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

type RoutingAddressGetResponseEnvelopeMessages 

type RoutingAddressGetResponseEnvelopeMessages struct {
	Code    int64                                         `json:"code,required"`
	Message string                                        `json:"message,required"`
	JSON    routingAddressGetResponseEnvelopeMessagesJSON `json:"-"`
}

func (*RoutingAddressGetResponseEnvelopeMessages) UnmarshalJSON 

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

type RoutingAddressGetResponseEnvelopeSuccess 

type RoutingAddressGetResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	RoutingAddressGetResponseEnvelopeSuccessTrue RoutingAddressGetResponseEnvelopeSuccess = true
)

type RoutingAddressListParams 

type RoutingAddressListParams struct {
	// Sorts results in an ascending or descending order.
	Direction param.Field[RoutingAddressListParamsDirection] `query:"direction"`
	// Page number of paginated results.
	Page param.Field[float64] `query:"page"`
	// Maximum number of results per page.
	PerPage param.Field[float64] `query:"per_page"`
	// Filter by verified destination addresses.
	Verified param.Field[RoutingAddressListParamsVerified] `query:"verified"`
}

func (RoutingAddressListParams) URLQuery 

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

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

type RoutingAddressListParamsDirection 

type RoutingAddressListParamsDirection string

Sorts results in an ascending or descending order. 

const (
	RoutingAddressListParamsDirectionAsc  RoutingAddressListParamsDirection = "asc"
	RoutingAddressListParamsDirectionDesc RoutingAddressListParamsDirection = "desc"
)

type RoutingAddressListParamsVerified 

type RoutingAddressListParamsVerified bool

Filter by verified destination addresses. 

const (
	RoutingAddressListParamsVerifiedTrue  RoutingAddressListParamsVerified = true
	RoutingAddressListParamsVerifiedFalse RoutingAddressListParamsVerified = false
)

type RoutingAddressListResponse 

type RoutingAddressListResponse struct {
	// Destination address identifier.
	ID string `json:"id"`
	// The date and time the destination address has been created.
	Created time.Time `json:"created" format:"date-time"`
	// The contact email address of the user.
	Email string `json:"email"`
	// The date and time the destination address was last modified.
	Modified time.Time `json:"modified" format:"date-time"`
	// Destination address tag. (Deprecated, replaced by destination address
	// identifier)
	Tag string `json:"tag"`
	// The date and time the destination address has been verified. Null means not
	// verified yet.
	Verified time.Time                      `json:"verified" format:"date-time"`
	JSON     routingAddressListResponseJSON `json:"-"`
}

func (*RoutingAddressListResponse) UnmarshalJSON 

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

type RoutingAddressNewParams 

type RoutingAddressNewParams struct {
	// The contact email address of the user.
	Email param.Field[string] `json:"email,required"`
}

func (RoutingAddressNewParams) MarshalJSON 

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

type RoutingAddressNewResponse 

type RoutingAddressNewResponse struct {
	// Destination address identifier.
	ID string `json:"id"`
	// The date and time the destination address has been created.
	Created time.Time `json:"created" format:"date-time"`
	// The contact email address of the user.
	Email string `json:"email"`
	// The date and time the destination address was last modified.
	Modified time.Time `json:"modified" format:"date-time"`
	// Destination address tag. (Deprecated, replaced by destination address
	// identifier)
	Tag string `json:"tag"`
	// The date and time the destination address has been verified. Null means not
	// verified yet.
	Verified time.Time                     `json:"verified" format:"date-time"`
	JSON     routingAddressNewResponseJSON `json:"-"`
}

func (*RoutingAddressNewResponse) UnmarshalJSON 

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

type RoutingAddressNewResponseEnvelope 

type RoutingAddressNewResponseEnvelope struct {
	Errors   []RoutingAddressNewResponseEnvelopeErrors   `json:"errors,required"`
	Messages []RoutingAddressNewResponseEnvelopeMessages `json:"messages,required"`
	Result   RoutingAddressNewResponse                   `json:"result,required"`
	// Whether the API call was successful
	Success RoutingAddressNewResponseEnvelopeSuccess `json:"success,required"`
	JSON    routingAddressNewResponseEnvelopeJSON    `json:"-"`
}

func (*RoutingAddressNewResponseEnvelope) UnmarshalJSON 

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

type RoutingAddressNewResponseEnvelopeErrors 

type RoutingAddressNewResponseEnvelopeErrors struct {
	Code    int64                                       `json:"code,required"`
	Message string                                      `json:"message,required"`
	JSON    routingAddressNewResponseEnvelopeErrorsJSON `json:"-"`
}

func (*RoutingAddressNewResponseEnvelopeErrors) UnmarshalJSON 

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

type RoutingAddressNewResponseEnvelopeMessages 

type RoutingAddressNewResponseEnvelopeMessages struct {
	Code    int64                                         `json:"code,required"`
	Message string                                        `json:"message,required"`
	JSON    routingAddressNewResponseEnvelopeMessagesJSON `json:"-"`
}

func (*RoutingAddressNewResponseEnvelopeMessages) UnmarshalJSON 

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

type RoutingAddressNewResponseEnvelopeSuccess 

type RoutingAddressNewResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	RoutingAddressNewResponseEnvelopeSuccessTrue RoutingAddressNewResponseEnvelopeSuccess = true
)

type RoutingAddressService 

type RoutingAddressService struct {
	Options []option.RequestOption
}

RoutingAddressService 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 NewRoutingAddressService method instead.

func NewRoutingAddressService 

func NewRoutingAddressService(opts ...option.RequestOption) (r *RoutingAddressService)

NewRoutingAddressService 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 (*RoutingAddressService) Delete 

func (r *RoutingAddressService) Delete(ctx context.Context, accountIdentifier string, destinationAddressIdentifier string, opts ...option.RequestOption) (res *RoutingAddressDeleteResponse, err error)

Deletes a specific destination address.

func (*RoutingAddressService) Get 

func (r *RoutingAddressService) Get(ctx context.Context, accountIdentifier string, destinationAddressIdentifier string, opts ...option.RequestOption) (res *RoutingAddressGetResponse, err error)

Gets information for a specific destination email already created.

func (*RoutingAddressService) List 

func (r *RoutingAddressService) List(ctx context.Context, accountIdentifier string, query RoutingAddressListParams, opts ...option.RequestOption) (res *shared.V4PagePaginationArray[RoutingAddressListResponse], err error)

Lists existing destination addresses.

func (*RoutingAddressService) ListAutoPaging 

func (r *RoutingAddressService) ListAutoPaging(ctx context.Context, accountIdentifier string, query RoutingAddressListParams, opts ...option.RequestOption) *shared.V4PagePaginationArrayAutoPager[RoutingAddressListResponse]

Lists existing destination addresses.

func (*RoutingAddressService) New 

func (r *RoutingAddressService) New(ctx context.Context, accountIdentifier string, body RoutingAddressNewParams, opts ...option.RequestOption) (res *RoutingAddressNewResponse, err error)

Create a destination address to forward your emails to. Destination addresses need to be verified before they can be used.

type RoutingDNSGetResponseEnvelope 

type RoutingDNSGetResponseEnvelope struct {
	Errors   []RoutingDNSGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []RoutingDNSGetResponseEnvelopeMessages `json:"messages,required"`
	Result   []EmailDNSRecord                        `json:"result,required,nullable"`
	// Whether the API call was successful
	Success    RoutingDNSGetResponseEnvelopeSuccess    `json:"success,required"`
	ResultInfo RoutingDNSGetResponseEnvelopeResultInfo `json:"result_info"`
	JSON       routingDNSGetResponseEnvelopeJSON       `json:"-"`
}

func (*RoutingDNSGetResponseEnvelope) UnmarshalJSON 

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

type RoutingDNSGetResponseEnvelopeErrors 

type RoutingDNSGetResponseEnvelopeErrors struct {
	Code    int64                                   `json:"code,required"`
	Message string                                  `json:"message,required"`
	JSON    routingDNSGetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*RoutingDNSGetResponseEnvelopeErrors) UnmarshalJSON 

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

type RoutingDNSGetResponseEnvelopeMessages 

type RoutingDNSGetResponseEnvelopeMessages struct {
	Code    int64                                     `json:"code,required"`
	Message string                                    `json:"message,required"`
	JSON    routingDNSGetResponseEnvelopeMessagesJSON `json:"-"`
}

func (*RoutingDNSGetResponseEnvelopeMessages) UnmarshalJSON 

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

type RoutingDNSGetResponseEnvelopeResultInfo 

type RoutingDNSGetResponseEnvelopeResultInfo struct {
	// Total number of results for the requested service
	Count float64 `json:"count"`
	// Current page within paginated list of results
	Page float64 `json:"page"`
	// Number of results per page of results
	PerPage float64 `json:"per_page"`
	// Total results available without any search parameters
	TotalCount float64                                     `json:"total_count"`
	JSON       routingDNSGetResponseEnvelopeResultInfoJSON `json:"-"`
}

func (*RoutingDNSGetResponseEnvelopeResultInfo) UnmarshalJSON 

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

type RoutingDNSGetResponseEnvelopeSuccess 

type RoutingDNSGetResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	RoutingDNSGetResponseEnvelopeSuccessTrue RoutingDNSGetResponseEnvelopeSuccess = true
)

type RoutingDNSService 

type RoutingDNSService struct {
	Options []option.RequestOption
}

RoutingDNSService 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 NewRoutingDNSService method instead.

func NewRoutingDNSService 

func NewRoutingDNSService(opts ...option.RequestOption) (r *RoutingDNSService)

NewRoutingDNSService 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 (*RoutingDNSService) Get 

func (r *RoutingDNSService) Get(ctx context.Context, zoneIdentifier string, opts ...option.RequestOption) (res *[]EmailDNSRecord, err error)

Show the DNS records needed to configure your Email Routing zone.

type RoutingDisableResponse 

type RoutingDisableResponse struct {
	// Email Routing settings identifier.
	ID string `json:"id"`
	// The date and time the settings have been created.
	Created time.Time `json:"created" format:"date-time"`
	// State of the zone settings for Email Routing.
	Enabled RoutingDisableResponseEnabled `json:"enabled"`
	// The date and time the settings have been modified.
	Modified time.Time `json:"modified" format:"date-time"`
	// Domain of your zone.
	Name string `json:"name"`
	// Flag to check if the user skipped the configuration wizard.
	SkipWizard RoutingDisableResponseSkipWizard `json:"skip_wizard"`
	// Show the state of your account, and the type or configuration error.
	Status RoutingDisableResponseStatus `json:"status"`
	// Email Routing settings tag. (Deprecated, replaced by Email Routing settings
	// identifier)
	Tag  string                     `json:"tag"`
	JSON routingDisableResponseJSON `json:"-"`
}

func (*RoutingDisableResponse) UnmarshalJSON 

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

type RoutingDisableResponseEnabled 

type RoutingDisableResponseEnabled bool

State of the zone settings for Email Routing. 

const (
	RoutingDisableResponseEnabledTrue  RoutingDisableResponseEnabled = true
	RoutingDisableResponseEnabledFalse RoutingDisableResponseEnabled = false
)

type RoutingDisableResponseEnvelope 

type RoutingDisableResponseEnvelope struct {
	Errors   []RoutingDisableResponseEnvelopeErrors   `json:"errors,required"`
	Messages []RoutingDisableResponseEnvelopeMessages `json:"messages,required"`
	Result   RoutingDisableResponse                   `json:"result,required"`
	// Whether the API call was successful
	Success RoutingDisableResponseEnvelopeSuccess `json:"success,required"`
	JSON    routingDisableResponseEnvelopeJSON    `json:"-"`
}

func (*RoutingDisableResponseEnvelope) UnmarshalJSON 

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

type RoutingDisableResponseEnvelopeErrors 

type RoutingDisableResponseEnvelopeErrors struct {
	Code    int64                                    `json:"code,required"`
	Message string                                   `json:"message,required"`
	JSON    routingDisableResponseEnvelopeErrorsJSON `json:"-"`
}

func (*RoutingDisableResponseEnvelopeErrors) UnmarshalJSON 

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

type RoutingDisableResponseEnvelopeMessages 

type RoutingDisableResponseEnvelopeMessages struct {
	Code    int64                                      `json:"code,required"`
	Message string                                     `json:"message,required"`
	JSON    routingDisableResponseEnvelopeMessagesJSON `json:"-"`
}

func (*RoutingDisableResponseEnvelopeMessages) UnmarshalJSON 

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

type RoutingDisableResponseEnvelopeSuccess 

type RoutingDisableResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	RoutingDisableResponseEnvelopeSuccessTrue RoutingDisableResponseEnvelopeSuccess = true
)

type RoutingDisableResponseSkipWizard 

type RoutingDisableResponseSkipWizard bool

Flag to check if the user skipped the configuration wizard. 

const (
	RoutingDisableResponseSkipWizardTrue  RoutingDisableResponseSkipWizard = true
	RoutingDisableResponseSkipWizardFalse RoutingDisableResponseSkipWizard = false
)

type RoutingDisableResponseStatus 

type RoutingDisableResponseStatus string

Show the state of your account, and the type or configuration error. 

const (
	RoutingDisableResponseStatusReady               RoutingDisableResponseStatus = "ready"
	RoutingDisableResponseStatusUnconfigured        RoutingDisableResponseStatus = "unconfigured"
	RoutingDisableResponseStatusMisconfigured       RoutingDisableResponseStatus = "misconfigured"
	RoutingDisableResponseStatusMisconfiguredLocked RoutingDisableResponseStatus = "misconfigured/locked"
	RoutingDisableResponseStatusUnlocked            RoutingDisableResponseStatus = "unlocked"
)

type RoutingEnableResponse 

type RoutingEnableResponse struct {
	// Email Routing settings identifier.
	ID string `json:"id"`
	// The date and time the settings have been created.
	Created time.Time `json:"created" format:"date-time"`
	// State of the zone settings for Email Routing.
	Enabled RoutingEnableResponseEnabled `json:"enabled"`
	// The date and time the settings have been modified.
	Modified time.Time `json:"modified" format:"date-time"`
	// Domain of your zone.
	Name string `json:"name"`
	// Flag to check if the user skipped the configuration wizard.
	SkipWizard RoutingEnableResponseSkipWizard `json:"skip_wizard"`
	// Show the state of your account, and the type or configuration error.
	Status RoutingEnableResponseStatus `json:"status"`
	// Email Routing settings tag. (Deprecated, replaced by Email Routing settings
	// identifier)
	Tag  string                    `json:"tag"`
	JSON routingEnableResponseJSON `json:"-"`
}

func (*RoutingEnableResponse) UnmarshalJSON 

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

type RoutingEnableResponseEnabled 

type RoutingEnableResponseEnabled bool

State of the zone settings for Email Routing. 

const (
	RoutingEnableResponseEnabledTrue  RoutingEnableResponseEnabled = true
	RoutingEnableResponseEnabledFalse RoutingEnableResponseEnabled = false
)

type RoutingEnableResponseEnvelope 

type RoutingEnableResponseEnvelope struct {
	Errors   []RoutingEnableResponseEnvelopeErrors   `json:"errors,required"`
	Messages []RoutingEnableResponseEnvelopeMessages `json:"messages,required"`
	Result   RoutingEnableResponse                   `json:"result,required"`
	// Whether the API call was successful
	Success RoutingEnableResponseEnvelopeSuccess `json:"success,required"`
	JSON    routingEnableResponseEnvelopeJSON    `json:"-"`
}

func (*RoutingEnableResponseEnvelope) UnmarshalJSON 

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

type RoutingEnableResponseEnvelopeErrors 

type RoutingEnableResponseEnvelopeErrors struct {
	Code    int64                                   `json:"code,required"`
	Message string                                  `json:"message,required"`
	JSON    routingEnableResponseEnvelopeErrorsJSON `json:"-"`
}

func (*RoutingEnableResponseEnvelopeErrors) UnmarshalJSON 

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

type RoutingEnableResponseEnvelopeMessages 

type RoutingEnableResponseEnvelopeMessages struct {
	Code    int64                                     `json:"code,required"`
	Message string                                    `json:"message,required"`
	JSON    routingEnableResponseEnvelopeMessagesJSON `json:"-"`
}

func (*RoutingEnableResponseEnvelopeMessages) UnmarshalJSON 

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

type RoutingEnableResponseEnvelopeSuccess 

type RoutingEnableResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	RoutingEnableResponseEnvelopeSuccessTrue RoutingEnableResponseEnvelopeSuccess = true
)

type RoutingEnableResponseSkipWizard 

type RoutingEnableResponseSkipWizard bool

Flag to check if the user skipped the configuration wizard. 

const (
	RoutingEnableResponseSkipWizardTrue  RoutingEnableResponseSkipWizard = true
	RoutingEnableResponseSkipWizardFalse RoutingEnableResponseSkipWizard = false
)

type RoutingEnableResponseStatus 

type RoutingEnableResponseStatus string

Show the state of your account, and the type or configuration error. 

const (
	RoutingEnableResponseStatusReady               RoutingEnableResponseStatus = "ready"
	RoutingEnableResponseStatusUnconfigured        RoutingEnableResponseStatus = "unconfigured"
	RoutingEnableResponseStatusMisconfigured       RoutingEnableResponseStatus = "misconfigured"
	RoutingEnableResponseStatusMisconfiguredLocked RoutingEnableResponseStatus = "misconfigured/locked"
	RoutingEnableResponseStatusUnlocked            RoutingEnableResponseStatus = "unlocked"
)

type RoutingGetResponse 

type RoutingGetResponse struct {
	// Email Routing settings identifier.
	ID string `json:"id"`
	// The date and time the settings have been created.
	Created time.Time `json:"created" format:"date-time"`
	// State of the zone settings for Email Routing.
	Enabled RoutingGetResponseEnabled `json:"enabled"`
	// The date and time the settings have been modified.
	Modified time.Time `json:"modified" format:"date-time"`
	// Domain of your zone.
	Name string `json:"name"`
	// Flag to check if the user skipped the configuration wizard.
	SkipWizard RoutingGetResponseSkipWizard `json:"skip_wizard"`
	// Show the state of your account, and the type or configuration error.
	Status RoutingGetResponseStatus `json:"status"`
	// Email Routing settings tag. (Deprecated, replaced by Email Routing settings
	// identifier)
	Tag  string                 `json:"tag"`
	JSON routingGetResponseJSON `json:"-"`
}

func (*RoutingGetResponse) UnmarshalJSON 

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

type RoutingGetResponseEnabled 

type RoutingGetResponseEnabled bool

State of the zone settings for Email Routing. 

const (
	RoutingGetResponseEnabledTrue  RoutingGetResponseEnabled = true
	RoutingGetResponseEnabledFalse RoutingGetResponseEnabled = false
)

type RoutingGetResponseEnvelope 

type RoutingGetResponseEnvelope struct {
	Errors   []RoutingGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []RoutingGetResponseEnvelopeMessages `json:"messages,required"`
	Result   RoutingGetResponse                   `json:"result,required"`
	// Whether the API call was successful
	Success RoutingGetResponseEnvelopeSuccess `json:"success,required"`
	JSON    routingGetResponseEnvelopeJSON    `json:"-"`
}

func (*RoutingGetResponseEnvelope) UnmarshalJSON 

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

type RoutingGetResponseEnvelopeErrors 

type RoutingGetResponseEnvelopeErrors struct {
	Code    int64                                `json:"code,required"`
	Message string                               `json:"message,required"`
	JSON    routingGetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*RoutingGetResponseEnvelopeErrors) UnmarshalJSON 

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

type RoutingGetResponseEnvelopeMessages 

type RoutingGetResponseEnvelopeMessages struct {
	Code    int64                                  `json:"code,required"`
	Message string                                 `json:"message,required"`
	JSON    routingGetResponseEnvelopeMessagesJSON `json:"-"`
}

func (*RoutingGetResponseEnvelopeMessages) UnmarshalJSON 

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

type RoutingGetResponseEnvelopeSuccess 

type RoutingGetResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	RoutingGetResponseEnvelopeSuccessTrue RoutingGetResponseEnvelopeSuccess = true
)

type RoutingGetResponseSkipWizard 

type RoutingGetResponseSkipWizard bool

Flag to check if the user skipped the configuration wizard. 

const (
	RoutingGetResponseSkipWizardTrue  RoutingGetResponseSkipWizard = true
	RoutingGetResponseSkipWizardFalse RoutingGetResponseSkipWizard = false
)

type RoutingGetResponseStatus 

type RoutingGetResponseStatus string

Show the state of your account, and the type or configuration error. 

const (
	RoutingGetResponseStatusReady               RoutingGetResponseStatus = "ready"
	RoutingGetResponseStatusUnconfigured        RoutingGetResponseStatus = "unconfigured"
	RoutingGetResponseStatusMisconfigured       RoutingGetResponseStatus = "misconfigured"
	RoutingGetResponseStatusMisconfiguredLocked RoutingGetResponseStatus = "misconfigured/locked"
	RoutingGetResponseStatusUnlocked            RoutingGetResponseStatus = "unlocked"
)

type RoutingRuleCatchAllGetResponseEnvelope 

type RoutingRuleCatchAllGetResponseEnvelope struct {
	Errors   []RoutingRuleCatchAllGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []RoutingRuleCatchAllGetResponseEnvelopeMessages `json:"messages,required"`
	Result   EmailCatchAllRule                                `json:"result,required"`
	// Whether the API call was successful
	Success RoutingRuleCatchAllGetResponseEnvelopeSuccess `json:"success,required"`
	JSON    routingRuleCatchAllGetResponseEnvelopeJSON    `json:"-"`
}

func (*RoutingRuleCatchAllGetResponseEnvelope) UnmarshalJSON 

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

type RoutingRuleCatchAllGetResponseEnvelopeErrors 

type RoutingRuleCatchAllGetResponseEnvelopeErrors struct {
	Code    int64                                            `json:"code,required"`
	Message string                                           `json:"message,required"`
	JSON    routingRuleCatchAllGetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*RoutingRuleCatchAllGetResponseEnvelopeErrors) UnmarshalJSON 

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

type RoutingRuleCatchAllGetResponseEnvelopeMessages 

type RoutingRuleCatchAllGetResponseEnvelopeMessages struct {
	Code    int64                                              `json:"code,required"`
	Message string                                             `json:"message,required"`
	JSON    routingRuleCatchAllGetResponseEnvelopeMessagesJSON `json:"-"`
}

func (*RoutingRuleCatchAllGetResponseEnvelopeMessages) UnmarshalJSON 

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

type RoutingRuleCatchAllGetResponseEnvelopeSuccess 

type RoutingRuleCatchAllGetResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	RoutingRuleCatchAllGetResponseEnvelopeSuccessTrue RoutingRuleCatchAllGetResponseEnvelopeSuccess = true
)

type RoutingRuleCatchAllService 

type RoutingRuleCatchAllService struct {
	Options []option.RequestOption
}

RoutingRuleCatchAllService 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 NewRoutingRuleCatchAllService method instead.

func NewRoutingRuleCatchAllService 

func NewRoutingRuleCatchAllService(opts ...option.RequestOption) (r *RoutingRuleCatchAllService)

NewRoutingRuleCatchAllService 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 (*RoutingRuleCatchAllService) Get 

func (r *RoutingRuleCatchAllService) Get(ctx context.Context, zoneIdentifier string, opts ...option.RequestOption) (res *EmailCatchAllRule, err error)

Get information on the default catch-all routing rule.

func (*RoutingRuleCatchAllService) Update 

func (r *RoutingRuleCatchAllService) Update(ctx context.Context, zoneIdentifier string, body RoutingRuleCatchAllUpdateParams, opts ...option.RequestOption) (res *EmailCatchAllRule, err error)

Enable or disable catch-all routing rule, or change action to forward to specific destination address.

type RoutingRuleCatchAllUpdateParams 

type RoutingRuleCatchAllUpdateParams struct {
	// List actions for the catch-all routing rule.
	Actions param.Field[[]RoutingRuleCatchAllUpdateParamsAction] `json:"actions,required"`
	// List of matchers for the catch-all routing rule.
	Matchers param.Field[[]RoutingRuleCatchAllUpdateParamsMatcher] `json:"matchers,required"`
	// Routing rule status.
	Enabled param.Field[RoutingRuleCatchAllUpdateParamsEnabled] `json:"enabled"`
	// Routing rule name.
	Name param.Field[string] `json:"name"`
}

func (RoutingRuleCatchAllUpdateParams) MarshalJSON 

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

type RoutingRuleCatchAllUpdateParamsAction 

type RoutingRuleCatchAllUpdateParamsAction struct {
	// Type of action for catch-all rule.
	Type  param.Field[RoutingRuleCatchAllUpdateParamsActionsType] `json:"type,required"`
	Value param.Field[[]string]                                   `json:"value"`
}

Action for the catch-all routing rule.

func (RoutingRuleCatchAllUpdateParamsAction) MarshalJSON 

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

type RoutingRuleCatchAllUpdateParamsActionsType 

type RoutingRuleCatchAllUpdateParamsActionsType string

Type of action for catch-all rule. 

const (
	RoutingRuleCatchAllUpdateParamsActionsTypeDrop    RoutingRuleCatchAllUpdateParamsActionsType = "drop"
	RoutingRuleCatchAllUpdateParamsActionsTypeForward RoutingRuleCatchAllUpdateParamsActionsType = "forward"
	RoutingRuleCatchAllUpdateParamsActionsTypeWorker  RoutingRuleCatchAllUpdateParamsActionsType = "worker"
)

type RoutingRuleCatchAllUpdateParamsEnabled 

type RoutingRuleCatchAllUpdateParamsEnabled bool

Routing rule status. 

const (
	RoutingRuleCatchAllUpdateParamsEnabledTrue  RoutingRuleCatchAllUpdateParamsEnabled = true
	RoutingRuleCatchAllUpdateParamsEnabledFalse RoutingRuleCatchAllUpdateParamsEnabled = false
)

type RoutingRuleCatchAllUpdateParamsMatcher 

type RoutingRuleCatchAllUpdateParamsMatcher struct {
	// Type of matcher. Default is 'all'.
	Type param.Field[RoutingRuleCatchAllUpdateParamsMatchersType] `json:"type,required"`
}

Matcher for catch-all routing rule.

func (RoutingRuleCatchAllUpdateParamsMatcher) MarshalJSON 

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

type RoutingRuleCatchAllUpdateParamsMatchersType 

type RoutingRuleCatchAllUpdateParamsMatchersType string

Type of matcher. Default is 'all'. 

const (
	RoutingRuleCatchAllUpdateParamsMatchersTypeAll RoutingRuleCatchAllUpdateParamsMatchersType = "all"
)

type RoutingRuleCatchAllUpdateResponseEnvelope 

type RoutingRuleCatchAllUpdateResponseEnvelope struct {
	Errors   []RoutingRuleCatchAllUpdateResponseEnvelopeErrors   `json:"errors,required"`
	Messages []RoutingRuleCatchAllUpdateResponseEnvelopeMessages `json:"messages,required"`
	Result   EmailCatchAllRule                                   `json:"result,required"`
	// Whether the API call was successful
	Success RoutingRuleCatchAllUpdateResponseEnvelopeSuccess `json:"success,required"`
	JSON    routingRuleCatchAllUpdateResponseEnvelopeJSON    `json:"-"`
}

func (*RoutingRuleCatchAllUpdateResponseEnvelope) UnmarshalJSON 

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

type RoutingRuleCatchAllUpdateResponseEnvelopeErrors 

type RoutingRuleCatchAllUpdateResponseEnvelopeErrors struct {
	Code    int64                                               `json:"code,required"`
	Message string                                              `json:"message,required"`
	JSON    routingRuleCatchAllUpdateResponseEnvelopeErrorsJSON `json:"-"`
}

func (*RoutingRuleCatchAllUpdateResponseEnvelopeErrors) UnmarshalJSON 

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

type RoutingRuleCatchAllUpdateResponseEnvelopeMessages 

type RoutingRuleCatchAllUpdateResponseEnvelopeMessages struct {
	Code    int64                                                 `json:"code,required"`
	Message string                                                `json:"message,required"`
	JSON    routingRuleCatchAllUpdateResponseEnvelopeMessagesJSON `json:"-"`
}

func (*RoutingRuleCatchAllUpdateResponseEnvelopeMessages) UnmarshalJSON 

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

type RoutingRuleCatchAllUpdateResponseEnvelopeSuccess 

type RoutingRuleCatchAllUpdateResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	RoutingRuleCatchAllUpdateResponseEnvelopeSuccessTrue RoutingRuleCatchAllUpdateResponseEnvelopeSuccess = true
)

type RoutingRuleDeleteResponse 

type RoutingRuleDeleteResponse struct {
	// Routing rule identifier.
	ID string `json:"id"`
	// List actions patterns.
	Actions []RoutingRuleDeleteResponseAction `json:"actions"`
	// Routing rule status.
	Enabled RoutingRuleDeleteResponseEnabled `json:"enabled"`
	// Matching patterns to forward to your actions.
	Matchers []RoutingRuleDeleteResponseMatcher `json:"matchers"`
	// Routing rule name.
	Name string `json:"name"`
	// Priority of the routing rule.
	Priority float64 `json:"priority"`
	// Routing rule tag. (Deprecated, replaced by routing rule identifier)
	Tag  string                        `json:"tag"`
	JSON routingRuleDeleteResponseJSON `json:"-"`
}

func (*RoutingRuleDeleteResponse) UnmarshalJSON 

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

type RoutingRuleDeleteResponseAction 

type RoutingRuleDeleteResponseAction struct {
	// Type of supported action.
	Type  RoutingRuleDeleteResponseActionsType `json:"type,required"`
	Value []string                             `json:"value,required"`
	JSON  routingRuleDeleteResponseActionJSON  `json:"-"`
}

Actions pattern.

func (*RoutingRuleDeleteResponseAction) UnmarshalJSON 

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

type RoutingRuleDeleteResponseActionsType 

type RoutingRuleDeleteResponseActionsType string

Type of supported action. 

const (
	RoutingRuleDeleteResponseActionsTypeDrop    RoutingRuleDeleteResponseActionsType = "drop"
	RoutingRuleDeleteResponseActionsTypeForward RoutingRuleDeleteResponseActionsType = "forward"
	RoutingRuleDeleteResponseActionsTypeWorker  RoutingRuleDeleteResponseActionsType = "worker"
)

type RoutingRuleDeleteResponseEnabled 

type RoutingRuleDeleteResponseEnabled bool

Routing rule status. 

const (
	RoutingRuleDeleteResponseEnabledTrue  RoutingRuleDeleteResponseEnabled = true
	RoutingRuleDeleteResponseEnabledFalse RoutingRuleDeleteResponseEnabled = false
)

type RoutingRuleDeleteResponseEnvelope 

type RoutingRuleDeleteResponseEnvelope struct {
	Errors   []RoutingRuleDeleteResponseEnvelopeErrors   `json:"errors,required"`
	Messages []RoutingRuleDeleteResponseEnvelopeMessages `json:"messages,required"`
	Result   RoutingRuleDeleteResponse                   `json:"result,required"`
	// Whether the API call was successful
	Success RoutingRuleDeleteResponseEnvelopeSuccess `json:"success,required"`
	JSON    routingRuleDeleteResponseEnvelopeJSON    `json:"-"`
}

func (*RoutingRuleDeleteResponseEnvelope) UnmarshalJSON 

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

type RoutingRuleDeleteResponseEnvelopeErrors 

type RoutingRuleDeleteResponseEnvelopeErrors struct {
	Code    int64                                       `json:"code,required"`
	Message string                                      `json:"message,required"`
	JSON    routingRuleDeleteResponseEnvelopeErrorsJSON `json:"-"`
}

func (*RoutingRuleDeleteResponseEnvelopeErrors) UnmarshalJSON 

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

type RoutingRuleDeleteResponseEnvelopeMessages 

type RoutingRuleDeleteResponseEnvelopeMessages struct {
	Code    int64                                         `json:"code,required"`
	Message string                                        `json:"message,required"`
	JSON    routingRuleDeleteResponseEnvelopeMessagesJSON `json:"-"`
}

func (*RoutingRuleDeleteResponseEnvelopeMessages) UnmarshalJSON 

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

type RoutingRuleDeleteResponseEnvelopeSuccess 

type RoutingRuleDeleteResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	RoutingRuleDeleteResponseEnvelopeSuccessTrue RoutingRuleDeleteResponseEnvelopeSuccess = true
)

type RoutingRuleDeleteResponseMatcher 

type RoutingRuleDeleteResponseMatcher struct {
	// Field for type matcher.
	Field RoutingRuleDeleteResponseMatchersField `json:"field,required"`
	// Type of matcher.
	Type RoutingRuleDeleteResponseMatchersType `json:"type,required"`
	// Value for matcher.
	Value string                               `json:"value,required"`
	JSON  routingRuleDeleteResponseMatcherJSON `json:"-"`
}

Matching pattern to forward your actions.

func (*RoutingRuleDeleteResponseMatcher) UnmarshalJSON 

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

type RoutingRuleDeleteResponseMatchersField 

type RoutingRuleDeleteResponseMatchersField string

Field for type matcher. 

const (
	RoutingRuleDeleteResponseMatchersFieldTo RoutingRuleDeleteResponseMatchersField = "to"
)

type RoutingRuleDeleteResponseMatchersType 

type RoutingRuleDeleteResponseMatchersType string

Type of matcher. 

const (
	RoutingRuleDeleteResponseMatchersTypeLiteral RoutingRuleDeleteResponseMatchersType = "literal"
)

type RoutingRuleGetResponse 

type RoutingRuleGetResponse struct {
	// Routing rule identifier.
	ID string `json:"id"`
	// List actions patterns.
	Actions []RoutingRuleGetResponseAction `json:"actions"`
	// Routing rule status.
	Enabled RoutingRuleGetResponseEnabled `json:"enabled"`
	// Matching patterns to forward to your actions.
	Matchers []RoutingRuleGetResponseMatcher `json:"matchers"`
	// Routing rule name.
	Name string `json:"name"`
	// Priority of the routing rule.
	Priority float64 `json:"priority"`
	// Routing rule tag. (Deprecated, replaced by routing rule identifier)
	Tag  string                     `json:"tag"`
	JSON routingRuleGetResponseJSON `json:"-"`
}

func (*RoutingRuleGetResponse) UnmarshalJSON 

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

type RoutingRuleGetResponseAction 

type RoutingRuleGetResponseAction struct {
	// Type of supported action.
	Type  RoutingRuleGetResponseActionsType `json:"type,required"`
	Value []string                          `json:"value,required"`
	JSON  routingRuleGetResponseActionJSON  `json:"-"`
}

Actions pattern.

func (*RoutingRuleGetResponseAction) UnmarshalJSON 

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

type RoutingRuleGetResponseActionsType 

type RoutingRuleGetResponseActionsType string

Type of supported action. 

const (
	RoutingRuleGetResponseActionsTypeDrop    RoutingRuleGetResponseActionsType = "drop"
	RoutingRuleGetResponseActionsTypeForward RoutingRuleGetResponseActionsType = "forward"
	RoutingRuleGetResponseActionsTypeWorker  RoutingRuleGetResponseActionsType = "worker"
)

type RoutingRuleGetResponseEnabled 

type RoutingRuleGetResponseEnabled bool

Routing rule status. 

const (
	RoutingRuleGetResponseEnabledTrue  RoutingRuleGetResponseEnabled = true
	RoutingRuleGetResponseEnabledFalse RoutingRuleGetResponseEnabled = false
)

type RoutingRuleGetResponseEnvelope 

type RoutingRuleGetResponseEnvelope struct {
	Errors   []RoutingRuleGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []RoutingRuleGetResponseEnvelopeMessages `json:"messages,required"`
	Result   RoutingRuleGetResponse                   `json:"result,required"`
	// Whether the API call was successful
	Success RoutingRuleGetResponseEnvelopeSuccess `json:"success,required"`
	JSON    routingRuleGetResponseEnvelopeJSON    `json:"-"`
}

func (*RoutingRuleGetResponseEnvelope) UnmarshalJSON 

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

type RoutingRuleGetResponseEnvelopeErrors 

type RoutingRuleGetResponseEnvelopeErrors struct {
	Code    int64                                    `json:"code,required"`
	Message string                                   `json:"message,required"`
	JSON    routingRuleGetResponseEnvelopeErrorsJSON `json:"-"`
}

func (*RoutingRuleGetResponseEnvelopeErrors) UnmarshalJSON 

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

type RoutingRuleGetResponseEnvelopeMessages 

type RoutingRuleGetResponseEnvelopeMessages struct {
	Code    int64                                      `json:"code,required"`
	Message string                                     `json:"message,required"`
	JSON    routingRuleGetResponseEnvelopeMessagesJSON `json:"-"`
}

func (*RoutingRuleGetResponseEnvelopeMessages) UnmarshalJSON 

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

type RoutingRuleGetResponseEnvelopeSuccess 

type RoutingRuleGetResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	RoutingRuleGetResponseEnvelopeSuccessTrue RoutingRuleGetResponseEnvelopeSuccess = true
)

type RoutingRuleGetResponseMatcher 

type RoutingRuleGetResponseMatcher struct {
	// Field for type matcher.
	Field RoutingRuleGetResponseMatchersField `json:"field,required"`
	// Type of matcher.
	Type RoutingRuleGetResponseMatchersType `json:"type,required"`
	// Value for matcher.
	Value string                            `json:"value,required"`
	JSON  routingRuleGetResponseMatcherJSON `json:"-"`
}

Matching pattern to forward your actions.

func (*RoutingRuleGetResponseMatcher) UnmarshalJSON 

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

type RoutingRuleGetResponseMatchersField 

type RoutingRuleGetResponseMatchersField string

Field for type matcher. 

const (
	RoutingRuleGetResponseMatchersFieldTo RoutingRuleGetResponseMatchersField = "to"
)

type RoutingRuleGetResponseMatchersType 

type RoutingRuleGetResponseMatchersType string

Type of matcher. 

const (
	RoutingRuleGetResponseMatchersTypeLiteral RoutingRuleGetResponseMatchersType = "literal"
)

type RoutingRuleListParams 

type RoutingRuleListParams struct {
	// Filter by enabled routing rules.
	Enabled param.Field[RoutingRuleListParamsEnabled] `query:"enabled"`
	// Page number of paginated results.
	Page param.Field[float64] `query:"page"`
	// Maximum number of results per page.
	PerPage param.Field[float64] `query:"per_page"`
}

func (RoutingRuleListParams) URLQuery 

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

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

type RoutingRuleListParamsEnabled 

type RoutingRuleListParamsEnabled bool

Filter by enabled routing rules. 

const (
	RoutingRuleListParamsEnabledTrue  RoutingRuleListParamsEnabled = true
	RoutingRuleListParamsEnabledFalse RoutingRuleListParamsEnabled = false
)

type RoutingRuleListResponse 

type RoutingRuleListResponse struct {
	// Routing rule identifier.
	ID string `json:"id"`
	// List actions patterns.
	Actions []RoutingRuleListResponseAction `json:"actions"`
	// Routing rule status.
	Enabled RoutingRuleListResponseEnabled `json:"enabled"`
	// Matching patterns to forward to your actions.
	Matchers []RoutingRuleListResponseMatcher `json:"matchers"`
	// Routing rule name.
	Name string `json:"name"`
	// Priority of the routing rule.
	Priority float64 `json:"priority"`
	// Routing rule tag. (Deprecated, replaced by routing rule identifier)
	Tag  string                      `json:"tag"`
	JSON routingRuleListResponseJSON `json:"-"`
}

func (*RoutingRuleListResponse) UnmarshalJSON 

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

type RoutingRuleListResponseAction 

type RoutingRuleListResponseAction struct {
	// Type of supported action.
	Type  RoutingRuleListResponseActionsType `json:"type,required"`
	Value []string                           `json:"value,required"`
	JSON  routingRuleListResponseActionJSON  `json:"-"`
}

Actions pattern.

func (*RoutingRuleListResponseAction) UnmarshalJSON 

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

type RoutingRuleListResponseActionsType 

type RoutingRuleListResponseActionsType string

Type of supported action. 

const (
	RoutingRuleListResponseActionsTypeDrop    RoutingRuleListResponseActionsType = "drop"
	RoutingRuleListResponseActionsTypeForward RoutingRuleListResponseActionsType = "forward"
	RoutingRuleListResponseActionsTypeWorker  RoutingRuleListResponseActionsType = "worker"
)

type RoutingRuleListResponseEnabled 

type RoutingRuleListResponseEnabled bool

Routing rule status. 

const (
	RoutingRuleListResponseEnabledTrue  RoutingRuleListResponseEnabled = true
	RoutingRuleListResponseEnabledFalse RoutingRuleListResponseEnabled = false
)

type RoutingRuleListResponseMatcher 

type RoutingRuleListResponseMatcher struct {
	// Field for type matcher.
	Field RoutingRuleListResponseMatchersField `json:"field,required"`
	// Type of matcher.
	Type RoutingRuleListResponseMatchersType `json:"type,required"`
	// Value for matcher.
	Value string                             `json:"value,required"`
	JSON  routingRuleListResponseMatcherJSON `json:"-"`
}

Matching pattern to forward your actions.

func (*RoutingRuleListResponseMatcher) UnmarshalJSON 

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

type RoutingRuleListResponseMatchersField 

type RoutingRuleListResponseMatchersField string

Field for type matcher. 

const (
	RoutingRuleListResponseMatchersFieldTo RoutingRuleListResponseMatchersField = "to"
)

type RoutingRuleListResponseMatchersType 

type RoutingRuleListResponseMatchersType string

Type of matcher. 

const (
	RoutingRuleListResponseMatchersTypeLiteral RoutingRuleListResponseMatchersType = "literal"
)

type RoutingRuleNewParams 

type RoutingRuleNewParams struct {
	// List actions patterns.
	Actions param.Field[[]RoutingRuleNewParamsAction] `json:"actions,required"`
	// Matching patterns to forward to your actions.
	Matchers param.Field[[]RoutingRuleNewParamsMatcher] `json:"matchers,required"`
	// Routing rule status.
	Enabled param.Field[RoutingRuleNewParamsEnabled] `json:"enabled"`
	// Routing rule name.
	Name param.Field[string] `json:"name"`
	// Priority of the routing rule.
	Priority param.Field[float64] `json:"priority"`
}

func (RoutingRuleNewParams) MarshalJSON 

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

type RoutingRuleNewParamsAction 

type RoutingRuleNewParamsAction struct {
	// Type of supported action.
	Type  param.Field[RoutingRuleNewParamsActionsType] `json:"type,required"`
	Value param.Field[[]string]                        `json:"value,required"`
}

Actions pattern.

func (RoutingRuleNewParamsAction) MarshalJSON 

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

type RoutingRuleNewParamsActionsType 

type RoutingRuleNewParamsActionsType string

Type of supported action. 

const (
	RoutingRuleNewParamsActionsTypeDrop    RoutingRuleNewParamsActionsType = "drop"
	RoutingRuleNewParamsActionsTypeForward RoutingRuleNewParamsActionsType = "forward"
	RoutingRuleNewParamsActionsTypeWorker  RoutingRuleNewParamsActionsType = "worker"
)

type RoutingRuleNewParamsEnabled 

type RoutingRuleNewParamsEnabled bool

Routing rule status. 

const (
	RoutingRuleNewParamsEnabledTrue  RoutingRuleNewParamsEnabled = true
	RoutingRuleNewParamsEnabledFalse RoutingRuleNewParamsEnabled = false
)

type RoutingRuleNewParamsMatcher 

type RoutingRuleNewParamsMatcher struct {
	// Field for type matcher.
	Field param.Field[RoutingRuleNewParamsMatchersField] `json:"field,required"`
	// Type of matcher.
	Type param.Field[RoutingRuleNewParamsMatchersType] `json:"type,required"`
	// Value for matcher.
	Value param.Field[string] `json:"value,required"`
}

Matching pattern to forward your actions.

func (RoutingRuleNewParamsMatcher) MarshalJSON 

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

type RoutingRuleNewParamsMatchersField 

type RoutingRuleNewParamsMatchersField string

Field for type matcher. 

const (
	RoutingRuleNewParamsMatchersFieldTo RoutingRuleNewParamsMatchersField = "to"
)

type RoutingRuleNewParamsMatchersType 

type RoutingRuleNewParamsMatchersType string

Type of matcher. 

const (
	RoutingRuleNewParamsMatchersTypeLiteral RoutingRuleNewParamsMatchersType = "literal"
)

type RoutingRuleNewResponse 

type RoutingRuleNewResponse struct {
	// Routing rule identifier.
	ID string `json:"id"`
	// List actions patterns.
	Actions []RoutingRuleNewResponseAction `json:"actions"`
	// Routing rule status.
	Enabled RoutingRuleNewResponseEnabled `json:"enabled"`
	// Matching patterns to forward to your actions.
	Matchers []RoutingRuleNewResponseMatcher `json:"matchers"`
	// Routing rule name.
	Name string `json:"name"`
	// Priority of the routing rule.
	Priority float64 `json:"priority"`
	// Routing rule tag. (Deprecated, replaced by routing rule identifier)
	Tag  string                     `json:"tag"`
	JSON routingRuleNewResponseJSON `json:"-"`
}

func (*RoutingRuleNewResponse) UnmarshalJSON 

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

type RoutingRuleNewResponseAction 

type RoutingRuleNewResponseAction struct {
	// Type of supported action.
	Type  RoutingRuleNewResponseActionsType `json:"type,required"`
	Value []string                          `json:"value,required"`
	JSON  routingRuleNewResponseActionJSON  `json:"-"`
}

Actions pattern.

func (*RoutingRuleNewResponseAction) UnmarshalJSON 

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

type RoutingRuleNewResponseActionsType 

type RoutingRuleNewResponseActionsType string

Type of supported action. 

const (
	RoutingRuleNewResponseActionsTypeDrop    RoutingRuleNewResponseActionsType = "drop"
	RoutingRuleNewResponseActionsTypeForward RoutingRuleNewResponseActionsType = "forward"
	RoutingRuleNewResponseActionsTypeWorker  RoutingRuleNewResponseActionsType = "worker"
)

type RoutingRuleNewResponseEnabled 

type RoutingRuleNewResponseEnabled bool

Routing rule status. 

const (
	RoutingRuleNewResponseEnabledTrue  RoutingRuleNewResponseEnabled = true
	RoutingRuleNewResponseEnabledFalse RoutingRuleNewResponseEnabled = false
)

type RoutingRuleNewResponseEnvelope 

type RoutingRuleNewResponseEnvelope struct {
	Errors   []RoutingRuleNewResponseEnvelopeErrors   `json:"errors,required"`
	Messages []RoutingRuleNewResponseEnvelopeMessages `json:"messages,required"`
	Result   RoutingRuleNewResponse                   `json:"result,required"`
	// Whether the API call was successful
	Success RoutingRuleNewResponseEnvelopeSuccess `json:"success,required"`
	JSON    routingRuleNewResponseEnvelopeJSON    `json:"-"`
}

func (*RoutingRuleNewResponseEnvelope) UnmarshalJSON 

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

type RoutingRuleNewResponseEnvelopeErrors 

type RoutingRuleNewResponseEnvelopeErrors struct {
	Code    int64                                    `json:"code,required"`
	Message string                                   `json:"message,required"`
	JSON    routingRuleNewResponseEnvelopeErrorsJSON `json:"-"`
}

func (*RoutingRuleNewResponseEnvelopeErrors) UnmarshalJSON 

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

type RoutingRuleNewResponseEnvelopeMessages 

type RoutingRuleNewResponseEnvelopeMessages struct {
	Code    int64                                      `json:"code,required"`
	Message string                                     `json:"message,required"`
	JSON    routingRuleNewResponseEnvelopeMessagesJSON `json:"-"`
}

func (*RoutingRuleNewResponseEnvelopeMessages) UnmarshalJSON 

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

type RoutingRuleNewResponseEnvelopeSuccess 

type RoutingRuleNewResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	RoutingRuleNewResponseEnvelopeSuccessTrue RoutingRuleNewResponseEnvelopeSuccess = true
)

type RoutingRuleNewResponseMatcher 

type RoutingRuleNewResponseMatcher struct {
	// Field for type matcher.
	Field RoutingRuleNewResponseMatchersField `json:"field,required"`
	// Type of matcher.
	Type RoutingRuleNewResponseMatchersType `json:"type,required"`
	// Value for matcher.
	Value string                            `json:"value,required"`
	JSON  routingRuleNewResponseMatcherJSON `json:"-"`
}

Matching pattern to forward your actions.

func (*RoutingRuleNewResponseMatcher) UnmarshalJSON 

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

type RoutingRuleNewResponseMatchersField 

type RoutingRuleNewResponseMatchersField string

Field for type matcher. 

const (
	RoutingRuleNewResponseMatchersFieldTo RoutingRuleNewResponseMatchersField = "to"
)

type RoutingRuleNewResponseMatchersType 

type RoutingRuleNewResponseMatchersType string

Type of matcher. 

const (
	RoutingRuleNewResponseMatchersTypeLiteral RoutingRuleNewResponseMatchersType = "literal"
)

type RoutingRuleService 

type RoutingRuleService struct {
	Options   []option.RequestOption
	CatchAlls *RoutingRuleCatchAllService
}

RoutingRuleService 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 NewRoutingRuleService method instead.

func NewRoutingRuleService 

func NewRoutingRuleService(opts ...option.RequestOption) (r *RoutingRuleService)

NewRoutingRuleService 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 (*RoutingRuleService) Delete 

func (r *RoutingRuleService) Delete(ctx context.Context, zoneIdentifier string, ruleIdentifier string, opts ...option.RequestOption) (res *RoutingRuleDeleteResponse, err error)

Delete a specific routing rule.

func (*RoutingRuleService) Get 

func (r *RoutingRuleService) Get(ctx context.Context, zoneIdentifier string, ruleIdentifier string, opts ...option.RequestOption) (res *RoutingRuleGetResponse, err error)

Get information for a specific routing rule already created.

func (*RoutingRuleService) List 

func (r *RoutingRuleService) List(ctx context.Context, zoneIdentifier string, query RoutingRuleListParams, opts ...option.RequestOption) (res *shared.V4PagePaginationArray[RoutingRuleListResponse], err error)

Lists existing routing rules.

func (*RoutingRuleService) ListAutoPaging 

func (r *RoutingRuleService) ListAutoPaging(ctx context.Context, zoneIdentifier string, query RoutingRuleListParams, opts ...option.RequestOption) *shared.V4PagePaginationArrayAutoPager[RoutingRuleListResponse]

Lists existing routing rules.

func (*RoutingRuleService) New 

func (r *RoutingRuleService) New(ctx context.Context, zoneIdentifier string, body RoutingRuleNewParams, opts ...option.RequestOption) (res *RoutingRuleNewResponse, err error)

Rules consist of a set of criteria for matching emails (such as an email being sent to a specific custom email address) plus a set of actions to take on the email (like forwarding it to a specific destination address).

func (*RoutingRuleService) Update 

func (r *RoutingRuleService) Update(ctx context.Context, zoneIdentifier string, ruleIdentifier string, body RoutingRuleUpdateParams, opts ...option.RequestOption) (res *RoutingRuleUpdateResponse, err error)

Update actions and matches, or enable/disable specific routing rules.

type RoutingRuleUpdateParams 

type RoutingRuleUpdateParams struct {
	// List actions patterns.
	Actions param.Field[[]RoutingRuleUpdateParamsAction] `json:"actions,required"`
	// Matching patterns to forward to your actions.
	Matchers param.Field[[]RoutingRuleUpdateParamsMatcher] `json:"matchers,required"`
	// Routing rule status.
	Enabled param.Field[RoutingRuleUpdateParamsEnabled] `json:"enabled"`
	// Routing rule name.
	Name param.Field[string] `json:"name"`
	// Priority of the routing rule.
	Priority param.Field[float64] `json:"priority"`
}

func (RoutingRuleUpdateParams) MarshalJSON 

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

type RoutingRuleUpdateParamsAction 

type RoutingRuleUpdateParamsAction struct {
	// Type of supported action.
	Type  param.Field[RoutingRuleUpdateParamsActionsType] `json:"type,required"`
	Value param.Field[[]string]                           `json:"value,required"`
}

Actions pattern.

func (RoutingRuleUpdateParamsAction) MarshalJSON 

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

type RoutingRuleUpdateParamsActionsType 

type RoutingRuleUpdateParamsActionsType string

Type of supported action. 

const (
	RoutingRuleUpdateParamsActionsTypeDrop    RoutingRuleUpdateParamsActionsType = "drop"
	RoutingRuleUpdateParamsActionsTypeForward RoutingRuleUpdateParamsActionsType = "forward"
	RoutingRuleUpdateParamsActionsTypeWorker  RoutingRuleUpdateParamsActionsType = "worker"
)

type RoutingRuleUpdateParamsEnabled 

type RoutingRuleUpdateParamsEnabled bool

Routing rule status. 

const (
	RoutingRuleUpdateParamsEnabledTrue  RoutingRuleUpdateParamsEnabled = true
	RoutingRuleUpdateParamsEnabledFalse RoutingRuleUpdateParamsEnabled = false
)

type RoutingRuleUpdateParamsMatcher 

type RoutingRuleUpdateParamsMatcher struct {
	// Field for type matcher.
	Field param.Field[RoutingRuleUpdateParamsMatchersField] `json:"field,required"`
	// Type of matcher.
	Type param.Field[RoutingRuleUpdateParamsMatchersType] `json:"type,required"`
	// Value for matcher.
	Value param.Field[string] `json:"value,required"`
}

Matching pattern to forward your actions.

func (RoutingRuleUpdateParamsMatcher) MarshalJSON 

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

type RoutingRuleUpdateParamsMatchersField 

type RoutingRuleUpdateParamsMatchersField string

Field for type matcher. 

const (
	RoutingRuleUpdateParamsMatchersFieldTo RoutingRuleUpdateParamsMatchersField = "to"
)

type RoutingRuleUpdateParamsMatchersType 

type RoutingRuleUpdateParamsMatchersType string

Type of matcher. 

const (
	RoutingRuleUpdateParamsMatchersTypeLiteral RoutingRuleUpdateParamsMatchersType = "literal"
)

type RoutingRuleUpdateResponse 

type RoutingRuleUpdateResponse struct {
	// Routing rule identifier.
	ID string `json:"id"`
	// List actions patterns.
	Actions []RoutingRuleUpdateResponseAction `json:"actions"`
	// Routing rule status.
	Enabled RoutingRuleUpdateResponseEnabled `json:"enabled"`
	// Matching patterns to forward to your actions.
	Matchers []RoutingRuleUpdateResponseMatcher `json:"matchers"`
	// Routing rule name.
	Name string `json:"name"`
	// Priority of the routing rule.
	Priority float64 `json:"priority"`
	// Routing rule tag. (Deprecated, replaced by routing rule identifier)
	Tag  string                        `json:"tag"`
	JSON routingRuleUpdateResponseJSON `json:"-"`
}

func (*RoutingRuleUpdateResponse) UnmarshalJSON 

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

type RoutingRuleUpdateResponseAction 

type RoutingRuleUpdateResponseAction struct {
	// Type of supported action.
	Type  RoutingRuleUpdateResponseActionsType `json:"type,required"`
	Value []string                             `json:"value,required"`
	JSON  routingRuleUpdateResponseActionJSON  `json:"-"`
}

Actions pattern.

func (*RoutingRuleUpdateResponseAction) UnmarshalJSON 

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

type RoutingRuleUpdateResponseActionsType 

type RoutingRuleUpdateResponseActionsType string

Type of supported action. 

const (
	RoutingRuleUpdateResponseActionsTypeDrop    RoutingRuleUpdateResponseActionsType = "drop"
	RoutingRuleUpdateResponseActionsTypeForward RoutingRuleUpdateResponseActionsType = "forward"
	RoutingRuleUpdateResponseActionsTypeWorker  RoutingRuleUpdateResponseActionsType = "worker"
)

type RoutingRuleUpdateResponseEnabled 

type RoutingRuleUpdateResponseEnabled bool

Routing rule status. 

const (
	RoutingRuleUpdateResponseEnabledTrue  RoutingRuleUpdateResponseEnabled = true
	RoutingRuleUpdateResponseEnabledFalse RoutingRuleUpdateResponseEnabled = false
)

type RoutingRuleUpdateResponseEnvelope 

type RoutingRuleUpdateResponseEnvelope struct {
	Errors   []RoutingRuleUpdateResponseEnvelopeErrors   `json:"errors,required"`
	Messages []RoutingRuleUpdateResponseEnvelopeMessages `json:"messages,required"`
	Result   RoutingRuleUpdateResponse                   `json:"result,required"`
	// Whether the API call was successful
	Success RoutingRuleUpdateResponseEnvelopeSuccess `json:"success,required"`
	JSON    routingRuleUpdateResponseEnvelopeJSON    `json:"-"`
}

func (*RoutingRuleUpdateResponseEnvelope) UnmarshalJSON 

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

type RoutingRuleUpdateResponseEnvelopeErrors 

type RoutingRuleUpdateResponseEnvelopeErrors struct {
	Code    int64                                       `json:"code,required"`
	Message string                                      `json:"message,required"`
	JSON    routingRuleUpdateResponseEnvelopeErrorsJSON `json:"-"`
}

func (*RoutingRuleUpdateResponseEnvelopeErrors) UnmarshalJSON 

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

type RoutingRuleUpdateResponseEnvelopeMessages 

type RoutingRuleUpdateResponseEnvelopeMessages struct {
	Code    int64                                         `json:"code,required"`
	Message string                                        `json:"message,required"`
	JSON    routingRuleUpdateResponseEnvelopeMessagesJSON `json:"-"`
}

func (*RoutingRuleUpdateResponseEnvelopeMessages) UnmarshalJSON 

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

type RoutingRuleUpdateResponseEnvelopeSuccess 

type RoutingRuleUpdateResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	RoutingRuleUpdateResponseEnvelopeSuccessTrue RoutingRuleUpdateResponseEnvelopeSuccess = true
)

type RoutingRuleUpdateResponseMatcher 

type RoutingRuleUpdateResponseMatcher struct {
	// Field for type matcher.
	Field RoutingRuleUpdateResponseMatchersField `json:"field,required"`
	// Type of matcher.
	Type RoutingRuleUpdateResponseMatchersType `json:"type,required"`
	// Value for matcher.
	Value string                               `json:"value,required"`
	JSON  routingRuleUpdateResponseMatcherJSON `json:"-"`
}

Matching pattern to forward your actions.

func (*RoutingRuleUpdateResponseMatcher) UnmarshalJSON 

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

type RoutingRuleUpdateResponseMatchersField 

type RoutingRuleUpdateResponseMatchersField string

Field for type matcher. 

const (
	RoutingRuleUpdateResponseMatchersFieldTo RoutingRuleUpdateResponseMatchersField = "to"
)

type RoutingRuleUpdateResponseMatchersType 

type RoutingRuleUpdateResponseMatchersType string

Type of matcher. 

const (
	RoutingRuleUpdateResponseMatchersTypeLiteral RoutingRuleUpdateResponseMatchersType = "literal"
)

type RoutingService 

type RoutingService struct {
	Options   []option.RequestOption
	DNS       *RoutingDNSService
	Rules     *RoutingRuleService
	Addresses *RoutingAddressService
}

RoutingService 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 NewRoutingService method instead.

func NewRoutingService 

func NewRoutingService(opts ...option.RequestOption) (r *RoutingService)

NewRoutingService 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 (*RoutingService) Disable 

func (r *RoutingService) Disable(ctx context.Context, zoneIdentifier string, opts ...option.RequestOption) (res *RoutingDisableResponse, err error)

Disable your Email Routing zone. Also removes additional MX records previously required for Email Routing to work.

func (*RoutingService) Enable 

func (r *RoutingService) Enable(ctx context.Context, zoneIdentifier string, opts ...option.RequestOption) (res *RoutingEnableResponse, err error)

Enable you Email Routing zone. Add and lock the necessary MX and SPF records.

func (*RoutingService) Get 

func (r *RoutingService) Get(ctx context.Context, zoneIdentifier string, opts ...option.RequestOption) (res *RoutingGetResponse, err error)

Get information about the settings for your Email Routing zone.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.