@bumail/smtp 0.1.0

package/dist/server/options.d.ts

@@ -0,0 +1,151 @@
+import type { Path } from '../protocol/path';
+import type { Reply } from '../protocol/reply';
+import type { Credentials } from '../protocol/sasl';
+/** What the server knows of one connection; hooks read it, and may keep their own state in `data`. */
+export interface Session {
+    readonly id: string;
+    readonly remoteAddress: string;
+    /** TLS is on: implicit, or after STARTTLS. */
+    readonly secure: boolean;
+    /** The name the client gave in EHLO or HELO. */
+    readonly helo?: string;
+    /** The client said EHLO, not HELO. */
+    readonly esmtp: boolean;
+    /** The username the client authenticated as. */
+    readonly user?: string;
+    /**
+     * For the app's own state across hooks. It lasts the whole connection,
+     * STARTTLS included: what the server learnt before TLS is forgotten, but
+     * what the app keeps here is the app's to judge.
+     */
+    readonly data: Record<string, unknown>;
+}
+/** The sender and recipients of one message. */
+export interface Envelope {
+    /** `''` for the null reverse-path `<>`: a bounce. */
+    readonly from: string;
+    readonly to: readonly string[];
+    /** The client asked for SMTPUTF8 (RFC 6531). */
+    readonly smtputf8: boolean;
+    /** `7BIT` or `8BITMIME`, as MAIL FROM's BODY= said; `7BIT` when it said nothing. */
+    readonly body: '7BIT' | '8BITMIME';
+}
+/** A message on its way in, handed to `onData` as the client sends it. */
+export interface ReceivedMessage {
+    /** The id the server gave it, also in its Received field and the 250 reply. */
+    readonly id: string;
+    readonly envelope: Envelope;
+    /**
+     * The message as the client sends it, dot-unstuffed, with the server's
+     * Received field first. It holds 64 KiB at most: the server reads the
+     * client only as fast as this stream is read.
+     *
+     * It ends in an `SmtpError` when the message must not be delivered:
+     * `MESSAGE_TOO_BIG`, `BARE_LINE_BREAK` (SMTP smuggling),
+     * `CONNECTION_LOST`, `HOOK_TIMEOUT` or `MESSAGE_NOT_READ`. Read it to
+     * its end before keeping anything: a message is taken only when the
+     * stream ended cleanly and `onData` resolved, within `hookTimeout`,
+     * without a refusal. `signal` says when it was not.
+     */
+    readonly content: ReadableStream<Uint8Array>;
+    /**
+     * Aborts when the server refuses the message on `onData`'s behalf: the
+     * stream errored, `onData` accepted before reading to the end, did not
+     * answer within `hookTimeout`, threw, or answered what is not a
+     * refusal, or the connection closed before the reply. Its `reason` is
+     * the `SmtpError`, or what `onData` threw. A refusal `onData` returns
+     * leaves it alone, unless the client never hears it: a later stream
+     * failure (whose 552 or 550 replaces `onData`'s reply) or a closed
+     * connection still aborts it, with that error. The stream may already
+     * have ended cleanly, so check `signal.aborted` (or listen for `abort`)
+     * before keeping a message for good: the client will send it again.
+     */
+    readonly signal: AbortSignal;
+}
+/**
+ * What a hook answers: nothing to accept, or a reply — a 4xx or 5xx code —
+ * to refuse with. A hook that throws, answers anything else, or does not
+ * settle within `hookTimeout` refuses with `451 4.3.0`, and the error goes
+ * to `onError`.
+ */
+export type HookResult = Reply | undefined | void;
+export interface SmtpHooks {
+    /** A client connected. */
+    onConnect?(session: Session): HookResult | Promise<HookResult>;
+    /** After the server's own checks of MAIL FROM. */
+    onMailFrom?(path: Path, session: Session): HookResult | Promise<HookResult>;
+    /** After the server's own checks of RCPT TO, relaying included. */
+    onRcptTo?(path: Path, session: Session): HookResult | Promise<HookResult>;
+    /**
+     * A message is coming: read `message.content` to its end, then deliver
+     * or queue it before resolving. The reply to DATA waits for this hook
+     * and for the end of the content, so the client knows whether the
+     * message was taken. If the stream errors, do not deliver.
+     */
+    onData(message: ReceivedMessage, session: Session): HookResult | Promise<HookResult>;
+}
+/** Bun's TLS options: `key` and `cert`, as `Bun.listen` takes them. */
+export interface TlsOptions {
+    readonly key: string | Uint8Array | Bun.BunFile;
+    readonly cert: string | Uint8Array | Bun.BunFile;
+}
+export interface SmtpServerOptions extends SmtpHooks {
+    /** The server's own name, in its greeting, its EHLO reply and its Received fields. */
+    readonly hostname: string;
+    /**
+     * `mx` receives mail for `localDomains` from anyone, and relays nothing
+     * without AUTH (port 25). `submission` takes mail only from
+     * authenticated users (ports 587 and 465). Default `mx`.
+     */
+    readonly mode?: 'mx' | 'submission';
+    /**
+     * The domains this server receives mail for, matched whole and without
+     * case. A recipient anywhere else is relaying, and is refused unless the
+     * session authenticated: there is no option to relay without AUTH. A
+     * function is given the domain in lower case; if it throws or times out,
+     * that recipient gets `451 4.3.0`.
+     */
+    readonly localDomains: readonly string[] | ((domain: string) => boolean | Promise<boolean>);
+    /** Turns on STARTTLS, or TLS from the first byte with `implicitTls`. */
+    readonly tls?: TlsOptions;
+    /** TLS from the first byte (port 465, RFC 8314). Needs `tls`. */
+    readonly implicitTls?: boolean;
+    /**
+     * Checks credentials; turns on AUTH PLAIN and LOGIN (RFC 4954), offered
+     * and accepted only over TLS, so it needs `tls`. Only `true` accepts. A
+     * PLAIN authorization identity other than the username is refused before
+     * this is called: a session acts as the user it authenticated as.
+     */
+    authenticate?(credentials: Credentials, session: Session): boolean | Promise<boolean>;
+    /** The largest message, in bytes; announced with SIZE (RFC 1870). Default 25 MiB. */
+    readonly maxMessageSize?: number;
+    /** Recipients per message. Default 100, the minimum RFC 5321 §4.5.3.1.8 asks a server to take. */
+    readonly maxRecipients?: number;
+    /** Open connections at once. Default 1000. */
+    readonly maxConnections?: number;
+    /** Commands that fail before the server hangs up. Default 10. */
+    readonly maxErrors?: number;
+    /** Idle time before the server hangs up, in seconds; any byte from the client starts it again. Default 300, RFC 5321 §4.5.3.2.7's. */
+    readonly timeout?: number;
+    /**
+     * Seconds the server waits, once `onConnect` accepted, before its 220
+     * greeting. A client that talks in that time is refused with `554`
+     * (RFC 5321 §4.3.1): a legitimate client waits for the greeting, many
+     * spam senders do not. Default 0: the greeting goes out at once, and
+     * only a client that talks before it is refused.
+     */
+    readonly greetingDelay?: number;
+    /**
+     * Seconds a hook, `authenticate` or `localDomains` has to settle — and
+     * `onData` to read the next part of a message, then to answer once it
+     * ended. Past it, the command is refused with `451 4.3.0`. Default 60.
+     */
+    readonly hookTimeout?: number;
+    /**
+     * Told of what went wrong in the app's code: a hook, `authenticate` or
+     * `localDomains` that threw or timed out, or a hook reply that is not a
+     * refusal. The client only sees a 451 or 454.
+     */
+    onError?(error: unknown, session: Session): void;
+}
+//# sourceMappingURL=options.d.ts.map

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

