CONNECT APP
Build with IMAP
Connect to any IMAP email provider
Communication
- API key
MCP
Give your agent IMAP tools
Every IMAP action is exposed as an MCP tool on Pipedream's remote server. Point a client at it with your end user's ID and Connect resolves that user's IMAP account for each tool call — you store no tokens.
// accessToken: mint a short-lived token with the Connect SDK — see the MCP guide
const transport = new StreamableHTTPClientTransport(
new URL("https://remote.mcp.pipedream.net/v3"),
{
requestInit: {
headers: {
Authorization: `Bearer ${accessToken}`,
"x-pd-project-id": "{project_id}",
"x-pd-environment": "production",
"x-pd-external-user-id": "{external_user_id}", // any stable ID for this user in your system
"x-pd-app-slug": "imap",
},
},
},
)
const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)
const { tools } = await mcp.listTools()
// e.g. run List Mailbox Options:
const result = await mcp.callTool({
name: "imap-list-mailbox-options",
arguments: {},
})# access_token: mint a short-lived token with the Connect SDK — see the MCP guide
headers = {
"Authorization": f"Bearer {access_token}",
"x-pd-project-id": "{project_id}",
"x-pd-environment": "production",
"x-pd-external-user-id": "{external_user_id}", # any stable ID for this user in your system
"x-pd-app-slug": "imap",
}
async with streamablehttp_client("https://remote.mcp.pipedream.net/v3", headers=headers) as (read, write, _):
async with ClientSession(read, write) as session:
await session.initialize()
tools = await session.list_tools()
# e.g. run List Mailbox Options:
result = await session.call_tool("imap-list-mailbox-options", {})SDK
Run IMAP actions from your backend
Connect a user's IMAP account once, then run List Mailbox Options on their behalf from your own code — TypeScript, Python, or plain HTTP.
import { PipedreamClient } from "@pipedream/sdk"
const pd = new PipedreamClient({
projectId: process.env.PIPEDREAM_PROJECT_ID!,
clientId: process.env.PIPEDREAM_CLIENT_ID!,
clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
projectEnvironment: "production",
})
const result = await pd.actions.run({
id: "imap-list-mailbox-options",
externalUserId: "{external_user_id}", // any stable ID for this user in your system
configuredProps: {
imap: { authProvisionId: "apn_xxxxxxx" },
},
})from pipedream import Pipedream
pd = Pipedream(
client_id="{oauth_client_id}",
client_secret="{oauth_client_secret}",
project_id="{project_id}",
project_environment="production",
)
result = pd.actions.run(
id="imap-list-mailbox-options",
external_user_id="{external_user_id}", # any stable ID for this user in your system
configured_props={
"imap": {"authProvisionId": "apn_xxxxxxx"},
},
)curl -X POST https://api.pipedream.com/v1/connect/{project_id}/actions/run \
-H "Content-Type: application/json" \
-H "X-PD-Environment: production" \
-H "Authorization: Bearer {access_token}" \
-d '{
"external_user_id": "{external_user_id}",
"id": "imap-list-mailbox-options",
"configured_props": {
"imap": { "authProvisionId": "apn_xxxxxxx" }
}
}'TOOLS
IMAP actions
On-demand operations your product or agent can configure and run on behalf of a connected user.
MULTI-APP
Use IMAP with other popular apps
Most products don't stop at one integration. Pair IMAP with the other apps your users rely on, and ship use cases that span both.
- App slug
- imap
- Authentication
- API key
- Categories
- Communication
- Actions
- 1
- Triggers
- 1
- API proxy
- Not available