# imAPI — MCP Email Bridge (IMAP + SMTP) (`saipeon_won/imapi`) Actor

Search/fetch/manage email over IMAP and send/reply over SMTP. Built for MCP and automation workflows with BYO credentials and usage counters.

- **URL**: https://apify.com/saipeon\_won/imapi.md
- **Developed by:** [Juan Won](https://apify.com/saipeon_won) (community)
- **Categories:** Business, Developer tools
- **Stats:** 7 total users, 2 monthly users, 100.0% runs succeeded, NaN bookmarks
- **User rating**: No ratings yet

## Pricing

Pay per usage

This Actor is paid per platform usage. The Actor is free to use, and you only pay for the Apify platform usage, which gets cheaper the higher subscription plan you have.

Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-usage

## What's an Apify Actor?

Actors are a software tools running on the Apify platform, for all kinds of web data extraction and automation use cases.
In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours,
and optionally produces a well-defined JSON output, datasets with results, or files in key-value store.
In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server.
Actors are written with capital "A".

## How to integrate an Actor?

If asked about integration, you help developers integrate Actors into their projects.
You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready.
The best way to integrate Actors is as follows.

In JavaScript/TypeScript projects, use official [JavaScript/TypeScript client](https://docs.apify.com/api/client/js.md):

```bash
npm install apify-client
```

In Python projects, use official [Python client library](https://docs.apify.com/api/client/python.md):

```bash
pip install apify-client
```

In shell scripts, use [Apify CLI](https://docs.apify.com/cli/docs.md):

````bash
# MacOS / Linux
curl -fsSL https://apify.com/install-cli.sh | bash
# Windows
irm https://apify.com/install-cli.ps1 | iex
```bash

In AI frameworks, you might use the [Apify MCP server](https://docs.apify.com/platform/integrations/mcp.md).

If your project is in a different language, use the [REST API](https://docs.apify.com/api/v2.md).

For usage examples, see the [API](#api) section below.

For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt).


# README

## imAPI

**IMAP + SMTP bridge for MCP/automation workflows.**

Use it to search, fetch, and manage email over IMAP, then send/reply over SMTP — with secrets-based auth and usage counters for billing.

### Why imAPI

- One tool for both **read** (IMAP) and **send** (SMTP)
- Built for MCP/tooling workflows
- Bring-your-own mailbox credentials (no shared account lock-in)
- Returns usage counters in output (`imapTouches`, `smtpRecipients`)

### Actions

- `imap.list_folders`
- `imap.search`
- `imap.fetch`
- `imap.mark_read`
- `smtp.send`
- `smtp.reply`

---

### Quickstart (production-safe)

Use `accountRef` + env secrets (recommended), not raw credentials in run input.

#### 1) Configure account secrets

##### Recommended: per-field env vars (most reliable in Apify UI)
For `accountRef = main`:

- `IMAPI_MAIN_IMAP_HOST`, `IMAPI_MAIN_IMAP_PORT`, `IMAPI_MAIN_IMAP_SECURE`, `IMAPI_MAIN_IMAP_USER`, `IMAPI_MAIN_IMAP_PASSWORD`
- `IMAPI_MAIN_SMTP_HOST`, `IMAPI_MAIN_SMTP_PORT`, `IMAPI_MAIN_SMTP_SECURE`, `IMAPI_MAIN_SMTP_USER`, `IMAPI_MAIN_SMTP_PASSWORD`

(Also supports fallback `IMAPI_IMAP_*` / `IMAPI_SMTP_*` for `main`.)

##### Optional: single JSON env var
`IMAPI_ACCOUNTS_JSON` is supported by code, but some users may find per-field env vars easier/more predictable in Apify Console.

```json
{
  "main": {
    "imap": {
      "host": "imap.purelymail.com",
      "port": 993,
      "secure": true,
      "user": "you@example.com",
      "password": "..."
    },
    "smtp": {
      "host": "smtp.purelymail.com",
      "port": 465,
      "secure": true,
      "user": "you@example.com",
      "password": "..."
    }
  }
}
````

#### 2) Run actions

##### Search inbox

```json
{
  "action": "imap.search",
  "accountRef": "main",
  "query": {
    "folder": "INBOX",
    "unseen": true,
    "subject": "invoice",
    "limit": 20
  }
}
```

##### Fetch one message

```json
{
  "action": "imap.fetch",
  "accountRef": "main",
  "folder": "INBOX",
  "uids": [12345]
}
```

##### Send email

```json
{
  "action": "smtp.send",
  "accountRef": "main",
  "message": {
    "to": "team@example.com",
    "subject": "Status update",
    "text": "Hello from imAPI"
  }
}
```

##### Dry run (no send)

```json
{
  "action": "smtp.send",
  "accountRef": "main",
  "dryRun": true,
  "message": {
    "to": "team@example.com",
    "subject": "Test",
    "text": "Preview only"
  }
}
```

***

### Output shape

Successful output includes action result + usage counters:

```json
{
  "ok": true,
  "data": { "...": "action result" },
  "usage": {
    "imapTouches": 1,
    "smtpRecipients": 0
  }
}
```

Error output:

```json
{
  "ok": false,
  "error": {
    "code": "INVALID_INPUT",
    "message": "uids are required"
  }
}
```

***

### Safety and limits

Optional env controls:

- `IMAPI_MAX_SMTP_RECIPIENTS_PER_RUN` (default `200`)
- `IMAPI_ALLOWED_RECIPIENT_DOMAINS` (comma-separated allowlist)

#### BYO credentials

imAPI users should always provide **their own** mailbox credentials via their own secrets/env vars.

***

### Local development

```bash
npm i
npm run build
npm run test:live
```

# Actor input Schema

## `action` (type: `string`):

Which imAPI action to execute.

## `accountRef` (type: `string`):

Named account profile to resolve from secrets/env (e.g. main, support).

## `imapAccount` (type: `object`):

Direct IMAP credentials. Prefer accountRef + secrets in production.

## `smtpAccount` (type: `object`):

Direct SMTP credentials. Prefer accountRef + secrets in production.

## `query` (type: `object`):

IMAP query object such as folder/from/subject/unseen/limit.

## `uids` (type: `array`):

Message UIDs for fetch/mark\_read actions.

## `folder` (type: `string`):

Mailbox folder path (defaults to INBOX).

## `message` (type: `object`):

Message payload for smtp.send/smtp.reply.

## `dryRun` (type: `boolean`):

If true for smtp actions, validates and returns preview without sending.

## Actor input object example

```json
{
  "action": "imap.search",
  "accountRef": "main",
  "folder": "INBOX",
  "dryRun": false
}
```

# Actor output Schema

## `ok` (type: `string`):

No description

## `imapTouches` (type: `string`):

No description

## `smtpRecipients` (type: `string`):

No description

## `errorCode` (type: `string`):

No description

## `errorMessage` (type: `string`):

No description

# API

You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup.

## JavaScript example

```javascript
import { ApifyClient } from 'apify-client';

// Initialize the ApifyClient with your Apify API token
// Replace the '<YOUR_API_TOKEN>' with your token
const client = new ApifyClient({
    token: '<YOUR_API_TOKEN>',
});

// Prepare Actor input
const input = {
    "action": "imap.search",
    "accountRef": "main"
};

// Run the Actor and wait for it to finish
const run = await client.actor("saipeon_won/imapi").call(input);

// Fetch and print Actor results from the run's dataset (if any)
console.log('Results from dataset');
console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`);
const { items } = await client.dataset(run.defaultDatasetId).listItems();
items.forEach((item) => {
    console.dir(item);
});

// 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs

```

## Python example

```python
from apify_client import ApifyClient

# Initialize the ApifyClient with your Apify API token
# Replace '<YOUR_API_TOKEN>' with your token.
client = ApifyClient("<YOUR_API_TOKEN>")

# Prepare the Actor input
run_input = {
    "action": "imap.search",
    "accountRef": "main",
}

# Run the Actor and wait for it to finish
run = client.actor("saipeon_won/imapi").call(run_input=run_input)

# Fetch and print Actor results from the run's dataset (if there are any)
print("💾 Check your data here: https://console.apify.com/storage/datasets/" + run["defaultDatasetId"])
for item in client.dataset(run["defaultDatasetId"]).iterate_items():
    print(item)

# 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start

```

## CLI example

```bash
echo '{
  "action": "imap.search",
  "accountRef": "main"
}' |
apify call saipeon_won/imapi --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "command": "npx",
            "args": [
                "mcp-remote",
                "https://mcp.apify.com/?tools=saipeon_won/imapi",
                "--header",
                "Authorization: Bearer <YOUR_API_TOKEN>"
            ]
        }
    }
}

