Implement MDN/send method/response

[sherlockvn]

Issues

linagora/tmail-flutter#878

[dab246]

Use MDN/send

Header

Accept: application/json; charset=UTF-8; jmapVersion=rfc-8621

Request

{
    "using": [
        "urn:ietf:params:jmap:mail",
        "urn:ietf:params:jmap:mdn",
        "urn:ietf:params:jmap:core"
    ],
    "methodCalls": [
        [
            "MDN/send",
            {
                "accountId": "{{accountId}}",
                "identityId": "{{identityId}}",
                "send": {
                    "k1546": {
                        "forEmailId": "31ed5fe0-4486-11ed-b412-4700d9090322",
                        "subject": "Subject MDN/send",
                        "textBody": "Hello MDN/send",
                        "disposition": {
                            "actionMode": "manual-action",
                            "sendingMode": "mdn-sent-manually",
                            "type": "displayed"
                        }
                    }
                },
                "onSuccessUpdateEmail": {
                    "#k1546": {
                        "keywords/$mdnsent": true
                    }
                }
            },
            "0"
        ]
    ]
}

Response

• If the email id matches an existing email message without the $mdnsent keyword, the server can answer:

{
    "sessionState": "2c9f1b12-b35a-43e6-9af2-0106fb53a943",
    "methodResponses": [
        [
            "MDN/send",
            {
                "accountId": "0d14dbabe6482aff5cbf922e04cef51a40b4eabccbe12d28fe27c97038752555",
                "sent": {
                    "k1546": {
                        "originalRecipient": "rfc822; [email protected]",
                        "finalRecipient": "rfc822; [email protected]",
                        "includeOriginalMessage": false
                    }
                }
            },
            "0"
        ],
        [
            "Email/set",
            {
                "accountId": "0d14dbabe6482aff5cbf922e04cef51a40b4eabccbe12d28fe27c97038752555",
                "oldState": "324b8570-4486-11ed-b412-4700d9090322",
                "newState": "324b8570-4486-11ed-b412-4700d9090322",
                "updated": {
                    "31ed5fe0-4486-11ed-b412-4700d9090322": null
                }
            },
            "0"
        ]
    ]
}

• If the $mdnsent keyword has already been set, the server can answer an error:

{
    "sessionState": "2c9f1b12-b35a-43e6-9af2-0106fb53a943",
    "methodResponses": [
        [
            "MDN/send",
            {
                "accountId": "0d14dbabe6482aff5cbf922e04cef51a40b4eabccbe12d28fe27c97038752555",
                "sent": {
                    "k1546": {
                        "originalRecipient": "rfc822; [email protected]",
                        "finalRecipient": "rfc822; [email protected]",
                        "includeOriginalMessage": false
                    }
                }
            },
            "0"
        ],
        [
            "Email/set",
            {
                "accountId": "0d14dbabe6482aff5cbf922e04cef51a40b4eabccbe12d28fe27c97038752555",
                "oldState": "324b8570-4486-11ed-b412-4700d9090322",
                "newState": "324b8570-4486-11ed-b412-4700d9090322",
                "updated": {
                    "31ed5fe0-4486-11ed-b412-4700d9090322": null
                }
            },
            "0"
        ]
    ]
}

[hoangdat]

still not have test

[dab246]

To get forEmailId passed in MDN/send can be done in 2 ways:

1. Send an email with a header attribute in the outgoing email:
   "header:Disposition-Notification-To:asText": "{{username}}"

• Request sent

"Email/set",
            {
                "accountId": "{{accountId}}",
                "create": {
                    "e01": {
                        "mailboxIds": {
                            "9bc32a50-32cf-11eb-995c-a3ae66e9f96a": true
                        },
                        "subject": "[POSTMAN] SEND EMAIL WITH MDN",
                        "from": [
                            {
                                "name": "{{username}}",
                                "email": "{{username}}"
                            }
                        ],
                        "big": [
                            {
                                "name": "firstname239.surname239",
                                "email": "[email protected]"
                            }
                        ],
                        "htmlBody": [
                            {
                                "partId": "abc123",
                                "type": "text/html"
                            }
                        ],
                        "bodyValues": {
                            "abc123": {
                                "value": "[POSTMAN] SEND EMAIL WITH MDN",
                                "isEncodingProblem": false,
                                "isTruncated": false
                            }
                        },
                        "header:Disposition-Notification-To:asText": "{{username}}"
                    }
                }
            },

• Then get the id value in created of the Email/set method of the returned response.

"Email/set",
            {
                "accountId": "0d14dbabe6482aff5cbf922e04cef51a40b4eabccbe12d28fe27c97038752555",
                "oldState": "1bce8420-4551-11ed-a5ca-053c64f285c3",
                "newState": "1bce8420-4551-11ed-a5ca-053c64f285c3",
                "created": {
                    "e01": {
                        "id": "4cb8a430-4551-11ed-96d7-838c1117bed5",
                        "blobId": "4cb8a430-4551-11ed-96d7-838c1117bed5",
                        "threadId": "4cb8a430-4551-11ed-96d7-838c1117bed5",
                        "size": 1011
                    }
                }
            },
            "c1"

2. Use MDN/parse to get forEmailId