Create & handle "Inbox" notification checkbox in Flutter

[tddang-linagora]

Description

Create a checkbox to control Inbox push notification. This checkbox will only appear if the toggle created in #2877 is on, and the checkbox's state will be cache with Hive for Android & Keychain for iOS. When this checkbox is turned on, user will only receive push notification when new email comes to Inbox mailbox. When off, user will receive push notification for every new email from all mailboxes.

Definitions of done

For Android

• [ ] #2921

For iOS

• [ ] #2924

[hoangdat]

please more detail on the technical guideline, how to prevent notification?

[tddang-linagora]

Entitlement needed

• https://stackoverflow.com/a/46157854/23727759
• https://developer.apple.com/documentation/bundleresources/entitlements/com_apple_developer_usernotifications_filtering

[tddang-linagora]

@hoangdat @dab246 Should we save the setting for each user and restore that setting when user login or whenever user is log out, this setting will be cleared?

[hoangdat]

@hoangdat @dab246 Should we save the setting for each user and restore that setting when user login or whenever user is log out, this setting will be cleared?

IMO, still a good choice to still save this settings event user logout. How about keychain item if we delete app in iOS?

[tddang-linagora]

How about keychain item if we delete app in iOS?

The user's data persists even after the app is deleted if we use Keychain. If that's not what we want, changing the iOS's storage of choice from Keychain to SharedPreferences is better.

[hoangdat]

if we change to SharedPreference how to prevent notification in NSE?

[tddang-linagora]

if we change to SharedPreference how to prevent notification in NSE?

Instead of from Keychain, we will get the user's data from NSUserDefaults if SharedPreferences is used. Either case, an entitlement has to be added to prevent notification in NSE. see this comment

[dab246]

IMO, we should use Hive database, which is better stored as objects rather than as primitive variables in SharePreference

[tddang-linagora]

IMO, we should use Hive database, which is better stored as objects rather than as primitive variables in SharePreference

I only intend to store a boolean so Hive is a bit overkill.

[dab246]

IMO, we should use Hive database, which is better stored as objects rather than as primitive variables in SharePreference

I only intend to store a boolean so Hive is a bit overkill.

So how does it support multiple accounts? How to manage it?

[tddang-linagora]

So how does it support multiple accounts? How to manage it?

Data is saved with SharedPreferences using key-value pair. The key is where I intend to separate those values. E.g. The form of the key might take is "accountId-mailboxRole"

[dab246]

So how does it support multiple accounts? How to manage it?

Data is saved with SharedPreferences using key-value pair. The key is where I intend to separate those values. E.g. The form of the key might take is "accountId-mailboxRole"

When we want to turn on/off notifications for more mailboxes. We have to create multiple keys for each account then will now have a data table

accountId1-mailboxRole1 : value
accountId1-mailboxRole2 : value
accountId2-mailboxRole1 : value
accountId2-mailboxRole2 : value
accountId3-mailboxRole1 : value
accountId3-mailboxRole2 : value

It can be seen that organizing such data will be very confusing and will be difficult for future developers. IMO, we should organize in a tree style

account1: {
   mailbox1 : value
   mailbox2 : value
}

account2: {
   mailbox1 : value
   mailbox2 : value
}

[tddang-linagora]

we should organize in a tree style

Sure let me update the issue's description

[tddang-linagora]

Few points need to be mentioned

• Since we cannot decide which mailbox does an email belongs to from email detail alone, an additional server request must be made to get the information of mailboxes before pushing the notification to users, in this case Inbox id
• For Android
  • Android supports push notification grouping by channels, we can separate the new emails when notification comes by:
    • Inbox category if that mailbox's id is included with the email
    • Others category for every other emails
  • Then let the user toggle these configurations inside the system's setting to control which mailbox do they want to have push notification
• For iOS
  • Since iOS does not support notification channels, we have to make a dedicated UI inside setting screen for user to toggle, and handle notification filtering inside NSE

@hoangdat @dab246 what do you think?

[dab246]

LGTM

[hoangdat]

@tddang-linagora can you try the JMAP requests to detect the email belongs to which mailbox?

[hoangdat]

Android:

• Channel notification group - use System settings

• Navigate to System settings from app

• How to find it is Inbox mailbox?

  • Create GetInboxMailboxIdInteractor: accountId - MailboxId
  • Hive
  • This interactor first call MailboxCacheManager to check for Inbox mailbox id
  • If exist, return id
  • If not, proceed with next step
  • This interactor will call method Mailbox/query for role inbox

• Inside _pushActionFromRemoteMessageBackground(), call GetInboxMailboxIdInteractor.execute() before the _mappingTypeStateToAction() call inside FcmMessageController. Add the Inbox mailbox id to EmailChangeListener.

• Inside _showLocalNotification() of EmailChangeListener, add the Inbox mailbox id to the local push notification config.

[hoangdat]

iOS:

• Share preference is not work with AppGroup
• Use UserDefault with Suite name = appGroupId
• Compare UserDefault vs KeyChain?
  • UserDefault: less security and will be removed when app is deleted
• 3rd lib?
• Key: accountId|username|key - Value: Dictionary {MailboxId: boolean} ADR-27