@mxraven/mail 0.1.0

package/dist/index.d.cts

@@ -0,0 +1,323 @@
+import { ConnectionOptions } from "node:tls";
+//#region src/message.d.ts
+/** A custom message header. */
+interface Header {
+  /** The header field name. */
+  readonly name: string;
+  /** The header field value. It must not contain line breaks. */
+  readonly value: string;
+}
+/**
+ * A message attachment.
+ *
+ * The attachment data is retained by reference until the message is built. Callers must not mutate
+ * it in the meantime.
+ */
+interface Attachment {
+  /** The attachment filename. It may be empty. */
+  readonly filename?: string;
+  /** The media type. Defaults to `application/octet-stream`. */
+  readonly contentType?: string;
+  /** The raw attachment content. The caller retains ownership. */
+  readonly data: Uint8Array;
+  /** Marks the attachment for inline display, for example a `cid:` image. */
+  readonly inline?: boolean;
+  /** The inline content identifier, without angle brackets. */
+  readonly contentId?: string;
+}
+/**
+ * The SMTP envelope for a raw message, independent of the message headers.
+ *
+ * @public
+ */
+interface Envelope {
+  /**
+   * The envelope sender. An empty or omitted value requests a null reverse-path, which is
+   * appropriate for bounce messages.
+   */
+  readonly from?: string;
+  /** At least one envelope recipient. */
+  readonly to: readonly string[];
+}
+/**
+ * A mutable, chainable builder for an email message.
+ *
+ * Chained methods return the receiver, so a message is normally composed in a single expression. A
+ * `Message` is not safe for concurrent use. It can be sent repeatedly; each send serializes the
+ * current state.
+ *
+ * @example
+ * ```ts
+ * const message = new Message()
+ *   .from("Acme <noreply@acme.example>")
+ *   .to("customer@example.com")
+ *   .subject("Your receipt")
+ *   .text("Thanks for your order.")
+ *   .html("<p>Thanks for your order.</p>");
+ * ```
+ *
+ * @public
+ */
+export declare class Message {
+  private fromAddress;
+  private isNullSender;
+  private senderAddress;
+  private replyToAddress;
+  private toAddresses;
+  private ccAddresses;
+  private bccAddresses;
+  private subjectText;
+  private textBody;
+  private htmlBody;
+  private customHeaders;
+  private attachments;
+  private messageIdValue;
+  private inReplyToValue;
+  private referencesValue;
+  private dateValue;
+  /** Sets the envelope sender and the `From` header. */
+  from(address: string): this;
+  /**
+   * Uses a null reverse-path while keeping the `From` header.
+   *
+   * It is intended for bounce and other auto-generated messages. A `From` header is still required
+   * for a valid message.
+   */
+  nullSender(): this;
+  /** Sets the `Sender` header, required when `From` contains more than one mailbox. */
+  sender(address: string): this;
+  /** Sets the `Reply-To` header. */
+  replyTo(address: string): this;
+  /** Adds envelope and `To` header recipients. */
+  to(addresses: string | readonly string[]): this;
+  /** Adds envelope and `Cc` header recipients. */
+  cc(addresses: string | readonly string[]): this;
+  /** Adds envelope recipients without a visible `Bcc` header. */
+  bcc(addresses: string | readonly string[]): this;
+  /** Sets the `Subject` header. Non-ASCII subjects are RFC 2047 encoded. */
+  subject(subject: string): this;
+  /** Sets the `Message-ID` header. The value is wrapped in angle brackets when needed. */
+  messageId(id: string): this;
+  /** Sets the `In-Reply-To` header for threading. */
+  inReplyTo(id: string): this;
+  /** Sets the `References` header for threading. */
+  references(ids: string | readonly string[]): this;
+  /** Sets the `Date` header. When unset, the time of sending is used. */
+  date(date: Date): this;
+  /**
+   * Sets the plain-text body.
+   *
+   * When both a text and an HTML body are set, the message is sent as `multipart/alternative`.
+   */
+  text(body: string): this;
+  /**
+   * Sets the HTML body.
+   *
+   * When both a text and an HTML body are set, the message is sent as `multipart/alternative`.
+   */
+  html(body: string): this;
+  /** Appends a custom header. */
+  header(name: string, value: string): this;
+  /**
+   * Appends an attachment.
+   *
+   * The data is retained by reference until the message is built. Callers must not mutate it in the
+   * meantime.
+   */
+  attach(attachment: Attachment): this;
+  /** Appends a file attachment with an `application/octet-stream` content type. */
+  attachFile(filename: string, data: Uint8Array): this;
+  /** Appends an inline attachment referenced by `contentId`, for example from `cid:` HTML. */
+  attachInline(filename: string, contentId: string, data: Uint8Array): this;
+  /** Renders the body, wrapping attachments in `multipart/mixed` when present. */
+  private renderBody;
+  /** Parses an optional address, recording a problem when invalid. */
+  private parseOptional;
+  /** Parses a list of addresses, recording problems for invalid entries. */
+  private parseMany;
+}
+//#endregion
+//#region src/result.d.ts
+/**
+ * Describes the outcome of a submission that reached the server.
+ *
+ * @public
+ */
+interface Result {
+  /**
+   * The mxRaven message reference from the server's final `message_ref=<uuid>` reply. It is empty
+   * when the server did not report one.
+   */
+  readonly messageRef: string;
+  /** The three-digit SMTP reply code of the final reply. */
+  readonly code: number;
+  /** The final SMTP reply text. It is intended for humans and is not stable. */
+  readonly message: string;
+  /**
+   * Per-recipient acceptance. It is populated when the server returned individual `RCPT TO`
+   * responses.
+   */
+  readonly recipients: readonly RecipientResult[];
+}
+/**
+ * Reports whether a single envelope recipient was accepted.
+ *
+ * @public
+ */
+interface RecipientResult {
+  /** The recipient address as submitted. */
+  readonly address: string;
+  /** Whether the server accepted the recipient. */
+  readonly accepted: boolean;
+  /** The rejection reason when {@link RecipientResult.accepted} is `false`. */
+  readonly error?: Error;
+}
+//#endregion
+//#region src/client.d.ts
+/** The default mxRaven SMTP submission port. */
+export declare const defaultAddressPort = 587;
+/** Options for a {@link Client}. */
+interface ClientOptions {
+  /** The submission server host. A port must not be included. */
+  readonly host: string;
+  /** The submission server port. Defaults to {@link defaultAddressPort}. */
+  readonly port?: number;
+  /** The submission API key username, for example `mxr_tx_ab12cd34ef56`. */
+  readonly username: string;
+  /** The submission API key secret. */
+  readonly secret: string;
+  /** STARTTLS options, for example a custom CA or `servername`. */
+  readonly tls?: ConnectionOptions;
+  /** The maximum number of pooled connections. Defaults to 5. */
+  readonly poolSize?: number;
+  /** The TCP connect deadline in milliseconds. Defaults to 30000. */
+  readonly connectTimeout?: number;
+  /** The per-read deadline in milliseconds. Defaults to 300000. */
+  readonly readTimeout?: number;
+  /** The per-write deadline in milliseconds. Defaults to 300000. */
+  readonly writeTimeout?: number;
+  /** The name sent in EHLO. Defaults to `localhost`. */
+  readonly localName?: string;
+}
+/** Per-call options for {@link Client.send} and {@link Client.sendRaw}. */
+interface SendOptions {
+  /** Cancels the submission. */
+  readonly signal?: AbortSignal;
+}
+/**
+ * Submits mail to the mxRaven SMTP submission service.
+ *
+ * A client maintains a bounded pool of authenticated connections and is safe
+ * for concurrent use. The submission service requires STARTTLS and SMTP AUTH,
+ * so both are always used.
+ *
+ * @example
+ * ```ts
+ * const secret = process.env.MXRAVEN_SECRET;
+ * if (secret === undefined || secret === "") {
+ *   throw new Error("MXRAVEN_SECRET is required");
+ * }
+ *
+ * const client = new Client({
+ *   host: "smtp.mxraven.com",
+ *   username: "mxr_tx_ab12cd34ef56",
+ *   secret,
+ * });
+ * const result = await client.send(
+ *   new Message().from("noreply@acme.example").to("customer@example.com").text("Hi"),
+ * );
+ * await client.close();
+ * ```
+ *
+ * @public
+ */
+export declare class Client {
+  private readonly pool;
+  /**
+   * @param options - The server address, credentials, and tuning options.
+   * @throws `Error` When required options are missing or invalid.
+   */
+  constructor(options: ClientOptions);
+  /**
+   * Sends a composed message.
+   *
+   * @param message - The message to submit. It may be sent more than once.
+   * @param options - An optional cancellation signal.
+   * @returns The server's result for the submission.
+   * @throws {@link SMTPError} When the server rejects a command.
+   * @throws {@link SMTPTransactionError} When every recipient is rejected; the
+   * per-recipient detail is on {@link SMTPTransactionError.result}.
+   *
+   * @public
+   */
+  send(message: Message, options?: SendOptions): Promise<Result>;
+  /**
+   * Streams an already serialized RFC 5322 message with an explicit envelope.
+   *
+   * The message is not parsed, so the caller is responsible for RFC 5322
+   * correctness. Prefer this for large or pre-rendered messages.
+   *
+   * @param envelope - The SMTP envelope, independent of the message headers.
+   * @param data - The raw message bytes, or an async stream of chunks.
+   * @param options - An optional cancellation signal.
+   * @returns The server's result for the submission.
+   * @throws {@link SMTPError} When the server rejects a command.
+   * @throws {@link SMTPTransactionError} When every recipient is rejected.
+   *
+   * @public
+   */
+  sendRaw(envelope: Envelope, data: Uint8Array | AsyncIterable<Uint8Array>, options?: SendOptions): Promise<Result>;
+  /** Releases the pooled connections. It is safe to call more than once. */
+  close(): Promise<void>;
+  private transact;
+  private toEnvelope;
+  private envelopeFromPublic;
+}
+//#endregion
+//#region src/errors.d.ts
+/**
+ * An SMTP reply that rejected a submission.
+ *
+ * It is thrown when the server refuses a command, for example when the sender
+ * domain is not authorized or a recipient is rejected. Inspect {@link SMTPError.code}
+ * or {@link SMTPError.enhancedCode} to make a delivery decision; the `message`
+ * is intended for humans and is not stable.
+ *
+ * @public
+ */
+export declare class SMTPError extends Error {
+  /** The three-digit SMTP reply code. */
+  readonly code: number;
+  /** The RFC 3463 enhanced status code, when the server supplied one. */
+  readonly enhancedCode?: string;
+  /** @param options - The reply code, optional enhanced code, and reply text. */
+  constructor(options: {
+    code: number;
+    enhancedCode?: string;
+    message: string;
+  });
+  /** Reports whether the failure is permanent (5xx). Retrying is unlikely to succeed. */
+  get permanent(): boolean;
+  /** Reports whether the failure is transient (4xx). The message may be retried later. */
+  get transient(): boolean;
+}
+/**
+ * A submission the server rejected after per-recipient results were collected.
+ *
+ * It is thrown when every envelope recipient was rejected. The per-recipient
+ * detail remains available in {@link SMTPTransactionError.result}.
+ *
+ * @public
+ */
+export declare class SMTPTransactionError extends Error {
+  /** The per-recipient results collected before the failure. */
+  readonly result: Result;
+  /**
+   * @param message - A human-readable description.
+   * @param result - The partial submission result.
+   */
+  constructor(message: string, result: Result);
+}
+//#endregion
+export type { Attachment, ClientOptions, Envelope, Header, RecipientResult, Result, SendOptions };
+//# sourceMappingURL=index.d.cts.map

