Get email SPF validation summary

Deprecated

client.Radar.Email.Security.Summary.SPF(ctx, query) (*EmailSecuritySummarySPFResponse, error)

GET/radar/email/security/summary/spf

Retrieves the distribution of emails by SPF (Sender Policy Framework) validation.

Security

API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example:X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194

Accepted Permissions (at least one required)

User Details WriteUser Details Read

ParametersExpand Collapse

query EmailSecuritySummarySPFParams

ARC param.Field[[]EmailSecuritySummarySPFParamsARC]optional

Filters results by ARC (Authenticated Received Chain) validation.

const EmailSecuritySummarySPFParamsARCPass EmailSecuritySummarySPFParamsARC = "PASS"

const EmailSecuritySummarySPFParamsARCNone EmailSecuritySummarySPFParamsARC = "NONE"

const EmailSecuritySummarySPFParamsARCFail EmailSecuritySummarySPFParamsARC = "FAIL"

DateEnd param.Field[[]Time]optional

End of the date range (inclusive).

DateRange param.Field[[]string]optional

Filters results by date range. For example, use 7d and 7dcontrol to compare this week with the previous week. Use this parameter or set specific start and end dates (dateStart and dateEnd parameters).

DateStart param.Field[[]Time]optional

Start of the date range.

DKIM param.Field[[]EmailSecuritySummarySPFParamsDKIM]optional

Filters results by DKIM (DomainKeys Identified Mail) validation status.

const EmailSecuritySummarySPFParamsDKIMPass EmailSecuritySummarySPFParamsDKIM = "PASS"

const EmailSecuritySummarySPFParamsDKIMNone EmailSecuritySummarySPFParamsDKIM = "NONE"

const EmailSecuritySummarySPFParamsDKIMFail EmailSecuritySummarySPFParamsDKIM = "FAIL"

DMARC param.Field[[]EmailSecuritySummarySPFParamsDMARC]optional

Filters results by DMARC (Domain-based Message Authentication, Reporting and Conformance) validation status.

const EmailSecuritySummarySPFParamsDMARCPass EmailSecuritySummarySPFParamsDMARC = "PASS"

const EmailSecuritySummarySPFParamsDMARCNone EmailSecuritySummarySPFParamsDMARC = "NONE"

const EmailSecuritySummarySPFParamsDMARCFail EmailSecuritySummarySPFParamsDMARC = "FAIL"

Format param.Field[EmailSecuritySummarySPFParamsFormat]optional

Format in which results will be returned.

const EmailSecuritySummarySPFParamsFormatJson EmailSecuritySummarySPFParamsFormat = "JSON"

const EmailSecuritySummarySPFParamsFormatCsv EmailSecuritySummarySPFParamsFormat = "CSV"

Name param.Field[[]string]optional

Array of names used to label the series in the response.

TLSVersion param.Field[[]EmailSecuritySummarySPFParamsTLSVersion]optional

Filters results by TLS version.

const EmailSecuritySummarySPFParamsTLSVersionTlSv1_0 EmailSecuritySummarySPFParamsTLSVersion = "TLSv1_0"

const EmailSecuritySummarySPFParamsTLSVersionTlSv1_1 EmailSecuritySummarySPFParamsTLSVersion = "TLSv1_1"

const EmailSecuritySummarySPFParamsTLSVersionTlSv1_2 EmailSecuritySummarySPFParamsTLSVersion = "TLSv1_2"

const EmailSecuritySummarySPFParamsTLSVersionTlSv1_3 EmailSecuritySummarySPFParamsTLSVersion = "TLSv1_3"

ReturnsExpand Collapse

type EmailSecuritySummarySPFResponse struct{…}

Meta EmailSecuritySummarySPFResponseMeta

Metadata for the results.

ConfidenceInfo EmailSecuritySummarySPFResponseMetaConfidenceInfo

Annotations []EmailSecuritySummarySPFResponseMetaConfidenceInfoAnnotation

DataSource EmailSecuritySummarySPFResponseMetaConfidenceInfoAnnotationsDataSource