@@ -0,0 +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,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,0BAA0B;IAC1B,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,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,iEAAiE;IACjE,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAC5B,sIAAsI;IACtI,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAC1B;;;;;;OAMG;IACH,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,CAAC;IAChC;;;;OAIG;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/received.d.ts

@@ -0,0 +1,11 @@
+import type { Connection } from './connection';
+/** An RFC 5322 §3.3 date-time, in UTC. */
+export declare function dateTime(date: Date): string;
+/** RFC 3848: how the message came — SMTP, ESMTP, then S for TLS and A for AUTH. */
+export declare function protocolOf(esmtp: boolean, secure: boolean, authenticated: boolean): string;
+/**
+ * The Received field the server puts on top (RFC 5321 §4.4): who sent the
+ * message, from where, how, to whom when there is one recipient, and when.
+ */
+export declare function receivedField(connection: Connection, recipients: readonly string[], id: string, now?: Date): string;
+//# sourceMappingURL=received.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"received.d.ts","sourceRoot":"","sources":["../../src/server/received.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAoB/C,0CAA0C;AAC1C,wBAAgB,QAAQ,CAAC,IAAI,EAAE,IAAI,GAAG,MAAM,CAE3C;AAED,mFAAmF;AACnF,wBAAgB,UAAU,CACzB,KAAK,EAAE,OAAO,EACd,MAAM,EAAE,OAAO,EACf,aAAa,EAAE,OAAO,GACpB,MAAM,CAGR;AAiBD;;;GAGG;AACH,wBAAgB,aAAa,CAC5B,UAAU,EAAE,UAAU,EACtB,UAAU,EAAE,SAAS,MAAM,EAAE,EAC7B,EAAE,EAAE,MAAM,EACV,GAAG,OAAa,GACd,MAAM,CAYR"}

