@shipfox/node-mailer 0.1.0

package/.turbo/turbo-build.log

@@ -0,0 +1,2 @@
+$ shipfox-swc
+Successfully compiled: 4 files with swc (24.74ms)

package/.turbo/turbo-type$colon$emit.log

@@ -0,0 +1 @@
+$ shipfox-tsc-emit

package/.turbo/turbo-type.log

@@ -0,0 +1,2 @@
+
+$ shipfox-tsc-check

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Shipfox
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,51 @@
+# Shipfox Mailer
+
+Small mailer interface for Shipfox Node packages. It supports SMTP delivery for production and a console mailer for local development and tests.
+
+## What it does
+
+- **`Mailer`**: Interface with one `send(message)` method.
+- **`MailMessage`**: Message shape with `to`, `subject`, `text`, and optional `html`.
+- **`createConsoleMailer(options)`**: Logs mail through the Shipfox logger and can capture messages in an array.
+- **`createSmtpMailer(options)`**: Sends mail through `nodemailer`.
+
+## Usage
+
+```ts
+import {createConsoleMailer, createSmtpMailer, type Mailer} from '@shipfox/node-mailer';
+
+const mailer: Mailer =
+  process.env.MAILER_TRANSPORT === 'smtp'
+    ? createSmtpMailer({
+        host: 'smtp.example.com',
+        port: 587,
+        user: process.env.SMTP_USER,
+        password: process.env.SMTP_PASSWORD,
+        from: 'noreply@shipfox.local',
+      })
+    : createConsoleMailer({from: 'noreply@shipfox.local'});
+
+await mailer.send({
+  to: 'user@example.com',
+  subject: 'Verify your email',
+  text: 'Open this link to verify your email.',
+});
+```
+
+## Notes
+
+- SMTP uses `secure: true` by default on port `465`.
+- SMTP auth is only sent when both `user` and `password` are set.
+- The console mailer is useful in tests because `capture` stores each message.
+
+## Development
+
+```sh
+turbo check --filter=@shipfox/node-mailer
+turbo type --filter=@shipfox/node-mailer
+turbo test --filter=@shipfox/node-mailer
+```
+
+## License
+
+MIT

package/dist/console-mailer.d.ts

@@ -0,0 +1,7 @@
+import type { Mailer, MailMessage } from './mailer.js';
+export interface ConsoleMailerOptions {
+    from: string;
+    capture?: MailMessage[];
+}
+export declare function createConsoleMailer(options: ConsoleMailerOptions): Mailer;
+//# sourceMappingURL=console-mailer.d.ts.map

package/dist/console-mailer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"console-mailer.d.ts","sourceRoot":"","sources":["../src/console-mailer.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAC,MAAM,EAAE,WAAW,EAAC,MAAM,aAAa,CAAC;AAErD,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,EAAE,WAAW,EAAE,CAAC;CACzB;AAED,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,oBAAoB,GAAG,MAAM,CAmBzE"}

package/dist/console-mailer.js

@@ -0,0 +1,20 @@
+import { logger } from '@shipfox/node-opentelemetry';
+export function createConsoleMailer(options) {
+    const { from, capture } = options;
+    return {
+        send: (message)=>{
+            capture?.push(message);
+            logger().info({
+                mailer: 'console',
+                from,
+                to: message.to,
+                subject: message.subject,
+                text: message.text,
+                html: message.html
+            }, 'mailer.send');
+            return Promise.resolve();
+        }
+    };
+}
+
+//# sourceMappingURL=console-mailer.js.map

package/dist/console-mailer.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/console-mailer.ts"],"sourcesContent":["import {logger} from '@shipfox/node-opentelemetry';\nimport type {Mailer, MailMessage} from './mailer.js';\n\nexport interface ConsoleMailerOptions {\n  from: string;\n  capture?: MailMessage[];\n}\n\nexport function createConsoleMailer(options: ConsoleMailerOptions): Mailer {\n  const {from, capture} = options;\n  return {\n    send: (message) => {\n      capture?.push(message);\n      logger().info(\n        {\n          mailer: 'console',\n          from,\n          to: message.to,\n          subject: message.subject,\n          text: message.text,\n          html: message.html,\n        },\n        'mailer.send',\n      );\n      return Promise.resolve();\n    },\n  };\n}\n"],"names":["logger","createConsoleMailer","options","from","capture","send","message","push","info","mailer","to","subject","text","html","Promise","resolve"],"mappings":"AAAA,SAAQA,MAAM,QAAO,8BAA8B;AAQnD,OAAO,SAASC,oBAAoBC,OAA6B;IAC/D,MAAM,EAACC,IAAI,EAAEC,OAAO,EAAC,GAAGF;IACxB,OAAO;QACLG,MAAM,CAACC;YACLF,SAASG,KAAKD;YACdN,SAASQ,IAAI,CACX;gBACEC,QAAQ;gBACRN;gBACAO,IAAIJ,QAAQI,EAAE;gBACdC,SAASL,QAAQK,OAAO;gBACxBC,MAAMN,QAAQM,IAAI;gBAClBC,MAAMP,QAAQO,IAAI;YACpB,GACA;YAEF,OAAOC,QAAQC,OAAO;QACxB;IACF;AACF"}

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+export { type ConsoleMailerOptions, createConsoleMailer } from './console-mailer.js';
+export type { Mailer, MailMessage } from './mailer.js';
+export { createSmtpMailer, type SmtpMailerOptions } from './smtp-mailer.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,KAAK,oBAAoB,EAAE,mBAAmB,EAAC,MAAM,qBAAqB,CAAC;AACnF,YAAY,EAAC,MAAM,EAAE,WAAW,EAAC,MAAM,aAAa,CAAC;AACrD,OAAO,EAAC,gBAAgB,EAAE,KAAK,iBAAiB,EAAC,MAAM,kBAAkB,CAAC"}

