email-cg-lib

email-cg-lib

https://github.com/CloudGenUser/email-cg-lib.git

1. Introduction

This code has the objective to send and email.

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).

_2. Library usage

The library can be installed from npm page with the next:

npm install email-cg-lib, npm i email-cg-lib or yarn install email-cg-lib

2.1. Send and email

• Args:

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.

• 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.

• 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

Resultant sample:

{
    "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!!!"} //Sample applied into a component function for NXGP

Resultant sample:

{
    "code": "EAUTH",
    "response": "535-5.7.8 Username and Password not accepted. Learn more at\n535 5.7.8  https://support.google.com/mail/?p=BadCredentials x9-20020a9d5889000000b0063b2875246dsm2896371otg.49 - gsmtp",
    "responseCode": 535,
    "command": "AUTH PLAIN"
}