package/dist/server/refusals.d.ts

@@ -0,0 +1,16 @@
+import { SmtpError } from '../errors';
+/** Why a message on its way in is refused, as the reply and the error `onData` and `onError` see. */
+export declare const TOO_BIG: import("..").Reply;
+export declare const BARE_LINE_BREAK: import("..").Reply;
+export declare function tooBig(maxMessageSize: number): SmtpError;
+/** A bare CR or LF is how SMTP smuggling hides a second message. */
+export declare function bareLineBreak(): SmtpError;
+/**
+ * The connection closed mid-message, or after its end but before the reply:
+ * the client hung up, or the server closed it (idle timeout, socket error).
+ */
+export declare function connectionLost(ended: boolean): SmtpError;
+export declare function notAnswered(seconds: number): SmtpError;
+export declare function notReadInTime(seconds: number): SmtpError;
+export declare function notRead(): SmtpError;
+//# sourceMappingURL=refusals.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"refusals.d.ts","sourceRoot":"","sources":["../../src/server/refusals.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AAGtC,qGAAqG;AAErG,eAAO,MAAM,OAAO,oBAAoD,CAAC;AAEzE,eAAO,MAAM,eAAe,oBAI3B,CAAC;AAEF,wBAAgB,MAAM,CAAC,cAAc,EAAE,MAAM,GAAG,SAAS,CAKxD;AAED,oEAAoE;AACpE,wBAAgB,aAAa,IAAI,SAAS,CAKzC;AAED;;;GAGG;AACH,wBAAgB,cAAc,CAAC,KAAK,EAAE,OAAO,GAAG,SAAS,CAOxD;AAED,wBAAgB,WAAW,CAAC,OAAO,EAAE,MAAM,GAAG,SAAS,CAKtD;AAED,wBAAgB,aAAa,CAAC,OAAO,EAAE,MAAM,GAAG,SAAS,CAKxD;AAED,wBAAgB,OAAO,IAAI,SAAS,CAKnC"}

package/dist/server/server.d.ts