Data source for annotations.

One of the following:

const EmailSecuritySummarySPFResponseMetaConfidenceInfoAnnotationsDataSourceAll EmailSecuritySummarySPFResponseMetaConfidenceInfoAnnotationsDataSource = "ALL"

const EmailSecuritySummarySPFResponseMetaConfidenceInfoAnnotationsDataSourceAIBots EmailSecuritySummarySPFResponseMetaConfidenceInfoAnnotationsDataSource = "AI_BOTS"

const EmailSecuritySummarySPFResponseMetaConfidenceInfoAnnotationsDataSourceAIGateway EmailSecuritySummarySPFResponseMetaConfidenceInfoAnnotationsDataSource = "AI_GATEWAY"

const EmailSecuritySummarySPFResponseMetaConfidenceInfoAnnotationsDataSourceBGP EmailSecuritySummarySPFResponseMetaConfidenceInfoAnnotationsDataSource = "BGP"

const EmailSecuritySummarySPFResponseMetaConfidenceInfoAnnotationsDataSourceBots EmailSecuritySummarySPFResponseMetaConfidenceInfoAnnotationsDataSource = "BOTS"

const EmailSecuritySummarySPFResponseMetaConfidenceInfoAnnotationsDataSourceConnectionAnomaly EmailSecuritySummarySPFResponseMetaConfidenceInfoAnnotationsDataSource = "CONNECTION_ANOMALY"

const EmailSecuritySummarySPFResponseMetaConfidenceInfoAnnotationsDataSourceCT EmailSecuritySummarySPFResponseMetaConfidenceInfoAnnotationsDataSource = "CT"

const EmailSecuritySummarySPFResponseMetaConfidenceInfoAnnotationsDataSourceDNS EmailSecuritySummarySPFResponseMetaConfidenceInfoAnnotationsDataSource = "DNS"

const EmailSecuritySummarySPFResponseMetaConfidenceInfoAnnotationsDataSourceDNSMagnitude EmailSecuritySummarySPFResponseMetaConfidenceInfoAnnotationsDataSource = "DNS_MAGNITUDE"

const EmailSecuritySummarySPFResponseMetaConfidenceInfoAnnotationsDataSourceDNSAS112 EmailSecuritySummarySPFResponseMetaConfidenceInfoAnnotationsDataSource = "DNS_AS112"

const EmailSecuritySummarySPFResponseMetaConfidenceInfoAnnotationsDataSourceDos EmailSecuritySummarySPFResponseMetaConfidenceInfoAnnotationsDataSource = "DOS"

const EmailSecuritySummarySPFResponseMetaConfidenceInfoAnnotationsDataSourceEmailRouting EmailSecuritySummarySPFResponseMetaConfidenceInfoAnnotationsDataSource = "EMAIL_ROUTING"

const EmailSecuritySummarySPFResponseMetaConfidenceInfoAnnotationsDataSourceEmailSecurity EmailSecuritySummarySPFResponseMetaConfidenceInfoAnnotationsDataSource = "EMAIL_SECURITY"

const EmailSecuritySummarySPFResponseMetaConfidenceInfoAnnotationsDataSourceFw EmailSecuritySummarySPFResponseMetaConfidenceInfoAnnotationsDataSource = "FW"

const EmailSecuritySummarySPFResponseMetaConfidenceInfoAnnotationsDataSourceFwPg EmailSecuritySummarySPFResponseMetaConfidenceInfoAnnotationsDataSource = "FW_PG"

const EmailSecuritySummarySPFResponseMetaConfidenceInfoAnnotationsDataSourceHTTP EmailSecuritySummarySPFResponseMetaConfidenceInfoAnnotationsDataSource = "HTTP"

const EmailSecuritySummarySPFResponseMetaConfidenceInfoAnnotationsDataSourceHTTPControl EmailSecuritySummarySPFResponseMetaConfidenceInfoAnnotationsDataSource = "HTTP_CONTROL"