package/dist/index.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.cts","names":[],"sources":["../src/message.ts","../src/result.ts","../src/client.ts","../src/errors.ts"],"mappings":";;;UA2BiB;;WAEN;;WAEA;;;;;;;;UASM;;WAEN;;WAEA;;WAEA,MAAM;;WAEN;;WAEA;;;;;;;UAQM;;;;;WAKN;;WAEA;;;;;;;;;;;;;;;;;;;;;qBA8CE;UACH;UACA;UACA;UACA;UACA;UACA;UACA;UACA;UACA;UACA;UACA;UACA;UACA;UACA;UACA;UACA;;EAGR,KAAK;;;;;;;EAWL;;EAMA,OAAO;;EAMP,QAAQ;;EAMR,GAAG;;EAMH,GAAG;;EAMH,IAAI;;EAMJ,QAAQ;;EAMR,UAAU;;EAMV,UAAU;;EAMV,WAAW;;EAMX,KAAK,MAAM;;;;;;EAUX,KAAK;;;;;;EAUL,KAAK;;EAML,OAAO,cAAc;;;;;;;EAWrB,OAAO,YAAY;;EAMnB,WAAW,kBAAkB,MAAM;;EAKnC,aAAa,kBAAkB,mBAAmB,MAAM;;UA6GhD;;UAqDA;;UAiBA;;;;;;;;;UCvaO;;;;;WAKN;;WAGA;;WAGA;;;;;WAMA,qBAAqB;;;;;;;UAQf;;WAEN;;WAGA;;WAGA,QAAQ;;;;;qBC1BN;;UAGI;;WAEN;;WAEA;;WAEA;;WAEA;;WAEA,MAAM;;WAEN;;WAEA;;WAEA;;WAEA;;WAEA;;;UAIM;;WAEN,SAAS;;;;;;;;;;;;;;;;;;;;;;;;;;;;;qBAgCP;mBACM;;;;;EAML,YAAA,SAAS;;;;;;;;;;;;;EAmDf,KAAK,SAAS,SAAS,UAAS,cAAmB,QAAQ;;;;;;;;;;;;;;;;EA0B3D,QACJ,UAAU,UACV,MAAM,aAAa,cAAc,aACjC,UAAS,cACR,QAAQ;;EASL,SAAS;UAID;UAWN;UASA;;;;;;;;;;;;;;qBCtLG,kBAAkB;;WAEpB;;WAGA;;EAGG,YAAA;IAAW;IAAc;IAAuB;;;MAQxD;;MAKA;;;;;;;;;;qBAaO,6BAA6B;;WAE/B,QAAQ;;;;;EAML,YAAA,iBAAiB,QAAQ"}

