fix(messages-search): ZMS-265: messages.js search, allow to search for only seen messages (#865)

Author: NickOvt

lib/api/messages.js

@@ -647,7 +647,8 @@ module.exports = (db, server, messageHandler, userHandler, storageHandler, setti
         maxSize: Joi.number().empty('').description('Maximal message size in bytes'),
         attachments: booleanSchema.description('If true, then matches only messages with attachments'),
         flagged: booleanSchema.description('If true, then matches only messages with \\Flagged flags'),
-        unseen: booleanSchema.description('If true, then matches only messages without \\Seen flags'),
+        unseen: booleanSchema.description('If true, then matches only messages without \\Seen flags. Takes precedence over the seen flag'),
+        seen: booleanSchema.description('If true, then matches only messages with \\Seen flags'),
         includeHeaders: Joi.string()
             .max(1024)
             .trim()

lib/prepare-search-filter.js

@@ -47,25 +47,26 @@ const uidRangeStringToQuery = uidRange => {
 };
 
 const prepareSearchFilter = async (db, user, payload) => {
-    let mailbox = payload.mailbox ? new ObjectId(payload.mailbox) : false;
-    let idQuery = uidRangeStringToQuery(payload.id);
-    let thread = payload.thread ? new ObjectId(payload.thread) : false;
-
-    let orTerms = payload.or || {};
-    let orQuery = [];
-
-    let query = payload.query;
-    let datestart = payload.datestart || false;
-    let dateend = payload.dateend || false;
-    let filterFrom = payload.from;
-    let filterTo = payload.to;
-    let filterSubject = payload.subject;
-    let filterAttachments = payload.attachments;
-    let filterFlagged = payload.flagged;
-    let filterUnseen = payload.unseen;
-    let filterSearchable = payload.searchable;
-    let filterMinSize = payload.minSize;
-    let filterMaxSize = payload.maxSize;
+    const mailbox = payload.mailbox ? new ObjectId(payload.mailbox) : false;
+    const idQuery = uidRangeStringToQuery(payload.id);
+    const thread = payload.thread ? new ObjectId(payload.thread) : false;
+
+    const orTerms = payload.or || {};
+    const orQuery = [];
+
+    const query = payload.query;
+    const datestart = payload.datestart || false;
+    const dateend = payload.dateend || false;
+    const filterFrom = payload.from;
+    const filterTo = payload.to;
+    const filterSubject = payload.subject;
+    const filterAttachments = payload.attachments;
+    const filterFlagged = payload.flagged;
+    const filterUnseen = payload.unseen;
+    const filterSeen = payload.seen;
+    const filterSearchable = payload.searchable;
+    const filterMinSize = payload.minSize;
+    const filterMaxSize = payload.maxSize;
 
     let userData;
     try {
@@ -144,6 +145,12 @@ const prepareSearchFilter = async (db, user, payload) => {
         filter.flagged = true;
     }
 
+    if (filterSeen) {
+        filter.unseen = false;
+        filter.searchable = true;
+    }
+
+    // Unseen takes precedence over seen
     if (filterUnseen) {
         filter.unseen = true;
         filter.searchable = true;