Domain

Sending and receiving domains with DNS verification records.

Source: packages/db/src/schema/domain.ts

Enums

EnumValues
domain_statuspending, verifying, active, suspended, failed
dns_record_typeA, AAAA, CNAME, MX, TXT
dns_record_type_nameMX, SPF, DKIM, DMARC, CNAME
dns_record_purposesending, receiving, tracking
tls_modeopportunistic, enforced

domain

ColumnTypeNotes
idtextPK, prefix domain_
domainvarchar(255)NOT NULL
organization_idtextFK → organization.id, CASCADE
user_idtextFK → user.id, CASCADE
statusdomain_statusdefault pending
user_verified_domainbooleandefault false
system_verifiedbooleandefault false
custom_return_pathvarchar(255)default inbound
tracking_subdomainvarchar(255)default tracking
is_click_tracking_enabledbooleandefault false
is_open_tracking_enabledbooleandefault false
tlstls_modedefault opportunistic
is_tracking_domainbooleandefault false
is_sending_email_enabledbooleandefault true
is_receiving_email_enabledbooleandefault true
verification_failed_reasontext
deleted_attimestampsoft delete
last_verified_attimestamp
created_attimestamp
updated_attimestamp

Unique: (organization_id, domain)

domain_dns_record

ColumnTypeNotes
idtextPK, prefix dns_
domain_idtextFK → domain.id, CASCADE
organization_idtextFK → organization.id, CASCADE
user_idtextFK → user.id, CASCADE
record_typedns_record_typeNOT NULL
nametextNOT NULL
statusdomain_statusdefault pending
valuetextNOT NULL
ttltextdefault Auto
priorityinteger
record_type_namedns_record_type_nameNOT NULL
purposedns_record_purposedefault sending
domaintextNOT NULL
fqdntextNOT NULL
private_keytextDKIM private key
verification_errortext
deleted_attimestamp
created_attimestamp
updated_attimestamp

Unique: (domain_id, record_type, name, value)

Was this page helpful?

Edit this page