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 2,000+ 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");
  },
})

Choose an API to Connect with IMAP API

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

HTTP / Webhook
HTTP / Webhook
Get a unique URL where you can send HTTP or webhook requests
Notion
Notion
Notion is a new tool that blends your everyday work apps into one. It's the all-in-one workspace for you and your team.
OpenAI (ChatGPT)
OpenAI (ChatGPT)
OpenAI is an AI research and deployment company with the mission to ensure that artificial general intelligence benefits all of humanity. They are the makers of popular models like ChatGPT, DALL-E, and Whisper.
Schedule
Schedule
Trigger workflows on an interval or cron schedule.
Google Drive
Google Drive
Google Drive is a file storage and synchronization service which allows you to create and share your work online, and access your documents from anywhere.
Google Sheets
Google Sheets
Use Google Sheets to create and edit online spreadsheets. Get insights together with secure sharing in real-time and from any device.
Filter
Filter
Specify a condition that your workflow must meet and whether you'd like to proceed or end workflow execution.
Python
Python
Anything you can do in Python can be done in a Pipedream Workflow. This includes using any of the 350,000+ PyPi packages available in your Python powered workflows.
Slack
Slack
Slack is a channel-based messaging platform. With Slack, people can work together more effectively, connect all their software tools and services, and find the information they need to do their best work — all within a secure, enterprise-grade environment.
Data Stores
Data Stores
Use Pipedream Data Stores to manage state throughout your workflows.
GitHub
GitHub
Where the world builds software. Millions of developers and companies build, ship, and maintain their software on GitHub—the largest and most advanced development platform in the world.
Formatting
Formatting
Pre-built actions to make formatting and manipulating data within your workflows easier.
Node
Node
Anything you can do with Node.js, you can do in a Pipedream workflow. This includes using most of npm's 400,000+ packages.
Airtable (OAuth)
Airtable (OAuth)
Airtable is a low-code platform to build next-gen apps. Move beyond rigid tools, operationalize your critical data, and reimagine workflows with AI.
Zoom
Zoom
Zoom is the leader in modern enterprise video communications, with an easy, reliable cloud platform for video and audio conferencing, chat, and webinars.
Google Calendar
Google Calendar
With Google Calendar, you can quickly schedule meetings and events and get reminders about upcoming activities, so you always know what’s next.
Gmail
Gmail
Gmail offers private and secure email by Google at no cost, for business and consumer accounts.
Gmail (Developer App)
Gmail (Developer App)
Private and secure email by Google at no cost, for business and consumer accounts. Use this app to connect your own developer account credentials.
Email
Email
Trigger workflows on new emails, and send emails to yourself as part of a Pipedream workflow.
Delay
Delay
Delay, pause, suspend, or have the execution of your workflow wait for as little as one millisecond, or as long as one year.
Go
Go
Anything you can do in Go, you can do in a Pipedream Workflow. You can use any of Go packages available with a simple import.
Premium
Zoom Admin
Zoom Admin
Video conferencing (includes account-level scopes) for Zoom Admins.
Twilio
Twilio
Twilio is a cloud communications platform for building SMS, Voice & Messaging applications on an API built for global scale.
Bash
Bash
Run any Bash in a Pipedream step within your workflow, including making curl requests.
Merge RSS Feeds with RSS API on New Email from IMAP API
IMAP + RSS
 
Try it
Custom Request with HTTP / Webhook API on New Email from IMAP API
IMAP + HTTP / Webhook
 
Try it
Send new message with Front API on New Email from IMAP API
IMAP + Front
 
Try it
Upsert Row with Supabase API on New Email from IMAP API
IMAP + Supabase
 
Try it
Create Column with monday.com API on New Email from IMAP API
IMAP + monday.com
 
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.