https://github.com/dulajdeshan/smtp-listener

SMTP Listener is a simple SMTP server that listens for incoming SMTP messages and broadcasts them via WebSockets. This project is useful for testing SMTP notification services.
https://github.com/dulajdeshan/smtp-listener

smtp smtp-listener smtp-server

Last synced: about 2 months ago
JSON representation

SMTP Listener is a simple SMTP server that listens for incoming SMTP messages and broadcasts them via WebSockets. This project is useful for testing SMTP notification services.

• Host: GitHub
• URL: https://github.com/dulajdeshan/smtp-listener
• Owner: Dulajdeshan
• License: mit
• Created: 2024-06-22T03:50:38.000Z (6 months ago)
• Default Branch: main
• Last Pushed: 2024-06-22T03:55:18.000Z (6 months ago)
• Last Synced: 2024-06-22T15:49:51.813Z (6 months ago)
• Topics: smtp, smtp-listener, smtp-server
• Language: HTML
• Homepage:
• Size: 222 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# SMTP Listener

SMTP Listener is a simple SMTP server that listens for incoming SMTP messages and broadcasts them via WebSockets. This project is useful for testing SMTP notification services.

## Features

- Listens for incoming SMTP messages on port 2525.

- Broadcasts parsed email messages to connected WebSocket clients on port 8586.

- Serves a web interface to display incoming messages.

## Installation

1. Clone the repository:

   ```bash

   git clone https://github.com/dulajdeshan/smtp-listener.git

   cd smtp-listener

   ```

2. Install dependencies:

   ```bash

   npm install

   ```

3. Build the project:

   ```bash

   npm run build

   ```

4. Bundle the project:

   ```bash

   npm run bundle

   ```

5. Package the project:

   ```bash

   pkg --config pkg-config.json bundle/index.js --out-path dist

   ```

## Usage

1. Start the SMTP server:

   - Navigate to dist folder and run the relevant executable.

2. Open the web interface at [http://localhost:8585](http://localhost:8585) to view incoming messages.

## Screenshots

![SMTP Listener](/screenshots//screenshot-1.png)

## Configuration

- The SMTP server listens on port 2525.

- The WebSocket server listens on port 8586.

- The web interface is served on port 8585.

## Contributing

Contributions are welcome! Please open an issue or submit a pull request.

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.