Send Email From Template with Mailersend API on New Email from IMAP API

Pipedream makes it easy to connect APIs for Mailersend, IMAP and 2,500+ other apps remarkably fast.

Trigger workflow on

New Email from the IMAP API

Next, do this

Send Email From Template with the Mailersend 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 IMAP trigger and Mailersend 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 Email From Template action
1. Connect your Mailersend account
2. Configure From Email
3. Configure From Name
4. Configure To Email
5. Optional- Configure To Name
6. Configure Subject
7. Select a Domain ID
8. Select a Template ID
9. Optional- Configure Variables Substitutions
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.5

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.5",
  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 Email From Template on Mailersend

Description:This action sends a personalized e-mail to the specified recipient using templates. [See the documentation](https://developers.mailersend.com/api/v1/email.html#send-an-email)

Version:0.0.1

Key:mailersend-send-email-from-template

View on GitHub

Mailersend Overview#

The MailerSend API integrates with Pipedream to create powerful email automation workflows, enabling you to send transactional emails, create and manage templates, and track email activities like opens or clicks. With these capabilities, you can automate routine communications, personalize mass mailings based on user actions or data, and gain insights into your email campaign performances, all within the context of a serverless Pipedream workflow.

Action Code#

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

export default {
  key: "mailersend-send-email-from-template",
  name: "Send Email From Template",
  description: "This action sends a personalized e-mail to the specified recipient using templates. [See the documentation](https://developers.mailersend.com/api/v1/email.html#send-an-email)",
  version: "0.0.1",
  type: "action",
  props: {
    app,
    fromEmail: {
      propDefinition: [
        app,
        "fromEmail",
      ],
    },
    fromName: {
      propDefinition: [
        app,
        "fromName",
      ],
    },
    toEmail: {
      propDefinition: [
        app,
        "toEmail",
      ],
    },
    toName: {
      propDefinition: [
        app,
        "toName",
      ],
    },
    subject: {
      propDefinition: [
        app,
        "subject",
      ],
    },
    domainId: {
      propDefinition: [
        app,
        "domainId",
      ],
    },
    templateId: {
      propDefinition: [
        app,
        "templateId",
        ({ domainId }) => ({
          domainId,
        }),
      ],
    },
    substitutions: {
      propDefinition: [
        app,
        "substitutions",
      ],
    },
  },
  async run({ $ }) {
    const {
      fromEmail,
      fromName,
      toEmail,
      toName,
      subject,
      templateId,
      substitutions,
    } = this;

    const variables = this.app.parseVariables(toEmail, substitutions);

    const response = await this.app.sendEmail({
      fromEmail,
      fromName,
      toEmail,
      toName,
      subject,
      templateId,
      variables,
    });
    $.export("$summary", `Email successfully sent to ${toEmail}`);
    return response;
  },
};

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
Mailersend	`app`	`app`	This component uses the Mailersend app.
From Email	`fromEmail`	`string`	The 'From' email address used to deliver the message. This address should be a verified sender in your MailerSend account.
From Name	`fromName`	`string`	A name or title associated with the sending email address.
To Email	`toEmail`	`string`	The intended recipient's email address.
To Name	`toName`	`string`	The intended recipient's name.
Subject	`subject`	`string`	The email subject.
Domain ID	`domainId`	`string`	Select a value from the drop down menu.
Template ID	`templateId`	`string`	Select a value from the drop down menu.
Variables Substitutions	`substitutions`	`object`	Dynamic variables that should be replaced on the email. e.g: `{ "company": "MailerSend" }`.