@pipedream/reachmail 0.0.1 → 0.2.0

package/README.md

@@ -0,0 +1,11 @@
+# Overview
+
+The ReachMail API lets you seamlessly integrate email marketing capabilities into your workflows on Pipedream. With it, you can automate email list management, campaign creation, and performance tracking. This flexibility opens up possibilities for custom email marketing automation, audience segmentation, and targeted outreach based on user actions or data from other apps. By harnessing the power of Pipedream's serverless platform, you can build workflows that trigger from various events and connect with numerous other services to create a sophisticated, automated email marketing machine.
+
+# Example Use Cases
+
+- **Automated Campaign Creation from Webhooks**: Trigger an email campaign in ReachMail when a specific event occurs in your app. For instance, you could set up a Pipedream workflow where a new sign-up on your platform via a webhook triggers a welcome email sequence in ReachMail.
+
+- **Dynamic Audience Segmentation with Google Sheets**: Maintain a Google Sheet with contact information and preferences. Use a Pipedream workflow to periodically sync this data to ReachMail, automatically updating email lists for targeted campaigns based on the latest data.
+
+- **Performance-Driven Emails with ReachMail and Slack**: Monitor your email campaign performance with ReachMail, and use Pipedream to send summary reports or alerts to a Slack channel when key metrics hit certain thresholds, ensuring that your team stays informed about your marketing efforts in real time.

package/actions/list-list-id-options/list-list-id-options.mjs

@@ -0,0 +1,26 @@
+import reachmail from "../../reachmail.app.mjs";
+
+export default {
+  key: "reachmail-list-list-id-options",
+  name: "List List ID Options",
+  description: "Retrieves available options for the List ID field.",
+  version: "0.0.1",
+  type: "action",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
+  props: {
+    reachmail,
+  },
+  async run({ $ }) {
+    const options = await reachmail.propDefinitions.listId.options.call(this.reachmail, {});
+    $.export("$summary", `Successfully retrieved ${options.length} option${
+      options.length === 1
+        ? ""
+        : "s"
+    }`);
+    return options;
+  },
+};

package/actions/opt-out-recipient-from-list/opt-out-recipient-from-list.mjs