const EmailSecuritySummarySPFResponseMetaConfidenceInfoAnnotationsDataSourceHTTPCrawlerReferer EmailSecuritySummarySPFResponseMetaConfidenceInfoAnnotationsDataSource = "HTTP_CRAWLER_REFERER"

const EmailSecuritySummarySPFResponseMetaConfidenceInfoAnnotationsDataSourceHTTPOrigins EmailSecuritySummarySPFResponseMetaConfidenceInfoAnnotationsDataSource = "HTTP_ORIGINS"

const EmailSecuritySummarySPFResponseMetaConfidenceInfoAnnotationsDataSourceIQI EmailSecuritySummarySPFResponseMetaConfidenceInfoAnnotationsDataSource = "IQI"

const EmailSecuritySummarySPFResponseMetaConfidenceInfoAnnotationsDataSourceLeakedCredentials EmailSecuritySummarySPFResponseMetaConfidenceInfoAnnotationsDataSource = "LEAKED_CREDENTIALS"

const EmailSecuritySummarySPFResponseMetaConfidenceInfoAnnotationsDataSourceNet EmailSecuritySummarySPFResponseMetaConfidenceInfoAnnotationsDataSource = "NET"

const EmailSecuritySummarySPFResponseMetaConfidenceInfoAnnotationsDataSourceRobotsTXT EmailSecuritySummarySPFResponseMetaConfidenceInfoAnnotationsDataSource = "ROBOTS_TXT"

const EmailSecuritySummarySPFResponseMetaConfidenceInfoAnnotationsDataSourceSpeed EmailSecuritySummarySPFResponseMetaConfidenceInfoAnnotationsDataSource = "SPEED"

const EmailSecuritySummarySPFResponseMetaConfidenceInfoAnnotationsDataSourceWorkersAI EmailSecuritySummarySPFResponseMetaConfidenceInfoAnnotationsDataSource = "WORKERS_AI"

Description string

EndDate Time

formatdate-time

EventType EmailSecuritySummarySPFResponseMetaConfidenceInfoAnnotationsEventType

Event type for annotations.

One of the following:

const EmailSecuritySummarySPFResponseMetaConfidenceInfoAnnotationsEventTypeEvent EmailSecuritySummarySPFResponseMetaConfidenceInfoAnnotationsEventType = "EVENT"

const EmailSecuritySummarySPFResponseMetaConfidenceInfoAnnotationsEventTypeGeneral EmailSecuritySummarySPFResponseMetaConfidenceInfoAnnotationsEventType = "GENERAL"

const EmailSecuritySummarySPFResponseMetaConfidenceInfoAnnotationsEventTypeOutage EmailSecuritySummarySPFResponseMetaConfidenceInfoAnnotationsEventType = "OUTAGE"

const EmailSecuritySummarySPFResponseMetaConfidenceInfoAnnotationsEventTypePartialProjection EmailSecuritySummarySPFResponseMetaConfidenceInfoAnnotationsEventType = "PARTIAL_PROJECTION"

const EmailSecuritySummarySPFResponseMetaConfidenceInfoAnnotationsEventTypePipeline EmailSecuritySummarySPFResponseMetaConfidenceInfoAnnotationsEventType = "PIPELINE"

const EmailSecuritySummarySPFResponseMetaConfidenceInfoAnnotationsEventTypeTrafficAnomaly EmailSecuritySummarySPFResponseMetaConfidenceInfoAnnotationsEventType = "TRAFFIC_ANOMALY"

IsInstantaneous bool

Whether event is a single point in time or a time range.

LinkedURL string

formaturi

StartDate Time

formatdate-time

Level int64

Provides an indication of how much confidence Cloudflare has in the data.

DateRange []EmailSecuritySummarySPFResponseMetaDateRange

EndTime Time

Adjusted end of date range.

formatdate-time

StartTime Time

Adjusted start of date range.

formatdate-time

LastUpdated Time

Timestamp of the last dataset update.

formatdate-time

Normalization EmailSecuritySummarySPFResponseMetaNormalization

Normalization method applied to the results. Refer to Normalization methods.

