@wirecat/mail-cli 0.5.0 → 0.7.0

package/dist/mail/imap/write.js

@@ -0,0 +1,93 @@
+import { CliError } from "@wirecat/cli-base";
+const SEARCH_IDS = 100;
+const range = (uids) => uids.join(",");
+const movedOf = (answer) => answer === false
+    ? { uids: new Map() }
+    : {
+        uids: new Map(answer.uidMap ?? []),
+        ...(answer.uidValidity === undefined ? {} : { validity: String(answer.uidValidity) }),
+    };
+/** Every change the mail commands make, over imapflow. Each is one command per folder, never repeated. */
+export const imapWrites = (pool) => {
+    const changed = async (done, what) => {
+        if (!(await done))
+            throw new CliError("provider_unavailable", `the server refused to ${what}`);
+    };
+    return {
+        locate: (folder, { emailIds = [], messageIds = [] }) => pool.inFolder(folder, async (open, validity) => {
+            const uids = new Map();
+            const found = async (queries, keyOf) => {
+                for (let at = 0; at < queries.length; at += SEARCH_IDS) {
+                    const part = queries.slice(at, at + SEARCH_IDS);
+                    const hits = (await open.search(part.length === 1 ? part[0] : { or: part }, { uid: true })) || [];
+                    if (hits.length === 0)
+                        continue;
+                    for (const message of await open.fetchAll(hits, { uid: true, emailId: true, envelope: true }, { uid: true })) {
+                        const key = keyOf(message);
+                        if (key !== undefined)
+                            uids.set(key, message.uid);
+                    }
+                }
+            };
+            const wantedEmails = new Set(emailIds);
+            await found(emailIds.map((emailId) => ({ emailId })), (message) => message.emailId && wantedEmails.has(String(message.emailId)) ? String(message.emailId) : undefined);
+            const wantedMessages = new Set(messageIds);
+            await found(messageIds.map((messageId) => ({ header: { "message-id": messageId } })), (message) => {
+                const id = message.envelope?.messageId;
+                return id && wantedMessages.has(id) ? id : undefined;
+            });
+            return { validity, uids };
+        }),
+        state: (folder, validity, uids) => pool.inFolder(folder, async (open) => {
+            const states = new Map();
+            if (uids.length === 0)
+                return states;
+            const fetched = await open.fetchAll(range(uids), { uid: true, flags: true, labels: true, envelope: true }, { uid: true });
+            for (const message of fetched)
+                states.set(message.uid, {
+                    flags: [...(message.flags ?? [])].sort(),
+                    ...(message.labels ? { labels: [...message.labels].sort() } : {}),
+                    ...(message.envelope?.messageId ? { messageId: message.envelope.messageId } : {}),
+                });
+            return states;
+        }, validity),
+        flag: (folder, validity, uids, { add = [], remove = [] }) => pool.writeIn(folder, async (open) => {
+            if (add.length)
+                await changed(open.messageFlagsAdd(range(uids), add, { uid: true }), "add the flags");
+            if (remove.length)
+                await changed(open.messageFlagsRemove(range(uids), remove, { uid: true }), "remove the flags");
+        }, validity),
+        label: (folder, validity, uids, { add = [], remove = [] }) => pool.writeIn(folder, async (open) => {
+            if (add.length)
+                await changed(open.messageFlagsAdd(range(uids), add, { uid: true, useLabels: true }), "add the labels");
+            if (remove.length)
+                await changed(open.messageFlagsRemove(range(uids), remove, { uid: true, useLabels: true }), "remove the labels");
+        }, validity),
+        move: (folder, validity, uids, to) => pool.writeIn(folder, async (open) => movedOf(await open.messageMove(range(uids), to, { uid: true })), validity),
+        copy: (folder, validity, uids, to) => pool.writeIn(folder, async (open) => movedOf(await open.messageCopy(range(uids), to, { uid: true })), validity),
+        expunge: (folder, validity, uids) => pool.writeIn(folder, async (open) => {
+            if (!open.capabilities.has("UIDPLUS"))
+                throw new CliError("provider_unavailable", "the server cannot expunge single messages (no UIDPLUS), so a copy cannot be taken back alone", { reason: "mail.no-uidplus" });
+            await changed(open.messageDelete(range(uids), { uid: true }), "remove the copies");
+        }, validity),
+        append: (folder, raw, flags) => pool.writeOnServer(async (open) => {
+            const stored = await open.append(folder, Buffer.from(raw), [...flags]);
+            if (stored === false)
+                throw new CliError("provider_unavailable", `the server refused to store the message in ${folder}`);
+            return {
+                ...(stored.uid === undefined ? {} : { uid: stored.uid }),
+                ...(stored.uidValidity === undefined ? {} : { validity: String(stored.uidValidity) }),
+            };
+        }),
+        createFolder: (path) => pool.writeOnServer(async (open) => {
+            await open.mailboxCreate(path);
+        }),
+        renameFolder: (path, to) => pool.writeOnServer(async (open) => {
+            await open.mailboxRename(path, to);
+        }),
+        deleteFolder: (path) => pool.writeOnServer(async (open) => {
+            await open.mailboxDelete(path);
+        }),
+    };
+};
+//# sourceMappingURL=write.js.map

