email-cg-lib - npm Package Compare versions

Comparing version 1.0.3 to 1.0.4

package.json

 {
   "name": "email-cg-lib",
-  "version": "1.0.3",
+  "version": "1.0.4",
   "description": "Email to send emails with basic information.",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

@@ -9,7 +9,7 @@ [![N|Solid](https://cloudgensys.com/cg-demo/wp-content/uploads/2019/05/CG-Logo-01.png)](https://www.cloudgensys.com/)
 
-This code has the objective to send and email.
+This code has the objective to send an email from a specific mail account.
 
-As components are used in the NXGP flows regardless that the library should be added on component code, when the flow is running, an exchange and some queues are created using the ID flow (assigned from NXGP).
+This library could be used as part of a component based on Open Integration Hub (OIH) framework or any Nodejs development that requires convertion between this two formats.
 
-## _2.	Library usage
+## _2.	Library usage_
 
@@ -22,42 +22,61 @@ The library can be installed from npm page with the next:
 
-- **Args:** 
+- **Arguments:** 
 
-Needed:
-host: String that contains the host of the email account, could be for example smtp.gmail.com for G-Mail accounts.
-port: String that contains the number of port where the connection will be stablished, could be dor example 465 for G-Mail accounts.
-secure: String that contains a boolean value (true or false) depending of the security of the server account.
-user: String that contains the email account.
-pass: String that contains the password of the email account, extra configurations in the account may be needed, specially in G-Mail accounts. Warning password for this library may not be the same as the password of the official applications of email privider service.
-from: String that contains the email who is sending the mail. May be the same has user.
-to: String that contains the email who will receive the email.
-
-Optionals:
-subject: String that contains the title of the email who will see the receiver on the inbox,
-text: String that contains the body of the email.
+    - Required:
+        - from: String that contains the email address of the sender of the mail.
+        - host: String that contains the host of the email server that contains the account, an example of a host could be like smtp.gmail.com for G-Mail accounts.
+        - pass: String that contains the password of the email account. Depending of the email account it could require additional configurations to be applied directly in the configurations of the account, for example in the case of the G-Mail accounts is required to configure a different password to be used in external applications. If this actions are not performed a warning message for this library related to the password that may appear and prevents to perform the mail send.
+        - port: String that contains the port number of the email server where the connection will be stablished, for example it could be 465 for G-Mail accounts.
+        - secure: String that contains a boolean value (true or false) depending if the email server requires that the connection must be secure or not.
+        - to: String that contains the email address or addresses that will receive the email.
+        - user: String that contains the email account to have access to the mail server.
+    
+    - Optionals:
+        - subject: String in a single line that contains a description that the sender set as a title and will be seen by the receiver on its mailbox.
+        - text: String that contains the body of the email.
  
-- **Description:** This request send an email if the parameter in the request are the expected.
-Once the request is sended, the answear will be a string in a JSon format with the result of the sending.
+ 
+- **Description:** A request is sent with the parameters configured, connecting to the email server and authenticaiting to the corresponding email account. At the end the process sends the email to the set addresses. Once the request is sent, the response will be a string in a JSON format with the result of the sending.
 
 - **Sample of a request:**
-{"host":"smtp.gmail.com", "port":465, "secure":true, "user":"[e-mail]", "pass":"myPass", "from":"[e-mail]", "to":"[e-mail]", "subject":"Regards",  "text":"Hello Jhon!!!"}
-//Sample applied into a component function for NXGP
-
+```js
+{
+    "host":"smtp.gmail.com",
+    "port":465,
+    "secure":true,
+    "user":"[e-mail]",
+    "pass":"myPass",
+    "from":"[e-mail]",
+    "to":"[e-mail]",
+    "subject":"Regards",
+    "text":"Hello Jhon!!!"
+}
+//Sample applied into a component running into the  N3xGen Portal
 ```
 
-Resultant sample:
-
+- **Sample of a result:**
+```js
 {
     "response": "Mail sended: 250 2.0.0 OK  1663863828 t6-20020a05683014c600b00655bc7c4522sm2925074otq.81 - gsmtp"
 }
-
 ```
 
 - **Sample of a bad request:**
-{"host":"smtp.gmail.com", "port":465, "secure":true, "user":"[e-mail]", "pass":"wrongPassword", "from":"[e-mail]", "to":"[e-mail]", "subject":"Regards",  "text":"Hello Jhon!!!"}
+```js
+{
+    "host":"smtp.gmail.com",
+    "port":465,
+    "secure":true,
+    "user":"[e-mail]",
+    "pass":"wrongPassword",
+    "from":"[e-mail]",
+    "to":"[e-mail]",
+    "subject":"Regards",
+    "text":"Hello Jhon!!!"
+}
 //Sample applied into a component function for NXGP
-
 ```
 
-Resultant sample:
-
+- **Sample of a responce for a bad request:**
+```js
 {
@@ -69,3 +88,2 @@ "code": "EAUTH",
 }
-
-```
+```

No alert changes

Improved metrics

Total package byte prevSize

7383

increased by11.73%

Number of lines in readme file

87

increased by27.94%

No dependency changes