API

What is API?

API is a project that provides both an MCP (Model Context Protocol) server and a REST API for interacting with email mailboxes. The MCP interface is designed for AI clients such as Claude and OpenAI, while the REST API is intended for reporting and other automation tasks. The server can search for unread emails and includes a planned OCR capability using Mistral’s API.

How to use API?

Configure the server with a mailbox to enable searching for unread emails. The MCP interface can be connected via an MCP‑compatible client. For automation, the REST API endpoints can be invoked directly. No specific configuration commands are provided in the documentation.

Key features of API

• Search for unread emails in a provided mailbox (MCP and REST).
• REST API for reporting and automation tasks.
• MCP interface for AI assistants like Claude and OpenAI.
• OCR server and client using Mistral API (endpoint available).
• Planned support for PDF attachment extraction and structured output.

Use cases of API

• Automate email triage by retrieving unread messages.
• Integrate with AI assistants to fetch and process email data.
• Perform OCR on email attachments for data extraction.
• Build custom reporting dashboards using the REST API.

FAQ from API

What is the current state of the OCR functionality?

A new OCR server and client have been created using Mistral. An endpoint exists to perform OCR on an email that matches provided search criteria.

How does the MCP interface differ from the REST interface?

The MCP interface is intended for clients like Claude and OpenAI, whereas the REST API is designed for other reporting or automation tasks.

Is the project complete?

No, the project is in active development. Current capabilities include email search; future plans include gathering PDF attachments, full OCR processing, and returning structured output.