Merge pull request #63 from railsware/batch-sending-api

Batch Sending Api

Author: narekhovhannisyan

README.md

@@ -66,6 +66,13 @@ Refer to the [`examples`](examples) folder for the source code of this and other
  - [Send email using template](examples/sending/template.ts)
  - [Nodemailer transport](examples/sending/transport.ts)
 
+### Batch Sending API
+
+ - [Send a batch of transactional emails](examples/batch/transactional.ts)
+ - [Send a batch of bulk emails](examples/batch/bulk.ts)
+ - [Send a batch of sandbox emails](examples/batch/sandbox.ts)
+ - [Send a batch of emails from template](examples/batch/template.ts)
+
 ### Email testing API
 
  - [Attachments](examples/testing/attachments.ts)

examples/batch/bulk.ts

@@ -0,0 +1,39 @@
+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
+ */
+
+const TOKEN = "<YOUR-TOKEN-HERE>";
+const SENDER_EMAIL = "<SENDER@YOURDOMAIN.COM>";
+const RECIPIENT_EMAIL = "<RECIPIENT@EMAIL.COM>";
+
+const client = new MailtrapClient({ 
+  token: TOKEN,
+});
+
+client.batchSend({
+  base: {
+    from: { name: "Mailtrap Test", email: SENDER_EMAIL },
+    subject: "Sandbox Email",
+    text: "Welcome to Mailtrap Sandbox Batch Sending!"
+  },
+  requests: [
+    {
+      to: [{ email: RECIPIENT_EMAIL }],
+      custom_variables: {
+        email_number: 1
+      }
+    },
+    {
+      to: [{ email: RECIPIENT_EMAIL }],
+      custom_variables: {
+        email_number: 2
+      }
+    }
+  ]
+})
+  .then(console.log)
+  .catch(console.error);

examples/batch/sandbox.ts

@@ -0,0 +1,42 @@
+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
+ */
+
+const TOKEN = "<YOUR-TOKEN-HERE>";
+const TEST_INBOX_ID = "<YOUR-TEST-INBOX-ID-HERE>";
+const SENDER_EMAIL = "<SENDER@YOURDOMAIN.COM>";
+const RECIPIENT_EMAIL = "<RECIPIENT@EMAIL.COM>";
+
+const client = new MailtrapClient({ 
+  token: TOKEN,
+  sandbox: true,
+  testInboxId: TEST_INBOX_ID
+});
+
+client.batchSend({
+  base: {
+    from: { name: "Mailtrap Test", email: SENDER_EMAIL },
+    subject: "Sandbox Email",
+    text: "Welcome to Mailtrap Sandbox Batch Sending!"
+  },
+  requests: [
+    {
+      to: [{ email: RECIPIENT_EMAIL }],
+      custom_variables: {
+        email_number: 1
+      }
+    },
+    {
+      to: [{ email: RECIPIENT_EMAIL }],
+      custom_variables: {
+        email_number: 2
+      }
+    }
+  ]
+})
+  .then(console.log)
+  .catch(console.error); 

examples/batch/template.ts

@@ -0,0 +1,39 @@
+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
+ */
+
+const TOKEN = "<YOUR-TOKEN-HERE>";
+const SENDER_EMAIL = "<SENDER@YOURDOMAIN.COM>";
+const RECIPIENT_EMAIL = "<RECIPIENT@EMAIL.COM>";
+const TEMPLATE_UUID = "<TEMPLATE-UUID>";
+
+const client = new MailtrapClient({ token: TOKEN });
+
+client.batchSend({
+  base: {
+    from: { name: "Mailtrap Test", email: SENDER_EMAIL },
+    template_uuid: TEMPLATE_UUID
+  },
+  requests: [
+    {
+      to: [{ email: RECIPIENT_EMAIL }],
+      template_variables: {
+        user_name: "John Doe",
+        company_name: "Example Corp"
+      }
+    },
+    {
+      to: [{ email: RECIPIENT_EMAIL }],
+      template_variables: {
+        user_name: "Jane Smith",
+        company_name: "Example Corp"
+      }
+    }
+  ]
+})
+  .then(console.log)
+  .catch(console.error); 

examples/batch/transactional.ts

@@ -0,0 +1,37 @@
+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
+ */
+
+const TOKEN = "<YOUR-TOKEN-HERE>";
+const SENDER_EMAIL = "<SENDER@YOURDOMAIN.COM>";
+const RECIPIENT_EMAIL = "<RECIPIENT@EMAIL.COM>";
+
+const client = new MailtrapClient({ token: TOKEN });
+
+client.batchSend({
+  base: {
+    from: { name: "Mailtrap Test", email: SENDER_EMAIL },
+    subject: "Transactional Email",
+    text: "Welcome to Mailtrap Batch Sending!"
+  },
+  requests: [
+    {
+      to: [{ email: RECIPIENT_EMAIL }],
+      custom_variables: {
+        email_number: 1
+      }
+    },
+    {
+      to: [{ email: RECIPIENT_EMAIL }],
+      custom_variables: {
+        email_number: 2
+      }
+    }
+  ]
+})
+  .then(console.log)
+  .catch(console.error); 

examples/testing/send-mail.ts

@@ -4,9 +4,9 @@ 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"
  */
 
-", @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>"