@bumail/smtp 0.10.0 → 0.11.1

package/docs/roadmap.md

@@ -20,8 +20,7 @@ Nothing is under way besides what is marked shipped below.
 
 ## Later
 
-- **UTF-8 address types in DSNs** (RFC 6533) — internationalized addresses
-  in the `ORCPT` parameter and in the reports built from it.
+Nothing yet.
 
 ## Not planned
 
@@ -33,26 +32,46 @@ Nothing is under way besides what is marked shipped below.
 
 ## Shipped
 
-### Unreleased — merged, not yet published
+### 0.11.0
+
+- **UTF-8 `ORCPT` (RFC 6533)**: the server decodes `ORCPT=utf-8;…`
+  (`utf-8-addr-xtext` with `\x{HEX}`, and raw UTF-8 under `SMTPUTF8`); the
+  client sends a
+  `utf-8` `ORCPT` in the form the transaction allows instead of leaving it
+  out. The reports built from it, in `@bumail/queue`, are not part of this.
+
+### 0.10.0
 
 - **DSN requests (RFC 3461)**: the server accepts `RET`, `ENVID`, `NOTIFY`
   and `ORCPT` and hands them to the app, and always lists `DSN` in its
   `EHLO` reply, so these parameters are no longer refused with `555 5.5.4`
   (a client that relied on that refusal has to adapt). The client sends
   them when the next hop lists `DSN`, and its result reports `dsnOffered`.
+
+### 0.9.0
+
 - **The envelope on an `afterData` error**: `SmtpError.accepted` and
   `rejected` list the recipients the server took and refused at `RCPT TO`
   when the session failed after the final dot.
+
+### 0.8.0
+
 - **A message holding a NUL byte is refused**: the server reads it to its
   end, then answers `554 5.6.0 Message holds a NUL byte`, and the content
   stream errors with `SmtpError` code `NUL_BYTE`, so `onData` never takes
   it.
+
+### 0.6.0
+
 - **A renewed certificate without a restart**, `server.setTls({ key, cert
   })`: the next STARTTLS upgrade and the next implicit TLS connection use
   it, the sessions open keep their TLS, and a pair that cannot be used
   throws `INVALID_OPTION` and leaves the old one. Implicit TLS without a
   proxy now listens in clear and upgrades each socket as it opens, since
   a native Bun TLS listener cannot swap its certificate.
+
+### 0.5.0
+
 - **Behind a TCP proxy, the client's own address**, with `proxyProtocol:
   { trusted: [...] }`: the server reads the PROXY protocol, versions 1 and
   2, from the proxies listed — a Traefik TCP router, HAProxy — so

package/docs/troubleshooting.md

@@ -1157,7 +1157,8 @@ a token`; `orcpt.address of <address> must be a non-empty string`; `orcpt of
 <address> is over 500 characters once encoded`.
 
 **Why**: RFC 3461 §4.4 and §4.2 cap the parameters as sent, so a character that
-xtext writes as `+XX` counts three.
+xtext writes as `+XX` counts three (for a `utf-8` `orcpt`, the unitext form:
+raw UTF-8 octets, `\x{HH}` = 6; for another type, the type, the `;` and the xtext form).
 
 **Fix**: shorten the value, or give the type as letters, digits and hyphens.
 
@@ -1171,18 +1172,24 @@ await sendMail(message, { host, from, to, envid: 'q-1042' }); // not 'q 1042 …
 than `FULL` or `HDRS`; `ENVID` empty, longer than 100 characters as sent,
 not printable ASCII or not xtext; `NOTIFY` mixing `NEVER` with another
 event, naming an event twice or an unknown one; `ORCPT` with no
-`addr-type;` prefix, an address that is not xtext, or more than 500
-characters as sent (RFC 3461 §4.2).
+`addr-type;` prefix, an address that does not decode (not xtext for
+`rfc822`; for `utf-8`, RFC 6533's `\x{HEX}` form, with raw UTF-8 only when
+the transaction used `SMTPUTF8`), or more than 500 characters as sent (RFC
+3461 §4.2).
 
 **Why**: RFC 3461 §4. The server refuses the command rather than hand a
 wrong value to `onData`.
 
 **Fix**, as a client: encode the value as xtext (`+` and `=`, spaces and
-non-ASCII bytes as `+XX`), and send `NOTIFY=NEVER` alone.
+non-ASCII bytes as `+XX`), and send `NOTIFY=NEVER` alone. For
+`ORCPT=utf-8;` use RFC 6533 instead: `\x{E9}` for `é`, and `\x{2B}` for `+`
+(not `+2B`), or raw UTF-8 after `MAIL FROM … SMTPUTF8`.
 
 ```text
 C: RCPT TO:<bob@example.com> NOTIFY=SUCCESS,FAILURE ORCPT=rfc822;bob+2Btag@example.com
 S: 250 2.1.5 OK
+C: RCPT TO:<bob@example.com> ORCPT=utf-8;\x{E9}l\x{E8}ve@example.com
+S: 250 2.1.5 OK
 ```
 
 ### `501 5.5.4 … given twice`

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@bumail/smtp",
-	"version": "0.10.0",
+	"version": "0.11.1",
 	"description": "An SMTP server on Bun.listen — RFC 5321 with PIPELINING, SIZE, 8BITMIME, SMTPUTF8, STARTTLS and AUTH after TLS, policy hooks, and no open relay — and a client that delivers a message to a smarthost or by MX",
 	"license": "MIT",
 	"type": "module",
@@ -48,8 +48,8 @@
 	},
 	"devDependencies": {
 		"@bumail/auth": "^0.5.0",
-		"@bumail/dns": "^0.2.1",
-		"@bumail/store": "^0.6.0",
+		"@bumail/dns": "^0.2.2",
+		"@bumail/store": "^0.6.1",
 		"@types/bun": "^1.4.2"
 	},
 	"peerDependencies": {