IMAP
Connect Pipedream to any IMAP email provider to trigger custom workflows.
Integrate the IMAP API with the Formatting API
Setup the IMAP API trigger to run a workflow which integrates with the Formatting API. Pipedream's integration platform allows you to integrate IMAP and Formatting remarkably fast. Free for developers.
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");
},
})Connect Formatting#
1
2
3
4
5
6
export default defineComponent({
async run({ steps, $ }) {
const text = ' Hello world! ';
return text.trim()
},
})