mcp-twake-mail 0.1.0

package/build/types/dto.d.ts

@@ -0,0 +1,91 @@
+/**
+ * Simplified DTO types for MCP tools.
+ * These types represent JMAP objects in a format optimized for AI assistants:
+ * - Boolean flags instead of keyword objects
+ * - Arrays instead of Record<string, boolean> for mailboxIds
+ * - Human-readable property names
+ */
+/**
+ * Email address with optional display name.
+ */
+export interface EmailAddress {
+    name: string | null;
+    email: string;
+}
+/**
+ * Simplified email attachment.
+ */
+export interface SimplifiedAttachment {
+    blobId: string;
+    type: string;
+    name: string | null;
+    size: number;
+}
+/**
+ * Standard mailbox roles defined in RFC 8621.
+ */
+export type MailboxRole = 'inbox' | 'drafts' | 'sent' | 'trash' | 'junk' | 'archive' | 'all' | 'important' | 'subscribed' | null;
+/**
+ * Mailbox permission rights.
+ */
+export interface MailboxRights {
+    mayReadItems: boolean;
+    mayAddItems: boolean;
+    mayRemoveItems: boolean;
+    maySetSeen: boolean;
+    maySetKeywords: boolean;
+    mayCreateChild: boolean;
+    mayRename: boolean;
+    mayDelete: boolean;
+    maySubmit: boolean;
+}
+/**
+ * Simplified email DTO for MCP tools.
+ * Converts JMAP keywords to boolean flags:
+ * - $seen -> isRead
+ * - $flagged -> isFlagged
+ * - $draft -> isDraft
+ * - $answered -> isAnswered
+ * - $forwarded -> isForwarded
+ */
+export interface SimplifiedEmail {
+    id: string;
+    blobId: string;
+    threadId: string;
+    mailboxIds: string[];
+    isRead: boolean;
+    isFlagged: boolean;
+    isDraft: boolean;
+    isAnswered: boolean;
+    isForwarded: boolean;
+    receivedAt: string;
+    subject: string | null;
+    preview?: string;
+    size?: number;
+    hasAttachment?: boolean;
+    from: EmailAddress[];
+    to: EmailAddress[];
+    cc?: EmailAddress[];
+    bcc?: EmailAddress[];
+    replyTo?: EmailAddress[];
+    textBody?: string;
+    htmlBody?: string;
+    attachments?: SimplifiedAttachment[];
+}
+/**
+ * Simplified mailbox DTO for MCP tools.
+ * Preserves JMAP structure but with cleaner typing.
+ */
+export interface SimplifiedMailbox {
+    id: string;
+    name: string;
+    role: MailboxRole;
+    parentId: string | null;
+    sortOrder: number;
+    totalEmails: number;
+    unreadEmails: number;
+    totalThreads?: number;
+    unreadThreads?: number;
+    myRights?: MailboxRights;
+    isSubscribed?: boolean;
+}

package/build/types/dto.js

@@ -0,0 +1,9 @@
+/**
+ * Simplified DTO types for MCP tools.
+ * These types represent JMAP objects in a format optimized for AI assistants:
+ * - Boolean flags instead of keyword objects
+ * - Arrays instead of Record<string, boolean> for mailboxIds
+ * - Human-readable property names
+ */
+export {};
+//# sourceMappingURL=dto.js.map

package/build/types/dto.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dto.js","sourceRoot":"","sources":["../../src/types/dto.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG"}

package/build/types/jmap.d.ts

