@nxgt/mail-smtp 0.3.0 → 0.3.1

package/README.md

@@ -76,7 +76,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',
-	headers: { 'List-Unsubscribe': '<https://acme.test/unsubscribe>' },
+	headers: { 'X-Entity-Ref-ID': 'invoice-42' },
 	subject: 'Your invoice',
 	html: '<p>…</p>',
 	text: '…',
@@ -89,6 +89,10 @@ await mailer.send({
 - A name is handed to nodemailer as `{ name, address }`: nodemailer quotes and
   encodes it, so `Doe, John` names one recipient.
 - `messageId` is nodemailer's id (`<…@host>`), or `null` when it gives none.
+- For marketing mail, build `List-Unsubscribe` and `List-Unsubscribe-Post`
+  with `listUnsubscribe` from `@nxgt/mail` rather than by hand; your relay, or
+  nodemailer's `dkim` option, must DKIM-sign them — see
+  [one-click unsubscribe](https://github.com/softistx/nxgt-mail/blob/develop/packages/mail/docs/guide/sending.md#one-click-unsubscribe).
 - The parts are strings and the attachments bytes: nodemailer is told never
   to read a file or a URL (`disableFileAccess`, `disableUrlAccess`).
 - `idempotencyKey` is ignored: SMTP has no such mechanism, so a message sent

package/docs/guide/setup.md

@@ -171,7 +171,7 @@ A string is only an address: `'Acme <noreply@acme.test>'` is refused. Write
 | an `{ name, address }` | the same object: nodemailer quotes and encodes the name, so `Doe, John` or `Ada <mallory@example.test>` stays one recipient's name |
 | `from`, `replyTo` | `from`, `replyTo` |
 | `subject`, `html`, `text` | the same, as strings — the e-mail is `multipart/alternative` |
-| `headers` | `headers`, copied |
+| `headers` | `headers`, copied — `List-Unsubscribe` from [`listUnsubscribe`](https://github.com/softistx/nxgt-mail/blob/develop/packages/mail/docs/guide/sending.md#one-click-unsubscribe) included, which your relay or nodemailer's `dkim` option must DKIM-sign |
 | `idempotencyKey` | nothing: ignored — see [below](#the-idempotency-key) |
 | `attachments`, each `{ filename, content, contentType }` | `attachments`, each `{ filename, content: Buffer, contentType }` — the bytes copied into a `Buffer`, never a `path` or an `href`; the e-mail is then `multipart/mixed`. Left out when the list is empty |
 | — | `disableFileAccess: true`, `disableUrlAccess: true`: a part or an attachment is never read from a file or fetched from a URL |

package/docs/roadmap.md

@@ -5,10 +5,7 @@ no dates here, and the version something shipped in is the only number.
 
 ## Now
 
-- **Messages with an idempotency key** — a message that carries an
-  `idempotencyKey` is accepted, and the key is ignored: SMTP has no
-  idempotency, so a message sent twice is delivered twice. Needs `@nxgt/mail`
-  0.3. Built, not yet published.
+Nothing yet.
 
 ## Next
 
@@ -38,6 +35,10 @@ Nothing planned yet. Say what you need in an issue.
 The last ten, newest first, each with the version it came in. Everything
 before is in the [CHANGELOG](../CHANGELOG.md).
 
+- **Messages with an idempotency key, v0.3.0** — a message that carries an
+  `idempotencyKey` is accepted, and the key is ignored: SMTP has no
+  idempotency, so a message sent twice is delivered twice. Needs `@nxgt/mail`
+  0.3.
 - **Attachments, v0.2.0** — the `attachments` of a message are handed to nodemailer
   as bytes, a `Buffer` copied from each `Uint8Array`, with their file name
   (encoded by nodemailer when it is not ASCII) and their type. Never a `path`

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@nxgt/mail-smtp",
-	"version": "0.3.0",
+	"version": "0.3.1",
 	"description": "An SMTP transport for @nxgt/mail, on the nodemailer you install: it throws the MailFailure and MailRefused of its @nxgt/mail peer, and passes the conformance suite.",
 	"license": "MIT",
 	"type": "module",
@@ -44,7 +44,7 @@
 		"typecheck": "tsc --noEmit"
 	},
 	"devDependencies": {
-		"@nxgt/mail": "0.3.0",
+		"@nxgt/mail": "0.4.0",
 		"@types/bun": "^1.4.2",
 		"@types/mailparser": "^3.4.6",
 		"@types/nodemailer": "^8.0.2",
@@ -54,7 +54,7 @@
 		"smtp-server": "^3.19.13"
 	},
 	"peerDependencies": {
-		"@nxgt/mail": "^0.3.0",
+		"@nxgt/mail": "^0.4.0",
 		"nodemailer": ">=7.0.0 <11",
 		"typescript": "^6.0.3"
 	}