Here is the updated README.md
file with the corrected usage example:
A Node.js library for sending emails via Gmail. Supports sending single emails, multiple emails, and emails from Excel sheets.
You can install the library via npm. Make sure you have Node.js installed.
npm install gmailer_by_semicile
- 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.
const emailLibrary = require('gmailer_by_semicile');
(async () => {
try {
// Send a single email
const singleMailResult = await emailLibrary.sendSingleMail('your-email@gmail.com', 'your-app-password', 'recipient@example.com', 'Test Subject', 'Test Body');
console.log('Single Mail Result:', singleMailResult);
// Send multiple emails
const recipients = ['recipient1@example.com', 'recipient2@example.com'];
const multipleMailsResult = await emailLibrary.sendMultipleMails('your-email@gmail.com', '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, 'your-email@gmail.com', 'your-app-password', 'Test Subject', 'Test Body');
console.log('Excel Mails Result:', excelMailsResult);
} catch (error) {
console.error('Error:', error);
}
})();
Set up Gmail authentication with your email and app password.
-
userEmail
(string): Your Gmail email address. -
appPassword
(string): Your Gmail app password.
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.
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.
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.
This project is licensed under the ISC License. See the LICENSE file for details.
Contributions are welcome! Please fork the repository and submit a pull request.
Report any issues or feature requests on the GitHub Issues page.
- Your Name
- GitHub: github.com/Semicile17
### 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.