@@ -0,0 +1,110 @@
+/**
+ * TypeScript types for JMAP protocol (RFC 8620/8621)
+ */
+/** JMAP capabilities object - maps capability URIs to their configurations */
+export type JMAPCapabilities = Record<string, unknown>;
+/** JMAP account from session response */
+export interface JMAPAccount {
+    name: string;
+    isPersonal: boolean;
+    accountCapabilities: JMAPCapabilities;
+}
+/** JMAP session response from .well-known/jmap endpoint */
+export interface JMAPSessionResponse {
+    capabilities: JMAPCapabilities;
+    accounts: Record<string, JMAPAccount>;
+    primaryAccounts: Record<string, string>;
+    apiUrl: string;
+    state: string;
+    downloadUrl?: string;
+    uploadUrl?: string;
+    eventSourceUrl?: string;
+}
+/**
+ * JMAP method call: [methodName, arguments, callId]
+ * Example: ['Email/get', { accountId: '...', ids: ['msg1'] }, 'c1']
+ */
+export type JMAPMethodCall = [
+    methodName: string,
+    args: Record<string, unknown>,
+    callId: string
+];
+/**
+ * JMAP method response: [methodName, response, callId]
+ * Example: ['Email/get', { accountId: '...', list: [...], state: '...' }, 'c1']
+ */
+export type JMAPMethodResponse = [
+    methodName: string,
+    response: Record<string, unknown>,
+    callId: string
+];
+/** JMAP request body */
+export interface JMAPRequest {
+    using: string[];
+    methodCalls: JMAPMethodCall[];
+}
+/** JMAP response body */
+export interface JMAPResponse {
+    methodResponses: JMAPMethodResponse[];
+    sessionState?: string;
+}
+/** JMAP error response (method-level error) */
+export interface JMAPErrorResponse {
+    type: string;
+    description?: string;
+}
+/** JMAP Email/set response (RFC 8621 Section 4.3) */
+export interface EmailSetResponse {
+    accountId: string;
+    oldState: string;
+    newState: string;
+    created?: Record<string, {
+        id: string;
+        blobId: string;
+        threadId: string;
+    }>;
+    updated?: Record<string, null>;
+    destroyed?: string[];
+    notCreated?: Record<string, {
+        type: string;
+        description?: string;
+    }>;
+    notUpdated?: Record<string, {
+        type: string;
+        description?: string;
+    }>;
+    notDestroyed?: Record<string, {
+        type: string;
+        description?: string;
+    }>;
+}
+/** JMAP Identity for email sending (RFC 8621 Section 6) */
+export interface Identity {
+    id: string;
+    name: string;
+    email: string;
+    replyTo?: Array<{
+        name?: string;
+        email: string;
+    }> | null;
+    bcc?: Array<{
+        name?: string;
+        email: string;
+    }> | null;
+    textSignature?: string;
+    htmlSignature?: string;
+    mayDelete: boolean;
+}
+/** JMAP EmailSubmission/set response (RFC 8621 Section 7.5) */
+export interface EmailSubmissionSetResponse {
+    accountId: string;
+    oldState: string | null;
+    newState: string;
+    created?: Record<string, {
+        id: string;
+    }>;
+    notCreated?: Record<string, {
+        type: string;
+        description?: string;
+    }>;
+}

package/build/types/jmap.js

@@ -0,0 +1,5 @@
+/**
+ * TypeScript types for JMAP protocol (RFC 8620/8621)
+ */
+export {};
+//# sourceMappingURL=jmap.js.map

package/build/types/jmap.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"jmap.js","sourceRoot":"","sources":["../../src/types/jmap.ts"],"names":[],"mappings":"AAAA;;GAEG"}

package/package.json

@@ -0,0 +1,71 @@
+{
+  "name": "mcp-twake-mail",
+  "version": "0.1.0",
+  "description": "MCP server for Twake.ai — integrate your sovereign JMAP email server with any MCP-compatible AI assistant",
+  "type": "module",
+  "main": "./build/index.js",
+  "bin": {
+    "mcp-twake-mail": "./build/index.js"
+  },
+  "files": [
+    "build",
+    "README.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "start": "node build/index.js",
+    "dev": "tsc --watch",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:coverage": "vitest run --coverage",
+    "lint": "eslint src/",
+    "lint:fix": "eslint src/ --fix",
+    "prepublishOnly": "npm run build && npm test"
+  },
+  "keywords": [
+    "mcp",
+    "model-context-protocol",
+    "jmap",
+    "email",
+    "twake",
+    "ai",
+    "claude",
+    "assistant",
+    "mail",
+    "sovereign"
+  ],
+  "author": "LINAGORA <https://linagora.com>",
+  "license": "AGPL-3.0",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/linagora/mcp-twake-mail.git"
+  },
+  "homepage": "https://github.com/linagora/mcp-twake-mail#readme",
+  "bugs": {
+    "url": "https://github.com/linagora/mcp-twake-mail/issues"
+  },
+  "engines": {
+    "node": ">=20.0.0"
+  },
+  "dependencies": {
+    "@inquirer/prompts": "^8.2.0",
+    "@modelcontextprotocol/sdk": "^1.25.3",
+    "commander": "^14.0.2",
+    "oauth-callback": "^2.2.0",
+    "open": "^11.0.0",
+    "openid-client": "^6.8.1",
+    "pino": "^10.3.0",
+    "zod": "^4.3.6"
+  },
+  "devDependencies": {
+    "@eslint/js": "^9.39.2",
+    "@types/node": "^25.0.10",
+    "@vitest/coverage-v8": "^4.0.18",
+    "eslint": "^9.39.2",
+    "typescript": "^5.9.0",
+    "typescript-eslint": "^8.54.0",
+    "vitest": "^4.0.18",
+    "vitest-fetch-mock": "^0.4.0"
+  }
+}