Find Email with Microsoft Outlook API

Pipedream makes it easy to connect APIs for Microsoft Outlook and 3,000+ other apps remarkably fast.

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Find Email with the Microsoft Outlook API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

Create a workflow to Find Email with the Microsoft Outlook API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the Find Email action
1. Connect your Microsoft Outlook account
2. Configure info
3. Optional- Configure Search
4. Optional- Configure Filter
5. Optional- Configure Order By
6. Optional- Configure Max Results
Select a trigger to run your workflow on HTTP requests, schedules or app events
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Find Email on Microsoft Outlook

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

Key:microsoft_outlook-find-email

View on GitHub

Code#

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;
  },
};

Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
Microsoft Outlook	`microsoftOutlook`	`app`	This component uses the Microsoft Outlook app.
Search	`search`	`string`	Search for an email in Microsoft Outlook. Can search for specific message properties such as `"to:example@example.com"` or `"subject:example"`. If the property is excluded, the search targets the default propertes `from`, `subject`, and `body`. For example, `"pizza"` will search for messages with the word `pizza` in the subject, body, or from address, but `"to:example@example.com"` will only search for messages to `example@example.com`. Not for use with `$filter` or `$orderby`.
Filter	`filter`	`string`	Filters results. For example, `contains(subject, 'meet for lunch?')` will include messages whose subject contains ‘meet for lunch?’. See documentation for the full list of operations. Not for use with `$search`.
Order By	`orderBy`	`string`	Order results by a property. For example, `receivedDateTime desc` will order messages by the received date in descending order. Not for use with `$search`.
Max Results	`maxResults`	`integer`	The maximum number of results to return

Authentication#

Microsoft Outlook uses OAuth authentication. When you connect your Microsoft Outlook account, Pipedream will open a popup window where you can sign into Microsoft Outlook and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Microsoft Outlook API.

Pipedream requests the following authorization scopes when you connect your account:

User.Reademailoffline_accessopenidprofileMail.ReadWriteMail.SendMailboxSettings.ReadWriteIMAP.AccessAsUser.AllPOP.AccessAsUser.AllSMTP.SendCalendars.ReadWriteContacts.ReadWriteUser.ReadBasic.All