TF-3189 new option to enable/disable subaddressing for a personal folder

lib/features/mailbox/domain/constants/mailbox_constants.dart

@@ -16,7 +16,8 @@ class MailboxConstants {
     MailboxProperty.unreadEmails,
     MailboxProperty.unreadThreads,
     MailboxProperty.myRights,
-    MailboxProperty.namespace
+    MailboxProperty.namespace,
+    MailboxProperty.rights
   });
 
   static final List<Role> defaultMailboxRoles = [

lib/features/mailbox/domain/exceptions/null_session_or_accountid_exception.dart

@@ -0,0 +1,8 @@
+
+class NullSessionOrAccountIdException implements Exception {
+
+  NullSessionOrAccountIdException();
+
+  @override
+  String toString() => 'NullSessionOrAccountIdException: session and accountId should not be null';
+}

lib/features/mailbox/domain/exceptions/set_mailbox_rights_exception.dart

@@ -0,0 +1,8 @@
+
+class SetMailboxRightsException implements Exception {
+
+  SetMailboxRightsException();
+
+  @override
+  String toString() => 'Failed to update mailbox rights.';
+}

lib/features/mailbox/domain/model/mailbox_right_request.dart

@@ -0,0 +1,23 @@
+import 'package:equatable/equatable.dart';
+import 'package:jmap_dart_client/jmap/mail/mailbox/mailbox.dart';
+import 'package:tmail_ui_user/features/mailbox/domain/model/mailbox_subaddressing_action.dart';
+
+class MailboxRightRequest with EquatableMixin {
+
+  final MailboxSubaddressingAction subaddressingAction;
+  final MailboxId mailboxId;
+  final Map<String, List<String>?>? currentRights;
+
+  MailboxRightRequest(
+      this.mailboxId,
+      this.currentRights,
+      this.subaddressingAction
+  );
+
+  @override
+  List<Object?> get props => [
+    mailboxId,
+    currentRights,
+    subaddressingAction,
+  ];
+}

lib/features/mailbox/domain/model/mailbox_subaddressing_action.dart

@@ -0,0 +1,4 @@
+enum MailboxSubaddressingAction {
+  allow,
+  disallow,
+}

lib/features/mailbox/domain/repository/mailbox_repository.dart

@@ -19,6 +19,7 @@ import 'package:tmail_ui_user/features/mailbox/domain/model/move_mailbox_request
 import 'package:tmail_ui_user/features/mailbox/domain/model/rename_mailbox_request.dart';
 import 'package:tmail_ui_user/features/mailbox/domain/model/subscribe_mailbox_request.dart';
 import 'package:tmail_ui_user/features/mailbox/domain/model/subscribe_multiple_mailbox_request.dart';
+import 'package:tmail_ui_user/features/mailbox/domain/model/mailbox_right_request.dart';
 
 abstract class MailboxRepository {
   Stream<MailboxResponse> getAllMailbox(Session session, AccountId accountId, {Properties? properties});
@@ -46,6 +47,8 @@ abstract class MailboxRepository {
 
   Future<List<MailboxId>> subscribeMultipleMailbox(Session session, AccountId accountId, SubscribeMultipleMailboxRequest subscribeRequest);
 
+  Future<bool> handleMailboxRightRequest(Session session, AccountId accountId, MailboxRightRequest request);
+
   Future<List<Mailbox>> createDefaultMailbox(Session session, AccountId accountId, List<Role> listRole);
 
   Future<void> setRoleDefaultMailbox(Session session, AccountId accountId, List<Mailbox> listMailbox);

lib/features/mailbox/domain/state/subaddressing_mailbox_state.dart

@@ -0,0 +1,37 @@
+import 'package:core/presentation/state/failure.dart';
+import 'package:core/presentation/state/success.dart';
+import 'package:jmap_dart_client/jmap/mail/mailbox/mailbox.dart';
+import 'package:tmail_ui_user/features/base/state/ui_action_state.dart';
+import 'package:jmap_dart_client/jmap/core/state.dart' as jmap;
+import 'package:tmail_ui_user/features/mailbox/domain/model/mailbox_subaddressing_action.dart';
+
+class LoadingSubaddressingMailbox extends LoadingState {}
+
+class SubaddressingSuccess extends UIActionState {
+  final MailboxId mailboxId;
+  final MailboxSubaddressingAction subaddressingAction;
+
+  SubaddressingSuccess(
+    this.mailboxId, 
+    this.subaddressingAction,
+    {
+      jmap.State? currentEmailState,
+      jmap.State? currentMailboxState,
+    }
+  ) : super(currentEmailState, currentMailboxState);
+
+  @override
+  List<Object?> get props => [
+    mailboxId,
+    subaddressingAction,
+    ...super.props
+  ];
+}
+
+class SubaddressingFailure extends FeatureFailure {
+
+  SubaddressingFailure(dynamic exception) : super(exception: exception);
+
+  SubaddressingFailure.withException(Exception exception)
+      : super(exception: exception);
+}

lib/features/mailbox/domain/usecases/subaddressing_interactor.dart

@@ -0,0 +1,36 @@
+import 'package:core/presentation/state/failure.dart';
+import 'package:core/presentation/state/success.dart';
+import 'package:dartz/dartz.dart';
+import 'package:jmap_dart_client/jmap/account_id.dart';
+import 'package:jmap_dart_client/jmap/core/session/session.dart';
+import 'package:tmail_ui_user/features/mailbox/domain/model/mailbox_right_request.dart';
+import 'package:tmail_ui_user/features/mailbox/domain/repository/mailbox_repository.dart';
+import 'package:tmail_ui_user/features/mailbox/domain/state/subaddressing_mailbox_state.dart';
+
+class SubaddressingInteractor {
+  final MailboxRepository _mailboxRepository;
+
+  SubaddressingInteractor(this._mailboxRepository);
+
+  Stream<Either<Failure, Success>> execute(Session session, AccountId accountId, MailboxRightRequest mailboxRightRequest) async* {
+    try {
+      yield Right<Failure, Success>(LoadingSubaddressingMailbox());
+
+      final currentMailboxState = await _mailboxRepository.getMailboxState(session, accountId);
+
+      final result = await _mailboxRepository.handleMailboxRightRequest(session, accountId, mailboxRightRequest);
+
+      if (result) {
+        yield Right<Failure, Success>(SubaddressingSuccess(
+          mailboxRightRequest.mailboxId, 
+          currentMailboxState: currentMailboxState,
+          mailboxRightRequest.subaddressingAction));
+      } else {
+        yield Left<Failure, Success>(SubaddressingFailure(null));
+      }
+
+    } catch (exception) {
+      yield Left<Failure, Success>(SubaddressingFailure(exception));
+    }
+  }
+}