One of the following:

const EmailSecuritySummarySPFResponseMetaNormalizationPercentage EmailSecuritySummarySPFResponseMetaNormalization = "PERCENTAGE"

const EmailSecuritySummarySPFResponseMetaNormalizationMin0Max EmailSecuritySummarySPFResponseMetaNormalization = "MIN0_MAX"

const EmailSecuritySummarySPFResponseMetaNormalizationMinMax EmailSecuritySummarySPFResponseMetaNormalization = "MIN_MAX"

const EmailSecuritySummarySPFResponseMetaNormalizationRawValues EmailSecuritySummarySPFResponseMetaNormalization = "RAW_VALUES"

const EmailSecuritySummarySPFResponseMetaNormalizationPercentageChange EmailSecuritySummarySPFResponseMetaNormalization = "PERCENTAGE_CHANGE"

const EmailSecuritySummarySPFResponseMetaNormalizationRollingAverage EmailSecuritySummarySPFResponseMetaNormalization = "ROLLING_AVERAGE"

const EmailSecuritySummarySPFResponseMetaNormalizationOverlappedPercentage EmailSecuritySummarySPFResponseMetaNormalization = "OVERLAPPED_PERCENTAGE"

const EmailSecuritySummarySPFResponseMetaNormalizationRatio EmailSecuritySummarySPFResponseMetaNormalization = "RATIO"

Units []EmailSecuritySummarySPFResponseMetaUnit

Measurement units for the results.

Name string

Value string

Summary0 RadarEmailSummary

Fail string

A numeric string.

None string

A numeric string.

Pass string

A numeric string.

Get email SPF validation summary

package main

import (
  "context"
  "fmt"

  "github.com/cloudflare/cloudflare-go"
  "github.com/cloudflare/cloudflare-go/option"
  "github.com/cloudflare/cloudflare-go/radar"
)

func main() {
  client := cloudflare.NewClient(
    option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
  )
  response, err := client.Radar.Email.Security.Summary.SPF(context.TODO(), radar.EmailSecuritySummarySPFParams{

  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", response.Meta)
}

{
  "result": {
    "meta": {
      "confidenceInfo": {
        "annotations": [
          {
            "dataSource": "ALL",
            "description": "Cable cut in Tonga",
            "endDate": "2019-12-27T18:11:19.117Z",
            "eventType": "EVENT",
            "isInstantaneous": true,
            "linkedUrl": "https://example.com",
            "startDate": "2019-12-27T18:11:19.117Z"
          }
        ],
        "level": 0
      },
      "dateRange": [
        {
          "endTime": "2022-09-17T10:22:57.555Z",
          "startTime": "2022-09-16T10:22:57.555Z"
        }
      ],
      "lastUpdated": "2019-12-27T18:11:19.117Z",
      "normalization": "PERCENTAGE",
      "units": [
        {
          "name": "*",
          "value": "requests"
        }
      ]
    },
    "summary_0": {
      "FAIL": "10",
      "NONE": "10",
      "PASS": "10"
    }
  },
  "success": true
}

Returns Examples

{
  "result": {
    "meta": {
      "confidenceInfo": {
        "annotations": [
          {
            "dataSource": "ALL",
            "description": "Cable cut in Tonga",
            "endDate": "2019-12-27T18:11:19.117Z",
            "eventType": "EVENT",
            "isInstantaneous": true,
            "linkedUrl": "https://example.com",
            "startDate": "2019-12-27T18:11:19.117Z"
          }
        ],
        "level": 0
      },
      "dateRange": [
        {
          "endTime": "2022-09-17T10:22:57.555Z",
          "startTime": "2022-09-16T10:22:57.555Z"
        }
      ],
      "lastUpdated": "2019-12-27T18:11:19.117Z",
      "normalization": "PERCENTAGE",
      "units": [
        {
          "name": "*",
          "value": "requests"
        }
      ]
    },
    "summary_0": {
      "FAIL": "10",
      "NONE": "10",
      "PASS": "10"
    }
  },
  "success": true
}