Feat: Complete adding only option

Author: ksambhi

email/mailmerge-cli/src/commands/send.ts

@@ -23,13 +23,16 @@ export default class Send extends Command {
         sleepBetween: Flags.integer({
             char: "s",
             description: "Time to sleep between sending emails to prevent hitting rate limits",
-            default: 0,
         }),
         yes: Flags.boolean({
             char: "y",
             description: "Skip confirmation prompt",
             default: false,
         }),
+        only: Flags.integer({
+            char: "n",
+            description: "Only send this many emails (i.e. the first X emails)",
+        }),
     };
 
     public async run(): Promise<void> {
@@ -48,7 +51,10 @@ export default class Send extends Command {
             getDefaultDoCSocFromLine(),
             ENGINES_MAP,
             flags.yes,
-            flags.sleepBetween,
+            {
+                sleepBetween: flags.sleepBetween,
+                onlySend: flags.only,
+            },
         );
     }
 }

email/mailmerge-cli/src/commands/upload-drafts.ts

@@ -30,6 +30,10 @@ export default class UploadDrafts extends Command {
             description: "Skip confirmation prompt",
             default: false,
         }),
+        only: Flags.integer({
+            char: "n",
+            description: "Only send this many emails (i.e. the first X emails)",
+        }),
     };
 
     public async run(): Promise<void> {
@@ -42,6 +46,9 @@ export default class UploadDrafts extends Command {
             namer: (record) => record[DEFAULT_FIELD_NAMES.to],
         });
 
-        await uploadDrafts(storageBackend, ENGINES_MAP, flags.yes, flags.sleepBetween);
+        await uploadDrafts(storageBackend, ENGINES_MAP, flags.yes, {
+            sleepBetween: flags.sleepBetween,
+            onlySend: flags.only,
+        });
     }
 }

email/mailmerge/src/pipelines/send.spec.ts

