Skip to Content

The DnsRecord type of the TypeScript SDK, part of DnsRecordCheck.

type DnsRecord = {
  accept?: string[]
  kind: ('ownership' | 'mx' | 'spf' | 'dkim' | 'dmarc' | 'jmap' | 'dav')
  name: string
  port?: number
  priority?: number
  purpose: string
  required: boolean
  type: ('MX' | 'TXT' | 'CNAME' | 'SRV')
  value: string
  weight?: number
}

Fields

FieldTypeDescription
acceptstring[]Optional. Alternative accepted DNS record values
kind('ownership' | 'mx' | 'spf' | 'dkim' | 'dmarc' | 'jmap' | 'dav')Record category
namestringFully-qualified DNS record host to create
portnumberOptional. SRV record target port (RFC 2782)
prioritynumberOptional. MX preference or SRV priority
purposestringHuman-readable explanation of why this DNS record is required
requiredbooleanTrue if this record is required for normal mail delivery
type('MX' | 'TXT' | 'CNAME' | 'SRV')DNS record type
valuestringExpected DNS record target value
weightnumberOptional. SRV record weight (RFC 2782)

Used in

DnsRecordCheck.

On this page