@sockethub/platform-email 0.0.0-stage → 1.0.0-beta.2

package/LICENSE

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

package/README.md

@@ -1,3 +1,238 @@
-# Temporary Holding Version
+# Email platform
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+`@sockethub/platform-email` receives mail through IMAP and submits outgoing mail
+through SMTP. The mail server remains the message store. Sockethub keeps no
+mailbox database and does not change read flags, move messages, or delete mail.
+
+Requires Node.js >=20.19 and Redis through the Sockethub server.
+
+Supported actions: `connect`, `disconnect`, `fetch`, `watch`, `unwatch`, `send`.
+Each client session has its own worker and IMAP connection, so clients using the
+same account can choose different folders and filters independently.
+
+## Connect
+
+Enable `@sockethub/platform-email` in the server's `platforms` list if you use an
+explicit configuration. The bundled default configuration includes it.
+
+```javascript
+await sc.ready();
+const actor = { id: 'me@example.com', type: 'person', name: 'Example Sender' };
+const context = sc.contextFor('email');
+
+function emit(event, activity) {
+  return new Promise((resolve, reject) => {
+    sc.socket.emit(event, activity, (result) => {
+      if (result?.error) reject(new Error(result.error));
+      else resolve(result);
+    });
+  });
+}
+
+await emit('credentials', {
+  '@context': context,
+  type: 'credentials',
+  actor,
+  object: {
+    type: 'credentials',
+    from: 'me@example.com',
+    imap: {
+      host: 'imap.example.com',
+      port: 993,
+      secure: true,
+      username: 'me@example.com',
+      password: '<runtime app password>'
+    },
+    smtp: {
+      host: 'smtp.example.com',
+      port: 587,
+      secure: false,
+      username: 'me@example.com',
+      token: '<runtime OAuth access token>'
+    }
+  }
+});
+await emit('message', { '@context': context, type: 'connect', actor });
+```
+
+Configure IMAP, SMTP, or both. Every server needs its own username and exactly one
+of `password` or `token`. Access tokens are supplied by your application; this
+platform does not run authorization flows or refresh tokens. `from` is the sender
+address used for outgoing mail, which the SMTP provider must authorize.
+
+`secure: true` uses TLS immediately. `secure: false` requires STARTTLS; plaintext
+credentials and invalid certificates are never accepted. IMAP defaults to TLS on
+993, SMTP to STARTTLS on 587. SMTP port 465 implies immediate TLS unless overridden.
+
+Private, loopback, and metadata server addresses are blocked by default. An
+operator can allow a trusted private mail server with:
+
+```json
+{
+  "packageConfig": {
+    "@sockethub/platform-email": {
+      "allowPrivateAddresses": true
+    }
+  }
+}
+```
+
+The examples app includes an `/email` page for configuring an account, fetching,
+watching, and sending. Credentials are entered at runtime.
+
+## Fetch
+
+```javascript
+const page = await emit('message', {
+  '@context': context,
+  type: 'fetch',
+  actor,
+  object: {
+    folders: ['INBOX', 'Orders'],
+    from: ['friend@example.com'],
+    to: ['me@example.com'],
+    match: 'any',
+    limit: 20
+  }
+});
+
+// Repeat with the same folders and filters to fetch the next page.
+const next = await emit('message', {
+  '@context': context,
+  type: 'fetch',
+  actor,
+  object: {
+    folders: ['INBOX', 'Orders'],
+    from: ['friend@example.com'],
+    to: ['me@example.com'],
+    match: 'any',
+    limit: 20,
+    cursors: page.cursors
+  }
+});
+```
+
+Responses are `collection` objects with `items`, per-folder `cursors`, and
+`hasMore`. Merge returned cursors into the previous cursor map before requesting
+another page: folders not visited in a page have no replacement cursor. Results
+are ordered by increasing UID within each requested folder, visiting folders in
+request order. There is no cross-folder date sort. Omit cursors to start from the
+oldest messages; the default folder is `INBOX` and the default limit is 20 (max 50).
+
+Address arrays match any listed address. `match: "any"` (default) means From OR To;
+`match: "all"` means From AND To when both filters are present. Sockethub checks
+parsed addresses case-insensitively after IMAP search, avoiding substring matches.
+To refers to the visible To header, not BCC or the actual delivery envelope. A
+matching From header does not establish sender authenticity.
+
+Every item is a `post` activity: its actor is the sender, target is your account,
+and object is a `message` containing `id`, `folder`, `uidValidity`, `uid`, `from`,
+`to`, `cc`, `subject`, `messageId`, `inReplyTo`, `references` (an array of message
+IDs), `published`, `content` (plain text), and optional `html`. Sender display
+names are retained in `from` and the activity's `actor.name`. Treat returned HTML
+as untrusted when rendering it.
+
+`attachments` lists MIME part metadata as `{ filename?, contentType }`, including
+named inline parts and nested attachments. An attachment without a filename is
+still listed with its media type. Filenames and References are fetched separately
+from the body, so they remain available when `bodyOmitted` is true. Attachment
+contents are never returned.
+
+A request examines up to 500 UID positions per folder and transfers up to 512 KiB
+of source message data across the batch. A page can therefore be empty while
+`hasMore` remains true; continue using its cursors. Messages larger than 256 KiB
+are returned as metadata with `bodyOmitted: true`. Attachment contents are not returned.
+
+The cursor combines UIDVALIDITY and the last scanned UID. Keep it tied to the
+same mail server, account, and folder: UIDVALIDITY values can overlap across
+accounts. The examples page resets pagination on connection changes.
+If the server resets UIDVALIDITY, Sockethub rejects the cursor;
+discard that folder's cursor and fetch again. The application owns any durable
+cursor storage and duplicate handling. Reset cursors when changing filters.
+
+## Watch
+
+```javascript
+sc.socket.on('message', (activity) => {
+  // Check the email context before processing messages from a multi-platform client.
+  if (activity['@context']?.some(value => value.includes('/platform/email/'))) {
+    if (activity.error) console.error(activity.error);
+    else if (activity.type === 'post') console.log(activity.object);
+    else if (activity.type === 'watch') console.log(activity.object.cursor);
+  }
+});
+
+await emit('message', {
+  '@context': context,
+  type: 'watch',
+  actor,
+  object: { folder: 'INBOX', to: ['me@example.com'] }
+});
+
+await emit('message', { '@context': context, type: 'unwatch', actor });
+```
+
+Watch observes one folder per client session, using IMAP IDLE with the library's
+polling fallback. A new watch replaces the previous watch. It starts at the
+current end of the folder unless `object.cursor` supplies a prior cursor for
+catch-up. Filters have the same meaning as fetch. Progress arrives as `watch`
+activities containing `{ type: "subscription", folder, cursor }`, including when
+new messages do not match the filters. Fetching other folders temporarily pauses
+the watch and then resumes it, catching up by UID.
+
+Watching stops on connection loss and reports a `disconnect` activity with an
+error. Explicitly reconnect and supply your saved cursor to fetch or watch again.
+There is no background collection or exactly-once delivery guarantee. Mail moved
+out of the watched folder before it can be fetched may not be observed.
+
+## Send
+
+```javascript
+const submission = await emit('message', {
+  '@context': context,
+  type: 'send',
+  actor,
+  object: {
+    to: ['friend@example.com'],
+    subject: 'Hello',
+    content: 'Hello from Sockethub!',
+    inReplyTo: '<original-message@example.com>'
+  }
+});
+console.log(submission.object.accepted, submission.object.rejected);
+```
+
+Send accepts `to`, optional `cc` and `bcc` arrays, `subject`, `content` (plain text),
+`html`, `inReplyTo`, and a `references` array. The outgoing sender display name
+comes from `actor.name` when provided. At least one body representation and
+one To recipient are required. It returns a `send` activity with a `submission`
+object containing `messageId`, `accepted`, `rejected`, and
+`status: "accepted-by-server"`. Acceptance does not guarantee delivery; some
+recipients can be rejected while others are accepted.
+
+A failed submission can have an uncertain outcome if the connection drops after
+the server accepts it. Do not automatically resend an uncertain submission. The
+platform makes one submission attempt per action and disables stalled-job replay
+after worker crashes, so uncertain sends are left for the application to resolve.
+It does not save a Sent-folder copy.
+
+On logout, disconnect and clear the client's replayed credentials:
+
+```javascript
+await emit('message', { '@context': context, type: 'disconnect', actor });
+sc.clearCredentials({ platform: 'email', actorId: actor.id });
+```
+
+POP, folder mutations, flags, drafts, attachment transfers, provider OAuth
+onboarding, and durable mailbox synchronization are outside this platform's scope.
+
+## Development checks
+
+After `bun install`, run `bun run --filter='@sockethub/platform-email' test` for
+unit tests, including on a clean checkout. This runs the repository's shared
+`build:foundations` preparation first; it does not build the whole monorepo.
+Direct `bun test` assumes those dependencies have already been built.
+
+After `bun run build`, run `bun run integration:email` for real IMAP fetch/watch
+and SMTP send against local TLS test servers. That check requires `openssl` and
+no external mail account.