package/dist/mail/imap/write.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"write.js","sourceRoot":"","sources":["../../../src/mail/imap/write.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAA;AAK5C,MAAM,UAAU,GAAG,GAAG,CAAA;AAEtB,MAAM,KAAK,GAAG,CAAC,IAAuB,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;AAEzD,MAAM,OAAO,GAAG,CAAC,MAAoD,EAAS,EAAE,CAC9E,MAAM,KAAK,KAAK;IACd,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,GAAG,EAAE,EAAE;IACrB,CAAC,CAAC;QACE,IAAI,EAAE,IAAI,GAAG,CAAC,MAAM,CAAC,MAAM,IAAI,EAAE,CAAC;QAClC,GAAG,CAAC,MAAM,CAAC,WAAW,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,EAAE,CAAC;KACtF,CAAA;AAEP,0GAA0G;AAC1G,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,IAAiB,EAAc,EAAE;IAC1D,MAAM,OAAO,GAAG,KAAK,EAAE,IAAsB,EAAE,IAAY,EAAE,EAAE;QAC7D,IAAI,CAAC,CAAC,MAAM,IAAI,CAAC;YAAE,MAAM,IAAI,QAAQ,CAAC,sBAAsB,EAAE,yBAAyB,IAAI,EAAE,CAAC,CAAA;IAChG,CAAC,CAAA;IAED,OAAO;QACL,MAAM,EAAE,CAAC,MAAM,EAAE,EAAE,QAAQ,GAAG,EAAE,EAAE,UAAU,GAAG,EAAE,EAAE,EAAE,EAAE,CACrD,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE;YAC7C,MAAM,IAAI,GAAG,IAAI,GAAG,EAAkB,CAAA;YACtC,MAAM,KAAK,GAAG,KAAK,EAAE,OAAuB,EAAE,KAA0D,EAAE,EAAE;gBAC1G,KAAK,IAAI,EAAE,GAAG,CAAC,EAAE,EAAE,GAAG,OAAO,CAAC,MAAM,EAAE,EAAE,IAAI,UAAU,EAAE,CAAC;oBACvD,MAAM,IAAI,GAAG,OAAO,CAAC,KAAK,CAAC,EAAE,EAAE,EAAE,GAAG,UAAU,CAAC,CAAA;oBAC/C,MAAM,IAAI,GACR,CAAC,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAE,IAAI,CAAC,CAAC,CAAkB,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE,GAAG,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAA;oBACxG,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC;wBAAE,SAAQ;oBAC/B,KAAK,MAAM,OAAO,IAAI,MAAM,IAAI,CAAC,QAAQ,CACvC,IAAI,EACJ,EAAE,GAAG,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,EAC5C,EAAE,GAAG,EAAE,IAAI,EAAE,CACd,EAAE,CAAC;wBACF,MAAM,GAAG,GAAG,KAAK,CAAC,OAAO,CAAC,CAAA;wBAC1B,IAAI,GAAG,KAAK,SAAS;4BAAE,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,OAAO,CAAC,GAAG,CAAC,CAAA;oBACnD,CAAC;gBACH,CAAC;YACH,CAAC,CAAA;YACD,MAAM,YAAY,GAAG,IAAI,GAAG,CAAC,QAAQ,CAAC,CAAA;YACtC,MAAM,KAAK,CACT,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC,EACxC,CAAC,OAAO,EAAE,EAAE,CACV,OAAO,CAAC,OAAO,IAAI,YAAY,CAAC,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS,CACrG,CAAA;YACD,MAAM,cAAc,GAAG,IAAI,GAAG,CAAC,UAAU,CAAC,CAAA;YAC1C,MAAM,KAAK,CACT,UAAU,CAAC,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC,EAAE,MAAM,EAAE,EAAE,YAAY,EAAE,SAAS,EAAE,EAAE,CAAC,CAAC,EACxE,CAAC,OAAO,EAAE,EAAE;gBACV,MAAM,EAAE,GAAG,OAAO,CAAC,QAAQ,EAAE,SAAS,CAAA;gBACtC,OAAO,EAAE,IAAI,cAAc,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,SAAS,CAAA;YACtD,CAAC,CACF,CAAA;YACD,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAA;QAC3B,CAAC,CAAC;QAEJ,KAAK,EAAE,CAAC,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,EAAE,CAChC,IAAI,CAAC,QAAQ,CACX,MAAM,EACN,KAAK,EAAE,IAAI,EAAE,EAAE;YACb,MAAM,MAAM,GAAG,IAAI,GAAG,EAAuB,CAAA;YAC7C,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC;gBAAE,OAAO,MAAM,CAAA;YACpC,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,QAAQ,CACjC,KAAK,CAAC,IAAI,CAAC,EACX,EAAE,GAAG,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,EACxD,EAAE,GAAG,EAAE,IAAI,EAAE,CACd,CAAA;YACD,KAAK,MAAM,OAAO,IAAI,OAAO;gBAC3B,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,EAAE;oBACtB,KAAK,EAAE,CAAC,GAAG,CAAC,OAAO,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE;oBACxC,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;oBACjE,GAAG,CAAC,OAAO,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,OAAO,CAAC,QAAQ,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;iBAClF,CAAC,CAAA;YACJ,OAAO,MAAM,CAAA;QACf,CAAC,EACD,QAAQ,CACT;QAEH,IAAI,EAAE,CAAC,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,EAAE,GAAG,GAAG,EAAE,EAAE,MAAM,GAAG,EAAE,EAAE,EAAE,EAAE,CAC1D,IAAI,CAAC,OAAO,CACV,MAAM,EACN,KAAK,EAAE,IAAI,EAAE,EAAE;YACb,IAAI,GAAG,CAAC,MAAM;gBAAE,MAAM,OAAO,CAAC,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,GAAG,EAAE,EAAE,GAAG,EAAE,IAAI,EAAE,CAAC,EAAE,eAAe,CAAC,CAAA;YACrG,IAAI,MAAM,CAAC,MAAM;gBACf,MAAM,OAAO,CAAC,IAAI,CAAC,kBAAkB,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,EAAE,GAAG,EAAE,IAAI,EAAE,CAAC,EAAE,kBAAkB,CAAC,CAAA;QAClG,CAAC,EACD,QAAQ,CACT;QAEH,KAAK,EAAE,CAAC,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,EAAE,GAAG,GAAG,EAAE,EAAE,MAAM,GAAG,EAAE,EAAE,EAAE,EAAE,CAC3D,IAAI,CAAC,OAAO,CACV,MAAM,EACN,KAAK,EAAE,IAAI,EAAE,EAAE;YACb,IAAI,GAAG,CAAC,MAAM;gBACZ,MAAM,OAAO,CAAC,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,GAAG,EAAE,EAAE,GAAG,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,EAAE,gBAAgB,CAAC,CAAA;YACzG,IAAI,MAAM,CAAC,MAAM;gBACf,MAAM,OAAO,CACX,IAAI,CAAC,kBAAkB,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,EAAE,GAAG,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,EAC5E,mBAAmB,CACpB,CAAA;QACL,CAAC,EACD,QAAQ,CACT;QAEH,IAAI,EAAE,CAAC,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,EAAE,EAAE,EAAE,CACnC,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,CAAC,OAAO,CAAC,MAAM,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,EAAE,GAAG,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE,QAAQ,CAAC;QAEjH,IAAI,EAAE,CAAC,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,EAAE,EAAE,EAAE,CACnC,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,CAAC,OAAO,CAAC,MAAM,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,EAAE,GAAG,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE,QAAQ,CAAC;QAEjH,OAAO,EAAE,CAAC,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,EAAE,CAClC,IAAI,CAAC,OAAO,CACV,MAAM,EACN,KAAK,EAAE,IAAI,EAAE,EAAE;YACb,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,SAAS,CAAC;gBACnC,MAAM,IAAI,QAAQ,CAChB,sBAAsB,EACtB,8FAA8F,EAC9F,EAAE,MAAM,EAAE,iBAAiB,EAAE,CAC9B,CAAA;YACH,MAAM,OAAO,CAAC,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,EAAE,GAAG,EAAE,IAAI,EAAE,CAAC,EAAE,mBAAmB,CAAC,CAAA;QACpF,CAAC,EACD,QAAQ,CACT;QAEH,MAAM,EAAE,CAAC,MAAM,EAAE,GAAG,EAAE,KAAK,EAAE,EAAE,CAC7B,IAAI,CAAC,aAAa,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE;YAChC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,CAAC,CAAA;YACtE,IAAI,MAAM,KAAK,KAAK;gBAClB,MAAM,IAAI,QAAQ,CAAC,sBAAsB,EAAE,8CAA8C,MAAM,EAAE,CAAC,CAAA;YACpG,OAAO;gBACL,GAAG,CAAC,MAAM,CAAC,GAAG,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,CAAC,GAAG,EAAE,CAAC;gBACxD,GAAG,CAAC,MAAM,CAAC,WAAW,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,EAAE,CAAC;aACtF,CAAA;QACH,CAAC,CAAC;QAEJ,YAAY,EAAE,CAAC,IAAI,EAAE,EAAE,CACrB,IAAI,CAAC,aAAa,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE;YAChC,MAAM,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,CAAA;QAChC,CAAC,CAAC;QAEJ,YAAY,EAAE,CAAC,IAAI,EAAE,EAAE,EAAE,EAAE,CACzB,IAAI,CAAC,aAAa,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE;YAChC,MAAM,IAAI,CAAC,aAAa,CAAC,IAAI,EAAE,EAAE,CAAC,CAAA;QACpC,CAAC,CAAC;QAEJ,YAAY,EAAE,CAAC,IAAI,EAAE,EAAE,CACrB,IAAI,CAAC,aAAa,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE;YAChC,MAAM,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,CAAA;QAChC,CAAC,CAAC;KACL,CAAA;AACH,CAAC,CAAA"}