@@ -0,0 +1,25 @@
+import type { SmtpServerOptions } from './options';
+export interface SmtpServer {
+    /** Starts listening; resolves once the port is bound. Once only: a second call throws. */
+    listen(options: {
+        port: number;
+        hostname?: string;
+    }): Promise<{
+        port: number;
+        hostname: string;
+    }>;
+    /** Stops listening; `closeConnections` hangs up on every client too. */
+    stop(closeConnections?: boolean): void;
+    /** Open connections. */
+    readonly connections: number;
+}
+/**
+ * An SMTP server (RFC 5321) on `Bun.listen`: EHLO with PIPELINING, SIZE,
+ * 8BITMIME, SMTPUTF8 and ENHANCEDSTATUSCODES; STARTTLS (RFC 3207) or
+ * implicit TLS (RFC 8314); AUTH PLAIN and LOGIN over TLS only (RFC 4954);
+ * policy through hooks. It never relays without AUTH: a recipient outside
+ * `localDomains` is refused to an unauthenticated session, whatever the
+ * hooks say.
+ */
+export declare function createSmtpServer(options: SmtpServerOptions): SmtpServer;
+//# sourceMappingURL=server.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"server.d.ts","sourceRoot":"","sources":["../../src/server/server.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,WAAW,CAAC;AAWnD,MAAM,WAAW,UAAU;IAC1B,0FAA0F;IAC1F,MAAM,CAAC,OAAO,EAAE;QACf,IAAI,EAAE,MAAM,CAAC;QACb,QAAQ,CAAC,EAAE,MAAM,CAAC;KAClB,GAAG,OAAO,CAAC;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IAChD,wEAAwE;IACxE,IAAI,CAAC,gBAAgB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IACvC,wBAAwB;IACxB,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;CAC7B;AAqED;;;;;;;GAOG;AACH,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,iBAAiB,GAAG,UAAU,CAuDvE"}

package/dist/server/settings.d.ts

@@ -0,0 +1,16 @@
+import type { SmtpServerOptions } from './options';
+/** The options with their defaults, checked once. */
+export interface Settings {
+    readonly options: SmtpServerOptions;
+    readonly mode: 'mx' | 'submission';
+    readonly maxMessageSize: number;
+    readonly maxRecipients: number;
+    readonly maxConnections: number;
+    readonly maxErrors: number;
+    readonly timeout: number;
+    readonly hookTimeout: number;
+    readonly greetingDelay: number;
+    isLocal(domain: string): boolean | Promise<boolean>;
+}
+export declare function settingsOf(options: SmtpServerOptions): Settings;
+//# sourceMappingURL=settings.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"settings.d.ts","sourceRoot":"","sources":["../../src/server/settings.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,WAAW,CAAC;AAEnD,qDAAqD;AACrD,MAAM,WAAW,QAAQ;IACxB,QAAQ,CAAC,OAAO,EAAE,iBAAiB,CAAC;IACpC,QAAQ,CAAC,IAAI,EAAE,IAAI,GAAG,YAAY,CAAC;IACnC,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC;IAChC,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAC;IAC/B,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC;IAChC,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAC;IAC/B,OAAO,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;CACpD;AAgDD,wBAAgB,UAAU,CAAC,OAAO,EAAE,iBAAiB,GAAG,QAAQ,CA+C/D"}

package/dist/server/state.d.ts

@@ -0,0 +1,24 @@
+import type { Envelope } from './options';
+/** A mail transaction in progress (RFC 5321 §3.3). */
+export interface Transaction {
+    from?: string;
+    to: string[];
+    smtputf8: boolean;
+    body: Envelope['body'];
+}
+/** What the next line from the client is. */
+export type Waiting = 'command' | 'data' | 'auth-plain' | 'auth-login-user' | 'auth-login-password';
+/** The state of a session the commands change. */
+export interface State {
+    helo?: string | undefined;
+    esmtp: boolean;
+    user?: string | undefined;
+    secure: boolean;
+    transaction: Transaction;
+    waiting: Waiting;
+    loginUser?: string | undefined;
+    errors: number;
+    authFailures: number;
+}
+export declare const emptyTransaction: () => Transaction;
+//# sourceMappingURL=state.d.ts.map

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

@@ -0,0 +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"}

package/dist/server/transaction.d.ts

@@ -0,0 +1,6 @@
+import type { Connection } from './connection';
+/** `MAIL FROM:<path> [SIZE=] [BODY=] [SMTPUTF8] [AUTH=]` (RFC 5321 §4.1.1.2). */
+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. */
+export declare function rcpt(connection: Connection, argument: string): Promise<void>;
+//# sourceMappingURL=transaction.d.ts.map

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

@@ -0,0 +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,CAwCf"}

