Send message with Discord Bot API on New Email from IMAP API

Pipedream makes it easy to connect APIs for Discord Bot, IMAP and 2,000+ other apps remarkably fast.

Trigger workflow on

New Email from the IMAP API

Next, do this

Send message with the Discord Bot API

No credit card required

▶

Watch us build a workflow

4 min

Watch now ➜

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

Developers ♥ Pipedream

Getting Started#

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

Select this integration
Configure the New Email trigger
1. Connect your IMAP account
2. Configure Polling interval
3. Select a Mailbox
Configure the Send message action
1. Connect your Discord Bot account
2. Select a Guild
3. Configure Message
4. Optional- Configure Embeds
5. Optional- Configure Thread ID
6. Optional- Configure Username
7. Optional- Configure Avatar URL
8. Optional- Configure Include link to workflow
9. Optional- Select a User
10. Optional- Select a Channel
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 Email on IMAP

Description:Emit new event for each new email in a mailbox

Version:0.0.4

Key:imap-new-email

View on GitHub

IMAP Overview#

Using Pipedream's IMAP API, developers can automate interactions with their email inbox, enabling serverless workflows that perform actions based on incoming emails. This could include parsing email contents, triggering events upon receiving emails from specific senders, attaching labels, and much more. By leveraging IMAP, Pipedream can act as a bridge between your email and other services, streamlining processes that would otherwise require manual intervention.

Trigger Code#

import imap from "../../imap.app.mjs";
import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";

/**
 * Creates an IMAP server connection and emits emails added to a mailbox after the last emitted
 * email.
 */
export default {
  key: "imap-new-email",
  name: "New Email",
  description: "Emit new event for each new email in a mailbox",
  version: "0.0.4",
  type: "source",
  dedupe: "unique",
  props: {
    imap,
    db: "$.service.db",
    timer: {
      label: "Polling interval",
      description:
        "Pipedream will poll the IMAP server for new emails at this interval",
      type: "$.interface.timer",
      default: {
        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
      },
    },
    mailbox: {
      propDefinition: [
        imap,
        "mailbox",
      ],
    },
  },
  methods: {
    _getLastUid(mailbox) {
      return this.db.get(`lastUid-${mailbox}`);
    },
    _setLastUid(mailbox, lastUid) {
      this.db.set(`lastUid-${mailbox}`, lastUid);
    },
    _getUidValidity(mailbox) {
      return this.db.get(`uidValidity-${mailbox}`);
    },
    _setUidValidity(mailbox, uidValidity) {
      this.db.set(`uidValidity-${mailbox}`, uidValidity);
    },
    _handleUidValidityChange(mailbox, uidValidity) {
      this._setUidValidity(mailbox, uidValidity);
      this._setLastUid(mailbox, null);
    },
    hasNewMessages(box) {
      const lastUid = this._getLastUid(box.name);
      return !lastUid || box.uidnext > lastUid + 1;
    },
    generateMeta(message) {
      const date = message.attributes?.date ?? new Date();
      const ts = Date.parse(date);
      return {
        id: `${message.attributes?.uid}-${ts}`,
        ts,
        summary: message.mail?.subject,
      };
    },
    processMessage(message) {
      const lastUid = message.attributes?.uid ?? lastUid;
      this._setLastUid(this.mailbox, lastUid);
      this.$emit(message.mail, this.generateMeta(message));
    },
    async processMessageStream(stream) {
      for await (const message of stream) {
        this.processMessage(message);
      }
    },
    async getHistoricalEvents() {
      const { mailbox } = this;
      const connection = await this.imap.getConnection();
      try {
        const box = await this.imap.openMailbox(connection, mailbox);
        const startSeqno = box.messages.total > 25
          ? box.messages.total - 24
          : 1;
        const messageStream = this.imap.fetchMessages(connection, {
          startSeqno,
        });
        await this.processMessageStream(messageStream);
      } finally {
        await this.imap.closeConnection(connection);
      }
    },
  },
  hooks: {
    async deploy() {
      await this.getHistoricalEvents();
    },
  },
  async run() {
    const { mailbox } = this;
    const connection = await this.imap.getConnection();

    try {
      const box = await this.imap.openMailbox(connection, mailbox);

      const uidValidity = this._getUidValidity(box.name);
      if (uidValidity !== box.uidvalidity) {
        this._handleUidValidityChange(box.name, box.uidvalidity);
      }

      if (!this.hasNewMessages(box)) {
        console.log("No new messages since last run");
        return;
      }

      const lastUid = this._getLastUid(box.name);

      // Fetch messages after lastUid if it exists, or most recent message otherwise
      const messageStream = this.imap.fetchMessages(connection, {
        startUid: lastUid && lastUid + 1,
        startSeqno: box.messages.total,
      });
      await this.processMessageStream(messageStream);
    } finally {
      await this.imap.closeConnection(connection);
    }
  },
};

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
IMAP	`imap`	`app`	This component uses the IMAP app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Polling interval	`timer`	`$.interface.timer`	Pipedream will poll the IMAP server for new emails at this interval
Mailbox	`mailbox`	`string`	Select a value from the drop down menu.

