fix(api): Improved message-move API endpoint for Gmail API accounts. …

…There is now a new payload option 'source' that specifies the folder the message is moved from
postalsys · Feb 1, 2025 · 861bc23 · 861bc23
1 parent d1bd122
commit 861bc23
Show file tree

Hide file tree

Showing 6 changed files with 54 additions and 15 deletions.
diff --git a/lib/account.js b/lib/account.js
@@ -1161,13 +1161,14 @@ class Account {
         return x;
     }
 
-    async moveMessage(message, target) {
+    async moveMessage(message, target, options) {
         await this.loadAccountData(this.account, true);
         return await this.call({
             cmd: 'moveMessage',
             account: this.account,
             message,
             target,
+            options,
             timeout: this.timeout
         });
     }

diff --git a/lib/email-client/gmail-client.js b/lib/email-client/gmail-client.js
@@ -879,9 +879,11 @@ class GmailClient extends BaseClient {
         });
     }
 
-    async moveMessage(emailId, target) {
+    async moveMessage(emailId, target, options) {
         await this.prepare();
 
+        options = options || {};
+
         let path = [].concat(target?.path || []).join('/');
 
         let label = await this.getLabel(path);
@@ -894,8 +896,26 @@ class GmailClient extends BaseClient {
             error.statusCode = 404;
             throw error;
         }
+        let labelsUpdate = { add: [label.id] };
+
+        let sourcePath = options.source?.path;
+
+        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;
+        }
+
+        if (sourceLabel) {
+            labelsUpdate.delete = sourceLabel.id;
+        }
 
-        await this.updateMessage(emailId, { labels: { add: [label.id] } });
+        await this.updateMessage(emailId, { labels: labelsUpdate });
 
         return {
             path,

diff --git a/lib/email-client/imap-client.js b/lib/email-client/imap-client.js
@@ -1381,7 +1381,7 @@ class IMAPClient extends BaseClient {
         return await this.getCurrentListing(options, connectionOptions);
     }
 
-    async moveMessage(id, target, connectionOptions) {
+    async moveMessage(id, target, options, connectionOptions) {
         target = target || {};
         connectionOptions = connectionOptions || { allowSecondary: true };
 
@@ -1399,7 +1399,7 @@ class IMAPClient extends BaseClient {
         }
 
         let mailbox = this.mailboxes.get(normalizePath(message.path));
-        return await mailbox.moveMessage(message, target, connectionOptions);
+        return await mailbox.moveMessage(message, target, options, connectionOptions);
     }
 
     async moveMessages(source, search, target, connectionOptions) {

diff --git a/lib/email-client/imap/mailbox.js b/lib/email-client/imap/mailbox.js
@@ -2644,7 +2644,7 @@ class Mailbox {
         }
     }
 
-    async moveMessage(message, target, connectionOptions) {
+    async moveMessage(message, target, options, connectionOptions) {
         target = target || {};
 
         const connectionClient = await this.connection.getImapConnection(connectionOptions);

diff --git a/workers/api.js b/workers/api.js
@@ -4472,7 +4472,17 @@ const init = async () => {
             });
 
             try {
-                return await accountObject.moveMessage(request.params.message, request.payload);
+                return await accountObject.moveMessage(
+                    request.params.message,
+                    { path: request.payload.path },
+                    {
+                        source: request.payload.source
+                            ? {
+                                  path: request.payload.source
+                              }
+                            : null
+                    }
+                );
             } catch (err) {
                 request.logger.error({ msg: 'API request failed', err });
                 if (Boom.isBoom(err)) {
@@ -4486,8 +4496,8 @@ const init = async () => {
             }
         },
         options: {
-            description: 'Move message',
-            notes: 'Move message to another folder',
+            description: 'Move a message to a specified folder',
+            notes: 'Moves a message to a target folder',
             tags: ['api', 'Message'],
 
             plugins: {},
@@ -4512,15 +4522,23 @@ const init = async () => {
                 }),
 
                 payload: Joi.object({
-                    path: Joi.string().required().example('INBOX').description('Target mailbox folder path')
-                }).label('MessageMove')
+                    path: Joi.string().required().example('INBOX').description('Destination mailbox folder path'),
+                    source: Joi.string()
+                        .example('INBOX')
+                        .description('Source mailbox folder path (Gmail API only). Needed to remove the label from the message.')
+                })
+                    .example({ path: 'Target/Folder' })
+                    .label('MessageMove')
             },
 
             response: {
                 schema: Joi.object({
-                    path: Joi.string().required().example('INBOX').description('Target mailbox folder path'),
-                    id: Joi.string().max(256).required().example('AAAAAQAACnA').description('Message ID'),
-                    uid: Joi.number().integer().example(12345).description('UID of moved message')
+                    path: Joi.string().required().example('INBOX').description('Destination mailbox folder path'),
+                    id: Joi.string().max(256).example('AAAAAQAACnA').description('ID of the moved message. Only included if the server provides it.'),
+                    uid: Joi.number()
+                        .integer()
+                        .example(12345)
+                        .description('UID of the moved message, applies only to IMAP accounts. Only included if the server provides it.')
                 }).label('MessageMoveResponse'),
                 failAction: 'log'
             }

diff --git a/workers/imap.js b/workers/imap.js
@@ -444,7 +444,7 @@ class ConnectionHandler {
             return NO_ACTIVE_HANDLER_RESP;
         }
 
-        return await accountData.connection.moveMessage(message.message, message.target);
+        return await accountData.connection.moveMessage(message.message, message.target, message.options);
     }
 
     async moveMessages(message) {