Other: Handle Seen/Flagged IMAP flags when APPENDing a message

When an IMAP client appends a message to a mailbox, it can specify which flags it wants the appended message to have. We need to handle these in a proton-specific way; not-seen messages need to be imported with the Unread bool set to true, and flagged messages need to additionally be imported with the Starred label.
2026-02-04 00:08:33 +00:00 · 2022-10-19 08:00:45 +02:00
parent a7a7d9a3d4
commit 04b6571cb8
12 changed files with 259 additions and 39 deletions
--- a/tests/api_test.go
+++ b/tests/api_test.go
@ -37,10 +37,6 @@ type API interface {
 	GetLabels(userID string) ([]liteapi.Label, error)
 	CreateLabel(userID, name string, labelType liteapi.LabelType) (string, error)

-	CreateMessage(userID, addrID string, literal []byte, flags liteapi.MessageFlag, unread, starred bool) (string, error)
-	LabelMessage(userID, messageID, labelID string) error
-	UnlabelMessage(userID, messageID, labelID string) error
-
 	Close()
 }

--- a/tests/bdd_test.go
+++ b/tests/bdd_test.go
@ -170,6 +170,8 @@ func TestFeatures(testingT *testing.T) {
 			ctx.Step(`^IMAP client "([^"]*)" marks all messages as deleted$`, s.imapClientMarksAllMessagesAsDeleted)
 			ctx.Step(`^IMAP client "([^"]*)" sees that message (\d+) has the flag "([^"]*)"$`, s.imapClientSeesThatMessageHasTheFlag)
 			ctx.Step(`^IMAP client "([^"]*)" expunges$`, s.imapClientExpunges)
+			ctx.Step(`^IMAP client "([^"]*)" appends the following message to "([^"]*)":$`, s.imapClientAppendsTheFollowingMessageToMailbox)
+			ctx.Step(`^IMAP client "([^"]*)" appends "([^"]*)" to "([^"]*)"$`, s.imapClientAppendsToMailbox)

 			// ==== SMTP ====
 			ctx.Step(`^user "([^"]*)" connects SMTP client "([^"]*)"$`, s.userConnectsSMTPClient)
--- a/tests/features/imap/message/import.feature
+++ b/tests/features/imap/message/import.feature
@ -0,0 +1,147 @@
+Feature: IMAP import messages
+  Background:
+    Given there exists an account with username "user@pm.me" and password "password"
+    And bridge starts
+    And the user logs in with username "user@pm.me" and password "password"
+    And user "user@pm.me" finishes syncing
+    And user "user@pm.me" connects and authenticates IMAP client "1"
+
+  Scenario: Basic message import
+    When IMAP client "1" appends the following message to "INBOX":
+      """
+      From: Bridge Test <bridgetest@pm.test>
+      To: Internal Bridge <bridgetest@protonmail.com>
+      Received: by 2002:0:0:0:0:0:0:0 with SMTP id 0123456789abcdef; Wed, 30 Dec 2020 01:23:45 0000
+      Subject: Basic text/plain message
+      Content-Type: text/plain
+
+      Hello
+      """
+    Then it succeeds
+    And IMAP client "1" eventually sees the following messages in "INBOX":
+      | from               | to                        | subject                  | body  |
+      | bridgetest@pm.test | bridgetest@protonmail.com | Basic text/plain message | Hello |
+
+  Scenario: Import message with double charset in content type
+    When IMAP client "1" appends the following message to "INBOX":
+      """
+      From: Bridge Test <bridgetest@pm.test>
+      To: Internal Bridge <bridgetest@protonmail.com>
+      Subject: Message with double charset in content type
+      Content-Type: text/plain; charset=utf-8; charset=utf-8
+      Content-Disposition: inline
+      Received: by 2002:0:0:0:0:0:0:0 with SMTP id 0123456789abcdef; Wed, 30 Dec 2020 01:23:45 0000
+
+      Hello
+      """
+    Then it succeeds
+    And IMAP client "1" eventually sees the following messages in "INBOX":
+      | from               | to                        | subject                                     | body  |
+      | bridgetest@pm.test | bridgetest@protonmail.com | Message with double charset in content type | Hello |
+
+  # The message is imported as UTF-8 and the content type is determined at build time.
+  Scenario: Import message as latin1 without content type
+    When IMAP client "1" appends "text_plain_unknown_latin1.eml" to "INBOX"
+    Then it succeeds
+    And IMAP client "1" eventually sees the following messages in "INBOX":
+      | from         | to             | body    |
+      | sender@pm.me | receiver@pm.me | ééééééé |
+
+  # The message is imported and the body is converted to UTF-8.
+  Scenario: Import message as latin1 with content type
+    When IMAP client "1" appends "text_plain_latin1.eml" to "INBOX"
+    Then it succeeds
+    And IMAP client "1" eventually sees the following messages in "INBOX":
+      | from         | to             | body    |
+      | sender@pm.me | receiver@pm.me | ééééééé |
+
+  # The message is imported anad the body is wrongly converted (body is corrupted).
+  Scenario: Import message as latin1 with wrong content type
+    When IMAP client "1" appends "text_plain_wrong_latin1.eml" to "INBOX"
+    Then it succeeds
+    And IMAP client "1" eventually sees the following messages in "INBOX":
+      | from         | to             |
+      | sender@pm.me | receiver@pm.me |
+
+  Scenario: Import received message to Sent
+    When IMAP client "1" appends the following message to "Sent":
+      """
+      From: Foo <foo@example.com>
+      To: Bridge Test <bridgetest@pm.test>
+      Subject: Hello
+      Received: by 2002:0:0:0:0:0:0:0 with SMTP id 0123456789abcdef; Wed, 30 Dec 2020 01:23:45 0000
+
+      Hello
+      """
+    Then it succeeds
+    And IMAP client "1" eventually sees the following messages in "INBOX":
+      | from            | to                 | subject | body  |
+      | foo@example.com | bridgetest@pm.test | Hello   | Hello |
+    And IMAP client "1" sees 0 messages in "Sent"
+
+  Scenario: Import non-received message to Inbox
+    When IMAP client "1" appends the following message to "Inbox":
+      """
+      From: Foo <foo@example.com>
+      To: Bridge Test <bridgetest@pm.test>
+      Subject: Hello
+
+      Hello
+      """
+    Then it succeeds
+    And IMAP client "1" eventually sees the following messages in "Sent":
+      | from            | to                 | subject | body  |
+      | foo@example.com | bridgetest@pm.test | Hello   | Hello |
+    And IMAP client "1" sees 0 messages in "Inbox"
+
+  Scenario Outline: Import message without sender
+    When IMAP client "1" appends the following message to "<mailbox>":
+      """
+      To: Lionel Richie <lionel@richie.com>
+      Subject: RE: Hello, is it me you looking for?
+
+      Nope.
+      """
+    Then it succeeds
+    And IMAP client "1" eventually sees the following messages in "<mailbox>":
+      | to                | subject                              | body  |
+      | lionel@richie.com | RE: Hello, is it me you looking for? | Nope. |
+
+    Examples:
+        | mailbox |
+        | Drafts  |
+        | Archive |
+        | Sent    |
+
+  Scenario: Import embedded message
+    When IMAP client "1" appends the following message to "INBOX":
+      """
+      From: Foo <foo@example.com>
+      To: Bridge Test <bridgetest@pm.test>
+      Subject: Embedded message
+      Content-Type: multipart/mixed; boundary="boundary"
+      Received: by 2002:0:0:0:0:0:0:0 with SMTP id 0123456789abcdef; Wed, 30 Dec 2020 01:23:45 0000
+
+      This is a multi-part message in MIME format.
+      --boundary
+      Content-Type: text/plain; charset=utf-8
+      Content-Transfer-Encoding: 7bit
+
+
+      --boundary
+      Content-Type: message/rfc822; name="embedded.eml"
+      Content-Transfer-Encoding: 7bit
+      Content-Disposition: attachment; filename="embedded.eml"
+
+      From: Bar <bar@example.com>
+      To: Bridge Test <bridgetest@pm.test>
+      Subject: (No Subject)
+      Content-Type: text/plain; charset=utf-8
+      Content-Transfer-Encoding: quoted-printable
+
+      hello
+
+      --boundary--
+
+      """
+    Then it succeeds
--- a/tests/imap_test.go
+++ b/tests/imap_test.go
@ -19,7 +19,10 @@ package tests

 import (
 	"fmt"
+	"os"
+	"path/filepath"
 	"strings"
+	"time"

 	"github.com/bradenaw/juniper/iterator"
 	"github.com/bradenaw/juniper/xslices"
@ -380,6 +383,23 @@ func (s *scenario) imapClientExpunges(clientID string) error {
 	return client.Expunge(nil)
 }

+func (s *scenario) imapClientAppendsTheFollowingMessageToMailbox(clientID string, mailbox string, docString *godog.DocString) error {
+	_, client := s.t.getIMAPClient(clientID)
+
+	return clientAppend(client, mailbox, docString.Content)
+}
+
+func (s *scenario) imapClientAppendsToMailbox(clientID string, file, mailbox string) error {
+	_, client := s.t.getIMAPClient(clientID)
+
+	b, err := os.ReadFile(filepath.Join("testdata", file))
+	if err != nil {
+		return err
+	}
+
+	return clientAppend(client, mailbox, string(b))
+}
+
 func clientList(client *client.Client) []*imap.MailboxInfo {
 	resCh := make(chan *imap.MailboxInfo)

@ -490,3 +510,7 @@ func clientStore(client *client.Client, from, to int, item imap.StoreItem, flags

 	return iterator.Collect(iterator.Chan(resCh)), nil
 }
+
+func clientAppend(client *client.Client, mailbox string, literal string) error {
+	return client.Append(mailbox, []string{}, time.Now(), strings.NewReader(literal))
+}
--- a/tests/testdata/text_plain_latin1.eml
+++ b/tests/testdata/text_plain_latin1.eml
@ -0,0 +1,6 @@
+From: Sender <sender@pm.me>
+To: Receiver <receiver@pm.me>
+Received: by 2002:0:0:0:0:0:0:0 with SMTP id 0123456789abcdef; Wed, 30 Dec 2020 01:23:45 0000
+Content-Type: text/plain; charset=ISO-8859-1
+
+<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
--- a/tests/testdata/text_plain_unknown_latin1.eml
+++ b/tests/testdata/text_plain_unknown_latin1.eml
@ -0,0 +1,6 @@
+From: Sender <sender@pm.me>
+To: Receiver <receiver@pm.me>
+Received: by 2002:0:0:0:0:0:0:0 with SMTP id 0123456789abcdef; Wed, 30 Dec 2020 01:23:45 0000
+Content-Type: text/plain
+
+<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
--- a/tests/testdata/text_plain_wrong_latin1.eml
+++ b/tests/testdata/text_plain_wrong_latin1.eml
@ -0,0 +1,6 @@
+From: Sender <sender@pm.me>
+To: Receiver <receiver@pm.me>
+Received: by 2002:0:0:0:0:0:0:0 with SMTP id 0123456789abcdef; Wed, 30 Dec 2020 01:23:45 0000
+Content-Type: text/plain; charset=KOI8R
+
+<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>