Skip to content

Update xstate.io mail template to v2 (DMARC in its own group) - #3157

Open
agentfront-me wants to merge 1 commit into
Domain-Connect:masterfrom
agentfront-me:xstate-mail-v2
Open

agentfront-me wants to merge 1 commit into
Domain-Connect:masterfrom
agentfront-me:xstate-mail-v2

Conversation

@agentfront-me

Copy link
Copy Markdown
Contributor

Description

Version 2 of the xstate mail template (xstate.io/mail), already onboarded at Cloudflare.

  • Records are now in two groups: mail (MX, SPFM, the three SES DKIM CNAMEs) and dmarc (the DMARC TXT). We
    apply dmarc only when the domain has no DMARC record yet. Cloudflare doesn't support txtConflictMatchingMode,
    so without groups an existing DMARC record would get a second one next to it, and receivers treat two as no
    policy. Cloudflare honours groupId.
  • essential removed from the DMARC record: with the group the owner's existing record is kept anyway.
  • go.xstate.com added to syncRedirectDomain: our app moved there, and it is where the flow now returns.

Unchanged: syncPubKeyDomain xstate.io, key _dck1, the variables dkim1..dkim3 (each only inside a fixed
pattern: host %dkimN%._domainkey, target %dkimN%.dkim.amazonses.com), and the logo.

Type of change

Please mark options that are relevant.

  • New template
  • Bug fix (non-breaking change which fixes an issue in the template)
  • New feature (non-breaking change which adds functionality to the template)
  • Breaking change (fix or feature that would cause existing template behavior to be not backward compatible)

How Has This Been Tested?

Please mark the following checks done

  • Template functionality checked using Online Editor
  • Template file name follows the pattern <providerId>.<serviceId>.json
  • resource URL provided with logoUrl is actually served by a webserver

Checklist of common problems

Mark all the checkboxes after conducting the check. Comment on any point which is not fulfilled.
See Template Quality Guidelines for details and rationale on each rule.

  • syncPubKeyDomain is set — this is mandatory; omitting it requires explicit justification in the PR description or the PR will be rejected
  • warnPhishing is not set alongside syncPubKeyDomain — the two must not appear together
  • syncRedirectDomain is set whenever the template uses redirect_uri in the synchronous flow
  • no TXT record contains SPF content ("v=spf1 ...") — use the SPFM record type instead
  • txtConflictMatchingMode is set on every TXT record that must be unique per label or content prefix (e.g. DMARC)
  • no variable is used as a bare full record value (e.g. @ TXT "%foo%") unless necessary — prefer @ TXT "service-foo=%foo%"; if bare, justify in the PR description
  • no bare variable is used as the full host label — the non-variable parts are fixed to limit misuse (e.g. %dkimkey%._domainkey, not %dkimhost%); if bare, justify in the PR description
  • no variable is used in the host field to create a subdomain — use the host parameter or multiInstance instead
  • %host% does not appear explicitly in any host attribute
  • essential is set to OnApply on records the end user may need to modify or remove without breaking the template (e.g. DMARC): not set. DMARC is in its own group, which we leave out when the domain already has one, so the owner's record is never replaced; Cloudflare doesn't support essential (linter DCTL5011).

Online Editor test results

Editor test link(s):

🤖 Generated with Claude Code

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@github-actions

Copy link
Copy Markdown

✅ JSON Filename Check Passed

@github-actions

Copy link
Copy Markdown

✅ JSON Schema Validation Passed

@github-actions

Copy link
Copy Markdown

PR Description Check Passed

All required sections are filled in correctly.

Details
  OK  Type of change: 2/4 checkboxes ticked
  OK  How Has This Been Tested?: all 3 checkboxes ticked
  OK  Checklist of common problems: 9/10 checkboxes ticked
  OK  Online Editor test results: 3 link(s) found
  OK  Template coverage: all 1 template(s) covered
Labels to remove: Checklist of common problems not complete, Forged editor links, PR description incomplete, Test links missing

PR description check PASSED

@github-actions

Copy link
Copy Markdown

Linter OK

xstate.io.mail.json

Level Code Note

@github-actions github-actions Bot added the automerge-possible Label indicating, that restrictive linter checks all pass. For now it's PoC. label Nov 17, 2026

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

automerge-possible Label indicating, that restrictive linter checks all pass. For now it's PoC.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants