Merge pull request #1656 from Infomaniak/externals-api-call

Use `externalMailInfo` API call instead of `mailboxes` one to get ExternalMail info

Author: KevinBoulongne

Diff for: app/src/main/java/com/infomaniak/mail/data/api/ApiRepository.kt

@@ -49,6 +49,7 @@ import com.infomaniak.mail.data.models.getMessages.ActivitiesResult
 import com.infomaniak.mail.data.models.getMessages.GetMessagesByUidsResult
 import com.infomaniak.mail.data.models.getMessages.NewMessagesResult
 import com.infomaniak.mail.data.models.mailbox.Mailbox
+import com.infomaniak.mail.data.models.mailbox.MailboxExternalMailInfo
 import com.infomaniak.mail.data.models.mailbox.MailboxLinkedResult
 import com.infomaniak.mail.data.models.mailbox.MailboxPermissions
 import com.infomaniak.mail.data.models.message.Message
@@ -148,6 +149,10 @@ object ApiRepository : ApiRepositoryCore() {
         return callApi(ApiRoutes.permissions(mailboxLinkId, mailboxHostingId), GET)
     }
 
+    fun getExternalMailInfo(mailboxHostingId: Int, mailboxName: String): ApiResponse<MailboxExternalMailInfo> {
+        return callApi(ApiRoutes.externalMailInfo(mailboxHostingId, mailboxName), GET)
+    }
+
     fun markMessagesAsSeen(mailboxUuid: String, messagesUids: List<String>): ApiResponse<Unit> {
         return callApi(ApiRoutes.messagesSeen(mailboxUuid), POST, mapOf("uids" to messagesUids))
     }

Diff for: app/src/main/java/com/infomaniak/mail/data/api/ApiRoutes.kt

@@ -87,6 +87,10 @@ object ApiRoutes {
         return "$MAIL_API/api/securedProxy"
     }
 
+    fun externalMailInfo(mailboxHostingId: Int, mailboxName: String): String {
+        return "${securedProxy()}/1/mail_hostings/$mailboxHostingId/mailboxes/$mailboxName/external_mail_flag"
+    }
+
     fun updateMailboxPassword(mailboxId: Int): String {
         return "${securedProxy()}/cache/invalidation/profile/workspace/mailbox/$mailboxId/update_password"
     }