package/dist/mail/organise.d.ts

@@ -0,0 +1,116 @@
+import type { AppIdentity } from "@wirecat/cli-core/cli";
+import { type SendGuard } from "@wirecat/cli-core/sends";
+import type { AccountKey, MessageStore } from "@wirecat/cli-core/store";
+import type { Organise } from "../providers.js";
+import type { FolderInfo, MailWrites, ServerState } from "./backend.js";
+import { type ChangedItem, type ChangeLog, type ChangeRun, type StepLine } from "./changes.js";
+/** One mailbox as the write commands see it: its stored mail, its server and where its provider differs. */
+export interface Mailbox {
+    app: AppIdentity;
+    store: MessageStore;
+    key: AccountKey;
+    accountId: number;
+    writes: MailWrites;
+    folders: () => Promise<FolderInfo[]>;
+    organise: Organise;
+    now: () => number;
+}
+export declare const FILTER_LIMIT = 500;
+export declare const MAX_LIMIT = 5000;
+/** More messages than this at once is a bulk change: previewed first and checked as `messages.bulk` too. */
+export declare const BULK = 20;
+/** A flag as the owner types it, `read` or `$Junk`, in IMAP's spelling; `\Deleted` is refused, it is how mail is expunged. */
+export declare const flagOf: (given: string) => string;
+/** Stored mail by reference or by the shared query, at most `limit`; `more` says the query matched more. */
+export declare const selectIds: (mailbox: Mailbox, { refs, filter, limit }: {
+    refs?: string[];
+    filter?: string;
+    limit?: number;
+}) => Promise<{
+    ids: string[];
+    more: boolean;
+}>;
+interface Located {
+    folder: string;
+    validity: string;
+    items: ChangedItem[];
+}
+/**
+ * Where each email is on the server now, folder by folder. `everywhere` keeps every place an email is in (a flag is
+ * set on each copy); otherwise only its first, so one email is moved once. Trash counts only when `trash` is given.
+ */
+export declare const locate: (mailbox: Mailbox, ids: readonly string[], { everywhere, trash }?: {
+    everywhere?: boolean;
+    trash?: string;
+}) => Promise<{
+    located: Located[];
+    missing: string[];
+    deleted: string[];
+    inTrash: string[];
+}>;
+/** The folder a name or a role names: its path, a role (`archive`, `trash`), then a name in any case. */
+export declare const folderNamed: (folders: readonly FolderInfo[], given: string) => FolderInfo | undefined;
+export declare const trashOf: (mailbox: Mailbox) => Promise<string>;
+/** On Gmail a folder is a label: what a move or copy to `given` adds and takes away, or a real folder to move to. */
+type Target = {
+    kind: "folder";
+    path: string;
+} | {
+    kind: "labels";
+    add: string[];
+    remove: string[];
+    name: string;
+};
+export declare const targetOf: (mailbox: Mailbox, given: string, copy: boolean) => Promise<Target>;
+/** Runs one step against the server under the guard, recording it before it goes and once it is done. */
+export declare class Changer {
+    readonly mailbox: Mailbox;
+    readonly guard: SendGuard;
+    readonly log: ChangeLog;
+    readonly key: string;
+    readonly action: "message-flag" | "message-move" | "message-copy" | "message-delete" | "message-restore";
+    constructor(mailbox: Mailbox, guard: SendGuard, log: ChangeLog, key: string, action: "message-flag" | "message-move" | "message-copy" | "message-delete" | "message-restore");
+    step<T>(line: Omit<StepLine, "type" | "step">, act: () => Promise<T>, moved?: (done: T) => {
+        uids: Map<string, number>;
+        validity?: string;
+    }): Promise<T>;
+}
+/**
+ * Adds and removes flags, or with `replace` makes `add` each message's whole set. On Gmail the flags of All Mail are
+ * the message's own. The store takes read and flagged once the server said yes.
+ */
+export declare const changeFlags: (changer: Changer, located: Located[], change: {
+    add: string[];
+    remove: string[];
+    replace?: boolean;
+}) => Promise<string[]>;
+export declare const moveMessages: (changer: Changer, located: Located[], target: Target, op: "move" | "copy") => Promise<string[]>;
+/**
+ * Moves the messages to Trash, which the provider empties in its own time; until then `messages restore` brings them
+ * back. On Gmail each message's labels are kept in the record first. The store marks them deleted, as a sync would.
+ */
+export declare const trashMessages: (changer: Changer, located: Located[], trash: string, keep?: (id: string, state: ServerState) => string | undefined) => Promise<{
+    changed: string[];
+    kept: Record<string, number>;
+}>;
+export interface RestorePlan {
+    run: string;
+    command: string;
+    started_at: string;
+    restorable_until: string | null;
+    expired: boolean;
+    /** Messages the run changed. */
+    logged: number;
+    /** Messages a restore puts back: still where the run left them. */
+    restorable: number;
+    /** Changed by the run, and no longer where it left them: restored already, moved by hand, or gone for good. */
+    missing: number;
+    restored: number;
+}
+/**
+ * Undoes a run, last step first, for the messages still where it left them. Without `apply` it only counts. Trash
+ * brings mail back to where it was (on Gmail: to the Inbox if it was there, else All Mail, labels put back).
+ */
+export declare const restoreRun: (changer: Changer, { run, steps, restored: before }: ChangeRun, path: string, apply: boolean) => Promise<RestorePlan>;
+export {};
+//# sourceMappingURL=organise.d.ts.map

