jmap_mail: return lowest createdmodseq in Email/get

Signed-off-by: Robert Stepanek <[email protected]>

cassandane/tiny-tests/JMAPEmail/email_get_createdmodseq

@@ -0,0 +1,51 @@
+#!perl
+use Cassandane::Tiny;
+
+sub test_email_get_createdmodseq
+    :min_version_3_9 :needs_component_jmap :JMAPExtensions
+{
+    my ($self) = @_;
+    my $jmap = $self->{jmap};
+    my $imap = $self->{store}->get_client();
+    $jmap->AddUsing('https://cyrusimap.org/ns/jmap/mail');
+
+    xlog $self, "Append duplicate messages";
+    $mimeMessage = <<'EOF';
+From: <from@local>
+To: to@local
+Subject: test
+Date: Mon, 13 Apr 2020 15:34:03 +0200
+MIME-Version: 1.0
+Content-Type: text/plain
+
+test
+EOF
+    $mimeMessage =~ s/\r?\n/\r\n/gs;
+    $imap->append('INBOX', '17-Aug-2023 15:13:54 +0200', $mimeMessage) || die $@;
+    $imap->append('INBOX', '17-Aug-2023 15:13:54 +0200', $mimeMessage) || die $@;
+
+    $imap->select('INBOX');
+    $fetch = $imap->fetch('1:2', ['INTERNALDATE', 'CREATEDMODSEQ']);
+    $self->assert_str_equals(
+        $fetch->{1}{internaldate}, $fetch->{2}{internaldate}
+    );
+    $self->assert_num_lt(
+        $fetch->{2}{createdmodseq}[0], $fetch->{1}{createdmodseq}[0]
+    );
+
+    # The createdModseq must be the lower modseq.
+    $res = $jmap->CallMethods([
+        ['Email/query', { }, "R1"],
+        ['Email/get', {
+            '#ids' => {
+                resultOf => 'R1',
+                name => 'Email/query',
+                path => '/ids'
+            },
+            properties => ['createdModseq'],
+        }, 'R2' ],
+    ]);
+    $self->assert_num_equals(1, scalar @{$res->[1][1]{list}});
+    $self->assert_num_equals($fetch->{1}{createdmodseq}[0],
+        $res->[1][1]{list}[0]{createdModseq});
+}

imap/jmap_mail.c

@@ -6949,6 +6949,46 @@ static const char *_encode_emailheader_blobid(const char *emailid,
     return buf_cstring(dst);
 }
 
+struct email_get_createdmodseq_rock {
+    jmap_req_t *req;
+    modseq_t modseq;
+};
+
+static int _email_get_createdmodseq_cb(const conv_guidrec_t *rec, void *vrock)
+{
+    struct email_get_createdmodseq_rock *rock = vrock;
+    mbentry_t *mbentry = NULL;
+
+    if (rec->part) return 0;
+
+    if ((rec->system_flags & FLAG_DELETED) ||
+        (rec->internal_flags & FLAG_INTERNAL_EXPUNGED)) {
+        goto done;
+    }
+
+    conv_guidrec_mbentry(rec, &mbentry);
+
+    if (!mbentry || mboxname_isnondeliverymailbox(mbentry->name, mbentry->mbtype) ||
+        !jmap_hasrights_mbentry(rock->req, mbentry, JACL_READITEMS)) {
+        goto done;
+    }
+
+    struct mailbox *mbox = NULL;
+    if (!jmap_openmbox_by_uniqueid(rock->req, mbentry->uniqueid, &mbox, 0)) {
+        struct index_record index_record = {0};
+        if (!mailbox_find_index_record(mbox, rec->uid, &index_record)) {
+            if (!rock->modseq || rock->modseq > index_record.createdmodseq) {
+                rock->modseq = index_record.createdmodseq;
+            }
+        }
+        jmap_closembox(rock->req, &mbox);
+    }
+
+done:
+    mboxlist_entry_free(&mbentry);
+    return 0;
+}
+
 static int _email_get_meta(jmap_req_t *req,
                            struct email_getargs *args,
                            struct cyrusmsg *msg,
@@ -6979,6 +7019,11 @@ static int _email_get_meta(jmap_req_t *req,
         }
         if (jmap_wantprop(props, "receivedAt"))
             json_object_set_new(email, "receivedAt", json_null());
+
+        if (jmap_wantprop(props, "createdModseq")) {
+            json_object_set_new(email, "createdModseq", json_integer(0));
+        }
+
         return 0;
     }
 
@@ -7126,6 +7171,16 @@ static int _email_get_meta(jmap_req_t *req,
         buf_free(&buf);
     }
 
+    if (jmap_wantprop(props, "createdModseq")) {
+        struct email_get_createdmodseq_rock rock = { req, 0 };
+
+        /* Look for the smalled createdmodseq for all index records */
+        conversations_guid_foreach(req->cstate, _guid_from_id(email_id),
+                                   _email_get_createdmodseq_cb, &rock);
+
+        json_object_set_new(email, "createdModseq", json_integer(rock.modseq));
+    }
+
 done:
     return r;
 }
@@ -8295,6 +8350,11 @@ static const jmap_property_t email_props[] = {
         JMAP_MAIL_EXTENSION,
         JMAP_PROP_SERVER_SET | JMAP_PROP_IMMUTABLE | JMAP_PROP_SKIP_GET
     },
+    {
+        "createdModseq",
+        JMAP_MAIL_EXTENSION,
+        JMAP_PROP_SERVER_SET | JMAP_PROP_IMMUTABLE
+    },
     { NULL, NULL, 0 }
 };