IMAP

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

Go to site

IMAP API Integrations

Build and run workflows using the IMAP API. Use 1000s of source-available triggers and actions across 1000+ apps. Or write custom code to integrate any app or API in seconds.

Overview

The Internet Message Access Protocol (IMAP) is a mail protocol used for accessing email on a remote web server.

IMAP provides a way to access email stored on a server, allowing you to read, write, and delete emails from your account.

IMAP is a popular protocol for accessing email, and is supported by most email providers.

Here are some things you can build using the IMAP API:

  • A web-based email client
  • A desktop email client
  • A mobile email client
  • A command-line email client
  • A script to automatically delete old emails
  • A script to automatically forward emails to another address
  • A script to automatically save attachments to your computer
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
import { once } from "events";
import imaps from "imap-simple";
import cycle from "cycle";

export default defineComponent({
  props: {
    imap: {
      type: "app",
      app: "imap",
    }
  },
  async run({steps, $}) {
    const { host, port, email, password } = this.imap.$auth;

    const connection = await imaps.connect({
      imap: {
        host,
        port,
        user: email,
        password,
        tls: true,
        tlsOptions: { servername: host },
        authTimeout: 3000
      },
    });

    const boxes = await connection.getBoxes();
    // Filter out circular references to parents
    const filteredBoxes = cycle.decycle(boxes);
    $.export("results", filteredBoxes);

    connection.end();
    await once(connection.imap, "end");
  },
})
Send Message (Advanced) with Discord Webhook API on New Email from IMAP API
IMAP + Discord Webhook
 
Try it
Get Film with SWAPI - Star Wars API on New Email from IMAP API
IMAP + SWAPI - Star Wars
 
Try it
Delete Record with Airtable API on New Email from IMAP API
IMAP + Airtable
 
Try it
Custom Request with HTTP / Webhook API on New Email from IMAP API
IMAP + HTTP / Webhook
 
Try it
Create Image with OpenAI (ChatGPT) API on New Email from IMAP API
IMAP + OpenAI (ChatGPT)
 
Try it
New Email from the IMAP API

Emit new event for each new email in a mailbox

 
Try it

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.