Apple-Mail-MCP-Server/build/services/appleMailManager.d.ts

/**
 * Apple Mail Manager
 *
 * Handles all interactions with Apple Mail via AppleScript.
 * This is the core service layer for the MCP server.
 *
 * Architecture:
 * - Text escaping is handled by dedicated helper functions
 * - AppleScript generation uses template builders for consistency
 * - All public methods return typed results (no raw strings)
 * - Error handling is consistent across all operations
 *
 * @module services/appleMailManager
 */
import type { Message, MessageContent, Mailbox, Account, Attachment, HealthCheckResult, MailStats, BatchOperationResult, SyncStatus, RecentlyReceivedStats, MailRule, Contact, EmailTemplate, SerialEmailRecipient, SerialEmailResult } from "../types.js";
/**
 * Manager class for Apple Mail operations.
 *
 * Provides methods for:
 * - Reading and searching messages
 * - Sending emails
 * - Managing mailboxes
 * - Listing accounts
 *
 * All operations are synchronous since they rely on AppleScript
 * execution via osascript. Error handling is consistent: methods
 * return null/false/empty-array on failure rather than throwing.
 */
export declare class AppleMailManager {
    /**
     * Default account used when no account is specified.
     */
    private defaultAccount;
    /**
     * TTL cache for expensive AppleScript queries that rarely change.
     * Caches account list and per-account mailbox names to avoid
     * redundant AppleScript roundtrips on every tool call.
     */
    private cache;
    /** Cache TTL in milliseconds (60 seconds). */
    private readonly CACHE_TTL_MS;
    /**
     * Returns cached accounts or fetches fresh data if cache is expired/empty.
     */
    private getCachedAccounts;
    /**
     * Returns cached mailbox names for an account, or fetches fresh.
     * This caches only the name list used by resolveMailbox(), not the
     * full Mailbox objects with counts (which change frequently).
     */
    private getCachedMailboxNames;
    /**
     * Invalidate all caches. Call after operations that change
     * mailbox structure (create/delete/rename mailbox).
     */
    private invalidateCache;
    /**
     * Resolves the account to use for an operation.
     * Queries Mail.app's configured default send account, then falls back
     * to the first available account.
     */
    private resolveAccount;
    /**
     * Resolves a mailbox name to its actual name in the account.
     *
     * Different account types (IMAP, Exchange, iCloud) use different
     * mailbox naming conventions:
     * - IMAP/Gmail: "INBOX", "Sent", "Drafts"
     * - Exchange: "Inbox", "Sent Items", "Deleted Items"
     * - iCloud: "INBOX", "Sent", "Trash"
     *
     * This method tries to find a matching mailbox by:
     * 1. Exact match
     * 2. Case-insensitive match
     * 3. Known aliases (e.g., "Sent" -> "Sent Items")
     *
     * @param mailbox - Requested mailbox name
     * @param account - Account to search in
     * @returns Actual mailbox name, or original if not found
     */
    private resolveMailbox;
    /**
     * Search for messages matching criteria.
     *
     * @param query - Text to search for in subject or sender
     * @param mailbox - Mailbox to search in (e.g., "INBOX")
     * @param account - Account to search in
     * @param limit - Maximum number of results
     * @returns Array of matching messages
     */
    searchMessages(query?: string, mailbox?: string, account?: string, limit?: number, dateFrom?: string, dateTo?: string): Message[];
    /**
     * Get a message by ID.
     *
     * Note: Mail.app message IDs are unique per mailbox. This method searches
     * all mailboxes in all accounts to find the message.
     */
    getMessageById(id: string): Message | null;
    /**
     * Get the content of a message.
     */
    getMessageContent(id: string): MessageContent | null;
    /**
     * Get the raw MIME source of a message.
     * Used as fallback for attachment extraction when AppleScript
     * mail attachments returns empty.
     *
     * Timeout is 2x the default (120s) because `source of msg` returns
     * the entire raw message including base64-encoded attachments —
     * a 20MB attachment can take several seconds over Exchange/IMAP.
     */
    getRawSource(id: string): string | null;
    /**
     * List messages in a mailbox.
     *
     * @param mailbox - Mailbox to list from (default: INBOX)
     * @param account - Account to list from
     * @param limit - Maximum number of messages
     * @returns Array of messages
     */
    listMessages(mailbox?: string, account?: string, limit?: number, from?: string, offset?: number): Message[];
    /**
     * Parse message list output from AppleScript.
     *
     * Two emission schemas, disambiguated by length:
     *   7 fields: single-mailbox — ...|hasAtt (mailbox from caller)
     *   8 fields: all-mailboxes — ...|mailbox|hasAtt
     *
     * `hasAttachments` here is the fast-path AppleScript count only; it will
     * false-negative for MIME-embedded attachments (a known AppleScript
     * limitation). Use getMessage or list-attachments for authoritative info.
     */
    private parseMessageList;
    /**
     * Send an email.
     *
     * @param to - Recipient email addresses
     * @param subject - Email subject
     * @param body - Email body (plain text)
     * @param cc - CC recipients
     * @param bcc - BCC recipients
     * @param account - Account to send from
     * @returns true if sent successfully
     */
    sendEmail(to: string[], subject: string, body: string, cc?: string[], bcc?: string[], account?: string, attachments?: string[]): boolean;
    /**
     * Send individual personalized emails to a list of recipients (mail merge).
     *
     * Replaces {{placeholder}} tokens in subject and body with per-recipient values.
     * Each recipient receives their own individual email.
     *
     * @param recipients - List of recipient objects with email and variable values
     * @param subject - Email subject (may contain {{placeholders}})
     * @param body - Email body (may contain {{placeholders}})
     * @param account - Account to send from
     * @param delayMs - Delay between sends in milliseconds (default: 500, max: 10000)
     * @returns Array of per-recipient results
     */
    sendSerialEmail(recipients: SerialEmailRecipient[], subject: string, body: string, account?: string, delayMs?: number): SerialEmailResult[];
    /**
     * Create a draft email (saved to Drafts folder, not sent).
     *
     * @param to - Recipient email addresses
     * @param subject - Email subject
     * @param body - Email body (plain text)
     * @param cc - CC recipients
     * @param bcc - BCC recipients
     * @param account - Account to create draft in
     * @returns true if draft created successfully
     */
    createDraft(to: string[], subject: string, body: string, cc?: string[], bcc?: string[], account?: string, attachments?: string[]): boolean;
    /**
     * Reply to a message.
     *
     * @param id - Message ID to reply to
     * @param body - Reply body
     * @param replyAll - If true, reply to all recipients
     * @param send - If true, send immediately; if false, save as draft
     * @returns true if reply created/sent successfully
     */
    replyToMessage(id: string, body: string, replyAll?: boolean, send?: boolean): boolean;
    /**
     * Forward a message.
     *
     * @param id - Message ID to forward
     * @param to - Recipients to forward to
     * @param body - Optional body to prepend
     * @param send - If true, send immediately; if false, save as draft
     * @returns true if forward created/sent successfully
     */
    forwardMessage(id: string, to: string[], body?: string, send?: boolean): boolean;
    /**
     * Helper to find and operate on a message by ID.
     */
    private findMessageScript;
    /**
     * Mark a message as read.
     */
    markAsRead(id: string): boolean;
    /**
     * Mark a message as unread.
     */
    markAsUnread(id: string): boolean;
    /**
     * Flag a message.
     */
    flagMessage(id: string): boolean;
    /**
     * Unflag a message.
     */
    unflagMessage(id: string): boolean;
    /**
     * Delete a message.
     */
    deleteMessage(id: string): boolean;
    /**
     * Move a message to a different mailbox.
     */
    moveMessage(id: string, mailbox: string, account?: string): boolean;
    /**
     * Delete multiple messages at once.
     *
     * @param ids - Array of message IDs to delete
     * @returns Array of results for each message
     */
    batchDeleteMessages(ids: string[]): BatchOperationResult[];
    /**
     * Move multiple messages to a mailbox at once.
     *
     * @param ids - Array of message IDs to move
     * @param mailbox - Destination mailbox name
     * @param account - Account containing the destination mailbox
     * @returns Array of results for each message
     */
    batchMoveMessages(ids: string[], mailbox: string, account?: string): BatchOperationResult[];
    /**
     * Mark multiple messages as read at once.
     */
    batchMarkAsRead(ids: string[]): BatchOperationResult[];
    /**
     * Mark multiple messages as unread at once.
     */
    batchMarkAsUnread(ids: string[]): BatchOperationResult[];
    /**
     * Flag multiple messages at once.
     */
    batchFlagMessages(ids: string[]): BatchOperationResult[];
    /**
     * Unflag multiple messages at once.
     */
    batchUnflagMessages(ids: string[]): BatchOperationResult[];
    /**
     * List attachments for a message.
     * Tries AppleScript first, falls back to MIME source parsing
     * when AppleScript returns empty (known issue across all account types).
     */
    listAttachments(id: string): Attachment[];
    /**
     * Save an attachment from a message to disk.
     * Tries AppleScript first, falls back to MIME source extraction
     * when AppleScript can't find the attachment.
     */
    saveAttachment(id: string, attachmentName: string, savePath: string): boolean;
    /**
     * List all mailboxes for an account.
     */
    listMailboxes(account?: string): Mailbox[];
    /**
     * Get unread count for a mailbox.
     */
    getUnreadCount(mailbox?: string, account?: string): number;
    /**
     * Create a new mailbox.
     */
    createMailbox(name: string, account?: string): boolean;
    /**
     * Delete a mailbox.
     */
    deleteMailbox(name: string, account?: string): boolean;
    /**
     * Rename a mailbox by creating a new one, moving messages, and deleting the old one.
     */
    renameMailbox(oldName: string, newName: string, account?: string): boolean;
    /**
     * List all mail accounts (uses cache).
     */
    listAccounts(): Account[];
    /**
     * Fetches account list directly from Mail.app via AppleScript.
     * Used internally by the cache; prefer getCachedAccounts() or listAccounts().
     */
    private fetchAccounts;
    /**
     * Fetches mailbox names for an account directly from Mail.app.
     * Used internally by the cache; prefer getCachedMailboxNames().
     */
    private fetchMailboxNames;
    /**
     * List all mail rules.
     */
    listRules(): MailRule[];
    /**
     * Enable or disable a mail rule.
     */
    setRuleEnabled(ruleName: string, enabled: boolean): boolean;
    /**
     * Search contacts by name or email.
     */
    searchContacts(query: string): Contact[];
    private templates;
    private nextTemplateId;
    /**
     * List all stored templates.
     */
    listTemplates(): EmailTemplate[];
    /**
     * Get a template by ID.
     */
    getTemplate(id: string): EmailTemplate | null;
    /**
     * Create or update a template.
     */
    saveTemplate(name: string, subject: string, body: string, to?: string[], cc?: string[], id?: string): EmailTemplate;
    /**
     * Delete a template.
     */
    deleteTemplate(id: string): boolean;
    /**
     * Use a template to create a draft.
     */
    useTemplate(id: string, overrides?: {
        to?: string[];
        cc?: string[];
        subject?: string;
        body?: string;
    }): boolean;
    /**
     * Run health check on Mail.app connectivity.
     */
    healthCheck(): HealthCheckResult;
    /**
     * Get mail statistics.
     */
    getMailStats(): MailStats;
    /**
     * Get counts of recently received messages.
     *
     * Only counts messages in INBOX for performance (scanning all mailboxes
     * is too slow for large accounts).
     *
     * @returns Counts of messages received in last 24h, 7d, and 30d
     */
    getRecentlyReceivedStats(): RecentlyReceivedStats;
    /**
     * Get sync status for Mail.app.
     *
     * Checks for sync activity indicators like:
     * - Activity monitor status
     * - Network activity status
     * - Background refresh indicators
     *
     * @returns Sync status information
     */
    getSyncStatus(): SyncStatus;
}
//# sourceMappingURL=appleMailManager.d.ts.map