Add inbox-works.com mail template#1419
Open
masanori-iwata wants to merge 5 commits into
Open
Conversation
|
✅ JSON Filename Check Passed |
|
✅ JSON Schema Validation Passed |
Linter OK
|
| Level | Code | Note |
|---|
Template Quality Guideline 5: the DKIM TXT record must be unique per label, so an apply must replace any pre-existing TXT at that selector (e.g. a key the customer had added manually) instead of leaving a duplicate that breaks DKIM verification.
dc-template-linter --merge-or-fail rejected the previous %spfDomain% variable in host: (DCTL1040, bare variable in host), and Template Quality Guidelines 7/8 forbid it. The label is a constant of the sending infrastructure (Amazon SES custom MAIL FROM subdomain), so it belongs in the template rather than in a request parameter.
PR Description Check PassedAll required sections are filled in correctly. Details |
Author
|
Status update — this PR is ready from my side, and the automation is green on
The last step of (run: https://github.com/Domain-Connect/Templates/actions/runs/29728948211) So the PR was never added to the merge queue. That looks like a workflow-token / branch-protection setting rather than anything I can fix from the PR side. Could a maintainer merge it manually, or adjust the permissions? For context: Cloudflare have verified our public key and logo, and told us they will only start onboarding once this PR is merged. Thanks for the review! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Adds the mail template for Inbox Works (https://inbox-works.com), a shared-inbox product for small teams in Japan.
inbox-works.com/ serviceId:mailSPFMmerge) + return-path MX + DKIM TXT. Records point to the sending infrastructure (Amazon SES / Resend) that delivers our customers' mail.inbox-works.com(signing public key published at_dcpubkeyv1.inbox-works.com, RS256 — verified withdc-debug-pubkey)app.inbox-works.com_dmarcpolicy must never be overwritten by a template apply.dc-template-linter --merge-or-failpasses (exit 0), logo reachability check included.Type of change
How Has This Been Tested?
Please mark the following checks done
<providerId>.<serviceId>.jsonlogoUrlis actually served by a webserver (https://app.inbox-works.com/brand/inbox-works-logo.svg→ HTTP 200,image/svg+xml)Checklist of common problems
syncPubKeyDomainis set — this is mandatory; omitting it requires explicit justification in the PR description or the PR will be rejectedwarnPhishingis not set alongsidesyncPubKeyDomain— the two must not appear togethersyncRedirectDomainis set whenever the template usesredirect_uriin the synchronous flow"v=spf1 ...") — use theSPFMrecord type insteadtxtConflictMatchingModeis set on every TXT record that must be unique per label or content prefix (e.g. DMARC)@ TXT "%foo%") unless necessary — prefer@ TXT "service-foo=%foo%"; if bare, justify in the PR descriptionhostlabel — the non-variable parts are fixed to limit misuse (e.g.%dkimkey%._domainkey, not%dkimhost%); if bare, justify in the PR descriptionhostfield to create a subdomain — use thehostparameter ormultiInstanceinstead%host%does not appear explicitly in anyhostattributeessentialis set toOnApplyon records the end user may need to modify or remove without breaking the template (e.g. DMARC)Notes:
send(the Amazon SES custom MAIL FROM / return-path subdomain of the sending domain), not a variable — rules 7 and 8 hold. Our service verifies that the live sending records really use that label before it offers the one-click apply at all; if they ever differ, we fall back to manual setup rather than write a record the template cannot express.%region%insidefeedback-smtp.%region%.amazonses.com, and%domainKey%insidep=%domainKey%on the DKIM TXT.essential: OnApply: the template writes no policy record the end user is expected to edit (that is why DMARC is deliberately left out).Online Editor test results
Editor test link(s):
example.com, no host): Test inbox-works.com/mail example.com/@example.com,host=mail): Test inbox-works.com/mail example.com/mail