Skip to content

rurreac/dump25

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

16 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

dump25

Intro

Thought to work along with your application, so that, you can run your own tests without the need of a real SMTP server, or impacting your customers with a fake email by accident.

Dump25 will dump a JSON with the current Fake Email Queue at the root of its HTTP server.

The queue is stored in a Cache file (with a default expiration time), so the previous queue will be available after restarts, except items in queue that reached its expiration time.

Command line parameters

Just a little bit of optional configuration (./dump25 -help output):

  -cachePath string
        Directory where Cache should be stored. (default "./")
  -expTime int
        Expiration time (hours) of each Item in Queue. (default 8)
  -httpPort int
        What port should the HTTP Server use. (default 18080)
  -smtpAuth
        Whatever if dump25 should ask for SMTP authentication.
  -smtpPort string
        What port should the fake SMTP Server use. (default "10025")

Note that enabling SMTP authentication, requires the client to provide user and password (anything), if authentication is not provided, then the client will be rejected, with the corresponding SMTP Error Code.

Supported URLs paths

/

Inbox preview, some other options should be available from there (admits filtering).

/flush

Purges current Cache (or Inbox).

/inbox

Dumps a JSON with the current Inbox (admits filtering).

/inbox/:id

Previews the message with id :id.

Filtering

Paths where filtering is enabled allow partial or exact match of IP and / or From address:

http://<ipAddress>:<port>/<path>?ip=127.0.0&[email protected]

If SMTP Authentication is or was enabled, you can also filter by the exact UserName used during authentication.

http://<ipAddress>:<port>/<path>?ip=127.0.0&from=[test1,test2]&user=<user> 

About

Fake SMTP Server and Email Queue Viewer

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages