email-cg-lib

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

1. Introduction

This code has the objective to send an email from a specific mail account.

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

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

• Arguments:

  • 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.
    • 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: 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,
    "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

• Sample of a result:

{
    "response": "Mail sended: 250 2.0.0 OK  1663863828 t6-20020a05683014c600b00655bc7c4522sm2925074otq.81 - gsmtp"
}

• Sample of a bad request:

{
    "host":"smtp.gmail.com",
    "port":465,
    "user":"[e-mail]",
    "pass":"wrongPassword",
    "from":"[e-mail]",
    "to":"[e-mail]",
    "subject":"Regards",
    "text":"Hello Jhon!!!"
}
//Sample applied into a component function for NXGP

• Sample of a responce for a bad request:

{
    "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"
}