errormail

ErrorMail

A Node.js module for sending error emails using the Nodemailer library.

Installation

npm i errormail

Usage

const ErrorMail = require('errormail');
const errorMail = new ErrorMail({
  transporter: {
    service: 'gmail',
    auth: {
      user: '[e-mail]',
      pass: 'yourpassword',
    }
  },
  receiver: {
    to: '[e-mail]',
  },
  showLogs: true,
});

//Usage Example1
const error = new Error('Something went wrong');
errorMail.sendError(error, '[e-mail]', 'Optional Subject')
  .then(info => {
    console.log(`Error email sent: ${info.response}`);
  })
  .catch(err => {
    console.error('Error sending email:', err);
  });

//Usage Example2
fs.readFile('path/file/errors.txt', (err, chunk) => {
    if (err) {
        errorMail.sendError(
            err,
            '[e-mail]',
            'Optional Subject'
        );
    }
    ...
});

//Usage Example3
(async () => {
    try {
        await fs.promises.('path/file/errors.txt');
    } catch (err) {
        const sendedError = await errorMail.sendError(err, '[e-mail]');
        console.log(sendedError);
        //handle err...
    }
})();

ErrorMail Constructor

The ErrorMail constructor takes an options object with the following properties:

const errorMail = new ErrorMail({
  transporter: {
    service: 'gmail', // String specifying the email service. Default is 'gmail'.
    auth: {
      user: '[e-mail]', // String specifying the email address of the sender.
      pass: 'password' // String specifying the password for the email address of the sender.
    }
  },
  receiver: {
    to: '[e-mail]' // String specifying the email address of the recipient.
  },
  showLogs: false // Boolean specifying whether to show logs in the console. Default is false.
});

Options

When creating an instance of the ErrorMail class, you can provide the following options:

The ErrorMail constructor takes an options object with the following properties:

transporter: Object specifying the email service and authentication credentials. Required properties: service: String specifying the email service. Default is 'gmail'. auth: Object specifying the authentication credentials. Required properties: user: String specifying the email address of the sender. pass: String specifying the password for the email address of the sender. receiver: Object specifying the default recipient. Required properties: to: String specifying the email address of the recipient. showLogs: Boolean specifying whether to show logs in the console. Default is false. The sendError method is thenable and takes three optional parameters:

errorMail.sendError(error, to, subject);

error: Error object or string representing the error message. to: String specifying an optional recipient for the email. subject: String specifying an optional subject line for the email.

Example options object:

const options = {
  transporter: {
    service: 'gmail',
    auth: {
      user: '[e-mail]',
      pass: 'yourpassword'
    }
  },
  receiver: {
    to: '[e-mail], [e-mail]'
  },
  showLogs: true
};

You can then pass this options object as an argument when creating a new instance of the ErrorMail class:

const errorMail = new ErrorMail(options);

License This project is licensed under the MIT License - see the LICENSE file for details.

This README.md file includes information on how to install the module, as well as an example usage snippet that shows how to create an instance of the ErrorMail class and send an error email with optional recipient and subject parameters.

It also includes an Options section that describes the properties of the options object that can be passed to the ErrorMail constructor, as well as the optional parameters for the sendError method.

Finally, it includes a License section that describes the license for the module.