Nodemailer testing

examples/transport.ts

@@ -16,6 +16,7 @@ const transport = Nodemailer.createTransport(MailtrapTransport({
   token: TOKEN
 }))
 
+// Note: 'sandbox: true' can be passed for making requests to testing API
 transport.sendMail({
   text: "Welcome to Mailtrap Sending!",
   to: {

src/__tests__/lib/normalizer.test.ts

@@ -124,5 +124,43 @@ describe("lib/normalizer: ", () => {
       // @ts-ignore
       cb(null, mailData);
     });
+
+    it("checks if testing client is switched.", () => {
+      expect.assertions(3);
+
+      const mockResponse = {
+        statusCode: 200,
+      };
+      const mockClient = {
+        testing: {
+          send: jest.fn(() => Promise.resolve(mockResponse)),
+        },
+      };
+
+      const callback = (error: Error, data: SendError) => {
+        expect(error).toBeNull();
+        expect(data).toEqual(mockResponse);
+      };
+      const mailData = {
+        sandbox: true,
+        text: "mock-text",
+        to: {
+          address: "mock@mail.com",
+          name: "mock-name",
+        },
+        from: {
+          address: "mock@mail.com",
+          name: "mock-name",
+        },
+        subject: "mock-subject",
+      };
+
+      // @ts-ignore
+      const cb = normalizeCallback(mockClient, callback);
+
+      // @ts-ignore
+      cb(null, mailData);
+      expect(mockClient.testing.send).toBeCalledTimes(1);
+    });
   });
 });

src/adapters/mail.ts

@@ -41,7 +41,7 @@ export default function adaptMail(data: MailtrapMailOptions): Mail | SendError {
     mail.custom_variables = data.customVariables;
   }
 
-  if (data.templateUuid) {
+  if (!data.sandbox && data.templateUuid) {
     return {
       ...mail,
       template_uuid: data.templateUuid,

src/lib/normalizer.ts

@@ -37,7 +37,9 @@ export default function normalizeCallback(
         });
       }
 
-      return client
+      const mailtrapClient = data.sandbox ? client.testing : client;
+
+      return mailtrapClient
         .send(mail as MailtrapMail)
         .then((sendResponse) => callback(null, sendResponse))
         .catch((error) => {

src/types/transport.ts

@@ -13,6 +13,7 @@ type AdditionalFields = {
   custom_variables?: CustomVariables;
   template_uuid?: string;
   template_variables?: TemplateVariables;
+  sandbox?: boolean | undefined;
 };
 
 export type NormalizeCallbackData =
@@ -26,19 +27,28 @@ export type NormalizeCallback = (
   info: SendResponse | SendError
 ) => void;
 
+interface MailtrapMailOptionsSandbox extends NodemailerMail.Options {
+  customVariables?: CustomVariables;
+  category?: string;
+  sandbox: boolean;
+}
+
 export interface MailtrapMailOptions extends NodemailerMail.Options {
   customVariables?: CustomVariables;
   category?: string;
   templateUuid?: string;
   templateVariables?: Record<string, string | number | boolean>;
+  sandbox?: boolean | undefined;
 }
 
 export type MailtrapResponse = SendResponse | SendError;
 
 export interface MailtrapTransporter extends Transporter<MailtrapResponse> {
   sendMail(
-    mailOptions: MailtrapMailOptions,
+    mailOptions: MailtrapMailOptions | MailtrapMailOptionsSandbox,
     callback: (err: Error | null, info: MailtrapResponse) => void
   ): void;
-  sendMail(mailOptions: MailtrapMailOptions): Promise<MailtrapResponse>;
+  sendMail(
+    mailOptions: MailtrapMailOptions | MailtrapMailOptionsSandbox
+  ): Promise<MailtrapResponse>;
 }