added displayfrom and displayto search criteria

[FlexibleDevs]

Hi, I'm Filippo and i'm using your amazing lib for connecting my project to an imap server.
I've modified the list of sort criteria to implement the DISPLAYFROM and TO (as described here: https://tools.ietf.org/html/rfc5957). I think that the 2 added lines should be enough to implement that.

Could you review my branch and eventually merge it into master ?

Thanks for you work, I'm happy to contribute.

Let me know,
Filippo

[mscdex]

We need to be more strict and ensure that the server supports the 'SORT=DISPLAY' capability before allowing these sort options.

[FlexibleDevs]

I see, it's correct.
Can i use your serverSupports function? Maybe something like that "if (!this.serverSupports('THREAD=' + algorithm))"
I'll modify the code to check "sort=display" capability.

Let me know,
thanks for your fast response 👍

Filippo

[FlexibleDevs]

Modified the sort switch to control server capability.
Could you check the modified version ?

Filippo

[matteomattei]

+1

[mscdex]

It looks like there are other non-related changes now?

[matteomattei]

This should be the final patch

index 619862f..c9119f3 100644
--- a/lib/Connection.js
+++ b/lib/Connection.js
@@ -917,6 +917,7 @@ Connection.prototype.sort = function(sorts, criteria, cb) {
 };
 
 Connection.prototype._sort = function(which, sorts, criteria, cb) {
+  let displaySupported = false;
   if (this._box === undefined)
     throw new Error('No mailbox is currently selected');
   else if (!Array.isArray(sorts) || !sorts.length)
@@ -925,6 +926,9 @@ Connection.prototype._sort = function(which, sorts, criteria, cb) {
     throw new Error('Expected array for search criteria');
   else if (!this.serverSupports('SORT'))
     throw new Error('Sort is not supported on the server');
+  if(this.serverSupports("SORT=DISPLAY")){
+    displaySupported = true;
+  }
 
   sorts = sorts.map(function(c) {
     if (typeof c !== 'string')
@@ -945,6 +949,12 @@ Connection.prototype._sort = function(which, sorts, criteria, cb) {
       case 'SUBJECT':
       case 'TO':
         break;
+      case 'DISPLAYFROM':
+      case 'DISPLAYTO':
+        if(!displaySupported){
+          throw new Error("Unexpected sort criteria: " + c);
+        }
+        break;
       default:
         throw new Error('Unexpected sort criteria: ' + c);
     }

[mauriziomambrini]

+1

[Carlobravo]

+1

[alessice]

+1 I'm using Dovecot as IMAP server and it support this IMAP extension. Since Dovecot have a 75% market share is a very useful patch for many people.

[ciaoben]

+1

[JonahKr]

+1