Commit 1425619f authored by Tobias van Beek's avatar Tobias van Beek 👌
Browse files

Add a README, LICENSE, CONTRIBUTING and CHANGELOG file

parent 954490d5
Pipeline #15303227 passed with stage
in 5 minutes and 6 seconds
# Changelog
All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
## [Unreleased]
- Add an event handling to the Laravel sended mail
# Contributing
Contributions are allways very welcome. This file is a guideline about how to contribute.
## How to contribute
All the contributes need to be done with a merge request. It is possible to create a merge request prefixed with WIP: to ask for feedback or if you didn't know how to match all requirements.
Please be sure to check all the [requirements](#requirements) before sending your merge request (except a WIP merge request)
## Requirements
* All the code need to confirm to the [PSR-2](http://www.php-fig.org/psr/psr-2/). You can check this localy with `vendor/bin/phpcs --standard=psr2 src/`
* Add tests for code changes, we use [PHPUnit](https://phpunit.de/). You can run the test with `vendor/bin/phpunit` this wil also generate some reports in the build directory.
* Document the changes, any functional change or bug fix need to be writen in [CHANGELOG.md](CHANGELOG.md). Depending on your change you need to add some documentation to the [README.md](README.md)
* Respect [SemVer](http://semver.org/), we use Semanting Versioning so please respect it with the changes you want to add.
* A merge request for a change. Please don't mix multiple changes in one merge request.
* Ask questions, if you are not sure about something ask it.
MIT License
Copyright (c) 2017 Tobias van Beek
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
# Laravel Mail Catchall
[![Latest Stable Version](https://poser.pugx.org/tjvb/laravel-mail-catchall/v/stable)](https://packagist.org/packages/tjvb/laravel-mail-catchall)
[![pipeline status](https://gitlab.com/tjvb/laravel-mail-catchall/badges/master/pipeline.svg)](https://gitlab.com/tjvb/laravel-mail-catchall/commits/master)
[![coverage report](https://gitlab.com/tjvb/laravel-mail-catchall/badges/master/coverage.svg)](https://gitlab.com/tjvb/laravel-mail-catchall/commits/master)
[![License](https://poser.pugx.org/tjvb/laravel-mail-catchall/license)](https://packagist.org/packages/tjvb/laravel-mail-catchall)
## Why
The target is to catch all the mail send by Laravel and send it to a configured email adres. We found it usefull to
## Installation
You can install the Laravel Mail Catcher with composer with the command: `composer require tjvb/laravel-mail-catchall`
### Before Laravel 5.5
Add `TJVB\MailCatchall\MailCatchallServiceProvider::class,` to the providers array in config/app.php
### Publish the config file
Publish the config file with `php artisan vendor:publish --provider="TJVB\MailCatchall\MailCatchallServiceProvider"`
## Config
Set the `MAILCATCHALL_ENABLED` env variable (most used version is to set it in the .env file) to true
Set the `MAILCATCHALL_RECEIVER` env variable with the email address if the receiver.
## Changelog
We (try to) document all the changes in [CHANGELOG](CHANGELOG.md) so read it for more information.
## Contributing
You are very welcome to contribute, read about it in [CONTRIBUTING](CONTRIBUTING.md)
## Code of Conduct
We have a code of conduct, and suspect everybody who want to involve in this project to respect it. [CODE OF CONDUCT](CODE-OF-CONDUCT.md)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment