@schemavaults/send-email 0.2.1 → 0.3.1

package/README.md

@@ -51,6 +51,36 @@ await sendEmail({
 });
 ```
 
+### Choose a transport
+
+When the target `@schemavaults/mail-server` instance has more than one transport configured, the optional `transport` field selects which one delivers the email. Omit it to let the mail-server use its default transport.
+
+```ts
+await sendEmail({
+  body: {
+    to: "user@example.com",
+    subject: "Hello",
+    message: { text: "Hello.", html: "<p>Hello.</p>" },
+    transport: "smtp-primary",
+  },
+});
+
+// Equivalently, as a call-level override (sets `body.transport`):
+await sendEmail({
+  transport: "smtp-primary",
+  body: { to: "user@example.com", subject: "Hello", message: { /* ... */ } },
+});
+```
+
+The same applies to `sendEmailToMailingList()`, and to the CLI via the global `--transport <name>` flag:
+
+```bash
+bunx schemavaults-send-email --transport smtp-primary send \
+  --to user@example.com --subject "Hello" --text "Hello." --html "<p>Hello.</p>"
+```
+
+Transport names are defined by whoever configures the mail-server; this package only validates that the value looks like an identifier. An unknown transport name is rejected by the mail-server, not by the client.
+
 ### Send to a mailing list
 
 ```ts
@@ -109,6 +139,8 @@ interface ISendEmailOpts {
   bearerToken?: string;       // overrides SCHEMAVAULTS_MAIL_API_KEY
   mailServerUrl?: string;     // overrides resolved server URL
   environment?: "production" | "development" | "staging";
+  dryRun?: boolean;           // convenience; sets body.dryRun
+  transport?: string;         // convenience; sets body.transport
 }
 ```
 
@@ -123,6 +155,8 @@ interface ISendEmailToMailingListOpts {
   bearerToken?: string;
   mailServerUrl?: string;
   environment?: "production" | "development" | "staging";
+  dryRun?: boolean;           // convenience; sets body.dryRun
+  transport?: string;         // convenience; sets body.transport
 }
 ```
 
@@ -159,6 +193,10 @@ Returns a Zod schema for validating send-email request bodies. Pass `true` to al
 
 Zod schema for validating template IDs: lowercase alphanumeric with hyphens/underscores, 1-64 characters, must start with a letter.
 
+### `transportIdSchema`
+
+Zod schema for validating transport names: lowercase alphanumeric with hyphens/underscores, 1-64 characters, must start with a lowercase letter and end with a lowercase alphanumeric character. Whether a well-formed name corresponds to a transport the mail-server actually has configured is decided server-side.
+
 ## Request body shape
 
 The `message` field accepts either a template reference or raw content:
@@ -176,6 +214,8 @@ type SendEmailRequestBody = {
   replyTo?: string;
   cc?: string | string[];
   bcc?: string | string[];
+  dryRun?: boolean;            // server validates without dispatching
+  transport?: string;          // which mail-server transport delivers this email
 };
 ```
 

package/bun.lock

@@ -5,8 +5,8 @@
     "": {
       "name": "@schemavaults/send-email",
       "dependencies": {
-        "commander": "^14.0.1",
-        "zod": "3.25.8",
+        "commander": "14.0.1",
+        "zod": "4.4.3",
       },
       "devDependencies": {
         "@eslint/js": "9.39.1",
@@ -168,7 +168,7 @@
 
     "color-name": ["color-name@1.1.4", "", {}, "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA=="],
 
-    "commander": ["commander@14.0.3", "", {}, "sha512-H+y0Jo/T1RZ9qPP4Eh1pkcQcLRglraJaSLoyOtHxu6AapkjWVCy2Sit1QQ4x3Dng8qDlSsZEet7g5Pq06MvTgw=="],
+    "commander": ["commander@14.0.1", "", {}, "sha512-2JkV3gUZUVrbNA+1sjBOYLsMZ5cEEl8GTFP2a4AVz5hvasAMCQ1D2l2le/cX+pV4N6ZU17zjUahLpIXRrnWL8A=="],
 
     "concat-map": ["concat-map@0.0.1", "", {}, "sha512-/Srv4dswyQNBfohGpz9o6Yb3Gz3SrUDqBH5rTuhGR7ahtlbYKnVxw2bCFMRljaA7EXHaXZ8wsHdodFvbkhKmqg=="],
 
@@ -352,7 +352,7 @@
 
     "yocto-queue": ["yocto-queue@0.1.0", "", {}, "sha512-rVksvsnNCdJ/ohGc6xgPwyN8eheCxsiLM8mxuE/t/mOVqJewPuO1miLpTHQiRgTKCLexL4MeAFVagts7HmNZ2Q=="],
 
-    "zod": ["zod@3.25.8", "", {}, "sha512-iJPWX8HoZ2VE21VrhHGU9jVo/kVDUQyqM9vF0MxDhW/fp2sAl1eVwGJgiYZdHGiMwQJImXIW80lKk0MnfDxqiQ=="],
+    "zod": ["zod@4.4.3", "", {}, "sha512-ytENFjIJFl2UwYglde2jchW2Hwm4GJFLDiSXWdTrJQBIN9Fcyp7n4DhxJEiWNAJMV1/BqWfW/kkg71UDcHJyTQ=="],
 
     "@eslint-community/eslint-utils/eslint-visitor-keys": ["eslint-visitor-keys@3.4.3", "", {}, "sha512-wpc+LXeiyiisxPlEkUzU6svyS1frIO3Mgxj1fdy7Pm8Ygzguax2N3Fa/D/ag1WqbOprdI+uY6wMUl8/a2G+iag=="],