Send a Document with UltraMsg API on New Attachment Received (Instant) from Microsoft Outlook API

Pipedream makes it easy to connect APIs for UltraMsg, Microsoft Outlook and 2,500+ other apps remarkably fast.

Trigger workflow on

New Attachment Received (Instant) from the Microsoft Outlook API

Next, do this

Send a Document with the UltraMsg 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#

This integration creates a workflow with a Microsoft Outlook trigger and UltraMsg action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Attachment Received (Instant) trigger
1. Connect your Microsoft Outlook account
2. Configure Webhook renewal timer
3. Optional- Select one or more Folder IDs to Monitor
Configure the Send a Document action
1. Connect your UltraMsg account
2. Select a To
3. Configure Document
4. Configure Filename
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This integration uses pre-built, source-available components from Pipedream's GitHub repo. These components are 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.

Trigger#

New Attachment Received (Instant) on Microsoft Outlook

Description:Emit new event when a new email containing one or more attachments arrives in a specified Microsoft Outlook folder.

Version:0.0.1

Key:microsoft_outlook-new-attachment-received

View on GitHub

Microsoft Outlook Overview#

The Microsoft Outlook API on Pipedream allows you to automate email-related tasks, manage calendars, and handle contacts effortlessly. With the API, you can trigger workflows on new emails, send emails programmatically, and synchronize calendars across platforms, among other functions. Pipedream's serverless platform facilitates the connection between Outlook and a myriad of other apps for efficient automation workflows.

Trigger Code#

import common from "../common/common-new-email.mjs";

export default {
  ...common,
  key: "microsoft_outlook-new-attachment-received",
  name: "New Attachment Received (Instant)",
  description: "Emit new event when a new email containing one or more attachments arrives in a specified Microsoft Outlook folder.",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  methods: {
    ...common.methods,
    async getSampleEvents({ pageSize }) {
      const folders = this.folderIds?.length
        ? this.folderIds.map((id) => `/me/mailFolders/${id}/messages`)
        : [
          "/me/messages",
        ];

      const messagesWithAttachments = [];
      for (const folder of folders) {
        const { value: messages } = await this.microsoftOutlook.listMessages({
          resource: folder,
          params: {
            $top: pageSize,
            $filter: "hasAttachments eq true",
          },
        });
        messagesWithAttachments.push(...messages);
      }

      const attachments = [];
      for (const message of messagesWithAttachments) {
        const messageAttachments = await this.getMessageAttachments(message);
        attachments.push(...messageAttachments);
      }
      return attachments;
    },
    async getMessageAttachments(message) {
      const { value: attachments } = await this.microsoftOutlook.listAttachments({
        messageId: message.id,
      });
      if (!attachments?.length) {
        return [];
      }
      return attachments.map((attachment) => ({
        ...attachment,
        messageId: message.id,
        messageSubject: message.subject,
        messageSender: message.sender,
        messageReceivedDateTime: message.receivedDateTime,
        parentFolderId: message.parentFolderId,
        contentBytes: undefined,
      }));
    },
    emitEvent(item) {
      if (this.isRelevant(item)) {
        this.$emit(item, this.generateMeta(item));
      }
    },
    generateMeta(item) {
      return {
        id: item.contentId,
        summary: `New attachment ${item.name}`,
        ts: Date.parse(item.messageReceivedDateTime),
      };
    },
  },
  async run(event) {
    const folders = this.folderIds?.length
      ? this.folderIds.map((id) => `/me/mailFolders/${id}/messages`)
      : [
        "/me/messages",
      ];

    for (const folder of folders) {
      await this.run({
        event,
        emitFn: async ({ resourceId } = {}) => {
          try {
            const message = await this.microsoftOutlook.getMessage({
              resource: folder,
              messageId: resourceId,
            });
            if (message.hasAttachments) {
              const attachments = await this.getMessageAttachments(message);
              attachments.forEach((item) => this.emitEvent(item));
            }
          } catch {
            console.log(`Could not fetch message with ID: ${resourceId}`);
          }
        },
      });
    }
  },
};

Trigger 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.
N/A	`http`	`$.interface.http`	This component uses `$.interface.http` to generate a unique URL when the component is first instantiated. Each request to the URL will trigger the `run()` method of the component.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Webhook renewal timer	`timer`	`$.interface.timer`	Graph API expires Outlook notifications in 3 days, we auto-renew them in 2 days, see
Folder IDs to Monitor	`folderIds`	`string[]`	Select a value from the drop down menu.

Trigger 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.ReadWrite

About Microsoft Outlook#

Microsoft Outlook lets you bring all your email accounts and calendars in one convenient spot.

Action#

Send a Document on UltraMsg

Description:Send a document to a specified number. [See the docs here](https://docs.ultramsg.com/api/post/messages/document)

Version:0.0.2

Key:ultramsg-send-document

View on GitHub

UltraMsg Overview#

UltraMsg API offers a suite of messaging capabilities that let you automate WhatsApp messaging. With it, you can send and receive messages, create WhatsApp chatbots, and manage media, enabling a wide range of automated interactions with users. Pipedream acts as a powerful accelerator here, letting you connect UltraMsg to hundreds of other apps to craft custom workflows.

Action Code#

import ultramsg from "../../ultramsg.app.mjs";

export default {
  name: "Send a Document",
  description: "Send a document to a specified number. [See the docs here](https://docs.ultramsg.com/api/post/messages/document)",
  key: "ultramsg-send-document",
  version: "0.0.2",
  type: "action",
  props: {
    ultramsg,
    to: {
      propDefinition: [
        ultramsg,
        "to",
      ],
    },
    document: {
      type: "string",
      label: "Document",
      description: "Public URL of your document",
    },
    filename: {
      type: "string",
      label: "Filename",
      description: "The name of your file",
    },
  },
  async run({ $ }) {
    const {
      to,
      document,
      filename,
    } = this;

    const data = {
      to,
      document,
      filename,
    };
    const res = await this.ultramsg.sendDocument(data, $);
    $.export("$summary", `Document successfully sent to "${to}"`);

    return res;
  },
};

Action Configuration#

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

Label	Prop	Type	Description
UltraMsg	`ultramsg`	`app`	This component uses the UltraMsg app.
To	`to`	`string`	Select a value from the drop down menu.
Document	`document`	`string`	Public URL of your document
Filename	`filename`	`string`	The name of your file