@pipedream/microsoft_outlook/actions/find-email/find-email.mjs

Pipedream Microsoft Outlook Components

import microsoftOutlook from "../../microsoft_outlook.app.mjs";
import { ConfigurationError } from "@pipedream/platform";

export default {
  key: "microsoft_outlook-find-email",
  name: "Find Email",
  description: "Search for an email in Microsoft Outlook. [See the documentation](https://learn.microsoft.com/en-us/graph/api/user-list-messages)",
  version: "0.0.15",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: true,
  },
  type: "action",
  props: {
    microsoftOutlook,
    info: {
      type: "alert",
      alertType: "info",
      content: "**Note:** `$search` cannot be used together with `$filter` or `$orderby`. When you specify `$filter`, the service infers a sort order for the results. If you use both `$orderby` and `$filter` to get messages, because the server always infers a sort order for the results of a `$filter`, you must [specify properties in certain ways](https://learn.microsoft.com/en-us/graph/api/user-list-messages#using-filter-and-orderby-in-the-same-query).",
    },
    search: {
      propDefinition: [
        microsoftOutlook,
        "search",
      ],
    },
    filter: {
      propDefinition: [
        microsoftOutlook,
        "filter",
      ],
    },
    orderBy: {
      propDefinition: [
        microsoftOutlook,
        "orderBy",
      ],
    },
    maxResults: {
      propDefinition: [
        microsoftOutlook,
        "maxResults",
      ],
    },
  },
  methods: {
    ensureQuotes(str) {
      str = str.trim();
      str = str.replace(/^['"]?/, "").replace(/['"]?$/, "");
      return `"${str}"`;
    },
  },
  async run({ $ }) {
    if (this.search && (this.filter || this.orderBy)) {
      throw new ConfigurationError("`$search` not supported when using `$filter` or `$orderby`.");
    }

    let emails = [];

    if (!this.search) {
      const items = this.microsoftOutlook.paginate({
        fn: this.microsoftOutlook.listMessages,
        args: {
          $,
          params: {
            "$filter": this.filter,
            "$orderby": this.orderBy,
          },
        },
        max: this.maxResults,
      });

      for await (const item of items) {
        emails.push(item);
      }
    } else {
      const { value } = await this.microsoftOutlook.listMessages({
        $,
        params: {
          "$search": this.ensureQuotes(this.search),
          "$top": this.maxResults,
        },
      });

      emails = value;
    }

    $.export("$summary", `Successfully retrieved ${emails.length} message${emails.length != 1
      ? "s"
      : ""}.`);
    return emails;
  },
};