@bumail/smtp 0.9.0 → 0.10.0

package/dist/server/dsn-params.d.ts

@@ -0,0 +1,20 @@
+import type { DsnNotify, EnvelopeRecipient } from './options';
+import type { Transaction } from './state';
+/** The DSN parameters (RFC 3461 §4) MAIL FROM takes. */
+export declare const MAIL_DSN: Set<string>;
+/** The DSN parameters (RFC 3461 §4) RCPT TO takes. */
+export declare const RCPT_DSN: Set<string>;
+/**
+ * Reads one DSN parameter of MAIL FROM into the transaction under way.
+ * The text of the `501` to answer when the value is wrong, else `undefined`.
+ */
+export declare function readMailDsn(into: Pick<Transaction, 'ret' | 'envid'>, key: string, value: string, repeated: readonly string[]): string | undefined;
+/**
+ * Reads one DSN parameter of RCPT TO into `into`. The text of the `501` to
+ * answer when the value is wrong, else `undefined`.
+ */
+export declare function readRcptDsn(into: {
+    notify?: 'NEVER' | readonly DsnNotify[];
+    orcpt?: EnvelopeRecipient['orcpt'];
+}, key: string, value: string, repeated: readonly string[]): string | undefined;
+//# sourceMappingURL=dsn-params.d.ts.map

package/dist/server/dsn-params.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"dsn-params.d.ts","sourceRoot":"","sources":["../../src/server/dsn-params.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,SAAS,EAAE,iBAAiB,EAAE,MAAM,WAAW,CAAC;AAC9D,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAE3C,wDAAwD;AACxD,eAAO,MAAM,QAAQ,aAA4B,CAAC;AAClD,sDAAsD;AACtD,eAAO,MAAM,QAAQ,aAA+B,CAAC;AA0CrD;;;GAGG;AACH,wBAAgB,WAAW,CAC1B,IAAI,EAAE,IAAI,CAAC,WAAW,EAAE,KAAK,GAAG,OAAO,CAAC,EACxC,GAAG,EAAE,MAAM,EACX,KAAK,EAAE,MAAM,EACb,QAAQ,EAAE,SAAS,MAAM,EAAE,GACzB,MAAM,GAAG,SAAS,CAYpB;AAED;;;GAGG;AACH,wBAAgB,WAAW,CAC1B,IAAI,EAAE;IACL,MAAM,CAAC,EAAE,OAAO,GAAG,SAAS,SAAS,EAAE,CAAC;IACxC,KAAK,CAAC,EAAE,iBAAiB,CAAC,OAAO,CAAC,CAAC;CACnC,EACD,GAAG,EAAE,MAAM,EACX,KAAK,EAAE,MAAM,EACb,QAAQ,EAAE,SAAS,MAAM,EAAE,GACzB,MAAM,GAAG,SAAS,CAYpB"}

package/dist/server/envelope.d.ts

@@ -0,0 +1,5 @@
+import type { ReceivedMessage } from './options';
+import type { Transaction } from './state';
+/** The envelope of a message as `onData` is told it, from the transaction that ended in DATA. */
+export declare function envelopeOf(transaction: Transaction): ReceivedMessage['envelope'];
+//# sourceMappingURL=envelope.d.ts.map

package/dist/server/envelope.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"envelope.d.ts","sourceRoot":"","sources":["../../src/server/envelope.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,WAAW,CAAC;AACjD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAE3C,iGAAiG;AACjG,wBAAgB,UAAU,CACzB,WAAW,EAAE,WAAW,GACtB,eAAe,CAAC,UAAU,CAAC,CAU7B"}

