@realtebo/local-smtp-blackhole

Goal

IMPORTANT: This package is meant to be used ONLY with composer package laravel-local-smtp-blackhole.

This package offers a minimal but full working smtp that catches email but doesn't send to recipients. Instead, it save to db to allow later inspection, preview, etc.

Both this and the composer companion package are NOT meant to be used in production.

Every time an email is received, this package fire an event via websocket, so listening clients can not only read email in the db, but be informed realtime of the new message.

Prerequisites

This package (and the companion one) is compatible only with mysql.

SMTP configuration for your email client and/or for your code

host/ip: hostname/ip of machine running this code
username: localsmtp
password: blackhole
port: 2525
authmod: normal password, supports but ignores SSL/TLS

About socket.io

We're running a socket.io server on port 2626

Installation

npm install @realtebo/local-smtp-blackhole --save-dev [--no-bin-links]

or

yarn add @realtebo/local-smtp-blackhole --dev [--no-bin-links]

Run

node node_modules/@realtebo/local-smtp-blackhole/src/local-smtp-sever.js 

Remember ! This is a companion package

This package is not meant to be used alone. It must be used with composer package laravel-local-smtp-blackhole.

The composer package offer a laravel gui to see the email catched by this package.

Until the composer package will be officially released, you can install using github repository. See the companion github repository to instructions.

Important

Never, never, never use this package in production environments !

Issues

Feel free to open issues for requests, ideas and what else.