Cloud Mail

Cloud Mail is a responsive email service designed to be deployed on Cloudflare Workers. It allows users to create multiple different email addresses using a single domain, similar to major email platforms, while minimizing server costs by leveraging Cloudflare's serverless infrastructure.

Key Capabilities

• Low-Cost Deployment: Runs on Cloudflare Workers (no dedicated server required).
• Email Management: Send and receive emails with attachment support (stored via Cloudflare R2).
• Email Sending: Integrated with Resend for bulk sending and attachments.
• Admin & Security: RBAC-based access control, Turnstile CAPTCHA integration, and user/email management.
• Automation: Email push notifications to Telegram bots and automatic verification code recognition via Workers AI.
• Open API: Supports batch user creation and multi-condition email queries.

Cloud Mail is built using the following technologies:

• Platform: Cloudflare Workers
• Web Framework: Hono
• ORM: Drizzle
• Frontend: Vue3 with Element Plus
• Email Service: Resend
• Storage & Database:
  • Cache: Cloudflare KV
  • Database: Cloudflare D1
  • File Storage: Cloudflare R2

To deploy the service, you need specific credentials from your Cloudflare dashboard.

Cloudflare API Token

1. Visit the Cloudflare API Tokens page.
2. Create a new API token.
3. Use the "Edit Cloudflare Workers" template.
4. Ensure you add the necessary permissions as required by the service (refer to the template settings).
5. Save the token and add it to your GitHub Secrets as CLOUDFLARE_API_TOKEN.

Cloudflare Account ID

1. Locate your Account ID in the Cloudflare Dashboard account settings.
2. Add this value to your GitHub Secrets as CLOUDFLARE_ACCOUNT_ID.

To translate language files for TinyMCE within this project, do not modify the files in mail-vue/public/tinymce/langs/ directly. Instead, use the official Crowdin service to submit translations. This ensures that changes are managed correctly through the proper localization workflow.

https://crowdin.com/project/tinymce

To deploy Cloud Mail, refer to the official Deployment Guide. The project is split into two main components:

1. mail-worker: The backend worker project (Hono-based API and email processing).
2. mail-vue: The frontend Vue project.

Configuration is managed via wrangler.toml in the mail-worker directory and environment variables (see env.release for reference).

The following secrets must be configured in your GitHub repository to enable deployment to Cloudflare Workers and proper service operation.

Cloud Mail is built using the following technologies:

• Platform: Cloudflare Workers
• Web Framework: Hono
• ORM: Drizzle
• Frontend Framework: Vue3
• UI Framework: Element Plus
• Email Provider: Resend
• Caching: Cloudflare KV
• Database: Cloudflare D1
• File Storage: Cloudflare R2

The mail-vue package provides API client methods for managing user profile information, resetting passwords, and deleting user accounts. These methods use an underlying http client (Axios) to communicate with the backend.

import { loginUserInfo, resetPassword, userDelete } from 'mail-vue/src/request/my.js';

// Fetch current user info
const userInfo = await loginUserInfo();

// Reset password
await resetPassword('new_secure_password');

// Delete user account
await userDelete();

These methods allow for modifying existing user attributes, credentials, or operational status via PUT requests.

• userSetPwd(params): Updates a user's password. Expects a params object containing the necessary credentials/identifiers.
• userSetStatus(params): Updates the account status (e.g., active/inactive).
• userSetType(params): Updates the user type/role.
• userRestSendCount(userId): Resets the email sending count for a specific user. Expects an object { userId }.

export function userSetPwd(params) {
    return http.put('/user/setPwd', params)
}

export function userSetStatus(params) {
    return http.put('/user/setStatus', params)
}

export function userSetType(params) {
    return http.put('/user/setType', params)
}

export function userRestSendCount(userId) {
    return http.put('/user/resetSendCount', {userId})
}