@@ -81,7 +81,7 @@ describe("sendEmails", () => {
             [],
             { cc: [], bcc: [] },
         );
-        expect(mockStorageBackend.postSendAction).toHaveBeenCalledWith(mergeResults[0]);
+        expect(mockStorageBackend.postSendAction).toHaveBeenCalledWith(mergeResults[0], "sent");
     });
 
     it("should send only the number emails we want if only specified", async () => {

email/mailmerge/src/pipelines/send.ts

@@ -8,7 +8,7 @@ import { ENGINES_MAP } from "../engines/index.js";
 import { TemplateEngineConstructor } from "../engines/types.js";
 import Mailer from "../mailer/mailer.js";
 import { EmailString, FromEmail } from "../util/types.js";
-import { StorageBackend, MergeResultWithMetadata } from "./storage/types";
+import { StorageBackend, MergeResultWithMetadata, PostSendActionMode } from "./storage/types.js";
 
 interface SendEmailsOptions {
     /** Time to sleep between sending emails to prevent hitting rate limits */
@@ -143,7 +143,7 @@ You are about to send ${pendingEmails.length} emails. The esitmated time for thi
 
         if (storageBackend.postSendAction) {
             logger.debug("Calling post-send hook...");
-            await storageBackend.postSendAction(originalResult);
+            await storageBackend.postSendAction(originalResult, PostSendActionMode.SMTP_SEND);
         }
 
         logger.info("Email sent!");

email/mailmerge/src/pipelines/storage/sidecar.spec.ts

@@ -138,11 +138,31 @@ describe("JSONSidecarsBackend", () => {
                 namer: jest.fn(),
             });
             /// @ts-expect-error: Mocking things
-            await backend.postSendAction(resultSent);
+            await backend.postSendAction(resultSent, "sent");
 
             expect(mkdirp).toHaveBeenCalledWith("output/root/sent");
             expect(move).toHaveBeenCalledWith("output/root/file1", "output/root/sent");
         });
+
+        it("should move sent emails to drafts folder when in drafts mode", async () => {
+            const sidecar = {
+                name: "test",
+                files: [{ filename: "file1" }],
+            };
+            const resultSent = {
+                storageBackendMetadata: { sideCar: sidecar },
+            };
+
+            const backend = new JSONSidecarsBackend("output/root", {
+                type: "fixed",
+                namer: jest.fn(),
+            });
+            /// @ts-expect-error: Mocking things
+            await backend.postSendAction(resultSent, "drafts");
+
+            expect(mkdirp).toHaveBeenCalledWith("output/root/drafts");
+            expect(move).toHaveBeenCalledWith("output/root/file1", "output/root/drafts");
+        });
     });
 
     describe("storeOriginalMergeResults", () => {

email/mailmerge/src/pipelines/storage/sidecar.ts

@@ -14,7 +14,12 @@ import {
     getSidecarMetadata,
 } from "../../previews/index.js";
 import { MappedRecord } from "../../util/index.js";
-import { StorageBackend, MergeResultWithMetadata, MergeResult } from "./types";
+import {
+    StorageBackend,
+    MergeResultWithMetadata,
+    MergeResult,
+    PostSendActionMode,
+} from "./types.js";
 
 /** Metadata the JSON backend passes on {@link MergeResultWithMetadata.storageBackendMetadata} - bsically the original sidecar file with the path it came from */
 export interface JSONSidecarsBackendMetadata {
@@ -141,9 +146,21 @@ export class JSONSidecarsBackend implements StorageBackend<JSONSidecarsBackendMe
      */
     public async postSendAction(
         resultSent: MergeResultWithMetadata<JSONSidecarsBackendMetadata>,
+        mode: PostSendActionMode,
     ): Promise<void> {
         const sidecar = resultSent.storageBackendMetadata.sideCar;
-        const sentRoot = join(this.outputRoot, "sent");
+        let directoryName;
+        switch (mode) {
+            case PostSendActionMode.DRAFTS_UPLOAD:
+                directoryName = "drafts";
+                break;
+            case PostSendActionMode.SMTP_SEND:
+                directoryName = "sent";
+                break;
+            default:
+                throw new Error(`Invalid post-send action mode: ${mode}`);
+        }
+        const sentRoot = join(this.outputRoot, directoryName);
         this.logger.info(`Moving sent emails for ${sidecar.name} to ${sentRoot}...`);
         await mkdirp(sentRoot);
         await Promise.all(

email/mailmerge/src/pipelines/storage/types.ts

@@ -42,6 +42,16 @@ export type MergeResultWithMetadata<Metadata = unknown> = MergeResult & {
     storageBackendMetadata: Metadata;
 };
 
+/**
+ * Modes for a post-send action
+ */
+export enum PostSendActionMode {
+    /** The email was sent */
+    SMTP_SEND = "sent",
+    /** The email was uploaded to drafts intead */
+    DRAFTS_UPLOAD = "drafts",
+}
+
 /**
  * Interface for a storage backend, which is responsible for loading and storing merge results.
  *
@@ -69,9 +79,14 @@ export interface StorageBackend<Metadata = unknown> {
      */
     storeUpdatedMergeResults(results: MergeResultWithMetadata<Metadata>[]): PromiseLike<void>;
     /**
-     * Called after a merge result has been sent, so that you can do any post processing.
+     * Called after a merge result has been sent or uploaded to drafts, so that you can do any post processing.
+     *
+     * Note that you must handle both cases of sending and uploading to drafts, as the mode is passed to you.
      *
      * E.g. Move file around, mark as sent in database
      */
-    postSendAction?(resultSent: MergeResultWithMetadata<Metadata>): PromiseLike<void>;
+    postSendAction?(
+        resultSent: MergeResultWithMetadata<Metadata>,
+        mode: PostSendActionMode,
+    ): PromiseLike<void>;
 }

email/mailmerge/src/pipelines/uploadDrafts.ts

@@ -7,7 +7,7 @@ import readlineSync from "readline-sync";
 import { TemplateEngineConstructor, ENGINES_MAP } from "../engines/index.js";
 import { EmailUploader } from "../graph/index.js";
 import { EmailString } from "../util/index.js";
-import { StorageBackend, MergeResultWithMetadata } from "./storage";
+import { StorageBackend, MergeResultWithMetadata, PostSendActionMode } from "./storage/index.js";
 
 interface UploadDraftsOptions {
     /** Time to sleep between sending emails to prevent hitting rate limits */
@@ -101,10 +101,6 @@ export async function uploadDrafts(
     You are about to upload ${pendingEmails.length} emails.
     This action is IRREVERSIBLE.
 
-    If the system crashes, you will need to manually upload the emails.
-    Re-running this after a partial upload will end up uploading duplicate emails.
-    Unlike with send, emails will not be moved to a different folder after upload.
-
     Check that:
     1. The template was correct
     1. You are satisfied with ALL previews, including the HTML previews
@@ -134,7 +130,7 @@ export async function uploadDrafts(
     let sent = 0;
     const uploader = new EmailUploader(logger);
     await uploader.authenticate(expectedEmail, entraTenantId, entraClientId);
-    for (const { to, subject, html, attachments, cc, bcc } of pendingEmails) {
+    for (const { to, subject, html, attachments, cc, bcc, originalResult } of pendingEmails) {
         logger.info(
             `(${++sent} / ${total}) Uploading email to ${to} with subject ${subject} to Drafts...`,
         );
@@ -155,6 +151,12 @@ export async function uploadDrafts(
             options,
         );
 
+        // Execute post-send action
+        if (storageBackend.postSendAction) {
+            logger.debug("Calling post-send hook...");
+            await storageBackend.postSendAction(originalResult, PostSendActionMode.DRAFTS_UPLOAD);
+        }
+
         // Only send check
         if (onlySend && sent >= onlySend) {
             logger.warn(`Only sending ${onlySend} emails as requested.`);

email/workspace/quick-run.sh

@@ -1,4 +1,4 @@
-docsoc-mailmerge generate nunjucks ./data/names3.csv -o ./output -n test -b -c
+docsoc-mailmerge generate nunjucks ./data/names.csv -o ./output -n test -b -c
 docsoc-mailmerge regenerate ./output/test
-docsoc-mailmerge upload-drafts ./output/test -y -s 2
-docsoc-mailmerge send ./output/test -s 5
+docsoc-mailmerge upload-drafts ./output/test -y -s 2 -n 1
+docsoc-mailmerge send ./output/test -s 5 -n 1