diff --git a/README.md b/README.md index 5240bb252435cc419e76f68c14f355a6ee3bd5ec..d62a1e2324dc1f555e12b8af36d8128096ca271d 100644 --- a/README.md +++ b/README.md @@ -29,15 +29,20 @@ https://code.vereign.com/light/documentation/-/blob/master/Validation.md#normali - Create a directory for .eml files. Use the next structure as an example `__tests__/files/outlook-gmail/chrome-chrome/<test-case-dir>`. - Put `sent.eml` and `received.eml` files into the `<test-case-dir>` - - `sent.eml` contains MIME string logged by integrator application during the sending routine. - - `received.eml` contains MIME string extracted manually from email client or logged by the integrator application. + - `sent.eml` contains MIME string console logged by integrator application (Outlook Add-in/Chrome Extension) during the sending routine. + + **IMPORTANT NOTE:** log MIME before seal actually being attached to email + - `received.eml` contains MIME string extracted manually from email client or console logged by the integrator application. - For outlook.com - extract MIME string by logging it in the application itself. - _Do not do export MIME via the web client using `Show message source` action. - It breaks spacing of the quoted-printable parts and parsing/validation of such MIME might fail._ + - For outlook.com - extract MIME string by logging it in the Outlook Add-in itself, or using Outlook Desktop client. - For mail.google.com - use `Show original` -> `Download original` actions in web client. - _Don't copy contents provided by just `Show original` action because they miss base64 strings of the attachments_ + **IMPORTANT NOTE:** Do not do export MIME via the web client using `Show message source` action. + It breaks spacing of the quoted-printable parts and parsing/validation of such MIME might fail. + + + - For mail.google.com - use `Show original` -> `Download original` actions in web client. + + **IMPORTANT NOTE:** Don't copy contents provided by just `Show original` action because they miss base64 strings of the attachments - Create three test suites to cover html, plain and htmltext (pseudoplain) normalisation. E.g: - `html-outlook-gmail.test.ts` - `plain-outlook-gmail.test.ts`