edge-mailer 0.6.0

package/dist/pool-CcxclJQJ.d.mts

@@ -0,0 +1,323 @@
+declare function encodeHeader(text: string): string;
+type User = {
+    name?: string;
+    email: string;
+};
+type DsnOptions = {
+    envelopeId?: string;
+    RET?: {
+        HEADERS?: boolean;
+        FULL?: boolean;
+    };
+    NOTIFY?: {
+        DELAY?: boolean;
+        FAILURE?: boolean;
+        SUCCESS?: boolean;
+        NEVER?: boolean;
+    };
+    ORCPT?: string;
+};
+type MailBodyType = '7BIT' | '8BITMIME';
+type MailEnvelopeOptions = {
+    from?: string;
+    to?: string | string[];
+    size?: number;
+    body?: MailBodyType;
+    smtpUtf8?: boolean;
+    requireTls?: boolean;
+};
+type AttachmentEncoding = 'base64' | 'quoted-printable' | '7bit';
+type AttachmentDisposition = 'attachment' | 'inline';
+type EmailAttachmentContent = string | Uint8Array | ArrayBuffer | ArrayBufferView | Blob;
+type EmailAttachment = {
+    filename: string;
+    content: EmailAttachmentContent;
+    mimeType?: string;
+    contentType?: string;
+    encoding?: AttachmentEncoding;
+    contentId?: string;
+    disposition?: AttachmentDisposition;
+};
+type EmailOptions = {
+    from: string | User;
+    to: string | string[] | User | User[];
+    reply?: string | User;
+    cc?: string | string[] | User | User[];
+    bcc?: string | string[] | User | User[];
+    subject: string;
+    text?: string;
+    html?: string;
+    headers?: Record<string, string>;
+    attachments?: EmailAttachment[];
+    envelope?: MailEnvelopeOptions;
+    dsnOverride?: DsnOptions;
+};
+declare class Email {
+    readonly from: User;
+    readonly to: User[];
+    readonly reply?: User;
+    readonly cc?: User[];
+    readonly bcc?: User[];
+    readonly subject: string;
+    readonly text?: string;
+    readonly html?: string;
+    readonly envelope?: Omit<MailEnvelopeOptions, 'to'> & {
+        to?: string[];
+    };
+    readonly dsnOverride?: DsnOptions;
+    readonly attachments?: EmailAttachment[];
+    readonly headers: Record<string, string>;
+    setSent: () => void;
+    setSentError: (e: unknown) => void;
+    sent: Promise<void>;
+    constructor(options: EmailOptions);
+    private static toUsers;
+    private static toEnvelopeRecipients;
+    getMessageData(): string;
+    getMessageDataAsync(): Promise<string>;
+    private buildMessageData;
+    private resolveAttachments;
+    private resolveAttachmentsSync;
+    private attachmentBytes;
+    private isBlob;
+    private attachmentPart;
+    private attachmentDisposition;
+    private encodedAttachmentContent;
+    private attachmentTextContent;
+    private bytesToWrappedBase64;
+    private bytesToBase64;
+    private wrapBase64;
+    getEmailData(): string;
+    getEmailDataAsync(): Promise<string>;
+    static toSmtpData(data: string): string;
+    private static applyDotStuffing;
+    private generateSafeBoundary;
+    private getMimeType;
+    private resolveHeader;
+    private resolveFrom;
+    private resolveTo;
+    private resolveSubject;
+    private resolveReply;
+    private resolveCC;
+}
+
+type DkimConfig = {
+    domainName: string;
+    keySelector: string;
+    privateKey: string;
+    headerFieldNames?: string[];
+};
+declare function validateDkimConfig(dkim: DkimConfig | undefined): void;
+declare function signDkimMessage(message: string, dkim: DkimConfig): Promise<string>;
+
+declare enum LogLevel {
+    DEBUG = 0,
+    INFO = 1,
+    WARN = 2,
+    ERROR = 3,
+    NONE = 4
+}
+
+type SocketTlsMode = 'off' | 'on' | 'starttls';
+type EdgeSocket = {
+    readable: ReadableStream<Uint8Array>;
+    writable: WritableStream<Uint8Array>;
+    opened?: Promise<unknown>;
+    closed?: Promise<void>;
+    close(reason?: unknown): Promise<void> | void;
+    startTls?(): EdgeSocket | Promise<EdgeSocket>;
+};
+type EdgeSocketConnectOptions = {
+    hostname: string;
+    port: number;
+    tls: SocketTlsMode;
+    signal?: AbortSignal;
+};
+type EdgeSocketConnector = {
+    connect(options: EdgeSocketConnectOptions): EdgeSocket | Promise<EdgeSocket>;
+};
+
+type AuthType = 'plain' | 'login' | 'cram-md5';
+type Credentials = {
+    username: string;
+    password: string;
+};
+type BatchSendOptions = {
+    continueOnError?: boolean;
+};
+type SmtpRejectedRecipient = {
+    recipient: string;
+    response: string;
+    responseCode?: number;
+    enhancedStatusCode?: string;
+    transient: boolean;
+};
+type SmtpSendReceipt = {
+    messageId: string;
+    envelope: {
+        from: string;
+        to: string[];
+    };
+    accepted: string[];
+    rejected: SmtpRejectedRecipient[];
+    response: string;
+    responseCode?: number;
+    enhancedStatusCode?: string;
+    size: number;
+};
+type BatchSendResult = PromiseSettledResult<SmtpSendReceipt>[];
+type PipeliningMode = 'auto' | false;
+type SmtpBodyType = '7BIT' | '8BITMIME';
+type SMTPStage = 'connect' | 'greet' | 'ehlo' | 'helo' | 'starttls' | 'auth' | 'mail' | 'rcpt' | 'data' | 'body' | 'rset' | 'quit' | 'send' | 'read';
+type SMTPErrorOptions = {
+    stage: SMTPStage;
+    command?: string;
+    response?: string;
+    cause?: unknown;
+};
+declare class SMTPError extends Error {
+    readonly stage: SMTPStage;
+    readonly command?: string;
+    readonly response?: string;
+    readonly responseCode?: number;
+    readonly enhancedStatusCode?: string;
+    readonly transient: boolean;
+    readonly cause?: unknown;
+    constructor(message: string, options: SMTPErrorOptions);
+}
+type EdgeMailerOptions = {
+    host: string;
+    port: number;
+    secure?: boolean;
+    startTls?: boolean;
+    credentials?: Credentials;
+    authType?: AuthType | AuthType[];
+    logLevel?: LogLevel;
+    pipelining?: PipeliningMode;
+    dsn?: DsnOptions | undefined;
+    dkim?: DkimConfig | undefined;
+    pool?: SmtpPoolOptions | boolean | undefined;
+    socketTimeoutMs?: number;
+    responseTimeoutMs?: number;
+};
+type SmtpPoolOptions = {
+    maxConnections?: number;
+    maxMessagesPerConnection?: number;
+    idleTimeoutMs?: number;
+};
+declare class SmtpMailer {
+    private readonly connector;
+    private readonly host;
+    private readonly port;
+    private readonly secure;
+    private readonly startTls;
+    private readonly authType;
+    private readonly credentials?;
+    private readonly pipelining;
+    private readonly socketTimeoutMs;
+    private readonly responseTimeoutMs;
+    private socket?;
+    private reader;
+    private writer;
+    private responseBuffer;
+    private readonly logger;
+    private readonly dsn;
+    private readonly dkim;
+    private active;
+    private closeError?;
+    private sendChain;
+    private emailSending;
+    private queuedSendRejects;
+    /** SMTP server capabilities **/
+    private supportsDSN;
+    private supportsSize;
+    private maxMessageSize?;
+    private supports8BitMime;
+    private supportsSmtpUtf8;
+    private supportsRequireTls;
+    private allowAuth;
+    private authTypeSupported;
+    private supportsStartTls;
+    private supportsPipelining;
+    protected constructor(options: EdgeMailerOptions, connector: EdgeSocketConnector, runtimeName?: string);
+    send(options: EmailOptions): Promise<SmtpSendReceipt>;
+    sendMany(emails: EmailOptions[], options?: BatchSendOptions): Promise<BatchSendResult>;
+    close(error?: Error): Promise<void>;
+    isActive(): boolean;
+    protected initializeSmtpSession(): Promise<void>;
+    private sendEmail;
+    private canPipeline;
+    private prepareEmail;
+    private readTimeout;
+    private read;
+    private shiftResponse;
+    private writeLine;
+    private write;
+    private openSocket;
+    private waitForSocketConnected;
+    private greet;
+    private ehlo;
+    private helo;
+    private tls;
+    private resetCapabilities;
+    private parseCapabilities;
+    private auth;
+    private authWithPlain;
+    private authWithLogin;
+    private authWithCramMD5;
+    private mail;
+    private rcpt;
+    private data;
+    private envelopePipelined;
+    private body;
+    private createReceipt;
+    private rejectedRecipient;
+    private responseCode;
+    private enhancedStatusCode;
+    private rset;
+    private mailCommand;
+    private rcptCommand;
+    private recipients;
+    private mailFrom;
+    private mailParameters;
+    private rcptParameters;
+    private notificationParameter;
+    private retParameter;
+    private hasDsnRequest;
+    private needsSmtpUtf8;
+    protected abortConnection(error: unknown): Promise<void>;
+    private closedSendError;
+    private closeSocket;
+    private getSocket;
+}
+
+declare class SmtpConnectionPool<TMailer extends SmtpMailer> {
+    private readonly options;
+    private readonly connectMailer;
+    private readonly maxConnections;
+    private readonly maxMessagesPerConnection;
+    private readonly idleTimeoutMs;
+    private ready;
+    private busy;
+    private waitQueue;
+    private pendingCreates;
+    private pendingDestroys;
+    private totalConnections;
+    private closed;
+    constructor(options: EdgeMailerOptions, connectMailer: (options: EdgeMailerOptions) => Promise<TMailer>);
+    send(email: Parameters<TMailer['send']>[0]): Promise<SmtpSendReceipt>;
+    sendMany(emails: Parameters<TMailer['send']>[0][], options?: BatchSendOptions): Promise<BatchSendResult>;
+    close(): Promise<void>;
+    private acquire;
+    private release;
+    private dispatchWaiters;
+    private createBusyClient;
+    private createBusyClientInner;
+    private trackDestroy;
+    private destroy;
+    private destroyOnce;
+    private waitForDrained;
+    private clearIdleTimer;
+}
+
+export { type AttachmentDisposition as A, type BatchSendOptions as B, type Credentials as C, type DkimConfig as D, type EdgeMailerOptions as E, LogLevel as L, type MailBodyType as M, type PipeliningMode as P, SMTPError as S, type User as U, type AttachmentEncoding as a, type AuthType as b, type BatchSendResult as c, type DsnOptions as d, type EdgeSocketConnector as e, Email as f, type EmailAttachment as g, type EmailAttachmentContent as h, type EmailOptions as i, type MailEnvelopeOptions as j, type SMTPErrorOptions as k, type SMTPStage as l, type SmtpBodyType as m, SmtpConnectionPool as n, SmtpMailer as o, type SmtpPoolOptions as p, type SmtpRejectedRecipient as q, type SmtpSendReceipt as r, encodeHeader as s, signDkimMessage as t, validateDkimConfig as v };

