feat: improve serialization and API

analysis_options.yaml

@@ -63,7 +63,6 @@ linter:
     #- flutter_style_todos # Flutter todos are to verbose for our requirements.
     - hash_and_equals
     - implementation_imports
-    - invariant_booleans
     - iterable_contains_unrelated_type
     # - join_return_with_assignment # leads to less readable code IMHO
     - library_names

build.yaml

@@ -0,0 +1,20 @@
+targets:
+  $default:
+    builders:
+      json_serializable:
+        options:
+          # Options configure how source code is generated for every
+          # `@JsonSerializable`-annotated class in the package.
+          # any_map: false
+          # checked: false
+          # constructor: ""
+          # create_factory: true
+          # create_field_map: false
+          # create_per_field_to_json: false
+          # create_to_json: true
+          # disallow_unrecognized_keys: false
+          explicit_to_json: true
+          # field_rename: none
+          # generic_argument_factories: false
+          # ignore_unannotated: false
+          # include_if_null: true

lib/src/imap/message_sequence.dart

@@ -321,8 +321,11 @@ class MessageSequence {
   /// optionally skipping the first [skip] entries.
   /// When the [pageNumber] is 1 and the [pageSize] is equals or bigger
   /// than the [length] of this sequence, this sequence is returned.
-  MessageSequence subsequenceFromPage(int pageNumber, int pageSize,
-      {int skip = 0}) {
+  MessageSequence subsequenceFromPage(
+    int pageNumber,
+    int pageSize, {
+    int skip = 0,
+  }) {
     if (pageNumber == 1 && pageSize >= length) {
       return this;
     }

lib/src/mail/mail_account.dart

@@ -22,7 +22,7 @@ class MailAccount {
     this.userName = '',
     this.outgoingClientDomain = 'enough.de',
     this.supportsPlusAliases = false,
-    this.aliases,
+    this.aliases = const [],
     this.attributes = const {},
   });
 
@@ -46,7 +46,7 @@ class MailAccount {
     String outgoingClientDomain = 'enough.de',
     String? loginName,
     bool supportsPlusAliases = false,
-    List<MailAddress>? aliases,
+    List<MailAddress> aliases = const [],
   }) =>
       MailAccount.fromDiscoveredSettingsWithAuth(
         name: name,
@@ -77,7 +77,7 @@ class MailAccount {
     String outgoingClientDomain = 'enough.de',
     MailAuthentication? outgoingAuth,
     bool supportsPlusAliases = false,
-    List<MailAddress>? aliases,
+    List<MailAddress> aliases = const [],
   }) {
     final incoming = MailServerConfig(
       authentication: auth,
@@ -133,7 +133,7 @@ class MailAccount {
     SocketType incomingSocketType = SocketType.ssl,
     SocketType outgoingSocketType = SocketType.ssl,
     bool supportsPlusAliases = false,
-    List<MailAddress>? aliases,
+    List<MailAddress> aliases = const [],
   }) =>
       MailAccount.fromManualSettingsWithAuth(
         name: name,
@@ -185,7 +185,7 @@ class MailAccount {
     SocketType incomingSocketType = SocketType.ssl,
     SocketType outgoingSocketType = SocketType.ssl,
     bool supportsPlusAliases = false,
-    List<MailAddress>? aliases,
+    List<MailAddress> aliases = const [],
   }) {
     final incoming = MailServerConfig(
       authentication: auth,
@@ -246,7 +246,7 @@ class MailAccount {
   MailAddress get fromAddress => MailAddress(userName, email);
 
   /// Optional list of associated aliases
-  final List<MailAddress>? aliases;
+  final List<MailAddress> aliases;
 
   /// Optional indicator if the mail service supports + based aliases
   ///
@@ -279,7 +279,7 @@ class MailAccount {
       other.incoming == incoming &&
       other.outgoing == outgoing &&
       other.supportsPlusAliases == supportsPlusAliases &&
-      other.aliases?.length == aliases?.length &&
+      other.aliases.length == aliases.length &&
       other.attributes.length == attributes.length;
 
   @override
@@ -290,6 +290,8 @@ class MailAccount {
 
   /// Creates a new [MailAccount] with the given settings or by copying
   /// the current settings.
+  ///
+  /// Compare [copyWithAttribute], [copyWithAlias]
   MailAccount copyWith({
     String? name,
     String? email,
@@ -312,6 +314,64 @@ class MailAccount {
         supportsPlusAliases: supportsPlusAliases ?? this.supportsPlusAliases,
         attributes: attributes ?? this.attributes,
       );
+
+  /// Copies this account with the attribute [name] and [value]
+  ///
+  /// Compare [copyWith], [copyWithAlias]
+  MailAccount copyWithAttribute(String name, dynamic value) {
+    final attributes =
+        this.attributes.isEmpty ? <String, dynamic>{} : this.attributes;
+    attributes[name] = value;
+
+    return MailAccount(
+      name: name,
+      email: email,
+      userName: userName,
+      incoming: incoming,
+      outgoing: outgoing,
+      aliases: aliases,
+      outgoingClientDomain: outgoingClientDomain,
+      supportsPlusAliases: supportsPlusAliases,
+      attributes: attributes,
+    );
+  }
+
+  /// Copies this account with the additional [alias]
+  ///
+  /// Compare [copyWith], [copyWithAttribute]
+  MailAccount copyWithAlias(MailAddress alias) {
+    final aliases = this.aliases.isEmpty ? <MailAddress>[] : this.aliases
+      ..add(alias);
+
+    return MailAccount(
+      name: name,
+      email: email,
+      userName: userName,
+      incoming: incoming,
+      outgoing: outgoing,
+      aliases: aliases,
+      outgoingClientDomain: outgoingClientDomain,
+      supportsPlusAliases: supportsPlusAliases,
+      attributes: attributes,
+    );
+  }
+
+  /// Convenience method to update the incoming and outgoing authentication
+  /// user name for identifying the user towards the mail service.
+  MailAccount copyWithAuthenticationUserName(String authenticationUserName) {
+    var incomingAuth = incoming.authentication;
+    if (incomingAuth is UserNameBasedAuthentication) {
+      incomingAuth = incomingAuth.copyWithUserName(authenticationUserName);
+    }
+    var outgoingAuth = outgoing.authentication;
+    if (outgoingAuth is UserNameBasedAuthentication) {
+      outgoingAuth = outgoingAuth.copyWithUserName(authenticationUserName);
+    }
+    return copyWith(
+      incoming: incoming.copyWith(authentication: incomingAuth),
+      outgoing: outgoing.copyWith(authentication: outgoingAuth),
+    );
+  }
 }
 
 /// Configuration of a specific mail service like IMAP, POP3 or SMTP

lib/src/mail/mail_authentication.dart

@@ -55,6 +55,9 @@ abstract class UserNameBasedAuthentication extends MailAuthentication {
 
   /// The user name
   final String userName;
+
+  /// Copies this authentication with the new [userName]
+  UserNameBasedAuthentication copyWithUserName(String userName);
 }
 
 /// Provides a simple username-password authentication
@@ -111,6 +114,14 @@ class PlainAuthentication extends UserNameBasedAuthentication {
 
   @override
   int get hashCode => userName.hashCode | password.hashCode;
+
+  @override
+  UserNameBasedAuthentication copyWithUserName(String userName) =>
+      PlainAuthentication(userName, password);
+
+  /// Copies this authentication with the given values
+  PlainAuthentication copyWith({String? userName, String? password}) =>
+      PlainAuthentication(userName ?? this.userName, password ?? this.password);
 }
 
 /// Contains an OAuth compliant token
@@ -230,8 +241,12 @@ class OauthAuthentication extends UserNameBasedAuthentication {
   final OauthToken token;
 
   @override
-  Future<void> authenticate(ServerConfig serverConfig,
-      {ImapClient? imap, PopClient? pop, SmtpClient? smtp}) async {
+  Future<void> authenticate(
+    ServerConfig serverConfig, {
+    ImapClient? imap,
+    PopClient? pop,
+    SmtpClient? smtp,
+  }) async {
     final userName = this.userName;
     final accessToken = token.accessToken;
     switch (serverConfig.type) {
@@ -260,6 +275,13 @@ class OauthAuthentication extends UserNameBasedAuthentication {
   int get hashCode => userName.hashCode | token.hashCode;
 
   /// Copies this [OauthAuthentication] with the given [token]
-  OauthAuthentication copyWith(OauthToken token) =>
+  OauthAuthentication copyWith({String? userName, OauthToken? token}) =>
+      OauthAuthentication(
+        userName ?? this.userName,
+        token ?? this.token,
+      );
+
+  @override
+  UserNameBasedAuthentication copyWithUserName(String userName) =>
       OauthAuthentication(userName, token);
 }

lib/src/mail/mail_client.dart

@@ -293,13 +293,13 @@ class MailClient {
         final newToken =
             auth.token.copyWith(refreshed.accessToken, refreshed.expiresIn);
         final incoming = account.incoming.copyWith(
-          authentication: auth.copyWith(newToken),
+          authentication: auth.copyWith(token: newToken),
         );
         var outgoing = account.outgoing;
         final outAuth = outgoing.authentication;
         if (outAuth is OauthAuthentication) {
           outgoing = outgoing.copyWith(
-            authentication: outAuth.copyWith(newToken),
+            authentication: outAuth.copyWith(token: newToken),
           );
         }
         _account = _account.copyWith(

lib/src/mail_address.dart

@@ -178,6 +178,10 @@ class MailAddress {
     return null;
   }
 
+  /// Copies this mail address with the given values
+  MailAddress copyWith({String? personalName, String? email}) =>
+      MailAddress(personalName ?? this.personalName, email ?? this.email);
+
   @override
   int get hashCode => email.hashCode + (personalName?.hashCode ?? 0);
 

pubspec.yaml

@@ -13,14 +13,14 @@ dependencies:
   encrypt: ^5.0.0
   enough_convert: ^1.5.0
   event_bus: ^2.0.0
-  intl: ^0.17.0
-  json_annotation: ^4.6.0
+  intl: ^0.18.0
+  json_annotation: ^4.8.0
   pointycastle: ^3.6.0
   xml: '>=6.0.0 <7.0.0'
 
 
 dev_dependencies:
-  build_runner: ^2.2.0
+  build_runner: ^2.3.0
   json_serializable: ^6.3.0
   lints: ^2.0.1
   test: ^1.20.1