package/dist/index.js

@@ -0,0 +1,4 @@
+export { createConsoleMailer } from './console-mailer.js';
+export { createSmtpMailer } from './smtp-mailer.js';
+
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["export {type ConsoleMailerOptions, createConsoleMailer} from './console-mailer.js';\nexport type {Mailer, MailMessage} from './mailer.js';\nexport {createSmtpMailer, type SmtpMailerOptions} from './smtp-mailer.js';\n"],"names":["createConsoleMailer","createSmtpMailer"],"mappings":"AAAA,SAAmCA,mBAAmB,QAAO,sBAAsB;AAEnF,SAAQC,gBAAgB,QAA+B,mBAAmB"}

package/dist/mailer.d.ts

@@ -0,0 +1,10 @@
+export interface MailMessage {
+    to: string;
+    subject: string;
+    text: string;
+    html?: string;
+}
+export interface Mailer {
+    send(message: MailMessage): Promise<void>;
+}
+//# sourceMappingURL=mailer.d.ts.map

package/dist/mailer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mailer.d.ts","sourceRoot":"","sources":["../src/mailer.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,WAAW;IAC1B,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,MAAM;IACrB,IAAI,CAAC,OAAO,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAC3C"}

package/dist/mailer.js

@@ -0,0 +1,3 @@
+export { };
+
+//# sourceMappingURL=mailer.js.map

package/dist/mailer.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/mailer.ts"],"sourcesContent":["export interface MailMessage {\n  to: string;\n  subject: string;\n  text: string;\n  html?: string;\n}\n\nexport interface Mailer {\n  send(message: MailMessage): Promise<void>;\n}\n"],"names":[],"mappings":"AAOA,WAEC"}

package/dist/smtp-mailer.d.ts

@@ -0,0 +1,11 @@
+import type { Mailer } from './mailer.js';
+export interface SmtpMailerOptions {
+    host: string;
+    port: number;
+    secure?: boolean;
+    user?: string;
+    password?: string;
+    from: string;
+}
+export declare function createSmtpMailer(options: SmtpMailerOptions): Mailer;
+//# sourceMappingURL=smtp-mailer.d.ts.map

package/dist/smtp-mailer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"smtp-mailer.d.ts","sourceRoot":"","sources":["../src/smtp-mailer.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAC,MAAM,EAAC,MAAM,aAAa,CAAC;AAExC,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,MAAM,CAAC;CACd;AAED,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,iBAAiB,GAAG,MAAM,CAoBnE"}

package/dist/smtp-mailer.js

@@ -0,0 +1,26 @@
+import nodemailer from 'nodemailer';
+export function createSmtpMailer(options) {
+    const { host, port, secure, user, password, from } = options;
+    const transporter = nodemailer.createTransport({
+        host,
+        port,
+        secure: secure ?? port === 465,
+        auth: user && password ? {
+            user,
+            pass: password
+        } : undefined
+    });
+    return {
+        send: async (message)=>{
+            await transporter.sendMail({
+                from,
+                to: message.to,
+                subject: message.subject,
+                text: message.text,
+                html: message.html
+            });
+        }
+    };
+}
+
+//# sourceMappingURL=smtp-mailer.js.map

package/dist/smtp-mailer.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/smtp-mailer.ts"],"sourcesContent":["import nodemailer from 'nodemailer';\nimport type {Mailer} from './mailer.js';\n\nexport interface SmtpMailerOptions {\n  host: string;\n  port: number;\n  secure?: boolean;\n  user?: string;\n  password?: string;\n  from: string;\n}\n\nexport function createSmtpMailer(options: SmtpMailerOptions): Mailer {\n  const {host, port, secure, user, password, from} = options;\n  const transporter = nodemailer.createTransport({\n    host,\n    port,\n    secure: secure ?? port === 465,\n    auth: user && password ? {user, pass: password} : undefined,\n  });\n\n  return {\n    send: async (message) => {\n      await transporter.sendMail({\n        from,\n        to: message.to,\n        subject: message.subject,\n        text: message.text,\n        html: message.html,\n      });\n    },\n  };\n}\n"],"names":["nodemailer","createSmtpMailer","options","host","port","secure","user","password","from","transporter","createTransport","auth","pass","undefined","send","message","sendMail","to","subject","text","html"],"mappings":"AAAA,OAAOA,gBAAgB,aAAa;AAYpC,OAAO,SAASC,iBAAiBC,OAA0B;IACzD,MAAM,EAACC,IAAI,EAAEC,IAAI,EAAEC,MAAM,EAAEC,IAAI,EAAEC,QAAQ,EAAEC,IAAI,EAAC,GAAGN;IACnD,MAAMO,cAAcT,WAAWU,eAAe,CAAC;QAC7CP;QACAC;QACAC,QAAQA,UAAUD,SAAS;QAC3BO,MAAML,QAAQC,WAAW;YAACD;YAAMM,MAAML;QAAQ,IAAIM;IACpD;IAEA,OAAO;QACLC,MAAM,OAAOC;YACX,MAAMN,YAAYO,QAAQ,CAAC;gBACzBR;gBACAS,IAAIF,QAAQE,EAAE;gBACdC,SAASH,QAAQG,OAAO;gBACxBC,MAAMJ,QAAQI,IAAI;gBAClBC,MAAML,QAAQK,IAAI;YACpB;QACF;IACF;AACF"}