@freecorps/ember-email 0.5.2 → 0.5.4

package/README.md

@@ -51,12 +51,25 @@ export const signup = mutation({
     rejected.
   - It stores the raw `.eml` and the attachments in files (R2), and parses the message with `postal-mime`.
   - It reads DKIM, DMARC and SPF from Cloudflare's `Authentication-Results`.
-  - It threads messages by token, then by `In-Reply-To` (DMARC pass, same contact), then by subject.
+  - It threads messages like a mail client, with no token in the Reply-To by default:
+    - an answer that cites an email the mailbox sent joins its thread when the sender is the thread's contact or one
+      of that email's recipients (In-Reply-To / References against the Message-ID the provider gave it, recorded when
+      the send succeeds; DMARC not required, since only those recipients have that id);
+    - a citation of an inbound message counts with DMARC pass from the contact;
+    - then the same contact and subject, within 30 days, if the thread is not closed or spam;
+    - a plus-addressed token (`support+t_…@`) still threads from any sender.
+  - `replyToken: true` in the install config puts that token in the Reply-To of replies, composed emails and
+    auto-replies, as before 0.5.4.
   - It handles spam per sender per hour and auto-replies without loops.
   - Your `onInbound` hook runs in the same transaction (tickets, push).
 - **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).
+  from the mailbox, answers join it as above) 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

@@ -58,6 +58,13 @@ export type EmailInstallConfig = {
     };
     /** Default layout for stored templates without one. */
     layout?: LayoutOptions;
+    /**
+     * Put the thread's token in the Reply-To of inbox replies, composed emails and auto-replies (`support+t_…@`).
+     * Default false: the email goes with no Reply-To, and the answer joins the thread by the Message-ID the provider
+     * gave the sent email (In-Reply-To / References), else by contact + subject. A token in an old email's Reply-To
+     * still threads either way.
+     */
+    replyToken?: boolean;
 };
 export type SendInput = {
     project?: string;
@@ -252,6 +259,7 @@ export declare const emailFunctions: {
                 contentId?: string;
                 inline?: boolean;
                 size?: number;
+                link?: boolean;
             }[];
             replyTo?: {
                 email: string;
@@ -316,6 +324,7 @@ export declare const emailFunctions: {
                 contentId?: string;
                 inline?: boolean;
                 size?: number;
+                link?: boolean;
             }[];
             replyTo?: {
                 email: string;
@@ -419,6 +428,7 @@ export declare const emailFunctions: {
                 contentId?: string;
                 inline?: boolean;
                 size?: number;
+                link?: boolean;
             }[];
             replyTo?: {
                 email: string;
@@ -674,6 +684,7 @@ export declare const emailFunctions: {
                     contentId?: string;
                     inline?: boolean;
                     size?: number;
+                    link?: boolean;
                 }[];
                 references: string[];
                 to: {
@@ -731,6 +742,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 +776,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 +834,7 @@ export declare const emailFunctions: {
                     contentId?: string;
                     inline?: boolean;
                     size?: number;
+                    link?: boolean;
                 }[];
                 references: string[];
                 to: {
@@ -1028,6 +1052,7 @@ export declare const email: import("@freecorps/ember-server").ComponentDefinitio
                 contentId?: string;
                 inline?: boolean;
                 size?: number;
+                link?: boolean;
             }[];
             replyTo?: {
                 email: string;
@@ -1092,6 +1117,7 @@ export declare const email: import("@freecorps/ember-server").ComponentDefinitio
                 contentId?: string;
                 inline?: boolean;
                 size?: number;
+                link?: boolean;
             }[];
             replyTo?: {
                 email: string;
@@ -1195,6 +1221,7 @@ export declare const email: import("@freecorps/ember-server").ComponentDefinitio
                 contentId?: string;
                 inline?: boolean;
                 size?: number;
+                link?: boolean;
             }[];
             replyTo?: {
                 email: string;
@@ -1450,6 +1477,7 @@ export declare const email: import("@freecorps/ember-server").ComponentDefinitio
                     contentId?: string;
                     inline?: boolean;
                     size?: number;
+                    link?: boolean;
                 }[];
                 references: string[];
                 to: {
@@ -1507,6 +1535,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 +1569,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 +1627,7 @@ export declare const email: import("@freecorps/ember-server").ComponentDefinitio
                     contentId?: string;
                     inline?: boolean;
                     size?: number;
+                    link?: boolean;
                 }[];
                 references: string[];
                 to: {
@@ -1669,6 +1710,7 @@ export declare const email: import("@freecorps/ember-server").ComponentDefinitio
         onInbound?: string;
         onEvent?: string;
     };
+    replyToken?: boolean;
 }, Record<"rateLimit", import("@freecorps/ember-server").ComponentDefinition<"rateLimit", {
     lib: {
         limit: import("@freecorps/ember-server").RegisteredMutation<"public", {

package/dist/component.js

@@ -20,7 +20,7 @@
  */
 import { componentBuilders, cronJobs, defineComponent, EmberError, v } from "@freecorps/ember-server";
 import { rateLimit } from "@freecorps/ember-rate-limit";
-import { domainOf, isNoReplySender, parseAddress, parseAddressList, replySubject, splitPlus, subjectKey, withPlus, } from "./address.js";
+import { domainOf, isNoReplySender, parseAddress, parseAddressList, replySubject, splitPlus, subjectKey, normalizeMessageId, withPlus, } from "./address.js";
 import { nextStatus, parseDeliveryEvent } from "./events.js";
 import { parseInbound, snippetOf } from "./mime.js";
 import { addressV, emailSchema, errorV } from "./schema.js";
@@ -41,6 +41,7 @@ const configV = v.optional(v.object({
     spamPerHour: v.optional(v.number()),
     hooks: v.optional(v.object({ onInbound: v.optional(v.string()), onEvent: v.optional(v.string()) })),
     layout: v.optional(v.any()),
+    replyToken: v.optional(v.boolean()),
 }));
 const { query, mutation, internalQuery, internalMutation, internalAction } = componentBuilders();
 const MAX_RECIPIENTS = 50;
@@ -74,6 +75,22 @@ 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 Reply-To of an email in a thread: the token address only when the install asks for it (`replyToken`). */
+const threadReplyTo = (ctx, mb, thread) => (cfg(ctx).replyToken ? { replyTo: withPlus(mb.address, `t_${thread.token}`) } : {});
+/** 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";
@@ -378,14 +395,24 @@ function ingest(ctx, a) {
         thread = ctx.db.query("threads").withIndex("by_token", (q) => q.eq("token", a.tag.slice(2))).first();
     if (thread && thread.mailbox !== a.mailbox)
         thread = null;
-    if (!thread && a.auth.dmarc === "pass") {
+    if (!thread) {
         for (const ref of [a.inReplyTo, ...a.references.slice().reverse()].filter(Boolean)) {
             const m = ctx.db.query("messages").withIndex("by_message_id", (q) => q.eq("mailbox", a.mailbox).eq("messageIdHeader", ref)).first();
             if (!m)
                 continue;
             const t = ctx.db.get(m.threadId);
-            // Another contact's thread: keep looking (an older reference may be this contact's own thread).
-            if (t && t.contact === contact) {
+            if (!t)
+                continue;
+            // An answer to an email this mailbox sent: its Message-ID went only to that email's recipients, so it joins
+            // when the sender is the contact or one of them, DMARC or not (forwarders break DMARC). A reference to an
+            // inbound message is public (anyone in the conversation has it): DMARC must pass and the From be the contact.
+            // Who sent it is the From address, never the Reply-To: anyone writes a Reply-To, and DMARC vouches for the
+            // From's domain only.
+            const sender = a.from.email;
+            const sentTo = m.direction === "outbound" ? [...(m.to ?? []), ...(m.cc ?? [])].map((x) => x.email) : [];
+            const ok = m.direction === "outbound" ? sender === t.contact || sentTo.includes(sender) : a.auth.dmarc === "pass" && sender === t.contact;
+            // Otherwise keep looking (an older reference may be this contact's own thread).
+            if (ok) {
                 thread = t;
                 break;
             }
@@ -472,7 +499,7 @@ function ingest(ctx, a) {
                 project: `mailbox:${a.mailbox}`,
                 from: { email: mb.address, ...(mb.displayName ? { name: mb.displayName } : {}) },
                 to: contact,
-                replyTo: withPlus(mb.address, `t_${thread.token}`),
+                ...threadReplyTo(ctx, mb, thread),
                 subject: renderTemplateSafe(mb.autoReply.subject, data, false),
                 text,
                 html: mb.autoReply.html ? emailLayout(renderTemplateSafe(mb.autoReply.html, data, true)) : emailLayout(textToHtml(text)),
@@ -533,8 +560,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 } : {}),
@@ -652,6 +679,19 @@ export const emailFunctions = {
                 const extra = a.droppedHeaders?.length ? { droppedHeaders: a.droppedHeaders } : {};
                 if (a.outcome === "sent") {
                     ctx.db.patch(a.emailId, { status: "sent", messageId: a.messageId, sentAt: ctx.now, error: undefined, ...extra });
+                    // The provider's id is the email's Message-ID: the thread's outbound message records it, so an answer
+                    // (In-Reply-To / References) finds its thread without a token in the Reply-To.
+                    const mid = normalizeMessageId(a.messageId);
+                    if (e.threadId && mid) {
+                        const out = ctx.db
+                            .query("messages")
+                            .withIndex("by_thread", (q) => q.eq("threadId", e.threadId))
+                            .order("desc")
+                            .filter((q) => q.eq(q.field("emailId"), a.emailId))
+                            .first();
+                        if (out && !out.messageIdHeader)
+                            ctx.db.patch(out._id, { messageIdHeader: mid });
+                    }
                     // Events can arrive before `finish` commits (the provider is fast): apply the ones already stored, exactly
                     // as `applyEvent` would have (status, suppression, onEvent hook).
                     for (const ev of ctx.db.query("events").withIndex("by_message", (q) => q.eq("messageId", a.messageId)).collect()) {
@@ -880,7 +920,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)
@@ -910,15 +958,17 @@ export const emailFunctions = {
                     from: { email: mb.address, ...(mb.displayName ? { name: mb.displayName } : {}) },
                     to,
                     ...(a.cc?.length ? { cc: a.cc } : {}),
-                    replyTo: withPlus(mb.address, `t_${thread.token}`),
+                    ...threadReplyTo(ctx, mb, thread),
                     subject: replySubject(thread.subject),
                     text: a.text + quote,
                     html,
                     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 +1006,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();
@@ -997,13 +1048,15 @@ export const emailFunctions = {
                     from: { email: mb.address, ...(mb.displayName ? { name: mb.displayName } : {}) },
                     to,
                     ...(a.cc?.length ? { cc: a.cc } : {}),
-                    replyTo: withPlus(mb.address, `t_${thread.token}`),
+                    ...threadReplyTo(ctx, mb, thread),
                     subject,
                     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.2",
+  "version": "0.5.4",
   "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.2",
-    "@freecorps/ember-server": "0.5.2",
-    "@freecorps/ember-values": "0.5.2",
+    "@freecorps/ember-rate-limit": "0.5.4",
+    "@freecorps/ember-server": "0.5.4",
+    "@freecorps/ember-values": "0.5.4",
     "postal-mime": "^4.1.4"
   }
 }