Merge pull request #100 from DirectoryTree/fetch-since-uid

Add ability to fetch UID sequence range in messages query

Author: stevebauman

src/Connection/ImapQueryBuilder.php

@@ -230,11 +230,9 @@ public function header(string $header, string $value): static
     /**
      * Add a where "UID" clause to the query.
      */
-    public function uid(int|string|array $uid): static
+    public function uid(int|string|array $from, int|float|null $to = null): static
     {
-        return $this->where(ImapSearchKey::Uid, new RawQueryValue(
-            Str::set(array_map('intval', (array) $uid))
-        ));
+        return $this->where(ImapSearchKey::Uid, new RawQueryValue(Str::set($from, $to)));
     }
 
     /**

src/Support/Str.php

@@ -77,7 +77,7 @@ public static function enum(BackedEnum|string $enum): string
     /**
      * Make a range set for use in a search command.
      */
-    public static function set(array|int $from, int|float|null $to = null): string
+    public static function set(int|string|array $from, int|float|string|null $to = null): string
     {
         // If $from is an array with multiple elements, return them as a comma-separated list.
         if (is_array($from) && count($from) > 1) {

tests/Unit/Connection/ImapQueryBuilderTest.php

@@ -244,3 +244,43 @@ function (ImapQueryBuilder $q) {
 
     expect($builder->toImap())->toBe('UID 2,3,5');
 });
+
+test('compiles UID range to infinity with from and to', function () {
+    $builder = new ImapQueryBuilder;
+
+    $builder->uid(2, INF);
+
+    expect($builder->toImap())->toBe('UID 2:*');
+});
+
+test('compiles UID range with upper bound with array', function () {
+    $builder = new ImapQueryBuilder;
+
+    $builder->uid([2, 5]);
+
+    expect($builder->toImap())->toBe('UID 2,5');
+});
+
+test('compiles UID range with upper bound with from and to', function () {
+    $builder = new ImapQueryBuilder;
+
+    $builder->uid(2, 5);
+
+    expect($builder->toImap())->toBe('UID 2:5');
+});
+
+test('compiles UID range with single value', function () {
+    $builder = new ImapQueryBuilder;
+
+    $builder->uid(2);
+
+    expect($builder->toImap())->toBe('UID 2');
+});
+
+test('compiles UID range with single value array', function () {
+    $builder = new ImapQueryBuilder;
+
+    $builder->uid([2]);
+
+    expect($builder->toImap())->toBe('UID 2');
+});

tests/Unit/Support/StrTest.php

@@ -5,8 +5,10 @@
 
 test('set', function () {
     expect(Str::set(5, 10))->toBe('5:10');
+    expect(Str::set('5', '10'))->toBe('5:10');
     expect(Str::set(5, INF))->toBe('5:*');
     expect(Str::set([5, 10]))->toBe('5,10');
+    expect(Str::set(['5', '10']))->toBe('5,10');
     expect(Str::set([5]))->toBe('5');
     expect(Str::set(5))->toBe('5');
 });