Skip to content

Add DKIM/SPF configuration for CodexSuit email service#1107

Open
gcompanydev wants to merge 1 commit into
Domain-Connect:masterfrom
gcompanydev:master
Open

Add DKIM/SPF configuration for CodexSuit email service#1107
gcompanydev wants to merge 1 commit into
Domain-Connect:masterfrom
gcompanydev:master

Conversation

@gcompanydev
Copy link
Copy Markdown
Contributor

@gcompanydev gcompanydev commented May 18, 2026 •
edited
Loading

Description

New template for CodexSuit email marketing — configures DKIM (3 CNAME records), SPF (SPFM) and DMARC for domains using AWS SES via a relay on mail.codexsuit.com.

Type of change

  • 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

  • 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)

Online Editor test results

Editor test link(s):

Test codexsuit.com/emailDkim empresa.com/@
Test codexsuit.com/emailDkim codexsuit.com/@

@gcompanydev
Add DKIM/SPF configuration for CodexSuit email service
0be9a38 
This file configures DKIM, SPF, and DMARC records for email authentication through CodexSuit.
@github-actions github-actions Bot added the Test links missing No test links from Online Editor provided label May 18, 2026
@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 18, 2026

✅ JSON Filename Check Passed

@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 18, 2026

✅ JSON Schema Validation Passed

@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 18, 2026

Linter error

codexsuit.com.emaildkim.json

Level Code Note
error DCTL1022 invalid hostname

@gcompanydev
Copy link
Copy Markdown
Contributor Author

gcompanydev commented May 18, 2026

Description

New template for CodexSuit email marketing — configures DKIM (3 CNAME records), SPF (SPFM) and DMARC for domains using AWS SES via a relay on mail.codexsuit.com.

Type of change

  • 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

  • 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)

Online Editor test results

Editor test link(s):

Test codexsuit.com/emailDkim empresa.com/@
Test codexsuit.com/emailDkim codexsuit.com/@

@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 18, 2026

PR Description Check Failed

The PR description is missing required elements. Please update it according to the PR template.

Details 
  OK  Type of change: 1/4 checkboxes ticked
  OK  How Has This Been Tested?: all 3 checkboxes ticked
  OK  Checklist of common problems: 10/10 checkboxes ticked
  OK  Online Editor test results: 2 link(s) found

Labels to add: Test links missing
Labels to remove: Checklist of common problems not complete, Forged editor links, PR description incomplete

PR description check FAILED:
  FAIL  Template coverage: codexsuit.com.emaildkim.json: 2/2 test link(s) contain a template that does not match the file in this PR (tests may be out of date)

pawel-kow
pawel-kow requested changes May 19, 2026
View reviewed changes
Copy link
Copy Markdown
Member

@pawel-kow pawel-kow left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Template

Comment thread codexsuit.com.emaildkim.json
"description":"Configures DKIM, SPF and DMARC records to send authenticated emails through CodexSuit",
"variableDescription":"token1, token2, token3 are the DKIM selector names provided by CodexSuit",
"syncPubKeyDomain":"domainconnect.mail.codexsuit.com",
"syncRedirectDomain":"ev.codexsuit.com/mail/domains",
Copy link
Copy Markdown
Member

@pawel-kow pawel-kow May 19, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Only Domain name is allowed here

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

Reviewers

@pawel-kow pawel-kow pawel-kow requested changes

Requested changes must be addressed to merge this pull request.

Assignees

No one assigned

Labels

Test links missing No test links from Online Editor provided

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@gcompanydev @pawel-kow