@@ -0,0 +1,41 @@
+import reachmail from "../../reachmail.app.mjs";
+
+export default {
+  key: "reachmail-opt-out-recipient-from-list",
+  name: "Opt Out Recipient From List",
+  description: "The action will remove the recipient from the specified list. [See the documentation](https://services.reachmail.net/)",
+  version: "0.0.2",
+  annotations: {
+    destructiveHint: true,
+    openWorldHint: true,
+    readOnlyHint: false,
+  },
+  type: "action",
+  props: {
+    reachmail,
+    recipient: {
+      type: "string",
+      label: "Recipient Email",
+      description: "The email address of the recipient.",
+    },
+    listId: {
+      propDefinition: [
+        reachmail,
+        "listId",
+      ],
+      type: "string",
+      description: "The ID of the list from which the recipient should be opted out.",
+    },
+  },
+  async run({ $ }) {
+    const response = await this.reachmail.optOutRecipient({
+      $,
+      listId: this.listId,
+      data: {
+        Email: this.recipient,
+      },
+    });
+    $.export("$summary", `Successfully opted out ${this.recipient} from list ${this.listId}`);
+    return response;
+  },
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pipedream/reachmail",
-  "version": "0.0.1",
+  "version": "0.2.0",
   "description": "Pipedream ReachMail Components",
   "main": "reachmail.app.mjs",
   "keywords": [
@@ -11,5 +11,8 @@
   "author": "Pipedream <support@pipedream.com> (https://pipedream.com/)",
   "publishConfig": {
     "access": "public"
+  },
+  "dependencies": {
+    "@pipedream/platform": "^1.6.8"
   }
 }

package/reachmail.app.mjs

@@ -1,11 +1,80 @@
+import { axios } from "@pipedream/platform";
+
 export default {
   type: "app",
   app: "reachmail",
-  propDefinitions: {},
+  propDefinitions: {
+    listId: {
+      type: "string[]",
+      label: "List ID",
+      description: "The list ID related to the new campaign.",
+      async options() {
+        const data = await this.listLists();
+
+        return data.map(({
+          Id: value, Name: label,
+        }) => ({
+          label,
+          value,
+        }));
+      },
+    },
+  },
   methods: {
-    // this.$auth contains connected account data
-    authKeys() {
-      console.log(Object.keys(this.$auth));
+    _baseUrl() {
+      return "https://services.reachmail.net";
+    },
+    _headers() {
+      return {
+        "Authorization": `Bearer ${this.$auth.api_token}`,
+      };
+    },
+    _makeRequest({
+      $ = this, path, ...opts
+    }) {
+      return axios($, {
+        url: this._baseUrl() + path,
+        headers: this._headers(),
+        ...opts,
+      });
+    },
+    createWebhook({
+      action, ...opts
+    }) {
+      return this._makeRequest({
+        method: "POST",
+        path: `/Webhooks/${action}`,
+        ...opts,
+      });
+    },
+    deleteWebhook(action) {
+      return this._makeRequest({
+        method: "DELETE",
+        path: `/Webhooks/${action}`,
+      });
+    },
+    updateWebhook({
+      hookId, ...opts
+    }) {
+      return this._makeRequest({
+        method: "PUT",
+        path: `/Webhooks/${hookId}`,
+        ...opts,
+      });
+    },
+    listLists() {
+      return this._makeRequest({
+        path: "/Lists",
+      });
+    },
+    optOutRecipient({
+      listId, ...opts
+    }) {
+      return this._makeRequest({
+        method: "POST",
+        path: `/Lists/OptOut/${listId}`,
+        ...opts,
+      });
     },
   },
-};
+};

package/sources/common/base.mjs

@@ -0,0 +1,49 @@
+import reachmail from "../../reachmail.app.mjs";
+
+export default {
+  props: {
+    reachmail,
+    http: "$.interface.http",
+    db: "$.service.db",
+  },
+  methods: {
+    _setHookId(Id) {
+      this.db.set("hookId", Id);
+    },
+    _getHookId() {
+      return this.db.get("hookId");
+    },
+    emitData(body) {
+      this.$emit(body, {
+        id: body.Signature,
+        summary: this.getSummary(body),
+        ts: Date.parse(body.Timestamp),
+      });
+    },
+  },
+  hooks: {
+    async activate() {
+      const response = await this.reachmail.createWebhook({
+        action: this.getAction(),
+        data: {
+          Url: this.http.endpoint,
+        },
+      });
+      this._setHookId(response.Id);
+    },
+    async deactivate() {
+      const hookId = this._getHookId();
+
+      await this.reachmail.updateWebhook({
+        hookId,
+        data: {
+          Url: this.http.endpoint,
+          Active: false,
+        },
+      });
+    },
+  },
+  async run({ body }) {
+    this.emitData(body);
+  },
+};

package/sources/new-bounce-instant/new-bounce-instant.mjs

@@ -0,0 +1,22 @@
+import common from "../common/base.mjs";
+import sampleEmit from "./test-event.mjs";
+
+export default {
+  ...common,
+  key: "reachmail-new-bounce-instant",
+  name: "New Bounce Instant",
+  description: "Emit new event when a recipient's email address bounces.",
+  version: "0.0.1",
+  type: "source",
+  dedupe: "unique",
+  methods: {
+    ...common.methods,
+    getAction() {
+      return "Bounce";
+    },
+    getSummary(body) {
+      return `New bounce: ${body.Email}`;
+    },
+  },
+  sampleEmit,
+};

package/sources/new-bounce-instant/test-event.mjs

@@ -0,0 +1,39 @@
+export default {
+  "body": {
+      "Device": {
+          "ClientName": null,
+          "ClientOs": "Unknown",
+          "ClientType": "Other",
+          "DeviceType": "Desktop"
+      },
+      "Email": "webhook@reachmail.net",
+      "EventId": "9d2360cd-e094-4586-9125-ffcc9c713f58",
+      "EventType": "bounce",
+      "IpAddress": "123.11.32.1",
+      "Location": {
+          "City": "Chicago",
+          "CountryCode": "US",
+          "Region": "IL"
+      },
+      "RecipientId": "20b64129-c0a1-42bc-9453-209a28f7bd51",
+      "Signature": "816fb208ea0cb491f81b171d6d5d91d0de850b37156e1322fabccd2e2ed5cd64",
+      "Timestamp": 1710169299,
+      "Token": "xeeggtwycyqgcpemxduirulpdpmjbksejmkocvkjffwjefpnph",
+      "Url": null,
+      "UserAgent": "Mozilla/firefox",
+      "XCampaign": "Campaign Name"
+  },
+  "client_ip": "123.11.32.1",
+  "headers": {
+      "accept": "text/html, application/xhtml+xml, application/xml; q=0.9, image/webp, */*; q=0.8",
+      "accept-encoding": "gzip, deflate, sdch, br",
+      "content-length": "569",
+      "content-type": "application/json; charset=utf-8",
+      "host": "urltest.com",
+      "user-agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/14.1.1 Safari/605.1.15"
+  },
+  "method": "POST",
+  "path": "/",
+  "query": {},
+  "url": "https://urltest.com/"
+}

package/sources/new-click-instant/new-click-instant.mjs

@@ -0,0 +1,22 @@
+import common from "../common/base.mjs";
+import sampleEmit from "./test-event.mjs";
+
+export default {
+  ...common,
+  key: "reachmail-new-click-instant",
+  name: "New Click Instant",
+  description: "Emit new event when a recipient clicks on an email.",
+  version: "0.0.1",
+  type: "source",
+  dedupe: "unique",
+  methods: {
+    ...common.methods,
+    getAction() {
+      return "Click";
+    },
+    getSummary(body) {
+      return `New click from ${body.Email}`;
+    },
+  },
+  sampleEmit,
+};

package/sources/new-click-instant/test-event.mjs

@@ -0,0 +1,39 @@
+export default {
+  "body": {
+      "Device": {
+          "ClientName": null,
+          "ClientOs": "Unknown",
+          "ClientType": "Other",
+          "DeviceType": "Desktop"
+      },
+      "Email": "webhook@reachmail.net",
+      "EventId": "9d2360cd-e094-4586-9125-ffcc9c713f58",
+      "EventType": "click",
+      "IpAddress": "123.11.32.1",
+      "Location": {
+          "City": "Chicago",
+          "CountryCode": "US",
+          "Region": "IL"
+      },
+      "RecipientId": "20b64129-c0a1-42bc-9453-209a28f7bd51",
+      "Signature": "816fb208ea0cb491f81b171d6d5d91d0de850b37156e1322fabccd2e2ed5cd64",
+      "Timestamp": 1710169299,
+      "Token": "xeeggtwycyqgcpemxduirulpdpmjbksejmkocvkjffwjefpnph",
+      "Url": null,
+      "UserAgent": "Mozilla/firefox",
+      "XCampaign": "Campaign Name"
+  },
+  "client_ip": "123.11.32.1",
+  "headers": {
+      "accept": "text/html, application/xhtml+xml, application/xml; q=0.9, image/webp, */*; q=0.8",
+      "accept-encoding": "gzip, deflate, sdch, br",
+      "content-length": "569",
+      "content-type": "application/json; charset=utf-8",
+      "host": "urltest.com",
+      "user-agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/14.1.1 Safari/605.1.15"
+  },
+  "method": "POST",
+  "path": "/",
+  "query": {},
+  "url": "https://urltest.com/"
+}

package/sources/new-open-instant/new-open-instant.mjs

@@ -0,0 +1,22 @@
+import common from "../common/base.mjs";
+import sampleEmit from "./test-event.mjs";
+
+export default {
+  ...common,
+  key: "reachmail-new-open-instant",
+  name: "New Email Open Instant",
+  description: "Emit new event when a recipient opens an email.",
+  version: "0.0.1",
+  type: "source",
+  dedupe: "unique",
+  methods: {
+    ...common.methods,
+    getAction() {
+      return "Open";
+    },
+    getSummary(body) {
+      return `Email opened by ${body.Email}`;
+    },
+  },
+  sampleEmit,
+};

package/sources/new-open-instant/test-event.mjs

@@ -0,0 +1,39 @@
+export default {
+  "body": {
+      "Device": {
+          "ClientName": null,
+          "ClientOs": "Unknown",
+          "ClientType": "Other",
+          "DeviceType": "Desktop"
+      },
+      "Email": "webhook@reachmail.net",
+      "EventId": "9d2360cd-e094-4586-9125-ffcc9c713f58",
+      "EventType": "open",
+      "IpAddress": "123.11.32.1",
+      "Location": {
+          "City": "Chicago",
+          "CountryCode": "US",
+          "Region": "IL"
+      },
+      "RecipientId": "20b64129-c0a1-42bc-9453-209a28f7bd51",
+      "Signature": "816fb208ea0cb491f81b171d6d5d91d0de850b37156e1322fabccd2e2ed5cd64",
+      "Timestamp": 1710169299,
+      "Token": "xeeggtwycyqgcpemxduirulpdpmjbksejmkocvkjffwjefpnph",
+      "Url": null,
+      "UserAgent": "Mozilla/firefox",
+      "XCampaign": "Campaign Name"
+  },
+  "client_ip": "123.11.32.1",
+  "headers": {
+      "accept": "text/html, application/xhtml+xml, application/xml; q=0.9, image/webp, */*; q=0.8",
+      "accept-encoding": "gzip, deflate, sdch, br",
+      "content-length": "569",
+      "content-type": "application/json; charset=utf-8",
+      "host": "urltest.com",
+      "user-agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/14.1.1 Safari/605.1.15"
+  },
+  "method": "POST",
+  "path": "/",
+  "query": {},
+  "url": "https://urltest.com/"
+}