emailengine-app 2.69.0 → 2.71.0

package/lib/email-client/gmail-client.js

@@ -46,7 +46,7 @@ const SYSTEM_LABELS = {
 
 // User-friendly names for system labels
 const SYSTEM_NAMES = {
-    SENT: 'Sent ',
+    SENT: 'Sent',
     INBOX: 'Inbox',
     TRASH: 'Trash',
     DRAFT: 'Drafts',
@@ -63,6 +63,12 @@ for (let label of Object.keys(SYSTEM_LABELS)) {
     SYSTEM_LABELS_REV[SYSTEM_LABELS[label]] = label;
 }
 
+// Convert an IMAP special-use label (e.g. '\Important') to its Gmail system label ID, pass every
+// other value through as-is
+function toGmailLabelId(label) {
+    return SYSTEM_LABELS_REV.hasOwnProperty(label) ? SYSTEM_LABELS_REV[label] : label;
+}
+
 // Timing constants for Gmail Pub/Sub watch
 const RENEW_WATCH_TTL = 60 * 60 * 1000; // 1h - how often to check if watch needs renewal
 const MIN_WATCH_TTL = 24 * 3600 * 1000; // 1day - minimum time before renewing watch
@@ -753,7 +759,7 @@ class GmailClient extends BaseClient {
             // NB! Might throw if using unsupported search terms
             const preparedQuery = this.prepareQuery(query.search);
             if (preparedQuery) {
-                requestQuery.q = this.prepareQuery(query.search);
+                requestQuery.q = preparedQuery;
             }
         }
 
@@ -875,16 +881,13 @@ class GmailClient extends BaseClient {
 
         let sourceLabel = path && path !== '\\All' ? await this.getLabel(path) : null;
         if (path && path !== '\\All' && !sourceLabel) {
-            let error = new Error('Unknown path');
-            error.info = {
-                response: `Mailbox doesn't exist: ${path}`
-            };
-            error.code = 'NotFound';
-            error.statusCode = 404;
-            throw error;
+            throw this.unknownPathError(path);
         }
 
-        // Add TRASH label and remove source label
+        // Add TRASH label and remove source label. When deleting from the Trash folder itself both
+        // labels are TRASH - updateMessages resolves the add/remove conflict in favor of the add,
+        // keeping the request valid (Gmail API accounts only hold the gmail.modify scope, so a
+        // permanent batchDelete is not possible)
         let labelsUpdate = { add: 'TRASH' };
         if (sourceLabel) {
             labelsUpdate.delete = sourceLabel.id;
@@ -911,51 +914,28 @@ class GmailClient extends BaseClient {
         await this.prepare();
         updates = updates || {};
 
-        let addLabelIds = new Set();
-        let removeLabelIds = new Set();
-
         // Convert IMAP flags to Gmail labels
-        if (updates.flags) {
-            let labelUpdates = [];
-
-            for (let flag of [].concat(updates.flags.add || [])) {
-                labelUpdates.push(this.flagToLabel(flag));
-            }
-
-            for (let flag of [].concat(updates.flags.delete || [])) {
-                labelUpdates.push(this.flagToLabel(flag, true));
-            }
-
-            labelUpdates
-                .filter(label => label)
-                .forEach(label => {
-                    if (label.add) {
-                        addLabelIds.add(label.add);
-                    }
-                    if (label.remove) {
-                        removeLabelIds.add(label.remove);
-                    }
-                });
-        }
+        let { addLabelIds, removeLabelIds } = this.flagsToLabelIds(updates.flags);
 
         // Process direct label updates
         if (updates.labels) {
+            this.assertLabelSetSupported(updates.labels);
+
             for (let label of [].concat(updates.labels.add || [])) {
-                // Convert IMAP special-use to Gmail label
-                if (SYSTEM_LABELS_REV.hasOwnProperty(label)) {
-                    label = SYSTEM_LABELS_REV[label];
-                }
-                addLabelIds.add(label);
+                addLabelIds.add(toGmailLabelId(label));
             }
 
             for (let label of [].concat(updates.labels.delete || [])) {
-                if (SYSTEM_LABELS_REV.hasOwnProperty(label)) {
-                    label = SYSTEM_LABELS_REV[label];
-                }
-                removeLabelIds.add(label);
+                removeLabelIds.add(toGmailLabelId(label));
             }
         }
 
+        // Gmail rejects modify calls where the same label is both added and removed (deleting or
+        // moving a message within its current folder re-adds the source label) - the add wins
+        for (let label of addLabelIds) {
+            removeLabelIds.delete(label);
+        }
+
         if (!addLabelIds.size && !removeLabelIds.size) {
             return updates;
         }
@@ -1024,6 +1004,17 @@ class GmailClient extends BaseClient {
         await this.prepare();
         updates = updates || {};
 
+        // Reject unsupported operations before any API calls are made
+        if (updates.labels) {
+            this.assertLabelSetSupported(updates.labels);
+        }
+
+        path = [].concat(path || []).join('/');
+
+        if (path && path !== '\\All' && !(await this.getLabel(path))) {
+            throw this.unknownPathError(path);
+        }
+
         // Step 1. Resolve matching messages
         let messages = [];
         let cursor;
@@ -1043,8 +1034,8 @@ class GmailClient extends BaseClient {
                 { metadataOnly: true }
             );
 
-            if (messageListResult?.messages) {
-                messages = messages.concat(messageListResult?.messages);
+            if (messageListResult.messages) {
+                messages = messages.concat(messageListResult.messages);
                 if (messages.length >= maxMessages) {
                     messages = messages.slice(0, maxMessages);
                     break;
@@ -1064,43 +1055,25 @@ class GmailClient extends BaseClient {
             return updates;
         }
 
-        let addLabelIds = new Set();
-        let removeLabelIds = new Set();
-
         // Convert flags to label operations
-        if (updates.flags) {
-            let labelUpdates = [];
-
-            for (let flag of [].concat(updates.flags.add || [])) {
-                labelUpdates.push(this.flagToLabel(flag));
-            }
-
-            for (let flag of [].concat(updates.flags.delete || [])) {
-                labelUpdates.push(this.flagToLabel(flag, true));
-            }
-
-            labelUpdates
-                .filter(label => label)
-                .forEach(label => {
-                    if (label.add) {
-                        addLabelIds.add(label.add);
-                    }
-                    if (label.remove) {
-                        removeLabelIds.add(label.remove);
-                    }
-                });
-        }
+        let { addLabelIds, removeLabelIds } = this.flagsToLabelIds(updates.flags);
 
         if (updates.labels) {
             for (let label of [].concat(updates.labels.add || [])) {
-                addLabelIds.add(label);
+                addLabelIds.add(toGmailLabelId(label));
             }
 
             for (let label of [].concat(updates.labels.delete || [])) {
-                removeLabelIds.add(label);
+                removeLabelIds.add(toGmailLabelId(label));
             }
         }
 
+        // Gmail rejects batchModify calls where the same label is both added and removed (deleting
+        // or moving messages within their current folder re-adds the source label) - the add wins
+        for (let label of addLabelIds) {
+            removeLabelIds.delete(label);
+        }
+
         if (!addLabelIds.size && !removeLabelIds.size) {
             return { flags: {}, labels: {} };
         }
@@ -1141,13 +1114,7 @@ class GmailClient extends BaseClient {
 
         let label = await this.getLabel(path);
         if (!label) {
-            let error = new Error('Unknown path');
-            error.info = {
-                response: `Mailbox doesn't exist: ${path}`
-            };
-            error.code = 'NotFound';
-            error.statusCode = 404;
-            throw error;
+            throw this.unknownPathError(path);
         }
         let labelsUpdate = { add: [label.id] };
 
@@ -1155,13 +1122,7 @@ class GmailClient extends BaseClient {
 
         let sourceLabel = sourcePath ? await this.getLabel(sourcePath) : null;
         if (sourcePath && !sourceLabel) {
-            let error = new Error('Unknown path');
-            error.info = {
-                response: `Mailbox doesn't exist: ${sourcePath}`
-            };
-            error.code = 'NotFound';
-            error.statusCode = 404;
-            throw error;
+            throw this.unknownPathError(sourcePath);
         }
 
         if (sourceLabel) {
@@ -1190,24 +1151,12 @@ class GmailClient extends BaseClient {
 
         let targetLabel = await this.getLabel(path);
         if (!targetLabel) {
-            let error = new Error('Unknown path');
-            error.info = {
-                response: `Mailbox doesn't exist: ${path}`
-            };
-            error.code = 'NotFound';
-            error.statusCode = 404;
-            throw error;
+            throw this.unknownPathError(path);
         }
 
         let sourceLabel = source ? await this.getLabel(source) : null;
         if (source && !sourceLabel) {
-            let error = new Error('Unknown path');
-            error.info = {
-                response: `Mailbox doesn't exist: ${source}`
-            };
-            error.code = 'NotFound';
-            error.statusCode = 404;
-            throw error;
+            throw this.unknownPathError(source);
         }
 
         let labelsUpdate = { add: targetLabel.id };
@@ -1251,7 +1200,7 @@ class GmailClient extends BaseClient {
 
         const contentResponse = {
             headers: {
-                'content-type': attachmentData.mimeType || 'application/octet-stream',
+                'content-type': attachmentData.contentType || 'application/octet-stream',
                 'content-disposition': 'attachment' + filenameParam
             },
             contentType: attachmentData.contentType,
@@ -1421,7 +1370,7 @@ class GmailClient extends BaseClient {
 
         // Map part IDs to content types
         textParts[0].forEach(p => {
-            bodyParts.set(p, 'text');
+            bodyParts.set(p, 'plain');
         });
 
         textParts[1].forEach(p => {
@@ -1481,13 +1430,7 @@ class GmailClient extends BaseClient {
 
         let targetLabel = await this.getLabel(path);
         if (!targetLabel) {
-            let error = new Error('Unknown path');
-            error.info = {
-                response: `Mailbox doesn't exist: ${path}`
-            };
-            error.code = 'NotFound';
-            error.statusCode = 404;
-            throw error;
+            throw this.unknownPathError(path);
         }
 
         // Generate raw message
@@ -2400,7 +2343,7 @@ class GmailClient extends BaseClient {
             flags.push('\\Flagged');
         }
 
-        if (messageData.labelIds?.includes('DRAFTS')) {
+        if (messageData.labelIds?.includes('DRAFT')) {
             flags.push('\\Draft');
         }
 
@@ -2609,6 +2552,21 @@ class GmailClient extends BaseClient {
         return term;
     }
 
+    /**
+     * Builds the canonical 404 error for a mailbox path that does not match any Gmail label
+     * @param {string} path - Requested mailbox path
+     * @returns {Error} Error object with code and statusCode set
+     */
+    unknownPathError(path) {
+        let error = new Error('Unknown path');
+        error.info = {
+            response: `Mailbox doesn't exist: ${path}`
+        };
+        error.code = 'NotFound';
+        error.statusCode = 404;
+        return error;
+    }
+
     /**
      * Converts IMAP flags to Gmail label operations
      * @param {string} flag - IMAP flag
@@ -2625,6 +2583,55 @@ class GmailClient extends BaseClient {
         }
     }
 
+    /**
+     * Converts an IMAP-style flag update request (add/delete/set) into Gmail label ID sets.
+     * Set precedence is handled by BaseClient#normalizeFlagUpdates.
+     * @param {Object} [flagUpdates] - Flag update request ({ add, delete, set })
+     * @returns {Object} Label ID sets ({ addLabelIds: Set, removeLabelIds: Set })
+     */
+    flagsToLabelIds(flagUpdates) {
+        let addLabelIds = new Set();
+        let removeLabelIds = new Set();
+
+        let normalized = this.normalizeFlagUpdates(flagUpdates, ['\\Seen', '\\Flagged']);
+
+        let labelUpdates = [];
+
+        for (let flag of normalized.add) {
+            labelUpdates.push(this.flagToLabel(flag));
+        }
+
+        for (let flag of normalized.delete) {
+            labelUpdates.push(this.flagToLabel(flag, true));
+        }
+
+        labelUpdates
+            .filter(label => label)
+            .forEach(label => {
+                if (label.add) {
+                    addLabelIds.add(label.add);
+                }
+                if (label.remove) {
+                    removeLabelIds.add(label.remove);
+                }
+            });
+
+        return { addLabelIds, removeLabelIds };
+    }
+
+    /**
+     * Throws if the update request uses `labels.set`, which Gmail API accounts do not support
+     * @param {Object} labels - Label update request
+     */
+    assertLabelSetSupported(labels) {
+        if (labels.set) {
+            let error = new Error('Replacing the full label set is not supported for Gmail API accounts');
+            error.code = 'UnsupportedOperation';
+            error.statusCode = 400;
+            throw error;
+        }
+    }
+
     /**
      * Converts IMAP SEARCH query to Gmail API query
      * @param {Object} search - IMAP search object
@@ -2805,7 +2812,7 @@ class GmailClient extends BaseClient {
                         case 'STARRED':
                             changes.flags[addedProp].push('\\Flagged');
                             break;
-                        case 'DRAFTS':
+                        case 'DRAFT':
                             changes.flags[addedProp].push('\\Draft');
                             break;
                         default:

package/lib/email-client/imap/mailbox.js

@@ -15,7 +15,7 @@ const ical = require('ical.js');
 const addressparser = require('nodemailer/lib/addressparser');
 const { llmPreProcess } = require('../../llm-pre-process');
 
-const { getESClient } = require('../../document-store');
+const { getESClient, isDocumentStoreEnabled } = require('../../document-store');
 
 const {
     MESSAGE_NEW_NOTIFY,
@@ -1958,7 +1958,7 @@ class Mailbox {
     async publishSyncedEvents(storedStatus) {
         let messageFetchOptions = {};
 
-        let documentStoreEnabled = await settings.get('documentStoreEnabled');
+        let documentStoreEnabled = await isDocumentStoreEnabled();
 
         // Configure text fetching
         let notifyText = await settings.get('notifyText');

package/lib/email-client/imap/subconnection.js

@@ -133,7 +133,6 @@ class Subconnection extends EventEmitter {
                 if (prevImapClient === this.imapClient) {
                     this.imapClient = null;
                 }
-                prevImapClient = null;
             }
         }
 

package/lib/email-client/imap/sync-operations.js

@@ -909,7 +909,7 @@ class SyncOperations {
                                     currentPath: currentMailbox ? currentMailbox.path : 'none',
                                     loopId
                                 });
-                                throw new Error('Mailbox changed during sync operation');
+                                throw new Error('Mailbox changed during sync operation', { cause: err });
                             }
 
                             // Refresh mailbox status in case it changed

package/lib/email-client/imap-client.js

@@ -1858,11 +1858,13 @@ class IMAPClient extends BaseClient {
 
         this.checkIMAPConnection(connectionOptions);
 
-        if (!this.mailboxes.has(normalizePath(path))) {
+        path = await this.resolvePathAlias(path);
+
+        if (!this.mailboxes.has(path)) {
             return false; //?
         }
 
-        let mailbox = this.mailboxes.get(normalizePath(path));
+        let mailbox = this.mailboxes.get(path);
 
         return await mailbox.updateMessages(search, updates, connectionOptions);
     }
@@ -1924,11 +1926,13 @@ class IMAPClient extends BaseClient {
 
         this.checkIMAPConnection(connectionOptions);
 
-        if (!this.mailboxes.has(normalizePath(source))) {
+        source = await this.resolvePathAlias(source);
+
+        if (!this.mailboxes.has(source)) {
             return false; //?
         }
 
-        let mailbox = this.mailboxes.get(normalizePath(source));
+        let mailbox = this.mailboxes.get(source);
 
         let res = await mailbox.moveMessages(search, target, connectionOptions);
 
@@ -1981,11 +1985,13 @@ class IMAPClient extends BaseClient {
 
         this.checkIMAPConnection(connectionOptions);
 
-        if (!this.mailboxes.has(normalizePath(path))) {
+        path = await this.resolvePathAlias(path);
+
+        if (!this.mailboxes.has(path)) {
             return false; //?
         }
 
-        let mailbox = this.mailboxes.get(normalizePath(path));
+        let mailbox = this.mailboxes.get(path);
         let res = await mailbox.deleteMessages(search, force, connectionOptions);
 
         // force sync target mailbox if messages were moved to trash
@@ -2112,15 +2118,8 @@ class IMAPClient extends BaseClient {
 
         this.checkIMAPConnection(connectionOptions);
 
-        let path = normalizePath(options.path);
-
         // Handle special-use folder aliases
-        if (['\\Junk', '\\Sent', '\\Trash', '\\Inbox', '\\Drafts', '\\All'].includes(path)) {
-            let resolvedPath = await this.getSpecialUseMailbox(path);
-            if (resolvedPath) {
-                path = resolvedPath.path;
-            }
-        }
+        let path = await this.resolvePathAlias(options.path);
 
         if (!this.mailboxes.has(path)) {
             return false; //?
@@ -2294,7 +2293,7 @@ class IMAPClient extends BaseClient {
                 throw error;
             } else if (err.responseStatus === 'NO') {
                 return {
-                    path,
+                    path: [].concat(path || []).join('/'),
                     created: false
                 };
             } else {
@@ -2357,7 +2356,7 @@ class IMAPClient extends BaseClient {
                         error.info = {
                             response: err.response && typeof err.response === 'string' && err.response.replace(/^[^\s]*\s*/, '')
                         };
-                        error.code = err.serverResponseCode;
+                        error.code = err.serverResponseCode || 'RenameFailed';
                         error.statusCode = 400;
                         throw error;
                     } else {
@@ -2413,6 +2412,26 @@ class IMAPClient extends BaseClient {
             .find(entry => entry.specialUse === specialUse);
     }
 
+    /**
+     * Resolves a special-use folder alias (e.g. "\Sent") to the real mailbox path.
+     * Returns the normalized input path unchanged if it is not an alias or if no
+     * mailbox with the requested special-use flag exists.
+     * @param {string} path - Mailbox path or special-use alias
+     * @returns {string} Normalized mailbox path
+     */
+    async resolvePathAlias(path) {
+        path = normalizePath(path);
+
+        if (['\\Junk', '\\Sent', '\\Trash', '\\Inbox', '\\Drafts', '\\All'].includes(path)) {
+            let resolved = await this.getSpecialUseMailbox(path);
+            if (resolved) {
+                path = normalizePath(resolved.path);
+            }
+        }
+
+        return path;
+    }
+
     /**
      * Uploads a message to a mailbox
      * @param {Object} data - Message data including path, flags, content
@@ -2734,7 +2753,7 @@ class IMAPClient extends BaseClient {
         const emptyResponse = { signatures: [], signaturesSupported: false };
         let accountData = await this.accountObject.loadAccountData();
 
-        if (!accountData.oauth2.provider) {
+        if (!accountData.oauth2?.provider) {
             // Not an OAuth2 account
             return emptyResponse;
         }

package/lib/email-client/notification-handler.js

@@ -3,7 +3,7 @@
 const { parentPort } = require('worker_threads');
 const logger = require('../logger');
 const { webhooks: Webhooks } = require('../webhooks');
-const { getESClient } = require('../document-store');
+const { getESClient, isDocumentStoreEnabled } = require('../document-store');
 const { getThread } = require('../threads');
 const settings = require('../settings');
 
@@ -126,7 +126,7 @@ class NotificationHandler {
             return false;
         }
 
-        return await settings.get('documentStoreEnabled');
+        return await isDocumentStoreEnabled();
     }
 
     /**
@@ -157,10 +157,7 @@ class NotificationHandler {
             }
         } catch (err) {
             if (this.logger.notifyError) {
-                this.logger.notifyError(err, event => {
-                    event.setUser(this.account);
-                    event.addMetadata('ee', { index });
-                });
+                this.logger.notifyError(err, { user: this.account, meta: { index } });
             }
             this.logger.error({
                 msg: 'Failed to resolve thread',