From 572a9a7b033e7129e47d9d101e1233fb58f747c5 Mon Sep 17 00:00:00 2001
From: Igor Markin <igor.markin@vereign.com>
Date: Fri, 5 Mar 2021 14:58:16 +0000
Subject: [PATCH] Update README.md
---
README.md | 16 ++++++++++------
1 file changed, 10 insertions(+), 6 deletions(-)
diff --git a/README.md b/README.md
index 984ba4a..d62a1e2 100644
--- a/README.md
+++ b/README.md
@@ -29,16 +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 console logged by integrator application during the sending routine. **(Before seal actually being attached to MIME)**
+ - `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, or using Outlook Desktop client.
- **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.
+
+ **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.
- **Don't copy contents provided by just `Show original` action because they miss base64 strings of the attachments**
+ - 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`
--
GitLab