Skip to content

Commit a846064

Browse files
committed
Mention Punycode in the README
1 parent 7a19c33 commit a846064

File tree

1 file changed

+12
-11
lines changed

1 file changed

+12
-11
lines changed

README.md

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -141,8 +141,8 @@ internationalization.
141141

142142
The first is [internationalized domain names (RFC
143143
5891)](https://tools.ietf.org/html/rfc5891), a.k.a IDNA 2008. The DNS
144-
system has not been updated with Unicode support. Instead,
145-
internationalized domain names are converted into a special IDNA ASCII
144+
system has not been updated with Unicode support. Instead, internationalized
145+
domain names are converted into a special IDNA ASCII "[Punycode](https://www.rfc-editor.org/rfc/rfc3492.txt)"
146146
form starting with `xn--`. When an email address has non-ASCII
147147
characters in its domain part, the domain part is replaced with its IDNA
148148
ASCII equivalent form in the process of mail transmission. Your mail
@@ -279,7 +279,7 @@ Note that `smtputf8` is `False` even though the domain part is
279279
internationalized because
280280
[SMTPUTF8](https://tools.ietf.org/html/rfc6531) is only needed if the
281281
local part of the address is internationalized (the domain part can be
282-
converted to IDNA ASCII). Also note that the `email` and `domain`
282+
converted to IDNA ASCII Punycode). Also note that the `email` and `domain`
283283
fields provide a normalized form of the email address and domain name
284284
(casefolding and Unicode normalization as required by IDNA 2008).
285285

@@ -314,7 +314,8 @@ are:
314314
fields (see below).
315315

316316
`ascii_email`: If set, an ASCII-only form of the email address by replacing the
317-
domain part with [IDNA ASCII](https://tools.ietf.org/html/rfc5891).
317+
domain part with [IDNA](https://tools.ietf.org/html/rfc5891)
318+
[Punycode](https://www.rfc-editor.org/rfc/rfc3492.txt).
318319
This field will be present when an ASCII-only form of the email
319320
address exists (including if the email address is already ASCII). If
320321
the local part of the email address contains internationalized
@@ -326,16 +327,16 @@ are:
326327

327328
`ascii_local_part`: If set, the local part, which is composed of ASCII characters only.
328329

329-
`domain`: The canonical internationalized form of the domain part of the
330-
address, by round-tripping through IDNA ASCII. If the returned
331-
string contains non-ASCII characters, either the
330+
`domain`: The canonical internationalized Unicode form of the domain part of the
331+
email address. If the returned string contains non-ASCII characters, either the
332332
[SMTPUTF8](https://tools.ietf.org/html/rfc6531) feature of your
333333
mail relay will be required to transmit the message or else the
334-
email address's domain part must be converted to IDNA ASCII first
335-
(given in the returned `domain` field).
334+
email address's domain part must be converted to IDNA ASCII first: Use
335+
`ascii_domain` field instead.
336336

337-
`ascii_domain`: The [IDNA ASCII](https://tools.ietf.org/html/rfc5891)-encoded form
338-
of the domain part of the given email address (after the @-sign), as
337+
`ascii_domain`: The [IDNA](https://tools.ietf.org/html/rfc5891)
338+
[Punycode](https://www.rfc-editor.org/rfc/rfc3492.txt)-encoded
339+
form of the domain part of the given email address, as
339340
it would be transmitted on the wire.
340341

341342
`smtputf8`: A boolean indicating that the

0 commit comments

Comments
 (0)