@nxgt/mail-resend 0.3.0 → 0.3.1

package/README.md

@@ -71,7 +71,7 @@ await mailer.send({
 	to: [{ name: 'Doe, John', address: 'john@example.com' }],
 	from: 'billing@acme.test', // required here: this mailer has no default
 	replyTo: 'support@acme.test', // sent as reply_to
-	headers: { 'List-Unsubscribe': '<https://acme.test/unsubscribe>' },
+	headers: { 'X-Entity-Ref-ID': 'invoice-42' },
 	subject: 'Your invoice',
 	html: '<p>…</p>',
 	text: '…',
@@ -84,6 +84,9 @@ await mailer.send({
 - A name is sent as a quoted string — `"Doe, John" <john@example.com>` — so a
   comma or an angle bracket in it never names another recipient.
 - `messageId` is Resend's `id`, or `null` when the answer carries none.
+- For marketing mail, build `List-Unsubscribe` and `List-Unsubscribe-Post`
+  with `listUnsubscribe` from `@nxgt/mail` rather than by hand — see
+  [one-click unsubscribe](https://github.com/softistx/nxgt-mail/blob/develop/packages/mail/docs/guide/sending.md#one-click-unsubscribe).
 
 ### Attachments
 

package/docs/guide/setup.md

@@ -148,7 +148,7 @@ const mailer = createResendMailer({ apiKey: process.env.RESEND_API_KEY ?? '', ti
 await mailer.send({
 	to: ['ada@example.com', { name: 'Doe, "John"', address: 'john@example.com' }],
 	replyTo: 'support@acme.test',
-	headers: { 'List-Unsubscribe': '<https://acme.test/u>' },
+	headers: { 'X-Entity-Ref-ID': 'invoice-42' },
 	subject: 'Hi',
 	html: '<p>Hi</p>',
 	text: 'Hi',
@@ -169,7 +169,7 @@ Content-Type: application/json
   "html": "<p>Hi</p>",
   "text": "Hi",
   "reply_to": "support@acme.test",
-  "headers": { "List-Unsubscribe": "<https://acme.test/u>" },
+  "headers": { "X-Entity-Ref-ID": "invoice-42" },
   "attachments": [
     { "filename": "hello.txt", "content": "SGVsbG8=", "content_type": "text/plain" }
   ]
@@ -189,6 +189,11 @@ Content-Type: application/json
 
 - `replyTo` is sent as `reply_to`, Resend's name for it; `reply_to` and
   `headers` are left out when the message has none.
+- `headers` are sent as written, and Resend DKIM-signs the message with your
+  domain's key — check that the `DKIM-Signature` of a received message names
+  the headers you rely on in `h=`; build `List-Unsubscribe` with `listUnsubscribe` from
+  `@nxgt/mail` — see
+  [one-click unsubscribe](https://github.com/softistx/nxgt-mail/blob/develop/packages/mail/docs/guide/sending.md#one-click-unsubscribe).
 - Each attachment is sent as `{ filename, content, content_type }`: its bytes
   as base64, encoded in slices with `btoa` — no `Buffer`, so it runs on an
   edge runtime — and its type as `content_type`, Resend's name for it.

package/docs/roadmap.md

@@ -5,13 +5,7 @@ no dates here, and the version something shipped in is the only number.
 
 ## Now
 
-- **An idempotency key per send** — a message's `idempotencyKey` is sent as
-  Resend's `Idempotency-Key` header, so a retry the caller decides, within
-  Resend's 24 hours, answers the first send's id and cannot send the same
-  e-mail twice. A `409 invalid_idempotent_request` (the key already used for
-  another message) is a `MailRefused`; a `409 concurrent_idempotent_requests`
-  (the same key still in progress) stays a `MailFailure`. Needs `@nxgt/mail`
-  0.3. Built, not yet published.
+Nothing yet.
 
 ## Next
 
@@ -38,6 +32,13 @@ Nothing yet.
 The last ten, newest first, each with the version it came in. Everything
 before is in the [CHANGELOG](../CHANGELOG.md).
 
+- **An idempotency key per send, v0.3.0** — a message's `idempotencyKey` is sent as
+  Resend's `Idempotency-Key` header, so a retry the caller decides, within
+  Resend's 24 hours, answers the first send's id and cannot send the same
+  e-mail twice. A `409 invalid_idempotent_request` (the key already used for
+  another message) is a `MailRefused`; a `409 concurrent_idempotent_requests`
+  (the same key still in progress) stays a `MailFailure`. Needs `@nxgt/mail`
+  0.3.
 - **Attachments, v0.2.0** — the `attachments` of a message are sent in Resend's
   `attachments`, each as `{ filename, content, content_type }` with the bytes
   in base64, encoded with no Node built-in so the transport still runs on an

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@nxgt/mail-resend",
-	"version": "0.3.0",
+	"version": "0.3.1",
 	"description": "A Resend transport for @nxgt/mail over fetch, with no SDK: it throws the MailFailure and MailRefused of its @nxgt/mail peer, and passes the conformance suite.",
 	"license": "MIT",
 	"type": "module",
@@ -43,11 +43,11 @@
 		"typecheck": "tsc --noEmit"
 	},
 	"devDependencies": {
-		"@nxgt/mail": "0.3.0",
+		"@nxgt/mail": "0.4.0",
 		"@types/bun": "^1.4.2"
 	},
 	"peerDependencies": {
-		"@nxgt/mail": "^0.3.0",
+		"@nxgt/mail": "^0.4.0",
 		"typescript": "^6.0.3"
 	}
 }