[Components] mailosaur #16655

Sources
 - New Message
 - New Message Macthing Criteira

Actions
 - Create Email
 - Search Message
 - Delete Message

Author: luancazarine

components/mailosaur/actions/create-email/create-email.mjs

@@ -1,3 +1,4 @@
+import { ConfigurationError } from "@pipedream/platform";
 import mailosaur from "../../mailosaur.app.mjs";
 
 export default {
@@ -15,65 +16,56 @@ export default {
       ],
     },
     to: {
-      propDefinition: [
-        mailosaur,
-        "to",
-      ],
-    },
-    subject: {
-      propDefinition: [
-        mailosaur,
-        "subject",
-      ],
+      type: "string",
+      label: "To",
+      description: "The verified external email address to which the email should be sent.",
     },
     from: {
-      propDefinition: [
-        mailosaur,
-        "from",
-      ],
+      type: "string",
+      label: "From",
+      description: "Optionally overrides of the message's `from` address. This **must** be an address ending with `YOUR_SERVER.mailosaur.net`, such as `my-emails @a1bcdef2.mailosaur.net`.",
       optional: true,
     },
+    subject: {
+      type: "string",
+      label: "Subject",
+      description: "The subject line for an email.",
+    },
     html: {
-      propDefinition: [
-        mailosaur,
-        "html",
-      ],
+      type: "object",
+      label: "HTML",
+      description: "An object with HTML properties. Please [see the documentation](https://mailosaur.com/docs/api#send-an-email) for more details.",
       optional: true,
     },
     text: {
-      propDefinition: [
-        mailosaur,
-        "text",
-      ],
+      type: "object",
+      label: "Text",
+      description: "An object with Plain text properties. Please [see the documentation](https://mailosaur.com/docs/api#send-an-email) for more details.",
       optional: true,
     },
     send: {
-      propDefinition: [
-        mailosaur,
-        "send",
-      ],
-      optional: true,
-    },
-    attachments: {
-      propDefinition: [
-        mailosaur,
-        "attachments",
-      ],
-      optional: true,
+      type: "boolean",
+      label: "Send",
+      description: "If `false`, the email will be created in your server, but will not be sent.",
     },
   },
   async run({ $ }) {
-    const response = await this.mailosaur.sendEmail({
-      serverId: this.serverId,
-      to: this.to,
-      subject: this.subject,
-      from: this.from,
-      html: this.html,
-      text: this.text,
-      send: this.send,
-      attachments: this.attachments
-        ? this.attachments.map(JSON.parse)
-        : undefined,
+    if ((!!this.send) && (!this.html && !this.text)) {
+      throw new ConfigurationError("Please provide either HTML or plain text content.");
+    }
+
+    const {
+      mailosaur,
+      serverId,
+      ...data
+    } = this;
+
+    const response = await mailosaur.sendEmail({
+      $,
+      params: {
+        server: serverId,
+      },
+      data,
     });
 
     $.export("$summary", `Email sent successfully to ${this.to}`);

components/mailosaur/actions/delete-email/delete-email.mjs

@@ -1,5 +1,4 @@
 import mailosaur from "../../mailosaur.app.mjs";
-import { axios } from "@pipedream/platform";
 
 export default {
   key: "mailosaur-delete-email",
@@ -9,20 +8,29 @@ export default {
   type: "action",
   props: {
     mailosaur,
+    serverId: {
+      propDefinition: [
+        mailosaur,
+        "serverId",
+      ],
+    },
     emailId: {
       propDefinition: [
         mailosaur,
         "emailId",
+        ({ serverId }) => ({
+          serverId,
+        }),
       ],
     },
   },
   async run({ $ }) {
-    const response = await this.mailosaur.deleteEmail({
+    await this.mailosaur.deleteEmail({
+      $,
       emailId: this.emailId,
     });
     $.export("$summary", `Successfully deleted email with ID ${this.emailId}`);
     return {
-      success: true,
       emailId: this.emailId,
     };
   },

components/mailosaur/actions/search-email/search-email.mjs

@@ -1,11 +1,10 @@
 import mailosaur from "../../mailosaur.app.mjs";
-import { axios } from "@pipedream/platform";
 
 export default {
   key: "mailosaur-search-email",
   name: "Search Email",
   description: "Search for received emails in a server matching specified criteria. [See the documentation](https://mailosaur.com/docs/api/#search-for-messages)",
-  version: "0.0.{{ts}}",
+  version: "0.0.1",
   type: "action",
   props: {
     mailosaur,
@@ -16,31 +15,29 @@ export default {
       ],
     },
     receiveAfter: {
-      propDefinition: [
-        mailosaur,
-        "receiveAfter",
-      ],
+      type: "string",
+      label: "Receive After",
+      description:
+            "Limits results to only messages received after this date/time.",
       optional: true,
     },
     page: {
-      propDefinition: [
-        mailosaur,
-        "page",
-      ],
+      type: "integer",
+      label: "Page",
+      description: "Used in conjunction with `itemsPerPage` to support pagination.",
       optional: true,
     },
     itemsPerPage: {
-      propDefinition: [
-        mailosaur,
-        "itemsPerPage",
-      ],
+      type: "integer",
+      label: "Items Per Page",
+      description:
+            "A limit on the number of results to be returned per page. Can be set between 1 and 1000 items, default is 50.",
       optional: true,
     },
     dir: {
-      propDefinition: [
-        mailosaur,
-        "dir",
-      ],
+      type: "string",
+      label: "Direction",
+      description: "Optionally limits results based on the direction (`Sent` or `Received`).",
       optional: true,
     },
     sentFrom: {
@@ -81,16 +78,21 @@ export default {
   },
   async run({ $ }) {
     const response = await this.mailosaur.searchMessages({
-      serverId: this.serverId,
-      receiveAfter: this.receiveAfter,
-      page: this.page,
-      itemsPerPage: this.itemsPerPage,
-      dir: this.dir,
-      sentFrom: this.sentFrom,
-      sentTo: this.sentTo,
-      subject: this.subject,
-      body: this.body,
-      match: this.match,
+      $,
+      params: {
+        server: this.serverId,
+        receiveAfter: this.receiveAfter,
+        page: this.page,
+        itemsPerPage: this.itemsPerPage,
+        dir: this.dir,
+      },
+      data: {
+        sentFrom: this.sentFrom,
+        sentTo: this.sentTo,
+        subject: this.subject,
+        body: this.body,
+        match: this.match,
+      },
     });
 
     $.export("$summary", `Successfully retrieved ${response.items.length} email(s) from server.`);

components/mailosaur/common/constants.mjs

@@ -0,0 +1,12 @@
+export const LIMIT = 1000;
+
+export const MATCH_OPTIONS = [
+  {
+    label: "All",
+    value: "ALL",
+  },
+  {
+    label: "Any",
+    value: "ANY",
+  },
+];