Merge branch 'main' into readme-update-prerequisites

Author: yanchuk

CHANGELOG.md

@@ -1,3 +1,11 @@
+## [4.2.0] - 2025-07-08
+- Add support for [Batch Sending API](https://github.com/railsware/mailtrap-nodejs/pull/63).
+- Add support for [Contacts API](https://github.com/railsware/mailtrap-nodejs/pull/64).
+- Add support for [Contact Lists API](https://github.com/railsware/mailtrap-nodejs/pull/65).
+- Add support for [Templates API](https://github.com/railsware/mailtrap-nodejs/pull/67).
+- Add support for [Suppressions API](https://github.com/railsware/mailtrap-nodejs/pull/68).
+- Make `testInboxId` optional in the `MailtrapClient` configuration (https://github.com/railsware/mailtrap-nodejs/pull/70).
+
 ## [4.1.0] - 2025-04-18
 - Add support for `reply_to` in Sending API (in https://github.com/railsware/mailtrap-nodejs/pull/58, thanks to @aolamide).
 

examples/contact-lists/everything.ts

@@ -0,0 +1,35 @@
+import { MailtrapClient } from "mailtrap";
+
+const TOKEN = "<YOUR-TOKEN-HERE>";
+const ACCOUNT_ID = "<YOUR-ACCOUNT-ID-HERE>"
+
+const client = new MailtrapClient({
+  token: TOKEN,
+  accountId: ACCOUNT_ID,
+});
+
+async function contactListsFlow() {
+  // Create a new contact list
+  await client.contactLists.create({
+    name: "Test List",
+  });
+
+  // Get all contact lists
+  const all = await client.contactLists.getList();
+  console.log("All contact lists:", all);
+
+  // Get a specific contact list
+  const one = await client.contactLists.get(all[0].id);
+  console.log("One contact list:", one);
+
+  // Update a contact list
+  const updated = await client.contactLists.update(all[0].id, {
+    name: "Updated Test List",
+  });
+  console.log("Updated contact list:", updated);
+
+  // Delete a contact list
+  await client.contactLists.delete(all[0].id);
+}
+
+contactListsFlow();

examples/sending/suppressions.ts

@@ -0,0 +1,30 @@
+import { MailtrapClient } from "mailtrap";
+
+const TOKEN = "<YOUR-TOKEN-HERE>";
+const ACCOUNT_ID = "<YOUR-ACCOUNT-ID-HERE>";
+
+const client = new MailtrapClient({
+  token: TOKEN,
+  accountId: ACCOUNT_ID
+});
+
+async function suppressionsFlow() {
+  // Get suppressions (up to 1000 per request)
+  const suppressions = await client.suppressions.getList();
+  console.log("Suppressions (up to 1000):", suppressions);
+
+  // Get suppressions filtered by email
+  const filteredSuppressions = await client.suppressions.getList({email: "[email protected]"});
+  console.log("Filtered suppressions:", filteredSuppressions);
+
+  // Delete a suppression by ID (if any exist)
+  if (suppressions.length > 0) {
+    const suppressionToDelete = suppressions[0];
+    await client.suppressions.delete(suppressionToDelete.id);
+    console.log(`Suppression ${suppressionToDelete.id} deleted successfully`);
+  } else {
+    console.log("No suppressions found to delete");
+  }
+}
+
+suppressionsFlow().catch(console.error);

examples/templates/everything.ts

@@ -0,0 +1,44 @@
+import { MailtrapClient } from "mailtrap";
+
+const TOKEN = "<YOUR-TOKEN-HERE>";
+const ACCOUNT_ID = "<YOUR-ACCOUNT-ID-HERE>";
+
+const client = new MailtrapClient({
+  token: TOKEN,
+  accountId: ACCOUNT_ID
+});
+
+async function templatesFlow() {
+  // Create a new template
+  const newTemplate = await client.templates.create({
+    name: "Welcome Email",
+    subject: "Welcome to Our Service!",
+    category: "Promotional",
+    body_html: "<h1>Welcome!</h1><p>Thank you for joining our service.</p>",
+    body_text: "Welcome! Thank you for joining our service."
+  });
+  console.log("Created template:", newTemplate);
+
+  // Get all templates
+  const allTemplates = await client.templates.getList();
+  console.log("All templates:", allTemplates);
+
+  // Get a specific template
+  const template = await client.templates.get(newTemplate.id);
+  console.log("Template details:", template);
+
+  // Update the template
+  const updatedTemplate = await client.templates.update(newTemplate.id, {
+    name: "Updated Welcome Email",
+    subject: "Welcome to Our Amazing Service!",
+    body_html: "<h1>Welcome!</h1><p>Thank you for joining our amazing service.</p>"
+  });
+  console.log("Updated template:", updatedTemplate);
+
+  // Delete the template
+  await client.templates.delete(newTemplate.id);
+  console.log("Template deleted successfully");
+}
+
+templatesFlow().catch(console.error);
+

package.json

@@ -1,7 +1,7 @@
 {
   "name": "mailtrap",
   "description": "Official mailtrap.io API client",
-  "version": "4.1.0",
+  "version": "4.2.0",
   "author": "Railsware Products Studio LLC",
   "dependencies": {
     "axios": ">=0.27"

src/__tests__/lib/api/ContactLists.test.ts

@@ -0,0 +1,20 @@
+import axios from "axios";
+
+import ContactLists from "../../../lib/api/ContactLists";
+
+describe("lib/api/ContactLists: ", () => {
+  const accountId = 100;
+  const contactListsAPI = new ContactLists(axios, accountId);
+
+  describe("class ContactLists(): ", () => {
+    describe("init: ", () => {
+      it("initializes with all necessary params.", () => {
+        expect(contactListsAPI).toHaveProperty("create");
+        expect(contactListsAPI).toHaveProperty("getList");
+        expect(contactListsAPI).toHaveProperty("get");
+        expect(contactListsAPI).toHaveProperty("update");
+        expect(contactListsAPI).toHaveProperty("delete");
+      });
+    });
+  });
+});

src/__tests__/lib/api/Contacts.test.ts

@@ -8,7 +8,7 @@ describe("lib/api/Contacts: ", () => {
 
   describe("class Contacts(): ", () => {
     describe("init: ", () => {
-      it("initalizes with all necessary params.", () => {
+      it("initializes with all necessary params.", () => {
         expect(contactsAPI).toHaveProperty("create");
         expect(contactsAPI).toHaveProperty("get");
         expect(contactsAPI).toHaveProperty("update");

src/__tests__/lib/api/General.test.ts

@@ -8,7 +8,7 @@ describe("lib/api/General: ", () => {
 
   describe("class General(): ", () => {
     describe("init: ", () => {
-      it("initalizes with all necessary params.", () => {
+      it("initializes with all necessary params.", () => {
         expect(generalAPI).toHaveProperty("accountAccesses");
         expect(generalAPI).toHaveProperty("accounts");
         expect(generalAPI).toHaveProperty("permissions");

src/__tests__/lib/api/Suppressions.test.ts

@@ -0,0 +1,17 @@
+import axios from "axios";
+
+import SuppressionsBaseAPI from "../../../lib/api/Suppressions";
+
+describe("lib/api/Suppressions: ", () => {
+  const accountId = 100;
+  const suppressionsAPI = new SuppressionsBaseAPI(axios, accountId);
+
+  describe("class SuppressionsBaseAPI(): ", () => {
+    describe("init: ", () => {
+      it("initializes with all necessary params.", () => {
+        expect(suppressionsAPI).toHaveProperty("getList");
+        expect(suppressionsAPI).toHaveProperty("delete");
+      });
+    });
+  });
+});

src/__tests__/lib/api/Templates.test.ts

@@ -0,0 +1,20 @@
+import axios from "axios";
+
+import TemplatesBaseAPI from "../../../lib/api/Templates";
+
+describe("lib/api/Templates: ", () => {
+  const accountId = 100;
+  const templatesAPI = new TemplatesBaseAPI(axios, accountId);
+
+  describe("class TemplatesBaseAPI(): ", () => {
+    describe("init: ", () => {
+      it("initializes with all necessary params.", () => {
+        expect(templatesAPI).toHaveProperty("create");
+        expect(templatesAPI).toHaveProperty("getList");
+        expect(templatesAPI).toHaveProperty("get");
+        expect(templatesAPI).toHaveProperty("update");
+        expect(templatesAPI).toHaveProperty("delete");
+      });
+    });
+  });
+});