Protonmail MCP

🚀 Protonmail MCP Server

This MCP server, provided by amotivv, is designed for integration with the Protonmail service. It caters to users who need to connect to external services via the Model Context Protocol (MCP).

🚀 Quick Start

This MCP server, provided by amotivv, is used for integration with the Protonmail service. It is designed for users who need to connect to external services through the Model Context Protocol (MCP).

✨ Features

• Direct Integration: Connect directly to the Protonmail service without additional configuration.
• Secure Transmission: Support encrypted communication via SSL/TLS to ensure data transfer security.
• Multithreading Support: The server can handle multiple concurrent requests, enhancing performance and response speed.
• Logging: Built - in detailed logging system for easy debugging and server status monitoring.

📦 Installation

Quick Installation

1. Clone the repository:

   git clone https://github.com/amotivv/protonmail-mcp.git
   cd protonmail-mcp
   

2. Install dependencies and build:

   npm install
   npm run build
   

3. Configure environment variables and set the Protonmail API key and endpoint.
4. Start the server:

   npm start
   

Extended Features

• Custom Logging: Allow users to extend the logging functionality as needed.
• Plugin Support: Provide a flexible plugin system for adding additional functional modules.

📚 Documentation

Environment Variable Configuration

The following are the key environment variables required for the server to run:

Logging Configuration

Users can choose the output format and logging level, supporting the following options:

• JSON Format: Easy for machine parsing.
• PLAIN Text: Suitable for manual viewing.
• SYSLOG Format: Compatible with system logging tools.

💻 Usage Examples

Basic Usage

const { ProtonmailService } = require('protonmail-mcp');

async function sendEmail(to, subject, text) {
    const service = new ProtonmailService({
        apiKey: 'your_api_key',
        endpoint: 'api.proton.me'
    });

    await service.send({
        to,
        subject,
        text
    });
}

// Example call
sendEmail('user@example.com', 'Test Email', 'This is a test email.')
    .then(() => console.log('Email sent successfully!'))
    .catch(err => console.error('Sending failed:', err));

Advanced Usage

const { ProtonmailService, Logger } = require('protonmail-mcp');

// Custom logger
const logger = new Logger({
    format: 'json',
    level: 'debug'
});

async function processEmails(emails) {
    const service = new ProtonmailService({
        apiKey: process.env.PROTONMAIL_API_KEY,
        endpoint: process.env.PROTONMAIL_ENDPOINT,
        logger
    });

    for (const email of emails) {
        try {
            await service.send(email);
            logger.info(`Email sent to ${email.to}`);
        } catch (error) {
            logger.error(`Sending failed: ${email.to}`, error);
        }
    }
}

// Example call
processEmails([
    { to: 'user1@example.com', subject: 'Notification', text: 'New message alert' },
    { to: 'user2@example.com', subject: 'Update', text: 'The system has been updated. Please check.' }
]);

Troubleshooting

Frequently Asked Questions

1. Connection Timeout:
   • Check the network connectivity.
   • Ensure the Protonmail API endpoint is available.
   • Check the server logs for more information.
2. Authentication Failure:
   • Verify the correctness of the API key.
   • Ensure the key has not expired or been locked.
   • Contact the Protonmail support team to confirm the key status.
3. Email Sending Limit:
   • Check the rate - limit documentation.
   • Spread out the email sending frequency to avoid triggering the limit.
   • Upgrade to a premium account to increase the sending limit.

📚 Documentation Resources

• Official Documentation: Details the API usage and best practices.
• Example Code Repository: Provides code examples for various application scenarios.

🔧 Contribution Guidelines

We welcome the community to contribute code or suggestions to help us improve this project.

Submission Guidelines

1. Create a clear issue description for each submission.
2. Ensure the code follows the project's coding style.
3. Provide detailed change logs and test cases.

📄 License

This software is released under the MIT license, allowing free use, modification, and distribution, provided the copyright notice is retained.

📞 Contact

For feedback or technical support, please visit our GitHub repository to submit an issue.