@@ -106,7 +110,7 @@ object ApiRoutes {
     }
 
     fun mailboxes(): String {
-        return "${mailbox()}?with=aliases,external_mail_flag_enabled,unseen"
+        return "${mailbox()}?with=aliases,unseen"
     }
 
     fun permissions(linkId: Int, mailboxHostingId: Int): String {

Diff for: app/src/main/java/com/infomaniak/mail/data/cache/RealmDatabase.kt

@@ -161,7 +161,7 @@ object RealmDatabase {
 
         //region Configurations versions
         const val USER_INFO_SCHEMA_VERSION = 1L
-        const val MAILBOX_INFO_SCHEMA_VERSION = 4L
+        const val MAILBOX_INFO_SCHEMA_VERSION = 5L
         const val MAILBOX_CONTENT_SCHEMA_VERSION = 10L
         //endregion
 

Diff for: app/src/main/java/com/infomaniak/mail/data/models/correspondent/Recipient.kt

@@ -18,7 +18,7 @@
 package com.infomaniak.mail.data.models.correspondent
 
 import android.os.Parcel
-import com.infomaniak.mail.utils.extensions.MergedContactDictionary
+import com.infomaniak.mail.utils.ExternalUtils.ExternalData
 import com.infomaniak.mail.utils.extensions.isEmail
 import io.realm.kotlin.types.EmbeddedRealmObject
 import io.realm.kotlin.types.annotations.Ignore
@@ -64,14 +64,13 @@ open class Recipient : EmbeddedRealmObject, Correspondent {
 
     // Computes if the Recipient is external, according to the required conditions.
     // Does not tell anything about how to display the Recipient chip when composing a new Message.
-    fun isExternal(emailDictionary: MergedContactDictionary, aliases: List<String>): Boolean {
+    fun isExternal(externalData: ExternalData): Boolean = with(externalData) {
         val isUnknownContact = email !in emailDictionary
-        val isMailerDaemon = """mailer-daemon@(?:.+\.)?infomaniak\.ch""".toRegex(RegexOption.IGNORE_CASE).matches(email)
-        val trustedDomains = listOf("@infomaniak.com", "@infomaniak.event", "@swisstransfer.com")
-        val isUntrustedDomain = email.isEmail() && trustedDomains.none { email.endsWith(it) }
         val isAlias = email in aliases
+        val isUntrustedDomain = email.isEmail() && trustedDomains.none(email::endsWith)
+        val isMailerDaemon = """mailer-daemon@(?:.+\.)?infomaniak\.ch""".toRegex(RegexOption.IGNORE_CASE).matches(email)
 
-        return isUnknownContact && !isMailerDaemon && isUntrustedDomain && !isAlias
+        return@with isUnknownContact && !isAlias && isUntrustedDomain && !isMailerDaemon
     }
 
     fun quotedDisplayName(): String = "${("$name ").ifBlank { "" }}<$email>"

Diff for: app/src/main/java/com/infomaniak/mail/data/models/mailbox/Mailbox.kt

@@ -62,8 +62,6 @@ class Mailbox : RealmObject {
     @SerialName("unseen_messages")
     var unreadCountRemote: Int = 0
     var aliases: RealmList<String> = realmListOf()
-    @SerialName("external_mail_flag_enabled")
-    var externalMailFlagEnabled: Boolean = false
     //endregion
 
     //region Local data (Transient)
@@ -80,6 +78,10 @@ class Mailbox : RealmObject {
     var permissions: MailboxPermissions? = null
     @Transient
     private var _featureFlags: RealmSet<String> = realmSetOf()
+    @Transient
+    var externalMailFlagEnabled: Boolean = false
+    @Transient
+    var trustedDomains: RealmList<String> = realmListOf()
     //endregion
 
     //region UI data (Transient & Ignore)

Diff for: app/src/main/java/com/infomaniak/mail/data/models/mailbox/MailboxExternalMailInfo.kt

@@ -0,0 +1,29 @@
+/*
+ * Infomaniak Mail - Android
+ * Copyright (C) 2024 Infomaniak Network SA
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+package com.infomaniak.mail.data.models.mailbox
+
+import kotlinx.serialization.SerialName
+import kotlinx.serialization.Serializable
+
+@Serializable
+data class MailboxExternalMailInfo(
+    @SerialName("external_mail_flag_enabled")
+    val externalMailFlagEnabled: Boolean = false,
+    @SerialName("domains")
+    val trustedDomains: List<String> = emptyList(),
+)

Diff for: app/src/main/java/com/infomaniak/mail/ui/MainViewModel.kt

@@ -63,6 +63,7 @@ import com.infomaniak.mail.utils.extensions.*
 import com.infomaniak.mail.views.itemViews.AvatarMergedContactData
 import dagger.hilt.android.lifecycle.HiltViewModel
 import io.realm.kotlin.ext.copyFromRealm
+import io.realm.kotlin.ext.toRealmList
 import io.realm.kotlin.notifications.ResultsChange
 import kotlinx.coroutines.*
 import kotlinx.coroutines.flow.*
@@ -279,6 +280,7 @@ class MainViewModel @Inject constructor(
             updatePermissions(mailbox)
             updateSignatures(mailbox)
             updateFeatureFlag(mailbox)
+            updateExternalMailInfo(mailbox)
 
             // This update is blocking because we need it for the rest of the flow : `selectFolder()` needs the Folders.
             updateFolders(mailbox)
@@ -341,6 +343,19 @@ class MainViewModel @Inject constructor(
         sharedUtils.updateAiFeatureFlag(mailbox.objectId, mailbox.uuid)
     }
 
+    private fun updateExternalMailInfo(mailbox: Mailbox) = viewModelScope.launch(ioCoroutineContext) {
+        SentryLog.d(TAG, "Force refresh External Mail info")
+        with(ApiRepository.getExternalMailInfo(mailbox.hostingId, mailbox.mailboxName)) {
+            if (!isSuccess()) return@launch
+            data?.let { externalMailInfo ->
+                mailboxController.updateMailbox(mailbox.objectId) {
+                    it.externalMailFlagEnabled = externalMailInfo.externalMailFlagEnabled
+                    it.trustedDomains = externalMailInfo.trustedDomains.toRealmList()
+                }
+            }
+        }
+    }
+
     private fun updateFolders(mailbox: Mailbox) {
         SentryLog.d(TAG, "Force refresh Folders")
         ApiRepository.getFolders(mailbox.uuid).data?.let { folders ->

Diff for: app/src/main/java/com/infomaniak/mail/ui/main/thread/SubjectFormatter.kt

@@ -27,6 +27,7 @@ import androidx.core.content.res.ResourcesCompat
 import com.infomaniak.mail.MatomoMail.trackExternalEvent
 import com.infomaniak.mail.R
 import com.infomaniak.mail.data.models.thread.Thread
+import com.infomaniak.mail.utils.ExternalUtils.ExternalData
 import com.infomaniak.mail.utils.ExternalUtils.findExternalRecipients
 import com.infomaniak.mail.utils.Utils
 import com.infomaniak.mail.utils.extensions.MergedContactDictionary
@@ -56,7 +57,9 @@ class SubjectFormatter @Inject constructor(private val appContext: Context) {
     ): CharSequence {
         if (!externalMailFlagEnabled) return previousContent
 
-        val (externalRecipientEmail, externalRecipientQuantity) = thread.findExternalRecipients(emailDictionary, aliases)
+        val (externalRecipientEmail, externalRecipientQuantity) = thread.findExternalRecipients(
+            externalData = ExternalData(emailDictionary, aliases, trustedDomains),
+        )
         if (externalRecipientQuantity == 0) return previousContent
 
         return postFixWithExternal(previousContent, externalRecipientQuantity, externalRecipientEmail, onExternalClicked)
@@ -135,6 +138,7 @@ class SubjectFormatter @Inject constructor(private val appContext: Context) {
         val emailDictionary: MergedContactDictionary,
         val aliases: List<String>,
         val externalMailFlagEnabled: Boolean,
+        val trustedDomains: List<String>,
     )
 
     data class EllipsizeConfiguration(

Diff for: app/src/main/java/com/infomaniak/mail/ui/main/thread/ThreadFragment.kt

@@ -62,6 +62,7 @@ import com.infomaniak.mail.ui.main.SnackbarManager
 import com.infomaniak.mail.ui.main.folder.TwoPaneFragment
 import com.infomaniak.mail.ui.main.folder.TwoPaneViewModel
 import com.infomaniak.mail.ui.main.folder.TwoPaneViewModel.NavData
+import com.infomaniak.mail.ui.main.thread.SubjectFormatter.SubjectData
 import com.infomaniak.mail.ui.main.thread.ThreadAdapter.ContextMenuType
 import com.infomaniak.mail.ui.main.thread.ThreadAdapter.ThreadAdapterCallbacks
 import com.infomaniak.mail.ui.main.thread.actions.AttachmentActionsBottomSheetDialogArgs
@@ -424,11 +425,12 @@ class ThreadFragment : Fragment() {
         threadViewModel.assembleSubjectData(mainViewModel.mergedContactsLive).observe(viewLifecycleOwner) { result ->
 
             val (subjectWithoutTags, subjectWithTags) = subjectFormatter.generateSubjectContent(
-                subjectData = SubjectFormatter.SubjectData(
+                subjectData = SubjectData(
                     thread = result.thread ?: return@observe,
                     emailDictionary = result.mergedContacts ?: emptyMap(),
                     aliases = result.mailbox?.aliases ?: emptyList(),
                     externalMailFlagEnabled = result.mailbox?.externalMailFlagEnabled ?: false,
+                    trustedDomains = result.mailbox?.trustedDomains ?: emptyList(),
                 ),
             ) { description ->
                 informationDialog.show(

Diff for: app/src/main/java/com/infomaniak/mail/ui/newMessage/NewMessageExternalsManager.kt

@@ -22,9 +22,9 @@ import com.infomaniak.mail.MatomoMail.trackExternalEvent
 import com.infomaniak.mail.R
 import com.infomaniak.mail.databinding.FragmentNewMessageBinding
 import com.infomaniak.mail.ui.alertDialogs.InformationAlertDialog
+import com.infomaniak.mail.utils.ExternalUtils.ExternalData
 import com.infomaniak.mail.utils.ExternalUtils.findExternalRecipientForNewMessage
 import com.infomaniak.mail.utils.Utils
-import com.infomaniak.mail.utils.extensions.MergedContactDictionary
 import dagger.hilt.android.scopes.FragmentScoped
 import javax.inject.Inject
 
@@ -49,28 +49,30 @@ class NewMessageExternalsManager @Inject constructor() : NewMessageManager() {
 
     fun observeExternals(arrivedFromExistingDraft: Boolean) = with(newMessageViewModel) {
         Utils.waitInitMediator(initResult, mergedContacts).observe(viewLifecycleOwner) { (_, mergedContacts) ->
-            val externalMailFlagEnabled = currentMailbox.externalMailFlagEnabled
-            val shouldWarnForExternal = externalMailFlagEnabled && !arrivedFromExistingDraft
-            val emailDictionary = mergedContacts.second
-            val aliases = currentMailbox.aliases
+            val shouldWarnForExternal = currentMailbox.externalMailFlagEnabled && !arrivedFromExistingDraft
+            val externalData = ExternalData(
+                emailDictionary = mergedContacts.second,
+                aliases = currentMailbox.aliases,
+                trustedDomains = currentMailbox.trustedDomains,
+            )
 
-            updateFields(shouldWarnForExternal, emailDictionary, aliases)
-            updateBanner(shouldWarnForExternal, emailDictionary, aliases)
+            updateFields(shouldWarnForExternal, externalData)
+            updateBanner(shouldWarnForExternal, externalData)
         }
     }
 
-    private fun updateFields(shouldWarnForExternal: Boolean, emailDictionary: MergedContactDictionary, aliases: List<String>) {
+    private fun updateFields(shouldWarnForExternal: Boolean, externalData: ExternalData) {
         with(binding) {
-            toField.updateExternals(shouldWarnForExternal, emailDictionary, aliases)
-            ccField.updateExternals(shouldWarnForExternal, emailDictionary, aliases)
-            bccField.updateExternals(shouldWarnForExternal, emailDictionary, aliases)
+            toField.updateExternals(shouldWarnForExternal, externalData)
+            ccField.updateExternals(shouldWarnForExternal, externalData)
+            bccField.updateExternals(shouldWarnForExternal, externalData)
         }
     }
 
-    private fun updateBanner(shouldWarnForExternal: Boolean, emailDictionary: MergedContactDictionary, aliases: List<String>) {
+    private fun updateBanner(shouldWarnForExternal: Boolean, externalData: ExternalData) {
         with(newMessageViewModel) {
             if (shouldWarnForExternal && !isExternalBannerManuallyClosed) {
-                val (externalEmail, externalQuantity) = draft.findExternalRecipientForNewMessage(aliases, emailDictionary)
+                val (externalEmail, externalQuantity) = draft.findExternalRecipientForNewMessage(externalData)
                 externalRecipientCount.value = externalEmail to externalQuantity
             }
         }

Diff for: app/src/main/java/com/infomaniak/mail/ui/newMessage/RecipientFieldView.kt

@@ -43,8 +43,8 @@ import com.infomaniak.mail.data.models.correspondent.Recipient
 import com.infomaniak.mail.databinding.ViewContactChipContextMenuBinding
 import com.infomaniak.mail.databinding.ViewRecipientFieldBinding
 import com.infomaniak.mail.ui.main.SnackbarManager
+import com.infomaniak.mail.utils.ExternalUtils.ExternalData
 import com.infomaniak.mail.utils.UiUtils
-import com.infomaniak.mail.utils.extensions.MergedContactDictionary
 import com.infomaniak.mail.utils.extensions.isEmail
 import com.infomaniak.mail.utils.extensions.toggleChevron
 import dagger.hilt.android.AndroidEntryPoint
@@ -417,11 +417,11 @@ class RecipientFieldView @JvmOverloads constructor(
         return (if (recipientCount == 1) recipients.single().email else null) to recipientCount
     }
 
-    fun updateExternals(shouldWarnForExternal: Boolean, emailDictionary: MergedContactDictionary, aliases: List<String>) {
+    fun updateExternals(shouldWarnForExternal: Boolean, externalData: ExternalData) {
         for (recipient in contactChipAdapter.getRecipients()) {
             if (recipient.isManuallyEntered) continue
 
-            val shouldDisplayAsExternal = shouldWarnForExternal && recipient.isExternal(emailDictionary, aliases)
+            val shouldDisplayAsExternal = shouldWarnForExternal && recipient.isExternal(externalData)
             recipient.initDisplayAsExternal(shouldDisplayAsExternal)
 
             updateCollapsedChipValues(isSelfCollapsed)

Diff for: app/src/main/java/com/infomaniak/mail/utils/ExternalUtils.kt

@@ -23,18 +23,16 @@ import com.infomaniak.mail.data.models.thread.Thread
 import com.infomaniak.mail.utils.extensions.MergedContactDictionary
 
 object ExternalUtils {
+
     /**
      * Only returns a quantity of at most 2, used to differentiate between the singular or plural form of the dialog messages
      */
-    fun Thread.findExternalRecipients(
-        emailDictionary: MergedContactDictionary,
-        aliases: List<String>,
-    ): Pair<String?, Int> {
+    fun Thread.findExternalRecipients(externalData: ExternalData): Pair<String?, Int> {
         var externalRecipientEmail: String? = null
         var externalRecipientQuantity = 0
 
         messages.forEach { message ->
-            val (singleEmail, quantityForThisMessage) = findExternalRecipientInIterables(emailDictionary, aliases, message.from)
+            val (singleEmail, quantityForThisMessage) = findExternalRecipientInIterables(externalData, message.from)
 
             externalRecipientQuantity += quantityForThisMessage
             if (externalRecipientQuantity > 1) return null to 2
@@ -45,14 +43,12 @@ object ExternalUtils {
         return externalRecipientEmail to externalRecipientQuantity
     }
 
-    fun Draft.findExternalRecipientForNewMessage(
-        aliases: List<String>,
-        emailDictionary: MergedContactDictionary,
-    ): Pair<String?, Int> {
+    fun Draft.findExternalRecipientForNewMessage(externalData: ExternalData): Pair<String?, Int> {
         val to = to.onlyAutomaticallyAddedOnes()
         val cc = cc.onlyAutomaticallyAddedOnes()
         val bcc = bcc.onlyAutomaticallyAddedOnes()
-        return findExternalRecipientInIterables(emailDictionary, aliases, to, cc, bcc)
+
+        return findExternalRecipientInIterables(externalData, to, cc, bcc)
     }
 
     private fun List<Recipient>.onlyAutomaticallyAddedOnes(): List<Recipient> = filter { !it.isManuallyEntered }
@@ -61,16 +57,15 @@ object ExternalUtils {
      * Only returns a quantity of at most 2, used to differentiate between the singular or plural form of the dialog messages
      */
     private fun findExternalRecipientInIterables(
-        emailDictionary: MergedContactDictionary,
-        aliases: List<String>,
+        externalData: ExternalData,
         vararg recipientLists: Iterable<Recipient>,
     ): Pair<String?, Int> {
         var externalRecipientEmail: String? = null
         var externalRecipientQuantity = 0
 
         recipientLists.forEach { recipientList ->
             recipientList.forEach { recipient ->
-                if (recipient.isExternal(emailDictionary, aliases)) {
+                if (recipient.isExternal(externalData)) {
                     if (externalRecipientQuantity++ == 0) {
                         externalRecipientEmail = recipient.email
                     } else {
@@ -82,4 +77,10 @@ object ExternalUtils {
 
         return externalRecipientEmail to externalRecipientQuantity
     }
+
+    data class ExternalData(
+        val emailDictionary: MergedContactDictionary,
+        val aliases: List<String>,
+        val trustedDomains: List<String>,
+    )
 }