TF-221 Create emails with User-Agent header

lib/http/converter/individual_header_identifier_converter.dart

@@ -0,0 +1,11 @@
+
+import 'package:jmap_dart_client/jmap/mail/email/individual_header_identifier.dart';
+
+class IndividualHeaderIdentifierNullableConverter {
+
+  MapEntry<IndividualHeaderIdentifier, String?> parseEntry(String key, String? value) => MapEntry(IndividualHeaderIdentifier(key), value);
+
+  String? toJson(Map<IndividualHeaderIdentifier, String?>? header, IndividualHeaderIdentifier individualHeaderIdentifier) {
+    return header?[individualHeaderIdentifier];
+  }
+}

lib/jmap/mail/email/email.dart

@@ -4,6 +4,7 @@ import 'package:jmap_dart_client/http/converter/email/email_mailbox_ids_converte
 import 'package:jmap_dart_client/http/converter/email_id_converter.dart';
 import 'package:jmap_dart_client/http/converter/id_nullable_converter.dart';
 import 'package:jmap_dart_client/http/converter/email/email_keyword_identifier_converter.dart';
+import 'package:jmap_dart_client/http/converter/individual_header_identifier_converter.dart';
 import 'package:jmap_dart_client/http/converter/message_ids_header_value_converter.dart';
 import 'package:jmap_dart_client/http/converter/thread_id_nullable_converter.dart';
 import 'package:jmap_dart_client/http/converter/unsigned_int_nullable_converter.dart';
@@ -17,6 +18,7 @@ import 'package:jmap_dart_client/jmap/mail/email/email_address.dart';
 import 'package:jmap_dart_client/jmap/mail/email/email_body_part.dart';
 import 'package:jmap_dart_client/jmap/mail/email/email_body_value.dart';
 import 'package:jmap_dart_client/jmap/mail/email/email_header.dart';
+import 'package:jmap_dart_client/jmap/mail/email/individual_header_identifier.dart';
 import 'package:jmap_dart_client/jmap/mail/email/keyword_identifier.dart';
 import 'package:jmap_dart_client/jmap/mail/mailbox/mailbox.dart';
 
@@ -52,6 +54,7 @@ class Email with EquatableMixin {
   final Set<EmailBodyPart>? attachments;
   final EmailBodyPart? bodyStructure;
   final Map<PartId, EmailBodyValue>? bodyValues;
+  final Map<IndividualHeaderIdentifier, String?>? headerUserAgent;
 
   Email(
     this.id,
@@ -80,6 +83,7 @@ class Email with EquatableMixin {
     this.attachments,
     this.bodyStructure,
     this.bodyValues,
+    this.headerUserAgent,
   });
 
   factory Email.fromJson(Map<String, dynamic> json) {
@@ -118,6 +122,8 @@ class Email with EquatableMixin {
           ? null
           : EmailBodyPart.fromJson(json['bodyStructure'] as Map<String, dynamic>),
       bodyValues: (json['bodyValues'] as Map<String, dynamic>?)?.map((key, value) => EmailBodyValueConverter().parseEntry(key, value)),
+      headerUserAgent: (json[IndividualHeaderIdentifier.headerUserAgent.value] as Map<String, dynamic>?)?.map((key, value) =>
+          MapEntry(IndividualHeaderIdentifier(key), value as String?)),
     );
   }
 
@@ -157,6 +163,7 @@ class Email with EquatableMixin {
     writeNotNull('attachments', attachments?.map((attachment) => attachment.toJson()).toList());
     writeNotNull('bodyStructure', bodyStructure?.toJson());
     writeNotNull('bodyValues', bodyValues?.map((key, value) => EmailBodyValueConverter().toJson(key, value)));
+    writeNotNull(IndividualHeaderIdentifier.headerUserAgent.value, IndividualHeaderIdentifierNullableConverter().toJson(headerUserAgent, IndividualHeaderIdentifier.headerUserAgent));
     return val;
   }
 

lib/jmap/mail/email/individual_header_identifier.dart

@@ -0,0 +1,12 @@
+import 'package:equatable/equatable.dart';
+
+class IndividualHeaderIdentifier with EquatableMixin {
+  static final headerUserAgent = IndividualHeaderIdentifier('header:User-Agent:asText');
+
+  final String value;
+
+  IndividualHeaderIdentifier(this.value);
+
+  @override
+  List<Object> get props => [value];
+}

test/jmap/email/set/set_email_method_test.dart

@@ -11,6 +11,7 @@ import 'package:jmap_dart_client/jmap/mail/email/email.dart';
 import 'package:jmap_dart_client/jmap/mail/email/email_address.dart';
 import 'package:jmap_dart_client/jmap/mail/email/email_body_part.dart';
 import 'package:jmap_dart_client/jmap/mail/email/email_body_value.dart';
+import 'package:jmap_dart_client/jmap/mail/email/individual_header_identifier.dart';
 import 'package:jmap_dart_client/jmap/mail/email/keyword_identifier.dart';
 import 'package:jmap_dart_client/jmap/mail/email/set/set_email_method.dart';
 import 'package:jmap_dart_client/jmap/mail/email/set/set_email_response.dart';
@@ -141,5 +142,124 @@ void main() {
 
       expect(setEmailResponse!.created![Id('aa1234')], equals(expectedCreated));
     });
