npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

gmailer_by_semicile

v1.2.0

Published

A custom Node.js library for sending emails via Gmail.

Downloads

1

Readme

Here is the updated README.md file with the corrected usage example:

Gmailer

A Node.js library for sending emails via Gmail. Supports sending single emails, multiple emails, and emails from Excel sheets.

Installation

You can install the library via npm. Make sure you have Node.js installed.

npm install gmailer_by_semicile

Features

  • Gmail Setup: Easily set up Gmail authentication for sending emails.
  • Send Single Email: Send a single email to one recipient.
  • Send Multiple Emails: Send emails to multiple recipients at once.
  • Send Emails from Excel: Send personalized emails to recipients listed in an Excel file.

Usage

const emailLibrary = require('gmailer_by_semicile');

(async () => {
  try {
    // Send a single email
    const singleMailResult = await emailLibrary.sendSingleMail('[email protected]', 'your-app-password', '[email protected]', 'Test Subject', 'Test Body');
    console.log('Single Mail Result:', singleMailResult);

    // Send multiple emails
    const recipients = ['[email protected]', '[email protected]'];
    const multipleMailsResult = await emailLibrary.sendMultipleMails('[email protected]', 'your-app-password', recipients, 'Test Subject', 'Test Body');
    console.log('Multiple Mails Result:', multipleMailsResult);

    // Send emails from an Excel file
    const filePath = 'path/to/your/excel/file.xlsx';
    const excelMailsResult = await emailLibrary.sendExcelMails(filePath, '[email protected]', 'your-app-password', 'Test Subject', 'Test Body');
    console.log('Excel Mails Result:', excelMailsResult);
  } catch (error) {
    console.error('Error:', error);
  }
})();

API

gmailSetup(userEmail, appPassword)

Set up Gmail authentication with your email and app password.

  • userEmail (string): Your Gmail email address.
  • appPassword (string): Your Gmail app password.

sendSingleMail(userEmail, appPassword, to, subject, text)

Send a single email using Gmail.

  • userEmail (string): Your Gmail email address.
  • appPassword (string): Your Gmail app password.
  • to (string): Recipient's email address.
  • subject (string): Email subject.
  • text (string): Email body text.

sendMultipleMails(userEmail, appPassword, recipients, subject, text)

Send multiple emails using Gmail.

  • userEmail (string): Your Gmail email address.
  • appPassword (string): Your Gmail app password.
  • recipients (array of strings): Array of recipient email addresses.
  • subject (string): Email subject.
  • text (string): Email body text.

sendExcelMails(filePath, userEmail, appPassword, subject, text)

Send emails to recipients listed in an Excel file using Gmail.

  • filePath (string): Path to the Excel file containing recipient email addresses.
  • userEmail (string): Your Gmail email address.
  • appPassword (string): Your Gmail app password.
  • subject (string): Email subject.
  • text (string): Email body text.

License

This project is licensed under the ISC License. See the LICENSE file for details.

Contributing

Contributions are welcome! Please fork the repository and submit a pull request.

Issues

Report any issues or feature requests on the GitHub Issues page.

Author


### Adjustments Made:
- The usage example now correctly utilizes `async`/`await` for asynchronous function calls.
- Provided a detailed example of using the library functions within an `async` IIFE.
- Ensured the `try...catch` block is included to handle potential errors.

Once you have this `README.md` in your repository, it will serve as a comprehensive guide for users of your library.