```

## OpenAPI specification

```json
{
    "openapi": "3.0.1",
    "info": {
        "title": "imAPI — MCP Email Bridge (IMAP + SMTP)",
        "description": "Search/fetch/manage email over IMAP and send/reply over SMTP. Built for MCP and automation workflows with BYO credentials and usage counters.",
        "version": "0.1",
        "x-build-id": "5LnPvS5ZuiQ9wgZSK"
    },
    "servers": [
        {
            "url": "https://api.apify.com/v2"
        }
    ],
    "paths": {
        "/acts/saipeon_won~imapi/run-sync-get-dataset-items": {
            "post": {
                "operationId": "run-sync-get-dataset-items-saipeon_won-imapi",
                "x-openai-isConsequential": false,
                "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.",
                "tags": [
                    "Run Actor"
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/inputSchema"
                            }
                        }
                    }
                },
                "parameters": [
                    {
                        "name": "token",
                        "in": "query",
                        "required": true,
                        "schema": {
                            "type": "string"
                        },
                        "description": "Enter your Apify token here"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "OK"
                    }
                }
            }
        },
        "/acts/saipeon_won~imapi/runs": {
            "post": {
                "operationId": "runs-sync-saipeon_won-imapi",
                "x-openai-isConsequential": false,
                "summary": "Executes an Actor and returns information about the initiated run in response.",
                "tags": [
                    "Run Actor"
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/inputSchema"
                            }
                        }
                    }
                },
                "parameters": [
                    {
                        "name": "token",
                        "in": "query",
                        "required": true,
                        "schema": {
                            "type": "string"
                        },
                        "description": "Enter your Apify token here"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "OK",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/runsResponseSchema"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/acts/saipeon_won~imapi/run-sync": {
            "post": {
                "operationId": "run-sync-saipeon_won-imapi",
                "x-openai-isConsequential": false,
                "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.",
                "tags": [
                    "Run Actor"
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/inputSchema"
                            }
                        }
                    }
                },
                "parameters": [
                    {
                        "name": "token",
                        "in": "query",
                        "required": true,
                        "schema": {
                            "type": "string"
                        },
                        "description": "Enter your Apify token here"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "OK"
                    }
                }
            }
        }
    },
    "components": {
        "schemas": {
            "inputSchema": {
                "type": "object",
                "required": [
                    "action"
                ],
                "properties": {
                    "action": {
                        "title": "Action",
                        "enum": [
                            "imap.list_folders",
                            "imap.search",
                            "imap.fetch",
                            "imap.mark_read",
                            "smtp.send",
                            "smtp.reply"
                        ],
                        "type": "string",
                        "description": "Which imAPI action to execute."
                    },
                    "accountRef": {
                        "title": "Account reference",
                        "type": "string",
                        "description": "Named account profile to resolve from secrets/env (e.g. main, support)."
                    },
                    "imapAccount": {
                        "title": "IMAP account (dev/direct)",
                        "type": "object",
                        "description": "Direct IMAP credentials. Prefer accountRef + secrets in production."
                    },
                    "smtpAccount": {
                        "title": "SMTP account (dev/direct)",
                        "type": "object",
                        "description": "Direct SMTP credentials. Prefer accountRef + secrets in production."
                    },
                    "query": {
                        "title": "Search query",
                        "type": "object",
                        "description": "IMAP query object such as folder/from/subject/unseen/limit."
                    },
                    "uids": {
                        "title": "UIDs",
                        "type": "array",
                        "description": "Message UIDs for fetch/mark_read actions.",
                        "items": {
                            "type": "integer"
                        }
                    },
                    "folder": {
                        "title": "Folder",
                        "type": "string",
                        "description": "Mailbox folder path (defaults to INBOX).",
                        "default": "INBOX"
                    },
                    "message": {
                        "title": "SMTP message",
                        "type": "object",
                        "description": "Message payload for smtp.send/smtp.reply."
                    },
                    "dryRun": {
                        "title": "Dry run",
                        "type": "boolean",
                        "description": "If true for smtp actions, validates and returns preview without sending.",
                        "default": false
                    }
                }
            },
            "runsResponseSchema": {
                "type": "object",
                "properties": {
                    "data": {
                        "type": "object",
                        "properties": {
                            "id": {
                                "type": "string"
                            },
                            "actId": {
                                "type": "string"
                            },
                            "userId": {
                                "type": "string"
                            },
                            "startedAt": {
                                "type": "string",
                                "format": "date-time",
                                "example": "2025-01-08T00:00:00.000Z"
                            },
                            "finishedAt": {
                                "type": "string",
                                "format": "date-time",
                                "example": "2025-01-08T00:00:00.000Z"
                            },
                            "status": {
                                "type": "string",
                                "example": "READY"
                            },
                            "meta": {
                                "type": "object",
                                "properties": {
                                    "origin": {
                                        "type": "string",
                                        "example": "API"
                                    },
                                    "userAgent": {
                                        "type": "string"
                                    }
                                }
                            },
                            "stats": {
                                "type": "object",
                                "properties": {
                                    "inputBodyLen": {
                                        "type": "integer",
                                        "example": 2000
                                    },
                                    "rebootCount": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "restartCount": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "resurrectCount": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "computeUnits": {
                                        "type": "integer",
                                        "example": 0
                                    }
                                }
                            },
                            "options": {
                                "type": "object",
                                "properties": {
                                    "build": {
                                        "type": "string",
                                        "example": "latest"
                                    },
                                    "timeoutSecs": {
                                        "type": "integer",
                                        "example": 300
                                    },
                                    "memoryMbytes": {
                                        "type": "integer",
                                        "example": 1024
                                    },
                                    "diskMbytes": {
                                        "type": "integer",
                                        "example": 2048
                                    }
                                }
                            },
                            "buildId": {
                                "type": "string"
                            },
                            "defaultKeyValueStoreId": {
                                "type": "string"
                            },
                            "defaultDatasetId": {
                                "type": "string"
                            },
                            "defaultRequestQueueId": {
                                "type": "string"
                            },
                            "buildNumber": {
                                "type": "string",
                                "example": "1.0.0"
                            },
                            "containerUrl": {
                                "type": "string"
                            },
                            "usage": {
                                "type": "object",
                                "properties": {
                                    "ACTOR_COMPUTE_UNITS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATASET_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATASET_WRITES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "KEY_VALUE_STORE_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "KEY_VALUE_STORE_WRITES": {
                                        "type": "integer",
                                        "example": 1
                                    },
                                    "KEY_VALUE_STORE_LISTS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "REQUEST_QUEUE_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "REQUEST_QUEUE_WRITES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATA_TRANSFER_INTERNAL_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATA_TRANSFER_EXTERNAL_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "PROXY_SERPS": {
                                        "type": "integer",
                                        "example": 0
                                    }
                                }
                            },
                            "usageTotalUsd": {
                                "type": "number",
                                "example": 0.00005
                            },
                            "usageUsd": {
                                "type": "object",
                                "properties": {
                                    "ACTOR_COMPUTE_UNITS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATASET_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATASET_WRITES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "KEY_VALUE_STORE_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "KEY_VALUE_STORE_WRITES": {
                                        "type": "number",
                                        "example": 0.00005
                                    },
                                    "KEY_VALUE_STORE_LISTS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "REQUEST_QUEUE_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "REQUEST_QUEUE_WRITES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATA_TRANSFER_INTERNAL_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATA_TRANSFER_EXTERNAL_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "PROXY_SERPS": {
                                        "type": "integer",
                                        "example": 0
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}
```