https://github.com/m-ahmedk/mail-sender

The project is a Node.js application that uses the Mailgun.js library to send email templates to a recipient's email address. The purpose of the application is to test how the email template looks once it has been sent and received.
https://github.com/m-ahmedk/mail-sender

expressjs mailgun-js nodejs

Last synced: 5 days ago
JSON representation

The project is a Node.js application that uses the Mailgun.js library to send email templates to a recipient's email address. The purpose of the application is to test how the email template looks once it has been sent and received.

• Host: GitHub
• URL: https://github.com/m-ahmedk/mail-sender
• Owner: m-ahmedk
• License: mit
• Created: 2023-04-01T12:16:59.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2023-04-03T20:06:45.000Z (almost 2 years ago)
• Last Synced: 2024-11-07T18:18:54.948Z (about 2 months ago)
• Topics: expressjs, mailgun-js, nodejs
• Language: JavaScript
• Homepage:
• Size: 17.6 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Node.js Mail Tester

This project is a simple Node.js application that sends an email to a recipient using the Mailgun API. The objective of this project is to test how an email template appears once it has been sent to the recipient's email address.

## Installation

1. Clone this repository.

2. Run _npm install_ to install the project's dependencies.

3. Create a _.env_ file in the root of the project and add your Mailgun API key and domain:

```

MAILGUN_API_KEY=

```

```

MAILGUN_DOMAIN=

```

```

MAILGUN_FROM_EMAIL=

```

```

PORT=

```

4. Run npm run dev to start the development server using Nodemon.

## Usage

1. Open POSTMAN

2. Add a request for url: http://localhost:PORT/api/v1/mailsender/sendemail

3. Add _email_ in the body as raw json

```

{

    "email": "[email protected]"

}

```

4. Check the recipient's email inbox for the test email.

## License

This project is licensed under the [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/m-ahmedk/mail-sender/blob/main/LICENSE).