Emailer is a lightweight email microservice. The idea is to use it to handle sending emails from your applications. To get started using Emailer you will need to do five things.
- Download Emailer
- Fill out the .env file with your mail server settings and run
php artisan key:generate - Create a template using the Blade templating engine save it as
<templatename>generated.blade.php> - Run the artisan commands for Emailer in this order
- emailer:salt
- emailer:apps
- emailer:address (to generate an address to send to)
- emailer:addresses (to connect the new address with the app)
- Then start your webserver and send a POST request to
http://<your-url>/api/send/<appname>/<templatename>
- Create client to replace artisan commands
- Write tests for artisan commands
- Mock database to make tests faster
- Refactor MailController to be more testable
To get started contributing, just fork this repository and clone it.
Before you check out a branch go ahead and and a remote upstream by typing git remote add upstream https://github.com/colonelpopcorn/emailer.
Then checkout a new branch and code away!
When you're ready to submit a pull request, first run git pull on the master branch and then checkout your feature branch and run git rebase origin/master.
If you run into any trouble just ask in our gitter chat!
Emailer is released under the MIT license.
The emailer logo is comprised of several creative commons assets.