IMAP

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

Integrate the IMAP API with the Data Stores API

Setup the IMAP API trigger to run a workflow which integrates with the Data Stores API. Pipedream's integration platform allows you to integrate IMAP and Data Stores remarkably fast. Free for developers.

Add or update a single record with Data Stores API on New Email from IMAP API
IMAP + Data Stores
 
Try it
Add or update multiple records with Data Stores API on New Email from IMAP API
IMAP + Data Stores
 
Try it
Append to record with Data Stores API on New Email from IMAP API
IMAP + Data Stores
 
Try it
Delete a single record with Data Stores API on New Email from IMAP API
IMAP + Data Stores
 
Try it
Delete All Records with Data Stores API on New Email from IMAP API
IMAP + Data Stores
 
Try it
New Email from the IMAP API

Emit new event for each new email in a mailbox

 
Try it
Add or update a single record with the Data Stores API

Add or update a single record in your Pipedream Data Store.

 
Try it
Add or update multiple records with the Data Stores API

Add or update multiple records to your Pipedream Data Store.

 
Try it
Append to record with the Data Stores API

Append to a record in your data store Pipedream Data Store. If the record does not exist, a new record will be created in an array format.

 
Try it
Check for existence of key with the Data Stores API

Check if a key exists in your Pipedream Data Store or create one if it doesn't exist.

 
Try it
Delete a single record with the Data Stores API

Delete a single record in your Pipedream Data Store.

 
Try it

Overview of IMAP

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

Connect IMAP

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

Overview of Data Stores

With the Data Stores API, you can build applications that:

  • Store data for later retrieval
  • Retrieve data from a store
  • Update data in a store
  • Delete data from a store

Connect Data Stores

1
2
3
4
5
6
7
8
9
10
11
export default defineComponent({
  props: {
    myDataStore: {
      type: "data_store",
    },
  },
  async run({ steps, $ }) {
    await this.myDataStore.set("key_here","Any serializable JSON as the value")
    return await this.myDataStore.get("key_here")
  },
})