package/dist/index.d.ts

@@ -0,0 +1,323 @@
+import { ConnectionOptions } from "node:tls";
+//#region src/message.d.ts
+/** A custom message header. */
+interface Header {
+  /** The header field name. */
+  readonly name: string;
+  /** The header field value. It must not contain line breaks. */
+  readonly value: string;
+}
+/**
+ * A message attachment.
+ *
+ * The attachment data is retained by reference until the message is built. Callers must not mutate
+ * it in the meantime.
+ */
+interface Attachment {
+  /** The attachment filename. It may be empty. */
+  readonly filename?: string;
+  /** The media type. Defaults to `application/octet-stream`. */
+  readonly contentType?: string;
+  /** The raw attachment content. The caller retains ownership. */
+  readonly data: Uint8Array;
+  /** Marks the attachment for inline display, for example a `cid:` image. */
+  readonly inline?: boolean;
+  /** The inline content identifier, without angle brackets. */
+  readonly contentId?: string;
+}
+/**
+ * The SMTP envelope for a raw message, independent of the message headers.
+ *
+ * @public
+ */
+interface Envelope {
+  /**
+   * The envelope sender. An empty or omitted value requests a null reverse-path, which is
+   * appropriate for bounce messages.
+   */
+  readonly from?: string;
+  /** At least one envelope recipient. */
+  readonly to: readonly string[];
+}
+/**
+ * A mutable, chainable builder for an email message.
+ *
+ * Chained methods return the receiver, so a message is normally composed in a single expression. A
+ * `Message` is not safe for concurrent use. It can be sent repeatedly; each send serializes the
+ * current state.
+ *
+ * @example
+ * ```ts
+ * const message = new Message()
+ *   .from("Acme <noreply@acme.example>")
+ *   .to("customer@example.com")
+ *   .subject("Your receipt")
+ *   .text("Thanks for your order.")
+ *   .html("<p>Thanks for your order.</p>");
+ * ```
+ *
+ * @public
+ */
+export declare class Message {
+  private fromAddress;
+  private isNullSender;
+  private senderAddress;
+  private replyToAddress;
+  private toAddresses;
+  private ccAddresses;
+  private bccAddresses;
+  private subjectText;
+  private textBody;
+  private htmlBody;
+  private customHeaders;
+  private attachments;
+  private messageIdValue;
+  private inReplyToValue;
+  private referencesValue;
+  private dateValue;
+  /** Sets the envelope sender and the `From` header. */
+  from(address: string): this;
+  /**
+   * Uses a null reverse-path while keeping the `From` header.
+   *
+   * It is intended for bounce and other auto-generated messages. A `From` header is still required
+   * for a valid message.
+   */
+  nullSender(): this;
+  /** Sets the `Sender` header, required when `From` contains more than one mailbox. */
+  sender(address: string): this;
+  /** Sets the `Reply-To` header. */
+  replyTo(address: string): this;
+  /** Adds envelope and `To` header recipients. */
+  to(addresses: string | readonly string[]): this;
+  /** Adds envelope and `Cc` header recipients. */
+  cc(addresses: string | readonly string[]): this;
+  /** Adds envelope recipients without a visible `Bcc` header. */
+  bcc(addresses: string | readonly string[]): this;
+  /** Sets the `Subject` header. Non-ASCII subjects are RFC 2047 encoded. */
+  subject(subject: string): this;
+  /** Sets the `Message-ID` header. The value is wrapped in angle brackets when needed. */
+  messageId(id: string): this;
+  /** Sets the `In-Reply-To` header for threading. */
+  inReplyTo(id: string): this;
+  /** Sets the `References` header for threading. */
+  references(ids: string | readonly string[]): this;
+  /** Sets the `Date` header. When unset, the time of sending is used. */
+  date(date: Date): this;
+  /**
+   * Sets the plain-text body.
+   *
+   * When both a text and an HTML body are set, the message is sent as `multipart/alternative`.
+   */
+  text(body: string): this;
+  /**
+   * Sets the HTML body.
+   *
+   * When both a text and an HTML body are set, the message is sent as `multipart/alternative`.
+   */
+  html(body: string): this;
+  /** Appends a custom header. */
+  header(name: string, value: string): this;
+  /**
+   * Appends an attachment.
+   *
+   * The data is retained by reference until the message is built. Callers must not mutate it in the
+   * meantime.
+   */
+  attach(attachment: Attachment): this;
+  /** Appends a file attachment with an `application/octet-stream` content type. */
+  attachFile(filename: string, data: Uint8Array): this;
+  /** Appends an inline attachment referenced by `contentId`, for example from `cid:` HTML. */
+  attachInline(filename: string, contentId: string, data: Uint8Array): this;
+  /** Renders the body, wrapping attachments in `multipart/mixed` when present. */
+  private renderBody;
+  /** Parses an optional address, recording a problem when invalid. */
+  private parseOptional;
+  /** Parses a list of addresses, recording problems for invalid entries. */
+  private parseMany;
+}
+//#endregion
+//#region src/result.d.ts
+/**
+ * Describes the outcome of a submission that reached the server.
+ *
+ * @public
+ */
+interface Result {
+  /**
+   * The mxRaven message reference from the server's final `message_ref=<uuid>` reply. It is empty
+   * when the server did not report one.
+   */
+  readonly messageRef: string;
+  /** The three-digit SMTP reply code of the final reply. */
+  readonly code: number;
+  /** The final SMTP reply text. It is intended for humans and is not stable. */
+  readonly message: string;
+  /**
+   * Per-recipient acceptance. It is populated when the server returned individual `RCPT TO`
+   * responses.
+   */
+  readonly recipients: readonly RecipientResult[];
+}
+/**
+ * Reports whether a single envelope recipient was accepted.
+ *
+ * @public
+ */
+interface RecipientResult {
+  /** The recipient address as submitted. */
+  readonly address: string;
+  /** Whether the server accepted the recipient. */
+  readonly accepted: boolean;
+  /** The rejection reason when {@link RecipientResult.accepted} is `false`. */
+  readonly error?: Error;
+}
+//#endregion
+//#region src/client.d.ts
+/** The default mxRaven SMTP submission port. */
+export declare const defaultAddressPort = 587;
+/** Options for a {@link Client}. */
+interface ClientOptions {
+  /** The submission server host. A port must not be included. */
+  readonly host: string;
+  /** The submission server port. Defaults to {@link defaultAddressPort}. */
+  readonly port?: number;
+  /** The submission API key username, for example `mxr_tx_ab12cd34ef56`. */
+  readonly username: string;
+  /** The submission API key secret. */
+  readonly secret: string;
+  /** STARTTLS options, for example a custom CA or `servername`. */
+  readonly tls?: ConnectionOptions;
+  /** The maximum number of pooled connections. Defaults to 5. */
+  readonly poolSize?: number;
+  /** The TCP connect deadline in milliseconds. Defaults to 30000. */
+  readonly connectTimeout?: number;
+  /** The per-read deadline in milliseconds. Defaults to 300000. */
+  readonly readTimeout?: number;
+  /** The per-write deadline in milliseconds. Defaults to 300000. */
+  readonly writeTimeout?: number;
+  /** The name sent in EHLO. Defaults to `localhost`. */
+  readonly localName?: string;
+}
+/** Per-call options for {@link Client.send} and {@link Client.sendRaw}. */
+interface SendOptions {
+  /** Cancels the submission. */
+  readonly signal?: AbortSignal;
+}
+/**
+ * Submits mail to the mxRaven SMTP submission service.
+ *
+ * A client maintains a bounded pool of authenticated connections and is safe
+ * for concurrent use. The submission service requires STARTTLS and SMTP AUTH,
+ * so both are always used.
+ *
+ * @example
+ * ```ts
+ * const secret = process.env.MXRAVEN_SECRET;
+ * if (secret === undefined || secret === "") {
+ *   throw new Error("MXRAVEN_SECRET is required");
+ * }
+ *
+ * const client = new Client({
+ *   host: "smtp.mxraven.com",
+ *   username: "mxr_tx_ab12cd34ef56",
+ *   secret,
+ * });
+ * const result = await client.send(
+ *   new Message().from("noreply@acme.example").to("customer@example.com").text("Hi"),
+ * );
+ * await client.close();
+ * ```
+ *
+ * @public
+ */
+export declare class Client {
+  private readonly pool;
+  /**
+   * @param options - The server address, credentials, and tuning options.
+   * @throws `Error` When required options are missing or invalid.
+   */
+  constructor(options: ClientOptions);
+  /**
+   * Sends a composed message.
+   *
+   * @param message - The message to submit. It may be sent more than once.
+   * @param options - An optional cancellation signal.
+   * @returns The server's result for the submission.
+   * @throws {@link SMTPError} When the server rejects a command.
+   * @throws {@link SMTPTransactionError} When every recipient is rejected; the
+   * per-recipient detail is on {@link SMTPTransactionError.result}.
+   *
+   * @public
+   */
+  send(message: Message, options?: SendOptions): Promise<Result>;
+  /**
+   * Streams an already serialized RFC 5322 message with an explicit envelope.
+   *
+   * The message is not parsed, so the caller is responsible for RFC 5322
+   * correctness. Prefer this for large or pre-rendered messages.
+   *
+   * @param envelope - The SMTP envelope, independent of the message headers.
+   * @param data - The raw message bytes, or an async stream of chunks.
+   * @param options - An optional cancellation signal.
+   * @returns The server's result for the submission.
+   * @throws {@link SMTPError} When the server rejects a command.
+   * @throws {@link SMTPTransactionError} When every recipient is rejected.
+   *
+   * @public
+   */
+  sendRaw(envelope: Envelope, data: Uint8Array | AsyncIterable<Uint8Array>, options?: SendOptions): Promise<Result>;
+  /** Releases the pooled connections. It is safe to call more than once. */
+  close(): Promise<void>;
+  private transact;
+  private toEnvelope;
+  private envelopeFromPublic;
+}
+//#endregion
+//#region src/errors.d.ts
+/**
+ * An SMTP reply that rejected a submission.
+ *
+ * It is thrown when the server refuses a command, for example when the sender
+ * domain is not authorized or a recipient is rejected. Inspect {@link SMTPError.code}
+ * or {@link SMTPError.enhancedCode} to make a delivery decision; the `message`
+ * is intended for humans and is not stable.
+ *
+ * @public
+ */
+export declare class SMTPError extends Error {
+  /** The three-digit SMTP reply code. */
+  readonly code: number;
+  /** The RFC 3463 enhanced status code, when the server supplied one. */
+  readonly enhancedCode?: string;
+  /** @param options - The reply code, optional enhanced code, and reply text. */
+  constructor(options: {
+    code: number;
+    enhancedCode?: string;
+    message: string;
+  });
+  /** Reports whether the failure is permanent (5xx). Retrying is unlikely to succeed. */
+  get permanent(): boolean;
+  /** Reports whether the failure is transient (4xx). The message may be retried later. */
+  get transient(): boolean;
+}
+/**
+ * A submission the server rejected after per-recipient results were collected.
+ *
+ * It is thrown when every envelope recipient was rejected. The per-recipient
+ * detail remains available in {@link SMTPTransactionError.result}.
+ *
+ * @public
+ */
+export declare class SMTPTransactionError extends Error {
+  /** The per-recipient results collected before the failure. */
+  readonly result: Result;
+  /**
+   * @param message - A human-readable description.
+   * @param result - The partial submission result.
+   */
+  constructor(message: string, result: Result);
+}
+//#endregion
+export type { Attachment, ClientOptions, Envelope, Header, RecipientResult, Result, SendOptions };
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","names":[],"sources":["../src/message.ts","../src/result.ts","../src/client.ts","../src/errors.ts"],"mappings":";;;UA2BiB;;WAEN;;WAEA;;;;;;;;UASM;;WAEN;;WAEA;;WAEA,MAAM;;WAEN;;WAEA;;;;;;;UAQM;;;;;WAKN;;WAEA;;;;;;;;;;;;;;;;;;;;;qBA8CE;UACH;UACA;UACA;UACA;UACA;UACA;UACA;UACA;UACA;UACA;UACA;UACA;UACA;UACA;UACA;UACA;;EAGR,KAAK;;;;;;;EAWL;;EAMA,OAAO;;EAMP,QAAQ;;EAMR,GAAG;;EAMH,GAAG;;EAMH,IAAI;;EAMJ,QAAQ;;EAMR,UAAU;;EAMV,UAAU;;EAMV,WAAW;;EAMX,KAAK,MAAM;;;;;;EAUX,KAAK;;;;;;EAUL,KAAK;;EAML,OAAO,cAAc;;;;;;;EAWrB,OAAO,YAAY;;EAMnB,WAAW,kBAAkB,MAAM;;EAKnC,aAAa,kBAAkB,mBAAmB,MAAM;;UA6GhD;;UAqDA;;UAiBA;;;;;;;;;UCvaO;;;;;WAKN;;WAGA;;WAGA;;;;;WAMA,qBAAqB;;;;;;;UAQf;;WAEN;;WAGA;;WAGA,QAAQ;;;;;qBC1BN;;UAGI;;WAEN;;WAEA;;WAEA;;WAEA;;WAEA,MAAM;;WAEN;;WAEA;;WAEA;;WAEA;;WAEA;;;UAIM;;WAEN,SAAS;;;;;;;;;;;;;;;;;;;;;;;;;;;;;qBAgCP;mBACM;;;;;EAML,YAAA,SAAS;;;;;;;;;;;;;EAmDf,KAAK,SAAS,SAAS,UAAS,cAAmB,QAAQ;;;;;;;;;;;;;;;;EA0B3D,QACJ,UAAU,UACV,MAAM,aAAa,cAAc,aACjC,UAAS,cACR,QAAQ;;EASL,SAAS;UAID;UAWN;UASA;;;;;;;;;;;;;;qBCtLG,kBAAkB;;WAEpB;;WAGA;;EAGG,YAAA;IAAW;IAAc;IAAuB;;;MAQxD;;MAKA;;;;;;;;;;qBAaO,6BAA6B;;WAE/B,QAAQ;;;;;EAML,YAAA,iBAAiB,QAAQ"}