package/dist/server/transport.d.ts

@@ -0,0 +1,42 @@
+import type { Socket } from 'bun';
+/** What a connection needs from its socket: Bun's, or a fake one in specs. */
+export interface Transport {
+    readonly remoteAddress: string;
+    readonly secure: boolean;
+    /** Queues text for the client; what the socket cannot take now is kept for `drain`. */
+    write(text: string): void;
+    /** Resolves once everything written has left. */
+    drained(): Promise<void>;
+    /** Hangs up once everything written has left. */
+    end(): void;
+    /** Stops reading from the client, while the server catches up. */
+    pause(): void;
+    resume(): void;
+    /** Starts TLS on the connection, once the 220 to STARTTLS has left. */
+    startTls(): void;
+    /** Starts the idle time again, as a byte from the client does. */
+    restartIdle(seconds: number): void;
+}
+/**
+ * A Bun socket as a Transport. Bun's sockets do not buffer: `write` takes
+ * what the kernel takes and says how much. The rest waits here for the
+ * `drain` event, so no reply is lost to a client that reads slowly.
+ */
+export declare class SocketTransport implements Transport {
+    #private;
+    readonly remoteAddress: string;
+    readonly secure: boolean;
+    constructor(socket: Socket<unknown>, secure: boolean, startTls: () => void, remoteAddress?: string);
+    write(text: string): void;
+    /** Bun's `drain`: the socket can take more. */
+    drain(): void;
+    drained(): Promise<void>;
+    /** The socket closed: nothing more will leave. */
+    closed(): void;
+    end(): void;
+    pause(): void;
+    resume(): void;
+    startTls(): void;
+    restartIdle(seconds: number): void;
+}
+//# sourceMappingURL=transport.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"transport.d.ts","sourceRoot":"","sources":["../../src/server/transport.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,KAAK,CAAC;AAElC,8EAA8E;AAC9E,MAAM,WAAW,SAAS;IACzB,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAC;IAC/B,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC;IACzB,uFAAuF;IACvF,KAAK,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,iDAAiD;IACjD,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IACzB,iDAAiD;IACjD,GAAG,IAAI,IAAI,CAAC;IACZ,kEAAkE;IAClE,KAAK,IAAI,IAAI,CAAC;IACd,MAAM,IAAI,IAAI,CAAC;IACf,uEAAuE;IACvE,QAAQ,IAAI,IAAI,CAAC;IACjB,kEAAkE;IAClE,WAAW,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;CACnC;AAED;;;;GAIG;AACH,qBAAa,eAAgB,YAAW,SAAS;;IAEhD,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAC;IAC/B,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC;gBAOxB,MAAM,EAAE,MAAM,CAAC,OAAO,CAAC,EACvB,MAAM,EAAE,OAAO,EACf,QAAQ,EAAE,MAAM,IAAI,EACpB,aAAa,SAAuB;IAQrC,KAAK,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAUzB,+CAA+C;IAC/C,KAAK,IAAI,IAAI;IAcb,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAKxB,kDAAkD;IAClD,MAAM,IAAI,IAAI;IAKd,GAAG,IAAI,IAAI;IAKX,KAAK,IAAI,IAAI;IAIb,MAAM,IAAI,IAAI;IAId,QAAQ,IAAI,IAAI;IAIhB,WAAW,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI;CAGlC"}

package/docs/README.md

@@ -0,0 +1,10 @@
+# @bumail/smtp documentation
+
+The [package README](../README.md) is the short version. This folder is the
+long one.
+
+| Page | Read it when |
+| --- | --- |
+| [Guide](guide.md) | running an MX, a submission server or implicit TLS; reading what a reply means; writing hooks and keeping state in `Session.data`; handling what `onData` receives; delivering into `@bumail/store`; setting TLS, limits and `greetingDelay`; or checking which RFC a behaviour follows |
+| [Troubleshooting](troubleshooting.md) | `createSmtpServer` threw, the server will not listen, or a client reports a reply you did not expect |
+| [Roadmap](roadmap.md) | wondering what is coming — the client, DSN, a ready-made delivery into the store — and what is not planned |