mcp-email-server


Namemcp-email-server JSON
Version 0.2.2 PyPI version JSON
download
home_pageNone
SummaryIMAP and SMTP via MCP Server
upload_time2025-10-24 03:15:00
maintainerNone
docs_urlNone
authorNone
requires_python<4.0,>=3.10
licenseNone
keywords imap mcp smtp email
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # mcp-email-server

[![Release](https://img.shields.io/github/v/release/ai-zerolab/mcp-email-server)](https://img.shields.io/github/v/release/ai-zerolab/mcp-email-server)
[![Build status](https://img.shields.io/github/actions/workflow/status/ai-zerolab/mcp-email-server/main.yml?branch=main)](https://github.com/ai-zerolab/mcp-email-server/actions/workflows/main.yml?query=branch%3Amain)
[![codecov](https://codecov.io/gh/ai-zerolab/mcp-email-server/branch/main/graph/badge.svg)](https://codecov.io/gh/ai-zerolab/mcp-email-server)
[![Commit activity](https://img.shields.io/github/commit-activity/m/ai-zerolab/mcp-email-server)](https://img.shields.io/github/commit-activity/m/ai-zerolab/mcp-email-server)
[![License](https://img.shields.io/github/license/ai-zerolab/mcp-email-server)](https://img.shields.io/github/license/ai-zerolab/mcp-email-server)
[![smithery badge](https://smithery.ai/badge/@ai-zerolab/mcp-email-server)](https://smithery.ai/server/@ai-zerolab/mcp-email-server)

IMAP and SMTP via MCP Server

- **Github repository**: <https://github.com/ai-zerolab/mcp-email-server/>
- **Documentation** <https://ai-zerolab.github.io/mcp-email-server/>

## Installation

### Manual Installation

We recommend using [uv](https://github.com/astral-sh/uv) to manage your environment.

Try `uvx mcp-email-server@latest ui` to config, and use following configuration for mcp client:

```json
{
  "mcpServers": {
    "zerolib-email": {
      "command": "uvx",
      "args": ["mcp-email-server@latest", "stdio"]
    }
  }
}
```

This package is available on PyPI, so you can install it using `pip install mcp-email-server`

After that, configure your email server using the ui: `mcp-email-server ui`

### Environment Variable Configuration

You can also configure the email server using environment variables, which is particularly useful for CI/CD environments like Jenkins. zerolib-email supports both UI configuration (via TOML file) and environment variables, with environment variables taking precedence.

```json
{
  "mcpServers": {
    "zerolib-email": {
      "command": "uvx",
      "args": ["mcp-email-server@latest", "stdio"],
      "env": {
        "MCP_EMAIL_SERVER_ACCOUNT_NAME": "work",
        "MCP_EMAIL_SERVER_FULL_NAME": "John Doe",
        "MCP_EMAIL_SERVER_EMAIL_ADDRESS": "john@example.com",
        "MCP_EMAIL_SERVER_USER_NAME": "john@example.com",
        "MCP_EMAIL_SERVER_PASSWORD": "your_password",
        "MCP_EMAIL_SERVER_IMAP_HOST": "imap.gmail.com",
        "MCP_EMAIL_SERVER_IMAP_PORT": "993",
        "MCP_EMAIL_SERVER_SMTP_HOST": "smtp.gmail.com",
        "MCP_EMAIL_SERVER_SMTP_PORT": "465"
      }
    }
  }
}
```

#### Available Environment Variables

| Variable                          | Description        | Default       | Required |
| --------------------------------- | ------------------ | ------------- | -------- |
| `MCP_EMAIL_SERVER_ACCOUNT_NAME`   | Account identifier | `"default"`   | No       |
| `MCP_EMAIL_SERVER_FULL_NAME`      | Display name       | Email prefix  | No       |
| `MCP_EMAIL_SERVER_EMAIL_ADDRESS`  | Email address      | -             | Yes      |
| `MCP_EMAIL_SERVER_USER_NAME`      | Login username     | Same as email | No       |
| `MCP_EMAIL_SERVER_PASSWORD`       | Email password     | -             | Yes      |
| `MCP_EMAIL_SERVER_IMAP_HOST`      | IMAP server host   | -             | Yes      |
| `MCP_EMAIL_SERVER_IMAP_PORT`      | IMAP server port   | `993`         | No       |
| `MCP_EMAIL_SERVER_IMAP_SSL`       | Enable IMAP SSL    | `true`        | No       |
| `MCP_EMAIL_SERVER_SMTP_HOST`      | SMTP server host   | -             | Yes      |
| `MCP_EMAIL_SERVER_SMTP_PORT`      | SMTP server port   | `465`         | No       |
| `MCP_EMAIL_SERVER_SMTP_SSL`       | Enable SMTP SSL    | `true`        | No       |
| `MCP_EMAIL_SERVER_SMTP_START_SSL` | Enable STARTTLS    | `false`       | No       |

For separate IMAP/SMTP credentials, you can also use:

- `MCP_EMAIL_SERVER_IMAP_USER_NAME` / `MCP_EMAIL_SERVER_IMAP_PASSWORD`
- `MCP_EMAIL_SERVER_SMTP_USER_NAME` / `MCP_EMAIL_SERVER_SMTP_PASSWORD`

Then you can try it in [Claude Desktop](https://claude.ai/download). If you want to intergrate it with other mcp client, run `$which mcp-email-server` for the path and configure it in your client like:

```json
{
  "mcpServers": {
    "zerolib-email": {
      "command": "{{ ENTRYPOINT }}",
      "args": ["stdio"]
    }
  }
}
```

If `docker` is avaliable, you can try use docker image, but you may need to config it in your client using `tools` via `MCP`. The default config path is `~/.config/zerolib/mcp_email_server/config.toml`

```json
{
  "mcpServers": {
    "zerolib-email": {
      "command": "docker",
      "args": ["run", "-it", "ghcr.io/ai-zerolab/mcp-email-server:latest"]
    }
  }
}
```

### Installing via Smithery

To install Email Server for Claude Desktop automatically via [Smithery](https://smithery.ai/server/@ai-zerolab/mcp-email-server):

```bash
npx -y @smithery/cli install @ai-zerolab/mcp-email-server --client claude
```

## Development

This project is managed using [uv](https://github.com/ai-zerolab/uv).

Try `make install` to install the virtual environment and install the pre-commit hooks.

Use `uv run mcp-email-server` for local development.

## Releasing a new version

- Create an API Token on [PyPI](https://pypi.org/).
- Add the API Token to your projects secrets with the name `PYPI_TOKEN` by visiting [this page](https://github.com/ai-zerolab/mcp-email-server/settings/secrets/actions/new).
- Create a [new release](https://github.com/ai-zerolab/mcp-email-server/releases/new) on Github.
- Create a new tag in the form `*.*.*`.

For more details, see [here](https://fpgmaas.github.io/cookiecutter-uv/features/cicd/#how-to-trigger-a-release).

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "mcp-email-server",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<4.0,>=3.10",
    "maintainer_email": null,
    "keywords": "IMAP, MCP, SMTP, email",
    "author": null,
    "author_email": "ai-zerolab <jizhongsheng957@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/89/ec/29251a2b37c9f5b3e76cb36b35bb664901a7cc6ad7ebe9fc917128361029/mcp_email_server-0.2.2.tar.gz",
    "platform": null,
    "description": "# mcp-email-server\n\n[![Release](https://img.shields.io/github/v/release/ai-zerolab/mcp-email-server)](https://img.shields.io/github/v/release/ai-zerolab/mcp-email-server)\n[![Build status](https://img.shields.io/github/actions/workflow/status/ai-zerolab/mcp-email-server/main.yml?branch=main)](https://github.com/ai-zerolab/mcp-email-server/actions/workflows/main.yml?query=branch%3Amain)\n[![codecov](https://codecov.io/gh/ai-zerolab/mcp-email-server/branch/main/graph/badge.svg)](https://codecov.io/gh/ai-zerolab/mcp-email-server)\n[![Commit activity](https://img.shields.io/github/commit-activity/m/ai-zerolab/mcp-email-server)](https://img.shields.io/github/commit-activity/m/ai-zerolab/mcp-email-server)\n[![License](https://img.shields.io/github/license/ai-zerolab/mcp-email-server)](https://img.shields.io/github/license/ai-zerolab/mcp-email-server)\n[![smithery badge](https://smithery.ai/badge/@ai-zerolab/mcp-email-server)](https://smithery.ai/server/@ai-zerolab/mcp-email-server)\n\nIMAP and SMTP via MCP Server\n\n- **Github repository**: <https://github.com/ai-zerolab/mcp-email-server/>\n- **Documentation** <https://ai-zerolab.github.io/mcp-email-server/>\n\n## Installation\n\n### Manual Installation\n\nWe recommend using [uv](https://github.com/astral-sh/uv) to manage your environment.\n\nTry `uvx mcp-email-server@latest ui` to config, and use following configuration for mcp client:\n\n```json\n{\n  \"mcpServers\": {\n    \"zerolib-email\": {\n      \"command\": \"uvx\",\n      \"args\": [\"mcp-email-server@latest\", \"stdio\"]\n    }\n  }\n}\n```\n\nThis package is available on PyPI, so you can install it using `pip install mcp-email-server`\n\nAfter that, configure your email server using the ui: `mcp-email-server ui`\n\n### Environment Variable Configuration\n\nYou can also configure the email server using environment variables, which is particularly useful for CI/CD environments like Jenkins. zerolib-email supports both UI configuration (via TOML file) and environment variables, with environment variables taking precedence.\n\n```json\n{\n  \"mcpServers\": {\n    \"zerolib-email\": {\n      \"command\": \"uvx\",\n      \"args\": [\"mcp-email-server@latest\", \"stdio\"],\n      \"env\": {\n        \"MCP_EMAIL_SERVER_ACCOUNT_NAME\": \"work\",\n        \"MCP_EMAIL_SERVER_FULL_NAME\": \"John Doe\",\n        \"MCP_EMAIL_SERVER_EMAIL_ADDRESS\": \"john@example.com\",\n        \"MCP_EMAIL_SERVER_USER_NAME\": \"john@example.com\",\n        \"MCP_EMAIL_SERVER_PASSWORD\": \"your_password\",\n        \"MCP_EMAIL_SERVER_IMAP_HOST\": \"imap.gmail.com\",\n        \"MCP_EMAIL_SERVER_IMAP_PORT\": \"993\",\n        \"MCP_EMAIL_SERVER_SMTP_HOST\": \"smtp.gmail.com\",\n        \"MCP_EMAIL_SERVER_SMTP_PORT\": \"465\"\n      }\n    }\n  }\n}\n```\n\n#### Available Environment Variables\n\n| Variable                          | Description        | Default       | Required |\n| --------------------------------- | ------------------ | ------------- | -------- |\n| `MCP_EMAIL_SERVER_ACCOUNT_NAME`   | Account identifier | `\"default\"`   | No       |\n| `MCP_EMAIL_SERVER_FULL_NAME`      | Display name       | Email prefix  | No       |\n| `MCP_EMAIL_SERVER_EMAIL_ADDRESS`  | Email address      | -             | Yes      |\n| `MCP_EMAIL_SERVER_USER_NAME`      | Login username     | Same as email | No       |\n| `MCP_EMAIL_SERVER_PASSWORD`       | Email password     | -             | Yes      |\n| `MCP_EMAIL_SERVER_IMAP_HOST`      | IMAP server host   | -             | Yes      |\n| `MCP_EMAIL_SERVER_IMAP_PORT`      | IMAP server port   | `993`         | No       |\n| `MCP_EMAIL_SERVER_IMAP_SSL`       | Enable IMAP SSL    | `true`        | No       |\n| `MCP_EMAIL_SERVER_SMTP_HOST`      | SMTP server host   | -             | Yes      |\n| `MCP_EMAIL_SERVER_SMTP_PORT`      | SMTP server port   | `465`         | No       |\n| `MCP_EMAIL_SERVER_SMTP_SSL`       | Enable SMTP SSL    | `true`        | No       |\n| `MCP_EMAIL_SERVER_SMTP_START_SSL` | Enable STARTTLS    | `false`       | No       |\n\nFor separate IMAP/SMTP credentials, you can also use:\n\n- `MCP_EMAIL_SERVER_IMAP_USER_NAME` / `MCP_EMAIL_SERVER_IMAP_PASSWORD`\n- `MCP_EMAIL_SERVER_SMTP_USER_NAME` / `MCP_EMAIL_SERVER_SMTP_PASSWORD`\n\nThen you can try it in [Claude Desktop](https://claude.ai/download). If you want to intergrate it with other mcp client, run `$which mcp-email-server` for the path and configure it in your client like:\n\n```json\n{\n  \"mcpServers\": {\n    \"zerolib-email\": {\n      \"command\": \"{{ ENTRYPOINT }}\",\n      \"args\": [\"stdio\"]\n    }\n  }\n}\n```\n\nIf `docker` is avaliable, you can try use docker image, but you may need to config it in your client using `tools` via `MCP`. The default config path is `~/.config/zerolib/mcp_email_server/config.toml`\n\n```json\n{\n  \"mcpServers\": {\n    \"zerolib-email\": {\n      \"command\": \"docker\",\n      \"args\": [\"run\", \"-it\", \"ghcr.io/ai-zerolab/mcp-email-server:latest\"]\n    }\n  }\n}\n```\n\n### Installing via Smithery\n\nTo install Email Server for Claude Desktop automatically via [Smithery](https://smithery.ai/server/@ai-zerolab/mcp-email-server):\n\n```bash\nnpx -y @smithery/cli install @ai-zerolab/mcp-email-server --client claude\n```\n\n## Development\n\nThis project is managed using [uv](https://github.com/ai-zerolab/uv).\n\nTry `make install` to install the virtual environment and install the pre-commit hooks.\n\nUse `uv run mcp-email-server` for local development.\n\n## Releasing a new version\n\n- Create an API Token on [PyPI](https://pypi.org/).\n- Add the API Token to your projects secrets with the name `PYPI_TOKEN` by visiting [this page](https://github.com/ai-zerolab/mcp-email-server/settings/secrets/actions/new).\n- Create a [new release](https://github.com/ai-zerolab/mcp-email-server/releases/new) on Github.\n- Create a new tag in the form `*.*.*`.\n\nFor more details, see [here](https://fpgmaas.github.io/cookiecutter-uv/features/cicd/#how-to-trigger-a-release).\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "IMAP and SMTP via MCP Server",
    "version": "0.2.2",
    "project_urls": {
        "Documentation": "https://ai-zerolab.github.io/mcp-email-server/",
        "Homepage": "https://ai-zerolab.github.io/mcp-email-server/",
        "Repository": "https://github.com/ai-zerolab/mcp-email-server"
    },
    "split_keywords": [
        "imap",
        " mcp",
        " smtp",
        " email"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "9418351e8c7ad15f2de71a1a6936656a0502dcf61565c471c2df1fa9ce980dc7",
                "md5": "8128d1590505dc2017e1937132b57a16",
                "sha256": "446add14c8e378b230afef6fb43b139919f4f3c282caeef26c094ff5ca9e4608"
            },
            "downloads": -1,
            "filename": "mcp_email_server-0.2.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "8128d1590505dc2017e1937132b57a16",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.10",
            "size": 21889,
            "upload_time": "2025-10-24T03:14:59",
            "upload_time_iso_8601": "2025-10-24T03:14:59.803084Z",
            "url": "https://files.pythonhosted.org/packages/94/18/351e8c7ad15f2de71a1a6936656a0502dcf61565c471c2df1fa9ce980dc7/mcp_email_server-0.2.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "89ec29251a2b37c9f5b3e76cb36b35bb664901a7cc6ad7ebe9fc917128361029",
                "md5": "87bfe299bac5b1241e46f3f03205bb45",
                "sha256": "7dd695c1e37ef5df5a6314bbee5eed35d9a766284d85be3c0a84ab4361c682dc"
            },
            "downloads": -1,
            "filename": "mcp_email_server-0.2.2.tar.gz",
            "has_sig": false,
            "md5_digest": "87bfe299bac5b1241e46f3f03205bb45",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0,>=3.10",
            "size": 161190,
            "upload_time": "2025-10-24T03:15:00",
            "upload_time_iso_8601": "2025-10-24T03:15:00.922781Z",
            "url": "https://files.pythonhosted.org/packages/89/ec/29251a2b37c9f5b3e76cb36b35bb664901a7cc6ad7ebe9fc917128361029/mcp_email_server-0.2.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-10-24 03:15:00",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "ai-zerolab",
    "github_project": "mcp-email-server",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "tox": true,
    "lcname": "mcp-email-server"
}
        
Elapsed time: 7.68941s