package/dist/pool-CcxclJQJ.d.ts

@@ -0,0 +1,323 @@
+declare function encodeHeader(text: string): string;
+type User = {
+    name?: string;
+    email: string;
+};
+type DsnOptions = {
+    envelopeId?: string;
+    RET?: {
+        HEADERS?: boolean;
+        FULL?: boolean;
+    };
+    NOTIFY?: {
+        DELAY?: boolean;
+        FAILURE?: boolean;
+        SUCCESS?: boolean;
+        NEVER?: boolean;
+    };
+    ORCPT?: string;
+};
+type MailBodyType = '7BIT' | '8BITMIME';
+type MailEnvelopeOptions = {
+    from?: string;
+    to?: string | string[];
+    size?: number;
+    body?: MailBodyType;
+    smtpUtf8?: boolean;
+    requireTls?: boolean;
+};
+type AttachmentEncoding = 'base64' | 'quoted-printable' | '7bit';
+type AttachmentDisposition = 'attachment' | 'inline';
+type EmailAttachmentContent = string | Uint8Array | ArrayBuffer | ArrayBufferView | Blob;
+type EmailAttachment = {
+    filename: string;
+    content: EmailAttachmentContent;
+    mimeType?: string;
+    contentType?: string;
+    encoding?: AttachmentEncoding;
+    contentId?: string;
+    disposition?: AttachmentDisposition;
+};
+type EmailOptions = {
+    from: string | User;
+    to: string | string[] | User | User[];
+    reply?: string | User;
+    cc?: string | string[] | User | User[];
+    bcc?: string | string[] | User | User[];
+    subject: string;
+    text?: string;
+    html?: string;
+    headers?: Record<string, string>;
+    attachments?: EmailAttachment[];
+    envelope?: MailEnvelopeOptions;
+    dsnOverride?: DsnOptions;
+};
+declare class Email {
+    readonly from: User;
+    readonly to: User[];
+    readonly reply?: User;
+    readonly cc?: User[];
+    readonly bcc?: User[];
+    readonly subject: string;
+    readonly text?: string;
+    readonly html?: string;
+    readonly envelope?: Omit<MailEnvelopeOptions, 'to'> & {
+        to?: string[];
+    };
+    readonly dsnOverride?: DsnOptions;
+    readonly attachments?: EmailAttachment[];
+    readonly headers: Record<string, string>;
+    setSent: () => void;
+    setSentError: (e: unknown) => void;
+    sent: Promise<void>;
+    constructor(options: EmailOptions);
+    private static toUsers;
+    private static toEnvelopeRecipients;
+    getMessageData(): string;
+    getMessageDataAsync(): Promise<string>;
+    private buildMessageData;
+    private resolveAttachments;
+    private resolveAttachmentsSync;
+    private attachmentBytes;
+    private isBlob;
+    private attachmentPart;
+    private attachmentDisposition;
+    private encodedAttachmentContent;
+    private attachmentTextContent;
+    private bytesToWrappedBase64;
+    private bytesToBase64;
+    private wrapBase64;
+    getEmailData(): string;
+    getEmailDataAsync(): Promise<string>;
+    static toSmtpData(data: string): string;
+    private static applyDotStuffing;
+    private generateSafeBoundary;
+    private getMimeType;
+    private resolveHeader;
+    private resolveFrom;
+    private resolveTo;
+    private resolveSubject;
+    private resolveReply;
+    private resolveCC;
+}
+
+type DkimConfig = {
+    domainName: string;
+    keySelector: string;
+    privateKey: string;
+    headerFieldNames?: string[];
+};
+declare function validateDkimConfig(dkim: DkimConfig | undefined): void;
+declare function signDkimMessage(message: string, dkim: DkimConfig): Promise<string>;
+
+declare enum LogLevel {
+    DEBUG = 0,
+    INFO = 1,
+    WARN = 2,
+    ERROR = 3,
+    NONE = 4
+}
+
+type SocketTlsMode = 'off' | 'on' | 'starttls';
+type EdgeSocket = {
+    readable: ReadableStream<Uint8Array>;
+    writable: WritableStream<Uint8Array>;
+    opened?: Promise<unknown>;
+    closed?: Promise<void>;
+    close(reason?: unknown): Promise<void> | void;
+    startTls?(): EdgeSocket | Promise<EdgeSocket>;
+};
+type EdgeSocketConnectOptions = {
+    hostname: string;
+    port: number;
+    tls: SocketTlsMode;
+    signal?: AbortSignal;
+};
+type EdgeSocketConnector = {
+    connect(options: EdgeSocketConnectOptions): EdgeSocket | Promise<EdgeSocket>;
+};
+
+type AuthType = 'plain' | 'login' | 'cram-md5';
+type Credentials = {
+    username: string;
+    password: string;
+};
+type BatchSendOptions = {
+    continueOnError?: boolean;
+};
+type SmtpRejectedRecipient = {
+    recipient: string;
+    response: string;
+    responseCode?: number;
+    enhancedStatusCode?: string;
+    transient: boolean;
+};
+type SmtpSendReceipt = {
+    messageId: string;
+    envelope: {
+        from: string;
+        to: string[];
+    };
+    accepted: string[];
+    rejected: SmtpRejectedRecipient[];
+    response: string;
+    responseCode?: number;
+    enhancedStatusCode?: string;
+    size: number;
+};
+type BatchSendResult = PromiseSettledResult<SmtpSendReceipt>[];
+type PipeliningMode = 'auto' | false;
+type SmtpBodyType = '7BIT' | '8BITMIME';
+type SMTPStage = 'connect' | 'greet' | 'ehlo' | 'helo' | 'starttls' | 'auth' | 'mail' | 'rcpt' | 'data' | 'body' | 'rset' | 'quit' | 'send' | 'read';
+type SMTPErrorOptions = {
+    stage: SMTPStage;
+    command?: string;
+    response?: string;
+    cause?: unknown;
+};
+declare class SMTPError extends Error {
+    readonly stage: SMTPStage;
+    readonly command?: string;
+    readonly response?: string;
+    readonly responseCode?: number;
+    readonly enhancedStatusCode?: string;
+    readonly transient: boolean;
+    readonly cause?: unknown;
+    constructor(message: string, options: SMTPErrorOptions);
+}
+type EdgeMailerOptions = {
+    host: string;
+    port: number;
+    secure?: boolean;
+    startTls?: boolean;
+    credentials?: Credentials;
+    authType?: AuthType | AuthType[];
+    logLevel?: LogLevel;
+    pipelining?: PipeliningMode;
+    dsn?: DsnOptions | undefined;
+    dkim?: DkimConfig | undefined;
+    pool?: SmtpPoolOptions | boolean | undefined;
+    socketTimeoutMs?: number;
+    responseTimeoutMs?: number;
+};
+type SmtpPoolOptions = {
+    maxConnections?: number;
+    maxMessagesPerConnection?: number;
+    idleTimeoutMs?: number;
+};
+declare class SmtpMailer {
+    private readonly connector;
+    private readonly host;
+    private readonly port;
+    private readonly secure;
+    private readonly startTls;
+    private readonly authType;
+    private readonly credentials?;
+    private readonly pipelining;
+    private readonly socketTimeoutMs;
+    private readonly responseTimeoutMs;
+    private socket?;
+    private reader;
+    private writer;
+    private responseBuffer;
+    private readonly logger;
+    private readonly dsn;
+    private readonly dkim;
+    private active;
+    private closeError?;
+    private sendChain;
+    private emailSending;
+    private queuedSendRejects;
+    /** SMTP server capabilities **/
+    private supportsDSN;
+    private supportsSize;
+    private maxMessageSize?;
+    private supports8BitMime;
+    private supportsSmtpUtf8;
+    private supportsRequireTls;
+    private allowAuth;
+    private authTypeSupported;
+    private supportsStartTls;
+    private supportsPipelining;
+    protected constructor(options: EdgeMailerOptions, connector: EdgeSocketConnector, runtimeName?: string);
+    send(options: EmailOptions): Promise<SmtpSendReceipt>;
+    sendMany(emails: EmailOptions[], options?: BatchSendOptions): Promise<BatchSendResult>;
+    close(error?: Error): Promise<void>;
+    isActive(): boolean;
+    protected initializeSmtpSession(): Promise<void>;
+    private sendEmail;
+    private canPipeline;
+    private prepareEmail;
+    private readTimeout;
+    private read;
+    private shiftResponse;
+    private writeLine;
+    private write;
+    private openSocket;
+    private waitForSocketConnected;
+    private greet;
+    private ehlo;
+    private helo;
+    private tls;
+    private resetCapabilities;
+    private parseCapabilities;
+    private auth;
+    private authWithPlain;
+    private authWithLogin;
+    private authWithCramMD5;
+    private mail;
+    private rcpt;
+    private data;
+    private envelopePipelined;
+    private body;
+    private createReceipt;
+    private rejectedRecipient;
+    private responseCode;
+    private enhancedStatusCode;
+    private rset;
+    private mailCommand;
+    private rcptCommand;
+    private recipients;
+    private mailFrom;
+    private mailParameters;
+    private rcptParameters;
+    private notificationParameter;
+    private retParameter;
+    private hasDsnRequest;
+    private needsSmtpUtf8;
+    protected abortConnection(error: unknown): Promise<void>;
+    private closedSendError;
+    private closeSocket;
+    private getSocket;
+}
+
+declare class SmtpConnectionPool<TMailer extends SmtpMailer> {
+    private readonly options;
+    private readonly connectMailer;
+    private readonly maxConnections;
+    private readonly maxMessagesPerConnection;
+    private readonly idleTimeoutMs;
+    private ready;
+    private busy;
+    private waitQueue;
+    private pendingCreates;
+    private pendingDestroys;
+    private totalConnections;
+    private closed;
+    constructor(options: EdgeMailerOptions, connectMailer: (options: EdgeMailerOptions) => Promise<TMailer>);
+    send(email: Parameters<TMailer['send']>[0]): Promise<SmtpSendReceipt>;
+    sendMany(emails: Parameters<TMailer['send']>[0][], options?: BatchSendOptions): Promise<BatchSendResult>;
+    close(): Promise<void>;
+    private acquire;
+    private release;
+    private dispatchWaiters;
+    private createBusyClient;
+    private createBusyClientInner;
+    private trackDestroy;
+    private destroy;
+    private destroyOnce;
+    private waitForDrained;
+    private clearIdleTimer;
+}
+
+export { type AttachmentDisposition as A, type BatchSendOptions as B, type Credentials as C, type DkimConfig as D, type EdgeMailerOptions as E, LogLevel as L, type MailBodyType as M, type PipeliningMode as P, SMTPError as S, type User as U, type AttachmentEncoding as a, type AuthType as b, type BatchSendResult as c, type DsnOptions as d, type EdgeSocketConnector as e, Email as f, type EmailAttachment as g, type EmailAttachmentContent as h, type EmailOptions as i, type MailEnvelopeOptions as j, type SMTPErrorOptions as k, type SMTPStage as l, type SmtpBodyType as m, SmtpConnectionPool as n, SmtpMailer as o, type SmtpPoolOptions as p, type SmtpRejectedRecipient as q, type SmtpSendReceipt as r, encodeHeader as s, signDkimMessage as t, validateDkimConfig as v };