Trigger Authentication#

IMAP uses API keys for authentication. When you connect your IMAP account, Pipedream securely stores the keys so you can easily authenticate to IMAP APIs in both code and no-code steps.

Below are the required fields to connect your IMAP account to Pipedream:

host: Enter the host Pipedream should connect to. Refer to your email provider's IMAP instructions if you aren't sure what to enter.
email: Enter the email address you use to sign in to the account you'd like to connect.
password: This is the password you use to sign in to your email account. Note: in order to connect a Gmail account, you must use an App Password.
port: Specify the port number, either 143 (default) or 993. Refer to your email provider's IMAP instructions if you aren't sure which to use.

For Gmail accounts, refer to these instructions.

About IMAP#

Connect Pipedream to any IMAP email provider to trigger custom workflows.

Action#

Send message on Discord Bot

Description:Send message to a user or a channel. [See the docs here](https://discord.com/developers/docs/resources/user#create-dm) and [here](https://discord.com/developers/docs/resources/channel#create-message)

Version:0.0.12

Key:discord_bot-send-message

View on GitHub

Discord Bot Overview#

The Discord Bot API unlocks the power to interact with Discord users and channels programmatically, making it possible to automate messages, manage servers, and integrate with other services. With Pipedream's serverless platform, you can create complex workflows that respond to events in Discord, process data, and trigger actions in other apps. This opens up opportunities for community engagement, content moderation, analytics, and more, without the overhead of managing infrastructure.

Action Code#

import { ConfigurationError } from "@pipedream/platform";
import common from "../../common.mjs";
import constants from "../../common/constants.mjs";
import utils from "../../common/utils.mjs";

const { discord } = common.props;

export default {
  key: "discord_bot-send-message",
  name: "Send message",
  description: "Send message to a user or a channel. [See the docs here](https://discord.com/developers/docs/resources/user#create-dm) and [here](https://discord.com/developers/docs/resources/channel#create-message)",
  version: "0.0.12",
  type: "action",
  props: {
    discord,
    ...common.props,
    message: {
      propDefinition: [
        discord,
        "message",
      ],
    },
    embeds: {
      propDefinition: [
        discord,
        "embeds",
      ],
    },
    threadID: {
      propDefinition: [
        discord,
        "threadID",
      ],
    },
    username: {
      propDefinition: [
        discord,
        "username",
      ],
    },
    avatarURL: {
      propDefinition: [
        discord,
        "avatarURL",
      ],
    },
    includeSentViaPipedream: {
      type: "boolean",
      optional: true,
      default: true,
      label: "Include link to workflow",
      description: "Defaults to `true`, includes a link to this workflow at the end of your Discord message.",
    },
    userId: {
      propDefinition: [
        discord,
        "userId",
        (c) => ({
          guildId: c.guildId,
        }),
      ],
      description: "Select either a user or a channel",
      optional: true,
    },
    channelId: {
      propDefinition: [
        discord,
        "channelId",
        ({ guildId }) => ({
          guildId,
          notAllowedChannels: constants.NOT_ALLOWED_CHANNELS,
        }),
      ],
      description: "Select either a channel or an user",
      optional: true,
    },
  },
  methods: {
    ...common.methods,
    getUserInputProps(omit = [
      "discord",
    ]) {
      return Object.keys(this)
        .filter((key) => typeof this[key] !== "function" && !omit.includes(key))
        .reduce((props, key) => {
          props[key] = this[key];
          return props;
        }, {});
    },
    appendPipedreamText(message) {
      let content = message;
      if (typeof content !== "string") {
        content = JSON.stringify(content);
      }
      content += `\n\n${this.getSentViaPipedreamText()}`;
      return content;
    },
    getSentViaPipedreamText() {
      const workflowId = process.env.PIPEDREAM_WORKFLOW_ID;
      // The link text is a URL without a protocol for consistency with the "Send via link" text in
      // Slack messages
      const linkText = `pipedream.com/@/${workflowId}?o=a&a=discord_webhook`;
      const link = `https://${linkText}`;
      return `Sent via [${linkText}](<${link}>)`;
    },
  },
  async run({ $ }) {
    if ((this.userId && this.channelId) || (!this.userId && !this.channelId)) {
      throw new ConfigurationError("You must select either a user or a channel.");
    }
    let channelId = this.channelId;
    if (this.userId) {
      const createDMChannelResponse = await this.discord.createDm({
        $,
        recipientId: this.userId,
      });
      channelId = createDMChannelResponse.id;
    }
    if (channelId) {
      const createMessageResponse = await this.discord.createMessage({
        $,
        channelId,
        data: {
          embeds: utils.parseObject(this.embeds),
          avatarURL: this.avatarURL,
          threadID: this.threadID,
          username: this.username,
          content: this.includeSentViaPipedream
            ? this.appendPipedreamText(this.message)
            : this.message,
        },
      });
      $.export("$summary", "Message has been sent successfully");
      return createMessageResponse;
    } else {
      $.export("$summary", "Could not create or retrieve DM channel!");
      throw new Error("Create DM Channel call was not successful!");
    }
  },
};

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
Discord Bot	`discord`	`app`	This component uses the Discord Bot app.
Guild	`guildId`	`string`	Select a value from the drop down menu.
Message	`message`	`string`	Enter a simple message up to 2000 characters. This is the most commonly used field. However, it's optional if you pass embed content.
Embeds	`embeds`	`any`	Embedded rich content (up to 6000 characters), this should be given as an array, e.g. `[{"title": "Hello, Embed!","description": "This is an embedded message."}]`. To pass data from another step, enter a reference using double curly brackets (e.g., `{{steps.mydata.$return_value}}`). Tip: Construct the `embeds` array in a Node.js code step, return it, and then pass the return value to this step.
Thread ID	`threadID`	`string`	If provided, the message will be posted to this thread
Username	`username`	`string`	Overrides the current username
Avatar URL	`avatarURL`	`string`	If used, it overrides the default avatar
Include link to workflow	`includeSentViaPipedream`	`boolean`	Defaults to `true`, includes a link to this workflow at the end of your Discord message.
User	`userId`	`string`	Select a value from the drop down menu.
Channel	`channelId`	`string`	Select a value from the drop down menu.

Action Authentication#

Discord Bot uses API keys for authentication. When you connect your Discord Bot account, Pipedream securely stores the keys so you can easily authenticate to Discord Bot APIs in both code and no-code steps.

This app allows you to use the Discord API using your own Discord bot. If you don't want to use a custom bot, and you just need to use the Discord API, exit this screen and use the Discord app, instead.

If you want to use your own Discord bot, but haven't created one yet, see these instructions or watch this video. You'll need to add this bot to your server(s) to make successful API requests.

Once you've created your bot, you'll find the Bot token within the Bot section of your app. Enter that token below.

About Discord Bot#

Use this app to interact with the Discord API using a bot in your account

More Ways to Connect Discord Bot + IMAP#

Other Popular Integrations#

Add Role with Discord Bot API on New Email from IMAP API

IMAP + Discord Bot

Send message with Discord Bot API on New Email from IMAP API

Pipedream makes it easy to connect APIs for Discord Bot, IMAP and 2,000+ other apps remarkably fast.

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

Developers ♥ Pipedream

1-24of2,000+apps by most popular

1
-
24
of
2,000+
apps by most popular