package/dist/mail/organise.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"organise.d.ts","sourceRoot":"","sources":["../../src/mail/organise.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AAExD,OAAO,EAAmD,KAAK,SAAS,EAAE,MAAM,yBAAyB,CAAA;AACzG,OAAO,KAAK,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAA;AACvE,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAA;AAC/C,OAAO,KAAK,EAAE,UAAU,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,cAAc,CAAA;AACvE,OAAO,EAAiB,KAAK,WAAW,EAAE,KAAK,SAAS,EAAE,KAAK,SAAS,EAAE,KAAK,QAAQ,EAAE,MAAM,cAAc,CAAA;AAE7G,4GAA4G;AAC5G,MAAM,WAAW,OAAO;IACtB,GAAG,EAAE,WAAW,CAAA;IAChB,KAAK,EAAE,YAAY,CAAA;IACnB,GAAG,EAAE,UAAU,CAAA;IACf,SAAS,EAAE,MAAM,CAAA;IACjB,MAAM,EAAE,UAAU,CAAA;IAClB,OAAO,EAAE,MAAM,OAAO,CAAC,UAAU,EAAE,CAAC,CAAA;IACpC,QAAQ,EAAE,QAAQ,CAAA;IAClB,GAAG,EAAE,MAAM,MAAM,CAAA;CAClB;AAED,eAAO,MAAM,YAAY,MAAM,CAAA;AAC/B,eAAO,MAAM,SAAS,OAAQ,CAAA;AAC9B,4GAA4G;AAC5G,eAAO,MAAM,IAAI,KAAK,CAAA;AAatB,8HAA8H;AAC9H,eAAO,MAAM,MAAM,UAAW,MAAM,KAAG,MAmBtC,CAAA;AAED,4GAA4G;AAC5G,eAAO,MAAM,SAAS,YACX,OAAO,2BAC6B;IAAE,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IAAC,KAAK,CAAC,EAAE,MAAM,CAAA;CAAE,KAChG,OAAO,CAAC;IAAE,GAAG,EAAE,MAAM,EAAE,CAAC;IAAC,IAAI,EAAE,OAAO,CAAA;CAAE,CA+B1C,CAAA;AAED,UAAU,OAAO;IACf,MAAM,EAAE,MAAM,CAAA;IACd,QAAQ,EAAE,MAAM,CAAA;IAChB,KAAK,EAAE,WAAW,EAAE,CAAA;CACrB;AAKD;;;GAGG;AACH,eAAO,MAAM,MAAM,YACR,OAAO,OACX,SAAS,MAAM,EAAE,0BACS;IAAE,UAAU,CAAC,EAAE,OAAO,CAAC;IAAC,KAAK,CAAC,EAAE,MAAM,CAAA;CAAE,KACtE,OAAO,CAAC;IAAE,OAAO,EAAE,OAAO,EAAE,CAAC;IAAC,OAAO,EAAE,MAAM,EAAE,CAAC;IAAC,OAAO,EAAE,MAAM,EAAE,CAAC;IAAC,OAAO,EAAE,MAAM,EAAE,CAAA;CAAE,CAkDzF,CAAA;AAED,yGAAyG;AACzG,eAAO,MAAM,WAAW,YAAa,SAAS,UAAU,EAAE,SAAS,MAAM,KAAG,UAAU,GAAG,SASxF,CAAA;AAED,eAAO,MAAM,OAAO,YAAmB,OAAO,KAAG,OAAO,CAAC,MAAM,CAW9D,CAAA;AASD,qHAAqH;AACrH,KAAK,MAAM,GAAG;IAAE,IAAI,EAAE,QAAQ,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,GAAG;IAAE,IAAI,EAAE,QAAQ,CAAC;IAAC,GAAG,EAAE,MAAM,EAAE,CAAC;IAAC,MAAM,EAAE,MAAM,EAAE,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,CAAA;AAElH,eAAO,MAAM,QAAQ,YAAmB,OAAO,SAAS,MAAM,QAAQ,OAAO,KAAG,OAAO,CAAC,MAAM,CA2B7F,CAAA;AAQD,yGAAyG;AACzG,qBAAa,OAAO;IAEhB,QAAQ,CAAC,OAAO,EAAE,OAAO;IACzB,QAAQ,CAAC,KAAK,EAAE,SAAS;IACzB,QAAQ,CAAC,GAAG,EAAE,SAAS;IACvB,QAAQ,CAAC,GAAG,EAAE,MAAM;IACpB,QAAQ,CAAC,MAAM,EAAE,cAAc,GAAG,cAAc,GAAG,cAAc,GAAG,gBAAgB,GAAG,iBAAiB;IAL1G,YACW,OAAO,EAAE,OAAO,EAChB,KAAK,EAAE,SAAS,EAChB,GAAG,EAAE,SAAS,EACd,GAAG,EAAE,MAAM,EACX,MAAM,EAAE,cAAc,GAAG,cAAc,GAAG,cAAc,GAAG,gBAAgB,GAAG,iBAAiB,EACtG;IAEE,IAAI,CAAC,CAAC,EACV,IAAI,EAAE,IAAI,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAAC,EACrC,GAAG,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,EACrB,KAAK,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC,KAAK;QAAE,IAAI,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;KAAE,GACpE,OAAO,CAAC,CAAC,CAAC,CAiBZ;CACF;AA0BD;;;GAGG;AACH,eAAO,MAAM,WAAW,YACb,OAAO,WACP,OAAO,EAAE,UACV;IAAE,GAAG,EAAE,MAAM,EAAE,CAAC;IAAC,MAAM,EAAE,MAAM,EAAE,CAAC;IAAC,OAAO,CAAC,EAAE,OAAO,CAAA;CAAE,KAC7D,OAAO,CAAC,MAAM,EAAE,CA6ClB,CAAA;AAyED,eAAO,MAAM,YAAY,YACd,OAAO,WACP,OAAO,EAAE,UACV,MAAM,MACV,MAAM,GAAG,MAAM,KAClB,OAAO,CAAC,MAAM,EAAE,CAUlB,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,aAAa,YACf,OAAO,WACP,OAAO,EAAE,SACX,MAAM,SACP,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,WAAW,KAAK,MAAM,GAAG,SAAS,KAC3D,OAAO,CAAC;IAAE,OAAO,EAAE,MAAM,EAAE,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;CAAE,CA6C7D,CAAA;AAED,MAAM,WAAW,WAAW;IAC1B,GAAG,EAAE,MAAM,CAAA;IACX,OAAO,EAAE,MAAM,CAAA;IACf,UAAU,EAAE,MAAM,CAAA;IAClB,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAA;IAC/B,OAAO,EAAE,OAAO,CAAA;IAChB,gCAAgC;IAChC,MAAM,EAAE,MAAM,CAAA;IACd,mEAAmE;IACnE,UAAU,EAAE,MAAM,CAAA;IAClB,+GAA+G;IAC/G,OAAO,EAAE,MAAM,CAAA;IACf,QAAQ,EAAE,MAAM,CAAA;CACjB;AAgED;;;GAGG;AACH,eAAO,MAAM,UAAU,YACZ,OAAO,oCACkB,SAAS,QACrC,MAAM,SACL,OAAO,KACb,OAAO,CAAC,WAAW,CAmIrB,CAAA"}