+
+    test('set email method and response parsing with header User-Agent', () async {
+      final baseOption  = BaseOptions(method: 'POST');
+      final dio = Dio(baseOption)
+        ..options.baseUrl = 'http://domain.com';
+      final dioAdapter = DioAdapter(dio: dio);
+      dioAdapter.onPost(
+          '/jmap',
+              (server) => server.reply(200, {
+            "sessionState": "2c9f1b12-b35a-43e6-9af2-0106fb53a943",
+            "methodResponses": [[
+              "Email/set",
+              {
+                "accountId":"3ce33c876a726662c627746eb9537a1d13c2338193ef27bd051a3ce5c0fe5b12",
+                "oldState":"234c9ee0-0596-11ec-b153-2fef1ee78d9e",
+                "newState":"234c9ee0-0596-11ec-b153-2fef1ee78d9e",
+                "created": {
+                  "aa1234": {
+                    "id":"29a7f870-0596-11ec-b153-2fef1ee78d9e",
+                    "blobId":"29a7f870-0596-11ec-b153-2fef1ee78d9e",
+                    "threadId":"29a7f870-0596-11ec-b153-2fef1ee78d9e",
+                    "size": 657
+                  }
+                }
+              },
+              "c0"
+            ]]
+          }),
+          data: {
+            'using': [
+              'urn:ietf:params:jmap:mail',
+              'urn:ietf:params:jmap:core'
+            ],
+            'methodCalls': [[
+              'Email/set',
+              {
+                'accountId': '3ce33c876a726662c627746eb9537a1d13c2338193ef27bd051a3ce5c0fe5b12',
+                'create': {
+                  'aa1234': {
+                    'id': 'ea12345',
+                    'mailboxIds': {
+                      'fe00a5c0-0584-11ec-b153-2fef1ee78d9e': true
+                    },
+                    'keywords': {
+                      '\$seen': true
+                    },
+                    'subject': 'set email 3',
+                    'sender': [{
+                      'name: bob, email: bob@email'
+                    }],
+                    'from' : [{
+                      'name': 'alice', 'email': 'alice@email'
+                    }],
+                    'to': [{
+                      'name': 'dcu', 'email': 'dcu@email'
+                    }],
+                    'replyTo': [{
+                      'name': 'bob', 'email': 'bob@email'
+                    }],
+                    'htmlBody': [{
+                      'partId': 'a49d', 'type': 'text/html'
+                    }],
+                    'bodyValues': {
+                      'a49d': {
+                        'value': 'test html html',
+                        'isEncodingProblem': false,
+                        'isTruncated': false
+                      }
+                    },
+                    'header:User-Agent:asText': 'Android/1.0.0 TeamMail/1.0'
+                  }
+                }
+              },
+              'c0'
+            ]
+            ]
+          },
+          headers: {
+            "accept": "application/json;jmapVersion=rfc-8621",
+            "content-type": "application/json; charset=utf-8"
+          }
+      );
+
+      final setEmailMethod = SetEmailMethod(AccountId(Id('3ce33c876a726662c627746eb9537a1d13c2338193ef27bd051a3ce5c0fe5b12')))
+        ..addCreate(Id('aa1234'),
+            Email(
+              EmailId(Id('ea12345')),
+              mailboxIds: {
+                MailboxId(Id('fe00a5c0-0584-11ec-b153-2fef1ee78d9e')): true
+              },
+              keywords: {
+                KeyWordIdentifier.emailSeen: true
+              },
+              replyTo: {EmailAddress('bob', 'bob@email')},
+              from: {EmailAddress('alice', 'alice@email')},
+              sender: {EmailAddress('bob', 'bob@email')},
+              to: {EmailAddress('dcu', 'dcu@email')},
+              subject: 'set email 3',
+              htmlBody: {EmailBodyPart(partId: PartId('a49d'), type: MediaType.parse('text/html'))},
+              bodyValues: {
+                PartId('a49d'): EmailBodyValue('test html html', false, false)
+              },
+              headerUserAgent: {IndividualHeaderIdentifier.headerUserAgent : 'Android/1.0.0 TeamMail/1.0'}
+            )
+        );
+
+      final httpClient = HttpClient(dio);
+      final requestBuilder = JmapRequestBuilder(httpClient, ProcessingInvocation());
+      final setEmailInvocation = requestBuilder.invocation(setEmailMethod);
+      final response = await (requestBuilder..usings(setEmailMethod.requiredCapabilities))
+          .build()
+          .execute();
+
+      final setEmailResponse = response.parse<SetEmailResponse>(
+          setEmailInvocation.methodCallId,
+          SetEmailResponse.deserialize);
+
+      expect(setEmailResponse!.created![Id('aa1234')], equals(expectedCreated));
+    });
   });
 }