Skip to content

Update email schema to use format-assertion #100

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jviotti merged 1 commit into from
Jul 27, 2026
Merged

Update email schema to use format-assertion #100

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 5 additions & 45 deletions schemas/2020-12/ietf/email/address.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,56 +1,16 @@
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "RFC 5322 Email Address (Addr-Spec)",
"$schema": "urn:sourcemeta:std:ietf:jsonschema:2020-12:dialect:format-assertion",
"title": "RFC 5321 Email Address (Addr-Spec)",

@augmentcode augmentcode Bot Jul 27, 2026 •
edited
Loading

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

The title references RFC 5321 but also calls the syntax “Addr-Spec”, which is RFC 5322 terminology (RFC 5321 §4.1.2 describes a Mailbox/Local-part@Domain). Consider aligning the title/link/terminology to a single RFC to avoid misleading consumers about the intended grammar.

Severity: low

Fix This in Augment

🤖 Was this useful? React with 👍 or 👎, or 🚀 if it prevented an incident/outage.

"description": "A specific Internet identifier that represents an e-mail box to which messages are delivered",
"examples": [
"simple@example.com",
"first.last@sub.example.com",
"\"very.unusual.@.unusual.com\"@example.com",
"user@[IPv6:2001:db8::1]",
"(comment)john.smith@(comment)example.com(comment)",
"jo(comment)hn@example.com",
"user@[abc.def]"
"user@[IPv6:2001:db8::1]"
],
"x-license": "https://github.com/sourcemeta/std/blob/main/LICENSE",
"x-links": [ "https://www.rfc-editor.org/rfc/rfc5322#section-3.4.1" ],
"x-links": [ "https://www.rfc-editor.org/rfc/rfc5321#section-4.1.2" ],
"type": "string",
"anyOf": [
{
"$comment": "Unquoted (dot-atom) local-part with dot-atom domain — both allow inline single-level comments",
"pattern": "^(?:(?:[ \\t]|\\((?:[^()\\\\]|\\\\.)*\\))*)(?:[A-Za-z0-9!#$%&'*+\\/=?^_`{|}~-]+(?:(?:[ \\t]*\\((?:[^()\\\\]|\\\\.)*\\)[ \\t]*[A-Za-z0-9!#$%&'*+\\/=?^_`{|}~-]+)|(?:\\.[A-Za-z0-9!#$%&'*+\\/=?^_`{|}~-]+))*)(?:[ \\t]|\\((?:[^()\\\\]|\\\\.)*\\))*@(?:(?:[ \\t]|\\((?:[^()\\\\]|\\\\.)*\\))*(?:[A-Za-z0-9](?:[A-Za-z0-9-]{0,61}[A-Za-z0-9])?))(?:((?:[ \\t]|\\((?:[^()\\\\]|\\\\.)*\\))*\\.(?:[ \\t]|\\((?:[^()\\\\]|\\\\.)*\\))*(?:[A-Za-z0-9](?:[A-Za-z0-9-]{0,61}[A-Za-z0-9])?)))*(?:[ \\t]|\\((?:[^()\\\\]|\\\\.)*\\))*$"
},
{
"$comment": "Quoted local-part (with escapes) + dot-atom domain. Comments allowed around the quoted string and around domain labels",
"pattern": "^(?:[ \\t]|\\((?:[^()\\\\]|\\\\.)*\\))*(?:\"(?:[^\"\\\\\\r]|\\\\.)*\")(?:[ \\t]|\\((?:[^()\\\\]|\\\\.)*\\))*@(?:(?:[ \\t]|\\((?:[^()\\\\]|\\\\.)*\\))*(?:[A-Za-z0-9](?:[A-Za-z0-9-]{0,61}[A-Za-z0-9])?))(?:((?:[ \\t]|\\((?:[^()\\\\]|\\\\.)*\\))*\\.(?:[ \\t]|\\((?:[^()\\\\]|\\\\.)*\\))*(?:[A-Za-z0-9](?:[A-Za-z0-9-]{0,61}[A-Za-z0-9])?)))*(?:[ \\t]|\\((?:[^()\\\\]|\\\\.)*\\))*$"
},
{
"$comment": "Unquoted local-part + domain-literal (arbitrary dtext / quoted-pairs inside brackets). Comments allowed around tokens",
"pattern": "^(?:(?:[ \\t]|\\((?:[^()\\\\]|\\\\.)*\\))*)(?:[A-Za-z0-9!#$%&'*+\\/=?^_`{|}~-]+(?:(?:[ \\t]*\\((?:[^()\\\\]|\\\\.)*\\)[ \\t]*[A-Za-z0-9!#$%&'*+\\/=?^_`{|}~-]+)|(?:\\.[A-Za-z0-9!#$%&'*+\\/=?^_`{|}~-]+))*)(?:[ \\t]|\\((?:[^()\\\\]|\\\\.)*\\))*@(?:[ \\t]|\\((?:[^()\\\\]|\\\\.)*\\))*\\[(?:[^\\[\\]\\\\\\r]|\\\\.)*\\](?:[ \\t]|\\((?:[^()\\\\]|\\\\.)*\\))*$"
},
{
"$comment": "Quoted local-part + domain-literal. Comments allowed around quoted local and around the literal",
"pattern": "^(?:[ \\t]|\\((?:[^()\\\\]|\\\\.)*\\))*(?:\"(?:[^\"\\\\\\r]|\\\\.)*\")(?:[ \\t]|\\((?:[^()\\\\]|\\\\.)*\\))*@(?:[ \\t]|\\((?:[^()\\\\]|\\\\.)*\\))*\\[(?:[^\\[\\]\\\\\\r]|\\\\.)*\\](?:[ \\t]|\\((?:[^()\\\\]|\\\\.)*\\))*$"
}
],
"not": {
"anyOf": [
{
"$comment": "Disallow bare IPv4 address in domain (must be bracketed)",
"pattern": "@([0-9]{1,3}\\.){3}[0-9]{1,3}(?:$|\\s)"
},
{
"$comment": "Disallow IPv6 literal without brackets",
"pattern": "@IPv6:"
},
{
"$comment": "Disallow numeric-only final label (numeric TLDs like example.123)",
"pattern": "@[^@\\s]*\\.\\d+(?:$|\\s)"
},
{
"$comment": "Reject addresses that start with a single-quote delimiter",
"pattern": "^'"
}
]
},
"format": "email",
"minLength": 1
}
20 changes: 10 additions & 10 deletions test/ietf/email/address.test.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@
{
"description": "Comments around local, domain, and address",
"data": "(comment)john.smith@(comment)example.com(comment)",
"valid": true
"valid": false
},
{
"description": "Quoted local-part with space and letters",
Expand All @@ -139,7 +139,7 @@
{
"description": "Domain literal with letters and dot",
"data": "user@[abc.def]",
"valid": true
"valid": false
},
{
"description": "All uppercase local and domain",
Expand Down Expand Up @@ -169,12 +169,12 @@
{
"description": "Email with comment in domain",
"data": "john.smith@(comment)example.com",
"valid": true
"valid": false
},
{
"description": "Email with comment in local part",
"data": "jo(comment)hn@example.com",
"valid": true
"valid": false
},
{
"description": "Complex quoted local-part with many allowed symbols",
Expand Down Expand Up @@ -249,7 +249,7 @@
{
"description": "Numeric TLD in domain",
"data": "user@example.123",
"valid": false
"valid": true
},
{
"description": "Multiple @ symbols",
Expand Down Expand Up @@ -327,24 +327,24 @@
"valid": false
},
{
"description": "Uppercase numeric TLD (invalid as TLD numeric only)",
"description": "Uppercase numeric TLD",
"data": "user@EXAMPLE.123",
"valid": false
"valid": true
},
{
"description": "IP address without brackets in domain",
"data": "user@123.123.123.123",
"valid": false
"valid": true
},
{
"description": "IPv6 address without brackets",
"data": "user@IPv6:2001:db8::1",
"valid": false
},
{
"description": "Single quote used as delimiter (invalid)",
"description": "Single quote in local part",
"data": "'test'@example.com",
"valid": false
"valid": true
},
{
"description": "Double quotes misplacement",
Expand Down
Loading