imapflow 1.0.183 → 1.0.185

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Changelog
 
+## [1.0.185](https://github.com/postalsys/imapflow/compare/v1.0.184...v1.0.185) (2025-04-14)
+
+
+### Bug Fixes
+
+* **search:** add a `not` option for search options ([#281](https://github.com/postalsys/imapflow/issues/281)) ([000686b](https://github.com/postalsys/imapflow/commit/000686b2ace1ef0e21cca64d8e056d1f7f7f8914))
+
+## [1.0.184](https://github.com/postalsys/imapflow/compare/v1.0.183...v1.0.184) (2025-03-11)
+
+
+### Bug Fixes
+
+* Allow to call the connect method only once ([ca7ec96](https://github.com/postalsys/imapflow/commit/ca7ec969f19a93c5dc574bf3873cd7afc4d7af47))
+* **Authentication:** Report errors; Fix LOGINDISABLED ([#275](https://github.com/postalsys/imapflow/issues/275)) ([a3a3fb9](https://github.com/postalsys/imapflow/commit/a3a3fb993dee66c02b34bba0e0b26fc349487b26))
+
 ## [1.0.183](https://github.com/postalsys/imapflow/compare/v1.0.182...v1.0.183) (2025-03-09)
 
 

package/lib/commands/delete.js

@@ -11,7 +11,7 @@ module.exports = async (connection, path) => {
 
     path = normalizePath(connection, path);
 
-    if (connection.states.SELECTED && connection.mailbox.path === path) {
+    if (connection.state === connection.states.SELECTED && connection.mailbox.path === path) {
         await connection.run('CLOSE');
     }
 

package/lib/commands/rename.js

@@ -12,7 +12,7 @@ module.exports = async (connection, path, newPath) => {
     path = normalizePath(connection, path);
     newPath = normalizePath(connection, newPath);
 
-    if (connection.states.SELECTED && connection.mailbox.path === path) {
+    if (connection.state === connection.states.SELECTED && connection.mailbox.path === path) {
         await connection.run('CLOSE');
     }
 

package/lib/imap-flow.js

@@ -38,6 +38,7 @@ const {
     packMessageRange,
     normalizePath,
     expandRange,
+    AuthenticationFailure,
     getColorFlags
 } = require('./tools');
 
@@ -280,6 +281,8 @@ class ImapFlow extends EventEmitter {
         this.socket = false;
         this.writeSocket = false;
 
+        this.isClosed = false;
+
         this.states = states;
         this.state = this.states.NOT_AUTHENTICATED;
 
@@ -370,6 +373,9 @@ class ImapFlow extends EventEmitter {
             setImmediate(() => this.close());
             this.emitError(err);
         });
+
+        // Has the `connect` method already been called
+        this._connectCalled = false;
     }
 
     emitError(err) {
@@ -387,7 +393,7 @@ class ImapFlow extends EventEmitter {
     }
 
     write(chunk) {
-        if (this.socket.destroyed) {
+        if (!this.socket || this.socket.destroyed) {
             // do not write after connection end or logout
             const error = new Error('Socket is already closed');
             error.code = 'NoConnection';
@@ -503,7 +509,7 @@ class ImapFlow extends EventEmitter {
     }
 
     async exec(command, attributes, options) {
-        if (this.socket.destroyed) {
+        if (!this.socket || this.socket.destroyed) {
             let error = new Error('Connection closed');
             error.code = 'EConnectionClosed';
             throw error;
@@ -796,11 +802,7 @@ class ImapFlow extends EventEmitter {
 
         await this.upgradeToSTARTTLS();
 
-        let authenticated = await this.authenticate();
-        if (!authenticated) {
-            // nothing to do here
-            return await this.logout();
-        }
+        await this.authenticate();
 
         if (!this.idRequested && this.capabilities.has('ID')) {
             // re-request ID after LOGIN
@@ -812,8 +814,7 @@ class ImapFlow extends EventEmitter {
         if (nsResponse && nsResponse.error && nsResponse.status === 'BAD' && /User is authenticated but not connected/i.test(nsResponse.text)) {
             // Not a NAMESPACE failure but authentication failure, so report as
             this.authenticated = false;
-            let err = new Error('Authentication failed');
-            err.authenticationFailed = true;
+            let err = new AuthenticationFailure('Authentication failed');
             err.response = nsResponse.text;
             throw err;
         }
@@ -874,7 +875,7 @@ class ImapFlow extends EventEmitter {
         };
 
         Object.defineProperty(this.writeSocket, 'destroyed', {
-            get: () => this.socket.destroyed
+            get: () => !this.socket || this.socket.destroyed
         });
 
         // we need to force flush deflated data to socket so we can't
@@ -1043,14 +1044,17 @@ class ImapFlow extends EventEmitter {
     }
 
     async authenticate() {
+        if (this.state === this.states.LOGOUT) {
+            throw new AuthenticationFailure('Already logged out');
+        }
+
         if (this.state !== this.states.NOT_AUTHENTICATED) {
             // nothing to do here, usually happens with PREAUTH greeting
-            return this.state !== this.states.LOGOUT;
+            return true;
         }
 
-        if (this.capabilities.has('LOGINDISABLED') || !this.options.auth) {
-            // can not log in
-            return false;
+        if (!this.options.auth) {
+            throw new AuthenticationFailure('Please configure the login');
         }
 
         this.expectCapabilityUpdate = true;
@@ -1067,8 +1071,13 @@ class ImapFlow extends EventEmitter {
             if ((this.capabilities.has('AUTH=LOGIN') || this.capabilities.has('AUTH=PLAIN')) && loginMethod !== 'LOGIN') {
                 this.authenticated = await this.run('AUTHENTICATE', this.options.auth.user, { password: this.options.auth.pass, loginMethod });
             } else {
+                if (this.capabilities.has('LOGINDISABLED')) {
+                    throw new AuthenticationFailure('Login is disabled');
+                }
                 this.authenticated = await this.run('LOGIN', this.options.auth.user, this.options.auth.pass);
             }
+        } else {
+            throw new AuthenticationFailure('No password configured');
         }
 
         if (this.authenticated) {
@@ -1082,7 +1091,7 @@ class ImapFlow extends EventEmitter {
             return true;
         }
 
-        return false;
+        throw new AuthenticationFailure('No matching authentication method');
     }
 
     async initialOK(message) {
@@ -1405,6 +1414,12 @@ class ImapFlow extends EventEmitter {
      * await client.connect();
      */
     async connect() {
+        if (this._connectCalled) {
+            // Prevent re-using ImapFlow instances by allowing to call connect just once.
+            throw new Error('Can not re-use ImapFlow instance');
+        }
+        this._connectCalled = true;
+
         let connector = this.secureConnection ? tls : net;
 
         let opts = Object.assign(
@@ -1977,6 +1992,7 @@ class ImapFlow extends EventEmitter {
      * @property {String} [keyword] Matches messages that have the custom flag set
      * @property {String} [unKeyword] Matches messages that do not have the custom flag set
      * @property {Object.<string, Boolean|String>} [header] Matches messages with header key set if value is `true` (**NB!** not supported by all servers) or messages where header partially matches a string value
+     * @property {SearchObject} [not] A {@link SearchObject} object. It must not match.
      * @property {SearchObject[]} [or] An array of 2 or more {@link SearchObject} objects. At least on of these must match
      */
 
@@ -2467,7 +2483,7 @@ class ImapFlow extends EventEmitter {
 
         let res;
         while ((res = await getNext())) {
-            if (this.isClosed || this.socket.destroyed) {
+            if (this.isClosed || !this.socket || this.socket.destroyed) {
                 let error = new Error('Connection closed');
                 error.code = 'EConnectionClosed';
                 throw error;
@@ -2987,7 +3003,7 @@ class ImapFlow extends EventEmitter {
             return false;
         }
 
-        if (this.socket.destroyed) {
+        if (!this.socket || this.socket.destroyed) {
             const error = new Error('Connection not available');
             error.code = 'NoConnection';
             throw error;
@@ -3056,7 +3072,7 @@ class ImapFlow extends EventEmitter {
         const lock = this.locks.shift();
         const { resolve, reject, path, options, lockId } = lock;
 
-        if (!this.usable || this.socket.destroyed) {
+        if (!this.usable || !this.socket || this.socket.destroyed) {
             this.log.trace({ msg: 'Failed to acquire mailbox lock', path, lockId, idling: this.idling });
             // reject all
             let error = new Error('Connection not available');

package/lib/search-compiler.js

@@ -190,6 +190,19 @@ module.exports.searchCompiler = (connection, query) => {
                     }
                     break;
 
+                case 'NOT':
+                    {   
+                        if (!params[term]) {
+                            break;
+                        }
+
+                        if (typeof params[term] === 'object') {
+                            attributes.push({ type: 'ATOM', value: 'NOT' });
+                            walk(params[term]);
+                        }
+                    }
+                    break;
+                    
                 case 'OR':
                     {
                         if (!params[term] || !Array.isArray(params[term]) || !params[term].length) {

package/lib/tools.js

@@ -11,6 +11,10 @@ const iconv = require('iconv-lite');
 
 const FLAG_COLORS = ['red', 'orange', 'yellow', 'green', 'blue', 'purple', 'grey'];
 
+class AuthenticationFailure extends Error {
+    authenticationFailed = true;
+}
+
 const tools = {
     encodePath(connection, path) {
         path = (path || '').toString();
@@ -90,6 +94,8 @@ const tools = {
         return map;
     },
 
+    AuthenticationFailure,
+
     getStatusCode(response) {
         return response &&
             response.attributes &&
@@ -843,10 +849,9 @@ const tools = {
     },
 
     packMessageRange(list) {
-        if (typeof uidList === 'string')
-            if (!Array.isArray(list)) {
-                list = [].concat(list || []);
-            }
+        if (!Array.isArray(list)) {
+            list = [].concat(list || []);
+        }
 
         if (!list.length) {
             return '';

package/lib/types.d.ts

@@ -904,6 +904,7 @@ declare type SequenceString = string;
  * @property [keyword] - Matches messages that have the custom flag set
  * @property [unKeyword] - Matches messages that do not have the custom flag set
  * @property [header] - Matches messages with header key set if value is `true` (**NB!** not supported by all servers) or messages where header partially matches a string value
+ * @property [not] - A {@link SearchObject} object. It must not match.
  * @property [or] - An array of 2 or more {@link SearchObject} objects. At least on of these must match
  */
 declare type SearchObject = {
@@ -940,6 +941,7 @@ declare type SearchObject = {
     header?: {
         [key: string]: Boolean | String;
     };
+    not?: SearchObject;
     or?: SearchObject[];
 };
 

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "imapflow",
-    "version": "1.0.183",
+    "version": "1.0.185",
     "description": "IMAP Client for Node",
     "main": "./lib/imap-flow.js",
     "scripts": {