mailtrap · narekhovhannisyan · Oct 11, 2024 · Aug 19, 2024 · Aug 19, 2024 · Aug 19, 2024
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -5,7 +5,6 @@ on: push
 jobs:
   lint:
     runs-on: ubuntu-latest
-
     steps:
       - uses: actions/checkout@v2
       - uses: actions/setup-node@v3

diff --git a/README.md b/README.md
@@ -9,10 +9,6 @@ This NPM package offers integration with the [official API](https://api-docs.mai
 
 Quickly add email sending functionality to your Node.js application with Mailtrap.
 
-## Compatibility with previous releases
-
-Versions of this package up to 2.0.2 were an [unofficial client](https://github.com/vchin/mailtrap-client) developed by [@vchin](https://github.com/vchin). Package version 3 is a completely new package. It is still under development and does not support the testing API yet. Please continue using version 2 if you need access to the testing API.
-
 ## Installation
 
 Use yarn or npm to install the package:
@@ -125,3 +121,7 @@ The package is available as open source under the terms of the [MIT License](htt
 ## Code of Conduct
 
 Everyone interacting in the Mailtrap project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](CODE_OF_CONDUCT.md).
+
+## Compatibility with previous releases
+
+Versions of this package up to 2.0.2 were an [unofficial client](https://github.com/vchin/mailtrap-client) developed by [@vchin](https://github.com/vchin). Package version 3 is a completely new package. 
diff --git a/examples/bulk/send-mail.ts b/examples/bulk/send-mail.ts
@@ -12,9 +12,9 @@ const TOKEN = "<YOUR-TOKEN-HERE>";
 const SENDER_EMAIL = "<[email protected]>";
 const RECIPIENT_EMAIL = "<[email protected]>";
 
-const client = new MailtrapClient({ token: TOKEN });
+const client = new MailtrapClient({ token: TOKEN, bulk: true });
 
-client.bulk.send({
+client.send({
   from: { name: "Mailtrap Test", email: SENDER_EMAIL },
   to: [{ email: RECIPIENT_EMAIL }],
   subject: "Hello from Mailtrap!",

diff --git a/examples/bulk/transport.ts b/examples/bulk/transport.ts
@@ -0,0 +1,60 @@
+import { readFileSync } from "fs";
+import Nodemailer from "nodemailer";
+import { MailtrapTransport } from "mailtrap"
+
+/**
+ * For this example, you need to have ready-to-use sending domain or,
+ * a Demo domain that allows sending emails to your own account email.
+ * @see https://help.mailtrap.io/article/69-sending-domain-setup
+ */
+
+const TOKEN = "<YOUR-TOKEN-HERE>"
+const SENDER_EMAIL = "<[email protected]>";
+const RECIPIENT_EMAIL = "<[email protected]>";
+
+const transport = Nodemailer.createTransport(MailtrapTransport({
+  token: TOKEN,
+  bulk: true
+}))
+
+transport.sendMail({
+  text: "Welcome to Mailtrap Sending!",
+  to: {
+    address: RECIPIENT_EMAIL,
+    name: "John Doe"
+  },
+  from: {
+    address: SENDER_EMAIL,
+    name: "Mailtrap Test"
+  },
+  subject: "Hello from Mailtrap!",
+  html: `
+  <!doctype html>
+  <html>
+    <head>
+      <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+    </head>
+    <body style="font-family: sans-serif;">
+      <div style="display: block; margin: auto; max-width: 600px;" class="main">
+        <h1 style="font-size: 18px; font-weight: bold; margin-top: 20px">Congrats for sending test email with Mailtrap!</h1>
+        <p>Inspect it using the tabs you see above and learn how this email can be improved.</p>
+        <img alt="Inspect with Tabs" src="cid:welcome.png" style="width: 100%;">
+        <p>Now send your email using our fake SMTP server and integration of your choice!</p>
+        <p>Good luck! Hope it works.</p>
+      </div>
+      <!-- Example of invalid for email html/css, will be detected by Mailtrap: -->
+      <style>
+        .main { background-color: white; }
+        a:hover { border-left-width: 1em; min-height: 2em; }
+      </style>
+    </body>
+  </html>
+`,
+  attachments: [
+    {
+      filename: "welcome.png",
+      content: readFileSync("./welcome.png"),
+    },
+  ],
+}).then(console.log)
+  .catch(console.error)
diff --git a/examples/general/account-accesses.ts b/examples/general/account-accesses.ts
@@ -1,4 +1,4 @@
-import { MailtrapClient } from "../../src"
+import { MailtrapClient } from "mailtrap"
 
 const TOKEN = "<YOUR-TOKEN-HERE>";
 const TEST_INBOX_ID = "<YOUR-TEST-INBOX-ID-HERE>"

diff --git a/examples/general/accounts.ts b/examples/general/accounts.ts
@@ -1,4 +1,4 @@
-import { MailtrapClient } from "../../src"
+import { MailtrapClient } from "mailtrap"
 
 const TOKEN = "<YOUR-TOKEN-HERE>";
 const TEST_INBOX_ID = "<YOUR-TEST-INBOX-ID-HERE>"

diff --git a/examples/general/permissions.ts b/examples/general/permissions.ts
@@ -1,4 +1,4 @@
-import { MailtrapClient } from "../../src"
+import { MailtrapClient } from "mailtrap"
 
 const TOKEN = "<YOUR-TOKEN-HERE>";
 const TEST_INBOX_ID = "<YOUR-TEST-INBOX-ID-HERE>"

diff --git a/examples/sending/transport.ts b/examples/sending/transport.ts
@@ -13,10 +13,9 @@ const SENDER_EMAIL = "<[email protected]>";
 const RECIPIENT_EMAIL = "<[email protected]>";
 
 const transport = Nodemailer.createTransport(MailtrapTransport({
-  token: TOKEN
+  token: TOKEN,
 }))
 
-// Note: 'sandbox: true' can be passed for making requests to Testing API
 transport.sendMail({
   text: "Welcome to Mailtrap Sending!",
   to: {

diff --git a/examples/testing/attachments.ts b/examples/testing/attachments.ts
@@ -1,4 +1,4 @@
-import { MailtrapClient } from "../../src"
+import { MailtrapClient } from "mailtrap"
 
 const TOKEN = "<YOUR-TOKEN-HERE>";
 const TEST_INBOX_ID = "<YOUR-TEST-INBOX-ID-HERE>"

diff --git a/examples/testing/inboxes.ts b/examples/testing/inboxes.ts
@@ -1,4 +1,4 @@
-import { MailtrapClient } from "../../src"
+import { MailtrapClient } from "mailtrap"
 
 const TOKEN = "<YOUR-TOKEN-HERE>";
 const TEST_INBOX_ID = "<YOUR-TEST-INBOX-ID-HERE>"

diff --git a/examples/testing/messages.ts b/examples/testing/messages.ts
@@ -1,4 +1,4 @@
-import { MailtrapClient } from "../../src"
+import { MailtrapClient } from "mailtrap"
 
 const TOKEN = "<YOUR-TOKEN-HERE>";
 const TEST_INBOX_ID = "<YOUR-TEST-INBOX-ID-HERE>"

diff --git a/examples/testing/send-mail.ts b/examples/testing/send-mail.ts
@@ -0,0 +1,25 @@
+import { MailtrapClient } from "mailtrap"
+
+/**
+ * For this example, you need to have ready-to-use sending domain or,
+ * a Demo domain that allows sending emails to your own account email.
+ * @see https://help.mailtrap.io/article/69-sending-domain-setup
+ */
+
+", @see https://help.mailtrap.io/article/69-sending-domain-setup#Demo-Domain--oYOU5"
+
+const TOKEN = "<YOUR-TOKEN-HERE>";
+const TEST_INBOX_ID = "<YOUR-TEST-INBOX-ID-HERE>"
+const SENDER_EMAIL = "<[email protected]>";
+const RECIPIENT_EMAIL = "<[email protected]>";
+
+const client = new MailtrapClient({ token: TOKEN, sandbox: true, testInboxId: TEST_INBOX_ID });
+
+client.send({
+  from: { name: "Mailtrap Test", email: SENDER_EMAIL },
+  to: [{ email: RECIPIENT_EMAIL }],
+  subject: "Hello from Mailtrap!",
+  text: "Welcome to Mailtrap Sending!",
+})
+.then(console.log)
+.catch(console.error);
diff --git a/examples/testing/template.ts b/examples/testing/template.ts
@@ -1,4 +1,4 @@
-import { MailtrapClient } from "../../src"
+import { MailtrapClient } from "mailtrap"
 
 /**
  * For this example to work, you need to set up a sending domain,

diff --git a/examples/testing/transport.ts b/examples/testing/transport.ts
@@ -0,0 +1,62 @@
+import { readFileSync } from "fs";
+import Nodemailer from "nodemailer";
+import { MailtrapTransport } from "mailtrap"
+
+/**
+ * For this example, you need to have ready-to-use sending domain or,
+ * a Demo domain that allows sending emails to your own account email.
+ * @see https://help.mailtrap.io/article/69-sending-domain-setup
+ */
+
+const TOKEN = "<YOUR-TOKEN-HERE>"
+const TEST_INBOX_ID = "<YOUR-TEST-INBOX-ID-HERE>"
+const SENDER_EMAIL = "<[email protected]>";
+const RECIPIENT_EMAIL = "<[email protected]>";
+
+const transport = Nodemailer.createTransport(MailtrapTransport({
+  token: TOKEN,
+  testInboxId: TEST_INBOX_ID,
+  sandbox: true
+}))
+
+transport.sendMail({
+  text: "Welcome to Mailtrap Sending!",
+  to: {
+    address: RECIPIENT_EMAIL,
+    name: "John Doe"
+  },
+  from: {
+    address: SENDER_EMAIL,
+    name: "Mailtrap Test"
+  },
+  subject: "Hello from Mailtrap!",
+  html: `
+  <!doctype html>
+  <html>
+    <head>
+      <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+    </head>
+    <body style="font-family: sans-serif;">
+      <div style="display: block; margin: auto; max-width: 600px;" class="main">
+        <h1 style="font-size: 18px; font-weight: bold; margin-top: 20px">Congrats for sending test email with Mailtrap!</h1>
+        <p>Inspect it using the tabs you see above and learn how this email can be improved.</p>
+        <img alt="Inspect with Tabs" src="cid:welcome.png" style="width: 100%;">
+        <p>Now send your email using our fake SMTP server and integration of your choice!</p>
+        <p>Good luck! Hope it works.</p>
+      </div>
+      <!-- Example of invalid for email html/css, will be detected by Mailtrap: -->
+      <style>
+        .main { background-color: white; }
+        a:hover { border-left-width: 1em; min-height: 2em; }
+      </style>
+    </body>
+  </html>
+`,
+  attachments: [
+    {
+      filename: "welcome.png",
+      content: readFileSync("./welcome.png"),
+    },
+  ],
+}).then(console.log)
+  .catch(console.error)
diff --git a/src/__tests__/lib/api/Bulk.test.ts b/src/__tests__/lib/api/Bulk.test.ts
-Original file line number
+Diff line change
@@ Expand Up / @@ -5,7 +5,6 @@ on: push @@
     jobs:
       lint:
         runs-on: ubuntu-latest
         steps:
           - uses: actions/checkout@v2
           - uses: actions/setup-node@v3
@@ Expand Down @@