@freecorps/ember-email 0.5.1 → 0.5.3

package/README.md

@@ -57,6 +57,11 @@ export const signup = mutation({
 - **Inbox queries** for dashboards and mobile apps: `threads`, `thread`, `unread` (aggregate), `search`
   (`searchIndex`), `reply`, `note`, `markRead`, `markUnread`, `setStatus`, `assign`, `compose` (a new conversation
   from the mailbox, answers join it by token) and `recent` (latest threads with their messages, for offline replicas).
+  `reply` and `compose` take `attachments: [{ filename, contentType, file }]`, files already stored in the shard
+  (uploaded with `ctx.storage.generateUploadUrl`). They go with the email and stay on the thread's outbound message
+  (with their size). Mind the provider's message size: for a large file, put a download link in the text
+  (`ctx.storage.getUrl(file, { download, expiresIn })`) and pass it with `link: true`. The email then has no MIME part
+  for it, and the message still holds the file (the thread lists it, and it is not collected).
 
 ## Domains: `@freecorps/ember-email/cloudflare`
 

package/dist/component.d.ts

@@ -252,6 +252,7 @@ export declare const emailFunctions: {
                 contentId?: string;
                 inline?: boolean;
                 size?: number;
+                link?: boolean;
             }[];
             replyTo?: {
                 email: string;
@@ -316,6 +317,7 @@ export declare const emailFunctions: {
                 contentId?: string;
                 inline?: boolean;
                 size?: number;
+                link?: boolean;
             }[];
             replyTo?: {
                 email: string;
@@ -419,6 +421,7 @@ export declare const emailFunctions: {
                 contentId?: string;
                 inline?: boolean;
                 size?: number;
+                link?: boolean;
             }[];
             replyTo?: {
                 email: string;
@@ -674,6 +677,7 @@ export declare const emailFunctions: {
                     contentId?: string;
                     inline?: boolean;
                     size?: number;
+                    link?: boolean;
                 }[];
                 references: string[];
                 to: {
@@ -731,6 +735,12 @@ export declare const emailFunctions: {
             text: string;
             threadId: GenericId<"threads">;
             html?: string;
+            attachments?: {
+                filename: string;
+                contentType: string;
+                file: import("@freecorps/ember-values").FileId;
+                link?: boolean;
+            }[];
             cc?: string[];
             sendAt?: number;
             author?: string;
@@ -759,6 +769,12 @@ export declare const emailFunctions: {
             subject: string;
             mailbox: string;
             html?: string;
+            attachments?: {
+                filename: string;
+                contentType: string;
+                file: import("@freecorps/ember-values").FileId;
+                link?: boolean;
+            }[];
             cc?: string[];
             author?: string;
         }, {
@@ -811,6 +827,7 @@ export declare const emailFunctions: {
                     contentId?: string;
                     inline?: boolean;
                     size?: number;
+                    link?: boolean;
                 }[];
                 references: string[];
                 to: {
@@ -1028,6 +1045,7 @@ export declare const email: import("@freecorps/ember-server").ComponentDefinitio
                 contentId?: string;
                 inline?: boolean;
                 size?: number;
+                link?: boolean;
             }[];
             replyTo?: {
                 email: string;
@@ -1092,6 +1110,7 @@ export declare const email: import("@freecorps/ember-server").ComponentDefinitio
                 contentId?: string;
                 inline?: boolean;
                 size?: number;
+                link?: boolean;
             }[];
             replyTo?: {
                 email: string;
@@ -1195,6 +1214,7 @@ export declare const email: import("@freecorps/ember-server").ComponentDefinitio
                 contentId?: string;
                 inline?: boolean;
                 size?: number;
+                link?: boolean;
             }[];
             replyTo?: {
                 email: string;
@@ -1450,6 +1470,7 @@ export declare const email: import("@freecorps/ember-server").ComponentDefinitio
                     contentId?: string;
                     inline?: boolean;
                     size?: number;
+                    link?: boolean;
                 }[];
                 references: string[];
                 to: {
@@ -1507,6 +1528,12 @@ export declare const email: import("@freecorps/ember-server").ComponentDefinitio
             text: string;
             threadId: GenericId<"threads">;
             html?: string;
+            attachments?: {
+                filename: string;
+                contentType: string;
+                file: import("@freecorps/ember-values").FileId;
+                link?: boolean;
+            }[];
             cc?: string[];
             sendAt?: number;
             author?: string;
@@ -1535,6 +1562,12 @@ export declare const email: import("@freecorps/ember-server").ComponentDefinitio
             subject: string;
             mailbox: string;
             html?: string;
+            attachments?: {
+                filename: string;
+                contentType: string;
+                file: import("@freecorps/ember-values").FileId;
+                link?: boolean;
+            }[];
             cc?: string[];
             author?: string;
         }, {
@@ -1587,6 +1620,7 @@ export declare const email: import("@freecorps/ember-server").ComponentDefinitio
                     contentId?: string;
                     inline?: boolean;
                     size?: number;
+                    link?: boolean;
                 }[];
                 references: string[];
                 to: {

package/dist/component.js

@@ -74,6 +74,20 @@ const sendArgs = {
     threadId: v.optional(v.string()),
 };
 const HEADER_NAME = /^[A-Za-z0-9-]{1,100}$/;
+/**
+ * Files already stored in this shard, for an inbox reply or a composed email. `link: true`: too large to attach; the
+ * caller puts a download link in the text, the email carries no MIME part, and the message still holds the file.
+ */
+const inboxAttachmentsV = v.optional(v.array(v.object({ filename: v.string(), contentType: v.string(), file: v.file(), link: v.optional(v.boolean()) })));
+/** The MIME attachments of the email: every file not sent as a link. */
+const mimeParts = (list) => (list ?? []).filter((a) => !a.link).map(({ filename, contentType, file }) => ({ filename, contentType, file }));
+/** The stored message's attachment rows (size from the file's metadata when known). */
+function attachmentRows(ctx, list) {
+    return (list ?? []).map((a) => {
+        const meta = ctx.storage?.getMetadata?.(a.file);
+        return { filename: a.filename, contentType: a.contentType, file: a.file, ...(meta?.size != null ? { size: meta.size } : {}), ...(a.link ? { link: true } : {}) };
+    });
+}
 const RESERVED_HEADERS = new Set(["from", "to", "cc", "bcc", "subject", "reply-to", "content-type", "mime-version", "content-transfer-encoding"]);
 function doSend(ctx, a) {
     const project = a.project ?? "default";
@@ -533,8 +547,8 @@ function appendOutbound(ctx, thread, mb, a) {
         text: a.text,
         ...(a.html ? { html: a.html } : {}),
         snippet,
-        searchText: `${thread.subject}\n${a.author ?? ""}\n${a.text}`.slice(0, 100_000),
-        attachments: [],
+        searchText: `${thread.subject}\n${a.author ?? ""}\n${a.text}${(a.attachments ?? []).map((x) => `\n${x.filename}`).join("")}`.slice(0, 100_000),
+        attachments: a.attachments ?? [],
         autoSubmitted: false,
         ...(a.emailId ? { emailId: a.emailId } : {}),
         ...(a.author ? { author: a.author } : {}),
@@ -880,7 +894,15 @@ export const emailFunctions = {
         }),
         /** Replies from the inbox: sent from the mailbox address, Reply-To carries the thread token, threading headers set. */
         reply: mutation({
-            args: { threadId: v.id("threads"), text: v.string(), html: v.optional(v.string()), author: v.optional(v.string()), cc: v.optional(v.array(v.string())), sendAt: v.optional(v.number()) },
+            args: {
+                threadId: v.id("threads"),
+                text: v.string(),
+                html: v.optional(v.string()),
+                author: v.optional(v.string()),
+                cc: v.optional(v.array(v.string())),
+                sendAt: v.optional(v.number()),
+                attachments: inboxAttachmentsV,
+            },
             handler: (ctx, a) => {
                 const thread = ctx.db.get(a.threadId);
                 if (!thread)
@@ -917,8 +939,10 @@ export const emailFunctions = {
                     headers,
                     threadId: thread._id,
                     ...(a.sendAt ? { sendAt: a.sendAt } : {}),
+                    ...(mimeParts(a.attachments).length ? { attachments: mimeParts(a.attachments) } : {}),
                 });
-                const messageId = appendOutbound(ctx, thread, mb, { text: a.text, ...(a.html ? { html: a.html } : {}), emailId: sent.id, ...(a.author ? { author: a.author } : {}), to, ...(a.cc?.length ? { cc: parseAddressList(a.cc) } : {}) });
+                const files = attachmentRows(ctx, a.attachments);
+                const messageId = appendOutbound(ctx, thread, mb, { text: a.text, ...(a.html ? { html: a.html } : {}), emailId: sent.id, ...(a.author ? { author: a.author } : {}), to, ...(a.cc?.length ? { cc: parseAddressList(a.cc) } : {}), attachments: files });
                 return { emailId: sent.id, messageId, status: sent.status };
             },
         }),
@@ -956,6 +980,7 @@ export const emailFunctions = {
                 text: v.string(),
                 html: v.optional(v.string()),
                 author: v.optional(v.string()),
+                attachments: inboxAttachmentsV,
             },
             handler: (ctx, a) => {
                 const mb = ctx.db.query("mailboxes").withIndex("by_name", (q) => q.eq("name", a.mailbox)).first();
@@ -1002,8 +1027,10 @@ export const emailFunctions = {
                     text: a.text,
                     html: a.html ?? emailLayout(textToHtml(a.text)),
                     threadId,
+                    ...(mimeParts(a.attachments).length ? { attachments: mimeParts(a.attachments) } : {}),
                 });
-                const messageId = appendOutbound(ctx, thread, mb, { text: a.text, ...(a.html ? { html: a.html } : {}), emailId: sent.id, ...(a.author ? { author: a.author } : {}), to, ...(a.cc?.length ? { cc: parseAddressList(a.cc) } : {}) });
+                const files = attachmentRows(ctx, a.attachments);
+                const messageId = appendOutbound(ctx, thread, mb, { text: a.text, ...(a.html ? { html: a.html } : {}), emailId: sent.id, ...(a.author ? { author: a.author } : {}), to, ...(a.cc?.length ? { cc: parseAddressList(a.cc) } : {}), attachments: files });
                 return { threadId, emailId: sent.id, messageId, status: sent.status, number };
             },
         }),

package/dist/schema.d.ts

@@ -12,6 +12,7 @@ export declare const attachmentV: import("@freecorps/ember-values").Validator<{
     contentId?: string;
     inline?: boolean;
     size?: number;
+    link?: boolean;
 }, "required", import("@freecorps/ember-values").ObjectFieldPaths<{
     filename: import("@freecorps/ember-values").Validator<string, "required", never>;
     contentType: import("@freecorps/ember-values").Validator<string, "required", never>;
@@ -19,6 +20,8 @@ export declare const attachmentV: import("@freecorps/ember-values").Validator<{
     size: import("@freecorps/ember-values").Validator<number, "optional", never>;
     contentId: import("@freecorps/ember-values").Validator<string, "optional", never>;
     inline: import("@freecorps/ember-values").Validator<boolean, "optional", never>;
+    /** Sent as a link in the body (too large to attach), not as a MIME part: the message still holds the file. */
+    link: import("@freecorps/ember-values").Validator<boolean, "optional", never>;
 }>>;
 export declare const errorV: import("@freecorps/ember-values").Validator<{
     code: string;
@@ -68,6 +71,7 @@ export declare const emailSchema: import("@freecorps/ember-server").SchemaDefini
             contentId?: string;
             inline?: boolean;
             size?: number;
+            link?: boolean;
         }[], "optional", never>;
         template: import("@freecorps/ember-values").Validator<{
             name: string;
@@ -239,6 +243,7 @@ export declare const emailSchema: import("@freecorps/ember-server").SchemaDefini
             contentId?: string;
             inline?: boolean;
             size?: number;
+            link?: boolean;
         }[], "required", never>;
         droppedAttachments: import("@freecorps/ember-values").Validator<number, "optional", never>;
         auth: import("@freecorps/ember-values").Validator<{

package/dist/schema.js

@@ -8,6 +8,8 @@ export const attachmentV = v.object({
     size: v.optional(v.number()),
     contentId: v.optional(v.string()),
     inline: v.optional(v.boolean()),
+    /** Sent as a link in the body (too large to attach), not as a MIME part: the message still holds the file. */
+    link: v.optional(v.boolean()),
 });
 export const errorV = v.object({ code: v.string(), message: v.string() });
 export const emailSchema = defineSchema({

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@freecorps/ember-email",
-  "version": "0.5.1",
+  "version": "0.5.3",
   "description": "Email component for Ember on Cloudflare: send (atomic from mutations, scheduled, idempotent) through Email Service, templates, suppressions and per-project rate limits, delivery events from the Queue, inbound mail (Email Routing) parsed into mailboxes and threads. `@freecorps/ember-email/cloudflare` onboards a domain (sending, routing rules, event subscription) and removes it.",
   "keywords": [
     "ember",
@@ -52,9 +52,9 @@
     "access": "public"
   },
   "dependencies": {
-    "@freecorps/ember-rate-limit": "0.5.1",
-    "@freecorps/ember-server": "0.5.1",
-    "@freecorps/ember-values": "0.5.1",
+    "@freecorps/ember-rate-limit": "0.5.3",
+    "@freecorps/ember-server": "0.5.3",
+    "@freecorps/ember-values": "0.5.3",
     "postal-mime": "^4.1.4"
   }
 }