package/dist/server/intake.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"intake.d.ts","sourceRoot":"","sources":["../../src/server/intake.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,KAAK,EAAS,MAAM,mBAAmB,CAAC;AACtD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAgB/C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAK3C;;;;;;;;;;;;GAYG;AACH,qBAAa,MAAM;;IAClB,QAAQ,CAAC,EAAE,SAAsD;gBAoBrD,UAAU,EAAE,UAAU,EAAE,WAAW,EAAE,WAAW;IA0E5D,iEAAiE;IAC3D,KAAK,CAAC,KAAK,EAAE,UAAU,GAAG,OAAO,CAAC;QAAE,IAAI,EAAE,OAAO,CAAC;QAAC,IAAI,EAAE,UAAU,CAAA;KAAE,CAAC;IAmB5E,0CAA0C;IACpC,MAAM,IAAI,OAAO,CAAC,KAAK,CAAC;IAuB9B,uEAAuE;IACvE,KAAK,IAAI,IAAI;CA2Eb"}
+{"version":3,"file":"intake.d.ts","sourceRoot":"","sources":["../../src/server/intake.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,KAAK,EAAS,MAAM,mBAAmB,CAAC;AACtD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAiB/C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAK3C;;;;;;;;;;;;GAYG;AACH,qBAAa,MAAM;;IAClB,QAAQ,CAAC,EAAE,SAAsD;gBAoBrD,UAAU,EAAE,UAAU,EAAE,WAAW,EAAE,WAAW;IAqE5D,iEAAiE;IAC3D,KAAK,CAAC,KAAK,EAAE,UAAU,GAAG,OAAO,CAAC;QAAE,IAAI,EAAE,OAAO,CAAC;QAAC,IAAI,EAAE,UAAU,CAAA;KAAE,CAAC;IAmB5E,0CAA0C;IACpC,MAAM,IAAI,OAAO,CAAC,KAAK,CAAC;IAuB9B,uEAAuE;IACvE,KAAK,IAAI,IAAI;CA2Eb"}

package/dist/server/options.d.ts

@@ -20,6 +20,28 @@ export interface Session {
      */
     readonly data: Record<string, unknown>;
 }
+/** What a recipient asked to be told (RFC 3461 §4.1): `NEVER`, or the events among these. */
+export type DsnNotify = 'SUCCESS' | 'FAILURE' | 'DELAY';
+/**
+ * One recipient of a message, with the DSN parameters of its `RCPT TO`
+ * (RFC 3461 §4.1, §4.2). The server only passes them on: the app honours
+ * them when it relays the message or generates a DSN.
+ */
+export interface EnvelopeRecipient {
+    /** The same address as the matching entry of `Envelope.to`. */
+    readonly address: string;
+    /**
+     * `NOTIFY=`: `'NEVER'`, or the events, in the order given, with no
+     * duplicate. Absent when the client sent none: the default is a DSN on
+     * failure, delay and success never (RFC 3461 §4.1).
+     */
+    readonly notify?: 'NEVER' | readonly DsnNotify[];
+    /** `ORCPT=`: the original recipient, its `type` as sent (`rfc822`) and its `address` decoded from xtext. */
+    readonly orcpt?: {
+        readonly type: string;
+        readonly address: string;
+    };
+}
 /** The sender and recipients of one message. */
 export interface Envelope {
     /** `''` for the null reverse-path `<>`: a bounce. */
@@ -30,6 +52,12 @@ export interface Envelope {
     readonly smtputf8: boolean;
     /** `7BIT` or `8BITMIME`, as MAIL FROM's BODY= said; `7BIT` when it said nothing. */
     readonly body: '7BIT' | '8BITMIME';
+    /** `RET=` of MAIL FROM (RFC 3461 §4.3), upper case: whether a DSN returns the whole message or its headers. Absent when not sent. */
+    readonly ret?: 'FULL' | 'HDRS';
+    /** `ENVID=` of MAIL FROM (RFC 3461 §4.4), decoded from xtext: at most 100 printable ASCII characters. Absent when not sent. */
+    readonly envid?: string;
+    /** The recipients accepted, in the order of `to`, each with its `NOTIFY` and `ORCPT`. */
+    readonly recipients: readonly EnvelopeRecipient[];
 }
 /** A message on its way in, handed to `onData` as the client sends it. */
 export interface ReceivedMessage {

package/dist/server/options.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"options.d.ts","sourceRoot":"","sources":["../../src/server/options.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAC;AAC7C,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAC;AAC/C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAEpD,sGAAsG;AACtG,MAAM,WAAW,OAAO;IACvB,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAC;IAC/B,8CAA8C;IAC9C,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC;IACzB,gDAAgD;IAChD,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IACvB,sCAAsC;IACtC,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC;IACxB,gDAAgD;IAChD,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IACvB;;;;OAIG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACvC;AAED,gDAAgD;AAChD,MAAM,WAAW,QAAQ;IACxB,qDAAqD;IACrD,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,uFAAuF;IACvF,QAAQ,CAAC,EAAE,EAAE,SAAS,MAAM,EAAE,CAAC;IAC/B,gDAAgD;IAChD,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC;IAC3B,oFAAoF;IACpF,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,UAAU,CAAC;CACnC;AAED,0EAA0E;AAC1E,MAAM,WAAW,eAAe;IAC/B,+EAA+E;IAC/E,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC;IAC5B;;;;;;;;;;;OAWG;IACH,QAAQ,CAAC,OAAO,EAAE,cAAc,CAAC,UAAU,CAAC,CAAC;IAC7C;;;;;;;;;;;OAWG;IACH,QAAQ,CAAC,MAAM,EAAE,WAAW,CAAC;CAC7B;AAED;;;;;GAKG;AACH,MAAM,MAAM,UAAU,GAAG,KAAK,GAAG,SAAS,GAAG,IAAI,CAAC;AAElD,MAAM,WAAW,SAAS;IACzB;;;;;OAKG;IACH,SAAS,CAAC,CAAC,OAAO,EAAE,OAAO,GAAG,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;IAC/D,kDAAkD;IAClD,UAAU,CAAC,CAAC,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,GAAG,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;IAC5E,mEAAmE;IACnE,QAAQ,CAAC,CAAC,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,GAAG,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;IAC1E;;;;;OAKG;IACH,MAAM,CACL,OAAO,EAAE,eAAe,EACxB,OAAO,EAAE,OAAO,GACd,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;CACpC;AAED,uEAAuE;AACvE,MAAM,WAAW,UAAU;IAC1B,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,UAAU,GAAG,GAAG,CAAC,OAAO,CAAC;IAChD,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,UAAU,GAAG,GAAG,CAAC,OAAO,CAAC;CACjD;AAED,kEAAkE;AAClE,MAAM,WAAW,oBAAoB;IACpC,sFAAsF;IACtF,QAAQ,CAAC,OAAO,EAAE,SAAS,MAAM,EAAE,CAAC;CACpC;AAED,MAAM,WAAW,iBAAkB,SAAQ,SAAS;IACnD,sFAAsF;IACtF,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B;;;;OAIG;IACH,QAAQ,CAAC,IAAI,CAAC,EAAE,IAAI,GAAG,YAAY,CAAC;IACpC;;;;;;OAMG;IACH,QAAQ,CAAC,YAAY,EAClB,SAAS,MAAM,EAAE,GACjB,CAAC,CAAC,MAAM,EAAE,MAAM,KAAK,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC;IACpD,wEAAwE;IACxE,QAAQ,CAAC,GAAG,CAAC,EAAE,UAAU,CAAC;IAC1B,iEAAiE;IACjE,QAAQ,CAAC,WAAW,CAAC,EAAE,OAAO,CAAC;IAC/B;;;;;OAKG;IACH,YAAY,CAAC,CACZ,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,OAAO,GACd,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAC9B,qFAAqF;IACrF,QAAQ,CAAC,cAAc,CAAC,EAAE,MAAM,CAAC;IACjC,kGAAkG;IAClG,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,CAAC;IAChC,8CAA8C;IAC9C,QAAQ,CAAC,cAAc,CAAC,EAAE,MAAM,CAAC;IACjC;;;;;;;OAOG;IACH,QAAQ,CAAC,uBAAuB,CAAC,EAAE,MAAM,CAAC;IAC1C,iEAAiE;IACjE,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAC5B,sIAAsI;IACtI,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAC1B;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,aAAa,CAAC,EAAE,oBAAoB,CAAC;IAC9C;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,gBAAgB,CAAC,EAAE,MAAM,CAAC;IACnC;;;;;;OAMG;IACH,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,CAAC;IAChC;;;;;OAKG;IACH,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAC9B;;;;OAIG;IACH,OAAO,CAAC,CAAC,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,GAAG,IAAI,CAAC;CACjD"}
+{"version":3,"file":"options.d.ts","sourceRoot":"","sources":["../../src/server/options.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAC;AAC7C,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAC;AAC/C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAEpD,sGAAsG;AACtG,MAAM,WAAW,OAAO;IACvB,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAC;IAC/B,8CAA8C;IAC9C,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC;IACzB,gDAAgD;IAChD,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IACvB,sCAAsC;IACtC,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC;IACxB,gDAAgD;IAChD,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IACvB;;;;OAIG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACvC;AAED,6FAA6F;AAC7F,MAAM,MAAM,SAAS,GAAG,SAAS,GAAG,SAAS,GAAG,OAAO,CAAC;AAExD;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IACjC,+DAA+D;IAC/D,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB;;;;OAIG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,OAAO,GAAG,SAAS,SAAS,EAAE,CAAC;IACjD,4GAA4G;IAC5G,QAAQ,CAAC,KAAK,CAAC,EAAE;QAAE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC;CACrE;AAED,gDAAgD;AAChD,MAAM,WAAW,QAAQ;IACxB,qDAAqD;IACrD,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,uFAAuF;IACvF,QAAQ,CAAC,EAAE,EAAE,SAAS,MAAM,EAAE,CAAC;IAC/B,gDAAgD;IAChD,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC;IAC3B,oFAAoF;IACpF,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,UAAU,CAAC;IACnC,qIAAqI;IACrI,QAAQ,CAAC,GAAG,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAC/B,+HAA+H;IAC/H,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IACxB,yFAAyF;IACzF,QAAQ,CAAC,UAAU,EAAE,SAAS,iBAAiB,EAAE,CAAC;CAClD;AAED,0EAA0E;AAC1E,MAAM,WAAW,eAAe;IAC/B,+EAA+E;IAC/E,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC;IAC5B;;;;;;;;;;;OAWG;IACH,QAAQ,CAAC,OAAO,EAAE,cAAc,CAAC,UAAU,CAAC,CAAC;IAC7C;;;;;;;;;;;OAWG;IACH,QAAQ,CAAC,MAAM,EAAE,WAAW,CAAC;CAC7B;AAED;;;;;GAKG;AACH,MAAM,MAAM,UAAU,GAAG,KAAK,GAAG,SAAS,GAAG,IAAI,CAAC;AAElD,MAAM,WAAW,SAAS;IACzB;;;;;OAKG;IACH,SAAS,CAAC,CAAC,OAAO,EAAE,OAAO,GAAG,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;IAC/D,kDAAkD;IAClD,UAAU,CAAC,CAAC,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,GAAG,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;IAC5E,mEAAmE;IACnE,QAAQ,CAAC,CAAC,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,GAAG,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;IAC1E;;;;;OAKG;IACH,MAAM,CACL,OAAO,EAAE,eAAe,EACxB,OAAO,EAAE,OAAO,GACd,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;CACpC;AAED,uEAAuE;AACvE,MAAM,WAAW,UAAU;IAC1B,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,UAAU,GAAG,GAAG,CAAC,OAAO,CAAC;IAChD,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,UAAU,GAAG,GAAG,CAAC,OAAO,CAAC;CACjD;AAED,kEAAkE;AAClE,MAAM,WAAW,oBAAoB;IACpC,sFAAsF;IACtF,QAAQ,CAAC,OAAO,EAAE,SAAS,MAAM,EAAE,CAAC;CACpC;AAED,MAAM,WAAW,iBAAkB,SAAQ,SAAS;IACnD,sFAAsF;IACtF,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B;;;;OAIG;IACH,QAAQ,CAAC,IAAI,CAAC,EAAE,IAAI,GAAG,YAAY,CAAC;IACpC;;;;;;OAMG;IACH,QAAQ,CAAC,YAAY,EAClB,SAAS,MAAM,EAAE,GACjB,CAAC,CAAC,MAAM,EAAE,MAAM,KAAK,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC;IACpD,wEAAwE;IACxE,QAAQ,CAAC,GAAG,CAAC,EAAE,UAAU,CAAC;IAC1B,iEAAiE;IACjE,QAAQ,CAAC,WAAW,CAAC,EAAE,OAAO,CAAC;IAC/B;;;;;OAKG;IACH,YAAY,CAAC,CACZ,WAAW,EAAE,WAAW,EACxB,OAAO,EAAE,OAAO,GACd,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAC9B,qFAAqF;IACrF,QAAQ,CAAC,cAAc,CAAC,EAAE,MAAM,CAAC;IACjC,kGAAkG;IAClG,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,CAAC;IAChC,8CAA8C;IAC9C,QAAQ,CAAC,cAAc,CAAC,EAAE,MAAM,CAAC;IACjC;;;;;;;OAOG;IACH,QAAQ,CAAC,uBAAuB,CAAC,EAAE,MAAM,CAAC;IAC1C,iEAAiE;IACjE,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAC5B,sIAAsI;IACtI,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAC1B;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,aAAa,CAAC,EAAE,oBAAoB,CAAC;IAC9C;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,gBAAgB,CAAC,EAAE,MAAM,CAAC;IACnC;;;;;;OAMG;IACH,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,CAAC;IAChC;;;;;OAKG;IACH,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAC9B;;;;OAIG;IACH,OAAO,CAAC,CAAC,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,GAAG,IAAI,CAAC;CACjD"}

package/dist/server/state.d.ts

@@ -1,8 +1,11 @@
-import type { Envelope } from './options';
+import type { Envelope, EnvelopeRecipient } from './options';
 /** A mail transaction in progress (RFC 5321 §3.3). */
 export interface Transaction {
     from?: string;
     to: string[];
+    recipients: EnvelopeRecipient[];
+    ret?: Envelope['ret'];
+    envid?: string;
     smtputf8: boolean;
     body: Envelope['body'];
 }

package/dist/server/state.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"state.d.ts","sourceRoot":"","sources":["../../src/server/state.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAC;AAE1C,sDAAsD;AACtD,MAAM,WAAW,WAAW;IAC3B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,EAAE,EAAE,MAAM,EAAE,CAAC;IACb,QAAQ,EAAE,OAAO,CAAC;IAClB,IAAI,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC;CACvB;AAED,6CAA6C;AAC7C,MAAM,MAAM,OAAO,GAChB,SAAS,GACT,MAAM,GACN,YAAY,GACZ,iBAAiB,GACjB,qBAAqB,CAAC;AAEzB,kDAAkD;AAClD,MAAM,WAAW,KAAK;IACrB,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1B,KAAK,EAAE,OAAO,CAAC;IACf,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1B,MAAM,EAAE,OAAO,CAAC;IAChB,WAAW,EAAE,WAAW,CAAC;IACzB,OAAO,EAAE,OAAO,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC/B,MAAM,EAAE,MAAM,CAAC;IACf,YAAY,EAAE,MAAM,CAAC;CACrB;AAED,eAAO,MAAM,gBAAgB,QAAO,WAIlC,CAAC"}
+{"version":3,"file":"state.d.ts","sourceRoot":"","sources":["../../src/server/state.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,iBAAiB,EAAE,MAAM,WAAW,CAAC;AAE7D,sDAAsD;AACtD,MAAM,WAAW,WAAW;IAC3B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,EAAE,EAAE,MAAM,EAAE,CAAC;IACb,UAAU,EAAE,iBAAiB,EAAE,CAAC;IAChC,GAAG,CAAC,EAAE,QAAQ,CAAC,KAAK,CAAC,CAAC;IACtB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,OAAO,CAAC;IAClB,IAAI,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC;CACvB;AAED,6CAA6C;AAC7C,MAAM,MAAM,OAAO,GAChB,SAAS,GACT,MAAM,GACN,YAAY,GACZ,iBAAiB,GACjB,qBAAqB,CAAC;AAEzB,kDAAkD;AAClD,MAAM,WAAW,KAAK;IACrB,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1B,KAAK,EAAE,OAAO,CAAC;IACf,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1B,MAAM,EAAE,OAAO,CAAC;IAChB,WAAW,EAAE,WAAW,CAAC;IACzB,OAAO,EAAE,OAAO,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC/B,MAAM,EAAE,MAAM,CAAC;IACf,YAAY,EAAE,MAAM,CAAC;CACrB;AAED,eAAO,MAAM,gBAAgB,QAAO,WAKlC,CAAC"}

package/dist/server/transaction.d.ts

@@ -1,6 +1,6 @@
 import type { Connection } from './connection';
-/** `MAIL FROM:<path> [SIZE=] [BODY=] [SMTPUTF8] [AUTH=]` (RFC 5321 §4.1.1.2). */
+/** `MAIL FROM:<path> [SIZE=] [BODY=] [SMTPUTF8] [AUTH=] [RET=] [ENVID=]` (RFC 5321 §4.1.1.2, RFC 3461 §4.3, §4.4). */
 export declare function mail(connection: Connection, argument: string): Promise<void>;
-/** `RCPT TO:<path>` (RFC 5321 §4.1.1.3), where relaying is refused without AUTH. */
+/** `RCPT TO:<path> [NOTIFY=] [ORCPT=]` (RFC 5321 §4.1.1.3, RFC 3461 §4.1, §4.2), where relaying is refused without AUTH. */
 export declare function rcpt(connection: Connection, argument: string): Promise<void>;
 //# sourceMappingURL=transaction.d.ts.map

package/dist/server/transaction.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"transaction.d.ts","sourceRoot":"","sources":["../../src/server/transaction.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAS/C,iFAAiF;AACjF,wBAAsB,IAAI,CACzB,UAAU,EAAE,UAAU,EACtB,QAAQ,EAAE,MAAM,GACd,OAAO,CAAC,IAAI,CAAC,CAuDf;AAED,oFAAoF;AACpF,wBAAsB,IAAI,CACzB,UAAU,EAAE,UAAU,EACtB,QAAQ,EAAE,MAAM,GACd,OAAO,CAAC,IAAI,CAAC,CAyCf"}
+{"version":3,"file":"transaction.d.ts","sourceRoot":"","sources":["../../src/server/transaction.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAY/C,sHAAsH;AACtH,wBAAsB,IAAI,CACzB,UAAU,EAAE,UAAU,EACtB,QAAQ,EAAE,MAAM,GACd,OAAO,CAAC,IAAI,CAAC,CAkEf;AAED,4HAA4H;AAC5H,wBAAsB,IAAI,CACzB,UAAU,EAAE,UAAU,EACtB,QAAQ,EAAE,MAAM,GACd,OAAO,CAAC,IAAI,CAAC,CAoDf"}

package/docs/guide.md

@@ -192,7 +192,9 @@ Every reply the server sends of its own:
 | `503 5.5.1 Send MAIL first` | RCPT or DATA before MAIL |
 | `554 5.5.1 No valid recipients` | DATA with no recipient accepted; what the client pipelined behind it in the same write is dropped, not run as commands |
 | `501 5.5.4 Syntax: MAIL FROM:<address>` / `RCPT TO:<address>` / `DATA` | the command's syntax is wrong |
-| `555 5.5.4 <PARAM> is not supported` | an ESMTP parameter other than SIZE, BODY, SMTPUTF8 and AUTH on MAIL, or any parameter on RCPT |
+| `555 5.5.4 <PARAM> is not supported` | an ESMTP parameter other than SIZE, BODY, SMTPUTF8, AUTH, RET and ENVID on MAIL, or other than NOTIFY and ORCPT on RCPT |
+| `501 5.5.4 Syntax: RET=…` / `ENVID=…` / `NOTIFY=…` / `ORCPT=…` | a DSN parameter with a malformed value (RFC 3461 §4) |
+| `501 5.5.4 <PARAM> given twice` | a DSN parameter repeated on one command |
 | `555 5.5.4 <PARAM> needs EHLO` | a parameter after HELO |
 | `501 5.5.4 Syntax: SIZE=<bytes>` | SIZE is not a number |
 | `501 5.5.4 BODY is 7BIT or 8BITMIME` | another BODY value |
@@ -463,6 +465,20 @@ export interface Envelope {
 	readonly smtputf8: boolean;
 	/** `7BIT` or `8BITMIME`, as MAIL FROM's BODY= said; `7BIT` when it said nothing. */
 	readonly body: '7BIT' | '8BITMIME';
+	/** MAIL FROM's RET= (RFC 3461 §4.3); absent when not sent. */
+	readonly ret?: 'FULL' | 'HDRS';
+	/** MAIL FROM's ENVID=, decoded from xtext (RFC 3461 §4.4); absent when not sent. */
+	readonly envid?: string;
+	/** The recipients accepted, in the order of `to`, with their DSN parameters. */
+	readonly recipients: readonly EnvelopeRecipient[];
+}
+
+export interface EnvelopeRecipient {
+	readonly address: string; // the matching entry of `to`
+	/** NOTIFY= (RFC 3461 §4.1): `'NEVER'` or the events given; absent when not sent. */
+	readonly notify?: 'NEVER' | readonly ('SUCCESS' | 'FAILURE' | 'DELAY')[];
+	/** ORCPT= (RFC 3461 §4.2): the type as sent and the address decoded from xtext. */
+	readonly orcpt?: { readonly type: string; readonly address: string };
 }
 ```
 
@@ -636,6 +652,83 @@ const server = createSmtpServer({
 await server.listen({ port: 25 });
 ```
 
+## Delivery status notifications (DSN)
+
+The server advertises `DSN` (RFC 3461) in its EHLO reply, always (no option to
+turn it off). A client may then send `RET=FULL|HDRS` and `ENVID=<xtext>` on
+`MAIL FROM`, and `NOTIFY=NEVER` (or a comma list of `SUCCESS`, `FAILURE`,
+`DELAY`) and `ORCPT=<addr-type>;<xtext>` on `RCPT TO`. The server checks
+their syntax, decodes the xtext and puts them on the `Envelope` `onData`
+receives: `ret` and `envid`, and for each accepted recipient `notify` and
+`orcpt` in `recipients`. `to` is unchanged.
+
+The server does nothing else with them. Once it advertises DSN, the app that
+receives these parameters must honour them, or the client is told something
+untrue:
+
+- An app that **relays** the message (a queue, a smarthost) passes them on
+  to the next hop, or generates the DSN itself when the next hop does not
+  advertise DSN.
+- An app that **delivers locally** generates a DSN for a recipient that asked
+  for `SUCCESS` and was delivered, returning the message or only its
+  headers as `ret` says, and puts `envid` and `orcpt` in the report.
+- `NOTIFY=NEVER` means no DSN for that recipient, a bounce included.
+
+```ts
+import { createSmtpServer } from '@bumail/smtp';
+
+createSmtpServer({
+	hostname: 'mx.example.com',
+	localDomains: ['example.com'],
+	async onData({ envelope }) {
+		for (const { address, notify, orcpt } of envelope.recipients) {
+			if (notify === 'NEVER') continue; // no DSN for this one, ever
+			// deliver to `address`; report to `envelope.from` as `notify` asks,
+			// quoting `envelope.envid` and `orcpt?.address`
+		}
+	},
+});
+```
+
+A malformed or repeated DSN parameter is answered `501 5.5.4`; a parameter
+after `HELO` gets `555 <PARAM> needs EHLO`.
+
+### Sending DSN parameters
+
+`sendMail` takes `ret`, `envid` and `recipients` (the shape of
+`Envelope.recipients`: `address`, `notify`, `orcpt`, matched to `to` by
+address), so a received envelope can be passed through when a relay hands the
+message on. They are written only when the next hop's EHLO lists `DSN`, with
+`envid` and the `orcpt` address xtext-encoded (RFC 3461 §4). An `orcpt` whose
+type is not `rfc822`, or whose address is not ASCII (RFC 6533), is left out of
+the command, not refused, so a relay never fails on what a received envelope
+carries. When the next hop lists no `DSN` nothing is sent, the delivery goes
+through as usual, and the result says `dsnOffered: false`: the relay must then
+generate the DSNs itself (RFC 3461 §5.2.2).
+
+```ts
+import { sendMail } from '@bumail/smtp/client';
+
+const result = await sendMail(message, {
+	host: 'smtp.relay.example',
+	from: 'a@example.com',
+	to: ['b@example.net'],
+	ret: 'HDRS',
+	envid: 'q-1042',
+	recipients: [{ address: 'b@example.net', notify: ['FAILURE', 'DELAY'] }],
+});
+if (!result.dsnOffered) {
+	// the next hop never saw NOTIFY: send the 'relayed' DSN here
+}
+```
+
+`dsnOffered` is the server listing `DSN` in EHLO; it does not prove the next
+hop will send a DSN. These are `INVALID_OPTION`: a wrong `ret`, `notify` or
+`orcpt` shape; an `envid` over 100 characters once xtext-encoded (RFC 3461
+§4.4); an `orcpt` over 500 characters once encoded (§4.2), whose type is not a
+token, or whose address is empty; a `recipients` entry not in `to`, or named
+twice.
+
 ## Delivering into @bumail/store
 
 [`@bumail/store`](https://github.com/softistx/bumail/tree/develop/packages/store) keeps
@@ -1893,6 +1986,7 @@ console.log(chunk.done, reader.bareLineBreaks);
 | SIZE | RFC 1870 |
 | PIPELINING | RFC 2920 |
 | 8BITMIME | RFC 6152 |
+| DSN parameters (`RET`, `ENVID`, `NOTIFY`, `ORCPT`) and xtext | RFC 3461 §4 |
 | SMTPUTF8 | RFC 6531 |
 | ENHANCEDSTATUSCODES and the codes themselves | RFC 2034, RFC 3463 |
 | STARTTLS | RFC 3207 |
@@ -1914,9 +2008,9 @@ each one comes from.
 
 ## What is not implemented
 
-- **DSN** (RFC 3461). `RET`, `ENVID`, `NOTIFY` and `ORCPT` are refused with
-  `555 5.5.4 <PARAM> is not supported`; DSN is not advertised, so a
-  conforming client does not send them.
+- **Generating DSNs.** The server advertises DSN and hands the parameters to
+  `onData` (see [Delivery status notifications](#delivery-status-notifications-dsn)),
+  but it never writes a notification: honouring them is the app's job.
 - **CHUNKING** (RFC 3030). `BDAT` is answered `500 5.5.2 Command
   unrecognized`; a client sends DATA instead.
 - **A queue.** The client tries a destination once and reports;
@@ -1924,7 +2018,8 @@ each one comes from.
 - **Connection reuse.** The client opens one connection per message, and
   sends no `RSET`. Several messages to one destination over one session is
   on the [roadmap](roadmap.md).
-- **DSN in the client.** It sends no `RET`, `ENVID`, `NOTIFY` or `ORCPT`.
+- **`ORCPT` of an RFC 6533 type (`utf-8`) or with a non-ASCII address in the
+  client**: it is left out of `RCPT TO`, not sent.
 - **CHUNKING in the client.** It sends DATA, never `BDAT`.
 - **DANE and MTA-STS.** By MX, TLS is opportunistic; a policy that makes
   it required for a domain is for later.

package/docs/roadmap.md

@@ -6,22 +6,23 @@ number on it.
 
 ## Now
 
-Nothing in progress.
+Nothing is under way besides what is marked shipped below.
 
 ## Next
 
 - **Connection reuse in the client** — several messages to one
   destination over one session (`RSET` between them), for a queue that
   delivers in batches. Today each `sendMail` opens its own connection.
-- **DSN** (RFC 3461) — `RET`, `ENVID`, `NOTIFY` and `ORCPT` accepted and
-  handed to the app, so a sender can ask for delivery status
-  notifications. Today they are refused with `555 5.5.4`, and the client
-  sends none.
 - **Delivery into `@bumail/store`, ready-made** — an `onData` that puts
   each message in its recipients' inboxes, instead of the few lines the
   [guide](guide.md#delivering-into-bumailstore) shows today. The store
   itself has landed; only the helper is to come.
 
+## Later
+
+- **UTF-8 address types in DSNs** (RFC 6533) — internationalized addresses
+  in the `ORCPT` parameter and in the reports built from it.
+
 ## Not planned
 
 - **Relaying without AUTH** — not as a default, not as an option. A
@@ -34,6 +35,11 @@ Nothing in progress.
 
 ### Unreleased — merged, not yet published
 
+- **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`.
 - **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.

package/docs/troubleshooting.md

@@ -63,6 +63,8 @@ A reply carries its enhanced status code (`5.7.1`, RFC 3463) only after
 - [`503 5.5.1 TLS already active`](#503-551-tls-already-active)
 - [`501 5.5.4 BODY is 7BIT or 8BITMIME`](#501-554-body-is-7bit-or-8bitmime)
 - [`555 5.5.4 … is not supported`](#555-554--is-not-supported)
+- [`501 5.5.4 Syntax: RET=…`, `ENVID=…`, `NOTIFY=…`, `ORCPT=…`](#501-554-syntax-ret-envid-notify-orcpt)
+- [`501 5.5.4 … given twice`](#501-554--given-twice)
 - [`555 … needs EHLO`](#555--needs-ehlo)
 - [`553 5.6.7 A non-ASCII address needs SMTPUTF8`](#553-567-a-non-ascii-address-needs-smtputf8)
 - [`500 5.5.6 Line too long`](#500-556-line-too-long)
@@ -1136,14 +1138,60 @@ S: 250 2.1.0 OK
 ### `555 5.5.4 … is not supported`
 
 **When**: `MAIL FROM` with a parameter other than `SIZE`, `BODY`,
-`SMTPUTF8` and `AUTH`, such as `RET` or `ENVID`; or `RCPT TO` with any
-parameter, such as `NOTIFY` or `ORCPT`; or `SMTPUTF8` given a value.
+`SMTPUTF8`, `AUTH`, `RET` and `ENVID`; or `RCPT TO` with one other than
+`NOTIFY` and `ORCPT`; or `SMTPUTF8` given a value.
 
-**Why**: the server supports only the extensions its EHLO lists. Delivery
-status notifications (DSN, RFC 3461) are not among them.
+**Why**: the server supports only the extensions its EHLO lists. The DSN
+parameters (RFC 3461) are accepted, each on its own command: `RET` on
+`RCPT TO`, or `NOTIFY` on `MAIL FROM`, is refused here.
 
-**Fix**, as a client: send only the parameters the EHLO reply announces;
-turn off DSN options (`NOTIFY`, `RET`, `ENVID`, `ORCPT`) for this server.
+**Fix**, as a client: send only the parameters the EHLO reply announces,
+each on the command it belongs to.
+
+### `INVALID_OPTION` from `sendMail`: `envid …` or `orcpt …`
+
+**When**: `sendMail` is given a DSN option it refuses, before any connection.
+The messages: `envid must be 1 to 100 printable ASCII characters, at most 100
+once encoded as xtext`; `orcpt of <address> must be { type, address }, the type
+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.
+
+**Fix**: shorten the value, or give the type as letters, digits and hyphens.
+
+```ts
+await sendMail(message, { host, from, to, envid: 'q-1042' }); // not 'q 1042 …' past 100 encoded
+```
+
+### `501 5.5.4 Syntax: RET=…`, `ENVID=…`, `NOTIFY=…`, `ORCPT=…`
+
+**When**: a DSN parameter has a value the RFC does not allow: `RET` other
+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).
+
+**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.
+
+```text
+C: RCPT TO:<bob@example.com> NOTIFY=SUCCESS,FAILURE ORCPT=rfc822;bob+2Btag@example.com
+S: 250 2.1.5 OK
+```
+
+### `501 5.5.4 … given twice`
+
+**When**: `RET`, `ENVID`, `NOTIFY` or `ORCPT` appears twice on one command.
+
+**Why**: each DSN parameter may be given once (RFC 3461 §4).
+
+**Fix**, as a client: send it once; join `NOTIFY` events in one list.
 
 ### `555 … needs EHLO`
 

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@bumail/smtp",
-	"version": "0.9.0",
+	"version": "0.10.0",
 	"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",
@@ -47,9 +47,9 @@
 		]
 	},
 	"devDependencies": {
-		"@bumail/auth": "^0.4.1",
+		"@bumail/auth": "^0.5.0",
 		"@bumail/dns": "^0.2.1",
-		"@bumail/store": "^0.4.2",
+		"@bumail/store": "^0.6.0",
 		"@types/bun": "^1.4.2"
 	},
 	"peerDependencies": {