@dbx-tools/appkit-email-shared 0.1.78 → 0.1.79

package/README.md

@@ -24,15 +24,26 @@ import {
 } from "@dbx-tools/appkit-email-shared";
 
 const draft: EmailMessage = emailMessageSchema.parse({
-  to: "alice@example.com",
+  to: ["alice@example.com", "bob@example.com"],
   subject: "Status",
   body: "# Update\n- shipped\n- tested",
+  cc: ["lead@example.com"],
+  attachments: [{ filename: "report.pdf", path: "/tmp/report.pdf" }],
 });
 ```
 
-`emailMessageSchema` is the `send_email` tool's input (recipient,
-subject, Markdown body, optional `cc` / `bcc`); `emailResultSchema` is
-the dispatch result returned to the model.
+`emailMessageSchema` is the `send_email` tool's input: one or more `to`
+recipients, a subject, a Markdown `body`, and optional `cc` / `bcc`
+arrays and `attachments`. Each attachment carries a `filename` plus
+either inline `content` (with an optional `encoding` such as `base64`)
+or a `path` (local file, `data:` URI, or https URL), and an optional
+`contentType`. `emailResultSchema` is the dispatch result returned to
+the model (`recipient` echoes the comma-joined `to` list).
+
+`emailSendersSchema` / `EmailSenders` type the plugin's `GET /senders`
+payload - the permitted `From` options for the current user (`senders`),
+the `defaultSender` among them, and whether the list is an enforced
+`restricted` allow-list - so a compose UI can populate a sender dropdown.
 
 > Note: array fields intentionally omit `.min()` / `.nonempty()` so the
 > generated JSON schema carries no `minItems`, which some Model Serving

package/dist/index.d.ts

@@ -1,13 +1,30 @@
 import { z } from "zod";
 
 //#region packages/appkit-email-shared/src/protocol.d.ts
+/** Schema for a single file attached to an outbound email. */
+declare const emailAttachmentSchema: z.ZodObject<{
+  filename: z.ZodString;
+  content: z.ZodOptional<z.ZodString>;
+  encoding: z.ZodOptional<z.ZodString>;
+  path: z.ZodOptional<z.ZodString>;
+  contentType: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+/** A single file attached to an {@link EmailMessage}. */
+type EmailAttachment = z.infer<typeof emailAttachmentSchema>;
 /** Schema for the email a model asks to send (the tool input). */
 declare const emailMessageSchema: z.ZodObject<{
-  to: z.ZodString;
+  to: z.ZodArray<z.ZodString>;
   subject: z.ZodString;
   body: z.ZodString;
   cc: z.ZodOptional<z.ZodArray<z.ZodString>>;
   bcc: z.ZodOptional<z.ZodArray<z.ZodString>>;
+  attachments: z.ZodOptional<z.ZodArray<z.ZodObject<{
+    filename: z.ZodString;
+    content: z.ZodOptional<z.ZodString>;
+    encoding: z.ZodOptional<z.ZodString>;
+    path: z.ZodOptional<z.ZodString>;
+    contentType: z.ZodOptional<z.ZodString>;
+  }, z.core.$strip>>>;
 }, z.core.$strip>;
 /** A validated outbound email message. */
 type EmailMessage = z.infer<typeof emailMessageSchema>;
@@ -20,5 +37,22 @@ declare const emailResultSchema: z.ZodObject<{
 }, z.core.$strip>;
 /** The outcome of dispatching an {@link EmailMessage}. */
 type EmailResult = z.infer<typeof emailResultSchema>;
+/**
+ * Schema for the sender options a UI can offer for the `From` address -
+ * the payload of the plugin's `GET /senders` route. When the plugin
+ * configures a sender allow-list, `senders` holds the concrete addresses
+ * the current user may send as (domain wildcards expanded against the
+ * user's local part) and `restricted` is true; a picker should require a
+ * choice from the list. When unrestricted, `senders` holds at most the
+ * single default address (if one can be resolved) and `restricted` is
+ * false, so a UI may allow free entry.
+ */
+declare const emailSendersSchema: z.ZodObject<{
+  senders: z.ZodArray<z.ZodString>;
+  defaultSender: z.ZodOptional<z.ZodString>;
+  restricted: z.ZodBoolean;
+}, z.core.$strip>;
+/** Sender options for a `From` picker (see {@link emailSendersSchema}). */
+type EmailSenders = z.infer<typeof emailSendersSchema>;
 //#endregion
-export { EmailMessage, EmailResult, emailMessageSchema, emailResultSchema };
+export { EmailAttachment, EmailMessage, EmailResult, EmailSenders, emailAttachmentSchema, emailMessageSchema, emailResultSchema, emailSendersSchema };

package/dist/index.js

@@ -1,9 +1,17 @@
 import { z } from "zod";
 
 //#region packages/appkit-email-shared/src/protocol.ts
+/** Schema for a single file attached to an outbound email. */
+const emailAttachmentSchema = z.object({
+	filename: z.string().describe("File name shown to the recipient (e.g. \"report.pdf\")."),
+	content: z.string().optional().describe("Inline file content as a string. For binary data set `encoding` (e.g. \"base64\"). Provide this or `path`, not both."),
+	encoding: z.string().optional().describe("Encoding of `content` (e.g. \"base64\", \"utf-8\", \"hex\"). Defaults to utf-8 when omitted."),
+	path: z.string().optional().describe("Read the content from here instead of inlining it: a local file path, a data: URI, or an https URL. Provide this or `content`, not both."),
+	contentType: z.string().optional().describe("MIME type override (e.g. \"application/pdf\"). Inferred from the filename when omitted.")
+});
 /** Schema for the email a model asks to send (the tool input). */
 const emailMessageSchema = z.object({
-	to: z.string().describe("Single recipient email address (e.g. \"alice@example.com\"). Comma-separate multiple recipients yourself."),
+	to: z.array(z.string()).describe("One or more recipient email addresses (e.g. [\"alice@example.com\", \"bob@example.com\"]). Provide at least one."),
 	subject: z.string().describe("Subject line. Keep it short and specific."),
 	body: z.string().describe([
 		"Email body in GitHub-Flavored Markdown; it is rendered to HTML before sending.",
@@ -12,16 +20,32 @@ const emailMessageSchema = z.object({
 		"Do NOT format with ASCII art: no '=====' or '-----' divider lines, and never hand-draw tables or bar charts with spaces, pipes, or '#'. Use the Markdown constructs above instead.",
 		"Be self-contained: the recipient has none of the chat context."
 	].join(" ")),
-	cc: z.array(z.string()).optional().describe("Optional CC recipient addresses."),
-	bcc: z.array(z.string()).optional().describe("Optional BCC recipient addresses.")
+	cc: z.array(z.string()).optional().describe("Optional CC recipient addresses (one or more)."),
+	bcc: z.array(z.string()).optional().describe("Optional BCC recipient addresses (one or more)."),
+	attachments: z.array(emailAttachmentSchema).optional().describe("Optional file attachments to include with the message.")
 });
 /** Schema for the dispatch result returned to the model after a send. */
 const emailResultSchema = z.object({
 	sent: z.boolean().describe("True once the message was handed to the SMTP server."),
-	recipient: z.string().describe("Echo of the `to` field for confirmation."),
+	recipient: z.string().describe("Echo of the `to` recipients (comma-joined) for confirmation."),
 	from: z.string().describe("The resolved sender address the message was actually sent from."),
 	messageId: z.string().optional().describe("SMTP message id assigned by the server, when one was returned.")
 });
+/**
+* Schema for the sender options a UI can offer for the `From` address -
+* the payload of the plugin's `GET /senders` route. When the plugin
+* configures a sender allow-list, `senders` holds the concrete addresses
+* the current user may send as (domain wildcards expanded against the
+* user's local part) and `restricted` is true; a picker should require a
+* choice from the list. When unrestricted, `senders` holds at most the
+* single default address (if one can be resolved) and `restricted` is
+* false, so a UI may allow free entry.
+*/
+const emailSendersSchema = z.object({
+	senders: z.array(z.string()).describe("Permitted sender addresses to offer as `From` choices."),
+	defaultSender: z.string().optional().describe("The address a send uses by default (first `senders` entry, if any)."),
+	restricted: z.boolean().describe("True when `senders` is an enforced allow-list rather than a hint.")
+});
 
 //#endregion
-export { emailMessageSchema, emailResultSchema };
+export { emailAttachmentSchema, emailMessageSchema, emailResultSchema, emailSendersSchema };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dbx-tools/appkit-email-shared",
-  "version": "0.1.78",
+  "version": "0.1.79",
   "dependencies": {
     "zod": "^4.3.6"
   },