Getting Started - mailslurper/mailslurper GitHub Wiki
Step 1 - Download MailSlurper
To begin you must first download MailSlurper for your operating system. If you are on a Mac running OSX you will need to download the file named mailslurper-x.x-osx.zip (where x.x is the latest version number). If you are going to run MailSlurper on Windows download the file named mailslurper-x.x-windows.zip.
Step 2 - Configuration
The next step is to extract the contents of the ZIP file you downloaded. It does not particularly matter where. Once extracted you will wish to review the configuration details in config.json. For this example let's say you are going to run MailSlurper on your local machine. There are three addresses and ports that need to be configured.
- Web application address and port
- Services address and port
- SMTP server address and port
Let's see what that might look like if we wanted to access the web-based administrator using http://localhost:8080, with services running on port 8888 and the SMTP server running on port 25.
{
"wwwAddress": "127.0.0.1",
"wwwPort": 8080,
"serviceAddress": "127.0.0.1",
"servicePort": 8888,
"smtpAddress": "127.0.0.1",
"smtpPort": 25,
"dbEngine": "SQLite",
"dbHost": "",
"dbPort": 0,
"dbDatabase": "./mailslurper.db",
"dbUserName": "",
"dbPassword": "",
"maxWorkers": 1000,
"keyFile": "",
"certFile": "",
"adminKeyFile": "",
"adminCertFile": "",
"authenticationScheme": "",
"authSecret": "",
"authSalt": "",
"authTimeoutInMinutes": 120,
"credentials": {
}
}
Once you've updated be sure to save your changes to config.json. For more detail about config.json see Server Configuration.
Step 3 - Running
Now that you have MailSlurper configured all that is left to do is run it. Run the executable file named mailslurper for OSX, mailslurper.exe for Windows. Now open your favorite web browser and browse to http://localhost:8080. Congratulations! MailSlurper is now ready to slurp up mail for any of your applications and development projects setup to send mail to localhost on port 25!