package/dist/index.d.ts

@@ -0,0 +1,263 @@
+import type { ActivityStream, PersistentPlatformConfig, PersistentPlatformInterface, PlatformCallback, PlatformSession } from "@sockethub/schemas";
+import { ImapFlow, type ImapFlowOptions, type MessageEnvelopeObject, type MessageStructureObject } from "imapflow";
+import { type Transporter } from "nodemailer";
+import type SMTPTransport from "nodemailer/lib/smtp-transport/index.js";
+import type { EmailAttachment, EmailCredentials, EmailJob, FetchOptions, Filter, SendOptions, WatchOptions } from "./types.js";
+export type { Cursor, EmailAttachment, EmailCredentials, FetchOptions, Filter, SendOptions, WatchOptions, } from "./types.js";
+interface Dependencies {
+    imap(options: ImapFlowOptions): ImapFlow;
+    smtp(options: SMTPTransport.Options): Transporter<SMTPTransport.SentMessageInfo>;
+}
+export declare function matchesAddresses(envelope: MessageEnvelopeObject, filter: Filter): boolean;
+/** List attachment metadata without fetching attachment body parts. */
+export declare function attachmentMetadata(structure?: MessageStructureObject): EmailAttachment[];
+export default class Email implements PersistentPlatformInterface {
+    private readonly dependencies;
+    credentialsHash: string | undefined;
+    config: PersistentPlatformConfig;
+    private readonly log;
+    private readonly sendToClient;
+    private client?;
+    private initialized;
+    private connecting?;
+    private chain;
+    private watching?;
+    private draining;
+    private drainAgain;
+    private closed;
+    private disposed;
+    constructor(session: PlatformSession, dependencies?: Dependencies);
+    get schema(): {
+        name: string;
+        version: string;
+        contextUrl: string;
+        contextVersion: string;
+        schemaVersion: string;
+        credentials: {
+            required: string[];
+            properties: {
+                object: {
+                    type: string;
+                    additionalProperties: boolean;
+                    required: string[];
+                    properties: {
+                        type: {
+                            const: string;
+                        };
+                        from: {
+                            type: string;
+                            format: string;
+                            maxLength: number;
+                        };
+                        imap: {
+                            type: string;
+                            additionalProperties: boolean;
+                            required: string[];
+                            properties: {
+                                host: {
+                                    type: string;
+                                    minLength: number;
+                                    maxLength: number;
+                                    pattern: string;
+                                };
+                                port: {
+                                    type: string;
+                                    minimum: number;
+                                    maximum: number;
+                                };
+                                secure: {
+                                    type: string;
+                                };
+                                username: {
+                                    type: string;
+                                    minLength: number;
+                                    maxLength: number;
+                                };
+                                password: {
+                                    type: string;
+                                    minLength: number;
+                                    maxLength: number;
+                                };
+                                token: {
+                                    type: string;
+                                    minLength: number;
+                                    maxLength: number;
+                                };
+                            };
+                            oneOf: {
+                                required: string[];
+                            }[];
+                        };
+                        smtp: {
+                            type: string;
+                            additionalProperties: boolean;
+                            required: string[];
+                            properties: {
+                                host: {
+                                    type: string;
+                                    minLength: number;
+                                    maxLength: number;
+                                    pattern: string;
+                                };
+                                port: {
+                                    type: string;
+                                    minimum: number;
+                                    maximum: number;
+                                };
+                                secure: {
+                                    type: string;
+                                };
+                                username: {
+                                    type: string;
+                                    minLength: number;
+                                    maxLength: number;
+                                };
+                                password: {
+                                    type: string;
+                                    minLength: number;
+                                    maxLength: number;
+                                };
+                                token: {
+                                    type: string;
+                                    minLength: number;
+                                    maxLength: number;
+                                };
+                            };
+                            oneOf: {
+                                required: string[];
+                            }[];
+                        };
+                    };
+                    anyOf: {
+                        required: string[];
+                    }[];
+                };
+            };
+        };
+        messages: {
+            required: string[];
+            properties: {
+                type: {
+                    enum: string[];
+                };
+                object: {
+                    type: string;
+                };
+            };
+            allOf: ({
+                if: {
+                    properties: {
+                        type: {
+                            const: string;
+                        };
+                    };
+                };
+                then: {
+                    properties: {
+                        object: {
+                            type: string;
+                            additionalProperties: boolean;
+                            properties: {
+                                type: {
+                                    const: string;
+                                };
+                            };
+                        };
+                    };
+                    required?: undefined;
+                };
+            } | {
+                if: {
+                    properties: {
+                        type: {
+                            const: string;
+                        };
+                    };
+                };
+                then: {
+                    required: string[];
+                    properties: {
+                        object: {
+                            required: string[];
+                            anyOf: {
+                                required: string[];
+                            }[];
+                            type: string;
+                            additionalProperties: boolean;
+                            properties: {
+                                type: {
+                                    const: string;
+                                };
+                            };
+                        };
+                    };
+                };
+            })[];
+        };
+        responses: {
+            type: string;
+            required: string[];
+            properties: {
+                type: {
+                    enum: string[];
+                };
+                actor: {
+                    type: string;
+                    required: string[];
+                };
+                object: {
+                    type: string;
+                };
+                items: {
+                    type: string;
+                    maxItems: number;
+                    items: {
+                        type: string;
+                        required: string[];
+                    };
+                };
+                cursors: {
+                    type: string;
+                    additionalProperties: {
+                        type: string;
+                        additionalProperties: boolean;
+                        required: string[];
+                        properties: {
+                            uidValidity: {
+                                type: string;
+                                pattern: string;
+                                maxLength: number;
+                            };
+                            uid: {
+                                type: string;
+                                minimum: number;
+                                maximum: number;
+                            };
+                        };
+                    };
+                };
+                hasMore: {
+                    type: string;
+                };
+                error: {
+                    type: string;
+                };
+            };
+        };
+    };
+    isInitialized(): boolean;
+    private failure;
+    private run;
+    connect(job: ActivityStream, credentials: EmailCredentials, done: PlatformCallback): void;
+    private open;
+    fetch(job: EmailJob<FetchOptions>, done: PlatformCallback): void;
+    private imap;
+    private batch;
+    watch(job: EmailJob<WatchOptions>, done: PlatformCallback): void;
+    private drain;
+    unwatch(job: ActivityStream, done: PlatformCallback): void;
+    send(job: EmailJob<SendOptions>, credentials: EmailCredentials, done: PlatformCallback): void;
+    disconnect(job: ActivityStream, done: PlatformCallback): void;
+    private close;
+    cleanup(done: PlatformCallback): void;
+}